Connect / Paginator / ListUseCases

ListUseCases

class Connect.Paginator.ListUseCases

paginator = client.get_paginator('list_use_cases')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    IntegrationAssociationId='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.

• IntegrationAssociationId (string) –

  [REQUIRED]

  The identifier for the integration association.

• 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

{
    'UseCaseSummaryList': [
        {
            'UseCaseId': 'string',
            'UseCaseArn': 'string',
            'UseCaseType': 'RULES_EVALUATION'|'CONNECT_CAMPAIGNS'
        },
    ],

}

Response Structure

• (dict) –

  • UseCaseSummaryList (list) –

    The use cases.

    • (dict) –

      Contains the use case.

      • UseCaseId (string) –

        The identifier for the use case.

      • UseCaseArn (string) –

        The Amazon Resource Name (ARN) for the use case.

      • UseCaseType (string) –

        The type of use case to associate to the integration association. Each integration association can have only one of each use case type.