Skip to content

list_nodes async

list_nodes(
    *,
    config_overrides: Optional[AsyncPanoramaClientConfig] = None,
    category: Optional[NodeCategory] = None,
    owner_account: Optional[PackageOwnerAccount] = None,
    package_name: Optional[NodePackageName] = None,
    package_version: Optional[NodePackageVersion] = None,
    patch_version: Optional[NodePackagePatchVersion] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxSize25] = None,
) -> ListNodesResponse

Returns a list of nodes.

Parameters:

Raises:

Source code in docs_src/capo_panorama/_services/async_panorama.py
async def list_nodes(
    self,
    *,
    config_overrides: Optional[AsyncPanoramaClientConfig] = None,
    category: Optional["capo_panorama.types.node_category.NodeCategory"] = None,
    owner_account: Optional[
        "capo_panorama.types.package_owner_account.PackageOwnerAccount"
    ] = None,
    package_name: Optional[
        "capo_panorama.types.node_package_name.NodePackageName"
    ] = None,
    package_version: Optional[
        "capo_panorama.types.node_package_version.NodePackageVersion"
    ] = None,
    patch_version: Optional[
        "capo_panorama.types.node_package_patch_version.NodePackagePatchVersion"
    ] = None,
    next_token: Optional["capo_panorama.types.token.Token"] = None,
    max_results: Optional["capo_panorama.types.max_size25.MaxSize25"] = None,
) -> "capo_panorama.types.list_nodes_response.ListNodesResponse":
    """<p>Returns a list of nodes.</p>

    Args:
        category: <p>Search for nodes by category.</p>
        owner_account: <p>Search for nodes by the account ID of the nodes' owner.</p>
        package_name: <p>Search for nodes by name.</p>
        package_version: <p>Search for nodes by version.</p>
        patch_version: <p>Search for nodes by patch version.</p>
        next_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
        max_results: <p>The maximum number of nodes to return in one page of results.</p>

    Raises:
        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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_panorama.types.list_nodes_request.ListNodesRequest]",
    ) -> AsyncOperationResponse[
        "capo_panorama.types.list_nodes_response.ListNodesResponse"
    ]:
        import capo_panorama._operations.omni_cloud_service_lambda.list_nodes

        (
            output,
            http_response,
        ) = await capo_panorama._operations.omni_cloud_service_lambda.list_nodes.async_list_nodes(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListNodes")
    )
    input_: capo_panorama.types.list_nodes_request.ListNodesRequest = {}
    if category is not None:
        input_["category"] = category
    if owner_account is not None:
        input_["owner_account"] = owner_account
    if package_name is not None:
        input_["package_name"] = package_name
    if package_version is not None:
        input_["package_version"] = package_version
    if patch_version is not None:
        input_["patch_version"] = patch_version
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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