AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginValidateResourcePolicy and EndValidateResourcePolicy.

Namespace: Amazon.SecretsManager
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<ValidateResourcePolicyResponse> ValidateResourcePolicyAsync(
         ValidateResourcePolicyRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.SecretsManager.Model.ValidateResourcePolicyRequest

Container for the necessary parameters to execute the ValidateResourcePolicy service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ValidateResourcePolicy service method, as returned by SecretsManager.

Exceptions

ExceptionCondition
InternalServiceErrorException An error occurred on the server side.
InvalidParameterException The parameter name or value is invalid.
InvalidRequestException A parameter value is not valid for the current state of the resource. Possible causes: The secret is scheduled for deletion. 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. The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.
MalformedPolicyDocumentException The resource policy has syntax errors.
ResourceNotFoundException Secrets Manager can't find the resource that you asked for.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also