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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Array<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 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

Returns:



826
827
828
829
830
831
832
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 826

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

#max_results ⇒ 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.

Returns:

  • (Integer) 


826
827
828
829
830
831
832
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 826

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

#next_token ⇒ 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.

Returns:

  • (String) 


826
827
828
829
830
831
832
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 826

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