Skip to content

list_adapters async

list_adapters(
    *,
    config_overrides: Optional[AsyncTextractClientConfig] = None,
    after_creation_time: Optional[DateTime] = None,
    before_creation_time: Optional[DateTime] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListAdaptersResponse

Lists all adapters that match the specified filtration criteria.

Parameters:

  • after_creation_time (Optional[DateTime], default: None ) –

    Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time.

  • before_creation_time (Optional[DateTime], default: None ) –

    Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time.

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

    The maximum number of results to return when listing adapters.

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

    Identifies the next page of results to return when listing adapters.

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.

  • 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 list_adapters(
    self,
    *,
    config_overrides: Optional[AsyncTextractClientConfig] = None,
    after_creation_time: Optional["capo_textract.types.date_time.DateTime"] = None,
    before_creation_time: Optional["capo_textract.types.date_time.DateTime"] = None,
    max_results: Optional["capo_textract.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_textract.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_textract.types.list_adapters_response.ListAdaptersResponse":
    """<p>Lists all adapters that match the specified filtration criteria.</p>

    Args:
        after_creation_time: <p>Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time.</p>
        before_creation_time: <p>Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time.</p>
        max_results: <p>The maximum number of results to return when listing adapters.</p>
        next_token: <p>Identifies the next page of results to return when listing adapters.</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.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.list_adapters_request.ListAdaptersRequest]",
    ) -> AsyncOperationResponse[
        "capo_textract.types.list_adapters_response.ListAdaptersResponse"
    ]:
        import capo_textract._operations.textract.list_adapters

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAdapters")
    )
    input_: capo_textract.types.list_adapters_request.ListAdaptersRequest = {}
    if after_creation_time is not None:
        input_["after_creation_time"] = after_creation_time
    if before_creation_time is not None:
        input_["before_creation_time"] = before_creation_time
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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