UpdateAuthenticationProfileCommand

Suggest an Edit

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

Updates the selected authentication profile.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, UpdateAuthenticationProfileCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, UpdateAuthenticationProfileCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // UpdateAuthenticationProfileRequest
  AuthenticationProfileId: "STRING_VALUE", // required
  InstanceId: "STRING_VALUE", // required
  Name: "STRING_VALUE",
  Description: "STRING_VALUE",
  AllowedIps: [ // IpCidrList
    "STRING_VALUE",
  ],
  BlockedIps: [
    "STRING_VALUE",
  ],
  PeriodicSessionDuration: Number("int"),
};
const command = new UpdateAuthenticationProfileCommand(input);
const response = await client.send(command);
// {};

UpdateAuthenticationProfileCommand Input

See UpdateAuthenticationProfileCommandInput for more details

Parameter
Type
Description
AuthenticationProfileId
Required
string | undefined

A unique identifier for the authentication profile.

InstanceId
Required
string | undefined

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

AllowedIps
string[] | undefined

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.

BlockedIps
string[] | undefined

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.

Description
string | undefined

The description for the authentication profile.

Name
string | undefined

The name for the authentication profile.

PeriodicSessionDuration
number | undefined

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.

UpdateAuthenticationProfileCommand Output

See UpdateAuthenticationProfileCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InternalServiceException
server

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

InvalidParameterException
client

One or more of the specified parameters are not valid.

InvalidRequestException
client

The request is not valid.

ResourceNotFoundException
client

The specified resource was not found.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.