WorkLink / Client / list_domains

list_domains#

WorkLink.Client.list_domains(**kwargs)#

Retrieves a list of domains associated to a specified fleet.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

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

Parameters:

FleetArn (string) –
[REQUIRED]

The ARN of the fleet.
NextToken (string) – The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
MaxResults (integer) – The maximum number of results to be included in the next page.

Return type:

dict

Returns:

Response Syntax

{
    'Domains': [
        {
            'DomainName': 'string',
            'DisplayName': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'DomainStatus': 'PENDING_VALIDATION'|'ASSOCIATING'|'ACTIVE'|'INACTIVE'|'DISASSOCIATING'|'DISASSOCIATED'|'FAILED_TO_ASSOCIATE'|'FAILED_TO_DISASSOCIATE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Domains (list) –
  
  Information about the domains.
  - (dict) –
    
    The summary of the domain.
    - DomainName (string) –
      
      The name of the domain.
    - DisplayName (string) –
      
      The name to display.
    - CreatedTime (datetime) –
      
      The time that the domain was created.
    - DomainStatus (string) –
      
      The status of the domain.
- NextToken (string) –
  
  The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Exceptions

WorkLink.Client.exceptions.UnauthorizedException
WorkLink.Client.exceptions.InternalServerErrorException
WorkLink.Client.exceptions.InvalidRequestException
WorkLink.Client.exceptions.ResourceNotFoundException
WorkLink.Client.exceptions.TooManyRequestsException