Omics / Client / get_read_set_import_job

get_read_set_import_job

Omics.Client.get_read_set_import_job(**kwargs)

Gets information about a read set import job.

See also: AWS API Documentation

Request Syntax

response = client.get_read_set_import_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',
    'roleArn': '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': [
        {
            'sourceFiles': {
                'source1': 'string',
                'source2': 'string'
            },
            'sourceFileType': 'FASTQ'|'BAM'|'CRAM',
            'status': 'NOT_STARTED'|'IN_PROGRESS'|'FINISHED'|'FAILED',
            'statusMessage': 'string',
            'subjectId': 'string',
            'sampleId': 'string',
            'generatedFrom': 'string',
            'referenceArn': 'string',
            'name': 'string',
            'description': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

• (dict) –

  • id (string) –

    The job’s ID.

  • sequenceStoreId (string) –

    The job’s sequence store ID.

  • roleArn (string) –

    The job’s service role ARN.

  • 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 an import read set job.

      • sourceFiles (dict) –

        The source files’ location in Amazon S3.

        • source1 (string) –

          The location of the first file in Amazon S3.

        • source2 (string) –

          The location of the second file in Amazon S3.

      • sourceFileType (string) –

        The source’s file type.

      • status (string) –

        The source’s status.

      • statusMessage (string) –

        The source’s status message.

      • subjectId (string) –

        The source’s subject ID.

      • sampleId (string) –

        The source’s sample ID.

      • generatedFrom (string) –

        Where the source originated.

      • referenceArn (string) –

        The source’s genome reference ARN.

      • name (string) –

        The source’s name.

      • description (string) –

        The source’s description.

      • tags (dict) –

        The source’s tags.

        • (string) –

          • (string) –

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