CustomerProfiles / Client / list_profile_history_records

list_profile_history_records

CustomerProfiles.Client.list_profile_history_records(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_profile_history_records(
    DomainName='string',
    ProfileId='string',
    ObjectTypeName='string',
    NextToken='string',
    MaxResults=123,
    ActionType='ADDED_PROFILE_KEY'|'DELETED_PROFILE_KEY'|'CREATED'|'UPDATED'|'INGESTED'|'DELETED_BY_CUSTOMER'|'EXPIRED'|'MERGED'|'DELETED_BY_MERGE',
    PerformedBy='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

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

  • ProfileId (string) –

    [REQUIRED]

    The identifier of the profile to be taken.

  • ObjectTypeName (string) – Applies a filter to include profile history records only with the specified ObjectTypeName value in the response.

  • NextToken (string) – 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.

  • MaxResults (integer) – The maximum number of results to return per page.

  • ActionType (string) – Applies a filter to include profile history records only with the specified ActionType value in the response.

  • PerformedBy (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'ProfileHistoryRecords': [
        {
            'Id': 'string',
            'ObjectTypeName': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'ActionType': 'ADDED_PROFILE_KEY'|'DELETED_PROFILE_KEY'|'CREATED'|'UPDATED'|'INGESTED'|'DELETED_BY_CUSTOMER'|'EXPIRED'|'MERGED'|'DELETED_BY_MERGE',
            'ProfileObjectUniqueKey': 'string',
            'PerformedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ProfileHistoryRecords (list) –

      The list of profile history records.

      • (dict) –

        Contains profile history record metadata.

        • Id (string) –

          The unique identifier of the profile history record.

        • ObjectTypeName (string) –

          The name of the profile object type.

        • CreatedAt (datetime) –

          The timestamp of when the profile history record was created.

        • LastUpdatedAt (datetime) –

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

        • ActionType (string) –

          The action type of the profile history record.

        • ProfileObjectUniqueKey (string) –

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

        • PerformedBy (string) –

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

    • NextToken (string) –

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

Exceptions

  • CustomerProfiles.Client.exceptions.BadRequestException

  • CustomerProfiles.Client.exceptions.AccessDeniedException

  • CustomerProfiles.Client.exceptions.ResourceNotFoundException

  • CustomerProfiles.Client.exceptions.ThrottlingException

  • CustomerProfiles.Client.exceptions.InternalServerException