Amazon Web Services, Inc.

AWS Outposts

Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.
You can use certain Amazon EC2 API actions for Amazon Web Services Outposts. For more information on these API actions, see Amazon Web Services Outposts actions in the Amazon EC2 API Reference .

Endpoints 45

  • GETGet capacity task/outposts/:OutpostIdentifier/capacity/:CapacityTaskIdGets details of the specified capacity task.
  • POSTCancel capacity task/outposts/:OutpostIdentifier/capacity/:CapacityTaskIdCancels the capacity task.
  • POSTCancel order/orders/:OrderId/cancelCancels the specified order for an Outpost.
  • POSTCreate order/ordersCreates an order for an Outpost.
  • GETList outposts/outposts?NextToken=string&MaxResults=0&LifeCycleStatusFilter=&AvailabilityZoneFilter=&AvailabilityZoneIdFilter=Lists the Outposts for your Amazon Web Services account. Use filters to return specific results. If you specify multiple filters, the results include only the…
  • POSTCreate outpost/outpostsCreates an Outpost. You can specify either an Availability one or an AZ ID.
  • GETGet private connectivity config/outposts/:OutpostId/privateConnectivityGets the private connectivity configuration for the specified Outpost.
  • POSTCreate private connectivity config/outposts/:OutpostId/privateConnectivityCreates the private connectivity configuration for the specified Outpost. Private connectivity establishes a service link VPN connection between the Outpost…
  • GETList quotes/quotes?NextToken=string&MaxResults=0Lists the quotes for your Amazon Web Services account.
  • POSTCreate quote/quotesCreates a quote for an Outpost. A quote provides pricing and configuration options based on the requested capacity. You can optionally associate the quote…
  • POSTCreate renewal/renewalsCreates a renewal contract for the specified Outpost.
  • GETList sites/sites?NextToken=string&MaxResults=0&OperatingAddressCountryCodeFilter=&OperatingAddressStateOrRegionFilter=&OperatingAddressCityFilter=Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results. Use filters to return specific results. If you specify…
  • POSTCreate site/sitesCreates a site for an Outpost.
  • GETGet outpost/outposts/:OutpostIdGets information about the specified Outpost.
  • DELETEDelete outpost/outposts/:OutpostIdDeletes the specified Outpost.
  • PATCHUpdate outpost/outposts/:OutpostIdUpdates an Outpost.
  • GETGet quote/quotes/:QuoteIdentifierGets information about the specified quote.
  • DELETEDelete quote/quotes/:QuoteIdentifierDeletes the specified quote.
  • PATCHUpdate quote/quotes/:QuoteIdentifierUpdates the specified quote. You can modify the requested capacities, constraints, payment options, payment terms, or Outpost association.
  • GETGet site/sites/:SiteIdGets information about the specified Outpost site.
  • DELETEDelete site/sites/:SiteIdDeletes the specified site.
  • PATCHUpdate site/sites/:SiteIdUpdates the specified site.
  • GETGet catalog item/catalog/item/:CatalogItemIdGets information about the specified catalog item.
  • GETGet connection/connections/:ConnectionIdAmazon Web Services uses this action to install Outpost servers. Gets information about the specified connection. Use CloudTrail to monitor this action or…
  • GETGet order/orders/:OrderIdGets information about the specified order.
  • GETGet outpost billing information/outpost/:OutpostIdentifier/billing-information?NextToken=string&MaxResults=0Gets current and historical billing information about the specified Outpost.
  • GETGet outpost instance types/outposts/:OutpostId/instanceTypes?NextToken=string&MaxResults=0Gets the instance types for the specified Outpost.
  • GETGet outpost supported instance types/outposts/:OutpostIdentifier/supportedInstanceTypes?OrderId=string&AssetId=string&MaxResults=0&NextToken=stringGets the instance types that an Outpost can support in InstanceTypeCapacity . This will generally include instance types that are not currently configured and…
  • GETGet renewal pricing/outpost/:OutpostIdentifier/renewal-pricingGets all available renewal pricing options for the specified Outpost.
  • GETGet site address/sites/:SiteId/address?AddressType=stringGets the site address of the specified site.
  • PUTUpdate site address/sites/:SiteId/addressUpdates the address of the specified site. You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel…
  • GETList asset instances/outposts/:OutpostIdentifier/assetInstances?AssetIdFilter=&InstanceTypeFilter=&AccountIdFilter=&AwsServiceFilter=&MaxResults=0&NextToken=stringA list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost. Does not include Amazon EBS or Amazon S3 instances.
  • GETList assets/outposts/:OutpostIdentifier/assets?HostIdFilter=&MaxResults=0&NextToken=string&StatusFilter=&AssetTypeFilter=Lists the hardware assets for the specified Outpost. Use filters to return specific results. If you specify multiple filters, the results include only the…
  • GETList blocking instances for capacity task/outposts/:OutpostIdentifier/capacity/:CapacityTaskId/blockingInstances?MaxResults=0&NextToken=stringA list of Amazon EC2 instances running on the Outpost and belonging to the account that initiated the capacity task. Use this list to specify the instances…
  • GETList capacity tasks/capacity/tasks?OutpostIdentifierFilter=string&MaxResults=0&NextToken=string&CapacityTaskStatusFilter=Lists the capacity tasks for your Amazon Web Services account. Use filters to return specific results. If you specify multiple filters, the results include…
  • GETList catalog items/catalog/items?NextToken=string&MaxResults=0&ItemClassFilter=&SupportedStorageFilter=&EC2FamilyFilter=Lists the items in the catalog. Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all…
  • GETList orderable instance types/instanceTypes?OutpostGenerationFilter=string&MaxResults=0&NextToken=stringLists the instance types that can be ordered for an Outpost. You can filter the results by Outpost generation.
  • GETList orders/list-orders?OutpostIdentifierFilter=string&NextToken=string&MaxResults=0Lists the Outpost orders for your Amazon Web Services account.
  • GETList tags for resource/tags/:ResourceArnLists the tags for the specified resource.
  • POSTTag resource/tags/:ResourceArnAdds tags to the specified resource.
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Removes tags from the specified resource.
  • POSTStart capacity task/outposts/:OutpostIdentifier/capacityStarts the specified capacity task. You can have one active capacity task for each order and each Outpost.
  • POSTStart connection/connectionsAmazon Web Services uses this action to install Outpost servers. Starts the connection required for Outpost server installation. Use CloudTrail to monitor…
  • POSTStart outpost decommission/outposts/:OutpostIdentifier/decommissionStarts the decommission process to return the Outposts racks or servers.
  • PATCHUpdate site rack physical properties/sites/:SiteId/rackPhysicalPropertiesUpdate the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist…

API details

Base URL
https://outposts.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
45 operations on 31 pathsGET 24POST 12PATCH 4DELETE 4PUT 1
Description format
AWS Smithy model, API version 2019-12-03

How to test the AWS Outposts in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Outposts collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get capacity task” (GET /outposts/:OutpostIdentifier/capacity/:CapacityTaskId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Outposts?

Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing… It is listed under Developer tools and has 45 endpoints.

Who publishes the AWS Outposts?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Outposts?

Requests go to https://outposts.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Outposts?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Outposts have?

45 operations on 31 paths (24 GET, 12 POST, 4 PATCH, 4 DELETE, 1 PUT).

Is forking the AWS Outposts free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.