diff --git a/doc_source/index.md b/doc_source/index.md index 77aae8b..399a75d 100644 --- a/doc_source/index.md +++ b/doc_source/index.md @@ -50,7 +50,9 @@ Amazon's trademarks and trade dress may not be used in + [Amazon SQS Queue and Message Identifiers](sqs-queue-message-identifiers.md) + [Identifiers for Amazon SQS Standard and FIFO Queues](sqs-general-identifiers.md) + [Additional Identifiers for Amazon SQS FIFO Queues](sqs-additional-fifo-queue-identifiers.md) - + [Amazon SQS Message Attributes](sqs-message-attributes.md) + + [Message Metadata](sqs-message-metadata.md) + + [Amazon SQS Message Attributes](sqs-message-attributes.md) + + [Amazon SQS Message System Attributes](sqs-message-system-attributes.md) + [Resources Required to Process Amazon SQS Messages](sqs-resources-required-process-messages.md) + [Amazon SQS Cost Allocation Tags](sqs-queue-tags.md) + [Amazon SQS Short and Long Polling](sqs-short-and-long-polling.md) @@ -77,13 +79,14 @@ Amazon's trademarks and trade dress may not be used in + [Using the Amazon SQS Message Group ID](using-messagegroupid-property.md) + [Using the Amazon SQS Receive Request Attempt ID](using-receiverequestattemptid-request-parameter.md) + [Amazon SQS Limits](sqs-limits.md) -+ [Monitoring, Logging, and Automating Amazon SQS Queues](sqs-monitoring-logging.md) ++ [Monitoring, Logging, Automating, and Troubleshooting Amazon SQS Queues](sqs-monitoring-logging-automating-troubleshooting.md) + [Monitoring Amazon SQS Queues Using CloudWatch](sqs-monitoring-using-cloudwatch.md) + [Accessing CloudWatch Metrics for Amazon SQS](sqs-access-metrics.md) + [Creating CloudWatch Alarms for Amazon SQS Metrics](set-cloudwatch-alarms-for-metrics.md) + [Available CloudWatch Metrics for Amazon SQS](sqs-available-cloudwatch-metrics.md) - + [Logging Amazon SQS API Calls Using AWS CloudTrail](logging-using-cloudtrail.md) + + [Logging Amazon SQS API Calls Using AWS CloudTrail](sqs-logging-using-cloudtrail.md) + [Automating Notifications from AWS Services to Amazon SQS using CloudWatch Events](sqs-automating-using-cloudwatch-events.md) + + [Troubleshooting Amazon Simple Queue Service Queues Using AWS X-Ray](sqs-troubleshooting-using-x-ray.md) + [Amazon SQS Security](sqs-security.md) + [Authentication and Access Control for Amazon SQS](sqs-authentication-and-access-control.md) + [Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource](sqs-overview-of-managing-access.md) diff --git a/doc_source/sqs-document-history.md b/doc_source/sqs-document-history.md index 20a7e2a..429667b 100644 --- a/doc_source/sqs-document-history.md +++ b/doc_source/sqs-document-history.md @@ -5,6 +5,7 @@ The following table lists changes to the *Amazon Simple Queue Service Developer | Date | Documentation Update | | --- | --- | +| August 28, 2019 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-document-history.html) | | August 20, 2019 | Revised the information in the following sections: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-document-history.html) | | August 9, 2019 | Revised the information in the following sections: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-document-history.html) | | August 7, 2019 | Added the following statement to the [Limits Related to Queues](sqs-limits.md#limits-queues) section: The number of messages that an Amazon SQS queue can store is unlimited\. | @@ -36,7 +37,7 @@ The following table lists changes to the *Amazon Simple Queue Service Developer | September 4, 2018 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-document-history.html) | | August 28, 2018 | Updated the [Protecting Amazon SQS Data Using Server\-Side Encryption \(SSE\) and AWS KMS](sqs-server-side-encryption.md) section\. | | August 27, 2018 | Corrected the information in the [Amazon SQS API Permissions: Actions and Resource Reference](sqs-api-permissions-reference.md) section\. | -| August 22, 2018 | Rewrote the [Logging Amazon SQS API Calls Using AWS CloudTrail](logging-using-cloudtrail.md) section\. | +| August 22, 2018 | Rewrote the [Logging Amazon SQS API Calls Using AWS CloudTrail](sqs-logging-using-cloudtrail.md) section\. | | August 21, 2018 | Revised the attribute table in the [Resources Required to Process Amazon SQS Messages](sqs-resources-required-process-messages.md) section\. | | August 20, 2018 | Added the following note to the [Amazon SQS Dead\-Letter Queues](sqs-dead-letter-queues.md) and [Tutorial: Configuring an Amazon SQS Dead\-Letter Queue](sqs-configure-dead-letter-queue.md) section: When you designate a queue to be a source queue, a dead\-letter queue is not created automatically\. You must first create a normal standard or FIFO queue before designating it a dead\-letter queue\. | | August 15, 2018 | Added the following note to the [Amazon SQS Short and Long Polling](sqs-short-and-long-polling.md) section: You can confirm that a queue is empty when you perform a long poll and the ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessagesVisible metrics are equal to 0 at least 1 minute after the producers stop sending messages \(when the queue metadata reaches eventual consistency\)\. For more information, see [Available CloudWatch Metrics for Amazon SQS](sqs-available-cloudwatch-metrics.md)\. | @@ -137,7 +138,7 @@ The following table lists changes to the *Amazon Simple Queue Service Developer | February 6, 2017 | Updated the [Authentication and Access Control](sqs-authentication-and-access-control.md) section\. | | December 16, 2016 | Retired the Amazon Simple Queue Service Getting Started Guide and incorporated some of its content into the following sections of this guide:[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-document-history.html) | | December 2, 2016 | Restructured and updated the [Authentication and Access Control](sqs-authentication-and-access-control.md) section\. | -| November 2, 2016 | Renamed the Walkthroughs section to [Amazon SQS Tutorials](sqs-tutorials.md)\. | +| November 2, 2016 | Renamed the [Amazon SQS Tutorials](sqs-tutorials.md) section\. | | May 27, 2016 | Added the [Best Practices for Amazon SQS](sqs-best-practices.md) section\. | | May 12, 2016 | Added the [Amazon SQS Limits](sqs-limits.md) section\. | | December 7, 2015 | Updated Amazon SQS console screenshots\. | diff --git a/doc_source/sqs-getting-started.md b/doc_source/sqs-getting-started.md index 2157c4a..d13bbcd 100644 --- a/doc_source/sqs-getting-started.md +++ b/doc_source/sqs-getting-started.md @@ -135,5 +135,5 @@ Now that you've created a queue and learned how to send, receive, and delete mes + [Python](https://aws.amazon.com/python/) + [Ruby](https://aws.amazon.com/ruby/) + [Windows & \.NET](https://aws.amazon.com/net/) -+ Learn about keeping an eye on costs and resources in the [Monitoring, Logging, and Automating Amazon SQS Queues](sqs-monitoring-logging.md) section\. ++ Learn about keeping an eye on costs and resources in the [Monitoring, Logging, Automating, and Troubleshooting Amazon SQS Queues](sqs-monitoring-logging-automating-troubleshooting.md) section\. + Learn about protecting your data and access to it in the [Security](sqs-security.md) section\. \ No newline at end of file diff --git a/doc_source/sqs-how-it-works.md b/doc_source/sqs-how-it-works.md index 0146817..f7df17d 100644 --- a/doc_source/sqs-how-it-works.md +++ b/doc_source/sqs-how-it-works.md @@ -7,7 +7,7 @@ This section describes the types of Amazon SQS queues and their basic properties + [Amazon SQS Standard Queues](standard-queues.md) + [Amazon SQS FIFO \(First\-In\-First\-Out\) Queues](FIFO-queues.md) + [Amazon SQS Queue and Message Identifiers](sqs-queue-message-identifiers.md) -+ [Amazon SQS Message Attributes](sqs-message-attributes.md) ++ [Message Metadata](sqs-message-metadata.md) + [Resources Required to Process Amazon SQS Messages](sqs-resources-required-process-messages.md) + [Amazon SQS Cost Allocation Tags](sqs-queue-tags.md) + [Amazon SQS Short and Long Polling](sqs-short-and-long-polling.md) diff --git a/doc_source/logging-using-cloudtrail.md b/doc_source/sqs-logging-using-cloudtrail.md similarity index 99% rename from doc_source/logging-using-cloudtrail.md rename to doc_source/sqs-logging-using-cloudtrail.md index f089748..a355b1a 100644 --- a/doc_source/logging-using-cloudtrail.md +++ b/doc_source/sqs-logging-using-cloudtrail.md @@ -1,4 +1,4 @@ -# Logging Amazon SQS API Calls Using AWS CloudTrail +# Logging Amazon SQS API Calls Using AWS CloudTrail Amazon SQS is integrated with AWS CloudTrail, a service that provides a record of the Amazon SQS calls that a user, role, or AWS service makes\. CloudTrail captures API calls related to Amazon SQS queues as events, including calls from the Amazon SQS console and code calls from Amazon SQS APIs\. For more information about CloudTrail, see the [https://docs.aws.amazon.com/awscloudtrail/latest/userguide/](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)\. diff --git a/doc_source/sqs-message-attributes.md b/doc_source/sqs-message-attributes.md index c923fed..5c2b43f 100644 --- a/doc_source/sqs-message-attributes.md +++ b/doc_source/sqs-message-attributes.md @@ -2,6 +2,9 @@ Amazon SQS lets you include structured metadata \(such as timestamps, geospatial data, signatures, and identifiers\) with messages using *message attributes*\. Each message can have up to 10 attributes\. Message attributes are optional and separate from the message body \(however, they are sent alongside it\)\. Your consumer can use message attributes to handle a message in a particular way without having to process the message body first\. For information about sending messages with attributes using the AWS Management Console or the AWS SDK for Java, see [Tutorial: Sending a Message with Attributes to an Amazon SQS Queue](sqs-send-message-with-attributes.md)\. +**Note** +Don't confuse message attributes with *message system attributes*: Whereas you can use message attributes to attach custom metadata to Amazon SQS messages for your applications, you can use [message system attributes](sqs-message-system-attributes.md) to store metadata for other AWS services, such as AWS X\-Ray\. + **Topics** + [Message Attribute Components](#message-attribute-components) + [Message Attribute Data Types](#message-attribute-data-types) diff --git a/doc_source/sqs-message-metadata.md b/doc_source/sqs-message-metadata.md new file mode 100644 index 0000000..6618629 --- /dev/null +++ b/doc_source/sqs-message-metadata.md @@ -0,0 +1,7 @@ +# Message Metadata + +You can use message attributes to attach custom metadata to Amazon SQS messages for your applications\. You can use message system attributes to store metadata for other AWS services, such as AWS X\-Ray\. + +**Topics** ++ [Amazon SQS Message Attributes](sqs-message-attributes.md) ++ [Amazon SQS Message System Attributes](sqs-message-system-attributes.md) \ No newline at end of file diff --git a/doc_source/sqs-message-system-attributes.md b/doc_source/sqs-message-system-attributes.md new file mode 100644 index 0000000..5278fbd --- /dev/null +++ b/doc_source/sqs-message-system-attributes.md @@ -0,0 +1,7 @@ +# Amazon SQS Message System Attributes + +Whereas you can use [message attributes](sqs-message-attributes.md) to attach custom metadata to Amazon SQS messages for your applications, you can use *message system attributes* to store metadata for other AWS services, such as AWS X\-Ray\. For more information, see the `MessageSystemAttribute` request parameter of the `[SendMessage](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html)` and `[SendMessageBatch](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html)` API actions, the `AWSTraceHeader` attribute of the `[ReceiveMessage](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ReceiveMessage.html)` API action, and the `[MessageSystemAttributeValue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_MessageSystemAttributeValue.html)` data type in the *Amazon Simple Queue Service API Reference*\. + +Message system attributes are structured exactly like message attributes, with the following exceptions: ++ Currently, the only supported message system attribute is `AWSTraceHeader`\. Its type must be `String` and its value must be a correctly formatted AWS X\-Ray trace header string\. ++ The size of a message system attribute doesn't count towards the total size of a message\. \ No newline at end of file diff --git a/doc_source/sqs-monitoring-logging-automating-troubleshooting.md b/doc_source/sqs-monitoring-logging-automating-troubleshooting.md new file mode 100644 index 0000000..42d222f --- /dev/null +++ b/doc_source/sqs-monitoring-logging-automating-troubleshooting.md @@ -0,0 +1,9 @@ +# Monitoring, Logging, Automating, and Troubleshooting Amazon SQS Queues + +This section provides information about monitoring, logging, automating, and troubleshooting Amazon SQS queues\. + +**Topics** ++ [Monitoring Amazon SQS Queues Using CloudWatch](sqs-monitoring-using-cloudwatch.md) ++ [Logging Amazon SQS API Calls Using AWS CloudTrail](sqs-logging-using-cloudtrail.md) ++ [Automating Notifications from AWS Services to Amazon SQS using CloudWatch Events](sqs-automating-using-cloudwatch-events.md) ++ [Troubleshooting Amazon Simple Queue Service Queues Using AWS X\-Ray](sqs-troubleshooting-using-x-ray.md) \ No newline at end of file diff --git a/doc_source/sqs-monitoring-logging.md b/doc_source/sqs-monitoring-logging.md deleted file mode 100644 index 1c3dd7f..0000000 --- a/doc_source/sqs-monitoring-logging.md +++ /dev/null @@ -1,8 +0,0 @@ -# Monitoring, Logging, and Automating Amazon SQS Queues - -This section provides information about monitoring, logging, and automating Amazon SQS queues\. - -**Topics** -+ [Monitoring Amazon SQS Queues Using CloudWatch](sqs-monitoring-using-cloudwatch.md) -+ [Logging Amazon SQS API Calls Using AWS CloudTrail](logging-using-cloudtrail.md) -+ [Automating Notifications from AWS Services to Amazon SQS using CloudWatch Events](sqs-automating-using-cloudwatch-events.md) \ No newline at end of file diff --git a/doc_source/sqs-release-notes.md b/doc_source/sqs-release-notes.md index 42cc688..f631308 100644 --- a/doc_source/sqs-release-notes.md +++ b/doc_source/sqs-release-notes.md @@ -5,6 +5,7 @@ The following table lists Amazon SQS feature releases and improvements\. For cha | Date | Feature Release | | --- | --- | +| August 28, 2019 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-release-notes.html) | | August 22, 2019 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-release-notes.html) | | July 25, 2019 | Temporary queues help you save development time and deployment costs when using common message patterns such as request\-response\. You can use the [Temporary Queue Client](https://github.com/awslabs/amazon-sqs-java-temporary-queues-client) to create high\-throughput, cost\-effective, application\-managed temporary queues\. For more information, see [Amazon SQS Temporary Queues](sqs-temporary-queues.md)\. | | June 20, 2019 | Server\-side encryption \(SSE\) for Amazon SQS is available in the AWS GovCloud \(US\-East\) Region\. For more information about server\-side encryption and how to get started using it, see [Protecting Amazon SQS Data Using Server\-Side Encryption \(SSE\) and AWS KMS](sqs-server-side-encryption.md)\. | @@ -37,7 +38,7 @@ The following table lists Amazon SQS feature releases and improvements\. For cha | October 27, 2015 | The Amazon SQS Extended Client Library for Java lets you manage Amazon SQS messages with Amazon S3\. For more information, see [Managing Large Amazon SQS Messages Using Amazon S3](sqs-s3-messages.md) in the Amazon Simple Queue Service Developer Guide\. | | December 29, 2014 | Amazon SQS lets you use JMS \(Java Message Service\) with Amazon SQS queues\. For more information, see [Working with JMS and Amazon SQS](sqs-java-message-service-jms-client.md) in the *Amazon Simple Queue Service Developer Guide*\. | | December 8, 2014 | Amazon SQS lets you delete the messages in a queue using the `PurgeQueue` action\. For more information, see [PurgeQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_PurgeQueue.html) in the *Amazon Simple Queue Service API Reference*\. | -| July 16, 2014 | Amazon SQS lets you log actions using AWS CloudTrail\. For more information, see [Logging Amazon SQS API Calls Using AWS CloudTrail](logging-using-cloudtrail.md)\. | +| July 16, 2014 | Amazon SQS lets you log actions using AWS CloudTrail\. For more information, see [Logging Amazon SQS API Calls Using AWS CloudTrail](sqs-logging-using-cloudtrail.md)\. | | May 6, 2014 | Amazon SQS provides support for message attributes\. For more information, see [Amazon SQS Message Attributes](sqs-message-attributes.md)\. | | January 29, 2014 | Amazon SQS provides support for dead\-letter queues\. For more information, see [Amazon SQS Dead\-Letter Queues](sqs-dead-letter-queues.md)\. | | November 21, 2012 | You can subscribe an Amazon SQS queue to an Amazon SNS topic using the Amazon SQS console\. For more information, see [Tutorial: Subscribing an Amazon SQS Queue to an Amazon SNS Topic](sqs-subscribe-queue-sns-topic.md)\. | diff --git a/doc_source/sqs-troubleshooting-using-x-ray.md b/doc_source/sqs-troubleshooting-using-x-ray.md new file mode 100644 index 0000000..5113dce --- /dev/null +++ b/doc_source/sqs-troubleshooting-using-x-ray.md @@ -0,0 +1,11 @@ +# Troubleshooting Amazon Simple Queue Service Queues Using AWS X\-Ray + +AWS X\-Ray collects data about requests that your application serves and lets you view and filter data to identify potential issues and opportunities for optimization\. For any traced request to your application, you can see detailed information about the request, the response, and the calls that your application makes to downstream AWS resources, microservices, databases and HTTP web APIs\. + +To send AWS X\-Ray trace headers through Amazon SQS, you can do one of the following: ++ Use the `X-Amzn-Trace-Id` [tracing header](https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader)\. ++ Use the `AWSTraceHeader` [message system attribute](sqs-message-system-attributes.md)\. + +To collect data on errors and latency, you must instrument the [https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/index.html?com/amazonaws/services/sqs/AmazonSQSClient.html](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/index.html?com/amazonaws/services/sqs/AmazonSQSClient.html) client using the [AWS X\-Ray SDK](https://docs.aws.amazon.com/xray-sdk-for-java/latest/javadoc/index.html)\. + +You can use the AWS X\-Ray console to view the map of connections between Amazon SQS and other services that your application uses\. You can also use the console to view metrics such as average latency and failure rates\. For more information, see [Amazon SQS and AWS X\-Ray](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-sqs.html) in the *AWS X\-Ray Developer Guide*\. \ No newline at end of file