AWS API Changes

2026/10/12 - Amazon Omics - 3 updated api methods

Changes AWS HealthOmics now supports private workflow runs using VPC resources shared across accounts via AWS RAM. A new optional vpcOwnerAccountId field in CreateConfiguration's VpcConfig allows customers to specify the account that owns the shared subnets and security groups.

CreateConfiguration (updated)

Link ¶
Changes (both)

{'runConfigurations': {'vpcConfig': {'vpcOwnerAccountId': 'string'}}}

Create a new configuration.

See also: AWS API Documentation

Request Syntax

client.create_configuration(
    name='string',
    description='string',
    runConfigurations={
        'vpcConfig': {
            'securityGroupIds': [
                'string',
            ],
            'subnetIds': [
                'string',
            ],
            'vpcOwnerAccountId': 'string'
        }
    },
    tags={
        'string': 'string'
    },
    requestId='string'
)

type name:

string

param name:

[REQUIRED]

User-friendly name for the configuration.

type description:

string

param description:

Optional description for the configuration.

type runConfigurations:

dict

param runConfigurations:

[REQUIRED]

Required run-specific configurations.

vpcConfig (dict) --

VPC configuration for workflow runs.
- securityGroupIds (list) --
  
  List of security group IDs. Maximum of 5 security groups allowed.
  - (string) --
- subnetIds (list) --
  
  List of subnet IDs. Maximum of 16 subnets allowed.
  - (string) --
- vpcOwnerAccountId (string) --
  
  The Amazon Web Services account ID of the cross-account VPC owner for RAM-shared VPC configurations.

type tags:

dict

param tags:

Optional tags for the configuration.

(string) --
- (string) --

type requestId:

string

param requestId:

[REQUIRED]

Optional request idempotency token. If not specified, a universally unique identifier (UUID) will be automatically generated for the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'uuid': 'string',
    'name': 'string',
    'description': 'string',
    'runConfigurations': {
        'vpcConfig': {
            'securityGroupIds': [
                'string',
            ],
            'subnetIds': [
                'string',
            ],
            'vpcId': 'string',
            'vpcOwnerAccountId': 'string'
        }
    },
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
    'creationTime': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- arn (string) --
  
  Unique resource identifier for the configuration.
- uuid (string) --
  
  Unique identifier for the configuration.
- name (string) --
  
  User-friendly name for the configuration.
- description (string) --
  
  Description for the configuration.
- runConfigurations (dict) --
  
  Run-specific configurations.
  - vpcConfig (dict) --
    
    VPC configuration for workflow runs with computed VPC ID.
    - securityGroupIds (list) --
      
      List of security group IDs.
      - (string) --
    - subnetIds (list) --
      
      List of subnet IDs.
      - (string) --
    - vpcId (string) --
      
      VPC ID computed from the provided subnet IDs.
    - vpcOwnerAccountId (string) --
      
      The Amazon Web Services account ID of the cross-account VPC owner for RAM-shared VPC configurations.
- status (string) --
  
  Current configuration status.
- creationTime (datetime) --
  
  Configuration creation timestamp.
- tags (dict) --
  
  Tags for the configuration.
  - (string) --
    - (string) --

GetConfiguration (updated)

Link ¶
Changes (response)

{'runConfigurations': {'vpcConfig': {'vpcOwnerAccountId': 'string'}}}

Retrieve configuration details for specified name.

See also: AWS API Documentation

Request Syntax

client.get_run(
    id='string',
    export=[
        'DEFINITION',
    ]
)

type id:

string

param id:

[REQUIRED]

The run's ID.

type export:

list

param export:

The run's export format.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'cacheId': 'string',
    'cacheBehavior': 'CACHE_ON_FAILURE'|'CACHE_ALWAYS',
    'engineVersion': 'string',
    'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
    'workflowId': 'string',
    'workflowType': 'PRIVATE'|'READY2RUN',
    'runId': 'string',
    'roleArn': 'string',
    'name': 'string',
    'runGroupId': 'string',
    'batchId': 'string',
    'priority': 123,
    'definition': 'string',
    'digest': 'string',
    'parameters': {...}|[...]|123|123.4|'string'|True|None,
    'storageCapacity': 123,
    'outputUri': 'string',
    'logLevel': 'OFF'|'FATAL'|'ERROR'|'ALL',
    'resourceDigests': {
        'string': 'string'
    },
    'startedBy': 'string',
    'creationTime': datetime(2015, 1, 1),
    'startTime': datetime(2015, 1, 1),
    'stopTime': datetime(2015, 1, 1),
    'statusMessage': 'string',
    'tags': {
        'string': 'string'
    },
    'accelerators': 'GPU',
    'retentionMode': 'RETAIN'|'REMOVE',
    'failureReason': 'string',
    'logLocation': {
        'engineLogStream': 'string',
        'runLogStream': 'string'
    },
    'uuid': 'string',
    'runOutputUri': 'string',
    'storageType': 'STATIC'|'DYNAMIC',
    'workflowOwnerId': 'string',
    'workflowVersionName': 'string',
    'workflowUuid': 'string',
    'networkingMode': 'RESTRICTED'|'VPC',
    'scratchStorageMode': 'LOCAL'|'SHARED',
    'configuration': {
        'name': 'string',
        'arn': 'string',
        'uuid': 'string'
    },
    'vpcConfig': {
        'securityGroupIds': [
            'string',
        ],
        'subnetIds': [
            'string',
        ],
        'vpcId': 'string',
        'vpcOwnerAccountId': 'string'
    },
    'engineSettings': {...}|[...]|123|123.4|'string'|True|None,
    'sessionPolicy': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  The run's ARN.
- id (string) --
  
  The run's ID.
- cacheId (string) --
  
  The run cache associated with the run.
- cacheBehavior (string) --
  
  The run cache behavior for the run.
- engineVersion (string) --
  
  The actual Nextflow engine version that Amazon Web Services HealthOmics used for the run. The other workflow definition languages don't provide a value for this field.
- status (string) --
  
  The run's status.
- workflowId (string) --
  
  The run's workflow ID.
- workflowType (string) --
  
  The run's workflow type.
- runId (string) --
  
  The run's ID.
- roleArn (string) --
  
  The run's service role ARN.
- name (string) --
  
  The run's name.
- runGroupId (string) --
  
  The run's group ID.
- batchId (string) --
  
  The run's batch ID.
- priority (integer) --
  
  The run's priority.
- definition (string) --
  
  The run's definition.
- digest (string) --
  
  The run's digest.
- parameters (:ref:`document<document>`) --
  
  The run's parameters.
- storageCapacity (integer) --
  
  The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.
- outputUri (string) --
  
  The run's output URI.
- logLevel (string) --
  
  The run's log level.
- resourceDigests (dict) --
  
  The run's resource digests.
  - (string) --
    - (string) --
- startedBy (string) --
  
  Who started the run.
- creationTime (datetime) --
  
  When the run was created.
- startTime (datetime) --
  
  When the run started.
- stopTime (datetime) --
  
  The run's stop time.
- statusMessage (string) --
  
  The run's status message.
- tags (dict) --
  
  The run's tags.
  - (string) --
    - (string) --
- accelerators (string) --
  
  The computational accelerator used to run the workflow.
- retentionMode (string) --
  
  The run's retention mode.
- failureReason (string) --
  
  The reason a run has failed.
- logLocation (dict) --
  
  The location of the run log.
  - engineLogStream (string) --
    
    The log stream ARN for the engine log.
  - runLogStream (string) --
    
    The log stream ARN for the run log.
- uuid (string) --
  
  The universally unique identifier for a run.
- runOutputUri (string) --
  
  The destination for workflow outputs.
- storageType (string) --
  
  The run's storage type.
- workflowOwnerId (string) --
  
  The ID of the workflow owner.
- workflowVersionName (string) --
  
  The workflow version name.
- workflowUuid (string) --
  
  The universally unique identifier (UUID) value for the workflow.
- networkingMode (string) --
  
  Configuration for run networking behavior. If absent, this will default to RESTRICTED.
- scratchStorageMode (string) --
  
  Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If absent, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL.
- configuration (dict) --
  
  Configuration details for the workflow run.
  - name (string) --
    
    User-friendly name for the configuration.
  - arn (string) --
    
    Unique resource identifier for the configuration.
  - uuid (string) --
    
    Unique identifier for the configuration.
- vpcConfig (dict) --
  
  VPC configuration for the workflow run.
  - securityGroupIds (list) --
    
    List of security group IDs.
    - (string) --
  - subnetIds (list) --
    
    List of subnet IDs.
    - (string) --
  - vpcId (string) --
    
    VPC ID computed from the provided subnet IDs.
  - vpcOwnerAccountId (string) --
    
    The Amazon Web Services account ID of the cross-account VPC owner for RAM-shared VPC configurations.
- engineSettings (:ref:`document<document>`) --
  
  The engine-specific settings for the workflow run.
- sessionPolicy (string) --
  
  Inline policy json for scoping down permissions via a session policy on the IAM role.