Struct aws_sdk_sqs::client::fluent_builders::ListQueues

pub struct ListQueues { /* private fields */ }

Fluent builder constructing a request to ListQueues.

Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

The listQueues methods supports pagination. Set parameter MaxResults in the request to specify the maximum number of results to be returned in the response. If you do not set MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to display, the response includes a value for NextToken. Use NextToken as a parameter in your next request to listQueues to receive the next page of results.

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Implementations

impl ListQueues

pub async fn customize(
    self
) -> Result<CustomizableOperation<ListQueues, AwsResponseRetryClassifier>, SdkError<ListQueuesError>>

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<ListQueuesOutput, SdkError<ListQueuesError>>

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 into_paginator(self) -> ListQueuesPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

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

Queue URLs and names are case-sensitive.

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

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

Queue URLs and names are case-sensitive.

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

Pagination token to request the next set of results.

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

Pagination token to request the next set of results.

pub fn max_results(self, input: i32) -> Self

Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

pub fn set_max_results(self, input: Option<i32>) -> Self

Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

Trait Implementations

impl Clone for ListQueues

fn clone(&self) -> ListQueues

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListQueues

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

Formats the value using the given formatter.