DataZone / Client / list_domains

list_domains#

DataZone.Client.list_domains(**kwargs)#

Lists Amazon DataZone domains.

Request Syntax

response = client.list_domains(
    maxResults=123,
    nextToken='string',
    status='CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED'
)

Parameters:

maxResults (integer) – The maximum number of domains to return in a single call to ListDomains. When the number of domains to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomains to list the next set of domains.
nextToken (string) – When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.
status (string) – The status of the data source.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'domainVersion': 'V1'|'V2',
            'id': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'managedAccountId': 'string',
            'name': 'string',
            'portalUrl': 'string',
            'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The results of the ListDomains action.
  - (dict) –
    
    A summary of a Amazon DataZone domain.
    - arn (string) –
      
      The ARN of the Amazon DataZone domain.
    - createdAt (datetime) –
      
      A timestamp of when a Amazon DataZone domain was created.
    - description (string) –
      
      A description of an Amazon DataZone domain.
    - domainVersion (string) –
      
      The domain version.
    - id (string) –
      
      The ID of the Amazon DataZone domain.
    - lastUpdatedAt (datetime) –
      
      A timestamp of when a Amazon DataZone domain was last updated.
    - managedAccountId (string) –
      
      The identifier of the Amazon Web Services account that manages the domain.
    - name (string) –
      
      A name of an Amazon DataZone domain.
    - portalUrl (string) –
      
      The data portal URL for the Amazon DataZone domain.
    - status (string) –
      
      The status of the Amazon DataZone domain.
- nextToken (string) –
  
  When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.

Exceptions

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ServiceQuotaExceededException
DataZone.Client.exceptions.ConflictException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException