Skip to content

tag_resource

tag_resource(
    resource_arn: AmazonResourceName,
    tags: TagMap,
    *,
    config_overrides: Optional[TextractClientConfig] = None,
) -> TagResourceResponse

Adds one or more tags to the specified resource.

Parameters:

  • resource_arn (AmazonResourceName) –

    The Amazon Resource Name (ARN) that specifies the resource to be tagged.

  • tags (TagMap) –

    A set of tags (key-value pairs) that you want to assign to the resource.

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.

  • ServiceQuotaExceededException –

    Returned when a request cannot be completed as it would exceed a maximum service quota.

  • 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 tag_resource(
    self,
    resource_arn: "capo_textract.types.amazon_resource_name.AmazonResourceName",
    tags: "capo_textract.types.tag_map.TagMap",
    *,
    config_overrides: Optional[TextractClientConfig] = None,
) -> "capo_textract.types.tag_resource_response.TagResourceResponse":
    """<p>Adds one or more tags to the specified resource.</p>

    Args:
        resource_arn: <p>The Amazon Resource Name (ARN) that specifies the resource to be tagged.</p>
        tags: <p>A set of tags (key-value pairs) that you want to assign to the resource.</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.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.
    """

    def _handler(
        req: "OperationRequest[capo_textract.types.tag_resource_request.TagResourceRequest]",
    ) -> OperationResponse[
        "capo_textract.types.tag_resource_response.TagResourceResponse"
    ]:
        import capo_textract._operations.textract.tag_resource

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("TagResource")
    )
    input_: capo_textract.types.tag_resource_request.TagResourceRequest = {
        "resource_arn": resource_arn,
        "tags": tags,
    }

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