Class: AWS.ResourceGroupsTaggingAPI

var params = {
  GroupBy: [
    TARGET_ID | REGION | RESOURCE_TYPE,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  PaginationToken: 'STRING_VALUE',
  RegionFilters: [
    'STRING_VALUE',
    /* more items */
  ],
  ResourceTypeFilters: [
    'STRING_VALUE',
    /* more items */
  ],
  TagKeyFilters: [
    'STRING_VALUE',
    /* more items */
  ],
  TargetIdFilters: [
    'STRING_VALUE',
    /* more items */
  ]
};
resourcegroupstaggingapi.getComplianceSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TargetIdFilters — (Array<String>)

    Specifies 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.

  • RegionFilters — (Array<String>)

    Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.

  • ResourceTypeFilters — (Array<String>)

    Specifies that you want the response to include information for only resources of the specified types. 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 Amazon Web Services General Reference for the following:

    • For a list of service name strings, see Amazon Web Services Service Namespaces.

    • For resource type strings, see Example ARNs.

    • For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

  • TagKeyFilters — (Array<String>)

    Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.

  • GroupBy — (Array<String>)

    Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

  • MaxResults — (Integer)

    Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

  • PaginationToken — (String)

    Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SummaryList — (Array<map>)

      A table that shows counts of noncompliant resources.

      • LastUpdated — (String)

        The timestamp that shows when this summary was generated in this Region.

      • TargetId — (String)

        The account identifier or the root identifier of the organization. If you don't know the root ID, you can call the Organizations ListRoots API.

      • TargetIdType — (String)

        Whether the target is an account, an OU, or the organization root.

        Possible values include:
        • "ACCOUNT"
        • "OU"
        • "ROOT"
      • Region — (String)

        The Amazon Web Services Region that the summary applies to.

      • ResourceType — (String)

        The Amazon Web Services resource type.

      • NonCompliantResources — (Integer)

        The count of noncompliant resources.

    • PaginationToken — (String)

      A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ExcludeCompliantResources: true || false,
  IncludeComplianceDetails: true || false,
  PaginationToken: 'STRING_VALUE',
  ResourceARNList: [
    'STRING_VALUE',
    /* more items */
  ],
  ResourceTypeFilters: [
    'STRING_VALUE',
    /* more items */
  ],
  ResourcesPerPage: 'NUMBER_VALUE',
  TagFilters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  TagsPerPage: 'NUMBER_VALUE'
};
resourcegroupstaggingapi.getResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PaginationToken — (String)

    Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

  • TagFilters — (Array<map>)

    Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags with the specified keys and, if included, the specified values. Each TagFilter must contain a key with values 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 don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have 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 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 a value for a key, the response returns all resources that are tagged with that key, with any or no value.

      For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

      • 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 with the key key3, and with any or no value

      • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

    • Key — (String)

      One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    • Values — (Array<String>)

      One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

  • ResourcesPerPage — (Integer)

    Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

  • TagsPerPage — (Integer)

    Amazon Web Services 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).

    GetResources 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 up to a maximum of 500 items.

  • ResourceTypeFilters — (Array<String>)

    Specifies the resource types that you want included in the response. 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.

    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. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:

    ec2:instance,s3:bucket,auditmanager

  • IncludeComplianceDetails — (Boolean)

    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.

  • ExcludeCompliantResources — (Boolean)

    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.

  • ResourceARNList — (Array<String>)

    Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

    If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.

    An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PaginationToken — (String)

      A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

    • ResourceTagMappingList — (Array<map>)

      A list of resource ARNs and the tags (keys and values) associated with each.

      • ResourceARN — (String)

        The ARN of the resource.

      • Tags — (Array<map>)

        The tags that have been applied to one or more Amazon Web Services resources.

        • Key — required — (String)

          One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

        • Value — required — (String)

          One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

      • ComplianceDetails — (map)

        Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.

        • NoncompliantKeys — (Array<String>)

          These tag keys on the resource are noncompliant with the effective tag policy.

        • KeysWithNoncompliantValues — (Array<String>)

          These are keys defined in the effective policy that are on the resource with either incorrect case treatment or noncompliant values.

        • ComplianceStatus — (Boolean)

          Whether a resource is compliant with the effective tag policy.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  PaginationToken: 'STRING_VALUE'
};
resourcegroupstaggingapi.getTagKeys(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PaginationToken — (String)

    Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PaginationToken — (String)

      A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

    • TagKeys — (Array<String>)

      A list of all tag keys in the Amazon Web Services account.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Key: 'STRING_VALUE', /* required */
  PaginationToken: 'STRING_VALUE'
};
resourcegroupstaggingapi.getTagValues(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PaginationToken — (String)

    Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

  • Key — (String)

    Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PaginationToken — (String)

      A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

    • TagValues — (Array<String>)

      A list of all tag values for the specified key currently used in the specified Amazon Web Services Region for the calling account.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  S3Bucket: 'STRING_VALUE' /* required */
};
resourcegroupstaggingapi.startReportCreation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • S3Bucket — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARNList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resourcegroupstaggingapi.tagResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARNList — (Array<String>)

    Specifies the list of ARNs of the resources that you want to apply tags to.

    An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • Tags — (map<String>)

    Specifies a list of tags that you want to add to the specified resources. A tag consists of a key and a value that you define.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • FailedResourcesMap — (map<map>)

      A map containing a key-value pair for each failed item that couldn't be tagged. The key is the ARN of the failed resource. The value is a FailureInfo object that contains an error code, a status code, and an error message. If there are no errors, the FailedResourcesMap is empty.

      • StatusCode — (Integer)

        The HTTP status code of the common error.

      • ErrorCode — (String)

        The code of the common error. Valid values include InternalServiceException, InvalidParameterException, and any valid error code returned by the Amazon Web Services service that hosts the resource that you want to tag.

        Possible values include:
        • "InternalServiceException"
        • "InvalidParameterException"
      • ErrorMessage — (String)

        The message of the common error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARNList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
resourcegroupstaggingapi.untagResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARNList — (Array<String>)

    Specifies a list of ARNs of the resources that you want to remove tags from.

    An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • TagKeys — (Array<String>)

    Specifies a list of tag keys that you want to remove from the specified resources.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • FailedResourcesMap — (map<map>)

      A map containing a key-value pair for each failed item that couldn't be untagged. The key is the ARN of the failed resource. The value is a FailureInfo object that contains an error code, a status code, and an error message. If there are no errors, the FailedResourcesMap is empty.

      • StatusCode — (Integer)

        The HTTP status code of the common error.

      • ErrorCode — (String)

        The code of the common error. Valid values include InternalServiceException, InvalidParameterException, and any valid error code returned by the Amazon Web Services service that hosts the resource that you want to tag.

        Possible values include:
        • "InternalServiceException"
        • "InvalidParameterException"
      • ErrorMessage — (String)

        The message of the common error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.