start_domain_maintenance `async` ¶

start_domain_maintenance(
    domain_name: DomainName,
    action: MaintenanceType,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    node_id: Optional[NodeId] = None,
) -> StartDomainMaintenanceResponse

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

Parameters:

domain_name (DomainName) –

The name of the domain.
action (MaintenanceType) –

The name of the action.
node_id (Optional[NodeId], default: None ) –

The ID of the data node.

Raises:

BaseException –

An error occurred while processing the request.
DisabledOperationException –

An error occured because the client wanted to access an unsupported operation.
InternalException –

Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException –

An exception for accessing or deleting a resource that doesn't exist.
ValidationException –

An exception for accessing or deleting a resource that doesn't exist.
UnknownServiceError –

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

Source code in docs_src/capo_opensearch/_services/async_open_search.py

async def start_domain_maintenance(
    self,
    domain_name: "capo_opensearch.types.domain_name.DomainName",
    action: "capo_opensearch.types.maintenance_type.MaintenanceType",
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    node_id: Optional["capo_opensearch.types.node_id.NodeId"] = None,
) -> "capo_opensearch.types.start_domain_maintenance_response.StartDomainMaintenanceResponse":
    """<p>Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.</p>

    Args:
        domain_name: <p>The name of the domain.</p>
        action: <p>The name of the action.</p>
        node_id: <p>The ID of the data node.</p>

    Raises:
        capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_opensearch.types.start_domain_maintenance_request.StartDomainMaintenanceRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.start_domain_maintenance_response.StartDomainMaintenanceResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.start_domain_maintenance

        (
            output,
            http_response,
        ) = await capo_opensearch._operations.amazon_open_search_service.start_domain_maintenance.async_start_domain_maintenance(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartDomainMaintenance")
    )
    input_: capo_opensearch.types.start_domain_maintenance_request.StartDomainMaintenanceRequest = {
        "domain_name": domain_name,
        "action": action,
    }
    if node_id is not None:
        input_["node_id"] = node_id

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

start_domain_maintenance async ¶

start_domain_maintenance `async` ¶