You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IAM::Types::ListGroupsRequest

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

Overview

Note:

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

{
  path_prefix: "pathPrefixType",
  marker: "markerType",
  max_items: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#markerString

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

Returns:

  • (String)


5623
5624
5625
5626
5627
5628
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 5623

class ListGroupsRequest < Struct.new(
  :path_prefix,
  :marker,
  :max_items)
  include Aws::Structure
end

#max_itemsInteger

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Returns:

  • (Integer)


5623
5624
5625
5626
5627
5628
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 5623

class ListGroupsRequest < Struct.new(
  :path_prefix,
  :marker,
  :max_items)
  include Aws::Structure
end

#path_prefixString

The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Returns:

  • (String)


5623
5624
5625
5626
5627
5628
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 5623

class ListGroupsRequest < Struct.new(
  :path_prefix,
  :marker,
  :max_items)
  include Aws::Structure
end