Class: Aws::ResourceGroups::Types::ListGroupsInput

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 ListGroupsInput data as a hash:

{
  filters: [
    {
      name: "resource-type", # required, accepts resource-type, configuration-type
      values: ["GroupFilterValue"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::GroupFilter>

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

  • resource-type - Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

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

    • AWS:EC2::CapacityReservationPool

    ^

Returns:



837
838
839
840
841
842
843
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 837

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

#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)


837
838
839
840
841
842
843
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 837

class ListGroupsInput < Struct.new(
  :filters,
  :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)


837
838
839
840
841
842
843
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 837

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