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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
 import { UpdateRecordsRequest, UpdateRecordsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateRecordsCommand}.
  */
 export interface UpdateRecordsCommandInput extends UpdateRecordsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateRecordsCommand}.
  */
 export interface UpdateRecordsCommandOutput extends UpdateRecordsResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -27,6 +32,8 @@ export interface UpdateRecordsCommandOutput extends UpdateRecordsResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateRecordsCommandInput - {@link UpdateRecordsCommandInput}
+ * @returns {@link UpdateRecordsCommandOutput}
  * @see {@link UpdateRecordsCommandInput} for command's `input` shape.
  * @see {@link UpdateRecordsCommandOutput} for command's `response` shape.
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -70,11 +77,20 @@ export interface UpdateRecordsCommandOutput extends UpdateRecordsResponse, __Met
 export declare class UpdateRecordsCommand extends $Command<UpdateRecordsCommandInput, UpdateRecordsCommandOutput, CognitoSyncClientResolvedConfig> {
     readonly input: UpdateRecordsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRecordsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRecordsCommandInput, UpdateRecordsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/CognitoSyncServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from CognitoSync service.
  */
 export declare class CognitoSyncServiceException extends __ServiceException {

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { CognitoSyncServiceException as __BaseException } from "./CognitoSyncServiceException";
 /**
+ * @public
  * An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.
  */
 export declare class AlreadyStreamedException extends __BaseException {
@@ -12,6 +13,7 @@ export declare class AlreadyStreamedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AlreadyStreamedException, __BaseException>);
 }
 /**
+ * @public
  * The input for the BulkPublish operation.
  */
 export interface BulkPublishRequest {
@@ -23,6 +25,7 @@ export interface BulkPublishRequest {
     IdentityPoolId: string | undefined;
 }
 /**
+ * @public
  * The output for the BulkPublish operation.
  */
 export interface BulkPublishResponse {
@@ -34,6 +37,7 @@ export interface BulkPublishResponse {
     IdentityPoolId?: string;
 }
 /**
+ * @public
  * An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool.
  */
 export declare class DuplicateRequestException extends __BaseException {
@@ -45,6 +49,7 @@ export declare class DuplicateRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<DuplicateRequestException, __BaseException>);
 }
 /**
+ * @public
  * Indicates an internal service
  *       error.
  */
@@ -57,6 +62,7 @@ export declare class InternalErrorException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalErrorException, __BaseException>);
 }
 /**
+ * @public
  * Thrown when a request parameter does not comply
  *       with the associated constraints.
  */
@@ -69,6 +75,7 @@ export declare class InvalidParameterException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
 }
 /**
+ * @public
  * Thrown when a user is not authorized to access the
  *       requested resource.
  */
@@ -81,6 +88,7 @@ export declare class NotAuthorizedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
 }
 /**
+ * @public
  * Thrown if the resource doesn't
  *       exist.
  */
@@ -93,6 +101,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * A request to delete the specific
  *       dataset.
  */
@@ -117,6 +126,7 @@ export interface DeleteDatasetRequest {
     DatasetName: string | undefined;
 }
 /**
+ * @public
  * 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
@@ -161,6 +171,7 @@ export interface Dataset {
     NumRecords?: number;
 }
 /**
+ * @public
  * Response to a successful DeleteDataset
  *       request.
  */
@@ -175,6 +186,7 @@ export interface DeleteDatasetResponse {
     Dataset?: Dataset;
 }
 /**
+ * @public
  * Thrown if an update can't be applied because
  *       the resource was changed by another call and this would result in a conflict.
  */
@@ -187,6 +199,7 @@ export declare class ResourceConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceConflictException, __BaseException>);
 }
 /**
+ * @public
  * Thrown if the request is
  *       throttled.
  */
@@ -199,6 +212,7 @@ export declare class TooManyRequestsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
 }
 /**
+ * @public
  * A request for meta data about a dataset (creation
  *       date, number of records, size) by owner and dataset name.
  */
@@ -223,6 +237,7 @@ export interface DescribeDatasetRequest {
     DatasetName: string | undefined;
 }
 /**
+ * @public
  * Response to a successful DescribeDataset
  *       request.
  */
@@ -237,6 +252,7 @@ export interface DescribeDatasetResponse {
     Dataset?: Dataset;
 }
 /**
+ * @public
  * A request for usage information about
  *       the identity pool.
  */
@@ -249,6 +265,7 @@ export interface DescribeIdentityPoolUsageRequest {
     IdentityPoolId: string | undefined;
 }
 /**
+ * @public
  * Usage information for the identity
  *       pool.
  */
@@ -276,6 +293,7 @@ export interface IdentityPoolUsage {
     LastModifiedDate?: Date;
 }
 /**
+ * @public
  * Response to a successful
  *       DescribeIdentityPoolUsage request.
  */
@@ -287,6 +305,7 @@ export interface DescribeIdentityPoolUsageResponse {
     IdentityPoolUsage?: IdentityPoolUsage;
 }
 /**
+ * @public
  * A request for information about the usage of
  *       an identity pool.
  */
@@ -305,6 +324,7 @@ export interface DescribeIdentityUsageRequest {
     IdentityId: string | undefined;
 }
 /**
+ * @public
  * Usage information for the identity.
  */
 export interface IdentityUsage {
@@ -337,6 +357,7 @@ export interface IdentityUsage {
     DataStorage?: number;
 }
 /**
+ * @public
  * The response to a successful
  *       DescribeIdentityUsage request.
  */
@@ -348,6 +369,7 @@ export interface DescribeIdentityUsageResponse {
     IdentityUsage?: IdentityUsage;
 }
 /**
+ * @public
  * The input for the GetBulkPublishDetails operation.
  */
 export interface GetBulkPublishDetailsRequest {
@@ -358,6 +380,9 @@ export interface GetBulkPublishDetailsRequest {
      */
     IdentityPoolId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum BulkPublishStatus {
     FAILED = "FAILED",
     IN_PROGRESS = "IN_PROGRESS",
@@ -365,6 +390,7 @@ export declare enum BulkPublishStatus {
     SUCCEEDED = "SUCCEEDED"
 }
 /**
+ * @public
  * The output for the GetBulkPublishDetails operation.
  */
 export interface GetBulkPublishDetailsResponse {
@@ -396,6 +422,7 @@ export interface GetBulkPublishDetailsResponse {
     FailureMessage?: string;
 }
 /**
+ * @public
  * <p>A request for a list of the configured Cognito Events</p>
  */
 export interface GetCognitoEventsRequest {
@@ -405,6 +432,7 @@ export interface GetCognitoEventsRequest {
     IdentityPoolId: string | undefined;
 }
 /**
+ * @public
  * <p>The response from the GetCognitoEvents request</p>
  */
 export interface GetCognitoEventsResponse {
@@ -414,6 +442,7 @@ export interface GetCognitoEventsResponse {
     Events?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The input for the GetIdentityPoolConfiguration operation.</p>
  */
 export interface GetIdentityPoolConfigurationRequest {
@@ -423,8 +452,12 @@ export interface GetIdentityPoolConfigurationRequest {
      */
     IdentityPoolId: string | undefined;
 }
+/**
+ * @public
+ */
 export type StreamingStatus = "DISABLED" | "ENABLED";
 /**
+ * @public
  * Configuration options for configure Cognito streams.
  */
 export interface CognitoStreams {
@@ -444,6 +477,7 @@ export interface CognitoStreams {
     StreamingStatus?: StreamingStatus | string;
 }
 /**
+ * @public
  * <p>Configuration options to be applied to the identity pool.</p>
  */
 export interface PushSync {
@@ -457,6 +491,7 @@ export interface PushSync {
     RoleArn?: string;
 }
 /**
+ * @public
  * <p>The output for the GetIdentityPoolConfiguration operation.</p>
  */
 export interface GetIdentityPoolConfigurationResponse {
@@ -475,6 +510,7 @@ export interface GetIdentityPoolConfigurationResponse {
     CognitoStreams?: CognitoStreams;
 }
 /**
+ * @public
  * Request for a list of datasets for an
  *       identity.
  */
@@ -503,6 +539,7 @@ export interface ListDatasetsRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * Returned for a successful ListDatasets
  *       request.
  */
@@ -522,6 +559,7 @@ export interface ListDatasetsResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * A request for usage information on an
  *       identity pool.
  */
@@ -538,6 +576,7 @@ export interface ListIdentityPoolUsageRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * Returned for a successful
  *       ListIdentityPoolUsage request.
  */
@@ -564,6 +603,7 @@ export interface ListIdentityPoolUsageResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * A request for a list of records.
  */
 export interface ListRecordsRequest {
@@ -606,6 +646,7 @@ export interface ListRecordsRequest {
     SyncSessionToken?: string;
 }
 /**
+ * @public
  * The basic data structure of a dataset.
  */
 export interface _Record {
@@ -638,6 +679,7 @@ export interface _Record {
     DeviceLastModifiedDate?: Date;
 }
 /**
+ * @public
  * Returned for a successful
  *       ListRecordsRequest.
  */
@@ -686,6 +728,9 @@ export interface ListRecordsResponse {
      */
     SyncSessionToken?: string;
 }
+/**
+ * @public
+ */
 export declare class InvalidConfigurationException extends __BaseException {
     readonly name: "InvalidConfigurationException";
     readonly $fault: "client";
@@ -694,8 +739,12 @@ export declare class InvalidConfigurationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidConfigurationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export type Platform = "ADM" | "APNS" | "APNS_SANDBOX" | "GCM";
 /**
+ * @public
  * <p>A request to RegisterDevice.</p>
  */
 export interface RegisterDeviceRequest {
@@ -718,6 +767,7 @@ export interface RegisterDeviceRequest {
     Token: string | undefined;
 }
 /**
+ * @public
  * <p>Response to a RegisterDevice request.</p>
  */
 export interface RegisterDeviceResponse {
@@ -727,6 +777,7 @@ export interface RegisterDeviceResponse {
     DeviceId?: string;
 }
 /**
+ * @public
  * <p>A request to configure Cognito Events"</p>"
  */
 export interface SetCognitoEventsRequest {
@@ -740,6 +791,7 @@ export interface SetCognitoEventsRequest {
     Events: Record<string, string> | undefined;
 }
 /**
+ * @public
  * <p>Thrown if there are parallel requests to modify a resource.</p>
  */
 export declare class ConcurrentModificationException extends __BaseException {
@@ -751,6 +803,7 @@ export declare class ConcurrentModificationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
 }
 /**
+ * @public
  * <p>The input for the SetIdentityPoolConfiguration operation.</p>
  */
 export interface SetIdentityPoolConfigurationRequest {
@@ -769,6 +822,7 @@ export interface SetIdentityPoolConfigurationRequest {
     CognitoStreams?: CognitoStreams;
 }
 /**
+ * @public
  * <p>The output for the SetIdentityPoolConfiguration operation</p>
  */
 export interface SetIdentityPoolConfigurationResponse {
@@ -787,6 +841,7 @@ export interface SetIdentityPoolConfigurationResponse {
     CognitoStreams?: CognitoStreams;
 }
 /**
+ * @public
  * <p>A request to SubscribeToDatasetRequest.</p>
  */
 export interface SubscribeToDatasetRequest {
@@ -809,11 +864,13 @@ export interface SubscribeToDatasetRequest {
     DeviceId: string | undefined;
 }
 /**
+ * @public
  * <p>Response to a SubscribeToDataset request.</p>
  */
 export interface SubscribeToDatasetResponse {
 }
 /**
+ * @public
  * <p>A request to UnsubscribeFromDataset.</p>
  */
 export interface UnsubscribeFromDatasetRequest {
@@ -836,11 +893,13 @@ export interface UnsubscribeFromDatasetRequest {
     DeviceId: string | undefined;
 }
 /**
+ * @public
  * <p>Response to an UnsubscribeFromDataset request.</p>
  */
 export interface UnsubscribeFromDatasetResponse {
 }
 /**
+ * @public
  * <p>The AWS Lambda function returned invalid output or an exception.</p>
  */
 export declare class InvalidLambdaFunctionOutputException extends __BaseException {
@@ -852,6 +911,7 @@ export declare class InvalidLambdaFunctionOutputException extends __BaseExceptio
     constructor(opts: __ExceptionOptionType<InvalidLambdaFunctionOutputException, __BaseException>);
 }
 /**
+ * @public
  * <p>AWS Lambda throttled your account, please contact AWS Support</p>
  */
 export declare class LambdaThrottledException extends __BaseException {
@@ -863,6 +923,7 @@ export declare class LambdaThrottledException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LambdaThrottledException, __BaseException>);
 }
 /**
+ * @public
  * Thrown when the limit on the number of objects or
  *       operations has been exceeded.
  */
@@ -874,8 +935,12 @@ export declare class LimitExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export type Operation = "remove" | "replace";
 /**
+ * @public
  * An update operation for a record.
  */
 export interface RecordPatch {
@@ -904,6 +969,7 @@ export interface RecordPatch {
     DeviceLastModifiedDate?: Date;
 }
 /**
+ * @public
  * A request to post updates to records or add and
  *       delete records for a dataset and user.
  */
@@ -948,6 +1014,7 @@ export interface UpdateRecordsRequest {
     ClientContext?: string;
 }
 /**
+ * @public
  * Returned for a successful
  *       UpdateRecordsRequest.
  */

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.295.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.295.0",
-    "@aws-sdk/config-resolver": "3.295.0",
-    "@aws-sdk/credential-provider-node": "3.295.0",
-    "@aws-sdk/fetch-http-handler": "3.295.0",
-    "@aws-sdk/hash-node": "3.295.0",
-    "@aws-sdk/invalid-dependency": "3.295.0",
-    "@aws-sdk/middleware-content-length": "3.295.0",
-    "@aws-sdk/middleware-endpoint": "3.295.0",
-    "@aws-sdk/middleware-host-header": "3.295.0",
-    "@aws-sdk/middleware-logger": "3.295.0",
-    "@aws-sdk/middleware-recursion-detection": "3.295.0",
-    "@aws-sdk/middleware-retry": "3.295.0",
-    "@aws-sdk/middleware-serde": "3.295.0",
-    "@aws-sdk/middleware-signing": "3.295.0",
-    "@aws-sdk/middleware-stack": "3.295.0",
-    "@aws-sdk/middleware-user-agent": "3.295.0",
-    "@aws-sdk/node-config-provider": "3.295.0",
-    "@aws-sdk/node-http-handler": "3.295.0",
-    "@aws-sdk/protocol-http": "3.295.0",
-    "@aws-sdk/smithy-client": "3.295.0",
-    "@aws-sdk/types": "3.295.0",
-    "@aws-sdk/url-parser": "3.295.0",
+    "@aws-sdk/client-sts": "3.297.0",
+    "@aws-sdk/config-resolver": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
+    "@aws-sdk/fetch-http-handler": "3.296.0",
+    "@aws-sdk/hash-node": "3.296.0",
+    "@aws-sdk/invalid-dependency": "3.296.0",
+    "@aws-sdk/middleware-content-length": "3.296.0",
+    "@aws-sdk/middleware-endpoint": "3.296.0",
+    "@aws-sdk/middleware-host-header": "3.296.0",
+    "@aws-sdk/middleware-logger": "3.296.0",
+    "@aws-sdk/middleware-recursion-detection": "3.296.0",
+    "@aws-sdk/middleware-retry": "3.296.0",
+    "@aws-sdk/middleware-serde": "3.296.0",
+    "@aws-sdk/middleware-signing": "3.296.0",
+    "@aws-sdk/middleware-stack": "3.296.0",
+    "@aws-sdk/middleware-user-agent": "3.296.0",
+    "@aws-sdk/node-config-provider": "3.296.0",
+    "@aws-sdk/node-http-handler": "3.296.0",
+    "@aws-sdk/protocol-http": "3.296.0",
+    "@aws-sdk/smithy-client": "3.296.0",
+    "@aws-sdk/types": "3.296.0",
+    "@aws-sdk/url-parser": "3.296.0",
     "@aws-sdk/util-base64": "3.295.0",
     "@aws-sdk/util-body-length-browser": "3.295.0",
     "@aws-sdk/util-body-length-node": "3.295.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.295.0",
-    "@aws-sdk/util-defaults-mode-node": "3.295.0",
-    "@aws-sdk/util-endpoints": "3.295.0",
-    "@aws-sdk/util-retry": "3.295.0",
-    "@aws-sdk/util-user-agent-browser": "3.295.0",
-    "@aws-sdk/util-user-agent-node": "3.295.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.296.0",
+    "@aws-sdk/util-defaults-mode-node": "3.296.0",
+    "@aws-sdk/util-endpoints": "3.296.0",
+    "@aws-sdk/util-retry": "3.296.0",
+    "@aws-sdk/util-user-agent-browser": "3.296.0",
+    "@aws-sdk/util-user-agent-node": "3.296.0",
     "@aws-sdk/util-utf8": "3.295.0",
     "tslib": "^2.5.0"
   },