GetProfileHistoryRecord - Amazon Connect

GetProfileHistoryRecord

Returns a history record for a specific profile, for a specific domain.

Request Syntax

GET /domains/DomainName/profiles/ProfileId/history-records/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain for which to return a profile history record.

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

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

Required: Yes

Id

The unique identifier of the profile history record to return.

Pattern: [a-f0-9]{32}

Required: Yes

ProfileId

The unique identifier of the profile for which to return a history record.

Pattern: [a-f0-9]{32}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ActionType": "string", "Content": "string", "CreatedAt": number, "Id": "string", "LastUpdatedAt": number, "ObjectTypeName": "string", "PerformedBy": "string", "ProfileObjectUniqueKey": "string" }

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.

ActionType

The action type of the profile history record.

Type: String

Valid Values: ADDED_PROFILE_KEY | DELETED_PROFILE_KEY | CREATED | UPDATED | INGESTED | DELETED_BY_CUSTOMER | EXPIRED | MERGED | DELETED_BY_MERGE

Content

A string containing the customer profile, profile object, or profile key content.

Type: String

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

CreatedAt

The timestamp of when the profile history record was created.

Type: Timestamp

Id

The unique identifier of the profile history record.

Type: String

Pattern: [a-f0-9]{32}

LastUpdatedAt

The timestamp of when the profile history record was last updated.

Type: Timestamp

ObjectTypeName

The name of the profile object type.

Type: String

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

Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$

PerformedBy

The Amazon Resource Name (ARN) of the person or service principal who performed the action.

Type: String

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

ProfileObjectUniqueKey

The unique identifier of the profile object generated by the service.

Type: String

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

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: