Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

create_site

create_site(**kwargs)

Creates a new site in a global network.

See also: AWS API Documentation

Request Syntax

response = client.create_site(
    GlobalNetworkId='string',
    Description='string',
    Location={
        'Address': 'string',
        'Latitude': 'string',
        'Longitude': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • GlobalNetworkId (string) --

    [REQUIRED]

    The ID of the global network.

  • Description (string) --

    A description of your site.

    Constraints: Maximum length of 256 characters.

  • Location (dict) --

    The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

    • Address : The physical address of the site.
    • Latitude : The latitude of the site.
    • Longitude : The longitude of the site.
    • Address (string) --

      The physical address.

    • Latitude (string) --

      The latitude.

    • Longitude (string) --

      The longitude.

  • Tags (list) --

    The tags to apply to the resource during creation.

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

Return type

dict

Returns

Response Syntax

{
    'Site': {
        '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) --

    • Site (dict) --

      Information about the 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.

Exceptions

  • NetworkManager.Client.exceptions.ValidationException
  • NetworkManager.Client.exceptions.ServiceQuotaExceededException
  • NetworkManager.Client.exceptions.AccessDeniedException
  • NetworkManager.Client.exceptions.ResourceNotFoundException
  • NetworkManager.Client.exceptions.ConflictException
  • NetworkManager.Client.exceptions.ThrottlingException
  • NetworkManager.Client.exceptions.InternalServerException