sqs: Amazon Simple Queue Service

Description Usage Arguments Value Service syntax Operations Examples

View source: R/sqs_service.R

Description

Welcome to the Amazon Simple Queue Service API Reference.

Amazon Simple Queue Service (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 Simple Queue Service Developer Guide.

You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

Additional Information

Usage

1
sqs(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

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.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- sqs(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

add_permission Adds a permission to a queue for a specific principal
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_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 the messages in a queue 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 Delivers up to ten messages to the specified queue
set_queue_attributes Sets the value of one or more queue attributes
tag_queue Add cost allocation tags to the specified Amazon SQS queue
untag_queue Remove cost allocation tags from the specified Amazon SQS queue

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- sqs()
svc$add_permission(
  Foo = 123
)

## End(Not run)

paws.application.integration documentation built on Aug. 23, 2021, 9:20 a.m.