diff --git a/.changes/next-release/api-change-cognitoidp-27183.json b/.changes/next-release/api-change-cognitoidp-27183.json new file mode 100644 index 0000000000..df9df06aa8 --- /dev/null +++ b/.changes/next-release/api-change-cognitoidp-27183.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``cognito-idp``", + "description": "Add EXTERNAL_PROVIDER enum value to UserStatusType." +} diff --git a/.changes/next-release/api-change-ec2-61180.json b/.changes/next-release/api-change-ec2-61180.json new file mode 100644 index 0000000000..11b9250dc4 --- /dev/null +++ b/.changes/next-release/api-change-ec2-61180.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``ec2``", + "description": "Adding Precision Hardware Clock (PHC) to public API DescribeInstanceTypes" +} diff --git a/.changes/next-release/api-change-ecr-23684.json b/.changes/next-release/api-change-ecr-23684.json new file mode 100644 index 0000000000..1a5fe2b22d --- /dev/null +++ b/.changes/next-release/api-change-ecr-23684.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``ecr``", + "description": "This release adds pull through cache rules support for GitLab container registry in Amazon ECR." +} diff --git a/.changes/next-release/api-change-fms-16477.json b/.changes/next-release/api-change-fms-16477.json new file mode 100644 index 0000000000..5284904978 --- /dev/null +++ b/.changes/next-release/api-change-fms-16477.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``fms``", + "description": "The policy scope resource tag is always a string value, either a non-empty string or an empty string." +} diff --git a/.changes/next-release/api-change-polly-96373.json b/.changes/next-release/api-change-polly-96373.json new file mode 100644 index 0000000000..c6263ed2e4 --- /dev/null +++ b/.changes/next-release/api-change-polly-96373.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``polly``", + "description": "Add new engine - generative - that builds the most expressive conversational voices." +} diff --git a/.changes/next-release/api-change-sqs-35164.json b/.changes/next-release/api-change-sqs-35164.json new file mode 100644 index 0000000000..ce50729f07 --- /dev/null +++ b/.changes/next-release/api-change-sqs-35164.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``sqs``", + "description": "This release adds MessageSystemAttributeNames to ReceiveMessageRequest to replace AttributeNames." +} diff --git a/botocore/data/cognito-idp/2016-04-18/service-2.json b/botocore/data/cognito-idp/2016-04-18/service-2.json index 47a9ef4ed1..a98e7dfbda 100644 --- a/botocore/data/cognito-idp/2016-04-18/service-2.json +++ b/botocore/data/cognito-idp/2016-04-18/service-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"cognito-idp", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceFullName":"Amazon Cognito Identity Provider", "serviceId":"Cognito Identity Provider", "signatureVersion":"v4", @@ -8445,7 +8446,8 @@ "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", - "FORCE_CHANGE_PASSWORD" + "FORCE_CHANGE_PASSWORD", + "EXTERNAL_PROVIDER" ] }, "UserType":{ diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 84b1554dbd..a1c6a3446b 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -37277,6 +37277,11 @@ "shape":"NeuronInfo", "documentation":"
Describes the Neuron accelerator settings for the instance type.
", "locationName":"neuronInfo" + }, + "PhcSupport":{ + "shape":"PhcSupport", + "documentation":"Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported.
", + "locationName":"phcSupport" } }, "documentation":"Describes the instance type.
" @@ -47150,6 +47155,13 @@ }, "documentation":"Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.
" }, + "PhcSupport":{ + "type":"string", + "enum":[ + "unsupported", + "supported" + ] + }, "Placement":{ "type":"structure", "members":{ diff --git a/botocore/data/ecr/2015-09-21/service-2.json b/botocore/data/ecr/2015-09-21/service-2.json index 757fb53790..c4a7fe7612 100644 --- a/botocore/data/ecr/2015-09-21/service-2.json +++ b/botocore/data/ecr/2015-09-21/service-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"api.ecr", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceAbbreviation":"Amazon ECR", "serviceFullName":"Amazon EC2 Container Registry", "serviceId":"ECR", @@ -1032,7 +1033,7 @@ }, "upstreamRegistryUrl":{ "shape":"Url", - "documentation":"The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.
Amazon ECR Public (ecr-public
) - public.ecr.aws
Docker Hub (docker-hub
) - registry-1.docker.io
Quay (quay
) - quay.io
Kubernetes (k8s
) - registry.k8s.io
GitHub Container Registry (github-container-registry
) - ghcr.io
Microsoft Azure Container Registry (azure-container-registry
) - <custom>.azurecr.io
The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.
Amazon ECR Public (ecr-public
) - public.ecr.aws
Docker Hub (docker-hub
) - registry-1.docker.io
Quay (quay
) - quay.io
Kubernetes (k8s
) - registry.k8s.io
GitHub Container Registry (github-container-registry
) - ghcr.io
Microsoft Azure Container Registry (azure-container-registry
) - <custom>.azurecr.io
GitLab Container Registry (gitlab-container-registry
) - registry.gitlab.com
Creates an Firewall Manager policy.
A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.
If you add a new account to an organization that you created with Organizations, Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.
Firewall Manager provides the following types of policies:
WAF policy - This policy applies WAF web ACL protections to specified accounts and resources.
Shield Advanced policy - This policy applies Shield Advanced protection to specified accounts and resources.
Security Groups policy - This type of policy gives you control over security groups that are in use throughout your organization in Organizations and lets you enforce a baseline set of rules across your organization.
Network ACL policy - This type of policy gives you control over the network ACLs that are in use throughout your organization in Organizations and lets you enforce a baseline set of first and last network ACL rules across your organization.
Network Firewall policy - This policy applies Network Firewall protection to your organization's VPCs.
DNS Firewall policy - This policy applies Amazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at Amazon Web Services Marketplace.
Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
Fortigate CNF policy - This policy applies Fortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.
Creates an Firewall Manager policy.
A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.
If you add a new account to an organization that you created with Organizations, Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.
Firewall Manager provides the following types of policies:
WAF policy - This policy applies WAF web ACL protections to specified accounts and resources.
Shield Advanced policy - This policy applies Shield Advanced protection to specified accounts and resources.
Security Groups policy - This type of policy gives you control over security groups that are in use throughout your organization in Organizations and lets you enforce a baseline set of rules across your organization.
Network ACL policy - This type of policy gives you control over the network ACLs that are in use throughout your organization in Organizations and lets you enforce a baseline set of first and last network ACL rules across your organization.
Network Firewall policy - This policy applies Network Firewall protection to your organization's VPCs.
DNS Firewall policy - This policy applies Amazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at Amazon Web Services Marketplace.
Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
Fortigate CNF policy - This policy applies Fortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.
Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.
If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Network access control list (ACL) policies in the Firewall Manager Developer Guide.
" + "documentation":"Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.
If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the Firewall Manager Developer Guide.
" }, "LastEntries":{ "shape":"NetworkAclEntries", @@ -2645,7 +2645,7 @@ }, "ForceRemediateForLastEntries":{ "shape":"BooleanObject", - "documentation":"Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.
If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Network access control list (ACL) policies in the Firewall Manager Developer Guide.
" + "documentation":"Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.
If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the Firewall Manager Developer Guide.
" } }, "documentation":"The configuration of the first and last rules for the network ACL policy, and the remediation settings for each.
" @@ -3205,7 +3205,7 @@ }, "PolicyDescription":{ "shape":"ResourceDescription", - "documentation":"The definition of the Network Firewall firewall policy.
" + "documentation":"Your description of the Firewall Manager policy.
" }, "PolicyStatus":{ "shape":"CustomerPolicyStatus", @@ -3917,10 +3917,10 @@ }, "Value":{ "shape":"ResourceTagValue", - "documentation":"The resource tag value.
" + "documentation":"The resource tag value. To specify an empty string value, either don't provide this or specify it as \"\".
" } }, - "documentation":"The resource tags that Firewall Manager uses to determine if a particular resource should be included or excluded from the Firewall Manager policy. Tags enable you to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.
" + "documentation":"The resource tags that Firewall Manager uses to determine if a particular resource should be included or excluded from the Firewall Manager policy. Tags enable you to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.
Every resource tag must have a string value, either a non-empty string or an empty string. If you don't provide a value for a resource tag, Firewall Manager saves the value as an empty string: \"\". When Firewall Manager compares tags, it only matches two tags if they have the same key and the same value. A tag with an empty string value only matches with tags that also have an empty string value.
" }, "ResourceTagKey":{ "type":"string", diff --git a/botocore/data/polly/2016-06-10/service-2.json b/botocore/data/polly/2016-06-10/service-2.json index 47a5455d2e..420e8cbe37 100644 --- a/botocore/data/polly/2016-06-10/service-2.json +++ b/botocore/data/polly/2016-06-10/service-2.json @@ -199,7 +199,7 @@ "members":{ "Engine":{ "shape":"Engine", - "documentation":"Specifies the engine (standard
, neural
or long-form
) used by Amazon Polly when processing input text for speech synthesis.
Specifies the engine (standard
, neural
, long-form
or generative
) used by Amazon Polly when processing input text for speech synthesis.
Specifies the engine (standard
, neural
or long-form
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
Specifies the engine (standard
, neural
, long-form
or generative
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" + "documentation":"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\". The default value for generative voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" }, "SnsTopicArn":{ "shape":"SnsTopicArn", @@ -790,7 +791,7 @@ "members":{ "Engine":{ "shape":"Engine", - "documentation":"Specifies the engine (standard
, neural
or long-form
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
Specifies the engine (standard
, neural
, long-form
or generative
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" + "documentation":"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\". The default value for generative voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" }, "SpeechMarkTypes":{ "shape":"SpeechMarkTypeList", @@ -874,7 +875,7 @@ "members":{ "Engine":{ "shape":"Engine", - "documentation":"Specifies the engine (standard
, neural
or long-form
) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
NTTS-only voices
When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural
. If the engine is not specified, or is set to standard
, this will result in an error.
long-form-only voices
When using long-form-only voices such as Danielle (en-US), this parameter is required and must be set to long-form
. If the engine is not specified, or is set to standard
or neural
, this will result in an error.
Type: String
Valid Values: standard
| neural
| long-form
Required: Yes
Standard voices
For standard voices, this is not required; the engine parameter defaults to standard
. If the engine is not specified, or is set to standard
and an NTTS-only voice is selected, this will result in an error.
Specifies the engine (standard
, neural
, long-form
, or generative
) for Amazon Polly to use when processing input text for speech synthesis. Provide an engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
Type: String
Valid Values: standard
| neural
| long-form
| generative
Required: Yes
" }, "LanguageCode":{ "shape":"LanguageCode", @@ -890,7 +891,7 @@ }, "SampleRate":{ "shape":"SampleRate", - "documentation":"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" + "documentation":"The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\". The default value for generative voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" }, "SpeechMarkTypes":{ "shape":"SpeechMarkTypeList", @@ -1010,7 +1011,7 @@ }, "SupportedEngines":{ "shape":"EngineList", - "documentation":"Specifies which engines (standard
, neural
or long-form
) are supported by a given voice.
Specifies which engines (standard
, neural
, long-form
or generative
) are supported by a given voice.
Description of the voice.
" diff --git a/botocore/data/sqs/2012-11-05/service-2.json b/botocore/data/sqs/2012-11-05/service-2.json index 896b7daa6d..018749d7f3 100644 --- a/botocore/data/sqs/2012-11-05/service-2.json +++ b/botocore/data/sqs/2012-11-05/service-2.json @@ -47,7 +47,7 @@ {"shape":"InvalidSecurity"}, {"shape":"UnsupportedOperation"} ], - "documentation":"Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet.
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Currently, only standard queues are supported.
Only one active message movement task is supported per queue at any given time.
Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet.
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
Gets the most recent message movement tasks (up to 10) under a specific source queue.
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Currently, only standard queues are supported.
Only one active message movement task is supported per queue at any given time.
Gets the most recent message movement tasks (up to 10) under a specific source queue.
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod
attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod
is reduced below the age of existing messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.
Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod
attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod
is reduced below the age of existing messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.
This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported.
In dead-letter queues redrive context, the StartMessageMoveTask
the source queue is the DLQ, while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Currently, only standard queues support redrive. FIFO queues don't support redrive.
Only one active message movement task is supported per queue at any given time.
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.
This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported.
In dead-letter queues redrive context, the StartMessageMoveTask
the source queue is the DLQ, while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
The number of messages to be moved from the source queue. This number is obtained at the time of starting the message movement task.
" + "documentation":"The number of messages to be moved from the source queue. This number is obtained at the time of starting the message movement task and is only included after the message movement task is selected to start.
" }, "FailureReason":{ "shape":"String", @@ -1223,6 +1223,11 @@ "documentation":"The specified message isn't in flight.
", "exception":true }, + "MessageSystemAttributeList":{ + "type":"list", + "member":{"shape":"MessageSystemAttributeName"}, + "flattened":true + }, "MessageSystemAttributeMap":{ "type":"map", "key":{"shape":"MessageSystemAttributeName"}, @@ -1232,6 +1237,7 @@ "MessageSystemAttributeName":{ "type":"string", "enum":[ + "All", "SenderId", "SentTimestamp", "ApproximateReceiveCount", @@ -1385,6 +1391,12 @@ }, "AttributeNames":{ "shape":"AttributeNameList", + "documentation":" This parameter has been deprecated but will be supported for backward compatibility. To provide attribute names, you are encouraged to use MessageSystemAttributeNames
.
A list of attributes that need to be returned along with each message. These attributes include:
All
– Returns all values.
ApproximateFirstReceiveTimestamp
– Returns the time the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount
– Returns the number of times a message has been received across all queues but not deleted.
AWSTraceHeader
– Returns the X-Ray trace header string.
SenderId
For a user, returns the user ID, for example ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
SentTimestamp
– Returns the time the message was sent to the queue (epoch time in milliseconds).
SqsManagedSseEnabled
– Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
MessageDeduplicationId
– Returns the value provided by the producer that calls the SendMessage
action.
MessageGroupId
– Returns the value provided by the producer that calls the SendMessage
action. Messages with the same MessageGroupId
are returned in sequence.
SequenceNumber
– Returns the value provided by Amazon SQS.
A list of attributes that need to be returned along with each message. These attributes include:
All
– Returns all values.
ApproximateFirstReceiveTimestamp
– Returns the time the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount
– Returns the number of times a message has been received across all queues but not deleted.
AWSTraceHeader
– Returns the X-Ray trace header string.
SenderId
For a user, returns the user ID, for example ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
SentTimestamp
– Returns the time the message was sent to the queue (epoch time in milliseconds).
SqsManagedSseEnabled
– Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
MessageDeduplicationId
– Returns the value provided by the producer that calls the SendMessage
action.
MessageGroupId
– Returns the value provided by the producer that calls the SendMessage
action. Messages with the same MessageGroupId
are returned in sequence.
SequenceNumber
– Returns the value provided by Amazon SQS.
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds
. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage
requests is longer than the WaitTimeSeconds
parameter. For example, with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds
. If no messages are available and the wait time expires, the call does not return a message list.
To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage
requests is longer than the WaitTimeSeconds
parameter. For example, with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of ReceiveMessage
calls. If a networking issue occurs after a ReceiveMessage
action, and instead of a response you receive a generic error, it is possible to retry the same action with an identical ReceiveRequestAttemptId
to retrieve the same set of messages, even if their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId
only for 5 minutes after a ReceiveMessage
action.
When you set FifoQueue
, a caller of the ReceiveMessage
action can provide a ReceiveRequestAttemptId
explicitly.
If a caller of the ReceiveMessage
action doesn't provide a ReceiveRequestAttemptId
, Amazon SQS generates a ReceiveRequestAttemptId
.
It is possible to retry the ReceiveMessage
action with the same ReceiveRequestAttemptId
if none of the messages have been modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId
return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
If a caller of the ReceiveMessage
action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
While messages with a particular MessageGroupId
are invisible, no more messages belonging to the same MessageGroupId
are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId
as long as it is also visible.
If a caller of ReceiveMessage
can't track the ReceiveRequestAttemptId
, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId
is 128 characters. ReceiveRequestAttemptId
can contain alphanumeric characters (a-z
, A-Z
, 0-9
) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of ReceiveMessage
calls. If a networking issue occurs after a ReceiveMessage
action, and instead of a response you receive a generic error, it is possible to retry the same action with an identical ReceiveRequestAttemptId
to retrieve the same set of messages, even if their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId
only for 5 minutes after a ReceiveMessage
action.
When you set FifoQueue
, a caller of the ReceiveMessage
action can provide a ReceiveRequestAttemptId
explicitly.
It is possible to retry the ReceiveMessage
action with the same ReceiveRequestAttemptId
if none of the messages have been modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId
return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
If a caller of the ReceiveMessage
action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
While messages with a particular MessageGroupId
are invisible, no more messages belonging to the same MessageGroupId
are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId
as long as it is also visible.
If a caller of ReceiveMessage
can't track the ReceiveRequestAttemptId
, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId
is 128 characters. ReceiveRequestAttemptId
can contain alphanumeric characters (a-z
, A-Z
, 0-9
) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.
You must associate a non-empty MessageGroupId
with a message. If you don't provide a MessageGroupId
, the action fails.
ReceiveMessage
might return messages with multiple MessageGroupId
values. For each MessageGroupId
, the messages are sorted by time sent. The caller can't specify a MessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.
You must associate a non-empty MessageGroupId
with a message. If you don't provide a MessageGroupId
, the action fails.
ReceiveMessage
might return messages with multiple MessageGroupId
values. For each MessageGroupId
, the messages are sorted by time sent. The caller can't specify a MessageGroupId
.
The maximum length of MessageGroupId
is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.