/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the cognito-sync-2014-06-30.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.CognitoSync.Model; namespace Amazon.CognitoSync { /// /// Interface for accessing CognitoSync /// /// Amazon Cognito Sync /// /// 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. /// /// public partial interface IAmazonCognitoSync : IAmazonService, IDisposable { #region BulkPublish /// /// 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. /// /// /// Container for the necessary parameters to execute the BulkPublish service method. /// /// The response from the BulkPublish service method, as returned by CognitoSync. /// /// An exception thrown when a bulk publish operation is requested less than 24 hours /// after a previous bulk publish operation completed successfully. /// /// /// An exception thrown when there is an IN_PROGRESS bulk publish operation for the given /// identity pool. /// /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// REST API Reference for BulkPublish Operation BulkPublishResponse BulkPublish(BulkPublishRequest request); /// /// Initiates the asynchronous execution of the BulkPublish operation. /// /// /// Container for the necessary parameters to execute the BulkPublish operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBulkPublish /// operation. /// REST API Reference for BulkPublish Operation IAsyncResult BeginBulkPublish(BulkPublishRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BulkPublish operation. /// /// /// The IAsyncResult returned by the call to BeginBulkPublish. /// /// Returns a BulkPublishResult from CognitoSync. /// REST API Reference for BulkPublish Operation BulkPublishResponse EndBulkPublish(IAsyncResult asyncResult); #endregion #region DeleteDataset /// /// 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. /// /// /// Container for the necessary parameters to execute the DeleteDataset service method. /// /// The response from the DeleteDataset service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if an update can't be applied because the resource was changed by another call /// and this would result in a conflict. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for DeleteDataset Operation DeleteDatasetResponse DeleteDataset(DeleteDatasetRequest request); /// /// Initiates the asynchronous execution of the DeleteDataset operation. /// /// /// Container for the necessary parameters to execute the DeleteDataset operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDataset /// operation. /// REST API Reference for DeleteDataset Operation IAsyncResult BeginDeleteDataset(DeleteDatasetRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteDataset operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteDataset. /// /// Returns a DeleteDatasetResult from CognitoSync. /// REST API Reference for DeleteDataset Operation DeleteDatasetResponse EndDeleteDataset(IAsyncResult asyncResult); #endregion #region DescribeDataset /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeDataset service method. /// /// The response from the DescribeDataset service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for DescribeDataset Operation DescribeDatasetResponse DescribeDataset(DescribeDatasetRequest request); /// /// Initiates the asynchronous execution of the DescribeDataset operation. /// /// /// Container for the necessary parameters to execute the DescribeDataset operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDataset /// operation. /// REST API Reference for DescribeDataset Operation IAsyncResult BeginDescribeDataset(DescribeDatasetRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeDataset operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeDataset. /// /// Returns a DescribeDatasetResult from CognitoSync. /// REST API Reference for DescribeDataset Operation DescribeDatasetResponse EndDescribeDataset(IAsyncResult asyncResult); #endregion #region DescribeIdentityPoolUsage /// /// 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. /// /// /// A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. /// /// The response from the DescribeIdentityPoolUsage service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for DescribeIdentityPoolUsage Operation DescribeIdentityPoolUsageResponse DescribeIdentityPoolUsage(string identityPoolId); /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeIdentityPoolUsage service method. /// /// The response from the DescribeIdentityPoolUsage service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for DescribeIdentityPoolUsage Operation DescribeIdentityPoolUsageResponse DescribeIdentityPoolUsage(DescribeIdentityPoolUsageRequest request); /// /// Initiates the asynchronous execution of the DescribeIdentityPoolUsage operation. /// /// /// Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIdentityPoolUsage /// operation. /// REST API Reference for DescribeIdentityPoolUsage Operation IAsyncResult BeginDescribeIdentityPoolUsage(DescribeIdentityPoolUsageRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeIdentityPoolUsage operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeIdentityPoolUsage. /// /// Returns a DescribeIdentityPoolUsageResult from CognitoSync. /// REST API Reference for DescribeIdentityPoolUsage Operation DescribeIdentityPoolUsageResponse EndDescribeIdentityPoolUsage(IAsyncResult asyncResult); #endregion #region DescribeIdentityUsage /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeIdentityUsage service method. /// /// The response from the DescribeIdentityUsage service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for DescribeIdentityUsage Operation DescribeIdentityUsageResponse DescribeIdentityUsage(DescribeIdentityUsageRequest request); /// /// Initiates the asynchronous execution of the DescribeIdentityUsage operation. /// /// /// Container for the necessary parameters to execute the DescribeIdentityUsage operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIdentityUsage /// operation. /// REST API Reference for DescribeIdentityUsage Operation IAsyncResult BeginDescribeIdentityUsage(DescribeIdentityUsageRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeIdentityUsage operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeIdentityUsage. /// /// Returns a DescribeIdentityUsageResult from CognitoSync. /// REST API Reference for DescribeIdentityUsage Operation DescribeIdentityUsageResponse EndDescribeIdentityUsage(IAsyncResult asyncResult); #endregion #region GetBulkPublishDetails /// /// 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. /// /// /// Container for the necessary parameters to execute the GetBulkPublishDetails service method. /// /// The response from the GetBulkPublishDetails service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// REST API Reference for GetBulkPublishDetails Operation GetBulkPublishDetailsResponse GetBulkPublishDetails(GetBulkPublishDetailsRequest request); /// /// Initiates the asynchronous execution of the GetBulkPublishDetails operation. /// /// /// Container for the necessary parameters to execute the GetBulkPublishDetails operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBulkPublishDetails /// operation. /// REST API Reference for GetBulkPublishDetails Operation IAsyncResult BeginGetBulkPublishDetails(GetBulkPublishDetailsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetBulkPublishDetails operation. /// /// /// The IAsyncResult returned by the call to BeginGetBulkPublishDetails. /// /// Returns a GetBulkPublishDetailsResult from CognitoSync. /// REST API Reference for GetBulkPublishDetails Operation GetBulkPublishDetailsResponse EndGetBulkPublishDetails(IAsyncResult asyncResult); #endregion #region GetCognitoEvents /// /// 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. /// /// /// Container for the necessary parameters to execute the GetCognitoEvents service method. /// /// The response from the GetCognitoEvents service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for GetCognitoEvents Operation GetCognitoEventsResponse GetCognitoEvents(GetCognitoEventsRequest request); /// /// Initiates the asynchronous execution of the GetCognitoEvents operation. /// /// /// Container for the necessary parameters to execute the GetCognitoEvents operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCognitoEvents /// operation. /// REST API Reference for GetCognitoEvents Operation IAsyncResult BeginGetCognitoEvents(GetCognitoEventsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetCognitoEvents operation. /// /// /// The IAsyncResult returned by the call to BeginGetCognitoEvents. /// /// Returns a GetCognitoEventsResult from CognitoSync. /// REST API Reference for GetCognitoEvents Operation GetCognitoEventsResponse EndGetCognitoEvents(IAsyncResult asyncResult); #endregion #region GetIdentityPoolConfiguration /// /// 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. /// /// /// A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration. /// /// The response from the GetIdentityPoolConfiguration service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for GetIdentityPoolConfiguration Operation GetIdentityPoolConfigurationResponse GetIdentityPoolConfiguration(string identityPoolId); /// /// 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. /// /// /// Container for the necessary parameters to execute the GetIdentityPoolConfiguration service method. /// /// The response from the GetIdentityPoolConfiguration service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for GetIdentityPoolConfiguration Operation GetIdentityPoolConfigurationResponse GetIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest request); /// /// Initiates the asynchronous execution of the GetIdentityPoolConfiguration operation. /// /// /// Container for the necessary parameters to execute the GetIdentityPoolConfiguration operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetIdentityPoolConfiguration /// operation. /// REST API Reference for GetIdentityPoolConfiguration Operation IAsyncResult BeginGetIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetIdentityPoolConfiguration operation. /// /// /// The IAsyncResult returned by the call to BeginGetIdentityPoolConfiguration. /// /// Returns a GetIdentityPoolConfigurationResult from CognitoSync. /// REST API Reference for GetIdentityPoolConfiguration Operation GetIdentityPoolConfigurationResponse EndGetIdentityPoolConfiguration(IAsyncResult asyncResult); #endregion #region ListDatasets /// /// 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. /// /// /// Container for the necessary parameters to execute the ListDatasets service method. /// /// The response from the ListDatasets service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for ListDatasets Operation ListDatasetsResponse ListDatasets(ListDatasetsRequest request); /// /// Initiates the asynchronous execution of the ListDatasets operation. /// /// /// Container for the necessary parameters to execute the ListDatasets operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDatasets /// operation. /// REST API Reference for ListDatasets Operation IAsyncResult BeginListDatasets(ListDatasetsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListDatasets operation. /// /// /// The IAsyncResult returned by the call to BeginListDatasets. /// /// Returns a ListDatasetsResult from CognitoSync. /// REST API Reference for ListDatasets Operation ListDatasetsResponse EndListDatasets(IAsyncResult asyncResult); #endregion #region ListIdentityPoolUsage /// /// 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. /// /// /// Container for the necessary parameters to execute the ListIdentityPoolUsage service method. /// /// The response from the ListIdentityPoolUsage service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for ListIdentityPoolUsage Operation ListIdentityPoolUsageResponse ListIdentityPoolUsage(ListIdentityPoolUsageRequest request); /// /// Initiates the asynchronous execution of the ListIdentityPoolUsage operation. /// /// /// Container for the necessary parameters to execute the ListIdentityPoolUsage operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListIdentityPoolUsage /// operation. /// REST API Reference for ListIdentityPoolUsage Operation IAsyncResult BeginListIdentityPoolUsage(ListIdentityPoolUsageRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListIdentityPoolUsage operation. /// /// /// The IAsyncResult returned by the call to BeginListIdentityPoolUsage. /// /// Returns a ListIdentityPoolUsageResult from CognitoSync. /// REST API Reference for ListIdentityPoolUsage Operation ListIdentityPoolUsageResponse EndListIdentityPoolUsage(IAsyncResult asyncResult); #endregion #region ListRecords /// /// 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. /// /// /// Container for the necessary parameters to execute the ListRecords service method. /// /// The response from the ListRecords service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for ListRecords Operation ListRecordsResponse ListRecords(ListRecordsRequest request); /// /// Initiates the asynchronous execution of the ListRecords operation. /// /// /// Container for the necessary parameters to execute the ListRecords operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRecords /// operation. /// REST API Reference for ListRecords Operation IAsyncResult BeginListRecords(ListRecordsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListRecords operation. /// /// /// The IAsyncResult returned by the call to BeginListRecords. /// /// Returns a ListRecordsResult from CognitoSync. /// REST API Reference for ListRecords Operation ListRecordsResponse EndListRecords(IAsyncResult asyncResult); #endregion #region RegisterDevice /// /// 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. /// /// /// Container for the necessary parameters to execute the RegisterDevice service method. /// /// The response from the RegisterDevice service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for RegisterDevice Operation RegisterDeviceResponse RegisterDevice(RegisterDeviceRequest request); /// /// Initiates the asynchronous execution of the RegisterDevice operation. /// /// /// Container for the necessary parameters to execute the RegisterDevice operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterDevice /// operation. /// REST API Reference for RegisterDevice Operation IAsyncResult BeginRegisterDevice(RegisterDeviceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RegisterDevice operation. /// /// /// The IAsyncResult returned by the call to BeginRegisterDevice. /// /// Returns a RegisterDeviceResult from CognitoSync. /// REST API Reference for RegisterDevice Operation RegisterDeviceResponse EndRegisterDevice(IAsyncResult asyncResult); #endregion #region SetCognitoEvents /// /// 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. /// /// /// Container for the necessary parameters to execute the SetCognitoEvents service method. /// /// The response from the SetCognitoEvents service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for SetCognitoEvents Operation SetCognitoEventsResponse SetCognitoEvents(SetCognitoEventsRequest request); /// /// Initiates the asynchronous execution of the SetCognitoEvents operation. /// /// /// Container for the necessary parameters to execute the SetCognitoEvents operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetCognitoEvents /// operation. /// REST API Reference for SetCognitoEvents Operation IAsyncResult BeginSetCognitoEvents(SetCognitoEventsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the SetCognitoEvents operation. /// /// /// The IAsyncResult returned by the call to BeginSetCognitoEvents. /// /// Returns a SetCognitoEventsResult from CognitoSync. /// REST API Reference for SetCognitoEvents Operation SetCognitoEventsResponse EndSetCognitoEvents(IAsyncResult asyncResult); #endregion #region SetIdentityPoolConfiguration /// /// 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. /// /// /// Container for the necessary parameters to execute the SetIdentityPoolConfiguration service method. /// /// The response from the SetIdentityPoolConfiguration service method, as returned by CognitoSync. /// /// Thrown if there are parallel requests to modify a resource. /// /// /// Indicates an internal service error. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for SetIdentityPoolConfiguration Operation SetIdentityPoolConfigurationResponse SetIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest request); /// /// Initiates the asynchronous execution of the SetIdentityPoolConfiguration operation. /// /// /// Container for the necessary parameters to execute the SetIdentityPoolConfiguration operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetIdentityPoolConfiguration /// operation. /// REST API Reference for SetIdentityPoolConfiguration Operation IAsyncResult BeginSetIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the SetIdentityPoolConfiguration operation. /// /// /// The IAsyncResult returned by the call to BeginSetIdentityPoolConfiguration. /// /// Returns a SetIdentityPoolConfigurationResult from CognitoSync. /// REST API Reference for SetIdentityPoolConfiguration Operation SetIdentityPoolConfigurationResponse EndSetIdentityPoolConfiguration(IAsyncResult asyncResult); #endregion #region SubscribeToDataset /// /// 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. /// /// /// Container for the necessary parameters to execute the SubscribeToDataset service method. /// /// The response from the SubscribeToDataset service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for SubscribeToDataset Operation SubscribeToDatasetResponse SubscribeToDataset(SubscribeToDatasetRequest request); /// /// Initiates the asynchronous execution of the SubscribeToDataset operation. /// /// /// Container for the necessary parameters to execute the SubscribeToDataset operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSubscribeToDataset /// operation. /// REST API Reference for SubscribeToDataset Operation IAsyncResult BeginSubscribeToDataset(SubscribeToDatasetRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the SubscribeToDataset operation. /// /// /// The IAsyncResult returned by the call to BeginSubscribeToDataset. /// /// Returns a SubscribeToDatasetResult from CognitoSync. /// REST API Reference for SubscribeToDataset Operation SubscribeToDatasetResponse EndSubscribeToDataset(IAsyncResult asyncResult); #endregion #region UnsubscribeFromDataset /// /// 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. /// /// /// Container for the necessary parameters to execute the UnsubscribeFromDataset service method. /// /// The response from the UnsubscribeFromDataset service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for UnsubscribeFromDataset Operation UnsubscribeFromDatasetResponse UnsubscribeFromDataset(UnsubscribeFromDatasetRequest request); /// /// Initiates the asynchronous execution of the UnsubscribeFromDataset operation. /// /// /// Container for the necessary parameters to execute the UnsubscribeFromDataset operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnsubscribeFromDataset /// operation. /// REST API Reference for UnsubscribeFromDataset Operation IAsyncResult BeginUnsubscribeFromDataset(UnsubscribeFromDatasetRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UnsubscribeFromDataset operation. /// /// /// The IAsyncResult returned by the call to BeginUnsubscribeFromDataset. /// /// Returns a UnsubscribeFromDatasetResult from CognitoSync. /// REST API Reference for UnsubscribeFromDataset Operation UnsubscribeFromDatasetResponse EndUnsubscribeFromDataset(IAsyncResult asyncResult); #endregion #region UpdateRecords /// /// 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. /// /// /// Container for the necessary parameters to execute the UpdateRecords service method. /// /// The response from the UpdateRecords service method, as returned by CognitoSync. /// /// Indicates an internal service error. /// /// /// The AWS Lambda function returned invalid output or an exception. /// /// /// Thrown when a request parameter does not comply with the associated constraints. /// /// /// AWS Lambda throttled your account, please contact AWS Support /// /// /// Thrown when the limit on the number of objects or operations has been exceeded. /// /// /// Thrown when a user is not authorized to access the requested resource. /// /// /// Thrown if an update can't be applied because the resource was changed by another call /// and this would result in a conflict. /// /// /// Thrown if the resource doesn't exist. /// /// /// Thrown if the request is throttled. /// /// REST API Reference for UpdateRecords Operation UpdateRecordsResponse UpdateRecords(UpdateRecordsRequest request); /// /// Initiates the asynchronous execution of the UpdateRecords operation. /// /// /// Container for the necessary parameters to execute the UpdateRecords operation on AmazonCognitoSyncClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateRecords /// operation. /// REST API Reference for UpdateRecords Operation IAsyncResult BeginUpdateRecords(UpdateRecordsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateRecords operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateRecords. /// /// Returns a UpdateRecordsResult from CognitoSync. /// REST API Reference for UpdateRecords Operation UpdateRecordsResponse EndUpdateRecords(IAsyncResult asyncResult); #endregion } }