create_adapter async ¶

async def create_adapter(
    self,
    adapter_name: "capo_textract.types.adapter_name.AdapterName",
    feature_types: "capo_textract.types.feature_types.FeatureTypes",
    *,
    config_overrides: Optional[AsyncTextractClientConfig] = None,
    client_request_token: Optional[
        "capo_textract.types.client_request_token.ClientRequestToken"
    ] = None,
    description: Optional[
        "capo_textract.types.adapter_description.AdapterDescription"
    ] = None,
    auto_update: Optional["capo_textract.types.auto_update.AutoUpdate"] = None,
    tags: Optional["capo_textract.types.tag_map.TagMap"] = None,
) -> "capo_textract.types.create_adapter_response.CreateAdapterResponse":
    """<p>Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is <code>QUERIES</code>. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.</p>

    Args:
        adapter_name: <p>The name to be assigned to the adapter being created.</p>
        client_request_token: <p>Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</p>
        description: <p>The description to be assigned to the adapter being created.</p>
        feature_types: <p>The type of feature that the adapter is being trained on. Currrenly, supported feature types are: <code>QUERIES</code> </p>
        auto_update: <p>Controls whether or not the adapter should automatically update.</p>
        tags: <p>A list of tags to be added to the adapter.</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.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_textract.errors.idempotent_parameter_mismatch_exception.IdempotentParameterMismatchException: <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to 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.limit_exceeded_exception.LimitExceededException: <p>An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (<code>StartDocumentTextDetection</code>, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit. </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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Returned when a request cannot be completed as it would exceed a maximum service quota.</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.create_adapter_request.CreateAdapterRequest]",
    ) -> AsyncOperationResponse[
        "capo_textract.types.create_adapter_response.CreateAdapterResponse"
    ]:
        import capo_textract._operations.textract.create_adapter

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateAdapter")
    )
    input_: capo_textract.types.create_adapter_request.CreateAdapterRequest = {
        "adapter_name": adapter_name,
        "feature_types": feature_types,
    }
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if description is not None:
        input_["description"] = description
    if auto_update is not None:
        input_["auto_update"] = auto_update
    if tags is not None:
        input_["tags"] = tags

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