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

Class: Aws::CognitoIdentity::Types::ListIdentitiesInput

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

Overview

Note:

When making an API call, you may pass ListIdentitiesInput data as a 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

Instance Attribute Details

#hide_disabledBoolean

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

Returns:

  • (Boolean)


685
686
687
688
689
690
691
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 685

class ListIdentitiesInput < Struct.new(
  :identity_pool_id,
  :max_results,
  :next_token,
  :hide_disabled)
  include Aws::Structure
end

#identity_pool_idString

An identity pool ID in the format REGION:GUID.

Returns:

  • (String)


685
686
687
688
689
690
691
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 685

class ListIdentitiesInput < Struct.new(
  :identity_pool_id,
  :max_results,
  :next_token,
  :hide_disabled)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of identities to return.

Returns:

  • (Integer)


685
686
687
688
689
690
691
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 685

class ListIdentitiesInput < Struct.new(
  :identity_pool_id,
  :max_results,
  :next_token,
  :hide_disabled)
  include Aws::Structure
end

#next_tokenString

A pagination token.

Returns:

  • (String)


685
686
687
688
689
690
691
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 685

class ListIdentitiesInput < Struct.new(
  :identity_pool_id,
  :max_results,
  :next_token,
  :hide_disabled)
  include Aws::Structure
end