Skip to content

list_event_trackers

list_event_trackers(
    *,
    config_overrides: Optional[PersonalizeClientConfig] = None,
    dataset_group_arn: Optional[Arn] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListEventTrackersResponse

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

Parameters:

  • dataset_group_arn (Optional[Arn], default: None ) –

    The ARN of a dataset group used to filter the response.

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

    A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).

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

    The maximum number of event trackers to return.

Raises:

Source code in docs_src/capo_personalize/_services/personalize.py
def list_event_trackers(
    self,
    *,
    config_overrides: Optional[PersonalizeClientConfig] = None,
    dataset_group_arn: Optional["capo_personalize.types.arn.Arn"] = None,
    next_token: Optional["capo_personalize.types.next_token.NextToken"] = None,
    max_results: Optional["capo_personalize.types.max_results.MaxResults"] = None,
) -> (
    "capo_personalize.types.list_event_trackers_response.ListEventTrackersResponse"
):
    """<p>Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>

    Args:
        dataset_group_arn: <p>The ARN of a dataset group used to filter the response.</p>
        next_token: <p>A token returned from the previous call to <code>ListEventTrackers</code> for getting the next set of event trackers (if they exist).</p>
        max_results: <p>The maximum number of event trackers to return.</p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The token is not valid.</p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_personalize.types.list_event_trackers_request.ListEventTrackersRequest]",
    ) -> OperationResponse[
        "capo_personalize.types.list_event_trackers_response.ListEventTrackersResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.list_event_trackers

        output, http_response = (
            capo_personalize._operations.amazon_personalize.list_event_trackers.list_event_trackers(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEventTrackers")
    )
    input_: capo_personalize.types.list_event_trackers_request.ListEventTrackersRequest = {}
    if dataset_group_arn is not None:
        input_["dataset_group_arn"] = dataset_group_arn
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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