AWS SDK for C++  1.8.94
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::CognitoSync::CognitoSyncClient Class Reference

#include <CognitoSyncClient.h>

+ Inheritance diagram for Aws::CognitoSync::CognitoSyncClient:

Public Types

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

Public Member Functions

 CognitoSyncClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 CognitoSyncClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 CognitoSyncClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~CognitoSyncClient ()
 
virtual Model::BulkPublishOutcome BulkPublish (const Model::BulkPublishRequest &request) const
 
virtual Model::BulkPublishOutcomeCallable BulkPublishCallable (const Model::BulkPublishRequest &request) const
 
virtual void BulkPublishAsync (const Model::BulkPublishRequest &request, const BulkPublishResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteDatasetOutcome DeleteDataset (const Model::DeleteDatasetRequest &request) const
 
virtual Model::DeleteDatasetOutcomeCallable DeleteDatasetCallable (const Model::DeleteDatasetRequest &request) const
 
virtual void DeleteDatasetAsync (const Model::DeleteDatasetRequest &request, const DeleteDatasetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeDatasetOutcome DescribeDataset (const Model::DescribeDatasetRequest &request) const
 
virtual Model::DescribeDatasetOutcomeCallable DescribeDatasetCallable (const Model::DescribeDatasetRequest &request) const
 
virtual void DescribeDatasetAsync (const Model::DescribeDatasetRequest &request, const DescribeDatasetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeIdentityPoolUsageOutcome DescribeIdentityPoolUsage (const Model::DescribeIdentityPoolUsageRequest &request) const
 
virtual Model::DescribeIdentityPoolUsageOutcomeCallable DescribeIdentityPoolUsageCallable (const Model::DescribeIdentityPoolUsageRequest &request) const
 
virtual void DescribeIdentityPoolUsageAsync (const Model::DescribeIdentityPoolUsageRequest &request, const DescribeIdentityPoolUsageResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeIdentityUsageOutcome DescribeIdentityUsage (const Model::DescribeIdentityUsageRequest &request) const
 
virtual Model::DescribeIdentityUsageOutcomeCallable DescribeIdentityUsageCallable (const Model::DescribeIdentityUsageRequest &request) const
 
virtual void DescribeIdentityUsageAsync (const Model::DescribeIdentityUsageRequest &request, const DescribeIdentityUsageResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetBulkPublishDetailsOutcome GetBulkPublishDetails (const Model::GetBulkPublishDetailsRequest &request) const
 
virtual Model::GetBulkPublishDetailsOutcomeCallable GetBulkPublishDetailsCallable (const Model::GetBulkPublishDetailsRequest &request) const
 
virtual void GetBulkPublishDetailsAsync (const Model::GetBulkPublishDetailsRequest &request, const GetBulkPublishDetailsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetCognitoEventsOutcome GetCognitoEvents (const Model::GetCognitoEventsRequest &request) const
 
virtual Model::GetCognitoEventsOutcomeCallable GetCognitoEventsCallable (const Model::GetCognitoEventsRequest &request) const
 
virtual void GetCognitoEventsAsync (const Model::GetCognitoEventsRequest &request, const GetCognitoEventsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetIdentityPoolConfigurationOutcome GetIdentityPoolConfiguration (const Model::GetIdentityPoolConfigurationRequest &request) const
 
virtual Model::GetIdentityPoolConfigurationOutcomeCallable GetIdentityPoolConfigurationCallable (const Model::GetIdentityPoolConfigurationRequest &request) const
 
virtual void GetIdentityPoolConfigurationAsync (const Model::GetIdentityPoolConfigurationRequest &request, const GetIdentityPoolConfigurationResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListDatasetsOutcome ListDatasets (const Model::ListDatasetsRequest &request) const
 
virtual Model::ListDatasetsOutcomeCallable ListDatasetsCallable (const Model::ListDatasetsRequest &request) const
 
virtual void ListDatasetsAsync (const Model::ListDatasetsRequest &request, const ListDatasetsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListIdentityPoolUsageOutcome ListIdentityPoolUsage (const Model::ListIdentityPoolUsageRequest &request) const
 
virtual Model::ListIdentityPoolUsageOutcomeCallable ListIdentityPoolUsageCallable (const Model::ListIdentityPoolUsageRequest &request) const
 
virtual void ListIdentityPoolUsageAsync (const Model::ListIdentityPoolUsageRequest &request, const ListIdentityPoolUsageResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListRecordsOutcome ListRecords (const Model::ListRecordsRequest &request) const
 
virtual Model::ListRecordsOutcomeCallable ListRecordsCallable (const Model::ListRecordsRequest &request) const
 
virtual void ListRecordsAsync (const Model::ListRecordsRequest &request, const ListRecordsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::RegisterDeviceOutcome RegisterDevice (const Model::RegisterDeviceRequest &request) const
 
virtual Model::RegisterDeviceOutcomeCallable RegisterDeviceCallable (const Model::RegisterDeviceRequest &request) const
 
virtual void RegisterDeviceAsync (const Model::RegisterDeviceRequest &request, const RegisterDeviceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SetCognitoEventsOutcome SetCognitoEvents (const Model::SetCognitoEventsRequest &request) const
 
virtual Model::SetCognitoEventsOutcomeCallable SetCognitoEventsCallable (const Model::SetCognitoEventsRequest &request) const
 
virtual void SetCognitoEventsAsync (const Model::SetCognitoEventsRequest &request, const SetCognitoEventsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SetIdentityPoolConfigurationOutcome SetIdentityPoolConfiguration (const Model::SetIdentityPoolConfigurationRequest &request) const
 
virtual Model::SetIdentityPoolConfigurationOutcomeCallable SetIdentityPoolConfigurationCallable (const Model::SetIdentityPoolConfigurationRequest &request) const
 
virtual void SetIdentityPoolConfigurationAsync (const Model::SetIdentityPoolConfigurationRequest &request, const SetIdentityPoolConfigurationResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SubscribeToDatasetOutcome SubscribeToDataset (const Model::SubscribeToDatasetRequest &request) const
 
virtual Model::SubscribeToDatasetOutcomeCallable SubscribeToDatasetCallable (const Model::SubscribeToDatasetRequest &request) const
 
virtual void SubscribeToDatasetAsync (const Model::SubscribeToDatasetRequest &request, const SubscribeToDatasetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UnsubscribeFromDatasetOutcome UnsubscribeFromDataset (const Model::UnsubscribeFromDatasetRequest &request) const
 
virtual Model::UnsubscribeFromDatasetOutcomeCallable UnsubscribeFromDatasetCallable (const Model::UnsubscribeFromDatasetRequest &request) const
 
virtual void UnsubscribeFromDatasetAsync (const Model::UnsubscribeFromDatasetRequest &request, const UnsubscribeFromDatasetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateRecordsOutcome UpdateRecords (const Model::UpdateRecordsRequest &request) const
 
virtual Model::UpdateRecordsOutcomeCallable UpdateRecordsCallable (const Model::UpdateRecordsRequest &request) const
 
virtual void UpdateRecordsAsync (const Model::UpdateRecordsRequest &request, const UpdateRecordsResponseReceivedHandler &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 (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
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 ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

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 char *signerServiceNameOverride=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 char *signerServiceNameOverride=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 char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=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 char *signerServiceNameOverride=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 char *signerServiceNameOverride=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 Sync</fullname>

Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.

With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service.

If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.

Definition at line 167 of file CognitoSyncClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 170 of file CognitoSyncClient.h.

Constructor & Destructor Documentation

◆ CognitoSyncClient() [1/3]

Aws::CognitoSync::CognitoSyncClient::CognitoSyncClient ( 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.

◆ CognitoSyncClient() [2/3]

Aws::CognitoSync::CognitoSyncClient::CognitoSyncClient ( 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.

◆ CognitoSyncClient() [3/3]

Aws::CognitoSync::CognitoSyncClient::CognitoSyncClient ( 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

◆ ~CognitoSyncClient()

virtual Aws::CognitoSync::CognitoSyncClient::~CognitoSyncClient ( )
virtual

Member Function Documentation

◆ BulkPublish()

virtual Model::BulkPublishOutcome Aws::CognitoSync::CognitoSyncClient::BulkPublish ( const Model::BulkPublishRequest request) const
virtual

Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

◆ BulkPublishAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::BulkPublishAsync ( const Model::BulkPublishRequest request,
const BulkPublishResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ BulkPublishCallable()

virtual Model::BulkPublishOutcomeCallable Aws::CognitoSync::CognitoSyncClient::BulkPublishCallable ( const Model::BulkPublishRequest request) const
virtual

Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ DeleteDataset()

virtual Model::DeleteDatasetOutcome Aws::CognitoSync::CognitoSyncClient::DeleteDataset ( const Model::DeleteDatasetRequest request) const
virtual

Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

See Also:

AWS API Reference

◆ DeleteDatasetAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::DeleteDatasetAsync ( const Model::DeleteDatasetRequest request,
const DeleteDatasetResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

See Also:

AWS API Reference

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

◆ DeleteDatasetCallable()

virtual Model::DeleteDatasetOutcomeCallable Aws::CognitoSync::CognitoSyncClient::DeleteDatasetCallable ( const Model::DeleteDatasetRequest request) const
virtual

Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

See Also:

AWS API Reference

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

◆ DescribeDataset()

virtual Model::DescribeDatasetOutcome Aws::CognitoSync::CognitoSyncClient::DescribeDataset ( const Model::DescribeDatasetRequest request) const
virtual

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

See Also:

AWS API Reference

◆ DescribeDatasetAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::DescribeDatasetAsync ( const Model::DescribeDatasetRequest request,
const DescribeDatasetResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

See Also:

AWS API Reference

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

◆ DescribeDatasetCallable()

virtual Model::DescribeDatasetOutcomeCallable Aws::CognitoSync::CognitoSyncClient::DescribeDatasetCallable ( const Model::DescribeDatasetRequest request) const
virtual

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

See Also:

AWS API Reference

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

◆ DescribeIdentityPoolUsage()

virtual Model::DescribeIdentityPoolUsageOutcome Aws::CognitoSync::CognitoSyncClient::DescribeIdentityPoolUsage ( const Model::DescribeIdentityPoolUsageRequest request) const
virtual

Gets usage details (for example, data storage) about a particular identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

◆ DescribeIdentityPoolUsageAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::DescribeIdentityPoolUsageAsync ( const Model::DescribeIdentityPoolUsageRequest request,
const DescribeIdentityPoolUsageResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets usage details (for example, data storage) about a particular identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ DescribeIdentityPoolUsageCallable()

virtual Model::DescribeIdentityPoolUsageOutcomeCallable Aws::CognitoSync::CognitoSyncClient::DescribeIdentityPoolUsageCallable ( const Model::DescribeIdentityPoolUsageRequest request) const
virtual

Gets usage details (for example, data storage) about a particular identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ DescribeIdentityUsage()

virtual Model::DescribeIdentityUsageOutcome Aws::CognitoSync::CognitoSyncClient::DescribeIdentityUsage ( const Model::DescribeIdentityUsageRequest request) const
virtual

Gets usage information for an identity, including number of datasets and data usage.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

See Also:

AWS API Reference

◆ DescribeIdentityUsageAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::DescribeIdentityUsageAsync ( const Model::DescribeIdentityUsageRequest request,
const DescribeIdentityUsageResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets usage information for an identity, including number of datasets and data usage.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

See Also:

AWS API Reference

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

◆ DescribeIdentityUsageCallable()

virtual Model::DescribeIdentityUsageOutcomeCallable Aws::CognitoSync::CognitoSyncClient::DescribeIdentityUsageCallable ( const Model::DescribeIdentityUsageRequest request) const
virtual

Gets usage information for an identity, including number of datasets and data usage.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

See Also:

AWS API Reference

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

◆ GetBulkPublishDetails()

virtual Model::GetBulkPublishDetailsOutcome Aws::CognitoSync::CognitoSyncClient::GetBulkPublishDetails ( const Model::GetBulkPublishDetailsRequest request) const
virtual

Get the status of the last BulkPublish operation for an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

◆ GetBulkPublishDetailsAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::GetBulkPublishDetailsAsync ( const Model::GetBulkPublishDetailsRequest request,
const GetBulkPublishDetailsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Get the status of the last BulkPublish operation for an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ GetBulkPublishDetailsCallable()

virtual Model::GetBulkPublishDetailsOutcomeCallable Aws::CognitoSync::CognitoSyncClient::GetBulkPublishDetailsCallable ( const Model::GetBulkPublishDetailsRequest request) const
virtual

Get the status of the last BulkPublish operation for an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ GetCognitoEvents()

virtual Model::GetCognitoEventsOutcome Aws::CognitoSync::CognitoSyncClient::GetCognitoEvents ( const Model::GetCognitoEventsRequest request) const
virtual

Gets the events and the corresponding Lambda functions associated with an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

◆ GetCognitoEventsAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::GetCognitoEventsAsync ( const Model::GetCognitoEventsRequest request,
const GetCognitoEventsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets the events and the corresponding Lambda functions associated with an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ GetCognitoEventsCallable()

virtual Model::GetCognitoEventsOutcomeCallable Aws::CognitoSync::CognitoSyncClient::GetCognitoEventsCallable ( const Model::GetCognitoEventsRequest request) const
virtual

Gets the events and the corresponding Lambda functions associated with an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ GetIdentityPoolConfiguration()

virtual Model::GetIdentityPoolConfigurationOutcome Aws::CognitoSync::CognitoSyncClient::GetIdentityPoolConfiguration ( const Model::GetIdentityPoolConfigurationRequest request) const
virtual

Gets the configuration settings of an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

◆ GetIdentityPoolConfigurationAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::GetIdentityPoolConfigurationAsync ( const Model::GetIdentityPoolConfigurationRequest request,
const GetIdentityPoolConfigurationResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets the configuration settings of an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ GetIdentityPoolConfigurationCallable()

virtual Model::GetIdentityPoolConfigurationOutcomeCallable Aws::CognitoSync::CognitoSyncClient::GetIdentityPoolConfigurationCallable ( const Model::GetIdentityPoolConfigurationRequest request) const
virtual

Gets the configuration settings of an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ ListDatasets()

virtual Model::ListDatasetsOutcome Aws::CognitoSync::CognitoSyncClient::ListDatasets ( const Model::ListDatasetsRequest request) const
virtual

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

See Also:

AWS API Reference

◆ ListDatasetsAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::ListDatasetsAsync ( const Model::ListDatasetsRequest request,
const ListDatasetsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

See Also:

AWS API Reference

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

◆ ListDatasetsCallable()

virtual Model::ListDatasetsOutcomeCallable Aws::CognitoSync::CognitoSyncClient::ListDatasetsCallable ( const Model::ListDatasetsRequest request) const
virtual

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

See Also:

AWS API Reference

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

◆ ListIdentityPoolUsage()

virtual Model::ListIdentityPoolUsageOutcome Aws::CognitoSync::CognitoSyncClient::ListIdentityPoolUsage ( const Model::ListIdentityPoolUsageRequest request) const
virtual

Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

◆ ListIdentityPoolUsageAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::ListIdentityPoolUsageAsync ( const Model::ListIdentityPoolUsageRequest request,
const ListIdentityPoolUsageResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ ListIdentityPoolUsageCallable()

virtual Model::ListIdentityPoolUsageOutcomeCallable Aws::CognitoSync::CognitoSyncClient::ListIdentityPoolUsageCallable ( const Model::ListIdentityPoolUsageRequest request) const
virtual

Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ ListRecords()

virtual Model::ListRecordsOutcome Aws::CognitoSync::CognitoSyncClient::ListRecords ( const Model::ListRecordsRequest request) const
virtual

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

See Also:

AWS API Reference

◆ ListRecordsAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::ListRecordsAsync ( const Model::ListRecordsRequest request,
const ListRecordsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

See Also:

AWS API Reference

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

◆ ListRecordsCallable()

virtual Model::ListRecordsOutcomeCallable Aws::CognitoSync::CognitoSyncClient::ListRecordsCallable ( const Model::ListRecordsRequest request) const
virtual

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

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::CognitoSync::CognitoSyncClient::OverrideEndpoint ( const Aws::String endpoint)

◆ RegisterDevice()

virtual Model::RegisterDeviceOutcome Aws::CognitoSync::CognitoSyncClient::RegisterDevice ( const Model::RegisterDeviceRequest request) const
virtual

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

See Also:

AWS API Reference

◆ RegisterDeviceAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::RegisterDeviceAsync ( const Model::RegisterDeviceRequest request,
const RegisterDeviceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

See Also:

AWS API Reference

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

◆ RegisterDeviceCallable()

virtual Model::RegisterDeviceOutcomeCallable Aws::CognitoSync::CognitoSyncClient::RegisterDeviceCallable ( const Model::RegisterDeviceRequest request) const
virtual

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

See Also:

AWS API Reference

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

◆ SetCognitoEvents()

virtual Model::SetCognitoEventsOutcome Aws::CognitoSync::CognitoSyncClient::SetCognitoEvents ( const Model::SetCognitoEventsRequest request) const
virtual

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

◆ SetCognitoEventsAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::SetCognitoEventsAsync ( const Model::SetCognitoEventsRequest request,
const SetCognitoEventsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ SetCognitoEventsCallable()

virtual Model::SetCognitoEventsOutcomeCallable Aws::CognitoSync::CognitoSyncClient::SetCognitoEventsCallable ( const Model::SetCognitoEventsRequest request) const
virtual

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ SetIdentityPoolConfiguration()

virtual Model::SetIdentityPoolConfigurationOutcome Aws::CognitoSync::CognitoSyncClient::SetIdentityPoolConfiguration ( const Model::SetIdentityPoolConfigurationRequest request) const
virtual

Sets the necessary configuration for push sync.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

◆ SetIdentityPoolConfigurationAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::SetIdentityPoolConfigurationAsync ( const Model::SetIdentityPoolConfigurationRequest request,
const SetIdentityPoolConfigurationResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Sets the necessary configuration for push sync.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ SetIdentityPoolConfigurationCallable()

virtual Model::SetIdentityPoolConfigurationOutcomeCallable Aws::CognitoSync::CognitoSyncClient::SetIdentityPoolConfigurationCallable ( const Model::SetIdentityPoolConfigurationRequest request) const
virtual

Sets the necessary configuration for push sync.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AWS API Reference

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

◆ SubscribeToDataset()

virtual Model::SubscribeToDatasetOutcome Aws::CognitoSync::CognitoSyncClient::SubscribeToDataset ( const Model::SubscribeToDatasetRequest request) const
virtual

Subscribes to receive notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

See Also:

AWS API Reference

◆ SubscribeToDatasetAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::SubscribeToDatasetAsync ( const Model::SubscribeToDatasetRequest request,
const SubscribeToDatasetResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Subscribes to receive notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

See Also:

AWS API Reference

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

◆ SubscribeToDatasetCallable()

virtual Model::SubscribeToDatasetOutcomeCallable Aws::CognitoSync::CognitoSyncClient::SubscribeToDatasetCallable ( const Model::SubscribeToDatasetRequest request) const
virtual

Subscribes to receive notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

See Also:

AWS API Reference

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

◆ UnsubscribeFromDataset()

virtual Model::UnsubscribeFromDatasetOutcome Aws::CognitoSync::CognitoSyncClient::UnsubscribeFromDataset ( const Model::UnsubscribeFromDatasetRequest request) const
virtual

Unsubscribes from receiving notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

See Also:

AWS API Reference

◆ UnsubscribeFromDatasetAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::UnsubscribeFromDatasetAsync ( const Model::UnsubscribeFromDatasetRequest request,
const UnsubscribeFromDatasetResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Unsubscribes from receiving notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

See Also:

AWS API Reference

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

◆ UnsubscribeFromDatasetCallable()

virtual Model::UnsubscribeFromDatasetOutcomeCallable Aws::CognitoSync::CognitoSyncClient::UnsubscribeFromDatasetCallable ( const Model::UnsubscribeFromDatasetRequest request) const
virtual

Unsubscribes from receiving notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

See Also:

AWS API Reference

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

◆ UpdateRecords()

virtual Model::UpdateRecordsOutcome Aws::CognitoSync::CognitoSyncClient::UpdateRecords ( const Model::UpdateRecordsRequest request) const
virtual

Posts updates to records and adds and deletes records for a dataset and user.

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

See Also:

AWS API Reference

◆ UpdateRecordsAsync()

virtual void Aws::CognitoSync::CognitoSyncClient::UpdateRecordsAsync ( const Model::UpdateRecordsRequest request,
const UpdateRecordsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Posts updates to records and adds and deletes records for a dataset and user.

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

See Also:

AWS API Reference

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

◆ UpdateRecordsCallable()

virtual Model::UpdateRecordsOutcomeCallable Aws::CognitoSync::CognitoSyncClient::UpdateRecordsCallable ( const Model::UpdateRecordsRequest request) const
virtual

Posts updates to records and adds and deletes records for a dataset and user.

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

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: