@aws-sdk/client-resource-groups-tagging-api
Advanced tools
AWS SDK for JavaScript Resource Groups Tagging Api Client for Node.js, Browser and React Native
AWS SDK for JavaScript ResourceGroupsTaggingAPI Client for Node.js, Browser and React Native.
Resource Groups Tagging API
This guide describes the API operations for the resource groups tagging.
A tag is a label that you assign to an AWS resource. A tag consists of a key and a value, both of which you define. For example, if you have two Amazon EC2 instances, you might assign both a tag key of "Stack." But the value of "Stack" might be "Testing" for one and "Production" for the other.
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.
Tagging can help you organize your resources and enables you to simplify resource management, access management and cost allocation.
You can use the resource groups tagging API operations to complete the following tasks:
Tag and untag supported resources located in the specified Region for the AWS account.
Use tag-based filters to search for resources located in the specified Region for the AWS account.
List all existing tag keys in the specified Region for the AWS account.
List all existing values for the specified key in the specified Region for the AWS account.
To use resource groups tagging API operations, you must add the following permissions to your IAM policy:
tag:GetResources
tag:TagResources
tag:UntagResources
tag:GetTagKeys
tag:GetTagValues
You'll also need permissions to access the resources of individual services so that you can tag and untag those resources.
For more information on IAM policies, see Managing IAM Policies in the IAM User Guide.
Services that support the Resource Groups Tagging API
You can use the Resource Groups Tagging API to tag resources for the following AWS services.
To install the this package, simply type add or install @aws-sdk/client-resource-groups-tagging-api using your favorite package manager:
npm install @aws-sdk/client-resource-groups-tagging-apiyarn add @aws-sdk/client-resource-groups-tagging-apipnpm add @aws-sdk/client-resource-groups-tagging-apiThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ResourceGroupsTaggingAPIClient and
the commands you need, for example DescribeReportCreationCommand:
// ES5 example
const {
ResourceGroupsTaggingAPIClient,
DescribeReportCreationCommand,
} = require("@aws-sdk/client-resource-groups-tagging-api");
// ES6+ example
import {
ResourceGroupsTaggingAPIClient,
DescribeReportCreationCommand,
} from "@aws-sdk/client-resource-groups-tagging-api";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by difference commands.
const client = new ResourceGroupsTaggingAPIClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new DescribeReportCreationCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// 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.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// proccess err and data.
});
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-groups-tagging-api";
const client = new AWS.ResourceGroupsTaggingAPI({ region: "REGION" });
// async/await.
try {
const data = client.describeReportCreation(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.describeReportCreation(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.describeReportCreation(params, (err, data) => {
// proccess err and data.
});
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);
// 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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-resource-groups-tagging-api package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.4.0 (2021-01-28)
FAQs
AWS SDK for JavaScript Resource Groups Tagging Api Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-resource-groups-tagging-api receives a total of 92,205 weekly downloads. As such, @aws-sdk/client-resource-groups-tagging-api popularity was classified as popular.
We found that @aws-sdk/client-resource-groups-tagging-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.