@aws-sdk/client-secrets-manager 3.296.0 → 3.297.0

package/dist-types/SecretsManager.d.ts

@@ -23,6 +23,7 @@ import { UpdateSecretVersionStageCommandInput, UpdateSecretVersionStageCommandOu
 import { ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput } from "./commands/ValidateResourcePolicyCommand";
 import { SecretsManagerClient } from "./SecretsManagerClient";
 /**
+ * @public
  * <fullname>Amazon Web Services Secrets Manager</fullname>
  *          <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
  *          <p>This guide provides descriptions of the Secrets Manager API. For more information about using this
@@ -52,6 +53,7 @@ import { SecretsManagerClient } from "./SecretsManagerClient";
  */
 export declare class SecretsManager extends SecretsManagerClient {
     /**
+     * @public
      * <p>Turns off automatic rotation, and if a rotation is currently in
      *       progress, cancels the rotation.</p>
      *          <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
@@ -76,6 +78,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     cancelRotateSecret(args: CancelRotateSecretCommandInput, cb: (err: any, data?: CancelRotateSecretCommandOutput) => void): void;
     cancelRotateSecret(args: CancelRotateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelRotateSecretCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a new secret. A <i>secret</i> can be a password, a set of
      *       credentials such as a user name and password, an OAuth token, or other secret information
      *       that you store in an encrypted form in Secrets Manager. The secret also
@@ -117,6 +120,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     createSecret(args: CreateSecretCommandInput, cb: (err: any, data?: CreateSecretCommandOutput) => void): void;
     createSecret(args: CreateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecretCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the resource-based permission policy attached to the secret. To attach a policy to
      *       a secret, use <a>PutResourcePolicy</a>.</p>
      *          <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
@@ -131,6 +135,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
     deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a secret and all of its versions. You can specify a recovery
      *       window during which you can restore the secret. The minimum recovery window is 7 days.
      *       The default recovery window is 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to
@@ -165,6 +170,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     deleteSecret(args: DeleteSecretCommandInput, cb: (err: any, data?: DeleteSecretCommandOutput) => void): void;
     deleteSecret(args: DeleteSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecretCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager
      *       only returns fields that have a value in the response. </p>
      *          <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
@@ -179,6 +185,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     describeSecret(args: DescribeSecretCommandInput, cb: (err: any, data?: DescribeSecretCommandOutput) => void): void;
     describeSecret(args: DescribeSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecretCommandOutput) => void): void;
     /**
+     * @public
      * <p>Generates a random password. We recommend that you specify the
      *       maximum length and include every character type that the system you are generating a password
      *       for can support.</p>
@@ -194,6 +201,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     getRandomPassword(args: GetRandomPasswordCommandInput, cb: (err: any, data?: GetRandomPasswordCommandOutput) => void): void;
     getRandomPassword(args: GetRandomPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRandomPasswordCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the JSON text of the resource-based policy document attached to the
      *       secret. For more information about permissions policies attached to a secret, see
      *       <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html">Permissions
@@ -210,6 +218,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     getResourcePolicy(args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
     getResourcePolicy(args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or
      *         <code>SecretBinary</code> from the specified version of a secret, whichever contains
      *       content.</p>
@@ -232,6 +241,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     getSecretValue(args: GetSecretValueCommandInput, cb: (err: any, data?: GetSecretValueCommandOutput) => void): void;
     getSecretValue(args: GetSecretValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSecretValueCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets
      *       that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.</p>
      *          <p>ListSecrets is eventually consistent, however it might not reflect changes from the last five minutes.
@@ -252,6 +262,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     listSecrets(args: ListSecretsCommandInput, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
     listSecrets(args: ListSecretsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions
      *     of a secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">
      *     Secrets Manager concepts: Versions</a>.</p>
@@ -268,6 +279,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     listSecretVersionIds(args: ListSecretVersionIdsCommandInput, cb: (err: any, data?: ListSecretVersionIdsCommandOutput) => void): void;
     listSecretVersionIds(args: ListSecretVersionIdsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecretVersionIdsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Attaches a resource-based permission policy to a secret. A resource-based policy is
      *       optional. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control for Secrets Manager</a>
      *          </p>
@@ -285,6 +297,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
     putResourcePolicy(args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a new version with a new encrypted secret value and attaches it to the secret. The
      *       version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. </p>
      *          <p>We recommend you avoid calling <code>PutSecretValue</code> at a sustained rate of more than
@@ -318,6 +331,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     putSecretValue(args: PutSecretValueCommandInput, cb: (err: any, data?: PutSecretValueCommandOutput) => void): void;
     putSecretValue(args: PutSecretValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSecretValueCommandOutput) => void): void;
     /**
+     * @public
      * <p>For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.</p>
      *          <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
      *          <p>
@@ -331,6 +345,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     removeRegionsFromReplication(args: RemoveRegionsFromReplicationCommandInput, cb: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void): void;
     removeRegionsFromReplication(args: RemoveRegionsFromReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Replicates the secret to a new Regions. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html">Multi-Region secrets</a>.</p>
      *          <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
      *          <p>
@@ -344,6 +359,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     replicateSecretToRegions(args: ReplicateSecretToRegionsCommandInput, cb: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void): void;
     replicateSecretToRegions(args: ReplicateSecretToRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code> time
      *       stamp. You can access a secret again after it has been restored.</p>
      *          <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
@@ -358,6 +374,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     restoreSecret(args: RestoreSecretCommandInput, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
     restoreSecret(args: RestoreSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
     /**
+     * @public
      * <p>Configures and starts the asynchronous process of rotating the secret. For information about rotation,
      *       see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a> in the <i>Secrets Manager User Guide</i>. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. </p>
      *          <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached
@@ -379,6 +396,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     rotateSecret(args: RotateSecretCommandInput, cb: (err: any, data?: RotateSecretCommandOutput) => void): void;
     rotateSecret(args: RotateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RotateSecretCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.</p>
      *          <p>You must call this operation from the Region in which you want to promote the replica to a primary secret.</p>
      *          <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
@@ -393,6 +411,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     stopReplicationToReplica(args: StopReplicationToReplicaCommandInput, cb: (err: any, data?: StopReplicationToReplicaCommandOutput) => void): void;
     stopReplicationToReplica(args: StopReplicationToReplicaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopReplicationToReplicaCommandOutput) => void): void;
     /**
+     * @public
      * <p>Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the
      *       secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.</p>
      *          <p>The following restrictions apply to tags:</p>
@@ -439,6 +458,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes specific tags from a secret.</p>
      *          <p>This operation is idempotent. If a requested tag is not attached to the secret, no error
      *       is returned and the secret metadata is unchanged.</p>
@@ -460,6 +480,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use <a>PutSecretValue</a>.</p>
      *          <p>To change the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p>
      *          <p>To change a secret so that it is managed by another service, you need to recreate the secret in that service. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.</p>
@@ -492,6 +513,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     updateSecret(args: UpdateSecretCommandInput, cb: (err: any, data?: UpdateSecretCommandOutput) => void): void;
     updateSecret(args: UpdateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecretCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to
      *       track a version as it progresses through the secret rotation process. Each staging label can be
      *       attached to only one version at a time. To add a staging label to a version when it is already
@@ -519,6 +541,7 @@ export declare class SecretsManager extends SecretsManagerClient {
     updateSecretVersionStage(args: UpdateSecretVersionStageCommandInput, cb: (err: any, data?: UpdateSecretVersionStageCommandOutput) => void): void;
     updateSecretVersionStage(args: UpdateSecretVersionStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecretVersionStageCommandOutput) => void): void;
     /**
+     * @public
      * <p>Validates that a resource policy does not grant a wide range of principals access to
      *       your secret. A resource-based policy is optional for secrets.</p>
      *          <p>The API performs three checks when validating the policy:</p>

package/dist-types/SecretsManagerClient.d.ts

@@ -30,15 +30,24 @@ import { UpdateSecretCommandInput, UpdateSecretCommandOutput } from "./commands/
 import { UpdateSecretVersionStageCommandInput, UpdateSecretVersionStageCommandOutput } from "./commands/UpdateSecretVersionStageCommand";
 import { ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput } from "./commands/ValidateResourcePolicyCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = CancelRotateSecretCommandInput | CreateSecretCommandInput | DeleteResourcePolicyCommandInput | DeleteSecretCommandInput | DescribeSecretCommandInput | GetRandomPasswordCommandInput | GetResourcePolicyCommandInput | GetSecretValueCommandInput | ListSecretVersionIdsCommandInput | ListSecretsCommandInput | PutResourcePolicyCommandInput | PutSecretValueCommandInput | RemoveRegionsFromReplicationCommandInput | ReplicateSecretToRegionsCommandInput | RestoreSecretCommandInput | RotateSecretCommandInput | StopReplicationToReplicaCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateSecretCommandInput | UpdateSecretVersionStageCommandInput | ValidateResourcePolicyCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = CancelRotateSecretCommandOutput | CreateSecretCommandOutput | DeleteResourcePolicyCommandOutput | DeleteSecretCommandOutput | DescribeSecretCommandOutput | GetRandomPasswordCommandOutput | GetResourcePolicyCommandOutput | GetSecretValueCommandOutput | ListSecretVersionIdsCommandOutput | ListSecretsCommandOutput | PutResourcePolicyCommandOutput | PutSecretValueCommandOutput | RemoveRegionsFromReplicationCommandOutput | ReplicateSecretToRegionsCommandOutput | RestoreSecretCommandOutput | RotateSecretCommandOutput | StopReplicationToReplicaCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateSecretCommandOutput | UpdateSecretVersionStageCommandOutput | ValidateResourcePolicyCommandOutput;
+/**
+ * @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
      */
@@ -128,23 +137,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 SecretsManagerClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of SecretsManagerClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of SecretsManagerClient class constructor that set the region, credentials and other options.
  */
 export interface SecretsManagerClientConfig extends SecretsManagerClientConfigType {
 }
+/**
+ * @public
+ */
 type SecretsManagerClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of SecretsManagerClient class. This is resolved and normalized from the {@link SecretsManagerClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of SecretsManagerClient class. This is resolved and normalized from the {@link SecretsManagerClientConfig | constructor configuration interface}.
  */
 export interface SecretsManagerClientResolvedConfig extends SecretsManagerClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Amazon Web Services Secrets Manager</fullname>
  *          <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
  *          <p>This guide provides descriptions of the Secrets Manager API. For more information about using this

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CancelRotateSecretRequest, CancelRotateSecretResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link CancelRotateSecretCommand}.
  */
 export interface CancelRotateSecretCommandInput extends CancelRotateSecretRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CancelRotateSecretCommand}.
  */
 export interface CancelRotateSecretCommandOutput extends CancelRotateSecretResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Turns off automatic rotation, and if a rotation is currently in
  *       progress, cancels the rotation.</p>
  *          <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
@@ -43,6 +48,8 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param CancelRotateSecretCommandInput - {@link CancelRotateSecretCommandInput}
+ * @returns {@link CancelRotateSecretCommandOutput}
  * @see {@link CancelRotateSecretCommandInput} for command's `input` shape.
  * @see {@link CancelRotateSecretCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -96,11 +103,20 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo
 export declare class CancelRotateSecretCommand extends $Command<CancelRotateSecretCommandInput, CancelRotateSecretCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: CancelRotateSecretCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CancelRotateSecretCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelRotateSecretCommandInput, CancelRotateSecretCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateSecretRequest, CreateSecretResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link CreateSecretCommand}.
  */
 export interface CreateSecretCommandInput extends CreateSecretRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateSecretCommand}.
  */
 export interface CreateSecretCommandOutput extends CreateSecretResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new secret. A <i>secret</i> can be a password, a set of
  *       credentials such as a user name and password, an OAuth token, or other secret information
  *       that you store in an encrypted form in Secrets Manager. The secret also
@@ -60,6 +65,8 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateSecretCommandInput - {@link CreateSecretCommandInput}
+ * @returns {@link CreateSecretCommandOutput}
  * @see {@link CreateSecretCommandInput} for command's `input` shape.
  * @see {@link CreateSecretCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -137,11 +144,20 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
 export declare class CreateSecretCommand extends $Command<CreateSecretCommandInput, CreateSecretCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: CreateSecretCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateSecretCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSecretCommandInput, CreateSecretCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DeleteResourcePolicyRequest, DeleteResourcePolicyResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link DeleteResourcePolicyCommand}.
  */
 export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteResourcePolicyCommand}.
  */
 export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes the resource-based permission policy attached to the secret. To attach a policy to
  *       a secret, use <a>PutResourcePolicy</a>.</p>
  *          <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
@@ -33,6 +38,8 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
+ * @returns {@link DeleteResourcePolicyCommandOutput}
  * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape.
  * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -86,11 +93,20 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
 export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: DeleteResourcePolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteResourcePolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DeleteSecretRequest, DeleteSecretResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link DeleteSecretCommand}.
  */
 export interface DeleteSecretCommandInput extends DeleteSecretRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteSecretCommand}.
  */
 export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes a secret and all of its versions. You can specify a recovery
  *       window during which you can restore the secret. The minimum recovery window is 7 days.
  *       The default recovery window is 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to
@@ -53,6 +58,8 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteSecretCommandInput - {@link DeleteSecretCommandInput}
+ * @returns {@link DeleteSecretCommandOutput}
  * @see {@link DeleteSecretCommandInput} for command's `input` shape.
  * @see {@link DeleteSecretCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -108,11 +115,20 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad
 export declare class DeleteSecretCommand extends $Command<DeleteSecretCommandInput, DeleteSecretCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: DeleteSecretCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteSecretCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSecretCommandInput, DeleteSecretCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DescribeSecretRequest, DescribeSecretResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link DescribeSecretCommand}.
  */
 export interface DescribeSecretCommandInput extends DescribeSecretRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeSecretCommand}.
  */
 export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager
  *       only returns fields that have a value in the response. </p>
  *          <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
@@ -33,6 +38,8 @@ export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeSecretCommandInput - {@link DescribeSecretCommandInput}
+ * @returns {@link DescribeSecretCommandOutput}
  * @see {@link DescribeSecretCommandInput} for command's `input` shape.
  * @see {@link DescribeSecretCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -99,11 +106,20 @@ export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __M
 export declare class DescribeSecretCommand extends $Command<DescribeSecretCommandInput, DescribeSecretCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: DescribeSecretCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeSecretCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeSecretCommandInput, DescribeSecretCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetRandomPasswordRequest, GetRandomPasswordResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link GetRandomPasswordCommand}.
  */
 export interface GetRandomPasswordCommandInput extends GetRandomPasswordRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetRandomPasswordCommand}.
  */
 export interface GetRandomPasswordCommandOutput extends GetRandomPasswordResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Generates a random password. We recommend that you specify the
  *       maximum length and include every character type that the system you are generating a password
  *       for can support.</p>
@@ -34,6 +39,8 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param GetRandomPasswordCommandInput - {@link GetRandomPasswordCommandInput}
+ * @returns {@link GetRandomPasswordCommandOutput}
  * @see {@link GetRandomPasswordCommandInput} for command's `input` shape.
  * @see {@link GetRandomPasswordCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -85,11 +92,20 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons
 export declare class GetRandomPasswordCommand extends $Command<GetRandomPasswordCommandInput, GetRandomPasswordCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: GetRandomPasswordCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetRandomPasswordCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRandomPasswordCommandInput, GetRandomPasswordCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetResourcePolicyRequest, GetResourcePolicyResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link GetResourcePolicyCommand}.
  */
 export interface GetResourcePolicyCommandInput extends GetResourcePolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetResourcePolicyCommand}.
  */
 export interface GetResourcePolicyCommandOutput extends GetResourcePolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves the JSON text of the resource-based policy document attached to the
  *       secret. For more information about permissions policies attached to a secret, see
  *       <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html">Permissions
@@ -35,6 +40,8 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param GetResourcePolicyCommandInput - {@link GetResourcePolicyCommandInput}
+ * @returns {@link GetResourcePolicyCommandOutput}
  * @see {@link GetResourcePolicyCommandInput} for command's `input` shape.
  * @see {@link GetResourcePolicyCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -89,11 +96,20 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons
 export declare class GetResourcePolicyCommand extends $Command<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: GetResourcePolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetResourcePolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }