get_adapter_version `async` ¶

get_adapter_version(
    adapter_id: AdapterId,
    adapter_version: AdapterVersion,
    *,
    config_overrides: Optional[AsyncTextractClientConfig] = None,
) -> GetAdapterVersionResponse

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

Parameters:

adapter_id (AdapterId) –

A string specifying a unique ID for the adapter version you want to retrieve information for.
adapter_version (AdapterVersion) –

A string specifying the adapter version you want to retrieve information for.

Raises:

AccessDeniedException –

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
InternalServerError –

Amazon Textract experienced a service issue. Try your call again.
InvalidParameterException –

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.
ProvisionedThroughputExceededException –

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
ResourceNotFoundException –

Returned when an operation tried to access a nonexistent resource.
ThrottlingException –

Amazon Textract is temporarily unable to process the request. Try your call again.
ValidationException –

Indicates that a request was not valid. Check request for proper formatting.
UnknownServiceError –

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

Source code in docs_src/capo_textract/_services/async_textract.py

async def get_adapter_version(
    self,
    adapter_id: "capo_textract.types.adapter_id.AdapterId",
    adapter_version: "capo_textract.types.adapter_version.AdapterVersion",
    *,
    config_overrides: Optional[AsyncTextractClientConfig] = None,
) -> "capo_textract.types.get_adapter_version_response.GetAdapterVersionResponse":
    """<p>Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.</p>

    Args:
        adapter_id: <p>A string specifying a unique ID for the adapter version you want to retrieve information for.</p>
        adapter_version: <p>A string specifying the adapter version you want to retrieve information for.</p>

    Raises:
        capo_textract.errors.access_denied_exception.AccessDeniedException: <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.</p>
        capo_textract.errors.internal_server_error.InternalServerError: <p>Amazon Textract experienced a service issue. Try your call again.</p>
        capo_textract.errors.invalid_parameter_exception.InvalidParameterException: <p>An input parameter violated a constraint. For example, in synchronous operations, an <code>InvalidParameterException</code> exception occurs when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code> request parameter. Validate your parameter before calling the API operation again.</p>
        capo_textract.errors.provisioned_throughput_exceeded_exception.ProvisionedThroughputExceededException: <p>The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.</p>
        capo_textract.errors.resource_not_found_exception.ResourceNotFoundException: <p> Returned when an operation tried to access a nonexistent resource. </p>
        capo_textract.errors.throttling_exception.ThrottlingException: <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
        capo_textract.errors.validation_exception.ValidationException: <p> Indicates that a request was not valid. Check request for proper formatting. </p>
        capo_textract.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_textract.types.get_adapter_version_request.GetAdapterVersionRequest]",
    ) -> AsyncOperationResponse[
        "capo_textract.types.get_adapter_version_response.GetAdapterVersionResponse"
    ]:
        import capo_textract._operations.textract.get_adapter_version

        (
            output,
            http_response,
        ) = await capo_textract._operations.textract.get_adapter_version.async_get_adapter_version(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAdapterVersion")
    )
    input_: capo_textract.types.get_adapter_version_request.GetAdapterVersionRequest = {
        "adapter_id": adapter_id,
        "adapter_version": adapter_version,
    }

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

get_adapter_version async ¶

get_adapter_version `async` ¶