Skip to content

describe_entity_recognizer

describe_entity_recognizer(
    entity_recognizer_arn: EntityRecognizerArn,
    *,
    config_overrides: Optional[ComprehendClientConfig] = None,
) -> DescribeEntityRecognizerResponse

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

Parameters:

  • entity_recognizer_arn (EntityRecognizerArn) –

    The Amazon Resource Name (ARN) that identifies the entity recognizer.

Raises:

Source code in docs_src/capo_comprehend/_services/comprehend.py
def describe_entity_recognizer(
    self,
    entity_recognizer_arn: "capo_comprehend.types.entity_recognizer_arn.EntityRecognizerArn",
    *,
    config_overrides: Optional[ComprehendClientConfig] = None,
) -> "capo_comprehend.types.describe_entity_recognizer_response.DescribeEntityRecognizerResponse":
    """<p>Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.</p>

    Args:
        entity_recognizer_arn: <p>The Amazon Resource Name (ARN) that identifies the entity recognizer.</p>

    Raises:
        capo_comprehend.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_comprehend.errors.invalid_request_exception.InvalidRequestException: <p>The request is invalid.</p>
        capo_comprehend.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
        capo_comprehend.errors.too_many_requests_exception.TooManyRequestsException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_comprehend.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_comprehend.types.describe_entity_recognizer_request.DescribeEntityRecognizerRequest]",
    ) -> OperationResponse[
        "capo_comprehend.types.describe_entity_recognizer_response.DescribeEntityRecognizerResponse"
    ]:
        import capo_comprehend._operations.comprehend_20171127.describe_entity_recognizer

        output, http_response = (
            capo_comprehend._operations.comprehend_20171127.describe_entity_recognizer.describe_entity_recognizer(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_comprehend.types.describe_entity_recognizer_response.DescribeEntityRecognizerResponse",
    ) -> dict[str, Any]:
        import capo_comprehend.types.describe_entity_recognizer_response

        return capo_comprehend.types.describe_entity_recognizer_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeEntityRecognizer", redact_output=_redact_output),
    )
    input_: capo_comprehend.types.describe_entity_recognizer_request.DescribeEntityRecognizerRequest = {
        "entity_recognizer_arn": entity_recognizer_arn
    }

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