You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CognitoIdentity::Types::ListIdentitiesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentity::Types::ListIdentitiesInput
- Defined in:
- (unknown)
Overview
Note:
When passing ListIdentitiesInput as input to an Aws::Client method, you can use a vanilla Hash:
{
identity_pool_id: "IdentityPoolId", # required
max_results: 1, # required
next_token: "PaginationKey",
hide_disabled: false,
}
Input to the ListIdentities action.
Instance Attribute Summary collapse
-
#hide_disabled ⇒ Boolean
An optional boolean parameter that allows you to hide disabled identities.
-
#identity_pool_id ⇒ String
An identity pool ID in the format REGION:GUID.
-
#max_results ⇒ Integer
The maximum number of identities to return.
-
#next_token ⇒ String
A pagination token.
Instance Attribute Details
#hide_disabled ⇒ Boolean
An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
#identity_pool_id ⇒ String
An identity pool ID in the format REGION:GUID.
#max_results ⇒ Integer
The maximum number of identities to return.
#next_token ⇒ String
A pagination token.