Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateWorkflowVersion

Updates information about the workflow version. For more information, see Workflow versioning in AWS HealthOmics in the AWS HealthOmics User Guide.

Request Syntax


POST /workflow/workflowId/version/versionName HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "readmeMarkdown": "string",
   "storageCapacity": number,
   "storageType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

versionName

The name of the workflow version.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9][A-Za-z0-9\-\._]*

Required: Yes

workflowId

The workflow's ID. The workflowId is not the UUID.

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

Description of the workflow version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

readmeMarkdown

The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.

Type: String

Required: No

storageCapacity

The default static storage capacity (in gibibytes) for runs that use this workflow version. The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100000.

Required: No

storageType

The default storage type for runs that use this workflow version. The storageType can be overridden at run time. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see Run storage types in the in the AWS HealthOmics User Guide .

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: STATIC | DYNAMIC

Required: No

Response Syntax


HTTP/1.1 202

Response Elements

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request cannot be applied to the target resource in its current state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

RequestTimeoutException

The request timed out.

HTTP Status Code: 408

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ServiceQuotaExceededException

The request exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400