Class: Aws::IAM::Types::GetGroupRequest

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

Overview

Note:

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

{
  group_name: "groupNameType", # required
  marker: "markerType",
  max_items: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#group_nameString

The name of the group.

This parameter allows (through its [regex pattern]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,[email protected]

[1]: wikipedia.org/wiki/regex

Returns:

  • (String)

3740
3741
3742
3743
3744
3745
3746
# File 'lib/aws-sdk-iam/types.rb', line 3740

class GetGroupRequest < Struct.new(
  :group_name,
  :marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

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

3740
3741
3742
3743
3744
3745
3746
# File 'lib/aws-sdk-iam/types.rb', line 3740

class GetGroupRequest < Struct.new(
  :group_name,
  :marker,
  :max_items)
  SENSITIVE = []
  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)

3740
3741
3742
3743
3744
3745
3746
# File 'lib/aws-sdk-iam/types.rb', line 3740

class GetGroupRequest < Struct.new(
  :group_name,
  :marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end