SWF / Paginator / ListDomains

ListDomains

class SWF.Paginator.ListDomains

paginator = client.get_paginator('list_domains')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    registrationStatus='REGISTERED'|'DEPRECATED',
    reverseOrder=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• registrationStatus (string) –

  [REQUIRED]

  Specifies the registration status of the domains to list.

• reverseOrder (boolean) – When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

• 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:

dict

Returns:

Response Syntax

{
    'domainInfos': [
        {
            'name': 'string',
            'status': 'REGISTERED'|'DEPRECATED',
            'description': 'string',
            'arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains a paginated collection of DomainInfo structures.

  • domainInfos (list) –

    A list of DomainInfo structures.

    • (dict) –

      Contains general information about a domain.

      • name (string) –

        The name of the domain. This name is unique within the account.

      • status (string) –

        The status of the domain:

        • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.

        • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

      • description (string) –

        The description of the domain provided through RegisterDomain.

      • arn (string) –

        The ARN of the domain.

  • NextToken (string) –

    A token to resume pagination.