list_run_groups `async` ¶

list_run_groups(
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    name: Optional[RunGroupName] = None,
    starting_token: Optional[RunGroupListToken] = None,
    max_results: Optional[int] = None,
) -> ListRunGroupsResponse

Retrieves a list of all run groups and returns the metadata for each run group.

Parameters:

name (Optional[RunGroupName], default: None ) –

The run groups' name.
starting_token (Optional[RunGroupListToken], default: None ) –

Specify the pagination token from a previous request to retrieve the next page of results.
max_results (Optional[int], default: None ) –

The maximum number of run groups to return in one page of results.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

The request cannot be applied to the target resource in its current state.
InternalServerException –

An unexpected error occurred. Try the request again.
RequestTimeoutException –

The request timed out.
ResourceNotFoundException –

The target resource was not found in the current Region.
ServiceQuotaExceededException –

The request exceeds a service quota.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

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

Source code in docs_src/capo_omics/_services/async_omics.py

async def list_run_groups(
    self,
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    name: Optional["capo_omics.types.run_group_name.RunGroupName"] = None,
    starting_token: Optional[
        "capo_omics.types.run_group_list_token.RunGroupListToken"
    ] = None,
    max_results: Optional[int] = None,
) -> "capo_omics.types.list_run_groups_response.ListRunGroupsResponse":
    """<p>Retrieves a list of all run groups and returns the metadata for each run group.</p>

    Args:
        name: <p>The run groups' name.</p>
        starting_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 run groups to return in one page of results.</p>

    Raises:
        capo_omics.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_omics.errors.conflict_exception.ConflictException: <p>The request cannot be applied to the target resource in its current state.</p>
        capo_omics.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred. Try the request again.</p>
        capo_omics.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out.</p>
        capo_omics.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found in the current Region.</p>
        capo_omics.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds a service quota.</p>
        capo_omics.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_omics.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_omics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_omics.types.list_run_groups_request.ListRunGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_omics.types.list_run_groups_response.ListRunGroupsResponse"
    ]:
        import capo_omics._operations.omics.list_run_groups

        (
            output,
            http_response,
        ) = await capo_omics._operations.omics.list_run_groups.async_list_run_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRunGroups")
    )
    input_: capo_omics.types.list_run_groups_request.ListRunGroupsRequest = {}
    if name is not None:
        input_["name"] = name
    if starting_token is not None:
        input_["starting_token"] = starting_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

list_run_groups async ¶

list_run_groups `async` ¶