describe_domain_nodes ¶

describe_domain_nodes(
    domain_name: DomainName,
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
) -> DescribeDomainNodesResponse

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

Parameters:

domain_name (DomainName) –

The name of the domain.

Raises:

BaseException –

An error occurred while processing the request.
DependencyFailureException –

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
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/open_search.py

def describe_domain_nodes(
    self,
    domain_name: "capo_opensearch.types.domain_name.DomainName",
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
) -> "capo_opensearch.types.describe_domain_nodes_response.DescribeDomainNodesResponse":
    """<p>Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.</p>

    Args:
        domain_name: <p>The name of the domain.</p>

    Raises:
        capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_opensearch.errors.dependency_failure_exception.DependencyFailureException: <p>An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.</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.
    """

    def _handler(
        req: "OperationRequest[capo_opensearch.types.describe_domain_nodes_request.DescribeDomainNodesRequest]",
    ) -> OperationResponse[
        "capo_opensearch.types.describe_domain_nodes_response.DescribeDomainNodesResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.describe_domain_nodes

        output, http_response = (
            capo_opensearch._operations.amazon_open_search_service.describe_domain_nodes.describe_domain_nodes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDomainNodes")
    )
    input_: capo_opensearch.types.describe_domain_nodes_request.DescribeDomainNodesRequest = {
        "domain_name": domain_name
    }

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