Omics / Client / start_annotation_import_job

start_annotation_import_job#

Omics.Client.start_annotation_import_job(**kwargs)#

Starts an annotation import job.

Request Syntax

response = client.start_annotation_import_job(
    destinationName='string',
    formatOptions={
        'tsvOptions': {
            'readOptions': {
                'comment': 'string',
                'encoding': 'string',
                'escape': 'string',
                'escapeQuotes': True|False,
                'header': True|False,
                'lineSep': 'string',
                'quote': 'string',
                'quoteAll': True|False,
                'sep': 'string'
            }
        },
        'vcfOptions': {
            'ignoreFilterField': True|False,
            'ignoreQualField': True|False
        }
    },
    items=[
        {
            'source': 'string'
        },
    ],
    roleArn='string',
    runLeftNormalization=True|False
)

Parameters:

destinationName (string) –
[REQUIRED]

A destination annotation store for the job.
formatOptions (dict) –
Formatting options for the annotation file.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tsvOptions, vcfOptions.
- tsvOptions (dict) –
  
  Options for a TSV file.
  - readOptions (dict) –
    
    The file’s read options.
    - comment (string) –
      
      The file’s comment character.
    - encoding (string) –
      
      The file’s encoding.
    - escape (string) –
      
      A character for escaping quotes in the file.
    - escapeQuotes (boolean) –
      
      Whether quotes need to be escaped in the file.
    - header (boolean) –
      
      Whether the file has a header row.
    - lineSep (string) –
      
      A line separator for the file.
    - quote (string) –
      
      The file’s quote character.
    - quoteAll (boolean) –
      
      Whether all values need to be quoted, or just those that contain quotes.
    - sep (string) –
      
      The file’s field separator.
- vcfOptions (dict) –
  
  Options for a VCF file.
  - ignoreFilterField (boolean) –
    
    The file’s ignore filter field setting.
  - ignoreQualField (boolean) –
    
    The file’s ignore qual field setting.
items (list) –
[REQUIRED]

Items to import.
- (dict) –
  
  A source for an annotation import job.
  - source (string) – [REQUIRED]
    
    The source file’s location in Amazon S3.
roleArn (string) –
[REQUIRED]

A service role for the job.
runLeftNormalization (boolean) – The job’s left normalization setting.

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string'
}

Response Structure

(dict) –
- jobId (string) –
  
  The job’s ID.

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