Omics / Client / get_run_group

get_run_group#

Omics.Client.get_run_group(**kwargs)#

Gets information about a workflow run group.

See also: AWS API Documentation

Request Syntax

response = client.get_run_group(
    id='string'
)
Parameters:

id (string) –

[REQUIRED]

The group’s ID.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'creationTime': datetime(2015, 1, 1),
    'id': 'string',
    'maxCpus': 123,
    'maxDuration': 123,
    'maxRuns': 123,
    'name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • 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 number of CPUs to use.

    • maxDuration (integer) –

      The group’s maximum run time in minutes.

    • maxRuns (integer) –

      The maximum number of concurrent runs for the group.

    • name (string) –

      The group’s name.

    • tags (dict) –

      The group’s tags.

      • (string) –

        • (string) –

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