Connect / Client / list_authentication_profiles

list_authentication_profiles#

Connect.Client.list_authentication_profiles(**kwargs)#

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.

Provides summary information about the authentication profiles in a specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.list_authentication_profiles(
    InstanceId='string',
    MaxResults=123,
    NextToken='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.

  • MaxResults (integer) – The maximum number of results to return per page.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'AuthenticationProfileSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'IsDefault': True|False,
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

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

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException