@aws-sdk/client-cognito-sync 3.296.0 → 3.297.0

package/dist-types/CognitoSync.d.ts

@@ -18,6 +18,7 @@ import { SubscribeToDatasetCommandInput, SubscribeToDatasetCommandOutput } from
 import { UnsubscribeFromDatasetCommandInput, UnsubscribeFromDatasetCommandOutput } from "./commands/UnsubscribeFromDatasetCommand";
 import { UpdateRecordsCommandInput, UpdateRecordsCommandOutput } from "./commands/UpdateRecordsCommand";
 /**
+ * @public
  * <fullname>Amazon Cognito Sync</fullname>
  *       <p>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
@@ -34,12 +35,14 @@ import { UpdateRecordsCommandInput, UpdateRecordsCommandOutput } from "./command
  */
 export declare class CognitoSync extends CognitoSyncClient {
     /**
+     * @public
      * <p>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.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
      */
     bulkPublish(args: BulkPublishCommandInput, options?: __HttpHandlerOptions): Promise<BulkPublishCommandOutput>;
     bulkPublish(args: BulkPublishCommandInput, cb: (err: any, data?: BulkPublishCommandOutput) => void): void;
     bulkPublish(args: BulkPublishCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BulkPublishCommandOutput) => void): void;
     /**
+     * @public
      * <p>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
@@ -50,6 +53,7 @@ export declare class CognitoSync extends CognitoSyncClient {
     deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
     deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
@@ -59,6 +63,7 @@ export declare class CognitoSync extends CognitoSyncClient {
     describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
     describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets usage details (for example, data storage) about a particular identity pool.</p>
      *       <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
      *
@@ -75,14 +80,14 @@ export declare class CognitoSync extends CognitoSyncClient {
      * X-AMZ-DATE: 20141111T205737Z
      * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
      *
-     * {
+     * \{
      *     "Operation": "com.amazonaws.cognito.sync.model#DescribeIdentityPoolUsage",
      *     "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
      *     "Input":
-     *     {
+     *     \{
      *         "IdentityPoolId": "IDENTITY_POOL_ID"
-     *     }
-     * }
+     *     \}
+     * \}
      *                </request>
      *             <response>
      * 1.1 200 OK
@@ -91,20 +96,20 @@ export declare class CognitoSync extends CognitoSyncClient {
      * content-length: 271
      * date: Tue, 11 Nov 2014 20:57:37 GMT
      *
-     * {
+     * \{
      *     "Output":
-     *     {
+     *     \{
      *         "__type": "com.amazonaws.cognito.sync.model#DescribeIdentityPoolUsageResponse",
      *         "IdentityPoolUsage":
-     *         {
+     *         \{
      *             "DataStorage": 0,
      *             "IdentityPoolId": "IDENTITY_POOL_ID",
      *             "LastModifiedDate": 1.413231134115E9,
      *             "SyncSessionsCount": null
-     *         }
-     *     },
+     *         \}
+     *     \},
      *     "Version": "1.0"
-     * }
+     * \}
      *                </response>
      *          </example>
      *       </examples>
@@ -113,6 +118,7 @@ export declare class CognitoSync extends CognitoSyncClient {
     describeIdentityPoolUsage(args: DescribeIdentityPoolUsageCommandInput, cb: (err: any, data?: DescribeIdentityPoolUsageCommandOutput) => void): void;
     describeIdentityPoolUsage(args: DescribeIdentityPoolUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityPoolUsageCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets usage information for an identity, including number of datasets and data usage.</p>
      *       <p>This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.</p>
      *       <examples>
@@ -128,15 +134,15 @@ export declare class CognitoSync extends CognitoSyncClient {
      * X-AMZ-DATE: 20141111T215129Z
      * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
      *
-     * {
+     * \{
      *     "Operation": "com.amazonaws.cognito.sync.model#DescribeIdentityUsage",
      *     "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
      *     "Input":
-     *     {
+     *     \{
      *         "IdentityPoolId": "IDENTITY_POOL_ID",
      *         "IdentityId": "IDENTITY_ID"
-     *     }
-     * }
+     *     \}
+     * \}
      *                </request>
      *             <response>
      *                1.1 200 OK
@@ -145,21 +151,21 @@ export declare class CognitoSync extends CognitoSyncClient {
      * content-length: 318
      * date: Tue, 11 Nov 2014 21:51:29 GMT
      *
-     * {
+     * \{
      *     "Output":
-     *     {
+     *     \{
      *         "__type": "com.amazonaws.cognito.sync.model#DescribeIdentityUsageResponse",
      *         "IdentityUsage":
-     *         {
+     *         \{
      *             "DataStorage": 16,
      *             "DatasetCount": 1,
      *             "IdentityId": "IDENTITY_ID",
      *             "IdentityPoolId": "IDENTITY_POOL_ID",
      *             "LastModifiedDate": 1.412974081336E9
-     *         }
-     *     },
+     *         \}
+     *     \},
      *     "Version": "1.0"
-     * }
+     * \}
      *                </response>
      *          </example>
      *       </examples>
@@ -168,18 +174,21 @@ export declare class CognitoSync extends CognitoSyncClient {
     describeIdentityUsage(args: DescribeIdentityUsageCommandInput, cb: (err: any, data?: DescribeIdentityUsageCommandOutput) => void): void;
     describeIdentityUsage(args: DescribeIdentityUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityUsageCommandOutput) => void): void;
     /**
+     * @public
      * <p>Get the status of the last BulkPublish operation for an identity pool.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
      */
     getBulkPublishDetails(args: GetBulkPublishDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GetBulkPublishDetailsCommandOutput>;
     getBulkPublishDetails(args: GetBulkPublishDetailsCommandInput, cb: (err: any, data?: GetBulkPublishDetailsCommandOutput) => void): void;
     getBulkPublishDetails(args: GetBulkPublishDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBulkPublishDetailsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the events and the corresponding Lambda functions associated with an identity pool.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
      */
     getCognitoEvents(args: GetCognitoEventsCommandInput, options?: __HttpHandlerOptions): Promise<GetCognitoEventsCommandOutput>;
     getCognitoEvents(args: GetCognitoEventsCommandInput, cb: (err: any, data?: GetCognitoEventsCommandOutput) => void): void;
     getCognitoEvents(args: GetCognitoEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCognitoEventsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the configuration settings of an identity pool.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
      *       <examples>
      *          <example>
@@ -194,14 +203,14 @@ export declare class CognitoSync extends CognitoSyncClient {
      * X-AMZ-DATE: 20141004T195722Z
      * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>
      *
-     * {
+     * \{
      *     "Operation": "com.amazonaws.cognito.sync.model#GetIdentityPoolConfiguration",
      *     "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
      *     "Input":
-     *     {
+     *     \{
      *         "IdentityPoolId": "ID_POOL_ID"
-     *     }
-     * }
+     *     \}
+     * \}
      *
      *             </request>
      *             <response>
@@ -211,19 +220,19 @@ export declare class CognitoSync extends CognitoSyncClient {
      * content-type: application/json
      * content-length: 332
      *
-     * {
+     * \{
      *     "Output":
-     *     {
+     *     \{
      *         "__type": "com.amazonaws.cognito.sync.model#GetIdentityPoolConfigurationResponse",
      *         "IdentityPoolId": "ID_POOL_ID",
      *         "PushSync":
-     *         {
+     *         \{
      *             "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"],
      *             "RoleArn": "ROLEARN"
-     *         }
-     *     },
+     *         \}
+     *     \},
      *     "Version": "1.0"
-     * }
+     * \}
      *  </response>
      *          </example>
      *       </examples>
@@ -232,6 +241,7 @@ export declare class CognitoSync extends CognitoSyncClient {
     getIdentityPoolConfiguration(args: GetIdentityPoolConfigurationCommandInput, cb: (err: any, data?: GetIdentityPoolConfigurationCommandOutput) => void): void;
     getIdentityPoolConfiguration(args: GetIdentityPoolConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityPoolConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
@@ -251,16 +261,16 @@ export declare class CognitoSync extends CognitoSyncClient {
      * X-AMZ-DATE: 20141111T215640Z
      * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
      *
-     * {
+     * \{
      *     "Operation": "com.amazonaws.cognito.sync.model#ListDatasets",
      *     "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
      *     "Input":
-     *     {
+     *     \{
      *         "IdentityPoolId": "IDENTITY_POOL_ID",
      *         "IdentityId": "IDENTITY_ID",
      *         "MaxResults": "3"
-     *     }
-     * }
+     *     \}
+     * \}
      *                </request>
      *             <response>
      * 1.1 200 OK
@@ -269,13 +279,13 @@ export declare class CognitoSync extends CognitoSyncClient {
      * content-length: 355
      * date: Tue, 11 Nov 2014 21:56:40 GMT
      *
-     * {
+     * \{
      *     "Output":
-     *     {
+     *     \{
      *         "__type": "com.amazonaws.cognito.sync.model#ListDatasetsResponse",
      *         "Count": 1,
      *         "Datasets": [
-     *         {
+     *         \{
      *             "CreationDate": 1.412974057151E9,
      *             "DataStorage": 16,
      *             "DatasetName": "my_list",
@@ -283,11 +293,11 @@ export declare class CognitoSync extends CognitoSyncClient {
      *             "LastModifiedBy": "123456789012",
      *             "LastModifiedDate": 1.412974057244E9,
      *             "NumRecords": 1
-     *         }],
+     *         \}],
      *         "NextToken": null
-     *     },
+     *     \},
      *     "Version": "1.0"
-     * }
+     * \}
      *                </response>
      *          </example>
      *       </examples>
@@ -296,6 +306,7 @@ export declare class CognitoSync extends CognitoSyncClient {
     listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
     listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets a list of identity pools registered with Cognito.</p>
      *       <p>ListIdentityPoolUsage can only be called with developer credentials. You
      *          cannot make this API call with the temporary user credentials provided by Cognito
@@ -313,14 +324,14 @@ export declare class CognitoSync extends CognitoSyncClient {
      * X-AMZ-DATE: 20141111T211414Z
      * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
      *
-     * {
+     * \{
      *     "Operation": "com.amazonaws.cognito.sync.model#ListIdentityPoolUsage",
      *     "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
      *     "Input":
-     *     {
+     *     \{
      *         "MaxResults": "2"
-     *     }
-     * }
+     *     \}
+     * \}
      *                </request>
      *             <response>
      * 1.1 200 OK
@@ -329,29 +340,29 @@ export declare class CognitoSync extends CognitoSyncClient {
      * content-length: 519
      * date: Tue, 11 Nov 2014 21:14:14 GMT
      *
-     * {
+     * \{
      *     "Output":
-     *     {
+     *     \{
      *         "__type": "com.amazonaws.cognito.sync.model#ListIdentityPoolUsageResponse",
      *         "Count": 2,
      *         "IdentityPoolUsages": [
-     *         {
+     *         \{
      *             "DataStorage": 0,
      *             "IdentityPoolId": "IDENTITY_POOL_ID",
      *             "LastModifiedDate": 1.413836234607E9,
      *             "SyncSessionsCount": null
-     *         },
-     *         {
+     *         \},
+     *         \{
      *             "DataStorage": 0,
      *             "IdentityPoolId": "IDENTITY_POOL_ID",
      *             "LastModifiedDate": 1.410892165601E9,
      *             "SyncSessionsCount": null
-     *         }],
+     *         \}],
      *         "MaxResults": 2,
      *         "NextToken": "dXMtZWFzdC0xOjBjMWJhMDUyLWUwOTgtNDFmYS1hNzZlLWVhYTJjMTI1Zjg2MQ=="
-     *     },
+     *     \},
      *     "Version": "1.0"
-     * }
+     * \}
      *                </response>
      *          </example>
      *       </examples>
@@ -360,6 +371,7 @@ export declare class CognitoSync extends CognitoSyncClient {
     listIdentityPoolUsage(args: ListIdentityPoolUsageCommandInput, cb: (err: any, data?: ListIdentityPoolUsageCommandOutput) => void): void;
     listIdentityPoolUsage(args: ListIdentityPoolUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityPoolUsageCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
@@ -379,16 +391,16 @@ export declare class CognitoSync extends CognitoSyncClient {
      * X-AMZ-DATE: 20141111T183230Z
      * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
      *
-     * {
+     * \{
      *     "Operation": "com.amazonaws.cognito.sync.model#ListRecords",
      *     "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
      *     "Input":
-     *     {
+     *     \{
      *         "IdentityPoolId": "IDENTITY_POOL_ID",
      *         "IdentityId": "IDENTITY_ID",
      *         "DatasetName": "newDataSet"
-     *     }
-     * }
+     *     \}
+     * \}
      *                </request>
      *             <response>
      * 1.1 200 OK
@@ -397,9 +409,9 @@ export declare class CognitoSync extends CognitoSyncClient {
      * content-length: 623
      * date: Tue, 11 Nov 2014 18:32:30 GMT
      *
-     * {
+     * \{
      *     "Output":
-     *     {
+     *     \{
      *         "__type": "com.amazonaws.cognito.sync.model#ListRecordsResponse",
      *         "Count": 0,
      *         "DatasetDeletedAfterRequestedSyncCount": false,
@@ -410,9 +422,9 @@ export declare class CognitoSync extends CognitoSyncClient {
      *         "NextToken": null,
      *         "Records": [],
      *         "SyncSessionToken": "SYNC_SESSION_TOKEN"
-     *     },
+     *     \},
      *     "Version": "1.0"
-     * }
+     * \}
      *                </response>
      *          </example>
      *       </examples>
@@ -421,6 +433,7 @@ export declare class CognitoSync extends CognitoSyncClient {
     listRecords(args: ListRecordsCommandInput, cb: (err: any, data?: ListRecordsCommandOutput) => void): void;
     listRecords(args: ListRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecordsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Registers a device to receive push sync notifications.</p><p>This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.</p>
      *       <examples>
      *          <example>
@@ -436,17 +449,17 @@ export declare class CognitoSync extends CognitoSyncClient {
      * X-AMZ-SECURITY-TOKEN: <securitytoken>
      * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>
      *
-     * {
+     * \{
      *     "Operation": "com.amazonaws.cognito.sync.model#RegisterDevice",
      *     "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
      *     "Input":
-     *     {
+     *     \{
      *         "IdentityPoolId": "ID_POOL_ID",
      *         "IdentityId": "IDENTITY_ID",
      *         "Platform": "GCM",
      *         "Token": "PUSH_TOKEN"
-     *     }
-     * }
+     *     \}
+     * \}
      *                </request>
      *             <response>
      * 1.1 200 OK
@@ -455,14 +468,14 @@ export declare class CognitoSync extends CognitoSyncClient {
      * content-type: application/json
      * content-length: 145
      *
-     * {
+     * \{
      *     "Output":
-     *     {
+     *     \{
      *         "__type": "com.amazonaws.cognito.sync.model#RegisterDeviceResponse",
      *         "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014"
-     *     },
+     *     \},
      *     "Version": "1.0"
-     * }
+     * \}
      *                </response>
      *          </example>
      *       </examples>
@@ -471,12 +484,14 @@ export declare class CognitoSync extends CognitoSyncClient {
     registerDevice(args: RegisterDeviceCommandInput, cb: (err: any, data?: RegisterDeviceCommandOutput) => void): void;
     registerDevice(args: RegisterDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterDeviceCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
      */
     setCognitoEvents(args: SetCognitoEventsCommandInput, options?: __HttpHandlerOptions): Promise<SetCognitoEventsCommandOutput>;
     setCognitoEvents(args: SetCognitoEventsCommandInput, cb: (err: any, data?: SetCognitoEventsCommandOutput) => void): void;
     setCognitoEvents(args: SetCognitoEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetCognitoEventsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Sets the necessary configuration for push sync.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
      *       <examples>
      *          <example>
@@ -491,19 +506,19 @@ export declare class CognitoSync extends CognitoSyncClient {
      * X-AMZ-DATE: 20141004T200006Z
      * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>
      *
-     * {
+     * \{
      *     "Operation": "com.amazonaws.cognito.sync.model#SetIdentityPoolConfiguration",
      *     "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
      *     "Input":
-     *     {
+     *     \{
      *         "IdentityPoolId": "ID_POOL_ID",
      *         "PushSync":
-     *         {
+     *         \{
      *             "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"],
      *             "RoleArn": "ROLEARN"
-     *         }
-     *     }
-     * }
+     *         \}
+     *     \}
+     * \}
      *             </request>
      *             <response>
      * 1.1 200 OK
@@ -512,19 +527,19 @@ export declare class CognitoSync extends CognitoSyncClient {
      * content-type: application/json
      * content-length: 332
      *
-     * {
+     * \{
      *     "Output":
-     *     {
+     *     \{
      *         "__type": "com.amazonaws.cognito.sync.model#SetIdentityPoolConfigurationResponse",
      *         "IdentityPoolId": "ID_POOL_ID",
      *         "PushSync":
-     *         {
+     *         \{
      *             "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"],
      *             "RoleArn": "ROLEARN"
-     *         }
-     *     },
+     *         \}
+     *     \},
      *     "Version": "1.0"
-     * }
+     * \}
      *             </response>
      *          </example>
      *       </examples>
@@ -533,6 +548,7 @@ export declare class CognitoSync extends CognitoSyncClient {
     setIdentityPoolConfiguration(args: SetIdentityPoolConfigurationCommandInput, cb: (err: any, data?: SetIdentityPoolConfigurationCommandOutput) => void): void;
     setIdentityPoolConfiguration(args: SetIdentityPoolConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIdentityPoolConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Subscribes to receive notifications when a dataset is modified by another device.</p><p>This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.</p>
      *       <examples>
      *          <example>
@@ -548,17 +564,17 @@ export declare class CognitoSync extends CognitoSyncClient {
      * X-AMZ-SECURITY-TOKEN: <securitytoken>
      * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>
      *
-     * {
+     * \{
      *     "Operation": "com.amazonaws.cognito.sync.model#SubscribeToDataset",
      *     "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
      *     "Input":
-     *     {
+     *     \{
      *         "IdentityPoolId": "ID_POOL_ID",
      *         "IdentityId": "IDENTITY_ID",
      *         "DatasetName": "Rufus",
      *         "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014"
-     *     }
-     * }
+     *     \}
+     * \}
      *                </request>
      *             <response>
      * 1.1 200 OK
@@ -567,13 +583,13 @@ export declare class CognitoSync extends CognitoSyncClient {
      * content-type: application/json
      * content-length: 99
      *
-     * {
+     * \{
      *     "Output":
-     *     {
+     *     \{
      *         "__type": "com.amazonaws.cognito.sync.model#SubscribeToDatasetResponse"
-     *     },
+     *     \},
      *     "Version": "1.0"
-     * }
+     * \}
      *                </response>
      *          </example>
      *       </examples>
@@ -582,6 +598,7 @@ export declare class CognitoSync extends CognitoSyncClient {
     subscribeToDataset(args: SubscribeToDatasetCommandInput, cb: (err: any, data?: SubscribeToDatasetCommandOutput) => void): void;
     subscribeToDataset(args: SubscribeToDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubscribeToDatasetCommandOutput) => void): void;
     /**
+     * @public
      * <p>Unsubscribes from receiving notifications when a dataset is modified by another device.</p><p>This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.</p>
      *       <examples>
      *          <example>
@@ -598,17 +615,17 @@ export declare class CognitoSync extends CognitoSyncClient {
      * X-AMZ-SECURITY-TOKEN: <securitytoken>
      * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>
      *
-     * {
+     * \{
      *     "Operation": "com.amazonaws.cognito.sync.model#UnsubscribeFromDataset",
      *     "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
      *     "Input":
-     *     {
+     *     \{
      *         "IdentityPoolId": "ID_POOL_ID",
      *         "IdentityId": "IDENTITY_ID",
      *         "DatasetName": "Rufus",
      *         "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014"
-     *     }
-     * }
+     *     \}
+     * \}
      *                </request>
      *             <response>
      * 1.1 200 OK
@@ -617,13 +634,13 @@ export declare class CognitoSync extends CognitoSyncClient {
      * content-type: application/json
      * content-length: 103
      *
-     * {
+     * \{
      *     "Output":
-     *     {
+     *     \{
      *         "__type": "com.amazonaws.cognito.sync.model#UnsubscribeFromDatasetResponse"
-     *     },
+     *     \},
      *     "Version": "1.0"
-     * }
+     * \}
      *                </response>
      *          </example>
      *       </examples>
@@ -632,6 +649,7 @@ export declare class CognitoSync extends CognitoSyncClient {
     unsubscribeFromDataset(args: UnsubscribeFromDatasetCommandInput, cb: (err: any, data?: UnsubscribeFromDatasetCommandOutput) => void): void;
     unsubscribeFromDataset(args: UnsubscribeFromDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnsubscribeFromDatasetCommandOutput) => void): void;
     /**
+     * @public
      * <p>Posts updates to records and adds and deletes records for a dataset and user.</p>
      *       <p>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.</p><p>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.</p>
      *       <p>This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.</p>

package/dist-types/CognitoSyncClient.d.ts

@@ -25,15 +25,24 @@ import { SubscribeToDatasetCommandInput, SubscribeToDatasetCommandOutput } from
 import { UnsubscribeFromDatasetCommandInput, UnsubscribeFromDatasetCommandOutput } from "./commands/UnsubscribeFromDatasetCommand";
 import { UpdateRecordsCommandInput, UpdateRecordsCommandOutput } from "./commands/UpdateRecordsCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = BulkPublishCommandInput | DeleteDatasetCommandInput | DescribeDatasetCommandInput | DescribeIdentityPoolUsageCommandInput | DescribeIdentityUsageCommandInput | GetBulkPublishDetailsCommandInput | GetCognitoEventsCommandInput | GetIdentityPoolConfigurationCommandInput | ListDatasetsCommandInput | ListIdentityPoolUsageCommandInput | ListRecordsCommandInput | RegisterDeviceCommandInput | SetCognitoEventsCommandInput | SetIdentityPoolConfigurationCommandInput | SubscribeToDatasetCommandInput | UnsubscribeFromDatasetCommandInput | UpdateRecordsCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = BulkPublishCommandOutput | DeleteDatasetCommandOutput | DescribeDatasetCommandOutput | DescribeIdentityPoolUsageCommandOutput | DescribeIdentityUsageCommandOutput | GetBulkPublishDetailsCommandOutput | GetCognitoEventsCommandOutput | GetIdentityPoolConfigurationCommandOutput | ListDatasetsCommandOutput | ListIdentityPoolUsageCommandOutput | ListRecordsCommandOutput | RegisterDeviceCommandOutput | SetCognitoEventsCommandOutput | SetIdentityPoolConfigurationCommandOutput | SubscribeToDatasetCommandOutput | UnsubscribeFromDatasetCommandOutput | UpdateRecordsCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -123,23 +132,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type CognitoSyncClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of CognitoSyncClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of CognitoSyncClient class constructor that set the region, credentials and other options.
  */
 export interface CognitoSyncClientConfig extends CognitoSyncClientConfigType {
 }
+/**
+ * @public
+ */
 type CognitoSyncClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of CognitoSyncClient class. This is resolved and normalized from the {@link CognitoSyncClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of CognitoSyncClient class. This is resolved and normalized from the {@link CognitoSyncClientConfig | constructor configuration interface}.
  */
 export interface CognitoSyncClientResolvedConfig extends CognitoSyncClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Amazon Cognito Sync</fullname>
  *       <p>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