Amazon Omics

{'engine': {'CWL'}}

Creates a workflow.

See also: AWS API Documentation

Request Syntax

client.create_workflow(
    name='string',
    description='string',
    engine='WDL'|'NEXTFLOW'|'CWL',
    definitionZip=b'bytes',
    definitionUri='string',
    main='string',
    parameterTemplate={
        'string': {
            'description': 'string',
            'optional': True|False
        }
    },
    storageCapacity=123,
    tags={
        'string': 'string'
    },
    requestId='string',
    accelerators='GPU'
)

type name:

string

param name:

A name for the workflow.

type description:

string

param description:

A description for the workflow.

type engine:

string

param engine:

An engine for the workflow.

type definitionZip:

bytes

param definitionZip:

A ZIP archive for the workflow.

type definitionUri:

string

param definitionUri:

The URI of a definition for the workflow.

type main:

string

param main:

The path of the main definition file for the workflow.

type parameterTemplate:

dict

param parameterTemplate:

A parameter template for the workflow.

• (string) --

  • (dict) --

    A workflow parameter.

    • description (string) --

      The parameter's description.

    • optional (boolean) --

      Whether the parameter is optional.

type storageCapacity:

integer

param storageCapacity:

A storage capacity for the workflow in gigabytes.

type tags:

dict

param tags:

Tags for the workflow.

• (string) --

  • (string) --

type requestId:

string

param requestId:

[REQUIRED]

To ensure that requests don't run multiple times, specify a unique ID for each request.

This field is autopopulated if not provided.

type accelerators:

string

param accelerators:

The computational accelerator specified to run the workflow.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETED'|'FAILED'|'INACTIVE',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • arn (string) --

    The workflow's ARN.

  • id (string) --

    The workflow's ID.

  • status (string) --

    The workflow's status.

  • tags (dict) --

    The workflow's tags.

    • (string) --

      • (string) --

{'engine': {'CWL'}}

Gets information about a workflow.

See also: AWS API Documentation

Request Syntax

client.get_workflow(
    id='string',
    type='PRIVATE'|'READY2RUN',
    export=[
        'DEFINITION',
    ]
)

type id:

string

param id:

[REQUIRED]

The workflow's ID.

type type:

string

param type:

The workflow's type.

type export:

list

param export:

The export format for the workflow.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETED'|'FAILED'|'INACTIVE',
    'type': 'PRIVATE'|'READY2RUN',
    'name': 'string',
    'description': 'string',
    'engine': 'WDL'|'NEXTFLOW'|'CWL',
    'definition': 'string',
    'main': 'string',
    'digest': 'string',
    'parameterTemplate': {
        'string': {
            'description': 'string',
            'optional': True|False
        }
    },
    'storageCapacity': 123,
    'creationTime': datetime(2015, 1, 1),
    'statusMessage': 'string',
    'tags': {
        'string': 'string'
    },
    'metadata': {
        'string': 'string'
    },
    'accelerators': 'GPU'
}

Response Structure

• (dict) --

  • arn (string) --

    The workflow's ARN.

  • id (string) --

    The workflow's ID.

  • status (string) --

    The workflow's status.

  • type (string) --

    The workflow's type.

  • name (string) --

    The workflow's name.

  • description (string) --

    The workflow's description.

  • engine (string) --

    The workflow's engine.

  • definition (string) --

    The workflow's definition.

  • main (string) --

    The path of the main definition file for the workflow.

  • digest (string) --

    The workflow's digest.

  • parameterTemplate (dict) --

    The workflow's parameter template.

    • (string) --

      • (dict) --

        A workflow parameter.

        • description (string) --

          The parameter's description.

        • optional (boolean) --

          Whether the parameter is optional.

  • storageCapacity (integer) --

    The workflow's storage capacity in gigabytes.

  • creationTime (datetime) --

    When the workflow was created.

  • statusMessage (string) --

    The workflow's status message.

  • tags (dict) --

    The workflow's tags.

    • (string) --

      • (string) --

  • metadata (dict) --

    Gets metadata for workflow.

    • (string) --

      • (string) --

  • accelerators (string) --

    The computational accelerator specified to run the workflow.