Skip to content

tag_resource

tag_resource(
    resource: ResourceARN,
    tags: Tags,
    *,
    config_overrides: Optional[CloudFrontClientConfig] = None,
) -> None

Add tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.

Parameters:

  • resource (ResourceARN) –

    An ARN of a CloudFront resource.

  • tags (Tags) –

    A complex type that contains zero or more Tag elements.

Raises:

Source code in docs_src/capo_cloudfront/_services/cloud_front.py
def tag_resource(
    self,
    resource: "capo_cloudfront.types.resource_arn.ResourceARN",
    tags: "capo_cloudfront.types.tags.Tags",
    *,
    config_overrides: Optional[CloudFrontClientConfig] = None,
) -> None:
    """<p>Add tags to a CloudFront resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html">Tagging a distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>

    Args:
        resource: <p>An ARN of a CloudFront resource.</p>
        tags: <p>A complex type that contains zero or more <code>Tag</code> elements.</p>

    Raises:
        capo_cloudfront.errors.access_denied.AccessDenied: <p>Access denied.</p>
        capo_cloudfront.errors.invalid_argument.InvalidArgument: <p>An argument is invalid.</p>
        capo_cloudfront.errors.invalid_tagging.InvalidTagging: <p>The tagging specified is not valid.</p>
        capo_cloudfront.errors.no_such_resource.NoSuchResource: <p>A resource that was specified is not valid.</p>
        capo_cloudfront.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudfront.types.tag_resource_request.TagResourceRequest]",
    ) -> OperationResponse[None]:
        import capo_cloudfront._operations.cloudfront2020_05_31.tag_resource

        output, http_response = (
            capo_cloudfront._operations.cloudfront2020_05_31.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_cloudfront.types.tag_resource_request.TagResourceRequest = {
        "resource": resource,
        "tags": tags,
    }

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