R/resourcegroups_service.R

Defines functions service resourcegroups

Documented in resourcegroups

# 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
#'
#' @description
#' 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](https://docs.aws.amazon.com/ARG/latest/userguide/).
#' 
#' 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
#'
#' @param
#' config
#' Optional configuration of credentials, endpoint, and/or region.
#'
#' @section Service syntax:
#' ```
#' svc <- resourcegroups(
#'   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 <- resourcegroups()
#' svc$create_group(
#'   Foo = 123
#' )
#' }
#'
#' @section Operations:
#' \tabular{ll}{
#'  \link[=resourcegroups_create_group]{create_group} \tab Creates a resource group with the specified name and description\cr
#'  \link[=resourcegroups_delete_group]{delete_group} \tab Deletes the specified resource group\cr
#'  \link[=resourcegroups_get_group]{get_group} \tab Returns information about a specified resource group\cr
#'  \link[=resourcegroups_get_group_configuration]{get_group_configuration} \tab Returns the service configuration associated with the specified resource group\cr
#'  \link[=resourcegroups_get_group_query]{get_group_query} \tab Retrieves the resource query associated with the specified resource group\cr
#'  \link[=resourcegroups_get_tags]{get_tags} \tab Returns a list of tags that are associated with a resource group, specified by an ARN\cr
#'  \link[=resourcegroups_group_resources]{group_resources} \tab Adds the specified resources to the specified group\cr
#'  \link[=resourcegroups_list_group_resources]{list_group_resources} \tab Returns a list of ARNs of the resources that are members of a specified resource group\cr
#'  \link[=resourcegroups_list_groups]{list_groups} \tab Returns a list of existing resource groups in your account\cr
#'  \link[=resourcegroups_put_group_configuration]{put_group_configuration} \tab Attaches a service configuration to the specified group\cr
#'  \link[=resourcegroups_search_resources]{search_resources} \tab Returns a list of AWS resource identifiers that matches the specified query\cr
#'  \link[=resourcegroups_tag]{tag} \tab Adds tags to a resource group with the specified ARN\cr
#'  \link[=resourcegroups_ungroup_resources]{ungroup_resources} \tab Removes the specified resources from the specified group\cr
#'  \link[=resourcegroups_untag]{untag} \tab Deletes tags from a specified resource group\cr
#'  \link[=resourcegroups_update_group]{update_group} \tab Updates the description for an existing group\cr
#'  \link[=resourcegroups_update_group_query]{update_group_query} \tab Updates the resource query of a group
#' }
#'
#' @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 resourcegroups
#' @export
resourcegroups <- function(config = list()) {
  svc <- .resourcegroups$operations
  svc <- set_config(svc, config)
  return(svc)
}

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

.resourcegroups$operations <- list()

.resourcegroups$metadata <- list(
  service_name = "resource-groups",
  endpoints = list("*" = list(endpoint = "resource-groups.{region}.amazonaws.com", global = FALSE), "cn-*" = list(endpoint = "resource-groups.{region}.amazonaws.com.cn", global = FALSE), "us-iso-*" = list(endpoint = "resource-groups.{region}.c2s.ic.gov", global = FALSE), "us-isob-*" = list(endpoint = "resource-groups.{region}.sc2s.sgov.gov", global = FALSE)),
  service_id = "Resource Groups",
  api_version = "2017-11-27",
  signing_name = "resource-groups",
  json_version = "",
  target_prefix = ""
)

.resourcegroups$service <- function(config = list()) {
  handlers <- new_handlers("restjson", "v4")
  new_service(.resourcegroups$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.