Class: AWS.ResourceGroups

var params = {
  Group: 'STRING_VALUE',
  GroupName: 'STRING_VALUE'
};
resourcegroups.deleteGroup(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: {}) —
  • GroupName — (String)

    Deprecated - don't use this parameter. Use Group instead.

  • Group — (String)

    The name or the ARN of the resource group to delete.

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:

    • Group — (map)

      A full description of the deleted resource group.

      • GroupArn — required — (String)

        The ARN of the resource group.

      • Name — required — (String)

        The name of the resource group.

      • Description — (String)

        The description of the resource group.

Returns:

• (AWS.Request) —

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

resourcegroups.getAccountSettings(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

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:

    • AccountSettings — (map)

      The current settings for the optional features in Resource Groups.

      • GroupLifecycleEventsDesiredStatus — (String)

        The desired target status of the group lifecycle events feature. If

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • GroupLifecycleEventsStatus — (String)

        The current status of the group lifecycle events feature.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "IN_PROGRESS"
        • "ERROR"
      • GroupLifecycleEventsStatusMessage — (String)

        The text of any error message occurs during an attempt to turn group lifecycle events on or off.

Returns:

• (AWS.Request) —

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

var params = {
  Group: 'STRING_VALUE',
  GroupName: 'STRING_VALUE'
};
resourcegroups.getGroup(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: {}) —
  • GroupName — (String)

    Deprecated - don't use this parameter. Use Group instead.

  • Group — (String)

    The name or the ARN of the resource group to retrieve.

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:

    • Group — (map)

      A structure that contains the metadata details for the specified resource group. Use GetGroupQuery and GetGroupConfiguration to get those additional details of the resource group.

      • GroupArn — required — (String)

        The ARN of the resource group.

      • Name — required — (String)

        The name of the resource group.

      • Description — (String)

        The description of the resource group.

Returns:

• (AWS.Request) —

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

var params = {
  Group: 'STRING_VALUE'
};
resourcegroups.getGroupConfiguration(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: {}) —
  • Group — (String)

    The name or the ARN of the resource group for which you want to retrive the service configuration.

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:

    • GroupConfiguration — (map)

      A structure that describes the service configuration attached with the specified group. For details about the service configuration syntax, see Service configurations for Resource Groups.

      • Configuration — (Array<map>)

        The configuration currently associated with the group and in effect.

        • Type — required — (String)

          Specifies the type of group configuration item. Each item must have a unique value for type. For the list of types that you can specify for a configuration item, see Supported resource types and parameters.

        • Parameters — (Array<map>)

          A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.

          • Name — required — (String)

            The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.

          • Values — (Array<String>)

            The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.

      • ProposedConfiguration — (Array<map>)

        If present, the new configuration that is in the process of being applied to the group.

        • Type — required — (String)

          Specifies the type of group configuration item. Each item must have a unique value for type. For the list of types that you can specify for a configuration item, see Supported resource types and parameters.

        • Parameters — (Array<map>)

          A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.

          • Name — required — (String)

            The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.

          • Values — (Array<String>)

            The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.

      • Status — (String)

        The current status of an attempt to update the group configuration.

        Possible values include:
        • "UPDATING"
        • "UPDATE_COMPLETE"
        • "UPDATE_FAILED"
      • FailureReason — (String)

        If present, the reason why a request to update the group configuration failed.

Returns:

• (AWS.Request) —

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

var params = {
  Group: 'STRING_VALUE',
  GroupName: 'STRING_VALUE'
};
resourcegroups.getGroupQuery(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: {}) —
  • GroupName — (String)

    Don't use this parameter. Use Group instead.

  • Group — (String)

    The name or the ARN of the resource group to query.

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:

    • GroupQuery — (map)

      The resource query associated with the specified group. For more information about resource queries, see Create a tag-based group in Resource Groups.

      • GroupName — required — (String)

        The name of the resource group that is associated with the specified resource query.

      • ResourceQuery — required — (map)

        The resource query that determines which Amazon Web Services resources are members of the associated resource group.

        • Type — required — (String)

          The type of the query to perform. This can have one of two values:

          • CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.

          • TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.

          Possible values include:
          • "TAG_FILTERS_1_0"
          • "CLOUDFORMATION_STACK_1_0"
        • Query — required — (String)

          The query that defines a group or a search. The contents depends on the value of the Type element.

          • ResourceTypeFilters – Applies to all ResourceQuery objects of either Type. This element contains one of the following two items:

            • The value AWS::AllSupported. This causes the ResourceQuery to match resources of any resource type that also match the query.

            • A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide.

            Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

          • TagFilters – applicable only if Type = TAG_FILTERS_1_0. The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.

            For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each:

            [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]

            The results of this resource query could include the following.

            • An Amazon EC2 instance that has the following two tags: {"Stage":"Deploy"}, and {"Version":"2"}

            • An S3 bucket that has the following two tags: {"Stage":"Test"}, and {"Version":"1"}

            The resource query results would not include the following items in the results, however.

            • An Amazon EC2 instance that has only the following tag: {"Stage":"Deploy"}.

              The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

            • An RDS database that has the following two tags: {"Stage":"Archived"} and {"Version":"4"}

              The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

            Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

          • StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0. The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE' /* required */
};
resourcegroups.getTags(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: {}) —
  • Arn — (String)

    The ARN of the resource group whose tags you want to retrieve.

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:

    • Arn — (String)

      The ARN of the tagged resource group.

    • Tags — (map<String>)

      The tags associated with the specified resource group.

Returns:

• (AWS.Request) —

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

var params = {
  Group: 'STRING_VALUE', /* required */
  ResourceArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
resourcegroups.groupResources(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: {}) —
  • Group — (String)

    The name or the ARN of the resource group to add resources to.

  • ResourceArns — (Array<String>)

    The list of ARNs of the resources to be added to the group.

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:

    • Succeeded — (Array<String>)

      A list of ARNs of the resources that this operation successfully added to the group.

    • Failed — (Array<map>)

      A list of ARNs of any resources that this operation failed to add to the group.

      • ResourceArn — (String)

        The ARN of the resource that failed to be added or removed.

      • ErrorMessage — (String)

        The error message text associated with the failure.

      • ErrorCode — (String)

        The error code associated with the failure.

    • Pending — (Array<map>)

      A list of ARNs of any resources that this operation is still in the process adding to the group. These pending additions continue asynchronously. You can check the status of pending additions by using the ListGroupResources operation, and checking the Resources array in the response and the Status field of each object in that array.

      • ResourceArn — (String)

        The Amazon resource name (ARN) of the resource that's in a pending state.

Returns:

• (AWS.Request) —

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

var params = {
  Filters: [
    {
      Name: resource-type, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Group: 'STRING_VALUE',
  GroupName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
resourcegroups.listGroupResources(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: {}) —
  • GroupName — (String)

    Deprecated - don't use this parameter. Use the Group request field instead.

  • Group — (String)

    The name or the ARN of the resource group

  • Filters — (Array<map>)

    Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.

    • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

    When you specify a resource-type filter for ListGroupResources, Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:

    The resource types specified as filters in the request are not valid.

    The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or Amazon CloudFront stack-based queries).

    • Name — required — (String)

      The name of the filter. Filter names are case-sensitive.

      Possible values include:
      • "resource-type"
    • Values — required — (Array<String>)

      One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.

  • MaxResults — (Integer)

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken — (String)

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

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:

    • Resources — (Array<map>)

      An array of resources from which you can determine each resource's identity, type, and group membership status.

      • Identifier — (map)

        A structure that contains the ARN of a resource and its resource type.

        • ResourceArn — (String)

          The ARN of a resource.

        • ResourceType — (String)

          The resource type of a resource, such as AWS::EC2::Instance.

      • Status — (map)

        A structure that contains the status of this resource's membership in the group.

        Note: This field is present in the response only if the group is of type AWS::EC2::HostManagement.
        • Name — (String)

          The current status.

          Possible values include:
          • "PENDING"
    • ResourceIdentifiers — (Array<map>)

      Deprecated - don't use this parameter. Use the Resources response field instead.

      • ResourceArn — (String)

        The ARN of a resource.

      • ResourceType — (String)

        The resource type of a resource, such as AWS::EC2::Instance.

    • NextToken — (String)

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

    • QueryErrors — (Array<map>)

      A list of QueryError objects. Each error contains an ErrorCode and Message. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE, CLOUDFORMATION_STACK_NOT_EXISTING, CLOUDFORMATION_STACK_UNASSUMABLE_ROLE and RESOURCE_TYPE_NOT_SUPPORTED.

      • ErrorCode — (String)

        Specifies the error code that was raised.

        Possible values include:
        • "CLOUDFORMATION_STACK_INACTIVE"
        • "CLOUDFORMATION_STACK_NOT_EXISTING"
        • "CLOUDFORMATION_STACK_UNASSUMABLE_ROLE"
        • "RESOURCE_TYPE_NOT_SUPPORTED"
      • Message — (String)

        A message that explains the ErrorCode.

Returns:

• (AWS.Request) —

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

var params = {
  Filters: [
    {
      Name: resource-type | configuration-type, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
resourcegroups.listGroups(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: {}) —
  • Filters — (Array<map>)

    Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

    • resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

    • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

      • AWS::AppRegistry::Application

      • AWS::AppRegistry::ApplicationResourceGroups

      • AWS::CloudFormation::Stack

      • AWS::EC2::CapacityReservationPool

      • AWS::EC2::HostManagement

      • AWS::NetworkFirewall::RuleGroup

    • Name — required — (String)

      The name of the filter. Filter names are case-sensitive.

      Possible values include:
      • "resource-type"
      • "configuration-type"
    • Values — required — (Array<String>)

      One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive.

  • MaxResults — (Integer)

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken — (String)

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

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:

    • GroupIdentifiers — (Array<map>)

      A list of GroupIdentifier objects. Each identifier is an object that contains both the Name and the GroupArn.

      • GroupName — (String)

        The name of the resource group.

      • GroupArn — (String)

        The ARN of the resource group.

    • Groups — (Array<map>)

      Deprecated - don't use this field. Use the GroupIdentifiers response field instead.

      • GroupArn — required — (String)

        The ARN of the resource group.

      • Name — required — (String)

        The name of the resource group.

      • Description — (String)

        The description of the resource group.

    • NextToken — (String)

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

Returns:

• (AWS.Request) —

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

var params = {
  Configuration: [
    {
      Type: 'STRING_VALUE', /* required */
      Parameters: [
        {
          Name: 'STRING_VALUE', /* required */
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Group: 'STRING_VALUE'
};
resourcegroups.putGroupConfiguration(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: {}) —
  • Group — (String)

    The name or ARN of the resource group with the configuration that you want to update.

  • Configuration — (Array<map>)

    The new configuration to associate with the specified group. A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements.

    For information about the syntax of a service configuration, see Service configurations for Resource Groups.

    Note: A resource group can contain either a Configuration or a ResourceQuery, but not both.
    • Type — required — (String)

      Specifies the type of group configuration item. Each item must have a unique value for type. For the list of types that you can specify for a configuration item, see Supported resource types and parameters.

    • Parameters — (Array<map>)

      A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.

      • Name — required — (String)

        The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.

      • Values — (Array<String>)

        The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.

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 = {
  ResourceQuery: { /* required */
    Query: 'STRING_VALUE', /* required */
    Type: TAG_FILTERS_1_0 | CLOUDFORMATION_STACK_1_0 /* required */
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
resourcegroups.searchResources(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: {}) —
  • ResourceQuery — (map)

    The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

    • Type — required — (String)

      The type of the query to perform. This can have one of two values:

      • CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.

      • TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.

      Possible values include:
      • "TAG_FILTERS_1_0"
      • "CLOUDFORMATION_STACK_1_0"
    • Query — required — (String)

      The query that defines a group or a search. The contents depends on the value of the Type element.

      • ResourceTypeFilters – Applies to all ResourceQuery objects of either Type. This element contains one of the following two items:

        • The value AWS::AllSupported. This causes the ResourceQuery to match resources of any resource type that also match the query.

        • A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide.

        Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

      • TagFilters – applicable only if Type = TAG_FILTERS_1_0. The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.

        For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each:

        [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]

        The results of this resource query could include the following.

        • An Amazon EC2 instance that has the following two tags: {"Stage":"Deploy"}, and {"Version":"2"}

        • An S3 bucket that has the following two tags: {"Stage":"Test"}, and {"Version":"1"}

        The resource query results would not include the following items in the results, however.

        • An Amazon EC2 instance that has only the following tag: {"Stage":"Deploy"}.

          The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

        • An RDS database that has the following two tags: {"Stage":"Archived"} and {"Version":"4"}

          The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

        Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

      • StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0. The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.

  • MaxResults — (Integer)

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken — (String)

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

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:

    • ResourceIdentifiers — (Array<map>)

      The ARNs and resource types of resources that are members of the group that you specified.

      • ResourceArn — (String)

        The ARN of a resource.

      • ResourceType — (String)

        The resource type of a resource, such as AWS::EC2::Instance.

    • NextToken — (String)

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

    • QueryErrors — (Array<map>)

      A list of QueryError objects. Each error contains an ErrorCode and Message.

      Possible values for ErrorCode:

      • CLOUDFORMATION_STACK_INACTIVE

      • CLOUDFORMATION_STACK_NOT_EXISTING

      • CLOUDFORMATION_STACK_UNASSUMABLE_ROLE

      • ErrorCode — (String)

        Specifies the error code that was raised.

        Possible values include:
        • "CLOUDFORMATION_STACK_INACTIVE"
        • "CLOUDFORMATION_STACK_NOT_EXISTING"
        • "CLOUDFORMATION_STACK_UNASSUMABLE_ROLE"
        • "RESOURCE_TYPE_NOT_SUPPORTED"
      • Message — (String)

        A message that explains the ErrorCode.

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
resourcegroups.tag(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: {}) —
  • Arn — (String)

    The ARN of the resource group to which to add tags.

  • Tags — (map<String>)

    The tags to add to the specified resource group. A tag is a string-to-string map of key-value pairs.

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:

    • Arn — (String)

      The ARN of the tagged resource.

    • Tags — (map<String>)

      The tags that have been added to the specified resource group.

Returns:

• (AWS.Request) —

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

var params = {
  Group: 'STRING_VALUE', /* required */
  ResourceArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
resourcegroups.ungroupResources(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: {}) —
  • Group — (String)

    The name or the ARN of the resource group from which to remove the resources.

  • ResourceArns — (Array<String>)

    The ARNs of the resources to be removed from the group.

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:

    • Succeeded — (Array<String>)

      A list of resources that were successfully removed from the group by this operation.

    • Failed — (Array<map>)

      A list of any resources that failed to be removed from the group by this operation.

      • ResourceArn — (String)

        The ARN of the resource that failed to be added or removed.

      • ErrorMessage — (String)

        The error message text associated with the failure.

      • ErrorCode — (String)

        The error code associated with the failure.

    • Pending — (Array<map>)

      A list of any resources that are still in the process of being removed from the group by this operation. These pending removals continue asynchronously. You can check the status of pending removals by using the ListGroupResources operation. After the resource is successfully removed, it no longer appears in the response.

      • ResourceArn — (String)

        The Amazon resource name (ARN) of the resource that's in a pending state.

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE', /* required */
  Keys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
resourcegroups.untag(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: {}) —
  • Arn — (String)

    The ARN of the resource group from which to remove tags. The command removed both the specified keys and any values associated with those keys.

  • Keys — (Array<String>)

    The keys of the tags to be removed.

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:

    • Arn — (String)

      The ARN of the resource group from which tags have been removed.

    • Keys — (Array<String>)

      The keys of the tags that were removed.

Returns:

• (AWS.Request) —

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

var params = {
  GroupLifecycleEventsDesiredStatus: ACTIVE | INACTIVE
};
resourcegroups.updateAccountSettings(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: {}) —
  • GroupLifecycleEventsDesiredStatus — (String)

    Specifies whether you want to turn group lifecycle events on or off.

    Possible values include:
    • "ACTIVE"
    • "INACTIVE"

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:

    • AccountSettings — (map)

      A structure that displays the status of the optional features in the account.

      • GroupLifecycleEventsDesiredStatus — (String)

        The desired target status of the group lifecycle events feature. If

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • GroupLifecycleEventsStatus — (String)

        The current status of the group lifecycle events feature.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "IN_PROGRESS"
        • "ERROR"
      • GroupLifecycleEventsStatusMessage — (String)

        The text of any error message occurs during an attempt to turn group lifecycle events on or off.

Returns:

• (AWS.Request) —

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

var params = {
  Description: 'STRING_VALUE',
  Group: 'STRING_VALUE',
  GroupName: 'STRING_VALUE'
};
resourcegroups.updateGroup(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: {}) —
  • GroupName — (String)

    Don't use this parameter. Use Group instead.

  • Group — (String)

    The name or the ARN of the resource group to modify.

  • Description — (String)

    The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.

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:

    • Group — (map)

      The update description of the resource group.

      • GroupArn — required — (String)

        The ARN of the resource group.

      • Name — required — (String)

        The name of the resource group.

      • Description — (String)

        The description of the resource group.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceQuery: { /* required */
    Query: 'STRING_VALUE', /* required */
    Type: TAG_FILTERS_1_0 | CLOUDFORMATION_STACK_1_0 /* required */
  },
  Group: 'STRING_VALUE',
  GroupName: 'STRING_VALUE'
};
resourcegroups.updateGroupQuery(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: {}) —
  • GroupName — (String)

    Don't use this parameter. Use Group instead.

  • Group — (String)

    The name or the ARN of the resource group to query.

  • ResourceQuery — (map)

    The resource query to determine which Amazon Web Services resources are members of this resource group.

    Note: A resource group can contain either a Configuration or a ResourceQuery, but not both.
    • Type — required — (String)

      The type of the query to perform. This can have one of two values:

      • CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.

      • TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.

      Possible values include:
      • "TAG_FILTERS_1_0"
      • "CLOUDFORMATION_STACK_1_0"
    • Query — required — (String)

      The query that defines a group or a search. The contents depends on the value of the Type element.

      • ResourceTypeFilters – Applies to all ResourceQuery objects of either Type. This element contains one of the following two items:

        • The value AWS::AllSupported. This causes the ResourceQuery to match resources of any resource type that also match the query.

        • A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide.

        Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

      • TagFilters – applicable only if Type = TAG_FILTERS_1_0. The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.

        For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each:

        [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]

        The results of this resource query could include the following.

        • An Amazon EC2 instance that has the following two tags: {"Stage":"Deploy"}, and {"Version":"2"}

        • An S3 bucket that has the following two tags: {"Stage":"Test"}, and {"Version":"1"}

        The resource query results would not include the following items in the results, however.

        • An Amazon EC2 instance that has only the following tag: {"Stage":"Deploy"}.

          The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

        • An RDS database that has the following two tags: {"Stage":"Archived"} and {"Version":"4"}

          The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

        Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

      • StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0. The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.

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:

    • GroupQuery — (map)

      The updated resource query associated with the resource group after the update.

      • GroupName — required — (String)

        The name of the resource group that is associated with the specified resource query.

      • ResourceQuery — required — (map)

        The resource query that determines which Amazon Web Services resources are members of the associated resource group.

        • Type — required — (String)

          The type of the query to perform. This can have one of two values:

          • CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.

          • TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.

          Possible values include:
          • "TAG_FILTERS_1_0"
          • "CLOUDFORMATION_STACK_1_0"
        • Query — required — (String)

          The query that defines a group or a search. The contents depends on the value of the Type element.

          • ResourceTypeFilters – Applies to all ResourceQuery objects of either Type. This element contains one of the following two items:

            • The value AWS::AllSupported. This causes the ResourceQuery to match resources of any resource type that also match the query.

            • A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide.

            Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

          • TagFilters – applicable only if Type = TAG_FILTERS_1_0. The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.

            For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each:

            [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]

            The results of this resource query could include the following.

            • An Amazon EC2 instance that has the following two tags: {"Stage":"Deploy"}, and {"Version":"2"}

            • An S3 bucket that has the following two tags: {"Stage":"Test"}, and {"Version":"1"}

            The resource query results would not include the following items in the results, however.

            • An Amazon EC2 instance that has only the following tag: {"Stage":"Deploy"}.

              The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

            • An RDS database that has the following two tags: {"Stage":"Archived"} and {"Version":"4"}

              The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

            Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

          • StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0. The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.

Returns:

• (AWS.Request) —

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