Connect / Client / describe_authentication_profile

describe_authentication_profile

Connect.Client.describe_authentication_profile(**kwargs)

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

Describes the target authentication profile.

See also: AWS API Documentation

Request Syntax

response = client.describe_authentication_profile(
    AuthenticationProfileId='string',
    InstanceId='string'
)

Parameters:

• AuthenticationProfileId (string) –

  [REQUIRED]

  A unique identifier for the authentication profile.

• InstanceId (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'AuthenticationProfile': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string',
        'AllowedIps': [
            'string',
        ],
        'BlockedIps': [
            'string',
        ],
        'IsDefault': True|False,
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'LastModifiedRegion': 'string',
        'PeriodicSessionDuration': 123,
        'MaxSessionDuration': 123,
        'SessionInactivityDuration': 123,
        'SessionInactivityHandlingEnabled': True|False
    }
}

Response Structure

• (dict) –

  • AuthenticationProfile (dict) –

    The authentication profile object being described.

    • Id (string) –

      A unique identifier for the authentication profile.

    • Arn (string) –

      The Amazon Resource Name (ARN) for the authentication profile.

    • Name (string) –

      The name for the authentication profile.

    • Description (string) –

      The description for the authentication profile.

    • AllowedIps (list) –

      A list of IP address range strings that are allowed to access the Connect Customer instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Connect Customer Administrator Guide.

      • (string) –

    • BlockedIps (list) –

      A list of IP address range strings that are blocked from accessing the Connect Customer instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Connect Customer Administrator Guide.

      • (string) –

    • IsDefault (boolean) –

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

    • CreatedTime (datetime) –

      The timestamp when the authentication profile was created.

    • LastModifiedTime (datetime) –

      The timestamp when the authentication profile was last modified.

    • LastModifiedRegion (string) –

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

    • PeriodicSessionDuration (integer) –

      The short lived session duration configuration for users logged in to Connect Customer, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Connect Customer Administrator Guide.

    • MaxSessionDuration (integer) –

      The long lived session duration for users logged in to Connect Customer, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Connect Customer Administrator Guide.

    • SessionInactivityDuration (integer) –

      The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.

    • SessionInactivityHandlingEnabled (boolean) –

      Determines if automatic logout on user inactivity is enabled.

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.InvalidParameterException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.InternalServiceException