NAME

Paws::CognitoSync - Perl Interface to AWS Amazon Cognito Sync

SYNOPSIS

  use Paws;
  my $obj = Paws->service('CognitoSync');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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 (http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html).

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 (http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html) and the Developer Guide for iOS (http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html).

For the AWS API documentation, see <https://docs.aws.amazon.com/cognito/>

METHODS

BulkPublish

IdentityPoolId => Str

Each argument is described in detail in: Paws::CognitoSync::BulkPublish

Returns: a Paws::CognitoSync::BulkPublishResponse instance

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.

Each argument is described in detail in: Paws::CognitoSync::DeleteDataset

Returns: a Paws::CognitoSync::DeleteDatasetResponse instance

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.

DescribeDataset

DatasetName => Str
IdentityId => Str
IdentityPoolId => Str

Each argument is described in detail in: Paws::CognitoSync::DescribeDataset

Returns: a Paws::CognitoSync::DescribeDatasetResponse instance

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.

DescribeIdentityPoolUsage

IdentityPoolId => Str

Each argument is described in detail in: Paws::CognitoSync::DescribeIdentityPoolUsage

Returns: a Paws::CognitoSync::DescribeIdentityPoolUsageResponse instance

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.

DescribeIdentityUsage

IdentityId => Str
IdentityPoolId => Str

Each argument is described in detail in: Paws::CognitoSync::DescribeIdentityUsage

Returns: a Paws::CognitoSync::DescribeIdentityUsageResponse instance

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.

GetBulkPublishDetails

IdentityPoolId => Str

Each argument is described in detail in: Paws::CognitoSync::GetBulkPublishDetails

Returns: a Paws::CognitoSync::GetBulkPublishDetailsResponse instance

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.

GetCognitoEvents

IdentityPoolId => Str

Each argument is described in detail in: Paws::CognitoSync::GetCognitoEvents

Returns: a Paws::CognitoSync::GetCognitoEventsResponse instance

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.

GetIdentityPoolConfiguration

IdentityPoolId => Str

Each argument is described in detail in: Paws::CognitoSync::GetIdentityPoolConfiguration

Returns: a Paws::CognitoSync::GetIdentityPoolConfigurationResponse instance

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.

ListDatasets

IdentityId => Str
IdentityPoolId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CognitoSync::ListDatasets

Returns: a Paws::CognitoSync::ListDatasetsResponse instance

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.

ListIdentityPoolUsage

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CognitoSync::ListIdentityPoolUsage

Returns: a Paws::CognitoSync::ListIdentityPoolUsageResponse instance

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.

ListRecords

DatasetName => Str
IdentityId => Str
IdentityPoolId => Str
[LastSyncCount => Int]
[MaxResults => Int]
[NextToken => Str]
[SyncSessionToken => Str]

Each argument is described in detail in: Paws::CognitoSync::ListRecords

Returns: a Paws::CognitoSync::ListRecordsResponse instance

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.

RegisterDevice

IdentityId => Str
IdentityPoolId => Str
Platform => Str
Token => Str

Each argument is described in detail in: Paws::CognitoSync::RegisterDevice

Returns: a Paws::CognitoSync::RegisterDeviceResponse instance

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.

SetCognitoEvents

Events => Paws::CognitoSync::Events
IdentityPoolId => Str

Each argument is described in detail in: Paws::CognitoSync::SetCognitoEvents

Returns: nothing

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.

SetIdentityPoolConfiguration

IdentityPoolId => Str
[CognitoStreams => Paws::CognitoSync::CognitoStreams]
[PushSync => Paws::CognitoSync::PushSync]

Each argument is described in detail in: Paws::CognitoSync::SetIdentityPoolConfiguration

Returns: a Paws::CognitoSync::SetIdentityPoolConfigurationResponse instance

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.

SubscribeToDataset

DatasetName => Str
DeviceId => Str
IdentityId => Str
IdentityPoolId => Str

Each argument is described in detail in: Paws::CognitoSync::SubscribeToDataset

Returns: a Paws::CognitoSync::SubscribeToDatasetResponse instance

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.

UnsubscribeFromDataset

DatasetName => Str
DeviceId => Str
IdentityId => Str
IdentityPoolId => Str

Each argument is described in detail in: Paws::CognitoSync::UnsubscribeFromDataset

Returns: a Paws::CognitoSync::UnsubscribeFromDatasetResponse instance

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.

UpdateRecords

DatasetName => Str
IdentityId => Str
IdentityPoolId => Str
SyncSessionToken => Str
[ClientContext => Str]
[DeviceId => Str]
[RecordPatches => ArrayRef[Paws::CognitoSync::RecordPatch]]

Each argument is described in detail in: Paws::CognitoSync::UpdateRecords

Returns: a Paws::CognitoSync::UpdateRecordsResponse instance

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>