R/resourcegroupstaggingapi_operations.R

Defines functions resourcegroupstaggingapi_untag_resources resourcegroupstaggingapi_tag_resources resourcegroupstaggingapi_start_report_creation resourcegroupstaggingapi_get_tag_values resourcegroupstaggingapi_get_tag_keys resourcegroupstaggingapi_get_resources resourcegroupstaggingapi_get_compliance_summary resourcegroupstaggingapi_describe_report_creation

Documented in resourcegroupstaggingapi_describe_report_creation resourcegroupstaggingapi_get_compliance_summary resourcegroupstaggingapi_get_resources resourcegroupstaggingapi_get_tag_keys resourcegroupstaggingapi_get_tag_values resourcegroupstaggingapi_start_report_creation resourcegroupstaggingapi_tag_resources resourcegroupstaggingapi_untag_resources

# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common get_config new_operation new_request send_request
#' @include resourcegroupstaggingapi_service.R
NULL

#' Describes the status of the StartReportCreation operation
#'
#' @description
#' Describes the status of the
#' [`start_report_creation`][resourcegroupstaggingapi_start_report_creation]
#' operation.
#' 
#' You can call this operation only from the organization's master account
#' and from the us-east-1 Region.
#'
#' @usage
#' resourcegroupstaggingapi_describe_report_creation()
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#'   Status = "string",
#'   S3Location = "string",
#'   ErrorMessage = "string"
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$describe_report_creation()
#' ```
#'
#' @keywords internal
#'
#' @rdname resourcegroupstaggingapi_describe_report_creation
resourcegroupstaggingapi_describe_report_creation <- function() {
  op <- new_operation(
    name = "DescribeReportCreation",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .resourcegroupstaggingapi$describe_report_creation_input()
  output <- .resourcegroupstaggingapi$describe_report_creation_output()
  config <- get_config()
  svc <- .resourcegroupstaggingapi$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.resourcegroupstaggingapi$operations$describe_report_creation <- resourcegroupstaggingapi_describe_report_creation

#' Returns a table that shows counts of resources that are noncompliant
#' with their tag policies
#'
#' @description
#' Returns a table that shows counts of resources that are noncompliant
#' with their tag policies.
#' 
#' For more information on tag policies, see [Tag
#' Policies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html)
#' in the *AWS Organizations User Guide.*
#' 
#' You can call this operation only from the organization's master account
#' and from the us-east-1 Region.
#'
#' @usage
#' resourcegroupstaggingapi_get_compliance_summary(TargetIdFilters,
#'   RegionFilters, ResourceTypeFilters, TagKeyFilters, GroupBy, MaxResults,
#'   PaginationToken)
#'
#' @param TargetIdFilters The target identifiers (usually, specific account IDs) to limit the
#' output by. If you use this parameter, the count of returned noncompliant
#' resources includes only resources with the specified target IDs.
#' @param RegionFilters A list of Regions to limit the output by. If you use this parameter, the
#' count of returned noncompliant resources includes only resources in the
#' specified Regions.
#' @param ResourceTypeFilters The constraints on the resources that you want returned. The format of
#' each resource type is `service[:resourceType]`. For example, specifying
#' a resource type of `ec2` returns all Amazon EC2 resources (which
#' includes EC2 instances). Specifying a resource type of `ec2:instance`
#' returns only EC2 instances.
#' 
#' The string for each service name and resource type is the same as that
#' embedded in a resource's Amazon Resource Name (ARN). Consult the *AWS
#' General Reference* for the following:
#' 
#' -   For a list of service name strings, see [AWS Service
#'     Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces).
#' 
#' -   For resource type strings, see [Example
#'     ARNs](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax).
#' 
#' -   For more information about ARNs, see [Amazon Resource Names (ARNs)
#'     and AWS Service
#'     Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
#' 
#' You can specify multiple resource types by using an array. The array can
#' include up to 100 items. Note that the length constraint requirement
#' applies to each resource type filter.
#' @param TagKeyFilters A list of tag keys to limit the output by. If you use this parameter,
#' the count of returned noncompliant resources includes only resources
#' that have the specified tag keys.
#' @param GroupBy A list of attributes to group the counts of noncompliant resources by.
#' If supplied, the counts are sorted by those attributes.
#' @param MaxResults A limit that restricts the number of results that are returned per page.
#' @param PaginationToken A string that indicates that additional data is available. Leave this
#' value empty for your initial request. If the response includes a
#' `PaginationToken`, use that string for this value to request an
#' additional page of data.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#'   SummaryList = list(
#'     list(
#'       LastUpdated = "string",
#'       TargetId = "string",
#'       TargetIdType = "ACCOUNT"|"OU"|"ROOT",
#'       Region = "string",
#'       ResourceType = "string",
#'       NonCompliantResources = 123
#'     )
#'   ),
#'   PaginationToken = "string"
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$get_compliance_summary(
#'   TargetIdFilters = list(
#'     "string"
#'   ),
#'   RegionFilters = list(
#'     "string"
#'   ),
#'   ResourceTypeFilters = list(
#'     "string"
#'   ),
#'   TagKeyFilters = list(
#'     "string"
#'   ),
#'   GroupBy = list(
#'     "TARGET_ID"|"REGION"|"RESOURCE_TYPE"
#'   ),
#'   MaxResults = 123,
#'   PaginationToken = "string"
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname resourcegroupstaggingapi_get_compliance_summary
resourcegroupstaggingapi_get_compliance_summary <- function(TargetIdFilters = NULL, RegionFilters = NULL, ResourceTypeFilters = NULL, TagKeyFilters = NULL, GroupBy = NULL, MaxResults = NULL, PaginationToken = NULL) {
  op <- new_operation(
    name = "GetComplianceSummary",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .resourcegroupstaggingapi$get_compliance_summary_input(TargetIdFilters = TargetIdFilters, RegionFilters = RegionFilters, ResourceTypeFilters = ResourceTypeFilters, TagKeyFilters = TagKeyFilters, GroupBy = GroupBy, MaxResults = MaxResults, PaginationToken = PaginationToken)
  output <- .resourcegroupstaggingapi$get_compliance_summary_output()
  config <- get_config()
  svc <- .resourcegroupstaggingapi$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.resourcegroupstaggingapi$operations$get_compliance_summary <- resourcegroupstaggingapi_get_compliance_summary

#' Returns all the tagged or previously tagged resources that are located
#' in the specified Region for the AWS account
#'
#' @description
#' Returns all the tagged or previously tagged resources that are located
#' in the specified Region for the AWS account.
#' 
#' Depending on what information you want returned, you can also specify
#' the following:
#' 
#' -   *Filters* that specify what tags and resource types you want
#'     returned. The response includes all tags that are associated with
#'     the requested resources.
#' 
#' -   Information about compliance with the account's effective tag
#'     policy. For more information on tag policies, see [Tag
#'     Policies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html)
#'     in the *AWS Organizations User Guide.*
#' 
#' You can check the `PaginationToken` response parameter to determine if a
#' query is complete. Queries occasionally return fewer results on a page
#' than allowed. The `PaginationToken` response parameter value is `null`
#' *only* when there are no more results to display.
#'
#' @usage
#' resourcegroupstaggingapi_get_resources(PaginationToken, TagFilters,
#'   ResourcesPerPage, TagsPerPage, ResourceTypeFilters,
#'   IncludeComplianceDetails, ExcludeCompliantResources)
#'
#' @param PaginationToken A string that indicates that additional data is available. Leave this
#' value empty for your initial request. If the response includes a
#' `PaginationToken`, use that string for this value to request an
#' additional page of data.
#' @param TagFilters A list of TagFilters (keys and values). Each TagFilter specified must
#' contain a key with values as optional. A request can include up to 50
#' keys, and each key can include up to 20 values.
#' 
#' Note the following when deciding how to use TagFilters:
#' 
#' -   If you *do* specify a TagFilter, the response returns only those
#'     resources that are currently associated with the specified tag.
#' 
#' -   If you *don't* specify a TagFilter, the response includes all
#'     resources that were ever associated with tags. Resources that
#'     currently don't have associated tags are shown with an empty tag
#'     set, like this: `"Tags": []`.
#' 
#' -   If you specify more than one filter in a single request, the
#'     response returns only those resources that satisfy all specified
#'     filters.
#' 
#' -   If you specify a filter that contains more than one value for a key,
#'     the response returns resources that match any of the specified
#'     values for that key.
#' 
#' -   If you don't specify any values for a key, the response returns
#'     resources that are tagged with that key irrespective of the value.
#' 
#'     For example, for filters: filter1 = \{key1, \{value1\}\},
#'     filter2 = \{key2, \{value2,value3,value4\}\} , filter3 =
#'     \{key3\}:
#' 
#'     -   GetResources( \{filter1\} ) returns resources tagged with
#'         key1=value1
#' 
#'     -   GetResources( \{filter2\} ) returns resources tagged with
#'         key2=value2 or key2=value3 or key2=value4
#' 
#'     -   GetResources( \{filter3\} ) returns resources tagged with any
#'         tag containing key3 as its tag key, irrespective of its value
#' 
#'     -   GetResources( \{filter1,filter2,filter3\} ) returns resources
#'         tagged with ( key1=value1) and ( key2=value2 or key2=value3 or
#'         key2=value4) and (key3, irrespective of the value)
#' @param ResourcesPerPage A limit that restricts the number of resources returned by GetResources
#' in paginated output. You can set ResourcesPerPage to a minimum of 1 item
#' and the maximum of 100 items.
#' @param TagsPerPage AWS recommends using `ResourcesPerPage` instead of this parameter.
#' 
#' A limit that restricts the number of tags (key and value pairs) returned
#' by GetResources in paginated output. A resource with no tags is counted
#' as having one tag (one key and value pair).
#' 
#' [`get_resources`][resourcegroupstaggingapi_get_resources] does not split
#' a resource and its associated tags across pages. If the specified
#' `TagsPerPage` would cause such a break, a `PaginationToken` is returned
#' in place of the affected resource and its tags. Use that token in
#' another request to get the remaining data. For example, if you specify a
#' `TagsPerPage` of `100` and the account has 22 resources with 10 tags
#' each (meaning that each resource has 10 key and value pairs), the output
#' will consist of three pages. The first page displays the first 10
#' resources, each with its 10 tags. The second page displays the next 10
#' resources, each with its 10 tags. The third page displays the remaining
#' 2 resources, each with its 10 tags.
#' 
#' You can set `TagsPerPage` to a minimum of 100 items and the maximum of
#' 500 items.
#' @param ResourceTypeFilters The constraints on the resources that you want returned. The format of
#' each resource type is `service[:resourceType]`. For example, specifying
#' a resource type of `ec2` returns all Amazon EC2 resources (which
#' includes EC2 instances). Specifying a resource type of `ec2:instance`
#' returns only EC2 instances.
#' 
#' The string for each service name and resource type is the same as that
#' embedded in a resource's Amazon Resource Name (ARN). Consult the *AWS
#' General Reference* for the following:
#' 
#' -   For a list of service name strings, see [AWS Service
#'     Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces).
#' 
#' -   For resource type strings, see [Example
#'     ARNs](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax).
#' 
#' -   For more information about ARNs, see [Amazon Resource Names (ARNs)
#'     and AWS Service
#'     Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
#' 
#' You can specify multiple resource types by using an array. The array can
#' include up to 100 items. Note that the length constraint requirement
#' applies to each resource type filter.
#' @param IncludeComplianceDetails Specifies whether to include details regarding the compliance with the
#' effective tag policy. Set this to `true` to determine whether resources
#' are compliant with the tag policy and to get details.
#' @param ExcludeCompliantResources Specifies whether to exclude resources that are compliant with the tag
#' policy. Set this to `true` if you are interested in retrieving
#' information on noncompliant resources only.
#' 
#' You can use this parameter only if the `IncludeComplianceDetails`
#' parameter is also set to `true`.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#'   PaginationToken = "string",
#'   ResourceTagMappingList = list(
#'     list(
#'       ResourceARN = "string",
#'       Tags = list(
#'         list(
#'           Key = "string",
#'           Value = "string"
#'         )
#'       ),
#'       ComplianceDetails = list(
#'         NoncompliantKeys = list(
#'           "string"
#'         ),
#'         KeysWithNoncompliantValues = list(
#'           "string"
#'         ),
#'         ComplianceStatus = TRUE|FALSE
#'       )
#'     )
#'   )
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$get_resources(
#'   PaginationToken = "string",
#'   TagFilters = list(
#'     list(
#'       Key = "string",
#'       Values = list(
#'         "string"
#'       )
#'     )
#'   ),
#'   ResourcesPerPage = 123,
#'   TagsPerPage = 123,
#'   ResourceTypeFilters = list(
#'     "string"
#'   ),
#'   IncludeComplianceDetails = TRUE|FALSE,
#'   ExcludeCompliantResources = TRUE|FALSE
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname resourcegroupstaggingapi_get_resources
resourcegroupstaggingapi_get_resources <- function(PaginationToken = NULL, TagFilters = NULL, ResourcesPerPage = NULL, TagsPerPage = NULL, ResourceTypeFilters = NULL, IncludeComplianceDetails = NULL, ExcludeCompliantResources = NULL) {
  op <- new_operation(
    name = "GetResources",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .resourcegroupstaggingapi$get_resources_input(PaginationToken = PaginationToken, TagFilters = TagFilters, ResourcesPerPage = ResourcesPerPage, TagsPerPage = TagsPerPage, ResourceTypeFilters = ResourceTypeFilters, IncludeComplianceDetails = IncludeComplianceDetails, ExcludeCompliantResources = ExcludeCompliantResources)
  output <- .resourcegroupstaggingapi$get_resources_output()
  config <- get_config()
  svc <- .resourcegroupstaggingapi$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.resourcegroupstaggingapi$operations$get_resources <- resourcegroupstaggingapi_get_resources

#' Returns all tag keys in the specified Region for the AWS account
#'
#' @description
#' Returns all tag keys in the specified Region for the AWS account.
#'
#' @usage
#' resourcegroupstaggingapi_get_tag_keys(PaginationToken)
#'
#' @param PaginationToken A string that indicates that additional data is available. Leave this
#' value empty for your initial request. If the response includes a
#' `PaginationToken`, use that string for this value to request an
#' additional page of data.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#'   PaginationToken = "string",
#'   TagKeys = list(
#'     "string"
#'   )
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$get_tag_keys(
#'   PaginationToken = "string"
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname resourcegroupstaggingapi_get_tag_keys
resourcegroupstaggingapi_get_tag_keys <- function(PaginationToken = NULL) {
  op <- new_operation(
    name = "GetTagKeys",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .resourcegroupstaggingapi$get_tag_keys_input(PaginationToken = PaginationToken)
  output <- .resourcegroupstaggingapi$get_tag_keys_output()
  config <- get_config()
  svc <- .resourcegroupstaggingapi$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.resourcegroupstaggingapi$operations$get_tag_keys <- resourcegroupstaggingapi_get_tag_keys

#' Returns all tag values for the specified key in the specified Region for
#' the AWS account
#'
#' @description
#' Returns all tag values for the specified key in the specified Region for
#' the AWS account.
#'
#' @usage
#' resourcegroupstaggingapi_get_tag_values(PaginationToken, Key)
#'
#' @param PaginationToken A string that indicates that additional data is available. Leave this
#' value empty for your initial request. If the response includes a
#' `PaginationToken`, use that string for this value to request an
#' additional page of data.
#' @param Key &#91;required&#93; The key for which you want to list all existing values in the specified
#' Region for the AWS account.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#'   PaginationToken = "string",
#'   TagValues = list(
#'     "string"
#'   )
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$get_tag_values(
#'   PaginationToken = "string",
#'   Key = "string"
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname resourcegroupstaggingapi_get_tag_values
resourcegroupstaggingapi_get_tag_values <- function(PaginationToken = NULL, Key) {
  op <- new_operation(
    name = "GetTagValues",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .resourcegroupstaggingapi$get_tag_values_input(PaginationToken = PaginationToken, Key = Key)
  output <- .resourcegroupstaggingapi$get_tag_values_output()
  config <- get_config()
  svc <- .resourcegroupstaggingapi$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.resourcegroupstaggingapi$operations$get_tag_values <- resourcegroupstaggingapi_get_tag_values

#' 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
#'
#' @description
#' 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. Compliance data is refreshed daily.
#' 
#' The generated report is saved to the following location:
#' 
#' `s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv`
#' 
#' You can call this operation only from the organization's master account
#' and from the us-east-1 Region.
#'
#' @usage
#' resourcegroupstaggingapi_start_report_creation(S3Bucket)
#'
#' @param S3Bucket &#91;required&#93; The name of the Amazon S3 bucket where the report will be stored; for
#' example:
#' 
#' `awsexamplebucket`
#' 
#' For more information on S3 bucket requirements, including an example
#' bucket policy, see the example S3 bucket policy on this page.
#'
#' @return
#' An empty list.
#'
#' @section Request syntax:
#' ```
#' svc$start_report_creation(
#'   S3Bucket = "string"
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname resourcegroupstaggingapi_start_report_creation
resourcegroupstaggingapi_start_report_creation <- function(S3Bucket) {
  op <- new_operation(
    name = "StartReportCreation",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .resourcegroupstaggingapi$start_report_creation_input(S3Bucket = S3Bucket)
  output <- .resourcegroupstaggingapi$start_report_creation_output()
  config <- get_config()
  svc <- .resourcegroupstaggingapi$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.resourcegroupstaggingapi$operations$start_report_creation <- resourcegroupstaggingapi_start_report_creation

#' Applies one or more tags to the specified resources
#'
#' @description
#' Applies one or more tags to the specified resources. Note the following:
#' 
#' -   Not all resources can have tags. For a list of services that support
#'     tagging, see [this
#'     list](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/).
#' 
#' -   Each resource can have up to 50 tags. For other limits, see [Tag
#'     Naming and Usage
#'     Conventions](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions)
#'     in the *AWS General Reference.*
#' 
#' -   You can only tag resources that are located in the specified Region
#'     for the AWS account.
#' 
#' -   To add tags to a resource, you need the necessary permissions for
#'     the service that the resource belongs to as well as permissions for
#'     adding tags. For more information, see [this
#'     list](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/).
#' 
#' 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.
#'
#' @usage
#' resourcegroupstaggingapi_tag_resources(ResourceARNList, Tags)
#'
#' @param ResourceARNList &#91;required&#93; A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a
#' resource. For more information, see [Amazon Resource Names (ARNs) and
#' AWS Service
#' Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
#' in the *AWS General Reference*.
#' @param Tags &#91;required&#93; The tags that you want to add to the specified resources. A tag consists
#' of a key and a value that you define.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#'   FailedResourcesMap = list(
#'     list(
#'       StatusCode = 123,
#'       ErrorCode = "InternalServiceException"|"InvalidParameterException",
#'       ErrorMessage = "string"
#'     )
#'   )
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$tag_resources(
#'   ResourceARNList = list(
#'     "string"
#'   ),
#'   Tags = list(
#'     "string"
#'   )
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname resourcegroupstaggingapi_tag_resources
resourcegroupstaggingapi_tag_resources <- function(ResourceARNList, Tags) {
  op <- new_operation(
    name = "TagResources",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .resourcegroupstaggingapi$tag_resources_input(ResourceARNList = ResourceARNList, Tags = Tags)
  output <- .resourcegroupstaggingapi$tag_resources_output()
  config <- get_config()
  svc <- .resourcegroupstaggingapi$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.resourcegroupstaggingapi$operations$tag_resources <- resourcegroupstaggingapi_tag_resources

#' Removes the specified tags from the specified resources
#'
#' @description
#' Removes the specified tags from the specified resources. When you
#' specify a tag key, the action removes both that key and its associated
#' value. The operation succeeds even if you attempt to remove tags from a
#' resource that were already removed. Note the following:
#' 
#' -   To remove tags from a resource, you need the necessary permissions
#'     for the service that the resource belongs to as well as permissions
#'     for removing tags. For more information, see [this
#'     list](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/).
#' 
#' -   You can only tag resources that are located in the specified Region
#'     for the AWS account.
#'
#' @usage
#' resourcegroupstaggingapi_untag_resources(ResourceARNList, TagKeys)
#'
#' @param ResourceARNList &#91;required&#93; A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a
#' resource. For more information, see [Amazon Resource Names (ARNs) and
#' AWS Service
#' Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
#' in the *AWS General Reference*.
#' @param TagKeys &#91;required&#93; A list of the tag keys that you want to remove from the specified
#' resources.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#'   FailedResourcesMap = list(
#'     list(
#'       StatusCode = 123,
#'       ErrorCode = "InternalServiceException"|"InvalidParameterException",
#'       ErrorMessage = "string"
#'     )
#'   )
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$untag_resources(
#'   ResourceARNList = list(
#'     "string"
#'   ),
#'   TagKeys = list(
#'     "string"
#'   )
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname resourcegroupstaggingapi_untag_resources
resourcegroupstaggingapi_untag_resources <- function(ResourceARNList, TagKeys) {
  op <- new_operation(
    name = "UntagResources",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .resourcegroupstaggingapi$untag_resources_input(ResourceARNList = ResourceARNList, TagKeys = TagKeys)
  output <- .resourcegroupstaggingapi$untag_resources_output()
  config <- get_config()
  svc <- .resourcegroupstaggingapi$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.resourcegroupstaggingapi$operations$untag_resources <- resourcegroupstaggingapi_untag_resources

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.