AWS Outposts
API Reference
API Version 2019-12-03
AWS Outposts: API Reference
Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.
Table of Contents
Welcome ... 1
Actions ... 2
CancelOrder ... 3
Request Syntax ... 3
URI Request Parameters ... 3
Request Body ... 3
Response Syntax ... 3
Response Elements ... 3
Errors ... 3
See Also ... 4
CreateOrder ... 5
Request Syntax ... 5
URI Request Parameters ... 5
Request Body ... 5
Response Syntax ... 6
Response Elements ... 6
Errors ... 6
See Also ... 7
CreateOutpost ... 8
Request Syntax ... 8
URI Request Parameters ... 8
Request Body ... 8
Response Syntax ... 9
Response Elements ... 10
Errors ... 10
See Also ... 11
CreateSite ... 12
Request Syntax ... 12
URI Request Parameters ... 12
Request Body ... 13
Response Syntax ... 14
Response Elements ... 14
Errors ... 15
See Also ... 15
DeleteOutpost ... 16
Request Syntax ... 16
URI Request Parameters ... 16
Request Body ... 16
Response Syntax ... 16
Response Elements ... 16
Errors ... 16
Response Syntax ... 20
Response Elements ... 20
Errors ... 21
See Also ... 21
GetOrder ... 22
Request Syntax ... 22
URI Request Parameters ... 22
Request Body ... 22
Response Syntax ... 22
Response Elements ... 22
Errors ... 23
See Also ... 23
GetOutpost ... 24
Request Syntax ... 24
URI Request Parameters ... 24
Request Body ... 24
Response Syntax ... 24
Response Elements ... 24
Errors ... 25
See Also ... 25
GetOutpostInstanceTypes ... 26
Request Syntax ... 26
URI Request Parameters ... 26
Request Body ... 26
Response Syntax ... 26
Response Elements ... 27
Errors ... 27
See Also ... 28
GetSite ... 29
Request Syntax ... 29
URI Request Parameters ... 29
Request Body ... 29
Response Syntax ... 29
Response Elements ... 30
Errors ... 30
See Also ... 30
GetSiteAddress ... 32
Request Syntax ... 32
URI Request Parameters ... 32
Request Body ... 32
Response Syntax ... 32
Response Elements ... 33
Errors ... 33
See Also ... 34
ListCatalogItems ... 35
Request Syntax ... 35
URI Request Parameters ... 35
Request Body ... 36
Response Syntax ... 36
Response Elements ... 36
Errors ... 36
See Also ... 37
ListOrders ... 38
Request Syntax ... 38
URI Request Parameters ... 38
Request Body ... 38
Response Syntax ... 38
Response Elements ... 39
Errors ... 39
See Also ... 39
ListOutposts ... 41
Request Syntax ... 41
URI Request Parameters ... 41
Request Body ... 42
Response Syntax ... 42
Response Elements ... 42
Errors ... 43
See Also ... 43
ListSites ... 44
Request Syntax ... 44
URI Request Parameters ... 44
Request Body ... 44
Response Syntax ... 44
Response Elements ... 45
Errors ... 45
See Also ... 45
ListTagsForResource ... 47
Request Syntax ... 47
URI Request Parameters ... 47
Request Body ... 47
Response Syntax ... 47
Response Elements ... 47
Errors ... 48
See Also ... 48
TagResource ... 49
Request Syntax ... 49
URI Request Parameters ... 49
Request Body ... 49
Response Syntax ... 49
Response Elements ... 50
Errors ... 50
See Also ... 50
UntagResource ... 51
Request Syntax ... 51
URI Request Parameters ... 51
Request Body ... 51
Response Syntax ... 51
Response Elements ... 51
Errors ... 51
See Also ... 52
UpdateOutpost ... 53
Errors ... 57
See Also ... 58
UpdateSiteAddress ... 59
Request Syntax ... 59
URI Request Parameters ... 59
Request Body ... 59
Response Syntax ... 60
Response Elements ... 60
Errors ... 60
See Also ... 61
UpdateSiteRackPhysicalProperties ... 62
Request Syntax ... 62
URI Request Parameters ... 62
Request Body ... 62
Response Syntax ... 64
Response Elements ... 65
Errors ... 65
See Also ... 66
Data Types ... 67
Address ... 68
Contents ... 68
See Also ... 70
CatalogItem ... 71
Contents ... 71
See Also ... 72
EC2Capacity ... 73
Contents ... 73
See Also ... 73
InstanceTypeItem ... 74
Contents ... 74
See Also ... 74
LineItem ... 75
Contents ... 75
See Also ... 75
LineItemRequest ... 76
Contents ... 76
See Also ... 76
Order ... 77
Contents ... 77
See Also ... 78
OrderSummary ... 79
Contents ... 79
See Also ... 80
Outpost ... 81
Contents ... 81
See Also ... 83
RackPhysicalProperties ... 84
Contents ... 84
See Also ... 85
Site ... 86
Contents ... 86
See Also ... 88
Common Parameters ... 89
Common Errors ... 91
Welcome
AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.
This document was last published on March 6, 2022.
Actions
The following actions are supported:
• CancelOrder (p. 3)
• CreateOrder (p. 5)
• CreateOutpost (p. 8)
• CreateSite (p. 12)
• DeleteOutpost (p. 16)
• DeleteSite (p. 18)
• GetCatalogItem (p. 20)
• GetOrder (p. 22)
• GetOutpost (p. 24)
• GetOutpostInstanceTypes (p. 26)
• GetSite (p. 29)
• GetSiteAddress (p. 32)
• ListCatalogItems (p. 35)
• ListOrders (p. 38)
• ListOutposts (p. 41)
• ListSites (p. 44)
• ListTagsForResource (p. 47)
• TagResource (p. 49)
• UntagResource (p. 51)
• UpdateOutpost (p. 53)
• UpdateSite (p. 56)
• UpdateSiteAddress (p. 59)
• UpdateSiteRackPhysicalProperties (p. 62)
CancelOrder
CancelOrder
Cancels an order for an Outpost.
Request Syntax
POST /orders/OrderId/cancel HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
OrderId (p. 3)
The ID of the order to cancel.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: oo-[a-f0-9]{17}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
See Also
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateOrder
CreateOrder
Creates an order for an Outpost.
Request Syntax
POST /orders HTTP/1.1
Content-type: application/json { "LineItems": [
{
"CatalogItemId": "string", "Quantity": number
} ],
"OutpostIdentifier": "string", "PaymentOption": "string", "PaymentTerm": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
LineItems (p. 5)
The line items that make up the order.
Type: Array of LineItemRequest (p. 76) objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: Yes OutpostIdentifier (p. 5)
The ID or the Amazon Resource Name (ARN) of the Outpost.
Response Syntax
Required: Yes PaymentTerm (p. 5)
The payment terms for the order.
Type: String
Valid Values: THREE_YEARS Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Order": {
"LineItems": [ {
"CatalogItemId": "string", "LineItemId": "string", "Quantity": number, "Status": "string"
} ],
"OrderFulfilledDate": number, "OrderId": "string",
"OrderSubmissionDate": number, "OutpostId": "string",
"PaymentOption": "string", "Status": "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.
Order (p. 6)
Information about this order.
Type: Order (p. 77) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
AccessDeniedException
You do not have permission to perform this operation.
HTTP Status Code: 403
See Also
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateOutpost
CreateOutpost
Creates an Outpost.
You can specify AvailabilityZone or AvailabilityZoneId.
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 (p. 8) 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 (p. 8)
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 (p. 8)
The description of the Outpost.
Type: String
Response Syntax
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: ^[\S ]*$
Required: No Name (p. 8)
The name of the Outpost.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[\S ]+$
Required: Yes SiteId (p. 8)
The ID or the Amazon Resource Name (ARN) of the site.
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 (p. 8)
The type of hardware for this Outpost.
Type: String
Valid Values: RACK | SERVER Required: No
Tags (p. 8)
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.
Response Elements
{ "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 (p. 9)
Information about an Outpost.
Type: Outpost (p. 81) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
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.
See Also
HTTP Status Code: 402 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateSite
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
Request Body
The request accepts the following data in JSON format.
Description (p. 12)
The description of the site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1001.
Pattern: ^[\S ]+$
Required: No Name (p. 12)
The name of the site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: ^[\S ]+$
Required: Yes Notes (p. 12)
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 (p. 12)
The location to install and power on the hardware. This address might be different from the shipping address.
Type: Address (p. 68) object
Response Syntax
Type: Address (p. 68) object Required: No
Tags (p. 12)
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.
Errors
Site (p. 14)
Information about a site.
Type: Site (p. 86) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
DeleteOutpost
DeleteOutpost
Deletes the Outpost.
Request Syntax
DELETE /outposts/OutpostId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
OutpostId (p. 16)
The ID or the Amazon Resource Name (ARN) of the Outpost.
Length Constraints: Minimum length of 1. Maximum length of 180.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]
{17}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
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.
See Also
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteSite
DeleteSite
Deletes the site.
Request Syntax
DELETE /sites/SiteId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
SiteId (p. 18)
The ID or the Amazon Resource Name (ARN) of the site.
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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
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.
See Also
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetCatalogItem
GetCatalogItem
Gets information about a catalog item.
Request Syntax
GET /catalog/item/CatalogItemId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
CatalogItemId (p. 20)
The ID of the catalog item.
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern: OR-[A-Z0-9]{7}
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"CatalogItem": {
"CatalogItemId": "string", "EC2Capacities": [ {
"Family": "string", "MaxSize": "string", "Quantity": "string"
} ],
"ItemStatus": "string", "PowerKva": number,
"SupportedStorage": [ "string" ], "SupportedUplinkGbps": [ number ], "WeightLbs": number
} }
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.
Errors
CatalogItem (p. 20)
Information about this catalog item.
Type: CatalogItem (p. 71) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
InternalServerException
An internal error has occurred.
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetOrder
GetOrder
Gets an order.
Request Syntax
GET /orders/OrderId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
OrderId (p. 22)
The ID of the order.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: oo-[a-f0-9]{17}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Order": {
"LineItems": [ {
"CatalogItemId": "string", "LineItemId": "string", "Quantity": number, "Status": "string"
} ],
"OrderFulfilledDate": number, "OrderId": "string",
"OrderSubmissionDate": number, "OutpostId": "string",
"PaymentOption": "string", "Status": "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.
Errors
Order (p. 22)
Information about an order.
Type: Order (p. 77) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
InternalServerException
An internal error has occurred.
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetOutpost
GetOutpost
Gets information about the specified Outpost.
Request Syntax
GET /outposts/OutpostId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
OutpostId (p. 24)
The ID or the Amazon Resource Name (ARN) of the Outpost.
Length Constraints: Minimum length of 1. Maximum length of 180.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]
{17}$
Required: Yes
Request Body
The request does not have a request body.
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.
Errors
The following data is returned in JSON format by the service.
Outpost (p. 24)
Information about an Outpost.
Type: Outpost (p. 81) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
AccessDeniedException
You do not have permission to perform this operation.
HTTP Status Code: 403 InternalServerException
An internal error has occurred.
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
GetOutpostInstanceTypes
GetOutpostInstanceTypes
Lists the instance types for the specified Outpost.
Request Syntax
GET /outposts/OutpostId/instanceTypes?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
MaxResults (p. 26)
The maximum page size.
Valid Range: Minimum value of 1. Maximum value of 1000.
NextToken (p. 26) The pagination token.
Length Constraints: Minimum length of 1. Maximum length of 1005.
Pattern: ^(\d+)##(\S+)$
OutpostId (p. 26)
The ID or the Amazon Resource Name (ARN) of the Outpost.
Length Constraints: Minimum length of 1. Maximum length of 180.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]
{17}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "InstanceTypes": [
{
"InstanceType": "string"
} ],
"NextToken": "string", "OutpostArn": "string", "OutpostId": "string"
}
Response Elements
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.
InstanceTypes (p. 26)
Information about the instance types.
Type: Array of InstanceTypeItem (p. 74) objects NextToken (p. 26)
The pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1005.
Pattern: ^(\d+)##(\S+)$
OutpostArn (p. 26)
The Amazon Resource Name (ARN) of the Outpost.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$
OutpostId (p. 26)
The ID of the Outpost.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 180.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]
{17}$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
See Also
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetSite
GetSite
Gets information about the specified Outpost site.
Request Syntax
GET /sites/SiteId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
SiteId (p. 29)
The ID or the Amazon Resource Name (ARN) of the site.
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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Site": {
"AccountId": "string", "Description": "string", "Name": "string", "Notes": "string",
"OperatingAddressCity": "string", "OperatingAddressCountryCode": "string",
Response Elements
} }}
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 (p. 29)
Information about a site.
Type: Site (p. 86) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
AccessDeniedException
You do not have permission to perform this operation.
HTTP Status Code: 403 InternalServerException
An internal error has occurred.
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
See Also
• AWS SDK for Ruby V3
GetSiteAddress
GetSiteAddress
Gets the site address.
Request Syntax
GET /sites/SiteId/address?AddressType=AddressType HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
AddressType (p. 32)
The type of the address you request.
Valid Values: SHIPPING_ADDRESS | OPERATING_ADDRESS Required: Yes
SiteId (p. 32)
The ID or the Amazon Resource Name (ARN) of the site.
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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Address": {
"AddressLine1": "string", "AddressLine2": "string", "AddressLine3": "string", "City": "string",
"ContactName": "string",
"ContactPhoneNumber": "string", "CountryCode": "string",
"DistrictOrCounty": "string", "Municipality": "string", "PostalCode": "string", "StateOrRegion": "string"
},
"AddressType": "string",
Response Elements
"SiteId": "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.
Address (p. 32)
Information about the address.
Type: Address (p. 68) object AddressType (p. 32)
The type of the address you receive.
Type: String
Valid Values: SHIPPING_ADDRESS | OPERATING_ADDRESS SiteId (p. 32)
The ID of the site.
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})$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
AccessDeniedException
You do not have permission to perform this operation.
HTTP Status Code: 403 InternalServerException
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListCatalogItems
ListCatalogItems
Use to create a list of every item in the catalog. Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
Request Syntax
GET /catalog/items?
EC2FamilyFilter=EC2FamilyFilter&ItemClassFilter=ItemClassFilter&MaxResults=MaxResults&NextToken=NextToken&SupportedStorageFilter=SupportedStorageFilter HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
EC2FamilyFilter (p. 35)
A filter for EC2 family options for items in the catalog.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern: [a-z0-9]+
ItemClassFilter (p. 35)
A filter for the class of items in the catalog.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
Valid Values: RACK | SERVER MaxResults (p. 35)
The maximum page size.
Valid Range: Minimum value of 1. Maximum value of 1000.
NextToken (p. 35)
Request Body
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "CatalogItems": [
{
"CatalogItemId": "string", "EC2Capacities": [ {
"Family": "string", "MaxSize": "string", "Quantity": "string"
} ],
"ItemStatus": "string", "PowerKva": number,
"SupportedStorage": [ "string" ], "SupportedUplinkGbps": [ number ], "WeightLbs": number
} ],
"NextToken": "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.
CatalogItems (p. 36)
Information about the catalog items.
Type: Array of CatalogItem (p. 71) objects NextToken (p. 36)
The pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1005.
Pattern: ^(\d+)##(\S+)$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
InternalServerException
An internal error has occurred.
See Also
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListOrders
ListOrders
Create a list of the Outpost orders for your AWS account. You can filter your request by Outpost to return a more specific list of results.
Request Syntax
GET /list-orders?
MaxResults=MaxResults&NextToken=NextToken&OutpostIdentifierFilter=OutpostIdentifierFilter HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
MaxResults (p. 38)
The maximum page size.
Valid Range: Minimum value of 1. Maximum value of 1000.
NextToken (p. 38) The pagination token.
Length Constraints: Minimum length of 1. Maximum length of 1005.
Pattern: ^(\d+)##(\S+)$
OutpostIdentifierFilter (p. 38)
The ID or the Amazon Resource Name (ARN) of the Outpost.
Length Constraints: Minimum length of 1. Maximum length of 180.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]
{17}$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "NextToken": "string", "Orders": [
{
"LineItemCountsByStatus": { "string" : number },
"OrderFulfilledDate": number, "OrderId": "string",
"OrderSubmissionDate": number,
Response Elements
"OrderType": "string", "OutpostId": "string", "Status": "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.
NextToken (p. 38) The pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1005.
Pattern: ^(\d+)##(\S+)$
Orders (p. 38)
Information about the orders.
Type: Array of OrderSummary (p. 79) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
AccessDeniedException
You do not have permission to perform this operation.
HTTP Status Code: 403 InternalServerException
An internal error has occurred.
HTTP Status Code: 500 NotFoundException
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListOutposts
ListOutposts
Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availability Zone (us-east-1a), and AZ ID (use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
Request Syntax
GET /outposts?
AvailabilityZoneFilter=AvailabilityZoneFilter&AvailabilityZoneIdFilter=AvailabilityZoneIdFilter&LifeCycleStatusFilter=LifeCycleStatusFilter&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
AvailabilityZoneFilter (p. 41)
A filter for the Availability Zone (us-east-1a) of the Outpost.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: ^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\d+[a-zA-Z]?)?$
AvailabilityZoneIdFilter (p. 41)
A filter for the AZ IDs (use1-az1) of the Outpost.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z]+\d-[a-zA-Z]+\d$
Request Body
Valid Range: Minimum value of 1. Maximum value of 1000.
NextToken (p. 41) The pagination token.
Length Constraints: Minimum length of 1. Maximum length of 1005.
Pattern: ^(\d+)##(\S+)$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"NextToken": "string", "Outposts": [
{
"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.
NextToken (p. 42) The pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1005.
Pattern: ^(\d+)##(\S+)$
Outposts (p. 42)
Information about the Outposts.
Errors
Type: Array of Outpost (p. 81) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
AccessDeniedException
You do not have permission to perform this operation.
HTTP Status Code: 403 InternalServerException
An internal error has occurred.
HTTP Status Code: 500 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListSites
ListSites
Lists the sites for your AWS account.
Request Syntax
GET /sites?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
MaxResults (p. 44)
The maximum page size.
Valid Range: Minimum value of 1. Maximum value of 1000.
NextToken (p. 44) The pagination token.
Length Constraints: Minimum length of 1. Maximum length of 1005.
Pattern: ^(\d+)##(\S+)$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"NextToken": "string", "Sites": [
{
"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"
Response Elements
},
"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.
NextToken (p. 44) The pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1005.
Pattern: ^(\d+)##(\S+)$
Sites (p. 44)
Information about the sites.
Type: Array of Site (p. 86) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
AccessDeniedException
You do not have permission to perform this operation.
HTTP Status Code: 403 InternalServerException
An internal error has occurred.
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListTagsForResource
ListTagsForResource
Lists the tags for the specified resource.
Request Syntax
GET /tags/ResourceArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
ResourceArn (p. 47)
The Amazon Resource Name (ARN) of the resource.
Length Constraints: Maximum length of 1011.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:([a-z\d-]+)/)[a-z]
{2,8}-[a-f0-9]{17}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Tags": {
"string" : "string"
}}
Response Elements
Errors
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Value Pattern: ^[\S \n]+$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
InternalServerException
An internal error has occurred.
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
TagResource
TagResource
Adds tags to the specified resource.
Request Syntax
POST /tags/ResourceArn HTTP/1.1 Content-type: application/json { "Tags": {
"string" : "string"
}}
URI Request Parameters
The request uses the following URI parameters.
ResourceArn (p. 49)
The Amazon Resource Name (ARN) of the resource.
Length Constraints: Maximum length of 1011.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:([a-z\d-]+)/)[a-z]
{2,8}-[a-f0-9]{17}$
Required: Yes
Request Body
The request accepts the following data in JSON format.
Tags (p. 49)
The tags to add to the resource.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
InternalServerException
An internal error has occurred.
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UntagResource
UntagResource
Removes tags from the specified resource.
Request Syntax
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
ResourceArn (p. 51)
The Amazon Resource Name (ARN) of the resource.
Length Constraints: Maximum length of 1011.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:([a-z\d-]+)/)[a-z]
{2,8}-[a-f0-9]{17}$
Required: Yes TagKeys (p. 51)
The tag keys.
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
See Also
HTTP Status Code: 500 NotFoundException
The specified request is not valid.
HTTP Status Code: 404 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateOutpost
UpdateOutpost
Updates an Outpost.
Request Syntax
PATCH /outposts/OutpostId HTTP/1.1 Content-type: application/json {
"Description": "string", "Name": "string",
"SupportedHardwareType": "string"
}
URI Request Parameters
The request uses the following URI parameters.
OutpostId (p. 53)
The ID or the Amazon Resource Name (ARN) of the Outpost.
Length Constraints: Minimum length of 1. Maximum length of 180.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]
{17}$
Required: Yes
Request Body
The request accepts the following data in JSON format.
Description (p. 53)
The description of the Outpost.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Response Syntax
SupportedHardwareType (p. 53)
The type of hardware for this Outpost.
Type: String
Valid Values: RACK | SERVER 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 (p. 54)
Information about an Outpost.
Type: Outpost (p. 81) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
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.
See Also
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 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateSite
UpdateSite
Updates the site.
Request Syntax
PATCH /sites/SiteId HTTP/1.1 Content-type: application/json {
"Description": "string", "Name": "string",
"Notes": "string"
}
URI Request Parameters
The request uses the following URI parameters.
SiteId (p. 56)
The ID or the Amazon Resource Name (ARN) of the site.
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
Request Body
The request accepts the following data in JSON format.
Description (p. 56)
The description of the site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1001.
Pattern: ^[\S ]+$
Required: No Name (p. 56)
The name of the site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: ^[\S ]+$
Required: No
Response Syntax
Notes (p. 56)
Notes about a site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
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
See Also
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 ValidationException
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateSiteAddress
UpdateSiteAddress
Updates the site address.
To update a site address with an order IN_PROGRESS, you must wait for the order to complete or cancel the order.
You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.
Request Syntax
PUT /sites/SiteId/address HTTP/1.1 Content-type: application/json { "Address": {
"AddressLine1": "string", "AddressLine2": "string", "AddressLine3": "string", "City": "string",
"ContactName": "string",
"ContactPhoneNumber": "string", "CountryCode": "string",
"DistrictOrCounty": "string", "Municipality": "string", "PostalCode": "string", "StateOrRegion": "string"
},
"AddressType": "string"
}
URI Request Parameters
The request uses the following URI parameters.
SiteId (p. 59)
The ID or the Amazon Resource Name (ARN) of the site.
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})$
Response Syntax
AddressType (p. 59) The type of the address.
Type: String
Valid Values: SHIPPING_ADDRESS | OPERATING_ADDRESS Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Address": {
"AddressLine1": "string", "AddressLine2": "string", "AddressLine3": "string", "City": "string",
"ContactName": "string",
"ContactPhoneNumber": "string", "CountryCode": "string",
"DistrictOrCounty": "string", "Municipality": "string", "PostalCode": "string", "StateOrRegion": "string"
},
"AddressType": "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.
Address (p. 60)
Information about an address.
Type: Address (p. 68) object AddressType (p. 60)
The type of the address.
Type: String
Valid Values: SHIPPING_ADDRESS | OPERATING_ADDRESS
Errors
For information about the errors that are common to all actions, see Common Errors (p. 91).
AccessDeniedException
You do not have permission to perform this operation.
