Class: Aws::CognitoIdentity::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CognitoIdentity::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cognitoidentity/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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 betweenPrincipalTags
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 aDeveloperUserIdentifier
or the list ofDeveloperUserIdentifier
values associated with anIdentityId
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
453 454 455 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 453 def initialize(*args) super end |
Instance Method Details
#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.
579 580 581 582 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 579 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.
612 613 614 615 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 612 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.
637 638 639 640 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 637 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.
675 676 677 678 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 675 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.
731 732 733 734 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 731 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.
797 798 799 800 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 797 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.
854 855 856 857 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 854 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.
896 897 898 899 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 896 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.
943 944 945 946 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 943 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.
1032 1033 1034 1035 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1032 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.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1073 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.
1126 1127 1128 1129 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1126 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.
1166 1167 1168 1169 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1166 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.
1202 1203 1204 1205 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1202 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.
1277 1278 1279 1280 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1277 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.
1339 1340 1341 1342 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1339 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.
1396 1397 1398 1399 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1396 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.
1447 1448 1449 1450 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1447 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.
1494 1495 1496 1497 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1494 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.
1535 1536 1537 1538 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1535 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.
1573 1574 1575 1576 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1573 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
1600 1601 1602 1603 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1600 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.
1711 1712 1713 1714 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1711 def update_identity_pool(params = {}, = {}) req = build_request(:update_identity_pool, params) req.send_request() end |