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
orPREVIOUS
returns the current or previous passwords respectively. SpecifyingPENDING
returns the newest version of the password that will rotate toCURRENT
. After thePENDING
password rotates toCURRENT
, thePENDING
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