Amazon Connect Service

2024/07/01 - Amazon Connect Service - 3 new api methods

Changes  Authentication profiles are Amazon Connect resources (in gated preview) that allow you to configure authentication settings for users in your contact center. This release adds support for new ListAuthenticationProfiles, DescribeAuthenticationProfile and UpdateAuthenticationProfile APIs.

UpdateAuthenticationProfile (new) Link ¶

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.

Updates the selected authentication profile.

See also: AWS API Documentation

Request Syntax

client.update_authentication_profile(
    AuthenticationProfileId='string',
    InstanceId='string',
    Name='string',
    Description='string',
    AllowedIps=[
        'string',
    ],
    BlockedIps=[
        'string',
    ],
    PeriodicSessionDuration=123
)
type AuthenticationProfileId

string

param AuthenticationProfileId

[REQUIRED]

A unique identifier for the authentication profile.

type InstanceId

string

param InstanceId

[REQUIRED]

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

type Name

string

param Name

The name for the authentication profile.

type Description

string

param Description

The description for the authentication profile.

type AllowedIps

list

param AllowedIps

A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator Guide .

  • (string) --

type BlockedIps

list

param BlockedIps

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

  • (string) --

type PeriodicSessionDuration

integer

param PeriodicSessionDuration

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

returns

None

ListAuthenticationProfiles (new) Link ¶

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

client.list_authentication_profiles(
    InstanceId='string',
    MaxResults=123,
    NextToken='string'
)
type InstanceId

string

param InstanceId

[REQUIRED]

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

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

type NextToken

string

param NextToken

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.

rtype

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.

DescribeAuthenticationProfile (new) Link ¶

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.

Describes the target authentication profile.

See also: AWS API Documentation

Request Syntax

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

string

param AuthenticationProfileId

[REQUIRED]

A unique identifier for the authentication profile.

type InstanceId

string

param InstanceId

[REQUIRED]

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

rtype

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
    }
}

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 Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide .

        • (string) --

      • BlockedIps (list) --

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

        • (string) --

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

      • 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 Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Amazon Connect Administrator Guide .

      • MaxSessionDuration (integer) --

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