AmazonSecretsManagerClient.GetRandomPassword Method (GetRandomPasswordRequest)

Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~

Secrets Manager generates a CloudTrail log entry when you call this action.

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

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetRandomPasswordAsync.

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

Syntax

public virtual GetRandomPasswordResponse GetRandomPassword(
         GetRandomPasswordRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.GetRandomPasswordRequest

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

Return Value

Type: GetRandomPasswordResponse

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

Exceptions

Exception	Condition
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.

Examples

The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters.

To generate a random password


var client = new AmazonSecretsManagerClient();
var response = client.GetRandomPassword(new GetRandomPasswordRequest 
{
    IncludeSpace = true,
    PasswordLength = 20,
    RequireEachIncludedType = true
});

string randomPassword = response.RandomPassword;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonSecretsManagerClient.GetRandomPassword (GetRandomPasswordRequest)

Method