Skip to content

list_adapter_versions

list_adapter_versions(
    *,
    config_overrides: Optional[TextractClientConfig] = None,
    adapter_id: Optional[AdapterId] = None,
    after_creation_time: Optional[DateTime] = None,
    before_creation_time: Optional[DateTime] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListAdapterVersionsResponse

List all version of an adapter that meet the specified filtration criteria.

Parameters:

  • adapter_id (Optional[AdapterId], default: None ) –

    A string containing a unique ID for the adapter to match for when listing adapter versions.

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

    Specifies the lower bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.

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

    Specifies the upper bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.

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

    The maximum number of results to return when listing adapter versions.

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

    Identifies the next page of results to return when listing adapter versions.

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/textract.py
def list_adapter_versions(
    self,
    *,
    config_overrides: Optional[TextractClientConfig] = None,
    adapter_id: Optional["capo_textract.types.adapter_id.AdapterId"] = 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_adapter_versions_response.ListAdapterVersionsResponse"
):
    """<p>List all version of an adapter that meet the specified filtration criteria.</p>

    Args:
        adapter_id: <p>A string containing a unique ID for the adapter to match for when listing adapter versions.</p>
        after_creation_time: <p>Specifies the lower bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.</p>
        before_creation_time: <p>Specifies the upper bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.</p>
        max_results: <p>The maximum number of results to return when listing adapter versions.</p>
        next_token: <p>Identifies the next page of results to return when listing adapter versions.</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.
    """

    def _handler(
        req: "OperationRequest[capo_textract.types.list_adapter_versions_request.ListAdapterVersionsRequest]",
    ) -> OperationResponse[
        "capo_textract.types.list_adapter_versions_response.ListAdapterVersionsResponse"
    ]:
        import capo_textract._operations.textract.list_adapter_versions

        output, http_response = (
            capo_textract._operations.textract.list_adapter_versions.list_adapter_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAdapterVersions")
    )
    input_: capo_textract.types.list_adapter_versions_request.ListAdapterVersionsRequest = {}
    if adapter_id is not None:
        input_["adapter_id"] = adapter_id
    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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output