start_read_set_import_job

Omics.Client.start_read_set_import_job(**kwargs)

Starts a read set import job.

See also: AWS API Documentation

Request Syntax

response = client.start_read_set_import_job(
    clientToken='string',
    roleArn='string',
    sequenceStoreId='string',
    sources=[
        {
            'description': 'string',
            'generatedFrom': 'string',
            'name': 'string',
            'referenceArn': 'string',
            'sampleId': 'string',
            'sourceFileType': 'FASTQ'|'BAM'|'CRAM',
            'sourceFiles': {
                'source1': 'string',
                'source2': 'string'
            },
            'subjectId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ]
)

Parameters

• clientToken (string) -- To ensure that jobs don't run multiple times, specify a unique token for each job.
• roleArn (string) --

  [REQUIRED]

  A service role for the job.

• sequenceStoreId (string) --

  [REQUIRED]

  The read set's sequence store ID.

• sources (list) --

  [REQUIRED]

  The job's source files.

  • (dict) --

    A source for a read set import job.

    • description (string) --

      The source's description.

    • generatedFrom (string) --

      Where the source originated.

    • name (string) --

      The source's name.

    • referenceArn (string) -- [REQUIRED]

      The source's reference ARN.

    • sampleId (string) -- [REQUIRED]

      The source's sample ID.

    • sourceFileType (string) -- [REQUIRED]

      The source's file type.

    • sourceFiles (dict) -- [REQUIRED]

      The source files' location in Amazon S3.

      • source1 (string) -- [REQUIRED]

        The location of the first file in Amazon S3.

      • source2 (string) --

        The location of the second file in Amazon S3.

    • subjectId (string) -- [REQUIRED]

      The source's subject ID.

    • tags (dict) --

      The source's tags.

      • (string) --
        • (string) --

Return type

dict

Returns

Response Syntax

{
    'creationTime': datetime(2015, 1, 1),
    'id': 'string',
    'roleArn': 'string',
    'sequenceStoreId': 'string',
    'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES'
}

Response Structure

• (dict) --

  • creationTime (datetime) --

    When the job was created.

  • id (string) --

    The job's ID.

  • roleArn (string) --

    The job's service role ARN.

  • sequenceStoreId (string) --

    The read set's sequence store ID.

  • status (string) --

    The job's status.

Exceptions

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