Skip to content

describe_node

describe_node(
    node_id: NodeId,
    *,
    config_overrides: Optional[PanoramaClientConfig] = None,
    owner_account: Optional[PackageOwnerAccount] = None,
) -> DescribeNodeResponse

Returns information about a node.

Parameters:

Raises:

Source code in docs_src/capo_panorama/_services/panorama.py
def describe_node(
    self,
    node_id: "capo_panorama.types.node_id.NodeId",
    *,
    config_overrides: Optional[PanoramaClientConfig] = None,
    owner_account: Optional[
        "capo_panorama.types.package_owner_account.PackageOwnerAccount"
    ] = None,
) -> "capo_panorama.types.describe_node_response.DescribeNodeResponse":
    """<p>Returns information about a node.</p>

    Args:
        node_id: <p>The node's ID.</p>
        owner_account: <p>The account ID of the node's owner.</p>

    Raises:
        capo_panorama.errors.access_denied_exception.AccessDeniedException: <p>The requestor does not have permission to access the target action or resource.</p>
        capo_panorama.errors.conflict_exception.ConflictException: <p>The target resource is in use.</p>
        capo_panorama.errors.internal_server_exception.InternalServerException: <p>An internal error occurred.</p>
        capo_panorama.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found.</p>
        capo_panorama.errors.validation_exception.ValidationException: <p>The request contains an invalid parameter value.</p>
        capo_panorama.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_panorama.types.describe_node_request.DescribeNodeRequest]",
    ) -> OperationResponse[
        "capo_panorama.types.describe_node_response.DescribeNodeResponse"
    ]:
        import capo_panorama._operations.omni_cloud_service_lambda.describe_node

        output, http_response = (
            capo_panorama._operations.omni_cloud_service_lambda.describe_node.describe_node(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeNode")
    )
    input_: capo_panorama.types.describe_node_request.DescribeNodeRequest = {
        "node_id": node_id
    }
    if owner_account is not None:
        input_["owner_account"] = owner_account

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