Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.
", "CreateStoreImageTask": "Stores an AMI as a single object in an Amazon S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
", "CreateSubnet": "Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you can't change its CIDR block.
The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for your use.
If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block with a subnet when you create it. The allowed block size for an IPv6 subnet is a /64 netmask.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information, see Subnets in the Amazon VPC User Guide.
", - "CreateSubnetCidrReservation": "Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.
", + "CreateSubnetCidrReservation": "Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide and Assign prefixes to network interfaces in the Amazon Elastic Compute Cloud User Guide.
", "CreateTags": "Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the Amazon Elastic Compute Cloud User Guide.
", "CreateTrafficMirrorFilter": "Creates a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
", "CreateTrafficMirrorFilterRule": "Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
", @@ -158,7 +158,7 @@ "DeleteIpamScope": "Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
", "DeleteKeyPair": "Deletes the specified key pair, by removing the public key from Amazon EC2.
", "DeleteLaunchTemplate": "Deletes a launch template. Deleting a launch template deletes all of its versions.
", - "DeleteLaunchTemplateVersions": "Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.
", + "DeleteLaunchTemplateVersions": "Deletes one or more versions of a launch template.
You can't delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.
You can delete up to 200 launch template versions in a single request. To delete more than 200 versions in a single request, use DeleteLaunchTemplate, which deletes the launch template and all of its versions.
For more information, see Delete a launch template version in the EC2 User Guide.
", "DeleteLocalGatewayRoute": "Deletes the specified route from the specified local gateway route table.
", "DeleteLocalGatewayRouteTable": "Deletes a local gateway route table.
", "DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation": "Deletes a local gateway route table virtual interface group association.
", @@ -9065,7 +9065,7 @@ "DescribeInstanceStatusRequest$Filters": "The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
One or more filters. Filter names and values are case-sensitive.
location - This depends on the location type. For example, if the location type is region (default), the location is the Region code (for example, us-east-2.)
instance-type - The instance type. For example, c5.2xlarge.
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, \"25 Gigabit\").
nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported).
nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported).
nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0).
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
processor-info.supported-features - The supported CPU features (amd-sev-snp).
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
boot-mode - The boot mode that was specified by the AMI (legacy-bios | uefi | uefi-preferred).
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity Reservation preference (open | none).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn - The ARN of the targeted Capacity Reservation group.
client-token - The idempotency token you provided when you launched the instance.
current-instance-boot-mode - The boot mode that is used to launch the instance at launch or start (legacy-bios | uefi).
dns-name - The public DNS name of the instance.
ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
iam-instance-profile.name - The instance profile associated with the instance. Specified as an name.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
ipv6-address - The IPv6 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
license-pool -
maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (disabled | default).
metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (disabled | enabled).
metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (disabled | enabled).
metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)
metadata-options.state - The state of the metadata option changes (pending | applied).
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server Standard | Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web).
private-dns-name - The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type - The type of hostname (ip-name | resource-name).
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
usage-operation - The usage operation value for the instance (RunInstances | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 | RunInstances:0110 | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
usage-operation-update-time - The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z.
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", "DescribeIpamResourceDiscoveriesRequest$Filters": "The resource discovery filters.
", @@ -11606,7 +11606,7 @@ "CreateReservedInstancesListingRequest$InstanceCount": "The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
", "CreateTrafficMirrorFilterRuleRequest$RuleNumber": "The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
", "CreateTrafficMirrorFilterRuleRequest$Protocol": "The protocol, for example UDP, to assign to the Traffic Mirror rule.
For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.
", - "CreateTrafficMirrorSessionRequest$PacketLength": "The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.
If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.
If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
", "CreateTrafficMirrorSessionRequest$VirtualNetworkId": "The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId, an account-wide unique id is chosen at random.
The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). A local network interface cannot be the primary network interface (eth0).
The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
", "ModifyTrafficMirrorFilterRuleRequest$Protocol": "The protocol, for example TCP, to assign to the Traffic Mirror rule.
", - "ModifyTrafficMirrorSessionRequest$PacketLength": "The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
", + "ModifyTrafficMirrorSessionRequest$PacketLength": "The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
For sessions with Network Load Balancer (NLB) traffic mirror targets, the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
", "ModifyTrafficMirrorSessionRequest$VirtualNetworkId": "The virtual network ID of the Traffic Mirror session.
", "ModifyVolumeRequest$Size": "The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
Default: The existing size is retained.
", @@ -18608,7 +18608,7 @@ "CreateFlowLogsRequest$DeliverCrossAccountRole": "The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
", "CreateFlowLogsRequest$LogGroupName": "The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
This parameter is valid only if the destination type is cloud-watch-logs.
The destination for the flow log data. The meaning of this parameter depends on the destination type.
If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:
arn:aws:logs:region:account_id:log-group:my_group
Alternatively, use the LogGroupName parameter.
If the destination type is s3, specify the ARN of an S3 bucket. For example:
arn:aws:s3:::my_bucket/my_subfolder/
The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.
If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:
arn:aws:firehose:region:account_id:deliverystream:my_stream
The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.
Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.
Specify the fields using the ${field-id} format, separated by spaces.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateFpgaImageRequest$Description": "A description for the AFI.
", "CreateFpgaImageRequest$Name": "A name for the AFI.
", @@ -20425,7 +20425,7 @@ "SubnetCidrReservationType": { "base": null, "refs": { - "CreateSubnetCidrReservationRequest$ReservationType": "The type of reservation.
The following are valid values:
prefix: The Amazon EC2 Prefix Delegation feature assigns the IP addresses to network interfaces that are associated with an instance. For information about Prefix Delegation, see Prefix Delegation for Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
explicit: You manually assign the IP addresses to resources that reside in your subnet.
The type of reservation. The reservation type determines how the reserved IP addresses are assigned to resources.
prefix - Amazon Web Services assigns the reserved IP addresses to network interfaces.
explicit - You assign the reserved IP addresses to network interfaces.
The type of reservation.
" } }, @@ -22633,7 +22633,7 @@ "VersionStringList": { "base": null, "refs": { - "DeleteLaunchTemplateVersionsRequest$Versions": "The version numbers of one or more launch template versions to delete.
", + "DeleteLaunchTemplateVersionsRequest$Versions": "The version numbers of one or more launch template versions to delete. You can specify up to 200 launch template version numbers.
", "DescribeLaunchTemplateVersionsRequest$Versions": "One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest. To describe all launch templates in your account that are defined as the default version, the valid value is $Default. You can specify $Latest and $Default in the same request. You cannot specify numbers.
This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.
For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.
For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
This documentation contains reference information related to the following:
", "operations": { - "CloneReceiptRuleSet": "Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.
For information about setting up rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "CreateConfigurationSet": "Creates a configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "CreateConfigurationSetEventDestination": "Creates a configuration set event destination.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "CreateConfigurationSetTrackingOptions": "Creates an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
", - "CreateCustomVerificationEmailTemplate": "Creates a new custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "CreateReceiptFilter": "Creates a new IP address filter.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "CreateReceiptRule": "Creates a receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "CreateReceiptRuleSet": "Creates an empty receipt rule set.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "CreateTemplate": "Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "DeleteConfigurationSet": "Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "DeleteConfigurationSetEventDestination": "Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "DeleteConfigurationSetTrackingOptions": "Deletes an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
Deletes an existing custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "CloneReceiptRuleSet": "Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.
For information about setting up rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "CreateConfigurationSet": "Creates a configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "CreateConfigurationSetEventDestination": "Creates a configuration set event destination.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the Amazon Web Services service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "CreateConfigurationSetTrackingOptions": "Creates an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
", + "CreateCustomVerificationEmailTemplate": "Creates a new custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "CreateReceiptFilter": "Creates a new IP address filter.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "CreateReceiptRule": "Creates a receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "CreateReceiptRuleSet": "Creates an empty receipt rule set.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "CreateTemplate": "Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "DeleteConfigurationSet": "Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "DeleteConfigurationSetEventDestination": "Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "DeleteConfigurationSetTrackingOptions": "Deletes an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
Deleting this kind of association results in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
Deletes an existing custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", "DeleteIdentity": "Deletes the specified identity (an email address or a domain) from the list of verified identities.
You can execute this operation no more than once per second.
", - "DeleteIdentityPolicy": "Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "DeleteReceiptFilter": "Deletes the specified IP address filter.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "DeleteReceiptRule": "Deletes the specified receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "DeleteReceiptRuleSet": "Deletes the specified receipt rule set and all of the receipt rules it contains.
The currently active rule set cannot be deleted.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "DeleteIdentityPolicy": "Deletes the specified sending authorization policy for the given identity (an email address or a domain). This operation returns successfully even if a policy with the specified name does not exist.
This operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "DeleteReceiptFilter": "Deletes the specified IP address filter.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "DeleteReceiptRule": "Deletes the specified receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "DeleteReceiptRuleSet": "Deletes the specified receipt rule set and all of the receipt rules it contains.
The currently active rule set cannot be deleted.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", "DeleteTemplate": "Deletes an email template.
You can execute this operation no more than once per second.
", "DeleteVerifiedEmailAddress": "Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
Returns the metadata and receipt rules for the receipt rule set that is currently active.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "DescribeConfigurationSet": "Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "DescribeReceiptRule": "Returns the details of the specified receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "DescribeReceiptRuleSet": "Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "GetAccountSendingEnabled": "Returns the email sending status of the Amazon SES account for the current region.
You can execute this operation no more than once per second.
", - "GetCustomVerificationEmailTemplate": "Returns the custom email verification template for the template name you specify.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "GetIdentityDkimAttributes": "Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This operation takes a list of identities as input and returns the following information for each:
Whether Easy DKIM signing is enabled or disabled.
A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.
This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
", + "DescribeActiveReceiptRuleSet": "Returns the metadata and receipt rules for the receipt rule set that is currently active.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "DescribeConfigurationSet": "Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "DescribeReceiptRule": "Returns the details of the specified receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "DescribeReceiptRuleSet": "Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "GetAccountSendingEnabled": "Returns the email sending status of the Amazon SES account for the current Region.
You can execute this operation no more than once per second.
", + "GetCustomVerificationEmailTemplate": "Returns the custom email verification template for the template name you specify.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "GetIdentityDkimAttributes": "Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This operation takes a list of identities as input and returns the following information for each:
Whether Easy DKIM signing is enabled or disabled.
A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.
This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
", "GetIdentityMailFromDomainAttributes": "Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
", - "GetIdentityNotificationAttributes": "Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
", - "GetIdentityPolicies": "Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "GetIdentityVerificationAttributes": "Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
The verification status of an email address is \"Pending\" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to \"Success\". If the link is not clicked within 24 hours, the verification status changes to \"Failed.\" In that case, if you still want to verify the email address, you must restart the verification process from the beginning.
For domain identities, the domain's verification status is \"Pending\" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to \"Success\". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to \"Failed.\" In that case, if you still want to verify the domain, you must restart the verification process from the beginning.
This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
", + "GetIdentityNotificationAttributes": "Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
", + "GetIdentityPolicies": "Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.
This operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "GetIdentityVerificationAttributes": "Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
The verification status of an email address is \"Pending\" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to \"Success\". If the link is not clicked within 24 hours, the verification status changes to \"Failed.\" In that case, to verify the email address, you must restart the verification process from the beginning.
For domain identities, the domain's verification status is \"Pending\" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to \"Success\". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to \"Failed.\" In that case, to verify the domain, you must restart the verification process from the beginning.
This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
", "GetSendQuota": "Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
", - "GetSendStatistics": "Provides sending statistics for the current AWS Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.
You can execute this operation no more than once per second.
", + "GetSendStatistics": "Provides sending statistics for the current Amazon Web Services Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.
You can execute this operation no more than once per second.
", "GetTemplate": "Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.
You can execute this operation no more than once per second.
", - "ListConfigurationSets": "Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.
Lists the existing custom verification email templates for your account in the current AWS Region.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "ListIdentities": "Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.
You can execute this operation no more than once per second.
", - "ListIdentityPolicies": "Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "ListReceiptFilters": "Lists the IP address filters associated with your AWS account in the current AWS Region.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "ListReceiptRuleSets": "Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "ListTemplates": "Lists the email templates present in your Amazon SES account in the current AWS Region.
You can execute this operation no more than once per second.
", + "ListConfigurationSets": "Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
You can execute this operation no more than once per second. This operation returns up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation also returns NextToken. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.
Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "ListIdentities": "Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.
You can execute this operation no more than once per second.
It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used IdentityType=Domain in the the original call and received a NextToken in the response, you should continue providing the IdentityType=Domain parameter for further NextToken calls; however, if you didn't provide the IdentityType parameter in the original call, then continue to not provide it for successive pagination calls. Using this protocol will ensure consistent results.
Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This operation returns only a list. To get the actual policy content, use GetIdentityPolicies.
This operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "ListReceiptFilters": "Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "ListReceiptRuleSets": "Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "ListTemplates": "Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
You can execute this operation no more than once per second.
", "ListVerifiedEmailAddresses": "Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.
Adds or updates the delivery options for a configuration set.
", - "PutIdentityPolicy": "Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "ReorderReceiptRuleSet": "Reorders the receipt rules within a receipt rule set.
All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "SendBounce": "Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.
You cannot use this API to send generic bounces for mail that was not received by Amazon SES.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "SendBulkTemplatedEmail": "Composes an email message to multiple destinations. The message body is created using an email template.
In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:
The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
The message must be sent from a verified email address or domain.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group.
The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.
Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.
To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "SendEmail": "Composes an email message and immediately queues it for sending. In order to send email using the SendEmail operation, your message must meet the following requirements:
The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an \"Email address not verified\" error.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
Composes an email message and immediately queues it for sending.
This operation is more flexible than the SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.
The SendRawEmail operation has the following requirements:
You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an \"Email address not verified\" error.
If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.
The maximum message size, including attachments, is 10 MB.
Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.
If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.
Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.
Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide.
Additionally, keep the following considerations in mind when using the SendRawEmail operation:
Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides.
If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email:
X-SES-SOURCE-ARN
X-SES-FROM-ARN
X-SES-RETURN-PATH-ARN
Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.
If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.
For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
Composes an email message using an email template and immediately queues it for sending.
In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements:
The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
The message must be sent from a verified email address or domain.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients who will receive the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.
The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.
If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.
For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
Sets the specified receipt rule set as the active receipt rule set.
To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "SetIdentityDkimEnabled": "Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.
For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM.
You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete.
You can execute this operation no more than once per second.
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
", - "SetIdentityFeedbackForwardingEnabled": "Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.
Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
", - "SetIdentityHeadersInNotificationsEnabled": "Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
", - "SetIdentityMailFromDomain": "Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "SetIdentityNotificationTopic": "Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.
You can execute this operation no more than once per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
", - "SetReceiptRulePosition": "Sets the position of the specified receipt rule in the receipt rule set.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "PutIdentityPolicy": "Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
This operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "ReorderReceiptRuleSet": "Reorders the receipt rules within a receipt rule set.
All of the rules in the rule set must be represented in this request. That is, it is error if the reorder request doesn't explicitly position all of the rules.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "SendBounce": "Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this operation on an email up to 24 hours after you receive it.
You cannot use this operation to send generic bounces for mail that was not received by Amazon SES.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "SendBulkTemplatedEmail": "Composes an email message to multiple destinations. The message body is created using an email template.
To send email using this operation, your call must meet the following requirements:
The call must refer to an existing email template. You can create email templates using CreateTemplate.
The message must be sent from a verified email address or domain.
If your account is still in the Amazon SES sandbox, you may send only to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group.
The number of destinations you can contact in a single call can be limited by your account's maximum sending rate.
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.
To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "SendEmail": "Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:
The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation results in an \"Email address not verified\" error.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
Composes an email message and immediately queues it for sending.
This operation is more flexible than the SendEmail operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you need to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.
The SendRawEmail operation has the following requirements:
You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an \"Email address not verified\" error.
If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.
The maximum message size, including attachments, is 10 MB.
Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.
If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.
Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.
Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide.
Additionally, keep the following considerations in mind when using the SendRawEmail operation:
Although you can customize the message headers when using the SendRawEmail operation, Amazon SES automatically applies its own Message-ID and Date headers; if you passed these headers when creating the message, they are overwritten by the values that Amazon SES provides.
If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn, or you can include the following X-headers in the header of your raw email:
X-SES-SOURCE-ARN
X-SES-FROM-ARN
X-SES-RETURN-PATH-ARN
Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.
If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.
For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
Composes an email message using an email template and immediately queues it for sending.
To send email using this operation, your call must meet the following requirements:
The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
The message must be sent from a verified email address or domain.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients that receives the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.
The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.
For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
Sets the specified receipt rule set as the active receipt rule set.
To disable your email-receiving through Amazon SES completely, you can call this operation with RuleSetName set to null.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "SetIdentityDkimEnabled": "Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.
For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM.
You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete.
You can execute this operation no more than once per second.
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
", + "SetIdentityFeedbackForwardingEnabled": "Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.
Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
", + "SetIdentityHeadersInNotificationsEnabled": "Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
", + "SetIdentityMailFromDomain": "Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "SetIdentityNotificationTopic": "Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.
You can execute this operation no more than once per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
", + "SetReceiptRulePosition": "Sets the position of the specified receipt rule in the receipt rule set.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", "TestRenderTemplate": "Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
You can execute this operation no more than once per second.
", - "UpdateAccountSendingEnabled": "Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.
You can execute this operation no more than once per second.
", - "UpdateConfigurationSetEventDestination": "Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
You can execute this operation no more than once per second.
", - "UpdateConfigurationSetReputationMetricsEnabled": "Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.
You can execute this operation no more than once per second.
", - "UpdateConfigurationSetSendingEnabled": "Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.
You can execute this operation no more than once per second.
", - "UpdateConfigurationSetTrackingOptions": "Modifies an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
", - "UpdateCustomVerificationEmailTemplate": "Updates an existing custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "UpdateReceiptRule": "Updates a receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "UpdateTemplate": "Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", - "VerifyDomainDkim": "Returns a set of DKIM tokens for a domain identity.
When you execute the VerifyDomainDkim operation, the domain that you specify is added to the list of identities that are associated with your account. This is true even if you haven't already associated the domain with your account by using the VerifyDomainIdentity operation. However, you can't send email from the domain until you either successfully verify it or you successfully set up DKIM for it.
You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.
To create the CNAME records for DKIM authentication, use the following values:
Name: token._domainkey.example.com
Type: CNAME
Value: token.dkim.amazonses.com
In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation.
You can execute this operation no more than once per second.
", - "VerifyDomainIdentity": "Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "UpdateAccountSendingEnabled": "Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given Amazon Web Services Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.
You can execute this operation no more than once per second.
", + "UpdateConfigurationSetEventDestination": "Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
You can execute this operation no more than once per second.
", + "UpdateConfigurationSetReputationMetricsEnabled": "Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.
You can execute this operation no more than once per second.
", + "UpdateConfigurationSetSendingEnabled": "Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.
You can execute this operation no more than once per second.
", + "UpdateConfigurationSetTrackingOptions": "Modifies an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
", + "UpdateCustomVerificationEmailTemplate": "Updates an existing custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "UpdateReceiptRule": "Updates a receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "UpdateTemplate": "Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", + "VerifyDomainDkim": "Returns a set of DKIM tokens for a domain identity.
When you execute the VerifyDomainDkim operation, the domain that you specify is added to the list of identities that are associated with your account. This is true even if you haven't already associated the domain with your account by using the VerifyDomainIdentity operation. However, you can't send email from the domain until you either successfully verify it or you successfully set up DKIM for it.
You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.
To create the CNAME records for DKIM authentication, use the following values:
Name: token._domainkey.example.com
Type: CNAME
Value: token.dkim.amazonses.com
In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation.
You can execute this operation no more than once per second.
", + "VerifyDomainIdentity": "Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
", "VerifyEmailAddress": "Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.
Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.
You can execute this operation no more than once per second.
" + "VerifyEmailIdentity": "Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.
You can execute this operation no more than once per second.
" }, "shapes": { "AccountSendingPausedException": { @@ -81,7 +81,7 @@ } }, "AddHeaderAction": { - "base": "When included in a receipt rule, this action adds a header to the received email.
For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.
", + "base": "When included in a receipt rule, this action adds a header to the received email.
For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.
", "refs": { "ReceiptAction$AddHeaderAction": "Adds a header to the received email.
" } @@ -90,19 +90,19 @@ "base": null, "refs": { "AddressList$member": null, - "BounceAction$Sender": "The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
", + "BounceAction$Sender": "The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
", "BouncedRecipientInfo$Recipient": "The email address of the recipient of the bounced email.
", "DeleteVerifiedEmailAddressRequest$EmailAddress": "An email address to be removed from the list of verified addresses.
", - "RecipientDsnFields$FinalRecipient": "The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.
Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.
The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient is set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.
Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.
The address to use in the \"From\" header of the bounce message. This must be an identity that you have verified with Amazon SES.
", - "SendBulkTemplatedEmailRequest$Source": "The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode characters in the \"friendly from\" name, you must encode the \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
The email address to verify.
", - "SendEmailRequest$Source": "The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
The identity's email address. If you do not provide a value for this parameter, you must specify a \"From\" address in the raw text of the message. (You can also specify both.)
Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode characters in the \"friendly from\" name, you must encode the \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
The identity's email address. If you do not provide a value for this parameter, you must specify a \"From\" address in the raw text of the message. (You can also specify both.)
Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode characters in the \"friendly from\" name, you must encode the \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints are sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. for this reason, The email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode characters in the \"friendly from\" name, you must encode the \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
The email address to be verified.
", "VerifyEmailIdentityRequest$EmailAddress": "The email address to be verified.
" } @@ -114,10 +114,10 @@ "Destination$CcAddresses": "The recipients to place on the CC: line of the message.
", "Destination$BccAddresses": "The recipients to place on the BCC: line of the message.
", "ListVerifiedEmailAddressesResponse$VerifiedEmailAddresses": "A list of email addresses that have been verified.
", - "SendBulkTemplatedEmailRequest$ReplyToAddresses": "The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
", - "SendEmailRequest$ReplyToAddresses": "The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
", + "SendBulkTemplatedEmailRequest$ReplyToAddresses": "The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
", + "SendEmailRequest$ReplyToAddresses": "The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
", "SendRawEmailRequest$Destinations": "A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
", - "SendTemplatedEmailRequest$ReplyToAddresses": "The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
" + "SendTemplatedEmailRequest$ReplyToAddresses": "The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
" } }, "AlreadyExistsException": { @@ -128,33 +128,33 @@ "AmazonResourceName": { "base": null, "refs": { - "BounceAction$TopicArn": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.
", + "BounceAction$TopicArn": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
", + "BouncedRecipientInfo$RecipientArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.
", "InvalidLambdaFunctionException$FunctionArn": "Indicates that the ARN of the function was not found.
", "InvalidSnsTopicException$Topic": "Indicates that the topic does not exist.
", "KinesisFirehoseDestination$IAMRoleARN": "The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
", "KinesisFirehoseDestination$DeliveryStreamARN": "The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
", - "LambdaAction$TopicArn": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:
To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.
To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.
For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the \"From\" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.
", - "SendBulkTemplatedEmailRequest$SourceArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", - "SendBulkTemplatedEmailRequest$ReturnPathArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", + "LambdaAction$TopicArn": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
", + "LambdaAction$FunctionArn": "The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An example of an Amazon Web Services Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about Amazon Web Services Lambda, see the Amazon Web Services Lambda Developer Guide.
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
", + "S3Action$KmsKeyArn": "The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key that you created in Amazon Web Services KMS as follows:
To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your Amazon Web Services account ID is 123456789012 and you want to use the default master key in the US West (Oregon) Region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.
To use a custom master key that you created in Amazon Web Services KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.
For more information about key policies, see the Amazon Web Services KMS Developer Guide. If you do not specify a master key, Amazon SES does not encrypt your emails.
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your Amazon Web Services KMS keys for decryption. This encryption client is currently available with the Amazon Web Services SDK for Java and Amazon Web Services SDK for Ruby only. For more information about client-side encryption using Amazon Web Services KMS master keys, see the Amazon S3 Developer Guide.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
", + "SNSDestination$TopicARN": "The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
", + "SendBounceRequest$BounceSenderArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the \"From\" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.
", + "SendBulkTemplatedEmailRequest$SourceArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", + "SendBulkTemplatedEmailRequest$ReturnPathArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", "SendBulkTemplatedEmailRequest$TemplateArn": "The ARN of the template to use when sending this email.
", - "SendEmailRequest$SourceArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", - "SendEmailRequest$ReturnPathArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", - "SendRawEmailRequest$FromArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular \"From\" address in the header of the raw email.
Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter.
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter.
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter.
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", - "SendTemplatedEmailRequest$ReturnPathArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", + "SendEmailRequest$SourceArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", + "SendEmailRequest$ReturnPathArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", + "SendRawEmailRequest$FromArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular \"From\" address in the header of the raw email.
Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter.
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter.
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter.
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", + "SendTemplatedEmailRequest$ReturnPathArn": "This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
", "SendTemplatedEmailRequest$TemplateArn": "The ARN of the template to use when sending this email.
", - "StopAction$TopicArn": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
", + "WorkmailAction$TopicArn": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
", + "WorkmailAction$OrganizationArn": "The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format:
arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with \"m-\", followed by a string of alphanumeric characters.
For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.
" } }, "ArrivalDate": { @@ -167,7 +167,7 @@ "base": null, "refs": { "IdentityMailFromDomainAttributes$BehaviorOnMXFailure": "The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.
The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.
The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified error and not send the email.
The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.
The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES returns a MailFromDomainNotVerified error and not send the email.
The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.
When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.
", + "base": "When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.
", "refs": { "ReceiptAction$BounceAction": "Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
" } @@ -207,7 +207,7 @@ } }, "BouncedRecipientInfo": { - "base": "Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
", + "base": "Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
", "refs": { "BouncedRecipientInfoList$member": null } @@ -227,7 +227,7 @@ "BulkEmailDestinationList": { "base": null, "refs": { - "SendBulkTemplatedEmailRequest$Destinations": "One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.
One or more Destination objects. All of the recipients in a Destination receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.
The unique message identifier returned from the SendBulkTemplatedEmail action.
One object per intended recipient. Check each response object and retry any messages with a failure status. (Note that order of responses will be respective to order of destinations in the request.)Receipt rules enable you to specify which actions
" } }, "BulkEmailStatus": { "base": null, "refs": { - "BulkEmailDestinationStatus$Status": "The status of a message sent using the SendBulkTemplatedEmail operation.
Possible values for this parameter include:
Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
MessageRejected: The message was rejected because it contained a virus.
MailFromDomainNotVerified: The sender's email address or domain was not verified.
ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
TemplateDoesNotExist: The template you specified does not exist.
AccountSuspended: Your account has been shut down because of issues related to your email sending practices.
AccountThrottled: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.
AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.
InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not exist.
AccountSendingPaused: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.
ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.
InvalidParameterValue: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.
TransientFailure: Amazon SES was unable to process your request because of a temporary issue.
Failed: Amazon SES was unable to process your request. See the error message for additional information.
The status of a message sent using the SendBulkTemplatedEmail operation.
Possible values for this parameter include:
Success: Amazon SES accepted the message, and attempts to deliver it to the recipients.
MessageRejected: The message was rejected because it contained a virus.
MailFromDomainNotVerified: The sender's email address or domain was not verified.
ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
TemplateDoesNotExist: The template you specified does not exist.
AccountSuspended: Your account has been shut down because of issues related to your email sending practices.
AccountThrottled: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.
AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.
InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not exist.
AccountSendingPaused: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.
ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.
InvalidParameterValue: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.
TransientFailure: Amazon SES was unable to process your request because of a temporary issue.
Failed: Amazon SES was unable to process your request. See the error message for additional information.
A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.
" + "ReceiptIpFilter$Cidr": "A single IP address or a range of IP addresses to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.
" } }, "CloneReceiptRuleSetRequest": { - "base": "Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -276,13 +276,13 @@ } }, "CloudWatchDestination": { - "base": "Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.
Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.
Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { "EventDestination$CloudWatchDestination": "An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
" } }, "CloudWatchDimensionConfiguration": { - "base": "Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.
", + "base": "Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.
", "refs": { "CloudWatchDimensionConfigurations$member": null } @@ -294,7 +294,7 @@ } }, "ConfigurationSet": { - "base": "The name of the configuration set.
Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide.
", + "base": "The name of the configuration set.
Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide.
", "refs": { "ConfigurationSets$member": null, "CreateConfigurationSetRequest$ConfigurationSet": "A data structure that contains the name of the configuration set.
", @@ -334,14 +334,14 @@ "CreateConfigurationSetTrackingOptionsRequest$ConfigurationSetName": "The name of the configuration set that the tracking options should be associated with.
", "DeleteConfigurationSetEventDestinationRequest$ConfigurationSetName": "The name of the configuration set from which to delete the event destination.
", "DeleteConfigurationSetRequest$ConfigurationSetName": "The name of the configuration set to delete.
", - "DeleteConfigurationSetTrackingOptionsRequest$ConfigurationSetName": "The name of the configuration set from which you want to delete the tracking options.
", + "DeleteConfigurationSetTrackingOptionsRequest$ConfigurationSetName": "The name of the configuration set.
", "DescribeConfigurationSetRequest$ConfigurationSetName": "The name of the configuration set to describe.
", "EventDestinationAlreadyExistsException$ConfigurationSetName": "Indicates that the configuration set does not exist.
", "EventDestinationDoesNotExistException$ConfigurationSetName": "Indicates that the configuration set does not exist.
", "InvalidCloudWatchDestinationException$ConfigurationSetName": "Indicates that the configuration set does not exist.
", "InvalidFirehoseDestinationException$ConfigurationSetName": "Indicates that the configuration set does not exist.
", "InvalidSNSDestinationException$ConfigurationSetName": "Indicates that the configuration set does not exist.
", - "PutConfigurationSetDeliveryOptionsRequest$ConfigurationSetName": "The name of the configuration set that you want to specify the delivery options for.
", + "PutConfigurationSetDeliveryOptionsRequest$ConfigurationSetName": "The name of the configuration set.
", "SendBulkTemplatedEmailRequest$ConfigurationSetName": "The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.
Name of a configuration set to use when sending the verification email.
", "SendEmailRequest$ConfigurationSetName": "The name of the configuration set to use when you send an email using SendEmail.
The name of the configuration set to use when you send an email using SendTemplatedEmail.
Indicates that a TrackingOptions object already exists in the specified configuration set.
", "TrackingOptionsDoesNotExistException$ConfigurationSetName": "Indicates that a TrackingOptions object does not exist in the specified configuration set.
", - "UpdateConfigurationSetEventDestinationRequest$ConfigurationSetName": "The name of the configuration set that contains the event destination that you want to update.
", - "UpdateConfigurationSetReputationMetricsEnabledRequest$ConfigurationSetName": "The name of the configuration set that you want to update.
", - "UpdateConfigurationSetSendingEnabledRequest$ConfigurationSetName": "The name of the configuration set that you want to update.
", - "UpdateConfigurationSetTrackingOptionsRequest$ConfigurationSetName": "The name of the configuration set for which you want to update the custom tracking domain.
" + "UpdateConfigurationSetEventDestinationRequest$ConfigurationSetName": "The name of the configuration set that contains the event destination.
", + "UpdateConfigurationSetReputationMetricsEnabledRequest$ConfigurationSetName": "The name of the configuration set to update.
", + "UpdateConfigurationSetSendingEnabledRequest$ConfigurationSetName": "The name of the configuration set to update.
", + "UpdateConfigurationSetTrackingOptionsRequest$ConfigurationSetName": "The name of the configuration set.
" } }, "ConfigurationSetSendingPausedException": { @@ -371,7 +371,7 @@ "refs": { "Body$Text": "The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
", "Body$Html": "The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
", - "Message$Subject": "The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
" + "Message$Subject": "The subject of the message: A short summary of the content, which appears in the recipient's inbox.
" } }, "Counter": { @@ -384,7 +384,7 @@ } }, "CreateConfigurationSetEventDestinationRequest": { - "base": "Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an AWS service in which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an Amazon Web Services service in which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -394,7 +394,7 @@ } }, "CreateConfigurationSetRequest": { - "base": "Represents a request to create a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Represents a request to create a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -419,7 +419,7 @@ } }, "CreateReceiptFilterRequest": { - "base": "Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -429,7 +429,7 @@ } }, "CreateReceiptRuleRequest": { - "base": "Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -439,7 +439,7 @@ } }, "CreateReceiptRuleSetRequest": { - "base": "Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -449,7 +449,7 @@ } }, "CreateTemplateRequest": { - "base": "Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -467,7 +467,7 @@ "CustomRedirectDomain": { "base": null, "refs": { - "TrackingOptions$CustomRedirectDomain": "The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.
" + "TrackingOptions$CustomRedirectDomain": "The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
" } }, "CustomVerificationEmailInvalidContentException": { @@ -500,11 +500,11 @@ "DefaultDimensionValue": { "base": null, "refs": { - "CloudWatchDimensionConfiguration$DefaultDimensionValue": "The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), at signs (@), or periods (.).
Contain 256 characters or fewer.
Represents a request to delete a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Represents a request to delete a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -514,7 +514,7 @@ } }, "DeleteConfigurationSetRequest": { - "base": "Represents a request to delete a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Represents a request to delete a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -539,7 +539,7 @@ } }, "DeleteIdentityPolicyRequest": { - "base": "Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -559,7 +559,7 @@ } }, "DeleteReceiptFilterRequest": { - "base": "Represents a request to delete an IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to delete an IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -569,7 +569,7 @@ } }, "DeleteReceiptRuleRequest": { - "base": "Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -579,7 +579,7 @@ } }, "DeleteReceiptRuleSetRequest": { - "base": "Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -589,7 +589,7 @@ } }, "DeleteTemplateRequest": { - "base": "Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -599,7 +599,7 @@ } }, "DeleteVerifiedEmailAddressRequest": { - "base": "Represents a request to delete an email address from the list of email addresses you have attempted to verify under your AWS account.
", + "base": "Represents a request to delete an email address from the list of email addresses you have attempted to verify under your Amazon Web Services account.
", "refs": { } }, @@ -611,7 +611,7 @@ } }, "DescribeActiveReceiptRuleSetRequest": { - "base": "Represents a request to return the metadata and receipt rules for the receipt rule set that is currently active. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to return the metadata and receipt rules for the receipt rule set that is currently active. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -621,17 +621,17 @@ } }, "DescribeConfigurationSetRequest": { - "base": "Represents a request to return the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Represents a request to return the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { } }, "DescribeConfigurationSetResponse": { - "base": "Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { } }, "DescribeReceiptRuleRequest": { - "base": "Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -641,7 +641,7 @@ } }, "DescribeReceiptRuleSetRequest": { - "base": "Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -651,7 +651,7 @@ } }, "Destination": { - "base": "Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode characters in the \"friendly from\" name, you must encode the \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
The destination for this email, composed of To:, CC:, and BCC: fields.
", @@ -667,13 +667,13 @@ "DimensionName": { "base": null, "refs": { - "CloudWatchDimensionConfiguration$DimensionName": "The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:).
Contain 256 characters or fewer.
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader.
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag.
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.
Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.
", + "GetAccountSendingEnabledResponse$Enabled": "Describes whether email sending is enabled or disabled for your Amazon SES account in the current Amazon Web Services Region.
", "IdentityDkimAttributes$DkimEnabled": "Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is true.
", - "IdentityNotificationAttributes$ForwardingEnabled": "Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce. A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint. A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery. A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications.
Describes whether Amazon SES forwards bounce and complaint notifications as email. true indicates that Amazon SES forwards bounce and complaint notifications as email, while false indicates that bounce and complaint notifications are published only to the specified bounce and complaint Amazon SNS topics.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce. A value of true specifies that Amazon SES includes headers in bounce notifications, and a value of false specifies that Amazon SES does not include headers in bounce notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint. A value of true specifies that Amazon SES includes headers in complaint notifications, and a value of false specifies that Amazon SES does not include headers in complaint notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery. A value of true specifies that Amazon SES includes headers in delivery notifications, and a value of false specifies that Amazon SES does not include headers in delivery notifications.
If true, the receipt rule is active. The default value is false.
If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
Describes whether email sending is enabled or disabled for the configuration set. If the value is true, then Amazon SES will send emails that use the configuration set. If the value is false, Amazon SES will not send emails that use the configuration set. The default value is true. You can change this setting using UpdateConfigurationSetSendingEnabled.
Describes whether email sending is enabled or disabled for the configuration set. If the value is true, then Amazon SES sends emails that use the configuration set. If the value is false, Amazon SES does not send emails that use the configuration set. The default value is true. You can change this setting using UpdateConfigurationSetSendingEnabled.
Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
If the value is true, reputation metrics are published. If the value is false, reputation metrics are not published. The default value is false.
Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.
Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.
Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.
This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.
Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.
", - "UpdateConfigurationSetReputationMetricsEnabledRequest$Enabled": "Describes whether or not Amazon SES will publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
", + "SetIdentityFeedbackForwardingEnabledRequest$ForwardingEnabled": "Sets whether Amazon SES forwards bounce and complaint notifications as email. true specifies that Amazon SES forwards bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES publishes bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.
Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES includes headers in notifications, and a value of false specifies that Amazon SES does not include headers in notifications.
This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.
Describes whether email sending is enabled or disabled for your Amazon SES account in the current Amazon Web Services Region.
", + "UpdateConfigurationSetReputationMetricsEnabledRequest$Enabled": "Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
", "UpdateConfigurationSetSendingEnabledRequest$Enabled": "Describes whether email sending is enabled or disabled for the configuration set.
" } }, @@ -730,11 +730,11 @@ } }, "EventDestination": { - "base": "Contains information about the event destination that the specified email sending events will be published to.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Contains information about an event destination.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { - "CreateConfigurationSetEventDestinationRequest$EventDestination": "An object that describes the AWS service that email sending event information will be published to.
", + "CreateConfigurationSetEventDestinationRequest$EventDestination": "An object that describes the Amazon Web Services service that email sending event where information is published.
", "EventDestinations$member": null, - "UpdateConfigurationSetEventDestinationRequest$EventDestination": "The event destination object that you want to apply to the specified configuration set.
" + "UpdateConfigurationSetEventDestinationRequest$EventDestination": "The event destination object.
" } }, "EventDestinationAlreadyExistsException": { @@ -751,7 +751,7 @@ "base": null, "refs": { "DeleteConfigurationSetEventDestinationRequest$EventDestinationName": "The name of the event destination to delete.
", - "EventDestination$Name": "The name of the event destination. The name must:
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 64 characters.
The name of the event destination. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 64 characters or fewer.
Indicates that the event destination does not exist.
", "EventDestinationDoesNotExistException$EventDestinationName": "Indicates that the event destination does not exist.
", "InvalidCloudWatchDestinationException$EventDestinationName": "Indicates that the event destination does not exist.
", @@ -774,17 +774,17 @@ "EventTypes": { "base": null, "refs": { - "EventDestination$MatchingEventTypes": "The type of email sending events to publish to the event destination.
" + "EventDestination$MatchingEventTypes": "The type of email sending events to publish to the event destination.
send - The call was successful and Amazon SES is attempting to deliver the email.
reject - Amazon SES determined that the email contained a virus and rejected it.
bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce.
complaint - The recipient marked the email as spam.
delivery - Amazon SES successfully delivered the email to the recipient's mail server.
open - The recipient received the email and opened it in their email client.
click - The recipient clicked one or more links in the email.
renderingFailure - Amazon SES did not send the email because of a template rendering issue.
Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.
" + "SendBounceRequest$Explanation": "Human-readable text for the bounce message to explain the failure. If not specified, the text is auto-generated based on the bounced recipient information.
" } }, "ExtensionField": { - "base": "Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
", + "base": "Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
", "refs": { "ExtensionFieldList$member": null } @@ -805,7 +805,7 @@ "ExtensionFieldValue": { "base": null, "refs": { - "ExtensionField$Value": "The value of the header to add. Must be less than 2048 characters, and must not contain newline characters (\"\\r\" or \"\\n\").
" + "ExtensionField$Value": "The value of the header to add. Must contain 2048 characters or fewer, and must not contain newline characters (\"\\r\" or \"\\n\").
" } }, "FailureRedirectionURL": { @@ -833,7 +833,7 @@ } }, "GetAccountSendingEnabledResponse": { - "base": "Represents a request to return the email sending status for your Amazon SES account in the current AWS Region.
", + "base": "Represents a request to return the email sending status for your Amazon SES account in the current Amazon Web Services Region.
", "refs": { } }, @@ -848,7 +848,7 @@ } }, "GetIdentityDkimAttributesRequest": { - "base": "Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.
", + "base": "Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -858,7 +858,7 @@ } }, "GetIdentityMailFromDomainAttributesRequest": { - "base": "Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
", + "base": "Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -868,7 +868,7 @@ } }, "GetIdentityNotificationAttributesRequest": { - "base": "Represents a request to return the notification attributes for a list of identities you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES Developer Guide.
", + "base": "Represents a request to return the notification attributes for a list of identities you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -878,7 +878,7 @@ } }, "GetIdentityPoliciesRequest": { - "base": "Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -888,7 +888,7 @@ } }, "GetIdentityVerificationAttributesRequest": { - "base": "Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.
", + "base": "Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -920,13 +920,13 @@ "HeaderName": { "base": null, "refs": { - "AddHeaderAction$HeaderName": "The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
" + "AddHeaderAction$HeaderName": "The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
" } }, "HeaderValue": { "base": null, "refs": { - "AddHeaderAction$HeaderValue": "Must be less than 2048 characters, and must not contain newline characters (\"\\r\" or \"\\n\").
" + "AddHeaderAction$HeaderValue": "The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\\n) or carriage return (\\r) characters.
The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
", - "DeleteIdentityRequest$Identity": "The identity to be removed from the list of identities for the AWS Account.
", + "DeleteIdentityPolicyRequest$Identity": "The identity that is associated with the policy to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
", + "DeleteIdentityRequest$Identity": "The identity to be removed from the list of identities for the Amazon Web Services account.
", "DkimAttributes$key": null, - "GetIdentityPoliciesRequest$Identity": "The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
", + "GetIdentityPoliciesRequest$Identity": "The identity for which the policies are retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
", "IdentityList$member": null, - "ListIdentityPoliciesRequest$Identity": "The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
", + "ListIdentityPoliciesRequest$Identity": "The identity that is associated with the policy for which the policies are listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
", "MailFromDomainAttributes$key": null, "NotificationAttributes$key": null, - "PutIdentityPolicyRequest$Identity": "The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
", + "PutIdentityPolicyRequest$Identity": "The identity to which that the policy applies. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
", "SetIdentityDkimEnabledRequest$Identity": "The identity for which DKIM signing should be enabled or disabled.
", "SetIdentityFeedbackForwardingEnabledRequest$Identity": "The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com.
The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.
The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
", - "SetIdentityNotificationTopicRequest$Identity": "The identity (email address or domain) that you want to set the Amazon SNS topic for.
You can only specify a verified identity for this parameter.
You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
The verified identity.
", + "SetIdentityNotificationTopicRequest$Identity": "The identity (email address or domain) for the Amazon SNS topic.
You can only specify a verified identity for this parameter.
You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
The type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\". If this parameter is omitted, then all identities will be listed.
" + "ListIdentitiesRequest$IdentityType": "The type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\". If this parameter is omitted, then all identities are listed.
" } }, "IdentityVerificationAttributes": { @@ -1016,7 +1016,7 @@ } }, "InvalidLambdaFunctionException": { - "base": "Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
", + "base": "Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1031,7 +1031,7 @@ } }, "InvalidS3ConfigurationException": { - "base": "Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
", + "base": "Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1058,19 +1058,19 @@ "InvocationType": { "base": null, "refs": { - "LambdaAction$InvocationType": "The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.
There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
The invocation type of the Amazon Web Services Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about Amazon Web Services Lambda invocation types, see the Amazon Web Services Lambda Developer Guide.
There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { "EventDestination$KinesisFirehoseDestination": "An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
" } }, "LambdaAction": { - "base": "When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.
For information about using AWS Lambda actions in receipt rules, see the Amazon SES Developer Guide.
", + "base": "When included in a receipt rule, this action calls an Amazon Web Services Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to call your Amazon Web Services Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.
For information about using Amazon Web Services Lambda actions in receipt rules, see the Amazon SES Developer Guide.
", "refs": { - "ReceiptAction$LambdaAction": "Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
" + "ReceiptAction$LambdaAction": "Calls an Amazon Web Services Lambda function, and optionally, publishes a notification to Amazon SNS.
" } }, "LastAttemptDate": { @@ -1091,17 +1091,17 @@ } }, "ListConfigurationSetsRequest": { - "base": "Represents a request to list the configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Represents a request to list the configuration sets associated with your Amazon Web Services account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { } }, "ListConfigurationSetsResponse": { - "base": "A list of configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "A list of configuration sets associated with your Amazon Web Services account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { } }, "ListCustomVerificationEmailTemplatesRequest": { - "base": "Represents a request to list the existing custom verification email templates for your account.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
", + "base": "Represents a request to list the existing custom verification email templates for your account.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
", "refs": { } }, @@ -1111,17 +1111,17 @@ } }, "ListIdentitiesRequest": { - "base": "Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your AWS account, regardless of verification status.
", + "base": "Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your Amazon Web Services account, regardless of verification status.
", "refs": { } }, "ListIdentitiesResponse": { - "base": "A list of all identities that you have attempted to verify under your AWS account, regardless of verification status.
", + "base": "A list of all identities that you have attempted to verify under your Amazon Web Services account, regardless of verification status.
", "refs": { } }, "ListIdentityPoliciesRequest": { - "base": "Represents a request to return a list of sending authorization policies that are attached to an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to return a list of sending authorization policies that are attached to an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1131,22 +1131,22 @@ } }, "ListReceiptFiltersRequest": { - "base": "Represents a request to list the IP address filters that exist under your AWS account. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to list the IP address filters that exist under your Amazon Web Services account. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, "ListReceiptFiltersResponse": { - "base": "A list of IP address filters that exist under your AWS account.
", + "base": "A list of IP address filters that exist under your Amazon Web Services account.
", "refs": { } }, "ListReceiptRuleSetsRequest": { - "base": "Represents a request to list the receipt rule sets that exist under your AWS account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to list the receipt rule sets that exist under your Amazon Web Services account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, "ListReceiptRuleSetsResponse": { - "base": "A list of receipt rule sets that exist under your AWS account.
", + "base": "A list of receipt rule sets that exist under your Amazon Web Services account.
", "refs": { } }, @@ -1161,7 +1161,7 @@ } }, "ListVerifiedEmailAddressesResponse": { - "base": "A list of email addresses that you have verified with Amazon SES under your AWS account.
", + "base": "A list of email addresses that you have verified with Amazon SES under your Amazon Web Services account.
", "refs": { } }, @@ -1175,7 +1175,7 @@ "base": null, "refs": { "IdentityMailFromDomainAttributes$MailFromDomain": "The custom MAIL FROM domain that the identity is configured to use.
", - "SetIdentityMailFromDomainRequest$MailFromDomain": "The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a \"From\" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.
The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a \"From\" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.
The number of configuration sets to return.
", "ListIdentitiesRequest$MaxItems": "The maximum number of identities per page. Possible values are 1-1000 inclusive.
", - "ListTemplatesRequest$MaxItems": "The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.
" + "ListTemplatesRequest$MaxItems": "The maximum number of templates to return. This value must be at least 1 and less than or equal to 100. If more than 100 items are requested, the page size will automatically set to 100. If you do not specify a value, 10 is the default page size.
" } }, "MaxResults": { "base": null, "refs": { - "ListCustomVerificationEmailTemplatesRequest$MaxResults": "The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation will return up to 50 results.
" + "ListCustomVerificationEmailTemplatesRequest$MaxResults": "The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation returns up to 50 results.
" } }, "MaxSendRate": { @@ -1222,9 +1222,9 @@ } }, "MessageDsn": { - "base": "Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
", + "base": "Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
", "refs": { - "SendBounceRequest$MessageDsn": "Message-related DSN fields. If not specified, Amazon SES will choose the values.
" + "SendBounceRequest$MessageDsn": "Message-related DSN fields. If not specified, Amazon SES chooses the values.
" } }, "MessageId": { @@ -1245,7 +1245,7 @@ } }, "MessageTag": { - "base": "Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { "MessageTagList$member": null } @@ -1263,13 +1263,13 @@ "MessageTagName": { "base": null, "refs": { - "MessageTag$Name": "The name of the tag. The name must:
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
The name of the tag. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 256 characters or fewer.
The value of the tag. The value must:
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
The value of the tag. The value must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 256 characters or fewer.
A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list.
A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time.
A token returned from a previous call to ListTemplates to indicate the position in the list of email templates.
A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 email templates.
A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next set of email templates within your page size.
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
", - "IdentityNotificationAttributes$ComplaintTopic": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
", - "IdentityNotificationAttributes$DeliveryTopic": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
", + "IdentityNotificationAttributes$BounceTopic": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes bounce notifications.
", + "IdentityNotificationAttributes$ComplaintTopic": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes complaint notifications.
", + "IdentityNotificationAttributes$DeliveryTopic": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes delivery notifications.
", "SetIdentityNotificationTopicRequest$SnsTopic": "The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.
The notification type for which to enable or disable headers in notifications.
", - "SetIdentityNotificationTopicRequest$NotificationType": "The type of notifications that will be published to the specified Amazon SNS topic.
" + "SetIdentityNotificationTopicRequest$NotificationType": "The type of notifications that are published to the specified Amazon SNS topic.
" } }, "Policy": { "base": null, "refs": { "PolicyMap$value": null, - "PutIdentityPolicyRequest$Policy": "The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
" + "PutIdentityPolicyRequest$Policy": "The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
" } }, "PolicyMap": { @@ -1359,7 +1359,7 @@ } }, "PutIdentityPolicyRequest": { - "base": "Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1371,17 +1371,17 @@ "RawMessage": { "base": "Represents the raw data of the message.
", "refs": { - "SendRawEmailRequest$RawMessage": "The raw email message itself. The message has to meet the following criteria:
The message has to contain a header and a body, separated by a blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.
The entire message must be base64-encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.
Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.
The raw email message itself. The message has to meet the following criteria:
The message has to contain a header and a body, separated by a blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.
The entire message must be base64-encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.
Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.
The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.
The To:, CC:, and BCC: headers in the raw message can contain a group list.
If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the \"Source,\" \"From,\" and \"Return-Path\" addresses. For more information, see the documentation for SendRawEmail.
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For more information, go to the Amazon SES Developer Guide.
" + "RawMessage$Data": "The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.
The To:, CC:, and BCC: headers in the raw message can contain a group list.
If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the \"Source,\" \"From,\" and \"Return-Path\" addresses. For more information, see the documentation for SendRawEmail.
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For more information, go to the Amazon SES Developer Guide.
" } }, "ReceiptAction": { - "base": "An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
", + "base": "An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
", "refs": { "ReceiptActionsList$member": null } @@ -1393,7 +1393,7 @@ } }, "ReceiptFilter": { - "base": "A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
", + "base": "A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
", "refs": { "CreateReceiptFilterRequest$Filter": "A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.
", "ReceiptFilterList$member": null @@ -1409,7 +1409,7 @@ "base": null, "refs": { "DeleteReceiptFilterRequest$FilterName": "The name of the IP address filter to delete.
", - "ReceiptFilter$Name": "The name of the IP address filter. The name must:
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.
The name of the IP address filter. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain 64 characters or fewer.
A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
", + "base": "A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
", "refs": { "ReceiptFilter$IpFilter": "A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
" } }, "ReceiptRule": { - "base": "Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.
Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
", + "base": "Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.
Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
", "refs": { "CreateReceiptRuleRequest$Rule": "A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
", "DescribeReceiptRuleResponse$Rule": "A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.
", @@ -1436,10 +1436,10 @@ "ReceiptRuleName": { "base": null, "refs": { - "CreateReceiptRuleRequest$After": "The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.
", + "CreateReceiptRuleRequest$After": "The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
", "DeleteReceiptRuleRequest$RuleName": "The name of the receipt rule to delete.
", "DescribeReceiptRuleRequest$RuleName": "The name of the receipt rule.
", - "ReceiptRule$Name": "The name of the receipt rule. The name must:
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.
The name of the receipt rule. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).
Start and end with a letter or number.
Contain 64 characters or fewer.
The name of the receipt rule to reposition.
", "SetReceiptRulePositionRequest$After": "The name of the receipt rule after which to place the specified receipt rule.
" @@ -1448,11 +1448,11 @@ "ReceiptRuleNamesList": { "base": null, "refs": { - "ReorderReceiptRuleSetRequest$RuleNames": "A list of the specified receipt rule set's receipt rules in the order that you want to put them.
" + "ReorderReceiptRuleSetRequest$RuleNames": "The specified receipt rule set's receipt rules, in order.
" } }, "ReceiptRuleSetMetadata": { - "base": "Information about a receipt rule set.
A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
", + "base": "Information about a receipt rule set.
A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
", "refs": { "DescribeActiveReceiptRuleSetResponse$Metadata": "The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.
", "DescribeReceiptRuleSetResponse$Metadata": "The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.
", @@ -1462,15 +1462,15 @@ "ReceiptRuleSetName": { "base": null, "refs": { - "CloneReceiptRuleSetRequest$RuleSetName": "The name of the rule set to create. The name must:
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.
The name of the rule set to create. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain 64 characters or fewer.
The name of the rule set to clone.
", - "CreateReceiptRuleRequest$RuleSetName": "The name of the rule set that the receipt rule will be added to.
", - "CreateReceiptRuleSetRequest$RuleSetName": "The name of the rule set to create. The name must:
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.
The name of the rule set where the receipt rule is added.
", + "CreateReceiptRuleSetRequest$RuleSetName": "The name of the rule set to create. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain 64 characters or fewer.
The name of the receipt rule set that contains the receipt rule to delete.
", "DeleteReceiptRuleSetRequest$RuleSetName": "The name of the receipt rule set to delete.
", "DescribeReceiptRuleRequest$RuleSetName": "The name of the receipt rule set that the receipt rule belongs to.
", "DescribeReceiptRuleSetRequest$RuleSetName": "The name of the receipt rule set to describe.
", - "ReceiptRuleSetMetadata$Name": "The name of the receipt rule set. The name must:
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.
The name of the receipt rule set. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain 64 characters or fewer.
The name of the receipt rule set to reorder.
", "SetActiveReceiptRuleSetRequest$RuleSetName": "The name of the receipt rule set to make active. Setting this value to null disables all email receiving.
", "SetReceiptRulePositionRequest$RuleSetName": "The name of the receipt rule set that contains the receipt rule to reposition.
", @@ -1497,7 +1497,7 @@ } }, "RecipientDsnFields": { - "base": "Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
", + "base": "Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
", "refs": { "BouncedRecipientInfo$RecipientDsnFields": "Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.
The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.
" + "ReceiptRule$Recipients": "The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
" } }, "RemoteMta": { @@ -1521,7 +1521,7 @@ } }, "ReorderReceiptRuleSetRequest": { - "base": "Represents a request to reorder the receipt rules within a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to reorder the receipt rules within a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1562,7 +1562,7 @@ } }, "S3Action": { - "base": "When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.
When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 30 MB. Emails larger than that will bounce.
For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.
", + "base": "When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon Web Services KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about granting permissions, see the Amazon SES Developer Guide.
When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 40 MB. Emails larger than that bounces.
For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.
", "refs": { "ReceiptAction$S3Action": "Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
" } @@ -1571,7 +1571,7 @@ "base": null, "refs": { "InvalidS3ConfigurationException$Bucket": "Indicated that the S3 Bucket was not found.
", - "S3Action$BucketName": "The name of the Amazon S3 bucket that incoming email will be saved to.
" + "S3Action$BucketName": "The name of the Amazon S3 bucket for incoming email.
" } }, "S3KeyPrefix": { @@ -1581,7 +1581,7 @@ } }, "SNSAction": { - "base": "When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.
If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.
You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.
For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.
", + "base": "When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.
If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.
You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.
For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.
", "refs": { "ReceiptAction$SNSAction": "Publishes the email content within a notification to Amazon SNS.
" } @@ -1593,7 +1593,7 @@ } }, "SNSDestination": { - "base": "Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
Event destinations, such as Amazon SNS, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
Event destinations, such as Amazon SNS, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { "EventDestination$SNSDestination": "An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
" } @@ -1609,7 +1609,7 @@ } }, "SendBulkTemplatedEmailRequest": { - "base": "Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1641,7 +1641,7 @@ } }, "SendEmailRequest": { - "base": "Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1651,7 +1651,7 @@ } }, "SendRawEmailRequest": { - "base": "Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1661,7 +1661,7 @@ } }, "SendTemplatedEmailRequest": { - "base": "Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1677,7 +1677,7 @@ } }, "SetActiveReceiptRuleSetRequest": { - "base": "Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1687,7 +1687,7 @@ } }, "SetIdentityDkimEnabledRequest": { - "base": "Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
", + "base": "Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1697,7 +1697,7 @@ } }, "SetIdentityFeedbackForwardingEnabledRequest": { - "base": "Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.
", + "base": "Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1707,7 +1707,7 @@ } }, "SetIdentityHeadersInNotificationsEnabledRequest": { - "base": "Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.
", + "base": "Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1717,7 +1717,7 @@ } }, "SetIdentityMailFromDomainRequest": { - "base": "Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
", + "base": "Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1727,7 +1727,7 @@ } }, "SetIdentityNotificationTopicRequest": { - "base": "Represents a request to specify the Amazon SNS topic to which Amazon SES will publish bounce, complaint, or delivery notifications for emails sent with that identity as the Source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.
", + "base": "Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce, complaint, or delivery notifications for emails sent with that identity as the source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1737,7 +1737,7 @@ } }, "SetReceiptRulePositionRequest": { - "base": "Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1747,7 +1747,7 @@ } }, "StopAction": { - "base": "When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.
", + "base": "When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.
", "refs": { "ReceiptAction$StopAction": "Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
" } @@ -1783,9 +1783,9 @@ } }, "Template": { - "base": "The content of the email, composed of a subject line, an HTML part, and a text-only part.
", + "base": "The content of the email, composed of a subject line and either an HTML part or a text-only part.
", "refs": { - "CreateTemplateRequest$Template": "The content of the email, composed of a subject line, an HTML part, and a text-only part.
", + "CreateTemplateRequest$Template": "The content of the email, composed of a subject line and either an HTML part or a text-only part.
", "GetTemplateResponse$Template": null, "UpdateTemplateRequest$Template": null } @@ -1793,9 +1793,9 @@ "TemplateContent": { "base": null, "refs": { - "CreateCustomVerificationEmailTemplateRequest$TemplateContent": "The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
", + "CreateCustomVerificationEmailTemplateRequest$TemplateContent": "The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
", "GetCustomVerificationEmailTemplateResponse$TemplateContent": "The content of the custom verification email.
", - "UpdateCustomVerificationEmailTemplateRequest$TemplateContent": "The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
" + "UpdateCustomVerificationEmailTemplateRequest$TemplateContent": "The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
" } }, "TemplateData": { @@ -1831,22 +1831,22 @@ "CustomVerificationEmailTemplate$TemplateName": "The name of the custom verification email template.
", "CustomVerificationEmailTemplateAlreadyExistsException$CustomVerificationEmailTemplateName": "Indicates that the provided custom verification email template with the specified template name already exists.
", "CustomVerificationEmailTemplateDoesNotExistException$CustomVerificationEmailTemplateName": "Indicates that the provided custom verification email template does not exist.
", - "DeleteCustomVerificationEmailTemplateRequest$TemplateName": "The name of the custom verification email template that you want to delete.
", + "DeleteCustomVerificationEmailTemplateRequest$TemplateName": "The name of the custom verification email template to delete.
", "DeleteTemplateRequest$TemplateName": "The name of the template to be deleted.
", - "GetCustomVerificationEmailTemplateRequest$TemplateName": "The name of the custom verification email template that you want to retrieve.
", + "GetCustomVerificationEmailTemplateRequest$TemplateName": "The name of the custom verification email template to retrieve.
", "GetCustomVerificationEmailTemplateResponse$TemplateName": "The name of the custom verification email template.
", - "GetTemplateRequest$TemplateName": "The name of the template you want to retrieve.
", + "GetTemplateRequest$TemplateName": "The name of the template to retrieve.
", "InvalidRenderingParameterException$TemplateName": null, "InvalidTemplateException$TemplateName": null, "MissingRenderingAttributeException$TemplateName": null, "SendBulkTemplatedEmailRequest$Template": "The template to use when sending this email.
", "SendCustomVerificationEmailRequest$TemplateName": "The name of the custom verification email template to use when sending the verification email.
", "SendTemplatedEmailRequest$Template": "The template to use when sending this email.
", - "Template$TemplateName": "The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
The name of the template. You use this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
The name of the template.
", - "TestRenderTemplateRequest$TemplateName": "The name of the template that you want to render.
", - "UpdateCustomVerificationEmailTemplateRequest$TemplateName": "The name of the custom verification email template that you want to update.
" + "TestRenderTemplateRequest$TemplateName": "The name of the template to render.
", + "UpdateCustomVerificationEmailTemplateRequest$TemplateName": "The name of the custom verification email template to update.
" } }, "TestRenderTemplateRequest": { @@ -1862,7 +1862,7 @@ "TextPart": { "base": null, "refs": { - "Template$TextPart": "The email body that will be visible to recipients whose email clients do not display HTML.
" + "Template$TextPart": "The email body that is visible to recipients whose email clients do not display HTML content.
" } }, "Timestamp": { @@ -1877,11 +1877,11 @@ "base": null, "refs": { "DeliveryOptions$TlsPolicy": "Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.
For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
", + "base": "A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.
For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
", "refs": { "CreateConfigurationSetTrackingOptionsRequest$TrackingOptions": null, "DescribeConfigurationSetResponse$TrackingOptions": "The name of the custom open and click tracking domain associated with the configuration set.
", @@ -1904,7 +1904,7 @@ } }, "UpdateConfigurationSetEventDestinationRequest": { - "base": "Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", + "base": "Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1939,7 +1939,7 @@ } }, "UpdateReceiptRuleRequest": { - "base": "Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", + "base": "Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1976,18 +1976,18 @@ "refs": { "IdentityVerificationAttributes$VerificationToken": "The verification token for a domain identity. Null for email address identities.
", "VerificationTokenList$member": null, - "VerifyDomainIdentityResponse$VerificationToken": "A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.
As Amazon SES searches for the TXT record, the domain's verification status is \"Pending\". When Amazon SES detects the record, the domain's verification status changes to \"Success\". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to \"Failed.\" In that case, if you still want to verify the domain, you must restart the verification process from the beginning.
" + "VerifyDomainIdentityResponse$VerificationToken": "A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.
As Amazon SES searches for the TXT record, the domain's verification status is \"Pending\". When Amazon SES detects the record, the domain's verification status changes to \"Success\". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to \"Failed.\" In that case, to verify the domain, you must restart the verification process from the beginning. The domain's verification status also changes to \"Success\" when it is DKIM verified.
" } }, "VerificationTokenList": { "base": null, "refs": { - "IdentityDkimAttributes$DkimTokens": "A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
", - "VerifyDomainDkimResponse$DkimTokens": "A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.
Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
" + "IdentityDkimAttributes$DkimTokens": "A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
", + "VerifyDomainDkimResponse$DkimTokens": "A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.
Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
" } }, "VerifyDomainDkimRequest": { - "base": "Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
", + "base": "Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -1997,7 +1997,7 @@ } }, "VerifyDomainIdentityRequest": { - "base": "Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must publish to the DNS server of your domain to complete the verification. For information about domain verification, see the Amazon SES Developer Guide.
", + "base": "Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must publish to the DNS server of your domain to complete the verification. For information about domain verification, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -2007,12 +2007,12 @@ } }, "VerifyEmailAddressRequest": { - "base": "Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.
", + "base": "Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.
", "refs": { } }, "VerifyEmailIdentityRequest": { - "base": "Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.
", + "base": "Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.
", "refs": { } }, @@ -2022,7 +2022,7 @@ } }, "WorkmailAction": { - "base": "When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will typically not use this action directly because Amazon WorkMail adds the rule automatically during its setup procedure.
For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.
", + "base": "When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up manually, because Amazon WorkMail adds the rule automatically during its setup procedure.
For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.
", "refs": { "ReceiptAction$WorkmailAction": "Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
" } diff --git a/models/apis/email/2010-12-01/endpoint-rule-set-1.json b/models/apis/email/2010-12-01/endpoint-rule-set-1.json new file mode 100644 index 00000000000..1d567c5f974 --- /dev/null +++ b/models/apis/email/2010-12-01/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://email-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://email-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://email.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://email.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/email/2010-12-01/endpoint-tests-1.json b/models/apis/email/2010-12-01/endpoint-tests-1.json new file mode 100644 index 00000000000..fa4feb98bdd --- /dev/null +++ b/models/apis/email/2010-12-01/endpoint-tests-1.json @@ -0,0 +1,600 @@ +{ + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://email.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://email.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/glue/2017-03-31/api-2.json b/models/apis/glue/2017-03-31/api-2.json index 5941400d09b..0b68fc18984 100644 --- a/models/apis/glue/2017-03-31/api-2.json +++ b/models/apis/glue/2017-03-31/api-2.json @@ -4933,7 +4933,8 @@ "DisableValueTrimming":{"shape":"NullableBoolean"}, "AllowSingleColumn":{"shape":"NullableBoolean"}, "CustomDatatypeConfigured":{"shape":"NullableBoolean"}, - "CustomDatatypes":{"shape":"CustomDatatypes"} + "CustomDatatypes":{"shape":"CustomDatatypes"}, + "Serde":{"shape":"CsvSerdeOption"} } }, "CreateCustomEntityTypeRequest":{ @@ -5399,7 +5400,8 @@ "DisableValueTrimming":{"shape":"NullableBoolean"}, "AllowSingleColumn":{"shape":"NullableBoolean"}, "CustomDatatypeConfigured":{"shape":"NullableBoolean"}, - "CustomDatatypes":{"shape":"CustomDatatypes"} + "CustomDatatypes":{"shape":"CustomDatatypes"}, + "Serde":{"shape":"CsvSerdeOption"} } }, "CsvColumnDelimiter":{ @@ -5426,6 +5428,14 @@ "min":1, "pattern":"[^\\r\\n]" }, + "CsvSerdeOption":{ + "type":"string", + "enum":[ + "OpenCSVSerDe", + "LazySimpleSerDe", + "None" + ] + }, "CustomCode":{ "type":"structure", "required":[ @@ -12244,7 +12254,8 @@ "DisableValueTrimming":{"shape":"NullableBoolean"}, "AllowSingleColumn":{"shape":"NullableBoolean"}, "CustomDatatypeConfigured":{"shape":"NullableBoolean"}, - "CustomDatatypes":{"shape":"CustomDatatypes"} + "CustomDatatypes":{"shape":"CustomDatatypes"}, + "Serde":{"shape":"CsvSerdeOption"} } }, "UpdateDataQualityRulesetRequest":{ diff --git a/models/apis/glue/2017-03-31/docs-2.json b/models/apis/glue/2017-03-31/docs-2.json index bb25fe3e439..b394da6432d 100644 --- a/models/apis/glue/2017-03-31/docs-2.json +++ b/models/apis/glue/2017-03-31/docs-2.json @@ -1901,6 +1901,14 @@ "UpdateCsvClassifierRequest$QuoteSymbol": "A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
" } }, + "CsvSerdeOption": { + "base": null, + "refs": { + "CreateCsvClassifierRequest$Serde": "Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and None. You can specify the None value when you want the crawler to do the detection.
Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and None. You can specify the None value when you want the crawler to do the detection.
Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and None. You can specify the None value when you want the crawler to do the detection.
Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
", "refs": { diff --git a/models/apis/mediapackage/2017-10-12/api-2.json b/models/apis/mediapackage/2017-10-12/api-2.json index 840b4929fef..15fe43dba48 100644 --- a/models/apis/mediapackage/2017-10-12/api-2.json +++ b/models/apis/mediapackage/2017-10-12/api-2.json @@ -1762,7 +1762,7 @@ }, "Password": { "locationName": "password", - "shape": "__string" + "shape": "SensitiveString" }, "Url": { "locationName": "url", @@ -1770,7 +1770,7 @@ }, "Username": { "locationName": "username", - "shape": "__string" + "shape": "SensitiveString" } }, "type": "structure" @@ -2363,6 +2363,10 @@ ], "type": "string" }, + "SensitiveString": { + "sensitive": true, + "type": "string" + }, "ServiceUnavailableException": { "error": { "httpStatusCode": 503 diff --git a/models/apis/mediapackage/2017-10-12/endpoint-rule-set-1.json b/models/apis/mediapackage/2017-10-12/endpoint-rule-set-1.json index 471664d7912..94f09fea26e 100644 --- a/models/apis/mediapackage/2017-10-12/endpoint-rule-set-1.json +++ b/models/apis/mediapackage/2017-10-12/endpoint-rule-set-1.json @@ -58,52 +58,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -111,13 +115,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -127,224 +140,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://mediapackage-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://mediapackage-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://mediapackage-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://mediapackage-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://mediapackage.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://mediapackage.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://mediapackage.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://mediapackage.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } \ No newline at end of file diff --git a/models/apis/mediapackage/2017-10-12/endpoint-tests-1.json b/models/apis/mediapackage/2017-10-12/endpoint-tests-1.json index 89d130745a4..9d863247b5a 100644 --- a/models/apis/mediapackage/2017-10-12/endpoint-tests-1.json +++ b/models/apis/mediapackage/2017-10-12/endpoint-tests-1.json @@ -351,6 +351,17 @@ "UseDualStack": false } }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -364,6 +375,28 @@ "UseDualStack": false } }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -377,6 +410,17 @@ "UseDualStack": false } }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -440,6 +484,12 @@ "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/models/apis/omics/2022-11-28/api-2.json b/models/apis/omics/2022-11-28/api-2.json index 81d545b2075..2faa0d9de5e 100644 --- a/models/apis/omics/2022-11-28/api-2.json +++ b/models/apis/omics/2022-11-28/api-2.json @@ -55,6 +55,47 @@ "shape": "AbortMultipartReadSetUploadResponse" } }, + "AcceptShare": { + "authtype": "v4", + "endpoint": { + "hostPrefix": "analytics-" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + } + ], + "http": { + "method": "POST", + "requestUri": "/share/{shareId}", + "responseCode": 200 + }, + "input": { + "shape": "AcceptShareRequest" + }, + "name": "AcceptShare", + "output": { + "shape": "AcceptShareResponse" + } + }, "BatchDeleteReadSet": { "authtype": "v4", "endpoint": { @@ -292,6 +333,47 @@ "shape": "CreateAnnotationStoreResponse" } }, + "CreateAnnotationStoreVersion": { + "authtype": "v4", + "endpoint": { + "hostPrefix": "analytics-" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + } + ], + "http": { + "method": "POST", + "requestUri": "/annotationStore/{name}/version", + "responseCode": 200 + }, + "input": { + "shape": "CreateAnnotationStoreVersionRequest" + }, + "name": "CreateAnnotationStoreVersion", + "output": { + "shape": "CreateAnnotationStoreVersionResponse" + } + }, "CreateMultipartReadSetUpload": { "authtype": "v4", "endpoint": { @@ -456,6 +538,47 @@ "shape": "CreateSequenceStoreResponse" } }, + "CreateShare": { + "authtype": "v4", + "endpoint": { + "hostPrefix": "analytics-" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + } + ], + "http": { + "method": "POST", + "requestUri": "/share", + "responseCode": 200 + }, + "input": { + "shape": "CreateShareRequest" + }, + "name": "CreateShare", + "output": { + "shape": "CreateShareResponse" + } + }, "CreateVariantStore": { "authtype": "v4", "endpoint": { @@ -580,6 +703,45 @@ "shape": "DeleteAnnotationStoreResponse" } }, + "DeleteAnnotationStoreVersions": { + "authtype": "v4", + "endpoint": { + "hostPrefix": "analytics-" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + } + ], + "http": { + "method": "POST", + "requestUri": "/annotationStore/{name}/versions/delete", + "responseCode": 200 + }, + "idempotent": true, + "input": { + "shape": "DeleteAnnotationStoreVersionsRequest" + }, + "name": "DeleteAnnotationStoreVersions", + "output": { + "shape": "DeleteAnnotationStoreVersionsResponse" + } + }, "DeleteReference": { "authtype": "v4", "endpoint": { @@ -790,6 +952,48 @@ "shape": "DeleteSequenceStoreResponse" } }, + "DeleteShare": { + "authtype": "v4", + "endpoint": { + "hostPrefix": "analytics-" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + } + ], + "http": { + "method": "DELETE", + "requestUri": "/share/{shareId}", + "responseCode": 200 + }, + "idempotent": true, + "input": { + "shape": "DeleteShareRequest" + }, + "name": "DeleteShare", + "output": { + "shape": "DeleteShareResponse" + } + }, "DeleteVariantStore": { "authtype": "v4", "endpoint": { @@ -941,6 +1145,41 @@ "shape": "GetAnnotationStoreResponse" } }, + "GetAnnotationStoreVersion": { + "authtype": "v4", + "endpoint": { + "hostPrefix": "analytics-" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + } + ], + "http": { + "method": "GET", + "requestUri": "/annotationStore/{name}/version/{versionName}", + "responseCode": 200 + }, + "input": { + "shape": "GetAnnotationStoreVersionRequest" + }, + "name": "GetAnnotationStoreVersion", + "output": { + "shape": "GetAnnotationStoreVersionResponse" + } + }, "GetReadSet": { "authtype": "v4", "endpoint": { @@ -1462,6 +1701,47 @@ "shape": "GetSequenceStoreResponse" } }, + "GetShare": { + "authtype": "v4", + "endpoint": { + "hostPrefix": "analytics-" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + } + ], + "http": { + "method": "GET", + "requestUri": "/share/{shareId}", + "responseCode": 200 + }, + "input": { + "shape": "GetShareRequest" + }, + "name": "GetShare", + "output": { + "shape": "GetShareResponse" + } + }, "GetVariantImportJob": { "authtype": "v4", "endpoint": { @@ -1611,7 +1891,7 @@ "shape": "ListAnnotationImportJobsResponse" } }, - "ListAnnotationStores": { + "ListAnnotationStoreVersions": { "authtype": "v4", "endpoint": { "hostPrefix": "analytics-" @@ -1635,28 +1915,63 @@ ], "http": { "method": "POST", - "requestUri": "/annotationStores", + "requestUri": "/annotationStore/{name}/versions", "responseCode": 200 }, "input": { - "shape": "ListAnnotationStoresRequest" + "shape": "ListAnnotationStoreVersionsRequest" }, - "name": "ListAnnotationStores", + "name": "ListAnnotationStoreVersions", "output": { - "shape": "ListAnnotationStoresResponse" + "shape": "ListAnnotationStoreVersionsResponse" } }, - "ListMultipartReadSetUploads": { + "ListAnnotationStores": { "authtype": "v4", "endpoint": { - "hostPrefix": "control-storage-" + "hostPrefix": "analytics-" }, "errors": [ { "shape": "InternalServerException" }, { - "shape": "NotSupportedOperationException" + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + } + ], + "http": { + "method": "POST", + "requestUri": "/annotationStores", + "responseCode": 200 + }, + "input": { + "shape": "ListAnnotationStoresRequest" + }, + "name": "ListAnnotationStores", + "output": { + "shape": "ListAnnotationStoresResponse" + } + }, + "ListMultipartReadSetUploads": { + "authtype": "v4", + "endpoint": { + "hostPrefix": "control-storage-" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "NotSupportedOperationException" }, { "shape": "ServiceQuotaExceededException" @@ -2164,6 +2479,47 @@ "shape": "ListSequenceStoresResponse" } }, + "ListShares": { + "authtype": "v4", + "endpoint": { + "hostPrefix": "analytics-" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + } + ], + "http": { + "method": "POST", + "requestUri": "/shares", + "responseCode": 200 + }, + "input": { + "shape": "ListSharesRequest" + }, + "name": "ListShares", + "output": { + "shape": "ListSharesResponse" + } + }, "ListTagsForResource": { "authtype": "v4", "endpoint": { @@ -2730,6 +3086,41 @@ "shape": "UpdateAnnotationStoreResponse" } }, + "UpdateAnnotationStoreVersion": { + "authtype": "v4", + "endpoint": { + "hostPrefix": "analytics-" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + } + ], + "http": { + "method": "POST", + "requestUri": "/annotationStore/{name}/version/{versionName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateAnnotationStoreVersionRequest" + }, + "name": "UpdateAnnotationStoreVersion", + "output": { + "shape": "UpdateAnnotationStoreVersionResponse" + } + }, "UpdateRunGroup": { "authtype": "v4", "endpoint": { @@ -2924,6 +3315,27 @@ "min": 1, "type": "string" }, + "AcceptShareRequest": { + "members": { + "shareId": { + "location": "uri", + "locationName": "shareId", + "shape": "String" + } + }, + "required": [ + "shareId" + ], + "type": "structure" + }, + "AcceptShareResponse": { + "members": { + "status": { + "shape": "ShareStatus" + } + }, + "type": "structure" + }, "AccessDeniedException": { "error": { "httpStatusCode": 403, @@ -3104,11 +3516,15 @@ }, "updateTime": { "shape": "UpdateTime" + }, + "versionName": { + "shape": "VersionName" } }, "required": [ "id", "destinationName", + "versionName", "roleArn", "status", "creationTime", @@ -3128,7 +3544,7 @@ "shape": "CreationTime" }, "description": { - "shape": "StoreDescription" + "shape": "Description" }, "id": { "shape": "ResourceId" @@ -3183,6 +3599,63 @@ }, "type": "list" }, + "AnnotationStoreVersionItem": { + "members": { + "creationTime": { + "shape": "CreationTime" + }, + "description": { + "shape": "Description" + }, + "id": { + "shape": "ResourceId" + }, + "name": { + "shape": "StoreName" + }, + "status": { + "shape": "VersionStatus" + }, + "statusMessage": { + "shape": "StatusMessage" + }, + "storeId": { + "shape": "ResourceId" + }, + "updateTime": { + "shape": "UpdateTime" + }, + "versionArn": { + "shape": "Arn" + }, + "versionName": { + "shape": "VersionName" + }, + "versionSizeBytes": { + "shape": "Long" + } + }, + "required": [ + "storeId", + "id", + "status", + "versionArn", + "name", + "versionName", + "description", + "creationTime", + "updateTime", + "statusMessage", + "versionSizeBytes" + ], + "type": "structure" + }, + "AnnotationStoreVersionItems": { + "member": { + "shape": "AnnotationStoreVersionItem" + }, + "type": "list" + }, "AnnotationType": { "enum": [ "GENERIC", @@ -3201,6 +3674,14 @@ "pattern": "arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)", "type": "string" }, + "ArnList": { + "max": 10, + "member": { + "shape": "String" + }, + "min": 1, + "type": "list" + }, "BatchDeleteReadSetRequest": { "members": { "ids": { @@ -3379,10 +3860,10 @@ "CreateAnnotationStoreRequest": { "members": { "description": { - "shape": "StoreDescription" + "shape": "Description" }, "name": { - "shape": "CreateAnnotationStoreRequestNameString" + "shape": "StoreName" }, "reference": { "shape": "ReferenceItem" @@ -3398,6 +3879,9 @@ }, "tags": { "shape": "TagMap" + }, + "versionName": { + "shape": "VersionName" } }, "required": [ @@ -3405,10 +3889,6 @@ ], "type": "structure" }, - "CreateAnnotationStoreRequestNameString": { - "pattern": "([a-z]){1}([a-z0-9_]){2,254}", - "type": "string" - }, "CreateAnnotationStoreResponse": { "members": { "creationTime": { @@ -3431,12 +3911,76 @@ }, "storeOptions": { "shape": "StoreOptions" + }, + "versionName": { + "shape": "VersionName" } }, "required": [ "id", "status", "name", + "versionName", + "creationTime" + ], + "type": "structure" + }, + "CreateAnnotationStoreVersionRequest": { + "members": { + "description": { + "shape": "Description" + }, + "name": { + "location": "uri", + "locationName": "name", + "shape": "StoreName" + }, + "tags": { + "shape": "TagMap" + }, + "versionName": { + "shape": "VersionName" + }, + "versionOptions": { + "shape": "VersionOptions" + } + }, + "required": [ + "name", + "versionName" + ], + "type": "structure" + }, + "CreateAnnotationStoreVersionResponse": { + "members": { + "creationTime": { + "shape": "CreationTime" + }, + "id": { + "shape": "ResourceId" + }, + "name": { + "shape": "StoreName" + }, + "status": { + "shape": "VersionStatus" + }, + "storeId": { + "shape": "ResourceId" + }, + "versionName": { + "shape": "VersionName" + }, + "versionOptions": { + "shape": "VersionOptions" + } + }, + "required": [ + "id", + "versionName", + "storeId", + "name", + "status", "creationTime" ], "type": "structure" @@ -3709,13 +4253,45 @@ ], "type": "structure" }, + "CreateShareRequest": { + "members": { + "principalSubscriber": { + "shape": "String" + }, + "resourceArn": { + "shape": "String" + }, + "shareName": { + "shape": "ShareName" + } + }, + "required": [ + "resourceArn", + "principalSubscriber" + ], + "type": "structure" + }, + "CreateShareResponse": { + "members": { + "shareId": { + "shape": "String" + }, + "shareName": { + "shape": "ShareName" + }, + "status": { + "shape": "ShareStatus" + } + }, + "type": "structure" + }, "CreateVariantStoreRequest": { "members": { "description": { - "shape": "StoreDescription" + "shape": "Description" }, "name": { - "shape": "CreateVariantStoreRequestNameString" + "shape": "StoreName" }, "reference": { "shape": "ReferenceItem" @@ -3732,10 +4308,6 @@ ], "type": "structure" }, - "CreateVariantStoreRequestNameString": { - "pattern": "([a-z]){1}([a-z0-9_]){2,254}", - "type": "string" - }, "CreateVariantStoreResponse": { "members": { "creationTime": { @@ -3867,6 +4439,36 @@ ], "type": "structure" }, + "DeleteAnnotationStoreVersionsRequest": { + "members": { + "force": { + "location": "querystring", + "locationName": "force", + "shape": "PrimitiveBoolean" + }, + "name": { + "location": "uri", + "locationName": "name", + "shape": "String" + }, + "versions": { + "shape": "VersionList" + } + }, + "required": [ + "name", + "versions" + ], + "type": "structure" + }, + "DeleteAnnotationStoreVersionsResponse": { + "members": { + "errors": { + "shape": "VersionDeleteErrorList" + } + }, + "type": "structure" + }, "DeleteReferenceRequest": { "members": { "id": { @@ -3950,6 +4552,27 @@ "members": {}, "type": "structure" }, + "DeleteShareRequest": { + "members": { + "shareId": { + "location": "uri", + "locationName": "shareId", + "shape": "String" + } + }, + "required": [ + "shareId" + ], + "type": "structure" + }, + "DeleteShareResponse": { + "members": { + "status": { + "shape": "ShareStatus" + } + }, + "type": "structure" + }, "DeleteVariantStoreRequest": { "members": { "force": { @@ -3992,6 +4615,11 @@ ], "type": "structure" }, + "Description": { + "max": 500, + "min": 0, + "type": "string" + }, "Encoding": { "max": 20, "min": 1, @@ -4142,6 +4770,17 @@ ], "type": "string" }, + "Filter": { + "members": { + "resourceArns": { + "shape": "ArnList" + }, + "status": { + "shape": "StatusList" + } + }, + "type": "structure" + }, "FormatOptions": { "members": { "tsvOptions": { @@ -4235,11 +4874,15 @@ }, "updateTime": { "shape": "UpdateTime" + }, + "versionName": { + "shape": "VersionName" } }, "required": [ "id", "destinationName", + "versionName", "roleArn", "status", "statusMessage", @@ -4271,7 +4914,7 @@ "shape": "CreationTime" }, "description": { - "shape": "StoreDescription" + "shape": "Description" }, "id": { "shape": "ResourceId" @@ -4279,6 +4922,9 @@ "name": { "shape": "String" }, + "numVersions": { + "shape": "Integer" + }, "reference": { "shape": "ReferenceItem" }, @@ -4314,15 +4960,93 @@ "id", "reference", "status", - "storeArn", + "storeArn", + "name", + "description", + "sseConfig", + "creationTime", + "updateTime", + "tags", + "statusMessage", + "storeSizeBytes", + "numVersions" + ], + "type": "structure" + }, + "GetAnnotationStoreVersionRequest": { + "members": { + "name": { + "location": "uri", + "locationName": "name", + "shape": "String" + }, + "versionName": { + "location": "uri", + "locationName": "versionName", + "shape": "String" + } + }, + "required": [ + "name", + "versionName" + ], + "type": "structure" + }, + "GetAnnotationStoreVersionResponse": { + "members": { + "creationTime": { + "shape": "CreationTime" + }, + "description": { + "shape": "Description" + }, + "id": { + "shape": "ResourceId" + }, + "name": { + "shape": "StoreName" + }, + "status": { + "shape": "VersionStatus" + }, + "statusMessage": { + "shape": "StatusMessage" + }, + "storeId": { + "shape": "ResourceId" + }, + "tags": { + "shape": "TagMap" + }, + "updateTime": { + "shape": "UpdateTime" + }, + "versionArn": { + "shape": "Arn" + }, + "versionName": { + "shape": "VersionName" + }, + "versionOptions": { + "shape": "VersionOptions" + }, + "versionSizeBytes": { + "shape": "Long" + } + }, + "required": [ + "storeId", + "id", + "status", + "versionArn", "name", + "versionName", "description", - "sseConfig", "creationTime", "updateTime", "tags", "statusMessage", - "storeSizeBytes" + "versionSizeBytes" ], "type": "structure" }, @@ -5111,6 +5835,27 @@ ], "type": "structure" }, + "GetShareRequest": { + "members": { + "shareId": { + "location": "uri", + "locationName": "shareId", + "shape": "String" + } + }, + "required": [ + "shareId" + ], + "type": "structure" + }, + "GetShareResponse": { + "members": { + "share": { + "shape": "ShareDetails" + } + }, + "type": "structure" + }, "GetVariantImportRequest": { "members": { "jobId": { @@ -5192,7 +5937,7 @@ "shape": "CreationTime" }, "description": { - "shape": "StoreDescription" + "shape": "Description" }, "id": { "shape": "ResourceId" @@ -5518,6 +6263,10 @@ }, "type": "list" }, + "Integer": { + "box": true, + "type": "integer" + }, "InternalServerException": { "error": { "httpStatusCode": 500 @@ -5624,6 +6373,62 @@ }, "type": "structure" }, + "ListAnnotationStoreVersionsFilter": { + "members": { + "status": { + "shape": "VersionStatus" + } + }, + "type": "structure" + }, + "ListAnnotationStoreVersionsRequest": { + "members": { + "filter": { + "shape": "ListAnnotationStoreVersionsFilter" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "shape": "ListAnnotationStoreVersionsRequestMaxResultsInteger" + }, + "name": { + "location": "uri", + "locationName": "name", + "shape": "String" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken", + "shape": "ListAnnotationStoreVersionsRequestNextTokenString" + } + }, + "required": [ + "name" + ], + "type": "structure" + }, + "ListAnnotationStoreVersionsRequestMaxResultsInteger": { + "box": true, + "max": 100, + "min": 1, + "type": "integer" + }, + "ListAnnotationStoreVersionsRequestNextTokenString": { + "max": 10000, + "min": 1, + "type": "string" + }, + "ListAnnotationStoreVersionsResponse": { + "members": { + "annotationStoreVersions": { + "shape": "AnnotationStoreVersionItems" + }, + "nextToken": { + "shape": "String" + } + }, + "type": "structure" + }, "ListAnnotationStoresFilter": { "members": { "status": { @@ -6245,6 +7050,44 @@ ], "type": "structure" }, + "ListSharesRequest": { + "members": { + "filter": { + "shape": "Filter" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "shape": "Integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken", + "shape": "String" + }, + "resourceOwner": { + "shape": "ResourceOwner" + } + }, + "required": [ + "resourceOwner" + ], + "type": "structure" + }, + "ListSharesResponse": { + "members": { + "nextToken": { + "shape": "String" + }, + "shares": { + "shape": "ShareDetailsList" + } + }, + "required": [ + "shares" + ], + "type": "structure" + }, "ListTagsForResourceRequest": { "members": { "resourceArn": { @@ -7173,6 +8016,13 @@ ], "type": "structure" }, + "ResourceOwner": { + "enum": [ + "SELF", + "OTHER" + ], + "type": "string" + }, "RoleArn": { "max": 2048, "min": 20, @@ -7599,6 +8449,61 @@ ], "type": "structure" }, + "ShareDetails": { + "members": { + "creationTime": { + "shape": "CreationTime" + }, + "ownerId": { + "shape": "String" + }, + "principalSubscriber": { + "shape": "String" + }, + "resourceArn": { + "shape": "String" + }, + "shareId": { + "shape": "String" + }, + "shareName": { + "shape": "ShareName" + }, + "status": { + "shape": "ShareStatus" + }, + "statusMessage": { + "shape": "StatusMessage" + }, + "updateTime": { + "shape": "UpdateTime" + } + }, + "type": "structure" + }, + "ShareDetailsList": { + "member": { + "shape": "ShareDetails" + }, + "type": "list" + }, + "ShareName": { + "max": 256, + "min": 1, + "pattern": "[a-zA-Z0-9_-]+", + "type": "string" + }, + "ShareStatus": { + "enum": [ + "PENDING", + "ACTIVATING", + "ACTIVE", + "DELETING", + "DELETED", + "FAILED" + ], + "type": "string" + }, "SourceFiles": { "members": { "source1": { @@ -7652,6 +8557,9 @@ }, "runLeftNormalization": { "shape": "RunLeftNormalization" + }, + "versionName": { + "shape": "VersionName" } }, "required": [ @@ -8086,16 +8994,17 @@ ], "type": "structure" }, + "StatusList": { + "member": { + "shape": "ShareStatus" + }, + "type": "list" + }, "StatusMessage": { "max": 1000, "min": 0, "type": "string" }, - "StoreDescription": { - "max": 500, - "min": 0, - "type": "string" - }, "StoreFormat": { "enum": [ "GFF", @@ -8359,6 +9268,28 @@ "min": 1, "type": "list" }, + "TsvVersionOptions": { + "members": { + "annotationType": { + "shape": "AnnotationType" + }, + "formatToHeader": { + "shape": "FormatToHeader" + }, + "schema": { + "shape": "TsvVersionOptionsSchemaList" + } + }, + "type": "structure" + }, + "TsvVersionOptionsSchemaList": { + "max": 5000, + "member": { + "shape": "SchemaItem" + }, + "min": 1, + "type": "list" + }, "UntagResourceRequest": { "members": { "resourceArn": { @@ -8385,7 +9316,7 @@ "UpdateAnnotationStoreRequest": { "members": { "description": { - "shape": "StoreDescription" + "shape": "Description" }, "name": { "location": "uri", @@ -8404,7 +9335,7 @@ "shape": "CreationTime" }, "description": { - "shape": "StoreDescription" + "shape": "Description" }, "id": { "shape": "ResourceId" @@ -8439,6 +9370,67 @@ ], "type": "structure" }, + "UpdateAnnotationStoreVersionRequest": { + "members": { + "description": { + "shape": "Description" + }, + "name": { + "location": "uri", + "locationName": "name", + "shape": "String" + }, + "versionName": { + "location": "uri", + "locationName": "versionName", + "shape": "String" + } + }, + "required": [ + "name", + "versionName" + ], + "type": "structure" + }, + "UpdateAnnotationStoreVersionResponse": { + "members": { + "creationTime": { + "shape": "CreationTime" + }, + "description": { + "shape": "Description" + }, + "id": { + "shape": "ResourceId" + }, + "name": { + "shape": "StoreName" + }, + "status": { + "shape": "VersionStatus" + }, + "storeId": { + "shape": "ResourceId" + }, + "updateTime": { + "shape": "UpdateTime" + }, + "versionName": { + "shape": "VersionName" + } + }, + "required": [ + "storeId", + "id", + "status", + "name", + "versionName", + "description", + "creationTime", + "updateTime" + ], + "type": "structure" + }, "UpdateRunGroupRequest": { "members": { "id": { @@ -8498,7 +9490,7 @@ "UpdateVariantStoreRequest": { "members": { "description": { - "shape": "StoreDescription" + "shape": "Description" }, "name": { "location": "uri", @@ -8517,7 +9509,7 @@ "shape": "CreationTime" }, "description": { - "shape": "StoreDescription" + "shape": "Description" }, "id": { "shape": "ResourceId" @@ -8735,7 +9727,7 @@ "shape": "CreationTime" }, "description": { - "shape": "StoreDescription" + "shape": "Description" }, "id": { "shape": "ResourceId" @@ -8797,6 +9789,60 @@ }, "type": "structure" }, + "VersionDeleteError": { + "members": { + "message": { + "shape": "String" + }, + "versionName": { + "shape": "VersionName" + } + }, + "required": [ + "versionName", + "message" + ], + "type": "structure" + }, + "VersionDeleteErrorList": { + "member": { + "shape": "VersionDeleteError" + }, + "type": "list" + }, + "VersionList": { + "max": 10, + "member": { + "shape": "VersionName" + }, + "min": 1, + "type": "list" + }, + "VersionName": { + "max": 255, + "min": 3, + "pattern": "([a-z]){1}([a-z0-9_]){2,254}", + "type": "string" + }, + "VersionOptions": { + "members": { + "tsvVersionOptions": { + "shape": "TsvVersionOptions" + } + }, + "type": "structure", + "union": true + }, + "VersionStatus": { + "enum": [ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE", + "FAILED" + ], + "type": "string" + }, "WorkflowArn": { "max": 128, "min": 1, diff --git a/models/apis/omics/2022-11-28/docs-2.json b/models/apis/omics/2022-11-28/docs-2.json index f798aee0083..b1cc72e4f4a 100644 --- a/models/apis/omics/2022-11-28/docs-2.json +++ b/models/apis/omics/2022-11-28/docs-2.json @@ -3,28 +3,34 @@ "service": "This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.
", "operations": { "AbortMultipartReadSetUpload": "Stops a multipart upload.
", + "AcceptShare": "Accepts a share for an analytics store.
", "BatchDeleteReadSet": "Deletes one or more read sets.
", "CancelAnnotationImportJob": "Cancels an annotation import job.
", "CancelRun": "Cancels a run.
", "CancelVariantImportJob": "Cancels a variant import job.
", "CompleteMultipartReadSetUpload": "Concludes a multipart upload once you have uploaded all the components.
", "CreateAnnotationStore": "Creates an annotation store.
", + "CreateAnnotationStoreVersion": "Creates a new version of an annotation store.
", "CreateMultipartReadSetUpload": "Begins a multipart read set upload.
", "CreateReferenceStore": "Creates a reference store.
", "CreateRunGroup": "Creates a run group.
", "CreateSequenceStore": "Creates a sequence store.
", + "CreateShare": "Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber.
", "CreateVariantStore": "Creates a variant store.
", "CreateWorkflow": "Creates a workflow.
", "DeleteAnnotationStore": "Deletes an annotation store.
", + "DeleteAnnotationStoreVersions": "Deletes one or multiple versions of an annotation store.
", "DeleteReference": "Deletes a genome reference.
", "DeleteReferenceStore": "Deletes a genome reference store.
", "DeleteRun": "Deletes a workflow run.
", "DeleteRunGroup": "Deletes a workflow run group.
", "DeleteSequenceStore": "Deletes a sequence store.
", + "DeleteShare": "Deletes a share of an analytics store.
", "DeleteVariantStore": "Deletes a variant store.
", "DeleteWorkflow": "Deletes a workflow.
", "GetAnnotationImportJob": "Gets information about an annotation import job.
", "GetAnnotationStore": "Gets information about an annotation store.
", + "GetAnnotationStoreVersion": "Retrieves the metadata for an annotation store version.
", "GetReadSet": "Gets a file from a read set.
", "GetReadSetActivationJob": "Gets information about a read set activation job.
", "GetReadSetExportJob": "Gets information about a read set export job.
", @@ -38,10 +44,12 @@ "GetRunGroup": "Gets information about a workflow run group.
", "GetRunTask": "Gets information about a workflow run task.
", "GetSequenceStore": "Gets information about a sequence store.
", + "GetShare": "Retrieves the metadata for a share.
", "GetVariantImportJob": "Gets information about a variant import job.
", "GetVariantStore": "Gets information about a variant store.
", "GetWorkflow": "Gets information about a workflow.
", "ListAnnotationImportJobs": "Retrieves a list of annotation import jobs.
", + "ListAnnotationStoreVersions": "Lists the versions of an annotation store.
", "ListAnnotationStores": "Retrieves a list of annotation stores.
", "ListMultipartReadSetUploads": "Lists all multipart read set uploads and their statuses.
", "ListReadSetActivationJobs": "Retrieves a list of read set activation jobs.
", @@ -56,6 +64,7 @@ "ListRunTasks": "Retrieves a list of tasks for a run.
", "ListRuns": "Retrieves a list of runs.
", "ListSequenceStores": "Retrieves a list of sequence stores.
", + "ListShares": "Lists all shares associated with an account.
", "ListTagsForResource": "Retrieves a list of tags for a resource.
", "ListVariantImportJobs": "Retrieves a list of variant import jobs.
", "ListVariantStores": "Retrieves a list of variant stores.
", @@ -70,6 +79,7 @@ "TagResource": "Tags a resource.
", "UntagResource": "Removes tags from a resource.
", "UpdateAnnotationStore": "Updates an annotation store.
", + "UpdateAnnotationStoreVersion": "Updates the description of an annotation store version.
", "UpdateRunGroup": "Updates a run group.
", "UpdateVariantStore": "Updates a variant store.
", "UpdateWorkflow": "Updates a workflow.
", @@ -94,6 +104,16 @@ "GetWorkflowResponse$accelerators": "The computational accelerator specified to run the workflow.
" } }, + "AcceptShareRequest": { + "base": null, + "refs": { + } + }, + "AcceptShareResponse": { + "base": null, + "refs": { + } + }, "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": { @@ -209,10 +229,23 @@ "ListAnnotationStoresResponse$annotationStores": "A list of stores.
" } }, + "AnnotationStoreVersionItem": { + "base": "Annotation store versions.
", + "refs": { + "AnnotationStoreVersionItems$member": null + } + }, + "AnnotationStoreVersionItems": { + "base": null, + "refs": { + "ListAnnotationStoreVersionsResponse$annotationStoreVersions": "Lists all versions of an annotation store.
" + } + }, "AnnotationType": { "base": null, "refs": { - "TsvStoreOptions$annotationType": "The store's annotation type.
" + "TsvStoreOptions$annotationType": "The store's annotation type.
", + "TsvVersionOptions$annotationType": "The store version's annotation type.
" } }, "Arn": { @@ -220,8 +253,10 @@ "refs": { "AnnotationImportJobItem$roleArn": "The job's service role ARN.
", "AnnotationStoreItem$storeArn": "The store's ARN.
", + "AnnotationStoreVersionItem$versionArn": "The Arn for an annotation store version.
", "GetAnnotationImportResponse$roleArn": "The job's service role ARN.
", "GetAnnotationStoreResponse$storeArn": "The store's ARN.
", + "GetAnnotationStoreVersionResponse$versionArn": "The Arn for the annotation store.
", "GetVariantImportResponse$roleArn": "The job's service role ARN.
", "GetVariantStoreResponse$storeArn": "The store's ARN.
", "StartAnnotationImportRequest$roleArn": "A service role for the job.
", @@ -230,6 +265,12 @@ "VariantStoreItem$storeArn": "The store's ARN.
" } }, + "ArnList": { + "base": null, + "refs": { + "Filter$resourceArns": "The Amazon Resource Number (Arn) for an analytics store.
" + } + }, "BatchDeleteReadSetRequest": { "base": null, "refs": { @@ -344,13 +385,17 @@ "refs": { } }, - "CreateAnnotationStoreRequestNameString": { + "CreateAnnotationStoreResponse": { "base": null, "refs": { - "CreateAnnotationStoreRequest$name": "A name for the store.
" } }, - "CreateAnnotationStoreResponse": { + "CreateAnnotationStoreVersionRequest": { + "base": null, + "refs": { + } + }, + "CreateAnnotationStoreVersionResponse": { "base": null, "refs": { } @@ -419,15 +464,19 @@ "refs": { } }, - "CreateVariantStoreRequest": { + "CreateShareRequest": { + "base": null, + "refs": { + } + }, + "CreateShareResponse": { "base": null, "refs": { } }, - "CreateVariantStoreRequestNameString": { + "CreateVariantStoreRequest": { "base": null, "refs": { - "CreateVariantStoreRequest$name": "A name for the store.
" } }, "CreateVariantStoreResponse": { @@ -456,13 +505,18 @@ "refs": { "AnnotationImportJobItem$creationTime": "When the job was created.
", "AnnotationStoreItem$creationTime": "The store's creation time.
", + "AnnotationStoreVersionItem$creationTime": "The time stamp for when an annotation store version was created.
", "CreateAnnotationStoreResponse$creationTime": "When the store was created.
", + "CreateAnnotationStoreVersionResponse$creationTime": "The time stamp for the creation of an annotation store version.
", "CreateVariantStoreResponse$creationTime": "When the store was created.
", "GetAnnotationImportResponse$creationTime": "When the job was created.
", "GetAnnotationStoreResponse$creationTime": "When the store was created.
", + "GetAnnotationStoreVersionResponse$creationTime": "The time stamp for when an annotation store version was created.
", "GetVariantImportResponse$creationTime": "When the job was created.
", "GetVariantStoreResponse$creationTime": "When the store was created.
", + "ShareDetails$creationTime": "The timestamp for when the share was created.
", "UpdateAnnotationStoreResponse$creationTime": "When the store was created.
", + "UpdateAnnotationStoreVersionResponse$creationTime": "The time stamp for when an annotation store version was created.
", "UpdateVariantStoreResponse$creationTime": "When the store was created.
", "VariantImportJobItem$creationTime": "When the job was created.
", "VariantStoreItem$creationTime": "When the store was created.
" @@ -486,6 +540,16 @@ "refs": { } }, + "DeleteAnnotationStoreVersionsRequest": { + "base": null, + "refs": { + } + }, + "DeleteAnnotationStoreVersionsResponse": { + "base": null, + "refs": { + } + }, "DeleteReferenceRequest": { "base": null, "refs": { @@ -526,6 +590,16 @@ "refs": { } }, + "DeleteShareRequest": { + "base": null, + "refs": { + } + }, + "DeleteShareResponse": { + "base": null, + "refs": { + } + }, "DeleteVariantStoreRequest": { "base": null, "refs": { @@ -541,6 +615,26 @@ "refs": { } }, + "Description": { + "base": null, + "refs": { + "AnnotationStoreItem$description": "The store's description.
", + "AnnotationStoreVersionItem$description": "The description of an annotation store version.
", + "CreateAnnotationStoreRequest$description": "A description for the store.
", + "CreateAnnotationStoreVersionRequest$description": "The description of an annotation store version.
", + "CreateVariantStoreRequest$description": "A description for the store.
", + "GetAnnotationStoreResponse$description": "The store's description.
", + "GetAnnotationStoreVersionResponse$description": "The description for an annotation store version.
", + "GetVariantStoreResponse$description": "The store's description.
", + "UpdateAnnotationStoreRequest$description": "A description for the store.
", + "UpdateAnnotationStoreResponse$description": "The store's description.
", + "UpdateAnnotationStoreVersionRequest$description": "The description of an annotation store.
", + "UpdateAnnotationStoreVersionResponse$description": "The description of an annotation store version.
", + "UpdateVariantStoreRequest$description": "A description for the store.
", + "UpdateVariantStoreResponse$description": "The store's description.
", + "VariantStoreItem$description": "The store's description.
" + } + }, "Encoding": { "base": null, "refs": { @@ -650,6 +744,12 @@ "StartReadSetImportJobSourceItem$sourceFileType": "The source's file type.
" } }, + "Filter": { + "base": "Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.
", + "refs": { + "ListSharesRequest$filter": "Attributes used to filter for a specific subset of shares.
" + } + }, "FormatOptions": { "base": "Formatting options for a file.
", "refs": { @@ -660,7 +760,8 @@ "FormatToHeader": { "base": null, "refs": { - "TsvStoreOptions$formatToHeader": "The store's header key to column name mapping.
" + "TsvStoreOptions$formatToHeader": "The store's header key to column name mapping.
", + "TsvVersionOptions$formatToHeader": "The annotation store version's header key to column name mapping.
" } }, "FormatToHeaderKey": { @@ -707,6 +808,16 @@ "refs": { } }, + "GetAnnotationStoreVersionRequest": { + "base": null, + "refs": { + } + }, + "GetAnnotationStoreVersionResponse": { + "base": null, + "refs": { + } + }, "GetReadSetActivationJobRequest": { "base": null, "refs": { @@ -903,6 +1014,16 @@ "refs": { } }, + "GetShareRequest": { + "base": null, + "refs": { + } + }, + "GetShareResponse": { + "base": null, + "refs": { + } + }, "GetVariantImportRequest": { "base": null, "refs": { @@ -1018,6 +1139,13 @@ "GetReferenceImportJobResponse$sources": "The job's source files.
" } }, + "Integer": { + "base": null, + "refs": { + "GetAnnotationStoreResponse$numVersions": "An integer indicating how many versions of an annotation store exist.
", + "ListSharesRequest$maxResults": "The maximum number of shares to return in one page of results.
" + } + }, "InternalServerException": { "base": "An unexpected error occurred. Try the request again.
", "refs": { @@ -1097,6 +1225,34 @@ "refs": { } }, + "ListAnnotationStoreVersionsFilter": { + "base": "Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.
", + "refs": { + "ListAnnotationStoreVersionsRequest$filter": "A filter to apply to the list of annotation store versions.
" + } + }, + "ListAnnotationStoreVersionsRequest": { + "base": null, + "refs": { + } + }, + "ListAnnotationStoreVersionsRequestMaxResultsInteger": { + "base": null, + "refs": { + "ListAnnotationStoreVersionsRequest$maxResults": "The maximum number of annotation store versions to return in one page of results.
" + } + }, + "ListAnnotationStoreVersionsRequestNextTokenString": { + "base": null, + "refs": { + "ListAnnotationStoreVersionsRequest$nextToken": "Specifies the pagination token from a previous request to retrieve the next page of results.
" + } + }, + "ListAnnotationStoreVersionsResponse": { + "base": null, + "refs": { + } + }, "ListAnnotationStoresFilter": { "base": "A filter for annotation stores.
", "refs": { @@ -1339,6 +1495,16 @@ "refs": { } }, + "ListSharesRequest": { + "base": null, + "refs": { + } + }, + "ListSharesResponse": { + "base": null, + "refs": { + } + }, "ListTagsForResourceRequest": { "base": null, "refs": { @@ -1437,7 +1603,9 @@ "base": null, "refs": { "AnnotationStoreItem$storeSizeBytes": "The store's size in bytes.
", + "AnnotationStoreVersionItem$versionSizeBytes": "The size of an annotation store version in Bytes.
", "GetAnnotationStoreResponse$storeSizeBytes": "The store's size in bytes.
", + "GetAnnotationStoreVersionResponse$versionSizeBytes": "The size of the annotation store version in Bytes.
", "GetVariantStoreResponse$storeSizeBytes": "The store's size in bytes.
", "SequenceInformation$totalReadCount": "The sequence's total read count.
", "SequenceInformation$totalBaseCount": "The sequence's total base count.
", @@ -1498,6 +1666,7 @@ "base": null, "refs": { "DeleteAnnotationStoreRequest$force": "Whether to force deletion.
", + "DeleteAnnotationStoreVersionsRequest$force": "Forces the deletion of an annotation store version when imports are in-progress..
", "DeleteVariantStoreRequest$force": "Whether to force deletion.
" } }, @@ -1931,19 +2100,27 @@ "base": null, "refs": { "AnnotationStoreItem$id": "The store's ID.
", + "AnnotationStoreVersionItem$storeId": "The store ID for an annotation store version.
", + "AnnotationStoreVersionItem$id": "The annotation store version ID.
", "CancelAnnotationImportRequest$jobId": "The job's ID.
", "CancelVariantImportRequest$jobId": "The job's ID.
", "CreateAnnotationStoreResponse$id": "The store's ID.
", + "CreateAnnotationStoreVersionResponse$id": "A generated ID for the annotation store
", + "CreateAnnotationStoreVersionResponse$storeId": "The ID for the annotation store from which new versions are being created.
", "CreateVariantStoreResponse$id": "The store's ID.
", "GetAnnotationImportRequest$jobId": "The job's ID.
", "GetAnnotationImportResponse$id": "The job's ID.
", "GetAnnotationStoreResponse$id": "The store's ID.
", + "GetAnnotationStoreVersionResponse$storeId": "The store ID for annotation store version.
", + "GetAnnotationStoreVersionResponse$id": "The annotation store version ID.
", "GetVariantImportRequest$jobId": "The job's ID.
", "GetVariantImportResponse$id": "The job's ID.
", "GetVariantStoreResponse$id": "The store's ID.
", "StartAnnotationImportResponse$jobId": "The job's ID.
", "StartVariantImportResponse$jobId": "The job's ID.
", "UpdateAnnotationStoreResponse$id": "The store's ID.
", + "UpdateAnnotationStoreVersionResponse$storeId": "The annotation store ID.
", + "UpdateAnnotationStoreVersionResponse$id": "The annotation store version ID.
", "UpdateVariantStoreResponse$id": "The store's ID.
", "VariantStoreItem$id": "The store's ID.
" } @@ -1962,6 +2139,12 @@ "refs": { } }, + "ResourceOwner": { + "base": null, + "refs": { + "ListSharesRequest$resourceOwner": "The account that owns the analytics store shared.
" + } + }, "RoleArn": { "base": null, "refs": { @@ -2276,7 +2459,8 @@ "SchemaItem": { "base": null, "refs": { - "TsvStoreOptionsSchemaList$member": null + "TsvStoreOptionsSchemaList$member": null, + "TsvVersionOptionsSchemaList$member": null } }, "SchemaItemKeyString": { @@ -2396,6 +2580,37 @@ "refs": { } }, + "ShareDetails": { + "base": "The details of a share.
", + "refs": { + "GetShareResponse$share": "An analytic store share details object. contains status, resourceArn, ownerId, etc.
", + "ShareDetailsList$member": null + } + }, + "ShareDetailsList": { + "base": null, + "refs": { + "ListSharesResponse$shares": "The shares available and their meta details.
" + } + }, + "ShareName": { + "base": null, + "refs": { + "CreateShareRequest$shareName": "A name given to the share.
", + "CreateShareResponse$shareName": "A name given to the share.
", + "ShareDetails$shareName": "The name of the share.
" + } + }, + "ShareStatus": { + "base": null, + "refs": { + "AcceptShareResponse$status": "The status of an analytics store share.
", + "CreateShareResponse$status": "The status of a share.
", + "DeleteShareResponse$status": "The status of the share being deleted.
", + "ShareDetails$status": "The status of a share.
", + "StatusList$member": null + } + }, "SourceFiles": { "base": "Source files for a sequence.
", "refs": { @@ -2552,30 +2767,24 @@ "refs": { } }, + "StatusList": { + "base": null, + "refs": { + "Filter$status": "The status of an annotation store version.
" + } + }, "StatusMessage": { "base": null, "refs": { "AnnotationStoreItem$statusMessage": "The store's status message.
", + "AnnotationStoreVersionItem$statusMessage": "The status of an annotation store version.
", "GetAnnotationStoreResponse$statusMessage": "A status message.
", + "GetAnnotationStoreVersionResponse$statusMessage": "The status of an annotation store version.
", "GetVariantStoreResponse$statusMessage": "The store's status message.
", + "ShareDetails$statusMessage": "The status message for a share. It provides more details on the status of the share.
", "VariantStoreItem$statusMessage": "The store's status message.
" } }, - "StoreDescription": { - "base": null, - "refs": { - "AnnotationStoreItem$description": "The store's description.
", - "CreateAnnotationStoreRequest$description": "A description for the store.
", - "CreateVariantStoreRequest$description": "A description for the store.
", - "GetAnnotationStoreResponse$description": "The store's description.
", - "GetVariantStoreResponse$description": "The store's description.
", - "UpdateAnnotationStoreRequest$description": "A description for the store.
", - "UpdateAnnotationStoreResponse$description": "The store's description.
", - "UpdateVariantStoreRequest$description": "A description for the store.
", - "UpdateVariantStoreResponse$description": "The store's description.
", - "VariantStoreItem$description": "The store's description.
" - } - }, "StoreFormat": { "base": null, "refs": { @@ -2589,10 +2798,17 @@ "StoreName": { "base": null, "refs": { + "AnnotationStoreVersionItem$name": "A name given to an annotation store version to distinguish it from others.
", + "CreateAnnotationStoreRequest$name": "A name for the store.
", + "CreateAnnotationStoreVersionRequest$name": "The name of an annotation store version from which versions are being created.
", + "CreateAnnotationStoreVersionResponse$name": "The name given to an annotation store version to distinguish it from other versions.
", + "CreateVariantStoreRequest$name": "A name for the store.
", "GetAnnotationImportResponse$destinationName": "The job's destination annotation store.
", + "GetAnnotationStoreVersionResponse$name": "The name of the annotation store.
", "GetVariantImportResponse$destinationName": "The job's destination variant store.
", "StartAnnotationImportRequest$destinationName": "A destination annotation store for the job.
", - "StartVariantImportRequest$destinationName": "The destination variant store for the job.
" + "StartVariantImportRequest$destinationName": "The destination variant store for the job.
", + "UpdateAnnotationStoreVersionResponse$name": "The name of an annotation store.
" } }, "StoreOptions": { @@ -2624,24 +2840,38 @@ "String": { "base": null, "refs": { + "AcceptShareRequest$shareId": "The ID for a share offer for analytics store data.
", "AccessDeniedException$message": null, "AnnotationImportJobItem$id": "The job's ID.
", "AnnotationImportJobItem$destinationName": "The job's destination annotation store.
", "AnnotationStoreItem$name": "The store's name.
", + "ArnList$member": null, "CompleteReadSetUploadPartListItem$checksum": "A unique identifier used to confirm that parts are being added to the correct upload.
", "ConflictException$message": null, "CreateAnnotationStoreResponse$name": "The store's name.
", + "CreateShareRequest$resourceArn": "The resource ARN for the analytics store to be shared.
", + "CreateShareRequest$principalSubscriber": "The principal subscriber is the account being given access to the analytics store data through the share offer.
", + "CreateShareResponse$shareId": "An ID generated for the share.
", "CreateVariantStoreResponse$name": "The store's name.
", "DeleteAnnotationStoreRequest$name": "The store's name.
", + "DeleteAnnotationStoreVersionsRequest$name": "The name of the annotation store from which versions are being deleted.
", + "DeleteShareRequest$shareId": "The ID for the share request to be deleted.
", "DeleteVariantStoreRequest$name": "The store's name.
", "GetAnnotationStoreRequest$name": "The store's name.
", "GetAnnotationStoreResponse$name": "The store's name.
", + "GetAnnotationStoreVersionRequest$name": "The name given to an annotation store version to distinguish it from others.
", + "GetAnnotationStoreVersionRequest$versionName": "The name given to an annotation store version to distinguish it from others.
", + "GetShareRequest$shareId": "The generated ID for a share.
", "GetVariantStoreRequest$name": "The store's name.
", "GetVariantStoreResponse$name": "The store's name.
", "InternalServerException$message": null, "ListAnnotationImportJobsFilter$storeName": "A store name to filter on.
", "ListAnnotationImportJobsResponse$nextToken": "Specifies the pagination token from a previous request to retrieve the next page of results.
", + "ListAnnotationStoreVersionsRequest$name": "The name of an annotation store.
", + "ListAnnotationStoreVersionsResponse$nextToken": "Specifies the pagination token from a previous request to retrieve the next page of results.
", "ListAnnotationStoresResponse$nextToken": "A pagination token that's included if more results are available.
", + "ListSharesRequest$nextToken": "Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.
", + "ListSharesResponse$nextToken": "Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.
", "ListVariantImportJobsFilter$storeName": "A store name to filter on.
", "ListVariantImportJobsResponse$nextToken": "A pagination token that's included if more results are available.
", "ListVariantStoresResponse$nextToken": "A pagination token that's included if more results are available.
", @@ -2654,16 +2884,23 @@ "ResourceNotFoundException$message": null, "SequenceInformation$alignment": "The sequence's alignment setting.
", "ServiceQuotaExceededException$message": null, + "ShareDetails$shareId": "The ID for a share offer for an analytics store .
", + "ShareDetails$resourceArn": "The resource Arn of the analytics store being shared.
", + "ShareDetails$principalSubscriber": "The principal subscriber is the account the analytics store data is being shared with.
", + "ShareDetails$ownerId": "The account ID for the data owner. The owner creates the share offer.
", "ThrottlingException$message": null, "UpdateAnnotationStoreRequest$name": "A name for the store.
", "UpdateAnnotationStoreResponse$name": "The store's name.
", + "UpdateAnnotationStoreVersionRequest$name": "The name of an annotation store.
", + "UpdateAnnotationStoreVersionRequest$versionName": "The name of an annotation store version.
", "UpdateVariantStoreRequest$name": "A name for the store.
", "UpdateVariantStoreResponse$name": "The store's name.
", "UploadReadSetPartResponse$checksum": "An identifier used to confirm that parts are being added to the intended upload.
", "ValidationException$message": null, "VariantImportJobItem$id": "The job's ID.
", "VariantImportJobItem$destinationName": "The job's destination variant store.
", - "VariantStoreItem$name": "The store's name.
" + "VariantStoreItem$name": "The store's name.
", + "VersionDeleteError$message": "The message explaining the error in annotation store deletion.
" } }, "SubjectId": { @@ -2764,6 +3001,7 @@ "base": null, "refs": { "CreateAnnotationStoreRequest$tags": "Tags for the store.
", + "CreateAnnotationStoreVersionRequest$tags": "Any tags added to annotation store version.
", "CreateMultipartReadSetUploadRequest$tags": "Any tags to add to the read set.
", "CreateMultipartReadSetUploadResponse$tags": "The tags to add to the read set.
", "CreateReferenceStoreRequest$tags": "Tags for the store.
", @@ -2774,6 +3012,7 @@ "CreateWorkflowRequest$tags": "Tags for the workflow.
", "CreateWorkflowResponse$tags": "The workflow's tags.
", "GetAnnotationStoreResponse$tags": "The store's tags.
", + "GetAnnotationStoreVersionResponse$tags": "Any tags associated with an annotation store version.
", "GetRunGroupResponse$tags": "The group's tags.
", "GetRunResponse$tags": "The run's tags.
", "GetVariantStoreResponse$tags": "The store's tags.
", @@ -2924,6 +3163,18 @@ "TsvStoreOptions$schema": "The store's schema.
" } }, + "TsvVersionOptions": { + "base": "The options for a TSV file.
", + "refs": { + "VersionOptions$tsvVersionOptions": "File settings for a version of a TSV store.
" + } + }, + "TsvVersionOptionsSchemaList": { + "base": null, + "refs": { + "TsvVersionOptions$schema": "The TSV schema for an annotation store version.
" + } + }, "UntagResourceRequest": { "base": null, "refs": { @@ -2944,6 +3195,16 @@ "refs": { } }, + "UpdateAnnotationStoreVersionRequest": { + "base": null, + "refs": { + } + }, + "UpdateAnnotationStoreVersionResponse": { + "base": null, + "refs": { + } + }, "UpdateRunGroupRequest": { "base": null, "refs": { @@ -2978,11 +3239,15 @@ "refs": { "AnnotationImportJobItem$updateTime": "When the job was updated.
", "AnnotationStoreItem$updateTime": "When the store was updated.
", + "AnnotationStoreVersionItem$updateTime": "The time stamp for when an annotation store version was updated.
", "GetAnnotationImportResponse$updateTime": "When the job was updated.
", "GetAnnotationStoreResponse$updateTime": "When the store was updated.
", + "GetAnnotationStoreVersionResponse$updateTime": "The time stamp for when an annotation store version was updated.
", "GetVariantImportResponse$updateTime": "When the job was updated.
", "GetVariantStoreResponse$updateTime": "When the store was updated.
", + "ShareDetails$updateTime": "The timestamp of the share update.
", "UpdateAnnotationStoreResponse$updateTime": "When the store was updated.
", + "UpdateAnnotationStoreVersionResponse$updateTime": "The time stamp for when an annotation store version was updated.
", "UpdateVariantStoreResponse$updateTime": "When the store was updated.
", "VariantImportJobItem$updateTime": "When the job was updated.
", "VariantStoreItem$updateTime": "When the store was updated.
" @@ -3089,6 +3354,59 @@ "FormatOptions$vcfOptions": "Options for a VCF file.
" } }, + "VersionDeleteError": { + "base": "The error preventing deletion of the annotation store version.
", + "refs": { + "VersionDeleteErrorList$member": null + } + }, + "VersionDeleteErrorList": { + "base": null, + "refs": { + "DeleteAnnotationStoreVersionsResponse$errors": "Any errors that occur when attempting to delete an annotation store version.
" + } + }, + "VersionList": { + "base": null, + "refs": { + "DeleteAnnotationStoreVersionsRequest$versions": "The versions of an annotation store to be deleted.
" + } + }, + "VersionName": { + "base": null, + "refs": { + "AnnotationImportJobItem$versionName": "The name of the annotation store version.
", + "AnnotationStoreVersionItem$versionName": "The name of an annotation store version.
", + "CreateAnnotationStoreRequest$versionName": "The name given to an annotation store version to distinguish it from other versions.
", + "CreateAnnotationStoreResponse$versionName": "The name given to an annotation store version to distinguish it from other versions.
", + "CreateAnnotationStoreVersionRequest$versionName": "The name given to an annotation store version to distinguish it from other versions.
", + "CreateAnnotationStoreVersionResponse$versionName": "The name given to an annotation store version to distinguish it from other versions.
", + "GetAnnotationImportResponse$versionName": "The name of the annotation store version.
", + "GetAnnotationStoreVersionResponse$versionName": "The name given to an annotation store version to distinguish it from others.
", + "StartAnnotationImportRequest$versionName": "The name of the annotation store version.
", + "UpdateAnnotationStoreVersionResponse$versionName": "The name of an annotation store version.
", + "VersionDeleteError$versionName": "The name given to an annotation store version.
", + "VersionList$member": null + } + }, + "VersionOptions": { + "base": "The options for an annotation store version.
", + "refs": { + "CreateAnnotationStoreVersionRequest$versionOptions": "The options for an annotation store version.
", + "CreateAnnotationStoreVersionResponse$versionOptions": "The options for an annotation store version.
", + "GetAnnotationStoreVersionResponse$versionOptions": "The options for an annotation store version.
" + } + }, + "VersionStatus": { + "base": null, + "refs": { + "AnnotationStoreVersionItem$status": "The status of an annotation store version.
", + "CreateAnnotationStoreVersionResponse$status": "The status of a annotation store version.
", + "GetAnnotationStoreVersionResponse$status": "The status of an annotation store version.
", + "ListAnnotationStoreVersionsFilter$status": "The status of an annotation store version.
", + "UpdateAnnotationStoreVersionResponse$status": "The status of an annotation store version.
" + } + }, "WorkflowArn": { "base": null, "refs": { diff --git a/models/apis/omics/2022-11-28/paginators-1.json b/models/apis/omics/2022-11-28/paginators-1.json index 596e4bd7c24..0254c8f78fa 100644 --- a/models/apis/omics/2022-11-28/paginators-1.json +++ b/models/apis/omics/2022-11-28/paginators-1.json @@ -6,6 +6,12 @@ "limit_key": "maxResults", "result_key": "annotationImportJobs" }, + "ListAnnotationStoreVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "annotationStoreVersions" + }, "ListAnnotationStores": { "input_token": "nextToken", "output_token": "nextToken", @@ -90,6 +96,12 @@ "limit_key": "maxResults", "result_key": "sequenceStores" }, + "ListShares": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "shares" + }, "ListVariantImportJobs": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/models/apis/omics/2022-11-28/waiters-2.json b/models/apis/omics/2022-11-28/waiters-2.json index db1de32eedd..9e82e101dcb 100644 --- a/models/apis/omics/2022-11-28/waiters-2.json +++ b/models/apis/omics/2022-11-28/waiters-2.json @@ -81,6 +81,54 @@ "expected" : "DELETING" } ] }, + "AnnotationStoreVersionCreated" : { + "description" : "Wait until an annotation store version is created", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetAnnotationStoreVersion", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "ACTIVE" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "CREATING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "UPDATING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + } ] + }, + "AnnotationStoreVersionDeleted" : { + "description" : "Wait until an annotation store version is deleted.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetAnnotationStoreVersion", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "DELETED" + }, { + "matcher" : "error", + "state" : "success", + "expected" : "ResourceNotFoundException" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "DELETING" + } ] + }, "ReadSetActivationJobCompleted" : { "description" : "Wait until a job is completed.", "delay" : 30, diff --git a/models/apis/pi/2018-02-27/api-2.json b/models/apis/pi/2018-02-27/api-2.json index 199ffe2e37d..e30c4b44b48 100644 --- a/models/apis/pi/2018-02-27/api-2.json +++ b/models/apis/pi/2018-02-27/api-2.json @@ -14,6 +14,34 @@ "uid":"pi-2018-02-27" }, "operations":{ + "CreatePerformanceAnalysisReport":{ + "name":"CreatePerformanceAnalysisReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePerformanceAnalysisReportRequest"}, + "output":{"shape":"CreatePerformanceAnalysisReportResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ] + }, + "DeletePerformanceAnalysisReport":{ + "name":"DeletePerformanceAnalysisReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePerformanceAnalysisReportRequest"}, + "output":{"shape":"DeletePerformanceAnalysisReportResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ] + }, "DescribeDimensionKeys":{ "name":"DescribeDimensionKeys", "http":{ @@ -42,6 +70,20 @@ {"shape":"NotAuthorizedException"} ] }, + "GetPerformanceAnalysisReport":{ + "name":"GetPerformanceAnalysisReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPerformanceAnalysisReportRequest"}, + "output":{"shape":"GetPerformanceAnalysisReportResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ] + }, "GetResourceMetadata":{ "name":"GetResourceMetadata", "http":{ @@ -97,9 +139,69 @@ {"shape":"InternalServiceError"}, {"shape":"NotAuthorizedException"} ] + }, + "ListPerformanceAnalysisReports":{ + "name":"ListPerformanceAnalysisReports", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPerformanceAnalysisReportsRequest"}, + "output":{"shape":"ListPerformanceAnalysisReportsResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ] } }, "shapes":{ + "AcceptLanguage":{ + "type":"string", + "enum":["EN_US"] + }, "AdditionalMetricsList":{ "type":"list", "member":{"shape":"RequestString"}, @@ -111,6 +213,95 @@ "key":{"shape":"RequestString"}, "value":{"shape":"Double"} }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^arn:.*:pi:.*$" + }, + "AnalysisReport":{ + "type":"structure", + "required":["AnalysisReportId"], + "members":{ + "AnalysisReportId":{"shape":"AnalysisReportId"}, + "Identifier":{"shape":"IdentifierString"}, + "ServiceType":{"shape":"ServiceType"}, + "CreateTime":{"shape":"ISOTimestamp"}, + "StartTime":{"shape":"ISOTimestamp"}, + "EndTime":{"shape":"ISOTimestamp"}, + "Status":{"shape":"AnalysisStatus"}, + "Insights":{"shape":"InsightList"} + } + }, + "AnalysisReportId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"report-[0-9a-f]{17}" + }, + "AnalysisReportSummary":{ + "type":"structure", + "members":{ + "AnalysisReportId":{"shape":"String"}, + "CreateTime":{"shape":"ISOTimestamp"}, + "StartTime":{"shape":"ISOTimestamp"}, + "EndTime":{"shape":"ISOTimestamp"}, + "Status":{"shape":"AnalysisStatus"}, + "Tags":{"shape":"TagList"} + } + }, + "AnalysisReportSummaryList":{ + "type":"list", + "member":{"shape":"AnalysisReportSummary"} + }, + "AnalysisStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "SUCCEEDED", + "FAILED" + ] + }, + "Boolean":{"type":"boolean"}, + "ContextType":{ + "type":"string", + "enum":[ + "CAUSAL", + "CONTEXTUAL" + ] + }, + "CreatePerformanceAnalysisReportRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "Identifier", + "StartTime", + "EndTime" + ], + "members":{ + "ServiceType":{"shape":"ServiceType"}, + "Identifier":{"shape":"IdentifierString"}, + "StartTime":{"shape":"ISOTimestamp"}, + "EndTime":{"shape":"ISOTimestamp"}, + "Tags":{"shape":"TagList"} + } + }, + "CreatePerformanceAnalysisReportResponse":{ + "type":"structure", + "members":{ + "AnalysisReportId":{"shape":"AnalysisReportId"} + } + }, + "Data":{ + "type":"structure", + "members":{ + "PerformanceInsightsMetric":{"shape":"PerformanceInsightsMetric"} + } + }, + "DataList":{ + "type":"list", + "member":{"shape":"Data"} + }, "DataPoint":{ "type":"structure", "required":[ @@ -126,6 +317,24 @@ "type":"list", "member":{"shape":"DataPoint"} }, + "DeletePerformanceAnalysisReportRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "Identifier", + "AnalysisReportId" + ], + "members":{ + "ServiceType":{"shape":"ServiceType"}, + "Identifier":{"shape":"IdentifierString"}, + "AnalysisReportId":{"shape":"AnalysisReportId"} + } + }, + "DeletePerformanceAnalysisReportResponse":{ + "type":"structure", + "members":{ + } + }, "DescribeDimensionKeysRequest":{ "type":"structure", "required":[ @@ -138,7 +347,7 @@ ], "members":{ "ServiceType":{"shape":"ServiceType"}, - "Identifier":{"shape":"RequestString"}, + "Identifier":{"shape":"IdentifierString"}, "StartTime":{"shape":"ISOTimestamp"}, "EndTime":{"shape":"ISOTimestamp"}, "Metric":{"shape":"RequestString"}, @@ -166,6 +375,17 @@ "max":2048, "min":1 }, + "DescriptiveMap":{ + "type":"map", + "key":{"shape":"DescriptiveString"}, + "value":{"shape":"DescriptiveString"} + }, + "DescriptiveString":{ + "type":"string", + "max":2000, + "min":1, + "pattern":"^.*$" + }, "DetailStatus":{ "type":"string", "enum":[ @@ -286,6 +506,27 @@ "Dimensions":{"shape":"DimensionKeyDetailList"} } }, + "GetPerformanceAnalysisReportRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "Identifier", + "AnalysisReportId" + ], + "members":{ + "ServiceType":{"shape":"ServiceType"}, + "Identifier":{"shape":"IdentifierString"}, + "AnalysisReportId":{"shape":"AnalysisReportId"}, + "TextFormat":{"shape":"TextFormat"}, + "AcceptLanguage":{"shape":"AcceptLanguage"} + } + }, + "GetPerformanceAnalysisReportResponse":{ + "type":"structure", + "members":{ + "AnalysisReport":{"shape":"AnalysisReport"} + } + }, "GetResourceMetadataRequest":{ "type":"structure", "required":[ @@ -294,7 +535,7 @@ ], "members":{ "ServiceType":{"shape":"ServiceType"}, - "Identifier":{"shape":"RequestString"} + "Identifier":{"shape":"IdentifierString"} } }, "GetResourceMetadataResponse":{ @@ -315,7 +556,7 @@ ], "members":{ "ServiceType":{"shape":"ServiceType"}, - "Identifier":{"shape":"RequestString"}, + "Identifier":{"shape":"IdentifierString"}, "MetricQueries":{"shape":"MetricQueryList"}, "StartTime":{"shape":"ISOTimestamp"}, "EndTime":{"shape":"ISOTimestamp"}, @@ -340,7 +581,28 @@ "type":"string", "max":256, "min":0, - "pattern":"^db-[a-zA-Z0-9-]*$" + "pattern":"^[a-zA-Z0-9-]+$" + }, + "Insight":{ + "type":"structure", + "required":["InsightId"], + "members":{ + "InsightId":{"shape":"String"}, + "InsightType":{"shape":"String"}, + "Context":{"shape":"ContextType"}, + "StartTime":{"shape":"ISOTimestamp"}, + "EndTime":{"shape":"ISOTimestamp"}, + "Severity":{"shape":"Severity"}, + "SupportingInsights":{"shape":"InsightList"}, + "Description":{"shape":"MarkdownString"}, + "Recommendations":{"shape":"RecommendationList"}, + "InsightData":{"shape":"DataList"}, + "BaselineData":{"shape":"DataList"} + } + }, + "InsightList":{ + "type":"list", + "member":{"shape":"Insight"} }, "Integer":{"type":"integer"}, "InternalServiceError":{ @@ -372,7 +634,7 @@ ], "members":{ "ServiceType":{"shape":"ServiceType"}, - "Identifier":{"shape":"RequestString"}, + "Identifier":{"shape":"IdentifierString"}, "Metrics":{"shape":"DimensionsMetricList"}, "MaxResults":{"shape":"MaxResults"}, "NextToken":{"shape":"NextToken"} @@ -394,7 +656,7 @@ ], "members":{ "ServiceType":{"shape":"ServiceType"}, - "Identifier":{"shape":"RequestString"}, + "Identifier":{"shape":"IdentifierString"}, "MetricTypes":{"shape":"MetricTypeList"}, "NextToken":{"shape":"NextToken"}, "MaxResults":{"shape":"MaxResults"} @@ -407,6 +669,51 @@ "NextToken":{"shape":"NextToken"} } }, + "ListPerformanceAnalysisReportsRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "Identifier" + ], + "members":{ + "ServiceType":{"shape":"ServiceType"}, + "Identifier":{"shape":"IdentifierString"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "ListTags":{"shape":"Boolean"} + } + }, + "ListPerformanceAnalysisReportsResponse":{ + "type":"structure", + "members":{ + "AnalysisReports":{"shape":"AnalysisReportSummaryList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "ResourceARN" + ], + "members":{ + "ServiceType":{"shape":"ServiceType"}, + "ResourceARN":{"shape":"AmazonResourceName"} + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{"shape":"TagList"} + } + }, + "MarkdownString":{ + "type":"string", + "max":8000, + "min":0, + "pattern":"(.|\\n)*", + "sensitive":true + }, "MaxResults":{ "type":"integer", "max":25, @@ -466,7 +773,7 @@ "type":"string", "max":8192, "min":1, - "pattern":"[\\s\\S]*" + "pattern":"^[a-zA-Z0-9_=-]+$" }, "NotAuthorizedException":{ "type":"structure", @@ -475,6 +782,15 @@ }, "exception":true }, + "PerformanceInsightsMetric":{ + "type":"structure", + "members":{ + "Metric":{"shape":"DescriptiveString"}, + "DisplayName":{"shape":"DescriptiveString"}, + "Dimensions":{"shape":"DescriptiveMap"}, + "Value":{"shape":"Double"} + } + }, "PeriodAlignment":{ "type":"string", "enum":[ @@ -482,6 +798,17 @@ "START_TIME" ] }, + "Recommendation":{ + "type":"structure", + "members":{ + "RecommendationId":{"shape":"String"}, + "RecommendationDescription":{"shape":"MarkdownString"} + } + }, + "RecommendationList":{ + "type":"list", + "member":{"shape":"Recommendation"} + }, "RequestString":{ "type":"string", "max":256, @@ -538,11 +865,97 @@ "DOCDB" ] }, + "Severity":{ + "type":"string", + "enum":[ + "LOW", + "MEDIUM", + "HIGH" + ] + }, "String":{ "type":"string", "max":256, "min":0, "pattern":".*\\S.*" + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^.*$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "ResourceARN", + "Tags" + ], + "members":{ + "ServiceType":{"shape":"ServiceType"}, + "ResourceARN":{"shape":"AmazonResourceName"}, + "Tags":{"shape":"TagList"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^.*$" + }, + "TextFormat":{ + "type":"string", + "enum":[ + "PLAIN_TEXT", + "MARKDOWN" + ] + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "ResourceARN", + "TagKeys" + ], + "members":{ + "ServiceType":{"shape":"ServiceType"}, + "ResourceARN":{"shape":"AmazonResourceName"}, + "TagKeys":{"shape":"TagKeyList"} + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } } } } diff --git a/models/apis/pi/2018-02-27/docs-2.json b/models/apis/pi/2018-02-27/docs-2.json index 328bb1c5fd5..5687cc097e3 100644 --- a/models/apis/pi/2018-02-27/docs-2.json +++ b/models/apis/pi/2018-02-27/docs-2.json @@ -2,14 +2,27 @@ "version": "2.0", "service": "Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.
When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.
DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide .
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide .
To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide .
Creates a new performance analysis report for a specific time period for the DB instance.
", + "DeletePerformanceAnalysisReport": "Deletes a performance analysis report.
", "DescribeDimensionKeys": "For a specific time period, retrieve the top N dimension keys for a metric.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.
Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.
Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
", "GetResourceMetrics": "Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
", - "ListAvailableResourceMetrics": "Retrieve metrics of the specified types that can be queried for a specified DB instance.
" + "ListAvailableResourceMetrics": "Retrieve metrics of the specified types that can be queried for a specified DB instance.
", + "ListPerformanceAnalysisReports": "Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
", + "ListTagsForResource": "Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
", + "TagResource": "Adds metadata tags to the Amazon RDS Performance Insights resource.
", + "UntagResource": "Deletes the metadata tags from the Amazon RDS Performance Insights resource.
" }, "shapes": { + "AcceptLanguage": { + "base": null, + "refs": { + "GetPerformanceAnalysisReportRequest$AcceptLanguage": "The text language in the report. The default language is EN_US (English).
A map that contains the value for each additional metric.
" } }, + "AmazonResourceName": { + "base": null, + "refs": { + "ListTagsForResourceRequest$ResourceARN": "Lists all the tags for the Amazon RDS Performance Insights resource. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "TagResourceRequest$ResourceARN": "The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "UntagResourceRequest$ResourceARN": "The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
" + } + }, + "AnalysisReport": { + "base": "Retrieves the summary of the performance analysis report created for a time period.
", + "refs": { + "GetPerformanceAnalysisReportResponse$AnalysisReport": "The summary of the performance analysis report created for a time period.
" + } + }, + "AnalysisReportId": { + "base": null, + "refs": { + "AnalysisReport$AnalysisReportId": "The name of the analysis report.
", + "CreatePerformanceAnalysisReportResponse$AnalysisReportId": "A unique identifier for the created analysis report.
", + "DeletePerformanceAnalysisReportRequest$AnalysisReportId": "The unique identifier of the analysis report for deletion.
", + "GetPerformanceAnalysisReportRequest$AnalysisReportId": "A unique identifier of the created analysis report. For example, report-12345678901234567
Retrieves the details of the performance analysis report.
", + "refs": { + "AnalysisReportSummaryList$member": null + } + }, + "AnalysisReportSummaryList": { + "base": null, + "refs": { + "ListPerformanceAnalysisReportsResponse$AnalysisReports": "List of reports including the report identifier, start and end time, creation time, and status.
" + } + }, + "AnalysisStatus": { + "base": null, + "refs": { + "AnalysisReport$Status": "The status of the created analysis report.
", + "AnalysisReportSummary$Status": "The status of the analysis report.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "ListPerformanceAnalysisReportsRequest$ListTags": "Specifies whether or not to include the list of tags in the response.
" + } + }, + "ContextType": { + "base": null, + "refs": { + "Insight$Context": "Indicates if the insight is causal or correlated insight.
" + } + }, + "CreatePerformanceAnalysisReportRequest": { + "base": null, + "refs": { + } + }, + "CreatePerformanceAnalysisReportResponse": { + "base": null, + "refs": { + } + }, + "Data": { + "base": "List of data objects which provide details about source metrics. This field can be used to determine the PI metric to render for the insight. This data type also includes static values for the metrics for the Insight that were calculated and included in text and annotations on the DB load chart.
", + "refs": { + "DataList$member": null + } + }, + "DataList": { + "base": null, + "refs": { + "Insight$InsightData": "List of data objects containing metrics and references from the time range while generating the insight.
", + "Insight$BaselineData": "Metric names and values from the timeframe used as baseline to generate the insight.
" + } + }, "DataPoint": { "base": "A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.
", "refs": { @@ -34,6 +124,16 @@ "MetricKeyDataPoints$DataPoints": "An array of timestamp-value pairs, representing measurements over a period of time.
" } }, + "DeletePerformanceAnalysisReportRequest": { + "base": null, + "refs": { + } + }, + "DeletePerformanceAnalysisReportResponse": { + "base": null, + "refs": { + } + }, "DescribeDimensionKeysRequest": { "base": null, "refs": { @@ -50,6 +150,21 @@ "ResponseResourceMetric$Description": "The description of the metric.
" } }, + "DescriptiveMap": { + "base": null, + "refs": { + "PerformanceInsightsMetric$Dimensions": "A dimension map that contains the dimensions for this partition.
" + } + }, + "DescriptiveString": { + "base": null, + "refs": { + "DescriptiveMap$key": null, + "DescriptiveMap$value": null, + "PerformanceInsightsMetric$Metric": "The Performance Insights metric.
", + "PerformanceInsightsMetric$DisplayName": "The Performance Insights metric name.
" + } + }, "DetailStatus": { "base": null, "refs": { @@ -132,7 +247,8 @@ "AdditionalMetricsMap$value": null, "DataPoint$Value": "The actual value associated with a particular Timestamp.
The aggregated metric value for the dimensions, over the requested time range.
", - "MetricValuesList$member": null + "MetricValuesList$member": null, + "PerformanceInsightsMetric$Value": "The value of the metric. For example, 9 for db.load.avg.
The time you created the analysis report.
", + "AnalysisReport$StartTime": "The analysis start time in the report.
", + "AnalysisReport$EndTime": "The analysis end time in the report.
", + "AnalysisReportSummary$CreateTime": "The time you created the analysis report.
", + "AnalysisReportSummary$StartTime": "The start time of the analysis in the report.
", + "AnalysisReportSummary$EndTime": "The end time of the analysis in the report.
", + "CreatePerformanceAnalysisReportRequest$StartTime": "The start time defined for the analysis report.
", + "CreatePerformanceAnalysisReportRequest$EndTime": "The end time defined for the analysis report.
", "DataPoint$Timestamp": "The time, in epoch format, associated with a particular Value.
The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.
The value for StartTime must be earlier than the value for EndTime.
The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.
The value for EndTime must be later than the value for StartTime.
The date and time specifying the beginning of the requested time series query range. You can't specify a StartTime that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime.
The value for StartTime must be earlier than the value for EndTime.
The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime.
The value for EndTime must be later than the value for StartTime.
The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.
The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.
The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.
The start time of the insight. For example, 2018-10-30T00:00:00Z.
The end time of the insight. For example, 2018-10-30T00:00:00Z.
The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
The unique identifier of the analysis report.
", + "CreatePerformanceAnalysisReportRequest$Identifier": "An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.
The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
Retrieves the list of performance issues which are identified.
", + "refs": { + "InsightList$member": null + } + }, + "InsightList": { + "base": null, + "refs": { + "AnalysisReport$Insights": "The list of identified insights in the analysis report.
", + "Insight$SupportingInsights": "List of supporting insights that provide additional factors for the insight.
" } }, "Integer": { @@ -254,13 +413,41 @@ "refs": { } }, + "ListPerformanceAnalysisReportsRequest": { + "base": null, + "refs": { + } + }, + "ListPerformanceAnalysisReportsResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "MarkdownString": { + "base": null, + "refs": { + "Insight$Description": "Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact.
The recommendation details to help resolve the performance issue. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id
The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return. If the MaxRecords value is less than the number of existing items, the response includes a pagination token.
The maximum number of items to return. If the MaxRecords value is less than the number of existing items, the response includes a pagination token.
The maximum number of items to return in the response. If more items exist than the specified MaxResults value, a pagination token is included in the response so that the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.
A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.
A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.
This data type helps to determine Performance Insights metric to render for the insight.
", + "refs": { + "Data$PerformanceInsightsMetric": "This field determines the Performance Insights metric to render for the insight. The name field refers to a Performance Insights metric.
The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.
The list of recommendations for the insight.
", + "refs": { + "RecommendationList$member": null + } + }, + "RecommendationList": { + "base": null, + "refs": { + "Insight$Recommendations": "List of recommendations for the insight. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id.
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.
The name of a Performance Insights metric to be measured.
Valid values for Metric are:
db.load.avg - A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg - The raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
The name of the dimension group. Valid values are as follows:
db - The name of the database to which the client is connected. The following values are permitted:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Aurora MySQL
Amazon RDS MySQL
Amazon RDS MariaDB
Amazon DocumentDB
db.application - The name of the application that is connected to the database. The following values are permitted:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Amazon DocumentDB
db.host - The host name of the connected client (all engines).
db.query - The query that is currently running (only Amazon DocumentDB).
db.query_tokenized - The digest query (only Amazon DocumentDB).
db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).
db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).
db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).
db.user - The user logged in to the database (all engines except Amazon DocumentDB).
db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB).
db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).
db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).
The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:
db.query (Amazon DocumentDB only)
db.sql (Amazon RDS and Aurora only)
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id. The following group ID values are valid:
db.sql.id for dimension group db.sql (Aurora and RDS only)
db.query.id for dimension group db.query (DocumentDB only)
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
The name of a Performance Insights metric to be measured.
Valid values for Metric are:
db.load.avg - A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg - The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
RDS
DOCDB
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:
RDS
DOCDB
The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
The Amazon Web Services service for which Performance Insights returns metrics.
", "GetResourceMetricsRequest$ServiceType": "The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
RDS
DOCDB
The Amazon Web Services service for which Performance Insights returns metrics.
", - "ListAvailableResourceMetricsRequest$ServiceType": "The Amazon Web Services service for which Performance Insights returns metrics.
" + "ListAvailableResourceMetricsRequest$ServiceType": "The Amazon Web Services service for which Performance Insights returns metrics.
", + "ListPerformanceAnalysisReportsRequest$ServiceType": "The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
The severity of the insight. The values are: Low, Medium, or High.
The name of the analysis report.
", "DimensionDetail$Identifier": "The identifier of a dimension.
", "DimensionGroupDetail$Group": "The name of the dimension group.
", "DimensionKeyDetail$Value": "The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:
db.query.statement (Amazon DocumentDB)
db.sql.statement (Amazon RDS and Aurora)
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.
The unique identifier for the insight. For example, insight-12345678901234567.
The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs.
The metric type to which the dimension information belongs.
", + "Recommendation$RecommendationId": "The unique identifier for the recommendation.
", "ResponseResourceMetric$Metric": "The full name of the metric.
", "ResponseResourceMetric$Unit": "The unit of the metric.
", "ResponseResourceMetricKey$Metric": "The name of a Performance Insights metric to be measured.
Valid values for Metric are:
db.load.avg - A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg - The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").
The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.
" + } + }, + "TagList": { + "base": null, + "refs": { + "AnalysisReportSummary$Tags": "List of all the tags added to the analysis report.
", + "CreatePerformanceAnalysisReportRequest$Tags": "The metadata assigned to the analysis report consisting of a key-value pair.
", + "ListTagsForResourceResponse$Tags": "The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
", + "TagResourceRequest$Tags": "The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").
Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default value is plain text.
Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
", "StartAssetBundleImportJob": "Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary \"create\", \"describe\", and \"update\" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
Starts an asynchronous job that generates a dashboard snapshot. You can request up to one paginated PDF and up to five CSVs per API call.
Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call.
1 paginated PDF
5 CSVs
Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, and topic.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
Removes a tag or tags from a resource.
", "UpdateAccountCustomization": "Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
A structure that contains the following elements:
Your Amazon QuickSight account name.
The edition of Amazon QuickSight that your account is using.
The notification email address that is associated with the Amazon QuickSight account.
The authentication type of the Amazon QuickSight account.
The status of the Amazon QuickSight account's subscription.
The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.
The Amazon QuickSight settings associated with your Amazon Web Services account.
", "refs": { @@ -3463,7 +3469,7 @@ "base": null, "refs": { "TopicCalculatedField$Aggregation": "The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
The type of aggregation that is performed on the column data when it's queried. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
The type of aggregation that is performed on the column data when it's queried.
" } }, "DefaultFormatting": { @@ -7106,7 +7112,9 @@ "refs": { "DescribeIpRestrictionResponse$Enabled": "A value that specifies whether IP rules are turned on.
", "TopicCalculatedField$DisableIndexing": "A Boolean value that indicates if a calculated field is visible in the autocomplete.
", + "TopicCalculatedField$NonAdditive": "The non additive for the table style target.
", "TopicColumn$DisableIndexing": "A Boolean value that indicates whether the column shows in the autocomplete functionality.
", + "TopicColumn$NonAdditive": "The non additive value for the column.
", "TopicRefreshSchedule$IsEnabled": "A Boolean value that controls whether to schedule is enabled.
", "UpdateIpRestrictionRequest$Enabled": "A value that specifies whether IP rules are turned on.
" } @@ -7718,6 +7726,24 @@ "PivotTableConfiguration$PaginatedReportOptions": "The paginated report options for a pivot table visual.
" } }, + "PivotTableRowsLabelOptions": { + "base": "The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.
The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.
The custom label string for the rows label.
" + } + }, + "PivotTableRowsLayout": { + "base": null, + "refs": { + "PivotTableOptions$RowsLayout": "The layout for the row dimension headers of a pivot table. Choose one of the following options.
TABULAR: (Default) Each row field is displayed in a separate column.
HIERARCHY: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.
The sort by field for the field sort options.
", "refs": { @@ -7771,6 +7797,7 @@ "PanelConfiguration$BorderThickness": "Sets the line thickness of panel borders.
", "PanelConfiguration$GutterSpacing": "Sets the total amount of negative space to display between sibling panels.
", "PivotTableDataPathOption$Width": "The width of the data path option.
", + "PivotTableOptions$DefaultCellWidth": "The default cell width of the pivot table.
", "SectionStyle$Height": "The height of a section.
Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.
", "TableFieldOption$Width": "The width for a table field.
" } @@ -9387,7 +9414,7 @@ "SheetDefinition$SheetId": "The unique identifier of a sheet.
", "SheetTextBox$SheetTextBoxId": "The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.
", "SheetVisualScopingConfiguration$SheetId": "The selected sheet that the filter is applied to.
", - "SnapshotFileSheetSelection$SheetId": "The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV or PDF format types.
", + "SnapshotFileSheetSelection$SheetId": "The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV and PDF format types.
", "SnapshotFileSheetSelectionVisualIdList$member": null, "StartAssetBundleExportJobRequest$AssetBundleExportJobId": "The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
", "StartAssetBundleExportJobResponse$AssetBundleExportJobId": "The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
", @@ -9562,7 +9589,7 @@ "SnapshotFileFormatType": { "base": null, "refs": { - "SnapshotFile$FormatType": "The format of the snapshot file to be generated. You can choose between CSV and PDF.
The format of the snapshot file to be generated. You can choose between CSV or PDF.
A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV. This value supports a maximum of 1 visual ID.
" + "SnapshotFileSheetSelection$VisualIds": "A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.
" } }, "SnapshotJobErrorInfo": { @@ -9968,6 +9995,7 @@ "AccountInfo$NotificationEmail": "The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.
", "AccountInfo$AuthenticationType": "The way that your Amazon QuickSight account is authenticated.
", "AccountInfo$AccountSubscriptionStatus": "The status of your account subscription.
", + "AccountInfo$IAMIdentityCenterInstanceArn": "The Amazon Resource Name (ARN) for the IAM Identity Center instance.
", "AccountSettings$AccountName": "The \"account name\" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.
", "AccountSettings$NotificationEmail": "The main notification email for your Amazon QuickSight subscription.
", "ActionList$member": null, @@ -9992,7 +10020,6 @@ "ConflictException$Message": null, "ConflictException$RequestId": "The Amazon Web Services request ID for this request.
", "CreateAccountCustomizationResponse$RequestId": "The Amazon Web Services request ID for this operation.
", - "CreateAccountSubscriptionRequest$AccountName": "The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
", "CreateAccountSubscriptionRequest$ActiveDirectoryName": "The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
The configuration that defines the default value of a String parameter when a value has not been set.
The cell type of the table style target.
" + } + }, "SubnetId": { "base": null, "refs": { @@ -10670,6 +10703,18 @@ "TableConfiguration$SortConfiguration": "The sort configuration for a TableVisual.
The table style target.
", + "refs": { + "TableStyleTargetList$member": null + } + }, + "TableStyleTargetList": { + "base": null, + "refs": { + "SubtotalOptions$StyleTargets": "The style targets options for subtotals.
" + } + }, "TableTotalsPlacement": { "base": null, "refs": { @@ -12140,6 +12185,7 @@ "PivotTableOptions$CollapsedRowDimensionsVisibility": "The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.
The visibility of the printing table overflow across pages.
", "PivotTablePaginatedReportOptions$OverflowColumnHeaderVisibility": "The visibility of the repeating header rows on each page.
", + "PivotTableRowsLabelOptions$Visibility": "The visibility of the rows label.
", "PivotTotalOptions$TotalsVisibility": "The visibility configuration for the total cells.
", "ProgressBarOptions$Visibility": "The visibility of the progress bar.
", "RadarChartAreaStyleSettings$Visibility": "The visibility settings of a radar chart.
", @@ -12404,6 +12450,7 @@ "FilterGroup$Status": "The status of the FilterGroup.
The status of the reference line. Choose one of the following options:
ENABLE
DISABLE
Determines the widget status.
", + "RowAlternateColorOptions$UsePrimaryBackgroundColor": "The primary background color options for alternate rows.
", "VisualCustomAction$Status": "The status of the VisualCustomAction.
Provides an explanation for when a domain can't be transferred.
" + } + }, "Nameserver": { "base": "Name server includes the following elements.
", "refs": { @@ -780,6 +786,13 @@ "ViewBillingRequest$MaxItems": "The number of billing records to be returned.
Default: 20
" } }, + "Password": { + "base": null, + "refs": { + "AcceptDomainTransferFromAnotherAwsAccountRequest$Password": "The password that was returned by the TransferDomainToAnotherAwsAccount request.
", + "TransferDomainToAnotherAwsAccountResponse$Password": "To finish transferring a domain to another Amazon Web Services account, the account that the domain is being transferred to must submit an AcceptDomainTransferFromAnotherAwsAccount request. The request must include the value of the Password element that was returned in the TransferDomainToAnotherAwsAccount response.
ID of the request operation.
" + } + }, "Reseller": { "base": null, "refs": { @@ -923,12 +942,10 @@ "String": { "base": null, "refs": { - "AcceptDomainTransferFromAnotherAwsAccountRequest$Password": "The password that was returned by the TransferDomainToAnotherAwsAccount request.
", "DisassociateDelegationSignerFromDomainRequest$Id": "An internal identification number assigned to each DS record after it’s created. You can retrieve it as part of DNSSEC information returned by GetDomainDetail.
", "DnssecKey$Digest": "The delegation signer digest.
Digest is calculated from the public key provided using specified digest algorithm and this digest is the actual value returned from the registry nameservers as the value of DS records.
", "DnssecKey$Id": "An ID assigned to each DS record created by AssociateDelegationSignerToDomain.
", - "DomainSuggestion$Availability": "Whether the domain name is available for registering.
You can register only the domains that are designated as AVAILABLE.
Valid values:
The domain name is available.
The domain name is reserved under specific conditions.
The domain name is available and can be preordered.
The TLD registry didn't reply with a definitive answer about whether the domain name is available. Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
The domain name has been reserved for another person or organization.
The domain name is not available.
The domain name is not available.
The domain name is forbidden.
To finish transferring a domain to another Amazon Web Services account, the account that the domain is being transferred to must submit an AcceptDomainTransferFromAnotherAwsAccount request. The request must include the value of the Password element that was returned in the TransferDomainToAnotherAwsAccount response.
Whether the domain name is available for registering.
You can register only the domains that are designated as AVAILABLE.
Valid values:
The domain name is available.
The domain name is reserved under specific conditions.
The domain name is available and can be preordered.
The TLD registry didn't reply with a definitive answer about whether the domain name is available. Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
The domain name has been reserved for another person or organization.
The domain name is not available.
The domain name is not available.
The domain name is forbidden.
Whether the domain name can be transferred to Route 53.
You can transfer only domains that have a value of TRANSFERABLE or Transferable.
Valid values:
The domain name can be transferred to Route 53.
The domain name can't be transferred to Route 53.
Reserved for future use.
The domain already exists in the current Amazon Web Services account.
the domain exists in another Amazon Web Services account.
Premium domain transfer is not supported.
Whether the domain name can be transferred to Route 53.
You can transfer only domains that have a value of TRANSFERABLE or Transferable.
Valid values:
The domain name can be transferred to Route 53.
The domain name can't be transferred to Route 53.
Reserved for future use.
The domain already exists in the current Amazon Web Services account.
The domain exists in another Amazon Web Services account.
Premium domain transfer is not supported.
Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.
", "CreateEdgeDeploymentStage": "Creates a new stage in an existing edge deployment plan.
", "CreateEdgePackagingJob": "Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
", - "CreateEndpoint": "Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using SageMaker hosting services.
For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook.
You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.
When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.
To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.
Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:
\"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]
\"Resource\": [
\"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"
\"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"
]
For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using SageMaker hosting services.
You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.
When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.
To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.
Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:
\"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]
\"Resource\": [
\"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"
\"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"
]
For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.
Use this API if you want to use SageMaker hosting services to deploy models into production.
In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
", "CreateFeatureGroup": "Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.
The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.
You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.
A list of the instance types that are used to generate inferences in real-time.
" } }, + "RecommendationJobSupportedResponseMIMEType": { + "base": null, + "refs": { + "RecommendationJobSupportedResponseMIMETypes$member": null + } + }, + "RecommendationJobSupportedResponseMIMETypes": { + "base": null, + "refs": { + "RecommendationJobContainerConfig$SupportedResponseMIMETypes": "The supported MIME types for the output data.
" + } + }, "RecommendationJobType": { "base": null, "refs": { @@ -13341,7 +13353,7 @@ "CreateModelExplainabilityJobDefinitionRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
", "CreateModelInput$Tags": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
", "CreateModelPackageGroupInput$Tags": "A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
", - "CreateModelPackageInput$Tags": "A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
", + "CreateModelPackageInput$Tags": "A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
", "CreateMonitoringScheduleRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
", "CreateNotebookInstanceInput$Tags": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
", diff --git a/models/apis/swf/2012-01-25/api-2.json b/models/apis/swf/2012-01-25/api-2.json index fec93b09f59..6c4423267d7 100644 --- a/models/apis/swf/2012-01-25/api-2.json +++ b/models/apis/swf/2012-01-25/api-2.json @@ -1044,7 +1044,9 @@ "members":{ "executionContext":{"shape":"Data"}, "scheduledEventId":{"shape":"EventId"}, - "startedEventId":{"shape":"EventId"} + "startedEventId":{"shape":"EventId"}, + "taskList":{"shape":"TaskList"}, + "taskListScheduleToStartTimeout":{"shape":"DurationInSecondsOptional"} } }, "DecisionTaskScheduledEventAttributes":{ @@ -1053,7 +1055,8 @@ "members":{ "taskList":{"shape":"TaskList"}, "taskPriority":{"shape":"TaskPriority"}, - "startToCloseTimeout":{"shape":"DurationInSecondsOptional"} + "startToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "scheduleToStartTimeout":{"shape":"DurationInSecondsOptional"} } }, "DecisionTaskStartedEventAttributes":{ @@ -1079,7 +1082,10 @@ }, "DecisionTaskTimeoutType":{ "type":"string", - "enum":["START_TO_CLOSE"] + "enum":[ + "START_TO_CLOSE", + "SCHEDULE_TO_START" + ] }, "DecisionType":{ "type":"string", @@ -1969,7 +1975,9 @@ "members":{ "taskToken":{"shape":"TaskToken"}, "decisions":{"shape":"DecisionList"}, - "executionContext":{"shape":"Data"} + "executionContext":{"shape":"Data"}, + "taskList":{"shape":"TaskList"}, + "taskListScheduleToStartTimeout":{"shape":"DurationInSecondsOptional"} } }, "ReverseOrder":{"type":"boolean"}, diff --git a/models/apis/swf/2012-01-25/docs-2.json b/models/apis/swf/2012-01-25/docs-2.json index 0b11e425a54..7d4658465e9 100644 --- a/models/apis/swf/2012-01-25/docs-2.json +++ b/models/apis/swf/2012-01-25/docs-2.json @@ -617,7 +617,9 @@ "ActivityTypeConfiguration$defaultTaskScheduleToCloseTimeout": " The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.
Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
The maximum amount of time the decision task can wait to be assigned to a worker.
", "DecisionTaskScheduledEventAttributes$startToCloseTimeout": "The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
The maximum amount of time the decision task can wait to be assigned to a worker.
", "LambdaFunctionScheduledEventAttributes$startToCloseTimeout": "The maximum amount of time a worker can take to process the Lambda task.
", "RegisterActivityTypeInput$defaultTaskStartToCloseTimeout": "If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.
Specifies a timeout (in seconds) for the task list override. When this parameter is missing, the task list override is permanent. This parameter makes it possible to temporarily override the task list. If a decision task scheduled on the override task list is not started within the timeout, the decision task will time out. Amazon SWF will revert the override and schedule a new decision task to the original task list.
If a decision task scheduled on the override task list is started within the timeout, but not completed within the start-to-close timeout, Amazon SWF will also revert the override and schedule a new decision task to the original task list.
", "ScheduleActivityTaskDecisionAttributes$scheduleToCloseTimeout": "The maximum duration for this activity task.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.
If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.
If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.
The task list to use for the decisions of the new (continued) workflow execution.
", "CountPendingActivityTasksInput$taskList": "The name of the task list.
", "CountPendingDecisionTasksInput$taskList": "The name of the task list.
", + "DecisionTaskCompletedEventAttributes$taskList": null, "DecisionTaskScheduledEventAttributes$taskList": "The name of the task list in which the decision task was scheduled.
", "PollForActivityTaskInput$taskList": "Specifies the task list to poll for activity tasks.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.
Specifies the task list to poll for decision tasks.
The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.
If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
The task list to use for the future decision tasks of this workflow execution. This list overrides the original task list you specified while starting the workflow execution.
", "ScheduleActivityTaskDecisionAttributes$taskList": "If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.
A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.
The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.
The name of the task list to be used for decision tasks of the child workflow execution.
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.
The name of the task list used for the decision tasks of the child workflow execution.
", diff --git a/models/apis/swf/2012-01-25/endpoint-rule-set-1.json b/models/apis/swf/2012-01-25/endpoint-rule-set-1.json index 64949755fc8..c25159f6f59 100644 --- a/models/apis/swf/2012-01-25/endpoint-rule-set-1.json +++ b/models/apis/swf/2012-01-25/endpoint-rule-set-1.json @@ -58,52 +58,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -111,13 +115,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -127,92 +140,83 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://swf-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://swf-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] } ], @@ -221,155 +225,115 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, + "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] } ] } ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://swf.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://swf-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://swf.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://swf-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://swf.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://swf.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://swf.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://swf.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } \ No newline at end of file diff --git a/models/apis/transfer/2018-11-05/docs-2.json b/models/apis/transfer/2018-11-05/docs-2.json index ef2cd8366c6..5af79c7f452 100644 --- a/models/apis/transfer/2018-11-05/docs-2.json +++ b/models/apis/transfer/2018-11-05/docs-2.json @@ -784,7 +784,7 @@ "FilePaths": { "base": null, "refs": { - "StartFileTransferRequest$SendFilePaths": "One or more source paths for the Transfer Family server. Each string represents a source file path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt .
Replace DOC-EXAMPLE-BUCKET with one of your actual buckets.
One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt .
Replace DOC-EXAMPLE-BUCKET with one of your actual buckets.
One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.
" } }, @@ -1573,7 +1573,7 @@ "SecretId": { "base": null, "refs": { - "SftpConnectorConfig$UserSecretId": "The identifiers for the secrets (in Amazon Web Services Secrets Manager) that contain the SFTP user's private keys or passwords.
" + "SftpConnectorConfig$UserSecretId": "The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
" } }, "SecurityGroupId": { diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 19e799d0cf3..f249c7a2b0b 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -375,6 +375,7 @@ "deprecated" : true, "hostname" : "acm-pca-fips.us-west-2.amazonaws.com" }, + "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, "sa-east-1" : { }, @@ -1066,6 +1067,7 @@ }, "endpoints" : { "ap-south-1" : { }, + "eu-central-1" : { }, "us-east-1" : { } } }, @@ -8019,12 +8021,60 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "inspector2-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "inspector2-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "inspector2-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "inspector2-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "inspector2-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "inspector2-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "inspector2-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "inspector2-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "internetmonitor" : { @@ -11349,7 +11399,18 @@ "credentialScope" : { "region" : "us-west-2" }, - "hostname" : "networkmanager.us-west-2.amazonaws.com" + "hostname" : "networkmanager.us-west-2.amazonaws.com", + "variants" : [ { + "hostname" : "networkmanager-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "fips-aws-global" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "networkmanager-fips.us-west-2.amazonaws.com" } }, "isRegionalized" : false, @@ -14135,18 +14196,26 @@ }, "schemas" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, + "eu-central-2" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "me-central-1" : { }, + "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -16889,7 +16958,11 @@ "ap-northeast-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-2" : { } @@ -19141,6 +19214,12 @@ }, "isRegionalized" : true }, + "schemas" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "secretsmanager" : { "endpoints" : { "cn-north-1" : { }, @@ -21573,8 +21652,32 @@ }, "inspector2" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "inspector2-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "inspector2-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "inspector2-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "inspector2-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "internetmonitor" : { @@ -22280,6 +22383,17 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "hostname" : "networkmanager.us-gov-west-1.amazonaws.com", + "variants" : [ { + "hostname" : "networkmanager.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "fips-aws-us-gov-global" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, "hostname" : "networkmanager.us-gov-west-1.amazonaws.com" } }, diff --git a/service/amplifybackend/api.go b/service/amplifybackend/api.go index f538bd7a972..94ed298025a 100644 --- a/service/amplifybackend/api.go +++ b/service/amplifybackend/api.go @@ -3058,7 +3058,7 @@ func (s *BackendAPIResourceConfig) SetTransformSchema(v string) *BackendAPIResou // Describes Apple social federation configurations for allowing your app users // to sign in using OAuth. type BackendAuthAppleProviderConfig struct { - _ struct{} `type:"structure"` + _ struct{} `type:"structure" sensitive:"true"` // Describes the client_id (also called Services ID) that comes from Apple. ClientId *string `locationName:"client_id" type:"string"` @@ -3118,7 +3118,7 @@ func (s *BackendAuthAppleProviderConfig) SetTeamId(v string) *BackendAuthApplePr // Describes third-party social federation configurations for allowing your // app users to sign in using OAuth. type BackendAuthSocialProviderConfig struct { - _ struct{} `type:"structure"` + _ struct{} `type:"structure" sensitive:"true"` // Describes the client_id, which can be obtained from the third-party social // federation provider. @@ -3695,11 +3695,19 @@ type CreateBackendAuthForgotPasswordConfig struct { // (DEPRECATED) The configuration for the email sent when an app user forgets // their password. - EmailSettings *EmailSettings `locationName:"emailSettings" type:"structure"` + // + // EmailSettings is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateBackendAuthForgotPasswordConfig's + // String and GoString methods. + EmailSettings *EmailSettings `locationName:"emailSettings" type:"structure" sensitive:"true"` // (DEPRECATED) The configuration for the SMS message sent when an app user // forgets their password. - SmsSettings *SmsSettings `locationName:"smsSettings" type:"structure"` + // + // SmsSettings is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateBackendAuthForgotPasswordConfig's + // String and GoString methods. + SmsSettings *SmsSettings `locationName:"smsSettings" type:"structure" sensitive:"true"` } // String returns the string representation. @@ -4463,10 +4471,18 @@ type CreateBackendAuthVerificationMessageConfig struct { DeliveryMethod *string `locationName:"deliveryMethod" type:"string" required:"true" enum:"DeliveryMethod"` // The settings for the email message. - EmailSettings *EmailSettings `locationName:"emailSettings" type:"structure"` + // + // EmailSettings is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateBackendAuthVerificationMessageConfig's + // String and GoString methods. + EmailSettings *EmailSettings `locationName:"emailSettings" type:"structure" sensitive:"true"` // The settings for the SMS message. - SmsSettings *SmsSettings `locationName:"smsSettings" type:"structure"` + // + // SmsSettings is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateBackendAuthVerificationMessageConfig's + // String and GoString methods. + SmsSettings *SmsSettings `locationName:"smsSettings" type:"structure" sensitive:"true"` } // String returns the string representation. @@ -5765,7 +5781,7 @@ func (s *DeleteTokenOutput) SetIsSuccess(v bool) *DeleteTokenOutput { // The settings for the email message. type EmailSettings struct { - _ struct{} `type:"structure"` + _ struct{} `type:"structure" sensitive:"true"` // The contents of the email message. EmailMessage *string `locationName:"emailMessage" type:"string"` @@ -7975,7 +7991,7 @@ func (s *Settings) SetSmsMessage(v string) *Settings { // The settings for the SMS message. type SmsSettings struct { - _ struct{} `type:"structure"` + _ struct{} `type:"structure" sensitive:"true"` // The contents of the SMS message. SmsMessage *string `locationName:"smsMessage" type:"string"` @@ -8010,19 +8026,35 @@ type SocialProviderSettings struct { // Describes third-party social federation configurations for allowing your // app users to sign in using OAuth. - Facebook *BackendAuthSocialProviderConfig `type:"structure"` + // + // Facebook is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SocialProviderSettings's + // String and GoString methods. + Facebook *BackendAuthSocialProviderConfig `type:"structure" sensitive:"true"` // Describes third-party social federation configurations for allowing your // app users to sign in using OAuth. - Google *BackendAuthSocialProviderConfig `type:"structure"` + // + // Google is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SocialProviderSettings's + // String and GoString methods. + Google *BackendAuthSocialProviderConfig `type:"structure" sensitive:"true"` // Describes third-party social federation configurations for allowing your // app users to sign in using OAuth. - LoginWithAmazon *BackendAuthSocialProviderConfig `type:"structure"` + // + // LoginWithAmazon is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SocialProviderSettings's + // String and GoString methods. + LoginWithAmazon *BackendAuthSocialProviderConfig `type:"structure" sensitive:"true"` // Describes Apple social federation configurations for allowing your app users // to sign in using OAuth. - SignInWithApple *BackendAuthAppleProviderConfig `type:"structure"` + // + // SignInWithApple is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SocialProviderSettings's + // String and GoString methods. + SignInWithApple *BackendAuthAppleProviderConfig `type:"structure" sensitive:"true"` } // String returns the string representation. @@ -8298,11 +8330,19 @@ type UpdateBackendAuthForgotPasswordConfig struct { // (DEPRECATED) The configuration for the email sent when an app user forgets // their password. - EmailSettings *EmailSettings `locationName:"emailSettings" type:"structure"` + // + // EmailSettings is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateBackendAuthForgotPasswordConfig's + // String and GoString methods. + EmailSettings *EmailSettings `locationName:"emailSettings" type:"structure" sensitive:"true"` // (DEPRECATED) The configuration for the SMS message sent when an Amplify app // user forgets their password. - SmsSettings *SmsSettings `locationName:"smsSettings" type:"structure"` + // + // SmsSettings is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateBackendAuthForgotPasswordConfig's + // String and GoString methods. + SmsSettings *SmsSettings `locationName:"smsSettings" type:"structure" sensitive:"true"` } // String returns the string representation. @@ -8899,10 +8939,18 @@ type UpdateBackendAuthVerificationMessageConfig struct { DeliveryMethod *string `locationName:"deliveryMethod" type:"string" required:"true" enum:"DeliveryMethod"` // The settings for the email message. - EmailSettings *EmailSettings `locationName:"emailSettings" type:"structure"` + // + // EmailSettings is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateBackendAuthVerificationMessageConfig's + // String and GoString methods. + EmailSettings *EmailSettings `locationName:"emailSettings" type:"structure" sensitive:"true"` // The settings for the SMS message. - SmsSettings *SmsSettings `locationName:"smsSettings" type:"structure"` + // + // SmsSettings is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateBackendAuthVerificationMessageConfig's + // String and GoString methods. + SmsSettings *SmsSettings `locationName:"smsSettings" type:"structure" sensitive:"true"` } // String returns the string representation. diff --git a/service/chimesdkmeetings/api.go b/service/chimesdkmeetings/api.go index a932eed2d20..19fc3ea3011 100644 --- a/service/chimesdkmeetings/api.go +++ b/service/chimesdkmeetings/api.go @@ -213,6 +213,12 @@ func (c *ChimeSDKMeetings) BatchUpdateAttendeeCapabilitiesExceptRequest(input *B // - ServiceUnavailableException // The service is currently unavailable. // +// - ServiceFailureException +// The service encountered an unexpected error. +// +// - ThrottlingException +// The number of customer requests exceeds the request rate limit. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/BatchUpdateAttendeeCapabilitiesExcept func (c *ChimeSDKMeetings) BatchUpdateAttendeeCapabilitiesExcept(input *BatchUpdateAttendeeCapabilitiesExceptInput) (*BatchUpdateAttendeeCapabilitiesExceptOutput, error) { req, out := c.BatchUpdateAttendeeCapabilitiesExceptRequest(input) @@ -403,6 +409,9 @@ func (c *ChimeSDKMeetings) CreateMeetingRequest(input *CreateMeetingInput) (req // - BadRequestException // The input parameters don't match the service's restrictions. // +// - ConflictException +// Multiple instances of the same request have been made simultaneously. +// // - ForbiddenException // The client is permanently forbidden from making the request. // @@ -505,6 +514,9 @@ func (c *ChimeSDKMeetings) CreateMeetingWithAttendeesRequest(input *CreateMeetin // - BadRequestException // The input parameters don't match the service's restrictions. // +// - ConflictException +// Multiple instances of the same request have been made simultaneously. +// // - ForbiddenException // The client is permanently forbidden from making the request. // @@ -1158,6 +1170,28 @@ func (c *ChimeSDKMeetings) ListTagsForResourceRequest(input *ListTagsForResource // API operation ListTagsForResource for usage and error information. // // Returned Error Types: +// +// - BadRequestException +// The input parameters don't match the service's restrictions. +// +// - ForbiddenException +// The client is permanently forbidden from making the request. +// +// - UnauthorizedException +// The user isn't authorized to request a resource. +// +// - LimitExceededException +// The request exceeds the resource limit. +// +// - ServiceUnavailableException +// The service is currently unavailable. +// +// - ServiceFailureException +// The service encountered an unexpected error. +// +// - ThrottlingException +// The number of customer requests exceeds the request rate limit. +// // - ResourceNotFoundException // The resource that you want to tag couldn't be found. // @@ -1468,6 +1502,24 @@ func (c *ChimeSDKMeetings) TagResourceRequest(input *TagResourceInput) (req *req // - BadRequestException // The input parameters don't match the service's restrictions. // +// - ForbiddenException +// The client is permanently forbidden from making the request. +// +// - UnauthorizedException +// The user isn't authorized to request a resource. +// +// - LimitExceededException +// The request exceeds the resource limit. +// +// - ServiceUnavailableException +// The service is currently unavailable. +// +// - ServiceFailureException +// The service encountered an unexpected error. +// +// - ThrottlingException +// The number of customer requests exceeds the request rate limit. +// // - ResourceNotFoundException // The resource that you want to tag couldn't be found. // @@ -1577,6 +1629,24 @@ func (c *ChimeSDKMeetings) UntagResourceRequest(input *UntagResourceInput) (req // - BadRequestException // The input parameters don't match the service's restrictions. // +// - ForbiddenException +// The client is permanently forbidden from making the request. +// +// - UnauthorizedException +// The user isn't authorized to request a resource. +// +// - LimitExceededException +// The request exceeds the resource limit. +// +// - ServiceUnavailableException +// The service is currently unavailable. +// +// - ServiceFailureException +// The service encountered an unexpected error. +// +// - ThrottlingException +// The number of customer requests exceeds the request rate limit. +// // - ResourceNotFoundException // The resource that you want to tag couldn't be found. // @@ -1695,6 +1765,12 @@ func (c *ChimeSDKMeetings) UpdateAttendeeCapabilitiesRequest(input *UpdateAttend // - ServiceUnavailableException // The service is currently unavailable. // +// - ServiceFailureException +// The service encountered an unexpected error. +// +// - ThrottlingException +// The number of customer requests exceeds the request rate limit. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/UpdateAttendeeCapabilities func (c *ChimeSDKMeetings) UpdateAttendeeCapabilities(input *UpdateAttendeeCapabilitiesInput) (*UpdateAttendeeCapabilitiesOutput, error) { req, out := c.UpdateAttendeeCapabilitiesRequest(input) diff --git a/service/configservice/api.go b/service/configservice/api.go index 812ec63eadb..37656f87faa 100644 --- a/service/configservice/api.go +++ b/service/configservice/api.go @@ -34783,6 +34783,111 @@ const ( // ResourceTypeAwsKinesisFirehoseDeliveryStream is a ResourceType enum value ResourceTypeAwsKinesisFirehoseDeliveryStream = "AWS::KinesisFirehose::DeliveryStream" + + // ResourceTypeAwsAmplifyBranch is a ResourceType enum value + ResourceTypeAwsAmplifyBranch = "AWS::Amplify::Branch" + + // ResourceTypeAwsAppIntegrationsEventIntegration is a ResourceType enum value + ResourceTypeAwsAppIntegrationsEventIntegration = "AWS::AppIntegrations::EventIntegration" + + // ResourceTypeAwsAppMeshRoute is a ResourceType enum value + ResourceTypeAwsAppMeshRoute = "AWS::AppMesh::Route" + + // ResourceTypeAwsAthenaPreparedStatement is a ResourceType enum value + ResourceTypeAwsAthenaPreparedStatement = "AWS::Athena::PreparedStatement" + + // ResourceTypeAwsEc2Ipamscope is a ResourceType enum value + ResourceTypeAwsEc2Ipamscope = "AWS::EC2::IPAMScope" + + // ResourceTypeAwsEvidentlyLaunch is a ResourceType enum value + ResourceTypeAwsEvidentlyLaunch = "AWS::Evidently::Launch" + + // ResourceTypeAwsForecastDatasetGroup is a ResourceType enum value + ResourceTypeAwsForecastDatasetGroup = "AWS::Forecast::DatasetGroup" + + // ResourceTypeAwsGreengrassV2ComponentVersion is a ResourceType enum value + ResourceTypeAwsGreengrassV2ComponentVersion = "AWS::GreengrassV2::ComponentVersion" + + // ResourceTypeAwsGroundStationMissionProfile is a ResourceType enum value + ResourceTypeAwsGroundStationMissionProfile = "AWS::GroundStation::MissionProfile" + + // ResourceTypeAwsMediaConnectFlowEntitlement is a ResourceType enum value + ResourceTypeAwsMediaConnectFlowEntitlement = "AWS::MediaConnect::FlowEntitlement" + + // ResourceTypeAwsMediaConnectFlowVpcInterface is a ResourceType enum value + ResourceTypeAwsMediaConnectFlowVpcInterface = "AWS::MediaConnect::FlowVpcInterface" + + // ResourceTypeAwsMediaTailorPlaybackConfiguration is a ResourceType enum value + ResourceTypeAwsMediaTailorPlaybackConfiguration = "AWS::MediaTailor::PlaybackConfiguration" + + // ResourceTypeAwsMskConfiguration is a ResourceType enum value + ResourceTypeAwsMskConfiguration = "AWS::MSK::Configuration" + + // ResourceTypeAwsPersonalizeDataset is a ResourceType enum value + ResourceTypeAwsPersonalizeDataset = "AWS::Personalize::Dataset" + + // ResourceTypeAwsPersonalizeSchema is a ResourceType enum value + ResourceTypeAwsPersonalizeSchema = "AWS::Personalize::Schema" + + // ResourceTypeAwsPersonalizeSolution is a ResourceType enum value + ResourceTypeAwsPersonalizeSolution = "AWS::Personalize::Solution" + + // ResourceTypeAwsPinpointEmailTemplate is a ResourceType enum value + ResourceTypeAwsPinpointEmailTemplate = "AWS::Pinpoint::EmailTemplate" + + // ResourceTypeAwsPinpointEventStream is a ResourceType enum value + ResourceTypeAwsPinpointEventStream = "AWS::Pinpoint::EventStream" + + // ResourceTypeAwsResilienceHubApp is a ResourceType enum value + ResourceTypeAwsResilienceHubApp = "AWS::ResilienceHub::App" + + // ResourceTypeAwsAcmpcaCertificateAuthority is a ResourceType enum value + ResourceTypeAwsAcmpcaCertificateAuthority = "AWS::ACMPCA::CertificateAuthority" + + // ResourceTypeAwsAppConfigHostedConfigurationVersion is a ResourceType enum value + ResourceTypeAwsAppConfigHostedConfigurationVersion = "AWS::AppConfig::HostedConfigurationVersion" + + // ResourceTypeAwsAppMeshVirtualGateway is a ResourceType enum value + ResourceTypeAwsAppMeshVirtualGateway = "AWS::AppMesh::VirtualGateway" + + // ResourceTypeAwsAppMeshVirtualRouter is a ResourceType enum value + ResourceTypeAwsAppMeshVirtualRouter = "AWS::AppMesh::VirtualRouter" + + // ResourceTypeAwsAppRunnerService is a ResourceType enum value + ResourceTypeAwsAppRunnerService = "AWS::AppRunner::Service" + + // ResourceTypeAwsCustomerProfilesObjectType is a ResourceType enum value + ResourceTypeAwsCustomerProfilesObjectType = "AWS::CustomerProfiles::ObjectType" + + // ResourceTypeAwsDmsEndpoint is a ResourceType enum value + ResourceTypeAwsDmsEndpoint = "AWS::DMS::Endpoint" + + // ResourceTypeAwsEc2CapacityReservation is a ResourceType enum value + ResourceTypeAwsEc2CapacityReservation = "AWS::EC2::CapacityReservation" + + // ResourceTypeAwsEc2ClientVpnEndpoint is a ResourceType enum value + ResourceTypeAwsEc2ClientVpnEndpoint = "AWS::EC2::ClientVpnEndpoint" + + // ResourceTypeAwsKendraIndex is a ResourceType enum value + ResourceTypeAwsKendraIndex = "AWS::Kendra::Index" + + // ResourceTypeAwsKinesisVideoStream is a ResourceType enum value + ResourceTypeAwsKinesisVideoStream = "AWS::KinesisVideo::Stream" + + // ResourceTypeAwsLogsDestination is a ResourceType enum value + ResourceTypeAwsLogsDestination = "AWS::Logs::Destination" + + // ResourceTypeAwsPinpointEmailChannel is a ResourceType enum value + ResourceTypeAwsPinpointEmailChannel = "AWS::Pinpoint::EmailChannel" + + // ResourceTypeAwsS3AccessPoint is a ResourceType enum value + ResourceTypeAwsS3AccessPoint = "AWS::S3::AccessPoint" + + // ResourceTypeAwsNetworkManagerCustomerGatewayAssociation is a ResourceType enum value + ResourceTypeAwsNetworkManagerCustomerGatewayAssociation = "AWS::NetworkManager::CustomerGatewayAssociation" + + // ResourceTypeAwsNetworkManagerLinkAssociation is a ResourceType enum value + ResourceTypeAwsNetworkManagerLinkAssociation = "AWS::NetworkManager::LinkAssociation" ) // ResourceType_Values returns all elements of the ResourceType enum @@ -35106,6 +35211,41 @@ func ResourceType_Values() []string { ResourceTypeAwsTransferAgreement, ResourceTypeAwsTransferConnector, ResourceTypeAwsKinesisFirehoseDeliveryStream, + ResourceTypeAwsAmplifyBranch, + ResourceTypeAwsAppIntegrationsEventIntegration, + ResourceTypeAwsAppMeshRoute, + ResourceTypeAwsAthenaPreparedStatement, + ResourceTypeAwsEc2Ipamscope, + ResourceTypeAwsEvidentlyLaunch, + ResourceTypeAwsForecastDatasetGroup, + ResourceTypeAwsGreengrassV2ComponentVersion, + ResourceTypeAwsGroundStationMissionProfile, + ResourceTypeAwsMediaConnectFlowEntitlement, + ResourceTypeAwsMediaConnectFlowVpcInterface, + ResourceTypeAwsMediaTailorPlaybackConfiguration, + ResourceTypeAwsMskConfiguration, + ResourceTypeAwsPersonalizeDataset, + ResourceTypeAwsPersonalizeSchema, + ResourceTypeAwsPersonalizeSolution, + ResourceTypeAwsPinpointEmailTemplate, + ResourceTypeAwsPinpointEventStream, + ResourceTypeAwsResilienceHubApp, + ResourceTypeAwsAcmpcaCertificateAuthority, + ResourceTypeAwsAppConfigHostedConfigurationVersion, + ResourceTypeAwsAppMeshVirtualGateway, + ResourceTypeAwsAppMeshVirtualRouter, + ResourceTypeAwsAppRunnerService, + ResourceTypeAwsCustomerProfilesObjectType, + ResourceTypeAwsDmsEndpoint, + ResourceTypeAwsEc2CapacityReservation, + ResourceTypeAwsEc2ClientVpnEndpoint, + ResourceTypeAwsKendraIndex, + ResourceTypeAwsKinesisVideoStream, + ResourceTypeAwsLogsDestination, + ResourceTypeAwsPinpointEmailChannel, + ResourceTypeAwsS3AccessPoint, + ResourceTypeAwsNetworkManagerCustomerGatewayAssociation, + ResourceTypeAwsNetworkManagerLinkAssociation, } } diff --git a/service/ec2/api.go b/service/ec2/api.go index f9de38875d4..e13d0eaf252 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -8685,9 +8685,11 @@ func (c *EC2) CreateSubnetCidrReservationRequest(input *CreateSubnetCidrReservat // CreateSubnetCidrReservation API operation for Amazon Elastic Compute Cloud. // -// Creates a subnet CIDR reservation. For information about subnet CIDR reservations, -// see Subnet CIDR reservations (https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html) -// in the Amazon Virtual Private Cloud User Guide. +// Creates a subnet CIDR reservation. For more information, see Subnet CIDR +// reservations (https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html) +// in the Amazon Virtual Private Cloud User Guide and Assign prefixes to network +// interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) +// in the Amazon Elastic Compute Cloud User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12609,10 +12611,19 @@ func (c *EC2) DeleteLaunchTemplateVersionsRequest(input *DeleteLaunchTemplateVer // DeleteLaunchTemplateVersions API operation for Amazon Elastic Compute Cloud. // -// Deletes one or more versions of a launch template. You cannot delete the -// default version of a launch template; you must first assign a different version -// as the default. If the default version is the only version for the launch -// template, you must delete the entire launch template using DeleteLaunchTemplate. +// Deletes one or more versions of a launch template. +// +// You can't delete the default version of a launch template; you must first +// assign a different version as the default. If the default version is the +// only version for the launch template, you must delete the entire launch template +// using DeleteLaunchTemplate. +// +// You can delete up to 200 launch template versions in a single request. To +// delete more than 200 versions in a single request, use DeleteLaunchTemplate, +// which deletes the launch template and all of its versions. +// +// For more information, see Delete a launch template version (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-launch-template-versions.html#delete-launch-template-version) +// in the EC2 User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -69416,9 +69427,7 @@ type CreateFlowLogsInput struct { // in the Amazon VPC User Guide or Transit Gateway Flow Log records (https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records) // in the Amazon Web Services Transit Gateway Guide. // - // Specify the fields using the ${field-id} format, separated by spaces. For - // the CLI, surround this parameter value with single quotes on Linux or double - // quotes on Windows. + // Specify the fields using the ${field-id} format, separated by spaces. LogFormat *string `type:"string"` // The name of a new or existing CloudWatch Logs log group where Amazon EC2 @@ -74866,18 +74875,13 @@ type CreateSubnetCidrReservationInput struct { // it is UnauthorizedOperation. DryRun *bool `type:"boolean"` - // The type of reservation. + // The type of reservation. The reservation type determines how the reserved + // IP addresses are assigned to resources. // - // The following are valid values: + // * prefix - Amazon Web Services assigns the reserved IP addresses to network + // interfaces. // - // * prefix: The Amazon EC2 Prefix Delegation feature assigns the IP addresses - // to network interfaces that are associated with an instance. For information - // about Prefix Delegation, see Prefix Delegation for Amazon EC2 network - // interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-delegation.html) - // in the Amazon Elastic Compute Cloud User Guide. - // - // * explicit: You manually assign the IP addresses to resources that reside - // in your subnet. + // * explicit - You assign the reserved IP addresses to network interfaces. // // ReservationType is a required field ReservationType *string `type:"string" required:"true" enum:"SubnetCidrReservationType"` @@ -75617,6 +75621,10 @@ type CreateTrafficMirrorSessionInput struct { // // If you do not want to mirror the entire packet, use the PacketLength parameter // to specify the number of bytes in each packet to mirror. + // + // For sessions with Network Load Balancer (NLB) Traffic Mirror targets the + // default PacketLength will be set to 8500. Valid values are 1-8500. Setting + // a PacketLength greater than 8500 will result in an error response. PacketLength *int64 `type:"integer"` // The session number determines the order in which sessions are evaluated when @@ -82180,7 +82188,8 @@ type DeleteLaunchTemplateVersionsInput struct { // not both. LaunchTemplateName *string `min:"3" type:"string"` - // The version numbers of one or more launch template versions to delete. + // The version numbers of one or more launch template versions to delete. You + // can specify up to 200 launch template version numbers. // // Versions is a required field Versions []*string `locationName:"LaunchTemplateVersion" locationNameList:"item" type:"list" required:"true"` @@ -95325,7 +95334,7 @@ type DescribeInstancesInput struct { // * availability-zone - The Availability Zone of the instance. // // * block-device-mapping.attach-time - The attach time for an EBS volume - // mapped to the instance, for example, 2010-09-15T17:15:20.000Z. + // mapped to the instance, for example, 2022-09-15T17:15:20.000Z. // // * block-device-mapping.delete-on-termination - A Boolean that indicates // whether the EBS volume is deleted on instance termination. @@ -95338,14 +95347,38 @@ type DescribeInstancesInput struct { // // * block-device-mapping.volume-id - The volume ID of the EBS volume. // + // * boot-mode - The boot mode that was specified by the AMI (legacy-bios + // | uefi | uefi-preferred). + // // * capacity-reservation-id - The ID of the Capacity Reservation into which // the instance was launched. // + // * capacity-reservation-specification.capacity-reservation-preference - + // The instance's Capacity Reservation preference (open | none). + // + // * capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id + // - The ID of the targeted Capacity Reservation. + // + // * capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn + // - The ARN of the targeted Capacity Reservation group. + // // * client-token - The idempotency token you provided when you launched // the instance. // + // * current-instance-boot-mode - The boot mode that is used to launch the + // instance at launch or start (legacy-bios | uefi). + // // * dns-name - The public DNS name of the instance. // + // * ebs-optimized - A Boolean that indicates whether the instance is optimized + // for Amazon EBS I/O. + // + // * ena-support - A Boolean that indicates whether the instance is enabled + // for enhanced networking with ENA. + // + // * enclave-options.enabled - A Boolean that indicates whether the instance + // is enabled for Amazon Web Services Nitro Enclaves. + // // * hibernation-options.configured - A Boolean that indicates whether the // instance is enabled for hibernation. A value of true means that the instance // is enabled for hibernation. @@ -95359,6 +95392,12 @@ type DescribeInstancesInput struct { // * iam-instance-profile.arn - The instance profile associated with the // instance. Specified as an ARN. // + // * iam-instance-profile.id - The instance profile associated with the instance. + // Specified as an ID. + // + // * iam-instance-profile.name - The instance profile associated with the + // instance. Specified as an name. + // // * image-id - The ID of the image used to launch the instance. // // * instance-id - The ID of the instance. @@ -95383,6 +95422,8 @@ type DescribeInstancesInput struct { // // * ip-address - The public IPv4 address of the instance. // + // * ipv6-address - The IPv6 address of the instance. + // // * kernel-id - The kernel ID. // // * key-name - The name of the key pair used when the instance was launched. @@ -95395,27 +95436,41 @@ type DescribeInstancesInput struct { // You can use a wildcard (*), for example, 2021-09-29T*, which matches an // entire day. // - // * metadata-options.http-tokens - The metadata request authorization state - // (optional | required) + // * license-pool - // - // * metadata-options.http-put-response-hop-limit - The HTTP metadata request - // put response hop limit (integer, possible values 1 to 64) + // * maintenance-options.auto-recovery - The current automatic recovery behavior + // of the instance (disabled | default). // // * metadata-options.http-endpoint - The status of access to the HTTP metadata // endpoint on your instance (enabled | disabled) // + // * metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint + // is enabled (disabled | enabled). + // + // * metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint + // is enabled (disabled | enabled). + // + // * metadata-options.http-put-response-hop-limit - The HTTP metadata request + // put response hop limit (integer, possible values 1 to 64) + // + // * metadata-options.http-tokens - The metadata request authorization state + // (optional | required) + // // * metadata-options.instance-metadata-tags - The status of access to instance // tags from the instance metadata (enabled | disabled) // + // * metadata-options.state - The state of the metadata option changes (pending + // | applied). + // // * monitoring-state - Indicates whether detailed monitoring is enabled // (disabled | enabled). // - // * network-interface.addresses.private-ip-address - The private IPv4 address - // associated with the network interface. - // // * network-interface.addresses.primary - Specifies whether the IPv4 address // of the network interface is the primary private IPv4 address. // + // * network-interface.addresses.private-ip-address - The private IPv4 address + // associated with the network interface. + // // * network-interface.addresses.association.public-ip - The ID of the association // of an Elastic IP address (IPv4) with a network interface. // @@ -95507,8 +95562,29 @@ type DescribeInstancesInput struct { // // * platform - The platform. To list only Windows instances, use windows. // + // * platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux | Red + // Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise + // Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with + // SQL Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server + // Standard | Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise + // Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server + // Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows + // BYOL | Windows with SQL Server Enterprise | Windows with SQL Server Standard + // | Windows with SQL Server Web). + // // * private-dns-name - The private IPv4 DNS name of the instance. // + // * private-dns-name-options.enable-resource-name-dns-a-record - A Boolean + // that indicates whether to respond to DNS queries for instance hostnames + // with DNS A records. + // + // * private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean + // that indicates whether to respond to DNS queries for instance hostnames + // with DNS AAAA records. + // + // * private-dns-name-options.hostname-type - The type of hostname (ip-name + // | resource-name). + // // * private-ip-address - The private IPv4 address of the instance. // // * product-code - The product code associated with the AMI used to launch @@ -95564,6 +95640,19 @@ type DescribeInstancesInput struct { // // * tenancy - The tenancy of an instance (dedicated | default | host). // + // * tpm-support - Indicates if the instance is configured for NitroTPM support + // (v2.0). + // + // * usage-operation - The usage operation value for the instance (RunInstances + // | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | RunInstances:1014 + // | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 | RunInstances:0110 + // | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 | RunInstances:000g + // | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 | RunInstances:0102 + // | RunInstances:0006 | RunInstances:0202). + // + // * usage-operation-update-time - The time that the usage operation was + // last updated, for example, 2022-09-15T17:15:20.000Z. + // // * virtualization-type - The virtualization type of the instance (paravirtual // | hvm). // @@ -145835,6 +145924,10 @@ type ModifyTrafficMirrorSessionInput struct { // For example, if you set this value to 100, then the first 100 bytes that // meet the filter criteria are copied to the target. Do not specify this parameter // when you want to mirror the entire packet. + // + // For sessions with Network Load Balancer (NLB) traffic mirror targets, the + // default PacketLength will be set to 8500. Valid values are 1-8500. Setting + // a PacketLength greater than 8500 will result in an error response. PacketLength *int64 `type:"integer"` // The properties that you want to remove from the Traffic Mirror session. @@ -187004,6 +187097,51 @@ const ( // InstanceTypeC7gn16xlarge is a InstanceType enum value InstanceTypeC7gn16xlarge = "c7gn.16xlarge" + + // InstanceTypeP548xlarge is a InstanceType enum value + InstanceTypeP548xlarge = "p5.48xlarge" + + // InstanceTypeM7iLarge is a InstanceType enum value + InstanceTypeM7iLarge = "m7i.large" + + // InstanceTypeM7iXlarge is a InstanceType enum value + InstanceTypeM7iXlarge = "m7i.xlarge" + + // InstanceTypeM7i2xlarge is a InstanceType enum value + InstanceTypeM7i2xlarge = "m7i.2xlarge" + + // InstanceTypeM7i4xlarge is a InstanceType enum value + InstanceTypeM7i4xlarge = "m7i.4xlarge" + + // InstanceTypeM7i8xlarge is a InstanceType enum value + InstanceTypeM7i8xlarge = "m7i.8xlarge" + + // InstanceTypeM7i12xlarge is a InstanceType enum value + InstanceTypeM7i12xlarge = "m7i.12xlarge" + + // InstanceTypeM7i16xlarge is a InstanceType enum value + InstanceTypeM7i16xlarge = "m7i.16xlarge" + + // InstanceTypeM7i24xlarge is a InstanceType enum value + InstanceTypeM7i24xlarge = "m7i.24xlarge" + + // InstanceTypeM7i48xlarge is a InstanceType enum value + InstanceTypeM7i48xlarge = "m7i.48xlarge" + + // InstanceTypeM7iFlexLarge is a InstanceType enum value + InstanceTypeM7iFlexLarge = "m7i-flex.large" + + // InstanceTypeM7iFlexXlarge is a InstanceType enum value + InstanceTypeM7iFlexXlarge = "m7i-flex.xlarge" + + // InstanceTypeM7iFlex2xlarge is a InstanceType enum value + InstanceTypeM7iFlex2xlarge = "m7i-flex.2xlarge" + + // InstanceTypeM7iFlex4xlarge is a InstanceType enum value + InstanceTypeM7iFlex4xlarge = "m7i-flex.4xlarge" + + // InstanceTypeM7iFlex8xlarge is a InstanceType enum value + InstanceTypeM7iFlex8xlarge = "m7i-flex.8xlarge" ) // InstanceType_Values returns all elements of the InstanceType enum @@ -187674,6 +187812,21 @@ func InstanceType_Values() []string { InstanceTypeC7gn8xlarge, InstanceTypeC7gn12xlarge, InstanceTypeC7gn16xlarge, + InstanceTypeP548xlarge, + InstanceTypeM7iLarge, + InstanceTypeM7iXlarge, + InstanceTypeM7i2xlarge, + InstanceTypeM7i4xlarge, + InstanceTypeM7i8xlarge, + InstanceTypeM7i12xlarge, + InstanceTypeM7i16xlarge, + InstanceTypeM7i24xlarge, + InstanceTypeM7i48xlarge, + InstanceTypeM7iFlexLarge, + InstanceTypeM7iFlexXlarge, + InstanceTypeM7iFlex2xlarge, + InstanceTypeM7iFlex4xlarge, + InstanceTypeM7iFlex8xlarge, } } diff --git a/service/glue/api.go b/service/glue/api.go index dfc638bde4a..dcc5b0a781d 100644 --- a/service/glue/api.go +++ b/service/glue/api.go @@ -29882,6 +29882,12 @@ type CreateCsvClassifierRequest struct { // A custom symbol to denote what combines content into a single column value. // Must be different from the column delimiter. QuoteSymbol *string `min:"1" type:"string"` + + // Sets the SerDe for processing CSV in the classifier, which will be applied + // in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and + // None. You can specify the None value when you want the crawler to do the + // detection. + Serde *string `type:"string" enum:"CsvSerdeOption"` } // String returns the string representation. @@ -29978,6 +29984,12 @@ func (s *CreateCsvClassifierRequest) SetQuoteSymbol(v string) *CreateCsvClassifi return s } +// SetSerde sets the Serde field's value. +func (s *CreateCsvClassifierRequest) SetSerde(v string) *CreateCsvClassifierRequest { + s.Serde = &v + return s +} + type CreateCustomEntityTypeInput struct { _ struct{} `type:"structure"` @@ -33561,6 +33573,12 @@ type CsvClassifier struct { // It must be different from the column delimiter. QuoteSymbol *string `min:"1" type:"string"` + // Sets the SerDe for processing CSV in the classifier, which will be applied + // in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and + // None. You can specify the None value when you want the crawler to do the + // detection. + Serde *string `type:"string" enum:"CsvSerdeOption"` + // The version of this classifier. Version *int64 `type:"long"` } @@ -33649,6 +33667,12 @@ func (s *CsvClassifier) SetQuoteSymbol(v string) *CsvClassifier { return s } +// SetSerde sets the Serde field's value. +func (s *CsvClassifier) SetSerde(v string) *CsvClassifier { + s.Serde = &v + return s +} + // SetVersion sets the Version field's value. func (s *CsvClassifier) SetVersion(v int64) *CsvClassifier { s.Version = &v @@ -70738,6 +70762,12 @@ type UpdateCsvClassifierRequest struct { // A custom symbol to denote what combines content into a single column value. // It must be different from the column delimiter. QuoteSymbol *string `min:"1" type:"string"` + + // Sets the SerDe for processing CSV in the classifier, which will be applied + // in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and + // None. You can specify the None value when you want the crawler to do the + // detection. + Serde *string `type:"string" enum:"CsvSerdeOption"` } // String returns the string representation. @@ -70834,6 +70864,12 @@ func (s *UpdateCsvClassifierRequest) SetQuoteSymbol(v string) *UpdateCsvClassifi return s } +// SetSerde sets the Serde field's value. +func (s *UpdateCsvClassifierRequest) SetSerde(v string) *UpdateCsvClassifierRequest { + s.Serde = &v + return s +} + type UpdateDataQualityRulesetInput struct { _ struct{} `type:"structure"` @@ -74364,6 +74400,26 @@ func CsvHeaderOption_Values() []string { } } +const ( + // CsvSerdeOptionOpenCsvserDe is a CsvSerdeOption enum value + CsvSerdeOptionOpenCsvserDe = "OpenCSVSerDe" + + // CsvSerdeOptionLazySimpleSerDe is a CsvSerdeOption enum value + CsvSerdeOptionLazySimpleSerDe = "LazySimpleSerDe" + + // CsvSerdeOptionNone is a CsvSerdeOption enum value + CsvSerdeOptionNone = "None" +) + +// CsvSerdeOption_Values returns all elements of the CsvSerdeOption enum +func CsvSerdeOption_Values() []string { + return []string{ + CsvSerdeOptionOpenCsvserDe, + CsvSerdeOptionLazySimpleSerDe, + CsvSerdeOptionNone, + } +} + const ( // DQStopJobOnFailureTimingImmediate is a DQStopJobOnFailureTiming enum value DQStopJobOnFailureTimingImmediate = "Immediate" diff --git a/service/mediapackage/api.go b/service/mediapackage/api.go index 8cf74c12815..79b83db12dc 100644 --- a/service/mediapackage/api.go +++ b/service/mediapackage/api.go @@ -4816,14 +4816,18 @@ type IngestEndpoint struct { // The system generated unique identifier for the IngestEndpoint Id *string `locationName:"id" type:"string"` - // The system generated password for ingest authentication. - Password *string `locationName:"password" type:"string"` + // Password is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by IngestEndpoint's + // String and GoString methods. + Password *string `locationName:"password" type:"string" sensitive:"true"` // The ingest URL to which the source stream should be sent. Url *string `locationName:"url" type:"string"` - // The system generated username for ingest authentication. - Username *string `locationName:"username" type:"string"` + // Username is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by IngestEndpoint's + // String and GoString methods. + Username *string `locationName:"username" type:"string" sensitive:"true"` } // String returns the string representation. diff --git a/service/omics/api.go b/service/omics/api.go index 623603b0f9f..6e024d2394e 100644 --- a/service/omics/api.go +++ b/service/omics/api.go @@ -119,6 +119,106 @@ func (c *Omics) AbortMultipartReadSetUploadWithContext(ctx aws.Context, input *A return out, req.Send() } +const opAcceptShare = "AcceptShare" + +// AcceptShareRequest generates a "aws/request.Request" representing the +// client's request for the AcceptShare operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See AcceptShare for more information on using the AcceptShare +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the AcceptShareRequest method. +// req, resp := client.AcceptShareRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/AcceptShare +func (c *Omics) AcceptShareRequest(input *AcceptShareInput) (req *request.Request, output *AcceptShareOutput) { + op := &request.Operation{ + Name: opAcceptShare, + HTTPMethod: "POST", + HTTPPath: "/share/{shareId}", + } + + if input == nil { + input = &AcceptShareInput{} + } + + output = &AcceptShareOutput{} + req = c.newRequest(op, input, output) + + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// AcceptShare API operation for Amazon Omics. +// +// Accepts a share for an analytics store. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Omics's +// API operation AcceptShare for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// An unexpected error occurred. Try the request again. +// +// - ServiceQuotaExceededException +// The request exceeds a service quota. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ConflictException +// The request cannot be applied to the target resource in its current state. +// +// - ResourceNotFoundException +// The target resource was not found in the current Region. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/AcceptShare +func (c *Omics) AcceptShare(input *AcceptShareInput) (*AcceptShareOutput, error) { + req, out := c.AcceptShareRequest(input) + return out, req.Send() +} + +// AcceptShareWithContext is the same as AcceptShare with the addition of +// the ability to pass a context and additional request options. +// +// See AcceptShare for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) AcceptShareWithContext(ctx aws.Context, input *AcceptShareInput, opts ...request.Option) (*AcceptShareOutput, error) { + req, out := c.AcceptShareRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opBatchDeleteReadSet = "BatchDeleteReadSet" // BatchDeleteReadSetRequest generates a "aws/request.Request" representing the @@ -713,6 +813,106 @@ func (c *Omics) CreateAnnotationStoreWithContext(ctx aws.Context, input *CreateA return out, req.Send() } +const opCreateAnnotationStoreVersion = "CreateAnnotationStoreVersion" + +// CreateAnnotationStoreVersionRequest generates a "aws/request.Request" representing the +// client's request for the CreateAnnotationStoreVersion operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateAnnotationStoreVersion for more information on using the CreateAnnotationStoreVersion +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateAnnotationStoreVersionRequest method. +// req, resp := client.CreateAnnotationStoreVersionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateAnnotationStoreVersion +func (c *Omics) CreateAnnotationStoreVersionRequest(input *CreateAnnotationStoreVersionInput) (req *request.Request, output *CreateAnnotationStoreVersionOutput) { + op := &request.Operation{ + Name: opCreateAnnotationStoreVersion, + HTTPMethod: "POST", + HTTPPath: "/annotationStore/{name}/version", + } + + if input == nil { + input = &CreateAnnotationStoreVersionInput{} + } + + output = &CreateAnnotationStoreVersionOutput{} + req = c.newRequest(op, input, output) + + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// CreateAnnotationStoreVersion API operation for Amazon Omics. +// +// Creates a new version of an annotation store. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Omics's +// API operation CreateAnnotationStoreVersion for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// An unexpected error occurred. Try the request again. +// +// - ServiceQuotaExceededException +// The request exceeds a service quota. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ConflictException +// The request cannot be applied to the target resource in its current state. +// +// - ResourceNotFoundException +// The target resource was not found in the current Region. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateAnnotationStoreVersion +func (c *Omics) CreateAnnotationStoreVersion(input *CreateAnnotationStoreVersionInput) (*CreateAnnotationStoreVersionOutput, error) { + req, out := c.CreateAnnotationStoreVersionRequest(input) + return out, req.Send() +} + +// CreateAnnotationStoreVersionWithContext is the same as CreateAnnotationStoreVersion with the addition of +// the ability to pass a context and additional request options. +// +// See CreateAnnotationStoreVersion for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) CreateAnnotationStoreVersionWithContext(ctx aws.Context, input *CreateAnnotationStoreVersionInput, opts ...request.Option) (*CreateAnnotationStoreVersionOutput, error) { + req, out := c.CreateAnnotationStoreVersionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateMultipartReadSetUpload = "CreateMultipartReadSetUpload" // CreateMultipartReadSetUploadRequest generates a "aws/request.Request" representing the @@ -1113,6 +1313,107 @@ func (c *Omics) CreateSequenceStoreWithContext(ctx aws.Context, input *CreateSeq return out, req.Send() } +const opCreateShare = "CreateShare" + +// CreateShareRequest generates a "aws/request.Request" representing the +// client's request for the CreateShare operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateShare for more information on using the CreateShare +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateShareRequest method. +// req, resp := client.CreateShareRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateShare +func (c *Omics) CreateShareRequest(input *CreateShareInput) (req *request.Request, output *CreateShareOutput) { + op := &request.Operation{ + Name: opCreateShare, + HTTPMethod: "POST", + HTTPPath: "/share", + } + + if input == nil { + input = &CreateShareInput{} + } + + output = &CreateShareOutput{} + req = c.newRequest(op, input, output) + + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// CreateShare API operation for Amazon Omics. +// +// Creates a share offer that can be accepted outside the account by a subscriber. +// The share is created by the owner and accepted by the principal subscriber. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Omics's +// API operation CreateShare for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// An unexpected error occurred. Try the request again. +// +// - ServiceQuotaExceededException +// The request exceeds a service quota. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ConflictException +// The request cannot be applied to the target resource in its current state. +// +// - ResourceNotFoundException +// The target resource was not found in the current Region. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateShare +func (c *Omics) CreateShare(input *CreateShareInput) (*CreateShareOutput, error) { + req, out := c.CreateShareRequest(input) + return out, req.Send() +} + +// CreateShareWithContext is the same as CreateShare with the addition of +// the ability to pass a context and additional request options. +// +// See CreateShare for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) CreateShareWithContext(ctx aws.Context, input *CreateShareInput, opts ...request.Option) (*CreateShareOutput, error) { + req, out := c.CreateShareRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateVariantStore = "CreateVariantStore" // CreateVariantStoreRequest generates a "aws/request.Request" representing the @@ -1413,61 +1714,60 @@ func (c *Omics) DeleteAnnotationStoreWithContext(ctx aws.Context, input *DeleteA return out, req.Send() } -const opDeleteReference = "DeleteReference" +const opDeleteAnnotationStoreVersions = "DeleteAnnotationStoreVersions" -// DeleteReferenceRequest generates a "aws/request.Request" representing the -// client's request for the DeleteReference operation. The "output" return +// DeleteAnnotationStoreVersionsRequest generates a "aws/request.Request" representing the +// client's request for the DeleteAnnotationStoreVersions operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See DeleteReference for more information on using the DeleteReference +// See DeleteAnnotationStoreVersions for more information on using the DeleteAnnotationStoreVersions // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the DeleteReferenceRequest method. -// req, resp := client.DeleteReferenceRequest(params) +// // Example sending a request using the DeleteAnnotationStoreVersionsRequest method. +// req, resp := client.DeleteAnnotationStoreVersionsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteReference -func (c *Omics) DeleteReferenceRequest(input *DeleteReferenceInput) (req *request.Request, output *DeleteReferenceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteAnnotationStoreVersions +func (c *Omics) DeleteAnnotationStoreVersionsRequest(input *DeleteAnnotationStoreVersionsInput) (req *request.Request, output *DeleteAnnotationStoreVersionsOutput) { op := &request.Operation{ - Name: opDeleteReference, - HTTPMethod: "DELETE", - HTTPPath: "/referencestore/{referenceStoreId}/reference/{id}", + Name: opDeleteAnnotationStoreVersions, + HTTPMethod: "POST", + HTTPPath: "/annotationStore/{name}/versions/delete", } if input == nil { - input = &DeleteReferenceInput{} + input = &DeleteAnnotationStoreVersionsInput{} } - output = &DeleteReferenceOutput{} + output = &DeleteAnnotationStoreVersionsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return } -// DeleteReference API operation for Amazon Omics. +// DeleteAnnotationStoreVersions API operation for Amazon Omics. // -// Deletes a genome reference. +// Deletes one or multiple versions of an annotation store. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Omics's -// API operation DeleteReference for usage and error information. +// API operation DeleteAnnotationStoreVersions for usage and error information. // // Returned Error Types: // @@ -1489,8 +1789,106 @@ func (c *Omics) DeleteReferenceRequest(input *DeleteReferenceInput) (req *reques // - AccessDeniedException // You do not have sufficient access to perform this action. // -// - RequestTimeoutException -// The request timed out. +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteAnnotationStoreVersions +func (c *Omics) DeleteAnnotationStoreVersions(input *DeleteAnnotationStoreVersionsInput) (*DeleteAnnotationStoreVersionsOutput, error) { + req, out := c.DeleteAnnotationStoreVersionsRequest(input) + return out, req.Send() +} + +// DeleteAnnotationStoreVersionsWithContext is the same as DeleteAnnotationStoreVersions with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteAnnotationStoreVersions for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) DeleteAnnotationStoreVersionsWithContext(ctx aws.Context, input *DeleteAnnotationStoreVersionsInput, opts ...request.Option) (*DeleteAnnotationStoreVersionsOutput, error) { + req, out := c.DeleteAnnotationStoreVersionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteReference = "DeleteReference" + +// DeleteReferenceRequest generates a "aws/request.Request" representing the +// client's request for the DeleteReference operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteReference for more information on using the DeleteReference +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteReferenceRequest method. +// req, resp := client.DeleteReferenceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteReference +func (c *Omics) DeleteReferenceRequest(input *DeleteReferenceInput) (req *request.Request, output *DeleteReferenceOutput) { + op := &request.Operation{ + Name: opDeleteReference, + HTTPMethod: "DELETE", + HTTPPath: "/referencestore/{referenceStoreId}/reference/{id}", + } + + if input == nil { + input = &DeleteReferenceInput{} + } + + output = &DeleteReferenceOutput{} + req = c.newRequest(op, input, output) + + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// DeleteReference API operation for Amazon Omics. +// +// Deletes a genome reference. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Omics's +// API operation DeleteReference for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// An unexpected error occurred. Try the request again. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ConflictException +// The request cannot be applied to the target resource in its current state. +// +// - ResourceNotFoundException +// The target resource was not found in the current Region. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// - RequestTimeoutException +// The request timed out. // // See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteReference func (c *Omics) DeleteReference(input *DeleteReferenceInput) (*DeleteReferenceOutput, error) { @@ -1924,6 +2322,106 @@ func (c *Omics) DeleteSequenceStoreWithContext(ctx aws.Context, input *DeleteSeq return out, req.Send() } +const opDeleteShare = "DeleteShare" + +// DeleteShareRequest generates a "aws/request.Request" representing the +// client's request for the DeleteShare operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteShare for more information on using the DeleteShare +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteShareRequest method. +// req, resp := client.DeleteShareRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteShare +func (c *Omics) DeleteShareRequest(input *DeleteShareInput) (req *request.Request, output *DeleteShareOutput) { + op := &request.Operation{ + Name: opDeleteShare, + HTTPMethod: "DELETE", + HTTPPath: "/share/{shareId}", + } + + if input == nil { + input = &DeleteShareInput{} + } + + output = &DeleteShareOutput{} + req = c.newRequest(op, input, output) + + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// DeleteShare API operation for Amazon Omics. +// +// Deletes a share of an analytics store. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Omics's +// API operation DeleteShare for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// An unexpected error occurred. Try the request again. +// +// - ServiceQuotaExceededException +// The request exceeds a service quota. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ConflictException +// The request cannot be applied to the target resource in its current state. +// +// - ResourceNotFoundException +// The target resource was not found in the current Region. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteShare +func (c *Omics) DeleteShare(input *DeleteShareInput) (*DeleteShareOutput, error) { + req, out := c.DeleteShareRequest(input) + return out, req.Send() +} + +// DeleteShareWithContext is the same as DeleteShare with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteShare for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) DeleteShareWithContext(ctx aws.Context, input *DeleteShareInput, opts ...request.Option) (*DeleteShareOutput, error) { + req, out := c.DeleteShareRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteVariantStore = "DeleteVariantStore" // DeleteVariantStoreRequest generates a "aws/request.Request" representing the @@ -2313,6 +2811,100 @@ func (c *Omics) GetAnnotationStoreWithContext(ctx aws.Context, input *GetAnnotat return out, req.Send() } +const opGetAnnotationStoreVersion = "GetAnnotationStoreVersion" + +// GetAnnotationStoreVersionRequest generates a "aws/request.Request" representing the +// client's request for the GetAnnotationStoreVersion operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetAnnotationStoreVersion for more information on using the GetAnnotationStoreVersion +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetAnnotationStoreVersionRequest method. +// req, resp := client.GetAnnotationStoreVersionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetAnnotationStoreVersion +func (c *Omics) GetAnnotationStoreVersionRequest(input *GetAnnotationStoreVersionInput) (req *request.Request, output *GetAnnotationStoreVersionOutput) { + op := &request.Operation{ + Name: opGetAnnotationStoreVersion, + HTTPMethod: "GET", + HTTPPath: "/annotationStore/{name}/version/{versionName}", + } + + if input == nil { + input = &GetAnnotationStoreVersionInput{} + } + + output = &GetAnnotationStoreVersionOutput{} + req = c.newRequest(op, input, output) + + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// GetAnnotationStoreVersion API operation for Amazon Omics. +// +// Retrieves the metadata for an annotation store version. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Omics's +// API operation GetAnnotationStoreVersion for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// An unexpected error occurred. Try the request again. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ResourceNotFoundException +// The target resource was not found in the current Region. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetAnnotationStoreVersion +func (c *Omics) GetAnnotationStoreVersion(input *GetAnnotationStoreVersionInput) (*GetAnnotationStoreVersionOutput, error) { + req, out := c.GetAnnotationStoreVersionRequest(input) + return out, req.Send() +} + +// GetAnnotationStoreVersionWithContext is the same as GetAnnotationStoreVersion with the addition of +// the ability to pass a context and additional request options. +// +// See GetAnnotationStoreVersion for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) GetAnnotationStoreVersionWithContext(ctx aws.Context, input *GetAnnotationStoreVersionInput, opts ...request.Option) (*GetAnnotationStoreVersionOutput, error) { + req, out := c.GetAnnotationStoreVersionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetReadSet = "GetReadSet" // GetReadSetRequest generates a "aws/request.Request" representing the @@ -3601,43 +4193,43 @@ func (c *Omics) GetSequenceStoreWithContext(ctx aws.Context, input *GetSequenceS return out, req.Send() } -const opGetVariantImportJob = "GetVariantImportJob" +const opGetShare = "GetShare" -// GetVariantImportJobRequest generates a "aws/request.Request" representing the -// client's request for the GetVariantImportJob operation. The "output" return +// GetShareRequest generates a "aws/request.Request" representing the +// client's request for the GetShare operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See GetVariantImportJob for more information on using the GetVariantImportJob +// See GetShare for more information on using the GetShare // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the GetVariantImportJobRequest method. -// req, resp := client.GetVariantImportJobRequest(params) +// // Example sending a request using the GetShareRequest method. +// req, resp := client.GetShareRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetVariantImportJob -func (c *Omics) GetVariantImportJobRequest(input *GetVariantImportJobInput) (req *request.Request, output *GetVariantImportJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetShare +func (c *Omics) GetShareRequest(input *GetShareInput) (req *request.Request, output *GetShareOutput) { op := &request.Operation{ - Name: opGetVariantImportJob, + Name: opGetShare, HTTPMethod: "GET", - HTTPPath: "/import/variant/{jobId}", + HTTPPath: "/share/{shareId}", } if input == nil { - input = &GetVariantImportJobInput{} + input = &GetShareInput{} } - output = &GetVariantImportJobOutput{} + output = &GetShareOutput{} req = c.newRequest(op, input, output) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) @@ -3645,7 +4237,107 @@ func (c *Omics) GetVariantImportJobRequest(input *GetVariantImportJobInput) (req return } -// GetVariantImportJob API operation for Amazon Omics. +// GetShare API operation for Amazon Omics. +// +// Retrieves the metadata for a share. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Omics's +// API operation GetShare for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// An unexpected error occurred. Try the request again. +// +// - ServiceQuotaExceededException +// The request exceeds a service quota. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ConflictException +// The request cannot be applied to the target resource in its current state. +// +// - ResourceNotFoundException +// The target resource was not found in the current Region. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetShare +func (c *Omics) GetShare(input *GetShareInput) (*GetShareOutput, error) { + req, out := c.GetShareRequest(input) + return out, req.Send() +} + +// GetShareWithContext is the same as GetShare with the addition of +// the ability to pass a context and additional request options. +// +// See GetShare for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) GetShareWithContext(ctx aws.Context, input *GetShareInput, opts ...request.Option) (*GetShareOutput, error) { + req, out := c.GetShareRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetVariantImportJob = "GetVariantImportJob" + +// GetVariantImportJobRequest generates a "aws/request.Request" representing the +// client's request for the GetVariantImportJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetVariantImportJob for more information on using the GetVariantImportJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetVariantImportJobRequest method. +// req, resp := client.GetVariantImportJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetVariantImportJob +func (c *Omics) GetVariantImportJobRequest(input *GetVariantImportJobInput) (req *request.Request, output *GetVariantImportJobOutput) { + op := &request.Operation{ + Name: opGetVariantImportJob, + HTTPMethod: "GET", + HTTPPath: "/import/variant/{jobId}", + } + + if input == nil { + input = &GetVariantImportJobInput{} + } + + output = &GetVariantImportJobOutput{} + req = c.newRequest(op, input, output) + + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// GetVariantImportJob API operation for Amazon Omics. // // Gets information about a variant import job. // @@ -4043,6 +4735,157 @@ func (c *Omics) ListAnnotationImportJobsPagesWithContext(ctx aws.Context, input return p.Err() } +const opListAnnotationStoreVersions = "ListAnnotationStoreVersions" + +// ListAnnotationStoreVersionsRequest generates a "aws/request.Request" representing the +// client's request for the ListAnnotationStoreVersions operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListAnnotationStoreVersions for more information on using the ListAnnotationStoreVersions +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListAnnotationStoreVersionsRequest method. +// req, resp := client.ListAnnotationStoreVersionsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListAnnotationStoreVersions +func (c *Omics) ListAnnotationStoreVersionsRequest(input *ListAnnotationStoreVersionsInput) (req *request.Request, output *ListAnnotationStoreVersionsOutput) { + op := &request.Operation{ + Name: opListAnnotationStoreVersions, + HTTPMethod: "POST", + HTTPPath: "/annotationStore/{name}/versions", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAnnotationStoreVersionsInput{} + } + + output = &ListAnnotationStoreVersionsOutput{} + req = c.newRequest(op, input, output) + + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// ListAnnotationStoreVersions API operation for Amazon Omics. +// +// Lists the versions of an annotation store. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Omics's +// API operation ListAnnotationStoreVersions for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// An unexpected error occurred. Try the request again. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ResourceNotFoundException +// The target resource was not found in the current Region. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListAnnotationStoreVersions +func (c *Omics) ListAnnotationStoreVersions(input *ListAnnotationStoreVersionsInput) (*ListAnnotationStoreVersionsOutput, error) { + req, out := c.ListAnnotationStoreVersionsRequest(input) + return out, req.Send() +} + +// ListAnnotationStoreVersionsWithContext is the same as ListAnnotationStoreVersions with the addition of +// the ability to pass a context and additional request options. +// +// See ListAnnotationStoreVersions for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) ListAnnotationStoreVersionsWithContext(ctx aws.Context, input *ListAnnotationStoreVersionsInput, opts ...request.Option) (*ListAnnotationStoreVersionsOutput, error) { + req, out := c.ListAnnotationStoreVersionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAnnotationStoreVersionsPages iterates over the pages of a ListAnnotationStoreVersions operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAnnotationStoreVersions method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListAnnotationStoreVersions operation. +// pageNum := 0 +// err := client.ListAnnotationStoreVersionsPages(params, +// func(page *omics.ListAnnotationStoreVersionsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Omics) ListAnnotationStoreVersionsPages(input *ListAnnotationStoreVersionsInput, fn func(*ListAnnotationStoreVersionsOutput, bool) bool) error { + return c.ListAnnotationStoreVersionsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAnnotationStoreVersionsPagesWithContext same as ListAnnotationStoreVersionsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) ListAnnotationStoreVersionsPagesWithContext(ctx aws.Context, input *ListAnnotationStoreVersionsInput, fn func(*ListAnnotationStoreVersionsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAnnotationStoreVersionsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAnnotationStoreVersionsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAnnotationStoreVersionsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListAnnotationStores = "ListAnnotationStores" // ListAnnotationStoresRequest generates a "aws/request.Request" representing the @@ -6221,60 +7064,66 @@ func (c *Omics) ListSequenceStoresPagesWithContext(ctx aws.Context, input *ListS return p.Err() } -const opListTagsForResource = "ListTagsForResource" +const opListShares = "ListShares" -// ListTagsForResourceRequest generates a "aws/request.Request" representing the -// client's request for the ListTagsForResource operation. The "output" return +// ListSharesRequest generates a "aws/request.Request" representing the +// client's request for the ListShares operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListTagsForResource for more information on using the ListTagsForResource +// See ListShares for more information on using the ListShares // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListTagsForResourceRequest method. -// req, resp := client.ListTagsForResourceRequest(params) +// // Example sending a request using the ListSharesRequest method. +// req, resp := client.ListSharesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListTagsForResource -func (c *Omics) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListShares +func (c *Omics) ListSharesRequest(input *ListSharesInput) (req *request.Request, output *ListSharesOutput) { op := &request.Operation{ - Name: opListTagsForResource, - HTTPMethod: "GET", - HTTPPath: "/tags/{resourceArn}", + Name: opListShares, + HTTPMethod: "POST", + HTTPPath: "/shares", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { - input = &ListTagsForResourceInput{} + input = &ListSharesInput{} } - output = &ListTagsForResourceOutput{} + output = &ListSharesOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("tags-", nil)) + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return } -// ListTagsForResource API operation for Amazon Omics. +// ListShares API operation for Amazon Omics. // -// Retrieves a list of tags for a resource. +// Lists all shares associated with an account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Omics's -// API operation ListTagsForResource for usage and error information. +// API operation ListShares for usage and error information. // // Returned Error Types: // @@ -6299,43 +7148,194 @@ func (c *Omics) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req // - AccessDeniedException // You do not have sufficient access to perform this action. // -// - RequestTimeoutException -// The request timed out. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListTagsForResource -func (c *Omics) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { - req, out := c.ListTagsForResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListShares +func (c *Omics) ListShares(input *ListSharesInput) (*ListSharesOutput, error) { + req, out := c.ListSharesRequest(input) return out, req.Send() } -// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// ListSharesWithContext is the same as ListShares with the addition of // the ability to pass a context and additional request options. // -// See ListTagsForResource for details on how to use this API operation. +// See ListShares for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Omics) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { - req, out := c.ListTagsForResourceRequest(input) +func (c *Omics) ListSharesWithContext(ctx aws.Context, input *ListSharesInput, opts ...request.Option) (*ListSharesOutput, error) { + req, out := c.ListSharesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opListVariantImportJobs = "ListVariantImportJobs" - -// ListVariantImportJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListVariantImportJobs operation. The "output" return -// value will be populated with the request's response once the request completes -// successfully. +// ListSharesPages iterates over the pages of a ListShares operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. // -// Use "Send" method on the returned Request to send the API call to the service. -// the "output" return value is not valid until after Send returns without error. +// See ListShares method for more information on how to use this operation. // -// See ListVariantImportJobs for more information on using the ListVariantImportJobs -// API call, and error handling. +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListShares operation. +// pageNum := 0 +// err := client.ListSharesPages(params, +// func(page *omics.ListSharesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Omics) ListSharesPages(input *ListSharesInput, fn func(*ListSharesOutput, bool) bool) error { + return c.ListSharesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSharesPagesWithContext same as ListSharesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) ListSharesPagesWithContext(ctx aws.Context, input *ListSharesInput, fn func(*ListSharesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSharesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSharesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSharesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListTagsForResource +func (c *Omics) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("tags-", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// ListTagsForResource API operation for Amazon Omics. +// +// Retrieves a list of tags for a resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Omics's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// An unexpected error occurred. Try the request again. +// +// - ServiceQuotaExceededException +// The request exceeds a service quota. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ConflictException +// The request cannot be applied to the target resource in its current state. +// +// - ResourceNotFoundException +// The target resource was not found in the current Region. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// - RequestTimeoutException +// The request timed out. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListTagsForResource +func (c *Omics) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListVariantImportJobs = "ListVariantImportJobs" + +// ListVariantImportJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListVariantImportJobs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListVariantImportJobs for more information on using the ListVariantImportJobs +// API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. @@ -7786,6 +8786,100 @@ func (c *Omics) UpdateAnnotationStoreWithContext(ctx aws.Context, input *UpdateA return out, req.Send() } +const opUpdateAnnotationStoreVersion = "UpdateAnnotationStoreVersion" + +// UpdateAnnotationStoreVersionRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAnnotationStoreVersion operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateAnnotationStoreVersion for more information on using the UpdateAnnotationStoreVersion +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UpdateAnnotationStoreVersionRequest method. +// req, resp := client.UpdateAnnotationStoreVersionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateAnnotationStoreVersion +func (c *Omics) UpdateAnnotationStoreVersionRequest(input *UpdateAnnotationStoreVersionInput) (req *request.Request, output *UpdateAnnotationStoreVersionOutput) { + op := &request.Operation{ + Name: opUpdateAnnotationStoreVersion, + HTTPMethod: "POST", + HTTPPath: "/annotationStore/{name}/version/{versionName}", + } + + if input == nil { + input = &UpdateAnnotationStoreVersionInput{} + } + + output = &UpdateAnnotationStoreVersionOutput{} + req = c.newRequest(op, input, output) + + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// UpdateAnnotationStoreVersion API operation for Amazon Omics. +// +// Updates the description of an annotation store version. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Omics's +// API operation UpdateAnnotationStoreVersion for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// An unexpected error occurred. Try the request again. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ResourceNotFoundException +// The target resource was not found in the current Region. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateAnnotationStoreVersion +func (c *Omics) UpdateAnnotationStoreVersion(input *UpdateAnnotationStoreVersionInput) (*UpdateAnnotationStoreVersionOutput, error) { + req, out := c.UpdateAnnotationStoreVersionRequest(input) + return out, req.Send() +} + +// UpdateAnnotationStoreVersionWithContext is the same as UpdateAnnotationStoreVersion with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateAnnotationStoreVersion for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) UpdateAnnotationStoreVersionWithContext(ctx aws.Context, input *UpdateAnnotationStoreVersionInput, opts ...request.Option) (*UpdateAnnotationStoreVersionOutput, error) { + req, out := c.UpdateAnnotationStoreVersionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateRunGroup = "UpdateRunGroup" // UpdateRunGroupRequest generates a "aws/request.Request" representing the @@ -8283,12 +9377,13 @@ func (s AbortMultipartReadSetUploadOutput) GoString() string { return s.String() } -// You do not have sufficient access to perform this action. -type AccessDeniedException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +type AcceptShareInput struct { + _ struct{} `type:"structure" nopayload:"true"` - Message_ *string `locationName:"message" type:"string"` + // The ID for a share offer for analytics store data. + // + // ShareId is a required field + ShareId *string `location:"uri" locationName:"shareId" type:"string" required:"true"` } // String returns the string representation. @@ -8296,7 +9391,7 @@ type AccessDeniedException struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s AccessDeniedException) String() string { +func (s AcceptShareInput) String() string { return awsutil.Prettify(s) } @@ -8305,39 +9400,118 @@ func (s AccessDeniedException) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s AccessDeniedException) GoString() string { +func (s AcceptShareInput) GoString() string { return s.String() } -func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { - return &AccessDeniedException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *AcceptShareInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AcceptShareInput"} + if s.ShareId == nil { + invalidParams.Add(request.NewErrParamRequired("ShareId")) } -} - -// Code returns the exception type name. -func (s *AccessDeniedException) Code() string { - return "AccessDeniedException" -} - -// Message returns the exception's message. -func (s *AccessDeniedException) Message() string { - if s.Message_ != nil { - return *s.Message_ + if s.ShareId != nil && len(*s.ShareId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ShareId", 1)) } - return "" -} -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *AccessDeniedException) OrigErr() error { + if invalidParams.Len() > 0 { + return invalidParams + } return nil } -func (s *AccessDeniedException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetShareId sets the ShareId field's value. +func (s *AcceptShareInput) SetShareId(v string) *AcceptShareInput { + s.ShareId = &v + return s } -// Status code returns the HTTP status code for the request's response error. +type AcceptShareOutput struct { + _ struct{} `type:"structure"` + + // The status of an analytics store share. + Status *string `locationName:"status" type:"string" enum:"ShareStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AcceptShareOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AcceptShareOutput) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *AcceptShareOutput) SetStatus(v string) *AcceptShareOutput { + s.Status = &v + return s +} + +// You do not have sufficient access to perform this action. +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AccessDeniedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. func (s *AccessDeniedException) StatusCode() int { return s.RespMetadata.StatusCode } @@ -8661,6 +9835,11 @@ type AnnotationImportJobItem struct { // // UpdateTime is a required field UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The name of the annotation store version. + // + // VersionName is a required field + VersionName *string `locationName:"versionName" min:"3" type:"string" required:"true"` } // String returns the string representation. @@ -8735,6 +9914,12 @@ func (s *AnnotationImportJobItem) SetUpdateTime(v time.Time) *AnnotationImportJo return s } +// SetVersionName sets the VersionName field's value. +func (s *AnnotationImportJobItem) SetVersionName(v string) *AnnotationImportJobItem { + s.VersionName = &v + return s +} + // An annotation store. type AnnotationStoreItem struct { _ struct{} `type:"structure"` @@ -8890,6 +10075,150 @@ func (s *AnnotationStoreItem) SetUpdateTime(v time.Time) *AnnotationStoreItem { return s } +// Annotation store versions. +type AnnotationStoreVersionItem struct { + _ struct{} `type:"structure"` + + // The time stamp for when an annotation store version was created. + // + // CreationTime is a required field + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The description of an annotation store version. + // + // Description is a required field + Description *string `locationName:"description" type:"string" required:"true"` + + // The annotation store version ID. + // + // Id is a required field + Id *string `locationName:"id" type:"string" required:"true"` + + // A name given to an annotation store version to distinguish it from others. + // + // Name is a required field + Name *string `locationName:"name" min:"3" type:"string" required:"true"` + + // The status of an annotation store version. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"VersionStatus"` + + // The status of an annotation store version. + // + // StatusMessage is a required field + StatusMessage *string `locationName:"statusMessage" type:"string" required:"true"` + + // The store ID for an annotation store version. + // + // StoreId is a required field + StoreId *string `locationName:"storeId" type:"string" required:"true"` + + // The time stamp for when an annotation store version was updated. + // + // UpdateTime is a required field + UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The Arn for an annotation store version. + // + // VersionArn is a required field + VersionArn *string `locationName:"versionArn" min:"20" type:"string" required:"true"` + + // The name of an annotation store version. + // + // VersionName is a required field + VersionName *string `locationName:"versionName" min:"3" type:"string" required:"true"` + + // The size of an annotation store version in Bytes. + // + // VersionSizeBytes is a required field + VersionSizeBytes *int64 `locationName:"versionSizeBytes" type:"long" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnnotationStoreVersionItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnnotationStoreVersionItem) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *AnnotationStoreVersionItem) SetCreationTime(v time.Time) *AnnotationStoreVersionItem { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *AnnotationStoreVersionItem) SetDescription(v string) *AnnotationStoreVersionItem { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *AnnotationStoreVersionItem) SetId(v string) *AnnotationStoreVersionItem { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *AnnotationStoreVersionItem) SetName(v string) *AnnotationStoreVersionItem { + s.Name = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *AnnotationStoreVersionItem) SetStatus(v string) *AnnotationStoreVersionItem { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *AnnotationStoreVersionItem) SetStatusMessage(v string) *AnnotationStoreVersionItem { + s.StatusMessage = &v + return s +} + +// SetStoreId sets the StoreId field's value. +func (s *AnnotationStoreVersionItem) SetStoreId(v string) *AnnotationStoreVersionItem { + s.StoreId = &v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *AnnotationStoreVersionItem) SetUpdateTime(v time.Time) *AnnotationStoreVersionItem { + s.UpdateTime = &v + return s +} + +// SetVersionArn sets the VersionArn field's value. +func (s *AnnotationStoreVersionItem) SetVersionArn(v string) *AnnotationStoreVersionItem { + s.VersionArn = &v + return s +} + +// SetVersionName sets the VersionName field's value. +func (s *AnnotationStoreVersionItem) SetVersionName(v string) *AnnotationStoreVersionItem { + s.VersionName = &v + return s +} + +// SetVersionSizeBytes sets the VersionSizeBytes field's value. +func (s *AnnotationStoreVersionItem) SetVersionSizeBytes(v int64) *AnnotationStoreVersionItem { + s.VersionSizeBytes = &v + return s +} + type BatchDeleteReadSetInput struct { _ struct{} `type:"structure"` @@ -9473,7 +10802,7 @@ type CreateAnnotationStoreInput struct { Description *string `locationName:"description" type:"string"` // A name for the store. - Name *string `locationName:"name" type:"string"` + Name *string `locationName:"name" min:"3" type:"string"` // The genome reference for the store's annotations. Reference *ReferenceItem `locationName:"reference" type:"structure"` @@ -9491,6 +10820,10 @@ type CreateAnnotationStoreInput struct { // Tags for the store. Tags map[string]*string `locationName:"tags" type:"map"` + + // The name given to an annotation store version to distinguish it from other + // versions. + VersionName *string `locationName:"versionName" min:"3" type:"string"` } // String returns the string representation. @@ -9514,9 +10847,15 @@ func (s CreateAnnotationStoreInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateAnnotationStoreInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CreateAnnotationStoreInput"} + if s.Name != nil && len(*s.Name) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Name", 3)) + } if s.StoreFormat == nil { invalidParams.Add(request.NewErrParamRequired("StoreFormat")) } + if s.VersionName != nil && len(*s.VersionName) < 3 { + invalidParams.Add(request.NewErrParamMinLen("VersionName", 3)) + } if s.Reference != nil { if err := s.Reference.Validate(); err != nil { invalidParams.AddNested("Reference", err.(request.ErrInvalidParams)) @@ -9581,6 +10920,12 @@ func (s *CreateAnnotationStoreInput) SetTags(v map[string]*string) *CreateAnnota return s } +// SetVersionName sets the VersionName field's value. +func (s *CreateAnnotationStoreInput) SetVersionName(v string) *CreateAnnotationStoreInput { + s.VersionName = &v + return s +} + type CreateAnnotationStoreOutput struct { _ struct{} `type:"structure"` @@ -9613,6 +10958,12 @@ type CreateAnnotationStoreOutput struct { // The store's file parsing options. StoreOptions *StoreOptions `locationName:"storeOptions" type:"structure"` + + // The name given to an annotation store version to distinguish it from other + // versions. + // + // VersionName is a required field + VersionName *string `locationName:"versionName" min:"3" type:"string" required:"true"` } // String returns the string representation. @@ -9675,52 +11026,34 @@ func (s *CreateAnnotationStoreOutput) SetStoreOptions(v *StoreOptions) *CreateAn return s } -type CreateMultipartReadSetUploadInput struct { - _ struct{} `type:"structure"` - - // An idempotency token that can be used to avoid triggering multiple multipart - // uploads. - ClientToken *string `locationName:"clientToken" min:"1" type:"string"` +// SetVersionName sets the VersionName field's value. +func (s *CreateAnnotationStoreOutput) SetVersionName(v string) *CreateAnnotationStoreOutput { + s.VersionName = &v + return s +} - // The description of the read set. - Description *string `locationName:"description" min:"1" type:"string"` +type CreateAnnotationStoreVersionInput struct { + _ struct{} `type:"structure"` - // Where the source originated. - GeneratedFrom *string `locationName:"generatedFrom" min:"1" type:"string"` + // The description of an annotation store version. + Description *string `locationName:"description" type:"string"` - // The name of the read set. + // The name of an annotation store version from which versions are being created. // // Name is a required field - Name *string `locationName:"name" min:"1" type:"string" required:"true"` - - // The ARN of the reference. - // - // ReferenceArn is a required field - ReferenceArn *string `locationName:"referenceArn" min:"1" type:"string" required:"true"` - - // The source's sample ID. - // - // SampleId is a required field - SampleId *string `locationName:"sampleId" min:"1" type:"string" required:"true"` - - // The sequence store ID for the store that is the destination of the multipart - // uploads. - // - // SequenceStoreId is a required field - SequenceStoreId *string `location:"uri" locationName:"sequenceStoreId" min:"10" type:"string" required:"true"` + Name *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"` - // The type of file being uploaded. - // - // SourceFileType is a required field - SourceFileType *string `locationName:"sourceFileType" type:"string" required:"true" enum:"FileType"` + // Any tags added to annotation store version. + Tags map[string]*string `locationName:"tags" type:"map"` - // The source's subject ID. + // The name given to an annotation store version to distinguish it from other + // versions. // - // SubjectId is a required field - SubjectId *string `locationName:"subjectId" min:"1" type:"string" required:"true"` + // VersionName is a required field + VersionName *string `locationName:"versionName" min:"3" type:"string" required:"true"` - // Any tags to add to the read set. - Tags map[string]*string `locationName:"tags" type:"map"` + // The options for an annotation store version. + VersionOptions *VersionOptions `locationName:"versionOptions" type:"structure"` } // String returns the string representation. @@ -9728,7 +11061,7 @@ type CreateMultipartReadSetUploadInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateMultipartReadSetUploadInput) String() string { +func (s CreateAnnotationStoreVersionInput) String() string { return awsutil.Prettify(s) } @@ -9737,27 +11070,249 @@ func (s CreateMultipartReadSetUploadInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateMultipartReadSetUploadInput) GoString() string { +func (s CreateAnnotationStoreVersionInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateMultipartReadSetUploadInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateMultipartReadSetUploadInput"} - if s.ClientToken != nil && len(*s.ClientToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) - } - if s.Description != nil && len(*s.Description) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Description", 1)) - } - if s.GeneratedFrom != nil && len(*s.GeneratedFrom) < 1 { - invalidParams.Add(request.NewErrParamMinLen("GeneratedFrom", 1)) - } +func (s *CreateAnnotationStoreVersionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAnnotationStoreVersionInput"} if s.Name == nil { invalidParams.Add(request.NewErrParamRequired("Name")) } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + if s.Name != nil && len(*s.Name) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Name", 3)) + } + if s.VersionName == nil { + invalidParams.Add(request.NewErrParamRequired("VersionName")) + } + if s.VersionName != nil && len(*s.VersionName) < 3 { + invalidParams.Add(request.NewErrParamMinLen("VersionName", 3)) + } + if s.VersionOptions != nil { + if err := s.VersionOptions.Validate(); err != nil { + invalidParams.AddNested("VersionOptions", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *CreateAnnotationStoreVersionInput) SetDescription(v string) *CreateAnnotationStoreVersionInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateAnnotationStoreVersionInput) SetName(v string) *CreateAnnotationStoreVersionInput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateAnnotationStoreVersionInput) SetTags(v map[string]*string) *CreateAnnotationStoreVersionInput { + s.Tags = v + return s +} + +// SetVersionName sets the VersionName field's value. +func (s *CreateAnnotationStoreVersionInput) SetVersionName(v string) *CreateAnnotationStoreVersionInput { + s.VersionName = &v + return s +} + +// SetVersionOptions sets the VersionOptions field's value. +func (s *CreateAnnotationStoreVersionInput) SetVersionOptions(v *VersionOptions) *CreateAnnotationStoreVersionInput { + s.VersionOptions = v + return s +} + +type CreateAnnotationStoreVersionOutput struct { + _ struct{} `type:"structure"` + + // The time stamp for the creation of an annotation store version. + // + // CreationTime is a required field + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // A generated ID for the annotation store + // + // Id is a required field + Id *string `locationName:"id" type:"string" required:"true"` + + // The name given to an annotation store version to distinguish it from other + // versions. + // + // Name is a required field + Name *string `locationName:"name" min:"3" type:"string" required:"true"` + + // The status of a annotation store version. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"VersionStatus"` + + // The ID for the annotation store from which new versions are being created. + // + // StoreId is a required field + StoreId *string `locationName:"storeId" type:"string" required:"true"` + + // The name given to an annotation store version to distinguish it from other + // versions. + // + // VersionName is a required field + VersionName *string `locationName:"versionName" min:"3" type:"string" required:"true"` + + // The options for an annotation store version. + VersionOptions *VersionOptions `locationName:"versionOptions" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateAnnotationStoreVersionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateAnnotationStoreVersionOutput) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *CreateAnnotationStoreVersionOutput) SetCreationTime(v time.Time) *CreateAnnotationStoreVersionOutput { + s.CreationTime = &v + return s +} + +// SetId sets the Id field's value. +func (s *CreateAnnotationStoreVersionOutput) SetId(v string) *CreateAnnotationStoreVersionOutput { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateAnnotationStoreVersionOutput) SetName(v string) *CreateAnnotationStoreVersionOutput { + s.Name = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *CreateAnnotationStoreVersionOutput) SetStatus(v string) *CreateAnnotationStoreVersionOutput { + s.Status = &v + return s +} + +// SetStoreId sets the StoreId field's value. +func (s *CreateAnnotationStoreVersionOutput) SetStoreId(v string) *CreateAnnotationStoreVersionOutput { + s.StoreId = &v + return s +} + +// SetVersionName sets the VersionName field's value. +func (s *CreateAnnotationStoreVersionOutput) SetVersionName(v string) *CreateAnnotationStoreVersionOutput { + s.VersionName = &v + return s +} + +// SetVersionOptions sets the VersionOptions field's value. +func (s *CreateAnnotationStoreVersionOutput) SetVersionOptions(v *VersionOptions) *CreateAnnotationStoreVersionOutput { + s.VersionOptions = v + return s +} + +type CreateMultipartReadSetUploadInput struct { + _ struct{} `type:"structure"` + + // An idempotency token that can be used to avoid triggering multiple multipart + // uploads. + ClientToken *string `locationName:"clientToken" min:"1" type:"string"` + + // The description of the read set. + Description *string `locationName:"description" min:"1" type:"string"` + + // Where the source originated. + GeneratedFrom *string `locationName:"generatedFrom" min:"1" type:"string"` + + // The name of the read set. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The ARN of the reference. + // + // ReferenceArn is a required field + ReferenceArn *string `locationName:"referenceArn" min:"1" type:"string" required:"true"` + + // The source's sample ID. + // + // SampleId is a required field + SampleId *string `locationName:"sampleId" min:"1" type:"string" required:"true"` + + // The sequence store ID for the store that is the destination of the multipart + // uploads. + // + // SequenceStoreId is a required field + SequenceStoreId *string `location:"uri" locationName:"sequenceStoreId" min:"10" type:"string" required:"true"` + + // The type of file being uploaded. + // + // SourceFileType is a required field + SourceFileType *string `locationName:"sourceFileType" type:"string" required:"true" enum:"FileType"` + + // The source's subject ID. + // + // SubjectId is a required field + SubjectId *string `locationName:"subjectId" min:"1" type:"string" required:"true"` + + // Any tags to add to the read set. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMultipartReadSetUploadInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMultipartReadSetUploadInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateMultipartReadSetUploadInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateMultipartReadSetUploadInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.GeneratedFrom != nil && len(*s.GeneratedFrom) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GeneratedFrom", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } if s.ReferenceArn == nil { invalidParams.Add(request.NewErrParamRequired("ReferenceArn")) @@ -10527,6 +12082,128 @@ func (s *CreateSequenceStoreOutput) SetSseConfig(v *SseConfig) *CreateSequenceSt return s } +type CreateShareInput struct { + _ struct{} `type:"structure"` + + // The principal subscriber is the account being given access to the analytics + // store data through the share offer. + // + // PrincipalSubscriber is a required field + PrincipalSubscriber *string `locationName:"principalSubscriber" type:"string" required:"true"` + + // The resource ARN for the analytics store to be shared. + // + // ResourceArn is a required field + ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` + + // A name given to the share. + ShareName *string `locationName:"shareName" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateShareInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateShareInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateShareInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateShareInput"} + if s.PrincipalSubscriber == nil { + invalidParams.Add(request.NewErrParamRequired("PrincipalSubscriber")) + } + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ShareName != nil && len(*s.ShareName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ShareName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPrincipalSubscriber sets the PrincipalSubscriber field's value. +func (s *CreateShareInput) SetPrincipalSubscriber(v string) *CreateShareInput { + s.PrincipalSubscriber = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *CreateShareInput) SetResourceArn(v string) *CreateShareInput { + s.ResourceArn = &v + return s +} + +// SetShareName sets the ShareName field's value. +func (s *CreateShareInput) SetShareName(v string) *CreateShareInput { + s.ShareName = &v + return s +} + +type CreateShareOutput struct { + _ struct{} `type:"structure"` + + // An ID generated for the share. + ShareId *string `locationName:"shareId" type:"string"` + + // A name given to the share. + ShareName *string `locationName:"shareName" min:"1" type:"string"` + + // The status of a share. + Status *string `locationName:"status" type:"string" enum:"ShareStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateShareOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateShareOutput) GoString() string { + return s.String() +} + +// SetShareId sets the ShareId field's value. +func (s *CreateShareOutput) SetShareId(v string) *CreateShareOutput { + s.ShareId = &v + return s +} + +// SetShareName sets the ShareName field's value. +func (s *CreateShareOutput) SetShareName(v string) *CreateShareOutput { + s.ShareName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *CreateShareOutput) SetStatus(v string) *CreateShareOutput { + s.Status = &v + return s +} + type CreateVariantStoreInput struct { _ struct{} `type:"structure"` @@ -10534,7 +12211,7 @@ type CreateVariantStoreInput struct { Description *string `locationName:"description" type:"string"` // A name for the store. - Name *string `locationName:"name" type:"string"` + Name *string `locationName:"name" min:"3" type:"string"` // The genome reference for the store's variants. // @@ -10569,6 +12246,9 @@ func (s CreateVariantStoreInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateVariantStoreInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CreateVariantStoreInput"} + if s.Name != nil && len(*s.Name) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Name", 3)) + } if s.Reference == nil { invalidParams.Add(request.NewErrParamRequired("Reference")) } @@ -11000,6 +12680,112 @@ func (s *DeleteAnnotationStoreOutput) SetStatus(v string) *DeleteAnnotationStore return s } +type DeleteAnnotationStoreVersionsInput struct { + _ struct{} `type:"structure"` + + // Forces the deletion of an annotation store version when imports are in-progress.. + Force *bool `location:"querystring" locationName:"force" type:"boolean"` + + // The name of the annotation store from which versions are being deleted. + // + // Name is a required field + Name *string `location:"uri" locationName:"name" type:"string" required:"true"` + + // The versions of an annotation store to be deleted. + // + // Versions is a required field + Versions []*string `locationName:"versions" min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAnnotationStoreVersionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAnnotationStoreVersionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteAnnotationStoreVersionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteAnnotationStoreVersionsInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Versions == nil { + invalidParams.Add(request.NewErrParamRequired("Versions")) + } + if s.Versions != nil && len(s.Versions) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Versions", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetForce sets the Force field's value. +func (s *DeleteAnnotationStoreVersionsInput) SetForce(v bool) *DeleteAnnotationStoreVersionsInput { + s.Force = &v + return s +} + +// SetName sets the Name field's value. +func (s *DeleteAnnotationStoreVersionsInput) SetName(v string) *DeleteAnnotationStoreVersionsInput { + s.Name = &v + return s +} + +// SetVersions sets the Versions field's value. +func (s *DeleteAnnotationStoreVersionsInput) SetVersions(v []*string) *DeleteAnnotationStoreVersionsInput { + s.Versions = v + return s +} + +type DeleteAnnotationStoreVersionsOutput struct { + _ struct{} `type:"structure"` + + // Any errors that occur when attempting to delete an annotation store version. + Errors []*VersionDeleteError `locationName:"errors" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAnnotationStoreVersionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAnnotationStoreVersionsOutput) GoString() string { + return s.String() +} + +// SetErrors sets the Errors field's value. +func (s *DeleteAnnotationStoreVersionsOutput) SetErrors(v []*VersionDeleteError) *DeleteAnnotationStoreVersionsOutput { + s.Errors = v + return s +} + type DeleteReferenceInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -11324,18 +13110,89 @@ func (s DeleteSequenceStoreInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteSequenceStoreInput) GoString() string { +func (s DeleteSequenceStoreInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteSequenceStoreInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteSequenceStoreInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 10 { + invalidParams.Add(request.NewErrParamMinLen("Id", 10)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *DeleteSequenceStoreInput) SetId(v string) *DeleteSequenceStoreInput { + s.Id = &v + return s +} + +type DeleteSequenceStoreOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteSequenceStoreOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteSequenceStoreOutput) GoString() string { + return s.String() +} + +type DeleteShareInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID for the share request to be deleted. + // + // ShareId is a required field + ShareId *string `location:"uri" locationName:"shareId" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteShareInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteShareInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteSequenceStoreInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteSequenceStoreInput"} - if s.Id == nil { - invalidParams.Add(request.NewErrParamRequired("Id")) +func (s *DeleteShareInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteShareInput"} + if s.ShareId == nil { + invalidParams.Add(request.NewErrParamRequired("ShareId")) } - if s.Id != nil && len(*s.Id) < 10 { - invalidParams.Add(request.NewErrParamMinLen("Id", 10)) + if s.ShareId != nil && len(*s.ShareId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ShareId", 1)) } if invalidParams.Len() > 0 { @@ -11344,14 +13201,17 @@ func (s *DeleteSequenceStoreInput) Validate() error { return nil } -// SetId sets the Id field's value. -func (s *DeleteSequenceStoreInput) SetId(v string) *DeleteSequenceStoreInput { - s.Id = &v +// SetShareId sets the ShareId field's value. +func (s *DeleteShareInput) SetShareId(v string) *DeleteShareInput { + s.ShareId = &v return s } -type DeleteSequenceStoreOutput struct { +type DeleteShareOutput struct { _ struct{} `type:"structure"` + + // The status of the share being deleted. + Status *string `locationName:"status" type:"string" enum:"ShareStatus"` } // String returns the string representation. @@ -11359,7 +13219,7 @@ type DeleteSequenceStoreOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteSequenceStoreOutput) String() string { +func (s DeleteShareOutput) String() string { return awsutil.Prettify(s) } @@ -11368,10 +13228,16 @@ func (s DeleteSequenceStoreOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteSequenceStoreOutput) GoString() string { +func (s DeleteShareOutput) GoString() string { return s.String() } +// SetStatus sets the Status field's value. +func (s *DeleteShareOutput) SetStatus(v string) *DeleteShareOutput { + s.Status = &v + return s +} + type DeleteVariantStoreInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -11825,6 +13691,61 @@ func (s *FileInformation) SetTotalParts(v int64) *FileInformation { return s } +// Use filters to focus the returned annotation store versions on a specific +// parameter, such as the status of the annotation store. +type Filter struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Number (Arn) for an analytics store. + ResourceArns []*string `locationName:"resourceArns" min:"1" type:"list"` + + // The status of an annotation store version. + Status []*string `locationName:"status" type:"list" enum:"ShareStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Filter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Filter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Filter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Filter"} + if s.ResourceArns != nil && len(s.ResourceArns) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArns", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArns sets the ResourceArns field's value. +func (s *Filter) SetResourceArns(v []*string) *Filter { + s.ResourceArns = v + return s +} + +// SetStatus sets the Status field's value. +func (s *Filter) SetStatus(v []*string) *Filter { + s.Status = v + return s +} + // Formatting options for a file. type FormatOptions struct { _ struct{} `type:"structure"` @@ -11990,6 +13911,11 @@ type GetAnnotationImportJobOutput struct { // // UpdateTime is a required field UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The name of the annotation store version. + // + // VersionName is a required field + VersionName *string `locationName:"versionName" min:"3" type:"string" required:"true"` } // String returns the string representation. @@ -12082,6 +14008,12 @@ func (s *GetAnnotationImportJobOutput) SetUpdateTime(v time.Time) *GetAnnotation return s } +// SetVersionName sets the VersionName field's value. +func (s *GetAnnotationImportJobOutput) SetVersionName(v string) *GetAnnotationImportJobOutput { + s.VersionName = &v + return s +} + type GetAnnotationStoreInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -12154,6 +14086,11 @@ type GetAnnotationStoreOutput struct { // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` + // An integer indicating how many versions of an annotation store exist. + // + // NumVersions is a required field + NumVersions *int64 `locationName:"numVersions" type:"integer" required:"true"` + // The store's genome reference. // // Reference is a required field @@ -12185,20 +14122,261 @@ type GetAnnotationStoreOutput struct { // The store's parsing options. StoreOptions *StoreOptions `locationName:"storeOptions" type:"structure"` - // The store's size in bytes. + // The store's size in bytes. + // + // StoreSizeBytes is a required field + StoreSizeBytes *int64 `locationName:"storeSizeBytes" type:"long" required:"true"` + + // The store's tags. + // + // Tags is a required field + Tags map[string]*string `locationName:"tags" type:"map" required:"true"` + + // When the store was updated. + // + // UpdateTime is a required field + UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAnnotationStoreOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAnnotationStoreOutput) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *GetAnnotationStoreOutput) SetCreationTime(v time.Time) *GetAnnotationStoreOutput { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *GetAnnotationStoreOutput) SetDescription(v string) *GetAnnotationStoreOutput { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *GetAnnotationStoreOutput) SetId(v string) *GetAnnotationStoreOutput { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *GetAnnotationStoreOutput) SetName(v string) *GetAnnotationStoreOutput { + s.Name = &v + return s +} + +// SetNumVersions sets the NumVersions field's value. +func (s *GetAnnotationStoreOutput) SetNumVersions(v int64) *GetAnnotationStoreOutput { + s.NumVersions = &v + return s +} + +// SetReference sets the Reference field's value. +func (s *GetAnnotationStoreOutput) SetReference(v *ReferenceItem) *GetAnnotationStoreOutput { + s.Reference = v + return s +} + +// SetSseConfig sets the SseConfig field's value. +func (s *GetAnnotationStoreOutput) SetSseConfig(v *SseConfig) *GetAnnotationStoreOutput { + s.SseConfig = v + return s +} + +// SetStatus sets the Status field's value. +func (s *GetAnnotationStoreOutput) SetStatus(v string) *GetAnnotationStoreOutput { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *GetAnnotationStoreOutput) SetStatusMessage(v string) *GetAnnotationStoreOutput { + s.StatusMessage = &v + return s +} + +// SetStoreArn sets the StoreArn field's value. +func (s *GetAnnotationStoreOutput) SetStoreArn(v string) *GetAnnotationStoreOutput { + s.StoreArn = &v + return s +} + +// SetStoreFormat sets the StoreFormat field's value. +func (s *GetAnnotationStoreOutput) SetStoreFormat(v string) *GetAnnotationStoreOutput { + s.StoreFormat = &v + return s +} + +// SetStoreOptions sets the StoreOptions field's value. +func (s *GetAnnotationStoreOutput) SetStoreOptions(v *StoreOptions) *GetAnnotationStoreOutput { + s.StoreOptions = v + return s +} + +// SetStoreSizeBytes sets the StoreSizeBytes field's value. +func (s *GetAnnotationStoreOutput) SetStoreSizeBytes(v int64) *GetAnnotationStoreOutput { + s.StoreSizeBytes = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *GetAnnotationStoreOutput) SetTags(v map[string]*string) *GetAnnotationStoreOutput { + s.Tags = v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *GetAnnotationStoreOutput) SetUpdateTime(v time.Time) *GetAnnotationStoreOutput { + s.UpdateTime = &v + return s +} + +type GetAnnotationStoreVersionInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The name given to an annotation store version to distinguish it from others. + // + // Name is a required field + Name *string `location:"uri" locationName:"name" type:"string" required:"true"` + + // The name given to an annotation store version to distinguish it from others. + // + // VersionName is a required field + VersionName *string `location:"uri" locationName:"versionName" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAnnotationStoreVersionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAnnotationStoreVersionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAnnotationStoreVersionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAnnotationStoreVersionInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.VersionName == nil { + invalidParams.Add(request.NewErrParamRequired("VersionName")) + } + if s.VersionName != nil && len(*s.VersionName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VersionName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *GetAnnotationStoreVersionInput) SetName(v string) *GetAnnotationStoreVersionInput { + s.Name = &v + return s +} + +// SetVersionName sets the VersionName field's value. +func (s *GetAnnotationStoreVersionInput) SetVersionName(v string) *GetAnnotationStoreVersionInput { + s.VersionName = &v + return s +} + +type GetAnnotationStoreVersionOutput struct { + _ struct{} `type:"structure"` + + // The time stamp for when an annotation store version was created. + // + // CreationTime is a required field + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The description for an annotation store version. + // + // Description is a required field + Description *string `locationName:"description" type:"string" required:"true"` + + // The annotation store version ID. + // + // Id is a required field + Id *string `locationName:"id" type:"string" required:"true"` + + // The name of the annotation store. + // + // Name is a required field + Name *string `locationName:"name" min:"3" type:"string" required:"true"` + + // The status of an annotation store version. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"VersionStatus"` + + // The status of an annotation store version. + // + // StatusMessage is a required field + StatusMessage *string `locationName:"statusMessage" type:"string" required:"true"` + + // The store ID for annotation store version. // - // StoreSizeBytes is a required field - StoreSizeBytes *int64 `locationName:"storeSizeBytes" type:"long" required:"true"` + // StoreId is a required field + StoreId *string `locationName:"storeId" type:"string" required:"true"` - // The store's tags. + // Any tags associated with an annotation store version. // // Tags is a required field Tags map[string]*string `locationName:"tags" type:"map" required:"true"` - // When the store was updated. + // The time stamp for when an annotation store version was updated. // // UpdateTime is a required field UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The Arn for the annotation store. + // + // VersionArn is a required field + VersionArn *string `locationName:"versionArn" min:"20" type:"string" required:"true"` + + // The name given to an annotation store version to distinguish it from others. + // + // VersionName is a required field + VersionName *string `locationName:"versionName" min:"3" type:"string" required:"true"` + + // The options for an annotation store version. + VersionOptions *VersionOptions `locationName:"versionOptions" type:"structure"` + + // The size of the annotation store version in Bytes. + // + // VersionSizeBytes is a required field + VersionSizeBytes *int64 `locationName:"versionSizeBytes" type:"long" required:"true"` } // String returns the string representation. @@ -12206,7 +14384,7 @@ type GetAnnotationStoreOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAnnotationStoreOutput) String() string { +func (s GetAnnotationStoreVersionOutput) String() string { return awsutil.Prettify(s) } @@ -12215,91 +14393,85 @@ func (s GetAnnotationStoreOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAnnotationStoreOutput) GoString() string { +func (s GetAnnotationStoreVersionOutput) GoString() string { return s.String() } // SetCreationTime sets the CreationTime field's value. -func (s *GetAnnotationStoreOutput) SetCreationTime(v time.Time) *GetAnnotationStoreOutput { +func (s *GetAnnotationStoreVersionOutput) SetCreationTime(v time.Time) *GetAnnotationStoreVersionOutput { s.CreationTime = &v return s } // SetDescription sets the Description field's value. -func (s *GetAnnotationStoreOutput) SetDescription(v string) *GetAnnotationStoreOutput { +func (s *GetAnnotationStoreVersionOutput) SetDescription(v string) *GetAnnotationStoreVersionOutput { s.Description = &v return s } // SetId sets the Id field's value. -func (s *GetAnnotationStoreOutput) SetId(v string) *GetAnnotationStoreOutput { +func (s *GetAnnotationStoreVersionOutput) SetId(v string) *GetAnnotationStoreVersionOutput { s.Id = &v return s } // SetName sets the Name field's value. -func (s *GetAnnotationStoreOutput) SetName(v string) *GetAnnotationStoreOutput { +func (s *GetAnnotationStoreVersionOutput) SetName(v string) *GetAnnotationStoreVersionOutput { s.Name = &v return s } -// SetReference sets the Reference field's value. -func (s *GetAnnotationStoreOutput) SetReference(v *ReferenceItem) *GetAnnotationStoreOutput { - s.Reference = v - return s -} - -// SetSseConfig sets the SseConfig field's value. -func (s *GetAnnotationStoreOutput) SetSseConfig(v *SseConfig) *GetAnnotationStoreOutput { - s.SseConfig = v - return s -} - // SetStatus sets the Status field's value. -func (s *GetAnnotationStoreOutput) SetStatus(v string) *GetAnnotationStoreOutput { +func (s *GetAnnotationStoreVersionOutput) SetStatus(v string) *GetAnnotationStoreVersionOutput { s.Status = &v return s } // SetStatusMessage sets the StatusMessage field's value. -func (s *GetAnnotationStoreOutput) SetStatusMessage(v string) *GetAnnotationStoreOutput { +func (s *GetAnnotationStoreVersionOutput) SetStatusMessage(v string) *GetAnnotationStoreVersionOutput { s.StatusMessage = &v return s } -// SetStoreArn sets the StoreArn field's value. -func (s *GetAnnotationStoreOutput) SetStoreArn(v string) *GetAnnotationStoreOutput { - s.StoreArn = &v +// SetStoreId sets the StoreId field's value. +func (s *GetAnnotationStoreVersionOutput) SetStoreId(v string) *GetAnnotationStoreVersionOutput { + s.StoreId = &v return s } -// SetStoreFormat sets the StoreFormat field's value. -func (s *GetAnnotationStoreOutput) SetStoreFormat(v string) *GetAnnotationStoreOutput { - s.StoreFormat = &v +// SetTags sets the Tags field's value. +func (s *GetAnnotationStoreVersionOutput) SetTags(v map[string]*string) *GetAnnotationStoreVersionOutput { + s.Tags = v return s } -// SetStoreOptions sets the StoreOptions field's value. -func (s *GetAnnotationStoreOutput) SetStoreOptions(v *StoreOptions) *GetAnnotationStoreOutput { - s.StoreOptions = v +// SetUpdateTime sets the UpdateTime field's value. +func (s *GetAnnotationStoreVersionOutput) SetUpdateTime(v time.Time) *GetAnnotationStoreVersionOutput { + s.UpdateTime = &v return s } -// SetStoreSizeBytes sets the StoreSizeBytes field's value. -func (s *GetAnnotationStoreOutput) SetStoreSizeBytes(v int64) *GetAnnotationStoreOutput { - s.StoreSizeBytes = &v +// SetVersionArn sets the VersionArn field's value. +func (s *GetAnnotationStoreVersionOutput) SetVersionArn(v string) *GetAnnotationStoreVersionOutput { + s.VersionArn = &v return s } -// SetTags sets the Tags field's value. -func (s *GetAnnotationStoreOutput) SetTags(v map[string]*string) *GetAnnotationStoreOutput { - s.Tags = v +// SetVersionName sets the VersionName field's value. +func (s *GetAnnotationStoreVersionOutput) SetVersionName(v string) *GetAnnotationStoreVersionOutput { + s.VersionName = &v return s } -// SetUpdateTime sets the UpdateTime field's value. -func (s *GetAnnotationStoreOutput) SetUpdateTime(v time.Time) *GetAnnotationStoreOutput { - s.UpdateTime = &v +// SetVersionOptions sets the VersionOptions field's value. +func (s *GetAnnotationStoreVersionOutput) SetVersionOptions(v *VersionOptions) *GetAnnotationStoreVersionOutput { + s.VersionOptions = v + return s +} + +// SetVersionSizeBytes sets the VersionSizeBytes field's value. +func (s *GetAnnotationStoreVersionOutput) SetVersionSizeBytes(v int64) *GetAnnotationStoreVersionOutput { + s.VersionSizeBytes = &v return s } @@ -14566,6 +16738,87 @@ func (s *GetSequenceStoreOutput) SetSseConfig(v *SseConfig) *GetSequenceStoreOut return s } +type GetShareInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The generated ID for a share. + // + // ShareId is a required field + ShareId *string `location:"uri" locationName:"shareId" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetShareInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetShareInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetShareInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetShareInput"} + if s.ShareId == nil { + invalidParams.Add(request.NewErrParamRequired("ShareId")) + } + if s.ShareId != nil && len(*s.ShareId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ShareId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetShareId sets the ShareId field's value. +func (s *GetShareInput) SetShareId(v string) *GetShareInput { + s.ShareId = &v + return s +} + +type GetShareOutput struct { + _ struct{} `type:"structure"` + + // An analytic store share details object. contains status, resourceArn, ownerId, + // etc. + Share *ShareDetails `locationName:"share" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetShareOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetShareOutput) GoString() string { + return s.String() +} + +// SetShare sets the Share field's value. +func (s *GetShareOutput) SetShare(v *ShareDetails) *GetShareOutput { + s.Share = v + return s +} + type GetVariantImportJobInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -15814,7 +18067,162 @@ type ListAnnotationImportJobsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAnnotationImportJobsInput) String() string { +func (s ListAnnotationImportJobsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAnnotationImportJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAnnotationImportJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAnnotationImportJobsInput"} + if s.Ids != nil && len(s.Ids) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Ids", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFilter sets the Filter field's value. +func (s *ListAnnotationImportJobsInput) SetFilter(v *ListAnnotationImportJobsFilter) *ListAnnotationImportJobsInput { + s.Filter = v + return s +} + +// SetIds sets the Ids field's value. +func (s *ListAnnotationImportJobsInput) SetIds(v []*string) *ListAnnotationImportJobsInput { + s.Ids = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAnnotationImportJobsInput) SetMaxResults(v int64) *ListAnnotationImportJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAnnotationImportJobsInput) SetNextToken(v string) *ListAnnotationImportJobsInput { + s.NextToken = &v + return s +} + +type ListAnnotationImportJobsOutput struct { + _ struct{} `type:"structure"` + + // A list of jobs. + AnnotationImportJobs []*AnnotationImportJobItem `locationName:"annotationImportJobs" type:"list"` + + // Specifies the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAnnotationImportJobsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAnnotationImportJobsOutput) GoString() string { + return s.String() +} + +// SetAnnotationImportJobs sets the AnnotationImportJobs field's value. +func (s *ListAnnotationImportJobsOutput) SetAnnotationImportJobs(v []*AnnotationImportJobItem) *ListAnnotationImportJobsOutput { + s.AnnotationImportJobs = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAnnotationImportJobsOutput) SetNextToken(v string) *ListAnnotationImportJobsOutput { + s.NextToken = &v + return s +} + +// Use filters to focus the returned annotation store versions on a specific +// parameter, such as the status of the annotation store. +type ListAnnotationStoreVersionsFilter struct { + _ struct{} `type:"structure"` + + // The status of an annotation store version. + Status *string `locationName:"status" type:"string" enum:"VersionStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAnnotationStoreVersionsFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAnnotationStoreVersionsFilter) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *ListAnnotationStoreVersionsFilter) SetStatus(v string) *ListAnnotationStoreVersionsFilter { + s.Status = &v + return s +} + +type ListAnnotationStoreVersionsInput struct { + _ struct{} `type:"structure"` + + // A filter to apply to the list of annotation store versions. + Filter *ListAnnotationStoreVersionsFilter `locationName:"filter" type:"structure"` + + // The maximum number of annotation store versions to return in one page of + // results. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The name of an annotation store. + // + // Name is a required field + Name *string `location:"uri" locationName:"name" type:"string" required:"true"` + + // Specifies the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAnnotationStoreVersionsInput) String() string { return awsutil.Prettify(s) } @@ -15823,19 +18231,22 @@ func (s ListAnnotationImportJobsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAnnotationImportJobsInput) GoString() string { +func (s ListAnnotationStoreVersionsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListAnnotationImportJobsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListAnnotationImportJobsInput"} - if s.Ids != nil && len(s.Ids) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Ids", 1)) - } +func (s *ListAnnotationStoreVersionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAnnotationStoreVersionsInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } @@ -15847,34 +18258,34 @@ func (s *ListAnnotationImportJobsInput) Validate() error { } // SetFilter sets the Filter field's value. -func (s *ListAnnotationImportJobsInput) SetFilter(v *ListAnnotationImportJobsFilter) *ListAnnotationImportJobsInput { +func (s *ListAnnotationStoreVersionsInput) SetFilter(v *ListAnnotationStoreVersionsFilter) *ListAnnotationStoreVersionsInput { s.Filter = v return s } -// SetIds sets the Ids field's value. -func (s *ListAnnotationImportJobsInput) SetIds(v []*string) *ListAnnotationImportJobsInput { - s.Ids = v +// SetMaxResults sets the MaxResults field's value. +func (s *ListAnnotationStoreVersionsInput) SetMaxResults(v int64) *ListAnnotationStoreVersionsInput { + s.MaxResults = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListAnnotationImportJobsInput) SetMaxResults(v int64) *ListAnnotationImportJobsInput { - s.MaxResults = &v +// SetName sets the Name field's value. +func (s *ListAnnotationStoreVersionsInput) SetName(v string) *ListAnnotationStoreVersionsInput { + s.Name = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListAnnotationImportJobsInput) SetNextToken(v string) *ListAnnotationImportJobsInput { +func (s *ListAnnotationStoreVersionsInput) SetNextToken(v string) *ListAnnotationStoreVersionsInput { s.NextToken = &v return s } -type ListAnnotationImportJobsOutput struct { +type ListAnnotationStoreVersionsOutput struct { _ struct{} `type:"structure"` - // A list of jobs. - AnnotationImportJobs []*AnnotationImportJobItem `locationName:"annotationImportJobs" type:"list"` + // Lists all versions of an annotation store. + AnnotationStoreVersions []*AnnotationStoreVersionItem `locationName:"annotationStoreVersions" type:"list"` // Specifies the pagination token from a previous request to retrieve the next // page of results. @@ -15886,7 +18297,7 @@ type ListAnnotationImportJobsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAnnotationImportJobsOutput) String() string { +func (s ListAnnotationStoreVersionsOutput) String() string { return awsutil.Prettify(s) } @@ -15895,18 +18306,18 @@ func (s ListAnnotationImportJobsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAnnotationImportJobsOutput) GoString() string { +func (s ListAnnotationStoreVersionsOutput) GoString() string { return s.String() } -// SetAnnotationImportJobs sets the AnnotationImportJobs field's value. -func (s *ListAnnotationImportJobsOutput) SetAnnotationImportJobs(v []*AnnotationImportJobItem) *ListAnnotationImportJobsOutput { - s.AnnotationImportJobs = v +// SetAnnotationStoreVersions sets the AnnotationStoreVersions field's value. +func (s *ListAnnotationStoreVersionsOutput) SetAnnotationStoreVersions(v []*AnnotationStoreVersionItem) *ListAnnotationStoreVersionsOutput { + s.AnnotationStoreVersions = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListAnnotationImportJobsOutput) SetNextToken(v string) *ListAnnotationImportJobsOutput { +func (s *ListAnnotationStoreVersionsOutput) SetNextToken(v string) *ListAnnotationStoreVersionsOutput { s.NextToken = &v return s } @@ -17677,6 +20088,128 @@ func (s *ListSequenceStoresOutput) SetSequenceStores(v []*SequenceStoreDetail) * return s } +type ListSharesInput struct { + _ struct{} `type:"structure"` + + // Attributes used to filter for a specific subset of shares. + Filter *Filter `locationName:"filter" type:"structure"` + + // The maximum number of shares to return in one page of results. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Next token returned in the response of a previous ListReadSetUploadPartsRequest + // call. Used to get the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + + // The account that owns the analytics store shared. + // + // ResourceOwner is a required field + ResourceOwner *string `locationName:"resourceOwner" type:"string" required:"true" enum:"ResourceOwner"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSharesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSharesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSharesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSharesInput"} + if s.ResourceOwner == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceOwner")) + } + if s.Filter != nil { + if err := s.Filter.Validate(); err != nil { + invalidParams.AddNested("Filter", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFilter sets the Filter field's value. +func (s *ListSharesInput) SetFilter(v *Filter) *ListSharesInput { + s.Filter = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListSharesInput) SetMaxResults(v int64) *ListSharesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSharesInput) SetNextToken(v string) *ListSharesInput { + s.NextToken = &v + return s +} + +// SetResourceOwner sets the ResourceOwner field's value. +func (s *ListSharesInput) SetResourceOwner(v string) *ListSharesInput { + s.ResourceOwner = &v + return s +} + +type ListSharesOutput struct { + _ struct{} `type:"structure"` + + // Next token returned in the response of a previous ListSharesResponse call. + // Used to get the next page of results. + NextToken *string `locationName:"nextToken" type:"string"` + + // The shares available and their meta details. + // + // Shares is a required field + Shares []*ShareDetails `locationName:"shares" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSharesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSharesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSharesOutput) SetNextToken(v string) *ListSharesOutput { + s.NextToken = &v + return s +} + +// SetShares sets the Shares field's value. +func (s *ListSharesOutput) SetShares(v []*ShareDetails) *ListSharesOutput { + s.Shares = v + return s +} + type ListTagsForResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -20151,6 +22684,112 @@ func (s *ServiceQuotaExceededException) RequestID() string { return s.RespMetadata.RequestID } +// The details of a share. +type ShareDetails struct { + _ struct{} `type:"structure"` + + // The timestamp for when the share was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The account ID for the data owner. The owner creates the share offer. + OwnerId *string `locationName:"ownerId" type:"string"` + + // The principal subscriber is the account the analytics store data is being + // shared with. + PrincipalSubscriber *string `locationName:"principalSubscriber" type:"string"` + + // The resource Arn of the analytics store being shared. + ResourceArn *string `locationName:"resourceArn" type:"string"` + + // The ID for a share offer for an analytics store . + ShareId *string `locationName:"shareId" type:"string"` + + // The name of the share. + ShareName *string `locationName:"shareName" min:"1" type:"string"` + + // The status of a share. + Status *string `locationName:"status" type:"string" enum:"ShareStatus"` + + // The status message for a share. It provides more details on the status of + // the share. + StatusMessage *string `locationName:"statusMessage" type:"string"` + + // The timestamp of the share update. + UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ShareDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ShareDetails) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *ShareDetails) SetCreationTime(v time.Time) *ShareDetails { + s.CreationTime = &v + return s +} + +// SetOwnerId sets the OwnerId field's value. +func (s *ShareDetails) SetOwnerId(v string) *ShareDetails { + s.OwnerId = &v + return s +} + +// SetPrincipalSubscriber sets the PrincipalSubscriber field's value. +func (s *ShareDetails) SetPrincipalSubscriber(v string) *ShareDetails { + s.PrincipalSubscriber = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ShareDetails) SetResourceArn(v string) *ShareDetails { + s.ResourceArn = &v + return s +} + +// SetShareId sets the ShareId field's value. +func (s *ShareDetails) SetShareId(v string) *ShareDetails { + s.ShareId = &v + return s +} + +// SetShareName sets the ShareName field's value. +func (s *ShareDetails) SetShareName(v string) *ShareDetails { + s.ShareName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ShareDetails) SetStatus(v string) *ShareDetails { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *ShareDetails) SetStatusMessage(v string) *ShareDetails { + s.StatusMessage = &v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *ShareDetails) SetUpdateTime(v time.Time) *ShareDetails { + s.UpdateTime = &v + return s +} + // Source files for a sequence. type SourceFiles struct { _ struct{} `type:"structure"` @@ -20292,6 +22931,9 @@ type StartAnnotationImportJobInput struct { // The job's left normalization setting. RunLeftNormalization *bool `locationName:"runLeftNormalization" type:"boolean"` + + // The name of the annotation store version. + VersionName *string `locationName:"versionName" min:"3" type:"string"` } // String returns the string representation. @@ -20333,6 +22975,9 @@ func (s *StartAnnotationImportJobInput) Validate() error { if s.RoleArn != nil && len(*s.RoleArn) < 20 { invalidParams.Add(request.NewErrParamMinLen("RoleArn", 20)) } + if s.VersionName != nil && len(*s.VersionName) < 3 { + invalidParams.Add(request.NewErrParamMinLen("VersionName", 3)) + } if s.FormatOptions != nil { if err := s.FormatOptions.Validate(); err != nil { invalidParams.AddNested("FormatOptions", err.(request.ErrInvalidParams)) @@ -20391,6 +23036,12 @@ func (s *StartAnnotationImportJobInput) SetRunLeftNormalization(v bool) *StartAn return s } +// SetVersionName sets the VersionName field's value. +func (s *StartAnnotationImportJobInput) SetVersionName(v string) *StartAnnotationImportJobInput { + s.VersionName = &v + return s +} + type StartAnnotationImportJobOutput struct { _ struct{} `type:"structure"` @@ -22164,23 +24815,86 @@ func (s *TsvOptions) Validate() error { return nil } -// SetReadOptions sets the ReadOptions field's value. -func (s *TsvOptions) SetReadOptions(v *ReadOptions) *TsvOptions { - s.ReadOptions = v +// SetReadOptions sets the ReadOptions field's value. +func (s *TsvOptions) SetReadOptions(v *ReadOptions) *TsvOptions { + s.ReadOptions = v + return s +} + +// File settings for a TSV store. +type TsvStoreOptions struct { + _ struct{} `type:"structure"` + + // The store's annotation type. + AnnotationType *string `locationName:"annotationType" type:"string" enum:"AnnotationType"` + + // The store's header key to column name mapping. + FormatToHeader map[string]*string `locationName:"formatToHeader" type:"map"` + + // The store's schema. + Schema []map[string]*string `locationName:"schema" min:"1" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TsvStoreOptions) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TsvStoreOptions) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TsvStoreOptions) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TsvStoreOptions"} + if s.Schema != nil && len(s.Schema) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Schema", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnnotationType sets the AnnotationType field's value. +func (s *TsvStoreOptions) SetAnnotationType(v string) *TsvStoreOptions { + s.AnnotationType = &v + return s +} + +// SetFormatToHeader sets the FormatToHeader field's value. +func (s *TsvStoreOptions) SetFormatToHeader(v map[string]*string) *TsvStoreOptions { + s.FormatToHeader = v + return s +} + +// SetSchema sets the Schema field's value. +func (s *TsvStoreOptions) SetSchema(v []map[string]*string) *TsvStoreOptions { + s.Schema = v return s } -// File settings for a TSV store. -type TsvStoreOptions struct { +// The options for a TSV file. +type TsvVersionOptions struct { _ struct{} `type:"structure"` - // The store's annotation type. + // The store version's annotation type. AnnotationType *string `locationName:"annotationType" type:"string" enum:"AnnotationType"` - // The store's header key to column name mapping. + // The annotation store version's header key to column name mapping. FormatToHeader map[string]*string `locationName:"formatToHeader" type:"map"` - // The store's schema. + // The TSV schema for an annotation store version. Schema []map[string]*string `locationName:"schema" min:"1" type:"list"` } @@ -22189,7 +24903,7 @@ type TsvStoreOptions struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s TsvStoreOptions) String() string { +func (s TsvVersionOptions) String() string { return awsutil.Prettify(s) } @@ -22198,13 +24912,13 @@ func (s TsvStoreOptions) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s TsvStoreOptions) GoString() string { +func (s TsvVersionOptions) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *TsvStoreOptions) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "TsvStoreOptions"} +func (s *TsvVersionOptions) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TsvVersionOptions"} if s.Schema != nil && len(s.Schema) < 1 { invalidParams.Add(request.NewErrParamMinLen("Schema", 1)) } @@ -22216,19 +24930,19 @@ func (s *TsvStoreOptions) Validate() error { } // SetAnnotationType sets the AnnotationType field's value. -func (s *TsvStoreOptions) SetAnnotationType(v string) *TsvStoreOptions { +func (s *TsvVersionOptions) SetAnnotationType(v string) *TsvVersionOptions { s.AnnotationType = &v return s } // SetFormatToHeader sets the FormatToHeader field's value. -func (s *TsvStoreOptions) SetFormatToHeader(v map[string]*string) *TsvStoreOptions { +func (s *TsvVersionOptions) SetFormatToHeader(v map[string]*string) *TsvVersionOptions { s.FormatToHeader = v return s } // SetSchema sets the Schema field's value. -func (s *TsvStoreOptions) SetSchema(v []map[string]*string) *TsvStoreOptions { +func (s *TsvVersionOptions) SetSchema(v []map[string]*string) *TsvVersionOptions { s.Schema = v return s } @@ -22493,6 +25207,191 @@ func (s *UpdateAnnotationStoreOutput) SetUpdateTime(v time.Time) *UpdateAnnotati return s } +type UpdateAnnotationStoreVersionInput struct { + _ struct{} `type:"structure"` + + // The description of an annotation store. + Description *string `locationName:"description" type:"string"` + + // The name of an annotation store. + // + // Name is a required field + Name *string `location:"uri" locationName:"name" type:"string" required:"true"` + + // The name of an annotation store version. + // + // VersionName is a required field + VersionName *string `location:"uri" locationName:"versionName" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAnnotationStoreVersionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAnnotationStoreVersionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateAnnotationStoreVersionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAnnotationStoreVersionInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.VersionName == nil { + invalidParams.Add(request.NewErrParamRequired("VersionName")) + } + if s.VersionName != nil && len(*s.VersionName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VersionName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *UpdateAnnotationStoreVersionInput) SetDescription(v string) *UpdateAnnotationStoreVersionInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateAnnotationStoreVersionInput) SetName(v string) *UpdateAnnotationStoreVersionInput { + s.Name = &v + return s +} + +// SetVersionName sets the VersionName field's value. +func (s *UpdateAnnotationStoreVersionInput) SetVersionName(v string) *UpdateAnnotationStoreVersionInput { + s.VersionName = &v + return s +} + +type UpdateAnnotationStoreVersionOutput struct { + _ struct{} `type:"structure"` + + // The time stamp for when an annotation store version was created. + // + // CreationTime is a required field + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The description of an annotation store version. + // + // Description is a required field + Description *string `locationName:"description" type:"string" required:"true"` + + // The annotation store version ID. + // + // Id is a required field + Id *string `locationName:"id" type:"string" required:"true"` + + // The name of an annotation store. + // + // Name is a required field + Name *string `locationName:"name" min:"3" type:"string" required:"true"` + + // The status of an annotation store version. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"VersionStatus"` + + // The annotation store ID. + // + // StoreId is a required field + StoreId *string `locationName:"storeId" type:"string" required:"true"` + + // The time stamp for when an annotation store version was updated. + // + // UpdateTime is a required field + UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The name of an annotation store version. + // + // VersionName is a required field + VersionName *string `locationName:"versionName" min:"3" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAnnotationStoreVersionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAnnotationStoreVersionOutput) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *UpdateAnnotationStoreVersionOutput) SetCreationTime(v time.Time) *UpdateAnnotationStoreVersionOutput { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *UpdateAnnotationStoreVersionOutput) SetDescription(v string) *UpdateAnnotationStoreVersionOutput { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *UpdateAnnotationStoreVersionOutput) SetId(v string) *UpdateAnnotationStoreVersionOutput { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateAnnotationStoreVersionOutput) SetName(v string) *UpdateAnnotationStoreVersionOutput { + s.Name = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *UpdateAnnotationStoreVersionOutput) SetStatus(v string) *UpdateAnnotationStoreVersionOutput { + s.Status = &v + return s +} + +// SetStoreId sets the StoreId field's value. +func (s *UpdateAnnotationStoreVersionOutput) SetStoreId(v string) *UpdateAnnotationStoreVersionOutput { + s.StoreId = &v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *UpdateAnnotationStoreVersionOutput) SetUpdateTime(v time.Time) *UpdateAnnotationStoreVersionOutput { + s.UpdateTime = &v + return s +} + +// SetVersionName sets the VersionName field's value. +func (s *UpdateAnnotationStoreVersionOutput) SetVersionName(v string) *UpdateAnnotationStoreVersionOutput { + s.VersionName = &v + return s +} + type UpdateRunGroupInput struct { _ struct{} `type:"structure"` @@ -23492,6 +26391,98 @@ func (s *VcfOptions) SetIgnoreQualField(v bool) *VcfOptions { return s } +// The error preventing deletion of the annotation store version. +type VersionDeleteError struct { + _ struct{} `type:"structure"` + + // The message explaining the error in annotation store deletion. + // + // Message is a required field + Message *string `locationName:"message" type:"string" required:"true"` + + // The name given to an annotation store version. + // + // VersionName is a required field + VersionName *string `locationName:"versionName" min:"3" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VersionDeleteError) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VersionDeleteError) GoString() string { + return s.String() +} + +// SetMessage sets the Message field's value. +func (s *VersionDeleteError) SetMessage(v string) *VersionDeleteError { + s.Message = &v + return s +} + +// SetVersionName sets the VersionName field's value. +func (s *VersionDeleteError) SetVersionName(v string) *VersionDeleteError { + s.VersionName = &v + return s +} + +// The options for an annotation store version. +type VersionOptions struct { + _ struct{} `type:"structure"` + + // File settings for a version of a TSV store. + TsvVersionOptions *TsvVersionOptions `locationName:"tsvVersionOptions" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VersionOptions) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VersionOptions) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *VersionOptions) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "VersionOptions"} + if s.TsvVersionOptions != nil { + if err := s.TsvVersionOptions.Validate(); err != nil { + invalidParams.AddNested("TsvVersionOptions", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetTsvVersionOptions sets the TsvVersionOptions field's value. +func (s *VersionOptions) SetTsvVersionOptions(v *TsvVersionOptions) *VersionOptions { + s.TsvVersionOptions = v + return s +} + // A workflow. type WorkflowListItem struct { _ struct{} `type:"structure"` @@ -24137,6 +27128,22 @@ func ReferenceStatus_Values() []string { } } +const ( + // ResourceOwnerSelf is a ResourceOwner enum value + ResourceOwnerSelf = "SELF" + + // ResourceOwnerOther is a ResourceOwner enum value + ResourceOwnerOther = "OTHER" +) + +// ResourceOwner_Values returns all elements of the ResourceOwner enum +func ResourceOwner_Values() []string { + return []string{ + ResourceOwnerSelf, + ResourceOwnerOther, + } +} + const ( // RunExportDefinition is a RunExport enum value RunExportDefinition = "DEFINITION" @@ -24245,6 +27252,38 @@ func SchemaValueType_Values() []string { } } +const ( + // ShareStatusPending is a ShareStatus enum value + ShareStatusPending = "PENDING" + + // ShareStatusActivating is a ShareStatus enum value + ShareStatusActivating = "ACTIVATING" + + // ShareStatusActive is a ShareStatus enum value + ShareStatusActive = "ACTIVE" + + // ShareStatusDeleting is a ShareStatus enum value + ShareStatusDeleting = "DELETING" + + // ShareStatusDeleted is a ShareStatus enum value + ShareStatusDeleted = "DELETED" + + // ShareStatusFailed is a ShareStatus enum value + ShareStatusFailed = "FAILED" +) + +// ShareStatus_Values returns all elements of the ShareStatus enum +func ShareStatus_Values() []string { + return []string{ + ShareStatusPending, + ShareStatusActivating, + ShareStatusActive, + ShareStatusDeleting, + ShareStatusDeleted, + ShareStatusFailed, + } +} + const ( // StoreFormatGff is a StoreFormat enum value StoreFormatGff = "GFF" @@ -24329,6 +27368,34 @@ func TaskStatus_Values() []string { } } +const ( + // VersionStatusCreating is a VersionStatus enum value + VersionStatusCreating = "CREATING" + + // VersionStatusUpdating is a VersionStatus enum value + VersionStatusUpdating = "UPDATING" + + // VersionStatusDeleting is a VersionStatus enum value + VersionStatusDeleting = "DELETING" + + // VersionStatusActive is a VersionStatus enum value + VersionStatusActive = "ACTIVE" + + // VersionStatusFailed is a VersionStatus enum value + VersionStatusFailed = "FAILED" +) + +// VersionStatus_Values returns all elements of the VersionStatus enum +func VersionStatus_Values() []string { + return []string{ + VersionStatusCreating, + VersionStatusUpdating, + VersionStatusDeleting, + VersionStatusActive, + VersionStatusFailed, + } +} + const ( // WorkflowEngineWdl is a WorkflowEngine enum value WorkflowEngineWdl = "WDL" diff --git a/service/omics/omicsiface/interface.go b/service/omics/omicsiface/interface.go index 4e9ce974e4f..fc51cbed76d 100644 --- a/service/omics/omicsiface/interface.go +++ b/service/omics/omicsiface/interface.go @@ -64,6 +64,10 @@ type OmicsAPI interface { AbortMultipartReadSetUploadWithContext(aws.Context, *omics.AbortMultipartReadSetUploadInput, ...request.Option) (*omics.AbortMultipartReadSetUploadOutput, error) AbortMultipartReadSetUploadRequest(*omics.AbortMultipartReadSetUploadInput) (*request.Request, *omics.AbortMultipartReadSetUploadOutput) + AcceptShare(*omics.AcceptShareInput) (*omics.AcceptShareOutput, error) + AcceptShareWithContext(aws.Context, *omics.AcceptShareInput, ...request.Option) (*omics.AcceptShareOutput, error) + AcceptShareRequest(*omics.AcceptShareInput) (*request.Request, *omics.AcceptShareOutput) + BatchDeleteReadSet(*omics.BatchDeleteReadSetInput) (*omics.BatchDeleteReadSetOutput, error) BatchDeleteReadSetWithContext(aws.Context, *omics.BatchDeleteReadSetInput, ...request.Option) (*omics.BatchDeleteReadSetOutput, error) BatchDeleteReadSetRequest(*omics.BatchDeleteReadSetInput) (*request.Request, *omics.BatchDeleteReadSetOutput) @@ -88,6 +92,10 @@ type OmicsAPI interface { CreateAnnotationStoreWithContext(aws.Context, *omics.CreateAnnotationStoreInput, ...request.Option) (*omics.CreateAnnotationStoreOutput, error) CreateAnnotationStoreRequest(*omics.CreateAnnotationStoreInput) (*request.Request, *omics.CreateAnnotationStoreOutput) + CreateAnnotationStoreVersion(*omics.CreateAnnotationStoreVersionInput) (*omics.CreateAnnotationStoreVersionOutput, error) + CreateAnnotationStoreVersionWithContext(aws.Context, *omics.CreateAnnotationStoreVersionInput, ...request.Option) (*omics.CreateAnnotationStoreVersionOutput, error) + CreateAnnotationStoreVersionRequest(*omics.CreateAnnotationStoreVersionInput) (*request.Request, *omics.CreateAnnotationStoreVersionOutput) + CreateMultipartReadSetUpload(*omics.CreateMultipartReadSetUploadInput) (*omics.CreateMultipartReadSetUploadOutput, error) CreateMultipartReadSetUploadWithContext(aws.Context, *omics.CreateMultipartReadSetUploadInput, ...request.Option) (*omics.CreateMultipartReadSetUploadOutput, error) CreateMultipartReadSetUploadRequest(*omics.CreateMultipartReadSetUploadInput) (*request.Request, *omics.CreateMultipartReadSetUploadOutput) @@ -104,6 +112,10 @@ type OmicsAPI interface { CreateSequenceStoreWithContext(aws.Context, *omics.CreateSequenceStoreInput, ...request.Option) (*omics.CreateSequenceStoreOutput, error) CreateSequenceStoreRequest(*omics.CreateSequenceStoreInput) (*request.Request, *omics.CreateSequenceStoreOutput) + CreateShare(*omics.CreateShareInput) (*omics.CreateShareOutput, error) + CreateShareWithContext(aws.Context, *omics.CreateShareInput, ...request.Option) (*omics.CreateShareOutput, error) + CreateShareRequest(*omics.CreateShareInput) (*request.Request, *omics.CreateShareOutput) + CreateVariantStore(*omics.CreateVariantStoreInput) (*omics.CreateVariantStoreOutput, error) CreateVariantStoreWithContext(aws.Context, *omics.CreateVariantStoreInput, ...request.Option) (*omics.CreateVariantStoreOutput, error) CreateVariantStoreRequest(*omics.CreateVariantStoreInput) (*request.Request, *omics.CreateVariantStoreOutput) @@ -116,6 +128,10 @@ type OmicsAPI interface { DeleteAnnotationStoreWithContext(aws.Context, *omics.DeleteAnnotationStoreInput, ...request.Option) (*omics.DeleteAnnotationStoreOutput, error) DeleteAnnotationStoreRequest(*omics.DeleteAnnotationStoreInput) (*request.Request, *omics.DeleteAnnotationStoreOutput) + DeleteAnnotationStoreVersions(*omics.DeleteAnnotationStoreVersionsInput) (*omics.DeleteAnnotationStoreVersionsOutput, error) + DeleteAnnotationStoreVersionsWithContext(aws.Context, *omics.DeleteAnnotationStoreVersionsInput, ...request.Option) (*omics.DeleteAnnotationStoreVersionsOutput, error) + DeleteAnnotationStoreVersionsRequest(*omics.DeleteAnnotationStoreVersionsInput) (*request.Request, *omics.DeleteAnnotationStoreVersionsOutput) + DeleteReference(*omics.DeleteReferenceInput) (*omics.DeleteReferenceOutput, error) DeleteReferenceWithContext(aws.Context, *omics.DeleteReferenceInput, ...request.Option) (*omics.DeleteReferenceOutput, error) DeleteReferenceRequest(*omics.DeleteReferenceInput) (*request.Request, *omics.DeleteReferenceOutput) @@ -136,6 +152,10 @@ type OmicsAPI interface { DeleteSequenceStoreWithContext(aws.Context, *omics.DeleteSequenceStoreInput, ...request.Option) (*omics.DeleteSequenceStoreOutput, error) DeleteSequenceStoreRequest(*omics.DeleteSequenceStoreInput) (*request.Request, *omics.DeleteSequenceStoreOutput) + DeleteShare(*omics.DeleteShareInput) (*omics.DeleteShareOutput, error) + DeleteShareWithContext(aws.Context, *omics.DeleteShareInput, ...request.Option) (*omics.DeleteShareOutput, error) + DeleteShareRequest(*omics.DeleteShareInput) (*request.Request, *omics.DeleteShareOutput) + DeleteVariantStore(*omics.DeleteVariantStoreInput) (*omics.DeleteVariantStoreOutput, error) DeleteVariantStoreWithContext(aws.Context, *omics.DeleteVariantStoreInput, ...request.Option) (*omics.DeleteVariantStoreOutput, error) DeleteVariantStoreRequest(*omics.DeleteVariantStoreInput) (*request.Request, *omics.DeleteVariantStoreOutput) @@ -152,6 +172,10 @@ type OmicsAPI interface { GetAnnotationStoreWithContext(aws.Context, *omics.GetAnnotationStoreInput, ...request.Option) (*omics.GetAnnotationStoreOutput, error) GetAnnotationStoreRequest(*omics.GetAnnotationStoreInput) (*request.Request, *omics.GetAnnotationStoreOutput) + GetAnnotationStoreVersion(*omics.GetAnnotationStoreVersionInput) (*omics.GetAnnotationStoreVersionOutput, error) + GetAnnotationStoreVersionWithContext(aws.Context, *omics.GetAnnotationStoreVersionInput, ...request.Option) (*omics.GetAnnotationStoreVersionOutput, error) + GetAnnotationStoreVersionRequest(*omics.GetAnnotationStoreVersionInput) (*request.Request, *omics.GetAnnotationStoreVersionOutput) + GetReadSet(*omics.GetReadSetInput) (*omics.GetReadSetOutput, error) GetReadSetWithContext(aws.Context, *omics.GetReadSetInput, ...request.Option) (*omics.GetReadSetOutput, error) GetReadSetRequest(*omics.GetReadSetInput) (*request.Request, *omics.GetReadSetOutput) @@ -204,6 +228,10 @@ type OmicsAPI interface { GetSequenceStoreWithContext(aws.Context, *omics.GetSequenceStoreInput, ...request.Option) (*omics.GetSequenceStoreOutput, error) GetSequenceStoreRequest(*omics.GetSequenceStoreInput) (*request.Request, *omics.GetSequenceStoreOutput) + GetShare(*omics.GetShareInput) (*omics.GetShareOutput, error) + GetShareWithContext(aws.Context, *omics.GetShareInput, ...request.Option) (*omics.GetShareOutput, error) + GetShareRequest(*omics.GetShareInput) (*request.Request, *omics.GetShareOutput) + GetVariantImportJob(*omics.GetVariantImportJobInput) (*omics.GetVariantImportJobOutput, error) GetVariantImportJobWithContext(aws.Context, *omics.GetVariantImportJobInput, ...request.Option) (*omics.GetVariantImportJobOutput, error) GetVariantImportJobRequest(*omics.GetVariantImportJobInput) (*request.Request, *omics.GetVariantImportJobOutput) @@ -223,6 +251,13 @@ type OmicsAPI interface { ListAnnotationImportJobsPages(*omics.ListAnnotationImportJobsInput, func(*omics.ListAnnotationImportJobsOutput, bool) bool) error ListAnnotationImportJobsPagesWithContext(aws.Context, *omics.ListAnnotationImportJobsInput, func(*omics.ListAnnotationImportJobsOutput, bool) bool, ...request.Option) error + ListAnnotationStoreVersions(*omics.ListAnnotationStoreVersionsInput) (*omics.ListAnnotationStoreVersionsOutput, error) + ListAnnotationStoreVersionsWithContext(aws.Context, *omics.ListAnnotationStoreVersionsInput, ...request.Option) (*omics.ListAnnotationStoreVersionsOutput, error) + ListAnnotationStoreVersionsRequest(*omics.ListAnnotationStoreVersionsInput) (*request.Request, *omics.ListAnnotationStoreVersionsOutput) + + ListAnnotationStoreVersionsPages(*omics.ListAnnotationStoreVersionsInput, func(*omics.ListAnnotationStoreVersionsOutput, bool) bool) error + ListAnnotationStoreVersionsPagesWithContext(aws.Context, *omics.ListAnnotationStoreVersionsInput, func(*omics.ListAnnotationStoreVersionsOutput, bool) bool, ...request.Option) error + ListAnnotationStores(*omics.ListAnnotationStoresInput) (*omics.ListAnnotationStoresOutput, error) ListAnnotationStoresWithContext(aws.Context, *omics.ListAnnotationStoresInput, ...request.Option) (*omics.ListAnnotationStoresOutput, error) ListAnnotationStoresRequest(*omics.ListAnnotationStoresInput) (*request.Request, *omics.ListAnnotationStoresOutput) @@ -321,6 +356,13 @@ type OmicsAPI interface { ListSequenceStoresPages(*omics.ListSequenceStoresInput, func(*omics.ListSequenceStoresOutput, bool) bool) error ListSequenceStoresPagesWithContext(aws.Context, *omics.ListSequenceStoresInput, func(*omics.ListSequenceStoresOutput, bool) bool, ...request.Option) error + ListShares(*omics.ListSharesInput) (*omics.ListSharesOutput, error) + ListSharesWithContext(aws.Context, *omics.ListSharesInput, ...request.Option) (*omics.ListSharesOutput, error) + ListSharesRequest(*omics.ListSharesInput) (*request.Request, *omics.ListSharesOutput) + + ListSharesPages(*omics.ListSharesInput, func(*omics.ListSharesOutput, bool) bool) error + ListSharesPagesWithContext(aws.Context, *omics.ListSharesInput, func(*omics.ListSharesOutput, bool) bool, ...request.Option) error + ListTagsForResource(*omics.ListTagsForResourceInput) (*omics.ListTagsForResourceOutput, error) ListTagsForResourceWithContext(aws.Context, *omics.ListTagsForResourceInput, ...request.Option) (*omics.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*omics.ListTagsForResourceInput) (*request.Request, *omics.ListTagsForResourceOutput) @@ -386,6 +428,10 @@ type OmicsAPI interface { UpdateAnnotationStoreWithContext(aws.Context, *omics.UpdateAnnotationStoreInput, ...request.Option) (*omics.UpdateAnnotationStoreOutput, error) UpdateAnnotationStoreRequest(*omics.UpdateAnnotationStoreInput) (*request.Request, *omics.UpdateAnnotationStoreOutput) + UpdateAnnotationStoreVersion(*omics.UpdateAnnotationStoreVersionInput) (*omics.UpdateAnnotationStoreVersionOutput, error) + UpdateAnnotationStoreVersionWithContext(aws.Context, *omics.UpdateAnnotationStoreVersionInput, ...request.Option) (*omics.UpdateAnnotationStoreVersionOutput, error) + UpdateAnnotationStoreVersionRequest(*omics.UpdateAnnotationStoreVersionInput) (*request.Request, *omics.UpdateAnnotationStoreVersionOutput) + UpdateRunGroup(*omics.UpdateRunGroupInput) (*omics.UpdateRunGroupOutput, error) UpdateRunGroupWithContext(aws.Context, *omics.UpdateRunGroupInput, ...request.Option) (*omics.UpdateRunGroupOutput, error) UpdateRunGroupRequest(*omics.UpdateRunGroupInput) (*request.Request, *omics.UpdateRunGroupOutput) @@ -411,6 +457,12 @@ type OmicsAPI interface { WaitUntilAnnotationStoreDeleted(*omics.GetAnnotationStoreInput) error WaitUntilAnnotationStoreDeletedWithContext(aws.Context, *omics.GetAnnotationStoreInput, ...request.WaiterOption) error + WaitUntilAnnotationStoreVersionCreated(*omics.GetAnnotationStoreVersionInput) error + WaitUntilAnnotationStoreVersionCreatedWithContext(aws.Context, *omics.GetAnnotationStoreVersionInput, ...request.WaiterOption) error + + WaitUntilAnnotationStoreVersionDeleted(*omics.GetAnnotationStoreVersionInput) error + WaitUntilAnnotationStoreVersionDeletedWithContext(aws.Context, *omics.GetAnnotationStoreVersionInput, ...request.WaiterOption) error + WaitUntilReadSetActivationJobCompleted(*omics.GetReadSetActivationJobInput) error WaitUntilReadSetActivationJobCompletedWithContext(aws.Context, *omics.GetReadSetActivationJobInput, ...request.WaiterOption) error diff --git a/service/omics/waiters.go b/service/omics/waiters.go index 5f81b455a24..91f673fa2ab 100644 --- a/service/omics/waiters.go +++ b/service/omics/waiters.go @@ -192,6 +192,123 @@ func (c *Omics) WaitUntilAnnotationStoreDeletedWithContext(ctx aws.Context, inpu return w.WaitWithContext(ctx) } +// WaitUntilAnnotationStoreVersionCreated uses the Amazon Omics API operation +// GetAnnotationStoreVersion to wait for a condition to be met before returning. +// If the condition is not met within the max attempt window, an error will +// be returned. +func (c *Omics) WaitUntilAnnotationStoreVersionCreated(input *GetAnnotationStoreVersionInput) error { + return c.WaitUntilAnnotationStoreVersionCreatedWithContext(aws.BackgroundContext(), input) +} + +// WaitUntilAnnotationStoreVersionCreatedWithContext is an extended version of WaitUntilAnnotationStoreVersionCreated. +// With the support for passing in a context and options to configure the +// Waiter and the underlying request options. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) WaitUntilAnnotationStoreVersionCreatedWithContext(ctx aws.Context, input *GetAnnotationStoreVersionInput, opts ...request.WaiterOption) error { + w := request.Waiter{ + Name: "WaitUntilAnnotationStoreVersionCreated", + MaxAttempts: 20, + Delay: request.ConstantWaiterDelay(30 * time.Second), + Acceptors: []request.WaiterAcceptor{ + { + State: request.SuccessWaiterState, + Matcher: request.PathWaiterMatch, Argument: "status", + Expected: "ACTIVE", + }, + { + State: request.RetryWaiterState, + Matcher: request.PathWaiterMatch, Argument: "status", + Expected: "CREATING", + }, + { + State: request.RetryWaiterState, + Matcher: request.PathWaiterMatch, Argument: "status", + Expected: "UPDATING", + }, + { + State: request.FailureWaiterState, + Matcher: request.PathWaiterMatch, Argument: "status", + Expected: "FAILED", + }, + }, + Logger: c.Config.Logger, + NewRequest: func(opts []request.Option) (*request.Request, error) { + var inCpy *GetAnnotationStoreVersionInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetAnnotationStoreVersionRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + w.ApplyOptions(opts...) + + return w.WaitWithContext(ctx) +} + +// WaitUntilAnnotationStoreVersionDeleted uses the Amazon Omics API operation +// GetAnnotationStoreVersion to wait for a condition to be met before returning. +// If the condition is not met within the max attempt window, an error will +// be returned. +func (c *Omics) WaitUntilAnnotationStoreVersionDeleted(input *GetAnnotationStoreVersionInput) error { + return c.WaitUntilAnnotationStoreVersionDeletedWithContext(aws.BackgroundContext(), input) +} + +// WaitUntilAnnotationStoreVersionDeletedWithContext is an extended version of WaitUntilAnnotationStoreVersionDeleted. +// With the support for passing in a context and options to configure the +// Waiter and the underlying request options. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Omics) WaitUntilAnnotationStoreVersionDeletedWithContext(ctx aws.Context, input *GetAnnotationStoreVersionInput, opts ...request.WaiterOption) error { + w := request.Waiter{ + Name: "WaitUntilAnnotationStoreVersionDeleted", + MaxAttempts: 20, + Delay: request.ConstantWaiterDelay(30 * time.Second), + Acceptors: []request.WaiterAcceptor{ + { + State: request.SuccessWaiterState, + Matcher: request.PathWaiterMatch, Argument: "status", + Expected: "DELETED", + }, + { + State: request.SuccessWaiterState, + Matcher: request.ErrorWaiterMatch, + Expected: "ResourceNotFoundException", + }, + { + State: request.RetryWaiterState, + Matcher: request.PathWaiterMatch, Argument: "status", + Expected: "DELETING", + }, + }, + Logger: c.Config.Logger, + NewRequest: func(opts []request.Option) (*request.Request, error) { + var inCpy *GetAnnotationStoreVersionInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetAnnotationStoreVersionRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + w.ApplyOptions(opts...) + + return w.WaitWithContext(ctx) +} + // WaitUntilReadSetActivationJobCompleted uses the Amazon Omics API operation // GetReadSetActivationJob to wait for a condition to be met before returning. // If the condition is not met within the max attempt window, an error will diff --git a/service/pi/api.go b/service/pi/api.go index 72cd1fcc1cb..d61557d6602 100644 --- a/service/pi/api.go +++ b/service/pi/api.go @@ -10,8 +10,181 @@ import ( "github.com/aws/aws-sdk-go/aws/awsutil" "github.com/aws/aws-sdk-go/aws/request" "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/jsonrpc" ) +const opCreatePerformanceAnalysisReport = "CreatePerformanceAnalysisReport" + +// CreatePerformanceAnalysisReportRequest generates a "aws/request.Request" representing the +// client's request for the CreatePerformanceAnalysisReport operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreatePerformanceAnalysisReport for more information on using the CreatePerformanceAnalysisReport +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreatePerformanceAnalysisReportRequest method. +// req, resp := client.CreatePerformanceAnalysisReportRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/CreatePerformanceAnalysisReport +func (c *PI) CreatePerformanceAnalysisReportRequest(input *CreatePerformanceAnalysisReportInput) (req *request.Request, output *CreatePerformanceAnalysisReportOutput) { + op := &request.Operation{ + Name: opCreatePerformanceAnalysisReport, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreatePerformanceAnalysisReportInput{} + } + + output = &CreatePerformanceAnalysisReportOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreatePerformanceAnalysisReport API operation for AWS Performance Insights. +// +// Creates a new performance analysis report for a specific time period for +// the DB instance. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Performance Insights's +// API operation CreatePerformanceAnalysisReport for usage and error information. +// +// Returned Error Types: +// +// - InvalidArgumentException +// One of the arguments provided is invalid for this request. +// +// - InternalServiceError +// The request failed due to an unknown error. +// +// - NotAuthorizedException +// The user is not authorized to perform this request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/CreatePerformanceAnalysisReport +func (c *PI) CreatePerformanceAnalysisReport(input *CreatePerformanceAnalysisReportInput) (*CreatePerformanceAnalysisReportOutput, error) { + req, out := c.CreatePerformanceAnalysisReportRequest(input) + return out, req.Send() +} + +// CreatePerformanceAnalysisReportWithContext is the same as CreatePerformanceAnalysisReport with the addition of +// the ability to pass a context and additional request options. +// +// See CreatePerformanceAnalysisReport for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *PI) CreatePerformanceAnalysisReportWithContext(ctx aws.Context, input *CreatePerformanceAnalysisReportInput, opts ...request.Option) (*CreatePerformanceAnalysisReportOutput, error) { + req, out := c.CreatePerformanceAnalysisReportRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeletePerformanceAnalysisReport = "DeletePerformanceAnalysisReport" + +// DeletePerformanceAnalysisReportRequest generates a "aws/request.Request" representing the +// client's request for the DeletePerformanceAnalysisReport operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeletePerformanceAnalysisReport for more information on using the DeletePerformanceAnalysisReport +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeletePerformanceAnalysisReportRequest method. +// req, resp := client.DeletePerformanceAnalysisReportRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/DeletePerformanceAnalysisReport +func (c *PI) DeletePerformanceAnalysisReportRequest(input *DeletePerformanceAnalysisReportInput) (req *request.Request, output *DeletePerformanceAnalysisReportOutput) { + op := &request.Operation{ + Name: opDeletePerformanceAnalysisReport, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeletePerformanceAnalysisReportInput{} + } + + output = &DeletePerformanceAnalysisReportOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeletePerformanceAnalysisReport API operation for AWS Performance Insights. +// +// Deletes a performance analysis report. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Performance Insights's +// API operation DeletePerformanceAnalysisReport for usage and error information. +// +// Returned Error Types: +// +// - InvalidArgumentException +// One of the arguments provided is invalid for this request. +// +// - InternalServiceError +// The request failed due to an unknown error. +// +// - NotAuthorizedException +// The user is not authorized to perform this request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/DeletePerformanceAnalysisReport +func (c *PI) DeletePerformanceAnalysisReport(input *DeletePerformanceAnalysisReportInput) (*DeletePerformanceAnalysisReportOutput, error) { + req, out := c.DeletePerformanceAnalysisReportRequest(input) + return out, req.Send() +} + +// DeletePerformanceAnalysisReportWithContext is the same as DeletePerformanceAnalysisReport with the addition of +// the ability to pass a context and additional request options. +// +// See DeletePerformanceAnalysisReport for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *PI) DeletePerformanceAnalysisReportWithContext(ctx aws.Context, input *DeletePerformanceAnalysisReportInput, opts ...request.Option) (*DeletePerformanceAnalysisReportOutput, error) { + req, out := c.DeletePerformanceAnalysisReportRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeDimensionKeys = "DescribeDimensionKeys" // DescribeDimensionKeysRequest generates a "aws/request.Request" representing the @@ -246,6 +419,93 @@ func (c *PI) GetDimensionKeyDetailsWithContext(ctx aws.Context, input *GetDimens return out, req.Send() } +const opGetPerformanceAnalysisReport = "GetPerformanceAnalysisReport" + +// GetPerformanceAnalysisReportRequest generates a "aws/request.Request" representing the +// client's request for the GetPerformanceAnalysisReport operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetPerformanceAnalysisReport for more information on using the GetPerformanceAnalysisReport +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetPerformanceAnalysisReportRequest method. +// req, resp := client.GetPerformanceAnalysisReportRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetPerformanceAnalysisReport +func (c *PI) GetPerformanceAnalysisReportRequest(input *GetPerformanceAnalysisReportInput) (req *request.Request, output *GetPerformanceAnalysisReportOutput) { + op := &request.Operation{ + Name: opGetPerformanceAnalysisReport, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetPerformanceAnalysisReportInput{} + } + + output = &GetPerformanceAnalysisReportOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetPerformanceAnalysisReport API operation for AWS Performance Insights. +// +// Retrieves the report including the report ID, status, time details, and the +// insights with recommendations. The report status can be RUNNING, SUCCEEDED, +// or FAILED. The insights include the description and recommendation fields. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Performance Insights's +// API operation GetPerformanceAnalysisReport for usage and error information. +// +// Returned Error Types: +// +// - InvalidArgumentException +// One of the arguments provided is invalid for this request. +// +// - InternalServiceError +// The request failed due to an unknown error. +// +// - NotAuthorizedException +// The user is not authorized to perform this request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetPerformanceAnalysisReport +func (c *PI) GetPerformanceAnalysisReport(input *GetPerformanceAnalysisReportInput) (*GetPerformanceAnalysisReportOutput, error) { + req, out := c.GetPerformanceAnalysisReportRequest(input) + return out, req.Send() +} + +// GetPerformanceAnalysisReportWithContext is the same as GetPerformanceAnalysisReport with the addition of +// the ability to pass a context and additional request options. +// +// See GetPerformanceAnalysisReport for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *PI) GetPerformanceAnalysisReportWithContext(ctx aws.Context, input *GetPerformanceAnalysisReportInput, opts ...request.Option) (*GetPerformanceAnalysisReportOutput, error) { + req, out := c.GetPerformanceAnalysisReportRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetResourceMetadata = "GetResourceMetadata" // GetResourceMetadataRequest generates a "aws/request.Request" representing the @@ -765,44 +1025,804 @@ func (c *PI) ListAvailableResourceMetricsPagesWithContext(ctx aws.Context, input return p.Err() } -// A timestamp, and a single numerical value, which together represent a measurement -// at a particular point in time. -type DataPoint struct { - _ struct{} `type:"structure"` - - // The time, in epoch format, associated with a particular Value. - // - // Timestamp is a required field - Timestamp *time.Time `type:"timestamp" required:"true"` - - // The actual value associated with a particular Timestamp. - // - // Value is a required field - Value *float64 `type:"double" required:"true"` -} +const opListPerformanceAnalysisReports = "ListPerformanceAnalysisReports" -// String returns the string representation. +// ListPerformanceAnalysisReportsRequest generates a "aws/request.Request" representing the +// client's request for the ListPerformanceAnalysisReports operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. // -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DataPoint) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation. +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. // -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DataPoint) GoString() string { - return s.String() -} +// See ListPerformanceAnalysisReports for more information on using the ListPerformanceAnalysisReports +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListPerformanceAnalysisReportsRequest method. +// req, resp := client.ListPerformanceAnalysisReportsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListPerformanceAnalysisReports +func (c *PI) ListPerformanceAnalysisReportsRequest(input *ListPerformanceAnalysisReportsInput) (req *request.Request, output *ListPerformanceAnalysisReportsOutput) { + op := &request.Operation{ + Name: opListPerformanceAnalysisReports, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } -// SetTimestamp sets the Timestamp field's value. -func (s *DataPoint) SetTimestamp(v time.Time) *DataPoint { - s.Timestamp = &v - return s + if input == nil { + input = &ListPerformanceAnalysisReportsInput{} + } + + output = &ListPerformanceAnalysisReportsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListPerformanceAnalysisReports API operation for AWS Performance Insights. +// +// Lists all the analysis reports created for the DB instance. The reports are +// sorted based on the start time of each report. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Performance Insights's +// API operation ListPerformanceAnalysisReports for usage and error information. +// +// Returned Error Types: +// +// - InvalidArgumentException +// One of the arguments provided is invalid for this request. +// +// - InternalServiceError +// The request failed due to an unknown error. +// +// - NotAuthorizedException +// The user is not authorized to perform this request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListPerformanceAnalysisReports +func (c *PI) ListPerformanceAnalysisReports(input *ListPerformanceAnalysisReportsInput) (*ListPerformanceAnalysisReportsOutput, error) { + req, out := c.ListPerformanceAnalysisReportsRequest(input) + return out, req.Send() +} + +// ListPerformanceAnalysisReportsWithContext is the same as ListPerformanceAnalysisReports with the addition of +// the ability to pass a context and additional request options. +// +// See ListPerformanceAnalysisReports for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *PI) ListPerformanceAnalysisReportsWithContext(ctx aws.Context, input *ListPerformanceAnalysisReportsInput, opts ...request.Option) (*ListPerformanceAnalysisReportsOutput, error) { + req, out := c.ListPerformanceAnalysisReportsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListPerformanceAnalysisReportsPages iterates over the pages of a ListPerformanceAnalysisReports operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListPerformanceAnalysisReports method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListPerformanceAnalysisReports operation. +// pageNum := 0 +// err := client.ListPerformanceAnalysisReportsPages(params, +// func(page *pi.ListPerformanceAnalysisReportsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *PI) ListPerformanceAnalysisReportsPages(input *ListPerformanceAnalysisReportsInput, fn func(*ListPerformanceAnalysisReportsOutput, bool) bool) error { + return c.ListPerformanceAnalysisReportsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListPerformanceAnalysisReportsPagesWithContext same as ListPerformanceAnalysisReportsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *PI) ListPerformanceAnalysisReportsPagesWithContext(ctx aws.Context, input *ListPerformanceAnalysisReportsInput, fn func(*ListPerformanceAnalysisReportsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListPerformanceAnalysisReportsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListPerformanceAnalysisReportsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListPerformanceAnalysisReportsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListTagsForResource +func (c *PI) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for AWS Performance Insights. +// +// Retrieves all the metadata tags associated with Amazon RDS Performance Insights +// resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Performance Insights's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// +// - InvalidArgumentException +// One of the arguments provided is invalid for this request. +// +// - InternalServiceError +// The request failed due to an unknown error. +// +// - NotAuthorizedException +// The user is not authorized to perform this request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListTagsForResource +func (c *PI) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *PI) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/TagResource +func (c *PI) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for AWS Performance Insights. +// +// Adds metadata tags to the Amazon RDS Performance Insights resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Performance Insights's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// +// - InvalidArgumentException +// One of the arguments provided is invalid for this request. +// +// - InternalServiceError +// The request failed due to an unknown error. +// +// - NotAuthorizedException +// The user is not authorized to perform this request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/TagResource +func (c *PI) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *PI) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/UntagResource +func (c *PI) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for AWS Performance Insights. +// +// Deletes the metadata tags from the Amazon RDS Performance Insights resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Performance Insights's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// +// - InvalidArgumentException +// One of the arguments provided is invalid for this request. +// +// - InternalServiceError +// The request failed due to an unknown error. +// +// - NotAuthorizedException +// The user is not authorized to perform this request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/UntagResource +func (c *PI) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *PI) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// Retrieves the summary of the performance analysis report created for a time +// period. +type AnalysisReport struct { + _ struct{} `type:"structure"` + + // The name of the analysis report. + // + // AnalysisReportId is a required field + AnalysisReportId *string `min:"1" type:"string" required:"true"` + + // The time you created the analysis report. + CreateTime *time.Time `type:"timestamp"` + + // The analysis end time in the report. + EndTime *time.Time `type:"timestamp"` + + // The unique identifier of the analysis report. + Identifier *string `type:"string"` + + // The list of identified insights in the analysis report. + Insights []*Insight `type:"list"` + + // List the tags for the Amazon Web Services service for which Performance Insights + // returns metrics. Valid values are as follows: + // + // * RDS + // + // * DOCDB + ServiceType *string `type:"string" enum:"ServiceType"` + + // The analysis start time in the report. + StartTime *time.Time `type:"timestamp"` + + // The status of the created analysis report. + Status *string `type:"string" enum:"AnalysisStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnalysisReport) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnalysisReport) GoString() string { + return s.String() +} + +// SetAnalysisReportId sets the AnalysisReportId field's value. +func (s *AnalysisReport) SetAnalysisReportId(v string) *AnalysisReport { + s.AnalysisReportId = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *AnalysisReport) SetCreateTime(v time.Time) *AnalysisReport { + s.CreateTime = &v + return s +} + +// SetEndTime sets the EndTime field's value. +func (s *AnalysisReport) SetEndTime(v time.Time) *AnalysisReport { + s.EndTime = &v + return s +} + +// SetIdentifier sets the Identifier field's value. +func (s *AnalysisReport) SetIdentifier(v string) *AnalysisReport { + s.Identifier = &v + return s +} + +// SetInsights sets the Insights field's value. +func (s *AnalysisReport) SetInsights(v []*Insight) *AnalysisReport { + s.Insights = v + return s +} + +// SetServiceType sets the ServiceType field's value. +func (s *AnalysisReport) SetServiceType(v string) *AnalysisReport { + s.ServiceType = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *AnalysisReport) SetStartTime(v time.Time) *AnalysisReport { + s.StartTime = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *AnalysisReport) SetStatus(v string) *AnalysisReport { + s.Status = &v + return s +} + +// Retrieves the details of the performance analysis report. +type AnalysisReportSummary struct { + _ struct{} `type:"structure"` + + // The name of the analysis report. + AnalysisReportId *string `type:"string"` + + // The time you created the analysis report. + CreateTime *time.Time `type:"timestamp"` + + // The end time of the analysis in the report. + EndTime *time.Time `type:"timestamp"` + + // The start time of the analysis in the report. + StartTime *time.Time `type:"timestamp"` + + // The status of the analysis report. + Status *string `type:"string" enum:"AnalysisStatus"` + + // List of all the tags added to the analysis report. + Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnalysisReportSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnalysisReportSummary) GoString() string { + return s.String() +} + +// SetAnalysisReportId sets the AnalysisReportId field's value. +func (s *AnalysisReportSummary) SetAnalysisReportId(v string) *AnalysisReportSummary { + s.AnalysisReportId = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *AnalysisReportSummary) SetCreateTime(v time.Time) *AnalysisReportSummary { + s.CreateTime = &v + return s +} + +// SetEndTime sets the EndTime field's value. +func (s *AnalysisReportSummary) SetEndTime(v time.Time) *AnalysisReportSummary { + s.EndTime = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *AnalysisReportSummary) SetStartTime(v time.Time) *AnalysisReportSummary { + s.StartTime = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *AnalysisReportSummary) SetStatus(v string) *AnalysisReportSummary { + s.Status = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *AnalysisReportSummary) SetTags(v []*Tag) *AnalysisReportSummary { + s.Tags = v + return s +} + +type CreatePerformanceAnalysisReportInput struct { + _ struct{} `type:"structure"` + + // The end time defined for the analysis report. + // + // EndTime is a required field + EndTime *time.Time `type:"timestamp" required:"true"` + + // An immutable, Amazon Web Services Region-unique identifier for a data source. + // Performance Insights gathers metrics from this data source. + // + // To use an Amazon RDS instance as a data source, you specify its DbiResourceId + // value. For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A. + // + // Identifier is a required field + Identifier *string `type:"string" required:"true"` + + // The Amazon Web Services service for which Performance Insights will return + // metrics. Valid value is RDS. + // + // ServiceType is a required field + ServiceType *string `type:"string" required:"true" enum:"ServiceType"` + + // The start time defined for the analysis report. + // + // StartTime is a required field + StartTime *time.Time `type:"timestamp" required:"true"` + + // The metadata assigned to the analysis report consisting of a key-value pair. + Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePerformanceAnalysisReportInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePerformanceAnalysisReportInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreatePerformanceAnalysisReportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreatePerformanceAnalysisReportInput"} + if s.EndTime == nil { + invalidParams.Add(request.NewErrParamRequired("EndTime")) + } + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.ServiceType == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceType")) + } + if s.StartTime == nil { + invalidParams.Add(request.NewErrParamRequired("StartTime")) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEndTime sets the EndTime field's value. +func (s *CreatePerformanceAnalysisReportInput) SetEndTime(v time.Time) *CreatePerformanceAnalysisReportInput { + s.EndTime = &v + return s +} + +// SetIdentifier sets the Identifier field's value. +func (s *CreatePerformanceAnalysisReportInput) SetIdentifier(v string) *CreatePerformanceAnalysisReportInput { + s.Identifier = &v + return s +} + +// SetServiceType sets the ServiceType field's value. +func (s *CreatePerformanceAnalysisReportInput) SetServiceType(v string) *CreatePerformanceAnalysisReportInput { + s.ServiceType = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *CreatePerformanceAnalysisReportInput) SetStartTime(v time.Time) *CreatePerformanceAnalysisReportInput { + s.StartTime = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreatePerformanceAnalysisReportInput) SetTags(v []*Tag) *CreatePerformanceAnalysisReportInput { + s.Tags = v + return s +} + +type CreatePerformanceAnalysisReportOutput struct { + _ struct{} `type:"structure"` + + // A unique identifier for the created analysis report. + AnalysisReportId *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePerformanceAnalysisReportOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePerformanceAnalysisReportOutput) GoString() string { + return s.String() +} + +// SetAnalysisReportId sets the AnalysisReportId field's value. +func (s *CreatePerformanceAnalysisReportOutput) SetAnalysisReportId(v string) *CreatePerformanceAnalysisReportOutput { + s.AnalysisReportId = &v + return s +} + +// List of data objects which provide details about source metrics. This field +// can be used to determine the PI metric to render for the insight. This data +// type also includes static values for the metrics for the Insight that were +// calculated and included in text and annotations on the DB load chart. +type Data struct { + _ struct{} `type:"structure"` + + // This field determines the Performance Insights metric to render for the insight. + // The name field refers to a Performance Insights metric. + PerformanceInsightsMetric *PerformanceInsightsMetric `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Data) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Data) GoString() string { + return s.String() +} + +// SetPerformanceInsightsMetric sets the PerformanceInsightsMetric field's value. +func (s *Data) SetPerformanceInsightsMetric(v *PerformanceInsightsMetric) *Data { + s.PerformanceInsightsMetric = v + return s +} + +// A timestamp, and a single numerical value, which together represent a measurement +// at a particular point in time. +type DataPoint struct { + _ struct{} `type:"structure"` + + // The time, in epoch format, associated with a particular Value. + // + // Timestamp is a required field + Timestamp *time.Time `type:"timestamp" required:"true"` + + // The actual value associated with a particular Timestamp. + // + // Value is a required field + Value *float64 `type:"double" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataPoint) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataPoint) GoString() string { + return s.String() +} + +// SetTimestamp sets the Timestamp field's value. +func (s *DataPoint) SetTimestamp(v time.Time) *DataPoint { + s.Timestamp = &v + return s } // SetValue sets the Value field's value. @@ -811,6 +1831,112 @@ func (s *DataPoint) SetValue(v float64) *DataPoint { return s } +type DeletePerformanceAnalysisReportInput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the analysis report for deletion. + // + // AnalysisReportId is a required field + AnalysisReportId *string `min:"1" type:"string" required:"true"` + + // An immutable identifier for a data source that is unique for an Amazon Web + // Services Region. Performance Insights gathers metrics from this data source. + // In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, + // the identifier is returned as DbiResourceId. + // + // To use a DB instance as a data source, specify its DbiResourceId value. For + // example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X. + // + // Identifier is a required field + Identifier *string `type:"string" required:"true"` + + // The Amazon Web Services service for which Performance Insights will return + // metrics. Valid value is RDS. + // + // ServiceType is a required field + ServiceType *string `type:"string" required:"true" enum:"ServiceType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePerformanceAnalysisReportInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePerformanceAnalysisReportInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeletePerformanceAnalysisReportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePerformanceAnalysisReportInput"} + if s.AnalysisReportId == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisReportId")) + } + if s.AnalysisReportId != nil && len(*s.AnalysisReportId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisReportId", 1)) + } + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.ServiceType == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnalysisReportId sets the AnalysisReportId field's value. +func (s *DeletePerformanceAnalysisReportInput) SetAnalysisReportId(v string) *DeletePerformanceAnalysisReportInput { + s.AnalysisReportId = &v + return s +} + +// SetIdentifier sets the Identifier field's value. +func (s *DeletePerformanceAnalysisReportInput) SetIdentifier(v string) *DeletePerformanceAnalysisReportInput { + s.Identifier = &v + return s +} + +// SetServiceType sets the ServiceType field's value. +func (s *DeletePerformanceAnalysisReportInput) SetServiceType(v string) *DeletePerformanceAnalysisReportInput { + s.ServiceType = &v + return s +} + +type DeletePerformanceAnalysisReportOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePerformanceAnalysisReportOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePerformanceAnalysisReportOutput) GoString() string { + return s.String() +} + type DescribeDimensionKeysInput struct { _ struct{} `type:"structure"` @@ -1746,6 +2872,140 @@ func (s *GetDimensionKeyDetailsOutput) SetDimensions(v []*DimensionKeyDetail) *G return s } +type GetPerformanceAnalysisReportInput struct { + _ struct{} `type:"structure"` + + // The text language in the report. The default language is EN_US (English). + AcceptLanguage *string `type:"string" enum:"AcceptLanguage"` + + // A unique identifier of the created analysis report. For example, report-12345678901234567 + // + // AnalysisReportId is a required field + AnalysisReportId *string `min:"1" type:"string" required:"true"` + + // An immutable identifier for a data source that is unique for an Amazon Web + // Services Region. Performance Insights gathers metrics from this data source. + // In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, + // the identifier is returned as DbiResourceId. + // + // To use a DB instance as a data source, specify its DbiResourceId value. For + // example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X. + // + // Identifier is a required field + Identifier *string `type:"string" required:"true"` + + // The Amazon Web Services service for which Performance Insights will return + // metrics. Valid value is RDS. + // + // ServiceType is a required field + ServiceType *string `type:"string" required:"true" enum:"ServiceType"` + + // Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. + // The default value is plain text. + TextFormat *string `type:"string" enum:"TextFormat"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPerformanceAnalysisReportInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPerformanceAnalysisReportInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetPerformanceAnalysisReportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetPerformanceAnalysisReportInput"} + if s.AnalysisReportId == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisReportId")) + } + if s.AnalysisReportId != nil && len(*s.AnalysisReportId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisReportId", 1)) + } + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.ServiceType == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAcceptLanguage sets the AcceptLanguage field's value. +func (s *GetPerformanceAnalysisReportInput) SetAcceptLanguage(v string) *GetPerformanceAnalysisReportInput { + s.AcceptLanguage = &v + return s +} + +// SetAnalysisReportId sets the AnalysisReportId field's value. +func (s *GetPerformanceAnalysisReportInput) SetAnalysisReportId(v string) *GetPerformanceAnalysisReportInput { + s.AnalysisReportId = &v + return s +} + +// SetIdentifier sets the Identifier field's value. +func (s *GetPerformanceAnalysisReportInput) SetIdentifier(v string) *GetPerformanceAnalysisReportInput { + s.Identifier = &v + return s +} + +// SetServiceType sets the ServiceType field's value. +func (s *GetPerformanceAnalysisReportInput) SetServiceType(v string) *GetPerformanceAnalysisReportInput { + s.ServiceType = &v + return s +} + +// SetTextFormat sets the TextFormat field's value. +func (s *GetPerformanceAnalysisReportInput) SetTextFormat(v string) *GetPerformanceAnalysisReportInput { + s.TextFormat = &v + return s +} + +type GetPerformanceAnalysisReportOutput struct { + _ struct{} `type:"structure"` + + // The summary of the performance analysis report created for a time period. + AnalysisReport *AnalysisReport `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPerformanceAnalysisReportOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPerformanceAnalysisReportOutput) GoString() string { + return s.String() +} + +// SetAnalysisReport sets the AnalysisReport field's value. +func (s *GetPerformanceAnalysisReportOutput) SetAnalysisReport(v *AnalysisReport) *GetPerformanceAnalysisReportOutput { + s.AnalysisReport = v + return s +} + type GetResourceMetadataInput struct { _ struct{} `type:"structure"` @@ -2121,9 +3381,143 @@ func (s *GetResourceMetricsOutput) SetMetricList(v []*MetricKeyDataPoints) *GetR return s } -// SetNextToken sets the NextToken field's value. -func (s *GetResourceMetricsOutput) SetNextToken(v string) *GetResourceMetricsOutput { - s.NextToken = &v +// SetNextToken sets the NextToken field's value. +func (s *GetResourceMetricsOutput) SetNextToken(v string) *GetResourceMetricsOutput { + s.NextToken = &v + return s +} + +// Retrieves the list of performance issues which are identified. +type Insight struct { + _ struct{} `type:"structure"` + + // Metric names and values from the timeframe used as baseline to generate the + // insight. + BaselineData []*Data `type:"list"` + + // Indicates if the insight is causal or correlated insight. + Context *string `type:"string" enum:"ContextType"` + + // Description of the insight. For example: A high severity Insight found between + // 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. + // Likely performance impact. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Insight's + // String and GoString methods. + Description *string `type:"string" sensitive:"true"` + + // The end time of the insight. For example, 2018-10-30T00:00:00Z. + EndTime *time.Time `type:"timestamp"` + + // List of data objects containing metrics and references from the time range + // while generating the insight. + InsightData []*Data `type:"list"` + + // The unique identifier for the insight. For example, insight-12345678901234567. + // + // InsightId is a required field + InsightId *string `type:"string" required:"true"` + + // The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs. + InsightType *string `type:"string"` + + // List of recommendations for the insight. For example, Investigate the following + // SQLs that contributed to 100% of the total DBLoad during that time period: + // sql-id. + Recommendations []*Recommendation `type:"list"` + + // The severity of the insight. The values are: Low, Medium, or High. + Severity *string `type:"string" enum:"Severity"` + + // The start time of the insight. For example, 2018-10-30T00:00:00Z. + StartTime *time.Time `type:"timestamp"` + + // List of supporting insights that provide additional factors for the insight. + SupportingInsights []*Insight `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Insight) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Insight) GoString() string { + return s.String() +} + +// SetBaselineData sets the BaselineData field's value. +func (s *Insight) SetBaselineData(v []*Data) *Insight { + s.BaselineData = v + return s +} + +// SetContext sets the Context field's value. +func (s *Insight) SetContext(v string) *Insight { + s.Context = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *Insight) SetDescription(v string) *Insight { + s.Description = &v + return s +} + +// SetEndTime sets the EndTime field's value. +func (s *Insight) SetEndTime(v time.Time) *Insight { + s.EndTime = &v + return s +} + +// SetInsightData sets the InsightData field's value. +func (s *Insight) SetInsightData(v []*Data) *Insight { + s.InsightData = v + return s +} + +// SetInsightId sets the InsightId field's value. +func (s *Insight) SetInsightId(v string) *Insight { + s.InsightId = &v + return s +} + +// SetInsightType sets the InsightType field's value. +func (s *Insight) SetInsightType(v string) *Insight { + s.InsightType = &v + return s +} + +// SetRecommendations sets the Recommendations field's value. +func (s *Insight) SetRecommendations(v []*Recommendation) *Insight { + s.Recommendations = v + return s +} + +// SetSeverity sets the Severity field's value. +func (s *Insight) SetSeverity(v string) *Insight { + s.Severity = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *Insight) SetStartTime(v time.Time) *Insight { + s.StartTime = &v + return s +} + +// SetSupportingInsights sets the SupportingInsights field's value. +func (s *Insight) SetSupportingInsights(v []*Insight) *Insight { + s.SupportingInsights = v return s } @@ -2558,6 +3952,248 @@ func (s *ListAvailableResourceMetricsOutput) SetNextToken(v string) *ListAvailab return s } +type ListPerformanceAnalysisReportsInput struct { + _ struct{} `type:"structure"` + + // An immutable identifier for a data source that is unique for an Amazon Web + // Services Region. Performance Insights gathers metrics from this data source. + // In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, + // the identifier is returned as DbiResourceId. + // + // To use a DB instance as a data source, specify its DbiResourceId value. For + // example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X. + // + // Identifier is a required field + Identifier *string `type:"string" required:"true"` + + // Specifies whether or not to include the list of tags in the response. + ListTags *bool `type:"boolean"` + + // The maximum number of items to return in the response. If more items exist + // than the specified MaxResults value, a pagination token is included in the + // response so that the remaining results can be retrieved. + MaxResults *int64 `type:"integer"` + + // An optional pagination token provided by a previous request. If this parameter + // is specified, the response includes only records beyond the token, up to + // the value specified by MaxResults. + NextToken *string `min:"1" type:"string"` + + // The Amazon Web Services service for which Performance Insights returns metrics. + // Valid value is RDS. + // + // ServiceType is a required field + ServiceType *string `type:"string" required:"true" enum:"ServiceType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPerformanceAnalysisReportsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPerformanceAnalysisReportsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListPerformanceAnalysisReportsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListPerformanceAnalysisReportsInput"} + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.ServiceType == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIdentifier sets the Identifier field's value. +func (s *ListPerformanceAnalysisReportsInput) SetIdentifier(v string) *ListPerformanceAnalysisReportsInput { + s.Identifier = &v + return s +} + +// SetListTags sets the ListTags field's value. +func (s *ListPerformanceAnalysisReportsInput) SetListTags(v bool) *ListPerformanceAnalysisReportsInput { + s.ListTags = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListPerformanceAnalysisReportsInput) SetMaxResults(v int64) *ListPerformanceAnalysisReportsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPerformanceAnalysisReportsInput) SetNextToken(v string) *ListPerformanceAnalysisReportsInput { + s.NextToken = &v + return s +} + +// SetServiceType sets the ServiceType field's value. +func (s *ListPerformanceAnalysisReportsInput) SetServiceType(v string) *ListPerformanceAnalysisReportsInput { + s.ServiceType = &v + return s +} + +type ListPerformanceAnalysisReportsOutput struct { + _ struct{} `type:"structure"` + + // List of reports including the report identifier, start and end time, creation + // time, and status. + AnalysisReports []*AnalysisReportSummary `type:"list"` + + // An optional pagination token provided by a previous request. If this parameter + // is specified, the response includes only records beyond the token, up to + // the value specified by MaxResults. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPerformanceAnalysisReportsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPerformanceAnalysisReportsOutput) GoString() string { + return s.String() +} + +// SetAnalysisReports sets the AnalysisReports field's value. +func (s *ListPerformanceAnalysisReportsOutput) SetAnalysisReports(v []*AnalysisReportSummary) *ListPerformanceAnalysisReportsOutput { + s.AnalysisReports = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPerformanceAnalysisReportsOutput) SetNextToken(v string) *ListPerformanceAnalysisReportsOutput { + s.NextToken = &v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` + + // Lists all the tags for the Amazon RDS Performance Insights resource. This + // value is an Amazon Resource Name (ARN). For information about creating an + // ARN, see Constructing an RDS Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing). + // + // ResourceARN is a required field + ResourceARN *string `min:"1" type:"string" required:"true"` + + // List the tags for the Amazon Web Services service for which Performance Insights + // returns metrics. Valid value is RDS. + // + // ServiceType is a required field + ServiceType *string `type:"string" required:"true" enum:"ServiceType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceARN == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceARN")) + } + if s.ResourceARN != nil && len(*s.ResourceARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceARN", 1)) + } + if s.ServiceType == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceARN sets the ResourceARN field's value. +func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput { + s.ResourceARN = &v + return s +} + +// SetServiceType sets the ServiceType field's value. +func (s *ListTagsForResourceInput) SetServiceType(v string) *ListTagsForResourceInput { + s.ServiceType = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The metadata assigned to an Amazon RDS resource consisting of a key-value + // pair. + Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput { + s.Tags = v + return s +} + // The available dimension information for a metric type. type MetricDimensionGroups struct { _ struct{} `type:"structure"` @@ -2794,18 +4430,125 @@ func (s *NotAuthorizedException) OrigErr() error { return nil } -func (s *NotAuthorizedException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +func (s *NotAuthorizedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *NotAuthorizedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *NotAuthorizedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// This data type helps to determine Performance Insights metric to render for +// the insight. +type PerformanceInsightsMetric struct { + _ struct{} `type:"structure"` + + // A dimension map that contains the dimensions for this partition. + Dimensions map[string]*string `type:"map"` + + // The Performance Insights metric name. + DisplayName *string `min:"1" type:"string"` + + // The Performance Insights metric. + Metric *string `min:"1" type:"string"` + + // The value of the metric. For example, 9 for db.load.avg. + Value *float64 `type:"double"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PerformanceInsightsMetric) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PerformanceInsightsMetric) GoString() string { + return s.String() +} + +// SetDimensions sets the Dimensions field's value. +func (s *PerformanceInsightsMetric) SetDimensions(v map[string]*string) *PerformanceInsightsMetric { + s.Dimensions = v + return s +} + +// SetDisplayName sets the DisplayName field's value. +func (s *PerformanceInsightsMetric) SetDisplayName(v string) *PerformanceInsightsMetric { + s.DisplayName = &v + return s +} + +// SetMetric sets the Metric field's value. +func (s *PerformanceInsightsMetric) SetMetric(v string) *PerformanceInsightsMetric { + s.Metric = &v + return s +} + +// SetValue sets the Value field's value. +func (s *PerformanceInsightsMetric) SetValue(v float64) *PerformanceInsightsMetric { + s.Value = &v + return s +} + +// The list of recommendations for the insight. +type Recommendation struct { + _ struct{} `type:"structure"` + + // The recommendation details to help resolve the performance issue. For example, + // Investigate the following SQLs that contributed to 100% of the total DBLoad + // during that time period: sql-id + // + // RecommendationDescription is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Recommendation's + // String and GoString methods. + RecommendationDescription *string `type:"string" sensitive:"true"` + + // The unique identifier for the recommendation. + RecommendationId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Recommendation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Recommendation) GoString() string { + return s.String() } -// Status code returns the HTTP status code for the request's response error. -func (s *NotAuthorizedException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetRecommendationDescription sets the RecommendationDescription field's value. +func (s *Recommendation) SetRecommendationDescription(v string) *Recommendation { + s.RecommendationDescription = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *NotAuthorizedException) RequestID() string { - return s.RespMetadata.RequestID +// SetRecommendationId sets the RecommendationId field's value. +func (s *Recommendation) SetRecommendationId(v string) *Recommendation { + s.RecommendationId = &v + return s } // If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions @@ -2956,6 +4699,340 @@ func (s *ResponseResourceMetricKey) SetMetric(v string) *ResponseResourceMetricK return s } +// Metadata assigned to an Amazon RDS resource consisting of a key-value pair. +type Tag struct { + _ struct{} `type:"structure"` + + // A key is the required name of the tag. The string value can be from 1 to + // 128 Unicode characters in length and can't be prefixed with aws: or rds:. + // The string can only contain only the set of Unicode letters, digits, white-space, + // '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"). + // + // Key is a required field + Key *string `min:"1" type:"string" required:"true"` + + // A value is the optional value of the tag. The string value can be from 1 + // to 256 Unicode characters in length and can't be prefixed with aws: or rds:. + // The string can only contain only the set of Unicode letters, digits, white-space, + // '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"). + // + // Value is a required field + Value *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Tag) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Tag) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Tag) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Tag"} + if s.Key == nil { + invalidParams.Add(request.NewErrParamRequired("Key")) + } + if s.Key != nil && len(*s.Key) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Key", 1)) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKey sets the Key field's value. +func (s *Tag) SetKey(v string) *Tag { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Tag) SetValue(v string) *Tag { + s.Value = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon RDS Performance Insights resource that the tags are added to. + // This value is an Amazon Resource Name (ARN). For information about creating + // an ARN, see Constructing an RDS Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing). + // + // ResourceARN is a required field + ResourceARN *string `min:"1" type:"string" required:"true"` + + // The Amazon Web Services service for which Performance Insights returns metrics. + // Valid value is RDS. + // + // ServiceType is a required field + ServiceType *string `type:"string" required:"true" enum:"ServiceType"` + + // The metadata assigned to an Amazon RDS resource consisting of a key-value + // pair. + // + // Tags is a required field + Tags []*Tag `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceARN == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceARN")) + } + if s.ResourceARN != nil && len(*s.ResourceARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceARN", 1)) + } + if s.ServiceType == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceType")) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceARN sets the ResourceARN field's value. +func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput { + s.ResourceARN = &v + return s +} + +// SetServiceType sets the ServiceType field's value. +func (s *TagResourceInput) SetServiceType(v string) *TagResourceInput { + s.ServiceType = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) GoString() string { + return s.String() +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon RDS Performance Insights resource that the tags are added to. + // This value is an Amazon Resource Name (ARN). For information about creating + // an ARN, see Constructing an RDS Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing). + // + // ResourceARN is a required field + ResourceARN *string `min:"1" type:"string" required:"true"` + + // List the tags for the Amazon Web Services service for which Performance Insights + // returns metrics. Valid value is RDS. + // + // ServiceType is a required field + ServiceType *string `type:"string" required:"true" enum:"ServiceType"` + + // The metadata assigned to an Amazon RDS Performance Insights resource consisting + // of a key-value pair. + // + // TagKeys is a required field + TagKeys []*string `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceARN == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceARN")) + } + if s.ResourceARN != nil && len(*s.ResourceARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceARN", 1)) + } + if s.ServiceType == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceType")) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceARN sets the ResourceARN field's value. +func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput { + s.ResourceARN = &v + return s +} + +// SetServiceType sets the ServiceType field's value. +func (s *UntagResourceInput) SetServiceType(v string) *UntagResourceInput { + s.ServiceType = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +const ( + // AcceptLanguageEnUs is a AcceptLanguage enum value + AcceptLanguageEnUs = "EN_US" +) + +// AcceptLanguage_Values returns all elements of the AcceptLanguage enum +func AcceptLanguage_Values() []string { + return []string{ + AcceptLanguageEnUs, + } +} + +const ( + // AnalysisStatusRunning is a AnalysisStatus enum value + AnalysisStatusRunning = "RUNNING" + + // AnalysisStatusSucceeded is a AnalysisStatus enum value + AnalysisStatusSucceeded = "SUCCEEDED" + + // AnalysisStatusFailed is a AnalysisStatus enum value + AnalysisStatusFailed = "FAILED" +) + +// AnalysisStatus_Values returns all elements of the AnalysisStatus enum +func AnalysisStatus_Values() []string { + return []string{ + AnalysisStatusRunning, + AnalysisStatusSucceeded, + AnalysisStatusFailed, + } +} + +const ( + // ContextTypeCausal is a ContextType enum value + ContextTypeCausal = "CAUSAL" + + // ContextTypeContextual is a ContextType enum value + ContextTypeContextual = "CONTEXTUAL" +) + +// ContextType_Values returns all elements of the ContextType enum +func ContextType_Values() []string { + return []string{ + ContextTypeCausal, + ContextTypeContextual, + } +} + const ( // DetailStatusAvailable is a DetailStatus enum value DetailStatusAvailable = "AVAILABLE" @@ -3039,3 +5116,39 @@ func ServiceType_Values() []string { ServiceTypeDocdb, } } + +const ( + // SeverityLow is a Severity enum value + SeverityLow = "LOW" + + // SeverityMedium is a Severity enum value + SeverityMedium = "MEDIUM" + + // SeverityHigh is a Severity enum value + SeverityHigh = "HIGH" +) + +// Severity_Values returns all elements of the Severity enum +func Severity_Values() []string { + return []string{ + SeverityLow, + SeverityMedium, + SeverityHigh, + } +} + +const ( + // TextFormatPlainText is a TextFormat enum value + TextFormatPlainText = "PLAIN_TEXT" + + // TextFormatMarkdown is a TextFormat enum value + TextFormatMarkdown = "MARKDOWN" +) + +// TextFormat_Values returns all elements of the TextFormat enum +func TextFormat_Values() []string { + return []string{ + TextFormatPlainText, + TextFormatMarkdown, + } +} diff --git a/service/pi/piiface/interface.go b/service/pi/piiface/interface.go index c02ad978617..c422ae5ecbc 100644 --- a/service/pi/piiface/interface.go +++ b/service/pi/piiface/interface.go @@ -26,7 +26,7 @@ import ( // // myFunc uses an SDK service client to make a request to // // AWS Performance Insights. // func myFunc(svc piiface.PIAPI) bool { -// // Make svc.DescribeDimensionKeys request +// // Make svc.CreatePerformanceAnalysisReport request // } // // func main() { @@ -42,7 +42,7 @@ import ( // type mockPIClient struct { // piiface.PIAPI // } -// func (m *mockPIClient) DescribeDimensionKeys(input *pi.DescribeDimensionKeysInput) (*pi.DescribeDimensionKeysOutput, error) { +// func (m *mockPIClient) CreatePerformanceAnalysisReport(input *pi.CreatePerformanceAnalysisReportInput) (*pi.CreatePerformanceAnalysisReportOutput, error) { // // mock response/functionality // } // @@ -60,6 +60,14 @@ import ( // and waiters. Its suggested to use the pattern above for testing, or using // tooling to generate mocks to satisfy the interfaces. type PIAPI interface { + CreatePerformanceAnalysisReport(*pi.CreatePerformanceAnalysisReportInput) (*pi.CreatePerformanceAnalysisReportOutput, error) + CreatePerformanceAnalysisReportWithContext(aws.Context, *pi.CreatePerformanceAnalysisReportInput, ...request.Option) (*pi.CreatePerformanceAnalysisReportOutput, error) + CreatePerformanceAnalysisReportRequest(*pi.CreatePerformanceAnalysisReportInput) (*request.Request, *pi.CreatePerformanceAnalysisReportOutput) + + DeletePerformanceAnalysisReport(*pi.DeletePerformanceAnalysisReportInput) (*pi.DeletePerformanceAnalysisReportOutput, error) + DeletePerformanceAnalysisReportWithContext(aws.Context, *pi.DeletePerformanceAnalysisReportInput, ...request.Option) (*pi.DeletePerformanceAnalysisReportOutput, error) + DeletePerformanceAnalysisReportRequest(*pi.DeletePerformanceAnalysisReportInput) (*request.Request, *pi.DeletePerformanceAnalysisReportOutput) + DescribeDimensionKeys(*pi.DescribeDimensionKeysInput) (*pi.DescribeDimensionKeysOutput, error) DescribeDimensionKeysWithContext(aws.Context, *pi.DescribeDimensionKeysInput, ...request.Option) (*pi.DescribeDimensionKeysOutput, error) DescribeDimensionKeysRequest(*pi.DescribeDimensionKeysInput) (*request.Request, *pi.DescribeDimensionKeysOutput) @@ -71,6 +79,10 @@ type PIAPI interface { GetDimensionKeyDetailsWithContext(aws.Context, *pi.GetDimensionKeyDetailsInput, ...request.Option) (*pi.GetDimensionKeyDetailsOutput, error) GetDimensionKeyDetailsRequest(*pi.GetDimensionKeyDetailsInput) (*request.Request, *pi.GetDimensionKeyDetailsOutput) + GetPerformanceAnalysisReport(*pi.GetPerformanceAnalysisReportInput) (*pi.GetPerformanceAnalysisReportOutput, error) + GetPerformanceAnalysisReportWithContext(aws.Context, *pi.GetPerformanceAnalysisReportInput, ...request.Option) (*pi.GetPerformanceAnalysisReportOutput, error) + GetPerformanceAnalysisReportRequest(*pi.GetPerformanceAnalysisReportInput) (*request.Request, *pi.GetPerformanceAnalysisReportOutput) + GetResourceMetadata(*pi.GetResourceMetadataInput) (*pi.GetResourceMetadataOutput, error) GetResourceMetadataWithContext(aws.Context, *pi.GetResourceMetadataInput, ...request.Option) (*pi.GetResourceMetadataOutput, error) GetResourceMetadataRequest(*pi.GetResourceMetadataInput) (*request.Request, *pi.GetResourceMetadataOutput) @@ -95,6 +107,25 @@ type PIAPI interface { ListAvailableResourceMetricsPages(*pi.ListAvailableResourceMetricsInput, func(*pi.ListAvailableResourceMetricsOutput, bool) bool) error ListAvailableResourceMetricsPagesWithContext(aws.Context, *pi.ListAvailableResourceMetricsInput, func(*pi.ListAvailableResourceMetricsOutput, bool) bool, ...request.Option) error + + ListPerformanceAnalysisReports(*pi.ListPerformanceAnalysisReportsInput) (*pi.ListPerformanceAnalysisReportsOutput, error) + ListPerformanceAnalysisReportsWithContext(aws.Context, *pi.ListPerformanceAnalysisReportsInput, ...request.Option) (*pi.ListPerformanceAnalysisReportsOutput, error) + ListPerformanceAnalysisReportsRequest(*pi.ListPerformanceAnalysisReportsInput) (*request.Request, *pi.ListPerformanceAnalysisReportsOutput) + + ListPerformanceAnalysisReportsPages(*pi.ListPerformanceAnalysisReportsInput, func(*pi.ListPerformanceAnalysisReportsOutput, bool) bool) error + ListPerformanceAnalysisReportsPagesWithContext(aws.Context, *pi.ListPerformanceAnalysisReportsInput, func(*pi.ListPerformanceAnalysisReportsOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*pi.ListTagsForResourceInput) (*pi.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *pi.ListTagsForResourceInput, ...request.Option) (*pi.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*pi.ListTagsForResourceInput) (*request.Request, *pi.ListTagsForResourceOutput) + + TagResource(*pi.TagResourceInput) (*pi.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *pi.TagResourceInput, ...request.Option) (*pi.TagResourceOutput, error) + TagResourceRequest(*pi.TagResourceInput) (*request.Request, *pi.TagResourceOutput) + + UntagResource(*pi.UntagResourceInput) (*pi.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *pi.UntagResourceInput, ...request.Option) (*pi.UntagResourceOutput, error) + UntagResourceRequest(*pi.UntagResourceInput) (*request.Request, *pi.UntagResourceOutput) } var _ PIAPI = (*pi.PI)(nil) diff --git a/service/quicksight/api.go b/service/quicksight/api.go index fbb4dc346bb..d13ef162cfb 100644 --- a/service/quicksight/api.go +++ b/service/quicksight/api.go @@ -15005,7 +15005,11 @@ func (c *QuickSight) StartDashboardSnapshotJobRequest(input *StartDashboardSnaps // StartDashboardSnapshotJob API operation for Amazon QuickSight. // // Starts an asynchronous job that generates a dashboard snapshot. You can request -// up to one paginated PDF and up to five CSVs per API call. +// one of the following format configurations per API call. +// +// - 1 paginated PDF +// +// - 5 CSVs // // Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once // the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain @@ -18436,6 +18440,9 @@ type AccountInfo struct { // The edition of your Amazon QuickSight account. Edition *string `type:"string" enum:"Edition"` + // The Amazon Resource Name (ARN) for the IAM Identity Center instance. + IAMIdentityCenterInstanceArn *string `type:"string"` + // The email address that will be used for Amazon QuickSight to send notifications // regarding your Amazon Web Services account or Amazon QuickSight subscription. NotificationEmail *string `type:"string"` @@ -18483,6 +18490,12 @@ func (s *AccountInfo) SetEdition(v string) *AccountInfo { return s } +// SetIAMIdentityCenterInstanceArn sets the IAMIdentityCenterInstanceArn field's value. +func (s *AccountInfo) SetIAMIdentityCenterInstanceArn(v string) *AccountInfo { + s.IAMIdentityCenterInstanceArn = &v + return s +} + // SetNotificationEmail sets the NotificationEmail field's value. func (s *AccountInfo) SetNotificationEmail(v string) *AccountInfo { s.NotificationEmail = &v @@ -28334,7 +28347,7 @@ type CreateAccountSubscriptionInput struct { // change AccountName value after the Amazon QuickSight account is created. // // AccountName is a required field - AccountName *string `type:"string" required:"true"` + AccountName *string `min:"1" type:"string" required:"true"` // The name of your Active Directory. This field is required if ACTIVE_DIRECTORY // is the selected authentication method of the new Amazon QuickSight account. @@ -28452,6 +28465,9 @@ func (s *CreateAccountSubscriptionInput) Validate() error { if s.AccountName == nil { invalidParams.Add(request.NewErrParamRequired("AccountName")) } + if s.AccountName != nil && len(*s.AccountName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AccountName", 1)) + } if s.AuthenticationMethod == nil { invalidParams.Add(request.NewErrParamRequired("AuthenticationMethod")) } @@ -71975,6 +71991,9 @@ type PivotTableOptions struct { // The visibility of the column names. ColumnNamesVisibility *string `type:"string" enum:"Visibility"` + // The default cell width of the pivot table. + DefaultCellWidth *string `type:"string"` + // The metric placement (row, column) options. MetricPlacement *string `type:"string" enum:"PivotTableMetricPlacement"` @@ -71987,6 +72006,19 @@ type PivotTableOptions struct { // The table cell style of the row headers. RowHeaderStyle *TableCellStyle `type:"structure"` + // The options for the label that is located above the row headers. This option + // is only applicable when RowsLayout is set to HIERARCHY. + RowsLabelOptions *PivotTableRowsLabelOptions `type:"structure"` + + // The layout for the row dimension headers of a pivot table. Choose one of + // the following options. + // + // * TABULAR: (Default) Each row field is displayed in a separate column. + // + // * HIERARCHY: All row fields are displayed in a single column. Indentation + // is used to differentiate row headers of different fields. + RowsLayout *string `type:"string" enum:"PivotTableRowsLayout"` + // The visibility of the single metric options. SingleMetricVisibility *string `type:"string" enum:"Visibility"` @@ -72035,6 +72067,11 @@ func (s *PivotTableOptions) Validate() error { invalidParams.AddNested("RowHeaderStyle", err.(request.ErrInvalidParams)) } } + if s.RowsLabelOptions != nil { + if err := s.RowsLabelOptions.Validate(); err != nil { + invalidParams.AddNested("RowsLabelOptions", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -72066,6 +72103,12 @@ func (s *PivotTableOptions) SetColumnNamesVisibility(v string) *PivotTableOption return s } +// SetDefaultCellWidth sets the DefaultCellWidth field's value. +func (s *PivotTableOptions) SetDefaultCellWidth(v string) *PivotTableOptions { + s.DefaultCellWidth = &v + return s +} + // SetMetricPlacement sets the MetricPlacement field's value. func (s *PivotTableOptions) SetMetricPlacement(v string) *PivotTableOptions { s.MetricPlacement = &v @@ -72090,6 +72133,18 @@ func (s *PivotTableOptions) SetRowHeaderStyle(v *TableCellStyle) *PivotTableOpti return s } +// SetRowsLabelOptions sets the RowsLabelOptions field's value. +func (s *PivotTableOptions) SetRowsLabelOptions(v *PivotTableRowsLabelOptions) *PivotTableOptions { + s.RowsLabelOptions = v + return s +} + +// SetRowsLayout sets the RowsLayout field's value. +func (s *PivotTableOptions) SetRowsLayout(v string) *PivotTableOptions { + s.RowsLayout = &v + return s +} + // SetSingleMetricVisibility sets the SingleMetricVisibility field's value. func (s *PivotTableOptions) SetSingleMetricVisibility(v string) *PivotTableOptions { s.SingleMetricVisibility = &v @@ -72143,6 +72198,61 @@ func (s *PivotTablePaginatedReportOptions) SetVerticalOverflowVisibility(v strin return s } +// The options for the label thta is located above the row headers. This option +// is only applicable when RowsLayout is set to HIERARCHY. +type PivotTableRowsLabelOptions struct { + _ struct{} `type:"structure"` + + // The custom label string for the rows label. + CustomLabel *string `min:"1" type:"string"` + + // The visibility of the rows label. + Visibility *string `type:"string" enum:"Visibility"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PivotTableRowsLabelOptions) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PivotTableRowsLabelOptions) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PivotTableRowsLabelOptions) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PivotTableRowsLabelOptions"} + if s.CustomLabel != nil && len(*s.CustomLabel) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CustomLabel", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCustomLabel sets the CustomLabel field's value. +func (s *PivotTableRowsLabelOptions) SetCustomLabel(v string) *PivotTableRowsLabelOptions { + s.CustomLabel = &v + return s +} + +// SetVisibility sets the Visibility field's value. +func (s *PivotTableRowsLabelOptions) SetVisibility(v string) *PivotTableRowsLabelOptions { + s.Visibility = &v + return s +} + // The sort by field for the field sort options. type PivotTableSortBy struct { _ struct{} `type:"structure"` @@ -76553,6 +76663,9 @@ type RowAlternateColorOptions struct { // Determines the widget status. Status *string `type:"string" enum:"WidgetStatus"` + + // The primary background color options for alternate rows. + UsePrimaryBackgroundColor *string `type:"string" enum:"WidgetStatus"` } // String returns the string representation. @@ -76585,6 +76698,12 @@ func (s *RowAlternateColorOptions) SetStatus(v string) *RowAlternateColorOptions return s } +// SetUsePrimaryBackgroundColor sets the UsePrimaryBackgroundColor field's value. +func (s *RowAlternateColorOptions) SetUsePrimaryBackgroundColor(v string) *RowAlternateColorOptions { + s.UsePrimaryBackgroundColor = &v + return s +} + // Information about rows for a data set SPICE ingestion. type RowInfo struct { _ struct{} `type:"structure"` @@ -81625,7 +81744,7 @@ type SnapshotFile struct { _ struct{} `type:"structure"` // The format of the snapshot file to be generated. You can choose between CSV - // and PDF. + // or PDF. // // FormatType is a required field FormatType *string `type:"string" required:"true" enum:"SnapshotFileFormatType"` @@ -81773,14 +81892,14 @@ type SnapshotFileSheetSelection struct { SelectionScope *string `type:"string" required:"true" enum:"SnapshotFileSheetSelectionScope"` // The sheet ID of the dashboard to generate the snapshot artifact from. This - // value is required for CSV or PDF format types. + // value is required for CSV and PDF format types. // // SheetId is a required field SheetId *string `min:"1" type:"string" required:"true"` - // A structure that lists the IDs of the visuals in the selected sheet. Supported - // visual types are table, pivot table visuals. This value is required if you - // are generating a CSV. This value supports a maximum of 1 visual ID. + // A list of visual IDs that are located in the selected sheet. This structure + // supports tables and pivot tables. This structure is required if you are generating + // a CSV. You can add a maximum of 1 visual ID to this structure. VisualIds []*string `min:"1" type:"list"` } @@ -83631,6 +83750,9 @@ type SubtotalOptions struct { // The cell styling options for the subtotals of header cells. MetricHeaderCellStyle *TableCellStyle `type:"structure"` + // The style targets options for subtotals. + StyleTargets []*TableStyleTarget `type:"list"` + // The cell styling options for the subtotal cells. TotalCellStyle *TableCellStyle `type:"structure"` @@ -83677,6 +83799,16 @@ func (s *SubtotalOptions) Validate() error { invalidParams.AddNested("MetricHeaderCellStyle", err.(request.ErrInvalidParams)) } } + if s.StyleTargets != nil { + for i, v := range s.StyleTargets { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "StyleTargets", i), err.(request.ErrInvalidParams)) + } + } + } if s.TotalCellStyle != nil { if err := s.TotalCellStyle.Validate(); err != nil { invalidParams.AddNested("TotalCellStyle", err.(request.ErrInvalidParams)) @@ -83718,6 +83850,12 @@ func (s *SubtotalOptions) SetMetricHeaderCellStyle(v *TableCellStyle) *SubtotalO return s } +// SetStyleTargets sets the StyleTargets field's value. +func (s *SubtotalOptions) SetStyleTargets(v []*TableStyleTarget) *SubtotalOptions { + s.StyleTargets = v + return s +} + // SetTotalCellStyle sets the TotalCellStyle field's value. func (s *SubtotalOptions) SetTotalCellStyle(v *TableCellStyle) *SubtotalOptions { s.TotalCellStyle = v @@ -85260,6 +85398,53 @@ func (s *TableSortConfiguration) SetRowSort(v []*FieldSortOptions) *TableSortCon return s } +// The table style target. +type TableStyleTarget struct { + _ struct{} `type:"structure"` + + // The cell type of the table style target. + // + // CellType is a required field + CellType *string `type:"string" required:"true" enum:"StyledCellType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TableStyleTarget) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TableStyleTarget) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TableStyleTarget) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TableStyleTarget"} + if s.CellType == nil { + invalidParams.Add(request.NewErrParamRequired("CellType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCellType sets the CellType field's value. +func (s *TableStyleTarget) SetCellType(v string) *TableStyleTarget { + s.CellType = &v + return s +} + // The unaggregated field well for the table. type TableUnaggregatedFieldWells struct { _ struct{} `type:"structure"` @@ -88603,6 +88788,9 @@ type TopicCalculatedField struct { // in filters. NeverAggregateInFilter *bool `type:"boolean"` + // The non additive for the table style target. + NonAdditive *bool `type:"boolean"` + // The list of aggregation types that are not allowed for the calculated field. // Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, // SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE. @@ -88730,6 +88918,12 @@ func (s *TopicCalculatedField) SetNeverAggregateInFilter(v bool) *TopicCalculate return s } +// SetNonAdditive sets the NonAdditive field's value. +func (s *TopicCalculatedField) SetNonAdditive(v bool) *TopicCalculatedField { + s.NonAdditive = &v + return s +} + // SetNotAllowedAggregations sets the NotAllowedAggregations field's value. func (s *TopicCalculatedField) SetNotAllowedAggregations(v []*string) *TopicCalculatedField { s.NotAllowedAggregations = v @@ -88871,8 +89065,6 @@ type TopicColumn struct { _ struct{} `type:"structure"` // The type of aggregation that is performed on the column data when it's queried. - // Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, - // and AVERAGE. Aggregation *string `type:"string" enum:"DefaultAggregation"` // The list of aggregation types that are allowed for the column. Valid values @@ -88919,6 +89111,9 @@ type TopicColumn struct { // it's used in a filter context. NeverAggregateInFilter *bool `type:"boolean"` + // The non additive value for the column. + NonAdditive *bool `type:"boolean"` + // The list of aggregation types that are not allowed for the column. Valid // values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, // AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE. @@ -89040,6 +89235,12 @@ func (s *TopicColumn) SetNeverAggregateInFilter(v bool) *TopicColumn { return s } +// SetNonAdditive sets the NonAdditive field's value. +func (s *TopicColumn) SetNonAdditive(v bool) *TopicColumn { + s.NonAdditive = &v + return s +} + // SetNotAllowedAggregations sets the NotAllowedAggregations field's value. func (s *TopicColumn) SetNotAllowedAggregations(v []*string) *TopicColumn { s.NotAllowedAggregations = v @@ -99879,6 +100080,9 @@ const ( // AuthenticationMethodOptionActiveDirectory is a AuthenticationMethodOption enum value AuthenticationMethodOptionActiveDirectory = "ACTIVE_DIRECTORY" + + // AuthenticationMethodOptionIamIdentityCenter is a AuthenticationMethodOption enum value + AuthenticationMethodOptionIamIdentityCenter = "IAM_IDENTITY_CENTER" ) // AuthenticationMethodOption_Values returns all elements of the AuthenticationMethodOption enum @@ -99887,6 +100091,7 @@ func AuthenticationMethodOption_Values() []string { AuthenticationMethodOptionIamAndQuicksight, AuthenticationMethodOptionIamOnly, AuthenticationMethodOptionActiveDirectory, + AuthenticationMethodOptionIamIdentityCenter, } } @@ -100904,6 +101109,21 @@ const ( // DefaultAggregationAverage is a DefaultAggregation enum value DefaultAggregationAverage = "AVERAGE" + + // DefaultAggregationMedian is a DefaultAggregation enum value + DefaultAggregationMedian = "MEDIAN" + + // DefaultAggregationStdev is a DefaultAggregation enum value + DefaultAggregationStdev = "STDEV" + + // DefaultAggregationStdevp is a DefaultAggregation enum value + DefaultAggregationStdevp = "STDEVP" + + // DefaultAggregationVar is a DefaultAggregation enum value + DefaultAggregationVar = "VAR" + + // DefaultAggregationVarp is a DefaultAggregation enum value + DefaultAggregationVarp = "VARP" ) // DefaultAggregation_Values returns all elements of the DefaultAggregation enum @@ -100915,6 +101135,11 @@ func DefaultAggregation_Values() []string { DefaultAggregationCount, DefaultAggregationDistinctCount, DefaultAggregationAverage, + DefaultAggregationMedian, + DefaultAggregationStdev, + DefaultAggregationStdevp, + DefaultAggregationVar, + DefaultAggregationVarp, } } @@ -101540,6 +101765,9 @@ const ( // IdentityTypeQuicksight is a IdentityType enum value IdentityTypeQuicksight = "QUICKSIGHT" + + // IdentityTypeIamIdentityCenter is a IdentityType enum value + IdentityTypeIamIdentityCenter = "IAM_IDENTITY_CENTER" ) // IdentityType_Values returns all elements of the IdentityType enum @@ -101547,6 +101775,7 @@ func IdentityType_Values() []string { return []string{ IdentityTypeIam, IdentityTypeQuicksight, + IdentityTypeIamIdentityCenter, } } @@ -102622,6 +102851,22 @@ func PivotTableMetricPlacement_Values() []string { } } +const ( + // PivotTableRowsLayoutTabular is a PivotTableRowsLayout enum value + PivotTableRowsLayoutTabular = "TABULAR" + + // PivotTableRowsLayoutHierarchy is a PivotTableRowsLayout enum value + PivotTableRowsLayoutHierarchy = "HIERARCHY" +) + +// PivotTableRowsLayout_Values returns all elements of the PivotTableRowsLayout enum +func PivotTableRowsLayout_Values() []string { + return []string{ + PivotTableRowsLayoutTabular, + PivotTableRowsLayoutHierarchy, + } +} + const ( // PivotTableSubtotalLevelAll is a PivotTableSubtotalLevel enum value PivotTableSubtotalLevelAll = "ALL" @@ -103302,6 +103547,26 @@ func Status_Values() []string { } } +const ( + // StyledCellTypeTotal is a StyledCellType enum value + StyledCellTypeTotal = "TOTAL" + + // StyledCellTypeMetricHeader is a StyledCellType enum value + StyledCellTypeMetricHeader = "METRIC_HEADER" + + // StyledCellTypeValue is a StyledCellType enum value + StyledCellTypeValue = "VALUE" +) + +// StyledCellType_Values returns all elements of the StyledCellType enum +func StyledCellType_Values() []string { + return []string{ + StyledCellTypeTotal, + StyledCellTypeMetricHeader, + StyledCellTypeValue, + } +} + const ( // TableBorderStyleNone is a TableBorderStyle enum value TableBorderStyleNone = "NONE" @@ -103879,6 +104144,9 @@ const ( // VerticalTextAlignmentBottom is a VerticalTextAlignment enum value VerticalTextAlignmentBottom = "BOTTOM" + + // VerticalTextAlignmentAuto is a VerticalTextAlignment enum value + VerticalTextAlignmentAuto = "AUTO" ) // VerticalTextAlignment_Values returns all elements of the VerticalTextAlignment enum @@ -103887,6 +104155,7 @@ func VerticalTextAlignment_Values() []string { VerticalTextAlignmentTop, VerticalTextAlignmentMiddle, VerticalTextAlignmentBottom, + VerticalTextAlignmentAuto, } } diff --git a/service/route53domains/api.go b/service/route53domains/api.go index c47959bce08..d9a6af573d2 100644 --- a/service/route53domains/api.go +++ b/service/route53domains/api.go @@ -3543,8 +3543,12 @@ type AcceptDomainTransferFromAnotherAwsAccountInput struct { // The password that was returned by the TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) // request. // + // Password is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by AcceptDomainTransferFromAnotherAwsAccountInput's + // String and GoString methods. + // // Password is a required field - Password *string `type:"string" required:"true"` + Password *string `type:"string" required:"true" sensitive:"true"` } // String returns the string representation. @@ -4113,6 +4117,9 @@ func (s *CheckDomainTransferabilityInput) SetDomainName(v string) *CheckDomainTr type CheckDomainTransferabilityOutput struct { _ struct{} `type:"structure"` + // Provides an explanation for when a domain can't be transferred. + Message *string `type:"string"` + // A complex type that contains information about whether the specified domain // can be transferred to Route 53. Transferability *DomainTransferability `type:"structure"` @@ -4136,6 +4143,12 @@ func (s CheckDomainTransferabilityOutput) GoString() string { return s.String() } +// SetMessage sets the Message field's value. +func (s *CheckDomainTransferabilityOutput) SetMessage(v string) *CheckDomainTransferabilityOutput { + s.Message = &v + return s +} + // SetTransferability sets the Transferability field's value. func (s *CheckDomainTransferabilityOutput) SetTransferability(v *DomainTransferability) *CheckDomainTransferabilityOutput { s.Transferability = v @@ -4211,13 +4224,25 @@ type ContactDetail struct { _ struct{} `type:"structure" sensitive:"true"` // First line of the contact's address. - AddressLine1 *string `type:"string"` + // + // AddressLine1 is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + AddressLine1 *string `type:"string" sensitive:"true"` // Second line of contact's address, if any. - AddressLine2 *string `type:"string"` + // + // AddressLine2 is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + AddressLine2 *string `type:"string" sensitive:"true"` // The city of the contact's address. - City *string `type:"string"` + // + // City is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + City *string `type:"string" sensitive:"true"` // Indicates whether the contact is a person, company, association, or public // organization. Note the following: @@ -4235,10 +4260,18 @@ type ContactDetail struct { ContactType *string `type:"string" enum:"ContactType"` // Code for the country of the contact's address. - CountryCode *string `type:"string" enum:"CountryCode"` + // + // CountryCode is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + CountryCode *string `type:"string" enum:"CountryCode" sensitive:"true"` // Email address of the contact. - Email *string `type:"string"` + // + // Email is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + Email *string `type:"string" sensitive:"true"` // A list of name-value pairs for parameters required by certain top-level domains. ExtraParams []*ExtraParam `type:"list"` @@ -4248,29 +4281,57 @@ type ContactDetail struct { // Constraints: Phone number must be specified in the format "+[country dialing // code].[number including any area code]". For example, a US phone number might // appear as "+1.1234567890". - Fax *string `type:"string"` + // + // Fax is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + Fax *string `type:"string" sensitive:"true"` // First name of contact. - FirstName *string `type:"string"` + // + // FirstName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + FirstName *string `type:"string" sensitive:"true"` // Last name of contact. - LastName *string `type:"string"` + // + // LastName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + LastName *string `type:"string" sensitive:"true"` // Name of the organization for contact types other than PERSON. - OrganizationName *string `type:"string"` + // + // OrganizationName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + OrganizationName *string `type:"string" sensitive:"true"` // The phone number of the contact. // // Constraints: Phone number must be specified in the format "+[country dialing // code].[number including any area code>]". For example, a US phone number // might appear as "+1.1234567890". - PhoneNumber *string `type:"string"` + // + // PhoneNumber is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + PhoneNumber *string `type:"string" sensitive:"true"` // The state or province of the contact's city. - State *string `type:"string"` + // + // State is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + State *string `type:"string" sensitive:"true"` // The zip or postal code of the contact's address. - ZipCode *string `type:"string"` + // + // ZipCode is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ContactDetail's + // String and GoString methods. + ZipCode *string `type:"string" sensitive:"true"` } // String returns the string representation. @@ -5350,7 +5411,7 @@ type DomainTransferability struct { // // DOMAIN_IN_ANOTHER_ACCOUNT // - // the domain exists in another Amazon Web Services account. + // The domain exists in another Amazon Web Services account. // // PREMIUM_DOMAIN // @@ -5389,6 +5450,9 @@ type DuplicateRequest struct { // The request is already in progress for the domain. Message_ *string `locationName:"message" type:"string"` + + // ID of the request operation. + RequestId *string `locationName:"requestId" type:"string"` } // String returns the string representation. @@ -5434,7 +5498,7 @@ func (s *DuplicateRequest) OrigErr() error { } func (s *DuplicateRequest) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) } // Status code returns the HTTP status code for the request's response error. @@ -6013,10 +6077,18 @@ type GetDomainDetailOutput struct { // Email address to contact to report incorrect contact information for a domain, // to report that the domain is being used to send spam, to report that someone // is cybersquatting on a domain name, or report some other type of abuse. - AbuseContactEmail *string `type:"string"` + // + // AbuseContactEmail is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GetDomainDetailOutput's + // String and GoString methods. + AbuseContactEmail *string `type:"string" sensitive:"true"` // Phone number for reporting abuse. - AbuseContactPhone *string `type:"string"` + // + // AbuseContactPhone is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GetDomainDetailOutput's + // String and GoString methods. + AbuseContactPhone *string `type:"string" sensitive:"true"` // Provides details about the domain administrative contact. // @@ -7992,7 +8064,11 @@ type ResendContactReachabilityEmailOutput struct { // The email address for the registrant contact at the time that we sent the // verification email. - EmailAddress *string `locationName:"emailAddress" type:"string"` + // + // EmailAddress is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ResendContactReachabilityEmailOutput's + // String and GoString methods. + EmailAddress *string `locationName:"emailAddress" type:"string" sensitive:"true"` // True if the email address for the registrant contact has already been verified, // and false otherwise. If the email address has already been verified, we don't @@ -8753,7 +8829,11 @@ type TransferDomainToAnotherAwsAccountOutput struct { // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html) // request. The request must include the value of the Password element that // was returned in the TransferDomainToAnotherAwsAccount response. - Password *string `type:"string"` + // + // Password is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by TransferDomainToAnotherAwsAccountOutput's + // String and GoString methods. + Password *string `type:"string" sensitive:"true"` } // String returns the string representation. @@ -10916,7 +10996,7 @@ func StatusFlag_Values() []string { // // DOMAIN_IN_ANOTHER_ACCOUNT // -// the domain exists in another Amazon Web Services account. +// The domain exists in another Amazon Web Services account. // // PREMIUM_DOMAIN // diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index 5974a1a0d3b..053227b988c 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -1821,9 +1821,6 @@ func (c *SageMaker) CreateEndpointRequest(input *CreateEndpointInput) (req *requ // // Use this API to deploy models using SageMaker hosting services. // -// For an example that calls this method when deploying a model to SageMaker -// hosting services, see the Create Endpoint example notebook. (https://github.com/aws/amazon-sagemaker-examples/blob/master/sagemaker-fundamentals/create-endpoint/create_endpoint.ipynb) -// // You must not delete an EndpointConfig that is in use by an endpoint that // is live or while the UpdateEndpoint or CreateEndpoint operations are being // performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. @@ -43609,6 +43606,10 @@ type CreateModelPackageInput struct { // A list of key value pairs associated with the model. For more information, // see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) // in the Amazon Web Services General Reference Guide. + // + // If you supply ModelPackageGroupName, your model package belongs to the model + // group you specify and uses the tags associated with the model group. In this + // case, you cannot supply a tag argument. Tags []*Tag `type:"list"` // The machine learning task your model package accomplishes. Common machine @@ -100966,6 +100967,9 @@ type RecommendationJobContainerConfig struct { // A list of the instance types that are used to generate inferences in real-time. SupportedInstanceTypes []*string `type:"list"` + // The supported MIME types for the output data. + SupportedResponseMIMETypes []*string `type:"list"` + // The machine learning task that the model accomplishes. // // Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | @@ -101052,6 +101056,12 @@ func (s *RecommendationJobContainerConfig) SetSupportedInstanceTypes(v []*string return s } +// SetSupportedResponseMIMETypes sets the SupportedResponseMIMETypes field's value. +func (s *RecommendationJobContainerConfig) SetSupportedResponseMIMETypes(v []*string) *RecommendationJobContainerConfig { + s.SupportedResponseMIMETypes = v + return s +} + // SetTask sets the Task field's value. func (s *RecommendationJobContainerConfig) SetTask(v string) *RecommendationJobContainerConfig { s.Task = &v diff --git a/service/ses/api.go b/service/ses/api.go index 08827d2a358..efca3b0d66c 100644 --- a/service/ses/api.go +++ b/service/ses/api.go @@ -62,7 +62,7 @@ func (c *SES) CloneReceiptRuleSetRequest(input *CloneReceiptRuleSetInput) (req * // independent of the source rule set. // // For information about setting up rule sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules). // // You can execute this operation no more than once per second. // @@ -154,7 +154,7 @@ func (c *SES) CreateConfigurationSetRequest(input *CreateConfigurationSetInput) // Creates a configuration set. // // Configuration sets enable you to publish email sending events. For information -// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). // // You can execute this operation no more than once per second. // @@ -251,9 +251,10 @@ func (c *SES) CreateConfigurationSetEventDestinationRequest(input *CreateConfigu // only one, destination. The destination can be CloudWatch, Amazon Kinesis // Firehose, or Amazon Simple Notification Service (Amazon SNS). // -// An event destination is the AWS service to which Amazon SES publishes the -// email sending events associated with a configuration set. For information -// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// An event destination is the Amazon Web Services service to which Amazon SES +// publishes the email sending events associated with a configuration set. For +// information about using configuration sets, see the Amazon SES Developer +// Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). // // You can execute this operation no more than once per second. // @@ -361,7 +362,7 @@ func (c *SES) CreateConfigurationSetTrackingOptionsRequest(input *CreateConfigur // By default, images and links used for tracking open and click events are // hosted on domains operated by Amazon SES. You can configure a subdomain of // your own to handle these events. For information about using custom domains, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -456,7 +457,7 @@ func (c *SES) CreateCustomVerificationEmailTemplateRequest(input *CreateCustomVe // Creates a new custom verification email template. // // For more information about custom verification email templates, see Using -// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. // // You can execute this operation no more than once per second. @@ -555,7 +556,7 @@ func (c *SES) CreateReceiptFilterRequest(input *CreateReceiptFilterInput) (req * // Creates a new IP address filter. // // For information about setting up IP address filters, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -644,7 +645,7 @@ func (c *SES) CreateReceiptRuleRequest(input *CreateReceiptRuleInput) (req *requ // Creates a receipt rule. // // For information about setting up receipt rules, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -663,16 +664,16 @@ func (c *SES) CreateReceiptRuleRequest(input *CreateReceiptRuleInput) (req *requ // about giving permissions, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). // // - ErrCodeInvalidS3ConfigurationException "InvalidS3Configuration" -// Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is -// invalid, or that Amazon SES could not publish to the bucket, possibly due -// to permissions issues. For information about giving permissions, see the -// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). +// Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption +// key is invalid, or that Amazon SES could not publish to the bucket, possibly +// due to permissions issues. For information about giving permissions, see +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). // // - ErrCodeInvalidLambdaFunctionException "InvalidLambdaFunction" -// Indicates that the provided AWS Lambda function is invalid, or that Amazon -// SES could not execute the provided function, possibly due to permissions -// issues. For information about giving permissions, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). +// Indicates that the provided Amazon Web Services Lambda function is invalid, +// or that Amazon SES could not execute the provided function, possibly due +// to permissions issues. For information about giving permissions, see the +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). // // - ErrCodeAlreadyExistsException "AlreadyExists" // Indicates that a resource could not be created because of a naming conflict. @@ -756,7 +757,7 @@ func (c *SES) CreateReceiptRuleSetRequest(input *CreateReceiptRuleSetInput) (req // Creates an empty receipt rule set. // // For information about setting up receipt rule sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules). // // You can execute this operation no more than once per second. // @@ -843,8 +844,8 @@ func (c *SES) CreateTemplateRequest(input *CreateTemplateInput) (req *request.Re // CreateTemplate API operation for Amazon Simple Email Service. // // Creates an email template. Email templates enable you to send personalized -// email to one or more destinations in a single API operation. For more information, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// email to one or more destinations in a single operation. For more information, +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html). // // You can execute this operation no more than once per second. // @@ -936,7 +937,7 @@ func (c *SES) DeleteConfigurationSetRequest(input *DeleteConfigurationSetInput) // // Deletes a configuration set. Configuration sets enable you to publish email // sending events. For information about using configuration sets, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). // // You can execute this operation no more than once per second. // @@ -1020,7 +1021,7 @@ func (c *SES) DeleteConfigurationSetEventDestinationRequest(input *DeleteConfigu // Deletes a configuration set event destination. Configuration set event destinations // are associated with configuration sets, which enable you to publish email // sending events. For information about using configuration sets, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). // // You can execute this operation no more than once per second. // @@ -1111,9 +1112,9 @@ func (c *SES) DeleteConfigurationSetTrackingOptionsRequest(input *DeleteConfigur // By default, images and links used for tracking open and click events are // hosted on domains operated by Amazon SES. You can configure a subdomain of // your own to handle these events. For information about using custom domains, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html). // -// Deleting this kind of association will result in emails sent using the specified +// Deleting this kind of association results in emails sent using the specified // configuration set to capture open and click events using the standard, Amazon // SES-operated domains. // @@ -1201,7 +1202,7 @@ func (c *SES) DeleteCustomVerificationEmailTemplateRequest(input *DeleteCustomVe // Deletes an existing custom verification email template. // // For more information about custom verification email templates, see Using -// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. // // You can execute this operation no more than once per second. @@ -1356,15 +1357,15 @@ func (c *SES) DeleteIdentityPolicyRequest(input *DeleteIdentityPolicyInput) (req // DeleteIdentityPolicy API operation for Amazon Simple Email Service. // // Deletes the specified sending authorization policy for the given identity -// (an email address or a domain). This API returns successfully even if a policy -// with the specified name does not exist. +// (an email address or a domain). This operation returns successfully even +// if a policy with the specified name does not exist. // -// This API is for the identity owner only. If you have not verified the identity, -// this API will return an error. +// This operation is for the identity owner only. If you have not verified the +// identity, it returns an error. // // Sending authorization is a feature that enables an identity owner to authorize // other senders to use its identities. For information about using sending -// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). // // You can execute this operation no more than once per second. // @@ -1443,7 +1444,7 @@ func (c *SES) DeleteReceiptFilterRequest(input *DeleteReceiptFilterInput) (req * // Deletes the specified IP address filter. // // For information about managing IP address filters, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -1522,7 +1523,7 @@ func (c *SES) DeleteReceiptRuleRequest(input *DeleteReceiptRuleInput) (req *requ // Deletes the specified receipt rule. // // For information about managing receipt rules, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -1608,7 +1609,7 @@ func (c *SES) DeleteReceiptRuleSetRequest(input *DeleteReceiptRuleSetInput) (req // The currently active rule set cannot be deleted. // // For information about managing receipt rule sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -1843,7 +1844,7 @@ func (c *SES) DescribeActiveReceiptRuleSetRequest(input *DescribeActiveReceiptRu // active. // // For information about setting up receipt rule sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules). // // You can execute this operation no more than once per second. // @@ -1919,7 +1920,7 @@ func (c *SES) DescribeConfigurationSetRequest(input *DescribeConfigurationSetInp // DescribeConfigurationSet API operation for Amazon Simple Email Service. // // Returns the details of the specified configuration set. For information about -// using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). // // You can execute this operation no more than once per second. // @@ -2002,7 +2003,7 @@ func (c *SES) DescribeReceiptRuleRequest(input *DescribeReceiptRuleInput) (req * // Returns the details of the specified receipt rule. // // For information about setting up receipt rules, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -2089,7 +2090,7 @@ func (c *SES) DescribeReceiptRuleSetRequest(input *DescribeReceiptRuleSetInput) // Returns the details of the specified receipt rule set. // // For information about managing receipt rule sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -2170,7 +2171,7 @@ func (c *SES) GetAccountSendingEnabledRequest(input *GetAccountSendingEnabledInp // GetAccountSendingEnabled API operation for Amazon Simple Email Service. // // Returns the email sending status of the Amazon SES account for the current -// region. +// Region. // // You can execute this operation no more than once per second. // @@ -2249,7 +2250,7 @@ func (c *SES) GetCustomVerificationEmailTemplateRequest(input *GetCustomVerifica // specify. // // For more information about custom verification email templates, see Using -// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. // // You can execute this operation no more than once per second. @@ -2352,7 +2353,7 @@ func (c *SES) GetIdentityDkimAttributesRequest(input *GetIdentityDkimAttributesI // attributes for up to 100 identities at a time. // // For more information about creating DNS records using DKIM tokens, go to -// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy-managing.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2509,7 +2510,7 @@ func (c *SES) GetIdentityNotificationAttributesRequest(input *GetIdentityNotific // attributes for up to 100 identities at a time. // // For more information about using notifications with Amazon SES, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2587,12 +2588,12 @@ func (c *SES) GetIdentityPoliciesRequest(input *GetIdentityPoliciesInput) (req * // names to policy contents. You can retrieve a maximum of 20 policies at a // time. // -// This API is for the identity owner only. If you have not verified the identity, -// this API will return an error. +// This operation is for the identity owner only. If you have not verified the +// identity, it returns an error. // // Sending authorization is a feature that enables an identity owner to authorize // other senders to use its identities. For information about using sending -// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). // // You can execute this operation no more than once per second. // @@ -2676,16 +2677,15 @@ func (c *SES) GetIdentityVerificationAttributesRequest(input *GetIdentityVerific // sent to that address. If the email address owner clicks the link within 24 // hours, the verification status of the email address changes to "Success". // If the link is not clicked within 24 hours, the verification status changes -// to "Failed." In that case, if you still want to verify the email address, -// you must restart the verification process from the beginning. +// to "Failed." In that case, to verify the email address, you must restart +// the verification process from the beginning. // // For domain identities, the domain's verification status is "Pending" as Amazon // SES searches for the required TXT record in the DNS settings of the domain. // When Amazon SES detects the record, the domain's verification status changes // to "Success". If Amazon SES is unable to detect the record within 72 hours, -// the domain's verification status changes to "Failed." In that case, if you -// still want to verify the domain, you must restart the verification process -// from the beginning. +// the domain's verification status changes to "Failed." In that case, to verify +// the domain, you must restart the verification process from the beginning. // // This operation is throttled at one request per second and can only get verification // attributes for up to 100 identities at a time. @@ -2836,9 +2836,10 @@ func (c *SES) GetSendStatisticsRequest(input *GetSendStatisticsInput) (req *requ // GetSendStatistics API operation for Amazon Simple Email Service. // -// Provides sending statistics for the current AWS Region. The result is a list -// of data points, representing the last two weeks of sending activity. Each -// data point in the list contains statistics for a 15-minute period of time. +// Provides sending statistics for the current Amazon Web Services Region. The +// result is a list of data points, representing the last two weeks of sending +// activity. Each data point in the list contains statistics for a 15-minute +// period of time. // // You can execute this operation no more than once per second. // @@ -2996,16 +2997,17 @@ func (c *SES) ListConfigurationSetsRequest(input *ListConfigurationSetsInput) (r // ListConfigurationSets API operation for Amazon Simple Email Service. // // Provides a list of the configuration sets associated with your Amazon SES -// account in the current AWS Region. For information about using configuration -// sets, see Monitoring Your Amazon SES Sending Activity (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// account in the current Amazon Web Services Region. For information about +// using configuration sets, see Monitoring Your Amazon SES Sending Activity +// (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html) // in the Amazon SES Developer Guide. // // You can execute this operation no more than once per second. This operation -// will return up to 1,000 configuration sets each time it is run. If your Amazon -// SES account has more than 1,000 configuration sets, this operation will also -// return a NextToken element. You can then execute the ListConfigurationSets -// operation again, passing the NextToken parameter and the value of the NextToken -// element to retrieve additional results. +// returns up to 1,000 configuration sets each time it is run. If your Amazon +// SES account has more than 1,000 configuration sets, this operation also returns +// NextToken. You can then execute the ListConfigurationSets operation again, +// passing the NextToken parameter and the value of the NextToken element to +// retrieve additional results. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3085,10 +3087,10 @@ func (c *SES) ListCustomVerificationEmailTemplatesRequest(input *ListCustomVerif // ListCustomVerificationEmailTemplates API operation for Amazon Simple Email Service. // // Lists the existing custom verification email templates for your account in -// the current AWS Region. +// the current Amazon Web Services Region. // // For more information about custom verification email templates, see Using -// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. // // You can execute this operation no more than once per second. @@ -3222,11 +3224,19 @@ func (c *SES) ListIdentitiesRequest(input *ListIdentitiesInput) (req *request.Re // ListIdentities API operation for Amazon Simple Email Service. // // Returns a list containing all of the identities (email addresses and domains) -// for your AWS account in the current AWS Region, regardless of verification -// status. +// for your Amazon Web Services account in the current Amazon Web Services Region, +// regardless of verification status. // // You can execute this operation no more than once per second. // +// It's recommended that for successive pagination calls of this API, you continue +// to the use the same parameter/value pairs as used in the original call, e.g., +// if you used IdentityType=Domain in the the original call and received a NextToken +// in the response, you should continue providing the IdentityType=Domain parameter +// for further NextToken calls; however, if you didn't provide the IdentityType +// parameter in the original call, then continue to not provide it for successive +// pagination calls. Using this protocol will ensure consistent results. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3350,15 +3360,15 @@ func (c *SES) ListIdentityPoliciesRequest(input *ListIdentityPoliciesInput) (req // ListIdentityPolicies API operation for Amazon Simple Email Service. // // Returns a list of sending authorization policies that are attached to the -// given identity (an email address or a domain). This API returns only a list. -// If you want the actual policy content, you can use GetIdentityPolicies. +// given identity (an email address or a domain). This operation returns only +// a list. To get the actual policy content, use GetIdentityPolicies. // -// This API is for the identity owner only. If you have not verified the identity, -// this API will return an error. +// This operation is for the identity owner only. If you have not verified the +// identity, it returns an error. // // Sending authorization is a feature that enables an identity owner to authorize // other senders to use its identities. For information about using sending -// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). // // You can execute this operation no more than once per second. // @@ -3433,11 +3443,11 @@ func (c *SES) ListReceiptFiltersRequest(input *ListReceiptFiltersInput) (req *re // ListReceiptFilters API operation for Amazon Simple Email Service. // -// Lists the IP address filters associated with your AWS account in the current -// AWS Region. +// Lists the IP address filters associated with your Amazon Web Services account +// in the current Amazon Web Services Region. // // For information about managing IP address filters, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -3512,13 +3522,13 @@ func (c *SES) ListReceiptRuleSetsRequest(input *ListReceiptRuleSetsInput) (req * // ListReceiptRuleSets API operation for Amazon Simple Email Service. // -// Lists the receipt rule sets that exist under your AWS account in the current -// AWS Region. If there are additional receipt rule sets to be retrieved, you -// will receive a NextToken that you can provide to the next call to ListReceiptRuleSets -// to retrieve the additional entries. +// Lists the receipt rule sets that exist under your Amazon Web Services account +// in the current Amazon Web Services Region. If there are additional receipt +// rule sets to be retrieved, you receive a NextToken that you can provide to +// the next call to ListReceiptRuleSets to retrieve the additional entries. // // For information about managing receipt rule sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -3594,7 +3604,7 @@ func (c *SES) ListTemplatesRequest(input *ListTemplatesInput) (req *request.Requ // ListTemplates API operation for Amazon Simple Email Service. // // Lists the email templates present in your Amazon SES account in the current -// AWS Region. +// Amazon Web Services Region. // // You can execute this operation no more than once per second. // @@ -3830,12 +3840,12 @@ func (c *SES) PutIdentityPolicyRequest(input *PutIdentityPolicyInput) (req *requ // Adds or updates a sending authorization policy for the specified identity // (an email address or a domain). // -// This API is for the identity owner only. If you have not verified the identity, -// this API will return an error. +// This operation is for the identity owner only. If you have not verified the +// identity, it returns an error. // // Sending authorization is a feature that enables an identity owner to authorize // other senders to use its identities. For information about using sending -// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). // // You can execute this operation no more than once per second. // @@ -3920,11 +3930,11 @@ func (c *SES) ReorderReceiptRuleSetRequest(input *ReorderReceiptRuleSetInput) (r // Reorders the receipt rules within a receipt rule set. // // All of the rules in the rule set must be represented in this request. That -// is, this API will return an error if the reorder request doesn't explicitly -// position all of the rules. +// is, it is error if the reorder request doesn't explicitly position all of +// the rules. // // For information about managing receipt rule sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -4009,14 +4019,14 @@ func (c *SES) SendBounceRequest(input *SendBounceInput) (req *request.Request, o // SendBounce API operation for Amazon Simple Email Service. // // Generates and sends a bounce message to the sender of an email you received -// through Amazon SES. You can only use this API on an email up to 24 hours -// after you receive it. +// through Amazon SES. You can only use this operation on an email up to 24 +// hours after you receive it. // -// You cannot use this API to send generic bounces for mail that was not received -// by Amazon SES. +// You cannot use this operation to send generic bounces for mail that was not +// received by Amazon SES. // // For information about receiving email through Amazon SES, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html). // // You can execute this operation no more than once per second. // @@ -4100,18 +4110,17 @@ func (c *SES) SendBulkTemplatedEmailRequest(input *SendBulkTemplatedEmailInput) // Composes an email message to multiple destinations. The message body is created // using an email template. // -// In order to send email using the SendBulkTemplatedEmail operation, your call -// to the API must meet the following requirements: +// To send email using this operation, your call must meet the following requirements: // // - The call must refer to an existing email template. You can create email -// templates using the CreateTemplate operation. +// templates using CreateTemplate. // // - The message must be sent from a verified email address or domain. // -// - If your account is still in the Amazon SES sandbox, you may only send +// - If your account is still in the Amazon SES sandbox, you may send only // to verified addresses or domains, or to email addresses associated with // the Amazon SES Mailbox Simulator. For more information, see Verifying -// Email Addresses and Domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) +// Email Addresses and Domains (https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html) // in the Amazon SES Developer Guide. // // - The maximum message size is 10 MB. @@ -4120,8 +4129,8 @@ func (c *SES) SendBulkTemplatedEmailRequest(input *SendBulkTemplatedEmailInput) // address. The recipient address can be a To: address, a CC: address, or // a BCC: address. If a recipient email address is invalid (that is, it is // not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire -// message will be rejected, even if the message contains other recipients -// that are valid. +// message is rejected, even if the message contains other recipients that +// are valid. // // - The message may not include more than 50 recipients, across the To:, // CC: and BCC: fields. If you need to send an email message to a larger @@ -4129,8 +4138,8 @@ func (c *SES) SendBulkTemplatedEmailRequest(input *SendBulkTemplatedEmailInput) // and then call the SendBulkTemplatedEmail operation several times to send // the message to each group. // -// - The number of destinations you can contact in a single call to the API -// may be limited by your account's maximum sending rate. +// - The number of destinations you can contact in a single call can be limited +// by your account's maximum sending rate. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4235,13 +4244,13 @@ func (c *SES) SendCustomVerificationEmailRequest(input *SendCustomVerificationEm // SendCustomVerificationEmail API operation for Amazon Simple Email Service. // // Adds an email address to the list of identities for your Amazon SES account -// in the current AWS Region and attempts to verify it. As a result of executing -// this operation, a customized verification email is sent to the specified -// address. +// in the current Amazon Web Services Region and attempts to verify it. As a +// result of executing this operation, a customized verification email is sent +// to the specified address. // // To use this operation, you must first create a custom verification email // template. For more information about creating and using custom verification -// email templates, see Using Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// email templates, see Using Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. // // You can execute this operation no more than once per second. @@ -4339,18 +4348,17 @@ func (c *SES) SendEmailRequest(input *SendEmailInput) (req *request.Request, out // SendEmail API operation for Amazon Simple Email Service. // -// Composes an email message and immediately queues it for sending. In order -// to send email using the SendEmail operation, your message must meet the following -// requirements: +// Composes an email message and immediately queues it for sending. To send +// email using this operation, your message must meet the following requirements: // // - The message must be sent from a verified email address or domain. If // you attempt to send email using a non-verified address or domain, the -// operation will result in an "Email address not verified" error. +// operation results in an "Email address not verified" error. // // - If your account is still in the Amazon SES sandbox, you may only send // to verified addresses or domains, or to email addresses associated with // the Amazon SES Mailbox Simulator. For more information, see Verifying -// Email Addresses and Domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) +// Email Addresses and Domains (https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html) // in the Amazon SES Developer Guide. // // - The maximum message size is 10 MB. @@ -4358,8 +4366,8 @@ func (c *SES) SendEmailRequest(input *SendEmailInput) (req *request.Request, out // - The message must include at least one recipient email address. The recipient // address can be a To: address, a CC: address, or a BCC: address. If a recipient // email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), -// the entire message will be rejected, even if the message contains other -// recipients that are valid. +// the entire message is rejected, even if the message contains other recipients +// that are valid. // // - The message may not include more than 50 recipients, across the To:, // CC: and BCC: fields. If you need to send an email message to a larger @@ -4371,7 +4379,7 @@ func (c *SES) SendEmailRequest(input *SendEmailInput) (req *request.Request, out // each recipient in the To:, CC: and BCC: fields) is counted against the maximum // number of emails you can send in a 24-hour period (your sending quota). For // more information about sending quotas in Amazon SES, see Managing Your Amazon -// SES Sending Limits (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html) +// SES Sending Limits (https://docs.aws.amazon.com/ses/latest/dg/manage-sending-quotas.html) // in the Amazon SES Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4474,23 +4482,23 @@ func (c *SES) SendRawEmailRequest(input *SendRawEmailInput) (req *request.Reques // // Composes an email message and immediately queues it for sending. // -// This operation is more flexible than the SendEmail API operation. When you -// use the SendRawEmail operation, you can specify the headers of the message -// as well as its content. This flexibility is useful, for example, when you -// want to send a multipart MIME email (such a message that contains both a -// text and an HTML version). You can also use this operation to send messages -// that include attachments. +// This operation is more flexible than the SendEmail operation. When you use +// the SendRawEmail operation, you can specify the headers of the message as +// well as its content. This flexibility is useful, for example, when you need +// to send a multipart MIME email (such a message that contains both a text +// and an HTML version). You can also use this operation to send messages that +// include attachments. // // The SendRawEmail operation has the following requirements: // -// - You can only send email from verified email addresses or domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). +// - You can only send email from verified email addresses or domains (https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html). // If you try to send email from an address that isn't verified, the operation // results in an "Email address not verified" error. // -// - If your account is still in the Amazon SES sandbox (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html), +// - If your account is still in the Amazon SES sandbox (https://docs.aws.amazon.com/ses/latest/dg/request-production-access.html), // you can only send email to other verified addresses in your account, or // to addresses that are associated with the Amazon SES mailbox simulator -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mailbox-simulator.html). +// (https://docs.aws.amazon.com/ses/latest/dg/send-an-email-from-console.html). // // - The maximum message size, including attachments, is 10 MB. // @@ -4513,35 +4521,35 @@ func (c *SES) SendRawEmailRequest(input *SendRawEmailInput) (req *request.Reques // of your message (for example, if you use open and click tracking), 8-bit // content isn't preserved. For this reason, we highly recommend that you // encode all content that isn't 7-bit ASCII. For more information, see MIME -// Encoding (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html#send-email-mime-encoding) +// Encoding (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html#send-email-mime-encoding) // in the Amazon SES Developer Guide. // // Additionally, keep the following considerations in mind when using the SendRawEmail // operation: // // - Although you can customize the message headers when using the SendRawEmail -// operation, Amazon SES will automatically apply its own Message-ID and -// Date headers; if you passed these headers when creating the message, they -// will be overwritten by the values that Amazon SES provides. +// operation, Amazon SES automatically applies its own Message-ID and Date +// headers; if you passed these headers when creating the message, they are +// overwritten by the values that Amazon SES provides. // // - If you are using sending authorization to send on behalf of another // user, SendRawEmail enables you to specify the cross-account identity for // the email's Source, From, and Return-Path parameters in one of two ways: -// you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn -// to the API, or you can include the following X-headers in the header of -// your raw email: X-SES-SOURCE-ARN X-SES-FROM-ARN X-SES-RETURN-PATH-ARN -// Don't include these X-headers in the DKIM signature. Amazon SES removes -// these before it sends the email. If you only specify the SourceIdentityArn -// parameter, Amazon SES sets the From and Return-Path addresses to the same -// identity that you specified. For more information about sending authorization, -// see the Using Sending Authorization with Amazon SES (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn, +// or you can include the following X-headers in the header of your raw email: +// X-SES-SOURCE-ARN X-SES-FROM-ARN X-SES-RETURN-PATH-ARN Don't include these +// X-headers in the DKIM signature. Amazon SES removes these before it sends +// the email. If you only specify the SourceIdentityArn parameter, Amazon +// SES sets the From and Return-Path addresses to the same identity that +// you specified. For more information about sending authorization, see the +// Using Sending Authorization with Amazon SES (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html) // in the Amazon SES Developer Guide. // // - For every message that you send, the total number of recipients (including // each recipient in the To:, CC: and BCC: fields) is counted against the // maximum number of emails you can send in a 24-hour period (your sending // quota). For more information about sending quotas in Amazon SES, see Managing -// Your Amazon SES Sending Limits (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html) +// Your Amazon SES Sending Limits (https://docs.aws.amazon.com/ses/latest/dg/manage-sending-quotas.html) // in the Amazon SES Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4645,8 +4653,7 @@ func (c *SES) SendTemplatedEmailRequest(input *SendTemplatedEmailInput) (req *re // Composes an email message using an email template and immediately queues // it for sending. // -// In order to send email using the SendTemplatedEmail operation, your call -// to the API must meet the following requirements: +// To send email using this operation, your call must meet the following requirements: // // - The call must refer to an existing email template. You can create email // templates using the CreateTemplate operation. @@ -4656,13 +4663,13 @@ func (c *SES) SendTemplatedEmailRequest(input *SendTemplatedEmailInput) (req *re // - If your account is still in the Amazon SES sandbox, you may only send // to verified addresses or domains, or to email addresses associated with // the Amazon SES Mailbox Simulator. For more information, see Verifying -// Email Addresses and Domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) +// Email Addresses and Domains (https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html) // in the Amazon SES Developer Guide. // // - The maximum message size is 10 MB. // // - Calls to the SendTemplatedEmail operation may only include one Destination -// parameter. A destination is a set of recipients who will receive the same +// parameter. A destination is a set of recipients that receives the same // version of the email. The Destination parameter can include up to 50 recipients, // across the To:, CC: and BCC: fields. // @@ -4670,8 +4677,8 @@ func (c *SES) SendTemplatedEmailRequest(input *SendTemplatedEmailInput) (req *re // address. The recipient address can be a To: address, a CC: address, or // a BCC: address. If a recipient email address is invalid (that is, it is // not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire -// message will be rejected, even if the message contains other recipients -// that are valid. +// message is rejected, even if the message contains other recipients that +// are valid. // // If your call to the SendTemplatedEmail operation includes all of the required // parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon @@ -4681,7 +4688,7 @@ func (c *SES) SendTemplatedEmailRequest(input *SendTemplatedEmailInput) (req *re // // For these reasons, we highly recommend that you set up Amazon SES to send // you notifications when Rendering Failure events occur. For more information, -// see Sending Personalized Email Using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// see Sending Personalized Email Using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html) // in the Amazon Simple Email Service Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4790,10 +4797,10 @@ func (c *SES) SetActiveReceiptRuleSetRequest(input *SetActiveReceiptRuleSetInput // Sets the specified receipt rule set as the active receipt rule set. // // To disable your email-receiving through Amazon SES completely, you can call -// this API with RuleSetName set to null. +// this operation with RuleSetName set to null. // // For information about managing receipt rule sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -4891,7 +4898,7 @@ func (c *SES) SetIdentityDkimEnabledRequest(input *SetIdentityDkimEnabledInput) // You can execute this operation no more than once per second. // // For more information about Easy DKIM signing, go to the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4976,7 +4983,7 @@ func (c *SES) SetIdentityFeedbackForwardingEnabledRequest(input *SetIdentityFeed // You can execute this operation no more than once per second. // // For more information about using notifications with Amazon SES, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5057,7 +5064,7 @@ func (c *SES) SetIdentityHeadersInNotificationsEnabledRequest(input *SetIdentity // You can execute this operation no more than once per second. // // For more information about using notifications with Amazon SES, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5135,9 +5142,9 @@ func (c *SES) SetIdentityMailFromDomainRequest(input *SetIdentityMailFromDomainI // (an email address or a domain). // // To send emails using the specified MAIL FROM domain, you must add an MX record -// to your MAIL FROM domain's DNS settings. If you want your emails to pass +// to your MAIL FROM domain's DNS settings. To ensure that your emails pass // Sender Policy Framework (SPF) checks, you must also add or update an SPF -// record. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-set.html). +// record. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/mail-from.html). // // You can execute this operation no more than once per second. // @@ -5223,7 +5230,7 @@ func (c *SES) SetIdentityNotificationTopicRequest(input *SetIdentityNotification // You can execute this operation no more than once per second. // // For more information about feedback notification, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5300,7 +5307,7 @@ func (c *SES) SetReceiptRulePositionRequest(input *SetReceiptRulePositionInput) // Sets the position of the specified receipt rule in the receipt rule set. // // For information about managing receipt rules, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -5478,10 +5485,10 @@ func (c *SES) UpdateAccountSendingEnabledRequest(input *UpdateAccountSendingEnab // UpdateAccountSendingEnabled API operation for Amazon Simple Email Service. // // Enables or disables email sending across your entire Amazon SES account in -// the current AWS Region. You can use this operation in conjunction with Amazon -// CloudWatch alarms to temporarily pause email sending across your Amazon SES -// account in a given AWS Region when reputation metrics (such as your bounce -// or complaint rates) reach certain thresholds. +// the current Amazon Web Services Region. You can use this operation in conjunction +// with Amazon CloudWatch alarms to temporarily pause email sending across your +// Amazon SES account in a given Amazon Web Services Region when reputation +// metrics (such as your bounce or complaint rates) reach certain thresholds. // // You can execute this operation no more than once per second. // @@ -5561,7 +5568,7 @@ func (c *SES) UpdateConfigurationSetEventDestinationRequest(input *UpdateConfigu // are associated with configuration sets, which enable you to publish email // sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple // Notification Service (Amazon SNS). For information about using configuration -// sets, see Monitoring Your Amazon SES Sending Activity (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// sets, see Monitoring Your Amazon SES Sending Activity (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html) // in the Amazon SES Developer Guide. // // When you create or update an event destination, you must provide one, and @@ -5664,10 +5671,10 @@ func (c *SES) UpdateConfigurationSetReputationMetricsEnabledRequest(input *Updat // UpdateConfigurationSetReputationMetricsEnabled API operation for Amazon Simple Email Service. // // Enables or disables the publishing of reputation metrics for emails sent -// using a specific configuration set in a given AWS Region. Reputation metrics -// include bounce and complaint rates. These metrics are published to Amazon -// CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint -// rates exceed certain thresholds. +// using a specific configuration set in a given Amazon Web Services Region. +// Reputation metrics include bounce and complaint rates. These metrics are +// published to Amazon CloudWatch. By using CloudWatch, you can create alarms +// when bounce or complaint rates exceed certain thresholds. // // You can execute this operation no more than once per second. // @@ -5749,10 +5756,10 @@ func (c *SES) UpdateConfigurationSetSendingEnabledRequest(input *UpdateConfigura // UpdateConfigurationSetSendingEnabled API operation for Amazon Simple Email Service. // // Enables or disables email sending for messages sent using a specific configuration -// set in a given AWS Region. You can use this operation in conjunction with -// Amazon CloudWatch alarms to temporarily pause email sending for a configuration -// set when the reputation metrics for that configuration set (such as your -// bounce on complaint rate) exceed certain thresholds. +// set in a given Amazon Web Services Region. You can use this operation in +// conjunction with Amazon CloudWatch alarms to temporarily pause email sending +// for a configuration set when the reputation metrics for that configuration +// set (such as your bounce on complaint rate) exceed certain thresholds. // // You can execute this operation no more than once per second. // @@ -5839,7 +5846,7 @@ func (c *SES) UpdateConfigurationSetTrackingOptionsRequest(input *UpdateConfigur // By default, images and links used for tracking open and click events are // hosted on domains operated by Amazon SES. You can configure a subdomain of // your own to handle these events. For information about using custom domains, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5933,7 +5940,7 @@ func (c *SES) UpdateCustomVerificationEmailTemplateRequest(input *UpdateCustomVe // Updates an existing custom verification email template. // // For more information about custom verification email templates, see Using -// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. // // You can execute this operation no more than once per second. @@ -6028,7 +6035,7 @@ func (c *SES) UpdateReceiptRuleRequest(input *UpdateReceiptRuleInput) (req *requ // Updates a receipt rule. // // For information about managing receipt rules, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). // // You can execute this operation no more than once per second. // @@ -6047,16 +6054,16 @@ func (c *SES) UpdateReceiptRuleRequest(input *UpdateReceiptRuleInput) (req *requ // about giving permissions, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). // // - ErrCodeInvalidS3ConfigurationException "InvalidS3Configuration" -// Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is -// invalid, or that Amazon SES could not publish to the bucket, possibly due -// to permissions issues. For information about giving permissions, see the -// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). +// Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption +// key is invalid, or that Amazon SES could not publish to the bucket, possibly +// due to permissions issues. For information about giving permissions, see +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). // // - ErrCodeInvalidLambdaFunctionException "InvalidLambdaFunction" -// Indicates that the provided AWS Lambda function is invalid, or that Amazon -// SES could not execute the provided function, possibly due to permissions -// issues. For information about giving permissions, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). +// Indicates that the provided Amazon Web Services Lambda function is invalid, +// or that Amazon SES could not execute the provided function, possibly due +// to permissions issues. For information about giving permissions, see the +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). // // - ErrCodeRuleSetDoesNotExistException "RuleSetDoesNotExist" // Indicates that the provided receipt rule set does not exist. @@ -6135,8 +6142,8 @@ func (c *SES) UpdateTemplateRequest(input *UpdateTemplateInput) (req *request.Re // UpdateTemplate API operation for Amazon Simple Email Service. // // Updates an email template. Email templates enable you to send personalized -// email to one or more destinations in a single API operation. For more information, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// email to one or more destinations in a single operation. For more information, +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html). // // You can execute this operation no more than once per second. // @@ -6228,8 +6235,8 @@ func (c *SES) VerifyDomainDkimRequest(input *VerifyDomainDkimInput) (req *reques // is added to the list of identities that are associated with your account. // This is true even if you haven't already associated the domain with your // account by using the VerifyDomainIdentity operation. However, you can't send -// email from the domain until you either successfully verify it (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html) -// or you successfully set up DKIM for it (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). +// email from the domain until you either successfully verify it (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-domain-procedure) +// or you successfully set up DKIM for it (https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html). // // You use the tokens that are generated by this operation to create CNAME records. // When Amazon SES detects that you've added these records to the DNS configuration @@ -6324,8 +6331,8 @@ func (c *SES) VerifyDomainIdentityRequest(input *VerifyDomainIdentityInput) (req // VerifyDomainIdentity API operation for Amazon Simple Email Service. // // Adds a domain to the list of identities for your Amazon SES account in the -// current AWS Region and attempts to verify it. For more information about -// verifying domains, see Verifying Email Addresses and Domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) +// current Amazon Web Services Region and attempts to verify it. For more information +// about verifying domains, see Verifying Email Addresses and Domains (https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html) // in the Amazon SES Developer Guide. // // You can execute this operation no more than once per second. @@ -6477,8 +6484,9 @@ func (c *SES) VerifyEmailIdentityRequest(input *VerifyEmailIdentityInput) (req * // VerifyEmailIdentity API operation for Amazon Simple Email Service. // // Adds an email address to the list of identities for your Amazon SES account -// in the current AWS region and attempts to verify it. As a result of executing -// this operation, a verification email is sent to the specified address. +// in the current Amazon Web Services Region and attempts to verify it. As a +// result of executing this operation, a verification email is sent to the specified +// address. // // You can execute this operation no more than once per second. // @@ -6514,18 +6522,19 @@ func (c *SES) VerifyEmailIdentityWithContext(ctx aws.Context, input *VerifyEmail // email. // // For information about adding a header using a receipt rule, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-add-header.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-add-header.html). type AddHeaderAction struct { _ struct{} `type:"structure"` - // The name of the header to add. Must be between 1 and 50 characters, inclusive, - // and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only. + // The name of the header to add to the incoming message. The name must contain + // at least one character, and can contain up to 50 characters. It consists + // of alphanumeric (a–z, A–Z, 0–9) characters and dashes. // // HeaderName is a required field HeaderName *string `type:"string" required:"true"` - // Must be less than 2048 characters, and must not contain newline characters - // ("\r" or "\n"). + // The content to include in the header. This value can contain up to 2048 characters. + // It can't contain newline (\n) or carriage return (\r) characters. // // HeaderValue is a required field HeaderValue *string `type:"string" required:"true"` @@ -6648,7 +6657,7 @@ func (s *Body) SetText(v *Content) *Body { // to Amazon Simple Notification Service (Amazon SNS). // // For information about sending a bounce message in response to a received -// email, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-bounce.html). +// email, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-bounce.html). type BounceAction struct { _ struct{} `type:"structure"` @@ -6658,7 +6667,7 @@ type BounceAction struct { Message *string `type:"string" required:"true"` // The email address of the sender of the bounced email. This is the address - // from which the bounce message will be sent. + // from which the bounce message is sent. // // Sender is a required field Sender *string `type:"string" required:"true"` @@ -6672,7 +6681,10 @@ type BounceAction struct { StatusCode *string `type:"string"` // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the - // bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. + // bounce action is taken. You can find the ARN of a topic by using the ListTopics + // (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) operation + // in Amazon SNS. + // // For more information about Amazon SNS topics, see the Amazon SNS Developer // Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). TopicArn *string `type:"string"` @@ -6749,7 +6761,7 @@ func (s *BounceAction) SetTopicArn(v string) *BounceAction { // (DSN) when an email that Amazon SES receives on your behalf bounces. // // For information about receiving email through Amazon SES, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html). type BouncedRecipientInfo struct { _ struct{} `type:"structure"` @@ -6764,7 +6776,7 @@ type BouncedRecipientInfo struct { // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to receive email for the recipient of the bounced email. For more information - // about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). RecipientArn *string `type:"string"` // Recipient-related DSN fields, most of which would normally be filled in automatically @@ -6842,12 +6854,15 @@ type BulkEmailDestination struct { // fields. // // Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 - // (https://tools.ietf.org/html/rfc6531). For this reason, the local part of - // a destination email address (the part of the email address that precedes - // the @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part). - // If the domain part of an address (the part after the @ sign) contains non-ASCII - // characters, they must be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). + // (https://tools.ietf.org/html/rfc6531). For this reason, the email address + // string must be 7-bit ASCII. If you want to send to or from email addresses + // that contain Unicode characters in the domain part of an address, you must + // encode the domain using Punycode. Punycode is not permitted in the local + // part of the email address (the part before the @ sign) nor in the "friendly + // from" name. If you want to use Unicode characters in the "friendly from" + // name, you must encode the "friendly from" name using MIME encoded-word syntax, + // as described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html). + // For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492). // // Destination is a required field Destination *Destination `type:"structure" required:"true"` @@ -6937,8 +6952,8 @@ type BulkEmailDestinationStatus struct { // // Possible values for this parameter include: // - // * Success: Amazon SES accepted the message, and will attempt to deliver - // it to the recipients. + // * Success: Amazon SES accepted the message, and attempts to deliver it + // to the recipients. // // * MessageRejected: The message was rejected because it contained a virus. // @@ -7018,7 +7033,7 @@ func (s *BulkEmailDestinationStatus) SetStatus(v string) *BulkEmailDestinationSt // Represents a request to create a receipt rule set by cloning an existing // one. You use receipt rule sets to receive email with Amazon SES. For more -// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type CloneReceiptRuleSetInput struct { _ struct{} `type:"structure"` @@ -7027,14 +7042,14 @@ type CloneReceiptRuleSetInput struct { // OriginalRuleSetName is a required field OriginalRuleSetName *string `type:"string" required:"true"` - // The name of the rule set to create. The name must: + // The name of the rule set to create. The name must meet the following requirements: // - // * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), - // underscores (_), or dashes (-). + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // or dashes (-). // // * Start and end with a letter or number. // - // * Contain less than 64 characters. + // * Contain 64 characters or fewer. // // RuleSetName is a required field RuleSetName *string `type:"string" required:"true"` @@ -7114,7 +7129,7 @@ func (s CloneReceiptRuleSetOutput) GoString() string { // // Event destinations, such as Amazon CloudWatch, are associated with configuration // sets, which enable you to publish email sending events. For information about -// using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type CloudWatchDestination struct { _ struct{} `type:"structure"` @@ -7176,38 +7191,38 @@ func (s *CloudWatchDestination) SetDimensionConfigurations(v []*CloudWatchDimens // events to Amazon CloudWatch. // // For information about publishing email sending events to Amazon CloudWatch, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type CloudWatchDimensionConfiguration struct { _ struct{} `type:"structure"` // The default value of the dimension that is published to Amazon CloudWatch // if you do not provide the value of the dimension when you send an email. - // The default value must: + // The default value must meet the following requirements: // - // * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), - // underscores (_), or dashes (-). + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // dashes (-), at signs (@), or periods (.). // - // * Contain less than 256 characters. + // * Contain 256 characters or fewer. // // DefaultDimensionValue is a required field DefaultDimensionValue *string `type:"string" required:"true"` // The name of an Amazon CloudWatch dimension associated with an email sending - // metric. The name must: + // metric. The name must meet the following requirements: // - // * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), - // underscores (_), or dashes (-). + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // dashes (-), or colons (:). // - // * Contain less than 256 characters. + // * Contain 256 characters or fewer. // // DimensionName is a required field DimensionName *string `type:"string" required:"true"` // The place where Amazon SES finds the value of a dimension to publish to Amazon - // CloudWatch. If you want Amazon SES to use the message tags that you specify - // using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail - // API, choose messageTag. If you want Amazon SES to use your own email headers, - // choose emailHeader. + // CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS + // header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. + // To use your own email headers, specify emailHeader. To put a custom tag on + // any link included in your email, specify linkTag. // // DimensionValueSource is a required field DimensionValueSource *string `type:"string" required:"true" enum:"DimensionValueSource"` @@ -7272,8 +7287,8 @@ func (s *CloudWatchDimensionConfiguration) SetDimensionValueSource(v string) *Cl // // Configuration sets let you create groups of rules that you can apply to the // emails you send using Amazon SES. For more information about using configuration -// sets, see Using Amazon SES Configuration Sets (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/using-configuration-sets.html) -// in the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). +// sets, see Using Amazon SES Configuration Sets (https://docs.aws.amazon.com/ses/latest/dg/using-configuration-sets.html) +// in the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/). type ConfigurationSet struct { _ struct{} `type:"structure"` @@ -7387,9 +7402,9 @@ func (s *Content) SetData(v string) *Content { // Represents a request to create a configuration set event destination. A configuration // set event destination, which can be either Amazon CloudWatch or Amazon Kinesis -// Firehose, describes an AWS service in which Amazon SES publishes the email -// sending events associated with a configuration set. For information about -// using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// Firehose, describes an Amazon Web Services service in which Amazon SES publishes +// the email sending events associated with a configuration set. For information +// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type CreateConfigurationSetEventDestinationInput struct { _ struct{} `type:"structure"` @@ -7399,8 +7414,8 @@ type CreateConfigurationSetEventDestinationInput struct { // ConfigurationSetName is a required field ConfigurationSetName *string `type:"string" required:"true"` - // An object that describes the AWS service that email sending event information - // will be published to. + // An object that describes the Amazon Web Services service that email sending + // event where information is published. // // EventDestination is a required field EventDestination *EventDestination `type:"structure" required:"true"` @@ -7482,7 +7497,7 @@ func (s CreateConfigurationSetEventDestinationOutput) GoString() string { // Represents a request to create a configuration set. Configuration sets enable // you to publish email sending events. For information about using configuration -// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type CreateConfigurationSetInput struct { _ struct{} `type:"structure"` @@ -7573,7 +7588,7 @@ type CreateConfigurationSetTrackingOptionsInput struct { // emails. // // For more information, see Configuring Custom Domains to Handle Open and Click - // Tracking (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) + // Tracking (https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html) // in the Amazon SES Developer Guide. // // TrackingOptions is a required field @@ -7673,7 +7688,7 @@ type CreateCustomVerificationEmailTemplateInput struct { // The content of the custom verification email. The total size of the email // must be less than 10 MB. The message body may contain HTML, with some limitations. // For more information, see Custom Verification Email Frequently Asked Questions - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq) + // (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. // // TemplateContent is a required field @@ -7796,7 +7811,7 @@ func (s CreateCustomVerificationEmailTemplateOutput) GoString() string { // Represents a request to create a new IP address filter. You use IP address // filters when you receive email with Amazon SES. For more information, see -// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type CreateReceiptFilterInput struct { _ struct{} `type:"structure"` @@ -7874,13 +7889,13 @@ func (s CreateReceiptFilterOutput) GoString() string { // Represents a request to create a receipt rule. You use receipt rules to receive // email with Amazon SES. For more information, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type CreateReceiptRuleInput struct { _ struct{} `type:"structure"` - // The name of an existing rule after which the new rule will be placed. If - // this parameter is null, the new rule will be inserted at the beginning of - // the rule list. + // The name of an existing rule after which the new rule is placed. If this + // parameter is null, the new rule is inserted at the beginning of the rule + // list. After *string `type:"string"` // A data structure that contains the specified rule's name, actions, recipients, @@ -7889,7 +7904,7 @@ type CreateReceiptRuleInput struct { // Rule is a required field Rule *ReceiptRule `type:"structure" required:"true"` - // The name of the rule set that the receipt rule will be added to. + // The name of the rule set where the receipt rule is added. // // RuleSetName is a required field RuleSetName *string `type:"string" required:"true"` @@ -7977,18 +7992,18 @@ func (s CreateReceiptRuleOutput) GoString() string { // Represents a request to create an empty receipt rule set. You use receipt // rule sets to receive email with Amazon SES. For more information, see the -// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type CreateReceiptRuleSetInput struct { _ struct{} `type:"structure"` - // The name of the rule set to create. The name must: + // The name of the rule set to create. The name must meet the following requirements: // - // * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), - // underscores (_), or dashes (-). + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // or dashes (-). // // * Start and end with a letter or number. // - // * Contain less than 64 characters. + // * Contain 64 characters or fewer. // // RuleSetName is a required field RuleSetName *string `type:"string" required:"true"` @@ -8055,12 +8070,12 @@ func (s CreateReceiptRuleSetOutput) GoString() string { } // Represents a request to create an email template. For more information, see -// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html). type CreateTemplateInput struct { _ struct{} `type:"structure"` - // The content of the email, composed of a subject line, an HTML part, and a - // text-only part. + // The content of the email, composed of a subject line and either an HTML part + // or a text-only part. // // Template is a required field Template *Template `type:"structure" required:"true"` @@ -8203,7 +8218,7 @@ func (s *CustomVerificationEmailTemplate) SetTemplateSubject(v string) *CustomVe // Represents a request to delete a configuration set event destination. Configuration // set event destinations are associated with configuration sets, which enable // you to publish email sending events. For information about using configuration -// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type DeleteConfigurationSetEventDestinationInput struct { _ struct{} `type:"structure"` @@ -8289,7 +8304,7 @@ func (s DeleteConfigurationSetEventDestinationOutput) GoString() string { // Represents a request to delete a configuration set. Configuration sets enable // you to publish email sending events. For information about using configuration -// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type DeleteConfigurationSetInput struct { _ struct{} `type:"structure"` @@ -8364,8 +8379,7 @@ func (s DeleteConfigurationSetOutput) GoString() string { type DeleteConfigurationSetTrackingOptionsInput struct { _ struct{} `type:"structure"` - // The name of the configuration set from which you want to delete the tracking - // options. + // The name of the configuration set. // // ConfigurationSetName is a required field ConfigurationSetName *string `type:"string" required:"true"` @@ -8435,7 +8449,7 @@ func (s DeleteConfigurationSetTrackingOptionsOutput) GoString() string { type DeleteCustomVerificationEmailTemplateInput struct { _ struct{} `type:"structure"` - // The name of the custom verification email template that you want to delete. + // The name of the custom verification email template to delete. // // TemplateName is a required field TemplateName *string `type:"string" required:"true"` @@ -8505,7 +8519,8 @@ func (s DeleteCustomVerificationEmailTemplateOutput) GoString() string { type DeleteIdentityInput struct { _ struct{} `type:"structure"` - // The identity to be removed from the list of identities for the AWS Account. + // The identity to be removed from the list of identities for the Amazon Web + // Services account. // // Identity is a required field Identity *string `type:"string" required:"true"` @@ -8574,15 +8589,15 @@ func (s DeleteIdentityOutput) GoString() string { // Represents a request to delete a sending authorization policy for an identity. // Sending authorization is an Amazon SES feature that enables you to authorize // other senders to use your identities. For information, see the Amazon SES -// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). type DeleteIdentityPolicyInput struct { _ struct{} `type:"structure"` - // The identity that is associated with the policy that you want to delete. - // You can specify the identity by using its name or by using its Amazon Resource - // Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. + // The identity that is associated with the policy to delete. You can specify + // the identity by using its name or by using its Amazon Resource Name (ARN). + // Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. // - // To successfully call this API, you must own the identity. + // To successfully call this operation, you must own the identity. // // Identity is a required field Identity *string `type:"string" required:"true"` @@ -8667,7 +8682,7 @@ func (s DeleteIdentityPolicyOutput) GoString() string { // Represents a request to delete an IP address filter. You use IP address filters // when you receive email with Amazon SES. For more information, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type DeleteReceiptFilterInput struct { _ struct{} `type:"structure"` @@ -8739,7 +8754,7 @@ func (s DeleteReceiptFilterOutput) GoString() string { // Represents a request to delete a receipt rule. You use receipt rules to receive // email with Amazon SES. For more information, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type DeleteReceiptRuleInput struct { _ struct{} `type:"structure"` @@ -8825,7 +8840,7 @@ func (s DeleteReceiptRuleOutput) GoString() string { // Represents a request to delete a receipt rule set and all of the receipt // rules it contains. You use receipt rule sets to receive email with Amazon -// SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type DeleteReceiptRuleSetInput struct { _ struct{} `type:"structure"` @@ -8896,7 +8911,7 @@ func (s DeleteReceiptRuleSetOutput) GoString() string { } // Represents a request to delete an email template. For more information, see -// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html). type DeleteTemplateInput struct { _ struct{} `type:"structure"` @@ -8966,7 +8981,7 @@ func (s DeleteTemplateOutput) GoString() string { } // Represents a request to delete an email address from the list of email addresses -// you have attempted to verify under your AWS account. +// you have attempted to verify under your Amazon Web Services account. type DeleteVerifiedEmailAddressInput struct { _ struct{} `type:"structure"` @@ -9074,7 +9089,7 @@ func (s *DeliveryOptions) SetTlsPolicy(v string) *DeliveryOptions { // Represents a request to return the metadata and receipt rules for the receipt // rule set that is currently active. You use receipt rule sets to receive email // with Amazon SES. For more information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type DescribeActiveReceiptRuleSetInput struct { _ struct{} `type:"structure"` } @@ -9142,7 +9157,7 @@ func (s *DescribeActiveReceiptRuleSetOutput) SetRules(v []*ReceiptRule) *Describ // Represents a request to return the details of a configuration set. Configuration // sets enable you to publish email sending events. For information about using -// configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type DescribeConfigurationSetInput struct { _ struct{} `type:"structure"` @@ -9200,7 +9215,7 @@ func (s *DescribeConfigurationSetInput) SetConfigurationSetName(v string) *Descr // Represents the details of a configuration set. Configuration sets enable // you to publish email sending events. For information about using configuration -// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type DescribeConfigurationSetOutput struct { _ struct{} `type:"structure"` @@ -9273,7 +9288,7 @@ func (s *DescribeConfigurationSetOutput) SetTrackingOptions(v *TrackingOptions) // Represents a request to return the details of a receipt rule. You use receipt // rules to receive email with Amazon SES. For more information, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type DescribeReceiptRuleInput struct { _ struct{} `type:"structure"` @@ -9370,7 +9385,7 @@ func (s *DescribeReceiptRuleOutput) SetRule(v *ReceiptRule) *DescribeReceiptRule // Represents a request to return the details of a receipt rule set. You use // receipt rule sets to receive email with Amazon SES. For more information, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type DescribeReceiptRuleSetInput struct { _ struct{} `type:"structure"` @@ -9463,12 +9478,15 @@ func (s *DescribeReceiptRuleSetOutput) SetRules(v []*ReceiptRule) *DescribeRecei // fields. // // Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 -// (https://tools.ietf.org/html/rfc6531). For this reason, the local part of -// a destination email address (the part of the email address that precedes -// the @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part). -// If the domain part of an address (the part after the @ sign) contains non-ASCII -// characters, they must be encoded using Punycode, as described in RFC3492 -// (https://tools.ietf.org/html/rfc3492.html). +// (https://tools.ietf.org/html/rfc6531). For this reason, the email address +// string must be 7-bit ASCII. If you want to send to or from email addresses +// that contain Unicode characters in the domain part of an address, you must +// encode the domain using Punycode. Punycode is not permitted in the local +// part of the email address (the part before the @ sign) nor in the "friendly +// from" name. If you want to use Unicode characters in the "friendly from" +// name, you must encode the "friendly from" name using MIME encoded-word syntax, +// as described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html). +// For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492). type Destination struct { _ struct{} `type:"structure"` @@ -9518,8 +9536,7 @@ func (s *Destination) SetToAddresses(v []*string) *Destination { return s } -// Contains information about the event destination that the specified email -// sending events will be published to. +// Contains information about an event destination. // // When you create or update an event destination, you must provide one, and // only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis @@ -9528,7 +9545,7 @@ func (s *Destination) SetToAddresses(v []*string) *Destination { // Event destinations are associated with configuration sets, which enable you // to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, // or Amazon Simple Notification Service (Amazon SNS). For information about -// using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type EventDestination struct { _ struct{} `type:"structure"` @@ -9548,15 +9565,37 @@ type EventDestination struct { // The type of email sending events to publish to the event destination. // + // * send - The call was successful and Amazon SES is attempting to deliver + // the email. + // + // * reject - Amazon SES determined that the email contained a virus and + // rejected it. + // + // * bounce - The recipient's mail server permanently rejected the email. + // This corresponds to a hard bounce. + // + // * complaint - The recipient marked the email as spam. + // + // * delivery - Amazon SES successfully delivered the email to the recipient's + // mail server. + // + // * open - The recipient received the email and opened it in their email + // client. + // + // * click - The recipient clicked one or more links in the email. + // + // * renderingFailure - Amazon SES did not send the email because of a template + // rendering issue. + // // MatchingEventTypes is a required field MatchingEventTypes []*string `type:"list" required:"true" enum:"EventType"` - // The name of the event destination. The name must: + // The name of the event destination. The name must meet the following requirements: // - // * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), - // underscores (_), or dashes (-). + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // or dashes (-). // - // * Contain less than 64 characters. + // * Contain 64 characters or fewer. // // Name is a required field Name *string `type:"string" required:"true"` @@ -9655,7 +9694,7 @@ func (s *EventDestination) SetSNSDestination(v *SNSDestination) *EventDestinatio // when an email that Amazon SES receives on your behalf bounces. // // For information about receiving email through Amazon SES, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html). type ExtensionField struct { _ struct{} `type:"structure"` @@ -9665,8 +9704,8 @@ type ExtensionField struct { // Name is a required field Name *string `type:"string" required:"true"` - // The value of the header to add. Must be less than 2048 characters, and must - // not contain newline characters ("\r" or "\n"). + // The value of the header to add. Must contain 2048 characters or fewer, and + // must not contain newline characters ("\r" or "\n"). // // Value is a required field Value *string `type:"string" required:"true"` @@ -9741,12 +9780,12 @@ func (s GetAccountSendingEnabledInput) GoString() string { } // Represents a request to return the email sending status for your Amazon SES -// account in the current AWS Region. +// account in the current Amazon Web Services Region. type GetAccountSendingEnabledOutput struct { _ struct{} `type:"structure"` // Describes whether email sending is enabled or disabled for your Amazon SES - // account in the current AWS Region. + // account in the current Amazon Web Services Region. Enabled *bool `type:"boolean"` } @@ -9778,7 +9817,7 @@ func (s *GetAccountSendingEnabledOutput) SetEnabled(v bool) *GetAccountSendingEn type GetCustomVerificationEmailTemplateInput struct { _ struct{} `type:"structure"` - // The name of the custom verification email template that you want to retrieve. + // The name of the custom verification email template to retrieve. // // TemplateName is a required field TemplateName *string `type:"string" required:"true"` @@ -9904,7 +9943,7 @@ func (s *GetCustomVerificationEmailTemplateOutput) SetTemplateSubject(v string) // identity. For domain identities, this request also returns the DKIM tokens // that are required for Easy DKIM signing, and whether Amazon SES successfully // verified that these tokens were published. For more information about Easy -// DKIM, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). +// DKIM, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html). type GetIdentityDkimAttributesInput struct { _ struct{} `type:"structure"` @@ -9991,7 +10030,7 @@ func (s *GetIdentityDkimAttributesOutput) SetDkimAttributes(v map[string]*Identi // Represents a request to return the Amazon SES custom MAIL FROM attributes // for a list of identities. For information about using a custom MAIL FROM -// domain, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html). +// domain, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/mail-from.html). type GetIdentityMailFromDomainAttributesInput struct { _ struct{} `type:"structure"` @@ -10074,7 +10113,7 @@ func (s *GetIdentityMailFromDomainAttributesOutput) SetMailFromDomainAttributes( // Represents a request to return the notification attributes for a list of // identities you verified with Amazon SES. For information about Amazon SES -// notifications, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html). +// notifications, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html). type GetIdentityNotificationAttributesInput struct { _ struct{} `type:"structure"` @@ -10160,15 +10199,15 @@ func (s *GetIdentityNotificationAttributesOutput) SetNotificationAttributes(v ma // Represents a request to return the requested sending authorization policies // for an identity. Sending authorization is an Amazon SES feature that enables // you to authorize other senders to use your identities. For information, see -// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). type GetIdentityPoliciesInput struct { _ struct{} `type:"structure"` - // The identity for which the policies will be retrieved. You can specify an - // identity by using its name or by using its Amazon Resource Name (ARN). Examples: - // user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. + // The identity for which the policies are retrieved. You can specify an identity + // by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, + // example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. // - // To successfully call this API, you must own the identity. + // To successfully call this operation, you must own the identity. // // Identity is a required field Identity *string `type:"string" required:"true"` @@ -10264,7 +10303,7 @@ func (s *GetIdentityPoliciesOutput) SetPolicies(v map[string]*string) *GetIdenti // Represents a request to return the Amazon SES verification status of a list // of identities. For domain identities, this request also returns the verification // token. For information about verifying identities with Amazon SES, see the -// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html). type GetIdentityVerificationAttributesInput struct { _ struct{} `type:"structure"` @@ -10482,7 +10521,7 @@ func (s *GetSendStatisticsOutput) SetSendDataPoints(v []*SendDataPoint) *GetSend type GetTemplateInput struct { _ struct{} `type:"structure"` - // The name of the template you want to retrieve. + // The name of the template to retrieve. // // TemplateName is a required field TemplateName *string `type:"string" required:"true"` @@ -10528,8 +10567,8 @@ func (s *GetTemplateInput) SetTemplateName(v string) *GetTemplateInput { type GetTemplateOutput struct { _ struct{} `type:"structure"` - // The content of the email, composed of a subject line, an HTML part, and a - // text-only part. + // The content of the email, composed of a subject line and either an HTML part + // or a text-only part. Template *Template `type:"structure"` } @@ -10576,7 +10615,7 @@ type IdentityDkimAttributes struct { // email address identities.) // // For more information about creating DNS records using DKIM tokens, see the - // Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). + // Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html). DkimTokens []*string `type:"list"` // Describes whether Amazon SES has successfully verified the DKIM DNS records @@ -10699,48 +10738,48 @@ func (s *IdentityMailFromDomainAttributes) SetMailFromDomainStatus(v string) *Id type IdentityNotificationAttributes struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will - // publish bounce notifications. + // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes + // bounce notifications. // // BounceTopic is a required field BounceTopic *string `type:"string" required:"true"` - // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will - // publish complaint notifications. + // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes + // complaint notifications. // // ComplaintTopic is a required field ComplaintTopic *string `type:"string" required:"true"` - // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will - // publish delivery notifications. + // The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes + // delivery notifications. // // DeliveryTopic is a required field DeliveryTopic *string `type:"string" required:"true"` - // Describes whether Amazon SES will forward bounce and complaint notifications - // as email. true indicates that Amazon SES will forward bounce and complaint - // notifications as email, while false indicates that bounce and complaint notifications - // will be published only to the specified bounce and complaint Amazon SNS topics. + // Describes whether Amazon SES forwards bounce and complaint notifications + // as email. true indicates that Amazon SES forwards bounce and complaint notifications + // as email, while false indicates that bounce and complaint notifications are + // published only to the specified bounce and complaint Amazon SNS topics. // // ForwardingEnabled is a required field ForwardingEnabled *bool `type:"boolean" required:"true"` // Describes whether Amazon SES includes the original email headers in Amazon // SNS notifications of type Bounce. A value of true specifies that Amazon SES - // will include headers in bounce notifications, and a value of false specifies - // that Amazon SES will not include headers in bounce notifications. + // includes headers in bounce notifications, and a value of false specifies + // that Amazon SES does not include headers in bounce notifications. HeadersInBounceNotificationsEnabled *bool `type:"boolean"` // Describes whether Amazon SES includes the original email headers in Amazon // SNS notifications of type Complaint. A value of true specifies that Amazon - // SES will include headers in complaint notifications, and a value of false - // specifies that Amazon SES will not include headers in complaint notifications. + // SES includes headers in complaint notifications, and a value of false specifies + // that Amazon SES does not include headers in complaint notifications. HeadersInComplaintNotificationsEnabled *bool `type:"boolean"` // Describes whether Amazon SES includes the original email headers in Amazon // SNS notifications of type Delivery. A value of true specifies that Amazon - // SES will include headers in delivery notifications, and a value of false - // specifies that Amazon SES will not include headers in delivery notifications. + // SES includes headers in delivery notifications, and a value of false specifies + // that Amazon SES does not include headers in delivery notifications. HeadersInDeliveryNotificationsEnabled *bool `type:"boolean"` } @@ -10854,7 +10893,7 @@ func (s *IdentityVerificationAttributes) SetVerificationToken(v string) *Identit // Event destinations, such as Amazon Kinesis Firehose, are associated with // configuration sets, which enable you to publish email sending events. For // information about using configuration sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type KinesisFirehoseDestination struct { _ struct{} `type:"structure"` @@ -10917,42 +10956,45 @@ func (s *KinesisFirehoseDestination) SetIAMRoleARN(v string) *KinesisFirehoseDes return s } -// When included in a receipt rule, this action calls an AWS Lambda function -// and, optionally, publishes a notification to Amazon Simple Notification Service -// (Amazon SNS). +// When included in a receipt rule, this action calls an Amazon Web Services +// Lambda function and, optionally, publishes a notification to Amazon Simple +// Notification Service (Amazon SNS). // -// To enable Amazon SES to call your AWS Lambda function or to publish to an -// Amazon SNS topic of another account, Amazon SES must have permission to access -// those resources. For information about giving permissions, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). +// To enable Amazon SES to call your Amazon Web Services Lambda function or +// to publish to an Amazon SNS topic of another account, Amazon SES must have +// permission to access those resources. For information about giving permissions, +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html). // -// For information about using AWS Lambda actions in receipt rules, see the -// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda.html). +// For information about using Amazon Web Services Lambda actions in receipt +// rules, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda.html). type LambdaAction struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the AWS Lambda function. An example of - // an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. - // For more information about AWS Lambda, see the AWS Lambda Developer Guide - // (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html). + // The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. + // An example of an Amazon Web Services Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. + // For more information about Amazon Web Services Lambda, see the Amazon Web + // Services Lambda Developer Guide (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html). // // FunctionArn is a required field FunctionArn *string `type:"string" required:"true"` - // The invocation type of the AWS Lambda function. An invocation type of RequestResponse - // means that the execution of the function will immediately result in a response, - // and a value of Event means that the function will be invoked asynchronously. - // The default value is Event. For information about AWS Lambda invocation types, - // see the AWS Lambda Developer Guide (https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html). + // The invocation type of the Amazon Web Services Lambda function. An invocation + // type of RequestResponse means that the execution of the function immediately + // results in a response, and a value of Event means that the function is invoked + // asynchronously. The default value is Event. For information about Amazon + // Web Services Lambda invocation types, see the Amazon Web Services Lambda + // Developer Guide (https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html). // // There is a 30-second timeout on RequestResponse invocations. You should use - // Event invocation in most cases. Use RequestResponse only when you want to - // make a mail flow decision, such as whether to stop the receipt rule or the - // receipt rule set. + // Event invocation in most cases. Use RequestResponse only to make a mail flow + // decision, such as whether to stop the receipt rule or the receipt rule set. InvocationType *string `type:"string" enum:"InvocationType"` // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the - // Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. + // Lambda action is executed. You can find the ARN of a topic by using the ListTopics + // (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) operation + // in Amazon SNS. + // // For more information about Amazon SNS topics, see the Amazon SNS Developer // Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). TopicArn *string `type:"string"` @@ -11008,9 +11050,9 @@ func (s *LambdaAction) SetTopicArn(v string) *LambdaAction { } // Represents a request to list the configuration sets associated with your -// AWS account. Configuration sets enable you to publish email sending events. -// For information about using configuration sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// Amazon Web Services account. Configuration sets enable you to publish email +// sending events. For information about using configuration sets, see the Amazon +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type ListConfigurationSetsInput struct { _ struct{} `type:"structure"` @@ -11052,9 +11094,9 @@ func (s *ListConfigurationSetsInput) SetNextToken(v string) *ListConfigurationSe return s } -// A list of configuration sets associated with your AWS account. Configuration -// sets enable you to publish email sending events. For information about using -// configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// A list of configuration sets associated with your Amazon Web Services account. +// Configuration sets enable you to publish email sending events. For information +// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type ListConfigurationSetsOutput struct { _ struct{} `type:"structure"` @@ -11100,7 +11142,7 @@ func (s *ListConfigurationSetsOutput) SetNextToken(v string) *ListConfigurationS // for your account. // // For more information about custom verification email templates, see Using -// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. type ListCustomVerificationEmailTemplatesInput struct { _ struct{} `type:"structure"` @@ -11108,7 +11150,7 @@ type ListCustomVerificationEmailTemplatesInput struct { // The maximum number of custom verification email templates to return. This // value must be at least 1 and less than or equal to 50. If you do not specify // a value, or if you specify a value less than 1 or greater than 50, the operation - // will return up to 50 results. + // returns up to 50 results. MaxResults *int64 `min:"1" type:"integer"` // An array the contains the name and creation time stamp for each template @@ -11203,13 +11245,13 @@ func (s *ListCustomVerificationEmailTemplatesOutput) SetNextToken(v string) *Lis } // Represents a request to return a list of all identities (email addresses -// and domains) that you have attempted to verify under your AWS account, regardless -// of verification status. +// and domains) that you have attempted to verify under your Amazon Web Services +// account, regardless of verification status. type ListIdentitiesInput struct { _ struct{} `type:"structure"` // The type of the identities to list. Possible values are "EmailAddress" and - // "Domain". If this parameter is omitted, then all identities will be listed. + // "Domain". If this parameter is omitted, then all identities are listed. IdentityType *string `type:"string" enum:"IdentityType"` // The maximum number of identities per page. Possible values are 1-1000 inclusive. @@ -11255,8 +11297,8 @@ func (s *ListIdentitiesInput) SetNextToken(v string) *ListIdentitiesInput { return s } -// A list of all identities that you have attempted to verify under your AWS -// account, regardless of verification status. +// A list of all identities that you have attempted to verify under your Amazon +// Web Services account, regardless of verification status. type ListIdentitiesOutput struct { _ struct{} `type:"structure"` @@ -11302,15 +11344,15 @@ func (s *ListIdentitiesOutput) SetNextToken(v string) *ListIdentitiesOutput { // Represents a request to return a list of sending authorization policies that // are attached to an identity. Sending authorization is an Amazon SES feature // that enables you to authorize other senders to use your identities. For information, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). type ListIdentityPoliciesInput struct { _ struct{} `type:"structure"` - // The identity that is associated with the policy for which the policies will - // be listed. You can specify an identity by using its name or by using its - // Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. + // The identity that is associated with the policy for which the policies are + // listed. You can specify an identity by using its name or by using its Amazon + // Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. // - // To successfully call this API, you must own the identity. + // To successfully call this operation, you must own the identity. // // Identity is a required field Identity *string `type:"string" required:"true"` @@ -11388,8 +11430,9 @@ func (s *ListIdentityPoliciesOutput) SetPolicyNames(v []*string) *ListIdentityPo } // Represents a request to list the IP address filters that exist under your -// AWS account. You use IP address filters when you receive email with Amazon -// SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// Amazon Web Services account. You use IP address filters when you receive +// email with Amazon SES. For more information, see the Amazon SES Developer +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type ListReceiptFiltersInput struct { _ struct{} `type:"structure"` } @@ -11412,7 +11455,7 @@ func (s ListReceiptFiltersInput) GoString() string { return s.String() } -// A list of IP address filters that exist under your AWS account. +// A list of IP address filters that exist under your Amazon Web Services account. type ListReceiptFiltersOutput struct { _ struct{} `type:"structure"` @@ -11446,8 +11489,8 @@ func (s *ListReceiptFiltersOutput) SetFilters(v []*ReceiptFilter) *ListReceiptFi } // Represents a request to list the receipt rule sets that exist under your -// AWS account. You use receipt rule sets to receive email with Amazon SES. -// For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// Amazon Web Services account. You use receipt rule sets to receive email with +// Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type ListReceiptRuleSetsInput struct { _ struct{} `type:"structure"` @@ -11480,7 +11523,7 @@ func (s *ListReceiptRuleSetsInput) SetNextToken(v string) *ListReceiptRuleSetsIn return s } -// A list of receipt rule sets that exist under your AWS account. +// A list of receipt rule sets that exist under your Amazon Web Services account. type ListReceiptRuleSetsOutput struct { _ struct{} `type:"structure"` @@ -11528,9 +11571,9 @@ type ListTemplatesInput struct { _ struct{} `type:"structure"` // The maximum number of templates to return. This value must be at least 1 - // and less than or equal to 10. If you do not specify a value, or if you specify - // a value less than 1 or greater than 10, the operation will return up to 10 - // results. + // and less than or equal to 100. If more than 100 items are requested, the + // page size will automatically set to 100. If you do not specify a value, 10 + // is the default page size. MaxItems *int64 `type:"integer"` // A token returned from a previous call to ListTemplates to indicate the position @@ -11573,7 +11616,7 @@ type ListTemplatesOutput struct { // A token indicating that there are additional email templates available to // be listed. Pass this token to a subsequent call to ListTemplates to retrieve - // the next 50 email templates. + // the next set of email templates within your page size. NextToken *string `type:"string"` // An array the contains the name and creation time stamp for each template @@ -11634,7 +11677,7 @@ func (s ListVerifiedEmailAddressesInput) GoString() string { } // A list of email addresses that you have verified with Amazon SES under your -// AWS account. +// Amazon Web Services account. type ListVerifiedEmailAddressesOutput struct { _ struct{} `type:"structure"` @@ -11675,7 +11718,7 @@ type Message struct { // Body is a required field Body *Body `type:"structure" required:"true"` - // The subject of the message: A short summary of the content, which will appear + // The subject of the message: A short summary of the content, which appears // in the recipient's inbox. // // Subject is a required field @@ -11742,7 +11785,7 @@ func (s *Message) SetSubject(v *Content) *Message { // (DSN) when an email that Amazon SES receives on your behalf bounces. // // For information about receiving email through Amazon SES, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html). type MessageDsn struct { _ struct{} `type:"structure"` @@ -11825,26 +11868,26 @@ func (s *MessageDsn) SetReportingMta(v string) *MessageDsn { // // Message tags, which you use with configuration sets, enable you to publish // email sending events. For information about using configuration sets, see -// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type MessageTag struct { _ struct{} `type:"structure"` - // The name of the tag. The name must: + // The name of the tag. The name must meet the following requirements: // - // * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), - // underscores (_), or dashes (-). + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // or dashes (-). // - // * Contain less than 256 characters. + // * Contain 256 characters or fewer. // // Name is a required field Name *string `type:"string" required:"true"` - // The value of the tag. The value must: + // The value of the tag. The value must meet the following requirements: // - // * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), - // underscores (_), or dashes (-). + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // or dashes (-). // - // * Contain less than 256 characters. + // * Contain 256 characters or fewer. // // Value is a required field Value *string `type:"string" required:"true"` @@ -11900,8 +11943,7 @@ func (s *MessageTag) SetValue(v string) *MessageTag { type PutConfigurationSetDeliveryOptionsInput struct { _ struct{} `type:"structure"` - // The name of the configuration set that you want to specify the delivery options - // for. + // The name of the configuration set. // // ConfigurationSetName is a required field ConfigurationSetName *string `type:"string" required:"true"` @@ -11981,15 +12023,15 @@ func (s PutConfigurationSetDeliveryOptionsOutput) GoString() string { // Represents a request to add or update a sending authorization policy for // an identity. Sending authorization is an Amazon SES feature that enables // you to authorize other senders to use your identities. For information, see -// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). type PutIdentityPolicyInput struct { _ struct{} `type:"structure"` - // The identity that the policy will apply to. You can specify an identity by - // using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, + // The identity to which that the policy applies. You can specify an identity + // by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, // example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. // - // To successfully call this API, you must own the identity. + // To successfully call this operation, you must own the identity. // // Identity is a required field Identity *string `type:"string" required:"true"` @@ -11997,7 +12039,7 @@ type PutIdentityPolicyInput struct { // The text of the policy in JSON format. The policy cannot exceed 4 KB. // // For information about the syntax of sending authorization policies, see the - // Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html). + // Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-policies.html). // // Policy is a required field Policy *string `min:"1" type:"string" required:"true"` @@ -12101,10 +12143,10 @@ type RawMessage struct { // The raw data of the message. This data needs to base64-encoded if you are // accessing Amazon SES directly through the HTTPS interface. If you are accessing - // Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for - // you. In all cases, the client must ensure that the message format complies - // with Internet email standards regarding email header fields, MIME types, - // and MIME encoding. + // Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base + // 64-encoding for you. In all cases, the client must ensure that the message + // format complies with Internet email standards regarding email header fields, + // MIME types, and MIME encoding. // // The To:, CC:, and BCC: headers in the raw message can contain a group list. // @@ -12115,7 +12157,7 @@ type RawMessage struct { // Do not include these X-headers in the DKIM signature, because they are removed // by Amazon SES before sending the email. // - // For more information, go to the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html). + // For more information, go to the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html). // Data is automatically base64 encoded/decoded by the SDK. // // Data is a required field @@ -12164,7 +12206,7 @@ func (s *RawMessage) SetData(v []byte) *RawMessage { // data type can represent only one action. // // For information about setting up receipt rules, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). type ReceiptAction struct { _ struct{} `type:"structure"` @@ -12176,8 +12218,8 @@ type ReceiptAction struct { // (Amazon SNS). BounceAction *BounceAction `type:"structure"` - // Calls an AWS Lambda function, and optionally, publishes a notification to - // Amazon SNS. + // Calls an Amazon Web Services Lambda function, and optionally, publishes a + // notification to Amazon SNS. LambdaAction *LambdaAction `type:"structure"` // Saves the received message to an Amazon Simple Storage Service (Amazon S3) @@ -12305,7 +12347,7 @@ func (s *ReceiptAction) SetWorkmailAction(v *WorkmailAction) *ReceiptAction { // mail originating from an IP address or range of IP addresses. // // For information about setting up IP address filters, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html). type ReceiptFilter struct { _ struct{} `type:"structure"` @@ -12315,14 +12357,14 @@ type ReceiptFilter struct { // IpFilter is a required field IpFilter *ReceiptIpFilter `type:"structure" required:"true"` - // The name of the IP address filter. The name must: + // The name of the IP address filter. The name must meet the following requirements: // - // * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), - // underscores (_), or dashes (-). + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // or dashes (-). // // * Start and end with a letter or number. // - // * Contain less than 64 characters. + // * Contain 64 characters or fewer. // // Name is a required field Name *string `type:"string" required:"true"` @@ -12383,14 +12425,14 @@ func (s *ReceiptFilter) SetName(v string) *ReceiptFilter { // mail originating from an IP address or range of IP addresses. // // For information about setting up IP address filters, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html). type ReceiptIpFilter struct { _ struct{} `type:"structure"` - // A single IP address or a range of IP addresses that you want to block or - // allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example - // of a single email address is 10.0.0.1. An example of a range of IP addresses - // is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317 (https://tools.ietf.org/html/rfc2317). + // A single IP address or a range of IP addresses to block or allow, specified + // in Classless Inter-Domain Routing (CIDR) notation. An example of a single + // email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. + // For more information about CIDR notation, see RFC 2317 (https://tools.ietf.org/html/rfc2317). // // Cidr is a required field Cidr *string `type:"string" required:"true"` @@ -12457,7 +12499,7 @@ func (s *ReceiptIpFilter) SetPolicy(v string) *ReceiptIpFilter { // the message. // // For information about setting up receipt rules, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). type ReceiptRule struct { _ struct{} `type:"structure"` @@ -12468,21 +12510,21 @@ type ReceiptRule struct { // If true, the receipt rule is active. The default value is false. Enabled *bool `type:"boolean"` - // The name of the receipt rule. The name must: + // The name of the receipt rule. The name must meet the following requirements: // - // * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), - // underscores (_), or dashes (-). + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // dashes (-), or periods (.). // // * Start and end with a letter or number. // - // * Contain less than 64 characters. + // * Contain 64 characters or fewer. // // Name is a required field Name *string `type:"string" required:"true"` // The recipient domains and email addresses that the receipt rule applies to. - // If this field is not specified, this rule will match all recipients under - // all verified domains. + // If this field is not specified, this rule matches all recipients on all verified + // domains. Recipients []*string `type:"list"` // If true, then messages that this receipt rule applies to are scanned for @@ -12491,7 +12533,7 @@ type ReceiptRule struct { // Specifies whether Amazon SES should require that incoming email is delivered // over a connection encrypted with Transport Layer Security (TLS). If this - // parameter is set to Require, Amazon SES will bounce emails that are not received + // parameter is set to Require, Amazon SES bounces emails that are not received // over TLS. The default is Optional. TlsPolicy *string `type:"string" enum:"TlsPolicy"` } @@ -12579,21 +12621,21 @@ func (s *ReceiptRule) SetTlsPolicy(v string) *ReceiptRule { // should do with mail it receives on behalf of your account's verified domains. // // For information about setting up receipt rule sets, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules). type ReceiptRuleSetMetadata struct { _ struct{} `type:"structure"` // The date and time the receipt rule set was created. CreatedTimestamp *time.Time `type:"timestamp"` - // The name of the receipt rule set. The name must: + // The name of the receipt rule set. The name must meet the following requirements: // - // * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), - // underscores (_), or dashes (-). + // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // or dashes (-). // // * Start and end with a letter or number. // - // * Contain less than 64 characters. + // * Contain 64 characters or fewer. Name *string `type:"string"` } @@ -12631,7 +12673,7 @@ func (s *ReceiptRuleSetMetadata) SetName(v string) *ReceiptRuleSetMetadata { // (DSN) when an email that Amazon SES receives on your behalf bounces. // // For information about receiving email through Amazon SES, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html). type RecipientDsnFields struct { _ struct{} `type:"structure"` @@ -12651,10 +12693,10 @@ type RecipientDsnFields struct { ExtensionFields []*ExtensionField `type:"list"` // The email address that the message was ultimately delivered to. This corresponds - // to the Final-Recipient in the DSN. If not specified, FinalRecipient will - // be set to the Recipient specified in the BouncedRecipientInfo structure. - // Either FinalRecipient or the recipient in BouncedRecipientInfo must be a - // recipient of the original bounced message. + // to the Final-Recipient in the DSN. If not specified, FinalRecipient is set + // to the Recipient specified in the BouncedRecipientInfo structure. Either + // FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient + // of the original bounced message. // // Do not prepend the FinalRecipient email address with rfc 822;, as described // in RFC 3798 (https://tools.ietf.org/html/rfc3798). @@ -12765,12 +12807,11 @@ func (s *RecipientDsnFields) SetStatus(v string) *RecipientDsnFields { // Represents a request to reorder the receipt rules within a receipt rule set. // You use receipt rule sets to receive email with Amazon SES. For more information, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type ReorderReceiptRuleSetInput struct { _ struct{} `type:"structure"` - // A list of the specified receipt rule set's receipt rules in the order that - // you want to put them. + // The specified receipt rule set's receipt rules, in order. // // RuleNames is a required field RuleNames []*string `type:"list" required:"true"` @@ -12873,10 +12914,10 @@ type ReputationOptions struct { ReputationMetricsEnabled *bool `type:"boolean"` // Describes whether email sending is enabled or disabled for the configuration - // set. If the value is true, then Amazon SES will send emails that use the - // configuration set. If the value is false, Amazon SES will not send emails - // that use the configuration set. The default value is true. You can change - // this setting using UpdateConfigurationSetSendingEnabled. + // set. If the value is true, then Amazon SES sends emails that use the configuration + // set. If the value is false, Amazon SES does not send emails that use the + // configuration set. The default value is true. You can change this setting + // using UpdateConfigurationSetSendingEnabled. SendingEnabled *bool `type:"boolean"` } @@ -12920,53 +12961,57 @@ func (s *ReputationOptions) SetSendingEnabled(v bool) *ReputationOptions { // an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes // a notification to Amazon Simple Notification Service (Amazon SNS). // -// To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS -// KMS key to encrypt your emails, or publish to an Amazon SNS topic of another -// account, Amazon SES must have permission to access those resources. For information -// about giving permissions, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). +// To enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon +// Web Services KMS key to encrypt your emails, or publish to an Amazon SNS +// topic of another account, Amazon SES must have permission to access those +// resources. For information about granting permissions, see the Amazon SES +// Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html). // // When you save your emails to an Amazon S3 bucket, the maximum email size -// (including headers) is 30 MB. Emails larger than that will bounce. +// (including headers) is 40 MB. Emails larger than that bounces. // // For information about specifying Amazon S3 actions in receipt rules, see -// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-s3.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html). type S3Action struct { _ struct{} `type:"structure"` - // The name of the Amazon S3 bucket that incoming email will be saved to. + // The name of the Amazon S3 bucket for incoming email. // // BucketName is a required field BucketName *string `type:"string" required:"true"` // The customer master key that Amazon SES should use to encrypt your emails // before saving them to the Amazon S3 bucket. You can use the default master - // key or a custom master key you created in AWS KMS as follows: + // key or a custom master key that you created in Amazon Web Services KMS as + // follows: // // * To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. - // For example, if your AWS account ID is 123456789012 and you want to use - // the default master key in the US West (Oregon) region, the ARN of the - // default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. + // For example, if your Amazon Web Services account ID is 123456789012 and + // you want to use the default master key in the US West (Oregon) Region, + // the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. // If you use the default master key, you don't need to perform any extra // steps to give Amazon SES permission to use the key. // - // * To use a custom master key you created in AWS KMS, provide the ARN of - // the master key and ensure that you add a statement to your key's policy - // to give Amazon SES permission to use it. For more information about giving - // permissions, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). + // * To use a custom master key that you created in Amazon Web Services KMS, + // provide the ARN of the master key and ensure that you add a statement + // to your key's policy to give Amazon SES permission to use it. For more + // information about giving permissions, see the Amazon SES Developer Guide + // (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html). // - // For more information about key policies, see the AWS KMS Developer Guide - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html). If - // you do not specify a master key, Amazon SES will not encrypt your emails. + // For more information about key policies, see the Amazon Web Services KMS + // Developer Guide (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html). + // If you do not specify a master key, Amazon SES does not encrypt your emails. // // Your mail is encrypted by Amazon SES using the Amazon S3 encryption client // before the mail is submitted to Amazon S3 for storage. It is not encrypted // using Amazon S3 server-side encryption. This means that you must use the // Amazon S3 encryption client to decrypt the email after retrieving it from - // Amazon S3, as the service has no access to use your AWS KMS keys for decryption. - // This encryption client is currently available with the AWS SDK for Java (http://aws.amazon.com/sdk-for-java/) - // and AWS SDK for Ruby (http://aws.amazon.com/sdk-for-ruby/) only. For more - // information about client-side encryption using AWS KMS master keys, see the - // Amazon S3 Developer Guide (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html). + // Amazon S3, as the service has no access to use your Amazon Web Services KMS + // keys for decryption. This encryption client is currently available with the + // Amazon Web Services SDK for Java (http://aws.amazon.com/sdk-for-java/) and + // Amazon Web Services SDK for Ruby (http://aws.amazon.com/sdk-for-ruby/) only. + // For more information about client-side encryption using Amazon Web Services + // KMS master keys, see the Amazon S3 Developer Guide (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html). KmsKeyArn *string `type:"string"` // The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory @@ -12975,7 +13020,10 @@ type S3Action struct { ObjectKeyPrefix *string `type:"string"` // The ARN of the Amazon SNS topic to notify when the message is saved to the - // Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. + // Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics + // (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) operation + // in Amazon SNS. + // // For more information about Amazon SNS topics, see the Amazon SNS Developer // Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). TopicArn *string `type:"string"` @@ -13046,14 +13094,14 @@ func (s *S3Action) SetTopicArn(v string) *S3Action { // SES permission to publish emails to it. However, if you don't own the Amazon // SNS topic, you need to attach a policy to the topic to give Amazon SES permissions // to access it. For information about giving permissions, see the Amazon SES -// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html). // // You can only publish emails that are 150 KB or less (including the header) -// to Amazon SNS. Larger emails will bounce. If you anticipate emails larger -// than 150 KB, use the S3 action instead. +// to Amazon SNS. Larger emails bounce. If you anticipate emails larger than +// 150 KB, use the S3 action instead. // // For information about using a receipt rule to publish an Amazon SNS notification, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-sns.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-sns.html). type SNSAction struct { _ struct{} `type:"structure"` @@ -13063,8 +13111,10 @@ type SNSAction struct { // characters. The default value is UTF-8. Encoding *string `type:"string" enum:"SNSActionEncoding"` - // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example - // of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. + // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can + // find the ARN of a topic by using the ListTopics (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) + // operation in Amazon SNS. + // // For more information about Amazon SNS topics, see the Amazon SNS Developer // Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). // @@ -13120,12 +13170,14 @@ func (s *SNSAction) SetTopicArn(v string) *SNSAction { // // Event destinations, such as Amazon SNS, are associated with configuration // sets, which enable you to publish email sending events. For information about -// using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type SNSDestination struct { _ struct{} `type:"structure"` - // The ARN of the Amazon SNS topic that email sending events will be published - // to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. + // The ARN of the Amazon SNS topic for email sending events. You can find the + // ARN of a topic by using the ListTopics (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) + // Amazon SNS operation. + // // For more information about Amazon SNS topics, see the Amazon SNS Developer // Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). // @@ -13184,7 +13236,7 @@ type SendBounceInput struct { // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to use the address in the "From" header of the bounce. For more information - // about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). BounceSenderArn *string `type:"string"` // A list of recipients of the bounced message, including the information required @@ -13195,12 +13247,10 @@ type SendBounceInput struct { BouncedRecipientInfoList []*BouncedRecipientInfo `type:"list" required:"true"` // Human-readable text for the bounce message to explain the failure. If not - // specified, the text will be auto-generated based on the bounced recipient - // information. + // specified, the text is auto-generated based on the bounced recipient information. Explanation *string `type:"string"` - // Message-related DSN fields. If not specified, Amazon SES will choose the - // values. + // Message-related DSN fields. If not specified, Amazon SES chooses the values. MessageDsn *MessageDsn `type:"structure"` // The message ID of the message to be bounced. @@ -13330,7 +13380,7 @@ func (s *SendBounceOutput) SetMessageId(v string) *SendBounceOutput { } // Represents a request to send a templated email to multiple destinations using -// Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html). type SendBulkTemplatedEmailInput struct { _ struct{} `type:"structure"` @@ -13349,21 +13399,21 @@ type SendBulkTemplatedEmailInput struct { // in which the keys correspond to replacement tags in the email template. DefaultTemplateData *string `type:"string"` - // One or more Destination objects. All of the recipients in a Destination will - // receive the same version of the email. You can specify up to 50 Destination - // objects within a Destinations array. + // One or more Destination objects. All of the recipients in a Destination receive + // the same version of the email. You can specify up to 50 Destination objects + // within a Destinations array. // // Destinations is a required field Destinations []*BulkEmailDestination `type:"list" required:"true"` // The reply-to email address(es) for the message. If the recipient replies - // to the message, each reply-to address will receive the reply. + // to the message, each reply-to address receives the reply. ReplyToAddresses []*string `type:"list"` - // The email address that bounces and complaints will be forwarded to when feedback + // The email address that bounces and complaints are forwarded to when feedback // forwarding is enabled. If the message cannot be delivered to the recipient, - // then an error message will be returned from the recipient's ISP; this message - // will then be forwarded to the email address specified by the ReturnPath parameter. + // then an error message is returned from the recipient's ISP; this message + // is forwarded to the email address specified by the ReturnPath parameter. // The ReturnPath parameter is never overwritten. This email address must be // either individually verified with Amazon SES, or from a domain that has been // verified with Amazon SES. @@ -13379,29 +13429,29 @@ type SendBulkTemplatedEmailInput struct { // and the ReturnPath to be feedback@example.com. // // For more information about sending authorization, see the Amazon SES Developer - // Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). ReturnPathArn *string `type:"string"` // The email address that is sending the email. This email address must be either // individually verified with Amazon SES, or from a domain that has been verified // with Amazon SES. For information about verifying identities, see the Amazon - // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html). // // If you are sending on behalf of another user and have been permitted to do // so by a sending authorization policy, then you must also specify the SourceArn // parameter. For more information about sending authorization, see the Amazon - // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). // // Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 - // (https://tools.ietf.org/html/rfc6531). For this reason, the local part of - // a source email address (the part of the email address that precedes the @ - // sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part). - // If the domain part of an address (the part after the @ sign) contains non-ASCII - // characters, they must be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as - // the friendly name) may contain non-ASCII characters. These characters must - // be encoded using MIME encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047). - // MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. + // (https://tools.ietf.org/html/rfc6531). For this reason, the email address + // string must be 7-bit ASCII. If you want to send to or from email addresses + // that contain Unicode characters in the domain part of an address, you must + // encode the domain using Punycode. Punycode is not permitted in the local + // part of the email address (the part before the @ sign) nor in the "friendly + // from" name. If you want to use Unicode characters in the "friendly from" + // name, you must encode the "friendly from" name using MIME encoded-word syntax, + // as described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html). + // For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492). // // Source is a required field Source *string `type:"string" required:"true"` @@ -13416,7 +13466,7 @@ type SendBulkTemplatedEmailInput struct { // and the Source to be user@example.com. // // For more information about sending authorization, see the Amazon SES Developer - // Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). SourceArn *string `type:"string"` // The template to use when sending this email. @@ -13554,7 +13604,10 @@ func (s *SendBulkTemplatedEmailInput) SetTemplateArn(v string) *SendBulkTemplate type SendBulkTemplatedEmailOutput struct { _ struct{} `type:"structure"` - // The unique message identifier returned from the SendBulkTemplatedEmail action. + // One object per intended recipient. Check each response object and retry any + // messages with a failure status. (Note that order of responses will be respective + // to order of destinations in the request.)Receipt rules enable you to specify + // which actions // // Status is a required field Status []*BulkEmailDestinationStatus `type:"list" required:"true"` @@ -13758,7 +13811,7 @@ func (s *SendDataPoint) SetTimestamp(v time.Time) *SendDataPoint { } // Represents a request to send a single formatted email using Amazon SES. For -// more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html). +// more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-email-formatted.html). type SendEmailInput struct { _ struct{} `type:"structure"` @@ -13776,13 +13829,13 @@ type SendEmailInput struct { Message *Message `type:"structure" required:"true"` // The reply-to email address(es) for the message. If the recipient replies - // to the message, each reply-to address will receive the reply. + // to the message, each reply-to address receives the reply. ReplyToAddresses []*string `type:"list"` - // The email address that bounces and complaints will be forwarded to when feedback + // The email address that bounces and complaints are forwarded to when feedback // forwarding is enabled. If the message cannot be delivered to the recipient, - // then an error message will be returned from the recipient's ISP; this message - // will then be forwarded to the email address specified by the ReturnPath parameter. + // then an error message is returned from the recipient's ISP; this message + // is forwarded to the email address specified by the ReturnPath parameter. // The ReturnPath parameter is never overwritten. This email address must be // either individually verified with Amazon SES, or from a domain that has been // verified with Amazon SES. @@ -13798,29 +13851,29 @@ type SendEmailInput struct { // and the ReturnPath to be feedback@example.com. // // For more information about sending authorization, see the Amazon SES Developer - // Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). ReturnPathArn *string `type:"string"` // The email address that is sending the email. This email address must be either // individually verified with Amazon SES, or from a domain that has been verified // with Amazon SES. For information about verifying identities, see the Amazon - // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html). // // If you are sending on behalf of another user and have been permitted to do // so by a sending authorization policy, then you must also specify the SourceArn // parameter. For more information about sending authorization, see the Amazon - // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). // // Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 - // (https://tools.ietf.org/html/rfc6531). For this reason, the local part of - // a source email address (the part of the email address that precedes the @ - // sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part). - // If the domain part of an address (the part after the @ sign) contains non-ASCII - // characters, they must be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as - // the friendly name) may contain non-ASCII characters. These characters must - // be encoded using MIME encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047). - // MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. + // (https://tools.ietf.org/html/rfc6531). For this reason, the email address + // string must be 7-bit ASCII. If you want to send to or from email addresses + // that contain Unicode characters in the domain part of an address, you must + // encode the domain using Punycode. Punycode is not permitted in the local + // part of the email address (the part before the @ sign) nor in the "friendly + // from" name. If you want to use Unicode characters in the "friendly from" + // name, you must encode the "friendly from" name using MIME encoded-word syntax, + // as described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html). + // For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492). // // Source is a required field Source *string `type:"string" required:"true"` @@ -13835,7 +13888,7 @@ type SendEmailInput struct { // and the Source to be user@example.com. // // For more information about sending authorization, see the Amazon SES Developer - // Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). SourceArn *string `type:"string"` // A list of tags, in the form of name/value pairs, to apply to an email that @@ -13985,7 +14038,7 @@ func (s *SendEmailOutput) SetMessageId(v string) *SendEmailOutput { } // Represents a request to send a single raw email using Amazon SES. For more -// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html). type SendRawEmailInput struct { _ struct{} `type:"structure"` @@ -14005,7 +14058,7 @@ type SendRawEmailInput struct { // the corresponding X-header, Amazon SES uses the value of the FromArn parameter. // // For information about when to use this parameter, see the description of - // SendRawEmail in this guide, or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html). + // SendRawEmail in this guide, or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html). FromArn *string `type:"string"` // The raw email message itself. The message has to meet the following criteria: @@ -14019,14 +14072,14 @@ type SendRawEmailInput struct { // // * Attachments must be of a content type that Amazon SES supports. For // a list on unsupported content types, see Unsupported Attachment Types - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types.html) - // in the Amazon SES Developer Guide. + // (https://docs.aws.amazon.com/ses/latest/dg/mime-types.html) in the Amazon + // SES Developer Guide. // // * The entire message must be base64-encoded. // // * If any of the MIME parts in your message contain content that is outside // of the 7-bit ASCII character range, we highly recommend that you encode - // that content. For more information, see Sending Raw Email (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html) + // that content. For more information, see Sending Raw Email (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html) // in the Amazon SES Developer Guide. // // * Per RFC 5321 (https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6), @@ -14051,7 +14104,7 @@ type SendRawEmailInput struct { // parameter. // // For information about when to use this parameter, see the description of - // SendRawEmail in this guide, or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html). + // SendRawEmail in this guide, or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html). ReturnPathArn *string `type:"string"` // The identity's email address. If you do not provide a value for this parameter, @@ -14059,20 +14112,20 @@ type SendRawEmailInput struct { // also specify both.) // // Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531 - // (https://tools.ietf.org/html/rfc6531). For this reason, the local part of - // a source email address (the part of the email address that precedes the @ - // sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part). - // If the domain part of an address (the part after the @ sign) contains non-ASCII - // characters, they must be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as - // the friendly name) may contain non-ASCII characters. These characters must - // be encoded using MIME encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047). - // MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. + // (https://tools.ietf.org/html/rfc6531). For this reason, the email address + // string must be 7-bit ASCII. If you want to send to or from email addresses + // that contain Unicode characters in the domain part of an address, you must + // encode the domain using Punycode. Punycode is not permitted in the local + // part of the email address (the part before the @ sign) nor in the "friendly + // from" name. If you want to use Unicode characters in the "friendly from" + // name, you must encode the "friendly from" name using MIME encoded-word syntax, + // as described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html). + // For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492). // // If you specify the Source parameter and have feedback forwarding enabled, - // then bounces and complaints will be sent to this email address. This takes - // precedence over any Return-Path header that you might include in the raw - // text of the message. + // then bounces and complaints are sent to this email address. This takes precedence + // over any Return-Path header that you might include in the raw text of the + // message. Source *string `type:"string"` // This parameter is used only for sending authorization. It is the ARN of the @@ -14090,7 +14143,7 @@ type SendRawEmailInput struct { // parameter. // // For information about when to use this parameter, see the description of - // SendRawEmail in this guide, or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html). + // SendRawEmail in this guide, or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html). SourceArn *string `type:"string"` // A list of tags, in the form of name/value pairs, to apply to an email that @@ -14228,7 +14281,7 @@ func (s *SendRawEmailOutput) SetMessageId(v string) *SendRawEmailOutput { } // Represents a request to send a templated email using Amazon SES. For more -// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html). type SendTemplatedEmailInput struct { _ struct{} `type:"structure"` @@ -14242,13 +14295,13 @@ type SendTemplatedEmailInput struct { Destination *Destination `type:"structure" required:"true"` // The reply-to email address(es) for the message. If the recipient replies - // to the message, each reply-to address will receive the reply. + // to the message, each reply-to address receives the reply. ReplyToAddresses []*string `type:"list"` - // The email address that bounces and complaints will be forwarded to when feedback + // The email address that bounces and complaints are forwarded to when feedback // forwarding is enabled. If the message cannot be delivered to the recipient, - // then an error message will be returned from the recipient's ISP; this message - // will then be forwarded to the email address specified by the ReturnPath parameter. + // then an error message is returned from the recipient's ISP; this message + // is forwarded to the email address specified by the ReturnPath parameter. // The ReturnPath parameter is never overwritten. This email address must be // either individually verified with Amazon SES, or from a domain that has been // verified with Amazon SES. @@ -14264,29 +14317,29 @@ type SendTemplatedEmailInput struct { // and the ReturnPath to be feedback@example.com. // // For more information about sending authorization, see the Amazon SES Developer - // Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). ReturnPathArn *string `type:"string"` // The email address that is sending the email. This email address must be either // individually verified with Amazon SES, or from a domain that has been verified // with Amazon SES. For information about verifying identities, see the Amazon - // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html). // // If you are sending on behalf of another user and have been permitted to do // so by a sending authorization policy, then you must also specify the SourceArn // parameter. For more information about sending authorization, see the Amazon - // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). // // Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 - // (https://tools.ietf.org/html/rfc6531). For this reason, the local part of - // a source email address (the part of the email address that precedes the @ - // sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part). - // If the domain part of an address (the part after the @ sign) contains non-ASCII - // characters, they must be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as - // the friendly name) may contain non-ASCII characters. These characters must - // be encoded using MIME encoded-word syntax, as described inRFC 2047 (https://tools.ietf.org/html/rfc2047). - // MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. + // (https://tools.ietf.org/html/rfc6531). for this reason, The email address + // string must be 7-bit ASCII. If you want to send to or from email addresses + // that contain Unicode characters in the domain part of an address, you must + // encode the domain using Punycode. Punycode is not permitted in the local + // part of the email address (the part before the @ sign) nor in the "friendly + // from" name. If you want to use Unicode characters in the "friendly from" + // name, you must encode the "friendly from" name using MIME encoded-word syntax, + // as described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html). + // For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492). // // Source is a required field Source *string `type:"string" required:"true"` @@ -14301,7 +14354,7 @@ type SendTemplatedEmailInput struct { // and the Source to be user@example.com. // // For more information about sending authorization, see the Amazon SES Developer - // Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // Guide (https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html). SourceArn *string `type:"string"` // A list of tags, in the form of name/value pairs, to apply to an email that @@ -14476,7 +14529,7 @@ func (s *SendTemplatedEmailOutput) SetMessageId(v string) *SendTemplatedEmailOut // Represents a request to set a receipt rule set as the active receipt rule // set. You use receipt rule sets to receive email with Amazon SES. For more -// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type SetActiveReceiptRuleSetInput struct { _ struct{} `type:"structure"` @@ -14534,7 +14587,7 @@ func (s SetActiveReceiptRuleSetOutput) GoString() string { // Represents a request to enable or disable Amazon SES Easy DKIM signing for // an identity. For more information about setting up Easy DKIM, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html). type SetIdentityDkimEnabledInput struct { _ struct{} `type:"structure"` @@ -14621,14 +14674,14 @@ func (s SetIdentityDkimEnabledOutput) GoString() string { // Represents a request to enable or disable whether Amazon SES forwards you // bounce and complaint notifications through email. For information about email -// feedback forwarding, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-email.html). +// feedback forwarding, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-email.html). type SetIdentityFeedbackForwardingEnabledInput struct { _ struct{} `type:"structure"` - // Sets whether Amazon SES will forward bounce and complaint notifications as - // email. true specifies that Amazon SES will forward bounce and complaint notifications + // Sets whether Amazon SES forwards bounce and complaint notifications as email. + // true specifies that Amazon SES forwards bounce and complaint notifications // as email, in addition to any Amazon SNS topic publishing otherwise specified. - // false specifies that Amazon SES will publish bounce and complaint notifications + // false specifies that Amazon SES publishes bounce and complaint notifications // only through Amazon SNS. This value can only be set to false when Amazon // SNS topics are set for both Bounce and Complaint notification types. // @@ -14713,14 +14766,14 @@ func (s SetIdentityFeedbackForwardingEnabledOutput) GoString() string { // Represents a request to set whether Amazon SES includes the original email // headers in the Amazon SNS notifications of a specified type. For information -// about notifications, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html). +// about notifications, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-sns.html). type SetIdentityHeadersInNotificationsEnabledInput struct { _ struct{} `type:"structure"` // Sets whether Amazon SES includes the original email headers in Amazon SNS // notifications of the specified notification type. A value of true specifies - // that Amazon SES will include headers in notifications, and a value of false - // specifies that Amazon SES will not include headers in notifications. + // that Amazon SES includes headers in notifications, and a value of false specifies + // that Amazon SES does not include headers in notifications. // // This value can only be set when NotificationType is already set to use a // particular Amazon SNS topic. @@ -14820,31 +14873,29 @@ func (s SetIdentityHeadersInNotificationsEnabledOutput) GoString() string { // Represents a request to enable or disable the Amazon SES custom MAIL FROM // domain setup for a verified identity. For information about using a custom -// MAIL FROM domain, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html). +// MAIL FROM domain, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/mail-from.html). type SetIdentityMailFromDomainInput struct { _ struct{} `type:"structure"` - // The action that you want Amazon SES to take if it cannot successfully read - // the required MX record when you send an email. If you choose UseDefaultValue, - // Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM - // domain. If you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified - // error and not send the email. + // The action for Amazon SES to take if it cannot successfully read the required + // MX record when you send an email. If you choose UseDefaultValue, Amazon SES + // uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you + // choose RejectMessage, Amazon SES returns a MailFromDomainNotVerified error + // and not send the email. // // The action specified in BehaviorOnMXFailure is taken when the custom MAIL // FROM domain setup is in the Pending, Failed, and TemporaryFailure states. BehaviorOnMXFailure *string `type:"string" enum:"BehaviorOnMXFailure"` - // The verified identity for which you want to enable or disable the specified - // custom MAIL FROM domain. + // The verified identity. // // Identity is a required field Identity *string `type:"string" required:"true"` - // The custom MAIL FROM domain that you want the verified identity to use. The - // MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not - // be used in a "From" address if the MAIL FROM domain is the destination of - // email feedback forwarding (for more information, see the Amazon SES Developer - // Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html)), + // The custom MAIL FROM domain for the verified identity to use. The MAIL FROM + // domain must 1) be a subdomain of the verified identity, 2) not be used in + // a "From" address if the MAIL FROM domain is the destination of email feedback + // forwarding (for more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/mail-from.html)), // and 3) not be used to receive emails. A value of null disables the custom // MAIL FROM setting for the identity. MailFromDomain *string `type:"string"` @@ -14923,14 +14974,13 @@ func (s SetIdentityMailFromDomainOutput) GoString() string { } // Represents a request to specify the Amazon SNS topic to which Amazon SES -// will publish bounce, complaint, or delivery notifications for emails sent -// with that identity as the Source. For information about Amazon SES notifications, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html). +// publishes bounce, complaint, or delivery notifications for emails sent with +// that identity as the source. For information about Amazon SES notifications, +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-sns.html). type SetIdentityNotificationTopicInput struct { _ struct{} `type:"structure"` - // The identity (email address or domain) that you want to set the Amazon SNS - // topic for. + // The identity (email address or domain) for the Amazon SNS topic. // // You can only specify a verified identity for this parameter. // @@ -14941,8 +14991,8 @@ type SetIdentityNotificationTopicInput struct { // Identity is a required field Identity *string `type:"string" required:"true"` - // The type of notifications that will be published to the specified Amazon - // SNS topic. + // The type of notifications that are published to the specified Amazon SNS + // topic. // // NotificationType is a required field NotificationType *string `type:"string" required:"true" enum:"NotificationType"` @@ -15030,7 +15080,7 @@ func (s SetIdentityNotificationTopicOutput) GoString() string { // Represents a request to set the position of a receipt rule in a receipt rule // set. You use receipt rule sets to receive email with Amazon SES. For more -// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type SetReceiptRulePositionInput struct { _ struct{} `type:"structure"` @@ -15128,7 +15178,7 @@ func (s SetReceiptRulePositionOutput) GoString() string { // Simple Notification Service (Amazon SNS). // // For information about setting a stop action in a receipt rule, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-stop.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-stop.html). type StopAction struct { _ struct{} `type:"structure"` @@ -15138,7 +15188,10 @@ type StopAction struct { Scope *string `type:"string" required:"true" enum:"StopScope"` // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the - // stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. + // stop action is taken. You can find the ARN of a topic by using the ListTopics + // (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) Amazon SNS + // operation. + // // For more information about Amazon SNS topics, see the Amazon SNS Developer // Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). TopicArn *string `type:"string"` @@ -15187,8 +15240,8 @@ func (s *StopAction) SetTopicArn(v string) *StopAction { return s } -// The content of the email, composed of a subject line, an HTML part, and a -// text-only part. +// The content of the email, composed of a subject line and either an HTML part +// or a text-only part. type Template struct { _ struct{} `type:"structure"` @@ -15198,14 +15251,14 @@ type Template struct { // The subject line of the email. SubjectPart *string `type:"string"` - // The name of the template. You will refer to this name when you send email - // using the SendTemplatedEmail or SendBulkTemplatedEmail operations. + // The name of the template. You use this name when you send email using the + // SendTemplatedEmail or SendBulkTemplatedEmail operations. // // TemplateName is a required field TemplateName *string `type:"string" required:"true"` - // The email body that will be visible to recipients whose email clients do - // not display HTML. + // The email body that is visible to recipients whose email clients do not display + // HTML content. TextPart *string `type:"string"` } @@ -15315,7 +15368,7 @@ type TestRenderTemplateInput struct { // TemplateData is a required field TemplateData *string `type:"string" required:"true"` - // The name of the template that you want to render. + // The name of the template to render. // // TemplateName is a required field TemplateName *string `type:"string" required:"true"` @@ -15404,13 +15457,13 @@ func (s *TestRenderTemplateOutput) SetRenderedTemplate(v string) *TestRenderTemp // emails. // // For more information, see Configuring Custom Domains to Handle Open and Click -// Tracking (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) +// Tracking (https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html) // in the Amazon SES Developer Guide. type TrackingOptions struct { _ struct{} `type:"structure"` - // The custom subdomain that will be used to redirect email recipients to the - // Amazon SES event tracking domain. + // The custom subdomain that is used to redirect email recipients to the Amazon + // SES event tracking domain. CustomRedirectDomain *string `type:"string"` } @@ -15444,7 +15497,7 @@ type UpdateAccountSendingEnabledInput struct { _ struct{} `type:"structure"` // Describes whether email sending is enabled or disabled for your Amazon SES - // account in the current AWS Region. + // account in the current Amazon Web Services Region. Enabled *bool `type:"boolean"` } @@ -15496,18 +15549,16 @@ func (s UpdateAccountSendingEnabledOutput) GoString() string { // Represents a request to update the event destination of a configuration set. // Configuration sets enable you to publish email sending events. For information -// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html). type UpdateConfigurationSetEventDestinationInput struct { _ struct{} `type:"structure"` - // The name of the configuration set that contains the event destination that - // you want to update. + // The name of the configuration set that contains the event destination. // // ConfigurationSetName is a required field ConfigurationSetName *string `type:"string" required:"true"` - // The event destination object that you want to apply to the specified configuration - // set. + // The event destination object. // // EventDestination is a required field EventDestination *EventDestination `type:"structure" required:"true"` @@ -15592,12 +15643,12 @@ func (s UpdateConfigurationSetEventDestinationOutput) GoString() string { type UpdateConfigurationSetReputationMetricsEnabledInput struct { _ struct{} `type:"structure"` - // The name of the configuration set that you want to update. + // The name of the configuration set to update. // // ConfigurationSetName is a required field ConfigurationSetName *string `type:"string" required:"true"` - // Describes whether or not Amazon SES will publish reputation metrics for the + // Describes whether or not Amazon SES publishes reputation metrics for the // configuration set, such as bounce and complaint rates, to Amazon CloudWatch. // // Enabled is a required field @@ -15677,7 +15728,7 @@ func (s UpdateConfigurationSetReputationMetricsEnabledOutput) GoString() string type UpdateConfigurationSetSendingEnabledInput struct { _ struct{} `type:"structure"` - // The name of the configuration set that you want to update. + // The name of the configuration set to update. // // ConfigurationSetName is a required field ConfigurationSetName *string `type:"string" required:"true"` @@ -15761,8 +15812,7 @@ func (s UpdateConfigurationSetSendingEnabledOutput) GoString() string { type UpdateConfigurationSetTrackingOptionsInput struct { _ struct{} `type:"structure"` - // The name of the configuration set for which you want to update the custom - // tracking domain. + // The name of the configuration set. // // ConfigurationSetName is a required field ConfigurationSetName *string `type:"string" required:"true"` @@ -15772,7 +15822,7 @@ type UpdateConfigurationSetTrackingOptionsInput struct { // emails. // // For more information, see Configuring Custom Domains to Handle Open and Click - // Tracking (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) + // Tracking (https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html) // in the Amazon SES Developer Guide. // // TrackingOptions is a required field @@ -15866,11 +15916,11 @@ type UpdateCustomVerificationEmailTemplateInput struct { // The content of the custom verification email. The total size of the email // must be less than 10 MB. The message body may contain HTML, with some limitations. // For more information, see Custom Verification Email Frequently Asked Questions - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq) + // (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. TemplateContent *string `type:"string"` - // The name of the custom verification email template that you want to update. + // The name of the custom verification email template to update. // // TemplateName is a required field TemplateName *string `type:"string" required:"true"` @@ -15970,7 +16020,7 @@ func (s UpdateCustomVerificationEmailTemplateOutput) GoString() string { // Represents a request to update a receipt rule. You use receipt rules to receive // email with Amazon SES. For more information, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html). type UpdateReceiptRuleInput struct { _ struct{} `type:"structure"` @@ -16062,8 +16112,8 @@ func (s UpdateReceiptRuleOutput) GoString() string { type UpdateTemplateInput struct { _ struct{} `type:"structure"` - // The content of the email, composed of a subject line, an HTML part, and a - // text-only part. + // The content of the email, composed of a subject line and either an HTML part + // or a text-only part. // // Template is a required field Template *Template `type:"structure" required:"true"` @@ -16135,7 +16185,7 @@ func (s UpdateTemplateOutput) GoString() string { // Represents a request to generate the CNAME records needed to set up Easy // DKIM with Amazon SES. For more information about setting up Easy DKIM, see -// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html). type VerifyDomainDkimInput struct { _ struct{} `type:"structure"` @@ -16198,7 +16248,7 @@ type VerifyDomainDkimOutput struct { // not email address identities.) // // For more information about creating DNS records using DKIM tokens, see the - // Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). + // Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html). // // DkimTokens is a required field DkimTokens []*string `type:"list" required:"true"` @@ -16231,7 +16281,7 @@ func (s *VerifyDomainDkimOutput) SetDkimTokens(v []*string) *VerifyDomainDkimOut // Represents a request to begin Amazon SES domain verification and to generate // the TXT records that you must publish to the DNS server of your domain to // complete the verification. For information about domain verification, see -// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-domain-procedure). type VerifyDomainIdentityInput struct { _ struct{} `type:"structure"` @@ -16290,8 +16340,9 @@ type VerifyDomainIdentityOutput struct { // is "Pending". When Amazon SES detects the record, the domain's verification // status changes to "Success". If Amazon SES is unable to detect the record // within 72 hours, the domain's verification status changes to "Failed." In - // that case, if you still want to verify the domain, you must restart the verification - // process from the beginning. + // that case, to verify the domain, you must restart the verification process + // from the beginning. The domain's verification status also changes to "Success" + // when it is DKIM verified. // // VerificationToken is a required field VerificationToken *string `type:"string" required:"true"` @@ -16323,7 +16374,7 @@ func (s *VerifyDomainIdentityOutput) SetVerificationToken(v string) *VerifyDomai // Represents a request to begin email address verification with Amazon SES. // For information about email address verification, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure). type VerifyEmailAddressInput struct { _ struct{} `type:"structure"` @@ -16394,7 +16445,7 @@ func (s VerifyEmailAddressOutput) GoString() string { // Represents a request to begin email address verification with Amazon SES. // For information about email address verification, see the Amazon SES Developer -// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html). +// Guide (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure). type VerifyEmailIdentityInput struct { _ struct{} `type:"structure"` @@ -16466,16 +16517,23 @@ func (s VerifyEmailIdentityOutput) GoString() string { // When included in a receipt rule, this action calls Amazon WorkMail and, optionally, // publishes a notification to Amazon Simple Notification Service (Amazon SNS). -// You will typically not use this action directly because Amazon WorkMail adds -// the rule automatically during its setup procedure. +// It usually isn't necessary to set this up manually, because Amazon WorkMail +// adds the rule automatically during its setup procedure. // // For information using a receipt rule to call Amazon WorkMail, see the Amazon -// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-workmail.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-workmail.html). type WorkmailAction struct { _ struct{} `type:"structure"` - // The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail - // organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. + // The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon + // WorkMail ARNs use the following format: + // + // arn:aws:workmail: