Amazon Web Services, Inc.

AWS Resource Groups

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases,…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service
databases, and Amazon Simple Storage Service 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 Amazon Web Services Systems Manager Automation documents, on tag-related resources in
Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in
Amazon Web Services Systems Manager that shows 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 Resource Groups User Guide .
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 Amazon resource names (ARN)s so they can be returned as search
results

Getting data about resources that are members of a group

Searching Amazon Web Services resources based on a resource query

Endpoints 23

  • POSTCancel tag sync task/cancel-tag-sync-taskCancels the specified tag-sync task. Minimum permissions To run this command, you must have the following permissions: resource-groups:CancelTagSyncTask on…
  • POSTCreate group/groupsCreates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more…
  • POSTDelete group/delete-groupDeletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group…
  • POSTGet account settings/get-account-settingsRetrieves the current status of optional features in Resource Groups.
  • POSTGet group/get-groupReturns information about a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroup
  • POSTGet group configuration/get-group-configurationRetrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service…
  • POSTGet group query/get-group-queryRetrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in…
  • POSTGet tag sync task/get-tag-sync-taskReturns information about a specified tag-sync task. Minimum permissions To run this command, you must have the following permissions:…
  • GETGet tags/resources/:Arn/tagsReturns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN). Minimum permissions To run this command, you…
  • PUTTag/resources/:Arn/tagsAdds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource group are not changed if they are not specified in…
  • PATCHUntag/resources/:Arn/tagsDeletes tags from a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:Untag
  • POSTGroup resources/group-resourcesAdds the specified resources to the specified group. You can only use this operation with the following groups: AWS::EC2::HostManagement…
  • POSTList group resources/list-group-resourcesReturns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group. Minimum permissions To run this command, you…
  • POSTList grouping statuses/list-grouping-statusesReturns the status of the last grouping or ungrouping action for each resource in the specified application group.
  • POSTList groups/groups-list?maxResults=0&nextToken=stringReturns a list of existing Resource Groups in your account. Minimum permissions To run this command, you must have the following permissions:…
  • POSTList tag sync tasks/list-tag-sync-tasksReturns a list of tag-sync tasks. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListTagSyncTasks with the…
  • POSTPut group configuration/put-group-configurationAttaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check…
  • POSTSearch resources/resources/searchReturns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a…
  • POSTStart tag sync task/start-tag-sync-taskCreates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application. To start a tag-sync task, you need a…
  • POSTUngroup resources/ungroup-resourcesRemoves the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation.…
  • POSTUpdate account settings/update-account-settingsTurns on or turns off optional features in Resource Groups. The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS .…
  • POSTUpdate group/update-groupUpdates the description for an existing group. You cannot update the name of a resource group. Minimum permissions To run this command, you must have the…
  • POSTUpdate group query/update-group-queryUpdates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups . Minimum permissions To…

API details

Base URL
https://resource-groups.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
23 operations on 21 pathsPOST 20GET 1PUT 1PATCH 1
Description format
AWS Smithy model, API version 2017-11-27

How to test the AWS Resource Groups in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Resource Groups collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Cancel tag sync task” (POST /cancel-tag-sync-task), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Resource Groups?

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases,… It is listed under Developer tools and has 23 endpoints.

Who publishes the AWS Resource Groups?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Resource Groups?

Requests go to https://resource-groups.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Resource Groups?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Resource Groups have?

23 operations on 21 paths (20 POST, 1 GET, 1 PUT, 1 PATCH).

Is forking the AWS Resource Groups free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.