Omics / Client / start_annotation_import_job

start_annotation_import_job#

Omics.Client.start_annotation_import_job(**kwargs)#

Starts an annotation import job.

See also: AWS API Documentation

Request Syntax

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

  • destinationName (string) –

    [REQUIRED]

    A destination annotation store for the job.

  • roleArn (string) –

    [REQUIRED]

    A service role for the job.

  • 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.

  • 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.

        • sep (string) –

          The file’s field separator.

        • encoding (string) –

          The file’s encoding.

        • quote (string) –

          The file’s quote character.

        • quoteAll (boolean) –

          Whether all values need to be quoted, or just those that contain quotes.

        • escape (string) –

          A character for escaping quotes in the file.

        • escapeQuotes (boolean) –

          Whether quotes need to be escaped in the file.

        • comment (string) –

          The file’s comment character.

        • header (boolean) –

          Whether the file has a header row.

        • lineSep (string) –

          A line separator for the file.

    • vcfOptions (dict) –

      Options for a VCF file.

      • ignoreQualField (boolean) –

        The file’s ignore qual field setting.

      • ignoreFilterField (boolean) –

        The file’s ignore filter field setting.

  • runLeftNormalization (boolean) – The job’s left normalization setting.

  • annotationFields (dict) –

    The annotation schema generated by the parsed annotation data.

    • (string) –

      • (string) –

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