get_relational_database_master_user_password ¶

def get_relational_database_master_user_password(
    self,
    relational_database_name: "capo_lightsail.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[LightsailClientConfig] = None,
    password_version: Optional[
        "capo_lightsail.types.relational_database_password_version.RelationalDatabasePasswordVersion"
    ] = None,
) -> "capo_lightsail.types.get_relational_database_master_user_password_result.GetRelationalDatabaseMasterUserPasswordResult":
    """<p>Returns the current, previous, or pending versions of the master user password for a Lightsail database.</p> <p>The <code>GetRelationalDatabaseMasterUserPassword</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.</p>

    Args:
        relational_database_name: <p>The name of your database for which to get the master user password.</p>
        password_version: <p>The password version to return.</p> <p>Specifying <code>CURRENT</code> or <code>PREVIOUS</code> returns the current or previous passwords respectively. Specifying <code>PENDING</code> returns the newest version of the password that will rotate to <code>CURRENT</code>. After the <code>PENDING</code> password rotates to <code>CURRENT</code>, the <code>PENDING</code> password is no longer available.</p> <p>Default: <code>CURRENT</code> </p>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.account_setup_in_progress_exception.AccountSetupInProgressException: <p>Lightsail throws this exception when an account is still in the setup in progress state.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.operation_failure_exception.OperationFailureException: <p>Lightsail throws this exception when an operation fails to execute.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lightsail.types.get_relational_database_master_user_password_request.GetRelationalDatabaseMasterUserPasswordRequest]",
    ) -> OperationResponse[
        "capo_lightsail.types.get_relational_database_master_user_password_result.GetRelationalDatabaseMasterUserPasswordResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.get_relational_database_master_user_password

        output, http_response = (
            capo_lightsail._operations.lightsail_20161128.get_relational_database_master_user_password.get_relational_database_master_user_password(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_lightsail.types.get_relational_database_master_user_password_result.GetRelationalDatabaseMasterUserPasswordResult",
    ) -> dict[str, Any]:
        import capo_lightsail.types.get_relational_database_master_user_password_result

        return capo_lightsail.types.get_relational_database_master_user_password_result.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "GetRelationalDatabaseMasterUserPassword", redact_output=_redact_output
        ),
    )
    input_: capo_lightsail.types.get_relational_database_master_user_password_request.GetRelationalDatabaseMasterUserPasswordRequest = {
        "relational_database_name": relational_database_name
    }
    if password_version is not None:
        input_["password_version"] = password_version

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output