queues#

SQS.ServiceResource.queues#

A collection of Queue resources.A Queue Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()#

Creates an iterable of all Queue resources in the collection.

See also: AWS API Documentation

Request Syntax

queue_iterator = sqs.queues.all()

Return type:: list(sqs.Queue)
Returns:: A list of Queue resources

filter(**kwargs)#

Creates an iterable of all Queue resources in the collection filtered by kwargs passed to method. A Queue collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

queue_iterator = sqs.queues.filter(
    QueueNamePrefix='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

QueueNamePrefix (string) –
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.
NextToken (string) – Pagination token to request the next set of results.
MaxResults (integer) – 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.

Return type:

list(sqs.Queue)

Returns:

A list of Queue resources

limit(**kwargs)#

Creates an iterable up to a specified amount of Queue resources in the collection.

See also: AWS API Documentation

Request Syntax

queue_iterator = sqs.queues.limit(
    count=123
)

Parameters:: count (integer) – The limit to the number of resources in the iterable.
Return type:: list(sqs.Queue)
Returns:: A list of Queue resources

page_size(**kwargs)#

Creates an iterable of all Queue resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

queue_iterator = sqs.queues.page_size(
    count=123
)

Parameters:: count (integer) – The number of items returned by each service call
Return type:: list(sqs.Queue)
Returns:: A list of Queue resources