Welcome to the Amazon SQS API Reference.
Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer Guide.
You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional information
Amazon SQS Developer Guide
Amazon Web Services General Reference
sqs(config = list(), credentials = list(), endpoint = NULL, region = NULL)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- sqs(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| add_permission | Adds a permission to a queue for a specific principal |
| cancel_message_move_task | Cancels a specified message movement task |
| change_message_visibility | Changes the visibility timeout of a specified message in a queue to a new value |
| change_message_visibility_batch | Changes the visibility timeout of multiple messages |
| create_queue | Creates a new standard or FIFO queue |
| delete_message | Deletes the specified message from the specified queue |
| delete_message_batch | Deletes up to ten messages from the specified queue |
| delete_queue | Deletes the queue specified by the QueueUrl, regardless of the queue's contents |
| get_queue_attributes | Gets attributes for the specified queue |
| get_queue_url | Returns the URL of an existing Amazon SQS queue |
| list_dead_letter_source_queues | Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue |
| list_message_move_tasks | Gets the most recent message movement tasks (up to 10) under a specific source queue |
| list_queues | Returns a list of your queues in the current region |
| list_queue_tags | List all cost allocation tags added to the specified Amazon SQS queue |
| purge_queue | Deletes available messages in a queue (including in-flight messages) specified by the QueueURL parameter |
| receive_message | Retrieves one or more messages (up to 10), from the specified queue |
| remove_permission | Revokes any permissions in the queue policy that matches the specified Label parameter |
| send_message | Delivers a message to the specified queue |
| send_message_batch | You can use SendMessageBatch to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all) |
| set_queue_attributes | Sets the value of one or more queue attributes |
| start_message_move_task | Starts an asynchronous task to move messages from a specified source queue to a specified destination queue |
| tag_queue | Add cost allocation tags to the specified Amazon SQS queue |
| untag_queue | Remove cost allocation tags from the specified Amazon SQS queue |
if (FALSE) {
svc <- sqs()
svc$add_permission(
Foo = 123
)
}
Run the code above in your browser using DataLab