Class: Aws::ResourceExplorer2::Types::ListIndexesInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

The maximum 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 appropriate to the operation. If additional items exist beyond those included in the current response, 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.

An API operation can 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) 


704
705
706
707
708
709
710
711
 
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 704

class ListIndexesInput < Struct.new(
  :max_results,
  :next_token,
  :regions,
  :type)
  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 of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.

Returns:

  • (String) 


704
705
706
707
708
709
710
711
 
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 704

class ListIndexesInput < Struct.new(
  :max_results,
  :next_token,
  :regions,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<String>

If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

Returns:

  • (Array<String>) 


704
705
706
707
708
709
710
711
 
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 704

class ListIndexesInput < Struct.new(
  :max_results,
  :next_token,
  :regions,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

Use this option to discover the aggregator index for your account.

Returns:

  • (String) 


704
705
706
707
708
709
710
711
 
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 704

class ListIndexesInput < Struct.new(
  :max_results,
  :next_token,
  :regions,
  :type)
  SENSITIVE = []
  include Aws::Structure
end