Class: AWS.SQS

Inherits:
AWS.Service show all
Identifier:
sqs
API Version:
2012-11-05
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using SQS

var sqs = new AWS.SQS();
sqs.addPermission(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SQS object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var sqs = new AWS.SQS({apiVersion: '2012-11-05'});

You can also set the API version globally in AWS.config.apiVersions using the sqs service identifier:

AWS.config.apiVersions = {
  sqs: '2012-11-05',
  // other service API versions
};

var sqs = new AWS.SQS();

Version:

  • 2012-11-05

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, defineService

Constructor Details

new AWS.SQS(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SQS object

var sqs = new AWS.SQS({apiVersion: '2012-11-05'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.SQS.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.SQS.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.SQS.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addPermission(params = {}, callback) ⇒ AWS.Request

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 Shared Queues in the Amazon SQS Developer Guide.

Note: AddPermission writes an Amazon-SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide. 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: &Attribute.1=this &Attribute.2=that

Service Reference:

Examples:

Calling the addPermission operation

var params = {
  AWSAccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Actions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Label: 'STRING_VALUE', /* required */
  QueueUrl: 'STRING_VALUE' /* required */
};
sqs.addPermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue to which permissions are added.

      Queue URLs are case-sensitive.

    • Label — (String)

      The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

    • AWSAccountIds — (Array<String>)

      The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.

    • Actions — (Array<String>)

      The action the client wants to allow for the specified principal. The following values are valid:

      • *

      • ChangeMessageVisibility

      • DeleteMessage

      • GetQueueAttributes

      • GetQueueUrl

      • ReceiveMessage

      • SendMessage

      For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.

      Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

changeMessageVisibility(params = {}, callback) ⇒ AWS.Request

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per 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.

For FIFO queues, there can be a maximum of 20,000 inflight messages per 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.

Service Reference:

Examples:

Calling the changeMessageVisibility operation

var params = {
  QueueUrl: 'STRING_VALUE', /* required */
  ReceiptHandle: 'STRING_VALUE', /* required */
  VisibilityTimeout: 0 /* required */
};
sqs.changeMessageVisibility(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue whose message's visibility is changed.

      Queue URLs are case-sensitive.

    • ReceiptHandle — (String)

      The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.

    • VisibilityTimeout — (Integer)

      The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

changeMessageVisibilityBatch(params = {}, callback) ⇒ AWS.Request

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.

Note: 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: &Attribute.1=this &Attribute.2=that

Service Reference:

Examples:

Calling the changeMessageVisibilityBatch operation

var params = {
  Entries: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      ReceiptHandle: 'STRING_VALUE', /* required */
      VisibilityTimeout: 0
    },
    /* more items */
  ],
  QueueUrl: 'STRING_VALUE' /* required */
};
sqs.changeMessageVisibilityBatch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue whose messages' visibility is changed.

      Queue URLs are case-sensitive.

    • Entries — (Array<map>)

      A list of receipt handles of the messages for which the visibility timeout must be changed.

      • Idrequired — (String)

        An identifier for this particular receipt handle used to communicate the result.

        Note: The Ids of a batch request need to be unique within a request
      • ReceiptHandlerequired — (String)

        A receipt handle.

      • VisibilityTimeout — (Integer)

        The new value (in seconds) for the message's visibility timeout.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Successful — (Array<map>)

        A list of ChangeMessageVisibilityBatchResultEntry items.

        • Idrequired — (String)

          Represents a message whose visibility timeout has been changed successfully.

      • Failed — (Array<map>)

        A list of BatchResultErrorEntry items.

        • Idrequired — (String)

          The Id of an entry in a batch request.

        • SenderFaultrequired — (Boolean)

          Specifies whether the error happened due to the sender's fault.

        • Coderequired — (String)

          An error code representing why the action failed on this entry.

        • Message — (String)

          A message explaining why the action failed on this entry.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createQueue(params = {}, callback) ⇒ AWS.Request

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

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

    Note: 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 SQS 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.

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.

Note: 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: &Attribute.1=this &Attribute.2=that

Service Reference:

Examples:

Calling the createQueue operation

var params = {
  QueueName: 'STRING_VALUE', /* required */
  Attributes: {
    '<QueueAttributeName>': 'STRING_VALUE',
    /* '<QueueAttributeName>': ... */
  }
};
sqs.createQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueName — (String)

      The name of the new queue. The following limits apply to this name:

      • A queue name can have up to 80 characters.

      • Valid values: alphanumeric characters, hyphens (-), and underscores (_).

      • A FIFO queue name must end with the .fifo suffix.

      Queue names are case-sensitive.

    • Attributes — (map<String>)

      A map of attributes with their corresponding values.

      The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

      • DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). The default is 0 (zero).

      • MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).

      • MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default is 345,600 (4 days).

      • Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.

      • ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). The default is 0 (zero).

      • RedrivePolicy - The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

        Note: The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead letter queue of a standard queue must also be a standard queue.
      • VisibilityTimeout - The visibility timeout for the queue. Valid values: An integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

      The following attributes apply only to server-side-encryption:

      • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/aws/sqs. For more examples, see KeyId in the AWS Key Management Service API Reference.

      • KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.

      The following attributes apply only to FIFO (first-in-first-out) queues:

      • FifoQueue - Designates a queue as FIFO. Valid values: true, false. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.

        For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

      • ContentBasedDeduplication - Enables content-based deduplication. Valid values: true, false. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

        • Every message must have a unique MessageDeduplicationId,

          • You may provide a MessageDeduplicationId explicitly.

          • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

          • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

          • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

        • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

        • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

      Any other valid special request parameters (such as the following) are ignored:

      • ApproximateNumberOfMessages

      • ApproximateNumberOfMessagesDelayed

      • ApproximateNumberOfMessagesNotVisible

      • CreatedTimestamp

      • LastModifiedTimestamp

      • QueueArn

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • QueueUrl — (String)

        The URL of the created Amazon SQS queue.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteMessage(params = {}, callback) ⇒ AWS.Request

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.

Note: The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, 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 storing 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 on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

Service Reference:

Examples:

Calling the deleteMessage operation

var params = {
  QueueUrl: 'STRING_VALUE', /* required */
  ReceiptHandle: 'STRING_VALUE' /* required */
};
sqs.deleteMessage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue from which messages are deleted.

      Queue URLs are case-sensitive.

    • ReceiptHandle — (String)

      The receipt handle associated with the message to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteMessageBatch(params = {}, callback) ⇒ AWS.Request

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.

Note: 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: &Attribute.1=this &Attribute.2=that

Service Reference:

Examples:

Calling the deleteMessageBatch operation

var params = {
  Entries: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      ReceiptHandle: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  QueueUrl: 'STRING_VALUE' /* required */
};
sqs.deleteMessageBatch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue from which messages are deleted.

      Queue URLs are case-sensitive.

    • Entries — (Array<map>)

      A list of receipt handles for the messages to be deleted.

      • Idrequired — (String)

        An identifier for this particular receipt handle. This is used to communicate the result.

        Note: The Ids of a batch request need to be unique within a request
      • ReceiptHandlerequired — (String)

        A receipt handle.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Successful — (Array<map>)

        A list of DeleteMessageBatchResultEntry items.

        • Idrequired — (String)

          Represents a successfully deleted message.

      • Failed — (Array<map>)

        A list of BatchResultErrorEntry items.

        • Idrequired — (String)

          The Id of an entry in a batch request.

        • SenderFaultrequired — (Boolean)

          Specifies whether the error happened due to the sender's fault.

        • Coderequired — (String)

          An error code representing why the action failed on this entry.

        • Message — (String)

          A message explaining why the action failed on this entry.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteQueue(params = {}, callback) ⇒ AWS.Request

Deletes the queue specified by the QueueUrl, even if the queue is empty. If the specified queue doesn't exist, Amazon SQS returns a successful response.

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.

Service Reference:

Examples:

Calling the deleteQueue operation

var params = {
  QueueUrl: 'STRING_VALUE' /* required */
};
sqs.deleteQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue to delete.

      Queue URLs are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getQueueAttributes(params = {}, callback) ⇒ AWS.Request

Gets attributes for the specified queue.

Note: To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
Note: 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: &Attribute.1=this &Attribute.2=that

Service Reference:

Examples:

Calling the getQueueAttributes operation

var params = {
  QueueUrl: 'STRING_VALUE', /* required */
  AttributeNames: [
    All | Policy | VisibilityTimeout | MaximumMessageSize | MessageRetentionPeriod | ApproximateNumberOfMessages | ApproximateNumberOfMessagesNotVisible | CreatedTimestamp | LastModifiedTimestamp | QueueArn | ApproximateNumberOfMessagesDelayed | DelaySeconds | ReceiveMessageWaitTimeSeconds | RedrivePolicy | FifoQueue | ContentBasedDeduplication | KmsMasterKeyId | KmsDataKeyReusePeriodSeconds,
    /* more items */
  ]
};
sqs.getQueueAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue whose attribute information is retrieved.

      Queue URLs are case-sensitive.

    • AttributeNames — (Array<String>)

      A list of attributes for which to retrieve information.

      Note: 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.

      The following attributes are supported:

      • All - Returns all values.

      • ApproximateNumberOfMessages - Returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

      • ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

      • ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and aren't deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

      • CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

      • DelaySeconds - Returns the default delay on the queue in seconds.

      • LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

      • MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

      • MessageRetentionPeriod - Returns the length of time, in seconds, for which Amazon SQS retains a message.

      • Policy - Returns the policy of the queue.

      • QueueArn - Returns the Amazon resource name (ARN) of the queue.

      • ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

      • RedrivePolicy - Returns the parameters for dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

      • VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

      The following attributes apply only to server-side-encryption:

      • KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

      • KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.

      The following attributes apply only to FIFO (first-in-first-out) queues:

      • FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

        Note: To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
      • ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attributes — (map<String>)

        A map of attributes to their respective values.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getQueueUrl(params = {}, callback) ⇒ AWS.Request

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 Shared Queues in the Amazon SQS Developer Guide.

Service Reference:

Examples:

Calling the getQueueUrl operation

var params = {
  QueueName: 'STRING_VALUE', /* required */
  QueueOwnerAWSAccountId: 'STRING_VALUE'
};
sqs.getQueueUrl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueName — (String)

      The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).

      Queue names are case-sensitive.

    • QueueOwnerAWSAccountId — (String)

      The AWS account ID of the account that created the queue.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • QueueUrl — (String)

        The URL of the queue.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDeadLetterSourceQueues(params = {}, callback) ⇒ AWS.Request

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 SQS Developer Guide.

Service Reference:

Examples:

Calling the listDeadLetterSourceQueues operation

var params = {
  QueueUrl: 'STRING_VALUE' /* required */
};
sqs.listDeadLetterSourceQueues(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of a dead letter queue.

      Queue URLs are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • queueUrls — (Array<String>)

        A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead letter queue.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listQueues(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listQueues operation

var params = {
  QueueNamePrefix: 'STRING_VALUE'
};
sqs.listQueues(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueNamePrefix — (String)

      A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

      Queue names are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • QueueUrls — (Array<String>)

        A list of queue URLs, up to 1,000 entries.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

purgeQueue(params = {}, callback) ⇒ AWS.Request

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

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

Service Reference:

Examples:

Calling the purgeQueue operation

var params = {
  QueueUrl: 'STRING_VALUE' /* required */
};
sqs.purgeQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the queue from which the PurgeQueue action deletes messages.

      Queue URLs are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

receiveMessage(params = {}, callback) ⇒ AWS.Request

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 SQS 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 SQS 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 SQS 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.

Note: 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.

Service Reference:

Examples:

Calling the receiveMessage operation

var params = {
  QueueUrl: 'STRING_VALUE', /* required */
  AttributeNames: [
    All | Policy | VisibilityTimeout | MaximumMessageSize | MessageRetentionPeriod | ApproximateNumberOfMessages | ApproximateNumberOfMessagesNotVisible | CreatedTimestamp | LastModifiedTimestamp | QueueArn | ApproximateNumberOfMessagesDelayed | DelaySeconds | ReceiveMessageWaitTimeSeconds | RedrivePolicy | FifoQueue | ContentBasedDeduplication | KmsMasterKeyId | KmsDataKeyReusePeriodSeconds,
    /* more items */
  ],
  MaxNumberOfMessages: 0,
  MessageAttributeNames: [
    'STRING_VALUE',
    /* more items */
  ],
  ReceiveRequestAttemptId: 'STRING_VALUE',
  VisibilityTimeout: 0,
  WaitTimeSeconds: 0
};
sqs.receiveMessage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue from which messages are received.

      Queue URLs are case-sensitive.

    • AttributeNames — (Array<String>)

      A list of attributes that need to be returned along with each message. These attributes include:

      • All - Returns all values.

      • ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).

      • ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.

      • SenderId

        • For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.

        • For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

      • SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).

      • MessageDeduplicationId - Returns the value provided by the sender that calls the SendMessage action.

      • MessageGroupId - Returns the value provided by the sender that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.

      • SequenceNumber - Returns the value provided by Amazon SQS.

      Any other valid special request parameters (such as the following) are ignored:

      • ApproximateNumberOfMessages

      • ApproximateNumberOfMessagesDelayed

      • ApproximateNumberOfMessagesNotVisible

      • CreatedTimestamp

      • ContentBasedDeduplication

      • DelaySeconds

      • FifoQueue

      • LastModifiedTimestamp

      • MaximumMessageSize

      • MessageRetentionPeriod

      • Policy

      • QueueArn,

      • ReceiveMessageWaitTimeSeconds

      • RedrivePolicy

      • VisibilityTimeout

    • MessageAttributeNames — (Array<String>)

      The name of the message attribute, where N is the index.

      • The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).

      • The name is case-sensitive and must be unique among all attribute names for the message.

      • The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).

      • The name must not start or end with a period (.), and it should not have periods in succession (..).

      • The name can be up to 256 characters long.

      When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.

    • MaxNumberOfMessages — (Integer)

      The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values are 1 to 10. Default is 1.

    • VisibilityTimeout — (Integer)

      The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

    • WaitTimeSeconds — (Integer)

      The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds.

    • ReceiveRequestAttemptId — (String)

      This parameter applies only to FIFO (first-in-first-out) queues.

      The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

      • You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.

      • When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.

      • If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.

      • You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).

      • During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

        If a caller of the ReceiveMessage action is still processing messages when the visibility timeout expires and messages become visible, another worker reading from the same queue can receive the same messages and therefore process duplicates. Also, if a reader whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.

        To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.

      • While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.

      • If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.

      The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[]^_{|}~).

      For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Messages — (Array<map>)

        A list of messages.

        • MessageId — (String)

          A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.

        • ReceiptHandle — (String)

          An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

        • MD5OfBody — (String)

          An MD5 digest of the non-URL-encoded message body string.

        • Body — (String)

          The message's contents (not URL-encoded).

        • Attributes — (map<String>)

          SenderId, SentTimestamp, ApproximateReceiveCount, and/or ApproximateFirstReceiveTimestamp. SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the epoch time in milliseconds.

        • MD5OfMessageAttributes — (String)

          An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

        • MessageAttributes — (map<map>)

          Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation in the Amazon SQS Developer Guide.

          • StringValue — (String)

            Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

          • BinaryValue — (Buffer, Typed Array, Blob, String)

            Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

          • StringListValues — (Array<String>)

            Not implemented. Reserved for future use.

          • BinaryListValues — (Array<Buffer, Typed Array, Blob, String>)

            Not implemented. Reserved for future use.

          • DataTyperequired — (String)

            Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

            You can also append custom labels. For more information, see Message Attribute Data Types and Validation in the Amazon SQS Developer Guide.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

removePermission(params = {}, callback) ⇒ AWS.Request

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

Service Reference:

Examples:

Calling the removePermission operation

var params = {
  Label: 'STRING_VALUE', /* required */
  QueueUrl: 'STRING_VALUE' /* required */
};
sqs.removePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue from which permissions are removed.

      Queue URLs are case-sensitive.

    • Label — (String)

      The identification of the permission to remove. This is the label added using the AddPermission action.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

sendMessage(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the sendMessage operation

var params = {
  MessageBody: 'STRING_VALUE', /* required */
  QueueUrl: 'STRING_VALUE', /* required */
  DelaySeconds: 0,
  MessageAttributes: {
    '<String>': {
      DataType: 'STRING_VALUE', /* required */
      BinaryListValues: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      BinaryValue: new Buffer('...') || 'STRING_VALUE',
      StringListValues: [
        'STRING_VALUE',
        /* more items */
      ],
      StringValue: 'STRING_VALUE'
    },
    /* '<String>': ... */
  },
  MessageDeduplicationId: 'STRING_VALUE',
  MessageGroupId: 'STRING_VALUE'
};
sqs.sendMessage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue to which a message is sent.

      Queue URLs are case-sensitive.

    • MessageBody — (String)

      The message to send. The maximum string size is 256 KB.

      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.

    • DelaySeconds — (Integer)

      The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.

      Note: When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
    • MessageAttributes — (map<map>)

      Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation in the Amazon SQS Developer Guide.

      • StringValue — (String)

        Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

      • BinaryValue — (Buffer, Typed Array, Blob, String)

        Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

      • StringListValues — (Array<String>)

        Not implemented. Reserved for future use.

      • BinaryListValues — (Array<Buffer, Typed Array, Blob, String>)

        Not implemented. Reserved for future use.

      • DataTyperequired — (String)

        Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

        You can also append custom labels. For more information, see Message Attribute Data Types and Validation in the Amazon SQS Developer Guide.

    • MessageDeduplicationId — (String)

      This parameter applies only to FIFO (first-in-first-out) queues.

      The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

      • Every message must have a unique MessageDeduplicationId,

        • You may provide a MessageDeduplicationId explicitly.

        • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

        • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

        • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

      • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

      • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

      Note: The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues). If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

      The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[]^_{|}~).

      For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.

    • MessageGroupId — (String)

      This parameter applies only to FIFO (first-in-first-out) queues.

      The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.

      • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

      • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

      The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[]^_{|}~).

      For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

      MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MD5OfMessageBody — (String)

        An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

      • MD5OfMessageAttributes — (String)

        An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

      • MessageId — (String)

        An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.

      • SequenceNumber — (String)

        This parameter applies only to FIFO (first-in-first-out) queues.

        The large, non-consecutive number that Amazon SQS assigns to each message.

        The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

sendMessageBatch(params = {}, callback) ⇒ AWS.Request

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.

Note: 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: &Attribute.1=this &Attribute.2=that

Service Reference:

Examples:

Calling the sendMessageBatch operation

var params = {
  Entries: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      MessageBody: 'STRING_VALUE', /* required */
      DelaySeconds: 0,
      MessageAttributes: {
        '<String>': {
          DataType: 'STRING_VALUE', /* required */
          BinaryListValues: [
            new Buffer('...') || 'STRING_VALUE',
            /* more items */
          ],
          BinaryValue: new Buffer('...') || 'STRING_VALUE',
          StringListValues: [
            'STRING_VALUE',
            /* more items */
          ],
          StringValue: 'STRING_VALUE'
        },
        /* '<String>': ... */
      },
      MessageDeduplicationId: 'STRING_VALUE',
      MessageGroupId: 'STRING_VALUE'
    },
    /* more items */
  ],
  QueueUrl: 'STRING_VALUE' /* required */
};
sqs.sendMessageBatch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue to which batched messages are sent.

      Queue URLs are case-sensitive.

    • Entries — (Array<map>)

      A list of SendMessageBatchRequestEntry items.

      • Idrequired — (String)

        An identifier for a message in this batch used to communicate the result.

        Note: The Ids of a batch request need to be unique within a request
      • MessageBodyrequired — (String)

        The body of the message.

      • DelaySeconds — (Integer)

        The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.

        Note: When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
      • MessageAttributes — (map<map>)

        Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation in the Amazon SQS Developer Guide.

        • StringValue — (String)

          Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

        • BinaryValue — (Buffer, Typed Array, Blob, String)

          Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

        • StringListValues — (Array<String>)

          Not implemented. Reserved for future use.

        • BinaryListValues — (Array<Buffer, Typed Array, Blob, String>)

          Not implemented. Reserved for future use.

        • DataTyperequired — (String)

          Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

          You can also append custom labels. For more information, see Message Attribute Data Types and Validation in the Amazon SQS Developer Guide.

      • MessageDeduplicationId — (String)

        This parameter applies only to FIFO (first-in-first-out) queues.

        The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

        • Every message must have a unique MessageDeduplicationId,

          • You may provide a MessageDeduplicationId explicitly.

          • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

          • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

          • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

        • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

        • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

        Note: The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues). If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

        The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[]^_{|}~).

        For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.

      • MessageGroupId — (String)

        This parameter applies only to FIFO (first-in-first-out) queues.

        The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.

        • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

        • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

        The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[]^_{|}~).

        For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

        MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Successful — (Array<map>)

        A list of SendMessageBatchResultEntry items.

        • Idrequired — (String)

          An identifier for the message in this batch.

        • MessageIdrequired — (String)

          An identifier for the message.

        • MD5OfMessageBodyrequired — (String)

          An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

        • MD5OfMessageAttributes — (String)

          An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

        • SequenceNumber — (String)

          This parameter applies only to FIFO (first-in-first-out) queues.

          The large, non-consecutive number that Amazon SQS assigns to each message.

          The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.

      • Failed — (Array<map>)

        A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.

        • Idrequired — (String)

          The Id of an entry in a batch request.

        • SenderFaultrequired — (Boolean)

          Specifies whether the error happened due to the sender's fault.

        • Coderequired — (String)

          An error code representing why the action failed on this entry.

        • Message — (String)

          A message explaining why the action failed on this entry.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

setQueueAttributes(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

Service Reference:

Examples:

Calling the setQueueAttributes operation

var params = {
  Attributes: { /* required */
    '<QueueAttributeName>': 'STRING_VALUE',
    /* '<QueueAttributeName>': ... */
  },
  QueueUrl: 'STRING_VALUE' /* required */
};
sqs.setQueueAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • QueueUrl — (String)

      The URL of the Amazon SQS queue whose attributes are set.

      Queue URLs are case-sensitive.

    • Attributes — (map<String>)

      A map of attributes to set.

      The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

      • DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). The default is 0 (zero).

      • MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).

      • MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). The default is 345,600 (4 days).

      • Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.

      • ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). The default is 0.

      • RedrivePolicy - The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

        Note: The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead letter queue of a standard queue must also be a standard queue.
      • VisibilityTimeout - The visibility timeout for the queue. Valid values: an integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

      The following attributes apply only to server-side-encryption:

      • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/aws/sqs. For more examples, see KeyId in the AWS Key Management Service API Reference.

      • KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.

      The following attribute applies only to FIFO (first-in-first-out) queues:

      • ContentBasedDeduplication - Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

        • Every message must have a unique MessageDeduplicationId,

          • You may provide a MessageDeduplicationId explicitly.

          • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

          • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

          • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

        • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

        • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

      Any other valid special request parameters (such as the following) are ignored:

      • ApproximateNumberOfMessages

      • ApproximateNumberOfMessagesDelayed

      • ApproximateNumberOfMessagesNotVisible

      • CreatedTimestamp

      • LastModifiedTimestamp

      • QueueArn

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.