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

CreateSite

Creates a site for an Outpost.

Request Syntax


POST /sites HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "Notes": "string",
   "OperatingAddress": { 
      "AddressLine1": "string",
      "AddressLine2": "string",
      "AddressLine3": "string",
      "City": "string",
      "ContactName": "string",
      "ContactPhoneNumber": "string",
      "CountryCode": "string",
      "DistrictOrCounty": "string",
      "Municipality": "string",
      "PostalCode": "string",
      "StateOrRegion": "string"
   },
   "RackPhysicalProperties": { 
      "FiberOpticCableType": "string",
      "MaximumSupportedWeightLbs": "string",
      "OpticalStandard": "string",
      "PowerConnector": "string",
      "PowerDrawKva": "string",
      "PowerFeedDrop": "string",
      "PowerPhase": "string",
      "UplinkCount": "string",
      "UplinkGbps": "string"
   },
   "ShippingAddress": { 
      "AddressLine1": "string",
      "AddressLine2": "string",
      "AddressLine3": "string",
      "City": "string",
      "ContactName": "string",
      "ContactPhoneNumber": "string",
      "CountryCode": "string",
      "DistrictOrCounty": "string",
      "Municipality": "string",
      "PostalCode": "string",
      "StateOrRegion": "string"
   },
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Description

The description of the site.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1001.

Pattern: ^[\S ]+$

Required: No

Name

The name of the site.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^[\S ]+$

Required: Yes

Notes

Additional information that you provide about site access requirements, electrician scheduling, personal protective equipment, or regulation of equipment materials that could affect your installation process.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: ^[\S \n]+$

Required: No

OperatingAddress

The location to install and power on the hardware. This address might be different from the shipping address.

Type: Address object

Required: No

RackPhysicalProperties

Information about the physical and logistical details for the rack at this site. For more information about hardware requirements for racks, see Network readiness checklist in the AWS Outposts User Guide.

Type: RackPhysicalProperties object

Required: No

ShippingAddress

The location to ship the hardware. This address might be different from the operating address.

Type: Address object

Required: No

Tags

The tags to apply to a site.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: ^[\S \n]+$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Site": { 
      "AccountId": "string",
      "Description": "string",
      "Name": "string",
      "Notes": "string",
      "OperatingAddressCity": "string",
      "OperatingAddressCountryCode": "string",
      "OperatingAddressStateOrRegion": "string",
      "RackPhysicalProperties": { 
         "FiberOpticCableType": "string",
         "MaximumSupportedWeightLbs": "string",
         "OpticalStandard": "string",
         "PowerConnector": "string",
         "PowerDrawKva": "string",
         "PowerFeedDrop": "string",
         "PowerPhase": "string",
         "UplinkCount": "string",
         "UplinkGbps": "string"
      },
      "SiteArn": "string",
      "SiteId": "string",
      "Tags": { 
         "string" : "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 a site.

Type: Site object

Errors

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

AccessDeniedException

You do not have permission to perform this operation.

HTTP Status Code: 403

ConflictException

Updating or deleting this resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

ServiceQuotaExceededException

You have exceeded a service quota.

HTTP Status Code: 402

ValidationException

A parameter is not valid.

HTTP Status Code: 400