Class: Aws::IdentityStore::Types::ListGroupsRequest

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

Overview

Note:

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

{
  identity_store_id: "IdentityStoreId", # required
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      attribute_path: "AttributePath", # required
      attribute_value: "SensitiveStringType", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Returns:



262
263
264
265
266
267
268
269
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 262

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

#identity_store_idString

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.

Returns:

  • (String)


262
263
264
265
266
267
268
269
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 262

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

#max_resultsInteger

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

Returns:

  • (Integer)


262
263
264
265
266
267
268
269
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 262

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

#next_tokenString

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Returns:

  • (String)


262
263
264
265
266
267
268
269
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 262

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