CodeArtifact / Client / list_domains

list_domains¶

CodeArtifact.Client.list_domains(**kwargs)¶

Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.

Request Syntax

response = client.list_domains(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return per page.
nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'domains': [
        {
            'name': 'string',
            'owner': 'string',
            'arn': 'string',
            'status': 'Active'|'Deleted',
            'createdTime': datetime(2015, 1, 1),
            'encryptionKey': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- domains (list) –
  
  The returned list of DomainSummary objects.
  - (dict) –
    
    Information about a domain, including its name, Amazon Resource Name (ARN), and status. The ListDomains operation returns a list of DomainSummary objects.
    - name (string) –
      
      The name of the domain.
    - owner (string) –
      
      The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
    - arn (string) –
      
      The ARN of the domain.
    - status (string) –
      
      A string that contains the status of the domain.
    - createdTime (datetime) –
      
      A timestamp that contains the date and time the domain was created.
    - encryptionKey (string) –
      
      The key used to encrypt the domain.
- nextToken (string) –
  
  The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Exceptions

CodeArtifact.Client.exceptions.AccessDeniedException
CodeArtifact.Client.exceptions.InternalServerException
CodeArtifact.Client.exceptions.ThrottlingException
CodeArtifact.Client.exceptions.ValidationException