Amazonka.SecretsManager.GetRandomPassword

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.

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:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Creating a Request

data GetRandomPassword

See: newGetRandomPassword smart constructor.

Constructors

GetRandomPassword'

Fields

• excludeCharacters :: Maybe Text

  A string of the characters that you don't want in the password.

• excludeLowercase :: Maybe Bool

  Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

• excludeNumbers :: Maybe Bool

  Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

• excludePunctuation :: Maybe Bool

  Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.

• excludeUppercase :: Maybe Bool

  Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

• includeSpace :: Maybe Bool

  Specifies whether to include the space character. If you include this switch, the password can contain space characters.

• passwordLength :: Maybe Natural

  The length of the password. If you don't include this parameter, the default length is 32 characters.

• requireEachIncludedType :: Maybe Bool

  Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.

Instances

ToJSON GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

toJSON :: GetRandomPassword -> Value

toEncoding :: GetRandomPassword -> Encoding

toJSONList :: [GetRandomPassword] -> Value

toEncodingList :: [GetRandomPassword] -> Encoding

ToHeaders GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

toHeaders :: GetRandomPassword -> [Header]

ToPath GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

toPath :: GetRandomPassword -> ByteString

ToQuery GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

toQuery :: GetRandomPassword -> QueryString

AWSRequest GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Associated Types

type AWSResponse GetRandomPassword

Methods

request :: (Service -> Service) -> GetRandomPassword -> Request GetRandomPassword

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRandomPassword -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRandomPassword)))

Generic GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Associated Types

type Rep GetRandomPassword :: Type -> Type

Methods

from :: GetRandomPassword -> Rep GetRandomPassword x

to :: Rep GetRandomPassword x -> GetRandomPassword

Read GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

readsPrec :: Int -> ReadS GetRandomPassword

readList :: ReadS [GetRandomPassword]

readPrec :: ReadPrec GetRandomPassword

readListPrec :: ReadPrec [GetRandomPassword]

Show GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

showsPrec :: Int -> GetRandomPassword -> ShowS

show :: GetRandomPassword -> String

showList :: [GetRandomPassword] -> ShowS

NFData GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

rnf :: GetRandomPassword -> ()

Eq GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

(==) :: GetRandomPassword -> GetRandomPassword -> Bool

(/=) :: GetRandomPassword -> GetRandomPassword -> Bool

Hashable GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

hashWithSalt :: Int -> GetRandomPassword -> Int

hash :: GetRandomPassword -> Int

type AWSResponse GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

type AWSResponse GetRandomPassword = GetRandomPasswordResponse

type Rep GetRandomPassword

Defined in Amazonka.SecretsManager.GetRandomPassword

type Rep GetRandomPassword = D1 ('MetaData "GetRandomPassword" "Amazonka.SecretsManager.GetRandomPassword" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "GetRandomPassword'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "excludeCharacters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "excludeLowercase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "excludeNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "excludePunctuation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "excludeUppercase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "includeSpace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "passwordLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "requireEachIncludedType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

newGetRandomPassword :: GetRandomPassword

Create a value of GetRandomPassword with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:excludeCharacters:GetRandomPassword', getRandomPassword_excludeCharacters - A string of the characters that you don't want in the password.

$sel:excludeLowercase:GetRandomPassword', getRandomPassword_excludeLowercase - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

$sel:excludeNumbers:GetRandomPassword', getRandomPassword_excludeNumbers - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

$sel:excludePunctuation:GetRandomPassword', getRandomPassword_excludePunctuation - Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.

$sel:excludeUppercase:GetRandomPassword', getRandomPassword_excludeUppercase - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

$sel:includeSpace:GetRandomPassword', getRandomPassword_includeSpace - Specifies whether to include the space character. If you include this switch, the password can contain space characters.

$sel:passwordLength:GetRandomPassword', getRandomPassword_passwordLength - The length of the password. If you don't include this parameter, the default length is 32 characters.

$sel:requireEachIncludedType:GetRandomPassword', getRandomPassword_requireEachIncludedType - Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.

Request Lenses

getRandomPassword_excludeCharacters :: Lens' GetRandomPassword (Maybe Text)

A string of the characters that you don't want in the password.

getRandomPassword_excludeLowercase :: Lens' GetRandomPassword (Maybe Bool)

Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

getRandomPassword_excludeNumbers :: Lens' GetRandomPassword (Maybe Bool)

Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

getRandomPassword_excludePunctuation :: Lens' GetRandomPassword (Maybe Bool)

Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.

getRandomPassword_excludeUppercase :: Lens' GetRandomPassword (Maybe Bool)

Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

getRandomPassword_includeSpace :: Lens' GetRandomPassword (Maybe Bool)

Specifies whether to include the space character. If you include this switch, the password can contain space characters.

getRandomPassword_passwordLength :: Lens' GetRandomPassword (Maybe Natural)

The length of the password. If you don't include this parameter, the default length is 32 characters.

getRandomPassword_requireEachIncludedType :: Lens' GetRandomPassword (Maybe Bool)

Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.

Destructuring the Response

data GetRandomPasswordResponse

See: newGetRandomPasswordResponse smart constructor.

Constructors

GetRandomPasswordResponse'

Fields

• randomPassword :: Maybe (Sensitive Text)

  A string with the password.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetRandomPasswordResponse

Defined in Amazonka.SecretsManager.GetRandomPassword

Associated Types

type Rep GetRandomPasswordResponse :: Type -> Type

Methods

from :: GetRandomPasswordResponse -> Rep GetRandomPasswordResponse x

to :: Rep GetRandomPasswordResponse x -> GetRandomPasswordResponse

Show GetRandomPasswordResponse

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

showsPrec :: Int -> GetRandomPasswordResponse -> ShowS

show :: GetRandomPasswordResponse -> String

showList :: [GetRandomPasswordResponse] -> ShowS

NFData GetRandomPasswordResponse

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

rnf :: GetRandomPasswordResponse -> ()

Eq GetRandomPasswordResponse

Defined in Amazonka.SecretsManager.GetRandomPassword

Methods

(==) :: GetRandomPasswordResponse -> GetRandomPasswordResponse -> Bool

(/=) :: GetRandomPasswordResponse -> GetRandomPasswordResponse -> Bool

type Rep GetRandomPasswordResponse

Defined in Amazonka.SecretsManager.GetRandomPassword

type Rep GetRandomPasswordResponse = D1 ('MetaData "GetRandomPasswordResponse" "Amazonka.SecretsManager.GetRandomPassword" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "GetRandomPasswordResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "randomPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetRandomPasswordResponse

Arguments

:: Int

$sel:httpStatus:GetRandomPasswordResponse'

-> GetRandomPasswordResponse

Create a value of GetRandomPasswordResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:randomPassword:GetRandomPasswordResponse', getRandomPasswordResponse_randomPassword - A string with the password.

$sel:httpStatus:GetRandomPasswordResponse', getRandomPasswordResponse_httpStatus - The response's http status code.

Response Lenses

getRandomPasswordResponse_randomPassword :: Lens' GetRandomPasswordResponse (Maybe Text)

A string with the password.

getRandomPasswordResponse_httpStatus :: Lens' GetRandomPasswordResponse Int

The response's http status code.