ServiceDiscovery / Paginator / ListNamespaces

ListNamespaces

class ServiceDiscovery.Paginator.ListNamespaces

paginator = client.get_paginator('list_namespaces')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ServiceDiscovery.Client.list_namespaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'TYPE'|'NAME'|'HTTP_NAME',
            'Values': [
                'string',
            ],
            'Condition': 'EQ'|'IN'|'BETWEEN'|'BEGINS_WITH'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  A complex type that contains specifications for the namespaces that you want to list.

  If you specify more than one filter, a namespace must match all filters to be returned by ListNamespaces.

  • (dict) –

    A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.

    • Name (string) – [REQUIRED]

      Specify the namespaces that you want to get using one of the following.

      • TYPE: Gets the namespaces of the specified type.

      • NAME: Gets the namespaces with the specified name.

      • HTTP_NAME: Gets the namespaces with the specified HTTP name.

    • Values (list) – [REQUIRED]

      Specify the values that are applicable to the value that you specify for Name.

      • TYPE: Specify HTTP, DNS_PUBLIC, or DNS_PRIVATE.

      • NAME: Specify the name of the namespace, which is found in Namespace.Name.

      • HTTP_NAME: Specify the HTTP name of the namespace, which is found in Namespace.Properties.HttpProperties.HttpName.

      • (string) –

    • Condition (string) –

      Specify the operator that you want to use to determine whether a namespace matches the specified value. Valid values for Condition are one of the following.

      • EQ: When you specify EQ for Condition, you can specify only one value. EQ is supported for TYPE, NAME, and HTTP_NAME. EQ is the default condition and can be omitted.

      • BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can specify only one value. BEGINS_WITH is supported for TYPE, NAME, and HTTP_NAME.

• 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

{
    'Namespaces': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Type': 'DNS_PUBLIC'|'DNS_PRIVATE'|'HTTP',
            'Description': 'string',
            'ServiceCount': 123,
            'Properties': {
                'DnsProperties': {
                    'HostedZoneId': 'string',
                    'SOA': {
                        'TTL': 123
                    }
                },
                'HttpProperties': {
                    'HttpName': 'string'
                }
            },
            'CreateDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Namespaces (list) –

    An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.

    • (dict) –

      A complex type that contains information about a namespace.

      • Id (string) –

        The ID of the namespace.

      • Arn (string) –

        The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

      • Name (string) –

        The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.

      • Type (string) –

        The type of the namespace, either public or private.

      • Description (string) –

        A description for the namespace.

      • ServiceCount (integer) –

        The number of services that were created using the namespace.

      • Properties (dict) –

        The properties of the namespace.

        • DnsProperties (dict) –

          A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

          • HostedZoneId (string) –

            The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

          • SOA (dict) –

            Start of Authority (SOA) record for the hosted zone.

            • TTL (integer) –

              The time to live (TTL) for purposes of negative caching.

        • HttpProperties (dict) –

          A complex type that contains the name of an HTTP namespace.

          • HttpName (string) –

            The name of an HTTP namespace.

      • CreateDate (datetime) –

        The date and time that the namespace was created.