Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

start_reference_import_job

start_reference_import_job(**kwargs)

Starts a reference import job.

See also: AWS API Documentation

Request Syntax

response = client.start_reference_import_job(
    clientToken='string',
    referenceStoreId='string',
    roleArn='string',
    sources=[
        {
            'description': 'string',
            'name': 'string',
            'sourceFile': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ]
)
Parameters
  • clientToken (string) -- To ensure that jobs don't run multiple times, specify a unique token for each job.
  • referenceStoreId (string) --

    [REQUIRED]

    The job's reference store ID.

  • roleArn (string) --

    [REQUIRED]

    A service role for the job.

  • sources (list) --

    [REQUIRED]

    The job's source files.

    • (dict) --

      A source for a reference import job.

      • description (string) --

        The source's description.

      • name (string) -- [REQUIRED]

        The source's name.

      • sourceFile (string) -- [REQUIRED]

        The source file's location in Amazon S3.

      • tags (dict) --

        The source's tags.

        • (string) --
          • (string) --
Return type

dict

Returns

Response Syntax

{
    'creationTime': datetime(2015, 1, 1),
    'id': 'string',
    'referenceStoreId': 'string',
    'roleArn': '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.

    • referenceStoreId (string) --

      The job's reference store ID.

    • roleArn (string) --

      The job's service role ARN.

    • 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