Class: Aws::CognitoIdentity::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CognitoIdentity::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- lib/aws-sdk-cognitoidentity/client.rb
Overview
An API client for CognitoIdentity. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::CognitoIdentity::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_identity_pool(params = {}) ⇒ Types::IdentityPool
Creates a new identity pool.
-
#delete_identities(params = {}) ⇒ Types::DeleteIdentitiesResponse
Deletes identities from an identity pool.
-
#delete_identity_pool(params = {}) ⇒ Struct
Deletes an identity pool.
-
#describe_identity(params = {}) ⇒ Types::IdentityDescription
Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
-
#describe_identity_pool(params = {}) ⇒ Types::IdentityPool
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
-
#get_credentials_for_identity(params = {}) ⇒ Types::GetCredentialsForIdentityResponse
Returns credentials for the provided identity ID.
-
#get_id(params = {}) ⇒ Types::GetIdResponse
Generates (or retrieves) a Cognito ID.
-
#get_identity_pool_roles(params = {}) ⇒ Types::GetIdentityPoolRolesResponse
Gets the roles for an identity pool.
-
#get_open_id_token(params = {}) ⇒ Types::GetOpenIdTokenResponse
Gets an OpenID token, using a known Cognito ID.
-
#get_open_id_token_for_developer_identity(params = {}) ⇒ Types::GetOpenIdTokenForDeveloperIdentityResponse
Registers (or retrieves) a Cognito ‘IdentityId` and an OpenID Connect token for a user authenticated by your backend authentication process.
-
#get_principal_tag_attribute_map(params = {}) ⇒ Types::GetPrincipalTagAttributeMapResponse
Use ‘GetPrincipalTagAttributeMap` to list all mappings between `PrincipalTags` and user attributes.
-
#list_identities(params = {}) ⇒ Types::ListIdentitiesResponse
Lists the identities in an identity pool.
-
#list_identity_pools(params = {}) ⇒ Types::ListIdentityPoolsResponse
Lists all of the Cognito identity pools registered for your account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags that are assigned to an Amazon Cognito identity pool.
-
#lookup_developer_identity(params = {}) ⇒ Types::LookupDeveloperIdentityResponse
Retrieves the ‘IdentityID` associated with a `DeveloperUserIdentifier` or the list of `DeveloperUserIdentifier` values associated with an `IdentityId` for an existing identity.
-
#merge_developer_identities(params = {}) ⇒ Types::MergeDeveloperIdentitiesResponse
Merges two users having different ‘IdentityId`s, existing in the same identity pool, and identified by the same developer provider.
-
#set_identity_pool_roles(params = {}) ⇒ Struct
Sets the roles for an identity pool.
-
#set_principal_tag_attribute_map(params = {}) ⇒ Types::SetPrincipalTagAttributeMapResponse
You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
-
#tag_resource(params = {}) ⇒ Struct
Assigns a set of tags to the specified Amazon Cognito identity pool.
-
#unlink_developer_identity(params = {}) ⇒ Struct
Unlinks a ‘DeveloperUserIdentifier` from an existing identity.
-
#unlink_identity(params = {}) ⇒ Struct
Unlinks a federated identity from an existing account.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified Amazon Cognito identity pool.
-
#update_identity_pool(params = {}) ⇒ Types::IdentityPool
Updates an identity pool.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 429 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1718 1719 1720 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1718 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1721 1722 1723 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1721 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1696 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-cognitoidentity' context[:gem_version] = '1.60.0' Seahorse::Client::Request.new(handlers, context) end |
#create_identity_pool(params = {}) ⇒ Types::IdentityPool
Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The keys for ‘SupportedLoginProviders` are as follows:
-
Facebook: ‘graph.facebook.com`
-
Google: ‘accounts.google.com`
-
Amazon: ‘www.amazon.com`
-
Twitter: ‘api.twitter.com`
-
Digits: ‘www.digits.com`
You must use AWS Developer credentials to call this API.
555 556 557 558 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 555 def create_identity_pool(params = {}, = {}) req = build_request(:create_identity_pool, params) req.send_request() end |
#delete_identities(params = {}) ⇒ Types::DeleteIdentitiesResponse
Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.
You must use AWS Developer credentials to call this API.
588 589 590 591 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 588 def delete_identities(params = {}, = {}) req = build_request(:delete_identities, params) req.send_request() end |
#delete_identity_pool(params = {}) ⇒ Struct
Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
613 614 615 616 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 613 def delete_identity_pool(params = {}, = {}) req = build_request(:delete_identity_pool, params) req.send_request() end |
#describe_identity(params = {}) ⇒ Types::IdentityDescription
Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
You must use AWS Developer credentials to call this API.
651 652 653 654 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 651 def describe_identity(params = {}, = {}) req = build_request(:describe_identity, params) req.send_request() end |
#describe_identity_pool(params = {}) ⇒ Types::IdentityPool
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
You must use AWS Developer credentials to call this API.
707 708 709 710 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 707 def describe_identity_pool(params = {}, = {}) req = build_request(:describe_identity_pool, params) req.send_request() end |
#get_credentials_for_identity(params = {}) ⇒ Types::GetCredentialsForIdentityResponse
Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
This is a public API. You do not need any credentials to call this API.
773 774 775 776 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 773 def get_credentials_for_identity(params = {}, = {}) req = build_request(:get_credentials_for_identity, params) req.send_request() end |
#get_id(params = {}) ⇒ Types::GetIdResponse
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.
830 831 832 833 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 830 def get_id(params = {}, = {}) req = build_request(:get_id, params) req.send_request() end |
#get_identity_pool_roles(params = {}) ⇒ Types::GetIdentityPoolRolesResponse
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
872 873 874 875 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 872 def get_identity_pool_roles(params = {}, = {}) req = build_request(:get_identity_pool_roles, params) req.send_request() end |
#get_open_id_token(params = {}) ⇒ Types::GetOpenIdTokenResponse
Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
The OpenID token is valid for 10 minutes.
This is a public API. You do not need any credentials to call this API.
919 920 921 922 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 919 def get_open_id_token(params = {}, = {}) req = build_request(:get_open_id_token, params) req.send_request() end |
#get_open_id_token_for_developer_identity(params = {}) ⇒ Types::GetOpenIdTokenForDeveloperIdentityResponse
Registers (or retrieves) a Cognito ‘IdentityId` and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the `Logins` map, which is linked to the identity pool. The developer provider is the “domain” by which Cognito will refer to your users.
You can use ‘GetOpenIdTokenForDeveloperIdentity` to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the `IdentityId` should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing `IdentityId`. This API will create the identity in the specified `IdentityPoolId`.
You must use AWS Developer credentials to call this API.
1008 1009 1010 1011 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1008 def get_open_id_token_for_developer_identity(params = {}, = {}) req = build_request(:get_open_id_token_for_developer_identity, params) req.send_request() end |
#get_principal_tag_attribute_map(params = {}) ⇒ Types::GetPrincipalTagAttributeMapResponse
Use ‘GetPrincipalTagAttributeMap` to list all mappings between `PrincipalTags` and user attributes.
1049 1050 1051 1052 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1049 def get_principal_tag_attribute_map(params = {}, = {}) req = build_request(:get_principal_tag_attribute_map, params) req.send_request() end |
#list_identities(params = {}) ⇒ Types::ListIdentitiesResponse
Lists the identities in an identity pool.
You must use AWS Developer credentials to call this API.
1102 1103 1104 1105 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1102 def list_identities(params = {}, = {}) req = build_request(:list_identities, params) req.send_request() end |
#list_identity_pools(params = {}) ⇒ Types::ListIdentityPoolsResponse
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1142 1143 1144 1145 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1142 def list_identity_pools(params = {}, = {}) req = build_request(:list_identity_pools, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags that are assigned to an Amazon Cognito identity pool.
A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
1178 1179 1180 1181 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1178 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#lookup_developer_identity(params = {}) ⇒ Types::LookupDeveloperIdentityResponse
Retrieves the ‘IdentityID` associated with a `DeveloperUserIdentifier` or the list of `DeveloperUserIdentifier` values associated with an `IdentityId` for an existing identity. Either `IdentityID` or `DeveloperUserIdentifier` must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, `DeveloperUserIdentifier` will be matched against `IdentityID`. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a `ResourceConflictException` is thrown.
‘LookupDeveloperIdentity` is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication.
You must use AWS Developer credentials to call this API.
1253 1254 1255 1256 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1253 def lookup_developer_identity(params = {}, = {}) req = build_request(:lookup_developer_identity, params) req.send_request() end |
#merge_developer_identities(params = {}) ⇒ Types::MergeDeveloperIdentitiesResponse
Merges two users having different ‘IdentityId`s, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (`SourceUserIdentifier`) with the `IdentityId` of the `DestinationUserIdentifier`. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.
The number of linked logins is limited to 20. So, the number of linked logins for the source user, ‘SourceUserIdentifier`, and the destination user, `DestinationUserIdentifier`, together should not be larger than 20. Otherwise, an exception will be thrown.
You must use AWS Developer credentials to call this API.
1315 1316 1317 1318 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1315 def merge_developer_identities(params = {}, = {}) req = build_request(:merge_developer_identities, params) req.send_request() end |
#set_identity_pool_roles(params = {}) ⇒ Struct
Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.
You must use AWS Developer credentials to call this API.
1372 1373 1374 1375 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1372 def set_identity_pool_roles(params = {}, = {}) req = build_request(:set_identity_pool_roles, params) req.send_request() end |
#set_principal_tag_attribute_map(params = {}) ⇒ Types::SetPrincipalTagAttributeMapResponse
You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
1423 1424 1425 1426 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1423 def set_principal_tag_attribute_map(params = {}, = {}) req = build_request(:set_principal_tag_attribute_map, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an ‘Environment` tag key to both identity pools. The value of this key might be `Test` for one identity pool and `Production` for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.
1470 1471 1472 1473 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1470 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#unlink_developer_identity(params = {}) ⇒ Struct
Unlinks a ‘DeveloperUserIdentifier` from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.
You must use AWS Developer credentials to call this API.
1511 1512 1513 1514 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1511 def unlink_developer_identity(params = {}, = {}) req = build_request(:unlink_developer_identity, params) req.send_request() end |
#unlink_identity(params = {}) ⇒ Struct
Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.
This is a public API. You do not need any credentials to call this API.
1549 1550 1551 1552 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1549 def unlink_identity(params = {}, = {}) req = build_request(:unlink_identity, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
1576 1577 1578 1579 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1576 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_identity_pool(params = {}) ⇒ Types::IdentityPool
Updates an identity pool.
You must use AWS Developer credentials to call this API.
1687 1688 1689 1690 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1687 def update_identity_pool(params = {}, = {}) req = build_request(:update_identity_pool, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1711 1712 1713 |
# File 'lib/aws-sdk-cognitoidentity/client.rb', line 1711 def waiter_names [] end |