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

CreateSecurityProfile

Creates a security profile.

For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

Request Syntax


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

{
   "AllowedAccessControlHierarchyGroupId": "string",
   "AllowedAccessControlTags": { 
      "string" : "string" 
   },
   "Applications": [ 
      { 
         "ApplicationPermissions": [ "string" ],
         "Namespace": "string"
      }
   ],
   "Description": "string",
   "HierarchyRestrictedResources": [ "string" ],
   "Permissions": [ "string" ],
   "SecurityProfileName": "string",
   "TagRestrictedResources": [ "string" ],
   "Tags": { 
      "string" : "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.

AllowedAccessControlHierarchyGroupId

The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.

Type: String

Required: No

AllowedAccessControlTags

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

Type: String to string map

Map Entries: Maximum number of 4 items.

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

Value Length Constraints: Maximum length of 256.

Required: No

Applications

A list of third-party applications that the security profile will give access to.

Type: Array of Application objects

Array Members: Maximum number of 10 items.

Required: No

Description

The description of the security profile.

Type: String

Length Constraints: Maximum length of 250.

Required: No

HierarchyRestrictedResources

The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.

Type: Array of strings

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

Required: No

Permissions

Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.

Type: Array of strings

Array Members: Maximum number of 500 items.

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

Required: No

SecurityProfileName

The name of the security profile.

Type: String

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

Pattern: ^[ a-zA-Z0-9_@-]+$

Required: Yes

TagRestrictedResources

The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile | Queue | RoutingProfile

Type: Array of strings

Array Members: Maximum number of 10 items.

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

Required: No

Tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Type: String to string map

Map Entries: Maximum number of 50 items.

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

Key Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "SecurityProfileArn": "string",
   "SecurityProfileId": "string"
}

Response Elements

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

The following data is returned in JSON format by the service.

SecurityProfileArn

The Amazon Resource Name (ARN) for the security profile.

Type: String

SecurityProfileId

The identifier for the security profle.

Type: String

Errors

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

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

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

LimitExceededException

The allowed limit for the resource has been exceeded.

HTTP Status Code: 429

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429