OutpostsClient

Suggest an Edit

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.

Installation

NPM
npm install @aws-sdk/client-outposts
Yarn
yarn add @aws-sdk/client-outposts
pnpm
pnpm add @aws-sdk/client-outposts

OutpostsClient Operations

Command
Summary
CancelCapacityTaskCommand

Cancels the capacity task.

CancelOrderCommand

Cancels the specified order for an Outpost.

CreateOrderCommand

Creates an order for an Outpost.

CreateOutpostCommand

Creates an Outpost.

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

CreateSiteCommand

Creates a site for an Outpost.

DeleteOutpostCommand

Deletes the specified Outpost.

DeleteSiteCommand

Deletes the specified site.

GetCapacityTaskCommand

Gets details of the specified capacity task.

GetCatalogItemCommand

Gets information about the specified catalog item.

GetConnectionCommand

Amazon Web Services uses this action to install Outpost servers.

Gets information about the specified connection.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts  and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail  in the Amazon Web Services Outposts User Guide.

GetOrderCommand

Gets information about the specified order.

GetOutpostCommand

Gets information about the specified Outpost.

GetOutpostInstanceTypesCommand

Gets the instance types for the specified Outpost.

GetOutpostSupportedInstanceTypesCommand

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.

GetSiteAddressCommand

Gets the site address of the specified site.

GetSiteCommand

Gets information about the specified Outpost site.

ListAssetInstancesCommand

A list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost. Does not include Amazon EBS or Amazon S3 instances.

ListAssetsCommand

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.

ListBlockingInstancesForCapacityTaskCommand

A 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 you cannot stop to free up capacity to run the capacity task.

ListCapacityTasksCommand

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.

ListCatalogItemsCommand

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.

ListOrdersCommand

Lists the Outpost orders for your Amazon Web Services account.

ListOutpostsCommand

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.

ListSitesCommand

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.

ListTagsForResourceCommand

Lists the tags for the specified resource.

StartCapacityTaskCommand

Starts the specified capacity task. You can have one active capacity task for each order and each Outpost.

StartConnectionCommand

Amazon Web Services uses this action to install Outpost servers.

Starts the connection required for Outpost server installation.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts  and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail  in the Amazon Web Services Outposts User Guide.

TagResourceCommand

Adds tags to the specified resource.

UntagResourceCommand

Removes tags from the specified resource.

UpdateOutpostCommand

Updates an Outpost.

UpdateSiteAddressCommand

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.

UpdateSiteCommand

Updates the specified site.

UpdateSiteRackPhysicalPropertiesCommand

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.

OutpostsClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: OutpostsClientConfig