deleteMessage method

Future<void> deleteMessage({ required String queueUrl, required String receiptHandle, })

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.

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.

May throw InvalidIdFormat. May throw ReceiptHandleIsInvalid.

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

Queue URLs and names are case-sensitive.

Parameter receiptHandle : The receipt handle associated with the message to delete.

Implementation

Future<void> deleteMessage({
  required String queueUrl,
  required String receiptHandle,
}) async {
  ArgumentError.checkNotNull(queueUrl, 'queueUrl');
  ArgumentError.checkNotNull(receiptHandle, 'receiptHandle');
  final $request = <String, dynamic>{};
  $request['QueueUrl'] = queueUrl;
  $request['ReceiptHandle'] = receiptHandle;
  await _protocol.send(
    $request,
    action: 'DeleteMessage',
    version: '2012-11-05',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DeleteMessageRequest'],
    shapes: shapes,
  );
}