[ aws . cloudtrail ]
Lists the tags for the trail in the current region.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-tags
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: ResourceTagList
list-tags
--resource-id-list <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--resource-id-list
(list)
Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
(string)
Syntax:
"string" "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
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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.
See ‘aws help’ for descriptions of global parameters.
To list the tags for a trail
The following list-tags
command lists the tags for Trail1
and Trail2
:
aws cloudtrail list-tags --resource-id-list arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail2
Output:
{
"ResourceTagList": [
{
"ResourceId": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1",
"TagsList": [
{
"Value": "Alice",
"Key": "name"
},
{
"Value": "us",
"Key": "location"
}
]
},
{
"ResourceId": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail2",
"TagsList": [
{
"Value": "Bob",
"Key": "name"
}
]
}
]
}
ResourceTagList -> (list)
A list of resource tags.
(structure)
A resource tag.
ResourceId -> (string)
Specifies the ARN of the resource.
TagsList -> (list)
A list of tags.
(structure)
A custom key-value pair associated with a resource such as a CloudTrail trail.
Key -> (string)
The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.
Value -> (string)
The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
NextToken -> (string)
Reserved for future use.