stop_relational_database ¶

def stop_relational_database(
    self,
    relational_database_name: "capo_lightsail.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[LightsailClientConfig] = None,
    relational_database_snapshot_name: Optional[
        "capo_lightsail.types.resource_name.ResourceName"
    ] = None,
) -> "capo_lightsail.types.stop_relational_database_result.StopRelationalDatabaseResult":
    """<p>Stops a specific database that is currently running in Amazon Lightsail.</p> <note> <p>If you don't manually start your database instance after it has been stopped for seven consecutive days, Amazon Lightsail automatically starts it for you. This action helps ensure that your database instance doesn't fall behind on any required maintenance updates.</p> </note> <p>The <code>stop relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags">Amazon Lightsail Developer Guide</a>.</p>

    Args:
        relational_database_name: <p>The name of your database to stop.</p>
        relational_database_snapshot_name: <p>The name of your new database snapshot to be created before stopping your database.</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.stop_relational_database_request.StopRelationalDatabaseRequest]",
    ) -> OperationResponse[
        "capo_lightsail.types.stop_relational_database_result.StopRelationalDatabaseResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.stop_relational_database

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopRelationalDatabase")
    )
    input_: capo_lightsail.types.stop_relational_database_request.StopRelationalDatabaseRequest = {
        "relational_database_name": relational_database_name
    }
    if relational_database_snapshot_name is not None:
        input_["relational_database_snapshot_name"] = (
            relational_database_snapshot_name
        )

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