update_adapter ¶

def update_adapter(
    self,
    adapter_id: "capo_textract.types.adapter_id.AdapterId",
    *,
    config_overrides: Optional[TextractClientConfig] = None,
    description: Optional[
        "capo_textract.types.adapter_description.AdapterDescription"
    ] = None,
    adapter_name: Optional["capo_textract.types.adapter_name.AdapterName"] = None,
    auto_update: Optional["capo_textract.types.auto_update.AutoUpdate"] = None,
) -> "capo_textract.types.update_adapter_response.UpdateAdapterResponse":
    """<p>Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.</p>

    Args:
        adapter_id: <p>A string containing a unique ID for the adapter that will be updated.</p>
        description: <p>The new description to be applied to the adapter.</p>
        adapter_name: <p>The new name to be applied to the adapter.</p>
        auto_update: <p>The new auto-update status to be applied 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.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.update_adapter_request.UpdateAdapterRequest]",
    ) -> OperationResponse[
        "capo_textract.types.update_adapter_response.UpdateAdapterResponse"
    ]:
        import capo_textract._operations.textract.update_adapter

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateAdapter")
    )
    input_: capo_textract.types.update_adapter_request.UpdateAdapterRequest = {
        "adapter_id": adapter_id
    }
    if description is not None:
        input_["description"] = description
    if adapter_name is not None:
        input_["adapter_name"] = adapter_name
    if auto_update is not None:
        input_["auto_update"] = auto_update

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