@datafire/amazonaws_resourcegroupstaggingapi v5.0.0

@datafire/amazonaws_resourcegroupstaggingapi

Client library for AWS Resource Groups Tagging API

Installation and Usage

npm install --save @datafire/amazonaws_resourcegroupstaggingapi

let amazonaws_resourcegroupstaggingapi = require('@datafire/amazonaws_resourcegroupstaggingapi').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_resourcegroupstaggingapi.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_resourcegroupstaggingapi.GetResources({}, context)

Input

• input object
  • ResourcesPerPage string
  • PaginationToken string
  • PaginationToken PaginationToken
  • ResourceTypeFilters ResourceTypeFilterList
  • ResourcesPerPage ResourcesPerPage
  • TagFilters TagFilterList
  • TagsPerPage TagsPerPage

Output

• output GetResourcesOutput

GetTagKeys

amazonaws_resourcegroupstaggingapi.GetTagKeys({}, context)

Input

• input object
  • PaginationToken string
  • PaginationToken PaginationToken

Output

• output GetTagKeysOutput

GetTagValues

amazonaws_resourcegroupstaggingapi.GetTagValues({
  "Key": ""
}, context)

Input

• input object
  • PaginationToken string
  • Key required TagKey
  • PaginationToken PaginationToken

Output

• output GetTagValuesOutput

TagResources

amazonaws_resourcegroupstaggingapi.TagResources({
  "ResourceARNList": [],
  "Tags": []
}, context)

Input

• input object
  • ResourceARNList required ResourceARNList
  • Tags required TagMap

Output

• output TagResourcesOutput

UntagResources

amazonaws_resourcegroupstaggingapi.UntagResources({
  "ResourceARNList": [],
  "TagKeys": []
}, context)

Input

• input object
  • ResourceARNList required ResourceARNList
  • TagKeys required TagKeyListForUntag

Output

• output UntagResourcesOutput

Definitions

AmazonResourceType

• AmazonResourceType string

ErrorCode

• ErrorCode string (values: InternalServiceException, InvalidParameterException)

ErrorMessage

• ErrorMessage string

ExceptionMessage

• ExceptionMessage string

FailedResourcesMap

• FailedResourcesMap array
  • items object
    • key ResourceARN
    • value FailureInfo

FailureInfo

• FailureInfo object: Details of the common errors that all actions return.
  • ErrorCode ErrorCode
  • ErrorMessage ErrorMessage
  • StatusCode StatusCode

GetResourcesInput

• GetResourcesInput object
  • PaginationToken PaginationToken
  • ResourceTypeFilters ResourceTypeFilterList
  • ResourcesPerPage ResourcesPerPage
  • TagFilters TagFilterList
  • TagsPerPage TagsPerPage

GetResourcesOutput

• GetResourcesOutput object
  • PaginationToken PaginationToken
  • ResourceTagMappingList ResourceTagMappingList

GetTagKeysInput

• GetTagKeysInput object
  • PaginationToken PaginationToken

GetTagKeysOutput

• GetTagKeysOutput object
  • PaginationToken PaginationToken
  • TagKeys TagKeyList

GetTagValuesInput

• GetTagValuesInput object
  • Key required TagKey
  • PaginationToken PaginationToken

GetTagValuesOutput

• GetTagValuesOutput object
  • PaginationToken PaginationToken
  • TagValues TagValuesOutputList

InternalServiceException

• InternalServiceException object: The request processing failed because of an unknown error, exception, or failure. You can retry the request.
  • Message ExceptionMessage

InvalidParameterException

• InvalidParameterException object: A parameter is missing or a malformed string or invalid or out-of-range value was supplied for the request parameter.
  • Message ExceptionMessage

PaginationToken

• PaginationToken string

PaginationTokenExpiredException

• PaginationTokenExpiredException object: A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.
  • Message ExceptionMessage

ResourceARN

• ResourceARN string

ResourceARNList

• ResourceARNList array
  • items ResourceARN

ResourceTagMapping

• ResourceTagMapping object: A list of resource ARNs and the tags (keys and values) that are associated with each.
  • ResourceARN ResourceARN
  • Tags TagList

ResourceTagMappingList

• ResourceTagMappingList array
  • items ResourceTagMapping

ResourceTypeFilterList

• ResourceTypeFilterList array
  • items AmazonResourceType

ResourcesPerPage

• ResourcesPerPage integer

StatusCode

• StatusCode integer

Tag

• Tag object: The metadata that you apply to AWS resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see Tag Basics in the Amazon EC2 User Guide for Linux Instances.
  • Key required TagKey
  • Value required TagValue

TagFilter

• TagFilter object: A list of tags (keys and values) that are used to specify the associated resources.
  • Key TagKey
  • Values TagValueList

TagFilterList

• TagFilterList array
  • items TagFilter

TagKey

• TagKey string

TagKeyList

• TagKeyList array
  • items TagKey

TagKeyListForUntag

• TagKeyListForUntag array
  • items TagKey

TagList

• TagList array
  • items Tag

TagMap

• TagMap array
  • items object
    • key TagKey
    • value TagValue

TagResourcesInput

• TagResourcesInput object
  • ResourceARNList required ResourceARNList
  • Tags required TagMap

TagResourcesOutput

• TagResourcesOutput object
  • FailedResourcesMap FailedResourcesMap

TagValue

• TagValue string

TagValueList

• TagValueList array
  • items TagValue

TagValuesOutputList

• TagValuesOutputList array
  • items TagValue

TagsPerPage

• TagsPerPage integer

ThrottledException

• ThrottledException object: The request was denied to limit the frequency of submitted requests.
  • Message ExceptionMessage

UntagResourcesInput

• UntagResourcesInput object
  • ResourceARNList required ResourceARNList
  • TagKeys required TagKeyListForUntag

UntagResourcesOutput

• UntagResourcesOutput object
  • FailedResourcesMap FailedResourcesMap