GetRelationalDatabaseMasterUserPassword
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.
Request Syntax
{
"passwordVersion": "string",
"relationalDatabaseName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- passwordVersion
-
The password version to return.
Specifying
CURRENTorPREVIOUSreturns the current or previous passwords respectively. SpecifyingPENDINGreturns the newest version of the password that will rotate toCURRENT. After thePENDINGpassword rotates toCURRENT, thePENDINGpassword is no longer available.Default:
CURRENTType: String
Valid Values:
CURRENT | PREVIOUS | PENDINGRequired: No
- relationalDatabaseName
-
The name of your database for which to get the master user password.
Type: String
Pattern:
\w[\w\-]*\wRequired: Yes
Response Syntax
{
"createdAt": number,
"masterUserPassword": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- createdAt
-
The timestamp when the specified version of the master user password was created.
Type: Timestamp
- masterUserPassword
-
The master user password for the
password versionspecified.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
HTTP Status Code: 400
- AccountSetupInProgressException
-
Lightsail throws this exception when an account is still in the setup in progress state.
HTTP Status Code: 400
- InvalidInputException
-
Lightsail throws this exception when user input does not conform to the validation rules of an input field.
Note
Domain and distribution APIs are only available in the N. Virginia (
us-east-1) AWS Region. Please set your AWS Region configuration tous-east-1to create, view, or edit these resources.HTTP Status Code: 400
- NotFoundException
-
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
- OperationFailureException
-
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
- ServiceException
-
A general service exception.
HTTP Status Code: 500
- UnauthenticatedException
-
Lightsail throws this exception when the user has not been authenticated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
