AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ResourceGroups::Types::SearchResourcesInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb

Overview

Note:

When making an API call, you may pass SearchResourcesInput data as a hash:

{
  resource_query: { # required
    type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
    query: "Query", # required
  },
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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.

Returns:

  • (Integer)


1309
1310
1311
1312
1313
1314
1315
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 1309

class SearchResourcesInput < Struct.new(
  :resource_query,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


1309
1310
1311
1312
1313
1314
1315
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 1309

class SearchResourcesInput < Struct.new(
  :resource_query,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_queryTypes::ResourceQuery

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



1309
1310
1311
1312
1313
1314
1315
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 1309

class SearchResourcesInput < Struct.new(
  :resource_query,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end