Connect / Client / list_queues

list_queues#

Connect.Client.list_queues(**kwargs)#

Provides information about the queues for the specified Amazon Connect instance.

If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_queues(
    InstanceId='string',
    QueueTypes=[
        'STANDARD'|'AGENT',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • QueueTypes (list) –

    The type of queue.

    • (string) –

  • NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return per page. The default MaxResult size is 100.

Return type:

dict

Returns:

Response Syntax

{
    'QueueSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'QueueType': 'STANDARD'|'AGENT',
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • QueueSummaryList (list) –

      Information about the queues.

      • (dict) –

        Contains summary information about a queue.

        • Id (string) –

          The identifier of the queue.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the queue.

        • Name (string) –

          The name of the queue.

        • QueueType (string) –

          The type of queue.

        • LastModifiedTime (datetime) –

          The timestamp when this resource was last modified.

        • LastModifiedRegion (string) –

          The Amazon Web Services Region where this resource was last modified.

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

Exceptions