@aws-sdk/client-resource-groups

Description

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

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service
databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A
resource group is a collection of resources that match the resource types specified in a
query, and share one or more tags or portions of tags. You can create a group of
resources based on their roles in your cloud infrastructure, lifecycle stages, regions,
application layers, or virtually any criteria. Resource Groups enable you to automate management
tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in
Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in
Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member
resources.

To create a resource group, build a resource query, and specify tags that identify the
criteria that members of the group have in common. Tags are key-value pairs.

For more information about Resource Groups, see the Resource Groups User Guide.

Resource Groups uses a REST-compliant API that you can use to perform the following types of
operations.

• 
  

  Create, Read, Update, and Delete (CRUD) operations on resource groups and
  resource query entities

  
  


• 
  

  Applying, editing, and removing tags from resource groups

  
  


• 
  

  Resolving resource group member Amazon resource names (ARN)s so they can be returned as search
  results

  
  


• 
  

  Getting data about resources that are members of a group

  
  


• 
  

  Searching Amazon Web Services resources based on a resource query

  
  

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { ResourceGroupsClient, ListGroupsCommand } = require("@aws-sdk/client-resource-groups");
`

`ts
// ES6+ example
import { ResourceGroupsClient, ListGroupsCommand } from "@aws-sdk/client-resource-groups";
`

$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 ResourceGroupsClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListGroupsCommand(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-resource-groups";
const client = new AWS.ResourceGroups({ region: "REGION" });

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

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

// callbacks.
client.listGroups(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-resource-groups` 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)

CancelTagSyncTask

Command API Reference / Input / Output

CreateGroup

Command API Reference / Input / Output

DeleteGroup

Command API Reference / Input / Output

GetAccountSettings

Command API Reference / Input / Output

GetGroup

Command API Reference / Input / Output

GetGroupConfiguration

Command API Reference / Input / Output

GetGroupQuery

Command API Reference / Input / Output

GetTags

Command API Reference / Input / Output

GetTagSyncTask

Command API Reference / Input / Output

GroupResources

Command API Reference / Input / Output

ListGroupingStatuses

Command API Reference / Input / Output

ListGroupResources

Command API Reference / Input / Output

ListGroups

Command API Reference / Input / Output

ListTagSyncTasks

Command API Reference / Input / Output

PutGroupConfiguration

Command API Reference / Input / Output

SearchResources

Command API Reference / Input / Output

StartTagSyncTask

Command API Reference / Input / Output

Tag

Command API Reference / Input / Output

UngroupResources

Command API Reference / Input / Output

Untag

Command API Reference / Input / Output

UpdateAccountSettings

Command API Reference / Input / Output

UpdateGroup

Command API Reference / Input / Output

UpdateGroupQuery

Command API Reference / Input / Output