aws-sdk-omics 1.53.0 → 1.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -65,6 +65,7 @@ module Aws::Omics
65
65
  CompletionTime = Shapes::TimestampShape.new(name: 'CompletionTime', timestampFormat: "iso8601")
66
66
  ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
67
67
  ConnectionArn = Shapes::StringShape.new(name: 'ConnectionArn')
68
+ ContainerRegistryMap = Shapes::StructureShape.new(name: 'ContainerRegistryMap')
68
69
  CreateAnnotationStoreRequest = Shapes::StructureShape.new(name: 'CreateAnnotationStoreRequest')
69
70
  CreateAnnotationStoreResponse = Shapes::StructureShape.new(name: 'CreateAnnotationStoreResponse')
70
71
  CreateAnnotationStoreVersionRequest = Shapes::StructureShape.new(name: 'CreateAnnotationStoreVersionRequest')
@@ -123,6 +124,7 @@ module Aws::Omics
123
124
  ETag = Shapes::StructureShape.new(name: 'ETag')
124
125
  ETagAlgorithm = Shapes::StringShape.new(name: 'ETagAlgorithm')
125
126
  ETagAlgorithmFamily = Shapes::StringShape.new(name: 'ETagAlgorithmFamily')
127
+ EcrRepositoryPrefix = Shapes::StringShape.new(name: 'EcrRepositoryPrefix')
126
128
  Encoding = Shapes::StringShape.new(name: 'Encoding')
127
129
  EncryptionType = Shapes::StringShape.new(name: 'EncryptionType')
128
130
  EngineLogStream = Shapes::StringShape.new(name: 'EngineLogStream')
@@ -210,6 +212,9 @@ module Aws::Omics
210
212
  GetWorkflowVersionResponse = Shapes::StructureShape.new(name: 'GetWorkflowVersionResponse')
211
213
  GetWorkflowVersionResponseStorageCapacityInteger = Shapes::IntegerShape.new(name: 'GetWorkflowVersionResponseStorageCapacityInteger')
212
214
  Header = Shapes::BooleanShape.new(name: 'Header')
215
+ ImageDetails = Shapes::StructureShape.new(name: 'ImageDetails')
216
+ ImageMapping = Shapes::StructureShape.new(name: 'ImageMapping')
217
+ ImageMappingsList = Shapes::ListShape.new(name: 'ImageMappingsList')
213
218
  ImportJobId = Shapes::StringShape.new(name: 'ImportJobId')
214
219
  ImportReadSetFilter = Shapes::StructureShape.new(name: 'ImportReadSetFilter')
215
220
  ImportReadSetJobItem = Shapes::StructureShape.new(name: 'ImportReadSetJobItem')
@@ -381,6 +386,8 @@ module Aws::Omics
381
386
  ReferenceStoreId = Shapes::StringShape.new(name: 'ReferenceStoreId')
382
387
  ReferenceStoreName = Shapes::StringShape.new(name: 'ReferenceStoreName')
383
388
  ReferenceStreamingBlob = Shapes::BlobShape.new(name: 'ReferenceStreamingBlob', streaming: true)
389
+ RegistryMapping = Shapes::StructureShape.new(name: 'RegistryMapping')
390
+ RegistryMappingsList = Shapes::ListShape.new(name: 'RegistryMappingsList')
384
391
  RequestTimeoutException = Shapes::StructureShape.new(name: 'RequestTimeoutException')
385
392
  ResourceId = Shapes::StringShape.new(name: 'ResourceId')
386
393
  ResourceIdentifier = Shapes::StringShape.new(name: 'ResourceIdentifier')
@@ -514,6 +521,7 @@ module Aws::Omics
514
521
  TagValue = Shapes::StringShape.new(name: 'TagValue')
515
522
  TaskFailureReason = Shapes::StringShape.new(name: 'TaskFailureReason')
516
523
  TaskId = Shapes::StringShape.new(name: 'TaskId')
524
+ TaskImageDigest = Shapes::StringShape.new(name: 'TaskImageDigest')
517
525
  TaskInstanceType = Shapes::StringShape.new(name: 'TaskInstanceType')
518
526
  TaskList = Shapes::ListShape.new(name: 'TaskList')
519
527
  TaskListItem = Shapes::StructureShape.new(name: 'TaskListItem')
@@ -558,6 +566,8 @@ module Aws::Omics
558
566
  UploadReadSetPartRequest = Shapes::StructureShape.new(name: 'UploadReadSetPartRequest')
559
567
  UploadReadSetPartRequestPartNumberInteger = Shapes::IntegerShape.new(name: 'UploadReadSetPartRequestPartNumberInteger')
560
568
  UploadReadSetPartResponse = Shapes::StructureShape.new(name: 'UploadReadSetPartResponse')
569
+ UpstreamRepositoryPrefix = Shapes::StringShape.new(name: 'UpstreamRepositoryPrefix')
570
+ Uri = Shapes::StringShape.new(name: 'Uri')
561
571
  UserCustomDescription = Shapes::StringShape.new(name: 'UserCustomDescription')
562
572
  UserCustomName = Shapes::StringShape.new(name: 'UserCustomName')
563
573
  ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
@@ -746,6 +756,10 @@ module Aws::Omics
746
756
  ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
747
757
  ConflictException.struct_class = Types::ConflictException
748
758
 
759
+ ContainerRegistryMap.add_member(:registry_mappings, Shapes::ShapeRef.new(shape: RegistryMappingsList, location_name: "registryMappings"))
760
+ ContainerRegistryMap.add_member(:image_mappings, Shapes::ShapeRef.new(shape: ImageMappingsList, location_name: "imageMappings"))
761
+ ContainerRegistryMap.struct_class = Types::ContainerRegistryMap
762
+
749
763
  CreateAnnotationStoreRequest.add_member(:reference, Shapes::ShapeRef.new(shape: ReferenceItem, location_name: "reference"))
750
764
  CreateAnnotationStoreRequest.add_member(:name, Shapes::ShapeRef.new(shape: StoreName, location_name: "name"))
751
765
  CreateAnnotationStoreRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
@@ -912,6 +926,8 @@ module Aws::Omics
912
926
  CreateWorkflowRequest.add_member(:request_id, Shapes::ShapeRef.new(shape: WorkflowRequestId, required: true, location_name: "requestId", metadata: {"idempotencyToken" => true}))
913
927
  CreateWorkflowRequest.add_member(:accelerators, Shapes::ShapeRef.new(shape: Accelerators, location_name: "accelerators"))
914
928
  CreateWorkflowRequest.add_member(:storage_type, Shapes::ShapeRef.new(shape: StorageType, location_name: "storageType"))
929
+ CreateWorkflowRequest.add_member(:container_registry_map, Shapes::ShapeRef.new(shape: ContainerRegistryMap, location_name: "containerRegistryMap"))
930
+ CreateWorkflowRequest.add_member(:container_registry_map_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "containerRegistryMapUri"))
915
931
  CreateWorkflowRequest.add_member(:readme_markdown, Shapes::ShapeRef.new(shape: ReadmeMarkdown, location_name: "readmeMarkdown"))
916
932
  CreateWorkflowRequest.add_member(:parameter_template_path, Shapes::ShapeRef.new(shape: ParameterTemplatePath, location_name: "parameterTemplatePath"))
917
933
  CreateWorkflowRequest.add_member(:readme_path, Shapes::ShapeRef.new(shape: ReadmePath, location_name: "readmePath"))
@@ -941,6 +957,8 @@ module Aws::Omics
941
957
  CreateWorkflowVersionRequest.add_member(:storage_capacity, Shapes::ShapeRef.new(shape: CreateWorkflowVersionRequestStorageCapacityInteger, location_name: "storageCapacity"))
942
958
  CreateWorkflowVersionRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
943
959
  CreateWorkflowVersionRequest.add_member(:workflow_bucket_owner_id, Shapes::ShapeRef.new(shape: WorkflowBucketOwnerId, location_name: "workflowBucketOwnerId"))
960
+ CreateWorkflowVersionRequest.add_member(:container_registry_map, Shapes::ShapeRef.new(shape: ContainerRegistryMap, location_name: "containerRegistryMap"))
961
+ CreateWorkflowVersionRequest.add_member(:container_registry_map_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "containerRegistryMapUri"))
944
962
  CreateWorkflowVersionRequest.add_member(:readme_markdown, Shapes::ShapeRef.new(shape: ReadmeMarkdown, location_name: "readmeMarkdown"))
945
963
  CreateWorkflowVersionRequest.add_member(:parameter_template_path, Shapes::ShapeRef.new(shape: ParameterTemplatePath, location_name: "parameterTemplatePath"))
946
964
  CreateWorkflowVersionRequest.add_member(:readme_path, Shapes::ShapeRef.new(shape: ReadmePath, location_name: "readmePath"))
@@ -1365,6 +1383,7 @@ module Aws::Omics
1365
1383
  GetRunTaskResponse.add_member(:gpus, Shapes::ShapeRef.new(shape: GetRunTaskResponseGpusInteger, location_name: "gpus"))
1366
1384
  GetRunTaskResponse.add_member(:instance_type, Shapes::ShapeRef.new(shape: TaskInstanceType, location_name: "instanceType"))
1367
1385
  GetRunTaskResponse.add_member(:failure_reason, Shapes::ShapeRef.new(shape: TaskFailureReason, location_name: "failureReason"))
1386
+ GetRunTaskResponse.add_member(:image_details, Shapes::ShapeRef.new(shape: ImageDetails, location_name: "imageDetails"))
1368
1387
  GetRunTaskResponse.struct_class = Types::GetRunTaskResponse
1369
1388
 
1370
1389
  GetS3AccessPolicyRequest.add_member(:s3_access_point_arn, Shapes::ShapeRef.new(shape: S3AccessPointArn, required: true, location: "uri", location_name: "s3AccessPointArn"))
@@ -1459,6 +1478,7 @@ module Aws::Omics
1459
1478
  GetWorkflowResponse.add_member(:accelerators, Shapes::ShapeRef.new(shape: Accelerators, location_name: "accelerators"))
1460
1479
  GetWorkflowResponse.add_member(:storage_type, Shapes::ShapeRef.new(shape: StorageType, location_name: "storageType"))
1461
1480
  GetWorkflowResponse.add_member(:uuid, Shapes::ShapeRef.new(shape: WorkflowUuid, location_name: "uuid"))
1481
+ GetWorkflowResponse.add_member(:container_registry_map, Shapes::ShapeRef.new(shape: ContainerRegistryMap, location_name: "containerRegistryMap"))
1462
1482
  GetWorkflowResponse.add_member(:readme, Shapes::ShapeRef.new(shape: ReadmeS3PresignedUrl, location_name: "readme"))
1463
1483
  GetWorkflowResponse.add_member(:definition_repository_details, Shapes::ShapeRef.new(shape: DefinitionRepositoryDetails, location_name: "definitionRepositoryDetails"))
1464
1484
  GetWorkflowResponse.add_member(:readme_path, Shapes::ShapeRef.new(shape: ReadmePath, location_name: "readmePath"))
@@ -1491,11 +1511,23 @@ module Aws::Omics
1491
1511
  GetWorkflowVersionResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
1492
1512
  GetWorkflowVersionResponse.add_member(:uuid, Shapes::ShapeRef.new(shape: WorkflowUuid, location_name: "uuid"))
1493
1513
  GetWorkflowVersionResponse.add_member(:workflow_bucket_owner_id, Shapes::ShapeRef.new(shape: WorkflowBucketOwnerId, location_name: "workflowBucketOwnerId"))
1514
+ GetWorkflowVersionResponse.add_member(:container_registry_map, Shapes::ShapeRef.new(shape: ContainerRegistryMap, location_name: "containerRegistryMap"))
1494
1515
  GetWorkflowVersionResponse.add_member(:readme, Shapes::ShapeRef.new(shape: ReadmeS3PresignedUrl, location_name: "readme"))
1495
1516
  GetWorkflowVersionResponse.add_member(:definition_repository_details, Shapes::ShapeRef.new(shape: DefinitionRepositoryDetails, location_name: "definitionRepositoryDetails"))
1496
1517
  GetWorkflowVersionResponse.add_member(:readme_path, Shapes::ShapeRef.new(shape: ReadmePath, location_name: "readmePath"))
1497
1518
  GetWorkflowVersionResponse.struct_class = Types::GetWorkflowVersionResponse
1498
1519
 
1520
+ ImageDetails.add_member(:image, Shapes::ShapeRef.new(shape: Uri, location_name: "image"))
1521
+ ImageDetails.add_member(:image_digest, Shapes::ShapeRef.new(shape: TaskImageDigest, location_name: "imageDigest"))
1522
+ ImageDetails.add_member(:source_image, Shapes::ShapeRef.new(shape: Uri, location_name: "sourceImage"))
1523
+ ImageDetails.struct_class = Types::ImageDetails
1524
+
1525
+ ImageMapping.add_member(:source_image, Shapes::ShapeRef.new(shape: Uri, location_name: "sourceImage"))
1526
+ ImageMapping.add_member(:destination_image, Shapes::ShapeRef.new(shape: Uri, location_name: "destinationImage"))
1527
+ ImageMapping.struct_class = Types::ImageMapping
1528
+
1529
+ ImageMappingsList.member = Shapes::ShapeRef.new(shape: ImageMapping)
1530
+
1499
1531
  ImportReadSetFilter.add_member(:status, Shapes::ShapeRef.new(shape: ReadSetImportJobStatus, location_name: "status"))
1500
1532
  ImportReadSetFilter.add_member(:created_after, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, location_name: "createdAfter"))
1501
1533
  ImportReadSetFilter.add_member(:created_before, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, location_name: "createdBefore"))
@@ -1953,6 +1985,14 @@ module Aws::Omics
1953
1985
  ReferenceStoreFilter.add_member(:created_before, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, location_name: "createdBefore"))
1954
1986
  ReferenceStoreFilter.struct_class = Types::ReferenceStoreFilter
1955
1987
 
1988
+ RegistryMapping.add_member(:upstream_registry_url, Shapes::ShapeRef.new(shape: Uri, location_name: "upstreamRegistryUrl"))
1989
+ RegistryMapping.add_member(:ecr_repository_prefix, Shapes::ShapeRef.new(shape: EcrRepositoryPrefix, location_name: "ecrRepositoryPrefix"))
1990
+ RegistryMapping.add_member(:upstream_repository_prefix, Shapes::ShapeRef.new(shape: UpstreamRepositoryPrefix, location_name: "upstreamRepositoryPrefix"))
1991
+ RegistryMapping.add_member(:ecr_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, location_name: "ecrAccountId"))
1992
+ RegistryMapping.struct_class = Types::RegistryMapping
1993
+
1994
+ RegistryMappingsList.member = Shapes::ShapeRef.new(shape: RegistryMapping)
1995
+
1956
1996
  RequestTimeoutException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
1957
1997
  RequestTimeoutException.struct_class = Types::RequestTimeoutException
1958
1998
 
@@ -2178,7 +2218,7 @@ module Aws::Omics
2178
2218
  StartRunRequest.add_member(:priority, Shapes::ShapeRef.new(shape: StartRunRequestPriorityInteger, location_name: "priority"))
2179
2219
  StartRunRequest.add_member(:parameters, Shapes::ShapeRef.new(shape: RunParameters, location_name: "parameters"))
2180
2220
  StartRunRequest.add_member(:storage_capacity, Shapes::ShapeRef.new(shape: StartRunRequestStorageCapacityInteger, location_name: "storageCapacity"))
2181
- StartRunRequest.add_member(:output_uri, Shapes::ShapeRef.new(shape: RunOutputUri, location_name: "outputUri"))
2221
+ StartRunRequest.add_member(:output_uri, Shapes::ShapeRef.new(shape: RunOutputUri, required: true, location_name: "outputUri"))
2182
2222
  StartRunRequest.add_member(:log_level, Shapes::ShapeRef.new(shape: RunLogLevel, location_name: "logLevel"))
2183
2223
  StartRunRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
2184
2224
  StartRunRequest.add_member(:request_id, Shapes::ShapeRef.new(shape: RunRequestId, required: true, location_name: "requestId", metadata: {"idempotencyToken" => true}))
@@ -525,6 +525,34 @@ module Aws::Omics
525
525
  include Aws::Structure
526
526
  end
527
527
 
528
+ # Use a container registry map to specify mappings between the ECR
529
+ # private repository and one or more upstream registries. For more
530
+ # information, see [Container images][1] in the *Amazon Web Services
531
+ # HealthOmics User Guide*.
532
+ #
533
+ #
534
+ #
535
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html
536
+ #
537
+ # @!attribute [rw] registry_mappings
538
+ # Mapping that provides the ECR repository path where upstream
539
+ # container images are pulled and synchronized.
540
+ # @return [Array<Types::RegistryMapping>]
541
+ #
542
+ # @!attribute [rw] image_mappings
543
+ # Image mappings specify path mappings between the ECR private
544
+ # repository and their corresponding external repositories.
545
+ # @return [Array<Types::ImageMapping>]
546
+ #
547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ContainerRegistryMap AWS API Documentation
548
+ #
549
+ class ContainerRegistryMap < Struct.new(
550
+ :registry_mappings,
551
+ :image_mappings)
552
+ SENSITIVE = []
553
+ include Aws::Structure
554
+ end
555
+
528
556
  # @!attribute [rw] reference
529
557
  # The genome reference for the store's annotations.
530
558
  # @return [Types::ReferenceItem]
@@ -1077,12 +1105,12 @@ module Aws::Omics
1077
1105
  # @return [Types::SseConfig]
1078
1106
  #
1079
1107
  # @!attribute [rw] tags
1080
- # Tags for the store.
1108
+ # Tags for the store. You can configure up to 50 tags.
1081
1109
  # @return [Hash<String,String>]
1082
1110
  #
1083
1111
  # @!attribute [rw] client_token
1084
- # To ensure that requests don't run multiple times, specify a unique
1085
- # token for each request.
1112
+ # An idempotency token used to dedupe retry requests so that duplicate
1113
+ # runs are not created.
1086
1114
  #
1087
1115
  # **A suitable default value is auto-generated.** You should normally
1088
1116
  # not need to pass this option.
@@ -1090,20 +1118,31 @@ module Aws::Omics
1090
1118
  #
1091
1119
  # @!attribute [rw] fallback_location
1092
1120
  # An S3 location that is used to store files that have failed a direct
1093
- # upload.
1121
+ # upload. You can add or change the `fallbackLocation` after creating
1122
+ # a sequence store. This is not required if you are uploading files
1123
+ # from a different S3 bucket.
1094
1124
  # @return [String]
1095
1125
  #
1096
1126
  # @!attribute [rw] e_tag_algorithm_family
1097
- # The ETag algorithm family to use for ingested read sets.
1127
+ # The ETag algorithm family to use for ingested read sets. The default
1128
+ # value is MD5up. For more information on ETags, see [ETags and data
1129
+ # provenance][1] in the *Amazon Web Services HealthOmics User Guide*.
1130
+ #
1131
+ #
1132
+ #
1133
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/etags-and-provenance.html
1098
1134
  # @return [String]
1099
1135
  #
1100
1136
  # @!attribute [rw] propagated_set_level_tags
1101
1137
  # The tags keys to propagate to the S3 objects associated with read
1102
- # sets in the sequence store.
1138
+ # sets in the sequence store. These tags can be used as input to add
1139
+ # metadata to your read sets.
1103
1140
  # @return [Array<String>]
1104
1141
  #
1105
1142
  # @!attribute [rw] s3_access_config
1106
- # S3 access configuration parameters
1143
+ # S3 access configuration parameters. This specifies the parameters
1144
+ # needed to access logs stored in S3 buckets. The S3 bucket must be in
1145
+ # the same region and account as the sequence store.
1107
1146
  # @return [Types::S3AccessConfig]
1108
1147
  #
1109
1148
  # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateSequenceStoreRequest AWS API Documentation
@@ -1139,7 +1178,8 @@ module Aws::Omics
1139
1178
  # @return [String]
1140
1179
  #
1141
1180
  # @!attribute [rw] sse_config
1142
- # The store's SSE settings.
1181
+ # Server-side encryption (SSE) settings for the store. This contains
1182
+ # the KMS key ARN that is used to encrypt read set objects.
1143
1183
  # @return [Types::SseConfig]
1144
1184
  #
1145
1185
  # @!attribute [rw] creation_time
@@ -1398,6 +1438,21 @@ module Aws::Omics
1398
1438
  # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
1399
1439
  # @return [String]
1400
1440
  #
1441
+ # @!attribute [rw] container_registry_map
1442
+ # (Optional) Use a container registry map to specify mappings between
1443
+ # the ECR private repository and one or more upstream registries. For
1444
+ # more information, see [Container images][1] in the *Amazon Web
1445
+ # Services HealthOmics User Guide*.
1446
+ #
1447
+ #
1448
+ #
1449
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html
1450
+ # @return [Types::ContainerRegistryMap]
1451
+ #
1452
+ # @!attribute [rw] container_registry_map_uri
1453
+ # (Optional) URI of the S3 location for the registry mapping file.
1454
+ # @return [String]
1455
+ #
1401
1456
  # @!attribute [rw] readme_markdown
1402
1457
  # The markdown content for the workflow's README file. This provides
1403
1458
  # documentation and usage information for users of the workflow.
@@ -1456,6 +1511,8 @@ module Aws::Omics
1456
1511
  :request_id,
1457
1512
  :accelerators,
1458
1513
  :storage_type,
1514
+ :container_registry_map,
1515
+ :container_registry_map_uri,
1459
1516
  :readme_markdown,
1460
1517
  :parameter_template_path,
1461
1518
  :readme_path,
@@ -1499,7 +1556,8 @@ module Aws::Omics
1499
1556
  end
1500
1557
 
1501
1558
  # @!attribute [rw] workflow_id
1502
- # The ID of the workflow where you are creating the new version.
1559
+ # The ID of the workflow where you are creating the new version. The
1560
+ # `workflowId` is not the UUID.
1503
1561
  # @return [String]
1504
1562
  #
1505
1563
  # @!attribute [rw] version_name
@@ -1516,13 +1574,16 @@ module Aws::Omics
1516
1574
  # @return [String]
1517
1575
  #
1518
1576
  # @!attribute [rw] definition_zip
1519
- # A zip archive containing the workflow definition for this workflow
1520
- # version.
1577
+ # A ZIP archive containing the main workflow definition file and
1578
+ # dependencies that it imports for this workflow version. You can use
1579
+ # a file with a ://fileb prefix instead of the Base64 string. For more
1580
+ # information, see Workflow definition requirements in the *Amazon Web
1581
+ # Services HealthOmics User Guide*.
1521
1582
  # @return [String]
1522
1583
  #
1523
1584
  # @!attribute [rw] definition_uri
1524
- # The URI specifies the location of the workflow definition for this
1525
- # workflow version.
1585
+ # The S3 URI of a definition for this workflow version. The S3 bucket
1586
+ # must be in the same region as this workflow version.
1526
1587
  # @return [String]
1527
1588
  #
1528
1589
  # @!attribute [rw] accelerators
@@ -1534,46 +1595,70 @@ module Aws::Omics
1534
1595
  # @return [String]
1535
1596
  #
1536
1597
  # @!attribute [rw] engine
1537
- # The workflow engine for this workflow version.
1598
+ # The workflow engine for this workflow version. This is only required
1599
+ # if you have workflow definition files from more than one engine in
1600
+ # your zip file. Otherwise, the service can detect the engine
1601
+ # automatically from your workflow definition.
1538
1602
  # @return [String]
1539
1603
  #
1540
1604
  # @!attribute [rw] main
1541
- # The path of the main definition file for this workflow version.
1605
+ # The path of the main definition file for this workflow version. This
1606
+ # parameter is not required if the ZIP archive contains only one
1607
+ # workflow definition file, or if the main definition file is named
1608
+ # “main”. An example path is: `workflow-definition/main-file.wdl`.
1542
1609
  # @return [String]
1543
1610
  #
1544
1611
  # @!attribute [rw] parameter_template
1545
- # The parameter template defines the input parameters for runs that
1546
- # use this workflow version.
1612
+ # A parameter template for this workflow version. If this field is
1613
+ # blank, Amazon Web Services HealthOmics will automatically parse the
1614
+ # parameter template values from your workflow definition file. To
1615
+ # override these service generated default values, provide a parameter
1616
+ # template. To view an example of a parameter template, see [Parameter
1617
+ # template files][1] in the *Amazon Web Services HealthOmics User
1618
+ # Guide*.
1619
+ #
1620
+ #
1621
+ #
1622
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html
1547
1623
  # @return [Hash<String,Types::WorkflowParameter>]
1548
1624
  #
1549
1625
  # @!attribute [rw] request_id
1550
- # To ensure that requests don't run multiple times, specify a unique
1551
- # ID for each request.
1626
+ # An idempotency token to ensure that duplicate workflows are not
1627
+ # created when Amazon Web Services HealthOmics submits retry requests.
1552
1628
  #
1553
1629
  # **A suitable default value is auto-generated.** You should normally
1554
1630
  # not need to pass this option.
1555
1631
  # @return [String]
1556
1632
  #
1557
1633
  # @!attribute [rw] storage_type
1558
- # The default storage type for runs that use this workflow. STATIC
1559
- # storage allocates a fixed amount of storage. DYNAMIC storage
1634
+ # The default storage type for runs that use this workflow version.
1635
+ # The `storageType` can be overridden at run time. `DYNAMIC` storage
1560
1636
  # dynamically scales the storage up or down, based on file system
1561
- # utilization. For more information about static and dynamic storage,
1562
- # see [Running workflows][1] in the *Amazon Web Services HealthOmics
1563
- # User Guide*.
1637
+ # utilization. STATIC storage allocates a fixed amount of storage. For
1638
+ # more information about dynamic and static storage types, see [Run
1639
+ # storage types][1] in the *Amazon Web Services HealthOmics User
1640
+ # Guide*.
1564
1641
  #
1565
1642
  #
1566
1643
  #
1567
- # [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
1644
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
1568
1645
  # @return [String]
1569
1646
  #
1570
1647
  # @!attribute [rw] storage_capacity
1571
1648
  # The default static storage capacity (in gibibytes) for runs that use
1572
- # this workflow or workflow version.
1649
+ # this workflow version. The `storageCapacity` can be overwritten at
1650
+ # run time. The storage capacity is not required for runs with a
1651
+ # `DYNAMIC` storage type.
1573
1652
  # @return [Integer]
1574
1653
  #
1575
1654
  # @!attribute [rw] tags
1576
- # Optional tags to associate with this workflow version.
1655
+ # Tags for this workflow version. You can define up to 50 tags for the
1656
+ # workflow. For more information, see [Adding a tag][1] in the *Amazon
1657
+ # Web Services HealthOmics User Guide*.
1658
+ #
1659
+ #
1660
+ #
1661
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html
1577
1662
  # @return [Hash<String,String>]
1578
1663
  #
1579
1664
  # @!attribute [rw] workflow_bucket_owner_id
@@ -1582,6 +1667,21 @@ module Aws::Omics
1582
1667
  # account is not the bucket owner.
1583
1668
  # @return [String]
1584
1669
  #
1670
+ # @!attribute [rw] container_registry_map
1671
+ # (Optional) Use a container registry map to specify mappings between
1672
+ # the ECR private repository and one or more upstream registries. For
1673
+ # more information, see [Container images][1] in the *Amazon Web
1674
+ # Services HealthOmics User Guide*.
1675
+ #
1676
+ #
1677
+ #
1678
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html
1679
+ # @return [Types::ContainerRegistryMap]
1680
+ #
1681
+ # @!attribute [rw] container_registry_map_uri
1682
+ # (Optional) URI of the S3 location for the registry mapping file.
1683
+ # @return [String]
1684
+ #
1585
1685
  # @!attribute [rw] readme_markdown
1586
1686
  # The markdown content for the workflow version's README file. This
1587
1687
  # provides documentation and usage information for users of this
@@ -1637,6 +1737,8 @@ module Aws::Omics
1637
1737
  :storage_capacity,
1638
1738
  :tags,
1639
1739
  :workflow_bucket_owner_id,
1740
+ :container_registry_map,
1741
+ :container_registry_map_uri,
1640
1742
  :readme_markdown,
1641
1743
  :parameter_template_path,
1642
1744
  :readme_path,
@@ -3490,6 +3592,10 @@ module Aws::Omics
3490
3592
  # The reason a task has failed.
3491
3593
  # @return [String]
3492
3594
  #
3595
+ # @!attribute [rw] image_details
3596
+ # Details about the container image that this task uses.
3597
+ # @return [Types::ImageDetails]
3598
+ #
3493
3599
  # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetRunTaskResponse AWS API Documentation
3494
3600
  #
3495
3601
  class GetRunTaskResponse < Struct.new(
@@ -3507,7 +3613,8 @@ module Aws::Omics
3507
3613
  :log_stream,
3508
3614
  :gpus,
3509
3615
  :instance_type,
3510
- :failure_reason)
3616
+ :failure_reason,
3617
+ :image_details)
3511
3618
  SENSITIVE = []
3512
3619
  include Aws::Structure
3513
3620
  end
@@ -3926,6 +4033,10 @@ module Aws::Omics
3926
4033
  # The universally unique identifier (UUID) value for this workflow.
3927
4034
  # @return [String]
3928
4035
  #
4036
+ # @!attribute [rw] container_registry_map
4037
+ # The registry map that this workflow is using.
4038
+ # @return [Types::ContainerRegistryMap]
4039
+ #
3929
4040
  # @!attribute [rw] readme
3930
4041
  # The README content for the workflow, providing documentation and
3931
4042
  # usage information.
@@ -3965,6 +4076,7 @@ module Aws::Omics
3965
4076
  :accelerators,
3966
4077
  :storage_type,
3967
4078
  :uuid,
4079
+ :container_registry_map,
3968
4080
  :readme,
3969
4081
  :definition_repository_details,
3970
4082
  :readme_path)
@@ -3973,7 +4085,7 @@ module Aws::Omics
3973
4085
  end
3974
4086
 
3975
4087
  # @!attribute [rw] workflow_id
3976
- # The workflow's ID.
4088
+ # The workflow's ID. The `workflowId` is not the UUID.
3977
4089
  # @return [String]
3978
4090
  #
3979
4091
  # @!attribute [rw] version_name
@@ -3989,7 +4101,9 @@ module Aws::Omics
3989
4101
  # @return [Array<String>]
3990
4102
  #
3991
4103
  # @!attribute [rw] workflow_owner_id
3992
- # Amazon Web Services Id of the owner of the workflow.
4104
+ # The 12-digit account ID of the workflow owner. The workflow owner ID
4105
+ # can be retrieved using the `GetShare` API operation. If you are the
4106
+ # workflow owner, you do not need to include this ID.
3993
4107
  # @return [String]
3994
4108
  #
3995
4109
  # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetWorkflowVersionRequest AWS API Documentation
@@ -4085,6 +4199,10 @@ module Aws::Omics
4085
4199
  # Amazon Web Services Id of the owner of the bucket.
4086
4200
  # @return [String]
4087
4201
  #
4202
+ # @!attribute [rw] container_registry_map
4203
+ # The registry map that this workflow version uses.
4204
+ # @return [Types::ContainerRegistryMap]
4205
+ #
4088
4206
  # @!attribute [rw] readme
4089
4207
  # The README content for the workflow version, providing documentation
4090
4208
  # and usage information specific to this version.
@@ -4125,6 +4243,7 @@ module Aws::Omics
4125
4243
  :tags,
4126
4244
  :uuid,
4127
4245
  :workflow_bucket_owner_id,
4246
+ :container_registry_map,
4128
4247
  :readme,
4129
4248
  :definition_repository_details,
4130
4249
  :readme_path)
@@ -4132,6 +4251,59 @@ module Aws::Omics
4132
4251
  include Aws::Structure
4133
4252
  end
4134
4253
 
4254
+ # Information about the container image used for a task.
4255
+ #
4256
+ # @!attribute [rw] image
4257
+ # The URI of the container image.
4258
+ # @return [String]
4259
+ #
4260
+ # @!attribute [rw] image_digest
4261
+ # The container image digest. If the image URI was transformed, this
4262
+ # will be the digest of the container image referenced by the
4263
+ # transformed URI.
4264
+ # @return [String]
4265
+ #
4266
+ # @!attribute [rw] source_image
4267
+ # URI of the source registry. If the URI is from a third-party
4268
+ # registry, Amazon Web Services HealthOmics transforms the URI to the
4269
+ # corresponding ECR path, using the pull-through cache mapping rules.
4270
+ # @return [String]
4271
+ #
4272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ImageDetails AWS API Documentation
4273
+ #
4274
+ class ImageDetails < Struct.new(
4275
+ :image,
4276
+ :image_digest,
4277
+ :source_image)
4278
+ SENSITIVE = []
4279
+ include Aws::Structure
4280
+ end
4281
+
4282
+ # Specifies image mappings that workflow tasks can use. For example, you
4283
+ # can replace all the task references of a public image to use an
4284
+ # equivalent image in your private ECR repository. You can use image
4285
+ # mappings with upstream registries that don't support pull through
4286
+ # cache. You need to manually synchronize the upstream registry with
4287
+ # your private repository.
4288
+ #
4289
+ # @!attribute [rw] source_image
4290
+ # Specifies the URI of the source image in the upstream registry.
4291
+ # @return [String]
4292
+ #
4293
+ # @!attribute [rw] destination_image
4294
+ # Specifies the URI of the corresponding image in the private ECR
4295
+ # registry.
4296
+ # @return [String]
4297
+ #
4298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ImageMapping AWS API Documentation
4299
+ #
4300
+ class ImageMapping < Struct.new(
4301
+ :source_image,
4302
+ :destination_image)
4303
+ SENSITIVE = []
4304
+ include Aws::Structure
4305
+ end
4306
+
4135
4307
  # A filter for import read set jobs.
4136
4308
  #
4137
4309
  # @!attribute [rw] status
@@ -5390,7 +5562,7 @@ module Aws::Omics
5390
5562
  end
5391
5563
 
5392
5564
  # @!attribute [rw] workflow_id
5393
- # The workflow's ID.
5565
+ # The workflow's ID. The `workflowId` is not the UUID.
5394
5566
  # @return [String]
5395
5567
  #
5396
5568
  # @!attribute [rw] type
@@ -5398,7 +5570,9 @@ module Aws::Omics
5398
5570
  # @return [String]
5399
5571
  #
5400
5572
  # @!attribute [rw] workflow_owner_id
5401
- # Amazon Web Services Id of the owner of the workflow.
5573
+ # The 12-digit account ID of the workflow owner. The workflow owner ID
5574
+ # can be retrieved using the `GetShare` API operation. If you are the
5575
+ # workflow owner, you do not need to include this ID.
5402
5576
  # @return [String]
5403
5577
  #
5404
5578
  # @!attribute [rw] starting_token
@@ -6122,6 +6296,38 @@ module Aws::Omics
6122
6296
  include Aws::Structure
6123
6297
  end
6124
6298
 
6299
+ # If you are using the ECR pull through cache feature, the registry
6300
+ # mapping maps between the ECR repository and the upstream registry
6301
+ # where container images are pulled and synchronized.
6302
+ #
6303
+ # @!attribute [rw] upstream_registry_url
6304
+ # The URI of the upstream registry.
6305
+ # @return [String]
6306
+ #
6307
+ # @!attribute [rw] ecr_repository_prefix
6308
+ # The repository prefix to use in the ECR private repository.
6309
+ # @return [String]
6310
+ #
6311
+ # @!attribute [rw] upstream_repository_prefix
6312
+ # The repository prefix of the corresponding repository in the
6313
+ # upstream registry.
6314
+ # @return [String]
6315
+ #
6316
+ # @!attribute [rw] ecr_account_id
6317
+ # Account ID of the account that owns the upstream container image.
6318
+ # @return [String]
6319
+ #
6320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/RegistryMapping AWS API Documentation
6321
+ #
6322
+ class RegistryMapping < Struct.new(
6323
+ :upstream_registry_url,
6324
+ :ecr_repository_prefix,
6325
+ :upstream_repository_prefix,
6326
+ :ecr_account_id)
6327
+ SENSITIVE = []
6328
+ include Aws::Structure
6329
+ end
6330
+
6125
6331
  # The request timed out.
6126
6332
  #
6127
6333
  # @!attribute [rw] message
@@ -7939,7 +8145,7 @@ module Aws::Omics
7939
8145
  end
7940
8146
 
7941
8147
  # @!attribute [rw] workflow_id
7942
- # The workflow's ID.
8148
+ # The workflow's ID. The `workflowId` is not the UUID.
7943
8149
  # @return [String]
7944
8150
  #
7945
8151
  # @!attribute [rw] version_name
@@ -7951,21 +8157,24 @@ module Aws::Omics
7951
8157
  # @return [String]
7952
8158
  #
7953
8159
  # @!attribute [rw] storage_type
7954
- # The default storage type for runs that use this workflow. STATIC
7955
- # storage allocates a fixed amount of storage. DYNAMIC storage
8160
+ # The default storage type for runs that use this workflow version.
8161
+ # The `storageType` can be overridden at run time. `DYNAMIC` storage
7956
8162
  # dynamically scales the storage up or down, based on file system
7957
- # utilization. For more information about static and dynamic storage,
7958
- # see [Running workflows][1] in the *Amazon Web Services HealthOmics
7959
- # User Guide*.
8163
+ # utilization. STATIC storage allocates a fixed amount of storage. For
8164
+ # more information about dynamic and static storage types, see [Run
8165
+ # storage types][1] in the <i>in the <i>Amazon Web Services
8166
+ # HealthOmics User Guide</i> </i>.
7960
8167
  #
7961
8168
  #
7962
8169
  #
7963
- # [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
8170
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
7964
8171
  # @return [String]
7965
8172
  #
7966
8173
  # @!attribute [rw] storage_capacity
7967
8174
  # The default static storage capacity (in gibibytes) for runs that use
7968
- # this workflow or workflow version.
8175
+ # this workflow version. The `storageCapacity` can be overwritten at
8176
+ # run time. The storage capacity is not required for runs with a
8177
+ # `DYNAMIC` storage type.
7969
8178
  # @return [Integer]
7970
8179
  #
7971
8180
  # @!attribute [rw] readme_markdown
data/lib/aws-sdk-omics.rb CHANGED
@@ -55,7 +55,7 @@ module Aws::Omics
55
55
  autoload :EndpointProvider, 'aws-sdk-omics/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-omics/endpoints'
57
57
 
58
- GEM_VERSION = '1.53.0'
58
+ GEM_VERSION = '1.55.0'
59
59
 
60
60
  end
61
61