Connect / Paginator / ListAuthenticationProfiles

ListAuthenticationProfiles#

class Connect.Paginator.ListAuthenticationProfiles#
paginator = client.get_paginator('list_authentication_profiles')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • 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

{
    'AuthenticationProfileSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'IsDefault': True|False,
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • AuthenticationProfileSummaryList (list) –

      A summary of a given authentication profile.

      • (dict) –

        This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

        A summary of a given authentication profile.

        • Id (string) –

          The unique identifier of the authentication profile.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the authentication profile summary.

        • Name (string) –

          The name of the authentication profile summary.

        • IsDefault (boolean) –

          Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.

        • LastModifiedTime (datetime) –

          The timestamp when the authentication profile summary was last modified.

        • LastModifiedRegion (string) –

          The Amazon Web Services Region when the authentication profile summary was last modified.