Struct aws_sdk_sqs::client::fluent_builders::PurgeQueue

pub struct PurgeQueue { /* private fields */ }

Fluent builder constructing a request to PurgeQueue.

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

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

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

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

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

Implementations

impl PurgeQueue

pub async fn customize(
    self
) -> Result<CustomizableOperation<PurgeQueue, AwsResponseRetryClassifier>, SdkError<PurgeQueueError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(self) -> Result<PurgeQueueOutput, SdkError<PurgeQueueError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn queue_url(self, input: impl Into<String>) -> Self

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

Queue URLs and names are case-sensitive.

pub fn set_queue_url(self, input: Option<String>) -> Self

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

Queue URLs and names are case-sensitive.

Trait Implementations

impl Clone for PurgeQueue

fn clone(&self) -> PurgeQueue

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PurgeQueue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.