ListTagOptions
Lists the specified TagOptions or all TagOptions.
Request Syntax
{
"Filters": {
"Active": boolean,
"Key": "string",
"Value": "string"
},
"PageSize": number,
"PageToken": "string"
}Request Parameters
The request accepts the following data in JSON format.
- Filters
-
The search filters. If no search filters are specified, the output includes all TagOptions.
Type: ListTagOptionsFilters object
Required: No
- PageSize
-
The maximum number of items to return with this call.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 20.
Required: No
- PageToken
-
The page token for the next set of results. To retrieve the first set of results, use null.
Type: String
Length Constraints: Maximum length of 2024.
Pattern:
[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*Required: No
Response Syntax
{
"PageToken": "string",
"TagOptionDetails": [
{
"Active": boolean,
"Id": "string",
"Key": "string",
"Owner": "string",
"Value": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- PageToken
-
The page token for the next set of results. To retrieve the first set of results, use null.
Type: String
Length Constraints: Maximum length of 2024.
Pattern:
[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]* - TagOptionDetails
-
Information about the TagOptions.
Type: Array of TagOptionDetail objects
Errors
- InvalidParametersException
-
One or more parameters provided to the operation are not valid.
HTTP Status Code: 400
- TagOptionNotMigratedException
-
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
