Classes Reference


                    
                    
                    AWSSQSAddPermissionRequest

Required parameters: [QueueUrl, Label, AWSAccountIds, Actions]

Declaration

Objective-C

@interface AWSSQSAddPermissionRequest

Swift

class AWSSQSAddPermissionRequest


                    
                    
                    AWSSQSBatchResultErrorEntry

Gives a detailed description of the result of an action on each entry in the request.

Required parameters: [Id, SenderFault, Code]

Declaration

Objective-C

@interface AWSSQSBatchResultErrorEntry

Swift

class AWSSQSBatchResultErrorEntry


                    
                    
                    AWSSQSCancelMessageMoveTaskRequest

Declaration

Objective-C

@interface AWSSQSCancelMessageMoveTaskRequest

Swift

class AWSSQSCancelMessageMoveTaskRequest


                    
                    
                    AWSSQSCancelMessageMoveTaskResult

Declaration

Objective-C

@interface AWSSQSCancelMessageMoveTaskResult

Swift

class AWSSQSCancelMessageMoveTaskResult


                    
                    
                    AWSSQSChangeMessageVisibilityBatchRequest

Required parameters: [QueueUrl, Entries]

Declaration

Objective-C

@interface AWSSQSChangeMessageVisibilityBatchRequest

Swift

class AWSSQSChangeMessageVisibilityBatchRequest


                    
                    
                    AWSSQSChangeMessageVisibilityBatchRequestEntry

Encloses a receipt handle and an entry ID for each message in ChangeMessageVisibilityBatch.

Required parameters: [Id, ReceiptHandle]

Declaration

Objective-C

@interface AWSSQSChangeMessageVisibilityBatchRequestEntry

Swift

class AWSSQSChangeMessageVisibilityBatchRequestEntry


                    
                    
                    AWSSQSChangeMessageVisibilityBatchResult

For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

Required parameters: [Successful, Failed]

Declaration

Objective-C

@interface AWSSQSChangeMessageVisibilityBatchResult

Swift

class AWSSQSChangeMessageVisibilityBatchResult


                    
                    
                    AWSSQSChangeMessageVisibilityBatchResultEntry

Encloses the Id of an entry in ChangeMessageVisibilityBatch.

Required parameters: [Id]

Declaration

Objective-C

@interface AWSSQSChangeMessageVisibilityBatchResultEntry

Swift

class AWSSQSChangeMessageVisibilityBatchResultEntry


                    
                    
                    AWSSQSChangeMessageVisibilityRequest

Declaration

Objective-C

@interface AWSSQSChangeMessageVisibilityRequest

Swift

class AWSSQSChangeMessageVisibilityRequest


                    
                    
                    AWSSQSCreateQueueRequest

Required parameters: [QueueName]

Declaration

Objective-C

@interface AWSSQSCreateQueueRequest

Swift

class AWSSQSCreateQueueRequest


                    
                    
                    AWSSQSCreateQueueResult

Returns the QueueUrl attribute of the created queue.

Declaration

Objective-C

@interface AWSSQSCreateQueueResult

Swift

class AWSSQSCreateQueueResult


                    
                    
                    AWSSQSDeleteMessageBatchRequest

Required parameters: [QueueUrl, Entries]

Declaration

Objective-C

@interface AWSSQSDeleteMessageBatchRequest

Swift

class AWSSQSDeleteMessageBatchRequest


                    
                    
                    AWSSQSDeleteMessageBatchRequestEntry

Encloses a receipt handle and an identifier for it.

Required parameters: [Id, ReceiptHandle]

Declaration

Objective-C

@interface AWSSQSDeleteMessageBatchRequestEntry

Swift

class AWSSQSDeleteMessageBatchRequestEntry


                    
                    
                    AWSSQSDeleteMessageBatchResult

For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message can’t be deleted.

Required parameters: [Successful, Failed]

Declaration

Objective-C

@interface AWSSQSDeleteMessageBatchResult

Swift

class AWSSQSDeleteMessageBatchResult


                    
                    
                    AWSSQSDeleteMessageBatchResultEntry

Encloses the Id of an entry in DeleteMessageBatch.

Required parameters: [Id]

Declaration

Objective-C

@interface AWSSQSDeleteMessageBatchResultEntry

Swift

class AWSSQSDeleteMessageBatchResultEntry


                    
                    
                    AWSSQSDeleteMessageRequest

Required parameters: [QueueUrl, ReceiptHandle]

Declaration

Objective-C

@interface AWSSQSDeleteMessageRequest

Swift

class AWSSQSDeleteMessageRequest


                    
                    
                    AWSSQSDeleteQueueRequest

Required parameters: [QueueUrl]

Declaration

Objective-C

@interface AWSSQSDeleteQueueRequest

Swift

class AWSSQSDeleteQueueRequest


                    
                    
                    AWSSQSGetQueueAttributesRequest

Required parameters: [QueueUrl]

Declaration

Objective-C

@interface AWSSQSGetQueueAttributesRequest

Swift

class AWSSQSGetQueueAttributesRequest


                    
                    
                    AWSSQSGetQueueAttributesResult

A list of returned queue attributes.

Declaration

Objective-C

@interface AWSSQSGetQueueAttributesResult

Swift

class AWSSQSGetQueueAttributesResult


                    
                    
                    AWSSQSGetQueueUrlRequest

Required parameters: [QueueName]

Declaration

Objective-C

@interface AWSSQSGetQueueUrlRequest

Swift

class AWSSQSGetQueueUrlRequest


                    
                    
                    AWSSQSGetQueueUrlResult

For more information, see Interpreting Responses in the Amazon SQS Developer Guide.

Declaration

Objective-C

@interface AWSSQSGetQueueUrlResult

Swift

class AWSSQSGetQueueUrlResult


                    
                    
                    AWSSQSListDeadLetterSourceQueuesRequest

Required parameters: [QueueUrl]

Declaration

Objective-C

@interface AWSSQSListDeadLetterSourceQueuesRequest

Swift

class AWSSQSListDeadLetterSourceQueuesRequest


                    
                    
                    AWSSQSListDeadLetterSourceQueuesResult

A list of your dead letter source queues.

Required parameters: [queueUrls]

Declaration

Objective-C

@interface AWSSQSListDeadLetterSourceQueuesResult

Swift

class AWSSQSListDeadLetterSourceQueuesResult


                    
                    
                    AWSSQSListMessageMoveTasksRequest

Declaration

Objective-C

@interface AWSSQSListMessageMoveTasksRequest

Swift

class AWSSQSListMessageMoveTasksRequest


                    
                    
                    AWSSQSListMessageMoveTasksResult

Declaration

Objective-C

@interface AWSSQSListMessageMoveTasksResult

Swift

class AWSSQSListMessageMoveTasksResult


                    
                    
                    AWSSQSListMessageMoveTasksResultEntry

Contains the details of a message movement task.

Declaration

Objective-C

@interface AWSSQSListMessageMoveTasksResultEntry

Swift

class AWSSQSListMessageMoveTasksResultEntry


                    
                    
                    AWSSQSListQueueTagsRequest

Declaration

Objective-C

@interface AWSSQSListQueueTagsRequest

Swift

class AWSSQSListQueueTagsRequest


                    
                    
                    AWSSQSListQueueTagsResult

Declaration

Objective-C

@interface AWSSQSListQueueTagsResult

Swift

class AWSSQSListQueueTagsResult


                    
                    
                    AWSSQSListQueuesRequest

Declaration

Objective-C

@interface AWSSQSListQueuesRequest

Swift

class AWSSQSListQueuesRequest


                    
                    
                    AWSSQSListQueuesResult

A list of your queues.

Declaration

Objective-C

@interface AWSSQSListQueuesResult

Swift

class AWSSQSListQueuesResult


                    
                    
                    AWSSQSMessage

An Amazon SQS message.

Declaration

Objective-C

@interface AWSSQSMessage

Swift

class AWSSQSMessage


                    
                    
                    AWSSQSMessageAttributeValue

The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.

Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KiB or 262,144 bytes).

Required parameters: [DataType]

Declaration

Objective-C

@interface AWSSQSMessageAttributeValue

Swift

class AWSSQSMessageAttributeValue


                    
                    
                    AWSSQSMessageSystemAttributeValue

The user-specified message system attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.

Name, type, value and the message body must not be empty or null.

Required parameters: [DataType]

Declaration

Objective-C

@interface AWSSQSMessageSystemAttributeValue

Swift

class AWSSQSMessageSystemAttributeValue


                    
                    
                    AWSSQSPurgeQueueRequest

Required parameters: [QueueUrl]

Declaration

Objective-C

@interface AWSSQSPurgeQueueRequest

Swift

class AWSSQSPurgeQueueRequest


                    
                    
                    AWSSQSReceiveMessageRequest

Required parameters: [QueueUrl]

Declaration

Objective-C

@interface AWSSQSReceiveMessageRequest

Swift

class AWSSQSReceiveMessageRequest


                    
                    
                    AWSSQSReceiveMessageResult

A list of received messages.

Declaration

Objective-C

@interface AWSSQSReceiveMessageResult

Swift

class AWSSQSReceiveMessageResult


                    
                    
                    AWSSQSRemovePermissionRequest

Required parameters: [QueueUrl, Label]

Declaration

Objective-C

@interface AWSSQSRemovePermissionRequest

Swift

class AWSSQSRemovePermissionRequest


                    
                    
                    AWSSQSSendMessageBatchRequest

Required parameters: [QueueUrl, Entries]

Declaration

Objective-C

@interface AWSSQSSendMessageBatchRequest

Swift

class AWSSQSSendMessageBatchRequest


                    
                    
                    AWSSQSSendMessageBatchRequestEntry

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

Required parameters: [Id, MessageBody]

Declaration

Objective-C

@interface AWSSQSSendMessageBatchRequestEntry

Swift

class AWSSQSSendMessageBatchRequestEntry


                    
                    
                    AWSSQSSendMessageBatchResult

For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

Required parameters: [Successful, Failed]

Declaration

Objective-C

@interface AWSSQSSendMessageBatchResult

Swift

class AWSSQSSendMessageBatchResult


                    
                    
                    AWSSQSSendMessageBatchResultEntry

Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch.

Required parameters: [Id, MessageId, MD5OfMessageBody]

Declaration

Objective-C

@interface AWSSQSSendMessageBatchResultEntry

Swift

class AWSSQSSendMessageBatchResultEntry


                    
                    
                    AWSSQSSendMessageRequest

Required parameters: [QueueUrl, MessageBody]

Declaration

Objective-C

@interface AWSSQSSendMessageRequest

Swift

class AWSSQSSendMessageRequest


                    
                    
                    AWSSQSSendMessageResult

The MD5OfMessageBody and MessageId elements.

Declaration

Objective-C

@interface AWSSQSSendMessageResult

Swift

class AWSSQSSendMessageResult


                    
                    
                    AWSSQSSetQueueAttributesRequest

Required parameters: [QueueUrl, Attributes]

Declaration

Objective-C

@interface AWSSQSSetQueueAttributesRequest

Swift

class AWSSQSSetQueueAttributesRequest


                    
                    
                    AWSSQSStartMessageMoveTaskRequest

Declaration

Objective-C

@interface AWSSQSStartMessageMoveTaskRequest

Swift

class AWSSQSStartMessageMoveTaskRequest


                    
                    
                    AWSSQSStartMessageMoveTaskResult

Declaration

Objective-C

@interface AWSSQSStartMessageMoveTaskResult

Swift

class AWSSQSStartMessageMoveTaskResult


                    
                    
                    AWSSQSTagQueueRequest

Declaration

Objective-C

@interface AWSSQSTagQueueRequest

Swift

class AWSSQSTagQueueRequest


                    
                    
                    AWSSQSUntagQueueRequest

Declaration

Objective-C

@interface AWSSQSUntagQueueRequest

Swift

class AWSSQSUntagQueueRequest


                    
                    
                    AWSSQSResources

Undocumented

Declaration

Objective-C

@interface AWSSQSResources : NSObject

+ (instancetype)sharedInstance;

- (NSDictionary *)JSONObject;

@end

Swift

class AWSSQSResources : NSObject


                    
                    
                    AWSSQS

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 Product Page
Amazon SQS Developer Guide
Amazon SQS in the Command Line Interface
Amazon Web Services General Reference
- Regions and Endpoints

Declaration

Objective-C

@interface AWSSQS

Swift

class AWSSQS