AWS.ResourceGroups — 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.

Overview

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

Service Description

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.

Sending a Request Using ResourceGroups

var resourcegroups = new AWS.ResourceGroups();
resourcegroups.createGroup(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 ResourceGroups object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var resourcegroups = new AWS.ResourceGroups({apiVersion: '2017-11-27'});

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

AWS.config.apiVersions = {
  resourcegroups: '2017-11-27',
  // other service API versions
};

var resourcegroups = new AWS.ResourceGroups();

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

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

Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups.

Minimum permissions

To run this command, you must have the following permissions:

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

Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

Minimum permissions

To run this command, you must have the following permissions:

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

Retrieves the current status of optional features in Resource Groups.

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

Returns information about a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

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

Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups.

Minimum permissions

To run this command, you must have the following permissions:

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

Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups.

Minimum permissions

To run this command, you must have the following permissions:

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

Returns a list of tags that are associated with a resource group, specified by an ARN.

Minimum permissions

To run this command, you must have the following permissions:

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

Adds the specified resources to the specified group.

You can use this operation with only resource groups that are configured with the following types:

Other resource group type and resource types aren't currently supported by this operation.

Minimum permissions

To run this command, you must have the following permissions:

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

Returns a list of ARNs of the resources that are members of a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

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

Returns a list of existing Resource Groups in your account.

Minimum permissions

To run this command, you must have the following permissions:

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

Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update.

Minimum permissions

To run this command, you must have the following permissions:

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

Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

Minimum permissions

To run this command, you must have the following permissions:

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

Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Minimum permissions

To run this command, you must have the following permissions:

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

Removes the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries.

Minimum permissions

To run this command, you must have the following permissions:

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

Deletes tags from a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

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

Turns on or turns off optional features in Resource Groups.

The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You can call the GetAccountSettings operation to check for completion by looking for GroupLifecycleEventsStatus to change to ACTIVE.

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

Updates the description for an existing group. You cannot update the name of a resource group.

Minimum permissions

To run this command, you must have the following permissions:

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

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups.

Minimum permissions

To run this command, you must have the following permissions: