From ba18a1e5cf5209d6eae8189f5bf8a15bc99409c8 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Wed, 8 May 2024 18:06:32 +0000 Subject: [PATCH] Update API model --- .../aws-models/cognito-identity-provider.json | 8 +- codegen/sdk-codegen/aws-models/ec2.json | 25 +++ codegen/sdk-codegen/aws-models/ecr.json | 8 +- codegen/sdk-codegen/aws-models/fms.json | 12 +- codegen/sdk-codegen/aws-models/polly.json | 24 +-- codegen/sdk-codegen/aws-models/sqs.json | 143 ++++++++++-------- 6 files changed, 143 insertions(+), 77 deletions(-) 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.

\n ", + "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.

\n ", "smithy.api#required": {} } }, @@ -7711,6 +7711,12 @@ "traits": { "smithy.api#enumValue": "azure-container-registry" } + }, + "GitLabContainerRegistry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gitlab-container-registry" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/fms.json b/codegen/sdk-codegen/aws-models/fms.json index 3d53d7ff4ce..b6d87a8a357 100644 --- a/codegen/sdk-codegen/aws-models/fms.json +++ b/codegen/sdk-codegen/aws-models/fms.json @@ -5275,7 +5275,7 @@ "ForceRemediateForFirstEntries": { "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.

\n

If 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.

\n

If 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.

\n

If 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.

\n

If 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.

\n

A 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.

\n

If 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.

\n

Firewall Manager provides the following types of policies:

\n " + "smithy.api#documentation": "

Creates an Firewall Manager policy.

\n

A 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.

\n

If 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.

\n

Firewall Manager provides the following types of policies:

\n " } }, "com.amazonaws.fms#PutPolicyRequest": { @@ -7396,12 +7396,12 @@ "Value": { "target": "com.amazonaws.fms#ResourceTagValue", "traits": { - "smithy.api#documentation": "

The 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.

\n

Every 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.

", + "smithy.api#documentation": "

Specifies the engine (standard, neural,\n long-form or generative) used by Amazon Polly when\n processing input text for speech synthesis.

", "smithy.api#httpQuery": "Engine" } }, @@ -238,6 +238,12 @@ "traits": { "smithy.api#enumValue": "long-form" } + }, + "GENERATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "generative" + } } } }, @@ -2288,7 +2294,7 @@ "com.amazonaws.polly#SnsTopicArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0-9_-]{1,50}:\\d{12}:[a-zA-Z0-9_-]{1,256}$" + "smithy.api#pattern": "^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0-9_-]{1,50}:\\d{12}:[a-zA-Z0-9_-]{1,251}([a-zA-Z0-9_-]{0,5}|\\.fifo)$" } }, "com.amazonaws.polly#SpeechMarkType": { @@ -2406,7 +2412,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.

" + "smithy.api#documentation": "

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.

" } }, "LanguageCode": { @@ -2444,7 +2450,7 @@ "SampleRate": { "target": "com.amazonaws.polly#SampleRate", "traits": { - "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The 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\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".

" + "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The 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\".

\n

Valid 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.

" + "smithy.api#documentation": "

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.

" } }, "TaskId": { @@ -2565,7 +2571,7 @@ "SampleRate": { "target": "com.amazonaws.polly#SampleRate", "traits": { - "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The 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\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".

" + "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The 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\".

\n

Valid 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

\n NTTS-only voices\n

\n

When 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

\n long-form-only voices\n

\n

When 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.

\n

Type: String

\n

Valid Values: standard | neural |\n long-form\n

\n

Required: Yes

\n

\n Standard voices\n

\n

For 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.

" + "smithy.api#documentation": "

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.

\n

Type: String

\n

Valid Values: standard | neural |\n long-form | generative\n

\n

Required: Yes

" } }, "LanguageCode": { @@ -2714,7 +2720,7 @@ "SampleRate": { "target": "com.amazonaws.polly#SampleRate", "traits": { - "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The 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\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".

" + "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The 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\".

\n

Valid 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.

" + "smithy.api#documentation": "

Specifies which engines (standard, neural,\n long-form or generative) are supported by a given voice.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/sqs.json b/codegen/sdk-codegen/aws-models/sqs.json index 1982004f6e5..578c7847656 100644 --- a/codegen/sdk-codegen/aws-models/sqs.json +++ b/codegen/sdk-codegen/aws-models/sqs.json @@ -70,7 +70,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a permission to a queue for a specific principal. This allows sharing\n access to the queue.

\n

When 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 \n \n \n

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.

\n
" + "smithy.api#documentation": "

Adds a permission to a queue for a specific principal. This allows sharing\n access to the queue.

\n

When 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 \n \n \n

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.

\n
" } }, "com.amazonaws.sqs#AddPermissionRequest": { @@ -93,7 +93,7 @@ "AWSAccountIds": { "target": "com.amazonaws.sqs#AWSAccountIdList", "traits": { - "smithy.api#documentation": "

The 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.

\n

Amazon 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.

\n

For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n

\n

You 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:

\n \n

\n Additional information\n

\n ", + "smithy.api#documentation": "

Welcome to the Amazon SQS API Reference.

\n

Amazon 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.

\n

For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n

\n

You 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:

\n \n

\n Additional information\n

\n ", "smithy.api#title": "Amazon Simple Queue Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1338,7 +1338,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels 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.

\n \n \n " + "smithy.api#documentation": "

Cancels 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.

\n \n \n " } }, "com.amazonaws.sqs#CancelMessageMoveTaskRequest": { @@ -1403,7 +1403,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

For 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.

\n

An Amazon SQS message has three basic states:

\n
    \n
  1. \n

    Sent to a queue by a producer.

    \n
  2. \n
  3. \n

    Received from the queue by a consumer.

    \n
  4. \n
  5. \n

    Deleted from the queue.

    \n
  6. \n
\n

A 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.

\n

Limits that apply to in flight messages are unrelated to the\n unlimited number of stored messages.

\n

For 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.

\n

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.

\n \n

If 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.

\n

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.

\n
" + "smithy.api#documentation": "

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.

\n

For 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.

\n

An Amazon SQS message has three basic states:

\n
    \n
  1. \n

    Sent to a queue by a producer.

    \n
  2. \n
  3. \n

    Received from the queue by a consumer.

    \n
  4. \n
  5. \n

    Deleted from the queue.

    \n
  6. \n
\n

A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\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.

\n

Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.

\n

For 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.

\n

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.

\n \n

If 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.

\n

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.

\n
" } }, "com.amazonaws.sqs#ChangeMessageVisibilityBatch": { @@ -1444,7 +1444,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n \n

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.

\n
" + "smithy.api#documentation": "

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.

\n \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.

\n
" } }, "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequest": { @@ -1478,7 +1478,7 @@ "Id": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

An identifier for this particular receipt handle used to communicate the\n result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n
", + "smithy.api#documentation": "

An identifier for this particular receipt handle used to communicate the\n result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n
", "smithy.api#required": {} } }, @@ -1618,7 +1618,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new standard or FIFO queue. You can pass one or more attributes in the\n request. Keep the following in mind:

\n \n

To 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.

\n \n

After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.

\n
\n

To 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:

\n \n \n

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.

\n
" + "smithy.api#documentation": "

Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

\n \n

To 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.

\n \n

After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.

\n
\n

To 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:

\n \n \n

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.

\n
" } }, "com.amazonaws.sqs#CreateQueueRequest": { @@ -1634,7 +1634,7 @@ "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { - "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue action uses:

\n \n

The following attributes apply only to dead-letter queues:\n

\n \n \n

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.

\n
\n

The following attributes apply only to server-side-encryption:

\n \n

The following attributes apply only to FIFO\n (first-in-first-out) queues:

\n \n

The following attributes apply only to high\n throughput for FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

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.

\n

For 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.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue action uses:

\n \n

The following attributes apply only to dead-letter queues:\n

\n \n \n

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.

\n
\n

The following attributes apply only to server-side-encryption:

\n \n

The following attributes apply only to FIFO (first-in-first-out)\n queues:

\n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

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.

\n

For 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.

\n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer\n Guide.

\n \n

To be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.

\n

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.

\n
", + "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.

\n \n

To be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.

\n

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.

\n
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Tag" } @@ -1700,7 +1700,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes 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.

\n \n

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).

\n

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.

\n
" + "smithy.api#documentation": "

Deletes 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.

\n \n

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).

\n

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.

\n
" } }, "com.amazonaws.sqs#DeleteMessageBatch": { @@ -1741,7 +1741,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n \n

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.

\n
" + "smithy.api#documentation": "

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.

\n \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.

\n
" } }, "com.amazonaws.sqs#DeleteMessageBatchRequest": { @@ -1775,7 +1775,7 @@ "Id": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

The identifier for this particular receipt handle. This is used to communicate the\n result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n
", + "smithy.api#documentation": "

The identifier for this particular receipt handle. This is used to communicate the\n result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n
", "smithy.api#required": {} } }, @@ -1894,7 +1894,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the queue specified by the QueueUrl, regardless of the queue's\n contents.

\n \n

Be careful with the DeleteQueue action: When you delete a queue, any\n messages in the queue are no longer available.

\n
\n

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.

\n

When you delete a queue, you must wait at least 60 seconds before creating a queue\n with the same name.

\n \n

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.

\n

The delete operation uses the HTTP GET verb.

\n
" + "smithy.api#documentation": "

Deletes the queue specified by the QueueUrl, regardless of the queue's\n contents.

\n \n

Be careful with the DeleteQueue action: When you delete a queue, any\n messages in the queue are no longer available.

\n
\n

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.

\n

When you delete a queue, you must wait at least 60 seconds before creating a queue\n with the same name.

\n \n

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.

\n

The delete operation uses the HTTP GET verb.

\n
" } }, "com.amazonaws.sqs#DeleteQueueRequest": { @@ -1962,7 +1962,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets attributes for the specified queue.

\n \n

To determine whether a queue is FIFO, you can check whether QueueName ends with the\n .fifo suffix.

\n
" + "smithy.api#documentation": "

Gets attributes for the specified queue.

\n \n

To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

\n
" } }, "com.amazonaws.sqs#GetQueueAttributesRequest": { @@ -1978,7 +1978,7 @@ "AttributeNames": { "target": "com.amazonaws.sqs#AttributeNameList", "traits": { - "smithy.api#documentation": "

A list of attributes for which to retrieve information.

\n

The AttributeNames parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.

\n \n

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.

\n
\n

The following attributes are supported:

\n \n

The 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
\n \n

The following attributes apply only to dead-letter queues:\n

\n \n \n

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.

\n
\n

The following attributes apply only to server-side-encryption:

\n \n

The following attributes apply only to FIFO\n (first-in-first-out) queues:

\n \n

The following attributes apply only to high\n throughput for FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

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.

\n

For 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.

\n

The AttributeNames parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.

\n \n

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.

\n
\n

The following attributes are supported:

\n \n

The 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
\n \n

The following attributes apply only to dead-letter queues:\n

\n \n \n

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.

\n
\n

The following attributes apply only to server-side-encryption:

\n \n

The following attributes apply only to FIFO (first-in-first-out)\n queues:

\n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

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.

\n

For 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.

\n

To 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.

" + "smithy.api#documentation": "

Returns the URL of an existing Amazon SQS queue.

\n

To 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.

" } }, "com.amazonaws.sqs#GetQueueUrlRequest": { @@ -2048,7 +2048,7 @@ "QueueOwnerAWSAccountId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

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.

\n \n \n " + "smithy.api#documentation": "

Gets the most recent message movement tasks (up to 10) under a specific source\n queue.

\n \n \n " } }, "com.amazonaws.sqs#ListMessageMoveTasksRequest": { @@ -2486,7 +2486,7 @@ "ApproximateNumberOfMessagesToMove": { "target": "com.amazonaws.sqs#NullableLong", "traits": { - "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.

" + "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.

\n \n

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.

\n
" + "smithy.api#documentation": "

List 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.

\n \n

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.

\n
" } }, "com.amazonaws.sqs#ListQueueTagsRequest": { @@ -2596,7 +2596,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns 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.

\n

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.

\n \n

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.

\n
", + "smithy.api#documentation": "

Returns 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.

\n

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.

\n \n

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.

\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2699,13 +2699,13 @@ "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.

" } }, "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.

", + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "MessageAttribute" } @@ -2758,7 +2758,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.

\n

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.

\n

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.

\n

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.

\n

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.

\n

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.

\n

For each message returned, the response includes the following:

\n \n

The 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.

\n

You 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.

\n

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.

\n \n

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.

\n
" + "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 SQS\n Long Polling in the Amazon SQS Developer Guide.

\n

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.

\n

For each message returned, the response includes the following:

\n \n

The 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.

\n

You 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.

\n

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.

\n \n

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.

\n
" } }, "com.amazonaws.sqs#ReceiveMessageRequest": { @@ -3324,7 +3336,18 @@ "AttributeNames": { "target": "com.amazonaws.sqs#AttributeNameList", "traits": { - "smithy.api#documentation": "

A list of attributes that need to be returned along with each message. These\n attributes include:

\n ", + "smithy.api#deprecated": { + "message": "AttributeNames has been replaced by MessageSystemAttributeNames" + }, + "smithy.api#documentation": "\n

\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

\n
\n

A list of attributes that need to be returned along with each message. These\n attributes include:

\n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AttributeName" + } + }, + "MessageSystemAttributeNames": { + "target": "com.amazonaws.sqs#MessageSystemAttributeList", + "traits": { + "smithy.api#documentation": "

A list of attributes that need to be returned along with each message. These\n attributes include:

\n ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -3340,7 +3363,7 @@ "MaxNumberOfMessages": { "target": "com.amazonaws.sqs#NullableInteger", "traits": { - "smithy.api#documentation": "

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.

\n \n

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.

\n
" + "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 does not return a message list.

\n \n

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.

\n
" } }, "ReceiveRequestAttemptId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The 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.

\n \n

The maximum length of ReceiveRequestAttemptId is 128 characters.\n ReceiveRequestAttemptId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon\n SQS Developer Guide.

" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The 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.

\n \n

The maximum length of ReceiveRequestAttemptId is 128 characters.\n ReceiveRequestAttemptId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.

" } } }, @@ -3410,7 +3433,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes any permissions in the queue policy that matches the specified\n Label parameter.

\n \n \n " + "smithy.api#documentation": "

Revokes any permissions in the queue policy that matches the specified\n Label parameter.

\n \n \n " } }, "com.amazonaws.sqs#RemovePermissionRequest": { @@ -3520,7 +3543,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delivers a message to the specified queue.

\n \n

A 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

\n

Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters.

\n
" + "smithy.api#documentation": "

Delivers a message to the specified queue.

\n \n

A 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

\n

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

\n
" } }, "com.amazonaws.sqs#SendMessageBatch": { @@ -3585,7 +3608,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 in\n the order they are sent.

\n

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.

\n

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).

\n \n

A 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

\n

Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters.

\n
\n

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS\n uses the default value for the queue.

" + "smithy.api#documentation": "

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.

\n

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.

\n

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).

\n \n

A 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

\n

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

\n
\n

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\n the default value for the queue.

" } }, "com.amazonaws.sqs#SendMessageBatchRequest": { @@ -3619,7 +3642,7 @@ "Id": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

An identifier for a message in this batch used to communicate the result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n
", + "smithy.api#documentation": "

An identifier for a message in this batch used to communicate the result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n
", "smithy.api#required": {} } }, @@ -3633,13 +3656,13 @@ "DelaySeconds": { "target": "com.amazonaws.sqs#NullableInteger", "traits": { - "smithy.api#documentation": "

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.

\n \n

When you set FifoQueue, you can't set DelaySeconds per\n message. You can set this parameter only on a queue level.

\n
" + "smithy.api#documentation": "

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.

\n \n

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

\n
" } }, "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.

", + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "MessageAttribute" } @@ -3647,7 +3670,7 @@ "MessageSystemAttributes": { "target": "com.amazonaws.sqs#MessageBodySystemAttributeMap", "traits": { - "smithy.api#documentation": "

The message system attribute to send Each message system attribute consists of a\n Name, Type, and Value.

\n \n \n ", + "smithy.api#documentation": "

The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

\n \n \n ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "MessageSystemAttribute" } @@ -3655,18 +3678,18 @@ "MessageDeduplicationId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The 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.

\n \n \n

The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

\n

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.

\n

Amazon SQS continues to keep track of the message deduplication ID even after the\n message is received and deleted.

\n
\n

The length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS\n Developer Guide.

" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The 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.

\n \n \n

The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

\n

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.

\n

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

\n
\n

The length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.

" } }, "MessageGroupId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The 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.

\n \n

The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.

\n
" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The 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.

\n \n

The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.

\n
" } } }, "traits": { - "smithy.api#documentation": "

Contains the details of a single Amazon SQS message along with an\n Id.

" + "smithy.api#documentation": "

Contains the details of a single Amazon SQS message along with an Id.

" } }, "com.amazonaws.sqs#SendMessageBatchRequestEntryList": { @@ -3722,20 +3745,20 @@ "MD5OfMessageBody": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

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.

\n \n

A 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

\n

Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters.

\n
", + "smithy.api#documentation": "

The message to send. The minimum size is one character. The maximum size is 256\n KiB.

\n \n

A 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

\n

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

\n
", "smithy.api#required": {} } }, "DelaySeconds": { "target": "com.amazonaws.sqs#NullableInteger", "traits": { - "smithy.api#documentation": "

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.

\n \n

When you set FifoQueue, you can't set DelaySeconds per\n message. You can set this parameter only on a queue level.

\n
" + "smithy.api#documentation": "

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.

\n \n

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

\n
" } }, "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.

", + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "MessageAttribute" } @@ -3789,7 +3812,7 @@ "MessageSystemAttributes": { "target": "com.amazonaws.sqs#MessageBodySystemAttributeMap", "traits": { - "smithy.api#documentation": "

The message system attribute to send. Each message system attribute consists of a\n Name, Type, and Value.

\n \n \n ", + "smithy.api#documentation": "

The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

\n \n \n ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "MessageSystemAttribute" } @@ -3797,13 +3820,13 @@ "MessageDeduplicationId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The 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.

\n \n \n

The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

\n

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.

\n

Amazon SQS continues to keep track of the message deduplication ID even after the\n message is received and deleted.

\n
\n

The maximum length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS\n Developer Guide.

" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The 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.

\n \n \n

The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

\n

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.

\n

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

\n
\n

The maximum length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.

" } }, "MessageGroupId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The 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.

\n \n

The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.

\n
" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The 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.

\n \n

The maximum length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.

\n
" } } }, @@ -3818,19 +3841,19 @@ "MD5OfMessageBody": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

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.

\n \n \n " + "smithy.api#documentation": "

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.

\n \n \n " } }, "com.amazonaws.sqs#SetQueueAttributesRequest": { @@ -3902,7 +3925,7 @@ "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { - "smithy.api#documentation": "

A map of attributes to set.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes action uses:

\n \n

The following attributes apply only to dead-letter queues:\n

\n \n \n

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.

\n
\n

The following attributes apply only to server-side-encryption:

\n \n

The following attribute applies only to FIFO\n (first-in-first-out) queues:

\n \n

The following attributes apply only to high\n throughput for FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

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.

\n

For 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.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes action uses:

\n \n

The following attributes apply only to dead-letter queues:\n

\n \n \n

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.

\n
\n

The following attributes apply only to server-side-encryption:

\n \n

The following attribute applies only to FIFO (first-in-first-out)\n queues:

\n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

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.

\n

For 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.

\n \n \n " + "smithy.api#documentation": "

Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.

\n \n \n " } }, "com.amazonaws.sqs#StartMessageMoveTaskRequest": { @@ -4046,7 +4069,7 @@ } ], "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.

\n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer\n Guide.

\n \n

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.

\n
" + "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.

\n \n

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.

\n
" } }, "com.amazonaws.sqs#TagQueueRequest": { @@ -4139,7 +4162,7 @@ } ], "traits": { - "smithy.api#documentation": "

Remove 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.

\n \n

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.

\n
" + "smithy.api#documentation": "

Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n \n

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.

\n
" } }, "com.amazonaws.sqs#UntagQueueRequest": {