@aws-sdk/client-docdb-elastic 3.296.0 → 3.298.0

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { DocDBElasticServiceException as __BaseException } from "./DocDBElasticServiceException";
 /**
+ * @public
  * <p>An exception that occurs when there are not sufficient permissions to perform an action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -11,11 +12,15 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum Auth {
     PLAIN_TEXT = "PLAIN_TEXT",
     SECRET_ARN = "SECRET_ARN"
 }
 /**
+ * @public
  * <p>There was an access conflict.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -34,6 +39,9 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateClusterInput {
     /**
      * <p>The name of the new Elastic DocumentDB cluster. This parameter is stored as
@@ -143,6 +151,9 @@ export interface CreateClusterInput {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export declare enum Status {
     ACTIVE = "ACTIVE",
     CREATING = "CREATING",
@@ -155,6 +166,7 @@ export declare enum Status {
     VPC_ENDPOINT_LIMIT_EXCEEDED = "VPC_ENDPOINT_LIMIT_EXCEEDED"
 }
 /**
+ * @public
  * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
  */
 export interface Cluster {
@@ -215,6 +227,9 @@ export interface Cluster {
      */
     kmsKeyId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateClusterOutput {
     /**
      * <p>The new Elastic DocumentDB cluster that has been created.</p>
@@ -222,6 +237,7 @@ export interface CreateClusterOutput {
     cluster: Cluster | undefined;
 }
 /**
+ * @public
  * <p>There was an internal server error.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -234,6 +250,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service quota for the action was exceeded.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -245,6 +262,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>ThrottlingException will be thrown when request was denied due to request throttling.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -261,6 +279,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>A specific field in which a given validation exception occurred.</p>
  */
 export interface ValidationExceptionField {
@@ -273,6 +292,9 @@ export interface ValidationExceptionField {
      */
     message: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ValidationExceptionReason {
     CANNOT_PARSE = "cannotParse",
     FIELD_VALIDATION_FAILED = "fieldValidationFailed",
@@ -280,6 +302,7 @@ export declare enum ValidationExceptionReason {
     UNKNOWN_OPERATION = "unknownOperation"
 }
 /**
+ * @public
  * <p>A structure defining a validation exception.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -299,6 +322,9 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateClusterSnapshotInput {
     /**
      * <p>The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.</p>
@@ -314,6 +340,7 @@ export interface CreateClusterSnapshotInput {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>Returns information about a specific Elastic DocumentDB snapshot.</p>
  */
 export interface ClusterSnapshot {
@@ -358,6 +385,9 @@ export interface ClusterSnapshot {
      */
     kmsKeyId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateClusterSnapshotOutput {
     /**
      * <p>Returns information about the new Elastic DocumentDB snapshot.</p>
@@ -365,6 +395,7 @@ export interface CreateClusterSnapshotOutput {
     snapshot: ClusterSnapshot | undefined;
 }
 /**
+ * @public
  * <p>The specified resource could not be located.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -383,54 +414,81 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteClusterInput {
     /**
      * <p>The arn of the Elastic DocumentDB cluster that is to be deleted.</p>
      */
     clusterArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteClusterOutput {
     /**
      * <p>Returns information about the newly deleted Elastic DocumentDB cluster.</p>
      */
     cluster: Cluster | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteClusterSnapshotInput {
     /**
      * <p>The arn of the Elastic DocumentDB snapshot that is to be deleted.</p>
      */
     snapshotArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteClusterSnapshotOutput {
     /**
      * <p>Returns information about the newly deleted Elastic DocumentDB snapshot.</p>
      */
     snapshot: ClusterSnapshot | undefined;
 }
+/**
+ * @public
+ */
 export interface GetClusterInput {
     /**
      * <p>The arn of the Elastic DocumentDB cluster.</p>
      */
     clusterArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetClusterOutput {
     /**
      * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
      */
     cluster: Cluster | undefined;
 }
+/**
+ * @public
+ */
 export interface GetClusterSnapshotInput {
     /**
      * <p>The arn of the Elastic DocumentDB snapshot.</p>
      */
     snapshotArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetClusterSnapshotOutput {
     /**
      * <p>Returns information about a specific Elastic DocumentDB snapshot.</p>
      */
     snapshot: ClusterSnapshot | undefined;
 }
+/**
+ * @public
+ */
 export interface ListClustersInput {
     /**
      * <p>The nextToken which is used the get the next page of data.</p>
@@ -442,6 +500,7 @@ export interface ListClustersInput {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>A list of Elastic DocumentDB cluster.</p>
  */
 export interface ClusterInList {
@@ -458,6 +517,9 @@ export interface ClusterInList {
      */
     status: Status | string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListClustersOutput {
     /**
      * <p>A list of Elastic DocumentDB cluster.</p>
@@ -469,6 +531,9 @@ export interface ListClustersOutput {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListClusterSnapshotsInput {
     /**
      * <p>The arn of the Elastic DocumentDB cluster.</p>
@@ -484,6 +549,7 @@ export interface ListClusterSnapshotsInput {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>A list of Elastic DocumentDB snapshots.</p>
  */
 export interface ClusterSnapshotInList {
@@ -508,6 +574,9 @@ export interface ClusterSnapshotInList {
      */
     snapshotCreationTime: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListClusterSnapshotsOutput {
     /**
      * <p>A list of Elastic DocumentDB snapshots for a specified cluster.</p>
@@ -519,18 +588,27 @@ export interface ListClusterSnapshotsOutput {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The arn of the Elastic DocumentDB resource.</p>
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The list of tags for the specified Elastic DocumentDB resource.</p>
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface RestoreClusterFromSnapshotInput {
     /**
      * <p>The name of the Elastic DocumentDB cluster.</p>
@@ -567,12 +645,18 @@ export interface RestoreClusterFromSnapshotInput {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface RestoreClusterFromSnapshotOutput {
     /**
      * <p>Returns information about a the restored Elastic DocumentDB cluster.</p>
      */
     cluster: Cluster | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The arn of the Elastic DocumentDB resource.</p>
@@ -583,8 +667,14 @@ export interface TagResourceRequest {
      */
     tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The arn of the Elastic DocumentDB resource.</p>
@@ -595,8 +685,14 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateClusterInput {
     /**
      * <p>The arn of the Elastic DocumentDB cluster.</p>
@@ -650,6 +746,9 @@ export interface UpdateClusterInput {
      */
     preferredMaintenanceWindow?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateClusterOutput {
     /**
      * <p>Returns information about the updated Elastic DocumentDB cluster.</p>
@@ -660,123 +759,7 @@ export interface UpdateClusterOutput {
  * @internal
  */
 export declare const CreateClusterInputFilterSensitiveLog: (obj: CreateClusterInput) => any;
-/**
- * @internal
- */
-export declare const ClusterFilterSensitiveLog: (obj: Cluster) => any;
-/**
- * @internal
- */
-export declare const CreateClusterOutputFilterSensitiveLog: (obj: CreateClusterOutput) => any;
-/**
- * @internal
- */
-export declare const ValidationExceptionFieldFilterSensitiveLog: (obj: ValidationExceptionField) => any;
-/**
- * @internal
- */
-export declare const CreateClusterSnapshotInputFilterSensitiveLog: (obj: CreateClusterSnapshotInput) => any;
-/**
- * @internal
- */
-export declare const ClusterSnapshotFilterSensitiveLog: (obj: ClusterSnapshot) => any;
-/**
- * @internal
- */
-export declare const CreateClusterSnapshotOutputFilterSensitiveLog: (obj: CreateClusterSnapshotOutput) => any;
-/**
- * @internal
- */
-export declare const DeleteClusterInputFilterSensitiveLog: (obj: DeleteClusterInput) => any;
-/**
- * @internal
- */
-export declare const DeleteClusterOutputFilterSensitiveLog: (obj: DeleteClusterOutput) => any;
-/**
- * @internal
- */
-export declare const DeleteClusterSnapshotInputFilterSensitiveLog: (obj: DeleteClusterSnapshotInput) => any;
-/**
- * @internal
- */
-export declare const DeleteClusterSnapshotOutputFilterSensitiveLog: (obj: DeleteClusterSnapshotOutput) => any;
-/**
- * @internal
- */
-export declare const GetClusterInputFilterSensitiveLog: (obj: GetClusterInput) => any;
-/**
- * @internal
- */
-export declare const GetClusterOutputFilterSensitiveLog: (obj: GetClusterOutput) => any;
-/**
- * @internal
- */
-export declare const GetClusterSnapshotInputFilterSensitiveLog: (obj: GetClusterSnapshotInput) => any;
-/**
- * @internal
- */
-export declare const GetClusterSnapshotOutputFilterSensitiveLog: (obj: GetClusterSnapshotOutput) => any;
-/**
- * @internal
- */
-export declare const ListClustersInputFilterSensitiveLog: (obj: ListClustersInput) => any;
-/**
- * @internal
- */
-export declare const ClusterInListFilterSensitiveLog: (obj: ClusterInList) => any;
-/**
- * @internal
- */
-export declare const ListClustersOutputFilterSensitiveLog: (obj: ListClustersOutput) => any;
-/**
- * @internal
- */
-export declare const ListClusterSnapshotsInputFilterSensitiveLog: (obj: ListClusterSnapshotsInput) => any;
-/**
- * @internal
- */
-export declare const ClusterSnapshotInListFilterSensitiveLog: (obj: ClusterSnapshotInList) => any;
-/**
- * @internal
- */
-export declare const ListClusterSnapshotsOutputFilterSensitiveLog: (obj: ListClusterSnapshotsOutput) => any;
-/**
- * @internal
- */
-export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
-/**
- * @internal
- */
-export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
-/**
- * @internal
- */
-export declare const RestoreClusterFromSnapshotInputFilterSensitiveLog: (obj: RestoreClusterFromSnapshotInput) => any;
-/**
- * @internal
- */
-export declare const RestoreClusterFromSnapshotOutputFilterSensitiveLog: (obj: RestoreClusterFromSnapshotOutput) => any;
-/**
- * @internal
- */
-export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
-/**
- * @internal
- */
-export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
 /**
  * @internal
  */
 export declare const UpdateClusterInputFilterSensitiveLog: (obj: UpdateClusterInput) => any;
-/**
- * @internal
- */
-export declare const UpdateClusterOutputFilterSensitiveLog: (obj: UpdateClusterOutput) => any;

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { DocDBElasticClient } from "../DocDBElasticClient";
+/**
+ * @public
+ */
 export interface DocDBElasticPaginationConfiguration extends PaginationConfiguration {
     client: DocDBElasticClient;
 }

package/dist-types/pagination/ListClusterSnapshotsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListClusterSnapshotsCommandInput, ListClusterSnapshotsCommandOutput } from "../commands/ListClusterSnapshotsCommand";
 import { DocDBElasticPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListClusterSnapshots(config: DocDBElasticPaginationConfiguration, input: ListClusterSnapshotsCommandInput, ...additionalArguments: any): Paginator<ListClusterSnapshotsCommandOutput>;

package/dist-types/pagination/ListClustersPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListClustersCommandInput, ListClustersCommandOutput } from "../commands/ListClustersCommand";
 import { DocDBElasticPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListClusters(config: DocDBElasticPaginationConfiguration, input: ListClustersCommandInput, ...additionalArguments: any): Paginator<ListClustersCommandOutput>;

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

@@ -230,91 +230,6 @@ export interface UpdateClusterOutput {
 export declare const CreateClusterInputFilterSensitiveLog: (
   obj: CreateClusterInput
 ) => any;
-export declare const ClusterFilterSensitiveLog: (obj: Cluster) => any;
-export declare const CreateClusterOutputFilterSensitiveLog: (
-  obj: CreateClusterOutput
-) => any;
-export declare const ValidationExceptionFieldFilterSensitiveLog: (
-  obj: ValidationExceptionField
-) => any;
-export declare const CreateClusterSnapshotInputFilterSensitiveLog: (
-  obj: CreateClusterSnapshotInput
-) => any;
-export declare const ClusterSnapshotFilterSensitiveLog: (
-  obj: ClusterSnapshot
-) => any;
-export declare const CreateClusterSnapshotOutputFilterSensitiveLog: (
-  obj: CreateClusterSnapshotOutput
-) => any;
-export declare const DeleteClusterInputFilterSensitiveLog: (
-  obj: DeleteClusterInput
-) => any;
-export declare const DeleteClusterOutputFilterSensitiveLog: (
-  obj: DeleteClusterOutput
-) => any;
-export declare const DeleteClusterSnapshotInputFilterSensitiveLog: (
-  obj: DeleteClusterSnapshotInput
-) => any;
-export declare const DeleteClusterSnapshotOutputFilterSensitiveLog: (
-  obj: DeleteClusterSnapshotOutput
-) => any;
-export declare const GetClusterInputFilterSensitiveLog: (
-  obj: GetClusterInput
-) => any;
-export declare const GetClusterOutputFilterSensitiveLog: (
-  obj: GetClusterOutput
-) => any;
-export declare const GetClusterSnapshotInputFilterSensitiveLog: (
-  obj: GetClusterSnapshotInput
-) => any;
-export declare const GetClusterSnapshotOutputFilterSensitiveLog: (
-  obj: GetClusterSnapshotOutput
-) => any;
-export declare const ListClustersInputFilterSensitiveLog: (
-  obj: ListClustersInput
-) => any;
-export declare const ClusterInListFilterSensitiveLog: (
-  obj: ClusterInList
-) => any;
-export declare const ListClustersOutputFilterSensitiveLog: (
-  obj: ListClustersOutput
-) => any;
-export declare const ListClusterSnapshotsInputFilterSensitiveLog: (
-  obj: ListClusterSnapshotsInput
-) => any;
-export declare const ClusterSnapshotInListFilterSensitiveLog: (
-  obj: ClusterSnapshotInList
-) => any;
-export declare const ListClusterSnapshotsOutputFilterSensitiveLog: (
-  obj: ListClusterSnapshotsOutput
-) => any;
-export declare const ListTagsForResourceRequestFilterSensitiveLog: (
-  obj: ListTagsForResourceRequest
-) => any;
-export declare const ListTagsForResourceResponseFilterSensitiveLog: (
-  obj: ListTagsForResourceResponse
-) => any;
-export declare const RestoreClusterFromSnapshotInputFilterSensitiveLog: (
-  obj: RestoreClusterFromSnapshotInput
-) => any;
-export declare const RestoreClusterFromSnapshotOutputFilterSensitiveLog: (
-  obj: RestoreClusterFromSnapshotOutput
-) => any;
-export declare const TagResourceRequestFilterSensitiveLog: (
-  obj: TagResourceRequest
-) => any;
-export declare const TagResourceResponseFilterSensitiveLog: (
-  obj: TagResourceResponse
-) => any;
-export declare const UntagResourceRequestFilterSensitiveLog: (
-  obj: UntagResourceRequest
-) => any;
-export declare const UntagResourceResponseFilterSensitiveLog: (
-  obj: UntagResourceResponse
-) => any;
 export declare const UpdateClusterInputFilterSensitiveLog: (
   obj: UpdateClusterInput
 ) => any;
-export declare const UpdateClusterOutputFilterSensitiveLog: (
-  obj: UpdateClusterOutput
-) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-docdb-elastic",
   "description": "AWS SDK for JavaScript Docdb Elastic Client for Node.js, Browser and React Native",
-  "version": "3.296.0",
+  "version": "3.298.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -11,6 +11,7 @@
     "build:types": "tsc -p tsconfig.types.json",
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
+    "extract:docs": "api-extractor run --local",
     "generate:client": "node ../../scripts/generate-clients/single-service --solo docdb-elastic"
   },
   "main": "./dist-cjs/index.js",
@@ -20,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.298.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.298.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",