list_run_groups

Omics.Client.list_run_groups(**kwargs)

Retrieves a list of run groups.

See also: AWS API Documentation

Request Syntax

response = client.list_run_groups(
    maxResults=123,
    name='string',
    startingToken='string'
)

Parameters

• maxResults (integer) -- The maximum number of run groups to return in one page of results.
• name (string) -- The run groups' name.
• startingToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.

Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'id': 'string',
            'maxCpus': 123,
            'maxDuration': 123,
            'maxRuns': 123,
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    A list of groups.

    • (dict) --

      A run group.

      • arn (string) --

        The group's ARN.

      • creationTime (datetime) --

        When the group was created.

      • id (string) --

        The group's ID.

      • maxCpus (integer) --

        The group's maximum CPU count setting.

      • maxDuration (integer) --

        The group's maximum duration setting in minutes.

      • maxRuns (integer) --

        The group's maximum concurrent run setting.

      • name (string) --

        The group's name.

  • nextToken (string) --

    A pagination token that's included if more results are available.

Exceptions

• Omics.Client.exceptions.InternalServerException
• Omics.Client.exceptions.ServiceQuotaExceededException
• Omics.Client.exceptions.ThrottlingException
• Omics.Client.exceptions.ValidationException
• Omics.Client.exceptions.ConflictException
• Omics.Client.exceptions.ResourceNotFoundException
• Omics.Client.exceptions.AccessDeniedException
• Omics.Client.exceptions.RequestTimeoutException