stop_db_node `async` ¶

stop_db_node(
    db_node_id: ResourceId,
    *,
    config_overrides: Optional[AsyncodbClientConfig] = None,
    cloud_vm_cluster_id: Optional[ResourceId] = None,
    exadb_vm_cluster_id: Optional[ResourceId] = None,
) -> StopDbNodeOutput

Stops the specified DB node in a VM cluster.

Parameters:

cloud_vm_cluster_id (Optional[ResourceId], default: None ) –

The unique identifier of the VM cluster that contains the DB node to stop. You must specify either this parameter or exadbVmClusterId.
exadb_vm_cluster_id (Optional[ResourceId], default: None ) –

The unique identifier of the Exascale VM cluster that contains the DB node to stop. You must specify either this parameter or cloudVmClusterId.
db_node_id (ResourceId) –

The unique identifier of the DB node to stop.

Raises:

AccessDeniedException –

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.
InternalServerException –

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.
ResourceNotFoundException –

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The request has failed validation because it is missing required fields or has invalid inputs.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_odb/_services/async_odb.py

async def stop_db_node(
    self,
    db_node_id: "capo_odb.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[AsyncodbClientConfig] = None,
    cloud_vm_cluster_id: Optional["capo_odb.types.resource_id.ResourceId"] = None,
    exadb_vm_cluster_id: Optional["capo_odb.types.resource_id.ResourceId"] = None,
) -> "capo_odb.types.stop_db_node_output.StopDbNodeOutput":
    """<p>Stops the specified DB node in a VM cluster.</p>

    Args:
        cloud_vm_cluster_id: <p>The unique identifier of the VM cluster that contains the DB node to stop. You must specify either this parameter or <code>exadbVmClusterId</code>.</p>
        exadb_vm_cluster_id: <p>The unique identifier of the Exascale VM cluster that contains the DB node to stop. You must specify either this parameter or <code>cloudVmClusterId</code>.</p>
        db_node_id: <p>The unique identifier of the DB node to stop.</p>

    Raises:
        capo_odb.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.</p>
        capo_odb.errors.internal_server_exception.InternalServerException: <p>Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.</p>
        capo_odb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.</p>
        capo_odb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_odb.errors.validation_exception.ValidationException: <p>The request has failed validation because it is missing required fields or has invalid inputs.</p>
        capo_odb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_odb.types.stop_db_node_input.StopDbNodeInput]",
    ) -> AsyncOperationResponse[
        "capo_odb.types.stop_db_node_output.StopDbNodeOutput"
    ]:
        import capo_odb._operations.odb.stop_db_node

        (
            output,
            http_response,
        ) = await capo_odb._operations.odb.stop_db_node.async_stop_db_node(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopDbNode")
    )
    input_: capo_odb.types.stop_db_node_input.StopDbNodeInput = {
        "db_node_id": db_node_id
    }
    if cloud_vm_cluster_id is not None:
        input_["cloud_vm_cluster_id"] = cloud_vm_cluster_id
    if exadb_vm_cluster_id is not None:
        input_["exadb_vm_cluster_id"] = exadb_vm_cluster_id

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

stop_db_node async ¶

stop_db_node `async` ¶