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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListGroupsRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Array<Types::Filter>

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

Returns:

  • (Array<Types::Filter>) —

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

#identity_store_id ⇒ String

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 which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Returns:

  • (String) —

    The globally unique identifier for the identity store, such as d-1234567890.

#max_results ⇒ Integer

The maximum number of results to be returned per request, which 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) —

    The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page.

#next_token ⇒ String

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

Returns:

  • (String) —

    The pagination token used for the ListUsers and ListGroups APIs.