@datafire/amazonaws_cognito_sync

v5.0.0

Published

3 years ago

DataFire integration for Amazon Cognito Sync

Downloads

0High
0Medium
0Low

datafire

@datafire/amazonaws_cognito_sync

Client library for Amazon Cognito Sync

Installation and Usage

npm install --save @datafire/amazonaws_cognito_sync

let amazonaws_cognito_sync = require('@datafire/amazonaws_cognito_sync').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_cognito_sync.ListIdentityPoolUsage({}).then(data => {
  console.log(data);
});

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

Actions

ListIdentityPoolUsage

amazonaws_cognito_sync.ListIdentityPoolUsage({}, context)

Input

input object

Output

output ListIdentityPoolUsageResponse

DescribeIdentityPoolUsage

amazonaws_cognito_sync.DescribeIdentityPoolUsage({
  "IdentityPoolId": ""
}, context)

Input

input object
- IdentityPoolId required string

Output

output DescribeIdentityPoolUsageResponse

BulkPublish

amazonaws_cognito_sync.BulkPublish({
  "IdentityPoolId": ""
}, context)

Input

input object
- IdentityPoolId required string

Output

output BulkPublishResponse

GetIdentityPoolConfiguration

amazonaws_cognito_sync.GetIdentityPoolConfiguration({
  "IdentityPoolId": ""
}, context)

Input

input object
- IdentityPoolId required string

Output

output GetIdentityPoolConfigurationResponse

SetIdentityPoolConfiguration

amazonaws_cognito_sync.SetIdentityPoolConfiguration({
  "IdentityPoolId": ""
}, context)

Input

input object
- IdentityPoolId required string
- CognitoStreams CognitoStreams
- PushSync PushSync

Output

output SetIdentityPoolConfigurationResponse

GetCognitoEvents

amazonaws_cognito_sync.GetCognitoEvents({
  "IdentityPoolId": ""
}, context)

Input

input object
- IdentityPoolId required string

Output

output GetCognitoEventsResponse

SetCognitoEvents

amazonaws_cognito_sync.SetCognitoEvents({
  "IdentityPoolId": "",
  "Events": []
}, context)

Input

input object
- IdentityPoolId required string
- Events required Events

Output

Output schema unknown

GetBulkPublishDetails

amazonaws_cognito_sync.GetBulkPublishDetails({
  "IdentityPoolId": ""
}, context)

Input

input object
- IdentityPoolId required string

Output

output GetBulkPublishDetailsResponse

DescribeIdentityUsage

amazonaws_cognito_sync.DescribeIdentityUsage({
  "IdentityPoolId": "",
  "IdentityId": ""
}, context)

Input

input object
- IdentityPoolId required string
- IdentityId required string

Output

output DescribeIdentityUsageResponse

ListDatasets

amazonaws_cognito_sync.ListDatasets({
  "IdentityPoolId": "",
  "IdentityId": ""
}, context)

Input

input object
- IdentityPoolId required string
- IdentityId required string

Output

output ListDatasetsResponse

DeleteDataset

amazonaws_cognito_sync.DeleteDataset({
  "IdentityPoolId": "",
  "IdentityId": "",
  "DatasetName": ""
}, context)

Input

input object
- IdentityPoolId required string
- IdentityId required string
- DatasetName required string

Output

output DeleteDatasetResponse

DescribeDataset

amazonaws_cognito_sync.DescribeDataset({
  "IdentityPoolId": "",
  "IdentityId": "",
  "DatasetName": ""
}, context)

Input

input object
- IdentityPoolId required string
- IdentityId required string
- DatasetName required string

Output

output DescribeDatasetResponse

UpdateRecords

amazonaws_cognito_sync.UpdateRecords({
  "IdentityPoolId": "",
  "IdentityId": "",
  "DatasetName": "",
  "SyncSessionToken": ""
}, context)

Input

input object
- IdentityPoolId required string
- IdentityId required string
- DatasetName required string
- DeviceId DeviceId
- RecordPatches RecordPatchList
- SyncSessionToken required SyncSessionToken

Output

output UpdateRecordsResponse

ListRecords

amazonaws_cognito_sync.ListRecords({
  "IdentityPoolId": "",
  "IdentityId": "",
  "DatasetName": ""
}, context)

Input

input object
- IdentityPoolId required string
- IdentityId required string
- DatasetName required string

Output

output ListRecordsResponse

UnsubscribeFromDataset

amazonaws_cognito_sync.UnsubscribeFromDataset({
  "IdentityPoolId": "",
  "IdentityId": "",
  "DatasetName": "",
  "DeviceId": ""
}, context)

Input

input object
- IdentityPoolId required string
- IdentityId required string
- DatasetName required string
- DeviceId required string

Output

output UnsubscribeFromDatasetResponse

SubscribeToDataset

amazonaws_cognito_sync.SubscribeToDataset({
  "IdentityPoolId": "",
  "IdentityId": "",
  "DatasetName": "",
  "DeviceId": ""
}, context)

Input

input object
- IdentityPoolId required string
- IdentityId required string
- DatasetName required string
- DeviceId required string

Output

output SubscribeToDatasetResponse

RegisterDevice

amazonaws_cognito_sync.RegisterDevice({
  "IdentityPoolId": "",
  "IdentityId": "",
  "Platform": "",
  "Token": ""
}, context)

Input

input object
- IdentityPoolId required string
- IdentityId required string
- Platform required Platform
- Token required PushToken

Output

output RegisterDeviceResponse

Definitions

AlreadyStreamedException

AlreadyStreamedException object: An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.
- message required ExceptionMessage

ApplicationArn

ApplicationArn string

ApplicationArnList

ApplicationArnList array
- items ApplicationArn

AssumeRoleArn

AssumeRoleArn string

Boolean

Boolean boolean

BulkPublishRequest

BulkPublishRequest object: The input for the BulkPublish operation.

BulkPublishResponse

BulkPublishResponse object: The output for the BulkPublish operation.
- IdentityPoolId IdentityPoolId

BulkPublishStatus

BulkPublishStatus string (values: NOT_STARTED, IN_PROGRESS, FAILED, SUCCEEDED)

ClientContext

ClientContext string

CognitoEventType

CognitoEventType string

CognitoStreams

CognitoStreams object: Configuration options for configure Cognito streams.
- RoleArn AssumeRoleArn
- StreamName StreamName
- StreamingStatus StreamingStatus

ConcurrentModificationException

ConcurrentModificationException object: Thrown if there are parallel requests to modify a resource.
- message required String

Dataset

Dataset object: A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.
- CreationDate Date
- DataStorage Long
- DatasetName DatasetName
- IdentityId IdentityId
- LastModifiedBy String
- LastModifiedDate Date
- NumRecords Long

DatasetList

DatasetList array
- items Dataset

DatasetName

DatasetName string

Date

Date string

DeleteDatasetRequest

DeleteDatasetRequest object: A request to delete the specific dataset.

DeleteDatasetResponse

DeleteDatasetResponse object: Response to a successful DeleteDataset request.
- Dataset Dataset

DescribeDatasetRequest

DescribeDatasetRequest object: A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.

DescribeDatasetResponse

DescribeDatasetResponse object: Response to a successful DescribeDataset request.
- Dataset Dataset

DescribeIdentityPoolUsageRequest

DescribeIdentityPoolUsageRequest object: A request for usage information about the identity pool.

DescribeIdentityPoolUsageResponse

DescribeIdentityPoolUsageResponse object: Response to a successful DescribeIdentityPoolUsage request.
- IdentityPoolUsage IdentityPoolUsage

DescribeIdentityUsageRequest

DescribeIdentityUsageRequest object: A request for information about the usage of an identity pool.

DescribeIdentityUsageResponse

DescribeIdentityUsageResponse object: The response to a successful DescribeIdentityUsage request.
- IdentityUsage IdentityUsage

DeviceId

DeviceId string

DuplicateRequestException

DuplicateRequestException object: An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool.
- message required ExceptionMessage

Events

Events array
- items object
  - key CognitoEventType
  - value LambdaFunctionArn

ExceptionMessage

ExceptionMessage string

GetBulkPublishDetailsRequest

GetBulkPublishDetailsRequest object: The input for the GetBulkPublishDetails operation.

GetBulkPublishDetailsResponse

GetBulkPublishDetailsResponse object: The output for the GetBulkPublishDetails operation.
- BulkPublishCompleteTime Date
- BulkPublishStartTime Date
- BulkPublishStatus BulkPublishStatus
- FailureMessage String
- IdentityPoolId IdentityPoolId

GetCognitoEventsRequest

GetCognitoEventsRequest object: A request for a list of the configured Cognito Events

GetCognitoEventsResponse

GetCognitoEventsResponse object: The response from the GetCognitoEvents request
- Events Events

GetIdentityPoolConfigurationRequest

GetIdentityPoolConfigurationRequest object: The input for the GetIdentityPoolConfiguration operation.

GetIdentityPoolConfigurationResponse

GetIdentityPoolConfigurationResponse object: The output for the GetIdentityPoolConfiguration operation.
- CognitoStreams CognitoStreams
- IdentityPoolId IdentityPoolId
- PushSync PushSync

IdentityId

IdentityId string

IdentityPoolId

IdentityPoolId string

IdentityPoolUsage

IdentityPoolUsage object: Usage information for the identity pool.
- DataStorage Long
- IdentityPoolId IdentityPoolId
- LastModifiedDate Date
- SyncSessionsCount Long

IdentityPoolUsageList

IdentityPoolUsageList array
- items IdentityPoolUsage

IdentityUsage

IdentityUsage object: Usage information for the identity.
- DataStorage Long
- DatasetCount Integer
- IdentityId IdentityId
- IdentityPoolId IdentityPoolId
- LastModifiedDate Date

Integer

Integer integer

IntegerString

IntegerString integer

InternalErrorException

InternalErrorException object: Indicates an internal service error.
- message required ExceptionMessage

InvalidConfigurationException

InvalidConfigurationException object
- message required ExceptionMessage

InvalidLambdaFunctionOutputException

InvalidLambdaFunctionOutputException object: The AWS Lambda function returned invalid output or an exception.
- message required ExceptionMessage

InvalidParameterException

InvalidParameterException object: Thrown when a request parameter does not comply with the associated constraints.
- message required ExceptionMessage

LambdaFunctionArn

LambdaFunctionArn string

LambdaThrottledException

LambdaThrottledException object: AWS Lambda throttled your account, please contact AWS Support
- message required ExceptionMessage

LimitExceededException

LimitExceededException object: Thrown when the limit on the number of objects or operations has been exceeded.
- message required ExceptionMessage

ListDatasetsRequest

ListDatasetsRequest object: Request for a list of datasets for an identity.

ListDatasetsResponse

ListDatasetsResponse object: Returned for a successful ListDatasets request.
- Count Integer
- Datasets DatasetList
- NextToken String

ListIdentityPoolUsageRequest

ListIdentityPoolUsageRequest object: A request for usage information on an identity pool.

ListIdentityPoolUsageResponse

ListIdentityPoolUsageResponse object: Returned for a successful ListIdentityPoolUsage request.
- Count Integer
- IdentityPoolUsages IdentityPoolUsageList
- MaxResults Integer
- NextToken String

ListRecordsRequest

ListRecordsRequest object: A request for a list of records.

ListRecordsResponse

ListRecordsResponse object: Returned for a successful ListRecordsRequest.
- Count Integer
- DatasetDeletedAfterRequestedSyncCount Boolean
- DatasetExists Boolean
- DatasetSyncCount Long
- LastModifiedBy String
- MergedDatasetNames MergedDatasetNameList
- NextToken String
- Records RecordList
- SyncSessionToken String

Long

Long integer

MergedDatasetNameList

MergedDatasetNameList array
- items String

NotAuthorizedException

NotAuthorizedException object: Thrown when a user is not authorized to access the requested resource.
- message required ExceptionMessage

Operation

Operation string (values: replace, remove)

Platform

Platform string (values: APNS, APNS_SANDBOX, GCM, ADM)

PushSync

PushSync object: Configuration options to be applied to the identity pool.
- ApplicationArns ApplicationArnList
- RoleArn AssumeRoleArn

PushToken

PushToken string

Record

Record object: The basic data structure of a dataset.
- DeviceLastModifiedDate Date
- Key RecordKey
- LastModifiedBy String
- LastModifiedDate Date
- SyncCount Long
- Value RecordValue

RecordKey

RecordKey string

RecordList

RecordList array
- items Record

RecordPatch

RecordPatch object: An update operation for a record.
- DeviceLastModifiedDate Date
- Key required RecordKey
- Op required Operation
- SyncCount required Long
- Value RecordValue

RecordPatchList

RecordPatchList array
- items RecordPatch

RecordValue

RecordValue string

RegisterDeviceRequest

RegisterDeviceRequest object: A request to RegisterDevice.
- Platform required Platform
- Token required PushToken

RegisterDeviceResponse

RegisterDeviceResponse object: Response to a RegisterDevice request.
- DeviceId DeviceId

ResourceConflictException

ResourceConflictException object: Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.
- message required ExceptionMessage

ResourceNotFoundException

ResourceNotFoundException object: Thrown if the resource doesn't exist.
- message required ExceptionMessage

SetCognitoEventsRequest

SetCognitoEventsRequest object: A request to configure Cognito Events""
- Events required Events

SetIdentityPoolConfigurationRequest

SetIdentityPoolConfigurationRequest object: The input for the SetIdentityPoolConfiguration operation.
- CognitoStreams CognitoStreams
- PushSync PushSync

SetIdentityPoolConfigurationResponse

SetIdentityPoolConfigurationResponse object: The output for the SetIdentityPoolConfiguration operation
- CognitoStreams CognitoStreams
- IdentityPoolId IdentityPoolId
- PushSync PushSync

StreamName

StreamName string

StreamingStatus

StreamingStatus string (values: ENABLED, DISABLED)

String

String string

SubscribeToDatasetRequest

SubscribeToDatasetRequest object: A request to SubscribeToDatasetRequest.

SubscribeToDatasetResponse

SubscribeToDatasetResponse object: Response to a SubscribeToDataset request.

SyncSessionToken

SyncSessionToken string

TooManyRequestsException

TooManyRequestsException object: Thrown if the request is throttled.
- message required ExceptionMessage

UnsubscribeFromDatasetRequest

UnsubscribeFromDatasetRequest object: A request to UnsubscribeFromDataset.

UnsubscribeFromDatasetResponse

UnsubscribeFromDatasetResponse object: Response to an UnsubscribeFromDataset request.

UpdateRecordsRequest

UpdateRecordsRequest object: A request to post updates to records or add and delete records for a dataset and user.
- DeviceId DeviceId
- RecordPatches RecordPatchList
- SyncSessionToken required SyncSessionToken

UpdateRecordsResponse

UpdateRecordsResponse object: Returned for a successful UpdateRecordsRequest.
- Records RecordList

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@datafire/amazonaws_cognito_sync

Installation and Usage

Description

Actions

ListIdentityPoolUsage

Input

Output

DescribeIdentityPoolUsage

Input

Output

BulkPublish

Input

Output

GetIdentityPoolConfiguration

Input

Output

SetIdentityPoolConfiguration

Input

Output

GetCognitoEvents

Input

Output

SetCognitoEvents

Input

Output

GetBulkPublishDetails

Input

Output

DescribeIdentityUsage

Input

Output

ListDatasets

Input

Output

DeleteDataset

Input

Output

DescribeDataset

Input

Output

UpdateRecords

Input

Output

ListRecords

Input

Output

UnsubscribeFromDataset

Input

Output

SubscribeToDataset

Input

Output

RegisterDevice

Input

Output

Definitions

AlreadyStreamedException

ApplicationArn

ApplicationArnList

AssumeRoleArn

Boolean

BulkPublishRequest

BulkPublishResponse

BulkPublishStatus

ClientContext

CognitoEventType

CognitoStreams

ConcurrentModificationException

Dataset

DatasetList

DatasetName

Date

DeleteDatasetRequest

DeleteDatasetResponse