R/resourcegroupstaggingapi_service.R

Defines functions service resourcegroupstaggingapi

Documented in resourcegroupstaggingapi

# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common new_handlers new_service set_config
NULL

#' 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html)
#' 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.
#' 
#' -   [Alexa for Business (a4b)](https://docs.aws.amazon.com/a4b/)
#' 
#' -   [API Gateway](https://docs.aws.amazon.com/apigateway/)
#' 
#' -   [Amazon AppStream](https://docs.aws.amazon.com/appstream2/)
#' 
#' -   [AWS AppSync](https://docs.aws.amazon.com/appsync/)
#' 
#' -   [AWS App Mesh](https://docs.aws.amazon.com/app-mesh/)
#' 
#' -   [Amazon Athena](https://docs.aws.amazon.com/athena/)
#' 
#' -   [Amazon
#'     Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/)
#' 
#' -   [AWS Backup](https://docs.aws.amazon.com/aws-backup/)
#' 
#' -   [AWS Certificate Manager](https://docs.aws.amazon.com/acm/)
#' 
#' -   [AWS Certificate Manager Private
#'     CA](https://docs.aws.amazon.com/acm/)
#' 
#' -   [Amazon Cloud
#'     Directory](https://docs.aws.amazon.com/clouddirectory/)
#' 
#' -   [AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/)
#' 
#' -   [AWS CloudFormation](https://docs.aws.amazon.com/cloudformation/)
#' 
#' -   [Amazon CloudFront](https://docs.aws.amazon.com/cloudfront/)
#' 
#' -   [AWS CloudHSM](https://docs.aws.amazon.com/cloudhsm/)
#' 
#' -   [AWS CloudTrail](https://docs.aws.amazon.com/cloudtrail/)
#' 
#' -   [Amazon CloudWatch (alarms
#'     only)](https://docs.aws.amazon.com/cloudwatch/)
#' 
#' -   [Amazon CloudWatch
#'     Events](https://docs.aws.amazon.com/cloudwatch/?id=docs_gateway#amazon-cloudwatch-events)
#' 
#' -   [Amazon CloudWatch
#'     Logs](https://docs.aws.amazon.com/cloudwatch/?id=docs_gateway#amazon-cloudwatch-logs)
#' 
#' -   [Amazon Cloudwatch
#'     Synthetics](https://docs.aws.amazon.com/cloudwatch/)
#' 
#' -   [AWS CodeBuild](https://docs.aws.amazon.com/codebuild/)
#' 
#' -   [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/)
#' 
#' -   [AWS CodeGuru
#'     Profiler](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/)
#' 
#' -   [AWS CodePipeline](https://docs.aws.amazon.com/codepipeline/)
#' 
#' -   [AWS CodeStar](https://docs.aws.amazon.com/codestar/)
#' 
#' -   [AWS CodeStar
#'     Connections](https://docs.aws.amazon.com/codestar-connections/latest/APIReference/)
#' 
#' -   [Amazon Cognito Identity](https://docs.aws.amazon.com/cognito/)
#' 
#' -   [Amazon Cognito User Pools](https://docs.aws.amazon.com/cognito/)
#' 
#' -   [Amazon Comprehend](https://docs.aws.amazon.com/comprehend/)
#' 
#' -   [AWS Config](https://docs.aws.amazon.com/config/)
#' 
#' -   [Amazon
#'     Connect](https://aws.amazon.com/connect/resources/?whats-new-cards=#Documentation)
#' 
#' -   [AWS Data Exchange](https://docs.aws.amazon.com/data-exchange/)
#' 
#' -   [AWS Data Pipeline](https://docs.aws.amazon.com/data-pipeline/)
#' 
#' -   [AWS Database Migration Service](https://docs.aws.amazon.com/dms/)
#' 
#' -   [AWS DataSync](https://docs.aws.amazon.com/datasync/)
#' 
#' -   [AWS Device Farm](https://docs.aws.amazon.com/devicefarm/)
#' 
#' -   [AWS Direct Connect](https://docs.aws.amazon.com/directconnect/)
#' 
#' -   [AWS Directory
#'     Service](https://docs.aws.amazon.com/directory-service/)
#' 
#' -   [Amazon DynamoDB](https://docs.aws.amazon.com/dynamodb/)
#' 
#' -   [Amazon EBS](https://docs.aws.amazon.com/ebs/)
#' 
#' -   [Amazon EC2](https://docs.aws.amazon.com/ec2/)
#' 
#' -   [EC2 Image Builder](https://docs.aws.amazon.com/imagebuilder/)
#' 
#' -   [Amazon ECR](https://docs.aws.amazon.com/ecr/)
#' 
#' -   [Amazon ECS](https://docs.aws.amazon.com/ecs/)
#' 
#' -   [Amazon EKS](https://docs.aws.amazon.com/eks/)
#' 
#' -   [AWS Elastic
#'     Beanstalk](https://docs.aws.amazon.com/elastic-beanstalk/)
#' 
#' -   [Amazon Elastic File System](https://docs.aws.amazon.com/efs/)
#' 
#' -   [Elastic Load
#'     Balancing](https://docs.aws.amazon.com/elasticloadbalancing/)
#' 
#' -   [Amazon Elastic
#'     Inference](https://docs.aws.amazon.com/elastic-inference/)
#' 
#' -   [Amazon ElastiCache](https://docs.aws.amazon.com/elasticache/)
#' 
#' -   [Amazon Elasticsearch
#'     Service](https://docs.aws.amazon.com/elasticsearch-service/)
#' 
#' -   [AWS Elemental MediaLive](https://docs.aws.amazon.com/medialive/)
#' 
#' -   [AWS Elemental
#'     MediaPackage](https://docs.aws.amazon.com/mediapackage/)
#' 
#' -   [AWS Elemental MediaPackage
#'     VoD](https://docs.aws.amazon.com/mediapackage/)
#' 
#' -   [AWS Elemental
#'     MediaTailor](https://docs.aws.amazon.com/mediatailor/)
#' 
#' -   [Amazon EMR](https://docs.aws.amazon.com/emr/)
#' 
#' -   [Amazon EventBridge
#'     Schema](https://docs.aws.amazon.com/eventbridge/)
#' 
#' -   [AWS Firewall
#'     Manager](https://docs.aws.amazon.com/firewall-manager/)
#' 
#' -   [Amazon Forecast](https://docs.aws.amazon.com/forecast/)
#' 
#' -   [Amazon Fraud Detector](https://docs.aws.amazon.com/frauddetector/)
#' 
#' -   [Amazon FSx](https://docs.aws.amazon.com/fsx/)
#' 
#' -   [Amazon S3
#'     Glacier](https://docs.aws.amazon.com/s3/?id=docs_gateway#amazon-s3-glacier)
#' 
#' -   [AWS Global
#'     Accelerator](https://docs.aws.amazon.com/global-accelerator/)
#' 
#' -   [AWS Ground Station](https://docs.aws.amazon.com/ground-station/)
#' 
#' -   [AWS Glue](https://docs.aws.amazon.com/glue/)
#' 
#' -   [Amazon GuardDuty](https://docs.aws.amazon.com/guardduty/)
#' 
#' -   [Amazon Inspector](https://docs.aws.amazon.com/inspector/)
#' 
#' -   [Amazon Interactive Video Service](https://docs.aws.amazon.com/ivs/)
#' 
#' -   [AWS IoT Analytics](https://docs.aws.amazon.com/iotanalytics/)
#' 
#' -   [AWS IoT Core](https://docs.aws.amazon.com/iot/)
#' 
#' -   [AWS IoT Device
#'     Defender](https://docs.aws.amazon.com/iot-device-defender/)
#' 
#' -   [AWS IoT Device
#'     Management](https://docs.aws.amazon.com/iot-device-management/)
#' 
#' -   [AWS IoT Events](https://docs.aws.amazon.com/iotevents/)
#' 
#' -   [AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/)
#' 
#' -   [AWS IoT 1-Click](https://docs.aws.amazon.com/iot-1-click/)
#' 
#' -   [AWS IoT Sitewise](https://docs.aws.amazon.com/iot-sitewise/)
#' 
#' -   [AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/)
#' 
#' -   [Amazon Kendra](https://docs.aws.amazon.com/kendra/)
#' 
#' -   [AWS Key Management Service](https://docs.aws.amazon.com/kms/)
#' 
#' -   [Amazon Kinesis](https://docs.aws.amazon.com/kinesis/)
#' 
#' -   [Amazon Kinesis Data
#'     Analytics](https://docs.aws.amazon.com/kinesis/?id=docs_gateway#amazon-kinesis-data-analytics)
#' 
#' -   [Amazon Kinesis Data
#'     Firehose](https://docs.aws.amazon.com/kinesis/?id=docs_gateway#amazon-kinesis-data-firehose)
#' 
#' -   [AWS Lambda](https://docs.aws.amazon.com/lambda/)
#' 
#' -   [Amazon Lex](https://docs.aws.amazon.com/lex/)
#' 
#' -   [AWS License Manager](https://docs.aws.amazon.com/license-manager/)
#' 
#' -   [Amazon Lightsail](https://docs.aws.amazon.com/lightsail/)
#' 
#' -   [Amazon Macie](https://docs.aws.amazon.com/macie/)
#' 
#' -   [Amazon Machine
#'     Learning](https://docs.aws.amazon.com/machine-learning/)
#' 
#' -   [Amazon MQ](https://docs.aws.amazon.com/amazon-mq/)
#' 
#' -   [Amazon MSK](https://docs.aws.amazon.com/msk/)
#' 
#' -   [Amazon MSK](https://docs.aws.amazon.com/msk/)
#' 
#' -   [Amazon Neptune](https://docs.aws.amazon.com/neptune/)
#' 
#' -   [AWS Network
#'     Manager](https://docs.aws.amazon.com/vpc/latest/tgw/what-is-network-manager.html)
#' 
#' -   [AWS OpsWorks](https://docs.aws.amazon.com/opsworks/)
#' 
#' -   [AWS OpsWorks CM](https://docs.aws.amazon.com/opsworks/)
#' 
#' -   [AWS Organizations](https://docs.aws.amazon.com/organizations/)
#' 
#' -   [Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/)
#' 
#' -   [Amazon Quantum Ledger Database
#'     (QLDB)](https://docs.aws.amazon.com/qldb/)
#' 
#' -   [Amazon RDS](https://docs.aws.amazon.com/rds/)
#' 
#' -   [Amazon Redshift](https://docs.aws.amazon.com/redshift/)
#' 
#' -   [AWS Resource Access Manager](https://docs.aws.amazon.com/ram/)
#' 
#' -   [AWS Resource Groups](https://docs.aws.amazon.com/ARG/)
#' 
#' -   [AWS RoboMaker](https://docs.aws.amazon.com/robomaker/)
#' 
#' -   [Amazon Route 53](https://docs.aws.amazon.com/route53/)
#' 
#' -   [Amazon Route 53 Resolver](https://docs.aws.amazon.com/route53/)
#' 
#' -   [Amazon S3 (buckets only)](https://docs.aws.amazon.com/s3/)
#' 
#' -   [Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/)
#' 
#' -   [Savings Plans](https://docs.aws.amazon.com/savingsplans/)
#' 
#' -   [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/)
#' 
#' -   [AWS Security Hub](https://docs.aws.amazon.com/securityhub/)
#' 
#' -   [AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/)
#' 
#' -   [Amazon Simple Email Service
#'     (SES)](https://docs.aws.amazon.com/ses/)
#' 
#' -   [Amazon Simple Notification Service
#'     (SNS)](https://docs.aws.amazon.com/sns/)
#' 
#' -   [Amazon Simple Queue Service
#'     (SQS)](https://docs.aws.amazon.com/sqs/)
#' 
#' -   [Amazon Simple Workflow Service](https://docs.aws.amazon.com/swf/)
#' 
#' -   [AWS Step Functions](https://docs.aws.amazon.com/step-functions/)
#' 
#' -   [AWS Storage Gateway](https://docs.aws.amazon.com/storagegateway/)
#' 
#' -   [AWS Systems Manager](https://docs.aws.amazon.com/systems-manager/)
#' 
#' -   [AWS Transfer for SFTP](https://docs.aws.amazon.com/transfer/)
#' 
#' -   [Amazon VPC](https://docs.aws.amazon.com/vpc/)
#' 
#' -   [AWS WAF](https://docs.aws.amazon.com/waf/)
#' 
#' -   [AWS WAF Regional](https://docs.aws.amazon.com/waf/)
#' 
#' -   [Amazon WorkLink](https://docs.aws.amazon.com/worklink/)
#' 
#' -   [Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/)
#'
#' @param
#' config
#' Optional configuration of credentials, endpoint, and/or region.
#'
#' @section 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"
#'   )
#' )
#' ```
#'
#' @examples
#' \dontrun{
#' svc <- resourcegroupstaggingapi()
#' svc$describe_report_creation(
#'   Foo = 123
#' )
#' }
#'
#' @section Operations:
#' \tabular{ll}{
#'  \link[=resourcegroupstaggingapi_describe_report_creation]{describe_report_creation} \tab Describes the status of the StartReportCreation operation\cr
#'  \link[=resourcegroupstaggingapi_get_compliance_summary]{get_compliance_summary} \tab Returns a table that shows counts of resources that are noncompliant with their tag policies\cr
#'  \link[=resourcegroupstaggingapi_get_resources]{get_resources} \tab Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account\cr
#'  \link[=resourcegroupstaggingapi_get_tag_keys]{get_tag_keys} \tab Returns all tag keys in the specified Region for the AWS account\cr
#'  \link[=resourcegroupstaggingapi_get_tag_values]{get_tag_values} \tab Returns all tag values for the specified key in the specified Region for the AWS account\cr
#'  \link[=resourcegroupstaggingapi_start_report_creation]{start_report_creation} \tab 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\cr
#'  \link[=resourcegroupstaggingapi_tag_resources]{tag_resources} \tab Applies one or more tags to the specified resources\cr
#'  \link[=resourcegroupstaggingapi_untag_resources]{untag_resources} \tab Removes the specified tags from the specified resources
#' }
#'
#' @return
#' 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.
#'
#' @rdname resourcegroupstaggingapi
#' @export
resourcegroupstaggingapi <- function(config = list()) {
  svc <- .resourcegroupstaggingapi$operations
  svc <- set_config(svc, config)
  return(svc)
}

# Private API objects: metadata, handlers, interfaces, etc.
.resourcegroupstaggingapi <- list()

.resourcegroupstaggingapi$operations <- list()

.resourcegroupstaggingapi$metadata <- list(
  service_name = "tagging",
  endpoints = list("*" = list(endpoint = "tagging.{region}.amazonaws.com", global = FALSE), "cn-*" = list(endpoint = "tagging.{region}.amazonaws.com.cn", global = FALSE), "us-iso-*" = list(endpoint = "tagging.{region}.c2s.ic.gov", global = FALSE), "us-isob-*" = list(endpoint = "tagging.{region}.sc2s.sgov.gov", global = FALSE)),
  service_id = "Resource Groups Tagging API",
  api_version = "2017-01-26",
  signing_name = "tagging",
  json_version = "1.1",
  target_prefix = "ResourceGroupsTaggingAPI_20170126"
)

.resourcegroupstaggingapi$service <- function(config = list()) {
  handlers <- new_handlers("jsonrpc", "v4")
  new_service(.resourcegroupstaggingapi$metadata, handlers, config)
}

Try the paws.management package in your browser

Any scripts or data that you put into this service are public.

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.