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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
 import { ListIdentityPoolUsageRequest, ListIdentityPoolUsageResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListIdentityPoolUsageCommand}.
  */
 export interface ListIdentityPoolUsageCommandInput extends ListIdentityPoolUsageRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListIdentityPoolUsageCommand}.
  */
 export interface ListIdentityPoolUsageCommandOutput extends ListIdentityPoolUsageResponse, __MetadataBearer {
 }
 /**
+ * @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
@@ -31,14 +36,14 @@ export interface ListIdentityPoolUsageCommandOutput extends ListIdentityPoolUsag
  * 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
@@ -47,29 +52,29 @@ export interface ListIdentityPoolUsageCommandOutput extends ListIdentityPoolUsag
  * 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>
@@ -83,6 +88,8 @@ export interface ListIdentityPoolUsageCommandOutput extends ListIdentityPoolUsag
  * const response = await client.send(command);
  * ```
  *
+ * @param ListIdentityPoolUsageCommandInput - {@link ListIdentityPoolUsageCommandInput}
+ * @returns {@link ListIdentityPoolUsageCommandOutput}
  * @see {@link ListIdentityPoolUsageCommandInput} for command's `input` shape.
  * @see {@link ListIdentityPoolUsageCommandOutput} for command's `response` shape.
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -108,11 +115,20 @@ export interface ListIdentityPoolUsageCommandOutput extends ListIdentityPoolUsag
 export declare class ListIdentityPoolUsageCommand extends $Command<ListIdentityPoolUsageCommandInput, ListIdentityPoolUsageCommandOutput, CognitoSyncClientResolvedConfig> {
     readonly input: ListIdentityPoolUsageCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListIdentityPoolUsageCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListIdentityPoolUsageCommandInput, ListIdentityPoolUsageCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
 import { ListRecordsRequest, ListRecordsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListRecordsCommand}.
  */
 export interface ListRecordsCommandInput extends ListRecordsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListRecordsCommand}.
  */
 export interface ListRecordsCommandOutput extends ListRecordsResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -33,16 +38,16 @@ export interface ListRecordsCommandOutput extends ListRecordsResponse, __Metadat
  * 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
@@ -51,9 +56,9 @@ export interface ListRecordsCommandOutput extends ListRecordsResponse, __Metadat
  * content-length: 623
  * date: Tue, 11 Nov 2014 18:32:30 GMT
  *
- * {
+ * \{
  *     "Output":
- *     {
+ *     \{
  *         "__type": "com.amazonaws.cognito.sync.model#ListRecordsResponse",
  *         "Count": 0,
  *         "DatasetDeletedAfterRequestedSyncCount": false,
@@ -64,9 +69,9 @@ export interface ListRecordsCommandOutput extends ListRecordsResponse, __Metadat
  *         "NextToken": null,
  *         "Records": [],
  *         "SyncSessionToken": "SYNC_SESSION_TOKEN"
- *     },
+ *     \},
  *     "Version": "1.0"
- * }
+ * \}
  *                </response>
  *          </example>
  *       </examples>
@@ -80,6 +85,8 @@ export interface ListRecordsCommandOutput extends ListRecordsResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param ListRecordsCommandInput - {@link ListRecordsCommandInput}
+ * @returns {@link ListRecordsCommandOutput}
  * @see {@link ListRecordsCommandInput} for command's `input` shape.
  * @see {@link ListRecordsCommandOutput} for command's `response` shape.
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -105,11 +112,20 @@ export interface ListRecordsCommandOutput extends ListRecordsResponse, __Metadat
 export declare class ListRecordsCommand extends $Command<ListRecordsCommandInput, ListRecordsCommandOutput, CognitoSyncClientResolvedConfig> {
     readonly input: ListRecordsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListRecordsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRecordsCommandInput, ListRecordsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
 import { RegisterDeviceRequest, RegisterDeviceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link RegisterDeviceCommand}.
  */
 export interface RegisterDeviceCommandInput extends RegisterDeviceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RegisterDeviceCommand}.
  */
 export interface RegisterDeviceCommandOutput extends RegisterDeviceResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -29,17 +34,17 @@ export interface RegisterDeviceCommandOutput extends RegisterDeviceResponse, __M
  * 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
@@ -48,14 +53,14 @@ export interface RegisterDeviceCommandOutput extends RegisterDeviceResponse, __M
  * 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>
@@ -69,6 +74,8 @@ export interface RegisterDeviceCommandOutput extends RegisterDeviceResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param RegisterDeviceCommandInput - {@link RegisterDeviceCommandInput}
+ * @returns {@link RegisterDeviceCommandOutput}
  * @see {@link RegisterDeviceCommandInput} for command's `input` shape.
  * @see {@link RegisterDeviceCommandOutput} for command's `response` shape.
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -100,11 +107,20 @@ export interface RegisterDeviceCommandOutput extends RegisterDeviceResponse, __M
 export declare class RegisterDeviceCommand extends $Command<RegisterDeviceCommandInput, RegisterDeviceCommandOutput, CognitoSyncClientResolvedConfig> {
     readonly input: RegisterDeviceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RegisterDeviceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterDeviceCommandInput, RegisterDeviceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
 import { SetCognitoEventsRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SetCognitoEventsCommand}.
  */
 export interface SetCognitoEventsCommandInput extends SetCognitoEventsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SetCognitoEventsCommand}.
  */
 export interface SetCognitoEventsCommandOutput extends __MetadataBearer {
 }
 /**
+ * @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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface SetCognitoEventsCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param SetCognitoEventsCommandInput - {@link SetCognitoEventsCommandInput}
+ * @returns {@link SetCognitoEventsCommandOutput}
  * @see {@link SetCognitoEventsCommandInput} for command's `input` shape.
  * @see {@link SetCognitoEventsCommandOutput} for command's `response` shape.
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -54,11 +61,20 @@ export interface SetCognitoEventsCommandOutput extends __MetadataBearer {
 export declare class SetCognitoEventsCommand extends $Command<SetCognitoEventsCommandInput, SetCognitoEventsCommandOutput, CognitoSyncClientResolvedConfig> {
     readonly input: SetCognitoEventsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SetCognitoEventsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetCognitoEventsCommandInput, SetCognitoEventsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
 import { SetIdentityPoolConfigurationRequest, SetIdentityPoolConfigurationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SetIdentityPoolConfigurationCommand}.
  */
 export interface SetIdentityPoolConfigurationCommandInput extends SetIdentityPoolConfigurationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SetIdentityPoolConfigurationCommand}.
  */
 export interface SetIdentityPoolConfigurationCommandOutput extends SetIdentityPoolConfigurationResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -28,19 +33,19 @@ export interface SetIdentityPoolConfigurationCommandOutput extends SetIdentityPo
  * 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
@@ -49,19 +54,19 @@ export interface SetIdentityPoolConfigurationCommandOutput extends SetIdentityPo
  * 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>
@@ -75,6 +80,8 @@ export interface SetIdentityPoolConfigurationCommandOutput extends SetIdentityPo
  * const response = await client.send(command);
  * ```
  *
+ * @param SetIdentityPoolConfigurationCommandInput - {@link SetIdentityPoolConfigurationCommandInput}
+ * @returns {@link SetIdentityPoolConfigurationCommandOutput}
  * @see {@link SetIdentityPoolConfigurationCommandInput} for command's `input` shape.
  * @see {@link SetIdentityPoolConfigurationCommandOutput} for command's `response` shape.
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -107,11 +114,20 @@ export interface SetIdentityPoolConfigurationCommandOutput extends SetIdentityPo
 export declare class SetIdentityPoolConfigurationCommand extends $Command<SetIdentityPoolConfigurationCommandInput, SetIdentityPoolConfigurationCommandOutput, CognitoSyncClientResolvedConfig> {
     readonly input: SetIdentityPoolConfigurationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SetIdentityPoolConfigurationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetIdentityPoolConfigurationCommandInput, SetIdentityPoolConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
 import { SubscribeToDatasetRequest, SubscribeToDatasetResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SubscribeToDatasetCommand}.
  */
 export interface SubscribeToDatasetCommandInput extends SubscribeToDatasetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SubscribeToDatasetCommand}.
  */
 export interface SubscribeToDatasetCommandOutput extends SubscribeToDatasetResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -29,17 +34,17 @@ export interface SubscribeToDatasetCommandOutput extends SubscribeToDatasetRespo
  * 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
@@ -48,13 +53,13 @@ export interface SubscribeToDatasetCommandOutput extends SubscribeToDatasetRespo
  * content-type: application/json
  * content-length: 99
  *
- * {
+ * \{
  *     "Output":
- *     {
+ *     \{
  *         "__type": "com.amazonaws.cognito.sync.model#SubscribeToDatasetResponse"
- *     },
+ *     \},
  *     "Version": "1.0"
- * }
+ * \}
  *                </response>
  *          </example>
  *       </examples>
@@ -68,6 +73,8 @@ export interface SubscribeToDatasetCommandOutput extends SubscribeToDatasetRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param SubscribeToDatasetCommandInput - {@link SubscribeToDatasetCommandInput}
+ * @returns {@link SubscribeToDatasetCommandOutput}
  * @see {@link SubscribeToDatasetCommandInput} for command's `input` shape.
  * @see {@link SubscribeToDatasetCommandOutput} for command's `response` shape.
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -99,11 +106,20 @@ export interface SubscribeToDatasetCommandOutput extends SubscribeToDatasetRespo
 export declare class SubscribeToDatasetCommand extends $Command<SubscribeToDatasetCommandInput, SubscribeToDatasetCommandOutput, CognitoSyncClientResolvedConfig> {
     readonly input: SubscribeToDatasetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SubscribeToDatasetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SubscribeToDatasetCommandInput, SubscribeToDatasetCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
 import { UnsubscribeFromDatasetRequest, UnsubscribeFromDatasetResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UnsubscribeFromDatasetCommand}.
  */
 export interface UnsubscribeFromDatasetCommandInput extends UnsubscribeFromDatasetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UnsubscribeFromDatasetCommand}.
  */
 export interface UnsubscribeFromDatasetCommandOutput extends UnsubscribeFromDatasetResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -30,17 +35,17 @@ export interface UnsubscribeFromDatasetCommandOutput extends UnsubscribeFromData
  * 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
@@ -49,13 +54,13 @@ export interface UnsubscribeFromDatasetCommandOutput extends UnsubscribeFromData
  * content-type: application/json
  * content-length: 103
  *
- * {
+ * \{
  *     "Output":
- *     {
+ *     \{
  *         "__type": "com.amazonaws.cognito.sync.model#UnsubscribeFromDatasetResponse"
- *     },
+ *     \},
  *     "Version": "1.0"
- * }
+ * \}
  *                </response>
  *          </example>
  *       </examples>
@@ -69,6 +74,8 @@ export interface UnsubscribeFromDatasetCommandOutput extends UnsubscribeFromData
  * const response = await client.send(command);
  * ```
  *
+ * @param UnsubscribeFromDatasetCommandInput - {@link UnsubscribeFromDatasetCommandInput}
+ * @returns {@link UnsubscribeFromDatasetCommandOutput}
  * @see {@link UnsubscribeFromDatasetCommandInput} for command's `input` shape.
  * @see {@link UnsubscribeFromDatasetCommandOutput} for command's `response` shape.
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -100,11 +107,20 @@ export interface UnsubscribeFromDatasetCommandOutput extends UnsubscribeFromData
 export declare class UnsubscribeFromDatasetCommand extends $Command<UnsubscribeFromDatasetCommandInput, UnsubscribeFromDatasetCommandOutput, CognitoSyncClientResolvedConfig> {
     readonly input: UnsubscribeFromDatasetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UnsubscribeFromDatasetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UnsubscribeFromDatasetCommandInput, UnsubscribeFromDatasetCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }