Omics / Client / get_workflow

get_workflow

Omics.Client.get_workflow(**kwargs)

Gets all information about a workflow using its ID.

If a workflow is shared with you, you cannot export the workflow.

For more information about your workflow status, see Verify the workflow status in the Amazon Web Services HealthOmics User Guide.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• id (string) –

  [REQUIRED]

  The workflow’s ID.

• type (string) – The workflow’s type.

• export (list) –

  The export format for the workflow.

  • (string) –

• workflowOwnerId (string) – The ID of the workflow owner.

Return type:

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',
    'storageType': 'STATIC'|'DYNAMIC',
    'uuid': 'string',
    'readme': 'string',
    'definitionRepositoryDetails': {
        'connectionArn': 'string',
        'fullRepositoryId': 'string',
        'sourceReference': {
            'type': 'BRANCH'|'TAG'|'COMMIT',
            'value': 'string'
        },
        'providerType': 'string',
        'providerEndpoint': 'string'
    },
    'readmePath': 'string'
}

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 default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

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

    • (string) –

      • (string) –

  • accelerators (string) –

    The computational accelerator specified to run the workflow.

  • storageType (string) –

    The default storage type for runs using this workflow.

  • uuid (string) –

    The universally unique identifier (UUID) value for this workflow.

  • readme (string) –

    The README content for the workflow, providing documentation and usage information.

  • definitionRepositoryDetails (dict) –

    Details about the source code repository that hosts the workflow definition files.

    • connectionArn (string) –

      The Amazon Resource Name (ARN) of the connection to the source code repository.

    • fullRepositoryId (string) –

      The full repository identifier, including the repository owner and name. For example, ‘repository-owner/repository-name’.

    • sourceReference (dict) –

      The source reference for the repository, such as a branch name, tag, or commit ID.

      • type (string) –

        The type of source reference, such as branch, tag, or commit.

      • value (string) –

        The value of the source reference, such as the branch name, tag name, or commit ID.

    • providerType (string) –

      The provider type of the source code repository, such as Bitbucket, GitHub, GitHubEnterpriseServer, GitLab, and GitLabSelfManaged.

    • providerEndpoint (string) –

      The endpoint URL of the source code repository provider.

  • readmePath (string) –

    The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.

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