AWSSQS

@interface AWSSQS

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

  • The service configuration used to instantiate this service client.

    Warning

    Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

    Swift

    var configuration: UnsafeMutablePointer<Int32> { get }
  • Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
       AWSServiceManager.default().defaultServiceConfiguration = configuration
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
         AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                         identityPoolId:@"YourIdentityPoolId"];
         AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                              credentialsProvider:credentialsProvider];
         [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;
    
         return YES;
     }
    

    Then call the following to get the default service client:

    Swift

    let SQS = AWSSQS.default()
    

    Objective-C

    AWSSQS *SQS = [AWSSQS defaultSQS];
    

    Declaration

    Objective-C

    + (nonnull instancetype)defaultSQS;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

  • Creates a service client with the given service configuration and registers it for the key.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSSQS.register(with: configuration!, forKey: "USWest2SQS")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSSQS registerSQSWithConfiguration:configuration forKey:@"USWest2SQS"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let SQS = AWSSQS(forKey: "USWest2SQS")
    

    Objective-C

    AWSSQS *SQS = [AWSSQS SQSForKey:@"USWest2SQS"];
    

    Warning

    After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    + (void)registerSQSWithConfiguration:(id)configuration
                                  forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.

    key

    A string to identify the service client.

  • Retrieves the service client associated with the key. You need to call + registerSQSWithConfiguration:forKey: before invoking this method.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSSQS.register(with: configuration!, forKey: "USWest2SQS")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSSQS registerSQSWithConfiguration:configuration forKey:@"USWest2SQS"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let SQS = AWSSQS(forKey: "USWest2SQS")
    

    Objective-C

    AWSSQS *SQS = [AWSSQS SQSForKey:@"USWest2SQS"];
    

    Declaration

    Objective-C

    + (nonnull instancetype)SQSForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

  • Removes the service client associated with the key and release it.

    Warning

    Before calling this method, make sure no method is running on this client.

    Declaration

    Objective-C

    + (void)removeSQSForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • Adds a permission to a queue for a specific principal. This allows sharing access to the queue.

    When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.

    • AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon Simple Queue Service Developer Guide.

    • An Amazon SQS policy can have a maximum of 7 actions.

    • To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSAddPermissionRequest

    Declaration

    Objective-C

    - (id)addPermission:(nonnull AWSSQSAddPermissionRequest *)request;

    Swift

    func addPermission(_ request: AWSSQSAddPermissionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the AddPermission service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorOverLimit.

  • Adds a permission to a queue for a specific principal. This allows sharing access to the queue.

    When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.

    • AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon Simple Queue Service Developer Guide.

    • An Amazon SQS policy can have a maximum of 7 actions.

    • To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSAddPermissionRequest

    Declaration

    Objective-C

    - (void)addPermission:(nonnull AWSSQSAddPermissionRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func addPermission(_ request: AWSSQSAddPermissionRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the AddPermission service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorOverLimit.

  • Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

    For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to extend the visibility timeout beyond the maximum, your request is rejected.

    An Amazon SQS message has three basic states:

    1. Sent to a queue by a producer.

    2. Received from the queue by a consumer.

    3. Deleted from the queue.

    A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.

    Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.

    For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they’re processed. You can also increase the number of queues you use to process your messages. To request a limit increase, file a support request.

    For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.

    If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn’t automatically recalculate and increase the timeout to the maximum remaining time.

    Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn’t saved in memory for that message. If you don’t delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.

    See

    AWSSQSChangeMessageVisibilityRequest

    Declaration

    Objective-C

    - (id)changeMessageVisibility:
        (nonnull AWSSQSChangeMessageVisibilityRequest *)request;

    Swift

    func changeMessageVisibility(_ request: AWSSQSChangeMessageVisibilityRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ChangeMessageVisibility service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorMessageNotInflight, AWSSQSErrorReceiptHandleIsInvalid.

  • Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

    For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to extend the visibility timeout beyond the maximum, your request is rejected.

    An Amazon SQS message has three basic states:

    1. Sent to a queue by a producer.

    2. Received from the queue by a consumer.

    3. Deleted from the queue.

    A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.

    Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.

    For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they’re processed. You can also increase the number of queues you use to process your messages. To request a limit increase, file a support request.

    For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.

    If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn’t automatically recalculate and increase the timeout to the maximum remaining time.

    Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn’t saved in memory for that message. If you don’t delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.

    See

    AWSSQSChangeMessageVisibilityRequest

    Declaration

    Objective-C

    - (void)changeMessageVisibility:
                (nonnull AWSSQSChangeMessageVisibilityRequest *)request
                  completionHandler:
                      (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func changeMessageVisibility(_ request: AWSSQSChangeMessageVisibilityRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ChangeMessageVisibility service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorMessageNotInflight, AWSSQSErrorReceiptHandleIsInvalid.

  • Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.

    Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    See

    AWSSQSChangeMessageVisibilityBatchRequest

    See

    AWSSQSChangeMessageVisibilityBatchResult

    Declaration

    Objective-C

    - (id)changeMessageVisibilityBatch:
        (nonnull AWSSQSChangeMessageVisibilityBatchRequest *)request;

    Swift

    func changeMessageVisibilityBatch(_ request: AWSSQSChangeMessageVisibilityBatchRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ChangeMessageVisibilityBatch service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSChangeMessageVisibilityBatchResult. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorTooManyEntriesInBatchRequest, AWSSQSErrorEmptyBatchRequest, AWSSQSErrorBatchEntryIdsNotDistinct, AWSSQSErrorInvalidBatchEntryId.

  • Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.

    Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    See

    AWSSQSChangeMessageVisibilityBatchRequest

    See

    AWSSQSChangeMessageVisibilityBatchResult

    Declaration

    Objective-C

    - (void)changeMessageVisibilityBatch:
                (nonnull AWSSQSChangeMessageVisibilityBatchRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSSQSChangeMessageVisibilityBatchResult *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func changeMessageVisibilityBatch(_ request: AWSSQSChangeMessageVisibilityBatchRequest, completionHandler: ((AWSSQSChangeMessageVisibilityBatchResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ChangeMessageVisibilityBatch service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorTooManyEntriesInBatchRequest, AWSSQSErrorEmptyBatchRequest, AWSSQSErrorBatchEntryIdsNotDistinct, AWSSQSErrorInvalidBatchEntryId.

  • Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:

    • If you don’t specify the FifoQueue attribute, Amazon SQS creates a standard queue.

      You can’t change the queue type after you create it and you can’t convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide.

    • If you don’t provide a value for an attribute, the queue is created with the default value for the attribute.

    • If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

    To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

    After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.

    To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:

    • If you provide the name of an existing queue along with the exact names and values of all the queue’s attributes, CreateQueue returns the queue URL for the existing queue.

    • If the queue name, attribute names, or attribute values don’t match an existing queue, CreateQueue returns an error.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSCreateQueueRequest

    See

    AWSSQSCreateQueueResult

    Declaration

    Objective-C

    - (id)createQueue:(nonnull AWSSQSCreateQueueRequest *)request;

    Swift

    func createQueue(_ request: AWSSQSCreateQueueRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateQueue service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSCreateQueueResult. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorQueueDeletedRecently, AWSSQSErrorQueueNameExists.

  • Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:

    • If you don’t specify the FifoQueue attribute, Amazon SQS creates a standard queue.

      You can’t change the queue type after you create it and you can’t convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide.

    • If you don’t provide a value for an attribute, the queue is created with the default value for the attribute.

    • If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

    To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

    After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.

    To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:

    • If you provide the name of an existing queue along with the exact names and values of all the queue’s attributes, CreateQueue returns the queue URL for the existing queue.

    • If the queue name, attribute names, or attribute values don’t match an existing queue, CreateQueue returns an error.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSCreateQueueRequest

    See

    AWSSQSCreateQueueResult

    Declaration

    Objective-C

    - (void)createQueue:(nonnull AWSSQSCreateQueueRequest *)request
        completionHandler:(void (^_Nullable)(AWSSQSCreateQueueResult *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func createQueue(_ request: AWSSQSCreateQueueRequest, completionHandler: ((AWSSQSCreateQueueResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateQueue service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorQueueDeletedRecently, AWSSQSErrorQueueNameExists.

  • Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.

    The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be deleted).

    For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

    See

    AWSSQSDeleteMessageRequest

    Declaration

    Objective-C

    - (id)deleteMessage:(nonnull AWSSQSDeleteMessageRequest *)request;

    Swift

    func deleteMessage(_ request: AWSSQSDeleteMessageRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMessage service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorInvalidIdFormat, AWSSQSErrorReceiptHandleIsInvalid.

  • Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.

    The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be deleted).

    For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

    See

    AWSSQSDeleteMessageRequest

    Declaration

    Objective-C

    - (void)deleteMessage:(nonnull AWSSQSDeleteMessageRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteMessage(_ request: AWSSQSDeleteMessageRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMessage service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorInvalidIdFormat, AWSSQSErrorReceiptHandleIsInvalid.

  • Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response.

    Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    See

    AWSSQSDeleteMessageBatchRequest

    See

    AWSSQSDeleteMessageBatchResult

    Declaration

    Objective-C

    - (id)deleteMessageBatch:(nonnull AWSSQSDeleteMessageBatchRequest *)request;

    Swift

    func deleteMessageBatch(_ request: AWSSQSDeleteMessageBatchRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMessageBatch service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSDeleteMessageBatchResult. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorTooManyEntriesInBatchRequest, AWSSQSErrorEmptyBatchRequest, AWSSQSErrorBatchEntryIdsNotDistinct, AWSSQSErrorInvalidBatchEntryId.

  • Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response.

    Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    See

    AWSSQSDeleteMessageBatchRequest

    See

    AWSSQSDeleteMessageBatchResult

    Declaration

    Objective-C

    - (void)deleteMessageBatch:(nonnull AWSSQSDeleteMessageBatchRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSSQSDeleteMessageBatchResult *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func deleteMessageBatch(_ request: AWSSQSDeleteMessageBatchRequest, completionHandler: ((AWSSQSDeleteMessageBatchResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMessageBatch service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorTooManyEntriesInBatchRequest, AWSSQSErrorEmptyBatchRequest, AWSSQSErrorBatchEntryIdsNotDistinct, AWSSQSErrorInvalidBatchEntryId.

  • Deletes the queue specified by the QueueUrl, regardless of the queue’s contents.

    Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.

    When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist.

    When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSDeleteQueueRequest

    Declaration

    Objective-C

    - (id)deleteQueue:(nonnull AWSSQSDeleteQueueRequest *)request;

    Swift

    func deleteQueue(_ request: AWSSQSDeleteQueueRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteQueue service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Deletes the queue specified by the QueueUrl, regardless of the queue’s contents.

    Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.

    When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist.

    When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSDeleteQueueRequest

    Declaration

    Objective-C

    - (void)deleteQueue:(nonnull AWSSQSDeleteQueueRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteQueue(_ request: AWSSQSDeleteQueueRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteQueue service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful.

  • Gets attributes for the specified queue.

    To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

    See

    AWSSQSGetQueueAttributesRequest

    See

    AWSSQSGetQueueAttributesResult

    Declaration

    Objective-C

    - (id)getQueueAttributes:(nonnull AWSSQSGetQueueAttributesRequest *)request;

    Swift

    func getQueueAttributes(_ request: AWSSQSGetQueueAttributesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetQueueAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSGetQueueAttributesResult. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorInvalidAttributeName.

  • Gets attributes for the specified queue.

    To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

    See

    AWSSQSGetQueueAttributesRequest

    See

    AWSSQSGetQueueAttributesResult

    Declaration

    Objective-C

    - (void)getQueueAttributes:(nonnull AWSSQSGetQueueAttributesRequest *)request
             completionHandler:
                 (void (^_Nullable)(AWSSQSGetQueueAttributesResult *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func getQueueAttributes(_ request: AWSSQSGetQueueAttributesRequest, completionHandler: ((AWSSQSGetQueueAttributesResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetQueueAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorInvalidAttributeName.

  • Returns the URL of an existing Amazon SQS queue.

    To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue’s owner. The queue’s owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSGetQueueUrlRequest

    See

    AWSSQSGetQueueUrlResult

    Declaration

    Objective-C

    - (id)getQueueUrl:(nonnull AWSSQSGetQueueUrlRequest *)request;

    Swift

    func getQueueUrl(_ request: AWSSQSGetQueueUrlRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetQueueUrl service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSGetQueueUrlResult. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorQueueDoesNotExist.

  • Returns the URL of an existing Amazon SQS queue.

    To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue’s owner. The queue’s owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSGetQueueUrlRequest

    See

    AWSSQSGetQueueUrlResult

    Declaration

    Objective-C

    - (void)getQueueUrl:(nonnull AWSSQSGetQueueUrlRequest *)request
        completionHandler:(void (^_Nullable)(AWSSQSGetQueueUrlResult *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func getQueueUrl(_ request: AWSSQSGetQueueUrlRequest, completionHandler: ((AWSSQSGetQueueUrlResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetQueueUrl service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorQueueDoesNotExist.

  • Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

    For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSListDeadLetterSourceQueuesRequest

    See

    AWSSQSListDeadLetterSourceQueuesResult

    Declaration

    Objective-C

    - (id)listDeadLetterSourceQueues:
        (nonnull AWSSQSListDeadLetterSourceQueuesRequest *)request;

    Swift

    func listDeadLetterSourceQueues(_ request: AWSSQSListDeadLetterSourceQueuesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListDeadLetterSourceQueues service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSListDeadLetterSourceQueuesResult. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorQueueDoesNotExist.

  • Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

    For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSListDeadLetterSourceQueuesRequest

    See

    AWSSQSListDeadLetterSourceQueuesResult

    Declaration

    Objective-C

    - (void)listDeadLetterSourceQueues:
                (nonnull AWSSQSListDeadLetterSourceQueuesRequest *)request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSSQSListDeadLetterSourceQueuesResult *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listDeadLetterSourceQueues(_ request: AWSSQSListDeadLetterSourceQueuesRequest, completionHandler: ((AWSSQSListDeadLetterSourceQueuesResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListDeadLetterSourceQueues service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorQueueDoesNotExist.

  • List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSListQueueTagsRequest

    See

    AWSSQSListQueueTagsResult

    Declaration

    Objective-C

    - (id)listQueueTags:(nonnull AWSSQSListQueueTagsRequest *)request;

    Swift

    func listQueueTags(_ request: AWSSQSListQueueTagsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListQueueTags service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSListQueueTagsResult.

  • List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSListQueueTagsRequest

    See

    AWSSQSListQueueTagsResult

    Declaration

    Objective-C

    - (void)listQueueTags:(nonnull AWSSQSListQueueTagsRequest *)request
        completionHandler:(void (^_Nullable)(AWSSQSListQueueTagsResult *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func listQueueTags(_ request: AWSSQSListQueueTagsRequest, completionHandler: ((AWSSQSListQueueTagsResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListQueueTags service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

  • Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSListQueuesRequest

    See

    AWSSQSListQueuesResult

    Declaration

    Objective-C

    - (id)listQueues:(nonnull AWSSQSListQueuesRequest *)request;

    Swift

    func listQueues(_ request: AWSSQSListQueuesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListQueues service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSListQueuesResult.

  • Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSListQueuesRequest

    See

    AWSSQSListQueuesResult

    Declaration

    Objective-C

    - (void)listQueues:(nonnull AWSSQSListQueuesRequest *)request
        completionHandler:(void (^_Nullable)(AWSSQSListQueuesResult *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func listQueues(_ request: AWSSQSListQueuesRequest, completionHandler: ((AWSSQSListQueuesResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListQueues service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

  • Deletes the messages in a queue specified by the QueueURL parameter.

    When you use the PurgeQueue action, you can’t retrieve any messages deleted from a queue.

    The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue’s size.

    Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute.

    Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged.

    See

    AWSSQSPurgeQueueRequest

    Declaration

    Objective-C

    - (id)purgeQueue:(nonnull AWSSQSPurgeQueueRequest *)request;

    Swift

    func purgeQueue(_ request: AWSSQSPurgeQueueRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PurgeQueue service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorQueueDoesNotExist, AWSSQSErrorPurgeQueueInProgress.

  • Deletes the messages in a queue specified by the QueueURL parameter.

    When you use the PurgeQueue action, you can’t retrieve any messages deleted from a queue.

    The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue’s size.

    Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute.

    Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged.

    See

    AWSSQSPurgeQueueRequest

    Declaration

    Objective-C

    - (void)purgeQueue:(nonnull AWSSQSPurgeQueueRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func purgeQueue(_ request: AWSSQSPurgeQueueRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the PurgeQueue service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorQueueDoesNotExist, AWSSQSErrorPurgeQueueInProgress.

  • Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon Simple Queue Service Developer Guide.

    Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.

    For each message returned, the response includes the following:

    • The message body.

    • An MD5 digest of the message body. For information about MD5, see RFC1321.

    • The MessageId you received when you sent the message to the queue.

    • The receipt handle.

    • The message attributes.

    • An MD5 digest of the message attributes.

    The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide.

    You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don’t include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

    A message that isn’t deleted or a message whose visibility isn’t extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.

    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    See

    AWSSQSReceiveMessageRequest

    See

    AWSSQSReceiveMessageResult

    Declaration

    Objective-C

    - (id)receiveMessage:(nonnull AWSSQSReceiveMessageRequest *)request;

    Swift

    func receiveMessage(_ request: AWSSQSReceiveMessageRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ReceiveMessage service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSReceiveMessageResult. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorOverLimit.

  • Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon Simple Queue Service Developer Guide.

    Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.

    For each message returned, the response includes the following:

    • The message body.

    • An MD5 digest of the message body. For information about MD5, see RFC1321.

    • The MessageId you received when you sent the message to the queue.

    • The receipt handle.

    • The message attributes.

    • An MD5 digest of the message attributes.

    The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide.

    You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don’t include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

    A message that isn’t deleted or a message whose visibility isn’t extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.

    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    See

    AWSSQSReceiveMessageRequest

    See

    AWSSQSReceiveMessageResult

    Declaration

    Objective-C

    - (void)receiveMessage:(nonnull AWSSQSReceiveMessageRequest *)request
         completionHandler:(void (^_Nullable)(AWSSQSReceiveMessageResult *_Nullable,
                                              NSError *_Nullable))completionHandler;

    Swift

    func receiveMessage(_ request: AWSSQSReceiveMessageRequest, completionHandler: ((AWSSQSReceiveMessageResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ReceiveMessage service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorOverLimit.

  • Revokes any permissions in the queue policy that matches the specified Label parameter.

    • Only the owner of a queue can remove permissions from it.

    • Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    • To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    See

    AWSSQSRemovePermissionRequest

    Declaration

    Objective-C

    - (id)removePermission:(nonnull AWSSQSRemovePermissionRequest *)request;

    Swift

    func removePermission(_ request: AWSSQSRemovePermissionRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the RemovePermission service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Revokes any permissions in the queue policy that matches the specified Label parameter.

    • Only the owner of a queue can remove permissions from it.

    • Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    • To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    See

    AWSSQSRemovePermissionRequest

    Declaration

    Objective-C

    - (void)removePermission:(nonnull AWSSQSRemovePermissionRequest *)request
           completionHandler:
               (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func removePermission(_ request: AWSSQSRemovePermissionRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the RemovePermission service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful.

  • Delivers a message to the specified queue.

    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

    See

    AWSSQSSendMessageRequest

    See

    AWSSQSSendMessageResult

    Declaration

    Objective-C

    - (id)sendMessage:(nonnull AWSSQSSendMessageRequest *)request;

    Swift

    func sendMessage(_ request: AWSSQSSendMessageRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SendMessage service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSSendMessageResult. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorInvalidMessageContents, AWSSQSErrorUnsupportedOperation.

  • Delivers a message to the specified queue.

    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

    See

    AWSSQSSendMessageRequest

    See

    AWSSQSSendMessageResult

    Declaration

    Objective-C

    - (void)sendMessage:(nonnull AWSSQSSendMessageRequest *)request
        completionHandler:(void (^_Nullable)(AWSSQSSendMessageResult *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func sendMessage(_ request: AWSSQSSendMessageRequest, completionHandler: ((AWSSQSSendMessageResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the SendMessage service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorInvalidMessageContents, AWSSQSErrorUnsupportedOperation.

  • Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

    The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

    If you don’t specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    See

    AWSSQSSendMessageBatchRequest

    See

    AWSSQSSendMessageBatchResult

    Declaration

    Objective-C

    - (id)sendMessageBatch:(nonnull AWSSQSSendMessageBatchRequest *)request;

    Swift

    func sendMessageBatch(_ request: AWSSQSSendMessageBatchRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SendMessageBatch service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSQSSendMessageBatchResult. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorTooManyEntriesInBatchRequest, AWSSQSErrorEmptyBatchRequest, AWSSQSErrorBatchEntryIdsNotDistinct, AWSSQSErrorBatchRequestTooLong, AWSSQSErrorInvalidBatchEntryId, AWSSQSErrorUnsupportedOperation.

  • Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

    The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

    If you don’t specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    See

    AWSSQSSendMessageBatchRequest

    See

    AWSSQSSendMessageBatchResult

    Declaration

    Objective-C

    - (void)sendMessageBatch:(nonnull AWSSQSSendMessageBatchRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSSQSSendMessageBatchResult *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func sendMessageBatch(_ request: AWSSQSSendMessageBatchRequest, completionHandler: ((AWSSQSSendMessageBatchResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the SendMessageBatch service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorTooManyEntriesInBatchRequest, AWSSQSErrorEmptyBatchRequest, AWSSQSErrorBatchEntryIdsNotDistinct, AWSSQSErrorBatchRequestTooLong, AWSSQSErrorInvalidBatchEntryId, AWSSQSErrorUnsupportedOperation.

  • Sets the value of one or more queue attributes. When you change a queue’s attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

    • In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    • Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    • To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    See

    AWSSQSSetQueueAttributesRequest

    Declaration

    Objective-C

    - (id)setQueueAttributes:(nonnull AWSSQSSetQueueAttributesRequest *)request;

    Swift

    func setQueueAttributes(_ request: AWSSQSSetQueueAttributesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SetQueueAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorInvalidAttributeName.

  • Sets the value of one or more queue attributes. When you change a queue’s attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

    • In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    • Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    • To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    See

    AWSSQSSetQueueAttributesRequest

    Declaration

    Objective-C

    - (void)setQueueAttributes:(nonnull AWSSQSSetQueueAttributesRequest *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func setQueueAttributes(_ request: AWSSQSSetQueueAttributesRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the SetQueueAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSQSErrorDomain domain and the following error code: AWSSQSErrorInvalidAttributeName.

  • Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    When you use queue tags, keep the following guidelines in mind:

    • Adding more than 50 tags to a queue isn’t recommended.

    • Tags don’t have any semantic meaning. Amazon SQS interprets tags as character strings.

    • Tags are case-sensitive.

    • A new tag with a key identical to that of an existing tag overwrites the existing tag.

    For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSTagQueueRequest

    Declaration

    Objective-C

    - (id)tagQueue:(nonnull AWSSQSTagQueueRequest *)request;

    Swift

    func tagQueue(_ request: AWSSQSTagQueueRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the TagQueue service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    When you use queue tags, keep the following guidelines in mind:

    • Adding more than 50 tags to a queue isn’t recommended.

    • Tags don’t have any semantic meaning. Amazon SQS interprets tags as character strings.

    • Tags are case-sensitive.

    • A new tag with a key identical to that of an existing tag overwrites the existing tag.

    For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSTagQueueRequest

    Declaration

    Objective-C

    - (void)tagQueue:(nonnull AWSSQSTagQueueRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func tagQueue(_ request: AWSSQSTagQueueRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the TagQueue service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful.

  • Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSUntagQueueRequest

    Declaration

    Objective-C

    - (id)untagQueue:(nonnull AWSSQSUntagQueueRequest *)request;

    Swift

    func untagQueue(_ request: AWSSQSUntagQueueRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UntagQueue service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    Cross-account permissions don’t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    See

    AWSSQSUntagQueueRequest

    Declaration

    Objective-C

    - (void)untagQueue:(nonnull AWSSQSUntagQueueRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func untagQueue(_ request: AWSSQSUntagQueueRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UntagQueue service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful.