@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
The @aws-sdk/client-resource-groups-tagging-api package is part of the AWS SDK for JavaScript. It provides a client for interacting with the AWS Resource Groups Tagging API, which allows you to manage and query tags for your AWS resources. This can be useful for organizing, searching, and managing resources based on their tags.
ListTagsForResource
This feature allows you to list the tags for a specific AWS resource. The code sample demonstrates how to use the GetResourcesCommand to retrieve tags for a given resource ARN.
const { ResourceGroupsTaggingAPIClient, GetResourcesCommand } = require('@aws-sdk/client-resource-groups-tagging-api');
const client = new ResourceGroupsTaggingAPIClient({ region: 'us-west-2' });
const params = {
ResourceARNList: ['arn:aws:s3:::example-bucket']
};
const run = async () => {
try {
const data = await client.send(new GetResourcesCommand(params));
console.log('Tags for resource:', data.ResourceTagMappingList);
} catch (err) {
console.error(err);
}
};
run();TagResources
This feature allows you to add or update tags for specified AWS resources. The code sample demonstrates how to use the TagResourcesCommand to tag a resource with key-value pairs.
const { ResourceGroupsTaggingAPIClient, TagResourcesCommand } = require('@aws-sdk/client-resource-groups-tagging-api');
const client = new ResourceGroupsTaggingAPIClient({ region: 'us-west-2' });
const params = {
ResourceARNList: ['arn:aws:s3:::example-bucket'],
Tags: {
'Environment': 'Production',
'Department': 'Finance'
}
};
const run = async () => {
try {
const data = await client.send(new TagResourcesCommand(params));
console.log('Resources tagged successfully:', data);
} catch (err) {
console.error(err);
}
};
run();UntagResources
This feature allows you to remove tags from specified AWS resources. The code sample demonstrates how to use the UntagResourcesCommand to remove specific tags from a resource.
const { ResourceGroupsTaggingAPIClient, UntagResourcesCommand } = require('@aws-sdk/client-resource-groups-tagging-api');
const client = new ResourceGroupsTaggingAPIClient({ region: 'us-west-2' });
const params = {
ResourceARNList: ['arn:aws:s3:::example-bucket'],
TagKeys: ['Environment', 'Department']
};
const run = async () => {
try {
const data = await client.send(new UntagResourcesCommand(params));
console.log('Tags removed successfully:', data);
} catch (err) {
console.error(err);
}
};
run();GetTagKeys
This feature allows you to retrieve all tag keys in your AWS account. The code sample demonstrates how to use the GetTagKeysCommand to list all tag keys.
const { ResourceGroupsTaggingAPIClient, GetTagKeysCommand } = require('@aws-sdk/client-resource-groups-tagging-api');
const client = new ResourceGroupsTaggingAPIClient({ region: 'us-west-2' });
const run = async () => {
try {
const data = await client.send(new GetTagKeysCommand({}));
console.log('Tag keys:', data.TagKeys);
} catch (err) {
console.error(err);
}
};
run();GetTagValues
This feature allows you to retrieve all tag values for a specific tag key in your AWS account. The code sample demonstrates how to use the GetTagValuesCommand to list all values for a given tag key.
const { ResourceGroupsTaggingAPIClient, GetTagValuesCommand } = require('@aws-sdk/client-resource-groups-tagging-api');
const client = new ResourceGroupsTaggingAPIClient({ region: 'us-west-2' });
const params = {
Key: 'Environment'
};
const run = async () => {
try {
const data = await client.send(new GetTagValuesCommand(params));
console.log('Tag values for key:', data.TagValues);
} catch (err) {
console.error(err);
}
};
run();The aws-sdk package is the official AWS SDK for JavaScript. It provides a comprehensive set of tools for interacting with all AWS services, including the Resource Groups Tagging API. Compared to @aws-sdk/client-resource-groups-tagging-api, the aws-sdk package is more monolithic and includes support for all AWS services in a single package.
The aws-cdk (AWS Cloud Development Kit) is a framework for defining cloud infrastructure in code and provisioning it through AWS CloudFormation. While it is not specifically focused on tagging, it allows you to define tags as part of your infrastructure code. Compared to @aws-sdk/client-resource-groups-tagging-api, aws-cdk is more focused on infrastructure as code and less on direct API interactions.
The serverless framework is a toolkit for deploying and operating serverless architectures. It supports tagging of resources as part of its configuration. Compared to @aws-sdk/client-resource-groups-tagging-api, the serverless framework is more focused on serverless application deployment and management, with tagging being a secondary feature.
AWS SDK for JavaScript ResourceGroupsTaggingAPI Client for Node.js, Browser and React Native.
Resource Groups Tagging API
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 different 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 = await 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.
FAQs
AWS SDK for JavaScript Resource Groups Tagging Api Client for Node.js, Browser and React Native
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
Research
Socket researchers uncover how threat actors weaponize Out-of-Band Application Security Testing (OAST) techniques across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Research
A malicious npm campaign is targeting Ethereum developers by impersonating Hardhat plugins and the Nomic Foundation, stealing sensitive data like private keys.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.