CodeArtifact / Paginator / ListDomains


class CodeArtifact.Paginator.ListDomains#
paginator = client.get_paginator('list_domains')

Creates an iterator that will paginate through responses from CodeArtifact.Client.list_domains().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



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) –

      A token to resume pagination.