ControlCatalog / Client / list_domains

list_domains#

ControlCatalog.Client.list_domains(**kwargs)#

Returns a paginated list of domains from the Amazon Web Services Control Catalog.

Request Syntax

response = client.list_domains(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – The maximum number of results on a page or for an API request call.
NextToken (string) – The pagination token that’s used to fetch the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'Domains': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'LastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Domains (list) –
  
  The list of domains that the ListDomains API returns.
  - (dict) –
    
    A summary of metadata for a domain.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) that identifies the domain.
    - Name (string) –
      
      The name of the domain.
    - Description (string) –
      
      The description of the domain.
    - CreateTime (datetime) –
      
      The time when the domain was created.
    - LastUpdateTime (datetime) –
      
      The time when the domain was most recently updated.
- NextToken (string) –
  
  The pagination token that’s used to fetch the next set of results.

Exceptions

ControlCatalog.Client.exceptions.AccessDeniedException
ControlCatalog.Client.exceptions.InternalServerException
ControlCatalog.Client.exceptions.ValidationException
ControlCatalog.Client.exceptions.ThrottlingException