@datafire/amazonaws_tagging
v4.0.0
Published
DataFire integration for AWS Resource Groups Tagging API
Downloads
16
Readme
@datafire/amazonaws_tagging
Client library for AWS Resource Groups Tagging API
Installation and Usage
npm install --save datafire @datafire/amazonaws_tagging
let datafire = require('datafire');
let amazonaws_tagging = require('@datafire/amazonaws_tagging').create({
accessKeyId: "",
secretAccessKey: "",
region: "",
});
amazonaws_tagging.GetResources({}).then(data => {
console.log(data);
})
Description
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. Tagging can help you organize your resources and enables you to simplify resource management, access management and cost allocation. For more information about tagging, see Working with Tag Editor and Working with Resource Groups. For more information about permissions you need to use the resource groups tagging APIs, see Obtaining Permissions for Resource Groups and Obtaining Permissions for Tagging . You can use the resource groups tagging APIs 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 Not all resources can have tags. For a lists of resources that you can tag, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide. To make full use of the resource groups tagging APIs, you might need additional IAM permissions, including permission to access the resources of individual services as well as permission to view and apply tags to those resources. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.
Actions
GetResources
amazonaws_tagging.GetResources({}, context)
Parameters
- ResourcesPerPage (string)
- PaginationToken (string)
- PaginationToken (string)
- ResourceTypeFilters (array)
- ResourcesPerPage (integer)
- TagFilters (array)
- TagsPerPage (integer)
GetTagKeys
amazonaws_tagging.GetTagKeys({}, context)
Parameters
- PaginationToken (string)
- PaginationToken (string)
GetTagValues
amazonaws_tagging.GetTagValues({
"Key": ""
}, context)
Parameters
- PaginationToken (string)
- Key (string) required
- PaginationToken (string)
TagResources
amazonaws_tagging.TagResources({
"ResourceARNList": [],
"Tags": []
}, context)
Parameters
- ResourceARNList (array) required
- Tags (array) required
UntagResources
amazonaws_tagging.UntagResources({
"ResourceARNList": [],
"TagKeys": []
}, context)
Parameters
- ResourceARNList (array) required
- TagKeys (array) required