NetworkManager / Client / get_sites

get_sites#

NetworkManager.Client.get_sites(**kwargs)#

Gets information about one or more of your sites in a global network.

See also: AWS API Documentation

Request Syntax

response = client.get_sites(
    GlobalNetworkId='string',
    SiteIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • GlobalNetworkId (string) –

    [REQUIRED]

    The ID of the global network.

  • SiteIds (list) –

    One or more site IDs. The maximum is 10.

    • (string) –

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – The token for the next page of results.

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'
                },
            ]
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      The token for the next page of results.

Exceptions