/*
* 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.Threading;
using System.Threading.Tasks;
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 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BulkPublishAsync(BulkPublishRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteDatasetAsync(DeleteDatasetRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeDatasetAsync(DescribeDatasetRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeIdentityPoolUsageAsync(string identityPoolId, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeIdentityUsageAsync(DescribeIdentityUsageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetBulkPublishDetailsAsync(GetBulkPublishDetailsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetCognitoEventsAsync(GetCognitoEventsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetIdentityPoolConfigurationAsync(string identityPoolId, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListDatasetsAsync(ListDatasetsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListIdentityPoolUsageAsync(ListIdentityPoolUsageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListRecordsAsync(ListRecordsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task RegisterDeviceAsync(RegisterDeviceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task SetCognitoEventsAsync(SetCognitoEventsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task SetIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task SubscribeToDatasetAsync(SubscribeToDatasetRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UnsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UpdateRecordsAsync(UpdateRecordsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}