Amazon Connect Customer Profiles

2025/09/30 - Amazon Connect Customer Profiles - 2 new api methods

Changes  This release introduces ListProfileHistoryRecords and GetProfileHistoryRecord APIs for comprehensive profile history tracking with complete audit trails of creation, updates, merges, deletions, and data ingestion events.

ListProfileHistoryRecords (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

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'
)
type DomainName:

string

param DomainName:

[REQUIRED]

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

type ProfileId:

string

param ProfileId:

[REQUIRED]

The identifier of the profile to be taken.

type ObjectTypeName:

string

param ObjectTypeName:

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

type NextToken:

string

param 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 MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

type ActionType:

string

param ActionType:

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

type PerformedBy:

string

param 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.

rtype:

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.

GetProfileHistoryRecord (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_profile_history_record(
    DomainName='string',
    ProfileId='string',
    Id='string'
)
type DomainName:

string

param DomainName:

[REQUIRED]

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

type ProfileId:

string

param ProfileId:

[REQUIRED]

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

type Id:

string

param Id:

[REQUIRED]

The unique identifier of the profile history record to return.

rtype:

dict

returns:

Response Syntax

{
    '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',
    'Content': 'string',
    'PerformedBy': 'string'
}

Response Structure

  • (dict) --

    • 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.

    • Content (string) --

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

    • PerformedBy (string) --

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