Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateAuthenticationProfile

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

Updates the selected authentication profile.

Request Syntax


POST /authentication-profiles/InstanceId/AuthenticationProfileId HTTP/1.1
Content-type: application/json

{
   "AllowedIps": [ "string" ],
   "BlockedIps": [ "string" ],
   "Description": "string",
   "Name": "string",
   "PeriodicSessionDuration": number
}

URI Request Parameters

The request uses the following URI parameters.

AuthenticationProfileId

A unique identifier for the authentication profile.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

InstanceId

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

AllowedIps

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

Type: Array of strings

Length Constraints: Minimum length of 2. Maximum length of 50.

Pattern: ^[A-Za-z0-9:/]*$

Required: No

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.

Type: Array of strings

Length Constraints: Minimum length of 2. Maximum length of 50.

Pattern: ^[A-Za-z0-9:/]*$

Required: No

Description

The description for the authentication profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 250.

Required: No

Name

The name for the authentication profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

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.

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 60.

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429