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

SearchPredefinedAttributes

Searches predefined attributes that meet certain criteria. 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


POST /search-predefined-attributes HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "PredefinedAttributeSearchCriteria"
      ],
      "OrConditions": [ 
         "PredefinedAttributeSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Type: String

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

Required: Yes

MaxResults

The maximum number of results to return per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Type: String

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

Required: No

SearchCriteria

The search criteria to be used to return predefined attributes.

Type: PredefinedAttributeSearchCriteria object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "PredefinedAttributes": [ 
      { 
         "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.

ApproximateTotalCount

The approximate number of predefined attributes which matched your search query.

Type: Long

NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Type: String

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

PredefinedAttributes

Predefined attributes matched by the search criteria.

Type: Array of PredefinedAttribute objects

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.


POST https://connect.us-west-2.amazonaws.com/search-predefined-attributes HTTP/1.1
Content-type: application/json
{
    "InstanceId": "InstanceId",
    "MaxResults": 5,
    "SearchCriteria": {
        "StringCondition": {
            "ComparisonType": "EXACT",
            "FieldName": "purposes",
            "Value": "proficiency"
        }
    }
}

Response:
{
    "ApproximateTotalCount": 20,
    "NextToken": "nextToken,
    "PredefinedAttributes": [
        {
            "AttributeConfiguration": {
                "EnableValueValidationOnAssociation": false,
                "IsReadOnly": false
            },
            "LastModifiedRegion": null,
            "LastModifiedTime": null,
            "Name": "Name1",
            "Purposes": [
                "proficiency"
            ],
            "Values": {
                "StringList": [
                    "value1",
                    "value2"
                ]
            }
        },
        {
            "AttributeConfiguration": {
                "EnableValueValidationOnAssociation": false,
                "IsReadOnly": false
            },
            "LastModifiedRegion": null,
            "LastModifiedTime": null,
            "Name": "Name2",
            "Purposes": [
                "contact-attributes-search",
                "proficiency"
            ],
            "Values": {
                "StringList": [
                    "value1",
                    "value2"
                ]
            }
        }
    ]
}