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

Module: Aws::CognitoIdentityProvider

Defined in:
(unknown)

Overview

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

Aws::CognitoIdentityProvider::Client

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

cognitoidentityprovider = Aws::CognitoIdentityProvider::Client.new(region: 'us-east-1')
cognitoidentityprovider.operation_names
#=> [:add_custom_attributes, :admin_add_user_to_group, :admin_confirm_sign_up, :admin_create_user, ...]

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

resp = cognitoidentityprovider.add_custom_attributes(params)

See Client for more information.

Aws::CognitoIdentityProvider::Errors

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

begin
  # do stuff
rescue Aws::CognitoIdentityProvider::Errors::ServiceError
  # rescues all errors returned by Amazon Cognito Identity Provider
end

See Errors for more information.

Defined Under Namespace

Modules: Errors, Types Classes: Client