describe_filter `async` ¶

describe_filter(
    filter_arn: Arn, *, config_overrides: Optional[AsyncPersonalizeClientConfig] = None
) -> DescribeFilterResponse

Describes a filter's properties.

Parameters:

filter_arn (Arn) –

The ARN of the filter to describe.

Raises:

InvalidInputException –

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

Could not find the specified resource.
UnknownServiceError –

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

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

async def describe_filter(
    self,
    filter_arn: "capo_personalize.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
) -> "capo_personalize.types.describe_filter_response.DescribeFilterResponse":
    """<p>Describes a filter's properties.</p>

    Args:
        filter_arn: <p>The ARN of the filter to describe.</p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.resource_not_found_exception.ResourceNotFoundException: <p>Could not find the specified resource.</p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_personalize.types.describe_filter_request.DescribeFilterRequest]",
    ) -> AsyncOperationResponse[
        "capo_personalize.types.describe_filter_response.DescribeFilterResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.describe_filter

        (
            output,
            http_response,
        ) = await capo_personalize._operations.amazon_personalize.describe_filter.async_describe_filter(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_personalize.types.describe_filter_response.DescribeFilterResponse",
    ) -> dict[str, Any]:
        import capo_personalize.types.describe_filter_response

        return capo_personalize.types.describe_filter_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeFilter", redact_output=_redact_output),
    )
    input_: capo_personalize.types.describe_filter_request.DescribeFilterRequest = {
        "filter_arn": filter_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_filter async ¶

describe_filter `async` ¶