{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-healthomics/json-schema/amazon-healthomics-get-workflow-response-schema.json",
  "title": "GetWorkflowResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-healthomics-workflow-api-openapi.yml#/components/schemas/GetWorkflowResponse",
  "type": "object",
  "properties": {
    "arn": {
      "type": "string",
      "description": "The workflow's ARN."
    },
    "id": {
      "type": "string",
      "description": "The workflow's ID."
    },
    "status": {
      "type": "string",
      "description": "The workflow's status."
    },
    "type": {
      "type": "string",
      "description": "The workflow's type."
    },
    "name": {
      "type": "string",
      "description": "The workflow's name."
    },
    "description": {
      "type": "string",
      "description": "The workflow's description."
    },
    "engine": {
      "type": "string",
      "description": "The workflow's engine."
    },
    "definition": {
      "type": "string",
      "description": "The workflow's definition."
    },
    "main": {
      "type": "string",
      "description": "The path of the main definition file for the workflow."
    },
    "digest": {
      "type": "string",
      "description": "The workflow's digest."
    },
    "parameterTemplate": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/WorkflowParameter"
      },
      "description": "The workflow's parameter template."
    },
    "storageCapacity": {
      "type": "integer",
      "description": "The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version."
    },
    "creationTime": {
      "type": "string",
      "format": "date-time",
      "description": "When the workflow was created."
    },
    "statusMessage": {
      "type": "string",
      "description": "The workflow's status message."
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The workflow's tags."
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Gets metadata for the workflow."
    },
    "accelerators": {
      "type": "string",
      "description": "The computational accelerator specified to run the workflow."
    },
    "storageType": {
      "type": "string",
      "description": "The default storage type for runs using this workflow."
    },
    "uuid": {
      "type": "string",
      "description": "The universally unique identifier (UUID) value for this workflow."
    },
    "containerRegistryMap": {
      "$ref": "#/$defs/ContainerRegistryMap"
    },
    "readme": {
      "type": "string",
      "description": "The README content for the workflow, providing documentation and usage information."
    },
    "definitionRepositoryDetails": {
      "$ref": "#/$defs/DefinitionRepositoryDetails"
    },
    "readmePath": {
      "type": "string",
      "description": "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."
    },
    "profiles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of Nextflow profiles that are available for this workflow. Profiles allow you to select predefined configuration settings at runtime."
    },
    "profileParameterTemplates": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/$defs/WorkflowParameter"
        }
      },
      "description": "A mapping of profile names to their parameter templates. Each profile defines its own set of parameters that you can use when starting a run with that profile."
    }
  },
  "$defs": {
    "ContainerRegistryMap": {
      "type": "object",
      "properties": {
        "registryMappings": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RegistryMapping"
          },
          "description": "Mapping that provides the ECR repository path where upstream container images are pulled and synchronized."
        },
        "imageMappings": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ImageMapping"
          },
          "description": "Image mappings specify path mappings between the ECR private repository and their corresponding external repositories."
        }
      }
    },
    "DefinitionRepositoryDetails": {
      "type": "object",
      "properties": {
        "connectionArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the connection to the source code repository."
        },
        "fullRepositoryId": {
          "type": "string",
          "description": "The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'."
        },
        "sourceReference": {
          "$ref": "#/$defs/SourceReference"
        },
        "providerType": {
          "type": "string",
          "description": "The provider type of the source code repository, such as Bitbucket, GitHub, GitHubEnterpriseServer, GitLab, and GitLabSelfManaged."
        },
        "providerEndpoint": {
          "type": "string",
          "description": "The endpoint URL of the source code repository provider."
        }
      }
    },
    "ImageMapping": {
      "type": "object",
      "properties": {
        "sourceImage": {
          "type": "string",
          "description": "Specifies the URI of the source image in the upstream registry."
        },
        "destinationImage": {
          "type": "string",
          "description": "Specifies the URI of the corresponding image in the private ECR registry."
        }
      }
    },
    "RegistryMapping": {
      "type": "object",
      "properties": {
        "upstreamRegistryUrl": {
          "type": "string",
          "description": "The URI of the upstream registry."
        },
        "ecrRepositoryPrefix": {
          "type": "string",
          "description": "The repository prefix to use in the ECR private repository."
        },
        "upstreamRepositoryPrefix": {
          "type": "string",
          "description": "The repository prefix of the corresponding repository in the upstream registry."
        },
        "ecrAccountId": {
          "type": "string",
          "description": "Account ID of the account that owns the upstream container image."
        },
        "credentialArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that holds the credentials for the upstream registry. You must specify this value when Amazon Elastic Container Registry (Amazon ECR) doesn't support pull through cache for the upstream registry. HealthOmics supports only some of these registries. The workflow role must have permission to call the secretsmanager:GetSecretValue operation on the secret. For more information about the supported registries, see Container images in the Amazon Web Services HealthOmics User Guide."
        }
      },
      "required": [
        "upstreamRegistryUrl",
        "ecrRepositoryPrefix"
      ]
    },
    "SourceReference": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "The type of source reference, such as branch, tag, or commit."
        },
        "value": {
          "type": "string",
          "description": "The value of the source reference, such as the branch name, tag name, or commit ID."
        }
      },
      "required": [
        "type",
        "value"
      ]
    },
    "WorkflowParameter": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "description": "The parameter's description."
        },
        "optional": {
          "type": "boolean",
          "description": "Whether the parameter is optional."
        }
      }
    }
  }
}