Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateSite

Creates a new site in a global network.

Request Syntax


POST /global-networks/globalNetworkId/sites HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Location": { 
      "Address": "string",
      "Latitude": "string",
      "Longitude": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

globalNetworkId

The ID of the global network.

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: [\s\S]*

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

A description of your site.

Constraints: Maximum length of 256 characters.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

Location

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.

Type: Location object

Required: No

Tags

The tags to apply to the resource during creation.

Type: Array of Tag objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Site": { 
      "CreatedAt": number,
      "Description": "string",
      "GlobalNetworkId": "string",
      "Location": { 
         "Address": "string",
         "Latitude": "string",
         "Longitude": "string"
      },
      "SiteArn": "string",
      "SiteId": "string",
      "State": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Site

Information about the site.

Type: Site object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ServiceQuotaExceededException

A service limit was exceeded.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints.

HTTP Status Code: 400