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

ListWorkflowVersions

Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in AWS HealthOmics in the AWS HealthOmics User Guide.

Request Syntax


GET /workflow/workflowId/version?maxResults=maxResults&startingToken=startingToken&type=type&workflowOwnerId=workflowOwnerId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of workflows to return in one page of results.

Valid Range: Minimum value of 1. Maximum value of 100.

startingToken

Specify the pagination token from a previous request to retrieve the next page of results.

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

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

type

The workflow type.

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

Valid Values: PRIVATE | READY2RUN

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

workflowOwnerId

The 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.

Pattern: [0-9]{12}

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "description": "string",
         "digest": "string",
         "metadata": { 
            "string" : "string" 
         },
         "status": "string",
         "type": "string",
         "versionName": "string",
         "workflowId": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

A list of workflow version items.

Type: Array of WorkflowVersionListItem objects

nextToken

A pagination token that's included if more results are available.

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}]+

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