@aws-sdk/client-secrets-manager 3.379.1 → 3.382.0

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

@@ -6,10 +6,12 @@ import { SecretsManagerServiceException as __BaseException } from "./SecretsMana
  */
 export interface ReplicaRegionType {
     /**
+     * @public
      * <p>A Region code. For a list of Region codes, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints">Name and code of Regions</a>.</p>
      */
     Region?: string;
     /**
+     * @public
      * <p>The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses <code>aws/secretsmanager</code>.</p>
      */
     KmsKeyId?: string;
@@ -19,6 +21,7 @@ export interface ReplicaRegionType {
  */
 export interface CancelRotateSecretRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
@@ -30,14 +33,17 @@ export interface CancelRotateSecretRequest {
  */
 export interface CancelRotateSecretResponse {
     /**
+     * @public
      * <p>The ARN of the secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The unique identifier of the version of the secret created during the rotation. This
      *       version might not be complete, and should be evaluated for possible deletion. We recommend
      *       that you remove the <code>VersionStage</code> value <code>AWSPENDING</code> from this version so that
@@ -119,10 +125,12 @@ export declare class ResourceNotFoundException extends __BaseException {
  */
 export interface Tag {
     /**
+     * @public
      * <p>The key identifier, or name, of the tag.</p>
      */
     Key?: string;
     /**
+     * @public
      * <p>The string value associated with the key of the tag.</p>
      */
     Value?: string;
@@ -132,6 +140,7 @@ export interface Tag {
  */
 export interface CreateSecretRequest {
     /**
+     * @public
      * <p>The name of the new secret.</p>
      *          <p>The secret name can contain ASCII letters, numbers, and the following characters:
      *       /_+=.@-</p>
@@ -141,6 +150,7 @@ export interface CreateSecretRequest {
      */
     Name: string | undefined;
     /**
+     * @public
      * <p>If you include <code>SecretString</code> or <code>SecretBinary</code>, then
      *       Secrets Manager creates an initial version for the secret, and this parameter specifies the unique
      *       identifier for the new version. </p>
@@ -177,10 +187,12 @@ export interface CreateSecretRequest {
      */
     ClientRequestToken?: string;
     /**
+     * @public
      * <p>The description of the secret.</p>
      */
     Description?: string;
     /**
+     * @public
      * <p>The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
      *       encrypt the secret value in the secret. An alias is always prefixed by <code>alias/</code>,
      *       for example <code>alias/aws/secretsmanager</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html">About aliases</a>.</p>
@@ -194,6 +206,7 @@ export interface CreateSecretRequest {
      */
     KmsKeyId?: string;
     /**
+     * @public
      * <p>The binary data to encrypt and store in the new version of
      *       the secret. We recommend that you store your binary data in a file and then pass the
      *       contents of the file as a parameter.</p>
@@ -203,6 +216,7 @@ export interface CreateSecretRequest {
      */
     SecretBinary?: Uint8Array;
     /**
+     * @public
      * <p>The text data to encrypt and store in this new version of
      *       the secret. We recommend you use a JSON structure of key/value pairs for your secret value.</p>
      *          <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but not
@@ -213,6 +227,7 @@ export interface CreateSecretRequest {
      */
     SecretString?: string;
     /**
+     * @public
      * <p>A list of tags to attach to the secret. Each tag
      *       is a key and value pair of strings in a JSON text string, for example:</p>
      *          <p>
@@ -259,10 +274,12 @@ export interface CreateSecretRequest {
      */
     Tags?: Tag[];
     /**
+     * @public
      * <p>A list of Regions and KMS keys to replicate secrets.</p>
      */
     AddReplicaRegions?: ReplicaRegionType[];
     /**
+     * @public
      * <p>Specifies whether to overwrite a secret with the same name in the
      *       destination Region. By default, secrets aren't overwritten.</p>
      */
@@ -287,23 +304,28 @@ export type StatusType = (typeof StatusType)[keyof typeof StatusType];
  */
 export interface ReplicationStatusType {
     /**
+     * @public
      * <p>The Region where replication occurs.</p>
      */
     Region?: string;
     /**
+     * @public
      * <p>Can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>. </p>
      */
     KmsKeyId?: string;
     /**
+     * @public
      * <p>The status can be <code>InProgress</code>, <code>Failed</code>, or <code>InSync</code>.</p>
      */
     Status?: StatusType | string;
     /**
+     * @public
      * <p>Status message such as "<i>Secret with this name already exists in this
      *       region</i>".</p>
      */
     StatusMessage?: string;
     /**
+     * @public
      * <p>The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.</p>
      */
     LastAccessedDate?: Date;
@@ -313,6 +335,7 @@ export interface ReplicationStatusType {
  */
 export interface CreateSecretResponse {
     /**
+     * @public
      * <p>The ARN of the new secret. The ARN includes the name of the secret followed by six random
      *       characters. This ensures that if you create a new secret with the same name as a deleted secret,
      *       then users with access to the old secret don't get access to the new secret because the ARNs
@@ -320,14 +343,17 @@ export interface CreateSecretResponse {
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the new secret.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The unique identifier associated with the version of the new secret.</p>
      */
     VersionId?: string;
     /**
+     * @public
      * <p>A list of the replicas of this secret and their status:</p>
      *          <ul>
      *             <li>
@@ -431,6 +457,7 @@ export declare class ResourceExistsException extends __BaseException {
  */
 export interface DeleteResourcePolicyRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret to delete the attached resource-based policy for.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
@@ -442,10 +469,12 @@ export interface DeleteResourcePolicyRequest {
  */
 export interface DeleteResourcePolicyResponse {
     /**
+     * @public
      * <p>The ARN of the secret that the resource-based policy was deleted for.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret that the resource-based policy was deleted for.</p>
      */
     Name?: string;
@@ -455,18 +484,21 @@ export interface DeleteResourcePolicyResponse {
  */
 export interface DeleteSecretRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret to delete.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the
      *       secret. You can't use both this parameter and <code>ForceDeleteWithoutRecovery</code>
      *       in the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.</p>
      */
     RecoveryWindowInDays?: number;
     /**
+     * @public
      * <p>Specifies whether to delete the secret without any recovery window. You
      *       can't use both this parameter and <code>RecoveryWindowInDays</code> in the same
      *       call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.</p>
@@ -489,14 +521,17 @@ export interface DeleteSecretRequest {
  */
 export interface DeleteSecretResponse {
     /**
+     * @public
      * <p>The ARN of the secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The date and time after which this secret Secrets Manager can permanently delete this secret,
      *       and it can no longer be restored. This value is the date and time of the delete request
      *       plus the number of days in <code>RecoveryWindowInDays</code>.</p>
@@ -508,6 +543,7 @@ export interface DeleteSecretResponse {
  */
 export interface DescribeSecretRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret. </p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
@@ -520,6 +556,7 @@ export interface DescribeSecretRequest {
  */
 export interface RotationRulesType {
     /**
+     * @public
      * <p>The number of days between rotations of the secret. You can use this
      *       value to check that your secret meets your compliance guidelines for how often secrets must
      *       be rotated. If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation
@@ -533,6 +570,7 @@ export interface RotationRulesType {
      */
     AutomaticallyAfterDays?: number;
     /**
+     * @public
      * <p>The length of the rotation window in hours, for example <code>3h</code> for a three
      *       hour window. Secrets Manager rotates your secret at any time during this window. The window must not
      *       extend into the next rotation window or the next UTC day. The window starts according to the <code>ScheduleExpression</code>. If you don't specify a <code>Duration</code>,
@@ -544,6 +582,7 @@ export interface RotationRulesType {
      */
     Duration?: string;
     /**
+     * @public
      * <p>A <code>cron()</code> or <code>rate()</code> expression that defines the schedule for
      *       rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.</p>
      *          <p>Secrets Manager <code>rate()</code> expressions represent the interval in hours or days that you
@@ -570,54 +609,65 @@ export interface RotationRulesType {
  */
 export interface DescribeSecretResponse {
     /**
+     * @public
      * <p>The ARN of the secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The description of the secret.</p>
      */
     Description?: string;
     /**
+     * @public
      * <p>The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
      *       If the secret is encrypted with the Amazon Web Services managed key <code>aws/secretsmanager</code>,
      *       this field is omitted. Secrets created using the console use an KMS key ID.</p>
      */
     KmsKeyId?: string;
     /**
+     * @public
      * <p>Specifies whether automatic rotation is turned on for this secret.</p>
      *          <p>To turn on rotation, use <a>RotateSecret</a>. To turn off
      *       rotation, use <a>CancelRotateSecret</a>.</p>
      */
     RotationEnabled?: boolean;
     /**
+     * @public
      * <p>The ARN of the Lambda function that Secrets Manager invokes to rotate the
      *       secret. </p>
      */
     RotationLambdaARN?: string;
     /**
+     * @public
      * <p>The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but
      *       it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had
      *     rotation turned on, this field is omitted.</p>
      */
     RotationRules?: RotationRulesType;
     /**
+     * @public
      * <p>The last date and time that Secrets Manager rotated the secret.
      *       If the secret isn't configured for rotation, Secrets Manager returns null.</p>
      */
     LastRotatedDate?: Date;
     /**
+     * @public
      * <p>The last date and time that this secret was modified in any way.</p>
      */
     LastChangedDate?: Date;
     /**
+     * @public
      * <p>The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.</p>
      */
     LastAccessedDate?: Date;
     /**
+     * @public
      * <p>The date the secret is scheduled for deletion. If it is not scheduled for deletion, this
      *       field is omitted. When you delete a secret, Secrets Manager requires a
      *       recovery window of at least 7 days before deleting the secret. Some time after the deleted date,
@@ -627,15 +677,18 @@ export interface DescribeSecretResponse {
      */
     DeletedDate?: Date;
     /**
+     * @public
      * <p>The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.</p>
      */
     NextRotationDate?: Date;
     /**
+     * @public
      * <p>The list of tags attached to the secret. To add tags to a
      *       secret, use <a>TagResource</a>. To remove tags, use <a>UntagResource</a>.</p>
      */
     Tags?: Tag[];
     /**
+     * @public
      * <p>A list of the versions of the secret that have staging labels attached.
      *       Versions that don't have staging labels are considered deprecated and Secrets Manager
      *       can delete them.</p>
@@ -664,18 +717,22 @@ export interface DescribeSecretResponse {
      */
     VersionIdsToStages?: Record<string, string[]>;
     /**
+     * @public
      * <p>The ID of the service that created this secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
      */
     OwningService?: string;
     /**
+     * @public
      * <p>The date the secret was created.</p>
      */
     CreatedDate?: Date;
     /**
+     * @public
      * <p>The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in <code>ReplicationStatus</code>. </p>
      */
     PrimaryRegion?: string;
     /**
+     * @public
      * <p>A list of the replicas of this secret and their status: </p>
      *          <ul>
      *             <li>
@@ -717,6 +774,7 @@ export type FilterNameStringType = (typeof FilterNameStringType)[keyof typeof Fi
  */
 export interface Filter {
     /**
+     * @public
      * <p>The following are keys you can use:</p>
      *          <ul>
      *             <li>
@@ -751,6 +809,7 @@ export interface Filter {
      */
     Key?: FilterNameStringType | string;
     /**
+     * @public
      * <p>The keyword to filter for.</p>
      *          <p>You can prefix your search value with an exclamation mark (<code>!</code>) in order to perform negation filters. </p>
      */
@@ -761,41 +820,49 @@ export interface Filter {
  */
 export interface GetRandomPasswordRequest {
     /**
+     * @public
      * <p>The length of the password. If you don't include this parameter, the
      *       default length is 32 characters.</p>
      */
     PasswordLength?: number;
     /**
+     * @public
      * <p>A string of the characters that you don't want in the password.</p>
      */
     ExcludeCharacters?: string;
     /**
+     * @public
      * <p>Specifies whether to exclude numbers from the password. If you don't
      *       include this switch, the password can contain numbers.</p>
      */
     ExcludeNumbers?: boolean;
     /**
+     * @public
      * <p>Specifies whether to exclude the following punctuation characters from the password:
      *       <code>! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` \{ | \} ~</code>.
      *       If you don't include this switch, the password can contain punctuation.</p>
      */
     ExcludePunctuation?: boolean;
     /**
+     * @public
      * <p>Specifies whether to exclude uppercase letters from the password. If you
      *       don't include this switch, the password can contain uppercase letters.</p>
      */
     ExcludeUppercase?: boolean;
     /**
+     * @public
      * <p>Specifies whether to exclude lowercase letters from the password. If
      *       you don't include this switch, the password can contain lowercase letters.</p>
      */
     ExcludeLowercase?: boolean;
     /**
+     * @public
      * <p>Specifies whether to include the space character. If you
      *       include this switch, the password can contain space characters.</p>
      */
     IncludeSpace?: boolean;
     /**
+     * @public
      * <p>Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
      *       If you don't include this switch, the password contains at least one of every character type.</p>
      */
@@ -806,6 +873,7 @@ export interface GetRandomPasswordRequest {
  */
 export interface GetRandomPasswordResponse {
     /**
+     * @public
      * <p>A string with the password.</p>
      */
     RandomPassword?: string;
@@ -815,6 +883,7 @@ export interface GetRandomPasswordResponse {
  */
 export interface GetResourcePolicyRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret to retrieve the attached resource-based policy for.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
@@ -826,14 +895,17 @@ export interface GetResourcePolicyRequest {
  */
 export interface GetResourcePolicyResponse {
     /**
+     * @public
      * <p>The ARN of the secret that the resource-based policy was retrieved for.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret that the resource-based policy was retrieved for.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>A JSON-formatted string that contains the permissions policy
      *       attached to the secret. For more information about permissions policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control for
      *         Secrets Manager</a>.</p>
@@ -845,12 +917,14 @@ export interface GetResourcePolicyResponse {
  */
 export interface GetSecretValueRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret to retrieve.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>The unique identifier of the version of the secret to retrieve. If
      *       you include both this parameter and <code>VersionStage</code>, the two parameters must refer
      *       to the same secret version. If you don't specify either a <code>VersionStage</code> or
@@ -860,6 +934,7 @@ export interface GetSecretValueRequest {
      */
     VersionId?: string;
     /**
+     * @public
      * <p>The staging label of the version of the secret to retrieve. </p>
      *          <p>Secrets Manager uses staging labels to keep track of different versions during the rotation process.
      *       If you include both this parameter and <code>VersionId</code>, the two parameters must refer
@@ -873,18 +948,22 @@ export interface GetSecretValueRequest {
  */
 export interface GetSecretValueResponse {
     /**
+     * @public
      * <p>The ARN of the secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The friendly name of the secret.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The unique identifier of this version of the secret.</p>
      */
     VersionId?: string;
     /**
+     * @public
      * <p>The decrypted secret value, if the secret value was originally provided as
      *       binary data in the form of a byte array. The response parameter represents the binary data as
      *       a <a href="https://tools.ietf.org/html/rfc4648#section-4">base64-encoded</a>
@@ -895,6 +974,7 @@ export interface GetSecretValueResponse {
      */
     SecretBinary?: Uint8Array;
     /**
+     * @public
      * <p>The decrypted secret value, if the secret value was originally provided as a string or
      *       through the Secrets Manager console.</p>
      *          <p>If this secret was created by using the console, then Secrets Manager stores the information as a
@@ -902,11 +982,13 @@ export interface GetSecretValueResponse {
      */
     SecretString?: string;
     /**
+     * @public
      * <p>A list of all of the staging labels currently attached to this version of the
      *       secret.</p>
      */
     VersionStages?: string[];
     /**
+     * @public
      * <p>The date and time that this version of the secret was created. If you don't specify
      *       which version in <code>VersionId</code> or <code>VersionStage</code>, then Secrets Manager uses the
      *       <code>AWSCURRENT</code> version.</p>
@@ -943,10 +1025,12 @@ export type SortOrderType = (typeof SortOrderType)[keyof typeof SortOrderType];
  */
 export interface ListSecretsRequest {
     /**
+     * @public
      * <p>Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.</p>
      */
     IncludePlannedDeletion?: boolean;
     /**
+     * @public
      * <p>The number of results to include in the response.</p>
      *          <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>.
      *       To get the next results, call <code>ListSecrets</code> again with the value from
@@ -954,16 +1038,19 @@ export interface ListSecretsRequest {
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>A token that indicates where the output should continue from, if a
      *       previous call did not show all results. To get the next results, call <code>ListSecrets</code> again
      *       with this value.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <p>The filters to apply to the list of secrets.</p>
      */
     Filters?: Filter[];
     /**
+     * @public
      * <p>Secrets are listed by <code>CreatedDate</code>. </p>
      */
     SortOrder?: SortOrderType | string;
@@ -977,10 +1064,12 @@ export interface ListSecretsRequest {
  */
 export interface SecretListEntry {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The friendly name of the secret. You can use forward slashes in the name to represent a
      *       path hierarchy. For example, <code>/prod/databases/dbserver1</code> could represent the secret
      *       for a server named <code>dbserver1</code> in the folder <code>databases</code> in the folder
@@ -988,19 +1077,23 @@ export interface SecretListEntry {
      */
     Name?: string;
     /**
+     * @public
      * <p>The user-provided description of the secret.</p>
      */
     Description?: string;
     /**
+     * @public
      * <p>The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with
      *       the Amazon Web Services managed key <code>aws/secretsmanager</code>, this field is omitted.</p>
      */
     KmsKeyId?: string;
     /**
+     * @public
      * <p>Indicates whether automatic, scheduled rotation is enabled for this secret.</p>
      */
     RotationEnabled?: boolean;
     /**
+     * @public
      * <p>The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the
      *       secret either automatically per the schedule or manually by a call to <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html">
      *                <code>RotateSecret</code>
@@ -1008,22 +1101,27 @@ export interface SecretListEntry {
      */
     RotationLambdaARN?: string;
     /**
+     * @public
      * <p>A structure that defines the rotation configuration for the secret.</p>
      */
     RotationRules?: RotationRulesType;
     /**
+     * @public
      * <p>The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.</p>
      */
     LastRotatedDate?: Date;
     /**
+     * @public
      * <p>The last date and time that this secret was modified in any way.</p>
      */
     LastChangedDate?: Date;
     /**
+     * @public
      * <p>The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.</p>
      */
     LastAccessedDate?: Date;
     /**
+     * @public
      * <p>The date and time the deletion of the secret occurred. Not present on active secrets. The
      *       secret can be recovered until the number of days in the recovery window has passed, as
      *       specified in the <code>RecoveryWindowInDays</code> parameter of the <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html">
@@ -1032,10 +1130,12 @@ export interface SecretListEntry {
      */
     DeletedDate?: Date;
     /**
+     * @public
      * <p>The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.</p>
      */
     NextRotationDate?: Date;
     /**
+     * @public
      * <p>The list of user-defined tags associated with the secret. To add tags to a
      *       secret, use <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_TagResource.html">
      *                <code>TagResource</code>
@@ -1046,6 +1146,7 @@ export interface SecretListEntry {
      */
     Tags?: Tag[];
     /**
+     * @public
      * <p>A list of all of the currently assigned <code>SecretVersionStage</code> staging labels and
      *       the <code>SecretVersionId</code> attached to each one. Staging labels are used to keep
      *       track of the different versions during the rotation process.</p>
@@ -1056,14 +1157,17 @@ export interface SecretListEntry {
      */
     SecretVersionsToStages?: Record<string, string[]>;
     /**
+     * @public
      * <p>Returns the name of the service that created the secret.</p>
      */
     OwningService?: string;
     /**
+     * @public
      * <p>The date and time when a secret was created.</p>
      */
     CreatedDate?: Date;
     /**
+     * @public
      * <p>The Region where Secrets Manager originated the secret.</p>
      */
     PrimaryRegion?: string;
@@ -1073,10 +1177,12 @@ export interface SecretListEntry {
  */
 export interface ListSecretsResponse {
     /**
+     * @public
      * <p>A list of the secrets in the account.</p>
      */
     SecretList?: SecretListEntry[];
     /**
+     * @public
      * <p>Secrets Manager includes this value if
      *       there's more output available than what is included in the current response. This can
      *       occur even when the response includes no values at all, such as when you ask for a filtered view
@@ -1090,24 +1196,28 @@ export interface ListSecretsResponse {
  */
 export interface ListSecretVersionIdsRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret whose versions you want to list.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>The number of results to include in the response.</p>
      *          <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>.
      *       To get the next results, call <code>ListSecretVersionIds</code> again with the value from <code>NextToken</code>. </p>
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>A token that indicates where the output should continue from, if a previous call
      *       did not show all results. To get the next results, call <code>ListSecretVersionIds</code> again with
      *       this value.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <p>Specifies whether to include versions of secrets that don't have any
      *       staging labels attached to them. Versions without staging labels are considered deprecated and are subject to
      *       deletion by Secrets Manager. By default, versions without staging labels aren't included.</p>
@@ -1120,24 +1230,29 @@ export interface ListSecretVersionIdsRequest {
  */
 export interface SecretVersionsListEntry {
     /**
+     * @public
      * <p>The unique version identifier of this version of the secret.</p>
      */
     VersionId?: string;
     /**
+     * @public
      * <p>An array of staging labels that are currently associated with this version of the
      *       secret.</p>
      */
     VersionStages?: string[];
     /**
+     * @public
      * <p>The date that this version of the secret was last accessed. Note that the resolution of
      *       this field is at the date level and does not include the time.</p>
      */
     LastAccessedDate?: Date;
     /**
+     * @public
      * <p>The date and time this version of the secret was created.</p>
      */
     CreatedDate?: Date;
     /**
+     * @public
      * <p>The KMS keys used to encrypt the secret version.</p>
      */
     KmsKeyIds?: string[];
@@ -1147,10 +1262,12 @@ export interface SecretVersionsListEntry {
  */
 export interface ListSecretVersionIdsResponse {
     /**
+     * @public
      * <p>A list of the versions of the secret.</p>
      */
     Versions?: SecretVersionsListEntry[];
     /**
+     * @public
      * <p>Secrets Manager includes this value if there's more output available than what is included
      *       in the current response. This can occur even when the response includes no values at all,
      *       such as when you ask for a filtered view of a long list. To get the next results,
@@ -1158,10 +1275,12 @@ export interface ListSecretVersionIdsResponse {
      */
     NextToken?: string;
     /**
+     * @public
      * <p>The ARN of the secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret.</p>
      */
     Name?: string;
@@ -1184,18 +1303,21 @@ export declare class PublicPolicyException extends __BaseException {
  */
 export interface PutResourcePolicyRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret to attach the resource-based policy.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>A JSON-formatted string for an Amazon Web Services
      *       resource-based policy. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions
      *         policy examples</a>.</p>
      */
     ResourcePolicy: string | undefined;
     /**
+     * @public
      * <p>Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren't blocked.</p>
      */
     BlockPublicPolicy?: boolean;
@@ -1205,10 +1327,12 @@ export interface PutResourcePolicyRequest {
  */
 export interface PutResourcePolicyResponse {
     /**
+     * @public
      * <p>The ARN of the secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret.</p>
      */
     Name?: string;
@@ -1218,6 +1342,7 @@ export interface PutResourcePolicyResponse {
  */
 export interface PutSecretValueRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret to add a new version to.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
@@ -1225,6 +1350,7 @@ export interface PutSecretValueRequest {
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier for the new version of the secret. </p>
      *          <note>
      *             <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can
@@ -1258,6 +1384,7 @@ export interface PutSecretValueRequest {
      */
     ClientRequestToken?: string;
     /**
+     * @public
      * <p>The binary data to encrypt and store in the new version of
      *       the secret. To use this parameter in the command-line tools, we recommend that you store your
      *       binary data in a file and then pass the
@@ -1267,12 +1394,14 @@ export interface PutSecretValueRequest {
      */
     SecretBinary?: Uint8Array;
     /**
+     * @public
      * <p>The text to encrypt and store in the new version of the secret. </p>
      *          <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
      *          <p>We recommend you create the secret string as JSON key/value pairs, as shown in the example.</p>
      */
     SecretString?: string;
     /**
+     * @public
      * <p>A list of staging labels to attach to this version of the
      *       secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.</p>
      *          <p>If you specify a staging
@@ -1291,18 +1420,22 @@ export interface PutSecretValueRequest {
  */
 export interface PutSecretValueResponse {
     /**
+     * @public
      * <p>The ARN of the secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The unique identifier of the version of the secret.</p>
      */
     VersionId?: string;
     /**
+     * @public
      * <p>The list of staging labels that are currently attached to this version of the secret.
      *       Secrets Manager uses staging labels to track a version as it progresses through the secret rotation
      *       process.</p>
@@ -1314,10 +1447,12 @@ export interface PutSecretValueResponse {
  */
 export interface RemoveRegionsFromReplicationRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret.</p>
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>The Regions of the replicas to remove.</p>
      */
     RemoveReplicaRegions: string[] | undefined;
@@ -1327,10 +1462,12 @@ export interface RemoveRegionsFromReplicationRequest {
  */
 export interface RemoveRegionsFromReplicationResponse {
     /**
+     * @public
      * <p>The ARN of the primary secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The status of replicas for this secret after you remove Regions.</p>
      */
     ReplicationStatus?: ReplicationStatusType[];
@@ -1340,14 +1477,17 @@ export interface RemoveRegionsFromReplicationResponse {
  */
 export interface ReplicateSecretToRegionsRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret to replicate.</p>
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>A list of Regions in which to replicate the secret.</p>
      */
     AddReplicaRegions: ReplicaRegionType[] | undefined;
     /**
+     * @public
      * <p>Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.</p>
      */
     ForceOverwriteReplicaSecret?: boolean;
@@ -1357,10 +1497,12 @@ export interface ReplicateSecretToRegionsRequest {
  */
 export interface ReplicateSecretToRegionsResponse {
     /**
+     * @public
      * <p>The ARN of the primary secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The status of replication.</p>
      */
     ReplicationStatus?: ReplicationStatusType[];
@@ -1370,6 +1512,7 @@ export interface ReplicateSecretToRegionsResponse {
  */
 export interface RestoreSecretRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret to restore.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
@@ -1381,10 +1524,12 @@ export interface RestoreSecretRequest {
  */
 export interface RestoreSecretResponse {
     /**
+     * @public
      * <p>The ARN of the secret that was restored.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret that was restored.</p>
      */
     Name?: string;
@@ -1394,12 +1539,14 @@ export interface RestoreSecretResponse {
  */
 export interface RotateSecretRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret to rotate.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier for the new version of the secret that helps
      *     ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if
      *     there are failures and retries during rotation. This value becomes the
@@ -1416,15 +1563,18 @@ export interface RotateSecretRequest {
      */
     ClientRequestToken?: string;
     /**
+     * @public
      * <p>For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function. </p>
      *          <p>For secrets that use <i>managed rotation</i>, omit this field. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html">Managed rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
      */
     RotationLambdaARN?: string;
     /**
+     * @public
      * <p>A structure that defines the rotation configuration for this secret.</p>
      */
     RotationRules?: RotationRulesType;
     /**
+     * @public
      * <p>Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
      *     The rotation schedule is defined in <a>RotateSecretRequest$RotationRules</a>.</p>
      *          <p>For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the
@@ -1440,14 +1590,17 @@ export interface RotateSecretRequest {
  */
 export interface RotateSecretResponse {
     /**
+     * @public
      * <p>The ARN of the secret.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The ID of the new version of the secret.</p>
      */
     VersionId?: string;
@@ -1457,6 +1610,7 @@ export interface RotateSecretResponse {
  */
 export interface StopReplicationToReplicaRequest {
     /**
+     * @public
      * <p>The ARN of the primary secret. </p>
      */
     SecretId: string | undefined;
@@ -1466,6 +1620,7 @@ export interface StopReplicationToReplicaRequest {
  */
 export interface StopReplicationToReplicaResponse {
     /**
+     * @public
      * <p>The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.</p>
      */
     ARN?: string;
@@ -1475,6 +1630,7 @@ export interface StopReplicationToReplicaResponse {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <p>The identifier for the secret to attach tags to. You can specify either the
      *       Amazon Resource Name (ARN) or the friendly name of the secret.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
@@ -1482,6 +1638,7 @@ export interface TagResourceRequest {
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a <code>Key</code>
      *       and a <code>Value</code>.</p>
      *          <p>For storing multiple values, we recommend that you use a JSON text
@@ -1495,12 +1652,14 @@ export interface TagResourceRequest {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>A list of tag key names to remove from the secret. You don't specify the value. Both the
      *       key and its associated value are removed.</p>
      *          <p>This parameter requires a JSON text string argument.</p>
@@ -1515,12 +1674,14 @@ export interface UntagResourceRequest {
  */
 export interface UpdateSecretRequest {
     /**
+     * @public
      * <p>The ARN or name of the secret.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>If you include <code>SecretString</code> or <code>SecretBinary</code>, then Secrets Manager creates
      *     a new version for the secret, and this parameter specifies the unique identifier for the new
      *     version.</p>
@@ -1536,10 +1697,12 @@ export interface UpdateSecretRequest {
      */
     ClientRequestToken?: string;
     /**
+     * @public
      * <p>The description of the secret.</p>
      */
     Description?: string;
     /**
+     * @public
      * <p>The ARN, key ID, or alias of the KMS key that Secrets Manager
      *       uses to encrypt new secret versions as well as any existing versions with the staging labels
      *       <code>AWSCURRENT</code>, <code>AWSPENDING</code>, or <code>AWSPREVIOUS</code>. If you don't have <code>kms:Encrypt</code> permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information about versions and staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">Concepts: Version</a>.</p>
@@ -1560,6 +1723,7 @@ export interface UpdateSecretRequest {
      */
     KmsKeyId?: string;
     /**
+     * @public
      * <p>The binary data to encrypt and store in the new
      *       version of the secret. We recommend that you
      *       store your binary data in a file and then pass
@@ -1570,6 +1734,7 @@ export interface UpdateSecretRequest {
      */
     SecretBinary?: Uint8Array;
     /**
+     * @public
      * <p>The text data to encrypt and store in the new
      *       version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value. </p>
      *          <p>Either <code>SecretBinary</code> or <code>SecretString</code> must have
@@ -1582,14 +1747,17 @@ export interface UpdateSecretRequest {
  */
 export interface UpdateSecretResponse {
     /**
+     * @public
      * <p>The ARN of the secret that was updated.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret that was updated.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>If Secrets Manager created a new version of the secret during this operation, then <code>VersionId</code>
      *       contains the unique identifier of the new version.</p>
      */
@@ -1600,16 +1768,19 @@ export interface UpdateSecretResponse {
  */
 export interface UpdateSecretVersionStageRequest {
     /**
+     * @public
      * <p>The ARN or the name of the secret with the version and staging labelsto modify.</p>
      *          <p>For an ARN, we recommend that you specify a complete ARN rather
      *       than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
      */
     SecretId: string | undefined;
     /**
+     * @public
      * <p>The staging label to add to this version.</p>
      */
     VersionStage: string | undefined;
     /**
+     * @public
      * <p>The ID of the version that the staging label is to be removed
      *       from. If the staging label you are trying to attach to one version is already attached to a
      *       different version, then you must include this parameter and specify the version that the label
@@ -1618,6 +1789,7 @@ export interface UpdateSecretVersionStageRequest {
      */
     RemoveFromVersionId?: string;
     /**
+     * @public
      * <p>The ID of the version to add the staging label to. To
      *       remove a label from a version, then do not specify this parameter.</p>
      *          <p>If the staging label is already attached to a different version of the secret, then you
@@ -1630,10 +1802,12 @@ export interface UpdateSecretVersionStageRequest {
  */
 export interface UpdateSecretVersionStageResponse {
     /**
+     * @public
      * <p>The ARN of the secret that was updated.</p>
      */
     ARN?: string;
     /**
+     * @public
      * <p>The name of the secret that was updated.</p>
      */
     Name?: string;
@@ -1643,10 +1817,12 @@ export interface UpdateSecretVersionStageResponse {
  */
 export interface ValidateResourcePolicyRequest {
     /**
+     * @public
      * <p>This field is reserved for internal use.</p>
      */
     SecretId?: string;
     /**
+     * @public
      * <p>A JSON-formatted string that contains an Amazon Web Services
      *       resource-based policy. The policy in the string identifies who can access or manage this
      *       secret and its versions. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions policy examples</a>.</p>
@@ -1659,10 +1835,12 @@ export interface ValidateResourcePolicyRequest {
  */
 export interface ValidationErrorsEntry {
     /**
+     * @public
      * <p>Checks the name of the policy.</p>
      */
     CheckName?: string;
     /**
+     * @public
      * <p>Displays error messages if validation encounters problems during validation of the resource policy.</p>
      */
     ErrorMessage?: string;
@@ -1672,10 +1850,12 @@ export interface ValidationErrorsEntry {
  */
 export interface ValidateResourcePolicyResponse {
     /**
+     * @public
      * <p>True if your policy passes validation, otherwise false.</p>
      */
     PolicyValidationPassed?: boolean;
     /**
+     * @public
      * <p>Validation errors if your policy didn't pass validation.</p>
      */
     ValidationErrors?: ValidationErrorsEntry[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-secrets-manager",
   "description": "AWS SDK for JavaScript Secrets Manager Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",