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

DescribePredefinedAttribute

Describes a predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. You can use predefined attributes 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.
Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes.

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

Endpoints: See Amazon Connect endpoints and quotas.

Request Syntax


GET /predefined-attributes/InstanceId/Name HTTP/1.1

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

Name

The name of the predefined attribute.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "PredefinedAttribute": { 
      "AttributeConfiguration": { 
         "EnableValueValidationOnAssociation": boolean,
         "IsReadOnly": boolean
      },
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Purposes": [ "string" ],
      "Values": { ... }
   }
}

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.

PredefinedAttribute

Information about the predefined attribute.

Type: PredefinedAttribute object

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

Examples

Example

The following example shows a request and response.


GET https://connect.us-west-2.amazonaws.com/predefined-attributes/InstanceId/Name HTTP/1.1

Response:
{
    "PredefinedAttribute": {
        "AttributeConfiguration": {
            "EnableValueValidationOnAssociation": false,
            "IsReadOnly": false
        },
        "LastModifiedRegion": "us-west-2",
        "LastModifiedTime": 1.756932542054E9,
        "Name": "Custom",
        "Purposes": [
            "proficiency"
        ],
        "Values": {
            "StringList": [
                "value1",
                "value2"
            ]
        }
    }
}