Skip to content

tag_resource

tag_resource(
    resource_arn: __string,
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    tags: Optional[Tags] = None,
) -> TagResourceResponse

Creates a new Tag resource to represent a tag.

Parameters:

  • resource_arn (__string) –

    The resource ARN for the tag.

  • tags (Optional[Tags], default: None ) –

    The collection of tags. Each tag element is associated with a given resource.

Raises:

  • BadRequestException –

    The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException –

    The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

  • NotFoundException –

    The resource specified in the request was not found. See the message field for more information.

  • TooManyRequestsException –

    A limit has been exceeded. See the accompanying error message for details.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_apigatewayv2/_services/api_gateway_v2.py
def tag_resource(
    self,
    resource_arn: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    tags: Optional["capo_apigatewayv2.types.tags.Tags"] = None,
) -> "capo_apigatewayv2.types.tag_resource_response.TagResourceResponse":
    """<p>Creates a new Tag resource to represent a tag.</p>

    Args:
        resource_arn: <p>The resource ARN for the tag.</p>
        tags: <p>The collection of tags. Each tag element is associated with a given resource.</p>

    Raises:
        capo_apigatewayv2.errors.bad_request_exception.BadRequestException: <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. See the message field for more information.</p>
        capo_apigatewayv2.errors.too_many_requests_exception.TooManyRequestsException: <p>A limit has been exceeded. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        output, http_response = (
            capo_apigatewayv2._operations.api_gateway_v2.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_apigatewayv2.types.tag_resource_request.TagResourceRequest = {
        "resource_arn": resource_arn
    }
    if tags is not None:
        input_["tags"] = tags

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