The AWS Outposts API provides programmatic access to create and manage Outposts, sites, orders, catalog items, assets, and local gateway routes for deploying AWS infrastructure on-premises.
openapi: 3.0.0
info:
version: 2019-12-03
x-release: v4
title: AWS Outposts
description: Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing local access to Amazon Web
Services managed infrastructure, Amazon Web Services Outposts enables customers to build and run applications on premises using the same programming interfaces as in Amazon Web Services Regions,
while using local compute and storage resources for lower latency and local data processing needs.
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: "#FFFFFF"
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: [email protected]
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: outposts
x-aws-signingName: outposts
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/outposts-2019-12-03.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/outposts/
servers:
- url: http://outposts.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Outposts multi-region endpoint
- url: https://outposts.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Outposts multi-region endpoint
- url: http://outposts.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Outposts endpoint for China (Beijing) and China (Ningxia)
- url: https://outposts.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Outposts endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
"/orders/{OrderId}/cancel":
post:
operationId: CancelOrder
description: Cancels the specified order for an Outpost.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CancelOrderOutput"
"480":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"481":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"482":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"483":
description: NotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
"484":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters:
- name: OrderId
in: path
required: true
description: " The ID of the order. "
schema:
type: string
pattern: oo-[a-f0-9]{17}$
minLength: 1
maxLength: 20
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts Cancel Order
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/orders:
post:
operationId: CreateOrder
description: Creates an order for an Outpost.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrderOutput"
examples:
CreateOrder200Example:
summary: Default CreateOrder 200 response
x-microcks-default: true
value:
Order: example-string
"480":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"481":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"482":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"483":
description: NotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
"484":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"485":
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceQuotaExceededException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- OutpostIdentifier
- LineItems
- PaymentOption
properties:
OutpostIdentifier:
description: " The ID or 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}$
minLength: 1
maxLength: 180
LineItems:
description: The line items that make up the order.
type: array
items:
$ref: "#/components/schemas/LineItemRequest"
minItems: 1
maxItems: 20
PaymentOption:
description: The payment option.
type: string
enum:
- ALL_UPFRONT
- NO_UPFRONT
- PARTIAL_UPFRONT
PaymentTerm:
description: The payment terms.
type: string
enum:
- THREE_YEARS
- ONE_YEAR
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts Create Order
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/outposts:
post:
operationId: CreateOutpost
description: <p>Creates an Outpost.</p> <p>You can specify either an Availability one or an AZ ID.</p>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOutpostOutput"
examples:
CreateOutpost200Example:
summary: Default CreateOutpost 200 response
x-microcks-default: true
value:
Outpost: example-ref
"480":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"481":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"482":
description: NotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
"483":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"484":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"485":
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceQuotaExceededException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Name
- SiteId
properties:
Name:
description: The name of the Outpost.
type: string
pattern: ^[\S ]+$
minLength: 1
maxLength: 255
Description:
description: The description of the Outpost.
type: string
pattern: ^[\S ]*$
minLength: 0
maxLength: 1000
SiteId:
description: The ID of the site.
type: string
pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$
minLength: 1
maxLength: 255
AvailabilityZone:
description: The Availability Zone.
type: string
pattern: ^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\d+[a-zA-Z]?)?$
minLength: 1
maxLength: 1000
AvailabilityZoneId:
description: The ID of the Availability Zone.
type: string
pattern: ^[a-zA-Z]+\d-[a-zA-Z]+\d$
minLength: 1
maxLength: 255
Tags:
description: The tags to apply to the Outpost.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: "#/components/schemas/TagValue"
SupportedHardwareType:
description: " The type of hardware for this Outpost. "
type: string
enum:
- RACK
- SERVER
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts Create Outpost
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: ListOutposts
description: <p>Lists the Outposts for your Amazon Web Services account.</p> <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources
that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.</p>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListOutpostsOutput"
examples:
ListOutposts200Example:
summary: Default ListOutposts 200 response
x-microcks-default: true
value:
Outposts: example-ref
NextToken: example-ref
"480":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"481":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"482":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters:
- name: NextToken
in: query
required: false
description: ""
schema:
type: string
pattern: ^(\d+)##(\S+)$
description: The pagination token.
minLength: 1
maxLength: 2048
- name: MaxResults
in: query
required: false
description: ""
schema:
type: integer
description: The maximum page size.
minimum: 1
maximum: 1000
- name: LifeCycleStatusFilter
in: query
required: false
description: Filters the results by the lifecycle status.
schema:
type: array
items:
$ref: "#/components/schemas/LifeCycleStatus"
minItems: 1
maxItems: 5
- name: AvailabilityZoneFilter
in: query
required: false
description: Filters the results by Availability Zone (for example, <code>us-east-1a</code>).
schema:
type: array
items:
$ref: "#/components/schemas/AvailabilityZone"
minItems: 1
maxItems: 5
- name: AvailabilityZoneIdFilter
in: query
required: false
description: Filters the results by AZ ID (for example, <code>use1-az1</code>).
schema:
type: array
items:
$ref: "#/components/schemas/AvailabilityZoneId"
minItems: 1
maxItems: 5
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts List Outposts
/sites:
post:
operationId: CreateSite
description: " Creates a site for an Outpost. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSiteOutput"
examples:
CreateSite200Example:
summary: Default CreateSite 200 response
x-microcks-default: true
value:
Site: example-ref
"480":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"481":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"482":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"483":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"484":
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceQuotaExceededException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Name
properties:
Name:
description: The name of the site.
type: string
pattern: ^[\S ]+$
minLength: 1
maxLength: 1000
Description:
description: The description of the site.
type: string
pattern: ^[\S ]+$
minLength: 1
maxLength: 1001
Notes:
description: "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
pattern: ^[\S \n]+$
minLength: 1
maxLength: 2000
Tags:
description: " The tags to apply to a site. "
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: "#/components/schemas/TagValue"
OperatingAddress:
description: " Information about an address. "
type: object
properties:
ContactName:
allOf:
- $ref: "#/components/schemas/ContactName"
- description: The name of the contact.
ContactPhoneNumber:
allOf:
- $ref: "#/components/schemas/ContactPhoneNumber"
- description: The phone number of the contact.
AddressLine1:
allOf:
- $ref: "#/components/schemas/AddressLine1"
- description: The first line of the address.
AddressLine2:
allOf:
- $ref: "#/components/schemas/AddressLine2"
- description: The second line of the address.
AddressLine3:
allOf:
- $ref: "#/components/schemas/AddressLine3"
- description: The third line of the address.
City:
allOf:
- $ref: "#/components/schemas/City"
- description: The city for the address.
StateOrRegion:
allOf:
- $ref: "#/components/schemas/StateOrRegion"
- description: The state for the address.
DistrictOrCounty:
allOf:
- $ref: "#/components/schemas/DistrictOrCounty"
- description: The district or county for the address.
PostalCode:
allOf:
- $ref: "#/components/schemas/PostalCode"
- description: The postal code for the address.
CountryCode:
allOf:
- $ref: "#/components/schemas/CountryCode"
- description: The ISO-3166 two-letter country code for the address.
Municipality:
allOf:
- $ref: "#/components/schemas/Municipality"
- description: The municipality for the address.
ShippingAddress:
description: " Information about an address. "
type: object
properties:
ContactName:
allOf:
- $ref: "#/components/schemas/ContactName"
- description: The name of the contact.
ContactPhoneNumber:
allOf:
- $ref: "#/components/schemas/ContactPhoneNumber"
- description: The phone number of the contact.
AddressLine1:
allOf:
- $ref: "#/components/schemas/AddressLine1"
- description: The first line of the address.
AddressLine2:
allOf:
- $ref: "#/components/schemas/AddressLine2"
- description: The second line of the address.
AddressLine3:
allOf:
- $ref: "#/components/schemas/AddressLine3"
- description: The third line of the address.
City:
allOf:
- $ref: "#/components/schemas/City"
- description: The city for the address.
StateOrRegion:
allOf:
- $ref: "#/components/schemas/StateOrRegion"
- description: The state for the address.
DistrictOrCounty:
allOf:
- $ref: "#/components/schemas/DistrictOrCounty"
- description: The district or county for the address.
PostalCode:
allOf:
- $ref: "#/components/schemas/PostalCode"
- description: The postal code for the address.
CountryCode:
allOf:
- $ref: "#/components/schemas/CountryCode"
- description: The ISO-3166 two-letter country code for the address.
Municipality:
allOf:
- $ref: "#/components/schemas/Municipality"
- description: The municipality for the address.
RackPhysicalProperties:
description: ' Information about the physical and logistical details for racks at sites. For more information about hardware requirements for racks, see <a href="https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist">Network
readiness checklist</a> in the Amazon Web Services Outposts User Guide. '
type: object
properties:
PowerDrawKva:
allOf:
- $ref: "#/components/schemas/PowerDrawKva"
- description: "The power draw available at the hardware placement position for the rack. "
PowerPhase:
allOf:
- $ref: "#/components/schemas/PowerPhase"
- description: The power option that you can provide for hardware.
PowerConnector:
allOf:
- $ref: "#/components/schemas/PowerConnector"
- description: "The power connector for the hardware. "
PowerFeedDrop:
allOf:
- $ref: "#/components/schemas/PowerFeedDrop"
- description: The position of the power feed.
UplinkGbps:
allOf:
- $ref: "#/components/schemas/UplinkGbps"
- description: "The uplink speed the rack supports for the connection to the Region. "
UplinkCount:
allOf:
- $ref: "#/components/schemas/UplinkCount"
- description: The number of uplinks each Outpost network device.
FiberOpticCableType:
allOf:
- $ref: "#/components/schemas/FiberOpticCableType"
- description: "The type of fiber used to attach the Outpost to the network. "
OpticalStandard:
allOf:
- $ref: "#/components/schemas/OpticalStandard"
- description: 'The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For
more information about networking requirements for racks, see <a href="https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking">Network</a>
in the Amazon Web Services Outposts User Guide. '
MaximumSupportedWeightLbs:
allOf:
- $ref: "#/components/schemas/MaximumSupportedWeightLbs"
- description: "The maximum rack weight that this site can support. <code>NO_LIMIT</code> is over 2000 lbs (907 kg). "
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts Create Site
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: ListSites
description: <p>Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.</p> <p>Use filters to return specific results. If you specify multiple
filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the
values that you specify for the filter.</p>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListSitesOutput"
examples:
ListSites200Example:
summary: Default ListSites 200 response
x-microcks-default: true
value:
Sites: example-ref
NextToken: example-ref
"480":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"481":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"482":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters:
- name: NextToken
in: query
required: false
description: ""
schema:
type: string
pattern: ^(\d+)##(\S+)$
description: The pagination token.
minLength: 1
maxLength: 2048
- name: MaxResults
in: query
required: false
description: ""
schema:
type: integer
description: The maximum page size.
minimum: 1
maximum: 1000
- name: OperatingAddressCountryCodeFilter
in: query
required: false
description: Filters the results by country code.
schema:
type: array
items:
$ref: "#/components/schemas/CountryCode"
- name: OperatingAddressStateOrRegionFilter
in: query
required: false
description: Filters the results by state or region.
schema:
type: array
items:
$ref: "#/components/schemas/StateOrRegion"
- name: OperatingAddressCityFilter
in: query
required: false
description: Filters the results by city.
schema:
type: array
items:
$ref: "#/components/schemas/City"
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts List Sites
"/outposts/{OutpostId}":
delete:
operationId: DeleteOutpost
description: Deletes the specified Outpost.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteOutpostOutput"
"480":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"481":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"482":
description: NotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
"483":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"484":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters:
- name: OutpostId
in: path
required: true
description: " The ID or the Amazon Resource Name (ARN) of the Outpost. "
schema:
type: string
pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$
minLength: 1
maxLength: 180
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Outposts Delete Outpost
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: GetOutpost
description: Gets information about the specified Outpost.
responses:
# --- truncated at 32 KB (137 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-outposts/refs/heads/main/openapi/amazon-outposts-openapi.yml