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

CreatePredefinedAttribute

Creates a new predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value.

For the predefined attributes per instance quota, see Amazon Connect quotas.

Use cases

Following are common uses cases for this API:

Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes.

Endpoints: See Amazon Connect endpoints and quotas.

Request Syntax


PUT /predefined-attributes/InstanceId HTTP/1.1
Content-type: application/json

{
   "AttributeConfiguration": { 
      "EnableValueValidationOnAssociation": boolean
   },
   "Name": "string",
   "Purposes": [ "string" ],
   "Values": { ... }
}

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.

AttributeConfiguration

Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.

Type: InputPredefinedAttributeConfiguration object

Required: No

Name

The name of the predefined attribute.

Type: String

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

Required: Yes

Purposes

Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

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

Required: No

Values

The values of the predefined attribute.

Type: PredefinedAttributeValues object

Note: This object is a Union. Only one member of this object can be specified or returned.

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.

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

Examples

Example

The following request and response example shows setting the proficiency on an attribute named Name1.


PUT https://connect.us-west-2.amazonaws.com/predefined-attributes/InstanceId HTTP/1.1
Content-type: application/json
{
    "Name": "Name1",
    "Values": {
        "StringList": [
            "value1"
        ]
    },
    "Purposes": [
        "proficiency"
    ],
    "Configuration": {
        "EnableValueValidationOnAssociation": true
    }
}

Response:
200