UpdateSecurityProfile
Updates 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
POST /security-profiles/InstanceId/SecurityProfileId HTTP/1.1
Content-type: application/json
{
"AllowedAccessControlHierarchyGroupId": "string",
"AllowedAccessControlTags": {
"string" : "string"
},
"Applications": [
{
"ApplicationPermissions": [ "string" ],
"Namespace": "string"
}
],
"Description": "string",
"HierarchyRestrictedResources": [ "string" ],
"Permissions": [ "string" ],
"TagRestrictedResources": [ "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
- SecurityProfileId
-
The identifier for the security profle.
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 the third-party application's metadata.
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
-
The permissions granted to a 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
- TagRestrictedResources
-
The list of resources that a security profile applies tag restrictions to in Amazon Connect.
Type: Array of strings
Array Members: Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
