diff --git a/codegen/sdk-codegen/aws-models/cognito-identity-provider.json b/codegen/sdk-codegen/aws-models/cognito-identity-provider.json index 7889954dc8a..aeb30844779 100644 --- a/codegen/sdk-codegen/aws-models/cognito-identity-provider.json +++ b/codegen/sdk-codegen/aws-models/cognito-identity-provider.json @@ -358,7 +358,7 @@ "sdkId": "Cognito Identity Provider", "arnNamespace": "cognito-idp", "cloudFormationName": "Cognito", - "cloudTrailEventSource": "cognitoidentityprovider.amazonaws.com", + "cloudTrailEventSource": "cognito-idp.amazonaws.com", "docId": "cognito-idp-2016-04-18", "endpointPrefix": "cognito-idp" }, @@ -15700,6 +15700,12 @@ "traits": { "smithy.api#enumValue": "FORCE_CHANGE_PASSWORD" } + }, + "EXTERNAL_PROVIDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL_PROVIDER" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 9ca7f79502d..0d83caf5624 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -66281,6 +66281,14 @@ "smithy.api#documentation": "
Describes the Neuron accelerator settings for the instance type.
", "smithy.api#xmlName": "neuronInfo" } + }, + "PhcSupport": { + "target": "com.amazonaws.ec2#PhcSupport", + "traits": { + "aws.protocols#ec2QueryName": "PhcSupport", + "smithy.api#documentation": "Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is\n supported.
", + "smithy.api#xmlName": "phcSupport" + } } }, "traits": { @@ -83436,6 +83444,23 @@ "smithy.api#documentation": "Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE\n negotiations.
" } }, + "com.amazonaws.ec2#PhcSupport": { + "type": "enum", + "members": { + "UNSUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + } + } + }, "com.amazonaws.ec2#Placement": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/ecr.json b/codegen/sdk-codegen/aws-models/ecr.json index 79a2193878e..7f10c77ad43 100644 --- a/codegen/sdk-codegen/aws-models/ecr.json +++ b/codegen/sdk-codegen/aws-models/ecr.json @@ -1905,7 +1905,7 @@ "upstreamRegistryUrl": { "target": "com.amazonaws.ecr#Url", "traits": { - "smithy.api#documentation": "The registry URL of the upstream public registry to use as the source for the pull\n through cache rule. The following is the syntax to use for each supported upstream\n registry.
\nAmazon ECR Public (ecr-public
) - public.ecr.aws
\n
Docker Hub (docker-hub
) -\n registry-1.docker.io
\n
Quay (quay
) - quay.io
\n
Kubernetes (k8s
) - registry.k8s.io
\n
GitHub Container Registry (github-container-registry
) -\n ghcr.io
\n
Microsoft Azure Container Registry (azure-container-registry
) -\n
\n
The registry URL of the upstream public registry to use as the source for the pull\n through cache rule. The following is the syntax to use for each supported upstream\n registry.
\nAmazon ECR Public (ecr-public
) - public.ecr.aws
\n
Docker Hub (docker-hub
) -\n registry-1.docker.io
\n
Quay (quay
) - quay.io
\n
Kubernetes (k8s
) - registry.k8s.io
\n
GitHub Container Registry (github-container-registry
) -\n ghcr.io
\n
Microsoft Azure Container Registry (azure-container-registry
) -\n
\n
GitLab Container Registry (gitlab-container-registry
) -\n registry.gitlab.com
\n
Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries.
\nIf forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \nNetwork access control list (ACL) policies \n in the Firewall Manager Developer Guide.
", + "smithy.api#documentation": "Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries.
\nIf forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \nRemediation for managed network ACLs \n in the Firewall Manager Developer Guide.
", "smithy.api#required": {} } }, @@ -5288,7 +5288,7 @@ "ForceRemediateForLastEntries": { "target": "com.amazonaws.fms#BooleanObject", "traits": { - "smithy.api#documentation": "Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries.
\nIf forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \nNetwork access control list (ACL) policies \n in the Firewall Manager Developer Guide.
", + "smithy.api#documentation": "Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries.
\nIf forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \nRemediation for managed network ACLs \n in the Firewall Manager Developer Guide.
", "smithy.api#required": {} } } @@ -6145,7 +6145,7 @@ "PolicyDescription": { "target": "com.amazonaws.fms#ResourceDescription", "traits": { - "smithy.api#documentation": "The definition of the Network Firewall firewall policy.
" + "smithy.api#documentation": "Your description of the Firewall Manager policy.
" } }, "PolicyStatus": { @@ -6799,7 +6799,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Firewall Manager policy.
\nA Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple\n\t\tpolicy types across accounts, you can create multiple policies. You can create more than one\n\t\tpolicy for each type.
\nIf you add a new account to an organization that you created with Organizations, Firewall Manager\n\t\tautomatically applies the policy to the resources in that account that are within scope of\n\t\tthe policy.
\nFirewall Manager provides the following types of policies:
\n\n WAF policy - This policy applies WAF web ACL\n\t\t\t\tprotections to specified accounts and resources.
\n\n Shield Advanced policy - This policy applies Shield Advanced\n\t\t\t\tprotection to specified accounts and resources.
\n\n Security Groups policy - This type of policy gives you\n\t\t\t\tcontrol over security groups that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of rules across your organization.
\n\n Network ACL policy - This type of policy gives you\n\t\t\t\tcontrol over the network ACLs that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of first and last network ACL rules across your organization.
\n\n Network Firewall policy - This policy applies\n\t\t\t\tNetwork Firewall protection to your organization's VPCs.
\n\n DNS Firewall policy - This policy applies\n\t\t\t\tAmazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
\n\n Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at Amazon Web Services Marketplace.
\n\n Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
\n\n Fortigate CNF policy - This policy applies\n\t\t\t\t\t\tFortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.
\nCreates an Firewall Manager policy.
\nA Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple\n\t\tpolicy types across accounts, you can create multiple policies. You can create more than one\n\t\tpolicy for each type.
\nIf you add a new account to an organization that you created with Organizations, Firewall Manager\n\t\tautomatically applies the policy to the resources in that account that are within scope of\n\t\tthe policy.
\nFirewall Manager provides the following types of policies:
\n\n WAF policy - This policy applies WAF web ACL\n\t\t\t\tprotections to specified accounts and resources.
\n\n Shield Advanced policy - This policy applies Shield Advanced\n\t\t\t\tprotection to specified accounts and resources.
\n\n Security Groups policy - This type of policy gives you\n\t\t\t\tcontrol over security groups that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of rules across your organization.
\n\n Network ACL policy - This type of policy gives you\n\t\t\t\tcontrol over the network ACLs that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of first and last network ACL rules across your organization.
\n\n Network Firewall policy - This policy applies\n\t\t\t\tNetwork Firewall protection to your organization's VPCs.
\n\n DNS Firewall policy - This policy applies\n\t\t\t\tAmazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
\n\n Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at Amazon Web Services Marketplace.
\n\n Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
\n\n Fortigate CNF policy - This policy applies\n\t\t\t\t\t\tFortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.
\nThe resource tag value.
" + "smithy.api#documentation": "The resource tag value. To specify an empty string value, either don't provide this or specify it as \"\".
" } } }, "traits": { - "smithy.api#documentation": "The resource tags that Firewall Manager uses to determine if a particular resource\n should be included or excluded from the Firewall Manager policy. Tags enable you to\n categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or\n environment. Each tag consists of a key and an optional value. Firewall Manager combines the\n tags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have\n all the specified tags to be included or excluded. For more information, see\n Working with Tag Editor.
" + "smithy.api#documentation": "The resource tags that Firewall Manager uses to determine if a particular resource\n should be included or excluded from the Firewall Manager policy. Tags enable you to\n categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or\n environment. Each tag consists of a key and an optional value. Firewall Manager combines the\n tags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have\n all the specified tags to be included or excluded. For more information, see\n Working with Tag Editor.
\nEvery resource tag must have a string value, either a non-empty string or an empty string. If you don't \n provide a value for a resource tag, Firewall Manager saves the value as an empty string: \"\". When Firewall Manager compares tags, it only \n matches two tags if they have the same key and the same value. A tag with an empty string value only \n matches with tags that also have an empty string value.
" } }, "com.amazonaws.fms#ResourceTagKey": { diff --git a/codegen/sdk-codegen/aws-models/polly.json b/codegen/sdk-codegen/aws-models/polly.json index 601b7c2f540..5bac0ca4229 100644 --- a/codegen/sdk-codegen/aws-models/polly.json +++ b/codegen/sdk-codegen/aws-models/polly.json @@ -167,7 +167,7 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "Specifies the engine (standard
, neural
or\n long-form
) used by Amazon Polly when processing input text for\n speech synthesis.
Specifies the engine (standard
, neural
,\n long-form
or generative
) used by Amazon Polly when\n processing input text for speech synthesis.
Specifies the engine (standard
, neural
or\n long-form
) for Amazon Polly to use when processing input text for\n speech synthesis. Using a voice that is not supported for the engine\n selected will result in an error.
Specifies the engine (standard
, neural
,\n long-form
or generative
) for Amazon Polly to use\n when processing input text for speech synthesis. Using a voice that\n is not supported for the engine selected will result in an error.
The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" + "smithy.api#documentation": "The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\". The default value for generative voices is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" } }, "SnsTopicArn": { @@ -2504,7 +2510,7 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "Specifies the engine (standard
, neural
or\n long-form
) for Amazon Polly to use when processing input text for\n speech synthesis. Using a voice that is not supported for the engine\n selected will result in an error.
Specifies the engine (standard
, neural
,\n long-form
or generative
) for Amazon Polly to use\n when processing input text for speech synthesis. Using a voice that\n is not supported for the engine selected will result in an error.
The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" + "smithy.api#documentation": "The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\". The default value for generative voices is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" } }, "SpeechMarkTypes": { @@ -2689,7 +2695,7 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "Specifies the engine (standard
, neural
or\n long-form
) for Amazon Polly to use when processing input text for\n speech synthesis. For information on Amazon Polly voices and which voices are\n available for each engine, see Available Voices.
\n NTTS-only voices\n
\nWhen using NTTS-only voices such as Kevin (en-US), this parameter is\n required and must be set to neural
. If the engine is not\n specified, or is set to standard
, this will result in an\n error.
\n long-form-only voices\n
\nWhen using long-form-only voices such as Danielle (en-US), this\n parameter is required and must be set to long-form
. If the\n engine is not specified, or is set to standard
or\n neural
, this will result in an error.
Type: String
\nValid Values: standard
| neural
|\n long-form
\n
Required: Yes
\n\n Standard voices\n
\nFor standard voices, this is not required; the engine parameter\n defaults to standard
. If the engine is not specified, or is\n set to standard
and an NTTS-only voice is selected, this will\n result in an error.
Specifies the engine (standard
, neural
,\n long-form
, or generative
) for Amazon Polly\n to use when processing input text for speech synthesis. Provide an engine\n that is supported by the voice you select. If you don't provide an engine,\n the standard engine is selected by default. If a chosen voice isn't supported\n by the standard engine, this will result in an error. For information on\n Amazon Polly voices and which voices are available for each engine, see Available Voices.
Type: String
\nValid Values: standard
| neural
|\n long-form
| generative
\n
Required: Yes
" } }, "LanguageCode": { @@ -2714,7 +2720,7 @@ "SampleRate": { "target": "com.amazonaws.polly#SampleRate", "traits": { - "smithy.api#documentation": "The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" + "smithy.api#documentation": "The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\". The default value for generative voices is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" } }, "SpeechMarkTypes": { @@ -2918,7 +2924,7 @@ "SupportedEngines": { "target": "com.amazonaws.polly#EngineList", "traits": { - "smithy.api#documentation": "Specifies which engines (standard
, neural
or\n long-form
) are supported by a given voice.
Specifies which engines (standard
, neural
,\n long-form
or generative
) are supported by a given voice.
Adds a permission to a queue for a specific principal. This allows sharing\n access to the queue.
\nWhen you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the\n Amazon SQS Developer Guide.
\n\n AddPermission
generates a policy for you. You can use\n \n SetQueueAttributes\n
to upload your\n policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy\n Language in the Amazon SQS Developer\n Guide.
An Amazon SQS policy can have a maximum of seven actions per\n statement.
\nTo remove the ability to change queue permissions, you must deny\n permission to the AddPermission
, RemovePermission
,\n and SetQueueAttributes
actions in your IAM policy.
Amazon SQS AddPermission
does not support adding a\n non-account principal.
Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nAdds a permission to a queue for a specific principal. This allows sharing\n access to the queue.
\nWhen you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.
\n\n AddPermission
generates a policy for you. You can use\n \n SetQueueAttributes\n
to upload your\n policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of seven actions per statement.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.
Amazon SQS AddPermission
does not support adding a non-account\n principal.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe Amazon Web\n Services account numbers of the principals who are to receive\n permission. For information about locating the Amazon Web Services\n account identification, see Your Amazon Web\n Services Identifiers in the Amazon SQS Developer\n Guide.
", + "smithy.api#documentation": "The Amazon Web Services account numbers of the principals who are to receive\n permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer\n Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AWSAccountId" @@ -201,7 +201,7 @@ }, "aws.protocols#awsJson1_0": {}, "aws.protocols#awsQueryCompatible": {}, - "smithy.api#documentation": "Welcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they\n travel between applications or microservices. Amazon SQS moves data between distributed\n application components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n
\nYou can use Amazon Web Services\n SDKs to access Amazon SQS using your favorite programming language. The SDKs\n perform tasks such as the following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nWelcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel\n between applications or microservices. Amazon SQS moves data between distributed application\n components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n
\nYou can use Amazon Web Services SDKs to access\n Amazon SQS using your favorite programming language. The SDKs perform tasks such as the\n following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nCancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet.
\nThis action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.
\nCurrently, only standard queues are supported.
\nOnly one active message movement task is supported per queue at any given\n time.
\nCancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet.
\nThis action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.
\nOnly one active message movement task is supported per queue at any given\n time.
\nChanges the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
\nFor example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout
set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility
call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.
An Amazon SQS message has three basic states:
\nSent to a queue by a producer.
\nReceived from the queue by a consumer.
\nDeleted from the queue.
\nA message is considered to be stored after it is sent to a queue\n by a producer, but not yet received from the queue by a consumer (that is, between\n states 1 and 2). There is no limit to the number of stored messages. A message is\n considered to be in flight after it is received from a queue by a\n consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is\n a limit to the number of in flight messages.
\nLimits that apply to in flight messages are unrelated to the\n unlimited number of stored messages.
\nFor most standard queues (depending on queue traffic and message backlog), there can\n be a maximum of approximately 120,000 in flight messages (received from a queue by a\n consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS\n returns the OverLimit
error message. To avoid reaching the limit, you\n should delete messages from the queue after they're processed. You can also increase the\n 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 in flight messages (received from a\n queue by a consumer, but not yet deleted from the queue). If you reach this limit,\n Amazon SQS returns no error messages.
\nIf you attempt to set the VisibilityTimeout
to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n ChangeMessageVisibility
action) the next time the message is\n received.
Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
\nFor example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout
set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility
call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.
An Amazon SQS message has three basic states:
\nSent to a queue by a producer.
\nReceived from the queue by a consumer.
\nDeleted from the queue.
\nA 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.\n 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 in flight messages.
\nLimits that apply to in flight messages are unrelated to the unlimited number of stored messages.
\nFor most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit
error message.\n 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.\n To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight 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.
\nIf you attempt to set the VisibilityTimeout
to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n ChangeMessageVisibility
action) the next time the message is\n received.
Changes the visibility timeout of multiple messages. This is a batch version of\n \n ChangeMessageVisibility.
The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n
requests with each\n ChangeMessageVisibilityBatch
action.
Because the batch request can result in a combination of successful and\n unsuccessful actions, you should check for batch errors even when the call returns\n an HTTP status code of 200
.
Changes the visibility timeout of multiple messages. This is a batch version of\n \n ChangeMessageVisibility.
The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n
requests with each\n 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
.
An identifier for this particular receipt handle used to communicate the\n result.
\nThe Id
s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nAn identifier for this particular receipt handle used to communicate the\n result.
\nThe Id
s 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 (_).
\nCreates a new standard or FIFO queue. You can pass one or more attributes in the\n request. Keep the following in mind:
\nIf you don't specify the FifoQueue
attribute, Amazon SQS creates\n a standard queue.
You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.
\nTo successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues.
\nAfter you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.
\nTo get the queue URL, use the \n GetQueueUrl\n
action.\n \n GetQueueUrl\n
requires only the\n QueueName
parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and\n values of all the queue's attributes, CreateQueue
returns the queue\n URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an\n existing queue, CreateQueue
returns an error.
Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nCreates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:
\nIf 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\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.
\nTo successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues.
\nAfter you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.
\nTo get the queue URL, use the \n GetQueueUrl\n
action.\n \n GetQueueUrl\n
requires only the\n QueueName
parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and\n values of all the queue's attributes, CreateQueue
returns the queue\n URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an\n existing queue, CreateQueue
returns an error.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nA map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue
action uses:
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0.
\n MaximumMessageSize
– The limit of how many bytes a message can\n contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod
– The length of time, in seconds, for which\n Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to\n the MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– The queue's policy. A valid Amazon Web Services\n policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the IAM\n User Guide.
\n ReceiveMessageWaitTimeSeconds
– The length of time, in seconds, for\n which a \n ReceiveMessage\n
action waits for a message\n to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
\n VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the\n dead-letter queue functionality of the source queue as a JSON object. The\n parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of\n the dead-letter queue to which Amazon SQS moves messages after the value\n of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is\n delivered to the source queue before being moved to the dead-letter\n queue. Default: 10. When the ReceiveCount
for a message\n exceeds the maxReceiveCount
for a queue, Amazon SQS moves\n the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for\n the permissions for the dead-letter queue redrive permission and which source\n queues can specify dead-letter queues as a JSON object. The parameters are as\n follows:
\n redrivePermission
– The permission type that defines\n which source queues can specify the current queue as the dead-letter\n queue. Valid values are:
\n allowAll
– (Default) Any source queues in this\n Amazon Web Services account in the same\n Region can specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue\n as the dead-letter queue.
\n byQueue
– Only queues specified by the\n sourceQueueArns
parameter can specify this\n queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the\n source queues that can specify this queue as the dead-letter queue and\n redrive messages. You can specify this parameter only when the\n redrivePermission
parameter is set to\n byQueue
. You can specify up to 10 source queue ARNs. To\n allow more than 10 source queues to specify dead-letter queues, set the\n redrivePermission
parameter to\n allowAll
.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the\n dead-letter queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see\n Key Terms. While the alias of the Amazon Web Services\n managed CMK for Amazon SQS is always alias/aws/sqs
, the alias of a\n custom CMK can, for example, be alias/MyAlias\n
.\n For more examples, see KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for\n which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer representing\n seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:\n 300 (5 minutes). A shorter time period provides better security but results in\n more calls to KMS which might incur charges after Free Tier. For more\n information, see How Does the Data Key Reuse Period Work?\n
\n SqsManagedSseEnabled
– Enables server-side queue encryption using\n SQS owned encryption keys. Only one server-side encryption option is supported\n per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO\n (first-in-first-out) queues:
\n\n FifoQueue
– Designates a queue as FIFO. Valid values are\n true
and false
. If you don't specify the\n FifoQueue
attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId
for your messages explicitly.
For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
\n\n ContentBasedDeduplication
– Enables content-based deduplication.\n Valid values are true
and false
. For more information,\n see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId
.
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.
If the queue has ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to high\n throughput for FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication\n occurs at the message group or queue level. Valid values are\n messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput\n quota applies to the entire queue or per message group. Valid values are\n perQueue
and perMessageGroupId
. The\n perMessageGroupId
value is allowed only when the value for\n DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, see Quotas\n related to messages in the Amazon SQS Developer\n Guide.
", + "smithy.api#documentation": "A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue
action uses:
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0.
\n MaximumMessageSize
– The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod
– The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the IAM User Guide.
\n ReceiveMessageWaitTimeSeconds
– The length of time, in\n seconds, for which a \n ReceiveMessage\n
action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.
\n VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
\n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission
– The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue as the dead-letter\n queue.
\n byQueue
– Only queues specified by the sourceQueueArns
parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission
parameter is set to byQueue
. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
parameter\n to allowAll
.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is\n always alias/aws/sqs
, the alias of a custom CMK can, for example,\n be alias/MyAlias\n
. For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds
– The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?\n
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out)\n queues:
\n\n FifoQueue
– Designates a queue as FIFO. Valid values are\n true
and false
. If you don't specify the FifoQueue
attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId
for your messages explicitly.
For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
\n\n ContentBasedDeduplication
– Enables content-based\n deduplication. Valid values are true
and false
. For\n more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId
.
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.
If the queue has ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
. \n The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } @@ -1642,7 +1642,7 @@ "tags": { "target": "com.amazonaws.sqs#TagMap", "traits": { - "smithy.api#documentation": "Add cost allocation tags to the specified Amazon SQS queue. For an overview, see\n Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character\n strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the\n existing tag.
\nFor a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer\n Guide.
\nTo be able to tag a queue on creation, you must have the\n sqs:CreateQueue
and sqs:TagQueue
permissions.
Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nAdd cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nTo be able to tag a queue on creation, you must have the\n sqs:CreateQueue
and sqs:TagQueue
permissions.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nDeletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle
of the message (not the\n MessageId
which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle
is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle
is different each time you receive a message.\n When you use the DeleteMessage
action, you must provide the most\n recently received ReceiptHandle
for the message (otherwise, the request\n succeeds, but the message will not be deleted).
For standard queues, it is possible to receive a message even after you delete it.\n This might happen on rare occasions if one of the servers which stores a copy of the\n message is unavailable when you send the request to delete the message. The copy\n remains on the server and might be returned to you during a subsequent receive\n request. You should ensure that your application is idempotent, so that receiving a\n message more than once does not cause issues.
\nDeletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle
of the message (not the\n MessageId
which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle
is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle
is different each time you receive a message.\n When you use the DeleteMessage
action, you must provide the most\n recently received ReceiptHandle
for the message (otherwise, the request\n succeeds, but the message will not be deleted).
For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues.
\nDeletes up to ten messages from the specified queue. This is a batch version of\n \n DeleteMessage.
The result of the action on each\n message is reported individually in the response.
Because the batch request can result in a combination of successful and\n unsuccessful actions, you should check for batch errors even when the call returns\n an HTTP status code of 200
.
Deletes up to ten messages from the specified queue. This is a batch version of\n \n DeleteMessage.
The result of the action on each\n 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 identifier for this particular receipt handle. This is used to communicate the\n result.
\nThe Id
s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nThe identifier for this particular receipt handle. This is used to communicate the\n result.
\nThe Id
s 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 (_).
\nDeletes the queue specified by the QueueUrl
, regardless of the queue's\n contents.
Be careful with the DeleteQueue
action: When you delete a queue, any\n messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n \n SendMessage\n
request might succeed, but after 60\n 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\n with the same name.
\nCross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nThe delete operation uses the HTTP GET
verb.
Deletes the queue specified by the QueueUrl
, regardless of the queue's\n contents.
Be careful with the DeleteQueue
action: When you delete a queue, any\n messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n \n SendMessage\n
request might succeed, but after 60\n 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\n with the same name.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe delete operation uses the HTTP GET
verb.
Gets attributes for the specified queue.
\nTo determine whether a queue is FIFO, you can check whether QueueName
ends with the\n .fifo
suffix.
Gets attributes for the specified queue.
\nTo determine whether a queue is FIFO, you can check whether QueueName
ends with the .fifo
suffix.
A list of attributes for which to retrieve information.
\nThe AttributeNames
parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.
In the future, new attributes might be added. If you write code that calls this\n action, we recommend that you structure your code so that it can handle new\n attributes gracefully.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed
,\n ApproximateNumberOfMessagesNotVisible
, and\n ApproximateNumberOfMessages
metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency.
\n All
– Returns all values.
\n ApproximateNumberOfMessages
– Returns the approximate number of\n messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed
– Returns the approximate\n number of messages in the queue that are delayed and not available for reading\n immediately. This can happen when the queue is configured as a delay queue or\n when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible
– Returns the approximate\n number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.\n
\n CreatedTimestamp
– Returns the time when the queue was created in\n seconds (epoch\n time).
\n DelaySeconds
– Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp
– Returns the time when the queue was last\n changed in seconds (epoch\n time).
\n MaximumMessageSize
– Returns the limit of how many bytes a\n message can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod
– Returns the length of time, in seconds,\n for which Amazon SQS retains a message. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate\n throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– Returns the policy of the queue.
\n QueueArn
– Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds
– Returns the length of time, in\n seconds, for which the ReceiveMessage
action waits for a message to\n arrive.
\n VisibilityTimeout
– Returns the visibility timeout for the queue.\n For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the\n dead-letter queue functionality of the source queue as a JSON object. The\n parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of\n the dead-letter queue to which Amazon SQS moves messages after the value\n of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is\n delivered to the source queue before being moved to the dead-letter\n queue. Default: 10. When the ReceiveCount
for a message\n exceeds the maxReceiveCount
for a queue, Amazon SQS moves\n the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for\n the permissions for the dead-letter queue redrive permission and which source\n queues can specify dead-letter queues as a JSON object. The parameters are as\n follows:
\n redrivePermission
– The permission type that defines\n which source queues can specify the current queue as the dead-letter\n queue. Valid values are:
\n allowAll
– (Default) Any source queues in this\n Amazon Web Services account in the same\n Region can specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue\n as the dead-letter queue.
\n byQueue
– Only queues specified by the\n sourceQueueArns
parameter can specify this\n queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the\n source queues that can specify this queue as the dead-letter queue and\n redrive messages. You can specify this parameter only when the\n redrivePermission
parameter is set to\n byQueue
. You can specify up to 10 source queue ARNs. To\n allow more than 10 source queues to specify dead-letter queues, set the\n redrivePermission
parameter to\n allowAll
.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the\n dead-letter queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– Returns the ID of an Amazon Web Services\n managed customer master key (CMK) for Amazon SQS or a custom CMK. For more\n information, see Key Terms.
\n KmsDataKeyReusePeriodSeconds
– Returns the length of time, in\n seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt\n messages before calling KMS again. For more information, see How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled
– Returns information about whether the queue\n is using SSE-SQS encryption using SQS owned encryption keys. Only one\n server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO\n (first-in-first-out) queues:
\n\n FifoQueue
– Returns information about whether the queue is FIFO.\n For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
To determine whether a queue is FIFO, you can check whether QueueName
ends with\n the .fifo
suffix.
\n ContentBasedDeduplication
– Returns whether content-based\n deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
The following attributes apply only to high\n throughput for FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication\n occurs at the message group or queue level. Valid values are\n messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput\n quota applies to the entire queue or per message group. Valid values are\n perQueue
and perMessageGroupId
. The\n perMessageGroupId
value is allowed only when the value for\n DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, see Quotas\n related to messages in the Amazon SQS Developer\n Guide.
", + "smithy.api#documentation": "A list of attributes for which to retrieve information.
\nThe AttributeNames
parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.
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.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed
,\n ApproximateNumberOfMessagesNotVisible
, and\n ApproximateNumberOfMessages
metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency.
\n All
– Returns all values.
\n ApproximateNumberOfMessages
– Returns the approximate\n number of messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed
– Returns the\n approximate number of messages in the queue that are delayed and not available\n for reading immediately. This can happen when the queue is configured as a delay\n queue or when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible
– Returns the\n approximate number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.\n
\n CreatedTimestamp
– Returns the time when the queue was\n created in seconds (epoch\n time).
\n DelaySeconds
– Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp
– Returns the time when the queue\n was last changed in seconds (epoch time).
\n MaximumMessageSize
– Returns the limit of how many bytes a\n message can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod
– Returns the length of time, in\n seconds, for which Amazon SQS retains a message. When you change a queue's\n attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– Returns the policy of the queue.
\n QueueArn
– Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds
– Returns the length of\n time, in seconds, for which the ReceiveMessage
action waits for a\n message to arrive.
\n VisibilityTimeout
– Returns the visibility timeout for the\n queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
\n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission
– The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue as the dead-letter\n queue.
\n byQueue
– Only queues specified by the sourceQueueArns
parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission
parameter is set to byQueue
. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
parameter\n to allowAll
.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– Returns the ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
\n KmsDataKeyReusePeriodSeconds
– Returns the length of time,\n in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt\n messages before calling KMS again. For more information, see\n How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled
– Returns information about whether the\n queue is using SSE-SQS encryption using SQS owned encryption keys. Only one\n server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out)\n queues:
\n\n FifoQueue
– Returns information about whether the queue is\n FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
To determine whether a queue is FIFO, you can check whether QueueName
ends with the .fifo
suffix.
\n ContentBasedDeduplication
– Returns whether content-based\n deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
. \n The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -2032,7 +2032,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the URL of an existing Amazon SQS queue.
\nTo access a queue that belongs to another AWS account, use the\n QueueOwnerAWSAccountId
parameter to specify the account ID of the\n queue's owner. The queue's owner must grant you permission to access the queue. For more\n information about shared queue access, see \n AddPermission\n
\n or see Allow Developers to Write Messages to a Shared Queue in the\n Amazon SQS Developer Guide.
Returns the URL of an existing Amazon SQS queue.
\nTo access a queue that belongs to another AWS account, use the\n QueueOwnerAWSAccountId
parameter to specify the account ID of the\n queue's owner. The queue's owner must grant you permission to access the queue. For more\n information about shared queue access, see \n AddPermission\n
\n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.
The Amazon Web\n Services account ID of the account that created the queue.
" + "smithy.api#documentation": "The Amazon Web Services account ID of the account that created the queue.
" } } }, @@ -2068,7 +2068,7 @@ } }, "traits": { - "smithy.api#documentation": "For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide.
", + "smithy.api#documentation": "For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide.
", "smithy.api#output": {} } }, @@ -2402,7 +2402,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the most recent message movement tasks (up to 10) under a specific source\n queue.
\nThis action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.
\nCurrently, only standard queues are supported.
\nOnly one active message movement task is supported per queue at any given\n time.
\nGets the most recent message movement tasks (up to 10) under a specific source\n queue.
\nThis action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.
\nOnly one active message movement task is supported per queue at any given\n time.
\nThe number of messages to be moved from the source queue. This number is obtained at\n the time of starting the message movement task.
" + "smithy.api#documentation": "The number of messages to be moved from the source queue. This number is obtained at\n the time of starting the message movement task and is only included after the message\n movement task is selected to start.
" } }, "FailureReason": { @@ -2539,7 +2539,7 @@ } ], "traits": { - "smithy.api#documentation": "List all cost allocation tags added to the specified Amazon SQS queue. For an\n overview, see Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n Guide.
\nCross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nList all cost allocation tags added to the specified Amazon SQS queue.\n For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nReturns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional QueueNamePrefix
\n parameter, only queues with a name that begins with the specified value are\n returned.
The listQueues
methods supports pagination. Set parameter\n MaxResults
in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults
, the response\n includes a maximum of 1,000 results. If you set MaxResults
and there are\n additional results to display, the response includes a value for NextToken
.\n Use NextToken
as a parameter in your next request to\n listQueues
to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nReturns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional QueueNamePrefix
\n parameter, only queues with a name that begins with the specified value are\n returned.
The listQueues
methods supports pagination. Set parameter\n MaxResults
in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults
, the response\n includes a maximum of 1,000 results. If you set MaxResults
and there are\n additional results to display, the response includes a value for NextToken
.\n Use NextToken
as a parameter in your next request to\n listQueues
to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nAn MD5 digest of the non-URL-encoded message attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321.
" + "smithy.api#documentation": "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.
" } }, "MessageAttributes": { "target": "com.amazonaws.sqs#MessageBodyAttributeMap", "traits": { - "smithy.api#documentation": "Each message attribute consists of a Name
, Type
, and\n Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer\n Guide.
Each message attribute consists of a Name
, Type
, \nand Value
. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.
Amazon SQS supports the following logical data types: String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", + "smithy.api#documentation": "Amazon SQS supports the following logical data types: String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", "smithy.api#required": {} } } @@ -2816,6 +2816,12 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.sqs#MessageSystemAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#MessageSystemAttributeName" + } + }, "com.amazonaws.sqs#MessageSystemAttributeMap": { "type": "map", "key": { @@ -2834,6 +2840,12 @@ "com.amazonaws.sqs#MessageSystemAttributeName": { "type": "enum", "members": { + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, "SenderId": { "target": "smithy.api#Unit", "traits": { @@ -2935,7 +2947,7 @@ "DataType": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "Amazon SQS supports the following logical data types: String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", + "smithy.api#documentation": "Amazon SQS supports the following logical data types: String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", "smithy.api#required": {} } } @@ -3230,7 +3242,7 @@ "code": "QueueAlreadyExists", "httpResponseCode": 400 }, - "smithy.api#documentation": "A queue with this name already exists. Amazon SQS returns this error only if the\n request includes attributes whose values differ from those of the existing queue.
", + "smithy.api#documentation": "A queue with this name already exists. Amazon SQS returns this error only if the request\n includes attributes whose values differ from those of the existing queue.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3308,7 +3320,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds
parameter enables long-poll support. For more\n information, see Amazon\n SQS Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage
call. Thus, only the messages on the sampled machines\n are returned. If the number of messages in the queue is small (fewer than 1,000), you\n most likely get fewer messages than you requested per ReceiveMessage
call.\n If the number of messages in the queue is extremely small, you might not receive any\n messages in a particular ReceiveMessage
response. If this happens, repeat\n the request.
For each message returned, the response includes the following:
\nThe message body.
\nAn MD5 digest of the message body. For information about MD5, see RFC1321.
\nThe MessageId
you received when you sent the message to the\n queue.
The receipt handle.
\nThe message attributes.
\nAn MD5 digest of the message attributes.
\nThe receipt handle is the identifier you must provide when deleting the message. For\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
\nYou can provide the VisibilityTimeout
parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you\n don't include the parameter, the overall visibility timeout for the queue is used for\n the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
A message that isn't deleted or a message whose visibility isn't extended before the\n visibility timeout expires counts as a failed receive. Depending on the configuration of\n the queue, the message might be sent to the dead-letter queue.
\nIn the future, new attributes might be added. If you write code that calls this\n action, we recommend that you structure your code so that it can handle new\n attributes gracefully.
\nRetrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds
parameter enables long-poll support. For more\n information, see Amazon SQS\n Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage
call. Thus, only the messages on the sampled machines\n are returned. If the number of messages in the queue is small (fewer than 1,000), you\n most likely get fewer messages than you requested per ReceiveMessage
call.\n If the number of messages in the queue is extremely small, you might not receive any\n messages in a particular ReceiveMessage
response. If this happens, repeat\n the request.
For each message returned, the response includes the following:
\nThe message body.
\nAn MD5 digest of the message body. For information about MD5, see RFC1321.
\nThe MessageId
you received when you sent the message to the\n queue.
The receipt handle.
\nThe message attributes.
\nAn MD5 digest of the message attributes.
\nThe receipt handle is the identifier you must provide when deleting the message. For\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
\nYou can provide the VisibilityTimeout
parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you don't\n include the parameter, the overall visibility timeout for the queue is used for the\n returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
A message that isn't deleted or a message whose visibility isn't extended before the\n visibility timeout expires counts as a failed receive. Depending on the configuration of\n the queue, the message might be sent to the dead-letter queue.
\nIn 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.
\nA list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All
– Returns all values.
\n ApproximateFirstReceiveTimestamp
– Returns the time the message was\n first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount
– Returns the number of times a message has\n been received across all queues but not deleted.
\n AWSTraceHeader
– Returns the X-Ray trace header\n string.
\n SenderId
\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
\n SentTimestamp
– Returns the time the message was sent to the queue\n (epoch time in\n milliseconds).
\n SqsManagedSseEnabled
– Enables server-side queue encryption using\n SQS owned encryption keys. Only one server-side encryption option is supported\n per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.
\n MessageGroupId
– Returns the value provided by the producer that\n calls the \n SendMessage\n
action. Messages with the\n same MessageGroupId
are returned in sequence.
\n SequenceNumber
– Returns the value provided by Amazon SQS.
\n This parameter has been deprecated but will be supported for backward compatibility.\n To provide attribute names, you are encouraged to use MessageSystemAttributeNames
. \n
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All
– Returns all values.
\n ApproximateFirstReceiveTimestamp
– Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount
– Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader
– Returns the X-Ray trace\n header string.
\n SenderId
\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
\n SentTimestamp
– Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.
\n MessageGroupId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
action.\n Messages with the same MessageGroupId
are returned in\n sequence.
\n SequenceNumber
– Returns the value provided by\n Amazon SQS.
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All
– Returns all values.
\n ApproximateFirstReceiveTimestamp
– Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount
– Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader
– Returns the X-Ray trace\n header string.
\n SenderId
\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
\n SentTimestamp
– Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.
\n MessageGroupId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
action.\n Messages with the same MessageGroupId
are returned in\n sequence.
\n SequenceNumber
– Returns the value provided by\n Amazon SQS.
The maximum number of messages to return. Amazon SQS never returns more messages than\n this value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1.
" + "smithy.api#documentation": "The maximum number of messages to return. Amazon SQS never returns more messages than this\n value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1.
" } }, "VisibilityTimeout": { @@ -3352,13 +3375,13 @@ "WaitTimeSeconds": { "target": "com.amazonaws.sqs#NullableInteger", "traits": { - "smithy.api#documentation": "The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds
. If no messages are available and the wait time\n expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for\n ReceiveMessage
requests is longer than the\n WaitTimeSeconds
parameter. For example, with the Java SDK, you can\n set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds
. If no messages are available and the wait time\n expires, the call does not return a message list.
To avoid HTTP errors, ensure that the HTTP response timeout for\n ReceiveMessage
requests is longer than the\n WaitTimeSeconds
parameter. For example, with the Java SDK, you can\n set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of ReceiveMessage
calls. If a networking\n issue occurs after a ReceiveMessage
action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId
to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId
only for 5 minutes after a\n ReceiveMessage
action.
When you set FifoQueue
, a caller of the\n ReceiveMessage
action can provide a\n ReceiveRequestAttemptId
explicitly.
If a caller of the ReceiveMessage
action doesn't provide a\n ReceiveRequestAttemptId
, Amazon SQS generates a\n ReceiveRequestAttemptId
.
It is possible to retry the ReceiveMessage
action with the same\n ReceiveRequestAttemptId
if none of the messages have been\n modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same\n ReceiveRequestAttemptId
return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
If a caller of the ReceiveMessage
action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary.
\nWhile messages with a particular MessageGroupId
are invisible, no\n more messages belonging to the same MessageGroupId
are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId
as long as it is also visible.
If a caller of ReceiveMessage
can't track the\n ReceiveRequestAttemptId
, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId
is 128 characters.\n ReceiveRequestAttemptId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon\n SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of ReceiveMessage
calls. If a networking\n issue occurs after a ReceiveMessage
action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId
to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId
only for 5 minutes after a\n ReceiveMessage
action.
When you set FifoQueue
, a caller of the\n ReceiveMessage
action can provide a\n ReceiveRequestAttemptId
explicitly.
It is possible to retry the ReceiveMessage
action with the same\n ReceiveRequestAttemptId
if none of the messages have been\n modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same\n ReceiveRequestAttemptId
return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
If a caller of the ReceiveMessage
action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary.
\nWhile messages with a particular MessageGroupId
are invisible, no\n more messages belonging to the same MessageGroupId
are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId
as long as it is also visible.
If a caller of ReceiveMessage
can't track the\n ReceiveRequestAttemptId
, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId
is 128 characters.\n ReceiveRequestAttemptId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.
Revokes any permissions in the queue policy that matches the specified\n Label
parameter.
Only the owner of a queue can remove permissions from it.
\nCross-account permissions don't apply to this action. For more\n information, see Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny\n permission to the AddPermission
, RemovePermission
,\n and SetQueueAttributes
actions in your IAM policy.
Revokes any permissions in the queue policy that matches the specified\n Label
parameter.
Only the owner of a queue can remove permissions from it.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nTo 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.
\nA message can include only XML, JSON, and unformatted text. The following Unicode\n characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to\n #xD7FF
| #xE000
to #xFFFD
|\n #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters.
\nDelivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nYou can use SendMessageBatch
to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued in\n the order they are sent.
The result of sending each message is reported individually in the response. Because\n the batch request can result in a combination of successful and unsuccessful actions,\n you should check for batch errors even when the call returns an HTTP status code of\n 200
.
The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode\n characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to\n #xD7FF
| #xE000
to #xFFFD
|\n #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters.
\nIf you don't specify the DelaySeconds
parameter for an entry, Amazon SQS\n uses the default value for the queue.
You can use SendMessageBatch
to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.
The result of sending each message is reported individually in the response.\n 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\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nIf you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses\n the default value for the queue.
An identifier for a message in this batch used to communicate the result.
\nThe Id
s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nAn identifier for a message in this batch used to communicate the result.
\nThe Id
s 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 (_).
\nThe length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue is applied.
When you set FifoQueue
, you can't set DelaySeconds
per\n message. You can set this parameter only on a queue level.
The length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n 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.
Each message attribute consists of a Name
, Type
, and\n Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer\n Guide.
Each message attribute consists of a Name
, Type
, \nand Value
. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.
The message system attribute to send Each message system attribute consists of a\n Name
, Type
, and Value
.
Currently, the only supported message system attribute is\n AWSTraceHeader
. Its type must be String
and\n its value must be a correctly formatted X-Ray trace\n header string.
The size of a message system attribute doesn't count towards the total\n size of a message.
\nThe 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
.\n Its type must be String
and its value must be a correctly formatted\n X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
\nThis parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular MessageDeduplicationId
is sent\n successfully, subsequent messages with the same MessageDeduplicationId
are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the queue has ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId
after the deduplication\n interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the\n message is received and deleted.
\nThe length of MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS\n Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular MessageDeduplicationId
is sent\n successfully, subsequent messages with the same MessageDeduplicationId
are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the queue has ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId
after the deduplication\n 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.
\nThe length of MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however, messages\n in different message groups might be processed out of order). To interleave multiple\n ordered streams within a single queue, use MessageGroupId
values (for\n example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.
\n ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId
values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.
\n ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.
Contains the details of a single Amazon SQS message along with an\n Id
.
Contains the details of a single Amazon SQS message along with an Id
.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute\n to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the\n message before creating the MD5 digest. For information about MD5, see RFC1321.
", + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message body 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.
", "smithy.api#required": {} } }, "MD5OfMessageAttributes": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321.
" + "smithy.api#documentation": "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.
" } }, "MD5OfMessageSystemAttributes": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321.
" + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute 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.
" } }, "SequenceNumber": { @@ -3768,20 +3791,20 @@ "MessageBody": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "The message to send. The minimum size is one character. The maximum size is 256\n KiB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode\n characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to\n #xD7FF
| #xE000
to #xFFFD
|\n #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters.
\nThe message to send. The minimum size is one character. The maximum size is 256\n KiB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\n The length of time, in seconds, for which to delay a specific message. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue applies.
When you set FifoQueue
, you can't set DelaySeconds
per\n 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:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n 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.
Each message attribute consists of a Name
, Type
, and\n Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer\n Guide.
Each message attribute consists of a Name
, Type
, \nand Value
. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.
The message system attribute to send. Each message system attribute consists of a\n Name
, Type
, and Value
.
Currently, the only supported message system attribute is\n AWSTraceHeader
. Its type must be String
and\n its value must be a correctly formatted X-Ray trace\n header string.
The size of a message system attribute doesn't count towards the total\n size of a message.
\nThe 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
.\n Its type must be String
and its value must be a correctly formatted\n X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
\nThis parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId
is sent successfully, any messages sent with the\n same MessageDeduplicationId
are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the queue has ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId
after the deduplication\n interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the\n message is received and deleted.
\nThe maximum length of MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS\n Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId
is sent successfully, any messages sent with the\n same MessageDeduplicationId
are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the queue has ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId
after the deduplication\n 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.
\nThe maximum length of MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however, messages\n in different message groups might be processed out of order). To interleave multiple\n ordered streams within a single queue, use MessageGroupId
values (for\n example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.
\n ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId
values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.
\n ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.
The maximum length of MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute\n to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the\n message before creating the MD5 digest. For information about MD5, see RFC1321.
" + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message body 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.
" } }, "MD5OfMessageAttributes": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321.
" + "smithy.api#documentation": "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.
" } }, "MD5OfMessageSystemAttributes": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest.
" + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.
" } }, "MessageId": { @@ -3886,7 +3909,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets the value of one or more queue attributes. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the MessageRetentionPeriod
attribute\n can take up to 15 minutes and will impact existing messages in the queue potentially\n causing them to be expired and deleted if the MessageRetentionPeriod
is\n reduced below the age of existing messages.
In the future, new attributes might be added. If you write code that calls\n this action, we recommend that you structure your code so that it can handle\n new attributes gracefully.
\nCross-account permissions don't apply to this action. For more\n information, see Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny\n permission to the AddPermission
, RemovePermission
,\n and SetQueueAttributes
actions in your IAM policy.
Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the MessageRetentionPeriod
attribute can\n take up to 15 minutes and will impact existing messages in the queue potentially causing\n them to be expired and deleted if the MessageRetentionPeriod
is reduced\n below the age of existing messages.
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.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.
A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes
action uses:
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0.
\n MaximumMessageSize
– The limit of how many bytes a message can\n contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod
– The length of time, in seconds, for which\n Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to\n the MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– The queue's policy. A valid Amazon Web Services\n policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the\n Identity and Access Management User Guide.\n
\n ReceiveMessageWaitTimeSeconds
– The length of time, in seconds, for\n which a \n ReceiveMessage\n
action waits for a message\n to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
\n VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the\n dead-letter queue functionality of the source queue as a JSON object. The\n parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of\n the dead-letter queue to which Amazon SQS moves messages after the value\n of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is\n delivered to the source queue before being moved to the dead-letter\n queue. Default: 10. When the ReceiveCount
for a message\n exceeds the maxReceiveCount
for a queue, Amazon SQS moves\n the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for\n the permissions for the dead-letter queue redrive permission and which source\n queues can specify dead-letter queues as a JSON object. The parameters are as\n follows:
\n redrivePermission
– The permission type that defines\n which source queues can specify the current queue as the dead-letter\n queue. Valid values are:
\n allowAll
– (Default) Any source queues in this\n Amazon Web Services account in the same\n Region can specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue\n as the dead-letter queue.
\n byQueue
– Only queues specified by the\n sourceQueueArns
parameter can specify this\n queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the\n source queues that can specify this queue as the dead-letter queue and\n redrive messages. You can specify this parameter only when the\n redrivePermission
parameter is set to\n byQueue
. You can specify up to 10 source queue ARNs. To\n allow more than 10 source queues to specify dead-letter queues, set the\n redrivePermission
parameter to\n allowAll
.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the\n dead-letter queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see\n Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs
, the alias of a custom CMK can, for example,\n be alias/MyAlias\n
. For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for\n which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer representing\n seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:\n 300 (5 minutes). A shorter time period provides better security but results in\n more calls to KMS which might incur charges after Free Tier. For more\n information, see How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled
– Enables server-side queue encryption using\n SQS owned encryption keys. Only one server-side encryption option is supported\n per queue (for example, SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO\n (first-in-first-out) queues:
\n\n ContentBasedDeduplication
– Enables content-based deduplication.\n For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId
.
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.
If the queue has ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to high\n throughput for FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication\n occurs at the message group or queue level. Valid values are\n messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput\n quota applies to the entire queue or per message group. Valid values are\n perQueue
and perMessageGroupId
. The\n perMessageGroupId
value is allowed only when the value for\n DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, see Quotas\n related to messages in the Amazon SQS Developer\n Guide.
", + "smithy.api#documentation": "A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes
action uses:
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0.
\n MaximumMessageSize
– The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod
– The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the Identity and Access Management User\n Guide.
\n ReceiveMessageWaitTimeSeconds
– The length of time, in\n seconds, for which a \n ReceiveMessage\n
action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.
\n VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
\n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission
– The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue as the dead-letter\n queue.
\n byQueue
– Only queues specified by the sourceQueueArns
parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission
parameter is set to byQueue
. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
parameter\n to allowAll
.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n 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\n always alias/aws/sqs
, the alias of a custom CMK can, for example,\n be alias/MyAlias\n
. For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds
– The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO (first-in-first-out)\n queues:
\n\n ContentBasedDeduplication
– Enables content-based\n deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId
.
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.
If the queue has ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
. \n The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" @@ -3940,7 +3963,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.
\nThis action is currently limited to supporting message redrive from queues\n that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS\n queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are\n currently not supported.
\nIn dead-letter queues redrive context, the\n StartMessageMoveTask
the source queue is the DLQ, while the\n destination queue can be the original source queue (from which the messages\n were driven to the dead-letter-queue), or a custom destination queue.
Currently, only standard queues support redrive. FIFO queues don't support\n redrive.
\nOnly one active message movement task is supported per queue at any given\n time.
\nStarts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.
\nThis action is currently limited to supporting message redrive from queues\n that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS\n queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are\n currently not supported.
\nIn dead-letter queues redrive context, the\n StartMessageMoveTask
the source queue is the DLQ, while the\n destination queue can be the original source queue (from which the messages\n were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given\n time.
\nAdd cost allocation tags to the specified Amazon SQS queue. For an overview, see\n Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character\n strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the\n existing tag.
\nFor a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer\n Guide.
\nCross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nAdd cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nRemove cost allocation tags from the specified Amazon SQS queue. For an overview, see\n Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n Guide.
\nCross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nRemove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\n