cognitosync/aws.sdk.kotlin.services.cognitosync

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

bulkPublish

inline suspend fun CognitoSyncClient.bulkPublish(crossinline block: BulkPublishRequest.Builder.() -> Unit): BulkPublishResponse

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.

deleteDataset

inline suspend fun CognitoSyncClient.deleteDataset(crossinline block: DeleteDatasetRequest.Builder.() -> Unit): DeleteDatasetResponse

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.

describeDataset

inline suspend fun CognitoSyncClient.describeDataset(crossinline block: DescribeDatasetRequest.Builder.() -> Unit): DescribeDatasetResponse

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.

describeIdentityPoolUsage

inline suspend fun CognitoSyncClient.describeIdentityPoolUsage(crossinline block: DescribeIdentityPoolUsageRequest.Builder.() -> Unit): DescribeIdentityPoolUsageResponse

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

describeIdentityUsage

inline suspend fun CognitoSyncClient.describeIdentityUsage(crossinline block: DescribeIdentityUsageRequest.Builder.() -> Unit): DescribeIdentityUsageResponse

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

getBulkPublishDetails

inline suspend fun CognitoSyncClient.getBulkPublishDetails(crossinline block: GetBulkPublishDetailsRequest.Builder.() -> Unit): GetBulkPublishDetailsResponse

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

getCognitoEvents

inline suspend fun CognitoSyncClient.getCognitoEvents(crossinline block: GetCognitoEventsRequest.Builder.() -> Unit): GetCognitoEventsResponse

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

getIdentityPoolConfiguration

inline suspend fun CognitoSyncClient.getIdentityPoolConfiguration(crossinline block: GetIdentityPoolConfigurationRequest.Builder.() -> Unit): GetIdentityPoolConfigurationResponse

Gets the configuration settings of an identity pool.

listDatasets

inline suspend fun CognitoSyncClient.listDatasets(crossinline block: ListDatasetsRequest.Builder.() -> Unit): ListDatasetsResponse

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.

listIdentityPoolUsage

inline suspend fun CognitoSyncClient.listIdentityPoolUsage(crossinline block: ListIdentityPoolUsageRequest.Builder.() -> Unit): ListIdentityPoolUsageResponse

Gets a list of identity pools registered with Cognito.

listRecords

inline suspend fun CognitoSyncClient.listRecords(crossinline block: ListRecordsRequest.Builder.() -> Unit): ListRecordsResponse

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.

registerDevice

inline suspend fun CognitoSyncClient.registerDevice(crossinline block: RegisterDeviceRequest.Builder.() -> Unit): RegisterDeviceResponse

Registers a device to receive push sync notifications.

setCognitoEvents

inline suspend fun CognitoSyncClient.setCognitoEvents(crossinline block: SetCognitoEventsRequest.Builder.() -> Unit): SetCognitoEventsResponse

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.

setIdentityPoolConfiguration

inline suspend fun CognitoSyncClient.setIdentityPoolConfiguration(crossinline block: SetIdentityPoolConfigurationRequest.Builder.() -> Unit): SetIdentityPoolConfigurationResponse

Sets the necessary configuration for push sync.

subscribeToDataset

inline suspend fun CognitoSyncClient.subscribeToDataset(crossinline block: SubscribeToDatasetRequest.Builder.() -> Unit): SubscribeToDatasetResponse

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

unsubscribeFromDataset

inline suspend fun CognitoSyncClient.unsubscribeFromDataset(crossinline block: UnsubscribeFromDatasetRequest.Builder.() -> Unit): UnsubscribeFromDatasetResponse

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

updateRecords

inline suspend fun CognitoSyncClient.updateRecords(crossinline block: UpdateRecordsRequest.Builder.() -> Unit): UpdateRecordsResponse

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

withConfig

fun CognitoSyncClient.withConfig(block: CognitoSyncClient.Config.Builder.() -> Unit): CognitoSyncClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.