list_filters ¶

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

Lists all filters that belong to a given dataset group.

Parameters:

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

The ARN of the dataset group that contains the filters.
next_token (Optional[NextToken], default: None ) –

A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).
max_results (Optional[MaxResults], default: None ) –

The maximum number of filters to return.

Raises:

InvalidInputException –

Provide a valid value for the field or parameter.
InvalidNextTokenException –

The token is not valid.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_personalize/_services/personalize.py

def list_filters(
    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_filters_response.ListFiltersResponse":
    """<p>Lists all filters that belong to a given dataset group.</p>

    Args:
        dataset_group_arn: <p>The ARN of the dataset group that contains the filters.</p>
        next_token: <p>A token returned from the previous call to <code>ListFilters</code> for getting the next set of filters (if they exist).</p>
        max_results: <p>The maximum number of filters 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_filters_request.ListFiltersRequest]",
    ) -> OperationResponse[
        "capo_personalize.types.list_filters_response.ListFiltersResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.list_filters

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFilters")
    )
    input_: capo_personalize.types.list_filters_request.ListFiltersRequest = {}
    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