Connect / Paginator / ListRoutingProfileQueues

ListRoutingProfileQueues

class Connect.Paginator.ListRoutingProfileQueues

paginator = client.get_paginator('list_routing_profile_queues')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_routing_profile_queues().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    RoutingProfileId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• RoutingProfileId (string) –

  [REQUIRED]

  The identifier of the routing profile.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'RoutingProfileQueueConfigSummaryList': [
        {
            'QueueId': 'string',
            'QueueArn': 'string',
            'QueueName': 'string',
            'Priority': 123,
            'Delay': 123,
            'Channel': 'VOICE'|'CHAT'|'TASK'
        },
    ]
}

Response Structure

• (dict) –

  • RoutingProfileQueueConfigSummaryList (list) –

    Information about the routing profiles.

    • (dict) –

      Contains summary information about a routing profile queue.

      • QueueId (string) –

        The identifier for the queue.

      • QueueArn (string) –

        The Amazon Resource Name (ARN) of the queue.

      • QueueName (string) –

        The name of the queue.

      • Priority (integer) –

        The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

      • Delay (integer) –

        The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

      • Channel (string) –

        The channels this queue supports.