[ aws . servicecatalog ]
Lists the specified TagOptions or all TagOptions.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-tag-options
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: TagOptionDetails
list-tag-options
[--filters <value>]
[--page-size <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--filters
(structure)
The search filters. If no search filters are specified, the output includes all TagOptions.
Key -> (string)
The TagOption key.
Value -> (string)
The TagOption value.
Active -> (boolean)
The active state.
Shorthand Syntax:
Key=string,Value=string,Active=boolean
JSON Syntax:
{
"Key": "string",
"Value": "string",
"Active": true|false
}
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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.
The following list-tag-options
example lists all values for TagOptions
.
aws servicecatalog list-tag-options
Output:
{
"TagOptionDetails": [
{
"Value": "newvalue",
"Active": true,
"Id": "tag-iabcdn4fzjjms",
"Key": "1234"
},
{
"Value": "value1",
"Active": true,
"Id": "tag-e3abcdvmwvrzy",
"Key": "key"
}
]
}
TagOptionDetails -> (list)
Information about the TagOptions.
(structure)
Information about a TagOption.
Key -> (string)
The TagOption key.
Value -> (string)
The TagOption value.
Active -> (boolean)
The TagOption active state.
Id -> (string)
The TagOption identifier.
Owner -> (string)
The AWS account Id of the owner account that created the TagOption.
PageToken -> (string)
The page token for the next set of results. To retrieve the first set of results, use null.