C# Class Amazon.CognitoSync.AmazonCognitoSyncClient

Implementation 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.

Inheritance: AmazonServiceClient, IAmazonCognitoSync
Show file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method Description
AmazonCognitoSyncClient ( ) : System

Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonCognitoSyncClient ( AWSCredentials credentials ) : System

Constructs AmazonCognitoSyncClient with AWS Credentials
AmazonCognitoSyncClient ( AWSCredentials credentials, AmazonCognitoSyncConfig clientConfig ) : System

Constructs AmazonCognitoSyncClient with AWS Credentials and an AmazonCognitoSyncClient Configuration object.
AmazonCognitoSyncClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonCognitoSyncClient with AWS Credentials
AmazonCognitoSyncClient ( AmazonCognitoSyncConfig config ) : System

Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonCognitoSyncClient ( RegionEndpoint region ) : System

Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key
AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonCognitoSyncConfig clientConfig ) : System

Constructs AmazonCognitoSyncClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoSyncClient Configuration object.
AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key
AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key
AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCognitoSyncConfig clientConfig ) : System

Constructs AmazonCognitoSyncClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoSyncClient Configuration object.
AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key
BulkPublishAsync ( Amazon.CognitoSync.Model.BulkPublishRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the BulkPublish operation.
BulkPublishAsync ( Amazon.CognitoSync.Model.BulkPublishRequest request, BulkPublishResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the BulkPublish operation.
DeleteDatasetAsync ( Amazon.CognitoSync.Model.DeleteDatasetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteDataset operation.
DeleteDatasetAsync ( Amazon.CognitoSync.Model.DeleteDatasetRequest request, DeleteDatasetResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the DeleteDataset operation.
DescribeDatasetAsync ( Amazon.CognitoSync.Model.DescribeDatasetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeDataset operation.
DescribeDatasetAsync ( Amazon.CognitoSync.Model.DescribeDatasetRequest request, DescribeDatasetResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the DescribeDataset operation.
DescribeIdentityPoolUsageAsync ( Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeIdentityPoolUsage operation.
DescribeIdentityPoolUsageAsync ( string identityPoolId, System cancellationToken = default(CancellationToken) ) : Task

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.

DescribeIdentityPoolUsageAsync ( Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest request, DescribeIdentityPoolUsageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the DescribeIdentityPoolUsage operation.
DescribeIdentityPoolUsageAsync ( string identityPoolId, DescribeIdentityPoolUsageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

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.

DescribeIdentityUsageAsync ( Amazon.CognitoSync.Model.DescribeIdentityUsageRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeIdentityUsage operation.
DescribeIdentityUsageAsync ( Amazon.CognitoSync.Model.DescribeIdentityUsageRequest request, DescribeIdentityUsageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the DescribeIdentityUsage operation.
GetBulkPublishDetailsAsync ( Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetBulkPublishDetails operation.
GetBulkPublishDetailsAsync ( Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest request, GetBulkPublishDetailsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the GetBulkPublishDetails operation.
GetCognitoEventsAsync ( Amazon.CognitoSync.Model.GetCognitoEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetCognitoEvents operation.
GetCognitoEventsAsync ( Amazon.CognitoSync.Model.GetCognitoEventsRequest request, GetCognitoEventsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the GetCognitoEvents operation.
GetIdentityPoolConfigurationAsync ( Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetIdentityPoolConfiguration operation.
GetIdentityPoolConfigurationAsync ( string identityPoolId, System cancellationToken = default(CancellationToken) ) : Task

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.

GetIdentityPoolConfigurationAsync ( Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest request, GetIdentityPoolConfigurationResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the GetIdentityPoolConfiguration operation.
GetIdentityPoolConfigurationAsync ( string identityPoolId, GetIdentityPoolConfigurationResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

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.

ListDatasetsAsync ( Amazon.CognitoSync.Model.ListDatasetsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListDatasets operation.
ListDatasetsAsync ( Amazon.CognitoSync.Model.ListDatasetsRequest request, ListDatasetsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the ListDatasets operation.
ListIdentityPoolUsageAsync ( Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListIdentityPoolUsage operation.
ListIdentityPoolUsageAsync ( Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest request, ListIdentityPoolUsageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the ListIdentityPoolUsage operation.
ListRecordsAsync ( Amazon.CognitoSync.Model.ListRecordsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListRecords operation.
ListRecordsAsync ( Amazon.CognitoSync.Model.ListRecordsRequest request, ListRecordsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the ListRecords operation.
RegisterDeviceAsync ( Amazon.CognitoSync.Model.RegisterDeviceRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the RegisterDevice operation.
RegisterDeviceAsync ( Amazon.CognitoSync.Model.RegisterDeviceRequest request, RegisterDeviceResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the RegisterDevice operation.
SetCognitoEventsAsync ( Amazon.CognitoSync.Model.SetCognitoEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the SetCognitoEvents operation.
SetCognitoEventsAsync ( Amazon.CognitoSync.Model.SetCognitoEventsRequest request, SetCognitoEventsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the SetCognitoEvents operation.
SetIdentityPoolConfigurationAsync ( Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the SetIdentityPoolConfiguration operation.
SetIdentityPoolConfigurationAsync ( Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest request, SetIdentityPoolConfigurationResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the SetIdentityPoolConfiguration operation.
SubscribeToDatasetAsync ( Amazon.CognitoSync.Model.SubscribeToDatasetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the SubscribeToDataset operation.
SubscribeToDatasetAsync ( Amazon.CognitoSync.Model.SubscribeToDatasetRequest request, SubscribeToDatasetResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the SubscribeToDataset operation.
UnsubscribeFromDatasetAsync ( Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UnsubscribeFromDataset operation.
UnsubscribeFromDatasetAsync ( Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest request, UnsubscribeFromDatasetResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the UnsubscribeFromDataset operation.
UpdateRecordsAsync ( Amazon.CognitoSync.Model.UpdateRecordsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateRecords operation.
UpdateRecordsAsync ( Amazon.CognitoSync.Model.UpdateRecordsRequest request, UpdateRecordsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Initiates the asynchronous execution of the UpdateRecords operation.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.
CustomizeRuntimePipeline ( RuntimePipeline pipeline ) : void

Customizes the runtime pipeline.
Dispose ( bool disposing ) : void

Disposes the service client.

Private Methods

Method Description
BulkPublish ( Amazon.CognitoSync.Model.BulkPublishRequest request ) : Amazon.CognitoSync.Model.BulkPublishResponse
DeleteDataset ( Amazon.CognitoSync.Model.DeleteDatasetRequest request ) : Amazon.CognitoSync.Model.DeleteDatasetResponse
DescribeDataset ( Amazon.CognitoSync.Model.DescribeDatasetRequest request ) : Amazon.CognitoSync.Model.DescribeDatasetResponse
DescribeIdentityPoolUsage ( Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest request ) : Amazon.CognitoSync.Model.DescribeIdentityPoolUsageResponse
DescribeIdentityUsage ( Amazon.CognitoSync.Model.DescribeIdentityUsageRequest request ) : Amazon.CognitoSync.Model.DescribeIdentityUsageResponse
GetBulkPublishDetails ( Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest request ) : Amazon.CognitoSync.Model.GetBulkPublishDetailsResponse
GetCognitoEvents ( Amazon.CognitoSync.Model.GetCognitoEventsRequest request ) : Amazon.CognitoSync.Model.GetCognitoEventsResponse
GetIdentityPoolConfiguration ( Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest request ) : Amazon.CognitoSync.Model.GetIdentityPoolConfigurationResponse
ListDatasets ( Amazon.CognitoSync.Model.ListDatasetsRequest request ) : Amazon.CognitoSync.Model.ListDatasetsResponse
ListIdentityPoolUsage ( Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest request ) : Amazon.CognitoSync.Model.ListIdentityPoolUsageResponse
ListRecords ( Amazon.CognitoSync.Model.ListRecordsRequest request ) : Amazon.CognitoSync.Model.ListRecordsResponse
RegisterDevice ( Amazon.CognitoSync.Model.RegisterDeviceRequest request ) : Amazon.CognitoSync.Model.RegisterDeviceResponse
SetCognitoEvents ( Amazon.CognitoSync.Model.SetCognitoEventsRequest request ) : SetCognitoEventsResponse
SetIdentityPoolConfiguration ( Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest request ) : Amazon.CognitoSync.Model.SetIdentityPoolConfigurationResponse
SubscribeToDataset ( Amazon.CognitoSync.Model.SubscribeToDatasetRequest request ) : Amazon.CognitoSync.Model.SubscribeToDatasetResponse
UnsubscribeFromDataset ( Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest request ) : Amazon.CognitoSync.Model.UnsubscribeFromDatasetResponse
UpdateRecords ( Amazon.CognitoSync.Model.UpdateRecordsRequest request ) : Amazon.CognitoSync.Model.UpdateRecordsResponse

Method Details

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonCognitoSyncClient ( ) : System
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with AWS Credentials
public AmazonCognitoSyncClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with AWS Credentials and an AmazonCognitoSyncClient Configuration object.
public AmazonCognitoSyncClient ( AWSCredentials credentials, AmazonCognitoSyncConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonCognitoSyncConfig The AmazonCognitoSyncClient Configuration Object
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with AWS Credentials
public AmazonCognitoSyncClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonCognitoSyncClient ( AmazonCognitoSyncConfig config ) : System
config AmazonCognitoSyncConfig The AmazonCognitoSyncClient Configuration Object
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonCognitoSyncClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key
public AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoSyncClient Configuration object.
public AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonCognitoSyncConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonCognitoSyncConfig The AmazonCognitoSyncClient Configuration Object
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key
public AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key
public AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoSyncClient Configuration object.
public AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCognitoSyncConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonCognitoSyncConfig The AmazonCognitoSyncClient Configuration Object
return System

AmazonCognitoSyncClient() public method

Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key
public AmazonCognitoSyncClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

BulkPublishAsync() public method

Initiates the asynchronous execution of the BulkPublish operation.
public BulkPublishAsync ( Amazon.CognitoSync.Model.BulkPublishRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.BulkPublishRequest Container for the necessary parameters to execute the BulkPublish operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

BulkPublishAsync() public method

Initiates the asynchronous execution of the BulkPublish operation.
public BulkPublishAsync ( Amazon.CognitoSync.Model.BulkPublishRequest request, BulkPublishResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.BulkPublishRequest Container for the necessary parameters to execute the BulkPublish operation on AmazonCognitoSyncClient.
callback BulkPublishResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return Amazon.Runtime.Internal.Auth.AbstractAWSSigner

CustomizeRuntimePipeline() protected method

Customizes the runtime pipeline.
protected CustomizeRuntimePipeline ( RuntimePipeline pipeline ) : void
pipeline RuntimePipeline Runtime pipeline for the current client.
return void

DeleteDatasetAsync() public method

Initiates the asynchronous execution of the DeleteDataset operation.
public DeleteDatasetAsync ( Amazon.CognitoSync.Model.DeleteDatasetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.DeleteDatasetRequest Container for the necessary parameters to execute the DeleteDataset operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteDatasetAsync() public method

Initiates the asynchronous execution of the DeleteDataset operation.
public DeleteDatasetAsync ( Amazon.CognitoSync.Model.DeleteDatasetRequest request, DeleteDatasetResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.DeleteDatasetRequest Container for the necessary parameters to execute the DeleteDataset operation on AmazonCognitoSyncClient.
callback DeleteDatasetResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

DescribeDatasetAsync() public method

Initiates the asynchronous execution of the DescribeDataset operation.
public DescribeDatasetAsync ( Amazon.CognitoSync.Model.DescribeDatasetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.DescribeDatasetRequest Container for the necessary parameters to execute the DescribeDataset operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeDatasetAsync() public method

Initiates the asynchronous execution of the DescribeDataset operation.
public DescribeDatasetAsync ( Amazon.CognitoSync.Model.DescribeDatasetRequest request, DescribeDatasetResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.DescribeDatasetRequest Container for the necessary parameters to execute the DescribeDataset operation on AmazonCognitoSyncClient.
callback DescribeDatasetResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

DescribeIdentityPoolUsageAsync() public method

Initiates the asynchronous execution of the DescribeIdentityPoolUsage operation.
public DescribeIdentityPoolUsageAsync ( Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeIdentityPoolUsageAsync() public method

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.

/// 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. ///
public DescribeIdentityPoolUsageAsync ( string identityPoolId, System cancellationToken = default(CancellationToken) ) : Task
identityPoolId string 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.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeIdentityPoolUsageAsync() public method

Initiates the asynchronous execution of the DescribeIdentityPoolUsage operation.
public DescribeIdentityPoolUsageAsync ( Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest request, DescribeIdentityPoolUsageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation on AmazonCognitoSyncClient.
callback DescribeIdentityPoolUsageResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

DescribeIdentityPoolUsageAsync() public method

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.

/// 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. ///
public DescribeIdentityPoolUsageAsync ( string identityPoolId, DescribeIdentityPoolUsageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
identityPoolId string 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.
callback DescribeIdentityPoolUsageResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

DescribeIdentityUsageAsync() public method

Initiates the asynchronous execution of the DescribeIdentityUsage operation.
public DescribeIdentityUsageAsync ( Amazon.CognitoSync.Model.DescribeIdentityUsageRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.DescribeIdentityUsageRequest Container for the necessary parameters to execute the DescribeIdentityUsage operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeIdentityUsageAsync() public method

Initiates the asynchronous execution of the DescribeIdentityUsage operation.
public DescribeIdentityUsageAsync ( Amazon.CognitoSync.Model.DescribeIdentityUsageRequest request, DescribeIdentityUsageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.DescribeIdentityUsageRequest Container for the necessary parameters to execute the DescribeIdentityUsage operation on AmazonCognitoSyncClient.
callback DescribeIdentityUsageResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

GetBulkPublishDetailsAsync() public method

Initiates the asynchronous execution of the GetBulkPublishDetails operation.
public GetBulkPublishDetailsAsync ( Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest Container for the necessary parameters to execute the GetBulkPublishDetails operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetBulkPublishDetailsAsync() public method

Initiates the asynchronous execution of the GetBulkPublishDetails operation.
public GetBulkPublishDetailsAsync ( Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest request, GetBulkPublishDetailsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest Container for the necessary parameters to execute the GetBulkPublishDetails operation on AmazonCognitoSyncClient.
callback GetBulkPublishDetailsResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

GetCognitoEventsAsync() public method

Initiates the asynchronous execution of the GetCognitoEvents operation.
public GetCognitoEventsAsync ( Amazon.CognitoSync.Model.GetCognitoEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.GetCognitoEventsRequest Container for the necessary parameters to execute the GetCognitoEvents operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetCognitoEventsAsync() public method

Initiates the asynchronous execution of the GetCognitoEvents operation.
public GetCognitoEventsAsync ( Amazon.CognitoSync.Model.GetCognitoEventsRequest request, GetCognitoEventsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.GetCognitoEventsRequest Container for the necessary parameters to execute the GetCognitoEvents operation on AmazonCognitoSyncClient.
callback GetCognitoEventsResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

GetIdentityPoolConfigurationAsync() public method

Initiates the asynchronous execution of the GetIdentityPoolConfiguration operation.
public GetIdentityPoolConfigurationAsync ( Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest Container for the necessary parameters to execute the GetIdentityPoolConfiguration operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetIdentityPoolConfigurationAsync() public method

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.

/// 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. ///
public GetIdentityPoolConfigurationAsync ( string identityPoolId, System cancellationToken = default(CancellationToken) ) : Task
identityPoolId string 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.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetIdentityPoolConfigurationAsync() public method

Initiates the asynchronous execution of the GetIdentityPoolConfiguration operation.
public GetIdentityPoolConfigurationAsync ( Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest request, GetIdentityPoolConfigurationResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest Container for the necessary parameters to execute the GetIdentityPoolConfiguration operation on AmazonCognitoSyncClient.
callback GetIdentityPoolConfigurationResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

GetIdentityPoolConfigurationAsync() public method

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.

/// 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. ///
public GetIdentityPoolConfigurationAsync ( string identityPoolId, GetIdentityPoolConfigurationResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
identityPoolId string 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.
callback GetIdentityPoolConfigurationResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. ///
return void

ListDatasetsAsync() public method

Initiates the asynchronous execution of the ListDatasets operation.
public ListDatasetsAsync ( Amazon.CognitoSync.Model.ListDatasetsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.ListDatasetsRequest Container for the necessary parameters to execute the ListDatasets operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListDatasetsAsync() public method

Initiates the asynchronous execution of the ListDatasets operation.
public ListDatasetsAsync ( Amazon.CognitoSync.Model.ListDatasetsRequest request, ListDatasetsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.ListDatasetsRequest Container for the necessary parameters to execute the ListDatasets operation on AmazonCognitoSyncClient.
callback ListDatasetsResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

ListIdentityPoolUsageAsync() public method

Initiates the asynchronous execution of the ListIdentityPoolUsage operation.
public ListIdentityPoolUsageAsync ( Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest Container for the necessary parameters to execute the ListIdentityPoolUsage operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListIdentityPoolUsageAsync() public method

Initiates the asynchronous execution of the ListIdentityPoolUsage operation.
public ListIdentityPoolUsageAsync ( Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest request, ListIdentityPoolUsageResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest Container for the necessary parameters to execute the ListIdentityPoolUsage operation on AmazonCognitoSyncClient.
callback ListIdentityPoolUsageResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

ListRecordsAsync() public method

Initiates the asynchronous execution of the ListRecords operation.
public ListRecordsAsync ( Amazon.CognitoSync.Model.ListRecordsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.ListRecordsRequest Container for the necessary parameters to execute the ListRecords operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListRecordsAsync() public method

Initiates the asynchronous execution of the ListRecords operation.
public ListRecordsAsync ( Amazon.CognitoSync.Model.ListRecordsRequest request, ListRecordsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.ListRecordsRequest Container for the necessary parameters to execute the ListRecords operation on AmazonCognitoSyncClient.
callback ListRecordsResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

RegisterDeviceAsync() public method

Initiates the asynchronous execution of the RegisterDevice operation.
public RegisterDeviceAsync ( Amazon.CognitoSync.Model.RegisterDeviceRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.RegisterDeviceRequest Container for the necessary parameters to execute the RegisterDevice operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

RegisterDeviceAsync() public method

Initiates the asynchronous execution of the RegisterDevice operation.
public RegisterDeviceAsync ( Amazon.CognitoSync.Model.RegisterDeviceRequest request, RegisterDeviceResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.RegisterDeviceRequest Container for the necessary parameters to execute the RegisterDevice operation on AmazonCognitoSyncClient.
callback RegisterDeviceResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

SetCognitoEventsAsync() public method

Initiates the asynchronous execution of the SetCognitoEvents operation.
public SetCognitoEventsAsync ( Amazon.CognitoSync.Model.SetCognitoEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.SetCognitoEventsRequest Container for the necessary parameters to execute the SetCognitoEvents operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

SetCognitoEventsAsync() public method

Initiates the asynchronous execution of the SetCognitoEvents operation.
public SetCognitoEventsAsync ( Amazon.CognitoSync.Model.SetCognitoEventsRequest request, SetCognitoEventsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.SetCognitoEventsRequest Container for the necessary parameters to execute the SetCognitoEvents operation on AmazonCognitoSyncClient.
callback SetCognitoEventsResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

SetIdentityPoolConfigurationAsync() public method

Initiates the asynchronous execution of the SetIdentityPoolConfiguration operation.
public SetIdentityPoolConfigurationAsync ( Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest Container for the necessary parameters to execute the SetIdentityPoolConfiguration operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

SetIdentityPoolConfigurationAsync() public method

Initiates the asynchronous execution of the SetIdentityPoolConfiguration operation.
public SetIdentityPoolConfigurationAsync ( Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest request, SetIdentityPoolConfigurationResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest Container for the necessary parameters to execute the SetIdentityPoolConfiguration operation on AmazonCognitoSyncClient.
callback SetIdentityPoolConfigurationResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

SubscribeToDatasetAsync() public method

Initiates the asynchronous execution of the SubscribeToDataset operation.
public SubscribeToDatasetAsync ( Amazon.CognitoSync.Model.SubscribeToDatasetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.SubscribeToDatasetRequest Container for the necessary parameters to execute the SubscribeToDataset operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

SubscribeToDatasetAsync() public method

Initiates the asynchronous execution of the SubscribeToDataset operation.
public SubscribeToDatasetAsync ( Amazon.CognitoSync.Model.SubscribeToDatasetRequest request, SubscribeToDatasetResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.SubscribeToDatasetRequest Container for the necessary parameters to execute the SubscribeToDataset operation on AmazonCognitoSyncClient.
callback SubscribeToDatasetResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

UnsubscribeFromDatasetAsync() public method

Initiates the asynchronous execution of the UnsubscribeFromDataset operation.
public UnsubscribeFromDatasetAsync ( Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest Container for the necessary parameters to execute the UnsubscribeFromDataset operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UnsubscribeFromDatasetAsync() public method

Initiates the asynchronous execution of the UnsubscribeFromDataset operation.
public UnsubscribeFromDatasetAsync ( Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest request, UnsubscribeFromDatasetResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest Container for the necessary parameters to execute the UnsubscribeFromDataset operation on AmazonCognitoSyncClient.
callback UnsubscribeFromDatasetResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void

UpdateRecordsAsync() public method

Initiates the asynchronous execution of the UpdateRecords operation.
public UpdateRecordsAsync ( Amazon.CognitoSync.Model.UpdateRecordsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CognitoSync.Model.UpdateRecordsRequest Container for the necessary parameters to execute the UpdateRecords operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateRecordsAsync() public method

Initiates the asynchronous execution of the UpdateRecords operation.
public UpdateRecordsAsync ( Amazon.CognitoSync.Model.UpdateRecordsRequest request, UpdateRecordsResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
request Amazon.CognitoSync.Model.UpdateRecordsRequest Container for the necessary parameters to execute the UpdateRecords operation on AmazonCognitoSyncClient.
callback UpdateRecordsResponse>.AmazonServiceCallback An Action delegate that is invoked when the operation completes.
options Amazon.Runtime.AsyncOptions A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return void