ServiceCatalog / Client / list_tag_options

list_tag_options#

ServiceCatalog.Client.list_tag_options(**kwargs)#

Lists the specified TagOptions or all TagOptions.

Request Syntax

response = client.list_tag_options(
    Filters={
        'Key': 'string',
        'Value': 'string',
        'Active': True|False
    },
    PageSize=123,
    PageToken='string'
)

Parameters:

Filters (dict) –
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.
PageSize (integer) – The maximum number of items to return with this call.
PageToken (string) – The page token for the next set of results. To retrieve the first set of results, use null.

Return type:

dict

Returns:

Response Syntax

{
    'TagOptionDetails': [
        {
            'Key': 'string',
            'Value': 'string',
            'Active': True|False,
            'Id': 'string',
            'Owner': 'string'
        },
    ],
    'PageToken': 'string'
}

Response Structure

(dict) –
- TagOptionDetails (list) –
  
  Information about the TagOptions.
  - (dict) –
    
    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 Amazon Web Services 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.

Exceptions

ServiceCatalog.Client.exceptions.TagOptionNotMigratedException
ServiceCatalog.Client.exceptions.InvalidParametersException