aws_sdk_sqs/client/
delete_message_batch.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DeleteMessageBatch`](crate::operation::delete_message_batch::builders::DeleteMessageBatchFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`queue_url(impl Into<String>)`](crate::operation::delete_message_batch::builders::DeleteMessageBatchFluentBuilder::queue_url) / [`set_queue_url(Option<String>)`](crate::operation::delete_message_batch::builders::DeleteMessageBatchFluentBuilder::set_queue_url):<br>required: **true**<br><p>The URL of the Amazon SQS queue from which messages are deleted.</p> <p>Queue URLs and names are case-sensitive.</p><br>
7    ///   - [`entries(DeleteMessageBatchRequestEntry)`](crate::operation::delete_message_batch::builders::DeleteMessageBatchFluentBuilder::entries) / [`set_entries(Option<Vec::<DeleteMessageBatchRequestEntry>>)`](crate::operation::delete_message_batch::builders::DeleteMessageBatchFluentBuilder::set_entries):<br>required: **true**<br><p>Lists the receipt handles for the messages to be deleted.</p><br>
8    /// - On success, responds with [`DeleteMessageBatchOutput`](crate::operation::delete_message_batch::DeleteMessageBatchOutput) with field(s):
9    ///   - [`successful(Vec::<DeleteMessageBatchResultEntry>)`](crate::operation::delete_message_batch::DeleteMessageBatchOutput::successful): <p>A list of <code> <code>DeleteMessageBatchResultEntry</code> </code> items.</p>
10    ///   - [`failed(Vec::<BatchResultErrorEntry>)`](crate::operation::delete_message_batch::DeleteMessageBatchOutput::failed): <p>A list of <code> <code>BatchResultErrorEntry</code> </code> items.</p>
11    /// - On failure, responds with [`SdkError<DeleteMessageBatchError>`](crate::operation::delete_message_batch::DeleteMessageBatchError)
12    pub fn delete_message_batch(&self) -> crate::operation::delete_message_batch::builders::DeleteMessageBatchFluentBuilder {
13        crate::operation::delete_message_batch::builders::DeleteMessageBatchFluentBuilder::new(self.handle.clone())
14    }
15}