NetworkManager / Paginator / DescribeGlobalNetworks

DescribeGlobalNetworks

class NetworkManager.Paginator.DescribeGlobalNetworks

paginator = client.get_paginator('describe_global_networks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.describe_global_networks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• GlobalNetworkIds (list) –

  The IDs of one or more global networks. The maximum is 10.

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

dict

Returns:

Response Syntax

{
    'GlobalNetworks': [
        {
            'GlobalNetworkId': 'string',
            'GlobalNetworkArn': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • GlobalNetworks (list) –

    Information about the global networks.

    • (dict) –

      Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-managed Core Network.

      • GlobalNetworkId (string) –

        The ID of the global network.

      • GlobalNetworkArn (string) –

        The Amazon Resource Name (ARN) of the global network.

      • Description (string) –

        The description of the global network.

      • CreatedAt (datetime) –

        The date and time that the global network was created.

      • State (string) –

        The state of the global network.

      • Tags (list) –

        The tags for the global network.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) –

            The tag value.

            Constraints: Maximum length of 256 characters.