resourcegroupstaggingapi: AWS Resource Groups Tagging API

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.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Tagging can help you organize your resources and enables you to simplify resource management, access management and cost allocation.

You can use the resource groups tagging API operations 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.

To use resource groups tagging API operations, you must add the following permissions to your IAM policy:

tag:GetResources
tag:TagResources
tag:UntagResources
tag:GetTagKeys
tag:GetTagValues

You'll also need permissions to access the resources of individual services so that you can tag and untag those resources.

For more information on IAM policies, see Managing IAM Policies in the IAM User Guide.

Services that support the Resource Groups Tagging API

You can use the Resource Groups Tagging API to tag resources for the following AWS services.

Usage

resourcegroupstaggingapi(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config: Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- resourcegroupstaggingapi(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

describe_report_creation	Describes the status of the StartReportCreation operation
get_compliance_summary	Returns a table that shows counts of resources that are noncompliant with their tag policies
get_resources	Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account
get_tag_keys	Returns all tag keys in the specified Region for the AWS account
get_tag_values	Returns all tag values for the specified key in the specified Region for the AWS account
start_report_creation	Generates a report that lists all tagged resources in accounts across your organization and tells whether each resource is compliant with the effective tag policy
tag_resources	Applies one or more tags to the specified resources
untag_resources	Removes the specified tags from the specified resources

Examples

Run this code

if (FALSE) {
svc <- resourcegroupstaggingapi()
svc$describe_report_creation(
  Foo = 123
)
}

Run the code above in your browser using DataLab