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

ListProfileHistoryRecords

Returns a list of history records for a specific profile, for a specific domain.

Request Syntax


POST /domains/DomainName/profiles/history-records?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json

{
   "ActionType": "string",
   "ObjectTypeName": "string",
   "PerformedBy": "string",
   "ProfileId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

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

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

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

Required: Yes

MaxResults

The maximum number of results to return per page.

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

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.

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

Request Body

The request accepts the following data in JSON format.

ActionType

Applies a filter to include profile history records only with the specified ActionType value in the response.

Type: String

Required: No

ObjectTypeName

Applies a filter to include profile history records only with the specified ObjectTypeName value in the response.

Type: String

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

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

Required: No

PerformedBy

Applies a filter to include profile history records only with the specified PerformedBy value in the response. The PerformedBy value can be 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.

Required: No

ProfileId

The identifier of the profile to be taken.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ProfileHistoryRecords": [ 
      { 
         "ActionType": "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.

NextToken

If there are additional results, this is the token for the next set of results.

Type: String

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

ProfileHistoryRecords

The list of profile history records.

Type: Array of ProfileHistoryRecord 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