@aws-sdk/client-outposts

Description

AWS SDK for JavaScript Outposts Client for Node.js, Browser and React Native.

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.

Installing

To install this package, simply type add or install @aws-sdk/client-outposts
using your favorite package manager:
- npm install @aws-sdk/client-outposts
- yarn add @aws-sdk/client-outposts
- pnpm add @aws-sdk/client-outposts

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the OutpostsClient and
the commands you need, for example ListOrdersCommand:

``js
// ES5 example
const { OutpostsClient, ListOrdersCommand } = require("@aws-sdk/client-outposts");
`

`ts
// ES6+ example
import { OutpostsClient, ListOrdersCommand } from "@aws-sdk/client-outposts";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new OutpostsClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListOrdersCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-outposts";
const client = new AWS.Outposts({ region: "REGION" });

// async/await.
try {
const data = await client.listOrders(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listOrders(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listOrders(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-outposts` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

CancelCapacityTask

Command API Reference / Input / Output

CancelOrder

Command API Reference / Input / Output

CreateOrder

Command API Reference / Input / Output

CreateOutpost

Command API Reference / Input / Output

CreateSite

Command API Reference / Input / Output

DeleteOutpost

Command API Reference / Input / Output

DeleteSite

Command API Reference / Input / Output

GetCapacityTask

Command API Reference / Input / Output

GetCatalogItem

Command API Reference / Input / Output

GetConnection

Command API Reference / Input / Output

GetOrder

Command API Reference / Input / Output

GetOutpost

Command API Reference / Input / Output

GetOutpostBillingInformation

Command API Reference / Input / Output

GetOutpostInstanceTypes

Command API Reference / Input / Output

GetOutpostSupportedInstanceTypes

Command API Reference / Input / Output

GetSite

Command API Reference / Input / Output

GetSiteAddress

Command API Reference / Input / Output

ListAssetInstances

Command API Reference / Input / Output

ListAssets

Command API Reference / Input / Output

ListBlockingInstancesForCapacityTask

Command API Reference / Input / Output

ListCapacityTasks

Command API Reference / Input / Output

ListCatalogItems

Command API Reference / Input / Output

ListOrders

Command API Reference / Input / Output

ListOutposts

Command API Reference / Input / Output

ListSites

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

StartCapacityTask

Command API Reference / Input / Output

StartConnection

Command API Reference / Input / Output

StartOutpostDecommission

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateOutpost

Command API Reference / Input / Output

UpdateSite

Command API Reference / Input / Output

UpdateSiteAddress

Command API Reference / Input / Output

UpdateSiteRackPhysicalProperties

Command API Reference / Input / Output