@datafire/amazonaws_resource_groups

Client library for AWS Resource Groups

Installation and Usage

npm install --save @datafire/amazonaws_resource_groups

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

amazonaws_resource_groups.ListGroups({}).then(data => {
  console.log(data);
});

Description

AWS Resource Groups AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service databases, and Amazon S3 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 AWS Systems Manager Automation documents, on tag-related resources in AWS Systems Manager. Groups of tagged resources also let you quickly view a custom console in AWS Systems Manager that shows AWS 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 AWS Resource Groups User Guide. AWS Resource Groups uses a REST-compliant API that you can use to perform the following types of operations. Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities Applying, editing, and removing tags from resource groups Resolving resource group member ARNs so they can be returned as search results Getting data about resources that are members of a group Searching AWS resources based on a resource query

Actions

ListGroups

amazonaws_resource_groups.ListGroups({}, context)

Input

• input object
  • MaxResults string
  • NextToken string

Output

• output ListGroupsOutput

CreateGroup

amazonaws_resource_groups.CreateGroup({
  "Name": "",
  "ResourceQuery": {
    "Type": "",
    "Query": ""
  }
}, context)

Input

• input object
  • Description GroupDescription
  • Name required GroupName
  • ResourceQuery required ResourceQuery
  • Tags Tags

Output

• output CreateGroupOutput

DeleteGroup

amazonaws_resource_groups.DeleteGroup({
  "GroupName": ""
}, context)

Input

• input object
  • GroupName required string

Output

• output DeleteGroupOutput

GetGroup

amazonaws_resource_groups.GetGroup({
  "GroupName": ""
}, context)

Input

• input object
  • GroupName required string

Output

• output GetGroupOutput

UpdateGroup

amazonaws_resource_groups.UpdateGroup({
  "GroupName": ""
}, context)

Input

• input object
  • GroupName required string
  • Description GroupDescription

Output

• output UpdateGroupOutput

GetGroupQuery

amazonaws_resource_groups.GetGroupQuery({
  "GroupName": ""
}, context)

Input

• input object
  • GroupName required string

Output

• output GetGroupQueryOutput

UpdateGroupQuery

amazonaws_resource_groups.UpdateGroupQuery({
  "GroupName": "",
  "ResourceQuery": {
    "Type": "",
    "Query": ""
  }
}, context)

Input

• input object
  • GroupName required string
  • ResourceQuery required ResourceQuery

Output

• output UpdateGroupQueryOutput

ListGroupResources

amazonaws_resource_groups.ListGroupResources({
  "GroupName": ""
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • GroupName required string

Output

• output ListGroupResourcesOutput

SearchResources

amazonaws_resource_groups.SearchResources({
  "ResourceQuery": {
    "Type": "",
    "Query": ""
  }
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults MaxResults
  • NextToken NextToken
  • ResourceQuery required ResourceQuery

Output

• output SearchResourcesOutput

GetTags

amazonaws_resource_groups.GetTags({
  "Arn": ""
}, context)

Input

• input object
  • Arn required string

Output

• output GetTagsOutput

Untag

amazonaws_resource_groups.Untag({
  "Arn": "",
  "Keys": []
}, context)

Input

• input object
  • Arn required string
  • Keys required TagKeyList

Output

• output UntagOutput

Tag

amazonaws_resource_groups.Tag({
  "Arn": "",
  "Tags": []
}, context)

Input

• input object
  • Arn required string
  • Tags required Tags

Output

• output TagOutput

Definitions

BadRequestException

• BadRequestException object: The request does not comply with validation rules that are defined for the request parameters.
  • Message ErrorMessage

CreateGroupInput

• CreateGroupInput object
  • Description GroupDescription
  • Name required GroupName
  • ResourceQuery required ResourceQuery
  • Tags Tags

CreateGroupOutput

• CreateGroupOutput object
  • Group Group
  • ResourceQuery ResourceQuery
  • Tags Tags

DeleteGroupInput

• DeleteGroupInput object

DeleteGroupOutput

• DeleteGroupOutput object
  • Group Group

ErrorMessage

• ErrorMessage string

ForbiddenException

• ForbiddenException object: The caller is not authorized to make the request.
  • Message ErrorMessage

GetGroupInput

• GetGroupInput object

GetGroupOutput

• GetGroupOutput object
  • Group Group

GetGroupQueryInput

• GetGroupQueryInput object

GetGroupQueryOutput

• GetGroupQueryOutput object
  • GroupQuery GroupQuery

GetTagsInput

• GetTagsInput object

GetTagsOutput

• GetTagsOutput object
  • Arn GroupArn
  • Tags Tags

Group

• Group object: A resource group.
  • Description GroupDescription
  • GroupArn required GroupArn
  • Name required GroupName

GroupArn

• GroupArn string

GroupDescription

• GroupDescription string

GroupList

• GroupList array
  • items Group

GroupName

• GroupName string

GroupQuery

• GroupQuery object: The underlying resource query of a resource group. Resources that match query results are part of the group.
  • GroupName required GroupName
  • ResourceQuery required ResourceQuery

InternalServerErrorException

• InternalServerErrorException object: An internal error occurred while processing the request.
  • Message ErrorMessage

ListGroupResourcesInput

• ListGroupResourcesInput object

ListGroupResourcesOutput

• ListGroupResourcesOutput object
  • NextToken NextToken
  • ResourceIdentifiers ResourceIdentifierList

ListGroupsInput

• ListGroupsInput object

ListGroupsOutput

• ListGroupsOutput object
  • Groups GroupList
  • NextToken NextToken

MaxResults

• MaxResults integer

MethodNotAllowedException

• MethodNotAllowedException object: The request uses an HTTP method which is not allowed for the specified resource.
  • Message ErrorMessage

NextToken

• NextToken string

NotFoundException

• NotFoundException object: One or more resources specified in the request do not exist.
  • Message ErrorMessage

Query

• Query string

QueryType

• QueryType string (values: TAG_FILTERS_1_0)

ResourceArn

• ResourceArn string

ResourceIdentifier

• ResourceIdentifier object: The ARN of a resource, and its resource type.
  • ResourceArn ResourceArn
  • ResourceType ResourceType

ResourceIdentifierList

• ResourceIdentifierList array
  • items ResourceIdentifier

ResourceQuery

• ResourceQuery object: The query that is used to define a resource group or a search for resources.
  • Query required Query
  • Type required QueryType

ResourceType

• ResourceType string

SearchResourcesInput

• SearchResourcesInput object
  • MaxResults MaxResults
  • NextToken NextToken
  • ResourceQuery required ResourceQuery

SearchResourcesOutput

• SearchResourcesOutput object
  • NextToken NextToken
  • ResourceIdentifiers ResourceIdentifierList

TagInput

• TagInput object
  • Tags required Tags

TagKey

• TagKey string

TagKeyList

• TagKeyList array
  • items TagKey

TagOutput

• TagOutput object
  • Arn GroupArn
  • Tags Tags

TagValue

• TagValue string

Tags

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

TooManyRequestsException

• TooManyRequestsException object: The caller has exceeded throttling limits.
  • Message ErrorMessage

UnauthorizedException

• UnauthorizedException object: The request has not been applied because it lacks valid authentication credentials for the target resource.
  • Message ErrorMessage

UntagInput

• UntagInput object
  • Keys required TagKeyList

UntagOutput

• UntagOutput object
  • Arn GroupArn
  • Keys TagKeyList

UpdateGroupInput

• UpdateGroupInput object
  • Description GroupDescription

UpdateGroupOutput

• UpdateGroupOutput object
  • Group Group

UpdateGroupQueryInput

• UpdateGroupQueryInput object
  • ResourceQuery required ResourceQuery

UpdateGroupQueryOutput

• UpdateGroupQueryOutput object
  • GroupQuery GroupQuery