Skip to content

list_dataflow_endpoint_groups async

list_dataflow_endpoint_groups(
    *,
    config_overrides: Optional[AsyncGroundStationClientConfig] = None,
    max_results: Optional[PaginationMaxResults] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListDataflowEndpointGroupsResponse

Returns a list of DataflowEndpoint groups.

Parameters:

  • max_results (Optional[PaginationMaxResults], default: None ) –

    Maximum number of dataflow endpoint groups returned.

  • next_token (Optional[PaginationToken], default: None ) –

    Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

Raises:

Source code in docs_src/capo_groundstation/_services/async_ground_station.py
async def list_dataflow_endpoint_groups(
    self,
    *,
    config_overrides: Optional[AsyncGroundStationClientConfig] = None,
    max_results: Optional[
        "capo_groundstation.types.pagination_max_results.PaginationMaxResults"
    ] = None,
    next_token: Optional[
        "capo_groundstation.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_groundstation.types.list_dataflow_endpoint_groups_response.ListDataflowEndpointGroupsResponse":
    """<p>Returns a list of <code>DataflowEndpoint</code> groups.</p>

    Args:
        max_results: <p>Maximum number of dataflow endpoint groups returned.</p>
        next_token: <p>Next token returned in the request of a previous <code>ListDataflowEndpointGroups</code> call. Used to get the next page of results.</p>

    Raises:
        capo_groundstation.errors.dependency_exception.DependencyException: <p>Dependency encountered an error.</p>
        capo_groundstation.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_groundstation.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource was not found.</p>
        capo_groundstation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_groundstation.types.list_dataflow_endpoint_groups_request.ListDataflowEndpointGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_groundstation.types.list_dataflow_endpoint_groups_response.ListDataflowEndpointGroupsResponse"
    ]:
        import capo_groundstation._operations.ground_station.list_dataflow_endpoint_groups

        (
            output,
            http_response,
        ) = await capo_groundstation._operations.ground_station.list_dataflow_endpoint_groups.async_list_dataflow_endpoint_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDataflowEndpointGroups")
    )
    input_: capo_groundstation.types.list_dataflow_endpoint_groups_request.ListDataflowEndpointGroupsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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