untag-resource¶

Description¶

Remove tags from a CloudFront resource.

Synopsis¶

  untag-resource
--resource <value>
--tag-keys <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--resource (string)

An ARN of a CloudFront resource.

--tag-keys (structure)

A complex type that contains zero or more Tag key elements.

Items -> (list)

A complex type that contains Tag key elements.

(string)

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .

Shorthand Syntax:

Items=string,string

JSON Syntax:

{
  "Items": ["string", ...]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To remove tags from a CloudFront distribution

The following example removes two tags from a CloudFront distribution by using command line arguments:

aws cloudfront untag-resource \
    --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \
    --tag-keys Items=Name,Project

Instead of using command line arguments, you can provide the tag keys in a JSON file, as shown in the following example:

aws cloudfront untag-resource \
    --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \
    --tag-keys file://tag-keys.json

The file tag-keys.json is a JSON document in the current folder that contains the following:

{
    "Items": [
        "Name",
        "Project"
    ]
}

When successful, this command has no output.

Output¶

None

Table of Contents

Feedback

User Guide