aws outposts - api reference · 2020. 11. 23. · aws outposts is a fully-managed service that...

AWS OutpostsAPI Reference

API Version 2019-12-03

AWS Outposts API Reference

AWS Outposts: API ReferenceCopyright © 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 notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

CreateOutpost ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

DeleteOutpost ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

DeleteSite .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

GetOutpost ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

GetOutpostInstanceTypes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

ListOutposts ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

ListSites ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

API Version 2019-12-03iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27InstanceTypeItem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Outpost ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Site .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

API Version 2019-12-03iv


WelcomeAWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools to customerpremises. By providing local access to AWS managed infrastructure, AWS Outposts enables customers tobuild and run applications on premises using the same programming interfaces as in AWS Regions, whileusing local compute and storage resources for lower latency and local data processing needs.

This document was last published on June 2, 2021.



ActionsThe following actions are supported:

• CreateOutpost (p. 3)• DeleteOutpost (p. 7)• DeleteSite (p. 9)• GetOutpost (p. 11)• GetOutpostInstanceTypes (p. 13)• ListOutposts (p. 16)• ListSites (p. 19)• ListTagsForResource (p. 21)• TagResource (p. 23)• UntagResource (p. 25)


AWS Outposts API ReferenceCreateOutpost

CreateOutpostCreates an Outpost.

Request SyntaxPOST /outposts HTTP/1.1Content-type: application/json

{ "AvailabilityZone": "string", "AvailabilityZoneId": "string", "Description": "string", "Name": "string", "SiteId": "string", "Tags": { "string" : "string" }}

URI Request ParametersThe request does not use any URI parameters.

Request BodyThe request accepts the following data in JSON format.

AvailabilityZone (p. 3)

The Availability Zone.

You must specify AvailabilityZone or AvailabilityZoneId.

Type: String

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

Pattern: [a-z\d-]+

Required: NoAvailabilityZoneId (p. 3)

The ID of the Availability Zone.


Type: String


Pattern: [a-z]+[0-9]+-az[0-9]+

Required: NoDescription (p. 3)

The description of the Outpost.


AWS Outposts API ReferenceResponse Syntax

Type: String


Pattern: ^[\S ]+$

Required: NoName (p. 3)

The name of the Outpost.

Type: String


Pattern: ^[\S ]+$

Required: YesSiteId (p. 3)

The ID of the site.

Type: String


Pattern: os-[a-f0-9]{17}

Required: YesTags (p. 3)

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 SyntaxHTTP/1.1 200Content-type: application/json

{ "Outpost": { "AvailabilityZone": "string", "AvailabilityZoneId": "string", "Description": "string", "LifeCycleStatus": "string", "Name": "string", "OutpostArn": "string",


AWS Outposts API ReferenceResponse Elements

"OutpostId": "string", "OwnerId": "string", "SiteId": "string", "Tags": { "string" : "string" } }}

Response ElementsIf 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. 4)

Information about an Outpost.

Type: Outpost (p. 29) object

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 36).

AccessDeniedException

You do not have permission to perform this operation.

HTTP Status Code: 403InternalServerException

An internal error has occurred.

HTTP Status Code: 500NotFoundException

The specified request is not valid.

HTTP Status Code: 404ServiceQuotaExceededException

You have exceeded a service quota.

HTTP Status Code: 402ValidationException

A parameter is not valid.

HTTP Status Code: 400

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface


https://docs.aws.amazon.com/goto/aws-cli/outposts-2019-12-03/CreateOutpost

AWS Outposts API ReferenceSee 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


https://docs.aws.amazon.com/goto/DotNetSDKV3/outposts-2019-12-03/CreateOutposthttps://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/CreateOutposthttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/CreateOutposthttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/CreateOutposthttps://docs.aws.amazon.com/goto/AWSJavaScriptSDK/outposts-2019-12-03/CreateOutposthttps://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/CreateOutposthttps://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/CreateOutposthttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/CreateOutpost

AWS Outposts API ReferenceDeleteOutpost

DeleteOutpostDeletes the Outpost.

Request SyntaxDELETE /outposts/OutpostId HTTP/1.1

URI Request ParametersThe request uses the following URI parameters.

OutpostId (p. 7)

The ID of the Outpost.


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

Required: Yes

Request BodyThe request does not have a request body.

Response SyntaxHTTP/1.1 200

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.














• 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


https://docs.aws.amazon.com/goto/aws-cli/outposts-2019-12-03/DeleteOutposthttps://docs.aws.amazon.com/goto/DotNetSDKV3/outposts-2019-12-03/DeleteOutposthttps://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/DeleteOutposthttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/DeleteOutposthttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/DeleteOutposthttps://docs.aws.amazon.com/goto/AWSJavaScriptSDK/outposts-2019-12-03/DeleteOutposthttps://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/DeleteOutposthttps://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/DeleteOutposthttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/DeleteOutpost

AWS Outposts API ReferenceDeleteSite

DeleteSiteDeletes the site.

Request SyntaxDELETE /sites/SiteId HTTP/1.1


SiteId (p. 9)

The ID of the site.



Required: Yes



















https://docs.aws.amazon.com/goto/aws-cli/outposts-2019-12-03/DeleteSitehttps://docs.aws.amazon.com/goto/DotNetSDKV3/outposts-2019-12-03/DeleteSitehttps://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/DeleteSitehttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/DeleteSitehttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/DeleteSitehttps://docs.aws.amazon.com/goto/AWSJavaScriptSDK/outposts-2019-12-03/DeleteSitehttps://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/DeleteSitehttps://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/DeleteSitehttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/DeleteSite

AWS Outposts API ReferenceGetOutpost

GetOutpostGets information about the specified Outpost.

Request SyntaxGET /outposts/OutpostId HTTP/1.1


OutpostId (p. 11)




Required: Yes



{ "Outpost": { "AvailabilityZone": "string", "AvailabilityZoneId": "string", "Description": "string", "LifeCycleStatus": "string", "Name": "string", "OutpostArn": "string", "OutpostId": "string", "OwnerId": "string", "SiteId": "string", "Tags": { "string" : "string" } }}




AWS Outposts API ReferenceErrors

Outpost (p. 11)

Information about an Outpost.

Type: Outpost (p. 29) object














https://docs.aws.amazon.com/goto/aws-cli/outposts-2019-12-03/GetOutposthttps://docs.aws.amazon.com/goto/DotNetSDKV3/outposts-2019-12-03/GetOutposthttps://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetOutposthttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/GetOutposthttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetOutposthttps://docs.aws.amazon.com/goto/AWSJavaScriptSDK/outposts-2019-12-03/GetOutposthttps://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetOutposthttps://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetOutposthttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetOutpost

AWS Outposts API ReferenceGetOutpostInstanceTypes

GetOutpostInstanceTypesLists the instance types for the specified Outpost.

Request SyntaxGET /outposts/OutpostId/instanceTypes?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1


MaxResults (p. 13)

The maximum page size.

Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 13)

The pagination token.


Pattern: .*\S.*OutpostId (p. 13)




Required: Yes



{ "InstanceTypes": [ { "InstanceType": "string" } ], "NextToken": "string", "OutpostArn": "string", "OutpostId": "string"}





InstanceTypes (p. 13)

Information about the instance types.

Type: Array of InstanceTypeItem (p. 28) objectsNextToken (p. 13)


Type: String


Pattern: .*\S.*OutpostArn (p. 13)

The Amazon Resource Name (ARN) of the Outpost.

Type: String


Pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$OutpostId (p. 13)


Type: String


















https://docs.aws.amazon.com/goto/aws-cli/outposts-2019-12-03/GetOutpostInstanceTypeshttps://docs.aws.amazon.com/goto/DotNetSDKV3/outposts-2019-12-03/GetOutpostInstanceTypeshttps://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetOutpostInstanceTypeshttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/GetOutpostInstanceTypeshttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetOutpostInstanceTypeshttps://docs.aws.amazon.com/goto/AWSJavaScriptSDK/outposts-2019-12-03/GetOutpostInstanceTypeshttps://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetOutpostInstanceTypeshttps://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetOutpostInstanceTypeshttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetOutpostInstanceTypes

AWS Outposts API ReferenceListOutposts

ListOutpostsList the Outposts for your AWS account.

Request Syntax

GET /outposts?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1


MaxResults (p. 16)


Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken (p. 16)



Pattern: .*\S.*


Response Syntax

HTTP/1.1 200Content-type: application/json

{ "NextToken": "string", "Outposts": [ { "AvailabilityZone": "string", "AvailabilityZoneId": "string", "Description": "string", "LifeCycleStatus": "string", "Name": "string", "OutpostArn": "string", "OutpostId": "string", "OwnerId": "string", "SiteId": "string", "Tags": { "string" : "string" } } ]}





NextToken (p. 16)


Type: String


Pattern: .*\S.*Outposts (p. 16)

Information about the Outposts.

Type: Array of Outpost (p. 29) objects












https://docs.aws.amazon.com/goto/aws-cli/outposts-2019-12-03/ListOutpostshttps://docs.aws.amazon.com/goto/DotNetSDKV3/outposts-2019-12-03/ListOutpostshttps://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListOutpostshttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/ListOutpostshttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListOutpostshttps://docs.aws.amazon.com/goto/AWSJavaScriptSDK/outposts-2019-12-03/ListOutpostshttps://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListOutpostshttps://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListOutpostshttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListOutposts

AWS Outposts API ReferenceListSites

ListSitesLists the sites for the specified AWS account.

Request SyntaxGET /sites?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1


MaxResults (p. 19)


Valid Range: Minimum value of 1. Maximum value of 1000.NextToken (p. 19)



Pattern: .*\S.*



{ "NextToken": "string", "Sites": [ { "AccountId": "string", "Description": "string", "Name": "string", "SiteId": "string", "Tags": { "string" : "string" } } ]}





NextToken (p. 19)


Type: String


Pattern: .*\S.*Sites (p. 19)

Information about the sites.

Type: Array of Site (p. 32) objects












https://docs.aws.amazon.com/goto/aws-cli/outposts-2019-12-03/ListSiteshttps://docs.aws.amazon.com/goto/DotNetSDKV3/outposts-2019-12-03/ListSiteshttps://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListSiteshttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/ListSiteshttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListSiteshttps://docs.aws.amazon.com/goto/AWSJavaScriptSDK/outposts-2019-12-03/ListSiteshttps://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListSiteshttps://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListSiteshttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListSites

AWS Outposts API ReferenceListTagsForResource

ListTagsForResourceLists the tags for the specified resource.

Request SyntaxGET /tags/ResourceArn HTTP/1.1


ResourceArn (p. 21)

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



{ "Tags": { "string" : "string" }}



Tags (p. 21)

The resource tags.










InternalServerException










https://docs.aws.amazon.com/goto/aws-cli/outposts-2019-12-03/ListTagsForResourcehttps://docs.aws.amazon.com/goto/DotNetSDKV3/outposts-2019-12-03/ListTagsForResourcehttps://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListTagsForResourcehttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/ListTagsForResourcehttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListTagsForResourcehttps://docs.aws.amazon.com/goto/AWSJavaScriptSDK/outposts-2019-12-03/ListTagsForResourcehttps://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListTagsForResourcehttps://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListTagsForResourcehttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListTagsForResource

AWS Outposts API ReferenceTagResource

TagResourceAdds tags to the specified resource.

Request SyntaxPOST /tags/ResourceArn HTTP/1.1Content-type: application/json

{ "Tags": { "string" : "string" }}


ResourceArn (p. 23)




Required: Yes

Request BodyThe request accepts the following data in JSON format.

Tags (p. 23)

The tags to add to the resource.







Required: Yes
















https://docs.aws.amazon.com/goto/aws-cli/outposts-2019-12-03/TagResourcehttps://docs.aws.amazon.com/goto/DotNetSDKV3/outposts-2019-12-03/TagResourcehttps://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/TagResourcehttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/TagResourcehttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/TagResourcehttps://docs.aws.amazon.com/goto/AWSJavaScriptSDK/outposts-2019-12-03/TagResourcehttps://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/TagResourcehttps://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/TagResourcehttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/TagResource

AWS Outposts API ReferenceUntagResource

UntagResourceRemoves tags from the specified resource.

Request SyntaxDELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1


ResourceArn (p. 25)




Required: YesTagKeys (p. 25)

The tag keys.

Array Members: Minimum number of 1 item. Maximum number of 50 items.


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

Required: Yes

















https://docs.aws.amazon.com/goto/aws-cli/outposts-2019-12-03/UntagResourcehttps://docs.aws.amazon.com/goto/DotNetSDKV3/outposts-2019-12-03/UntagResourcehttps://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/UntagResourcehttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/UntagResourcehttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/UntagResourcehttps://docs.aws.amazon.com/goto/AWSJavaScriptSDK/outposts-2019-12-03/UntagResourcehttps://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/UntagResourcehttps://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/UntagResourcehttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/UntagResource


Data TypesThe AWS Outposts API contains several data types that various actions use. This section describes eachdata type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• InstanceTypeItem (p. 28)• Outpost (p. 29)• Site (p. 32)


AWS Outposts API ReferenceInstanceTypeItem

InstanceTypeItemInformation about an instance type.

ContentsInstanceType

The instance type.

Type: String

Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/InstanceTypeItemhttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/InstanceTypeItemhttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/InstanceTypeItemhttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/InstanceTypeItem

AWS Outposts API ReferenceOutpost

OutpostInformation about an Outpost.

ContentsAvailabilityZone

The Availability Zone.


Type: String


Pattern: [a-z\d-]+

Required: NoAvailabilityZoneId

The ID of the Availability Zone.


Type: String


Pattern: [a-z]+[0-9]+-az[0-9]+

Required: NoDescription

The description of the Outpost.

Type: String


Pattern: ^[\S ]+$

Required: NoLifeCycleStatus

The life cycle status.

Type: String

Required: NoName

The name of the Outpost.

Type: String


Pattern: ^[\S ]+$


AWS Outposts API ReferenceContents

Required: NoOutpostArn

The Amazon Resource Name (ARN) of the Outpost.

Type: String


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

Required: NoOutpostId


Type: String



Required: NoOwnerId

The AWS account ID of the Outpost owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Required: NoSiteId

The ID of the site.

Type: String



Required: NoTags

The Outpost tags.









Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/Outposthttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/Outposthttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/Outposthttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/Outpost

AWS Outposts API ReferenceSite

SiteInformation about a site.

ContentsAccountId

The ID of the AWS account.

Type: String

Length Constraints: Fixed length of 12.

Required: NoDescription

The description of the site.

Type: String


Pattern: ^[\S ]+$

Required: NoName

The name of the site.

Type: String


Pattern: ^[\S ]+$

Required: NoSiteId

The ID of the site.

Type: String



Required: NoTags

The site tags.









Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/Sitehttps://docs.aws.amazon.com/goto/SdkForGoV1/outposts-2019-12-03/Sitehttps://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/Sitehttps://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/Site


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.


Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is


http://docs.aws.amazon.com/general/latest/gr/signature-version-4.htmlhttp://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional


http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.htmlhttp://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.htmlhttp://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.htmlhttp://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.


You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.




MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.



AWS OutpostsTable of ContentsWelcomeActionsCreateOutpostRequest SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

DeleteOutpostRequest SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

DeleteSiteRequest SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetOutpostRequest SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetOutpostInstanceTypesRequest SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

ListOutpostsRequest SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

ListSitesRequest SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

ListTagsForResourceRequest SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

TagResourceRequest SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

UntagResourceRequest SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

Data TypesInstanceTypeItemContentsSee Also

OutpostContentsSee Also

SiteContentsSee Also

Common ParametersCommon Errors

aws outposts - api reference · 2020. 11. 23. · aws outposts is a fully-managed service that...

Documents