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; new (input: ValidateResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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.

*

The API performs three checks when validating the policy:

* *

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 Logging Secrets Manager events with CloudTrail.

*

* Required permissions: * * secretsmanager:ValidateResourcePolicy and * secretsmanager:PutResourcePolicy. For more information, see * IAM policy actions for Secrets Manager and Authentication * and access control in Secrets Manager.

* @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) *

An error occurred on the server side.

* * @throws {@link InvalidParameterException} (client fault) *

The parameter name or value is invalid.

* * @throws {@link InvalidRequestException} (client fault) *

A parameter value is not valid for the current state of the * resource.

*

Possible causes:

* * * @throws {@link MalformedPolicyDocumentException} (client fault) *

The resource policy has syntax errors.

* * @throws {@link ResourceNotFoundException} (client fault) *

Secrets Manager can't find the resource that you asked for.

* * @throws {@link SecretsManagerServiceException} *

Base exception class for all service exceptions from SecretsManager service.

* * * @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; }; }; }