@aws-sdk/client-secrets-manager 3.451.0 → 3.458.0

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

@@ -18,39 +18,201 @@ export interface ReplicaRegionType {
 }
 /**
  * @public
+ * <p>The error Secrets Manager encountered while retrieving an individual secret as part of <a>BatchGetSecretValue</a>.</p>
  */
-export interface CancelRotateSecretRequest {
+export interface APIErrorType {
     /**
      * @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;
+    SecretId?: string;
+    /**
+     * @public
+     * <p>The error Secrets Manager encountered while retrieving an individual secret as part of <a>BatchGetSecretValue</a>, for example <code>ResourceNotFoundException</code>,<code>InvalidParameterException</code>, <code>InvalidRequestException</code>, <code>DecryptionFailure</code>, or <code>AccessDeniedException</code>.</p>
+     */
+    ErrorCode?: string;
+    /**
+     * @public
+     * <p>A message describing the error.</p>
+     */
+    Message?: string;
 }
 /**
  * @public
+ * @enum
  */
-export interface CancelRotateSecretResponse {
+export declare const FilterNameStringType: {
+    readonly all: "all";
+    readonly description: "description";
+    readonly name: "name";
+    readonly owning_service: "owning-service";
+    readonly primary_region: "primary-region";
+    readonly tag_key: "tag-key";
+    readonly tag_value: "tag-value";
+};
+/**
+ * @public
+ */
+export type FilterNameStringType = (typeof FilterNameStringType)[keyof typeof FilterNameStringType];
+/**
+ * @public
+ * <p>Allows you to add filters when you use the search function in Secrets Manager. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Find secrets in Secrets Manager</a>.</p>
+ */
+export interface Filter {
     /**
      * @public
-     * <p>The ARN of the secret.</p>
+     * <p>The following are keys you can use:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <b>description</b>: Prefix match, not case-sensitive.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>name</b>: Prefix match, case-sensitive.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>tag-key</b>: Prefix match, case-sensitive.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>tag-value</b>: Prefix match, case-sensitive.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>primary-region</b>: Prefix match, case-sensitive.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>owning-service</b>: Prefix match, case-sensitive.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>all</b>: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.</p>
+     *             </li>
+     *          </ul>
+     */
+    Key?: FilterNameStringType;
+    /**
+     * @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>
+     */
+    Values?: string[];
+}
+/**
+ * @public
+ */
+export interface BatchGetSecretValueRequest {
+    /**
+     * @public
+     * <p>The ARN or names of the secrets to retrieve. You must include <code>Filters</code> or <code>SecretIdList</code>, but not both.</p>
+     */
+    SecretIdList?: string[];
+    /**
+     * @public
+     * <p>The filters to choose which secrets to retrieve. You must include <code>Filters</code> or <code>SecretIdList</code>, but not both.</p>
+     */
+    Filters?: Filter[];
+    /**
+     * @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>BatchGetSecretValue</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>BatchGetSecretValue</code> again
+     *     with this value.</p>
+     */
+    NextToken?: string;
+}
+/**
+ * @public
+ * <p>A structure that contains the secret value and other details for a secret.</p>
+ */
+export interface SecretValueEntry {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the secret.</p>
      */
     ARN?: string;
     /**
      * @public
-     * <p>The name of the secret.</p>
+     * <p>The friendly 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
-     *       Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from
-     *       starting future rotations.</p>
+     * <p>The unique version 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 parameter represents the binary data as
+     *       a <a href="https://tools.ietf.org/html/rfc4648#section-4">base64-encoded</a>
+     *       string.</p>
+     */
+    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>
+     */
+    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 the secret was created.</p>
+     */
+    CreatedDate?: Date;
+}
+/**
+ * @public
+ */
+export interface BatchGetSecretValueResponse {
+    /**
+     * @public
+     * <p>A list of secret values.</p>
+     */
+    SecretValues?: SecretValueEntry[];
+    /**
+     * @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, call <code>BatchGetSecretValue</code> again
+     *     with this value.</p>
+     */
+    NextToken?: string;
+    /**
+     * @public
+     * <p>A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.</p>
+     */
+    Errors?: APIErrorType[];
+}
+/**
+ * @public
+ * <p>Secrets Manager can't decrypt the protected secret text using the provided KMS key. </p>
+ */
+export declare class DecryptionFailure extends __BaseException {
+    readonly name: "DecryptionFailure";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<DecryptionFailure, __BaseException>);
 }
 /**
  * @public
@@ -65,6 +227,19 @@ export declare class InternalServiceError extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
 }
+/**
+ * @public
+ * <p>The <code>NextToken</code> value is invalid.</p>
+ */
+export declare class InvalidNextTokenException extends __BaseException {
+    readonly name: "InvalidNextTokenException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
+}
 /**
  * @public
  * <p>The parameter name or value is invalid.</p>
@@ -119,6 +294,42 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
+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>
+     */
+    SecretId: string | undefined;
+}
+/**
+ * @public
+ */
+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
+     *       Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from
+     *       starting future rotations.</p>
+     */
+    VersionId?: string;
+}
 /**
  * @public
  * <p>A structure that contains information about a tag.</p>
@@ -341,19 +552,6 @@ export interface CreateSecretResponse {
      */
     ReplicationStatus?: ReplicationStatusType[];
 }
-/**
- * @public
- * <p>Secrets Manager can't decrypt the protected secret text using the provided KMS key. </p>
- */
-export declare class DecryptionFailure extends __BaseException {
-    readonly name: "DecryptionFailure";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<DecryptionFailure, __BaseException>);
-}
 /**
  * @public
  * <p>Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the
@@ -720,70 +918,6 @@ export interface DescribeSecretResponse {
      */
     ReplicationStatus?: ReplicationStatusType[];
 }
-/**
- * @public
- * @enum
- */
-export declare const FilterNameStringType: {
-    readonly all: "all";
-    readonly description: "description";
-    readonly name: "name";
-    readonly owning_service: "owning-service";
-    readonly primary_region: "primary-region";
-    readonly tag_key: "tag-key";
-    readonly tag_value: "tag-value";
-};
-/**
- * @public
- */
-export type FilterNameStringType = (typeof FilterNameStringType)[keyof typeof FilterNameStringType];
-/**
- * @public
- * <p>Allows you to add filters when you use the search function in Secrets Manager. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Find secrets in Secrets Manager</a>.</p>
- */
-export interface Filter {
-    /**
-     * @public
-     * <p>The following are keys you can use:</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <b>description</b>: Prefix match, not case-sensitive.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <b>name</b>: Prefix match, case-sensitive.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <b>tag-key</b>: Prefix match, case-sensitive.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <b>tag-value</b>: Prefix match, case-sensitive.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <b>primary-region</b>: Prefix match, case-sensitive.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <b>owning-service</b>: Prefix match, case-sensitive.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <b>all</b>: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.</p>
-     *             </li>
-     *          </ul>
-     */
-    Key?: FilterNameStringType;
-    /**
-     * @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>
-     */
-    Values?: string[];
-}
 /**
  * @public
  */
@@ -964,19 +1098,6 @@ export interface GetSecretValueResponse {
      */
     CreatedDate?: Date;
 }
-/**
- * @public
- * <p>The <code>NextToken</code> value is invalid.</p>
- */
-export declare class InvalidNextTokenException extends __BaseException {
-    readonly name: "InvalidNextTokenException";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
-}
 /**
  * @public
  * @enum
@@ -1039,10 +1160,7 @@ export interface SecretListEntry {
     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
-     *       <code>prod</code>. </p>
+     * <p>The friendly name of the secret.  </p>
      */
     Name?: string;
     /**
@@ -1813,6 +1931,14 @@ export interface ValidateResourcePolicyResponse {
      */
     ValidationErrors?: ValidationErrorsEntry[];
 }
+/**
+ * @internal
+ */
+export declare const SecretValueEntryFilterSensitiveLog: (obj: SecretValueEntry) => any;
+/**
+ * @internal
+ */
+export declare const BatchGetSecretValueResponseFilterSensitiveLog: (obj: BatchGetSecretValueResponse) => any;
 /**
  * @internal
  */

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

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { BatchGetSecretValueCommandInput, BatchGetSecretValueCommandOutput } from "../commands/BatchGetSecretValueCommand";
+import { SecretsManagerPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare function paginateBatchGetSecretValue(config: SecretsManagerPaginationConfiguration, input: BatchGetSecretValueCommandInput, ...additionalArguments: any): Paginator<BatchGetSecretValueCommandOutput>;

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

@@ -1,3 +1,4 @@
+export * from "./BatchGetSecretValuePaginator";
 export * from "./Interfaces";
 export * from "./ListSecretVersionIdsPaginator";
 export * from "./ListSecretsPaginator";

package/dist-types/protocols/Aws_json1_1.d.ts

@@ -1,5 +1,6 @@
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
+import { BatchGetSecretValueCommandInput, BatchGetSecretValueCommandOutput } from "../commands/BatchGetSecretValueCommand";
 import { CancelRotateSecretCommandInput, CancelRotateSecretCommandOutput } from "../commands/CancelRotateSecretCommand";
 import { CreateSecretCommandInput, CreateSecretCommandOutput } from "../commands/CreateSecretCommand";
 import { DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput } from "../commands/DeleteResourcePolicyCommand";
@@ -22,6 +23,10 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../comman
 import { UpdateSecretCommandInput, UpdateSecretCommandOutput } from "../commands/UpdateSecretCommand";
 import { UpdateSecretVersionStageCommandInput, UpdateSecretVersionStageCommandOutput } from "../commands/UpdateSecretVersionStageCommand";
 import { ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput } from "../commands/ValidateResourcePolicyCommand";
+/**
+ * serializeAws_json1_1BatchGetSecretValueCommand
+ */
+export declare const se_BatchGetSecretValueCommand: (input: BatchGetSecretValueCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_json1_1CancelRotateSecretCommand
  */
@@ -110,6 +115,10 @@ export declare const se_UpdateSecretVersionStageCommand: (input: UpdateSecretVer
  * serializeAws_json1_1ValidateResourcePolicyCommand
  */
 export declare const se_ValidateResourcePolicyCommand: (input: ValidateResourcePolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * deserializeAws_json1_1BatchGetSecretValueCommand
+ */
+export declare const de_BatchGetSecretValueCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<BatchGetSecretValueCommandOutput>;
 /**
  * deserializeAws_json1_1CancelRotateSecretCommand
  */

package/dist-types/ts3.4/SecretsManager.d.ts

@@ -1,4 +1,8 @@
 import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
+import {
+  BatchGetSecretValueCommandInput,
+  BatchGetSecretValueCommandOutput,
+} from "./commands/BatchGetSecretValueCommand";
 import {
   CancelRotateSecretCommandInput,
   CancelRotateSecretCommandOutput,
@@ -89,6 +93,19 @@ import {
 } from "./commands/ValidateResourcePolicyCommand";
 import { SecretsManagerClient } from "./SecretsManagerClient";
 export interface SecretsManager {
+  batchGetSecretValue(
+    args: BatchGetSecretValueCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<BatchGetSecretValueCommandOutput>;
+  batchGetSecretValue(
+    args: BatchGetSecretValueCommandInput,
+    cb: (err: any, data?: BatchGetSecretValueCommandOutput) => void
+  ): void;
+  batchGetSecretValue(
+    args: BatchGetSecretValueCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: BatchGetSecretValueCommandOutput) => void
+  ): void;
   cancelRotateSecret(
     args: CancelRotateSecretCommandInput,
     options?: __HttpHandlerOptions

package/dist-types/ts3.4/SecretsManagerClient.d.ts

@@ -45,6 +45,10 @@ import {
   UrlParser as __UrlParser,
   UserAgent as __UserAgent,
 } from "@smithy/types";
+import {
+  BatchGetSecretValueCommandInput,
+  BatchGetSecretValueCommandOutput,
+} from "./commands/BatchGetSecretValueCommand";
 import {
   CancelRotateSecretCommandInput,
   CancelRotateSecretCommandOutput,
@@ -141,6 +145,7 @@ import {
 import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
 export { __Client };
 export type ServiceInputTypes =
+  | BatchGetSecretValueCommandInput
   | CancelRotateSecretCommandInput
   | CreateSecretCommandInput
   | DeleteResourcePolicyCommandInput
@@ -164,6 +169,7 @@ export type ServiceInputTypes =
   | UpdateSecretVersionStageCommandInput
   | ValidateResourcePolicyCommandInput;
 export type ServiceOutputTypes =
+  | BatchGetSecretValueCommandOutput
   | CancelRotateSecretCommandOutput
   | CreateSecretCommandOutput
   | DeleteResourcePolicyCommandOutput

package/dist-types/ts3.4/commands/BatchGetSecretValueCommand.d.ts

@@ -0,0 +1,39 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import {
+  Handler,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@smithy/types";
+import {
+  BatchGetSecretValueRequest,
+  BatchGetSecretValueResponse,
+} from "../models/models_0";
+import {
+  SecretsManagerClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../SecretsManagerClient";
+export { __MetadataBearer, $Command };
+export interface BatchGetSecretValueCommandInput
+  extends BatchGetSecretValueRequest {}
+export interface BatchGetSecretValueCommandOutput
+  extends BatchGetSecretValueResponse,
+    __MetadataBearer {}
+export declare class BatchGetSecretValueCommand extends $Command<
+  BatchGetSecretValueCommandInput,
+  BatchGetSecretValueCommandOutput,
+  SecretsManagerClientResolvedConfig
+> {
+  readonly input: BatchGetSecretValueCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: BatchGetSecretValueCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: SecretsManagerClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<BatchGetSecretValueCommandInput, BatchGetSecretValueCommandOutput>;
+  private serialize;
+  private deserialize;
+}

package/dist-types/ts3.4/commands/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./BatchGetSecretValueCommand";
 export * from "./CancelRotateSecretCommand";
 export * from "./CreateSecretCommand";
 export * from "./DeleteResourcePolicyCommand";