AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Module: Aws::CognitoIdentity

Defined in:


This module provides a client for making API requests to Amazon Cognito Identity.


The Client class provides one-to-one mapping for each API operation.

cognitoidentity = 'us-east-1')
#=> [:create_identity_pool, :delete_identities, :delete_identity_pool, :describe_identity, ...]

Each API operation method accepts a hash of request parameters and returns a response object.

resp = cognitoidentity.create_identity_pool(params)

See Client for more information.


Errors returned from Amazon Cognito Identity are defined in the Errors module and extend Errors::ServiceError.

  # do stuff
rescue Aws::CognitoIdentity::Errors::ServiceError
  # rescues all errors returned by Amazon Cognito Identity

See Errors for more information.

Defined Under Namespace

Modules: Errors, Types Classes: Client