NetworkManager / Paginator / GetSites

GetSites

class NetworkManager.Paginator.GetSites

paginator = client.get_paginator('get_sites')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• GlobalNetworkId (string) –

  [REQUIRED]

  The ID of the global network.

• SiteIds (list) –

  One or more site IDs. 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

{
    'Sites': [
        {
            'SiteId': 'string',
            'SiteArn': 'string',
            'GlobalNetworkId': 'string',
            'Description': 'string',
            'Location': {
                'Address': 'string',
                'Latitude': 'string',
                'Longitude': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • Sites (list) –

    The sites.

    • (dict) –

      Describes a site.

      • SiteId (string) –

        The ID of the site.

      • SiteArn (string) –

        The Amazon Resource Name (ARN) of the site.

      • GlobalNetworkId (string) –

        The ID of the global network.

      • Description (string) –

        The description of the site.

      • Location (dict) –

        The location of the site.

        • Address (string) –

          The physical address.

        • Latitude (string) –

          The latitude.

        • Longitude (string) –

          The longitude.

      • CreatedAt (datetime) –

        The date and time that the site was created.

      • State (string) –

        The state of the site.

      • Tags (list) –

        The tags for the site.

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