@aws-sdk/client-resource-explorer-2
Description
AWS SDK for JavaScript ResourceExplorer2 Client for Node.js, Browser and React Native.
Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can
explore your resources using an internet search engine-like experience. Examples of
resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB
tables. You can search for your resources using resource metadata like names, tags, and
IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn
the service on, to simplify your cross-Region workloads.
Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which
you turn on Resource Explorer. Resource Explorer creates
and maintains an index in each Region, with the details of that Region's
resources.
You can search across all of the
indexed Regions in your account by designating one of your Amazon Web Services Regions to
contain the aggregator index for the account. When you promote a local index
in a Region to become the aggregator index for the account, Resource Explorer automatically
replicates the index information from all local indexes in the other Regions to the
aggregator index. Therefore, the Region with the aggregator index has a copy of all resource
information for all Regions in the account where you turned on Resource Explorer. As a result,
views in the aggregator index Region include resources from all of the indexed Regions in your
account.
For more information about Amazon Web Services Resource Explorer, including how to enable and configure the
service, see the Amazon Web Services Resource Explorer User Guide.
Installing
To install this package, simply type add or install @aws-sdk/client-resource-explorer-2
using your favorite package manager:
npm install @aws-sdk/client-resource-explorer-2
yarn add @aws-sdk/client-resource-explorer-2
pnpm add @aws-sdk/client-resource-explorer-2
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ResourceExplorer2Client
and
the commands you need, for example ListIndexesCommand
:
const { ResourceExplorer2Client, ListIndexesCommand } = require("@aws-sdk/client-resource-explorer-2");
import { ResourceExplorer2Client, ListIndexesCommand } from "@aws-sdk/client-resource-explorer-2";
Usage
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.
const client = new ResourceExplorer2Client({ region: "REGION" });
const params = {
};
const command = new ListIndexesCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} 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.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, 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
import * as AWS from "@aws-sdk/client-resource-explorer-2";
const client = new AWS.ResourceExplorer2({ region: "REGION" });
try {
const data = await client.listIndexes(params);
} catch (error) {
}
client
.listIndexes(params)
.then((data) => {
})
.catch((error) => {
});
client.listIndexes(params, (err, data) => {
});
Troubleshooting
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
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.
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-resource-explorer-2
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)
AssociateDefaultView
Command API Reference / Input / Output
BatchGetView
Command API Reference / Input / Output
CreateIndex
Command API Reference / Input / Output
CreateView
Command API Reference / Input / Output
DeleteIndex
Command API Reference / Input / Output
DeleteView
Command API Reference / Input / Output
DisassociateDefaultView
Command API Reference / Input / Output
GetAccountLevelServiceConfiguration
Command API Reference / Input / Output
GetDefaultView
Command API Reference / Input / Output
GetIndex
Command API Reference / Input / Output
GetManagedView
Command API Reference / Input / Output
GetView
Command API Reference / Input / Output
ListIndexes
Command API Reference / Input / Output
ListIndexesForMembers
Command API Reference / Input / Output
ListManagedViews
Command API Reference / Input / Output
ListResources
Command API Reference / Input / Output
ListSupportedResourceTypes
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ListViews
Command API Reference / Input / Output
Search
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateIndexType
Command API Reference / Input / Output
UpdateView
Command API Reference / Input / Output