Lightsail / Client / get_relational_database_master_user_password

get_relational_database_master_user_password

Lightsail.Client.get_relational_database_master_user_password(**kwargs)

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

See also: AWS API Documentation

Request Syntax

response = client.get_relational_database_master_user_password(
    relationalDatabaseName='string',
    passwordVersion='CURRENT'|'PREVIOUS'|'PENDING'
)

Parameters:

• relationalDatabaseName (string) –

  [REQUIRED]

  The name of your database for which to get the master user password.

• passwordVersion (string) –

  The password version to return.

  Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively. Specifying PENDING returns the newest version of the password that will rotate to CURRENT. After the PENDING password rotates to CURRENT, the PENDING password is no longer available.

  Default: CURRENT

Return type:

dict

Returns:

Response Syntax

{
    'masterUserPassword': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • masterUserPassword (string) –

    The master user password for the password version specified.

  • createdAt (datetime) –

    The timestamp when the specified version of the master user password was created.

Exceptions

• Lightsail.Client.exceptions.ServiceException

• Lightsail.Client.exceptions.InvalidInputException

• Lightsail.Client.exceptions.NotFoundException

• Lightsail.Client.exceptions.OperationFailureException

• Lightsail.Client.exceptions.AccessDeniedException

• Lightsail.Client.exceptions.AccountSetupInProgressException

• Lightsail.Client.exceptions.RegionSetupInProgressException

• Lightsail.Client.exceptions.UnauthenticatedException