ListProfileAttributeValues - Amazon Connect

ListProfileAttributeValues

Fetch the possible attribute values given the attribute name.

Request Syntax

GET /domains/DomainName/profile-attributes/AttributeName/values HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AttributeName

The attribute name.

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

Required: Yes

DomainName

The unique identifier of the domain.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 StatusCode Content-type: application/json { "AttributeName": "string", "DomainName": "string", "Items": [ { "Value": "string" } ] }

Response Elements

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

StatusCode

The status code for the response.

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

AttributeName

The attribute name.

Type: String

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

DomainName

The name of the domain.

Type: String

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

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

Items

The items returned as part of the response.

Type: Array of AttributeValueItem objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: