Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sqs ]

delete-message-batch

Description

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

Warning

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-message-batch
--queue-url <value>
--entries <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--queue-url (string)

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

Queue URLs are case-sensitive.

--entries (list)

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

Shorthand Syntax:

Id=string,ReceiptHandle=string ...

JSON Syntax:

[
  {
    "Id": "string",
    "ReceiptHandle": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To delete multiple messages as a batch

This example deletes the specified messages.

Command:

aws sqs delete-message-batch --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --entries file://delete-message-batch.json

Input file (delete-message-batch.json):

[
  {
        "Id": "FirstMessage",
        "ReceiptHandle": "AQEB1mgl...Z4GuLw=="
  },
  {
    "Id": "SecondMessage",
        "ReceiptHandle": "AQEBLsYM...VQubAA=="
  }
]

Output:

{
  "Successful": [
    {
      "Id": "FirstMessage"
    },
    {
      "Id": "SecondMessage"
    }
  ]
}

Output

Successful -> (list)

A list of `` DeleteMessageBatchResultEntry `` items.

(structure)

Encloses the Id of an entry in `` delete-message-batch .``

Id -> (string)

Represents a successfully deleted message.

Failed -> (list)

A list of `` BatchResultErrorEntry `` items.

(structure)

This is used in the responses of batch API to give a detailed description of the result of an action on each entry in the request.

Id -> (string)

The Id of an entry in a batch request.

SenderFault -> (boolean)

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

Code -> (string)

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

Message -> (string)

A message explaining why the action failed on this entry.