Omics / Client / create_workflow

create_workflow

Omics.Client.create_workflow(**kwargs)

Creates a workflow.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• definitionUri (string) – The URI of a definition for the workflow.

• definitionZip (bytes) – A ZIP archive for the workflow.

• description (string) – A description for the workflow.

• engine (string) – An engine for the workflow.

• main (string) – The path of the main definition file for the workflow.

• name (string) – A name for the workflow.

• parameterTemplate (dict) –

  A parameter template for the workflow.

  • (string) –

    • (dict) –

      A workflow parameter.

      • description (string) –

        The parameter’s description.

      • optional (boolean) –

        Whether the parameter is optional.

• requestId (string) –

  [REQUIRED]

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

  This field is autopopulated if not provided.

• storageCapacity (integer) – A storage capacity for the workflow in gigabytes.

• tags (dict) –

  Tags for the workflow.

  • (string) –

    • (string) –

Return type:

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) –

Exceptions

• Omics.Client.exceptions.InternalServerException

• Omics.Client.exceptions.ServiceQuotaExceededException

• Omics.Client.exceptions.ThrottlingException

• Omics.Client.exceptions.ValidationException

• Omics.Client.exceptions.ConflictException

• Omics.Client.exceptions.ResourceNotFoundException

• Omics.Client.exceptions.AccessDeniedException

• Omics.Client.exceptions.RequestTimeoutException