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

AssociateSecurityProfiles

Associate security profiles with an Entity in an Amazon Connect instance.

Request Syntax


POST /associate-security-profiles/InstanceId HTTP/1.1
Content-type: application/json

{
   "EntityArn": "string",
   "EntityType": "string",
   "SecurityProfiles": [ 
      { 
         "Id": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

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.

EntityArn

Arn of a Q in Connect AI Agent.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

EntityType

Only supported type is AI_AGENT.

Type: String

Valid Values: USER | AI_AGENT

Required: Yes

SecurityProfiles

List of Security Profile Object.

Type: Array of SecurityProfileItem objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

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.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ConditionalOperationFailedException

Request processing failed because dependent condition failed.

HTTP Status Code: 409

InternalServiceException

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

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceConflictException

A resource already has that name.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404