authentication_profiles

Creates, updates, deletes, gets or lists an authentication_profiles resource.

Overview

Name	authentication_profiles
Type	Resource
Id	aws.connect.authentication_profiles

Fields

The following fields are returned by SELECT queries:

describe_authentication_profile

Name	Datatype	Description
allowed_ips	array	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.
arn	string	The Amazon Resource Name (ARN) for the authentication profile.
blocked_ips	array	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.
created_time	string (date-time)	The timestamp when the authentication profile was created.
description	string	The description for the authentication profile.
id	string	A unique identifier for the authentication profile.
is_default	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.
last_modified_region	string	The Amazon Web Services Region where the authentication profile was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when the authentication profile was last modified.
max_session_duration	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.
name	string	The name for the authentication profile.
periodic_session_duration	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.
session_inactivity_duration	integer	The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.
session_inactivity_handling_enabled	boolean	Determines if automatic logout on user inactivity is enabled.

list_authentication_profiles

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the authentication profile summary.
id	string	The unique identifier of the authentication profile.
is_default	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.
last_modified_region	string	The Amazon Web Services Region when the authentication profile summary was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when the authentication profile summary was last modified.
name	string	The name of the authentication profile summary.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_authentication_profile	select	authentication_profile_id, instance_id, region		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.
list_authentication_profiles	select	instance_id, region	maxResults, nextToken	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. Provides summary information about the authentication profiles in a specified Connect Customer instance.
update_authentication_profile	update	authentication_profile_id, instance_id, region		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. Updates the selected authentication profile.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
authentication_profile_id	string	A unique identifier for the authentication profile.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
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.

SELECT examples

describe_authentication_profile

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.

SELECT
allowed_ips,
arn,
blocked_ips,
created_time,
description,
id,
is_default,
last_modified_region,
last_modified_time,
max_session_duration,
name,
periodic_session_duration,
session_inactivity_duration,
session_inactivity_handling_enabled
FROM aws.connect.authentication_profiles
WHERE authentication_profile_id = '{{ authentication_profile_id }}' -- required
AND instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
;

list_authentication_profiles

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. Provides summary information about the authentication profiles in a specified Connect Customer instance.

SELECT
arn,
id,
is_default,
last_modified_region,
last_modified_time,
name
FROM aws.connect.authentication_profiles
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_authentication_profile

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. Updates the selected authentication profile.

UPDATE aws.connect.authentication_profiles
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
AllowedIps = '{{ AllowedIps }}',
BlockedIps = '{{ BlockedIps }}',
PeriodicSessionDuration = {{ PeriodicSessionDuration }},
SessionInactivityDuration = {{ SessionInactivityDuration }},
SessionInactivityHandlingEnabled = {{ SessionInactivityHandlingEnabled }}
WHERE 
authentication_profile_id = '{{ authentication_profile_id }}' --required
AND instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required;