Omics / Client / get_read_set_activation_job

get_read_set_activation_job

Omics.Client.get_read_set_activation_job(**kwargs)

Gets information about a read set activation job.

See also: AWS API Documentation

Request Syntax

response = client.get_read_set_activation_job(
    id='string',
    sequenceStoreId='string'
)

Parameters:

• id (string) –

  [REQUIRED]

  The job’s ID.

• sequenceStoreId (string) –

  [REQUIRED]

  The job’s sequence store ID.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'sequenceStoreId': 'string',
    'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES',
    'statusMessage': 'string',
    'creationTime': datetime(2015, 1, 1),
    'completionTime': datetime(2015, 1, 1),
    'sources': [
        {
            'readSetId': 'string',
            'status': 'NOT_STARTED'|'IN_PROGRESS'|'FINISHED'|'FAILED',
            'statusMessage': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • id (string) –

    The job’s ID.

  • sequenceStoreId (string) –

    The job’s sequence store ID.

  • status (string) –

    The job’s status.

  • statusMessage (string) –

    The job’s status message.

  • creationTime (datetime) –

    When the job was created.

  • completionTime (datetime) –

    When the job completed.

  • sources (list) –

    The job’s source files.

    • (dict) –

      A source for a read set activation job.

      • readSetId (string) –

        The source’s read set ID.

      • status (string) –

        The source’s status.

      • statusMessage (string) –

        The source’s status message.

Exceptions

• Omics.Client.exceptions.InternalServerException

• Omics.Client.exceptions.ThrottlingException

• Omics.Client.exceptions.ValidationException

• Omics.Client.exceptions.ResourceNotFoundException

• Omics.Client.exceptions.AccessDeniedException

• Omics.Client.exceptions.RequestTimeoutException