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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetSecretValueRequest, GetSecretValueResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link GetSecretValueCommand}.
  */
 export interface GetSecretValueCommandInput extends GetSecretValueRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetSecretValueCommand}.
  */
 export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -41,6 +46,8 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param GetSecretValueCommandInput - {@link GetSecretValueCommandInput}
+ * @returns {@link GetSecretValueCommandOutput}
  * @see {@link GetSecretValueCommandInput} for command's `input` shape.
  * @see {@link GetSecretValueCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -103,11 +110,20 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
 export declare class GetSecretValueCommand extends $Command<GetSecretValueCommandInput, GetSecretValueCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: GetSecretValueCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetSecretValueCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSecretValueCommandInput, GetSecretValueCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListSecretVersionIdsRequest, ListSecretVersionIdsResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link ListSecretVersionIdsCommand}.
  */
 export interface ListSecretVersionIdsCommandInput extends ListSecretVersionIdsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListSecretVersionIdsCommand}.
  */
 export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -35,6 +40,8 @@ export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsR
  * const response = await client.send(command);
  * ```
  *
+ * @param ListSecretVersionIdsCommandInput - {@link ListSecretVersionIdsCommandInput}
+ * @returns {@link ListSecretVersionIdsCommandOutput}
  * @see {@link ListSecretVersionIdsCommandInput} for command's `input` shape.
  * @see {@link ListSecretVersionIdsCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -94,11 +101,20 @@ export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsR
 export declare class ListSecretVersionIdsCommand extends $Command<ListSecretVersionIdsCommandInput, ListSecretVersionIdsCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: ListSecretVersionIdsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListSecretVersionIdsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSecretVersionIdsCommandInput, ListSecretVersionIdsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListSecretsRequest, ListSecretsResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link ListSecretsCommand}.
  */
 export interface ListSecretsCommandInput extends ListSecretsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListSecretsCommand}.
  */
 export interface ListSecretsCommandOutput extends ListSecretsResponse, __MetadataBearer {
 }
 /**
+ * @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.
@@ -39,6 +44,8 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param ListSecretsCommandInput - {@link ListSecretsCommandInput}
+ * @returns {@link ListSecretsCommandOutput}
  * @see {@link ListSecretsCommandInput} for command's `input` shape.
  * @see {@link ListSecretsCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -94,11 +101,20 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat
 export declare class ListSecretsCommand extends $Command<ListSecretsCommandInput, ListSecretsCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: ListSecretsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListSecretsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSecretsCommandInput, ListSecretsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutResourcePolicyRequest, PutResourcePolicyResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link PutResourcePolicyCommand}.
  */
 export interface PutResourcePolicyCommandInput extends PutResourcePolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutResourcePolicyCommand}.
  */
 export interface PutResourcePolicyCommandOutput extends PutResourcePolicyResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -36,6 +41,8 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param PutResourcePolicyCommandInput - {@link PutResourcePolicyCommandInput}
+ * @returns {@link PutResourcePolicyCommandOutput}
  * @see {@link PutResourcePolicyCommandInput} for command's `input` shape.
  * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -96,11 +103,20 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
 export declare class PutResourcePolicyCommand extends $Command<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: PutResourcePolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutResourcePolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutSecretValueRequest, PutSecretValueResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link PutSecretValueCommand}.
  */
 export interface PutSecretValueCommandInput extends PutSecretValueRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutSecretValueCommand}.
  */
 export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __MetadataBearer {
 }
 /**
+ * @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
@@ -52,6 +57,8 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param PutSecretValueCommandInput - {@link PutSecretValueCommandInput}
+ * @returns {@link PutSecretValueCommandOutput}
  * @see {@link PutSecretValueCommandInput} for command's `input` shape.
  * @see {@link PutSecretValueCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -125,11 +132,20 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M
 export declare class PutSecretValueCommand extends $Command<PutSecretValueCommandInput, PutSecretValueCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: PutSecretValueCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutSecretValueCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutSecretValueCommandInput, PutSecretValueCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { RemoveRegionsFromReplicationRequest, RemoveRegionsFromReplicationResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link RemoveRegionsFromReplicationCommand}.
  */
 export interface RemoveRegionsFromReplicationCommandInput extends RemoveRegionsFromReplicationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RemoveRegionsFromReplicationCommand}.
  */
 export interface RemoveRegionsFromReplicationCommandOutput extends RemoveRegionsFromReplicationResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -32,6 +37,8 @@ export interface RemoveRegionsFromReplicationCommandOutput extends RemoveRegions
  * const response = await client.send(command);
  * ```
  *
+ * @param RemoveRegionsFromReplicationCommandInput - {@link RemoveRegionsFromReplicationCommandInput}
+ * @returns {@link RemoveRegionsFromReplicationCommandOutput}
  * @see {@link RemoveRegionsFromReplicationCommandInput} for command's `input` shape.
  * @see {@link RemoveRegionsFromReplicationCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -68,11 +75,20 @@ export interface RemoveRegionsFromReplicationCommandOutput extends RemoveRegions
 export declare class RemoveRegionsFromReplicationCommand extends $Command<RemoveRegionsFromReplicationCommandInput, RemoveRegionsFromReplicationCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: RemoveRegionsFromReplicationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RemoveRegionsFromReplicationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveRegionsFromReplicationCommandInput, RemoveRegionsFromReplicationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ReplicateSecretToRegionsRequest, ReplicateSecretToRegionsResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link ReplicateSecretToRegionsCommand}.
  */
 export interface ReplicateSecretToRegionsCommandInput extends ReplicateSecretToRegionsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ReplicateSecretToRegionsCommand}.
  */
 export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretToRegionsResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -32,6 +37,8 @@ export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretTo
  * const response = await client.send(command);
  * ```
  *
+ * @param ReplicateSecretToRegionsCommandInput - {@link ReplicateSecretToRegionsCommandInput}
+ * @returns {@link ReplicateSecretToRegionsCommandOutput}
  * @see {@link ReplicateSecretToRegionsCommandInput} for command's `input` shape.
  * @see {@link ReplicateSecretToRegionsCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -68,11 +75,20 @@ export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretTo
 export declare class ReplicateSecretToRegionsCommand extends $Command<ReplicateSecretToRegionsCommandInput, ReplicateSecretToRegionsCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: ReplicateSecretToRegionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ReplicateSecretToRegionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ReplicateSecretToRegionsCommandInput, ReplicateSecretToRegionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { RestoreSecretRequest, RestoreSecretResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link RestoreSecretCommand}.
  */
 export interface RestoreSecretCommandInput extends RestoreSecretRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RestoreSecretCommand}.
  */
 export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -33,6 +38,8 @@ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param RestoreSecretCommandInput - {@link RestoreSecretCommandInput}
+ * @returns {@link RestoreSecretCommandOutput}
  * @see {@link RestoreSecretCommandInput} for command's `input` shape.
  * @see {@link RestoreSecretCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -86,11 +93,20 @@ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __Met
 export declare class RestoreSecretCommand extends $Command<RestoreSecretCommandInput, RestoreSecretCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: RestoreSecretCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RestoreSecretCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RestoreSecretCommandInput, RestoreSecretCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { RotateSecretRequest, RotateSecretResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link RotateSecretCommand}.
  */
 export interface RotateSecretCommandInput extends RotateSecretRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RotateSecretCommand}.
  */
 export interface RotateSecretCommandOutput extends RotateSecretResponse, __MetadataBearer {
 }
 /**
+ * @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
@@ -40,6 +45,8 @@ export interface RotateSecretCommandOutput extends RotateSecretResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param RotateSecretCommandInput - {@link RotateSecretCommandInput}
+ * @returns {@link RotateSecretCommandOutput}
  * @see {@link RotateSecretCommandInput} for command's `input` shape.
  * @see {@link RotateSecretCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -117,11 +124,20 @@ export interface RotateSecretCommandOutput extends RotateSecretResponse, __Metad
 export declare class RotateSecretCommand extends $Command<RotateSecretCommandInput, RotateSecretCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: RotateSecretCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RotateSecretCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RotateSecretCommandInput, RotateSecretCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StopReplicationToReplicaRequest, StopReplicationToReplicaResponse } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link StopReplicationToReplicaCommand}.
  */
 export interface StopReplicationToReplicaCommandInput extends StopReplicationToReplicaRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StopReplicationToReplicaCommand}.
  */
 export interface StopReplicationToReplicaCommandOutput extends StopReplicationToReplicaResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -33,6 +38,8 @@ export interface StopReplicationToReplicaCommandOutput extends StopReplicationTo
  * const response = await client.send(command);
  * ```
  *
+ * @param StopReplicationToReplicaCommandInput - {@link StopReplicationToReplicaCommandInput}
+ * @returns {@link StopReplicationToReplicaCommandOutput}
  * @see {@link StopReplicationToReplicaCommandInput} for command's `input` shape.
  * @see {@link StopReplicationToReplicaCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -69,11 +76,20 @@ export interface StopReplicationToReplicaCommandOutput extends StopReplicationTo
 export declare class StopReplicationToReplicaCommand extends $Command<StopReplicationToReplicaCommandInput, StopReplicationToReplicaCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: StopReplicationToReplicaCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopReplicationToReplicaCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopReplicationToReplicaCommandInput, StopReplicationToReplicaCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UntagResourceRequest } from "../models/models_0";
 import { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @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>
@@ -40,6 +45,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
@@ -91,11 +98,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SecretsManagerClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }