@aws-sdk/client-cognito-sync 3.325.0 → 3.326.0

package/dist-types/commands/BulkPublishCommand.d.ts

@@ -31,6 +31,10 @@ export interface BulkPublishCommandOutput extends BulkPublishResponse, __Metadat
  * };
  * const command = new BulkPublishCommand(input);
  * const response = await client.send(command);
+ * // { // BulkPublishResponse
+ * //   IdentityPoolId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param BulkPublishCommandInput - {@link BulkPublishCommandInput}
@@ -61,6 +65,8 @@ export interface BulkPublishCommandOutput extends BulkPublishResponse, __Metadat
  *  Thrown if the resource doesn't
  *       exist.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class BulkPublishCommand extends $Command<BulkPublishCommandInput, BulkPublishCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/DeleteDatasetCommand.d.ts

@@ -37,6 +37,18 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
  * };
  * const command = new DeleteDatasetCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteDatasetResponse
+ * //   Dataset: { // Dataset
+ * //     IdentityId: "STRING_VALUE",
+ * //     DatasetName: "STRING_VALUE",
+ * //     CreationDate: new Date("TIMESTAMP"),
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //     LastModifiedBy: "STRING_VALUE",
+ * //     DataStorage: Number("long"),
+ * //     NumRecords: Number("long"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DeleteDatasetCommandInput - {@link DeleteDatasetCommandInput}
@@ -69,6 +81,8 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/DescribeDatasetCommand.d.ts

@@ -36,6 +36,18 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
  * };
  * const command = new DescribeDatasetCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeDatasetResponse
+ * //   Dataset: { // Dataset
+ * //     IdentityId: "STRING_VALUE",
+ * //     DatasetName: "STRING_VALUE",
+ * //     CreationDate: new Date("TIMESTAMP"),
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //     LastModifiedBy: "STRING_VALUE",
+ * //     DataStorage: Number("long"),
+ * //     NumRecords: Number("long"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeDatasetCommandInput - {@link DescribeDatasetCommandInput}
@@ -64,6 +76,8 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/DescribeIdentityPoolUsageCommand.d.ts

@@ -79,6 +79,15 @@ export interface DescribeIdentityPoolUsageCommandOutput extends DescribeIdentity
  * };
  * const command = new DescribeIdentityPoolUsageCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeIdentityPoolUsageResponse
+ * //   IdentityPoolUsage: { // IdentityPoolUsage
+ * //     IdentityPoolId: "STRING_VALUE",
+ * //     SyncSessionsCount: Number("long"),
+ * //     DataStorage: Number("long"),
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeIdentityPoolUsageCommandInput - {@link DescribeIdentityPoolUsageCommandInput}
@@ -107,6 +116,8 @@ export interface DescribeIdentityPoolUsageCommandOutput extends DescribeIdentity
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class DescribeIdentityPoolUsageCommand extends $Command<DescribeIdentityPoolUsageCommandInput, DescribeIdentityPoolUsageCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/DescribeIdentityUsageCommand.d.ts

@@ -81,6 +81,16 @@ export interface DescribeIdentityUsageCommandOutput extends DescribeIdentityUsag
  * };
  * const command = new DescribeIdentityUsageCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeIdentityUsageResponse
+ * //   IdentityUsage: { // IdentityUsage
+ * //     IdentityId: "STRING_VALUE",
+ * //     IdentityPoolId: "STRING_VALUE",
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //     DatasetCount: Number("int"),
+ * //     DataStorage: Number("long"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeIdentityUsageCommandInput - {@link DescribeIdentityUsageCommandInput}
@@ -109,6 +119,8 @@ export interface DescribeIdentityUsageCommandOutput extends DescribeIdentityUsag
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class DescribeIdentityUsageCommand extends $Command<DescribeIdentityUsageCommandInput, DescribeIdentityUsageCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/GetBulkPublishDetailsCommand.d.ts

@@ -31,6 +31,14 @@ export interface GetBulkPublishDetailsCommandOutput extends GetBulkPublishDetail
  * };
  * const command = new GetBulkPublishDetailsCommand(input);
  * const response = await client.send(command);
+ * // { // GetBulkPublishDetailsResponse
+ * //   IdentityPoolId: "STRING_VALUE",
+ * //   BulkPublishStartTime: new Date("TIMESTAMP"),
+ * //   BulkPublishCompleteTime: new Date("TIMESTAMP"),
+ * //   BulkPublishStatus: "STRING_VALUE",
+ * //   FailureMessage: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param GetBulkPublishDetailsCommandInput - {@link GetBulkPublishDetailsCommandInput}
@@ -55,6 +63,8 @@ export interface GetBulkPublishDetailsCommandOutput extends GetBulkPublishDetail
  *  Thrown if the resource doesn't
  *       exist.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class GetBulkPublishDetailsCommand extends $Command<GetBulkPublishDetailsCommandInput, GetBulkPublishDetailsCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/GetCognitoEventsCommand.d.ts

@@ -31,6 +31,12 @@ export interface GetCognitoEventsCommandOutput extends GetCognitoEventsResponse,
  * };
  * const command = new GetCognitoEventsCommand(input);
  * const response = await client.send(command);
+ * // { // GetCognitoEventsResponse
+ * //   Events: { // Events
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetCognitoEventsCommandInput - {@link GetCognitoEventsCommandInput}
@@ -59,6 +65,8 @@ export interface GetCognitoEventsCommandOutput extends GetCognitoEventsResponse,
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class GetCognitoEventsCommand extends $Command<GetCognitoEventsCommandInput, GetCognitoEventsCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/GetIdentityPoolConfigurationCommand.d.ts

@@ -77,6 +77,21 @@ export interface GetIdentityPoolConfigurationCommandOutput extends GetIdentityPo
  * };
  * const command = new GetIdentityPoolConfigurationCommand(input);
  * const response = await client.send(command);
+ * // { // GetIdentityPoolConfigurationResponse
+ * //   IdentityPoolId: "STRING_VALUE",
+ * //   PushSync: { // PushSync
+ * //     ApplicationArns: [ // ApplicationArnList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     RoleArn: "STRING_VALUE",
+ * //   },
+ * //   CognitoStreams: { // CognitoStreams
+ * //     StreamName: "STRING_VALUE",
+ * //     RoleArn: "STRING_VALUE",
+ * //     StreamingStatus: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetIdentityPoolConfigurationCommandInput - {@link GetIdentityPoolConfigurationCommandInput}
@@ -105,6 +120,8 @@ export interface GetIdentityPoolConfigurationCommandOutput extends GetIdentityPo
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class GetIdentityPoolConfigurationCommand extends $Command<GetIdentityPoolConfigurationCommandInput, GetIdentityPoolConfigurationCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/ListDatasetsCommand.d.ts

@@ -92,6 +92,22 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
  * };
  * const command = new ListDatasetsCommand(input);
  * const response = await client.send(command);
+ * // { // ListDatasetsResponse
+ * //   Datasets: [ // DatasetList
+ * //     { // Dataset
+ * //       IdentityId: "STRING_VALUE",
+ * //       DatasetName: "STRING_VALUE",
+ * //       CreationDate: new Date("TIMESTAMP"),
+ * //       LastModifiedDate: new Date("TIMESTAMP"),
+ * //       LastModifiedBy: "STRING_VALUE",
+ * //       DataStorage: Number("long"),
+ * //       NumRecords: Number("long"),
+ * //     },
+ * //   ],
+ * //   Count: Number("int"),
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListDatasetsCommandInput - {@link ListDatasetsCommandInput}
@@ -116,6 +132,8 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class ListDatasetsCommand extends $Command<ListDatasetsCommandInput, ListDatasetsCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/ListIdentityPoolUsageCommand.d.ts

@@ -90,6 +90,20 @@ export interface ListIdentityPoolUsageCommandOutput extends ListIdentityPoolUsag
  * };
  * const command = new ListIdentityPoolUsageCommand(input);
  * const response = await client.send(command);
+ * // { // ListIdentityPoolUsageResponse
+ * //   IdentityPoolUsages: [ // IdentityPoolUsageList
+ * //     { // IdentityPoolUsage
+ * //       IdentityPoolId: "STRING_VALUE",
+ * //       SyncSessionsCount: Number("long"),
+ * //       DataStorage: Number("long"),
+ * //       LastModifiedDate: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   MaxResults: Number("int"),
+ * //   Count: Number("int"),
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListIdentityPoolUsageCommandInput - {@link ListIdentityPoolUsageCommandInput}
@@ -114,6 +128,8 @@ export interface ListIdentityPoolUsageCommandOutput extends ListIdentityPoolUsag
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class ListIdentityPoolUsageCommand extends $Command<ListIdentityPoolUsageCommandInput, ListIdentityPoolUsageCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/ListRecordsCommand.d.ts

@@ -92,6 +92,29 @@ export interface ListRecordsCommandOutput extends ListRecordsResponse, __Metadat
  * };
  * const command = new ListRecordsCommand(input);
  * const response = await client.send(command);
+ * // { // ListRecordsResponse
+ * //   Records: [ // RecordList
+ * //     { // Record
+ * //       Key: "STRING_VALUE",
+ * //       Value: "STRING_VALUE",
+ * //       SyncCount: Number("long"),
+ * //       LastModifiedDate: new Date("TIMESTAMP"),
+ * //       LastModifiedBy: "STRING_VALUE",
+ * //       DeviceLastModifiedDate: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * //   Count: Number("int"),
+ * //   DatasetSyncCount: Number("long"),
+ * //   LastModifiedBy: "STRING_VALUE",
+ * //   MergedDatasetNames: [ // MergedDatasetNameList
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   DatasetExists: true || false,
+ * //   DatasetDeletedAfterRequestedSyncCount: true || false,
+ * //   SyncSessionToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListRecordsCommandInput - {@link ListRecordsCommandInput}
@@ -116,6 +139,8 @@ export interface ListRecordsCommandOutput extends ListRecordsResponse, __Metadat
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class ListRecordsCommand extends $Command<ListRecordsCommandInput, ListRecordsCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/RegisterDeviceCommand.d.ts

@@ -78,6 +78,10 @@ export interface RegisterDeviceCommandOutput extends RegisterDeviceResponse, __M
  * };
  * const command = new RegisterDeviceCommand(input);
  * const response = await client.send(command);
+ * // { // RegisterDeviceResponse
+ * //   DeviceId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param RegisterDeviceCommandInput - {@link RegisterDeviceCommandInput}
@@ -108,6 +112,8 @@ export interface RegisterDeviceCommandOutput extends RegisterDeviceResponse, __M
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class RegisterDeviceCommand extends $Command<RegisterDeviceCommandInput, RegisterDeviceCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/SetCognitoEventsCommand.d.ts

@@ -34,6 +34,8 @@ export interface SetCognitoEventsCommandOutput extends __MetadataBearer {
  * };
  * const command = new SetCognitoEventsCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param SetCognitoEventsCommandInput - {@link SetCognitoEventsCommandInput}
@@ -62,6 +64,8 @@ export interface SetCognitoEventsCommandOutput extends __MetadataBearer {
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class SetCognitoEventsCommand extends $Command<SetCognitoEventsCommandInput, SetCognitoEventsCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/SetIdentityPoolConfigurationCommand.d.ts

@@ -92,6 +92,21 @@ export interface SetIdentityPoolConfigurationCommandOutput extends SetIdentityPo
  * };
  * const command = new SetIdentityPoolConfigurationCommand(input);
  * const response = await client.send(command);
+ * // { // SetIdentityPoolConfigurationResponse
+ * //   IdentityPoolId: "STRING_VALUE",
+ * //   PushSync: { // PushSync
+ * //     ApplicationArns: [ // ApplicationArnList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     RoleArn: "STRING_VALUE",
+ * //   },
+ * //   CognitoStreams: { // CognitoStreams
+ * //     StreamName: "STRING_VALUE",
+ * //     RoleArn: "STRING_VALUE",
+ * //     StreamingStatus: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param SetIdentityPoolConfigurationCommandInput - {@link SetIdentityPoolConfigurationCommandInput}
@@ -123,6 +138,8 @@ export interface SetIdentityPoolConfigurationCommandOutput extends SetIdentityPo
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class SetIdentityPoolConfigurationCommand extends $Command<SetIdentityPoolConfigurationCommandInput, SetIdentityPoolConfigurationCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/SubscribeToDatasetCommand.d.ts

@@ -77,6 +77,8 @@ export interface SubscribeToDatasetCommandOutput extends SubscribeToDatasetRespo
  * };
  * const command = new SubscribeToDatasetCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param SubscribeToDatasetCommandInput - {@link SubscribeToDatasetCommandInput}
@@ -107,6 +109,8 @@ export interface SubscribeToDatasetCommandOutput extends SubscribeToDatasetRespo
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class SubscribeToDatasetCommand extends $Command<SubscribeToDatasetCommandInput, SubscribeToDatasetCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/UnsubscribeFromDatasetCommand.d.ts

@@ -78,6 +78,8 @@ export interface UnsubscribeFromDatasetCommandOutput extends UnsubscribeFromData
  * };
  * const command = new UnsubscribeFromDatasetCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UnsubscribeFromDatasetCommandInput - {@link UnsubscribeFromDatasetCommandInput}
@@ -108,6 +110,8 @@ export interface UnsubscribeFromDatasetCommandOutput extends UnsubscribeFromData
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class UnsubscribeFromDatasetCommand extends $Command<UnsubscribeFromDatasetCommandInput, UnsubscribeFromDatasetCommandOutput, CognitoSyncClientResolvedConfig> {

package/dist-types/commands/UpdateRecordsCommand.d.ts

@@ -47,6 +47,19 @@ export interface UpdateRecordsCommandOutput extends UpdateRecordsResponse, __Met
  * };
  * const command = new UpdateRecordsCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateRecordsResponse
+ * //   Records: [ // RecordList
+ * //     { // Record
+ * //       Key: "STRING_VALUE",
+ * //       Value: "STRING_VALUE",
+ * //       SyncCount: Number("long"),
+ * //       LastModifiedDate: new Date("TIMESTAMP"),
+ * //       LastModifiedBy: "STRING_VALUE",
+ * //       DeviceLastModifiedDate: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param UpdateRecordsCommandInput - {@link UpdateRecordsCommandInput}
@@ -89,6 +102,8 @@ export interface UpdateRecordsCommandOutput extends UpdateRecordsResponse, __Met
  *  Thrown if the request is
  *       throttled.
  *
+ * @throws {@link CognitoSyncServiceException}
+ * <p>Base exception class for all service exceptions from CognitoSync service.</p>
  *
  */
 export declare class UpdateRecordsCommand extends $Command<UpdateRecordsCommandInput, UpdateRecordsCommandOutput, CognitoSyncClientResolvedConfig> {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-cognito-sync",
   "description": "AWS SDK for JavaScript Cognito Sync Client for Node.js, Browser and React Native",
-  "version": "3.325.0",
+  "version": "3.326.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.325.0",
+    "@aws-sdk/client-sts": "3.326.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.325.0",
+    "@aws-sdk/credential-provider-node": "3.326.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",