Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow Log Records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
", "CreateFpgaImage": "Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit.
", "CreateImage": "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
", - "CreateInstanceExportTask": "Exports a running or stopped instance to an S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
", + "CreateInstanceExportTask": "Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
", "CreateInternetGateway": "Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
", "CreateKeyPair": "Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per Region.
The key pair returned to you is available only in the Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
", "CreateLaunchTemplate": "Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch templatein the Amazon Elastic Compute Cloud User Guide.
", @@ -167,8 +167,8 @@ "DescribeDhcpOptions": "Describes one or more of your DHCP options sets.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
", "DescribeEgressOnlyInternetGateways": "Describes one or more of your egress-only internet gateways.
", "DescribeElasticGpus": "Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.
", - "DescribeExportImageTasks": "Describes the specified export image tasks or all your export image tasks.
", - "DescribeExportTasks": "Describes the specified export instance tasks or all your export instance tasks.
", + "DescribeExportImageTasks": "Describes the specified export image tasks or all of your export image tasks.
", + "DescribeExportTasks": "Describes the specified export instance tasks or all of your export instance tasks.
", "DescribeFastSnapshotRestores": "Describes the state of fast snapshot restores for your snapshots.
", "DescribeFleetHistory": "Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
", "DescribeFleetInstances": "Describes the running instances for the specified EC2 Fleet.
", @@ -1430,7 +1430,7 @@ "ImportClientVpnClientCertificateRevocationListResult$Return": "Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
Indicates whether the AMI is encypted.
", + "ImportImageResult$Encrypted": "Indicates whether the AMI is encrypted.
", "ImportImageTask$Encrypted": "Indicates whether the image is encrypted.
", "ImportInstanceLaunchSpecification$Monitoring": "Indicates whether monitoring is enabled.
", "ImportInstanceRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes the destination for an export image task.
", "refs": { - "ExportImageResult$S3ExportLocation": "Information about the destination S3 bucket.
", - "ExportImageTask$S3ExportLocation": "Information about the destination S3 bucket.
" + "ExportImageResult$S3ExportLocation": "Information about the destination Amazon S3 bucket.
", + "ExportImageTask$S3ExportLocation": "Information about the destination Amazon S3 bucket.
" } }, "ExportTaskS3LocationRequest": { "base": "Describes the destination for an export image task.
", "refs": { - "ExportImageRequest$S3ExportLocation": "Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
" + "ExportImageRequest$S3ExportLocation": "Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
" } }, "ExportTaskState": { @@ -7031,6 +7031,7 @@ "ImportImageTaskId": { "base": null, "refs": { + "ImportImageResult$ImportTaskId": "The task ID of the import image task.
", "ImportTaskIdList$member": null } }, @@ -8200,6 +8201,7 @@ "CopySnapshotRequest$KmsKeyId": "The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the CMK using any of the following:
Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
", "CreateVolumeRequest$KmsKeyId": "The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the CMK using any of the following:
Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
", "ImportImageRequest$KmsKeyId": "An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric CMKs.
", + "ImportImageResult$KmsKeyId": "The identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted AMI.
", "ImportSnapshotRequest$KmsKeyId": "An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric CMKs.
", "LaunchTemplateEbsBlockDevice$KmsKeyId": "The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
", "LaunchTemplateEbsBlockDeviceRequest$KmsKeyId": "The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.
", @@ -12175,7 +12177,7 @@ "CreateImageRequest$Description": "A description for the new image.
", "CreateImageRequest$Name": "A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", "CreateImageResult$ImageId": "The ID of the new AMI.
", - "CreateInstanceExportTaskRequest$Description": "A description for the conversion task or the resource being exported. The maximum length is 255 bytes.
", + "CreateInstanceExportTaskRequest$Description": "A description for the conversion task or the resource being exported. The maximum length is 255 characters.
", "CreateKeyPairRequest$KeyName": "A unique name for the key pair.
Constraints: Up to 255 ASCII characters
", "CreateLaunchTemplateRequest$ClientToken": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
", "CreateLaunchTemplateVersionRequest$ClientToken": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
", @@ -12491,12 +12493,12 @@ "ExportClientVpnClientCertificateRevocationListResult$CertificateRevocationList": "Information about the client certificate revocation list.
", "ExportClientVpnClientConfigurationResult$ClientConfiguration": "The contents of the Client VPN endpoint configuration file.
", "ExportImageRequest$ClientToken": "Token to enable idempotency for export image requests.
", - "ExportImageRequest$Description": "A description of the image being exported. The maximum length is 255 bytes.
", - "ExportImageRequest$RoleName": "The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
", + "ExportImageRequest$Description": "A description of the image being exported. The maximum length is 255 characters.
", + "ExportImageRequest$RoleName": "The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
", "ExportImageResult$Description": "A description of the image being exported.
", "ExportImageResult$ExportImageTaskId": "The ID of the export image task.
", "ExportImageResult$ImageId": "The ID of the image.
", - "ExportImageResult$RoleName": "The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
", + "ExportImageResult$RoleName": "The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
", "ExportImageResult$Progress": "The percent complete of the export image task.
", "ExportImageResult$Status": "The status of the export image task. The possible values are active, completed, deleting, and deleted.
The status message for the export image task.
", @@ -12509,14 +12511,14 @@ "ExportTask$Description": "A description of the resource being exported.
", "ExportTask$ExportTaskId": "The ID of the export task.
", "ExportTask$StatusMessage": "The status message related to the export task.
", - "ExportTaskS3Location$S3Bucket": "The destination S3 bucket.
", + "ExportTaskS3Location$S3Bucket": "The destination Amazon S3 bucket.
", "ExportTaskS3Location$S3Prefix": "The prefix (logical hierarchy) in the bucket.
", - "ExportTaskS3LocationRequest$S3Bucket": "The destination S3 bucket.
", + "ExportTaskS3LocationRequest$S3Bucket": "The destination Amazon S3 bucket.
", "ExportTaskS3LocationRequest$S3Prefix": "The prefix (logical hierarchy) in the bucket.
", - "ExportToS3Task$S3Bucket": "The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
The encryption key for your S3 bucket.
", - "ExportToS3TaskSpecification$S3Bucket": "The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
", + "ExportToS3TaskSpecification$S3Bucket": "The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
", "ExportTransitGatewayRoutesRequest$S3Bucket": "The name of the S3 bucket.
", "ExportTransitGatewayRoutesResult$S3Location": "The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
", "FailedQueuedPurchaseDeletion$ReservedInstancesId": "The ID of the Reserved Instance.
", @@ -12628,7 +12630,7 @@ "ImageAttribute$ImageId": "The ID of the AMI.
", "ImageDiskContainer$Description": "The description of the disk image.
", "ImageDiskContainer$DeviceName": "The block device mapping for the disk.
", - "ImageDiskContainer$Format": "The format of the disk image being imported.
Valid values: VHD | VMDK | OVA
The format of the disk image being imported.
Valid values: OVA | VHD | VHDX |VMDK
The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)
", "ImportClientVpnClientCertificateRevocationListRequest$CertificateRevocationList": "The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide.
", "ImportImageLicenseConfigurationRequest$LicenseConfigurationArn": "The ARN of a license configuration.
", @@ -12644,8 +12646,6 @@ "ImportImageResult$Description": "A description of the import task.
", "ImportImageResult$Hypervisor": "The target hypervisor of the import task.
", "ImportImageResult$ImageId": "The ID of the Amazon Machine Image (AMI) created by the import task.
", - "ImportImageResult$ImportTaskId": "The task ID of the import image task.
", - "ImportImageResult$KmsKeyId": "The identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted AMI.
", "ImportImageResult$LicenseType": "The license type of the virtual machine.
", "ImportImageResult$Platform": "The operating system of the virtual machine.
", "ImportImageResult$Progress": "The progress of the task.
", @@ -13330,9 +13330,9 @@ "UnsuccessfulItem$ResourceId": "The ID of the resource.
", "UnsuccessfulItemError$Code": "The error code.
", "UnsuccessfulItemError$Message": "The error message accompanying the error code.
", - "UserBucket$S3Bucket": "The name of the S3 bucket where the disk image is located.
", + "UserBucket$S3Bucket": "The name of the Amazon S3 bucket where the disk image is located.
", "UserBucket$S3Key": "The file name of the disk image.
", - "UserBucketDetails$S3Bucket": "The S3 bucket from which the disk image was created.
", + "UserBucketDetails$S3Bucket": "The Amazon S3 bucket from which the disk image was created.
", "UserBucketDetails$S3Key": "The file name of the disk image.
", "UserData$Data": "The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
", "UserGroupStringList$member": null, @@ -13578,6 +13578,8 @@ "DhcpOptions$Tags": "Any tags assigned to the DHCP options set.
", "EgressOnlyInternetGateway$Tags": "The tags assigned to the egress-only internet gateway.
", "ElasticGpus$Tags": "The tags assigned to the Elastic Graphics accelerator.
", + "ExportImageResult$Tags": "Any tags assigned to the image being exported.
", + "ExportImageTask$Tags": "Any tags assigned to the image being exported.
", "ExportTask$Tags": "The tags for the export task.
", "FleetData$Tags": "The tags for an EC2 Fleet resource.
", "FlowLog$Tags": "The tags for the flow log.
", @@ -13585,8 +13587,10 @@ "Host$Tags": "Any tags assigned to the Dedicated Host.
", "HostReservation$Tags": "Any tags assigned to the Dedicated Host Reservation.
", "Image$Tags": "Any tags assigned to the image.
", + "ImportImageResult$Tags": "Any tags assigned to the image being imported.
", "ImportImageTask$Tags": "The tags for the import image task.
", "ImportKeyPairResult$Tags": "The tags applied to the imported key pair.
", + "ImportSnapshotResult$Tags": "Any tags assigned to the snapshot being imported.
", "ImportSnapshotTask$Tags": "The tags for the import snapshot task.
", "Instance$Tags": "Any tags assigned to the instance.
", "InternetGateway$Tags": "Any tags assigned to the internet gateway.
", @@ -13654,6 +13658,7 @@ "CreateFleetRequest$TagSpecifications": "The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging Your Resources.
The tags to apply to the flow logs.
", "CreateFpgaImageRequest$TagSpecifications": "The tags to apply to the FPGA image during creation.
", + "CreateInstanceExportTaskRequest$TagSpecifications": "The tags to apply to the instance export task during creation.
", "CreateKeyPairRequest$TagSpecifications": "The tags to apply to the new key pair.
", "CreateLaunchTemplateRequest$TagSpecifications": "The tags to apply to the launch template during creation.
", "CreateLocalGatewayRouteTableVpcAssociationRequest$TagSpecifications": "The tags to assign to the local gateway route table VPC association.
", @@ -13672,7 +13677,10 @@ "CreateVolumeRequest$TagSpecifications": "The tags to apply to the volume during creation.
", "CreateVpcEndpointRequest$TagSpecifications": "The tags to associate with the endpoint.
", "CreateVpcEndpointServiceConfigurationRequest$TagSpecifications": "The tags to associate with the service.
", + "ExportImageRequest$TagSpecifications": "The tags to apply to the image being exported.
", + "ImportImageRequest$TagSpecifications": "The tags to apply to the image being imported.
", "ImportKeyPairRequest$TagSpecifications": "The tags to apply to the imported key pair.
", + "ImportSnapshotRequest$TagSpecifications": "The tags to apply to the snapshot being imported.
", "ProvisionByoipCidrRequest$PoolTagSpecifications": "The tags to apply to the address pool.
", "RunInstancesRequest$TagSpecifications": "The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
", "SpotFleetRequestConfigData$TagSpecifications": "The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.
Describes the S3 bucket for the disk image.
", + "base": "Describes the Amazon S3 bucket for the disk image.
", "refs": { "ImageDiskContainer$UserBucket": "The S3 bucket for the disk image.
", - "SnapshotDiskContainer$UserBucket": "The S3 bucket for the disk image.
" + "SnapshotDiskContainer$UserBucket": "The Amazon S3 bucket for the disk image.
" } }, "UserBucketDetails": { - "base": "Describes the S3 bucket for the disk image.
", + "base": "Describes the Amazon S3 bucket for the disk image.
", "refs": { - "SnapshotDetail$UserBucket": "The S3 bucket for the disk image.
", - "SnapshotTaskDetail$UserBucket": "The S3 bucket for the disk image.
" + "SnapshotDetail$UserBucket": "The Amazon S3 bucket for the disk image.
", + "SnapshotTaskDetail$UserBucket": "The Amazon S3 bucket for the disk image.
" } }, "UserData": { diff --git a/models/apis/elasticmapreduce/2009-03-31/api-2.json b/models/apis/elasticmapreduce/2009-03-31/api-2.json index a483e7be10c..faf1668cca9 100644 --- a/models/apis/elasticmapreduce/2009-03-31/api-2.json +++ b/models/apis/elasticmapreduce/2009-03-31/api-2.json @@ -807,7 +807,8 @@ "UnitType":{"shape":"ComputeLimitsUnitType"}, "MinimumCapacityUnits":{"shape":"Integer"}, "MaximumCapacityUnits":{"shape":"Integer"}, - "MaximumOnDemandCapacityUnits":{"shape":"Integer"} + "MaximumOnDemandCapacityUnits":{"shape":"Integer"}, + "MaximumCoreCapacityUnits":{"shape":"Integer"} } }, "ComputeLimitsUnitType":{ diff --git a/models/apis/elasticmapreduce/2009-03-31/docs-2.json b/models/apis/elasticmapreduce/2009-03-31/docs-2.json index 794a06e0397..4fcea44c272 100644 --- a/models/apis/elasticmapreduce/2009-03-31/docs-2.json +++ b/models/apis/elasticmapreduce/2009-03-31/docs-2.json @@ -915,7 +915,8 @@ "ClusterSummary$NormalizedInstanceHours": "An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
", "ComputeLimits$MinimumCapacityUnits": "The lower boundary of EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
", "ComputeLimits$MaximumCapacityUnits": "The upper boundary of EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
", - "ComputeLimits$MaximumOnDemandCapacityUnits": "The upper boundary of on-demand EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The on-demand units are not allowed to scale beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
", + "ComputeLimits$MaximumOnDemandCapacityUnits": "The upper boundary of On-Demand EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The On-Demand units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between On-Demand and Spot instances.
", + "ComputeLimits$MaximumCoreCapacityUnits": "The upper boundary of EC2 units for core node type in a cluster. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The core units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between core and task nodes.
", "EbsBlockDeviceConfig$VolumesPerInstance": "Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group
", "InstanceGroup$RequestedInstanceCount": "The target number of instances for the instance group.
", "InstanceGroup$RunningInstanceCount": "The number of instances currently running in this instance group.
", diff --git a/models/apis/rds/2014-10-31/docs-2.json b/models/apis/rds/2014-10-31/docs-2.json index 80a0bb531bf..4056c000d29 100644 --- a/models/apis/rds/2014-10-31/docs-2.json +++ b/models/apis/rds/2014-10-31/docs-2.json @@ -4087,7 +4087,7 @@ "ResourcePendingMaintenanceActions$ResourceIdentifier": "The ARN of the resource that has pending maintenance actions.
", "RestoreDBClusterFromS3Message$CharacterSetName": "A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
", "RestoreDBClusterFromS3Message$DatabaseName": "The database name for the restored DB cluster.
", - "RestoreDBClusterFromS3Message$DBClusterIdentifier": "The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter is isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora, aurora-postgresql
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
", "RestoreDBClusterFromS3Message$KmsKeyId": "The AWS KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
The version of the database that the backup files were created from.
MySQL version 5.5 and 5.6 are supported.
Example: 5.6.22
The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
", "RestoreDBClusterFromS3Message$S3Prefix": "The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
", "RestoreDBClusterFromS3Message$S3IngestionRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
", @@ -4159,7 +4159,7 @@ "RestoreDBInstanceFromS3Message$KmsKeyId": "The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
The name of the engine of your source database.
Valid Values: mysql
The engine version of your source database.
Valid Values: 5.6
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
The name of your Amazon S3 bucket that contains your database backup file.
", "RestoreDBInstanceFromS3Message$S3Prefix": "The prefix of your Amazon S3 bucket.
", "RestoreDBInstanceFromS3Message$S3IngestionRoleArn": "An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
", diff --git a/models/apis/rds/2014-10-31/paginators-1.json b/models/apis/rds/2014-10-31/paginators-1.json index 7fc21f57956..e4a45469e4c 100644 --- a/models/apis/rds/2014-10-31/paginators-1.json +++ b/models/apis/rds/2014-10-31/paginators-1.json @@ -1,11 +1,47 @@ { "pagination": { + "DescribeCertificates": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Certificates" + }, "DescribeCustomAvailabilityZones": { "input_token": "Marker", "limit_key": "MaxRecords", "output_token": "Marker", "result_key": "CustomAvailabilityZones" }, + "DescribeDBClusterBacktracks": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusterBacktracks" + }, + "DescribeDBClusterEndpoints": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusterEndpoints" + }, + "DescribeDBClusterParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusterParameterGroups" + }, + "DescribeDBClusterParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeDBClusterSnapshots": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusterSnapshots" + }, "DescribeDBClusters": { "input_token": "Marker", "limit_key": "MaxRecords", @@ -138,6 +174,12 @@ "output_token": "Marker", "result_key": "OrderableDBInstanceOptions" }, + "DescribePendingMaintenanceActions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "PendingMaintenanceActions" + }, "DescribeReservedDBInstances": { "input_token": "Marker", "limit_key": "MaxRecords", @@ -150,6 +192,12 @@ "output_token": "Marker", "result_key": "ReservedDBInstancesOfferings" }, + "DescribeSourceRegions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "SourceRegions" + }, "DownloadDBLogFilePortion": { "input_token": "Marker", "limit_key": "NumberOfLines", diff --git a/models/apis/rekognition/2016-06-27/api-2.json b/models/apis/rekognition/2016-06-27/api-2.json index 78c909f03f5..6f5a2e432a3 100644 --- a/models/apis/rekognition/2016-06-27/api-2.json +++ b/models/apis/rekognition/2016-06-27/api-2.json @@ -484,6 +484,24 @@ {"shape":"ThrottlingException"} ] }, + "GetSegmentDetection":{ + "name":"GetSegmentDetection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSegmentDetectionRequest"}, + "output":{"shape":"GetSegmentDetectionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ] + }, "GetTextDetection":{ "name":"GetTextDetection", "http":{ @@ -778,6 +796,27 @@ {"shape":"ProvisionedThroughputExceededException"} ] }, + "StartSegmentDetection":{ + "name":"StartSegmentDetection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartSegmentDetectionRequest"}, + "output":{"shape":"StartSegmentDetectionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"InternalServerError"}, + {"shape":"VideoTooLargeException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"} + ], + "idempotent":true + }, "StartStreamProcessor":{ "name":"StartStreamProcessor", "http":{ @@ -889,6 +928,19 @@ "type":"list", "member":{"shape":"Attribute"} }, + "AudioMetadata":{ + "type":"structure", + "members":{ + "Codec":{"shape":"String"}, + "DurationMillis":{"shape":"ULong"}, + "SampleRate":{"shape":"ULong"}, + "NumberOfChannels":{"shape":"ULong"} + } + }, + "AudioMetadataList":{ + "type":"list", + "member":{"shape":"AudioMetadata"} + }, "Beard":{ "type":"structure", "members":{ @@ -1714,6 +1766,27 @@ "Persons":{"shape":"PersonDetections"} } }, + "GetSegmentDetectionRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"}, + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"PaginationToken"} + } + }, + "GetSegmentDetectionResponse":{ + "type":"structure", + "members":{ + "JobStatus":{"shape":"VideoJobStatus"}, + "StatusMessage":{"shape":"StatusMessage"}, + "VideoMetadata":{"shape":"VideoMetadataList"}, + "AudioMetadata":{"shape":"AudioMetadataList"}, + "NextToken":{"shape":"PaginationToken"}, + "Segments":{"shape":"SegmentDetections"}, + "SelectedSegmentTypes":{"shape":"SegmentTypesInfo"} + } + }, "GetTextDetectionRequest":{ "type":"structure", "required":["JobId"], @@ -2462,6 +2535,59 @@ "FaceModelVersion":{"shape":"String"} } }, + "SegmentConfidence":{ + "type":"float", + "max":100, + "min":50 + }, + "SegmentDetection":{ + "type":"structure", + "members":{ + "Type":{"shape":"SegmentType"}, + "StartTimestampMillis":{"shape":"Timestamp"}, + "EndTimestampMillis":{"shape":"Timestamp"}, + "DurationMillis":{"shape":"ULong"}, + "StartTimecodeSMPTE":{"shape":"Timecode"}, + "EndTimecodeSMPTE":{"shape":"Timecode"}, + "DurationSMPTE":{"shape":"Timecode"}, + "TechnicalCueSegment":{"shape":"TechnicalCueSegment"}, + "ShotSegment":{"shape":"ShotSegment"} + } + }, + "SegmentDetections":{ + "type":"list", + "member":{"shape":"SegmentDetection"} + }, + "SegmentType":{ + "type":"string", + "enum":[ + "TECHNICAL_CUE", + "SHOT" + ] + }, + "SegmentTypeInfo":{ + "type":"structure", + "members":{ + "Type":{"shape":"SegmentType"}, + "ModelVersion":{"shape":"String"} + } + }, + "SegmentTypes":{ + "type":"list", + "member":{"shape":"SegmentType"}, + "min":1 + }, + "SegmentTypesInfo":{ + "type":"list", + "member":{"shape":"SegmentTypeInfo"} + }, + "ShotSegment":{ + "type":"structure", + "members":{ + "Index":{"shape":"ULong"}, + "Confidence":{"shape":"SegmentConfidence"} + } + }, "Smile":{ "type":"structure", "members":{ @@ -2590,6 +2716,40 @@ "Status":{"shape":"ProjectVersionStatus"} } }, + "StartSegmentDetectionFilters":{ + "type":"structure", + "members":{ + "TechnicalCueFilter":{"shape":"StartTechnicalCueDetectionFilter"}, + "ShotFilter":{"shape":"StartShotDetectionFilter"} + } + }, + "StartSegmentDetectionRequest":{ + "type":"structure", + "required":[ + "Video", + "SegmentTypes" + ], + "members":{ + "Video":{"shape":"Video"}, + "ClientRequestToken":{"shape":"ClientRequestToken"}, + "NotificationChannel":{"shape":"NotificationChannel"}, + "JobTag":{"shape":"JobTag"}, + "Filters":{"shape":"StartSegmentDetectionFilters"}, + "SegmentTypes":{"shape":"SegmentTypes"} + } + }, + "StartSegmentDetectionResponse":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"} + } + }, + "StartShotDetectionFilter":{ + "type":"structure", + "members":{ + "MinSegmentConfidence":{"shape":"SegmentConfidence"} + } + }, "StartStreamProcessorRequest":{ "type":"structure", "required":["Name"], @@ -2602,6 +2762,12 @@ "members":{ } }, + "StartTechnicalCueDetectionFilter":{ + "type":"structure", + "members":{ + "MinSegmentConfidence":{"shape":"SegmentConfidence"} + } + }, "StartTextDetectionFilters":{ "type":"structure", "members":{ @@ -2715,6 +2881,21 @@ "Confidence":{"shape":"Percent"} } }, + "TechnicalCueSegment":{ + "type":"structure", + "members":{ + "Type":{"shape":"TechnicalCueType"}, + "Confidence":{"shape":"SegmentConfidence"} + } + }, + "TechnicalCueType":{ + "type":"string", + "enum":[ + "ColorBars", + "EndCredits", + "BlackFrames" + ] + }, "TestingData":{ "type":"structure", "members":{ @@ -2769,6 +2950,7 @@ "exception":true, "fault":true }, + "Timecode":{"type":"string"}, "Timestamp":{"type":"long"}, "TrainingData":{ "type":"structure", @@ -2844,6 +3026,10 @@ "FrameWidth":{"shape":"ULong"} } }, + "VideoMetadataList":{ + "type":"list", + "member":{"shape":"VideoMetadata"} + }, "VideoTooLargeException":{ "type":"structure", "members":{ diff --git a/models/apis/rekognition/2016-06-27/docs-2.json b/models/apis/rekognition/2016-06-27/docs-2.json index 71578456625..1a38193f118 100644 --- a/models/apis/rekognition/2016-06-27/docs-2.json +++ b/models/apis/rekognition/2016-06-27/docs-2.json @@ -9,8 +9,8 @@ "CreateStreamProcessor": "Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.
Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.
You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field.
After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor.
", "DeleteCollection": "Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure.
This operation requires permissions to perform the rekognition:DeleteCollection action.
Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.
This operation requires permissions to perform the rekognition:DeleteFaces action.
Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all versions of the model associated with the project. To delete a version of a model, see DeleteProjectVersion.
This operation requires permissions to perform the rekognition:DeleteProject action.
Deletes a version of a model.
You must first stop the model before you can delete it. To check if a model is running, use the Status field returned from DescribeProjectVersions. To stop a running model call StopProjectVersion.
This operation requires permissions to perform the rekognition:DeleteProjectVersion action.
Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated with the project. To delete a model, see DeleteProjectVersion.
This operation requires permissions to perform the rekognition:DeleteProject action.
Deletes an Amazon Rekognition Custom Labels model.
You can't delete a model if it is running or if it is training. To check the status of a model, use the Status field returned from DescribeProjectVersions. To stop a running model call StopProjectVersion. If the model is training, wait until it finishes.
This operation requires permissions to perform the rekognition:DeleteProjectVersion action.
Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor.
Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.
For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.
", "DescribeProjectVersions": "Lists and describes the models in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all models are returned.
This operation requires permissions to perform the rekognition:DescribeProjectVersions action.
Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.
Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch.
For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.
GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.
Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.
GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.
The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection.
Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.
The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.
To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.
GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video.
GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned.
For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter.
Use the MaxResults parameter to limit the number of items returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking.
Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.
Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by calling StartSegmentDetection which returns a job identifier (JobId). When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartSegmentDetection. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call of StartSegmentDetection.
GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected.
Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection.
Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection and populate the NextToken request parameter with the token value returned from the previous call to GetSegmentDetection.
For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.
", "GetTextDetection": "Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling StartTextDetection which returns a job identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartTextDetection. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call of StartLabelDetection.
GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 50 words per frame of video.
Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.
Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection and populate the NextToken request parameter with the token value returned from the previous call to GetTextDetection.
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.
For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.
To get the number of faces in a collection, call DescribeCollection.
If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
If you provide the optional ExternalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.
Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request parameter.
The face is too small compared to the image dimensions.
The face is too blurry.
The image is too dark.
The face has an extreme pose.
The face doesn’t have enough detail to be suitable for face search.
In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
This operation requires permissions to perform the rekognition:IndexFaces action.
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.
For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.
To get the number of faces in a collection, call DescribeCollection.
If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
If you provide the optional ExternalImageId for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.
Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request parameter.
The face is too small compared to the image dimensions.
The face is too blurry.
The image is too dark.
The face has an extreme pose.
The face doesn’t have enough detail to be suitable for face search.
In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
This operation requires permissions to perform the rekognition:IndexFaces action.
Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing Collections in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListCollections action.
Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListFaces action.
Gets a list of stream processors that you have created with CreateStreamProcessor.
", @@ -43,6 +44,7 @@ "StartLabelDetection": "Starts asynchronous detection of labels in a stored video.
Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.
To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.
Starts the asynchronous tracking of a person's path in a stored video.
Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.
To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.
Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.
Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.
You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.
This operation requires permissions to perform the rekognition:StartProjectVersion action.
Starts asynchronous detection of segment detection in a stored video.
Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.
You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.
To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call to StartSegmentDetection.
For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.
", "StartStreamProcessor": "Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.
Starts asynchronous detection of text in a stored video.
Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.
To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call to StartTextDetection.
Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions.
", @@ -86,6 +88,18 @@ "IndexFacesRequest$DetectionAttributes": "An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify [\"DEFAULT\"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide [\"ALL\"], all facial attributes are returned, but the operation takes longer to complete.
If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).
Metadata information about an audio stream. An array of AudioMetadata objects for the audio streams found in a stored video is returned by GetSegmentDetection.
An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.
Indicates whether or not the face has a beard, and the confidence level in the determination.
", "refs": { @@ -177,6 +191,7 @@ "StartFaceSearchRequest$ClientRequestToken": "Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartLabelDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.
The Amazon Resource Name (ARN) of the flow definition.
" + "HumanLoopConfig$FlowDefinitionArn": "The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by using the Amazon Sagemaker CreateFlowDefinition Operation.
" } }, "Gender": { @@ -778,6 +793,16 @@ "refs": { } }, + "GetSegmentDetectionRequest": { + "base": null, + "refs": { + } + }, + "GetSegmentDetectionResponse": { + "base": null, + "refs": { + } + }, "GetTextDetectionRequest": { "base": null, "refs": { @@ -954,13 +979,15 @@ "GetFaceSearchRequest$JobId": "The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.
Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.
The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.
Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartTextDetection.
Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to StartSegmentDetection.
Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to StartTextDetection.
The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition.
The identifier for the unsafe content analysis job. Use JobId to identify the job in a subsequent call to GetContentModeration.
The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection.
The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch.
The identifier for the label detection job. Use JobId to identify the job in a subsequent call to GetLabelDetection.
The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking.
Unique identifier for the segment detection job. The JobId is returned from StartSegmentDetection.
Identifier for the text detection job. Use JobId to identify the job in a subsequent call to GetTextDetection.
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
", "GetLabelDetectionRequest$MaxResults": "Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
", "GetPersonTrackingRequest$MaxResults": "Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
", + "GetSegmentDetectionRequest$MaxResults": "Maximum number of results to return per paginated call. The largest value you can specify is 1000.
", "GetTextDetectionRequest$MaxResults": "Maximum number of results to return per paginated call. The largest value you can specify is 1000.
", "ListStreamProcessorsRequest$MaxResults": "Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.
" } @@ -1145,6 +1174,7 @@ "StartFaceSearchRequest$NotificationChannel": "The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
", "StartLabelDetectionRequest$NotificationChannel": "The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.
", "StartPersonTrackingRequest$NotificationChannel": "The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
", + "StartSegmentDetectionRequest$NotificationChannel": "The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.
", "StartTextDetectionRequest$NotificationChannel": null } }, @@ -1188,6 +1218,8 @@ "GetLabelDetectionResponse$NextToken": "If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.
", "GetPersonTrackingRequest$NextToken": "If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.
", "GetPersonTrackingResponse$NextToken": "If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons.
", + "GetSegmentDetectionRequest$NextToken": "If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.
", + "GetSegmentDetectionResponse$NextToken": "If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.
", "GetTextDetectionRequest$NextToken": "If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.
", "GetTextDetectionResponse$NextToken": "If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.
", "ListCollectionsRequest$NextToken": "Pagination token from the previous response.
", @@ -1451,7 +1483,7 @@ } }, "ResourceInUseException": { - "base": "", + "base": "The specified resource is already being used.
", "refs": { } }, @@ -1533,6 +1565,59 @@ "refs": { } }, + "SegmentConfidence": { + "base": null, + "refs": { + "ShotSegment$Confidence": "The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.
", + "StartShotDetectionFilter$MinSegmentConfidence": "Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level lower than this specified value.
If you don't specify MinSegmentConfidence, the GetSegmentDetection returns segments with confidence values greater than or equal to 50 percent.
Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level lower than this specified value.
If you don't specify MinSegmentConfidence, GetSegmentDetection returns segments with confidence values greater than or equal to 50 percent.
The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.
" + } + }, + "SegmentDetection": { + "base": "A technical cue or shot detection segment detected in a video. An array of SegmentDetection objects containing all segments detected in a stored video is returned by GetSegmentDetection.
An array of segments detected in a video.
" + } + }, + "SegmentType": { + "base": null, + "refs": { + "SegmentDetection$Type": "The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
The type of a segment (technical cue or shot detection).
", + "SegmentTypes$member": null + } + }, + "SegmentTypeInfo": { + "base": "Information about the type of a segment requested in a call to StartSegmentDetection. An array of SegmentTypeInfo objects is returned by the response from GetSegmentDetection.
An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
" + } + }, + "SegmentTypesInfo": { + "base": null, + "refs": { + "GetSegmentDetectionResponse$SelectedSegmentTypes": "An array containing the segment types requested in the call to StartSegmentDetection.
Information about a shot detection segment detected in a video. For more information, see SegmentDetection.
", + "refs": { + "SegmentDetection$ShotSegment": "If the segment is a shot detection, contains information about the shot detection.
" + } + }, "Smile": { "base": "Indicates whether or not the face is smiling, and the confidence level in the determination.
", "refs": { @@ -1609,6 +1694,28 @@ "refs": { } }, + "StartSegmentDetectionFilters": { + "base": "Filters applied to the technical cue or shot detection segments. For more information, see StartSegmentDetection.
", + "refs": { + "StartSegmentDetectionRequest$Filters": "Filters for technical cue or shot detection.
" + } + }, + "StartSegmentDetectionRequest": { + "base": null, + "refs": { + } + }, + "StartSegmentDetectionResponse": { + "base": null, + "refs": { + } + }, + "StartShotDetectionFilter": { + "base": "Filters for the shot detection segments returned by GetSegmentDetection. For more information, see StartSegmentDetectionFilters.
Filters that are specific to shot detections.
" + } + }, "StartStreamProcessorRequest": { "base": null, "refs": { @@ -1619,6 +1726,12 @@ "refs": { } }, + "StartTechnicalCueDetectionFilter": { + "base": "Filters for the technical segments returned by GetSegmentDetection. For more information, see StartSegmentDetectionFilters.
", + "refs": { + "StartSegmentDetectionFilters$TechnicalCueFilter": "Filters that are specific to technical cues.
" + } + }, "StartTextDetectionFilters": { "base": "Set of optional parameters that let you set the criteria text must meet to be included in your response. WordFilter looks at a word's height, width and minimum confidence. RegionOfInterest lets you set a specific region of the screen to look for text in.
If the job fails, StatusMessage provides a descriptive error message.
If the job fails, StatusMessage provides a descriptive error message.
If the job fails, StatusMessage provides a descriptive error message.
If the job fails, StatusMessage provides a descriptive error message.
If the job fails, StatusMessage provides a descriptive error message.
A descriptive message for an error or warning that occurred.
" } @@ -1730,6 +1844,7 @@ "String": { "base": null, "refs": { + "AudioMetadata$Codec": "The audio codec used to encode or decode the audio stream.
", "Celebrity$Name": "The name of the celebrity.
", "CelebrityDetail$Name": "The name of the celebrity.
", "CreateCollectionResponse$CollectionArn": "Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.
", @@ -1746,9 +1861,9 @@ "GetContentModerationResponse$ModerationModelVersion": "Version number of the moderation detection model that was used to detect unsafe content.
", "GetLabelDetectionResponse$LabelModelVersion": "Version number of the label detection model that was used to detect labels.
", "GetTextDetectionResponse$TextModelVersion": "Version number of the text detection model that was used to detect text.
", - "HumanLoopQuotaExceededException$ResourceType": null, - "HumanLoopQuotaExceededException$QuotaCode": null, - "HumanLoopQuotaExceededException$ServiceCode": null, + "HumanLoopQuotaExceededException$ResourceType": "The resource type.
", + "HumanLoopQuotaExceededException$QuotaCode": "The quota code.
", + "HumanLoopQuotaExceededException$ServiceCode": "The service code.
", "IndexFacesResponse$FaceModelVersion": "The version number of the face detection model that's associated with the input collection (CollectionId).
The name (label) of the object or scene.
", "ListFacesResponse$NextToken": "If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
", @@ -1758,6 +1873,7 @@ "Parent$Name": "The name of the parent label.
", "SearchFacesByImageResponse$FaceModelVersion": "Version number of the face detection model associated with the input collection (CollectionId).
Version number of the face detection model associated with the input collection (CollectionId).
The version of the model used to detect segments.
", "TextDetection$DetectedText": "The word or line of text recognized by Amazon Rekognition.
", "VideoMetadata$Codec": "Type of compression used in the analyzed video.
", "VideoMetadata$Format": "Format of the analyzed video. Possible values are MP4, MOV and AVI.
" @@ -1775,6 +1891,18 @@ "FaceDetail$Sunglasses": "Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
" } }, + "TechnicalCueSegment": { + "base": "Information about a technical cue segment. For more information, see SegmentDetection.
", + "refs": { + "SegmentDetection$TechnicalCueSegment": "If the segment is a technical cue, contains information about the technical cue.
" + } + }, + "TechnicalCueType": { + "base": null, + "refs": { + "TechnicalCueSegment$Type": "The type of the technical cue.
" + } + }, "TestingData": { "base": "The dataset used for testing. Optionally, if AutoCreate is set, Amazon Rekognition Custom Labels creates a testing dataset using an 80/20 split of the training dataset.
The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).
The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).
The duration of the timecode for the detected segment in SMPTE format.
" + } + }, "Timestamp": { "base": null, "refs": { @@ -1834,6 +1970,8 @@ "LabelDetection$Timestamp": "Time, in milliseconds from the start of the video, that the label was detected.
", "PersonDetection$Timestamp": "The time, in milliseconds from the start of the video, that the person's path was tracked.
", "PersonMatch$Timestamp": "The time, in milliseconds from the beginning of the video, that the person was matched in the video.
", + "SegmentDetection$StartTimestampMillis": "The start time of the detected segment in milliseconds from the start of the video.
", + "SegmentDetection$EndTimestampMillis": "The end time of the detected segment, in milliseconds, from the start of the video.
", "TextDetectionResult$Timestamp": "The time, in milliseconds from the start of the video, that the text was detected.
" } }, @@ -1867,8 +2005,13 @@ "ULong": { "base": null, "refs": { + "AudioMetadata$DurationMillis": "The duration of the audio stream in milliseconds.
", + "AudioMetadata$SampleRate": "The sample rate for the audio stream.
", + "AudioMetadata$NumberOfChannels": "The number of audio channels in the segement.
", "DescribeCollectionResponse$FaceCount": "The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.
", "ProjectVersionDescription$BillableTrainingTimeInSeconds": "The duration, in seconds, that the model version has been billed for training. This value is only returned if the model version has been successfully trained.
", + "SegmentDetection$DurationMillis": "The duration of the detected segment in milliseconds.
", + "ShotSegment$Index": "An Identifier for a shot detection segment detected in a video
", "VideoMetadata$DurationMillis": "Length of the video in milliseconds.
", "VideoMetadata$FrameHeight": "Vertical pixel dimension of the video.
", "VideoMetadata$FrameWidth": "Horizontal pixel dimension of the video.
" @@ -1910,7 +2053,7 @@ "VersionNames": { "base": null, "refs": { - "DescribeProjectVersionsRequest$VersionNames": "A list of model version names that you want to describe. You can add up to 10 model version names to the list. If you don't specify a value, all model descriptions are returned.
" + "DescribeProjectVersionsRequest$VersionNames": "A list of model version names that you want to describe. You can add up to 10 model version names to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a model (ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.
The video you want to search. The video must be stored in an Amazon S3 bucket.
", "StartLabelDetectionRequest$Video": "The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.
", "StartPersonTrackingRequest$Video": "The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
", + "StartSegmentDetectionRequest$Video": null, "StartTextDetectionRequest$Video": null } }, @@ -1934,6 +2078,7 @@ "GetFaceSearchResponse$JobStatus": "The current status of the face search job.
", "GetLabelDetectionResponse$JobStatus": "The current status of the label detection job.
", "GetPersonTrackingResponse$JobStatus": "The current status of the person tracking job.
", + "GetSegmentDetectionResponse$JobStatus": "Current status of the segment detection job.
", "GetTextDetectionResponse$JobStatus": "Current status of the text detection job.
" } }, @@ -1946,7 +2091,14 @@ "GetFaceSearchResponse$VideoMetadata": "Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.
Welcome to the Amazon Simple Queue Service API Reference.
Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional Information
Amazon Simple Queue Service Developer Guide
Amazon Web Services General Reference
Adds a permission to a queue for a specific principal. This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.
AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon Simple Queue Service Developer Guide.
An Amazon SQS policy can have a maximum of 7 actions.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Adds a permission to a queue for a specific principal. This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.
AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon Simple Queue Service Developer Guide.
An Amazon SQS policy can have a maximum of 7 actions.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to extend the visibility timeout beyond the maximum, your request is rejected.
An Amazon SQS message has three basic states:
Sent to a queue by a producer.
Received from the queue by a consumer.
Deleted from the queue.
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.
Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages. To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.
Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind:
If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide.
If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide.
If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.
The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be deleted).
For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Deletes the queue specified by the QueueUrl, regardless of the queue's contents. If the specified queue doesn't exist, Amazon SQS returns a successful response.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Gets attributes for the specified queue.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Gets attributes for the specified queue.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
Returns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
", "ListQueueTags": "List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon Simple Queue Service Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
For each message returned, the response includes the following:
The message body.
An MD5 digest of the message body. For information about MD5, see RFC1321.
The MessageId you received when you sent the message to the queue.
The receipt handle.
The message attributes.
An MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide.
You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
A list of attributes for which to retrieve information.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
The following attributes are supported:
All - Returns all values.
ApproximateNumberOfMessages - Returns the approximate number of messages available for retrieval from the queue.
ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).
DelaySeconds - Returns the default delay on the queue in seconds.
LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).
MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod - Returns the length of time, in seconds, for which Amazon SQS retains a message.
Policy - Returns the policy of the queue.
QueueArn - Returns the Amazon resource name (ARN) of the queue.
ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
RedrivePolicy - Returns the string that includes the parameters for dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.
The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
A list of attributes that need to be returned along with each message. These attributes include:
All - Returns all values.
ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.
AWSTraceHeader - Returns the AWS X-Ray trace header string.
SenderId
For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).
MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.
MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
SequenceNumber - Returns the value provided by Amazon SQS.
A list of attributes for which to retrieve information.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
The following attributes are supported:
The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessagesVisible metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency.
All – Returns all values.
ApproximateNumberOfMessages – Returns the approximate number of messages available for retrieval from the queue.
ApproximateNumberOfMessagesDelayed – Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
ApproximateNumberOfMessagesNotVisible – Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
CreatedTimestamp – Returns the time when the queue was created in seconds (epoch time).
DelaySeconds – Returns the default delay on the queue in seconds.
LastModifiedTimestamp – Returns the time when the queue was last changed in seconds (epoch time).
MaximumMessageSize – Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod – Returns the length of time, in seconds, for which Amazon SQS retains a message.
Policy – Returns the policy of the queue.
QueueArn – Returns the Amazon resource name (ARN) of the queue.
ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId – Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.
The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue – Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
A list of attributes that need to be returned along with each message. These attributes include:
All – Returns all values.
ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
AWSTraceHeader – Returns the AWS X-Ray trace header string.
SenderId
For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
MessageDeduplicationId – Returns the value provided by the producer that calls the SendMessage action.
MessageGroupId – Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
SequenceNumber – Returns the value provided by Amazon SQS.
Specifies whether the error happened due to the producer.
" + "BatchResultErrorEntry$SenderFault": "Specifies whether the error happened due to the caller of the batch API action.
" + } + }, + "BoxedInteger": { + "base": null, + "refs": { + "ListDeadLetterSourceQueuesRequest$MaxResults": "Maximum number of results to include in the response.
", + "ListQueuesRequest$MaxResults": "Maximum number of results to include in the response.
" } }, "ChangeMessageVisibilityBatchRequest": { @@ -218,7 +225,7 @@ "ChangeMessageVisibilityRequest$VisibilityTimeout": "The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours.
The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
", "ReceiveMessageRequest$VisibilityTimeout": "The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage requests is longer than the WaitTimeSeconds parameter. For example, with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
The message system attribute to send Each message system attribute consists of a Name, Type, and Value.
Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted AWS X-Ray trace string.
The size of a message system attribute doesn't count towards the total size of a message.
The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.
Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted AWS X-Ray trace string.
The size of a message system attribute doesn't count towards the total size of a message.
The message system attribute to send Each message system attribute consists of a Name, Type, and Value.
Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted AWS X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.
Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted AWS X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:
DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).
Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.
ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue - Designates a queue as FIFO. Valid values: true, false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.
For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
ContentBasedDeduplication - Enables content-based deduplication. Valid values: true, false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:
DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).
Policy – The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.
ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue – Designates a queue as FIFO. Valid values: true, false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.
For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
ContentBasedDeduplication – Enables content-based deduplication. Valid values: true, false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
A map of attributes to their respective values.
", - "SetQueueAttributesRequest$Attributes": "A map of attributes to set.
The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:
DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.
MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.
ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). Default: 0.
RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: an integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
The following attribute applies only to FIFO (first-in-first-out) queues:
ContentBasedDeduplication - Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
A map of attributes to set.
The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:
DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.
MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
Policy – The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.
ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
The following attribute applies only to FIFO (first-in-first-out) queues:
ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.
A list of queue URLs, up to 1,000 entries.
" + "ListQueuesResult$QueueUrls": "A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.
" } }, "ReceiptHandleIsInvalid": { @@ -479,7 +486,7 @@ "BatchResultErrorEntry$Code": "An error code representing why the action failed on this entry.
", "BatchResultErrorEntry$Message": "A message explaining why the action failed on this entry.
", "ChangeMessageVisibilityBatchRequest$QueueUrl": "The URL of the Amazon SQS queue whose messages' visibility is changed.
Queue URLs and names are case-sensitive.
", - "ChangeMessageVisibilityBatchRequestEntry$Id": "An identifier for this particular receipt handle used to communicate the result.
The Ids of a batch request need to be unique within a request
An identifier for this particular receipt handle used to communicate the result.
The Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
A receipt handle.
", "ChangeMessageVisibilityBatchResultEntry$Id": "Represents a message whose visibility timeout has been changed successfully.
", "ChangeMessageVisibilityRequest$QueueUrl": "The URL of the Amazon SQS queue whose message's visibility is changed.
Queue URLs and names are case-sensitive.
", @@ -487,7 +494,7 @@ "CreateQueueRequest$QueueName": "The name of the new queue. The following limits apply to this name:
A queue name can have up to 80 characters.
Valid values: alphanumeric characters, hyphens (-), and underscores (_).
A FIFO queue name must end with the .fifo suffix.
Queue URLs and names are case-sensitive.
", "CreateQueueResult$QueueUrl": "The URL of the created Amazon SQS queue.
", "DeleteMessageBatchRequest$QueueUrl": "The URL of the Amazon SQS queue from which messages are deleted.
Queue URLs and names are case-sensitive.
", - "DeleteMessageBatchRequestEntry$Id": "An identifier for this particular receipt handle. This is used to communicate the result.
The Ids of a batch request need to be unique within a request
An identifier for this particular receipt handle. This is used to communicate the result.
The Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
A receipt handle.
", "DeleteMessageBatchResultEntry$Id": "Represents a successfully deleted message.
", "DeleteMessageRequest$QueueUrl": "The URL of the Amazon SQS queue from which messages are deleted.
Queue URLs and names are case-sensitive.
", @@ -515,11 +522,11 @@ "QueueAttributeMap$value": null, "QueueUrlList$member": null, "ReceiveMessageRequest$QueueUrl": "The URL of the Amazon SQS queue from which messages are received.
Queue URLs and names are case-sensitive.
", - "ReceiveMessageRequest$ReceiveRequestAttemptId": "This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.
If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.
If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.
The URL of the Amazon SQS queue from which permissions are removed.
Queue URLs and names are case-sensitive.
", "RemovePermissionRequest$Label": "The identification of the permission to remove. This is the label added using the AddPermission action.
The URL of the Amazon SQS queue to which batched messages are sent.
Queue URLs and names are case-sensitive.
", - "SendMessageBatchRequestEntry$Id": "An identifier for a message in this batch used to communicate the result.
The Ids of a batch request need to be unique within a request
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
An identifier for a message in this batch used to communicate the result.
The Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
The body of the message.
", "SendMessageBatchRequestEntry$MessageDeduplicationId": "This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
This parameter applies only to FIFO (first-in-first-out) queues.
The large, non-consecutive number that Amazon SQS assigns to each message.
The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
", "SendMessageRequest$MessageBody": "The message to send. The maximum string size is 256 KB.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
", "SendMessageResult$MD5OfMessageAttributes": "An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
", @@ -583,6 +590,15 @@ "TagMap$value": null } }, + "Token": { + "base": null, + "refs": { + "ListDeadLetterSourceQueuesRequest$NextToken": "Pagination token to request the next set of results.
", + "ListDeadLetterSourceQueuesResult$NextToken": "Pagination token to include in the next request.
", + "ListQueuesRequest$NextToken": "Pagination token to request the next set of results.
", + "ListQueuesResult$NextToken": "Pagination token to include in the next request.
" + } + }, "TooManyEntriesInBatchRequest": { "base": "The batch request contains more entries than permissible.
", "refs": { diff --git a/models/apis/sqs/2012-11-05/paginators-1.json b/models/apis/sqs/2012-11-05/paginators-1.json index 4d5fe76b971..7cae474a572 100644 --- a/models/apis/sqs/2012-11-05/paginators-1.json +++ b/models/apis/sqs/2012-11-05/paginators-1.json @@ -1,6 +1,15 @@ { "pagination": { + "ListDeadLetterSourceQueues": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "queueUrls" + }, "ListQueues": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", "result_key": "QueueUrls" } } diff --git a/service/ec2/api.go b/service/ec2/api.go index a985780fd4d..ef7e9c6803a 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -4432,7 +4432,7 @@ func (c *EC2) CreateInstanceExportTaskRequest(input *CreateInstanceExportTaskInp // CreateInstanceExportTask API operation for Amazon Elastic Compute Cloud. // -// Exports a running or stopped instance to an S3 bucket. +// Exports a running or stopped instance to an Amazon S3 bucket. // // For information about the supported operating systems, image formats, and // known limitations for the types of instances you can export, see Exporting @@ -13984,7 +13984,7 @@ func (c *EC2) DescribeExportImageTasksRequest(input *DescribeExportImageTasksInp // DescribeExportImageTasks API operation for Amazon Elastic Compute Cloud. // -// Describes the specified export image tasks or all your export image tasks. +// Describes the specified export image tasks or all of your export image tasks. // // 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 @@ -14110,7 +14110,7 @@ func (c *EC2) DescribeExportTasksRequest(input *DescribeExportTasksInput) (req * // DescribeExportTasks API operation for Amazon Elastic Compute Cloud. // -// Describes the specified export instance tasks or all your export instance +// Describes the specified export instance tasks or all of your export instance // tasks. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -46259,7 +46259,7 @@ type CreateInstanceExportTaskInput struct { _ struct{} `type:"structure"` // A description for the conversion task or the resource being exported. The - // maximum length is 255 bytes. + // maximum length is 255 characters. Description *string `locationName:"description" type:"string"` // The format and location for an instance export task. @@ -46270,6 +46270,9 @@ type CreateInstanceExportTaskInput struct { // InstanceId is a required field InstanceId *string `locationName:"instanceId" type:"string" required:"true"` + // The tags to apply to the instance export task during creation. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" type:"list"` + // The target virtualization environment. TargetEnvironment *string `locationName:"targetEnvironment" type:"string" enum:"ExportEnvironment"` } @@ -46315,6 +46318,12 @@ func (s *CreateInstanceExportTaskInput) SetInstanceId(v string) *CreateInstanceE return s } +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *CreateInstanceExportTaskInput) SetTagSpecifications(v []*TagSpecification) *CreateInstanceExportTaskInput { + s.TagSpecifications = v + return s +} + // SetTargetEnvironment sets the TargetEnvironment field's value. func (s *CreateInstanceExportTaskInput) SetTargetEnvironment(v string) *CreateInstanceExportTaskInput { s.TargetEnvironment = &v @@ -73238,7 +73247,7 @@ type ExportImageInput struct { // Token to enable idempotency for export image requests. ClientToken *string `type:"string" idempotencyToken:"true"` - // A description of the image being exported. The maximum length is 255 bytes. + // A description of the image being exported. The maximum length is 255 characters. Description *string `type:"string"` // The disk image format. @@ -73258,15 +73267,18 @@ type ExportImageInput struct { ImageId *string `type:"string" required:"true"` // The name of the role that grants VM Import/Export permission to export images - // to your S3 bucket. If this parameter is not specified, the default role is - // named 'vmimport'. + // to your Amazon S3 bucket. If this parameter is not specified, the default + // role is named 'vmimport'. RoleName *string `type:"string"` - // Information about the destination S3 bucket. The bucket must exist and grant - // WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com. + // Information about the destination Amazon S3 bucket. The bucket must exist + // and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com. // // S3ExportLocation is a required field S3ExportLocation *ExportTaskS3LocationRequest `type:"structure" required:"true"` + + // The tags to apply to the image being exported. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" type:"list"` } // String returns the string representation @@ -73345,6 +73357,12 @@ func (s *ExportImageInput) SetS3ExportLocation(v *ExportTaskS3LocationRequest) * return s } +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *ExportImageInput) SetTagSpecifications(v []*TagSpecification) *ExportImageInput { + s.TagSpecifications = v + return s +} + type ExportImageOutput struct { _ struct{} `type:"structure"` @@ -73364,10 +73382,10 @@ type ExportImageOutput struct { Progress *string `locationName:"progress" type:"string"` // The name of the role that grants VM Import/Export permission to export images - // to your S3 bucket. + // to your Amazon S3 bucket. RoleName *string `locationName:"roleName" type:"string"` - // Information about the destination S3 bucket. + // Information about the destination Amazon S3 bucket. S3ExportLocation *ExportTaskS3Location `locationName:"s3ExportLocation" type:"structure"` // The status of the export image task. The possible values are active, completed, @@ -73376,6 +73394,9 @@ type ExportImageOutput struct { // The status message for the export image task. StatusMessage *string `locationName:"statusMessage" type:"string"` + + // Any tags assigned to the image being exported. + Tags []*Tag `locationName:"tagSet" locationNameList:"item" type:"list"` } // String returns the string representation @@ -73442,6 +73463,12 @@ func (s *ExportImageOutput) SetStatusMessage(v string) *ExportImageOutput { return s } +// SetTags sets the Tags field's value. +func (s *ExportImageOutput) SetTags(v []*Tag) *ExportImageOutput { + s.Tags = v + return s +} + // Describes an export image task. type ExportImageTask struct { _ struct{} `type:"structure"` @@ -73458,7 +73485,7 @@ type ExportImageTask struct { // The percent complete of the export image task. Progress *string `locationName:"progress" type:"string"` - // Information about the destination S3 bucket. + // Information about the destination Amazon S3 bucket. S3ExportLocation *ExportTaskS3Location `locationName:"s3ExportLocation" type:"structure"` // The status of the export image task. The possible values are active, completed, @@ -73467,6 +73494,9 @@ type ExportImageTask struct { // The status message for the export image task. StatusMessage *string `locationName:"statusMessage" type:"string"` + + // Any tags assigned to the image being exported. + Tags []*Tag `locationName:"tagSet" locationNameList:"item" type:"list"` } // String returns the string representation @@ -73521,6 +73551,12 @@ func (s *ExportImageTask) SetStatusMessage(v string) *ExportImageTask { return s } +// SetTags sets the Tags field's value. +func (s *ExportImageTask) SetTags(v []*Tag) *ExportImageTask { + s.Tags = v + return s +} + // Describes an instance export task. type ExportTask struct { _ struct{} `type:"structure"` @@ -73603,7 +73639,7 @@ func (s *ExportTask) SetTags(v []*Tag) *ExportTask { type ExportTaskS3Location struct { _ struct{} `type:"structure"` - // The destination S3 bucket. + // The destination Amazon S3 bucket. S3Bucket *string `locationName:"s3Bucket" type:"string"` // The prefix (logical hierarchy) in the bucket. @@ -73636,7 +73672,7 @@ func (s *ExportTaskS3Location) SetS3Prefix(v string) *ExportTaskS3Location { type ExportTaskS3LocationRequest struct { _ struct{} `type:"structure"` - // The destination S3 bucket. + // The destination Amazon S3 bucket. // // S3Bucket is a required field S3Bucket *string `type:"string" required:"true"` @@ -73691,8 +73727,8 @@ type ExportToS3Task struct { // The format for the exported image. DiskImageFormat *string `locationName:"diskImageFormat" type:"string" enum:"DiskImageFormat"` - // The S3 bucket for the destination image. The destination bucket must exist - // and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com. + // The Amazon S3 bucket for the destination image. The destination bucket must + // exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com. S3Bucket *string `locationName:"s3Bucket" type:"string"` // The encryption key for your S3 bucket. @@ -73744,12 +73780,12 @@ type ExportToS3TaskSpecification struct { // The format for the exported image. DiskImageFormat *string `locationName:"diskImageFormat" type:"string" enum:"DiskImageFormat"` - // The S3 bucket for the destination image. The destination bucket must exist - // and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com. + // The Amazon S3 bucket for the destination image. The destination bucket must + // exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com. S3Bucket *string `locationName:"s3Bucket" type:"string"` - // The image is written to a single object in the S3 bucket at the S3 key s3prefix - // + exportTaskId + '.' + diskImageFormat. + // The image is written to a single object in the Amazon S3 bucket at the S3 + // key s3prefix + exportTaskId + '.' + diskImageFormat. S3Prefix *string `locationName:"s3Prefix" type:"string"` } @@ -78183,7 +78219,7 @@ type ImageDiskContainer struct { // The format of the disk image being imported. // - // Valid values: VHD | VMDK | OVA + // Valid values: OVA | VHD | VHDX |VMDK Format *string `type:"string"` // The ID of the EBS snapshot to be used for importing the snapshot. @@ -78425,6 +78461,9 @@ type ImportImageInput struct { // The name of the role to use when not using the default role, 'vmimport'. RoleName *string `type:"string"` + + // The tags to apply to the image being imported. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" type:"list"` } // String returns the string representation @@ -78515,6 +78554,12 @@ func (s *ImportImageInput) SetRoleName(v string) *ImportImageInput { return s } +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *ImportImageInput) SetTagSpecifications(v []*TagSpecification) *ImportImageInput { + s.TagSpecifications = v + return s +} + // The request information of license configurations. type ImportImageLicenseConfigurationRequest struct { _ struct{} `type:"structure"` @@ -78572,7 +78617,7 @@ type ImportImageOutput struct { // A description of the import task. Description *string `locationName:"description" type:"string"` - // Indicates whether the AMI is encypted. + // Indicates whether the AMI is encrypted. Encrypted *bool `locationName:"encrypted" type:"boolean"` // The target hypervisor of the import task. @@ -78608,6 +78653,9 @@ type ImportImageOutput struct { // A detailed status message of the import task. StatusMessage *string `locationName:"statusMessage" type:"string"` + + // Any tags assigned to the image being imported. + Tags []*Tag `locationName:"tagSet" locationNameList:"item" type:"list"` } // String returns the string representation @@ -78704,6 +78752,12 @@ func (s *ImportImageOutput) SetStatusMessage(v string) *ImportImageOutput { return s } +// SetTags sets the Tags field's value. +func (s *ImportImageOutput) SetTags(v []*Tag) *ImportImageOutput { + s.Tags = v + return s +} + // Describes an import image task. type ImportImageTask struct { _ struct{} `type:"structure"` @@ -79404,6 +79458,9 @@ type ImportSnapshotInput struct { // The name of the role to use when not using the default role, 'vmimport'. RoleName *string `type:"string"` + + // The tags to apply to the snapshot being imported. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" type:"list"` } // String returns the string representation @@ -79464,6 +79521,12 @@ func (s *ImportSnapshotInput) SetRoleName(v string) *ImportSnapshotInput { return s } +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *ImportSnapshotInput) SetTagSpecifications(v []*TagSpecification) *ImportSnapshotInput { + s.TagSpecifications = v + return s +} + type ImportSnapshotOutput struct { _ struct{} `type:"structure"` @@ -79475,6 +79538,9 @@ type ImportSnapshotOutput struct { // Information about the import snapshot task. SnapshotTaskDetail *SnapshotTaskDetail `locationName:"snapshotTaskDetail" type:"structure"` + + // Any tags assigned to the snapshot being imported. + Tags []*Tag `locationName:"tagSet" locationNameList:"item" type:"list"` } // String returns the string representation @@ -79505,6 +79571,12 @@ func (s *ImportSnapshotOutput) SetSnapshotTaskDetail(v *SnapshotTaskDetail) *Imp return s } +// SetTags sets the Tags field's value. +func (s *ImportSnapshotOutput) SetTags(v []*Tag) *ImportSnapshotOutput { + s.Tags = v + return s +} + // Describes an import snapshot task. type ImportSnapshotTask struct { _ struct{} `type:"structure"` @@ -101398,7 +101470,7 @@ type SnapshotDetail struct { // The URL used to access the disk image. Url *string `locationName:"url" type:"string"` - // The S3 bucket for the disk image. + // The Amazon S3 bucket for the disk image. UserBucket *UserBucketDetails `locationName:"userBucket" type:"structure"` } @@ -101488,7 +101560,7 @@ type SnapshotDiskContainer struct { // a https URL (https://..) or an Amazon S3 URL (s3://..). Url *string `type:"string"` - // The S3 bucket for the disk image. + // The Amazon S3 bucket for the disk image. UserBucket *UserBucket `type:"structure"` } @@ -101668,7 +101740,7 @@ type SnapshotTaskDetail struct { // The URL of the disk image from which the snapshot is created. Url *string `locationName:"url" type:"string"` - // The S3 bucket for the disk image. + // The Amazon S3 bucket for the disk image. UserBucket *UserBucketDetails `locationName:"userBucket" type:"structure"` } @@ -107398,11 +107470,11 @@ func (s *UpdateSecurityGroupRuleDescriptionsIngressOutput) SetReturn(v bool) *Up return s } -// Describes the S3 bucket for the disk image. +// Describes the Amazon S3 bucket for the disk image. type UserBucket struct { _ struct{} `type:"structure"` - // The name of the S3 bucket where the disk image is located. + // The name of the Amazon S3 bucket where the disk image is located. S3Bucket *string `type:"string"` // The file name of the disk image. @@ -107431,11 +107503,11 @@ func (s *UserBucket) SetS3Key(v string) *UserBucket { return s } -// Describes the S3 bucket for the disk image. +// Describes the Amazon S3 bucket for the disk image. type UserBucketDetails struct { _ struct{} `type:"structure"` - // The S3 bucket from which the disk image was created. + // The Amazon S3 bucket from which the disk image was created. S3Bucket *string `locationName:"s3Bucket" type:"string"` // The file name of the disk image. @@ -112405,6 +112477,12 @@ const ( // ResourceTypeElasticGpu is a ResourceType enum value ResourceTypeElasticGpu = "elastic-gpu" + // ResourceTypeExportImageTask is a ResourceType enum value + ResourceTypeExportImageTask = "export-image-task" + + // ResourceTypeExportInstanceTask is a ResourceType enum value + ResourceTypeExportInstanceTask = "export-instance-task" + // ResourceTypeFleet is a ResourceType enum value ResourceTypeFleet = "fleet" @@ -112417,6 +112495,12 @@ const ( // ResourceTypeImage is a ResourceType enum value ResourceTypeImage = "image" + // ResourceTypeImportImageTask is a ResourceType enum value + ResourceTypeImportImageTask = "import-image-task" + + // ResourceTypeImportSnapshotTask is a ResourceType enum value + ResourceTypeImportSnapshotTask = "import-snapshot-task" + // ResourceTypeInstance is a ResourceType enum value ResourceTypeInstance = "instance" @@ -112429,6 +112513,9 @@ const ( // ResourceTypeLaunchTemplate is a ResourceType enum value ResourceTypeLaunchTemplate = "launch-template" + // ResourceTypeLocalGatewayRouteTableVpcAssociation is a ResourceType enum value + ResourceTypeLocalGatewayRouteTableVpcAssociation = "local-gateway-route-table-vpc-association" + // ResourceTypeNatgateway is a ResourceType enum value ResourceTypeNatgateway = "natgateway" @@ -113144,9 +113231,6 @@ const ( // VolumeTypeIo1 is a VolumeType enum value VolumeTypeIo1 = "io1" - // VolumeTypeIo2 is a VolumeType enum value - VolumeTypeIo2 = "io2" - // VolumeTypeGp2 is a VolumeType enum value VolumeTypeGp2 = "gp2" diff --git a/service/emr/api.go b/service/emr/api.go index b4ae20a0144..b4683a6ef7a 100644 --- a/service/emr/api.go +++ b/service/emr/api.go @@ -4900,11 +4900,18 @@ type ComputeLimits struct { // MaximumCapacityUnits is a required field MaximumCapacityUnits *int64 `type:"integer" required:"true"` - // The upper boundary of on-demand EC2 units. It is measured through VCPU cores + // The upper boundary of EC2 units for core node type in a cluster. It is measured + // through VCPU cores or instances for instance groups and measured through + // units for instance fleets. The core units are not allowed to scale beyond + // this boundary. The parameter is used to split capacity allocation between + // core and task nodes. + MaximumCoreCapacityUnits *int64 `type:"integer"` + + // The upper boundary of On-Demand EC2 units. It is measured through VCPU cores // or instances for instance groups and measured through units for instance - // fleets. The on-demand units are not allowed to scale beyond this boundary. - // The limit only applies to the core and task nodes. The master node cannot - // be scaled after initial configuration. + // fleets. The On-Demand units are not allowed to scale beyond this boundary. + // The parameter is used to split capacity allocation between On-Demand and + // Spot instances. MaximumOnDemandCapacityUnits *int64 `type:"integer"` // The lower boundary of EC2 units. It is measured through VCPU cores or instances @@ -4957,6 +4964,12 @@ func (s *ComputeLimits) SetMaximumCapacityUnits(v int64) *ComputeLimits { return s } +// SetMaximumCoreCapacityUnits sets the MaximumCoreCapacityUnits field's value. +func (s *ComputeLimits) SetMaximumCoreCapacityUnits(v int64) *ComputeLimits { + s.MaximumCoreCapacityUnits = &v + return s +} + // SetMaximumOnDemandCapacityUnits sets the MaximumOnDemandCapacityUnits field's value. func (s *ComputeLimits) SetMaximumOnDemandCapacityUnits(v int64) *ComputeLimits { s.MaximumOnDemandCapacityUnits = &v diff --git a/service/rds/api.go b/service/rds/api.go index 4f3c0386d09..980b7220c89 100644 --- a/service/rds/api.go +++ b/service/rds/api.go @@ -4482,6 +4482,12 @@ func (c *RDS) DescribeCertificatesRequest(input *DescribeCertificatesInput) (req Name: opDescribeCertificates, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"Marker"}, + OutputTokens: []string{"Marker"}, + LimitToken: "MaxRecords", + TruncationToken: "", + }, } if input == nil { @@ -4530,6 +4536,58 @@ func (c *RDS) DescribeCertificatesWithContext(ctx aws.Context, input *DescribeCe return out, req.Send() } +// DescribeCertificatesPages iterates over the pages of a DescribeCertificates operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeCertificates 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 DescribeCertificates operation. +// pageNum := 0 +// err := client.DescribeCertificatesPages(params, +// func(page *rds.DescribeCertificatesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RDS) DescribeCertificatesPages(input *DescribeCertificatesInput, fn func(*DescribeCertificatesOutput, bool) bool) error { + return c.DescribeCertificatesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeCertificatesPagesWithContext same as DescribeCertificatesPages 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 *RDS) DescribeCertificatesPagesWithContext(ctx aws.Context, input *DescribeCertificatesInput, fn func(*DescribeCertificatesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeCertificatesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeCertificatesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeCertificatesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opDescribeCustomAvailabilityZones = "DescribeCustomAvailabilityZones" // DescribeCustomAvailabilityZonesRequest generates a "aws/request.Request" representing the @@ -4705,6 +4763,12 @@ func (c *RDS) DescribeDBClusterBacktracksRequest(input *DescribeDBClusterBacktra Name: opDescribeDBClusterBacktracks, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"Marker"}, + OutputTokens: []string{"Marker"}, + LimitToken: "MaxRecords", + TruncationToken: "", + }, } if input == nil { @@ -4761,6 +4825,58 @@ func (c *RDS) DescribeDBClusterBacktracksWithContext(ctx aws.Context, input *Des return out, req.Send() } +// DescribeDBClusterBacktracksPages iterates over the pages of a DescribeDBClusterBacktracks operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeDBClusterBacktracks 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 DescribeDBClusterBacktracks operation. +// pageNum := 0 +// err := client.DescribeDBClusterBacktracksPages(params, +// func(page *rds.DescribeDBClusterBacktracksOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RDS) DescribeDBClusterBacktracksPages(input *DescribeDBClusterBacktracksInput, fn func(*DescribeDBClusterBacktracksOutput, bool) bool) error { + return c.DescribeDBClusterBacktracksPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeDBClusterBacktracksPagesWithContext same as DescribeDBClusterBacktracksPages 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 *RDS) DescribeDBClusterBacktracksPagesWithContext(ctx aws.Context, input *DescribeDBClusterBacktracksInput, fn func(*DescribeDBClusterBacktracksOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeDBClusterBacktracksInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeDBClusterBacktracksRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeDBClusterBacktracksOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opDescribeDBClusterEndpoints = "DescribeDBClusterEndpoints" // DescribeDBClusterEndpointsRequest generates a "aws/request.Request" representing the @@ -4792,6 +4908,12 @@ func (c *RDS) DescribeDBClusterEndpointsRequest(input *DescribeDBClusterEndpoint Name: opDescribeDBClusterEndpoints, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"Marker"}, + OutputTokens: []string{"Marker"}, + LimitToken: "MaxRecords", + TruncationToken: "", + }, } if input == nil { @@ -4842,6 +4964,58 @@ func (c *RDS) DescribeDBClusterEndpointsWithContext(ctx aws.Context, input *Desc return out, req.Send() } +// DescribeDBClusterEndpointsPages iterates over the pages of a DescribeDBClusterEndpoints operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeDBClusterEndpoints 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 DescribeDBClusterEndpoints operation. +// pageNum := 0 +// err := client.DescribeDBClusterEndpointsPages(params, +// func(page *rds.DescribeDBClusterEndpointsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RDS) DescribeDBClusterEndpointsPages(input *DescribeDBClusterEndpointsInput, fn func(*DescribeDBClusterEndpointsOutput, bool) bool) error { + return c.DescribeDBClusterEndpointsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeDBClusterEndpointsPagesWithContext same as DescribeDBClusterEndpointsPages 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 *RDS) DescribeDBClusterEndpointsPagesWithContext(ctx aws.Context, input *DescribeDBClusterEndpointsInput, fn func(*DescribeDBClusterEndpointsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeDBClusterEndpointsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeDBClusterEndpointsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeDBClusterEndpointsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opDescribeDBClusterParameterGroups = "DescribeDBClusterParameterGroups" // DescribeDBClusterParameterGroupsRequest generates a "aws/request.Request" representing the @@ -4873,6 +5047,12 @@ func (c *RDS) DescribeDBClusterParameterGroupsRequest(input *DescribeDBClusterPa Name: opDescribeDBClusterParameterGroups, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"Marker"}, + OutputTokens: []string{"Marker"}, + LimitToken: "MaxRecords", + TruncationToken: "", + }, } if input == nil { @@ -4928,6 +5108,58 @@ func (c *RDS) DescribeDBClusterParameterGroupsWithContext(ctx aws.Context, input return out, req.Send() } +// DescribeDBClusterParameterGroupsPages iterates over the pages of a DescribeDBClusterParameterGroups operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeDBClusterParameterGroups 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 DescribeDBClusterParameterGroups operation. +// pageNum := 0 +// err := client.DescribeDBClusterParameterGroupsPages(params, +// func(page *rds.DescribeDBClusterParameterGroupsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RDS) DescribeDBClusterParameterGroupsPages(input *DescribeDBClusterParameterGroupsInput, fn func(*DescribeDBClusterParameterGroupsOutput, bool) bool) error { + return c.DescribeDBClusterParameterGroupsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeDBClusterParameterGroupsPagesWithContext same as DescribeDBClusterParameterGroupsPages 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 *RDS) DescribeDBClusterParameterGroupsPagesWithContext(ctx aws.Context, input *DescribeDBClusterParameterGroupsInput, fn func(*DescribeDBClusterParameterGroupsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeDBClusterParameterGroupsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeDBClusterParameterGroupsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeDBClusterParameterGroupsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opDescribeDBClusterParameters = "DescribeDBClusterParameters" // DescribeDBClusterParametersRequest generates a "aws/request.Request" representing the @@ -4959,6 +5191,12 @@ func (c *RDS) DescribeDBClusterParametersRequest(input *DescribeDBClusterParamet Name: opDescribeDBClusterParameters, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"Marker"}, + OutputTokens: []string{"Marker"}, + LimitToken: "MaxRecords", + TruncationToken: "", + }, } if input == nil { @@ -5013,6 +5251,58 @@ func (c *RDS) DescribeDBClusterParametersWithContext(ctx aws.Context, input *Des return out, req.Send() } +// DescribeDBClusterParametersPages iterates over the pages of a DescribeDBClusterParameters operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeDBClusterParameters 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 DescribeDBClusterParameters operation. +// pageNum := 0 +// err := client.DescribeDBClusterParametersPages(params, +// func(page *rds.DescribeDBClusterParametersOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RDS) DescribeDBClusterParametersPages(input *DescribeDBClusterParametersInput, fn func(*DescribeDBClusterParametersOutput, bool) bool) error { + return c.DescribeDBClusterParametersPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeDBClusterParametersPagesWithContext same as DescribeDBClusterParametersPages 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 *RDS) DescribeDBClusterParametersPagesWithContext(ctx aws.Context, input *DescribeDBClusterParametersInput, fn func(*DescribeDBClusterParametersOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeDBClusterParametersInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeDBClusterParametersRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeDBClusterParametersOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opDescribeDBClusterSnapshotAttributes = "DescribeDBClusterSnapshotAttributes" // DescribeDBClusterSnapshotAttributesRequest generates a "aws/request.Request" representing the @@ -5136,6 +5426,12 @@ func (c *RDS) DescribeDBClusterSnapshotsRequest(input *DescribeDBClusterSnapshot Name: opDescribeDBClusterSnapshots, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"Marker"}, + OutputTokens: []string{"Marker"}, + LimitToken: "MaxRecords", + TruncationToken: "", + }, } if input == nil { @@ -5190,6 +5486,58 @@ func (c *RDS) DescribeDBClusterSnapshotsWithContext(ctx aws.Context, input *Desc return out, req.Send() } +// DescribeDBClusterSnapshotsPages iterates over the pages of a DescribeDBClusterSnapshots operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeDBClusterSnapshots 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 DescribeDBClusterSnapshots operation. +// pageNum := 0 +// err := client.DescribeDBClusterSnapshotsPages(params, +// func(page *rds.DescribeDBClusterSnapshotsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RDS) DescribeDBClusterSnapshotsPages(input *DescribeDBClusterSnapshotsInput, fn func(*DescribeDBClusterSnapshotsOutput, bool) bool) error { + return c.DescribeDBClusterSnapshotsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeDBClusterSnapshotsPagesWithContext same as DescribeDBClusterSnapshotsPages 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 *RDS) DescribeDBClusterSnapshotsPagesWithContext(ctx aws.Context, input *DescribeDBClusterSnapshotsInput, fn func(*DescribeDBClusterSnapshotsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeDBClusterSnapshotsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeDBClusterSnapshotsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeDBClusterSnapshotsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opDescribeDBClusters = "DescribeDBClusters" // DescribeDBClustersRequest generates a "aws/request.Request" representing the @@ -8528,6 +8876,12 @@ func (c *RDS) DescribePendingMaintenanceActionsRequest(input *DescribePendingMai Name: opDescribePendingMaintenanceActions, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"Marker"}, + OutputTokens: []string{"Marker"}, + LimitToken: "MaxRecords", + TruncationToken: "", + }, } if input == nil { @@ -8577,6 +8931,58 @@ func (c *RDS) DescribePendingMaintenanceActionsWithContext(ctx aws.Context, inpu return out, req.Send() } +// DescribePendingMaintenanceActionsPages iterates over the pages of a DescribePendingMaintenanceActions operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribePendingMaintenanceActions 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 DescribePendingMaintenanceActions operation. +// pageNum := 0 +// err := client.DescribePendingMaintenanceActionsPages(params, +// func(page *rds.DescribePendingMaintenanceActionsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RDS) DescribePendingMaintenanceActionsPages(input *DescribePendingMaintenanceActionsInput, fn func(*DescribePendingMaintenanceActionsOutput, bool) bool) error { + return c.DescribePendingMaintenanceActionsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribePendingMaintenanceActionsPagesWithContext same as DescribePendingMaintenanceActionsPages 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 *RDS) DescribePendingMaintenanceActionsPagesWithContext(ctx aws.Context, input *DescribePendingMaintenanceActionsInput, fn func(*DescribePendingMaintenanceActionsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribePendingMaintenanceActionsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribePendingMaintenanceActionsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribePendingMaintenanceActionsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opDescribeReservedDBInstances = "DescribeReservedDBInstances" // DescribeReservedDBInstancesRequest generates a "aws/request.Request" representing the @@ -8883,6 +9289,12 @@ func (c *RDS) DescribeSourceRegionsRequest(input *DescribeSourceRegionsInput) (r Name: opDescribeSourceRegions, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"Marker"}, + OutputTokens: []string{"Marker"}, + LimitToken: "MaxRecords", + TruncationToken: "", + }, } if input == nil { @@ -8928,6 +9340,58 @@ func (c *RDS) DescribeSourceRegionsWithContext(ctx aws.Context, input *DescribeS return out, req.Send() } +// DescribeSourceRegionsPages iterates over the pages of a DescribeSourceRegions operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeSourceRegions 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 DescribeSourceRegions operation. +// pageNum := 0 +// err := client.DescribeSourceRegionsPages(params, +// func(page *rds.DescribeSourceRegionsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RDS) DescribeSourceRegionsPages(input *DescribeSourceRegionsInput, fn func(*DescribeSourceRegionsOutput, bool) bool) error { + return c.DescribeSourceRegionsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeSourceRegionsPagesWithContext same as DescribeSourceRegionsPages 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 *RDS) DescribeSourceRegionsPagesWithContext(ctx aws.Context, input *DescribeSourceRegionsInput, fn func(*DescribeSourceRegionsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeSourceRegionsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeSourceRegionsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeSourceRegionsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opDescribeValidDBInstanceModifications = "DescribeValidDBInstanceModifications" // DescribeValidDBInstanceModificationsRequest generates a "aws/request.Request" representing the @@ -36989,7 +37453,7 @@ type RestoreDBClusterFromS3Input struct { CopyTagsToSnapshot *bool `type:"boolean"` // The name of the DB cluster to create from the source data in the Amazon S3 - // bucket. This parameter is isn't case-sensitive. + // bucket. This parameter isn't case-sensitive. // // Constraints: // @@ -37197,9 +37661,9 @@ type RestoreDBClusterFromS3Input struct { // The version of the database that the backup files were created from. // - // MySQL version 5.5 and 5.6 are supported. + // MySQL versions 5.5, 5.6, and 5.7 are supported. // - // Example: 5.6.22 + // Example: 5.6.40 // // SourceEngineVersion is a required field SourceEngineVersion *string `type:"string" required:"true"` @@ -38952,9 +39416,11 @@ type RestoreDBInstanceFromS3Input struct { // SourceEngine is a required field SourceEngine *string `type:"string" required:"true"` - // The engine version of your source database. + // The version of the database that the backup files were created from. + // + // MySQL versions 5.6 and 5.7 are supported. // - // Valid Values: 5.6 + // Example: 5.6.40 // // SourceEngineVersion is a required field SourceEngineVersion *string `type:"string" required:"true"` diff --git a/service/rds/rdsiface/interface.go b/service/rds/rdsiface/interface.go index 3cfca01ec55..5add01a4105 100644 --- a/service/rds/rdsiface/interface.go +++ b/service/rds/rdsiface/interface.go @@ -248,6 +248,9 @@ type RDSAPI interface { DescribeCertificatesWithContext(aws.Context, *rds.DescribeCertificatesInput, ...request.Option) (*rds.DescribeCertificatesOutput, error) DescribeCertificatesRequest(*rds.DescribeCertificatesInput) (*request.Request, *rds.DescribeCertificatesOutput) + DescribeCertificatesPages(*rds.DescribeCertificatesInput, func(*rds.DescribeCertificatesOutput, bool) bool) error + DescribeCertificatesPagesWithContext(aws.Context, *rds.DescribeCertificatesInput, func(*rds.DescribeCertificatesOutput, bool) bool, ...request.Option) error + DescribeCustomAvailabilityZones(*rds.DescribeCustomAvailabilityZonesInput) (*rds.DescribeCustomAvailabilityZonesOutput, error) DescribeCustomAvailabilityZonesWithContext(aws.Context, *rds.DescribeCustomAvailabilityZonesInput, ...request.Option) (*rds.DescribeCustomAvailabilityZonesOutput, error) DescribeCustomAvailabilityZonesRequest(*rds.DescribeCustomAvailabilityZonesInput) (*request.Request, *rds.DescribeCustomAvailabilityZonesOutput) @@ -259,18 +262,30 @@ type RDSAPI interface { DescribeDBClusterBacktracksWithContext(aws.Context, *rds.DescribeDBClusterBacktracksInput, ...request.Option) (*rds.DescribeDBClusterBacktracksOutput, error) DescribeDBClusterBacktracksRequest(*rds.DescribeDBClusterBacktracksInput) (*request.Request, *rds.DescribeDBClusterBacktracksOutput) + DescribeDBClusterBacktracksPages(*rds.DescribeDBClusterBacktracksInput, func(*rds.DescribeDBClusterBacktracksOutput, bool) bool) error + DescribeDBClusterBacktracksPagesWithContext(aws.Context, *rds.DescribeDBClusterBacktracksInput, func(*rds.DescribeDBClusterBacktracksOutput, bool) bool, ...request.Option) error + DescribeDBClusterEndpoints(*rds.DescribeDBClusterEndpointsInput) (*rds.DescribeDBClusterEndpointsOutput, error) DescribeDBClusterEndpointsWithContext(aws.Context, *rds.DescribeDBClusterEndpointsInput, ...request.Option) (*rds.DescribeDBClusterEndpointsOutput, error) DescribeDBClusterEndpointsRequest(*rds.DescribeDBClusterEndpointsInput) (*request.Request, *rds.DescribeDBClusterEndpointsOutput) + DescribeDBClusterEndpointsPages(*rds.DescribeDBClusterEndpointsInput, func(*rds.DescribeDBClusterEndpointsOutput, bool) bool) error + DescribeDBClusterEndpointsPagesWithContext(aws.Context, *rds.DescribeDBClusterEndpointsInput, func(*rds.DescribeDBClusterEndpointsOutput, bool) bool, ...request.Option) error + DescribeDBClusterParameterGroups(*rds.DescribeDBClusterParameterGroupsInput) (*rds.DescribeDBClusterParameterGroupsOutput, error) DescribeDBClusterParameterGroupsWithContext(aws.Context, *rds.DescribeDBClusterParameterGroupsInput, ...request.Option) (*rds.DescribeDBClusterParameterGroupsOutput, error) DescribeDBClusterParameterGroupsRequest(*rds.DescribeDBClusterParameterGroupsInput) (*request.Request, *rds.DescribeDBClusterParameterGroupsOutput) + DescribeDBClusterParameterGroupsPages(*rds.DescribeDBClusterParameterGroupsInput, func(*rds.DescribeDBClusterParameterGroupsOutput, bool) bool) error + DescribeDBClusterParameterGroupsPagesWithContext(aws.Context, *rds.DescribeDBClusterParameterGroupsInput, func(*rds.DescribeDBClusterParameterGroupsOutput, bool) bool, ...request.Option) error + DescribeDBClusterParameters(*rds.DescribeDBClusterParametersInput) (*rds.DescribeDBClusterParametersOutput, error) DescribeDBClusterParametersWithContext(aws.Context, *rds.DescribeDBClusterParametersInput, ...request.Option) (*rds.DescribeDBClusterParametersOutput, error) DescribeDBClusterParametersRequest(*rds.DescribeDBClusterParametersInput) (*request.Request, *rds.DescribeDBClusterParametersOutput) + DescribeDBClusterParametersPages(*rds.DescribeDBClusterParametersInput, func(*rds.DescribeDBClusterParametersOutput, bool) bool) error + DescribeDBClusterParametersPagesWithContext(aws.Context, *rds.DescribeDBClusterParametersInput, func(*rds.DescribeDBClusterParametersOutput, bool) bool, ...request.Option) error + DescribeDBClusterSnapshotAttributes(*rds.DescribeDBClusterSnapshotAttributesInput) (*rds.DescribeDBClusterSnapshotAttributesOutput, error) DescribeDBClusterSnapshotAttributesWithContext(aws.Context, *rds.DescribeDBClusterSnapshotAttributesInput, ...request.Option) (*rds.DescribeDBClusterSnapshotAttributesOutput, error) DescribeDBClusterSnapshotAttributesRequest(*rds.DescribeDBClusterSnapshotAttributesInput) (*request.Request, *rds.DescribeDBClusterSnapshotAttributesOutput) @@ -279,6 +294,9 @@ type RDSAPI interface { DescribeDBClusterSnapshotsWithContext(aws.Context, *rds.DescribeDBClusterSnapshotsInput, ...request.Option) (*rds.DescribeDBClusterSnapshotsOutput, error) DescribeDBClusterSnapshotsRequest(*rds.DescribeDBClusterSnapshotsInput) (*request.Request, *rds.DescribeDBClusterSnapshotsOutput) + DescribeDBClusterSnapshotsPages(*rds.DescribeDBClusterSnapshotsInput, func(*rds.DescribeDBClusterSnapshotsOutput, bool) bool) error + DescribeDBClusterSnapshotsPagesWithContext(aws.Context, *rds.DescribeDBClusterSnapshotsInput, func(*rds.DescribeDBClusterSnapshotsOutput, bool) bool, ...request.Option) error + DescribeDBClusters(*rds.DescribeDBClustersInput) (*rds.DescribeDBClustersOutput, error) DescribeDBClustersWithContext(aws.Context, *rds.DescribeDBClustersInput, ...request.Option) (*rds.DescribeDBClustersOutput, error) DescribeDBClustersRequest(*rds.DescribeDBClustersInput) (*request.Request, *rds.DescribeDBClustersOutput) @@ -449,6 +467,9 @@ type RDSAPI interface { DescribePendingMaintenanceActionsWithContext(aws.Context, *rds.DescribePendingMaintenanceActionsInput, ...request.Option) (*rds.DescribePendingMaintenanceActionsOutput, error) DescribePendingMaintenanceActionsRequest(*rds.DescribePendingMaintenanceActionsInput) (*request.Request, *rds.DescribePendingMaintenanceActionsOutput) + DescribePendingMaintenanceActionsPages(*rds.DescribePendingMaintenanceActionsInput, func(*rds.DescribePendingMaintenanceActionsOutput, bool) bool) error + DescribePendingMaintenanceActionsPagesWithContext(aws.Context, *rds.DescribePendingMaintenanceActionsInput, func(*rds.DescribePendingMaintenanceActionsOutput, bool) bool, ...request.Option) error + DescribeReservedDBInstances(*rds.DescribeReservedDBInstancesInput) (*rds.DescribeReservedDBInstancesOutput, error) DescribeReservedDBInstancesWithContext(aws.Context, *rds.DescribeReservedDBInstancesInput, ...request.Option) (*rds.DescribeReservedDBInstancesOutput, error) DescribeReservedDBInstancesRequest(*rds.DescribeReservedDBInstancesInput) (*request.Request, *rds.DescribeReservedDBInstancesOutput) @@ -467,6 +488,9 @@ type RDSAPI interface { DescribeSourceRegionsWithContext(aws.Context, *rds.DescribeSourceRegionsInput, ...request.Option) (*rds.DescribeSourceRegionsOutput, error) DescribeSourceRegionsRequest(*rds.DescribeSourceRegionsInput) (*request.Request, *rds.DescribeSourceRegionsOutput) + DescribeSourceRegionsPages(*rds.DescribeSourceRegionsInput, func(*rds.DescribeSourceRegionsOutput, bool) bool) error + DescribeSourceRegionsPagesWithContext(aws.Context, *rds.DescribeSourceRegionsInput, func(*rds.DescribeSourceRegionsOutput, bool) bool, ...request.Option) error + DescribeValidDBInstanceModifications(*rds.DescribeValidDBInstanceModificationsInput) (*rds.DescribeValidDBInstanceModificationsOutput, error) DescribeValidDBInstanceModificationsWithContext(aws.Context, *rds.DescribeValidDBInstanceModificationsInput, ...request.Option) (*rds.DescribeValidDBInstanceModificationsOutput, error) DescribeValidDBInstanceModificationsRequest(*rds.DescribeValidDBInstanceModificationsInput) (*request.Request, *rds.DescribeValidDBInstanceModificationsOutput) diff --git a/service/rekognition/api.go b/service/rekognition/api.go index 22725fcf6de..a61fe9507e3 100644 --- a/service/rekognition/api.go +++ b/service/rekognition/api.go @@ -332,6 +332,7 @@ func (c *Rekognition) CreateProjectRequest(input *CreateProjectInput) (req *requ // // Returned Error Types: // * ResourceInUseException +// The specified resource is already being used. // // * LimitExceededException // An Amazon Rekognition service limit was exceeded. For example, if you start @@ -446,6 +447,7 @@ func (c *Rekognition) CreateProjectVersionRequest(input *CreateProjectVersionInp // // Returned Error Types: // * ResourceInUseException +// The specified resource is already being used. // // * ResourceNotFoundException // The collection specified in the request cannot be found. @@ -585,6 +587,7 @@ func (c *Rekognition) CreateStreamProcessorRequest(input *CreateStreamProcessorI // below the Amazon Rekognition service limit. // // * ResourceInUseException +// The specified resource is already being used. // // * ProvisionedThroughputExceededException // The number of requests exceeded your throughput limit. If you want to increase @@ -850,8 +853,8 @@ func (c *Rekognition) DeleteProjectRequest(input *DeleteProjectInput) (req *requ // DeleteProject API operation for Amazon Rekognition. // // Deletes an Amazon Rekognition Custom Labels project. To delete a project -// you must first delete all versions of the model associated with the project. -// To delete a version of a model, see DeleteProjectVersion. +// you must first delete all models associated with the project. To delete a +// model, see DeleteProjectVersion. // // This operation requires permissions to perform the rekognition:DeleteProject // action. @@ -865,6 +868,7 @@ func (c *Rekognition) DeleteProjectRequest(input *DeleteProjectInput) (req *requ // // Returned Error Types: // * ResourceInUseException +// The specified resource is already being used. // // * ResourceNotFoundException // The collection specified in the request cannot be found. @@ -950,11 +954,12 @@ func (c *Rekognition) DeleteProjectVersionRequest(input *DeleteProjectVersionInp // DeleteProjectVersion API operation for Amazon Rekognition. // -// Deletes a version of a model. +// Deletes an Amazon Rekognition Custom Labels model. // -// You must first stop the model before you can delete it. To check if a model -// is running, use the Status field returned from DescribeProjectVersions. To -// stop a running model call StopProjectVersion. +// You can't delete a model if it is running or if it is training. To check +// the status of a model, use the Status field returned from DescribeProjectVersions. +// To stop a running model call StopProjectVersion. If the model is training, +// wait until it finishes. // // This operation requires permissions to perform the rekognition:DeleteProjectVersion // action. @@ -971,6 +976,7 @@ func (c *Rekognition) DeleteProjectVersionRequest(input *DeleteProjectVersionInp // The collection specified in the request cannot be found. // // * ResourceInUseException +// The specified resource is already being used. // // * InvalidParameterException // Input parameter violated a constraint. Validate your parameter before calling @@ -1085,6 +1091,7 @@ func (c *Rekognition) DeleteStreamProcessorRequest(input *DeleteStreamProcessorI // The collection specified in the request cannot be found. // // * ResourceInUseException +// The specified resource is already being used. // // * ProvisionedThroughputExceededException // The number of requests exceeded your throughput limit. If you want to increase @@ -3527,6 +3534,192 @@ func (c *Rekognition) GetPersonTrackingPagesWithContext(ctx aws.Context, input * return p.Err() } +const opGetSegmentDetection = "GetSegmentDetection" + +// GetSegmentDetectionRequest generates a "aws/request.Request" representing the +// client's request for the GetSegmentDetection 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 GetSegmentDetection for more information on using the GetSegmentDetection +// 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 GetSegmentDetectionRequest method. +// req, resp := client.GetSegmentDetectionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +func (c *Rekognition) GetSegmentDetectionRequest(input *GetSegmentDetectionInput) (req *request.Request, output *GetSegmentDetectionOutput) { + op := &request.Operation{ + Name: opGetSegmentDetection, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetSegmentDetectionInput{} + } + + output = &GetSegmentDetectionOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetSegmentDetection API operation for Amazon Rekognition. +// +// Gets the segment detection results of a Amazon Rekognition Video analysis +// started by StartSegmentDetection. +// +// Segment detection with Amazon Rekognition Video is an asynchronous operation. +// You start segment detection by calling StartSegmentDetection which returns +// a job identifier (JobId). When the segment detection operation finishes, +// Amazon Rekognition publishes a completion status to the Amazon Simple Notification +// Service topic registered in the initial call to StartSegmentDetection. To +// get the results of the segment detection operation, first check that the +// status value published to the Amazon SNS topic is SUCCEEDED. if so, call +// GetSegmentDetection and pass the job identifier (JobId) from the initial +// call of StartSegmentDetection. +// +// GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection +// objects. Segments is sorted by the segment types specified in the SegmentTypes +// input parameter of StartSegmentDetection. Each element of the array includes +// the detected segment, the precentage confidence in the acuracy of the detected +// segment, the type of the segment, and the frame in which the segment was +// detected. +// +// Use SelectedSegmentTypes to find out the type of segment detection requested +// in the call to StartSegmentDetection. +// +// Use the MaxResults parameter to limit the number of segment detections returned. +// If there are more results than specified in MaxResults, the value of NextToken +// in the operation response contains a pagination token for getting the next +// set of results. To get the next page of results, call GetSegmentDetection +// and populate the NextToken request parameter with the token value returned +// from the previous call to GetSegmentDetection. +// +// For more information, see Detecting Video Segments in Stored Video in the +// Amazon Rekognition Developer 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 +// the error. +// +// See the AWS API reference guide for Amazon Rekognition's +// API operation GetSegmentDetection for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You are not authorized to perform the action. +// +// * InternalServerError +// Amazon Rekognition experienced a service issue. Try your call again. +// +// * InvalidParameterException +// Input parameter violated a constraint. Validate your parameter before calling +// the API operation again. +// +// * InvalidPaginationTokenException +// Pagination token in the request is not valid. +// +// * ProvisionedThroughputExceededException +// The number of requests exceeded your throughput limit. If you want to increase +// this limit, contact Amazon Rekognition. +// +// * ResourceNotFoundException +// The collection specified in the request cannot be found. +// +// * ThrottlingException +// Amazon Rekognition is temporarily unable to process the request. Try your +// call again. +// +func (c *Rekognition) GetSegmentDetection(input *GetSegmentDetectionInput) (*GetSegmentDetectionOutput, error) { + req, out := c.GetSegmentDetectionRequest(input) + return out, req.Send() +} + +// GetSegmentDetectionWithContext is the same as GetSegmentDetection with the addition of +// the ability to pass a context and additional request options. +// +// See GetSegmentDetection 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 *Rekognition) GetSegmentDetectionWithContext(ctx aws.Context, input *GetSegmentDetectionInput, opts ...request.Option) (*GetSegmentDetectionOutput, error) { + req, out := c.GetSegmentDetectionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetSegmentDetectionPages iterates over the pages of a GetSegmentDetection operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetSegmentDetection 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 GetSegmentDetection operation. +// pageNum := 0 +// err := client.GetSegmentDetectionPages(params, +// func(page *rekognition.GetSegmentDetectionOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Rekognition) GetSegmentDetectionPages(input *GetSegmentDetectionInput, fn func(*GetSegmentDetectionOutput, bool) bool) error { + return c.GetSegmentDetectionPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetSegmentDetectionPagesWithContext same as GetSegmentDetectionPages 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 *Rekognition) GetSegmentDetectionPagesWithContext(ctx aws.Context, input *GetSegmentDetectionInput, fn func(*GetSegmentDetectionOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetSegmentDetectionInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetSegmentDetectionRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetSegmentDetectionOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opGetTextDetection = "GetTextDetection" // GetTextDetectionRequest generates a "aws/request.Request" representing the @@ -3777,7 +3970,7 @@ func (c *Rekognition) IndexFacesRequest(input *IndexFacesInput) (req *request.Re // For more information, see Model Versioning in the Amazon Rekognition Developer // Guide. // -// If you provide the optional ExternalImageID for the input image you provided, +// If you provide the optional ExternalImageId for the input image you provided, // Amazon Rekognition associates this ID with all faces that it detects. When // you call the ListFaces operation, the response returns the external ID. You // can use this external image ID to create a client-side index to associate @@ -5580,6 +5773,7 @@ func (c *Rekognition) StartProjectVersionRequest(input *StartProjectVersionInput // The collection specified in the request cannot be found. // // * ResourceInUseException +// The specified resource is already being used. // // * LimitExceededException // An Amazon Rekognition service limit was exceeded. For example, if you start @@ -5627,6 +5821,137 @@ func (c *Rekognition) StartProjectVersionWithContext(ctx aws.Context, input *Sta return out, req.Send() } +const opStartSegmentDetection = "StartSegmentDetection" + +// StartSegmentDetectionRequest generates a "aws/request.Request" representing the +// client's request for the StartSegmentDetection 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 StartSegmentDetection for more information on using the StartSegmentDetection +// 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 StartSegmentDetectionRequest method. +// req, resp := client.StartSegmentDetectionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +func (c *Rekognition) StartSegmentDetectionRequest(input *StartSegmentDetectionInput) (req *request.Request, output *StartSegmentDetectionOutput) { + op := &request.Operation{ + Name: opStartSegmentDetection, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StartSegmentDetectionInput{} + } + + output = &StartSegmentDetectionOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartSegmentDetection API operation for Amazon Rekognition. +// +// Starts asynchronous detection of segment detection in a stored video. +// +// Amazon Rekognition Video can detect segments in a video stored in an Amazon +// S3 bucket. Use Video to specify the bucket name and the filename of the video. +// StartSegmentDetection returns a job identifier (JobId) which you use to get +// the results of the operation. When segment detection is finished, Amazon +// Rekognition Video publishes a completion status to the Amazon Simple Notification +// Service topic that you specify in NotificationChannel. +// +// You can use the Filters (StartSegmentDetectionFilters) input parameter to +// specify the minimum detection confidence returned in the response. Within +// Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. +// Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical +// cues. +// +// To get the results of the segment detection operation, first check that the +// status value published to the Amazon SNS topic is SUCCEEDED. if so, call +// GetSegmentDetection and pass the job identifier (JobId) from the initial +// call to StartSegmentDetection. +// +// For more information, see Detecting Video Segments in Stored Video in the +// Amazon Rekognition Developer 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 +// the error. +// +// See the AWS API reference guide for Amazon Rekognition's +// API operation StartSegmentDetection for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You are not authorized to perform the action. +// +// * IdempotentParameterMismatchException +// A ClientRequestToken input parameter was reused with an operation, but at +// least one of the other input parameters is different from the previous call +// to the operation. +// +// * InvalidParameterException +// Input parameter violated a constraint. Validate your parameter before calling +// the API operation again. +// +// * InvalidS3ObjectException +// Amazon Rekognition is unable to access the S3 object specified in the request. +// +// * InternalServerError +// Amazon Rekognition experienced a service issue. Try your call again. +// +// * VideoTooLargeException +// The file size or duration of the supplied media is too large. The maximum +// file size is 10GB. The maximum duration is 6 hours. +// +// * ProvisionedThroughputExceededException +// The number of requests exceeded your throughput limit. If you want to increase +// this limit, contact Amazon Rekognition. +// +// * LimitExceededException +// An Amazon Rekognition service limit was exceeded. For example, if you start +// too many Amazon Rekognition Video jobs concurrently, calls to start operations +// (StartLabelDetection, for example) will raise a LimitExceededException exception +// (HTTP status code: 400) until the number of concurrently running jobs is +// below the Amazon Rekognition service limit. +// +// * ThrottlingException +// Amazon Rekognition is temporarily unable to process the request. Try your +// call again. +// +func (c *Rekognition) StartSegmentDetection(input *StartSegmentDetectionInput) (*StartSegmentDetectionOutput, error) { + req, out := c.StartSegmentDetectionRequest(input) + return out, req.Send() +} + +// StartSegmentDetectionWithContext is the same as StartSegmentDetection with the addition of +// the ability to pass a context and additional request options. +// +// See StartSegmentDetection 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 *Rekognition) StartSegmentDetectionWithContext(ctx aws.Context, input *StartSegmentDetectionInput, opts ...request.Option) (*StartSegmentDetectionOutput, error) { + req, out := c.StartSegmentDetectionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opStartStreamProcessor = "StartStreamProcessor" // StartStreamProcessorRequest generates a "aws/request.Request" representing the @@ -5700,6 +6025,7 @@ func (c *Rekognition) StartStreamProcessorRequest(input *StartStreamProcessorInp // The collection specified in the request cannot be found. // // * ResourceInUseException +// The specified resource is already being used. // // * ProvisionedThroughputExceededException // The number of requests exceeded your throughput limit. If you want to increase @@ -5905,6 +6231,7 @@ func (c *Rekognition) StopProjectVersionRequest(input *StopProjectVersionInput) // The collection specified in the request cannot be found. // // * ResourceInUseException +// The specified resource is already being used. // // * InvalidParameterException // Input parameter violated a constraint. Validate your parameter before calling @@ -6016,6 +6343,7 @@ func (c *Rekognition) StopStreamProcessorRequest(input *StopStreamProcessorInput // The collection specified in the request cannot be found. // // * ResourceInUseException +// The specified resource is already being used. // // * ProvisionedThroughputExceededException // The number of requests exceeded your throughput limit. If you want to increase @@ -6176,38 +6504,90 @@ func (s *Asset) SetGroundTruthManifest(v *GroundTruthManifest) *Asset { return s } -// Indicates whether or not the face has a beard, and the confidence level in -// the determination. -type Beard struct { +// Metadata information about an audio stream. An array of AudioMetadata objects +// for the audio streams found in a stored video is returned by GetSegmentDetection. +type AudioMetadata struct { _ struct{} `type:"structure"` - // Level of confidence in the determination. - Confidence *float64 `type:"float"` + // The audio codec used to encode or decode the audio stream. + Codec *string `type:"string"` - // Boolean value that indicates whether the face has beard or not. - Value *bool `type:"boolean"` + // The duration of the audio stream in milliseconds. + DurationMillis *int64 `type:"long"` + + // The number of audio channels in the segement. + NumberOfChannels *int64 `type:"long"` + + // The sample rate for the audio stream. + SampleRate *int64 `type:"long"` } // String returns the string representation -func (s Beard) String() string { +func (s AudioMetadata) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s Beard) GoString() string { +func (s AudioMetadata) GoString() string { return s.String() } -// SetConfidence sets the Confidence field's value. -func (s *Beard) SetConfidence(v float64) *Beard { - s.Confidence = &v +// SetCodec sets the Codec field's value. +func (s *AudioMetadata) SetCodec(v string) *AudioMetadata { + s.Codec = &v return s } -// SetValue sets the Value field's value. -func (s *Beard) SetValue(v bool) *Beard { - s.Value = &v - return s +// SetDurationMillis sets the DurationMillis field's value. +func (s *AudioMetadata) SetDurationMillis(v int64) *AudioMetadata { + s.DurationMillis = &v + return s +} + +// SetNumberOfChannels sets the NumberOfChannels field's value. +func (s *AudioMetadata) SetNumberOfChannels(v int64) *AudioMetadata { + s.NumberOfChannels = &v + return s +} + +// SetSampleRate sets the SampleRate field's value. +func (s *AudioMetadata) SetSampleRate(v int64) *AudioMetadata { + s.SampleRate = &v + return s +} + +// Indicates whether or not the face has a beard, and the confidence level in +// the determination. +type Beard struct { + _ struct{} `type:"structure"` + + // Level of confidence in the determination. + Confidence *float64 `type:"float"` + + // Boolean value that indicates whether the face has beard or not. + Value *bool `type:"boolean"` +} + +// String returns the string representation +func (s Beard) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Beard) GoString() string { + return s.String() +} + +// SetConfidence sets the Confidence field's value. +func (s *Beard) SetConfidence(v float64) *Beard { + s.Confidence = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Beard) SetValue(v bool) *Beard { + s.Value = &v + return s } // Identifies the bounding box around the label, face, or text. The left (x-coordinate) @@ -7720,7 +8100,9 @@ type DescribeProjectVersionsInput struct { // A list of model version names that you want to describe. You can add up to // 10 model version names to the list. If you don't specify a value, all model - // descriptions are returned. + // descriptions are returned. A version name is part of a model (ProjectVersion) + // ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the + // following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123. VersionNames []*string `min:"1" type:"list"` } @@ -10275,10 +10657,162 @@ func (s *GetPersonTrackingOutput) SetVideoMetadata(v *VideoMetadata) *GetPersonT return s } +type GetSegmentDetectionInput struct { + _ struct{} `type:"structure"` + + // Job identifier for the text detection operation for which you want results + // returned. You get the job identifer from an initial call to StartSegmentDetection. + // + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` + + // Maximum number of results to return per paginated call. The largest value + // you can specify is 1000. + MaxResults *int64 `min:"1" type:"integer"` + + // If the response is truncated, Amazon Rekognition Video returns this token + // that you can use in the subsequent request to retrieve the next set of text. + NextToken *string `type:"string"` +} + +// String returns the string representation +func (s GetSegmentDetectionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetSegmentDetectionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetSegmentDetectionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetSegmentDetectionInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) + } + if s.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobId sets the JobId field's value. +func (s *GetSegmentDetectionInput) SetJobId(v string) *GetSegmentDetectionInput { + s.JobId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetSegmentDetectionInput) SetMaxResults(v int64) *GetSegmentDetectionInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetSegmentDetectionInput) SetNextToken(v string) *GetSegmentDetectionInput { + s.NextToken = &v + return s +} + +type GetSegmentDetectionOutput struct { + _ struct{} `type:"structure"` + + // An array of objects. There can be multiple audio streams. Each AudioMetadata + // object contains metadata for a single audio stream. Audio information in + // an AudioMetadata objects includes the audio codec, the number of audio channels, + // the duration of the audio stream, and the sample rate. Audio metadata is + // returned in each page of information returned by GetSegmentDetection. + AudioMetadata []*AudioMetadata `type:"list"` + + // Current status of the segment detection job. + JobStatus *string `type:"string" enum:"VideoJobStatus"` + + // If the previous response was incomplete (because there are more labels to + // retrieve), Amazon Rekognition Video returns a pagination token in the response. + // You can use this pagination token to retrieve the next set of text. + NextToken *string `type:"string"` + + // An array of segments detected in a video. + Segments []*SegmentDetection `type:"list"` + + // An array containing the segment types requested in the call to StartSegmentDetection. + SelectedSegmentTypes []*SegmentTypeInfo `type:"list"` + + // If the job fails, StatusMessage provides a descriptive error message. + StatusMessage *string `type:"string"` + + // Currently, Amazon Rekognition Video returns a single object in the VideoMetadata + // array. The object contains information about the video stream in the input + // file that Amazon Rekognition Video chose to analyze. The VideoMetadata object + // includes the video codec, video format and other information. Video metadata + // is returned in each page of information returned by GetSegmentDetection. + VideoMetadata []*VideoMetadata `type:"list"` +} + +// String returns the string representation +func (s GetSegmentDetectionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetSegmentDetectionOutput) GoString() string { + return s.String() +} + +// SetAudioMetadata sets the AudioMetadata field's value. +func (s *GetSegmentDetectionOutput) SetAudioMetadata(v []*AudioMetadata) *GetSegmentDetectionOutput { + s.AudioMetadata = v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *GetSegmentDetectionOutput) SetJobStatus(v string) *GetSegmentDetectionOutput { + s.JobStatus = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetSegmentDetectionOutput) SetNextToken(v string) *GetSegmentDetectionOutput { + s.NextToken = &v + return s +} + +// SetSegments sets the Segments field's value. +func (s *GetSegmentDetectionOutput) SetSegments(v []*SegmentDetection) *GetSegmentDetectionOutput { + s.Segments = v + return s +} + +// SetSelectedSegmentTypes sets the SelectedSegmentTypes field's value. +func (s *GetSegmentDetectionOutput) SetSelectedSegmentTypes(v []*SegmentTypeInfo) *GetSegmentDetectionOutput { + s.SelectedSegmentTypes = v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *GetSegmentDetectionOutput) SetStatusMessage(v string) *GetSegmentDetectionOutput { + s.StatusMessage = &v + return s +} + +// SetVideoMetadata sets the VideoMetadata field's value. +func (s *GetSegmentDetectionOutput) SetVideoMetadata(v []*VideoMetadata) *GetSegmentDetectionOutput { + s.VideoMetadata = v + return s +} + type GetTextDetectionInput struct { _ struct{} `type:"structure"` - // Job identifier for the label detection operation for which you want results + // Job identifier for the text detection operation for which you want results // returned. You get the job identifer from an initial call to StartTextDetection. // // JobId is a required field @@ -10512,7 +11046,9 @@ type HumanLoopConfig struct { // Sets attributes of the input data. DataAttributes *HumanLoopDataAttributes `type:"structure"` - // The Amazon Resource Name (ARN) of the flow definition. + // The Amazon Resource Name (ARN) of the flow definition. You can create a flow + // definition by using the Amazon Sagemaker CreateFlowDefinition (https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html) + // Operation. // // FlowDefinitionArn is a required field FlowDefinitionArn *string `type:"string" required:"true"` @@ -10604,10 +11140,13 @@ type HumanLoopQuotaExceededException struct { Message_ *string `locationName:"message" type:"string"` + // The quota code. QuotaCode *string `type:"string"` + // The resource type. ResourceType *string `type:"string"` + // The service code. ServiceCode *string `type:"string"` } @@ -12793,6 +13332,7 @@ func (s *ResourceAlreadyExistsException) RequestID() string { return s.RespMetadata.RequestID } +// The specified resource is already being used. type ResourceInUseException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -13314,6 +13854,180 @@ func (s *SearchFacesOutput) SetSearchedFaceId(v string) *SearchFacesOutput { return s } +// A technical cue or shot detection segment detected in a video. An array of +// SegmentDetection objects containing all segments detected in a stored video +// is returned by GetSegmentDetection. +type SegmentDetection struct { + _ struct{} `type:"structure"` + + // The duration of the detected segment in milliseconds. + DurationMillis *int64 `type:"long"` + + // The duration of the timecode for the detected segment in SMPTE format. + DurationSMPTE *string `type:"string"` + + // The frame-accurate SMPTE timecode, from the start of a video, for the end + // of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for + // drop frame-rates). + EndTimecodeSMPTE *string `type:"string"` + + // The end time of the detected segment, in milliseconds, from the start of + // the video. + EndTimestampMillis *int64 `type:"long"` + + // If the segment is a shot detection, contains information about the shot detection. + ShotSegment *ShotSegment `type:"structure"` + + // The frame-accurate SMPTE timecode, from the start of a video, for the start + // of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for + // drop frame-rates). + StartTimecodeSMPTE *string `type:"string"` + + // The start time of the detected segment in milliseconds from the start of + // the video. + StartTimestampMillis *int64 `type:"long"` + + // If the segment is a technical cue, contains information about the technical + // cue. + TechnicalCueSegment *TechnicalCueSegment `type:"structure"` + + // The type of the segment. Valid values are TECHNICAL_CUE and SHOT. + Type *string `type:"string" enum:"SegmentType"` +} + +// String returns the string representation +func (s SegmentDetection) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SegmentDetection) GoString() string { + return s.String() +} + +// SetDurationMillis sets the DurationMillis field's value. +func (s *SegmentDetection) SetDurationMillis(v int64) *SegmentDetection { + s.DurationMillis = &v + return s +} + +// SetDurationSMPTE sets the DurationSMPTE field's value. +func (s *SegmentDetection) SetDurationSMPTE(v string) *SegmentDetection { + s.DurationSMPTE = &v + return s +} + +// SetEndTimecodeSMPTE sets the EndTimecodeSMPTE field's value. +func (s *SegmentDetection) SetEndTimecodeSMPTE(v string) *SegmentDetection { + s.EndTimecodeSMPTE = &v + return s +} + +// SetEndTimestampMillis sets the EndTimestampMillis field's value. +func (s *SegmentDetection) SetEndTimestampMillis(v int64) *SegmentDetection { + s.EndTimestampMillis = &v + return s +} + +// SetShotSegment sets the ShotSegment field's value. +func (s *SegmentDetection) SetShotSegment(v *ShotSegment) *SegmentDetection { + s.ShotSegment = v + return s +} + +// SetStartTimecodeSMPTE sets the StartTimecodeSMPTE field's value. +func (s *SegmentDetection) SetStartTimecodeSMPTE(v string) *SegmentDetection { + s.StartTimecodeSMPTE = &v + return s +} + +// SetStartTimestampMillis sets the StartTimestampMillis field's value. +func (s *SegmentDetection) SetStartTimestampMillis(v int64) *SegmentDetection { + s.StartTimestampMillis = &v + return s +} + +// SetTechnicalCueSegment sets the TechnicalCueSegment field's value. +func (s *SegmentDetection) SetTechnicalCueSegment(v *TechnicalCueSegment) *SegmentDetection { + s.TechnicalCueSegment = v + return s +} + +// SetType sets the Type field's value. +func (s *SegmentDetection) SetType(v string) *SegmentDetection { + s.Type = &v + return s +} + +// Information about the type of a segment requested in a call to StartSegmentDetection. +// An array of SegmentTypeInfo objects is returned by the response from GetSegmentDetection. +type SegmentTypeInfo struct { + _ struct{} `type:"structure"` + + // The version of the model used to detect segments. + ModelVersion *string `type:"string"` + + // The type of a segment (technical cue or shot detection). + Type *string `type:"string" enum:"SegmentType"` +} + +// String returns the string representation +func (s SegmentTypeInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SegmentTypeInfo) GoString() string { + return s.String() +} + +// SetModelVersion sets the ModelVersion field's value. +func (s *SegmentTypeInfo) SetModelVersion(v string) *SegmentTypeInfo { + s.ModelVersion = &v + return s +} + +// SetType sets the Type field's value. +func (s *SegmentTypeInfo) SetType(v string) *SegmentTypeInfo { + s.Type = &v + return s +} + +// Information about a shot detection segment detected in a video. For more +// information, see SegmentDetection. +type ShotSegment struct { + _ struct{} `type:"structure"` + + // The confidence that Amazon Rekognition Video has in the accuracy of the detected + // segment. + Confidence *float64 `min:"50" type:"float"` + + // An Identifier for a shot detection segment detected in a video + Index *int64 `type:"long"` +} + +// String returns the string representation +func (s ShotSegment) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ShotSegment) GoString() string { + return s.String() +} + +// SetConfidence sets the Confidence field's value. +func (s *ShotSegment) SetConfidence(v float64) *ShotSegment { + s.Confidence = &v + return s +} + +// SetIndex sets the Index field's value. +func (s *ShotSegment) SetIndex(v int64) *ShotSegment { + s.Index = &v + return s +} + // Indicates whether or not the face is smiling, and the confidence level in // the determination. type Smile struct { @@ -14182,6 +14896,251 @@ func (s *StartProjectVersionOutput) SetStatus(v string) *StartProjectVersionOutp return s } +// Filters applied to the technical cue or shot detection segments. For more +// information, see StartSegmentDetection. +type StartSegmentDetectionFilters struct { + _ struct{} `type:"structure"` + + // Filters that are specific to shot detections. + ShotFilter *StartShotDetectionFilter `type:"structure"` + + // Filters that are specific to technical cues. + TechnicalCueFilter *StartTechnicalCueDetectionFilter `type:"structure"` +} + +// String returns the string representation +func (s StartSegmentDetectionFilters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartSegmentDetectionFilters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartSegmentDetectionFilters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartSegmentDetectionFilters"} + if s.ShotFilter != nil { + if err := s.ShotFilter.Validate(); err != nil { + invalidParams.AddNested("ShotFilter", err.(request.ErrInvalidParams)) + } + } + if s.TechnicalCueFilter != nil { + if err := s.TechnicalCueFilter.Validate(); err != nil { + invalidParams.AddNested("TechnicalCueFilter", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetShotFilter sets the ShotFilter field's value. +func (s *StartSegmentDetectionFilters) SetShotFilter(v *StartShotDetectionFilter) *StartSegmentDetectionFilters { + s.ShotFilter = v + return s +} + +// SetTechnicalCueFilter sets the TechnicalCueFilter field's value. +func (s *StartSegmentDetectionFilters) SetTechnicalCueFilter(v *StartTechnicalCueDetectionFilter) *StartSegmentDetectionFilters { + s.TechnicalCueFilter = v + return s +} + +type StartSegmentDetectionInput struct { + _ struct{} `type:"structure"` + + // Idempotent token used to identify the start request. If you use the same + // token with multiple StartSegmentDetection requests, the same JobId is returned. + // Use ClientRequestToken to prevent the same job from being accidently started + // more than once. + ClientRequestToken *string `min:"1" type:"string"` + + // Filters for technical cue or shot detection. + Filters *StartSegmentDetectionFilters `type:"structure"` + + // An identifier you specify that's returned in the completion notification + // that's published to your Amazon Simple Notification Service topic. For example, + // you can use JobTag to group related jobs and identify them in the completion + // notification. + JobTag *string `min:"1" type:"string"` + + // The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video + // to publish the completion status of the segment detection operation. + NotificationChannel *NotificationChannel `type:"structure"` + + // An array of segment types to detect in the video. Valid values are TECHNICAL_CUE + // and SHOT. + // + // SegmentTypes is a required field + SegmentTypes []*string `min:"1" type:"list" required:"true"` + + // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start + // operations such as StartLabelDetection use Video to specify a video for analysis. + // The supported file formats are .mp4, .mov and .avi. + // + // Video is a required field + Video *Video `type:"structure" required:"true"` +} + +// String returns the string representation +func (s StartSegmentDetectionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartSegmentDetectionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartSegmentDetectionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartSegmentDetectionInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) + } + if s.JobTag != nil && len(*s.JobTag) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobTag", 1)) + } + if s.SegmentTypes == nil { + invalidParams.Add(request.NewErrParamRequired("SegmentTypes")) + } + if s.SegmentTypes != nil && len(s.SegmentTypes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SegmentTypes", 1)) + } + if s.Video == nil { + invalidParams.Add(request.NewErrParamRequired("Video")) + } + if s.Filters != nil { + if err := s.Filters.Validate(); err != nil { + invalidParams.AddNested("Filters", err.(request.ErrInvalidParams)) + } + } + if s.NotificationChannel != nil { + if err := s.NotificationChannel.Validate(); err != nil { + invalidParams.AddNested("NotificationChannel", err.(request.ErrInvalidParams)) + } + } + if s.Video != nil { + if err := s.Video.Validate(); err != nil { + invalidParams.AddNested("Video", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *StartSegmentDetectionInput) SetClientRequestToken(v string) *StartSegmentDetectionInput { + s.ClientRequestToken = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *StartSegmentDetectionInput) SetFilters(v *StartSegmentDetectionFilters) *StartSegmentDetectionInput { + s.Filters = v + return s +} + +// SetJobTag sets the JobTag field's value. +func (s *StartSegmentDetectionInput) SetJobTag(v string) *StartSegmentDetectionInput { + s.JobTag = &v + return s +} + +// SetNotificationChannel sets the NotificationChannel field's value. +func (s *StartSegmentDetectionInput) SetNotificationChannel(v *NotificationChannel) *StartSegmentDetectionInput { + s.NotificationChannel = v + return s +} + +// SetSegmentTypes sets the SegmentTypes field's value. +func (s *StartSegmentDetectionInput) SetSegmentTypes(v []*string) *StartSegmentDetectionInput { + s.SegmentTypes = v + return s +} + +// SetVideo sets the Video field's value. +func (s *StartSegmentDetectionInput) SetVideo(v *Video) *StartSegmentDetectionInput { + s.Video = v + return s +} + +type StartSegmentDetectionOutput struct { + _ struct{} `type:"structure"` + + // Unique identifier for the segment detection job. The JobId is returned from + // StartSegmentDetection. + JobId *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s StartSegmentDetectionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartSegmentDetectionOutput) GoString() string { + return s.String() +} + +// SetJobId sets the JobId field's value. +func (s *StartSegmentDetectionOutput) SetJobId(v string) *StartSegmentDetectionOutput { + s.JobId = &v + return s +} + +// Filters for the shot detection segments returned by GetSegmentDetection. +// For more information, see StartSegmentDetectionFilters. +type StartShotDetectionFilter struct { + _ struct{} `type:"structure"` + + // Specifies the minimum confidence that Amazon Rekognition Video must have + // in order to return a detected segment. Confidence represents how certain + // Amazon Rekognition is that a segment is correctly identified. 0 is the lowest + // confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't + // return any segments with a confidence level lower than this specified value. + // + // If you don't specify MinSegmentConfidence, the GetSegmentDetection returns + // segments with confidence values greater than or equal to 50 percent. + MinSegmentConfidence *float64 `min:"50" type:"float"` +} + +// String returns the string representation +func (s StartShotDetectionFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartShotDetectionFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartShotDetectionFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartShotDetectionFilter"} + if s.MinSegmentConfidence != nil && *s.MinSegmentConfidence < 50 { + invalidParams.Add(request.NewErrParamMinValue("MinSegmentConfidence", 50)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMinSegmentConfidence sets the MinSegmentConfidence field's value. +func (s *StartShotDetectionFilter) SetMinSegmentConfidence(v float64) *StartShotDetectionFilter { + s.MinSegmentConfidence = &v + return s +} + type StartStreamProcessorInput struct { _ struct{} `type:"structure"` @@ -14237,6 +15196,51 @@ func (s StartStreamProcessorOutput) GoString() string { return s.String() } +// Filters for the technical segments returned by GetSegmentDetection. For more +// information, see StartSegmentDetectionFilters. +type StartTechnicalCueDetectionFilter struct { + _ struct{} `type:"structure"` + + // Specifies the minimum confidence that Amazon Rekognition Video must have + // in order to return a detected segment. Confidence represents how certain + // Amazon Rekognition is that a segment is correctly identified. 0 is the lowest + // confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't + // return any segments with a confidence level lower than this specified value. + // + // If you don't specify MinSegmentConfidence, GetSegmentDetection returns segments + // with confidence values greater than or equal to 50 percent. + MinSegmentConfidence *float64 `min:"50" type:"float"` +} + +// String returns the string representation +func (s StartTechnicalCueDetectionFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartTechnicalCueDetectionFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartTechnicalCueDetectionFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartTechnicalCueDetectionFilter"} + if s.MinSegmentConfidence != nil && *s.MinSegmentConfidence < 50 { + invalidParams.Add(request.NewErrParamMinValue("MinSegmentConfidence", 50)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMinSegmentConfidence sets the MinSegmentConfidence field's value. +func (s *StartTechnicalCueDetectionFilter) SetMinSegmentConfidence(v float64) *StartTechnicalCueDetectionFilter { + s.MinSegmentConfidence = &v + return s +} + // Set of optional parameters that let you set the criteria text must meet to // be included in your response. WordFilter looks at a word's height, width // and minimum confidence. RegionOfInterest lets you set a specific region of @@ -14718,6 +15722,40 @@ func (s *Sunglasses) SetValue(v bool) *Sunglasses { return s } +// Information about a technical cue segment. For more information, see SegmentDetection. +type TechnicalCueSegment struct { + _ struct{} `type:"structure"` + + // The confidence that Amazon Rekognition Video has in the accuracy of the detected + // segment. + Confidence *float64 `min:"50" type:"float"` + + // The type of the technical cue. + Type *string `type:"string" enum:"TechnicalCueType"` +} + +// String returns the string representation +func (s TechnicalCueSegment) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TechnicalCueSegment) GoString() string { + return s.String() +} + +// SetConfidence sets the Confidence field's value. +func (s *TechnicalCueSegment) SetConfidence(v float64) *TechnicalCueSegment { + s.Confidence = &v + return s +} + +// SetType sets the Type field's value. +func (s *TechnicalCueSegment) SetType(v string) *TechnicalCueSegment { + s.Type = &v + return s +} + // The dataset used for testing. Optionally, if AutoCreate is set, Amazon Rekognition // Custom Labels creates a testing dataset using an 80/20 split of the training // dataset. @@ -15571,6 +16609,14 @@ const ( ReasonLowFaceQuality = "LOW_FACE_QUALITY" ) +const ( + // SegmentTypeTechnicalCue is a SegmentType enum value + SegmentTypeTechnicalCue = "TECHNICAL_CUE" + + // SegmentTypeShot is a SegmentType enum value + SegmentTypeShot = "SHOT" +) + const ( // StreamProcessorStatusStopped is a StreamProcessorStatus enum value StreamProcessorStatusStopped = "STOPPED" @@ -15588,6 +16634,17 @@ const ( StreamProcessorStatusStopping = "STOPPING" ) +const ( + // TechnicalCueTypeColorBars is a TechnicalCueType enum value + TechnicalCueTypeColorBars = "ColorBars" + + // TechnicalCueTypeEndCredits is a TechnicalCueType enum value + TechnicalCueTypeEndCredits = "EndCredits" + + // TechnicalCueTypeBlackFrames is a TechnicalCueType enum value + TechnicalCueTypeBlackFrames = "BlackFrames" +) + const ( // TextTypesLine is a TextTypes enum value TextTypesLine = "LINE" diff --git a/service/rekognition/errors.go b/service/rekognition/errors.go index 6449d54b140..e65541ddb20 100644 --- a/service/rekognition/errors.go +++ b/service/rekognition/errors.go @@ -92,6 +92,8 @@ const ( // ErrCodeResourceInUseException for service response error code // "ResourceInUseException". + // + // The specified resource is already being used. ErrCodeResourceInUseException = "ResourceInUseException" // ErrCodeResourceNotFoundException for service response error code diff --git a/service/rekognition/rekognitioniface/interface.go b/service/rekognition/rekognitioniface/interface.go index ad41dedd41c..9028238ec0d 100644 --- a/service/rekognition/rekognitioniface/interface.go +++ b/service/rekognition/rekognitioniface/interface.go @@ -188,6 +188,13 @@ type RekognitionAPI interface { GetPersonTrackingPages(*rekognition.GetPersonTrackingInput, func(*rekognition.GetPersonTrackingOutput, bool) bool) error GetPersonTrackingPagesWithContext(aws.Context, *rekognition.GetPersonTrackingInput, func(*rekognition.GetPersonTrackingOutput, bool) bool, ...request.Option) error + GetSegmentDetection(*rekognition.GetSegmentDetectionInput) (*rekognition.GetSegmentDetectionOutput, error) + GetSegmentDetectionWithContext(aws.Context, *rekognition.GetSegmentDetectionInput, ...request.Option) (*rekognition.GetSegmentDetectionOutput, error) + GetSegmentDetectionRequest(*rekognition.GetSegmentDetectionInput) (*request.Request, *rekognition.GetSegmentDetectionOutput) + + GetSegmentDetectionPages(*rekognition.GetSegmentDetectionInput, func(*rekognition.GetSegmentDetectionOutput, bool) bool) error + GetSegmentDetectionPagesWithContext(aws.Context, *rekognition.GetSegmentDetectionInput, func(*rekognition.GetSegmentDetectionOutput, bool) bool, ...request.Option) error + GetTextDetection(*rekognition.GetTextDetectionInput) (*rekognition.GetTextDetectionOutput, error) GetTextDetectionWithContext(aws.Context, *rekognition.GetTextDetectionInput, ...request.Option) (*rekognition.GetTextDetectionOutput, error) GetTextDetectionRequest(*rekognition.GetTextDetectionInput) (*request.Request, *rekognition.GetTextDetectionOutput) @@ -260,6 +267,10 @@ type RekognitionAPI interface { StartProjectVersionWithContext(aws.Context, *rekognition.StartProjectVersionInput, ...request.Option) (*rekognition.StartProjectVersionOutput, error) StartProjectVersionRequest(*rekognition.StartProjectVersionInput) (*request.Request, *rekognition.StartProjectVersionOutput) + StartSegmentDetection(*rekognition.StartSegmentDetectionInput) (*rekognition.StartSegmentDetectionOutput, error) + StartSegmentDetectionWithContext(aws.Context, *rekognition.StartSegmentDetectionInput, ...request.Option) (*rekognition.StartSegmentDetectionOutput, error) + StartSegmentDetectionRequest(*rekognition.StartSegmentDetectionInput) (*request.Request, *rekognition.StartSegmentDetectionOutput) + StartStreamProcessor(*rekognition.StartStreamProcessorInput) (*rekognition.StartStreamProcessorOutput, error) StartStreamProcessorWithContext(aws.Context, *rekognition.StartStreamProcessorInput, ...request.Option) (*rekognition.StartStreamProcessorOutput, error) StartStreamProcessorRequest(*rekognition.StartStreamProcessorInput) (*request.Request, *rekognition.StartStreamProcessorOutput) diff --git a/service/sqs/api.go b/service/sqs/api.go index bc087b5b62e..8ca39942689 100644 --- a/service/sqs/api.go +++ b/service/sqs/api.go @@ -81,9 +81,9 @@ func (c *SQS) AddPermissionRequest(input *AddPermissionInput) (req *request.Requ // param.n notation. Values of n are integers starting from 1. For example, // a parameter list with two elements looks like this: // -// &Attribute.1=first +// &AttributeName.1=first // -// &Attribute.2=second +// &AttributeName.2=second // // Cross-account permissions don't apply to this action. For more information, // see Grant Cross-Account Permissions to a Role and a User Name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) @@ -316,9 +316,9 @@ func (c *SQS) ChangeMessageVisibilityBatchRequest(input *ChangeMessageVisibility // param.n notation. Values of n are integers starting from 1. For example, // a parameter list with two elements looks like this: // -// &Attribute.1=first +// &AttributeName.1=first // -// &Attribute.2=second +// &AttributeName.2=second // // 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 @@ -407,7 +407,7 @@ func (c *SQS) CreateQueueRequest(input *CreateQueueInput) (req *request.Request, // CreateQueue API operation for Amazon Simple Queue Service. // // Creates a new standard or FIFO queue. You can pass one or more attributes -// in the request. Keep the following caveats in mind: +// in the request. Keep the following in mind: // // * If you don't specify the FifoQueue attribute, Amazon SQS creates a standard // queue. You can't change the queue type after you create it and you can't @@ -427,6 +427,9 @@ func (c *SQS) CreateQueueRequest(input *CreateQueueInput) (req *request.Request, // to the limits related to queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) // and is unique within the scope of your queues. // +// After you create a queue, you must wait at least one second after the queue +// is created to be able to use the queue. +// // To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only // the QueueName parameter. be aware of existing queue names: // @@ -441,9 +444,9 @@ func (c *SQS) CreateQueueRequest(input *CreateQueueInput) (req *request.Request, // param.n notation. Values of n are integers starting from 1. For example, // a parameter list with two elements looks like this: // -// &Attribute.1=first +// &AttributeName.1=first // -// &Attribute.2=second +// &AttributeName.2=second // // Cross-account permissions don't apply to this action. For more information, // see Grant Cross-Account Permissions to a Role and a User Name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) @@ -646,9 +649,9 @@ func (c *SQS) DeleteMessageBatchRequest(input *DeleteMessageBatchInput) (req *re // param.n notation. Values of n are integers starting from 1. For example, // a parameter list with two elements looks like this: // -// &Attribute.1=first +// &AttributeName.1=first // -// &Attribute.2=second +// &AttributeName.2=second // // 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 @@ -738,7 +741,6 @@ func (c *SQS) DeleteQueueRequest(input *DeleteQueueInput) (req *request.Request, // DeleteQueue API operation for Amazon Simple Queue Service. // // Deletes the queue specified by the QueueUrl, regardless of the queue's contents. -// If the specified queue doesn't exist, Amazon SQS returns a successful response. // // Be careful with the DeleteQueue action: When you delete a queue, any messages // in the queue are no longer available. @@ -832,14 +834,6 @@ func (c *SQS) GetQueueAttributesRequest(input *GetQueueAttributesInput) (req *re // To determine whether a queue is FIFO (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html), // you can check whether QueueName ends with the .fifo suffix. // -// Some actions take lists of parameters. These lists are specified using the -// param.n notation. Values of n are integers starting from 1. For example, -// a parameter list with two elements looks like this: -// -// &Attribute.1=first -// -// &Attribute.2=second -// // 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. @@ -990,6 +984,12 @@ func (c *SQS) ListDeadLetterSourceQueuesRequest(input *ListDeadLetterSourceQueue Name: opListDeadLetterSourceQueues, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { @@ -1043,6 +1043,58 @@ func (c *SQS) ListDeadLetterSourceQueuesWithContext(ctx aws.Context, input *List return out, req.Send() } +// ListDeadLetterSourceQueuesPages iterates over the pages of a ListDeadLetterSourceQueues operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListDeadLetterSourceQueues 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 ListDeadLetterSourceQueues operation. +// pageNum := 0 +// err := client.ListDeadLetterSourceQueuesPages(params, +// func(page *sqs.ListDeadLetterSourceQueuesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *SQS) ListDeadLetterSourceQueuesPages(input *ListDeadLetterSourceQueuesInput, fn func(*ListDeadLetterSourceQueuesOutput, bool) bool) error { + return c.ListDeadLetterSourceQueuesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListDeadLetterSourceQueuesPagesWithContext same as ListDeadLetterSourceQueuesPages 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 *SQS) ListDeadLetterSourceQueuesPagesWithContext(ctx aws.Context, input *ListDeadLetterSourceQueuesInput, fn func(*ListDeadLetterSourceQueuesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListDeadLetterSourceQueuesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListDeadLetterSourceQueuesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListDeadLetterSourceQueuesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListQueueTags = "ListQueueTags" // ListQueueTagsRequest generates a "aws/request.Request" representing the @@ -1154,6 +1206,12 @@ func (c *SQS) ListQueuesRequest(input *ListQueuesInput) (req *request.Request, o Name: opListQueues, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { @@ -1203,6 +1261,58 @@ func (c *SQS) ListQueuesWithContext(ctx aws.Context, input *ListQueuesInput, opt return out, req.Send() } +// ListQueuesPages iterates over the pages of a ListQueues operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListQueues 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 ListQueues operation. +// pageNum := 0 +// err := client.ListQueuesPages(params, +// func(page *sqs.ListQueuesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *SQS) ListQueuesPages(input *ListQueuesInput, fn func(*ListQueuesOutput, bool) bool) error { + return c.ListQueuesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListQueuesPagesWithContext same as ListQueuesPages 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 *SQS) ListQueuesPagesWithContext(ctx aws.Context, input *ListQueuesInput, fn func(*ListQueuesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListQueuesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListQueuesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListQueuesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opPurgeQueue = "PurgeQueue" // PurgeQueueRequest generates a "aws/request.Request" representing the @@ -1676,9 +1786,9 @@ func (c *SQS) SendMessageBatchRequest(input *SendMessageBatchInput) (req *reques // param.n notation. Values of n are integers starting from 1. For example, // a parameter list with two elements looks like this: // -// &Attribute.1=first +// &AttributeName.1=first // -// &Attribute.2=second +// &AttributeName.2=second // // 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 @@ -2129,7 +2239,7 @@ type BatchResultErrorEntry struct { // A message explaining why the action failed on this entry. Message *string `type:"string"` - // Specifies whether the error happened due to the producer. + // Specifies whether the error happened due to the caller of the batch API action. // // SenderFault is a required field SenderFault *bool `type:"boolean" required:"true"` @@ -2290,7 +2400,10 @@ type ChangeMessageVisibilityBatchRequestEntry struct { // An identifier for this particular receipt handle used to communicate the // result. // - // The Ids of a batch request need to be unique within a request + // The Ids of a batch request need to be unique within a request. + // + // This identifier can have up to 80 characters. The following characters are + // accepted: alphanumeric characters, hyphens(-), and underscores (_). // // Id is a required field Id *string `type:"string" required:"true"` @@ -2466,41 +2579,41 @@ type CreateQueueInput struct { // The following lists the names, descriptions, and values of the special request // parameters that the CreateQueue action uses: // - // * DelaySeconds - The length of time, in seconds, for which the delivery + // * DelaySeconds – The length of time, in seconds, for which the delivery // of all messages in the queue is delayed. Valid values: An integer from // 0 to 900 seconds (15 minutes). Default: 0. // - // * MaximumMessageSize - The limit of how many bytes a message can contain + // * MaximumMessageSize – The limit of how many bytes a message can contain // before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes // (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). // - // * MessageRetentionPeriod - The length of time, in seconds, for which Amazon - // SQS retains a message. Valid values: An integer from 60 seconds (1 minute) - // to 1,209,600 seconds (14 days). Default: 345,600 (4 days). + // * MessageRetentionPeriod – The length of time, in seconds, for which + // Amazon SQS retains a message. Valid values: An integer from 60 seconds + // (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). // - // * Policy - The queue's policy. A valid AWS policy. For more information + // * Policy – The queue's policy. A valid AWS policy. For more information // about policy structure, see Overview of AWS IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) // in the Amazon IAM User Guide. // - // * ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for + // * ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for // which a ReceiveMessage action waits for a message to arrive. Valid values: // An integer from 0 to 20 (seconds). Default: 0. // - // * RedrivePolicy - The string that includes the parameters for the dead-letter - // queue functionality of the source queue. For more information about the - // redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter - // Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) + // * RedrivePolicy – The string that includes the parameters for the dead-letter + // queue functionality of the source queue as a JSON object. For more information + // about the redrive policy and dead-letter queues, see Using Amazon SQS + // Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) // in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn - // - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon + // – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon // SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount - // - The number of times a message is delivered to the source queue before + // – The number of times a message is delivered to the source queue before // being moved to the dead-letter queue. When the ReceiveCount for a message // exceeds the maxReceiveCount for a queue, Amazon SQS moves the message // to the dead-letter-queue. The dead-letter queue of a FIFO queue must also // be a FIFO queue. Similarly, the dead-letter queue of a standard queue // must also be a standard queue. // - // * VisibilityTimeout - The visibility timeout for the queue, in seconds. + // * VisibilityTimeout – The visibility timeout for the queue, in seconds. // Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For // more information about the visibility timeout, see Visibility Timeout // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) @@ -2508,15 +2621,15 @@ type CreateQueueInput struct { // // The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html): // - // * KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) + // * KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) // for Amazon SQS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). // While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, // the alias of a custom CMK can, for example, be alias/MyAlias . For more // examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) // in the AWS Key Management Service API Reference. // - // * KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which - // Amazon SQS can reuse a data key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) + // * KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for + // which Amazon SQS can reuse a data key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) // to encrypt or decrypt messages before calling AWS KMS again. An integer // representing seconds, between 60 seconds (1 minute) and 86,400 seconds // (24 hours). Default: 300 (5 minutes). A shorter time period provides better @@ -2526,15 +2639,15 @@ type CreateQueueInput struct { // // The following attributes apply only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html): // - // * FifoQueue - Designates a queue as FIFO. Valid values: true, false. If - // you don't specify the FifoQueue attribute, Amazon SQS creates a standard + // * FifoQueue – Designates a queue as FIFO. Valid values: true, false. + // If you don't specify the FifoQueue attribute, Amazon SQS creates a standard // queue. You can provide this attribute only during queue creation. You // can't change it for an existing queue. When you set this attribute, you // must also provide the MessageGroupId for your messages explicitly. For // more information, see FIFO Queue Logic (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic) // in the Amazon Simple Queue Service Developer Guide. // - // * ContentBasedDeduplication - Enables content-based deduplication. Valid + // * ContentBasedDeduplication – Enables content-based deduplication. Valid // values: true, false. For more information, see Exactly-Once Processing // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing) // in the Amazon Simple Queue Service Developer Guide. Every message must @@ -2771,7 +2884,10 @@ type DeleteMessageBatchRequestEntry struct { // An identifier for this particular receipt handle. This is used to communicate // the result. // - // The Ids of a batch request need to be unique within a request + // The Ids of a batch request need to be unique within a request. + // + // This identifier can have up to 80 characters. The following characters are + // accepted: alphanumeric characters, hyphens(-), and underscores (_). // // Id is a required field Id *string `type:"string" required:"true"` @@ -2979,79 +3095,84 @@ type GetQueueAttributesInput struct { // // The following attributes are supported: // - // * All - Returns all values. + // The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, + // and ApproximateNumberOfMessagesVisible metrics may not achieve consistency + // until at least 1 minute after the producers stop sending messages. This period + // is required for the queue metadata to reach eventual consistency. + // + // * All – Returns all values. // - // * ApproximateNumberOfMessages - Returns the approximate number of messages + // * ApproximateNumberOfMessages – Returns the approximate number of messages // available for retrieval from the queue. // - // * ApproximateNumberOfMessagesDelayed - Returns the approximate number + // * ApproximateNumberOfMessagesDelayed – Returns the approximate number // of messages in the queue that are delayed and not available for reading // immediately. This can happen when the queue is configured as a delay queue // or when a message has been sent with a delay parameter. // - // * ApproximateNumberOfMessagesNotVisible - Returns the approximate number + // * ApproximateNumberOfMessagesNotVisible – Returns the approximate number // of messages that are in flight. Messages are considered to be in flight // if they have been sent to a client but have not yet been deleted or have // not yet reached the end of their visibility window. // - // * CreatedTimestamp - Returns the time when the queue was created in seconds - // (epoch time (http://en.wikipedia.org/wiki/Unix_time)). + // * CreatedTimestamp – Returns the time when the queue was created in + // seconds (epoch time (http://en.wikipedia.org/wiki/Unix_time)). // - // * DelaySeconds - Returns the default delay on the queue in seconds. + // * DelaySeconds – Returns the default delay on the queue in seconds. // - // * LastModifiedTimestamp - Returns the time when the queue was last changed + // * LastModifiedTimestamp – Returns the time when the queue was last changed // in seconds (epoch time (http://en.wikipedia.org/wiki/Unix_time)). // - // * MaximumMessageSize - Returns the limit of how many bytes a message can - // contain before Amazon SQS rejects it. + // * MaximumMessageSize – Returns the limit of how many bytes a message + // can contain before Amazon SQS rejects it. // - // * MessageRetentionPeriod - Returns the length of time, in seconds, for + // * MessageRetentionPeriod – Returns the length of time, in seconds, for // which Amazon SQS retains a message. // - // * Policy - Returns the policy of the queue. + // * Policy – Returns the policy of the queue. // - // * QueueArn - Returns the Amazon resource name (ARN) of the queue. + // * QueueArn – Returns the Amazon resource name (ARN) of the queue. // - // * ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, + // * ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, // for which the ReceiveMessage action waits for a message to arrive. // - // * RedrivePolicy - Returns the string that includes the parameters for - // dead-letter queue functionality of the source queue. For more information + // * RedrivePolicy – The string that includes the parameters for the dead-letter + // queue functionality of the source queue as a JSON object. For more information // about the redrive policy and dead-letter queues, see Using Amazon SQS // Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) // in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn - // - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon + // – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon // SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount - // - The number of times a message is delivered to the source queue before + // – The number of times a message is delivered to the source queue before // being moved to the dead-letter queue. When the ReceiveCount for a message // exceeds the maxReceiveCount for a queue, Amazon SQS moves the message // to the dead-letter-queue. // - // * VisibilityTimeout - Returns the visibility timeout for the queue. For - // more information about the visibility timeout, see Visibility Timeout + // * VisibilityTimeout – Returns the visibility timeout for the queue. + // For more information about the visibility timeout, see Visibility Timeout // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) // in the Amazon Simple Queue Service Developer Guide. // // The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html): // - // * KmsMasterKeyId - Returns the ID of an AWS-managed customer master key - // (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). + // * KmsMasterKeyId – Returns the ID of an AWS-managed customer master + // key (CMK) for Amazon SQS or a custom CMK. For more information, see Key + // Terms (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). // - // * KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, + // * KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, // for which Amazon SQS can reuse a data key to encrypt or decrypt messages // before calling AWS KMS again. For more information, see How Does the Data // Key Reuse Period Work? (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work). // // The following attributes apply only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html): // - // * FifoQueue - Returns whether the queue is FIFO. For more information, + // * FifoQueue – Returns whether the queue is FIFO. For more information, // see FIFO Queue Logic (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic) // in the Amazon Simple Queue Service Developer Guide. To determine whether // a queue is FIFO (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html), // you can check whether QueueName ends with the .fifo suffix. // - // * ContentBasedDeduplication - Returns whether content-based deduplication + // * ContentBasedDeduplication – Returns whether content-based deduplication // is enabled for the queue. For more information, see Exactly-Once Processing // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing) // in the Amazon Simple Queue Service Developer Guide. @@ -3202,6 +3323,12 @@ func (s *GetQueueUrlOutput) SetQueueUrl(v string) *GetQueueUrlOutput { type ListDeadLetterSourceQueuesInput struct { _ struct{} `type:"structure"` + // Maximum number of results to include in the response. + MaxResults *int64 `type:"integer"` + + // Pagination token to request the next set of results. + NextToken *string `type:"string"` + // The URL of a dead-letter queue. // // Queue URLs and names are case-sensitive. @@ -3233,6 +3360,18 @@ func (s *ListDeadLetterSourceQueuesInput) Validate() error { return nil } +// SetMaxResults sets the MaxResults field's value. +func (s *ListDeadLetterSourceQueuesInput) SetMaxResults(v int64) *ListDeadLetterSourceQueuesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDeadLetterSourceQueuesInput) SetNextToken(v string) *ListDeadLetterSourceQueuesInput { + s.NextToken = &v + return s +} + // SetQueueUrl sets the QueueUrl field's value. func (s *ListDeadLetterSourceQueuesInput) SetQueueUrl(v string) *ListDeadLetterSourceQueuesInput { s.QueueUrl = &v @@ -3243,6 +3382,9 @@ func (s *ListDeadLetterSourceQueuesInput) SetQueueUrl(v string) *ListDeadLetterS type ListDeadLetterSourceQueuesOutput struct { _ struct{} `type:"structure"` + // Pagination token to include in the next request. + NextToken *string `type:"string"` + // A list of source queue URLs that have the RedrivePolicy queue attribute configured // with a dead-letter queue. // @@ -3260,6 +3402,12 @@ func (s ListDeadLetterSourceQueuesOutput) GoString() string { return s.String() } +// SetNextToken sets the NextToken field's value. +func (s *ListDeadLetterSourceQueuesOutput) SetNextToken(v string) *ListDeadLetterSourceQueuesOutput { + s.NextToken = &v + return s +} + // SetQueueUrls sets the QueueUrls field's value. func (s *ListDeadLetterSourceQueuesOutput) SetQueueUrls(v []*string) *ListDeadLetterSourceQueuesOutput { s.QueueUrls = v @@ -3330,6 +3478,12 @@ func (s *ListQueueTagsOutput) SetTags(v map[string]*string) *ListQueueTagsOutput type ListQueuesInput struct { _ struct{} `type:"structure"` + // Maximum number of results to include in the response. + MaxResults *int64 `type:"integer"` + + // Pagination token to request the next set of results. + NextToken *string `type:"string"` + // A string to use for filtering the list results. Only those queues whose name // begins with the specified string are returned. // @@ -3347,6 +3501,18 @@ func (s ListQueuesInput) GoString() string { return s.String() } +// SetMaxResults sets the MaxResults field's value. +func (s *ListQueuesInput) SetMaxResults(v int64) *ListQueuesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListQueuesInput) SetNextToken(v string) *ListQueuesInput { + s.NextToken = &v + return s +} + // SetQueueNamePrefix sets the QueueNamePrefix field's value. func (s *ListQueuesInput) SetQueueNamePrefix(v string) *ListQueuesInput { s.QueueNamePrefix = &v @@ -3357,7 +3523,11 @@ func (s *ListQueuesInput) SetQueueNamePrefix(v string) *ListQueuesInput { type ListQueuesOutput struct { _ struct{} `type:"structure"` - // A list of queue URLs, up to 1,000 entries. + // Pagination token to include in the next request. + NextToken *string `type:"string"` + + // A list of queue URLs, up to 1,000 entries, or the value of MaxResults that + // you sent in the request. QueueUrls []*string `locationNameList:"QueueUrl" type:"list" flattened:"true"` } @@ -3371,6 +3541,12 @@ func (s ListQueuesOutput) GoString() string { return s.String() } +// SetNextToken sets the NextToken field's value. +func (s *ListQueuesOutput) SetNextToken(v string) *ListQueuesOutput { + s.NextToken = &v + return s +} + // SetQueueUrls sets the QueueUrls field's value. func (s *ListQueuesOutput) SetQueueUrls(v []*string) *ListQueuesOutput { s.QueueUrls = v @@ -3720,31 +3896,31 @@ type ReceiveMessageInput struct { // A list of attributes that need to be returned along with each message. These // attributes include: // - // * All - Returns all values. + // * All – Returns all values. // - // * ApproximateFirstReceiveTimestamp - Returns the time the message was + // * ApproximateFirstReceiveTimestamp – Returns the time the message was // first received from the queue (epoch time (http://en.wikipedia.org/wiki/Unix_time) // in milliseconds). // - // * ApproximateReceiveCount - Returns the number of times a message has - // been received from the queue but not deleted. + // * ApproximateReceiveCount – Returns the number of times a message has + // been received across all queues but not deleted. // - // * AWSTraceHeader - Returns the AWS X-Ray trace header string. + // * AWSTraceHeader – Returns the AWS X-Ray trace header string. // // * SenderId For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R. // For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456. // - // * SentTimestamp - Returns the time the message was sent to the queue (epoch - // time (http://en.wikipedia.org/wiki/Unix_time) in milliseconds). + // * SentTimestamp – Returns the time the message was sent to the queue + // (epoch time (http://en.wikipedia.org/wiki/Unix_time) in milliseconds). // - // * MessageDeduplicationId - Returns the value provided by the producer + // * MessageDeduplicationId – Returns the value provided by the producer // that calls the SendMessage action. // - // * MessageGroupId - Returns the value provided by the producer that calls + // * MessageGroupId – Returns the value provided by the producer that calls // the SendMessage action. Messages with the same MessageGroupId are returned // in sequence. // - // * SequenceNumber - Returns the value provided by Amazon SQS. + // * SequenceNumber – Returns the value provided by Amazon SQS. AttributeNames []*string `locationNameList:"AttributeName" type:"list" flattened:"true"` // The maximum number of messages to return. Amazon SQS never returns more messages @@ -3785,9 +3961,9 @@ type ReceiveMessageInput struct { // // The token used for deduplication of ReceiveMessage calls. If a networking // issue occurs after a ReceiveMessage action, and instead of a response you - // receive a generic error, you can retry the same action with an identical - // ReceiveRequestAttemptId to retrieve the same set of messages, even if their - // visibility timeout has not yet expired. + // receive a generic error, it is possible to retry the same action with an + // identical ReceiveRequestAttemptId to retrieve the same set of messages, even + // if their visibility timeout has not yet expired. // // * You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage // action. @@ -3798,7 +3974,7 @@ type ReceiveMessageInput struct { // * If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, // Amazon SQS generates a ReceiveRequestAttemptId. // - // * You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId + // * It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId // if none of the messages have been modified (deleted or had their visibility // changes). // @@ -3825,7 +4001,7 @@ type ReceiveMessageInput struct { // no retries work until the original visibility timeout expires. As a result, // delays might occur but the messages in the queue remain in a strict order. // - // The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId + // The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId // can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId @@ -3841,6 +4017,13 @@ type ReceiveMessageInput struct { // in the queue before returning. If a message is available, the call returns // sooner than WaitTimeSeconds. If no messages are available and the wait time // expires, the call returns successfully with an empty list of messages. + // + // To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage + // requests is longer than the WaitTimeSeconds parameter. For example, with + // the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient + // (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html) + // for asynchronous clients, or the ApacheHttpClient (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html) + // for synchronous clients. WaitTimeSeconds *int64 `type:"integer"` } @@ -4121,7 +4304,7 @@ type SendMessageBatchRequestEntry struct { // An identifier for a message in this batch used to communicate the result. // - // The Ids of a batch request need to be unique within a request + // The Ids of a batch request need to be unique within a request. // // This identifier can have up to 80 characters. The following characters are // accepted: alphanumeric characters, hyphens(-), and underscores (_). @@ -4216,7 +4399,7 @@ type SendMessageBatchRequestEntry struct { // // * Currently, the only supported message system attribute is AWSTraceHeader. // Its type must be String and its value must be a correctly formatted AWS - // X-Ray trace string. + // X-Ray trace header string. // // * The size of a message system attribute doesn't count towards the total // size of a message. @@ -4467,7 +4650,7 @@ type SendMessageInput struct { // Amazon SQS continues to keep track of the message deduplication ID even after // the message is received and deleted. // - // The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId + // The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId // can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId @@ -4508,7 +4691,7 @@ type SendMessageInput struct { // // * Currently, the only supported message system attribute is AWSTraceHeader. // Its type must be String and its value must be a correctly formatted AWS - // X-Ray trace string. + // X-Ray trace header string. // // * The size of a message system attribute doesn't count towards the total // size of a message. @@ -4693,57 +4876,57 @@ type SetQueueAttributesInput struct { // The following lists the names, descriptions, and values of the special request // parameters that the SetQueueAttributes action uses: // - // * DelaySeconds - The length of time, in seconds, for which the delivery + // * DelaySeconds – The length of time, in seconds, for which the delivery // of all messages in the queue is delayed. Valid values: An integer from // 0 to 900 (15 minutes). Default: 0. // - // * MaximumMessageSize - The limit of how many bytes a message can contain + // * MaximumMessageSize – The limit of how many bytes a message can contain // before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes // (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). // - // * MessageRetentionPeriod - The length of time, in seconds, for which Amazon - // SQS retains a message. Valid values: An integer representing seconds, + // * MessageRetentionPeriod – The length of time, in seconds, for which + // Amazon SQS retains a message. Valid values: An integer representing seconds, // from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). // - // * Policy - The queue's policy. A valid AWS policy. For more information + // * Policy – The queue's policy. A valid AWS policy. For more information // about policy structure, see Overview of AWS IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) // in the Amazon IAM User Guide. // - // * ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for + // * ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for // which a ReceiveMessage action waits for a message to arrive. Valid values: - // an integer from 0 to 20 (seconds). Default: 0. + // An integer from 0 to 20 (seconds). Default: 0. // - // * RedrivePolicy - The string that includes the parameters for the dead-letter - // queue functionality of the source queue. For more information about the - // redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter - // Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) + // * RedrivePolicy – The string that includes the parameters for the dead-letter + // queue functionality of the source queue as a JSON object. For more information + // about the redrive policy and dead-letter queues, see Using Amazon SQS + // Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) // in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn - // - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon + // – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon // SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount - // - The number of times a message is delivered to the source queue before + // – The number of times a message is delivered to the source queue before // being moved to the dead-letter queue. When the ReceiveCount for a message // exceeds the maxReceiveCount for a queue, Amazon SQS moves the message // to the dead-letter-queue. The dead-letter queue of a FIFO queue must also // be a FIFO queue. Similarly, the dead-letter queue of a standard queue // must also be a standard queue. // - // * VisibilityTimeout - The visibility timeout for the queue, in seconds. - // Valid values: an integer from 0 to 43,200 (12 hours). Default: 30. For + // * VisibilityTimeout – The visibility timeout for the queue, in seconds. + // Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For // more information about the visibility timeout, see Visibility Timeout // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) // in the Amazon Simple Queue Service Developer Guide. // // The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html): // - // * KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) + // * KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) // for Amazon SQS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). // While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, // the alias of a custom CMK can, for example, be alias/MyAlias . For more // examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) // in the AWS Key Management Service API Reference. // - // * KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which - // Amazon SQS can reuse a data key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) + // * KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for + // which Amazon SQS can reuse a data key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) // to encrypt or decrypt messages before calling AWS KMS again. An integer // representing seconds, between 60 seconds (1 minute) and 86,400 seconds // (24 hours). Default: 300 (5 minutes). A shorter time period provides better @@ -4754,7 +4937,7 @@ type SetQueueAttributesInput struct { // The following attribute applies only to FIFO (first-in-first-out) queues // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html): // - // * ContentBasedDeduplication - Enables content-based deduplication. For + // * ContentBasedDeduplication – Enables content-based deduplication. For // more information, see Exactly-Once Processing (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing) // in the Amazon Simple Queue Service Developer Guide. Every message must // have a unique MessageDeduplicationId, You may provide a MessageDeduplicationId diff --git a/service/sqs/sqsiface/interface.go b/service/sqs/sqsiface/interface.go index c9168943c05..da86ebe9bc9 100644 --- a/service/sqs/sqsiface/interface.go +++ b/service/sqs/sqsiface/interface.go @@ -100,6 +100,9 @@ type SQSAPI interface { ListDeadLetterSourceQueuesWithContext(aws.Context, *sqs.ListDeadLetterSourceQueuesInput, ...request.Option) (*sqs.ListDeadLetterSourceQueuesOutput, error) ListDeadLetterSourceQueuesRequest(*sqs.ListDeadLetterSourceQueuesInput) (*request.Request, *sqs.ListDeadLetterSourceQueuesOutput) + ListDeadLetterSourceQueuesPages(*sqs.ListDeadLetterSourceQueuesInput, func(*sqs.ListDeadLetterSourceQueuesOutput, bool) bool) error + ListDeadLetterSourceQueuesPagesWithContext(aws.Context, *sqs.ListDeadLetterSourceQueuesInput, func(*sqs.ListDeadLetterSourceQueuesOutput, bool) bool, ...request.Option) error + ListQueueTags(*sqs.ListQueueTagsInput) (*sqs.ListQueueTagsOutput, error) ListQueueTagsWithContext(aws.Context, *sqs.ListQueueTagsInput, ...request.Option) (*sqs.ListQueueTagsOutput, error) ListQueueTagsRequest(*sqs.ListQueueTagsInput) (*request.Request, *sqs.ListQueueTagsOutput) @@ -108,6 +111,9 @@ type SQSAPI interface { ListQueuesWithContext(aws.Context, *sqs.ListQueuesInput, ...request.Option) (*sqs.ListQueuesOutput, error) ListQueuesRequest(*sqs.ListQueuesInput) (*request.Request, *sqs.ListQueuesOutput) + ListQueuesPages(*sqs.ListQueuesInput, func(*sqs.ListQueuesOutput, bool) bool) error + ListQueuesPagesWithContext(aws.Context, *sqs.ListQueuesInput, func(*sqs.ListQueuesOutput, bool) bool, ...request.Option) error + PurgeQueue(*sqs.PurgeQueueInput) (*sqs.PurgeQueueOutput, error) PurgeQueueWithContext(aws.Context, *sqs.PurgeQueueInput, ...request.Option) (*sqs.PurgeQueueOutput, error) PurgeQueueRequest(*sqs.PurgeQueueInput) (*request.Request, *sqs.PurgeQueueOutput)