AWS SDK for C++  1.8.3
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::CognitoIdentity::CognitoIdentityClient Class Reference

#include <CognitoIdentityClient.h>

+ Inheritance diagram for Aws::CognitoIdentity::CognitoIdentityClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 CognitoIdentityClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 CognitoIdentityClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 CognitoIdentityClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~CognitoIdentityClient ()
 
virtual const char * GetServiceClientName () const override
 
virtual Model::CreateIdentityPoolOutcome CreateIdentityPool (const Model::CreateIdentityPoolRequest &request) const
 
virtual Model::CreateIdentityPoolOutcomeCallable CreateIdentityPoolCallable (const Model::CreateIdentityPoolRequest &request) const
 
virtual void CreateIdentityPoolAsync (const Model::CreateIdentityPoolRequest &request, const CreateIdentityPoolResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteIdentitiesOutcome DeleteIdentities (const Model::DeleteIdentitiesRequest &request) const
 
virtual Model::DeleteIdentitiesOutcomeCallable DeleteIdentitiesCallable (const Model::DeleteIdentitiesRequest &request) const
 
virtual void DeleteIdentitiesAsync (const Model::DeleteIdentitiesRequest &request, const DeleteIdentitiesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteIdentityPoolOutcome DeleteIdentityPool (const Model::DeleteIdentityPoolRequest &request) const
 
virtual Model::DeleteIdentityPoolOutcomeCallable DeleteIdentityPoolCallable (const Model::DeleteIdentityPoolRequest &request) const
 
virtual void DeleteIdentityPoolAsync (const Model::DeleteIdentityPoolRequest &request, const DeleteIdentityPoolResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeIdentityOutcome DescribeIdentity (const Model::DescribeIdentityRequest &request) const
 
virtual Model::DescribeIdentityOutcomeCallable DescribeIdentityCallable (const Model::DescribeIdentityRequest &request) const
 
virtual void DescribeIdentityAsync (const Model::DescribeIdentityRequest &request, const DescribeIdentityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeIdentityPoolOutcome DescribeIdentityPool (const Model::DescribeIdentityPoolRequest &request) const
 
virtual Model::DescribeIdentityPoolOutcomeCallable DescribeIdentityPoolCallable (const Model::DescribeIdentityPoolRequest &request) const
 
virtual void DescribeIdentityPoolAsync (const Model::DescribeIdentityPoolRequest &request, const DescribeIdentityPoolResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetCredentialsForIdentityOutcome GetCredentialsForIdentity (const Model::GetCredentialsForIdentityRequest &request) const
 
virtual Model::GetCredentialsForIdentityOutcomeCallable GetCredentialsForIdentityCallable (const Model::GetCredentialsForIdentityRequest &request) const
 
virtual void GetCredentialsForIdentityAsync (const Model::GetCredentialsForIdentityRequest &request, const GetCredentialsForIdentityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetIdOutcome GetId (const Model::GetIdRequest &request) const
 
virtual Model::GetIdOutcomeCallable GetIdCallable (const Model::GetIdRequest &request) const
 
virtual void GetIdAsync (const Model::GetIdRequest &request, const GetIdResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetIdentityPoolRolesOutcome GetIdentityPoolRoles (const Model::GetIdentityPoolRolesRequest &request) const
 
virtual Model::GetIdentityPoolRolesOutcomeCallable GetIdentityPoolRolesCallable (const Model::GetIdentityPoolRolesRequest &request) const
 
virtual void GetIdentityPoolRolesAsync (const Model::GetIdentityPoolRolesRequest &request, const GetIdentityPoolRolesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetOpenIdTokenOutcome GetOpenIdToken (const Model::GetOpenIdTokenRequest &request) const
 
virtual Model::GetOpenIdTokenOutcomeCallable GetOpenIdTokenCallable (const Model::GetOpenIdTokenRequest &request) const
 
virtual void GetOpenIdTokenAsync (const Model::GetOpenIdTokenRequest &request, const GetOpenIdTokenResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetOpenIdTokenForDeveloperIdentityOutcome GetOpenIdTokenForDeveloperIdentity (const Model::GetOpenIdTokenForDeveloperIdentityRequest &request) const
 
virtual Model::GetOpenIdTokenForDeveloperIdentityOutcomeCallable GetOpenIdTokenForDeveloperIdentityCallable (const Model::GetOpenIdTokenForDeveloperIdentityRequest &request) const
 
virtual void GetOpenIdTokenForDeveloperIdentityAsync (const Model::GetOpenIdTokenForDeveloperIdentityRequest &request, const GetOpenIdTokenForDeveloperIdentityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListIdentitiesOutcome ListIdentities (const Model::ListIdentitiesRequest &request) const
 
virtual Model::ListIdentitiesOutcomeCallable ListIdentitiesCallable (const Model::ListIdentitiesRequest &request) const
 
virtual void ListIdentitiesAsync (const Model::ListIdentitiesRequest &request, const ListIdentitiesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListIdentityPoolsOutcome ListIdentityPools (const Model::ListIdentityPoolsRequest &request) const
 
virtual Model::ListIdentityPoolsOutcomeCallable ListIdentityPoolsCallable (const Model::ListIdentityPoolsRequest &request) const
 
virtual void ListIdentityPoolsAsync (const Model::ListIdentityPoolsRequest &request, const ListIdentityPoolsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const
 
virtual Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const Model::ListTagsForResourceRequest &request) const
 
virtual void ListTagsForResourceAsync (const Model::ListTagsForResourceRequest &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::LookupDeveloperIdentityOutcome LookupDeveloperIdentity (const Model::LookupDeveloperIdentityRequest &request) const
 
virtual Model::LookupDeveloperIdentityOutcomeCallable LookupDeveloperIdentityCallable (const Model::LookupDeveloperIdentityRequest &request) const
 
virtual void LookupDeveloperIdentityAsync (const Model::LookupDeveloperIdentityRequest &request, const LookupDeveloperIdentityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::MergeDeveloperIdentitiesOutcome MergeDeveloperIdentities (const Model::MergeDeveloperIdentitiesRequest &request) const
 
virtual Model::MergeDeveloperIdentitiesOutcomeCallable MergeDeveloperIdentitiesCallable (const Model::MergeDeveloperIdentitiesRequest &request) const
 
virtual void MergeDeveloperIdentitiesAsync (const Model::MergeDeveloperIdentitiesRequest &request, const MergeDeveloperIdentitiesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SetIdentityPoolRolesOutcome SetIdentityPoolRoles (const Model::SetIdentityPoolRolesRequest &request) const
 
virtual Model::SetIdentityPoolRolesOutcomeCallable SetIdentityPoolRolesCallable (const Model::SetIdentityPoolRolesRequest &request) const
 
virtual void SetIdentityPoolRolesAsync (const Model::SetIdentityPoolRolesRequest &request, const SetIdentityPoolRolesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const
 
virtual Model::TagResourceOutcomeCallable TagResourceCallable (const Model::TagResourceRequest &request) const
 
virtual void TagResourceAsync (const Model::TagResourceRequest &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UnlinkDeveloperIdentityOutcome UnlinkDeveloperIdentity (const Model::UnlinkDeveloperIdentityRequest &request) const
 
virtual Model::UnlinkDeveloperIdentityOutcomeCallable UnlinkDeveloperIdentityCallable (const Model::UnlinkDeveloperIdentityRequest &request) const
 
virtual void UnlinkDeveloperIdentityAsync (const Model::UnlinkDeveloperIdentityRequest &request, const UnlinkDeveloperIdentityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UnlinkIdentityOutcome UnlinkIdentity (const Model::UnlinkIdentityRequest &request) const
 
virtual Model::UnlinkIdentityOutcomeCallable UnlinkIdentityCallable (const Model::UnlinkIdentityRequest &request) const
 
virtual void UnlinkIdentityAsync (const Model::UnlinkIdentityRequest &request, const UnlinkIdentityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const
 
virtual Model::UntagResourceOutcomeCallable UntagResourceCallable (const Model::UntagResourceRequest &request) const
 
virtual void UntagResourceAsync (const Model::UntagResourceRequest &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateIdentityPoolOutcome UpdateIdentityPool (const Model::UpdateIdentityPoolRequest &request) const
 
virtual Model::UpdateIdentityPoolOutcomeCallable UpdateIdentityPoolCallable (const Model::UpdateIdentityPoolRequest &request) const
 
virtual void UpdateIdentityPoolAsync (const Model::UpdateIdentityPoolRequest &request, const UpdateIdentityPoolResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

<fullname>Amazon Cognito Federated Identities</fullname>

Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow.

For more information see Amazon Cognito Federated Identities.

Definition at line 180 of file CognitoIdentityClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 183 of file CognitoIdentityClient.h.

Constructor & Destructor Documentation

◆ CognitoIdentityClient() [1/3]

Aws::CognitoIdentity::CognitoIdentityClient::CognitoIdentityClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ CognitoIdentityClient() [2/3]

Aws::CognitoIdentity::CognitoIdentityClient::CognitoIdentityClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ CognitoIdentityClient() [3/3]

Aws::CognitoIdentity::CognitoIdentityClient::CognitoIdentityClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~CognitoIdentityClient()

virtual Aws::CognitoIdentity::CognitoIdentityClient::~CognitoIdentityClient ( )
virtual

Member Function Documentation

◆ CreateIdentityPool()

virtual Model::CreateIdentityPoolOutcome Aws::CognitoIdentity::CognitoIdentityClient::CreateIdentityPool ( const Model::CreateIdentityPoolRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ CreateIdentityPoolAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::CreateIdentityPoolAsync ( const Model::CreateIdentityPoolRequest request,
const CreateIdentityPoolResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateIdentityPoolCallable()

virtual Model::CreateIdentityPoolOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::CreateIdentityPoolCallable ( const Model::CreateIdentityPoolRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteIdentities()

virtual Model::DeleteIdentitiesOutcome Aws::CognitoIdentity::CognitoIdentityClient::DeleteIdentities ( const Model::DeleteIdentitiesRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ DeleteIdentitiesAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::DeleteIdentitiesAsync ( const Model::DeleteIdentitiesRequest request,
const DeleteIdentitiesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteIdentitiesCallable()

virtual Model::DeleteIdentitiesOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::DeleteIdentitiesCallable ( const Model::DeleteIdentitiesRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteIdentityPool()

virtual Model::DeleteIdentityPoolOutcome Aws::CognitoIdentity::CognitoIdentityClient::DeleteIdentityPool ( const Model::DeleteIdentityPoolRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ DeleteIdentityPoolAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::DeleteIdentityPoolAsync ( const Model::DeleteIdentityPoolRequest request,
const DeleteIdentityPoolResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteIdentityPoolCallable()

virtual Model::DeleteIdentityPoolOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::DeleteIdentityPoolCallable ( const Model::DeleteIdentityPoolRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeIdentity()

virtual Model::DescribeIdentityOutcome Aws::CognitoIdentity::CognitoIdentityClient::DescribeIdentity ( const Model::DescribeIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ DescribeIdentityAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::DescribeIdentityAsync ( const Model::DescribeIdentityRequest request,
const DescribeIdentityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeIdentityCallable()

virtual Model::DescribeIdentityOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::DescribeIdentityCallable ( const Model::DescribeIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeIdentityPool()

virtual Model::DescribeIdentityPoolOutcome Aws::CognitoIdentity::CognitoIdentityClient::DescribeIdentityPool ( const Model::DescribeIdentityPoolRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ DescribeIdentityPoolAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::DescribeIdentityPoolAsync ( const Model::DescribeIdentityPoolRequest request,
const DescribeIdentityPoolResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeIdentityPoolCallable()

virtual Model::DescribeIdentityPoolOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::DescribeIdentityPoolCallable ( const Model::DescribeIdentityPoolRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetCredentialsForIdentity()

virtual Model::GetCredentialsForIdentityOutcome Aws::CognitoIdentity::CognitoIdentityClient::GetCredentialsForIdentity ( const Model::GetCredentialsForIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetCredentialsForIdentityAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::GetCredentialsForIdentityAsync ( const Model::GetCredentialsForIdentityRequest request,
const GetCredentialsForIdentityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetCredentialsForIdentityCallable()

virtual Model::GetCredentialsForIdentityOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::GetCredentialsForIdentityCallable ( const Model::GetCredentialsForIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetId()

virtual Model::GetIdOutcome Aws::CognitoIdentity::CognitoIdentityClient::GetId ( const Model::GetIdRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetIdAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::GetIdAsync ( const Model::GetIdRequest request,
const GetIdResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetIdCallable()

virtual Model::GetIdOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::GetIdCallable ( const Model::GetIdRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetIdentityPoolRoles()

virtual Model::GetIdentityPoolRolesOutcome Aws::CognitoIdentity::CognitoIdentityClient::GetIdentityPoolRoles ( const Model::GetIdentityPoolRolesRequest request) const
virtual

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

◆ GetIdentityPoolRolesAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::GetIdentityPoolRolesAsync ( const Model::GetIdentityPoolRolesRequest request,
const GetIdentityPoolRolesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetIdentityPoolRolesCallable()

virtual Model::GetIdentityPoolRolesOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::GetIdentityPoolRolesCallable ( const Model::GetIdentityPoolRolesRequest request) const
virtual

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetOpenIdToken()

virtual Model::GetOpenIdTokenOutcome Aws::CognitoIdentity::CognitoIdentityClient::GetOpenIdToken ( const Model::GetOpenIdTokenRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetOpenIdTokenAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::GetOpenIdTokenAsync ( const Model::GetOpenIdTokenRequest request,
const GetOpenIdTokenResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetOpenIdTokenCallable()

virtual Model::GetOpenIdTokenOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::GetOpenIdTokenCallable ( const Model::GetOpenIdTokenRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetOpenIdTokenForDeveloperIdentity()

virtual Model::GetOpenIdTokenForDeveloperIdentityOutcome Aws::CognitoIdentity::CognitoIdentityClient::GetOpenIdTokenForDeveloperIdentity ( const Model::GetOpenIdTokenForDeveloperIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetOpenIdTokenForDeveloperIdentityAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::GetOpenIdTokenForDeveloperIdentityAsync ( const Model::GetOpenIdTokenForDeveloperIdentityRequest request,
const GetOpenIdTokenForDeveloperIdentityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetOpenIdTokenForDeveloperIdentityCallable()

virtual Model::GetOpenIdTokenForDeveloperIdentityOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::GetOpenIdTokenForDeveloperIdentityCallable ( const Model::GetOpenIdTokenForDeveloperIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetServiceClientName()

virtual const char* Aws::CognitoIdentity::CognitoIdentityClient::GetServiceClientName ( ) const
inlineoverridevirtual

Reimplemented from Aws::Client::AWSClient.

Definition at line 206 of file CognitoIdentityClient.h.

◆ ListIdentities()

virtual Model::ListIdentitiesOutcome Aws::CognitoIdentity::CognitoIdentityClient::ListIdentities ( const Model::ListIdentitiesRequest request) const
virtual

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

◆ ListIdentitiesAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::ListIdentitiesAsync ( const Model::ListIdentitiesRequest request,
const ListIdentitiesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListIdentitiesCallable()

virtual Model::ListIdentitiesOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::ListIdentitiesCallable ( const Model::ListIdentitiesRequest request) const
virtual

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListIdentityPools()

virtual Model::ListIdentityPoolsOutcome Aws::CognitoIdentity::CognitoIdentityClient::ListIdentityPools ( const Model::ListIdentityPoolsRequest request) const
virtual

Lists all of the Cognito identity pools registered for your account.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

◆ ListIdentityPoolsAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::ListIdentityPoolsAsync ( const Model::ListIdentityPoolsRequest request,
const ListIdentityPoolsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists all of the Cognito identity pools registered for your account.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListIdentityPoolsCallable()

virtual Model::ListIdentityPoolsOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::ListIdentityPoolsCallable ( const Model::ListIdentityPoolsRequest request) const
virtual

Lists all of the Cognito identity pools registered for your account.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::CognitoIdentity::CognitoIdentityClient::ListTagsForResource ( const Model::ListTagsForResourceRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ ListTagsForResourceAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::ListTagsForResourceAsync ( const Model::ListTagsForResourceRequest request,
const ListTagsForResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListTagsForResourceCallable()

virtual Model::ListTagsForResourceOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::ListTagsForResourceCallable ( const Model::ListTagsForResourceRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ LookupDeveloperIdentity()

virtual Model::LookupDeveloperIdentityOutcome Aws::CognitoIdentity::CognitoIdentityClient::LookupDeveloperIdentity ( const Model::LookupDeveloperIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ LookupDeveloperIdentityAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::LookupDeveloperIdentityAsync ( const Model::LookupDeveloperIdentityRequest request,
const LookupDeveloperIdentityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ LookupDeveloperIdentityCallable()

virtual Model::LookupDeveloperIdentityOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::LookupDeveloperIdentityCallable ( const Model::LookupDeveloperIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ MergeDeveloperIdentities()

virtual Model::MergeDeveloperIdentitiesOutcome Aws::CognitoIdentity::CognitoIdentityClient::MergeDeveloperIdentities ( const Model::MergeDeveloperIdentitiesRequest request) const
virtual

Merges two users having different IdentityIds, 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.

See Also:

AWS API Reference

◆ MergeDeveloperIdentitiesAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::MergeDeveloperIdentitiesAsync ( const Model::MergeDeveloperIdentitiesRequest request,
const MergeDeveloperIdentitiesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Merges two users having different IdentityIds, 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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ MergeDeveloperIdentitiesCallable()

virtual Model::MergeDeveloperIdentitiesOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::MergeDeveloperIdentitiesCallable ( const Model::MergeDeveloperIdentitiesRequest request) const
virtual

Merges two users having different IdentityIds, 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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::CognitoIdentity::CognitoIdentityClient::OverrideEndpoint ( const Aws::String endpoint)

◆ SetIdentityPoolRoles()

virtual Model::SetIdentityPoolRolesOutcome Aws::CognitoIdentity::CognitoIdentityClient::SetIdentityPoolRoles ( const Model::SetIdentityPoolRolesRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ SetIdentityPoolRolesAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::SetIdentityPoolRolesAsync ( const Model::SetIdentityPoolRolesRequest request,
const SetIdentityPoolRolesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ SetIdentityPoolRolesCallable()

virtual Model::SetIdentityPoolRolesOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::SetIdentityPoolRolesCallable ( const Model::SetIdentityPoolRolesRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TagResource()

virtual Model::TagResourceOutcome Aws::CognitoIdentity::CognitoIdentityClient::TagResource ( const Model::TagResourceRequest request) const
virtual

Assigns a set of tags to an 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.

See Also:

AWS API Reference

◆ TagResourceAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::TagResourceAsync ( const Model::TagResourceRequest request,
const TagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Assigns a set of tags to an 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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagResourceCallable()

virtual Model::TagResourceOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::TagResourceCallable ( const Model::TagResourceRequest request) const
virtual

Assigns a set of tags to an 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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UnlinkDeveloperIdentity()

virtual Model::UnlinkDeveloperIdentityOutcome Aws::CognitoIdentity::CognitoIdentityClient::UnlinkDeveloperIdentity ( const Model::UnlinkDeveloperIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ UnlinkDeveloperIdentityAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::UnlinkDeveloperIdentityAsync ( const Model::UnlinkDeveloperIdentityRequest request,
const UnlinkDeveloperIdentityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UnlinkDeveloperIdentityCallable()

virtual Model::UnlinkDeveloperIdentityOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::UnlinkDeveloperIdentityCallable ( const Model::UnlinkDeveloperIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UnlinkIdentity()

virtual Model::UnlinkIdentityOutcome Aws::CognitoIdentity::CognitoIdentityClient::UnlinkIdentity ( const Model::UnlinkIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ UnlinkIdentityAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::UnlinkIdentityAsync ( const Model::UnlinkIdentityRequest request,
const UnlinkIdentityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UnlinkIdentityCallable()

virtual Model::UnlinkIdentityOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::UnlinkIdentityCallable ( const Model::UnlinkIdentityRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UntagResource()

virtual Model::UntagResourceOutcome Aws::CognitoIdentity::CognitoIdentityClient::UntagResource ( const Model::UntagResourceRequest request) const
virtual

Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account

See Also:

AWS API Reference

◆ UntagResourceAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::UntagResourceAsync ( const Model::UntagResourceRequest request,
const UntagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagResourceCallable()

virtual Model::UntagResourceOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::UntagResourceCallable ( const Model::UntagResourceRequest request) const
virtual

Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateIdentityPool()

virtual Model::UpdateIdentityPoolOutcome Aws::CognitoIdentity::CognitoIdentityClient::UpdateIdentityPool ( const Model::UpdateIdentityPoolRequest request) const
virtual

Updates an identity pool.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

◆ UpdateIdentityPoolAsync()

virtual void Aws::CognitoIdentity::CognitoIdentityClient::UpdateIdentityPoolAsync ( const Model::UpdateIdentityPoolRequest request,
const UpdateIdentityPoolResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Updates an identity pool.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateIdentityPoolCallable()

virtual Model::UpdateIdentityPoolOutcomeCallable Aws::CognitoIdentity::CognitoIdentityClient::UpdateIdentityPoolCallable ( const Model::UpdateIdentityPoolRequest request) const
virtual

Updates an identity pool.

You must use AWS Developer credentials to call this API.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


The documentation for this class was generated from the following file: