cognitosync.d.ts (39334B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class CognitoSync extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: CognitoSync.Types.ClientConfiguration) 13 config: Config & CognitoSync.Types.ClientConfiguration; 14 /** 15 * 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. 16 */ 17 bulkPublish(params: CognitoSync.Types.BulkPublishRequest, callback?: (err: AWSError, data: CognitoSync.Types.BulkPublishResponse) => void): Request<CognitoSync.Types.BulkPublishResponse, AWSError>; 18 /** 19 * 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. 20 */ 21 bulkPublish(callback?: (err: AWSError, data: CognitoSync.Types.BulkPublishResponse) => void): Request<CognitoSync.Types.BulkPublishResponse, AWSError>; 22 /** 23 * 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. 24 */ 25 deleteDataset(params: CognitoSync.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: CognitoSync.Types.DeleteDatasetResponse) => void): Request<CognitoSync.Types.DeleteDatasetResponse, AWSError>; 26 /** 27 * 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. 28 */ 29 deleteDataset(callback?: (err: AWSError, data: CognitoSync.Types.DeleteDatasetResponse) => void): Request<CognitoSync.Types.DeleteDatasetResponse, AWSError>; 30 /** 31 * 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. 32 */ 33 describeDataset(params: CognitoSync.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: CognitoSync.Types.DescribeDatasetResponse) => void): Request<CognitoSync.Types.DescribeDatasetResponse, AWSError>; 34 /** 35 * 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. 36 */ 37 describeDataset(callback?: (err: AWSError, data: CognitoSync.Types.DescribeDatasetResponse) => void): Request<CognitoSync.Types.DescribeDatasetResponse, AWSError>; 38 /** 39 * 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. 40 */ 41 describeIdentityPoolUsage(params: CognitoSync.Types.DescribeIdentityPoolUsageRequest, callback?: (err: AWSError, data: CognitoSync.Types.DescribeIdentityPoolUsageResponse) => void): Request<CognitoSync.Types.DescribeIdentityPoolUsageResponse, AWSError>; 42 /** 43 * 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. 44 */ 45 describeIdentityPoolUsage(callback?: (err: AWSError, data: CognitoSync.Types.DescribeIdentityPoolUsageResponse) => void): Request<CognitoSync.Types.DescribeIdentityPoolUsageResponse, AWSError>; 46 /** 47 * 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. 48 */ 49 describeIdentityUsage(params: CognitoSync.Types.DescribeIdentityUsageRequest, callback?: (err: AWSError, data: CognitoSync.Types.DescribeIdentityUsageResponse) => void): Request<CognitoSync.Types.DescribeIdentityUsageResponse, AWSError>; 50 /** 51 * 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. 52 */ 53 describeIdentityUsage(callback?: (err: AWSError, data: CognitoSync.Types.DescribeIdentityUsageResponse) => void): Request<CognitoSync.Types.DescribeIdentityUsageResponse, AWSError>; 54 /** 55 * 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. 56 */ 57 getBulkPublishDetails(params: CognitoSync.Types.GetBulkPublishDetailsRequest, callback?: (err: AWSError, data: CognitoSync.Types.GetBulkPublishDetailsResponse) => void): Request<CognitoSync.Types.GetBulkPublishDetailsResponse, AWSError>; 58 /** 59 * 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. 60 */ 61 getBulkPublishDetails(callback?: (err: AWSError, data: CognitoSync.Types.GetBulkPublishDetailsResponse) => void): Request<CognitoSync.Types.GetBulkPublishDetailsResponse, AWSError>; 62 /** 63 * 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. 64 */ 65 getCognitoEvents(params: CognitoSync.Types.GetCognitoEventsRequest, callback?: (err: AWSError, data: CognitoSync.Types.GetCognitoEventsResponse) => void): Request<CognitoSync.Types.GetCognitoEventsResponse, AWSError>; 66 /** 67 * 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. 68 */ 69 getCognitoEvents(callback?: (err: AWSError, data: CognitoSync.Types.GetCognitoEventsResponse) => void): Request<CognitoSync.Types.GetCognitoEventsResponse, AWSError>; 70 /** 71 * 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. 72 */ 73 getIdentityPoolConfiguration(params: CognitoSync.Types.GetIdentityPoolConfigurationRequest, callback?: (err: AWSError, data: CognitoSync.Types.GetIdentityPoolConfigurationResponse) => void): Request<CognitoSync.Types.GetIdentityPoolConfigurationResponse, AWSError>; 74 /** 75 * 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. 76 */ 77 getIdentityPoolConfiguration(callback?: (err: AWSError, data: CognitoSync.Types.GetIdentityPoolConfigurationResponse) => void): Request<CognitoSync.Types.GetIdentityPoolConfigurationResponse, AWSError>; 78 /** 79 * 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. 80 */ 81 listDatasets(params: CognitoSync.Types.ListDatasetsRequest, callback?: (err: AWSError, data: CognitoSync.Types.ListDatasetsResponse) => void): Request<CognitoSync.Types.ListDatasetsResponse, AWSError>; 82 /** 83 * 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. 84 */ 85 listDatasets(callback?: (err: AWSError, data: CognitoSync.Types.ListDatasetsResponse) => void): Request<CognitoSync.Types.ListDatasetsResponse, AWSError>; 86 /** 87 * 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. 88 */ 89 listIdentityPoolUsage(params: CognitoSync.Types.ListIdentityPoolUsageRequest, callback?: (err: AWSError, data: CognitoSync.Types.ListIdentityPoolUsageResponse) => void): Request<CognitoSync.Types.ListIdentityPoolUsageResponse, AWSError>; 90 /** 91 * 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. 92 */ 93 listIdentityPoolUsage(callback?: (err: AWSError, data: CognitoSync.Types.ListIdentityPoolUsageResponse) => void): Request<CognitoSync.Types.ListIdentityPoolUsageResponse, AWSError>; 94 /** 95 * 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. 96 */ 97 listRecords(params: CognitoSync.Types.ListRecordsRequest, callback?: (err: AWSError, data: CognitoSync.Types.ListRecordsResponse) => void): Request<CognitoSync.Types.ListRecordsResponse, AWSError>; 98 /** 99 * 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. 100 */ 101 listRecords(callback?: (err: AWSError, data: CognitoSync.Types.ListRecordsResponse) => void): Request<CognitoSync.Types.ListRecordsResponse, AWSError>; 102 /** 103 * 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. 104 */ 105 registerDevice(params: CognitoSync.Types.RegisterDeviceRequest, callback?: (err: AWSError, data: CognitoSync.Types.RegisterDeviceResponse) => void): Request<CognitoSync.Types.RegisterDeviceResponse, AWSError>; 106 /** 107 * 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. 108 */ 109 registerDevice(callback?: (err: AWSError, data: CognitoSync.Types.RegisterDeviceResponse) => void): Request<CognitoSync.Types.RegisterDeviceResponse, AWSError>; 110 /** 111 * 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. 112 */ 113 setCognitoEvents(params: CognitoSync.Types.SetCognitoEventsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 114 /** 115 * 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. 116 */ 117 setCognitoEvents(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 118 /** 119 * 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. 120 */ 121 setIdentityPoolConfiguration(params: CognitoSync.Types.SetIdentityPoolConfigurationRequest, callback?: (err: AWSError, data: CognitoSync.Types.SetIdentityPoolConfigurationResponse) => void): Request<CognitoSync.Types.SetIdentityPoolConfigurationResponse, AWSError>; 122 /** 123 * 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. 124 */ 125 setIdentityPoolConfiguration(callback?: (err: AWSError, data: CognitoSync.Types.SetIdentityPoolConfigurationResponse) => void): Request<CognitoSync.Types.SetIdentityPoolConfigurationResponse, AWSError>; 126 /** 127 * 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. 128 */ 129 subscribeToDataset(params: CognitoSync.Types.SubscribeToDatasetRequest, callback?: (err: AWSError, data: CognitoSync.Types.SubscribeToDatasetResponse) => void): Request<CognitoSync.Types.SubscribeToDatasetResponse, AWSError>; 130 /** 131 * 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. 132 */ 133 subscribeToDataset(callback?: (err: AWSError, data: CognitoSync.Types.SubscribeToDatasetResponse) => void): Request<CognitoSync.Types.SubscribeToDatasetResponse, AWSError>; 134 /** 135 * 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. 136 */ 137 unsubscribeFromDataset(params: CognitoSync.Types.UnsubscribeFromDatasetRequest, callback?: (err: AWSError, data: CognitoSync.Types.UnsubscribeFromDatasetResponse) => void): Request<CognitoSync.Types.UnsubscribeFromDatasetResponse, AWSError>; 138 /** 139 * 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. 140 */ 141 unsubscribeFromDataset(callback?: (err: AWSError, data: CognitoSync.Types.UnsubscribeFromDatasetResponse) => void): Request<CognitoSync.Types.UnsubscribeFromDatasetResponse, AWSError>; 142 /** 143 * 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. 144 */ 145 updateRecords(params: CognitoSync.Types.UpdateRecordsRequest, callback?: (err: AWSError, data: CognitoSync.Types.UpdateRecordsResponse) => void): Request<CognitoSync.Types.UpdateRecordsResponse, AWSError>; 146 /** 147 * 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. 148 */ 149 updateRecords(callback?: (err: AWSError, data: CognitoSync.Types.UpdateRecordsResponse) => void): Request<CognitoSync.Types.UpdateRecordsResponse, AWSError>; 150 } 151 declare namespace CognitoSync.Types { 152 export type ApplicationArn = string; 153 export type ApplicationArnList = ApplicationArn[]; 154 export type AssumeRoleArn = string; 155 export type Boolean = boolean; 156 export interface BulkPublishRequest { 157 /** 158 * 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. 159 */ 160 IdentityPoolId: IdentityPoolId; 161 } 162 export interface BulkPublishResponse { 163 /** 164 * 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. 165 */ 166 IdentityPoolId?: IdentityPoolId; 167 } 168 export type BulkPublishStatus = "NOT_STARTED"|"IN_PROGRESS"|"FAILED"|"SUCCEEDED"|string; 169 export type ClientContext = string; 170 export type CognitoEventType = string; 171 export interface CognitoStreams { 172 /** 173 * The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool. 174 */ 175 StreamName?: StreamName; 176 /** 177 * The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream. 178 */ 179 RoleArn?: AssumeRoleArn; 180 /** 181 * Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates to identity pool is enabled. DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED. 182 */ 183 StreamingStatus?: StreamingStatus; 184 } 185 export interface Dataset { 186 /** 187 * 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. 188 */ 189 IdentityId?: IdentityId; 190 /** 191 * A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). 192 */ 193 DatasetName?: DatasetName; 194 /** 195 * Date on which the dataset was created. 196 */ 197 CreationDate?: _Date; 198 /** 199 * Date when the dataset was last modified. 200 */ 201 LastModifiedDate?: _Date; 202 /** 203 * The device that made the last change to this dataset. 204 */ 205 LastModifiedBy?: String; 206 /** 207 * Total size in bytes of the records in this dataset. 208 */ 209 DataStorage?: Long; 210 /** 211 * Number of records in this dataset. 212 */ 213 NumRecords?: Long; 214 } 215 export type DatasetList = Dataset[]; 216 export type DatasetName = string; 217 export type _Date = Date; 218 export interface DeleteDatasetRequest { 219 /** 220 * 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. 221 */ 222 IdentityPoolId: IdentityPoolId; 223 /** 224 * 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. 225 */ 226 IdentityId: IdentityId; 227 /** 228 * A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). 229 */ 230 DatasetName: DatasetName; 231 } 232 export interface DeleteDatasetResponse { 233 /** 234 * 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. 235 */ 236 Dataset?: Dataset; 237 } 238 export interface DescribeDatasetRequest { 239 /** 240 * 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. 241 */ 242 IdentityPoolId: IdentityPoolId; 243 /** 244 * 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. 245 */ 246 IdentityId: IdentityId; 247 /** 248 * A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). 249 */ 250 DatasetName: DatasetName; 251 } 252 export interface DescribeDatasetResponse { 253 /** 254 * Meta data for a collection of data for an identity. An identity can have multiple datasets. A dataset 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. 255 */ 256 Dataset?: Dataset; 257 } 258 export interface DescribeIdentityPoolUsageRequest { 259 /** 260 * 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. 261 */ 262 IdentityPoolId: IdentityPoolId; 263 } 264 export interface DescribeIdentityPoolUsageResponse { 265 /** 266 * Information about the usage of the identity pool. 267 */ 268 IdentityPoolUsage?: IdentityPoolUsage; 269 } 270 export interface DescribeIdentityUsageRequest { 271 /** 272 * 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. 273 */ 274 IdentityPoolId: IdentityPoolId; 275 /** 276 * 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. 277 */ 278 IdentityId: IdentityId; 279 } 280 export interface DescribeIdentityUsageResponse { 281 /** 282 * Usage information for the identity. 283 */ 284 IdentityUsage?: IdentityUsage; 285 } 286 export type DeviceId = string; 287 export type Events = {[key: string]: LambdaFunctionArn}; 288 export type ExceptionMessage = string; 289 export interface GetBulkPublishDetailsRequest { 290 /** 291 * 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. 292 */ 293 IdentityPoolId: IdentityPoolId; 294 } 295 export interface GetBulkPublishDetailsResponse { 296 /** 297 * 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. 298 */ 299 IdentityPoolId?: IdentityPoolId; 300 /** 301 * The date/time at which the last bulk publish was initiated. 302 */ 303 BulkPublishStartTime?: _Date; 304 /** 305 * If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed. 306 */ 307 BulkPublishCompleteTime?: _Date; 308 /** 309 * Status of the last bulk publish operation, valid values are: NOT_STARTED - No bulk publish has been requested for this identity pool IN_PROGRESS - Data is being published to the configured stream SUCCEEDED - All data for the identity pool has been published to the configured stream FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause. 310 */ 311 BulkPublishStatus?: BulkPublishStatus; 312 /** 313 * If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail. 314 */ 315 FailureMessage?: String; 316 } 317 export interface GetCognitoEventsRequest { 318 /** 319 * The Cognito Identity Pool ID for the request 320 */ 321 IdentityPoolId: IdentityPoolId; 322 } 323 export interface GetCognitoEventsResponse { 324 /** 325 * The Cognito Events returned from the GetCognitoEvents request 326 */ 327 Events?: Events; 328 } 329 export interface GetIdentityPoolConfigurationRequest { 330 /** 331 * 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. 332 */ 333 IdentityPoolId: IdentityPoolId; 334 } 335 export interface GetIdentityPoolConfigurationResponse { 336 /** 337 * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. 338 */ 339 IdentityPoolId?: IdentityPoolId; 340 /** 341 * Options to apply to this identity pool for push synchronization. 342 */ 343 PushSync?: PushSync; 344 /** 345 * Options to apply to this identity pool for Amazon Cognito streams. 346 */ 347 CognitoStreams?: CognitoStreams; 348 } 349 export type IdentityId = string; 350 export type IdentityPoolId = string; 351 export interface IdentityPoolUsage { 352 /** 353 * 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. 354 */ 355 IdentityPoolId?: IdentityPoolId; 356 /** 357 * Number of sync sessions for the identity pool. 358 */ 359 SyncSessionsCount?: Long; 360 /** 361 * Data storage information for the identity pool. 362 */ 363 DataStorage?: Long; 364 /** 365 * Date on which the identity pool was last modified. 366 */ 367 LastModifiedDate?: _Date; 368 } 369 export type IdentityPoolUsageList = IdentityPoolUsage[]; 370 export interface IdentityUsage { 371 /** 372 * 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. 373 */ 374 IdentityId?: IdentityId; 375 /** 376 * 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. 377 */ 378 IdentityPoolId?: IdentityPoolId; 379 /** 380 * Date on which the identity was last modified. 381 */ 382 LastModifiedDate?: _Date; 383 /** 384 * Number of datasets for the identity. 385 */ 386 DatasetCount?: Integer; 387 /** 388 * Total data storage for this identity. 389 */ 390 DataStorage?: Long; 391 } 392 export type Integer = number; 393 export type IntegerString = number; 394 export type LambdaFunctionArn = string; 395 export interface ListDatasetsRequest { 396 /** 397 * 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. 398 */ 399 IdentityPoolId: IdentityPoolId; 400 /** 401 * 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. 402 */ 403 IdentityId: IdentityId; 404 /** 405 * A pagination token for obtaining the next page of results. 406 */ 407 NextToken?: String; 408 /** 409 * The maximum number of results to be returned. 410 */ 411 MaxResults?: IntegerString; 412 } 413 export interface ListDatasetsResponse { 414 /** 415 * A set of datasets. 416 */ 417 Datasets?: DatasetList; 418 /** 419 * Number of datasets returned. 420 */ 421 Count?: Integer; 422 /** 423 * A pagination token for obtaining the next page of results. 424 */ 425 NextToken?: String; 426 } 427 export interface ListIdentityPoolUsageRequest { 428 /** 429 * A pagination token for obtaining the next page of results. 430 */ 431 NextToken?: String; 432 /** 433 * The maximum number of results to be returned. 434 */ 435 MaxResults?: IntegerString; 436 } 437 export interface ListIdentityPoolUsageResponse { 438 /** 439 * Usage information for the identity pools. 440 */ 441 IdentityPoolUsages?: IdentityPoolUsageList; 442 /** 443 * The maximum number of results to be returned. 444 */ 445 MaxResults?: Integer; 446 /** 447 * Total number of identities for the identity pool. 448 */ 449 Count?: Integer; 450 /** 451 * A pagination token for obtaining the next page of results. 452 */ 453 NextToken?: String; 454 } 455 export interface ListRecordsRequest { 456 /** 457 * 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. 458 */ 459 IdentityPoolId: IdentityPoolId; 460 /** 461 * 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. 462 */ 463 IdentityId: IdentityId; 464 /** 465 * A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). 466 */ 467 DatasetName: DatasetName; 468 /** 469 * The last server sync count for this record. 470 */ 471 LastSyncCount?: Long; 472 /** 473 * A pagination token for obtaining the next page of results. 474 */ 475 NextToken?: String; 476 /** 477 * The maximum number of results to be returned. 478 */ 479 MaxResults?: IntegerString; 480 /** 481 * A token containing a session ID, identity ID, and expiration. 482 */ 483 SyncSessionToken?: SyncSessionToken; 484 } 485 export interface ListRecordsResponse { 486 /** 487 * A list of all records. 488 */ 489 Records?: RecordList; 490 /** 491 * A pagination token for obtaining the next page of results. 492 */ 493 NextToken?: String; 494 /** 495 * Total number of records. 496 */ 497 Count?: Integer; 498 /** 499 * Server sync count for this dataset. 500 */ 501 DatasetSyncCount?: Long; 502 /** 503 * The user/device that made the last change to this record. 504 */ 505 LastModifiedBy?: String; 506 /** 507 * Names of merged datasets. 508 */ 509 MergedDatasetNames?: MergedDatasetNameList; 510 /** 511 * Indicates whether the dataset exists. 512 */ 513 DatasetExists?: Boolean; 514 /** 515 * A boolean value specifying whether to delete the dataset locally. 516 */ 517 DatasetDeletedAfterRequestedSyncCount?: Boolean; 518 /** 519 * A token containing a session ID, identity ID, and expiration. 520 */ 521 SyncSessionToken?: String; 522 } 523 export type Long = number; 524 export type MergedDatasetNameList = String[]; 525 export type Operation = "replace"|"remove"|string; 526 export type Platform = "APNS"|"APNS_SANDBOX"|"GCM"|"ADM"|string; 527 export interface PushSync { 528 /** 529 * List of SNS platform application ARNs that could be used by clients. 530 */ 531 ApplicationArns?: ApplicationArnList; 532 /** 533 * A role configured to allow Cognito to call SNS on behalf of the developer. 534 */ 535 RoleArn?: AssumeRoleArn; 536 } 537 export type PushToken = string; 538 export interface Record { 539 /** 540 * The key for the record. 541 */ 542 Key?: RecordKey; 543 /** 544 * The value for the record. 545 */ 546 Value?: RecordValue; 547 /** 548 * The server sync count for this record. 549 */ 550 SyncCount?: Long; 551 /** 552 * The date on which the record was last modified. 553 */ 554 LastModifiedDate?: _Date; 555 /** 556 * The user/device that made the last change to this record. 557 */ 558 LastModifiedBy?: String; 559 /** 560 * The last modified date of the client device. 561 */ 562 DeviceLastModifiedDate?: _Date; 563 } 564 export type RecordKey = string; 565 export type RecordList = Record[]; 566 export interface RecordPatch { 567 /** 568 * An operation, either replace or remove. 569 */ 570 Op: Operation; 571 /** 572 * The key associated with the record patch. 573 */ 574 Key: RecordKey; 575 /** 576 * The value associated with the record patch. 577 */ 578 Value?: RecordValue; 579 /** 580 * Last known server sync count for this record. Set to 0 if unknown. 581 */ 582 SyncCount: Long; 583 /** 584 * The last modified date of the client device. 585 */ 586 DeviceLastModifiedDate?: _Date; 587 } 588 export type RecordPatchList = RecordPatch[]; 589 export type RecordValue = string; 590 export interface RegisterDeviceRequest { 591 /** 592 * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to. 593 */ 594 IdentityPoolId: IdentityPoolId; 595 /** 596 * The unique ID for this identity. 597 */ 598 IdentityId: IdentityId; 599 /** 600 * The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX). 601 */ 602 Platform: Platform; 603 /** 604 * The push token. 605 */ 606 Token: PushToken; 607 } 608 export interface RegisterDeviceResponse { 609 /** 610 * The unique ID generated for this device by Cognito. 611 */ 612 DeviceId?: DeviceId; 613 } 614 export interface SetCognitoEventsRequest { 615 /** 616 * The Cognito Identity Pool to use when configuring Cognito Events 617 */ 618 IdentityPoolId: IdentityPoolId; 619 /** 620 * The events to configure 621 */ 622 Events: Events; 623 } 624 export interface SetIdentityPoolConfigurationRequest { 625 /** 626 * 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 to modify. 627 */ 628 IdentityPoolId: IdentityPoolId; 629 /** 630 * Options to apply to this identity pool for push synchronization. 631 */ 632 PushSync?: PushSync; 633 /** 634 * Options to apply to this identity pool for Amazon Cognito streams. 635 */ 636 CognitoStreams?: CognitoStreams; 637 } 638 export interface SetIdentityPoolConfigurationResponse { 639 /** 640 * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. 641 */ 642 IdentityPoolId?: IdentityPoolId; 643 /** 644 * Options to apply to this identity pool for push synchronization. 645 */ 646 PushSync?: PushSync; 647 /** 648 * Options to apply to this identity pool for Amazon Cognito streams. 649 */ 650 CognitoStreams?: CognitoStreams; 651 } 652 export type StreamName = string; 653 export type StreamingStatus = "ENABLED"|"DISABLED"|string; 654 export type String = string; 655 export interface SubscribeToDatasetRequest { 656 /** 657 * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs. 658 */ 659 IdentityPoolId: IdentityPoolId; 660 /** 661 * Unique ID for this identity. 662 */ 663 IdentityId: IdentityId; 664 /** 665 * The name of the dataset to subcribe to. 666 */ 667 DatasetName: DatasetName; 668 /** 669 * The unique ID generated for this device by Cognito. 670 */ 671 DeviceId: DeviceId; 672 } 673 export interface SubscribeToDatasetResponse { 674 } 675 export type SyncSessionToken = string; 676 export interface UnsubscribeFromDatasetRequest { 677 /** 678 * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs. 679 */ 680 IdentityPoolId: IdentityPoolId; 681 /** 682 * Unique ID for this identity. 683 */ 684 IdentityId: IdentityId; 685 /** 686 * The name of the dataset from which to unsubcribe. 687 */ 688 DatasetName: DatasetName; 689 /** 690 * The unique ID generated for this device by Cognito. 691 */ 692 DeviceId: DeviceId; 693 } 694 export interface UnsubscribeFromDatasetResponse { 695 } 696 export interface UpdateRecordsRequest { 697 /** 698 * 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. 699 */ 700 IdentityPoolId: IdentityPoolId; 701 /** 702 * 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. 703 */ 704 IdentityId: IdentityId; 705 /** 706 * A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). 707 */ 708 DatasetName: DatasetName; 709 /** 710 * The unique ID generated for this device by Cognito. 711 */ 712 DeviceId?: DeviceId; 713 /** 714 * A list of patch operations. 715 */ 716 RecordPatches?: RecordPatchList; 717 /** 718 * The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity. 719 */ 720 SyncSessionToken: SyncSessionToken; 721 /** 722 * Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented. 723 */ 724 ClientContext?: ClientContext; 725 } 726 export interface UpdateRecordsResponse { 727 /** 728 * A list of records that have been updated. 729 */ 730 Records?: RecordList; 731 } 732 /** 733 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 734 */ 735 export type apiVersion = "2014-06-30"|"latest"|string; 736 export interface ClientApiVersions { 737 /** 738 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 739 */ 740 apiVersion?: apiVersion; 741 } 742 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 743 } 744 export = CognitoSync;