@depup/aws-sdk__client-secrets-manager 3.1010.0-depup.0

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

@@ -0,0 +1,161 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ValidateResourcePolicyRequest, ValidateResourcePolicyResponse } from "../models/models_0";
+import type { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ValidateResourcePolicyCommand}.
+ */
+export interface ValidateResourcePolicyCommandInput extends ValidateResourcePolicyRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ValidateResourcePolicyCommand}.
+ */
+export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePolicyResponse, __MetadataBearer {
+}
+declare const ValidateResourcePolicyCommand_base: {
+    new (input: ValidateResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ValidateResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Validates that a resource policy does not grant a wide range of principals access to
+ *             your secret. A resource-based policy is optional for secrets.</p>
+ *          <p>The API performs three checks when validating the policy:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Sends a call to <a href="https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/">Zelkova</a>, an automated reasoning engine, to ensure your resource
+ *                     policy does not allow broad access to your secret, for example policies that use
+ *                     a wildcard for the principal.</p>
+ *             </li>
+ *             <li>
+ *                <p>Checks for correct syntax in a policy.</p>
+ *             </li>
+ *             <li>
+ *                <p>Verifies the policy does not lock out a caller.</p>
+ *             </li>
+ *          </ul>
+ *          <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>
+ *             <b>Required permissions:
+ *                 </b>
+ *             <code>secretsmanager:ValidateResourcePolicy</code> and
+ *                 <code>secretsmanager:PutResourcePolicy</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
+ *       IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
+ *       and access control in Secrets Manager</a>. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SecretsManagerClient, ValidateResourcePolicyCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
+ * // const { SecretsManagerClient, ValidateResourcePolicyCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
+ * // import type { SecretsManagerClientConfig } from "@aws-sdk/client-secrets-manager";
+ * const config = {}; // type is SecretsManagerClientConfig
+ * const client = new SecretsManagerClient(config);
+ * const input = { // ValidateResourcePolicyRequest
+ *   SecretId: "STRING_VALUE",
+ *   ResourcePolicy: "STRING_VALUE", // required
+ * };
+ * const command = new ValidateResourcePolicyCommand(input);
+ * const response = await client.send(command);
+ * // { // ValidateResourcePolicyResponse
+ * //   PolicyValidationPassed: true || false,
+ * //   ValidationErrors: [ // ValidationErrorsType
+ * //     { // ValidationErrorsEntry
+ * //       CheckName: "STRING_VALUE",
+ * //       ErrorMessage: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ValidateResourcePolicyCommandInput - {@link ValidateResourcePolicyCommandInput}
+ * @returns {@link ValidateResourcePolicyCommandOutput}
+ * @see {@link ValidateResourcePolicyCommandInput} for command's `input` shape.
+ * @see {@link ValidateResourcePolicyCommandOutput} for command's `response` shape.
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>An error occurred on the server side.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>The parameter name or value is invalid.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>A parameter value is not valid for the current state of the
+ *       resource.</p>
+ *          <p>Possible causes:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The secret is scheduled for deletion.</p>
+ *             </li>
+ *             <li>
+ *                <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
+ *           ARN configured and you didn't include such an ARN as a parameter in this call. </p>
+ *             </li>
+ *             <li>
+ *                <p>The secret is managed by another service, and you must use that service to update it.
+ *           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>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link MalformedPolicyDocumentException} (client fault)
+ *  <p>The resource policy has syntax errors.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Secrets Manager can't find the resource that you asked for.</p>
+ *
+ * @throws {@link SecretsManagerServiceException}
+ * <p>Base exception class for all service exceptions from SecretsManager service.</p>
+ *
+ *
+ * @example To validate a resource-based policy to a secret
+ * ```javascript
+ * // The following example shows how to validate a resource-based policy to a secret.
+ * const input = {
+ *   ResourcePolicy: `{
+ * "Version":"2012-10-17",
+ * "Statement":[{
+ * "Effect":"Allow",
+ * "Principal":{
+ * "AWS":"arn:aws:iam::123456789012:root"
+ * },
+ * "Action":"secretsmanager:GetSecretValue",
+ * "Resource":"*"
+ * }]
+ * }`,
+ *   SecretId: "MyTestDatabaseSecret"
+ * };
+ * const command = new ValidateResourcePolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   PolicyValidationPassed: true,
+ *   ValidationErrors:   []
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ValidateResourcePolicyCommand extends ValidateResourcePolicyCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ValidateResourcePolicyRequest;
+            output: ValidateResourcePolicyResponse;
+        };
+        sdk: {
+            input: ValidateResourcePolicyCommandInput;
+            output: ValidateResourcePolicyCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,23 @@
+export * from "./BatchGetSecretValueCommand";
+export * from "./CancelRotateSecretCommand";
+export * from "./CreateSecretCommand";
+export * from "./DeleteResourcePolicyCommand";
+export * from "./DeleteSecretCommand";
+export * from "./DescribeSecretCommand";
+export * from "./GetRandomPasswordCommand";
+export * from "./GetResourcePolicyCommand";
+export * from "./GetSecretValueCommand";
+export * from "./ListSecretVersionIdsCommand";
+export * from "./ListSecretsCommand";
+export * from "./PutResourcePolicyCommand";
+export * from "./PutSecretValueCommand";
+export * from "./RemoveRegionsFromReplicationCommand";
+export * from "./ReplicateSecretToRegionsCommand";
+export * from "./RestoreSecretCommand";
+export * from "./RotateSecretCommand";
+export * from "./StopReplicationToReplicaCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateSecretCommand";
+export * from "./UpdateSecretVersionStageCommand";
+export * from "./ValidateResourcePolicyCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,50 @@
+import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    region?: string | undefined | Provider<string | undefined>;
+    useDualstackEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+    useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+/**
+ * @public
+ */
+export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
+    defaultSigningName: string;
+};
+/**
+ * @internal
+ */
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
+/**
+ * @internal
+ */
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+    readonly UseDualStack: {
+        readonly type: "builtInParams";
+        readonly name: "useDualstackEndpoint";
+    };
+};
+/**
+ * @internal
+ */
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string | undefined;
+    UseDualStack?: boolean | undefined;
+    UseFIPS?: boolean | undefined;
+    Endpoint?: string | undefined;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,8 @@
+import type { EndpointV2, Logger } from "@smithy/types";
+import type { EndpointParameters } from "./EndpointParameters";
+/**
+ * @internal
+ */
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import type { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import type { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import type { DefaultExtensionConfiguration } from "@smithy/types";
+import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface SecretsManagerExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,42 @@
+/**
+ * <fullname>Amazon Web Services Secrets Manager</fullname>
+ *          <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
+ *          <p>This guide provides descriptions of the Secrets Manager API. For more information about using this
+ *       service, see the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html">Amazon Web Services Secrets Manager User Guide</a>.</p>
+ *          <p>
+ *             <b>API Version</b>
+ *          </p>
+ *          <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
+ *          <p>For a list of endpoints, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints">Amazon Web Services Secrets Manager
+ *       endpoints</a>.</p>
+ *          <p>
+ *             <b>Support and Feedback for Amazon Web Services Secrets Manager</b>
+ *          </p>
+ *          <p>We welcome your feedback. Send your comments to <a href="mailto:awssecretsmanager-feedback@amazon.com">awssecretsmanager-feedback@amazon.com</a>, or post your feedback and questions in the <a href="http://forums.aws.amazon.com/forum.jspa?forumID=296">Amazon Web Services Secrets Manager Discussion Forum</a>. For more
+ *       information about the Amazon Web Services Discussion Forums, see <a href="http://forums.aws.amazon.com/help.jspa">Forums
+ *         Help</a>.</p>
+ *          <p>
+ *             <b>Logging API Requests</b>
+ *          </p>
+ *          <p>Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services
+ *       account and delivers log files to an Amazon S3 bucket. By using information that's collected
+ *       by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the
+ *       request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services
+ *       CloudTrail, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail">Logging
+ *         Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.
+ *       To learn more about CloudTrail, including enabling it and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">Amazon Web Services CloudTrail User Guide</a>.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./SecretsManagerClient";
+export * from "./SecretsManager";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { SecretsManagerExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./schemas/schemas_0";
+export * from "./pagination";
+export * from "./models/enums";
+export * from "./models/errors";
+export * from "./models/models_0";
+export { SecretsManagerServiceException } from "./models/SecretsManagerServiceException";

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

@@ -0,0 +1,14 @@
+import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/smithy-client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from SecretsManager service.
+ */
+export declare class SecretsManagerServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1,56 @@
+/**
+ * @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
+ * @enum
+ */
+export declare const StatusType: {
+    readonly Failed: "Failed";
+    readonly InProgress: "InProgress";
+    readonly InSync: "InSync";
+};
+/**
+ * @public
+ */
+export type StatusType = (typeof StatusType)[keyof typeof StatusType];
+/**
+ * @public
+ * @enum
+ */
+export declare const SortByType: {
+    readonly created_date: "created-date";
+    readonly last_accessed_date: "last-accessed-date";
+    readonly last_changed_date: "last-changed-date";
+    readonly name: "name";
+};
+/**
+ * @public
+ */
+export type SortByType = (typeof SortByType)[keyof typeof SortByType];
+/**
+ * @public
+ * @enum
+ */
+export declare const SortOrderType: {
+    readonly asc: "asc";
+    readonly desc: "desc";
+};
+/**
+ * @public
+ */
+export type SortOrderType = (typeof SortOrderType)[keyof typeof SortOrderType];

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

@@ -0,0 +1,175 @@
+import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { SecretsManagerServiceException as __BaseException } from "./SecretsManagerServiceException";
+/**
+ * <p>Secrets Manager can't decrypt the protected secret text using the provided KMS key. </p>
+ * @public
+ */
+export declare class DecryptionFailure extends __BaseException {
+    readonly name: "DecryptionFailure";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<DecryptionFailure, __BaseException>);
+}
+/**
+ * <p>An error occurred on the server side.</p>
+ * @public
+ */
+export declare class InternalServiceError extends __BaseException {
+    readonly name: "InternalServiceError";
+    readonly $fault: "server";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
+}
+/**
+ * <p>The <code>NextToken</code> value is invalid.</p>
+ * @public
+ */
+export declare class InvalidNextTokenException extends __BaseException {
+    readonly name: "InvalidNextTokenException";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
+}
+/**
+ * <p>The parameter name or value is invalid.</p>
+ * @public
+ */
+export declare class InvalidParameterException extends __BaseException {
+    readonly name: "InvalidParameterException";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
+}
+/**
+ * <p>A parameter value is not valid for the current state of the
+ *       resource.</p>
+ *          <p>Possible causes:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The secret is scheduled for deletion.</p>
+ *             </li>
+ *             <li>
+ *                <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
+ *           ARN configured and you didn't include such an ARN as a parameter in this call. </p>
+ *             </li>
+ *             <li>
+ *                <p>The secret is managed by another service, and you must use that service to update it.
+ *           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>
+ *             </li>
+ *          </ul>
+ * @public
+ */
+export declare class InvalidRequestException extends __BaseException {
+    readonly name: "InvalidRequestException";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
+}
+/**
+ * <p>Secrets Manager can't find the resource that you asked for.</p>
+ * @public
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+/**
+ * <p>Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the
+ *       KMS key is available, enabled, and not in an invalid state. For more
+ *       information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a>.</p>
+ * @public
+ */
+export declare class EncryptionFailure extends __BaseException {
+    readonly name: "EncryptionFailure";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<EncryptionFailure, __BaseException>);
+}
+/**
+ * <p>The request failed because it would exceed one of the Secrets Manager quotas.</p>
+ * @public
+ */
+export declare class LimitExceededException extends __BaseException {
+    readonly name: "LimitExceededException";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
+}
+/**
+ * <p>The resource policy has syntax errors.</p>
+ * @public
+ */
+export declare class MalformedPolicyDocumentException extends __BaseException {
+    readonly name: "MalformedPolicyDocumentException";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
+}
+/**
+ * <p>The request failed because you did not complete all the prerequisite steps.</p>
+ * @public
+ */
+export declare class PreconditionNotMetException extends __BaseException {
+    readonly name: "PreconditionNotMetException";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<PreconditionNotMetException, __BaseException>);
+}
+/**
+ * <p>A resource with the ID you requested already exists.</p>
+ * @public
+ */
+export declare class ResourceExistsException extends __BaseException {
+    readonly name: "ResourceExistsException";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceExistsException, __BaseException>);
+}
+/**
+ * <p>The <code>BlockPublicPolicy</code> parameter is set to true, and the resource policy did not prevent broad access to the secret.</p>
+ * @public
+ */
+export declare class PublicPolicyException extends __BaseException {
+    readonly name: "PublicPolicyException";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<PublicPolicyException, __BaseException>);
+}