AWS.Outposts — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Outposts

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service 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.

Sending a Request Using Outposts

var outposts = new AWS.Outposts();
outposts.cancelCapacityTask(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Outposts object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var outposts = new AWS.Outposts({apiVersion: '2019-12-03'});

You can also set the API version globally in AWS.config.apiVersions using the outposts service identifier:

AWS.config.apiVersions = {
  outposts: '2019-12-03',
  // other service API versions
};

var outposts = new AWS.Outposts();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Outposts(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelCapacityTask(params = {}, callback) ⇒ AWS.Request

Cancels the capacity task.

cancelOrder(params = {}, callback) ⇒ AWS.Request

Cancels the specified order for an Outpost.

createOrder(params = {}, callback) ⇒ AWS.Request

Creates an order for an Outpost.

createOutpost(params = {}, callback) ⇒ AWS.Request

Creates an Outpost.

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

createSite(params = {}, callback) ⇒ AWS.Request

Creates a site for an Outpost.

deleteOutpost(params = {}, callback) ⇒ AWS.Request

Deletes the specified Outpost.

deleteSite(params = {}, callback) ⇒ AWS.Request

Deletes the specified site.

getCapacityTask(params = {}, callback) ⇒ AWS.Request

Gets details of the specified capacity task.

getCatalogItem(params = {}, callback) ⇒ AWS.Request

Gets information about the specified catalog item.

getConnection(params = {}, callback) ⇒ AWS.Request

getOrder(params = {}, callback) ⇒ AWS.Request

Gets information about the specified order.

getOutpost(params = {}, callback) ⇒ AWS.Request

Gets information about the specified Outpost.

getOutpostInstanceTypes(params = {}, callback) ⇒ AWS.Request

Gets the instance types for the specified Outpost.

getOutpostSupportedInstanceTypes(params = {}, callback) ⇒ AWS.Request

Gets the instance types that an Outpost can support in InstanceTypeCapacity. This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.

getSite(params = {}, callback) ⇒ AWS.Request

Gets information about the specified Outpost site.

getSiteAddress(params = {}, callback) ⇒ AWS.Request

Gets the site address of the specified site.

listAssets(params = {}, callback) ⇒ AWS.Request

Lists the hardware assets for the specified Outpost.

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.

listCapacityTasks(params = {}, callback) ⇒ AWS.Request

Lists the capacity tasks for your Amazon Web Services account.

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.

listCatalogItems(params = {}, callback) ⇒ AWS.Request

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 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.

listOrders(params = {}, callback) ⇒ AWS.Request

Lists the Outpost orders for your Amazon Web Services account.

listOutposts(params = {}, callback) ⇒ AWS.Request

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 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.

listSites(params = {}, callback) ⇒ AWS.Request

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 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.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for the specified resource.

startCapacityTask(params = {}, callback) ⇒ AWS.Request

Starts the specified capacity task. You can have one active capacity task for an order.

startConnection(params = {}, callback) ⇒ AWS.Request

tagResource(params = {}, callback) ⇒ AWS.Request

Adds tags to the specified resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from the specified resource.

updateOutpost(params = {}, callback) ⇒ AWS.Request

updateSite(params = {}, callback) ⇒ AWS.Request

Updates the specified site.

updateSiteAddress(params = {}, callback) ⇒ AWS.Request

Updates 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 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.

updateSiteRackPhysicalProperties(params = {}, callback) ⇒ AWS.Request

Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order.