Classes

The following classes are available globally.

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

    See more

    Declaration

    Objective-C

    @interface AWSSQSAddPermissionRequest

    Swift

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

    Required parameters: [Id, SenderFault, Code]

    See more

    Declaration

    Objective-C

    @interface AWSSQSBatchResultErrorEntry

    Swift

    class AWSSQSBatchResultErrorEntry
  • Required parameters: [QueueUrl, Entries]

    See more

    Declaration

    Objective-C

    @interface AWSSQSChangeMessageVisibilityBatchRequest

    Swift

    class AWSSQSChangeMessageVisibilityBatchRequest
  • Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.

    All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:

    &ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2

    &ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle

    &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45

    Required parameters: [Id, ReceiptHandle]

    See more

    Declaration

    Objective-C

    @interface AWSSQSChangeMessageVisibilityBatchRequestEntry

    Swift

    class AWSSQSChangeMessageVisibilityBatchRequestEntry
  • 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]

    See more

    Declaration

    Objective-C

    @interface AWSSQSChangeMessageVisibilityBatchResult

    Swift

    class AWSSQSChangeMessageVisibilityBatchResult
  • Encloses the Id of an entry in ChangeMessageVisibilityBatch.

    Required parameters: [Id]

    See more

    Declaration

    Objective-C

    @interface AWSSQSChangeMessageVisibilityBatchResultEntry

    Swift

    class AWSSQSChangeMessageVisibilityBatchResultEntry
  • Declaration

    Objective-C

    @interface AWSSQSChangeMessageVisibilityRequest

    Swift

    class AWSSQSChangeMessageVisibilityRequest
  • Required parameters: [QueueName]

    See more

    Declaration

    Objective-C

    @interface AWSSQSCreateQueueRequest

    Swift

    class AWSSQSCreateQueueRequest
  • Returns the QueueUrl attribute of the created queue.

    See more

    Declaration

    Objective-C

    @interface AWSSQSCreateQueueResult

    Swift

    class AWSSQSCreateQueueResult
  • Required parameters: [QueueUrl, Entries]

    See more

    Declaration

    Objective-C

    @interface AWSSQSDeleteMessageBatchRequest

    Swift

    class AWSSQSDeleteMessageBatchRequest
  • Encloses a receipt handle and an identifier for it.

    Required parameters: [Id, ReceiptHandle]

    See more

    Declaration

    Objective-C

    @interface AWSSQSDeleteMessageBatchRequestEntry

    Swift

    class AWSSQSDeleteMessageBatchRequestEntry
  • 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]

    See more

    Declaration

    Objective-C

    @interface AWSSQSDeleteMessageBatchResult

    Swift

    class AWSSQSDeleteMessageBatchResult
  • Encloses the Id of an entry in DeleteMessageBatch.

    Required parameters: [Id]

    See more

    Declaration

    Objective-C

    @interface AWSSQSDeleteMessageBatchResultEntry

    Swift

    class AWSSQSDeleteMessageBatchResultEntry
  • Required parameters: [QueueUrl, ReceiptHandle]

    See more

    Declaration

    Objective-C

    @interface AWSSQSDeleteMessageRequest

    Swift

    class AWSSQSDeleteMessageRequest
  • Required parameters: [QueueUrl]

    See more

    Declaration

    Objective-C

    @interface AWSSQSDeleteQueueRequest

    Swift

    class AWSSQSDeleteQueueRequest
  • Required parameters: [QueueUrl]

    See more

    Declaration

    Objective-C

    @interface AWSSQSGetQueueAttributesRequest

    Swift

    class AWSSQSGetQueueAttributesRequest
  • A list of returned queue attributes.

    See more

    Declaration

    Objective-C

    @interface AWSSQSGetQueueAttributesResult

    Swift

    class AWSSQSGetQueueAttributesResult
  • Required parameters: [QueueName]

    See more

    Declaration

    Objective-C

    @interface AWSSQSGetQueueUrlRequest

    Swift

    class AWSSQSGetQueueUrlRequest
  • For more information, see Interpreting Responses in the Amazon Simple Queue Service Developer Guide.

    See more

    Declaration

    Objective-C

    @interface AWSSQSGetQueueUrlResult

    Swift

    class AWSSQSGetQueueUrlResult
  • Required parameters: [QueueUrl]

    See more

    Declaration

    Objective-C

    @interface AWSSQSListDeadLetterSourceQueuesRequest

    Swift

    class AWSSQSListDeadLetterSourceQueuesRequest
  • A list of your dead letter source queues.

    Required parameters: [queueUrls]

    See more

    Declaration

    Objective-C

    @interface AWSSQSListDeadLetterSourceQueuesResult

    Swift

    class AWSSQSListDeadLetterSourceQueuesResult
  • Declaration

    Objective-C

    @interface AWSSQSListQueueTagsRequest

    Swift

    class AWSSQSListQueueTagsRequest
  • Declaration

    Objective-C

    @interface AWSSQSListQueueTagsResult

    Swift

    class AWSSQSListQueueTagsResult
  • Declaration

    Objective-C

    @interface AWSSQSListQueuesRequest

    Swift

    class AWSSQSListQueuesRequest
  • A list of your queues.

    See more

    Declaration

    Objective-C

    @interface AWSSQSListQueuesResult

    Swift

    class AWSSQSListQueuesResult
  • An Amazon SQS message.

    See more

    Declaration

    Objective-C

    @interface AWSSQSMessage

    Swift

    class AWSSQSMessage
  • 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 KB or 262,144 bytes).

    Required parameters: [DataType]

    See more

    Declaration

    Objective-C

    @interface AWSSQSMessageAttributeValue

    Swift

    class AWSSQSMessageAttributeValue
  • 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]

    See more

    Declaration

    Objective-C

    @interface AWSSQSMessageSystemAttributeValue

    Swift

    class AWSSQSMessageSystemAttributeValue
  • Required parameters: [QueueUrl]

    See more

    Declaration

    Objective-C

    @interface AWSSQSPurgeQueueRequest

    Swift

    class AWSSQSPurgeQueueRequest
  • Required parameters: [QueueUrl]

    See more

    Declaration

    Objective-C

    @interface AWSSQSReceiveMessageRequest

    Swift

    class AWSSQSReceiveMessageRequest
  • A list of received messages.

    See more

    Declaration

    Objective-C

    @interface AWSSQSReceiveMessageResult

    Swift

    class AWSSQSReceiveMessageResult
  • Required parameters: [QueueUrl, Label]

    See more

    Declaration

    Objective-C

    @interface AWSSQSRemovePermissionRequest

    Swift

    class AWSSQSRemovePermissionRequest
  • Required parameters: [QueueUrl, Entries]

    See more

    Declaration

    Objective-C

    @interface AWSSQSSendMessageBatchRequest

    Swift

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

    Required parameters: [Id, MessageBody]

    See more

    Declaration

    Objective-C

    @interface AWSSQSSendMessageBatchRequestEntry

    Swift

    class AWSSQSSendMessageBatchRequestEntry
  • 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]

    See more

    Declaration

    Objective-C

    @interface AWSSQSSendMessageBatchResult

    Swift

    class AWSSQSSendMessageBatchResult
  • Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch.

    Required parameters: [Id, MessageId, MD5OfMessageBody]

    See more

    Declaration

    Objective-C

    @interface AWSSQSSendMessageBatchResultEntry

    Swift

    class AWSSQSSendMessageBatchResultEntry
  • Required parameters: [QueueUrl, MessageBody]

    See more

    Declaration

    Objective-C

    @interface AWSSQSSendMessageRequest

    Swift

    class AWSSQSSendMessageRequest
  • The MD5OfMessageBody and MessageId elements.

    See more

    Declaration

    Objective-C

    @interface AWSSQSSendMessageResult

    Swift

    class AWSSQSSendMessageResult
  • Required parameters: [QueueUrl, Attributes]

    See more

    Declaration

    Objective-C

    @interface AWSSQSSetQueueAttributesRequest

    Swift

    class AWSSQSSetQueueAttributesRequest
  • Declaration

    Objective-C

    @interface AWSSQSTagQueueRequest

    Swift

    class AWSSQSTagQueueRequest
  • Declaration

    Objective-C

    @interface AWSSQSUntagQueueRequest

    Swift

    class AWSSQSUntagQueueRequest
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AWSSQSResources : NSObject
    
    + (instancetype)sharedInstance;
    
    - (NSDictionary *)JSONObject;
    
    @end

    Swift

    class AWSSQSResources : NSObject
  • 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.

    You can use AWS 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

    See more

    Declaration

    Objective-C

    @interface AWSSQS

    Swift

    class AWSSQS