Skip to content

list_profile_history_records

list_profile_history_records(
    domain_name: name,
    profile_id: uuid,
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    object_type_name: Optional[typeName] = None,
    next_token: Optional[token] = None,
    max_results: Optional[maxSize100] = None,
    action_type: Optional[ActionType] = None,
    performed_by: Optional[string1To255] = None,
) -> ListProfileHistoryRecordsResponse

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

Parameters:

  • domain_name (name) –

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

  • profile_id (uuid) –

    The identifier of the profile to be taken.

  • object_type_name (Optional[typeName], default: None ) –

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

  • next_token (Optional[token], default: None ) –

    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.

  • max_results (Optional[maxSize100], default: None ) –

    The maximum number of results to return per page.

  • action_type (Optional[ActionType], default: None ) –

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

  • performed_by (Optional[string1To255], default: None ) –

    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.

Raises:

Source code in docs_src/capo_customer_profiles/_services/customer_profiles.py
def list_profile_history_records(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    profile_id: "capo_customer_profiles.types.uuid.uuid",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    object_type_name: Optional[
        "capo_customer_profiles.types.type_name.typeName"
    ] = None,
    next_token: Optional["capo_customer_profiles.types.token.token"] = None,
    max_results: Optional[
        "capo_customer_profiles.types.max_size100.maxSize100"
    ] = None,
    action_type: Optional[
        "capo_customer_profiles.types.action_type.ActionType"
    ] = None,
    performed_by: Optional[
        "capo_customer_profiles.types.string1_to255.string1To255"
    ] = None,
) -> "capo_customer_profiles.types.list_profile_history_records_response.ListProfileHistoryRecordsResponse":
    """<p>Returns a list of history records for a specific profile, for a specific domain.</p>

    Args:
        domain_name: <p>The unique name of the domain for which to return profile history records.</p>
        profile_id: <p>The identifier of the profile to be taken.</p>
        object_type_name: <p>Applies a filter to include profile history records only with the specified <code>ObjectTypeName</code> value in the response.</p>
        next_token: <p>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.</p>
        max_results: <p>The maximum number of results to return per page.</p>
        action_type: <p>Applies a filter to include profile history records only with the specified <code>ActionType</code> value in the response.</p>
        performed_by: <p>Applies a filter to include profile history records only with the specified <code>PerformedBy</code> value in the response. The <code>PerformedBy</code> value can be the Amazon Resource Name (ARN) of the person or service principal who performed the action.</p>

    Raises:
        capo_customer_profiles.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_customer_profiles.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_customer_profiles.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred.</p>
        capo_customer_profiles.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_customer_profiles.errors.throttling_exception.ThrottlingException: <p>You exceeded the maximum number of requests.</p>
        capo_customer_profiles.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_customer_profiles.types.list_profile_history_records_request.ListProfileHistoryRecordsRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.list_profile_history_records_response.ListProfileHistoryRecordsResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.list_profile_history_records

        output, http_response = (
            capo_customer_profiles._operations.customer_profiles_20200815.list_profile_history_records.list_profile_history_records(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListProfileHistoryRecords")
    )
    input_: capo_customer_profiles.types.list_profile_history_records_request.ListProfileHistoryRecordsRequest = {
        "domain_name": domain_name,
        "profile_id": profile_id,
    }
    if object_type_name is not None:
        input_["object_type_name"] = object_type_name
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if action_type is not None:
        input_["action_type"] = action_type
    if performed_by is not None:
        input_["performed_by"] = performed_by

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output