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

CreateOutpost

Creates an Outpost.

You can specify either an Availability one or an AZ ID.

Request Syntax


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

{
   "AvailabilityZone": "string",
   "AvailabilityZoneId": "string",
   "Description": "string",
   "Name": "string",
   "SiteId": "string",
   "SupportedHardwareType": "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.

AvailabilityZone

The Availability Zone.

Type: String

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

Pattern: ^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\d+[a-zA-Z]?)?$

Required: No

AvailabilityZoneId

The ID of the Availability Zone.

Type: String

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

Pattern: ^[a-zA-Z]+\d-[a-zA-Z]+\d$

Required: No

Description

The description of the Outpost.

Type: String

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

Pattern: ^[\S ]*$

Required: No

Name

The name of the Outpost.

Type: String

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

Pattern: ^[\S ]+$

Required: Yes

SiteId

The ID or the Amazon Resource Name (ARN) of the site.

Note

Despite the parameter name, you can make the request with an ARN. The parameter name is SiteId for backward compatibility.

Type: String

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

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$

Required: Yes

SupportedHardwareType

The type of hardware for this Outpost.

Type: String

Valid Values: RACK | SERVER

Required: No

Tags

The tags to apply to the Outpost.

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

{
   "Outpost": { 
      "AvailabilityZone": "string",
      "AvailabilityZoneId": "string",
      "Description": "string",
      "LifeCycleStatus": "string",
      "Name": "string",
      "OutpostArn": "string",
      "OutpostId": "string",
      "OwnerId": "string",
      "SiteArn": "string",
      "SiteId": "string",
      "SupportedHardwareType": "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.

Outpost

Information about an Outpost.

Type: Outpost 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

NotFoundException

The specified request is not valid.

HTTP Status Code: 404

ServiceQuotaExceededException

You have exceeded a service quota.

HTTP Status Code: 402

ValidationException

A parameter is not valid.

HTTP Status Code: 400