aws-sdk-omics 1.63.0 → 1.65.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-omics/client.rb +712 -95
- data/lib/aws-sdk-omics/client_api.rb +533 -3
- data/lib/aws-sdk-omics/types.rb +1100 -10
- data/lib/aws-sdk-omics.rb +1 -1
- data/sig/client.rbs +202 -1
- data/sig/types.rbs +289 -0
- metadata +1 -1
data/lib/aws-sdk-omics/types.rb
CHANGED
|
@@ -406,6 +406,83 @@ module Aws::Omics
|
|
|
406
406
|
include Aws::Structure
|
|
407
407
|
end
|
|
408
408
|
|
|
409
|
+
# A summary of a batch returned by `ListBatch`.
|
|
410
|
+
#
|
|
411
|
+
# @!attribute [rw] id
|
|
412
|
+
# The batch identifier.
|
|
413
|
+
# @return [String]
|
|
414
|
+
#
|
|
415
|
+
# @!attribute [rw] name
|
|
416
|
+
# The batch name.
|
|
417
|
+
# @return [String]
|
|
418
|
+
#
|
|
419
|
+
# @!attribute [rw] status
|
|
420
|
+
# The current batch status.
|
|
421
|
+
# @return [String]
|
|
422
|
+
#
|
|
423
|
+
# @!attribute [rw] created_at
|
|
424
|
+
# The timestamp when the batch was created.
|
|
425
|
+
# @return [Time]
|
|
426
|
+
#
|
|
427
|
+
# @!attribute [rw] total_runs
|
|
428
|
+
# The total number of runs in the batch.
|
|
429
|
+
# @return [Integer]
|
|
430
|
+
#
|
|
431
|
+
# @!attribute [rw] workflow_id
|
|
432
|
+
# The identifier of the workflow used for the batch.
|
|
433
|
+
# @return [String]
|
|
434
|
+
#
|
|
435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/BatchListItem AWS API Documentation
|
|
436
|
+
#
|
|
437
|
+
class BatchListItem < Struct.new(
|
|
438
|
+
:id,
|
|
439
|
+
:name,
|
|
440
|
+
:status,
|
|
441
|
+
:created_at,
|
|
442
|
+
:total_runs,
|
|
443
|
+
:workflow_id)
|
|
444
|
+
SENSITIVE = []
|
|
445
|
+
include Aws::Structure
|
|
446
|
+
end
|
|
447
|
+
|
|
448
|
+
# A union type representing per-run configurations for the batch.
|
|
449
|
+
# Specify exactly one of the following members.
|
|
450
|
+
#
|
|
451
|
+
# @note BatchRunSettings is a union - when making an API calls you must set exactly one of the members.
|
|
452
|
+
#
|
|
453
|
+
# @!attribute [rw] inline_settings
|
|
454
|
+
# A list of per-run configurations provided inline in the request.
|
|
455
|
+
# Each entry must include a unique `runSettingId`. Supports up to 100
|
|
456
|
+
# entries. For batches with more than 100 runs, use `s3UriSettings`.
|
|
457
|
+
# @return [Array<Types::InlineSetting>]
|
|
458
|
+
#
|
|
459
|
+
# @!attribute [rw] s3_uri_settings
|
|
460
|
+
# An Amazon S3 URI pointing to a JSON file containing per-run
|
|
461
|
+
# configurations. The file must be a JSON array in the same format as
|
|
462
|
+
# `inlineSettings`. Supports up to 100,000 run configurations. The
|
|
463
|
+
# maximum file size is 6 GB.
|
|
464
|
+
#
|
|
465
|
+
# The IAM service role in `roleArn` must have read access to this S3
|
|
466
|
+
# object. HealthOmics validates access to the file during the
|
|
467
|
+
# synchronous API call and records the file's ETag. If the file is
|
|
468
|
+
# modified after submission, the batch fails.
|
|
469
|
+
# @return [String]
|
|
470
|
+
#
|
|
471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/BatchRunSettings AWS API Documentation
|
|
472
|
+
#
|
|
473
|
+
class BatchRunSettings < Struct.new(
|
|
474
|
+
:inline_settings,
|
|
475
|
+
:s3_uri_settings,
|
|
476
|
+
:unknown)
|
|
477
|
+
SENSITIVE = []
|
|
478
|
+
include Aws::Structure
|
|
479
|
+
include Aws::Structure::Union
|
|
480
|
+
|
|
481
|
+
class InlineSettings < BatchRunSettings; end
|
|
482
|
+
class S3UriSettings < BatchRunSettings; end
|
|
483
|
+
class Unknown < BatchRunSettings; end
|
|
484
|
+
end
|
|
485
|
+
|
|
409
486
|
# @!attribute [rw] job_id
|
|
410
487
|
# The job's ID.
|
|
411
488
|
# @return [String]
|
|
@@ -422,6 +499,22 @@ module Aws::Omics
|
|
|
422
499
|
#
|
|
423
500
|
class CancelAnnotationImportResponse < Aws::EmptyStructure; end
|
|
424
501
|
|
|
502
|
+
# @!attribute [rw] batch_id
|
|
503
|
+
# The identifier portion of the run batch ARN.
|
|
504
|
+
# @return [String]
|
|
505
|
+
#
|
|
506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CancelRunBatchRequest AWS API Documentation
|
|
507
|
+
#
|
|
508
|
+
class CancelRunBatchRequest < Struct.new(
|
|
509
|
+
:batch_id)
|
|
510
|
+
SENSITIVE = []
|
|
511
|
+
include Aws::Structure
|
|
512
|
+
end
|
|
513
|
+
|
|
514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CancelRunBatchResponse AWS API Documentation
|
|
515
|
+
#
|
|
516
|
+
class CancelRunBatchResponse < Aws::EmptyStructure; end
|
|
517
|
+
|
|
425
518
|
# @!attribute [rw] id
|
|
426
519
|
# The run's ID.
|
|
427
520
|
# @return [String]
|
|
@@ -511,6 +604,64 @@ module Aws::Omics
|
|
|
511
604
|
include Aws::Structure
|
|
512
605
|
end
|
|
513
606
|
|
|
607
|
+
# Minimal details for a configuration resource.
|
|
608
|
+
#
|
|
609
|
+
# @!attribute [rw] name
|
|
610
|
+
# User-friendly name for the configuration.
|
|
611
|
+
# @return [String]
|
|
612
|
+
#
|
|
613
|
+
# @!attribute [rw] arn
|
|
614
|
+
# Unique resource identifier for the configuration.
|
|
615
|
+
# @return [String]
|
|
616
|
+
#
|
|
617
|
+
# @!attribute [rw] uuid
|
|
618
|
+
# Unique identifier for the configuration.
|
|
619
|
+
# @return [String]
|
|
620
|
+
#
|
|
621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ConfigurationDetails AWS API Documentation
|
|
622
|
+
#
|
|
623
|
+
class ConfigurationDetails < Struct.new(
|
|
624
|
+
:name,
|
|
625
|
+
:arn,
|
|
626
|
+
:uuid)
|
|
627
|
+
SENSITIVE = []
|
|
628
|
+
include Aws::Structure
|
|
629
|
+
end
|
|
630
|
+
|
|
631
|
+
# Configuration list item with summary information.
|
|
632
|
+
#
|
|
633
|
+
# @!attribute [rw] arn
|
|
634
|
+
# Unique resource identifier for the configuration.
|
|
635
|
+
# @return [String]
|
|
636
|
+
#
|
|
637
|
+
# @!attribute [rw] name
|
|
638
|
+
# User-friendly name for the configuration.
|
|
639
|
+
# @return [String]
|
|
640
|
+
#
|
|
641
|
+
# @!attribute [rw] description
|
|
642
|
+
# Description for the configuration.
|
|
643
|
+
# @return [String]
|
|
644
|
+
#
|
|
645
|
+
# @!attribute [rw] status
|
|
646
|
+
# Current configuration status.
|
|
647
|
+
# @return [String]
|
|
648
|
+
#
|
|
649
|
+
# @!attribute [rw] creation_time
|
|
650
|
+
# Configuration creation timestamp.
|
|
651
|
+
# @return [Time]
|
|
652
|
+
#
|
|
653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ConfigurationListItem AWS API Documentation
|
|
654
|
+
#
|
|
655
|
+
class ConfigurationListItem < Struct.new(
|
|
656
|
+
:arn,
|
|
657
|
+
:name,
|
|
658
|
+
:description,
|
|
659
|
+
:status,
|
|
660
|
+
:creation_time)
|
|
661
|
+
SENSITIVE = []
|
|
662
|
+
include Aws::Structure
|
|
663
|
+
end
|
|
664
|
+
|
|
514
665
|
# The request cannot be applied to the target resource in its current
|
|
515
666
|
# state.
|
|
516
667
|
#
|
|
@@ -729,6 +880,90 @@ module Aws::Omics
|
|
|
729
880
|
include Aws::Structure
|
|
730
881
|
end
|
|
731
882
|
|
|
883
|
+
# @!attribute [rw] name
|
|
884
|
+
# User-friendly name for the configuration.
|
|
885
|
+
# @return [String]
|
|
886
|
+
#
|
|
887
|
+
# @!attribute [rw] description
|
|
888
|
+
# Optional description for the configuration.
|
|
889
|
+
# @return [String]
|
|
890
|
+
#
|
|
891
|
+
# @!attribute [rw] run_configurations
|
|
892
|
+
# Required run-specific configurations.
|
|
893
|
+
# @return [Types::RunConfigurations]
|
|
894
|
+
#
|
|
895
|
+
# @!attribute [rw] tags
|
|
896
|
+
# Optional tags for the configuration.
|
|
897
|
+
# @return [Hash<String,String>]
|
|
898
|
+
#
|
|
899
|
+
# @!attribute [rw] request_id
|
|
900
|
+
# Optional request idempotency token. If not specified, a universally
|
|
901
|
+
# unique identifier (UUID) will be automatically generated for the
|
|
902
|
+
# request.
|
|
903
|
+
#
|
|
904
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
905
|
+
# not need to pass this option.
|
|
906
|
+
# @return [String]
|
|
907
|
+
#
|
|
908
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateConfigurationRequest AWS API Documentation
|
|
909
|
+
#
|
|
910
|
+
class CreateConfigurationRequest < Struct.new(
|
|
911
|
+
:name,
|
|
912
|
+
:description,
|
|
913
|
+
:run_configurations,
|
|
914
|
+
:tags,
|
|
915
|
+
:request_id)
|
|
916
|
+
SENSITIVE = []
|
|
917
|
+
include Aws::Structure
|
|
918
|
+
end
|
|
919
|
+
|
|
920
|
+
# @!attribute [rw] arn
|
|
921
|
+
# Unique resource identifier for the configuration.
|
|
922
|
+
# @return [String]
|
|
923
|
+
#
|
|
924
|
+
# @!attribute [rw] uuid
|
|
925
|
+
# Unique identifier for the configuration.
|
|
926
|
+
# @return [String]
|
|
927
|
+
#
|
|
928
|
+
# @!attribute [rw] name
|
|
929
|
+
# User-friendly name for the configuration.
|
|
930
|
+
# @return [String]
|
|
931
|
+
#
|
|
932
|
+
# @!attribute [rw] description
|
|
933
|
+
# Description for the configuration.
|
|
934
|
+
# @return [String]
|
|
935
|
+
#
|
|
936
|
+
# @!attribute [rw] run_configurations
|
|
937
|
+
# Run-specific configurations.
|
|
938
|
+
# @return [Types::RunConfigurationsResponse]
|
|
939
|
+
#
|
|
940
|
+
# @!attribute [rw] status
|
|
941
|
+
# Current configuration status.
|
|
942
|
+
# @return [String]
|
|
943
|
+
#
|
|
944
|
+
# @!attribute [rw] creation_time
|
|
945
|
+
# Configuration creation timestamp.
|
|
946
|
+
# @return [Time]
|
|
947
|
+
#
|
|
948
|
+
# @!attribute [rw] tags
|
|
949
|
+
# Tags for the configuration.
|
|
950
|
+
# @return [Hash<String,String>]
|
|
951
|
+
#
|
|
952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateConfigurationResponse AWS API Documentation
|
|
953
|
+
#
|
|
954
|
+
class CreateConfigurationResponse < Struct.new(
|
|
955
|
+
:arn,
|
|
956
|
+
:uuid,
|
|
957
|
+
:name,
|
|
958
|
+
:description,
|
|
959
|
+
:run_configurations,
|
|
960
|
+
:status,
|
|
961
|
+
:creation_time,
|
|
962
|
+
:tags)
|
|
963
|
+
SENSITIVE = []
|
|
964
|
+
include Aws::Structure
|
|
965
|
+
end
|
|
966
|
+
|
|
732
967
|
# @!attribute [rw] sequence_store_id
|
|
733
968
|
# The sequence store ID for the store that is the destination of the
|
|
734
969
|
# multipart uploads.
|
|
@@ -1351,10 +1586,20 @@ module Aws::Omics
|
|
|
1351
1586
|
# @return [String]
|
|
1352
1587
|
#
|
|
1353
1588
|
# @!attribute [rw] engine
|
|
1354
|
-
# The workflow engine for the workflow.
|
|
1355
|
-
#
|
|
1356
|
-
#
|
|
1357
|
-
# from your
|
|
1589
|
+
# The workflow engine for the workflow. By default, Amazon Web
|
|
1590
|
+
# Services HealthOmics detects the engine automatically from your
|
|
1591
|
+
# workflow definition. Provide a value if you have workflow definition
|
|
1592
|
+
# files from more than one engine in your zip file, or to use WDL
|
|
1593
|
+
# lenient.
|
|
1594
|
+
#
|
|
1595
|
+
# WDL lenient is designed to handle workflows migrated from Cromwell.
|
|
1596
|
+
# It supports customer Cromwell directives and some non-conformant
|
|
1597
|
+
# logic. For details, see [Implicit type conversion in WDL lenient][1]
|
|
1598
|
+
# in the *Amazon Web Services HealthOmics User Guide*.
|
|
1599
|
+
#
|
|
1600
|
+
#
|
|
1601
|
+
#
|
|
1602
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-wdl-type-conversion.html
|
|
1358
1603
|
# @return [String]
|
|
1359
1604
|
#
|
|
1360
1605
|
# @!attribute [rw] definition_zip
|
|
@@ -1786,6 +2031,125 @@ module Aws::Omics
|
|
|
1786
2031
|
include Aws::Structure
|
|
1787
2032
|
end
|
|
1788
2033
|
|
|
2034
|
+
# Shared configuration applied to all runs in a batch. Fields specified
|
|
2035
|
+
# in a per-run `InlineSetting` entry override the corresponding fields
|
|
2036
|
+
# in this object for that run. The `parameters` and `runTags` fields are
|
|
2037
|
+
# merged rather than replaced — run-specific values take precedence when
|
|
2038
|
+
# keys overlap.
|
|
2039
|
+
#
|
|
2040
|
+
# @!attribute [rw] workflow_id
|
|
2041
|
+
# The identifier of the workflow to run.
|
|
2042
|
+
# @return [String]
|
|
2043
|
+
#
|
|
2044
|
+
# @!attribute [rw] workflow_type
|
|
2045
|
+
# The type of the originating workflow. Batch runs are not supported
|
|
2046
|
+
# with `READY2RUN` workflows.
|
|
2047
|
+
# @return [String]
|
|
2048
|
+
#
|
|
2049
|
+
# @!attribute [rw] role_arn
|
|
2050
|
+
# The IAM role ARN that grants HealthOmics permissions to access
|
|
2051
|
+
# required AWS resources such as Amazon S3 and CloudWatch. The role
|
|
2052
|
+
# must have the same permissions required for individual `StartRun`
|
|
2053
|
+
# calls.
|
|
2054
|
+
# @return [String]
|
|
2055
|
+
#
|
|
2056
|
+
# @!attribute [rw] name
|
|
2057
|
+
# An optional user-friendly name applied to each workflow run. Can be
|
|
2058
|
+
# overridden per run.
|
|
2059
|
+
# @return [String]
|
|
2060
|
+
#
|
|
2061
|
+
# @!attribute [rw] cache_id
|
|
2062
|
+
# The identifier of the run cache to associate with the runs.
|
|
2063
|
+
# @return [String]
|
|
2064
|
+
#
|
|
2065
|
+
# @!attribute [rw] cache_behavior
|
|
2066
|
+
# The cache behavior for the runs. Requires `cacheId` to be set.
|
|
2067
|
+
# @return [String]
|
|
2068
|
+
#
|
|
2069
|
+
# @!attribute [rw] run_group_id
|
|
2070
|
+
# The ID of the run group to contain all workflow runs in the batch.
|
|
2071
|
+
# @return [String]
|
|
2072
|
+
#
|
|
2073
|
+
# @!attribute [rw] priority
|
|
2074
|
+
# An integer priority for the workflow runs. Higher values correspond
|
|
2075
|
+
# to higher priority. A value of 0 corresponds to the lowest priority.
|
|
2076
|
+
# Can be overridden per run.
|
|
2077
|
+
# @return [Integer]
|
|
2078
|
+
#
|
|
2079
|
+
# @!attribute [rw] parameters
|
|
2080
|
+
# Workflow parameter names and values shared across all runs. Merged
|
|
2081
|
+
# with per-run parameters; run-specific values take precedence when
|
|
2082
|
+
# keys overlap. Can be overridden per run.
|
|
2083
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
2084
|
+
#
|
|
2085
|
+
# @!attribute [rw] storage_capacity
|
|
2086
|
+
# The filesystem size in gibibytes (GiB) provisioned for each workflow
|
|
2087
|
+
# run and shared by all tasks in that run. Defaults to 1200 GiB if not
|
|
2088
|
+
# specified.
|
|
2089
|
+
# @return [Integer]
|
|
2090
|
+
#
|
|
2091
|
+
# @!attribute [rw] output_uri
|
|
2092
|
+
# The destination S3 URI for workflow outputs. Must begin with
|
|
2093
|
+
# `s3://`. The `roleArn` must grant write permissions to this bucket.
|
|
2094
|
+
# Can be overridden per run.
|
|
2095
|
+
# @return [String]
|
|
2096
|
+
#
|
|
2097
|
+
# @!attribute [rw] log_level
|
|
2098
|
+
# The verbosity level for CloudWatch Logs emitted during each run.
|
|
2099
|
+
# @return [String]
|
|
2100
|
+
#
|
|
2101
|
+
# @!attribute [rw] run_tags
|
|
2102
|
+
# AWS tags to associate with each workflow run. Merged with per-run
|
|
2103
|
+
# `runTags`; run-specific values take precedence when keys overlap.
|
|
2104
|
+
# @return [Hash<String,String>]
|
|
2105
|
+
#
|
|
2106
|
+
# @!attribute [rw] retention_mode
|
|
2107
|
+
# The retention behavior for runs after completion.
|
|
2108
|
+
# @return [String]
|
|
2109
|
+
#
|
|
2110
|
+
# @!attribute [rw] storage_type
|
|
2111
|
+
# The storage type for the workflow runs.
|
|
2112
|
+
# @return [String]
|
|
2113
|
+
#
|
|
2114
|
+
# @!attribute [rw] workflow_owner_id
|
|
2115
|
+
# The AWS account ID of the workflow owner, used for cross-account
|
|
2116
|
+
# workflow sharing.
|
|
2117
|
+
# @return [String]
|
|
2118
|
+
#
|
|
2119
|
+
# @!attribute [rw] output_bucket_owner_id
|
|
2120
|
+
# The expected AWS account ID of the owner of the output S3 bucket.
|
|
2121
|
+
# Can be overridden per run.
|
|
2122
|
+
# @return [String]
|
|
2123
|
+
#
|
|
2124
|
+
# @!attribute [rw] workflow_version_name
|
|
2125
|
+
# The version name of the specified workflow.
|
|
2126
|
+
# @return [String]
|
|
2127
|
+
#
|
|
2128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DefaultRunSetting AWS API Documentation
|
|
2129
|
+
#
|
|
2130
|
+
class DefaultRunSetting < Struct.new(
|
|
2131
|
+
:workflow_id,
|
|
2132
|
+
:workflow_type,
|
|
2133
|
+
:role_arn,
|
|
2134
|
+
:name,
|
|
2135
|
+
:cache_id,
|
|
2136
|
+
:cache_behavior,
|
|
2137
|
+
:run_group_id,
|
|
2138
|
+
:priority,
|
|
2139
|
+
:parameters,
|
|
2140
|
+
:storage_capacity,
|
|
2141
|
+
:output_uri,
|
|
2142
|
+
:log_level,
|
|
2143
|
+
:run_tags,
|
|
2144
|
+
:retention_mode,
|
|
2145
|
+
:storage_type,
|
|
2146
|
+
:workflow_owner_id,
|
|
2147
|
+
:output_bucket_owner_id,
|
|
2148
|
+
:workflow_version_name)
|
|
2149
|
+
SENSITIVE = []
|
|
2150
|
+
include Aws::Structure
|
|
2151
|
+
end
|
|
2152
|
+
|
|
1789
2153
|
# Contains information about a source code repository that hosts the
|
|
1790
2154
|
# workflow definition files.
|
|
1791
2155
|
#
|
|
@@ -1925,6 +2289,30 @@ module Aws::Omics
|
|
|
1925
2289
|
include Aws::Structure
|
|
1926
2290
|
end
|
|
1927
2291
|
|
|
2292
|
+
# @!attribute [rw] batch_id
|
|
2293
|
+
# The identifier portion of the run batch ARN.
|
|
2294
|
+
# @return [String]
|
|
2295
|
+
#
|
|
2296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteBatchRequest AWS API Documentation
|
|
2297
|
+
#
|
|
2298
|
+
class DeleteBatchRequest < Struct.new(
|
|
2299
|
+
:batch_id)
|
|
2300
|
+
SENSITIVE = []
|
|
2301
|
+
include Aws::Structure
|
|
2302
|
+
end
|
|
2303
|
+
|
|
2304
|
+
# @!attribute [rw] name
|
|
2305
|
+
# Configuration name to delete.
|
|
2306
|
+
# @return [String]
|
|
2307
|
+
#
|
|
2308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteConfigurationRequest AWS API Documentation
|
|
2309
|
+
#
|
|
2310
|
+
class DeleteConfigurationRequest < Struct.new(
|
|
2311
|
+
:name)
|
|
2312
|
+
SENSITIVE = []
|
|
2313
|
+
include Aws::Structure
|
|
2314
|
+
end
|
|
2315
|
+
|
|
1928
2316
|
# @!attribute [rw] id
|
|
1929
2317
|
# The reference's ID.
|
|
1930
2318
|
# @return [String]
|
|
@@ -1962,6 +2350,22 @@ module Aws::Omics
|
|
|
1962
2350
|
#
|
|
1963
2351
|
class DeleteReferenceStoreResponse < Aws::EmptyStructure; end
|
|
1964
2352
|
|
|
2353
|
+
# @!attribute [rw] batch_id
|
|
2354
|
+
# The identifier portion of the run batch ARN.
|
|
2355
|
+
# @return [String]
|
|
2356
|
+
#
|
|
2357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteRunBatchRequest AWS API Documentation
|
|
2358
|
+
#
|
|
2359
|
+
class DeleteRunBatchRequest < Struct.new(
|
|
2360
|
+
:batch_id)
|
|
2361
|
+
SENSITIVE = []
|
|
2362
|
+
include Aws::Structure
|
|
2363
|
+
end
|
|
2364
|
+
|
|
2365
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteRunBatchResponse AWS API Documentation
|
|
2366
|
+
#
|
|
2367
|
+
class DeleteRunBatchResponse < Aws::EmptyStructure; end
|
|
2368
|
+
|
|
1965
2369
|
# @!attribute [rw] id
|
|
1966
2370
|
# Run cache identifier for the cache you want to delete.
|
|
1967
2371
|
# @return [String]
|
|
@@ -2595,6 +2999,164 @@ module Aws::Omics
|
|
|
2595
2999
|
include Aws::Structure
|
|
2596
3000
|
end
|
|
2597
3001
|
|
|
3002
|
+
# @!attribute [rw] batch_id
|
|
3003
|
+
# The identifier portion of the run batch ARN.
|
|
3004
|
+
# @return [String]
|
|
3005
|
+
#
|
|
3006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetBatchRequest AWS API Documentation
|
|
3007
|
+
#
|
|
3008
|
+
class GetBatchRequest < Struct.new(
|
|
3009
|
+
:batch_id)
|
|
3010
|
+
SENSITIVE = []
|
|
3011
|
+
include Aws::Structure
|
|
3012
|
+
end
|
|
3013
|
+
|
|
3014
|
+
# @!attribute [rw] id
|
|
3015
|
+
# The identifier portion of the run batch ARN.
|
|
3016
|
+
# @return [String]
|
|
3017
|
+
#
|
|
3018
|
+
# @!attribute [rw] arn
|
|
3019
|
+
# The unique ARN of the run batch.
|
|
3020
|
+
# @return [String]
|
|
3021
|
+
#
|
|
3022
|
+
# @!attribute [rw] uuid
|
|
3023
|
+
# The universally unique identifier (UUID) for the run batch.
|
|
3024
|
+
# @return [String]
|
|
3025
|
+
#
|
|
3026
|
+
# @!attribute [rw] name
|
|
3027
|
+
# The optional user-friendly name of the batch.
|
|
3028
|
+
# @return [String]
|
|
3029
|
+
#
|
|
3030
|
+
# @!attribute [rw] status
|
|
3031
|
+
# The current status of the run batch.
|
|
3032
|
+
# @return [String]
|
|
3033
|
+
#
|
|
3034
|
+
# @!attribute [rw] tags
|
|
3035
|
+
# AWS tags associated with the run batch.
|
|
3036
|
+
# @return [Hash<String,String>]
|
|
3037
|
+
#
|
|
3038
|
+
# @!attribute [rw] total_runs
|
|
3039
|
+
# The total number of runs in the batch.
|
|
3040
|
+
# @return [Integer]
|
|
3041
|
+
#
|
|
3042
|
+
# @!attribute [rw] default_run_setting
|
|
3043
|
+
# The shared configuration applied to all runs in the batch. See
|
|
3044
|
+
# `DefaultRunSetting`.
|
|
3045
|
+
# @return [Types::DefaultRunSetting]
|
|
3046
|
+
#
|
|
3047
|
+
# @!attribute [rw] submission_summary
|
|
3048
|
+
# A summary of run submission outcomes. See `SubmissionSummary`.
|
|
3049
|
+
# @return [Types::SubmissionSummary]
|
|
3050
|
+
#
|
|
3051
|
+
# @!attribute [rw] run_summary
|
|
3052
|
+
# A summary of run execution states. Run execution counts are
|
|
3053
|
+
# eventually consistent and may lag behind actual run states. Final
|
|
3054
|
+
# counts are accurate once the batch reaches `PROCESSED` status. See
|
|
3055
|
+
# `RunSummary`.
|
|
3056
|
+
# @return [Types::RunSummary]
|
|
3057
|
+
#
|
|
3058
|
+
# @!attribute [rw] creation_time
|
|
3059
|
+
# The timestamp when the batch was created.
|
|
3060
|
+
# @return [Time]
|
|
3061
|
+
#
|
|
3062
|
+
# @!attribute [rw] submitted_time
|
|
3063
|
+
# The timestamp when all run submissions completed.
|
|
3064
|
+
# @return [Time]
|
|
3065
|
+
#
|
|
3066
|
+
# @!attribute [rw] processed_time
|
|
3067
|
+
# The timestamp when all run executions completed.
|
|
3068
|
+
# @return [Time]
|
|
3069
|
+
#
|
|
3070
|
+
# @!attribute [rw] failed_time
|
|
3071
|
+
# The timestamp when the batch transitioned to a `FAILED` status.
|
|
3072
|
+
# @return [Time]
|
|
3073
|
+
#
|
|
3074
|
+
# @!attribute [rw] failure_reason
|
|
3075
|
+
# A description of the batch failure. Present only when status is
|
|
3076
|
+
# `FAILED`.
|
|
3077
|
+
# @return [String]
|
|
3078
|
+
#
|
|
3079
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetBatchResponse AWS API Documentation
|
|
3080
|
+
#
|
|
3081
|
+
class GetBatchResponse < Struct.new(
|
|
3082
|
+
:id,
|
|
3083
|
+
:arn,
|
|
3084
|
+
:uuid,
|
|
3085
|
+
:name,
|
|
3086
|
+
:status,
|
|
3087
|
+
:tags,
|
|
3088
|
+
:total_runs,
|
|
3089
|
+
:default_run_setting,
|
|
3090
|
+
:submission_summary,
|
|
3091
|
+
:run_summary,
|
|
3092
|
+
:creation_time,
|
|
3093
|
+
:submitted_time,
|
|
3094
|
+
:processed_time,
|
|
3095
|
+
:failed_time,
|
|
3096
|
+
:failure_reason)
|
|
3097
|
+
SENSITIVE = []
|
|
3098
|
+
include Aws::Structure
|
|
3099
|
+
end
|
|
3100
|
+
|
|
3101
|
+
# @!attribute [rw] name
|
|
3102
|
+
# Configuration name to retrieve.
|
|
3103
|
+
# @return [String]
|
|
3104
|
+
#
|
|
3105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetConfigurationRequest AWS API Documentation
|
|
3106
|
+
#
|
|
3107
|
+
class GetConfigurationRequest < Struct.new(
|
|
3108
|
+
:name)
|
|
3109
|
+
SENSITIVE = []
|
|
3110
|
+
include Aws::Structure
|
|
3111
|
+
end
|
|
3112
|
+
|
|
3113
|
+
# @!attribute [rw] arn
|
|
3114
|
+
# Unique resource identifier for the configuration.
|
|
3115
|
+
# @return [String]
|
|
3116
|
+
#
|
|
3117
|
+
# @!attribute [rw] uuid
|
|
3118
|
+
# Unique identifier for the configuration.
|
|
3119
|
+
# @return [String]
|
|
3120
|
+
#
|
|
3121
|
+
# @!attribute [rw] name
|
|
3122
|
+
# User-friendly name for the configuration.
|
|
3123
|
+
# @return [String]
|
|
3124
|
+
#
|
|
3125
|
+
# @!attribute [rw] description
|
|
3126
|
+
# Description for the configuration.
|
|
3127
|
+
# @return [String]
|
|
3128
|
+
#
|
|
3129
|
+
# @!attribute [rw] run_configurations
|
|
3130
|
+
# Run-specific configurations.
|
|
3131
|
+
# @return [Types::RunConfigurationsResponse]
|
|
3132
|
+
#
|
|
3133
|
+
# @!attribute [rw] status
|
|
3134
|
+
# Current configuration status.
|
|
3135
|
+
# @return [String]
|
|
3136
|
+
#
|
|
3137
|
+
# @!attribute [rw] creation_time
|
|
3138
|
+
# Configuration creation timestamp.
|
|
3139
|
+
# @return [Time]
|
|
3140
|
+
#
|
|
3141
|
+
# @!attribute [rw] tags
|
|
3142
|
+
# Tags for the configuration.
|
|
3143
|
+
# @return [Hash<String,String>]
|
|
3144
|
+
#
|
|
3145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetConfigurationResponse AWS API Documentation
|
|
3146
|
+
#
|
|
3147
|
+
class GetConfigurationResponse < Struct.new(
|
|
3148
|
+
:arn,
|
|
3149
|
+
:uuid,
|
|
3150
|
+
:name,
|
|
3151
|
+
:description,
|
|
3152
|
+
:run_configurations,
|
|
3153
|
+
:status,
|
|
3154
|
+
:creation_time,
|
|
3155
|
+
:tags)
|
|
3156
|
+
SENSITIVE = []
|
|
3157
|
+
include Aws::Structure
|
|
3158
|
+
end
|
|
3159
|
+
|
|
2598
3160
|
# @!attribute [rw] id
|
|
2599
3161
|
# The job's ID.
|
|
2600
3162
|
# @return [String]
|
|
@@ -3373,6 +3935,10 @@ module Aws::Omics
|
|
|
3373
3935
|
# The run's group ID.
|
|
3374
3936
|
# @return [String]
|
|
3375
3937
|
#
|
|
3938
|
+
# @!attribute [rw] batch_id
|
|
3939
|
+
# The run's batch ID.
|
|
3940
|
+
# @return [String]
|
|
3941
|
+
#
|
|
3376
3942
|
# @!attribute [rw] priority
|
|
3377
3943
|
# The run's priority.
|
|
3378
3944
|
# @return [Integer]
|
|
@@ -3471,6 +4037,19 @@ module Aws::Omics
|
|
|
3471
4037
|
# The universally unique identifier (UUID) value for the workflow.
|
|
3472
4038
|
# @return [String]
|
|
3473
4039
|
#
|
|
4040
|
+
# @!attribute [rw] networking_mode
|
|
4041
|
+
# Configuration for run networking behavior. If absent, this will
|
|
4042
|
+
# default to RESTRICTED.
|
|
4043
|
+
# @return [String]
|
|
4044
|
+
#
|
|
4045
|
+
# @!attribute [rw] configuration
|
|
4046
|
+
# Configuration details for the workflow run.
|
|
4047
|
+
# @return [Types::ConfigurationDetails]
|
|
4048
|
+
#
|
|
4049
|
+
# @!attribute [rw] vpc_config
|
|
4050
|
+
# VPC configuration for the workflow run.
|
|
4051
|
+
# @return [Types::VpcConfigResponse]
|
|
4052
|
+
#
|
|
3474
4053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetRunResponse AWS API Documentation
|
|
3475
4054
|
#
|
|
3476
4055
|
class GetRunResponse < Struct.new(
|
|
@@ -3486,6 +4065,7 @@ module Aws::Omics
|
|
|
3486
4065
|
:role_arn,
|
|
3487
4066
|
:name,
|
|
3488
4067
|
:run_group_id,
|
|
4068
|
+
:batch_id,
|
|
3489
4069
|
:priority,
|
|
3490
4070
|
:definition,
|
|
3491
4071
|
:digest,
|
|
@@ -3509,7 +4089,10 @@ module Aws::Omics
|
|
|
3509
4089
|
:storage_type,
|
|
3510
4090
|
:workflow_owner_id,
|
|
3511
4091
|
:workflow_version_name,
|
|
3512
|
-
:workflow_uuid
|
|
4092
|
+
:workflow_uuid,
|
|
4093
|
+
:networking_mode,
|
|
4094
|
+
:configuration,
|
|
4095
|
+
:vpc_config)
|
|
3513
4096
|
SENSITIVE = []
|
|
3514
4097
|
include Aws::Structure
|
|
3515
4098
|
end
|
|
@@ -4536,9 +5119,60 @@ module Aws::Omics
|
|
|
4536
5119
|
:status,
|
|
4537
5120
|
:status_message,
|
|
4538
5121
|
:name,
|
|
4539
|
-
:description,
|
|
4540
|
-
:tags,
|
|
4541
|
-
:reference_id)
|
|
5122
|
+
:description,
|
|
5123
|
+
:tags,
|
|
5124
|
+
:reference_id)
|
|
5125
|
+
SENSITIVE = []
|
|
5126
|
+
include Aws::Structure
|
|
5127
|
+
end
|
|
5128
|
+
|
|
5129
|
+
# A per-run configuration that overrides or merges with fields from
|
|
5130
|
+
# `DefaultRunSetting` for a specific run.
|
|
5131
|
+
#
|
|
5132
|
+
# @!attribute [rw] run_setting_id
|
|
5133
|
+
# A customer-provided unique identifier for this run configuration
|
|
5134
|
+
# within the batch. After submission, use `ListRunsInBatch` to map
|
|
5135
|
+
# each `runSettingId` to the HealthOmics-generated `runId`.
|
|
5136
|
+
# @return [String]
|
|
5137
|
+
#
|
|
5138
|
+
# @!attribute [rw] name
|
|
5139
|
+
# An optional user-friendly name for this run.
|
|
5140
|
+
# @return [String]
|
|
5141
|
+
#
|
|
5142
|
+
# @!attribute [rw] output_uri
|
|
5143
|
+
# Override the destination S3 URI for this run's outputs.
|
|
5144
|
+
# @return [String]
|
|
5145
|
+
#
|
|
5146
|
+
# @!attribute [rw] priority
|
|
5147
|
+
# Override the priority for this run.
|
|
5148
|
+
# @return [Integer]
|
|
5149
|
+
#
|
|
5150
|
+
# @!attribute [rw] parameters
|
|
5151
|
+
# Per-run workflow parameters. Merged with
|
|
5152
|
+
# `defaultRunSetting.parameters`; values in this object take
|
|
5153
|
+
# precedence when keys overlap.
|
|
5154
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
5155
|
+
#
|
|
5156
|
+
# @!attribute [rw] output_bucket_owner_id
|
|
5157
|
+
# The expected AWS account ID of the owner of the output S3 bucket for
|
|
5158
|
+
# this run.
|
|
5159
|
+
# @return [String]
|
|
5160
|
+
#
|
|
5161
|
+
# @!attribute [rw] run_tags
|
|
5162
|
+
# Per-run AWS tags. Merged with `defaultRunSetting.runTags`; values in
|
|
5163
|
+
# this object take precedence when keys overlap.
|
|
5164
|
+
# @return [Hash<String,String>]
|
|
5165
|
+
#
|
|
5166
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/InlineSetting AWS API Documentation
|
|
5167
|
+
#
|
|
5168
|
+
class InlineSetting < Struct.new(
|
|
5169
|
+
:run_setting_id,
|
|
5170
|
+
:name,
|
|
5171
|
+
:output_uri,
|
|
5172
|
+
:priority,
|
|
5173
|
+
:parameters,
|
|
5174
|
+
:output_bucket_owner_id,
|
|
5175
|
+
:run_tags)
|
|
4542
5176
|
SENSITIVE = []
|
|
4543
5177
|
include Aws::Structure
|
|
4544
5178
|
end
|
|
@@ -4742,6 +5376,91 @@ module Aws::Omics
|
|
|
4742
5376
|
include Aws::Structure
|
|
4743
5377
|
end
|
|
4744
5378
|
|
|
5379
|
+
# @!attribute [rw] max_items
|
|
5380
|
+
# The maximum number of batches to return. If not specified, defaults
|
|
5381
|
+
# to 100.
|
|
5382
|
+
# @return [Integer]
|
|
5383
|
+
#
|
|
5384
|
+
# @!attribute [rw] starting_token
|
|
5385
|
+
# A pagination token returned from a prior `ListBatch` call.
|
|
5386
|
+
# @return [String]
|
|
5387
|
+
#
|
|
5388
|
+
# @!attribute [rw] status
|
|
5389
|
+
# Filter batches by status.
|
|
5390
|
+
# @return [String]
|
|
5391
|
+
#
|
|
5392
|
+
# @!attribute [rw] name
|
|
5393
|
+
# Filter batches by name.
|
|
5394
|
+
# @return [String]
|
|
5395
|
+
#
|
|
5396
|
+
# @!attribute [rw] run_group_id
|
|
5397
|
+
# Filter batches by run group ID.
|
|
5398
|
+
# @return [String]
|
|
5399
|
+
#
|
|
5400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListBatchRequest AWS API Documentation
|
|
5401
|
+
#
|
|
5402
|
+
class ListBatchRequest < Struct.new(
|
|
5403
|
+
:max_items,
|
|
5404
|
+
:starting_token,
|
|
5405
|
+
:status,
|
|
5406
|
+
:name,
|
|
5407
|
+
:run_group_id)
|
|
5408
|
+
SENSITIVE = []
|
|
5409
|
+
include Aws::Structure
|
|
5410
|
+
end
|
|
5411
|
+
|
|
5412
|
+
# @!attribute [rw] items
|
|
5413
|
+
# A list of batch summary objects. See `BatchListItem`.
|
|
5414
|
+
# @return [Array<Types::BatchListItem>]
|
|
5415
|
+
#
|
|
5416
|
+
# @!attribute [rw] next_token
|
|
5417
|
+
# A pagination token to retrieve the next page of results. Absent when
|
|
5418
|
+
# no further results are available.
|
|
5419
|
+
# @return [String]
|
|
5420
|
+
#
|
|
5421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListBatchResponse AWS API Documentation
|
|
5422
|
+
#
|
|
5423
|
+
class ListBatchResponse < Struct.new(
|
|
5424
|
+
:items,
|
|
5425
|
+
:next_token)
|
|
5426
|
+
SENSITIVE = []
|
|
5427
|
+
include Aws::Structure
|
|
5428
|
+
end
|
|
5429
|
+
|
|
5430
|
+
# @!attribute [rw] max_results
|
|
5431
|
+
# Maximum number of results to return.
|
|
5432
|
+
# @return [Integer]
|
|
5433
|
+
#
|
|
5434
|
+
# @!attribute [rw] starting_token
|
|
5435
|
+
# Pagination token for retrieving next page of results.
|
|
5436
|
+
# @return [String]
|
|
5437
|
+
#
|
|
5438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListConfigurationsRequest AWS API Documentation
|
|
5439
|
+
#
|
|
5440
|
+
class ListConfigurationsRequest < Struct.new(
|
|
5441
|
+
:max_results,
|
|
5442
|
+
:starting_token)
|
|
5443
|
+
SENSITIVE = []
|
|
5444
|
+
include Aws::Structure
|
|
5445
|
+
end
|
|
5446
|
+
|
|
5447
|
+
# @!attribute [rw] items
|
|
5448
|
+
# List of configuration items.
|
|
5449
|
+
# @return [Array<Types::ConfigurationListItem>]
|
|
5450
|
+
#
|
|
5451
|
+
# @!attribute [rw] next_token
|
|
5452
|
+
# Token for retrieving next page of results.
|
|
5453
|
+
# @return [String]
|
|
5454
|
+
#
|
|
5455
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListConfigurationsResponse AWS API Documentation
|
|
5456
|
+
#
|
|
5457
|
+
class ListConfigurationsResponse < Struct.new(
|
|
5458
|
+
:items,
|
|
5459
|
+
:next_token)
|
|
5460
|
+
SENSITIVE = []
|
|
5461
|
+
include Aws::Structure
|
|
5462
|
+
end
|
|
5463
|
+
|
|
4745
5464
|
# @!attribute [rw] sequence_store_id
|
|
4746
5465
|
# The Sequence Store ID used for the multipart uploads.
|
|
4747
5466
|
# @return [String]
|
|
@@ -5276,6 +5995,61 @@ module Aws::Omics
|
|
|
5276
5995
|
include Aws::Structure
|
|
5277
5996
|
end
|
|
5278
5997
|
|
|
5998
|
+
# @!attribute [rw] batch_id
|
|
5999
|
+
# The identifier portion of the run batch ARN.
|
|
6000
|
+
# @return [String]
|
|
6001
|
+
#
|
|
6002
|
+
# @!attribute [rw] max_items
|
|
6003
|
+
# The maximum number of runs to return.
|
|
6004
|
+
# @return [Integer]
|
|
6005
|
+
#
|
|
6006
|
+
# @!attribute [rw] starting_token
|
|
6007
|
+
# A pagination token returned from a prior `ListRunsInBatch` call.
|
|
6008
|
+
# @return [String]
|
|
6009
|
+
#
|
|
6010
|
+
# @!attribute [rw] submission_status
|
|
6011
|
+
# Filter runs by submission status.
|
|
6012
|
+
# @return [String]
|
|
6013
|
+
#
|
|
6014
|
+
# @!attribute [rw] run_setting_id
|
|
6015
|
+
# Filter runs by the customer-provided run setting ID.
|
|
6016
|
+
# @return [String]
|
|
6017
|
+
#
|
|
6018
|
+
# @!attribute [rw] run_id
|
|
6019
|
+
# Filter runs by the HealthOmics-generated run ID.
|
|
6020
|
+
# @return [String]
|
|
6021
|
+
#
|
|
6022
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRunsInBatchRequest AWS API Documentation
|
|
6023
|
+
#
|
|
6024
|
+
class ListRunsInBatchRequest < Struct.new(
|
|
6025
|
+
:batch_id,
|
|
6026
|
+
:max_items,
|
|
6027
|
+
:starting_token,
|
|
6028
|
+
:submission_status,
|
|
6029
|
+
:run_setting_id,
|
|
6030
|
+
:run_id)
|
|
6031
|
+
SENSITIVE = []
|
|
6032
|
+
include Aws::Structure
|
|
6033
|
+
end
|
|
6034
|
+
|
|
6035
|
+
# @!attribute [rw] runs
|
|
6036
|
+
# A list of run entries in the batch. See `RunBatchListItem`.
|
|
6037
|
+
# @return [Array<Types::RunBatchListItem>]
|
|
6038
|
+
#
|
|
6039
|
+
# @!attribute [rw] next_token
|
|
6040
|
+
# A pagination token to retrieve the next page of results. Absent when
|
|
6041
|
+
# the last run has been returned.
|
|
6042
|
+
# @return [String]
|
|
6043
|
+
#
|
|
6044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRunsInBatchResponse AWS API Documentation
|
|
6045
|
+
#
|
|
6046
|
+
class ListRunsInBatchResponse < Struct.new(
|
|
6047
|
+
:runs,
|
|
6048
|
+
:next_token)
|
|
6049
|
+
SENSITIVE = []
|
|
6050
|
+
include Aws::Structure
|
|
6051
|
+
end
|
|
6052
|
+
|
|
5279
6053
|
# @!attribute [rw] name
|
|
5280
6054
|
# Filter the list by run name.
|
|
5281
6055
|
# @return [String]
|
|
@@ -5284,6 +6058,10 @@ module Aws::Omics
|
|
|
5284
6058
|
# Filter the list by run group ID.
|
|
5285
6059
|
# @return [String]
|
|
5286
6060
|
#
|
|
6061
|
+
# @!attribute [rw] batch_id
|
|
6062
|
+
# Filter by batch ID.
|
|
6063
|
+
# @return [String]
|
|
6064
|
+
#
|
|
5287
6065
|
# @!attribute [rw] starting_token
|
|
5288
6066
|
# Specify the pagination token from a previous request to retrieve the
|
|
5289
6067
|
# next page of results.
|
|
@@ -5302,6 +6080,7 @@ module Aws::Omics
|
|
|
5302
6080
|
class ListRunsRequest < Struct.new(
|
|
5303
6081
|
:name,
|
|
5304
6082
|
:run_group_id,
|
|
6083
|
+
:batch_id,
|
|
5305
6084
|
:starting_token,
|
|
5306
6085
|
:max_results,
|
|
5307
6086
|
:status)
|
|
@@ -6354,6 +7133,55 @@ module Aws::Omics
|
|
|
6354
7133
|
include Aws::Structure
|
|
6355
7134
|
end
|
|
6356
7135
|
|
|
7136
|
+
# A single run entry returned by `ListRunsInBatch`.
|
|
7137
|
+
#
|
|
7138
|
+
# @!attribute [rw] run_setting_id
|
|
7139
|
+
# The customer-provided identifier for the run configuration. Use this
|
|
7140
|
+
# to correlate results back to the input configuration provided in
|
|
7141
|
+
# `inlineSettings` or `s3UriSettings`.
|
|
7142
|
+
# @return [String]
|
|
7143
|
+
#
|
|
7144
|
+
# @!attribute [rw] run_id
|
|
7145
|
+
# The HealthOmics-generated identifier for the workflow run. Empty if
|
|
7146
|
+
# submission failed.
|
|
7147
|
+
# @return [String]
|
|
7148
|
+
#
|
|
7149
|
+
# @!attribute [rw] run_internal_uuid
|
|
7150
|
+
# The universally unique identifier (UUID) for the run.
|
|
7151
|
+
# @return [String]
|
|
7152
|
+
#
|
|
7153
|
+
# @!attribute [rw] run_arn
|
|
7154
|
+
# The unique ARN of the workflow run.
|
|
7155
|
+
# @return [String]
|
|
7156
|
+
#
|
|
7157
|
+
# @!attribute [rw] submission_status
|
|
7158
|
+
# The submission outcome for this run.
|
|
7159
|
+
# @return [String]
|
|
7160
|
+
#
|
|
7161
|
+
# @!attribute [rw] submission_failure_reason
|
|
7162
|
+
# The error category for a failed submission. See the run-level
|
|
7163
|
+
# failure table in the HealthOmics User Guide for details on each
|
|
7164
|
+
# value.
|
|
7165
|
+
# @return [String]
|
|
7166
|
+
#
|
|
7167
|
+
# @!attribute [rw] submission_failure_message
|
|
7168
|
+
# A detailed message describing the submission failure.
|
|
7169
|
+
# @return [String]
|
|
7170
|
+
#
|
|
7171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/RunBatchListItem AWS API Documentation
|
|
7172
|
+
#
|
|
7173
|
+
class RunBatchListItem < Struct.new(
|
|
7174
|
+
:run_setting_id,
|
|
7175
|
+
:run_id,
|
|
7176
|
+
:run_internal_uuid,
|
|
7177
|
+
:run_arn,
|
|
7178
|
+
:submission_status,
|
|
7179
|
+
:submission_failure_reason,
|
|
7180
|
+
:submission_failure_message)
|
|
7181
|
+
SENSITIVE = []
|
|
7182
|
+
include Aws::Structure
|
|
7183
|
+
end
|
|
7184
|
+
|
|
6357
7185
|
# List entry for one run cache.
|
|
6358
7186
|
#
|
|
6359
7187
|
# @!attribute [rw] arn
|
|
@@ -6399,6 +7227,34 @@ module Aws::Omics
|
|
|
6399
7227
|
include Aws::Structure
|
|
6400
7228
|
end
|
|
6401
7229
|
|
|
7230
|
+
# Run-specific configuration settings.
|
|
7231
|
+
#
|
|
7232
|
+
# @!attribute [rw] vpc_config
|
|
7233
|
+
# VPC configuration for workflow runs.
|
|
7234
|
+
# @return [Types::VpcConfig]
|
|
7235
|
+
#
|
|
7236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/RunConfigurations AWS API Documentation
|
|
7237
|
+
#
|
|
7238
|
+
class RunConfigurations < Struct.new(
|
|
7239
|
+
:vpc_config)
|
|
7240
|
+
SENSITIVE = []
|
|
7241
|
+
include Aws::Structure
|
|
7242
|
+
end
|
|
7243
|
+
|
|
7244
|
+
# Run-specific configuration settings with computed values.
|
|
7245
|
+
#
|
|
7246
|
+
# @!attribute [rw] vpc_config
|
|
7247
|
+
# VPC configuration for workflow runs with computed VPC ID.
|
|
7248
|
+
# @return [Types::VpcConfigResponse]
|
|
7249
|
+
#
|
|
7250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/RunConfigurationsResponse AWS API Documentation
|
|
7251
|
+
#
|
|
7252
|
+
class RunConfigurationsResponse < Struct.new(
|
|
7253
|
+
:vpc_config)
|
|
7254
|
+
SENSITIVE = []
|
|
7255
|
+
include Aws::Structure
|
|
7256
|
+
end
|
|
7257
|
+
|
|
6402
7258
|
# A run group.
|
|
6403
7259
|
#
|
|
6404
7260
|
# @!attribute [rw] arn
|
|
@@ -6466,6 +7322,10 @@ module Aws::Omics
|
|
|
6466
7322
|
# The run's workflow ID.
|
|
6467
7323
|
# @return [String]
|
|
6468
7324
|
#
|
|
7325
|
+
# @!attribute [rw] batch_id
|
|
7326
|
+
# The run's batch ID.
|
|
7327
|
+
# @return [String]
|
|
7328
|
+
#
|
|
6469
7329
|
# @!attribute [rw] name
|
|
6470
7330
|
# The run's name.
|
|
6471
7331
|
# @return [String]
|
|
@@ -6507,6 +7367,7 @@ module Aws::Omics
|
|
|
6507
7367
|
:id,
|
|
6508
7368
|
:status,
|
|
6509
7369
|
:workflow_id,
|
|
7370
|
+
:batch_id,
|
|
6510
7371
|
:name,
|
|
6511
7372
|
:priority,
|
|
6512
7373
|
:storage_capacity,
|
|
@@ -6538,6 +7399,55 @@ module Aws::Omics
|
|
|
6538
7399
|
include Aws::Structure
|
|
6539
7400
|
end
|
|
6540
7401
|
|
|
7402
|
+
# A summary of the runs in a batch.
|
|
7403
|
+
#
|
|
7404
|
+
# @!attribute [rw] pending_run_count
|
|
7405
|
+
# The number of pending runs.
|
|
7406
|
+
# @return [Integer]
|
|
7407
|
+
#
|
|
7408
|
+
# @!attribute [rw] starting_run_count
|
|
7409
|
+
# The number of starting runs.
|
|
7410
|
+
# @return [Integer]
|
|
7411
|
+
#
|
|
7412
|
+
# @!attribute [rw] running_run_count
|
|
7413
|
+
# The number of running runs.
|
|
7414
|
+
# @return [Integer]
|
|
7415
|
+
#
|
|
7416
|
+
# @!attribute [rw] stopping_run_count
|
|
7417
|
+
# The number of stopping runs.
|
|
7418
|
+
# @return [Integer]
|
|
7419
|
+
#
|
|
7420
|
+
# @!attribute [rw] completed_run_count
|
|
7421
|
+
# The number of completed runs.
|
|
7422
|
+
# @return [Integer]
|
|
7423
|
+
#
|
|
7424
|
+
# @!attribute [rw] deleted_run_count
|
|
7425
|
+
# The number of deleted runs.
|
|
7426
|
+
# @return [Integer]
|
|
7427
|
+
#
|
|
7428
|
+
# @!attribute [rw] failed_run_count
|
|
7429
|
+
# The number of failed runs.
|
|
7430
|
+
# @return [Integer]
|
|
7431
|
+
#
|
|
7432
|
+
# @!attribute [rw] cancelled_run_count
|
|
7433
|
+
# The number of cancelled runs.
|
|
7434
|
+
# @return [Integer]
|
|
7435
|
+
#
|
|
7436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/RunSummary AWS API Documentation
|
|
7437
|
+
#
|
|
7438
|
+
class RunSummary < Struct.new(
|
|
7439
|
+
:pending_run_count,
|
|
7440
|
+
:starting_run_count,
|
|
7441
|
+
:running_run_count,
|
|
7442
|
+
:stopping_run_count,
|
|
7443
|
+
:completed_run_count,
|
|
7444
|
+
:deleted_run_count,
|
|
7445
|
+
:failed_run_count,
|
|
7446
|
+
:cancelled_run_count)
|
|
7447
|
+
SENSITIVE = []
|
|
7448
|
+
include Aws::Structure
|
|
7449
|
+
end
|
|
7450
|
+
|
|
6541
7451
|
# S3 access configuration parameters.
|
|
6542
7452
|
#
|
|
6543
7453
|
# @!attribute [rw] access_log_location
|
|
@@ -7230,6 +8140,78 @@ module Aws::Omics
|
|
|
7230
8140
|
include Aws::Structure
|
|
7231
8141
|
end
|
|
7232
8142
|
|
|
8143
|
+
# @!attribute [rw] batch_name
|
|
8144
|
+
# An optional user-friendly name for the run batch.
|
|
8145
|
+
# @return [String]
|
|
8146
|
+
#
|
|
8147
|
+
# @!attribute [rw] request_id
|
|
8148
|
+
# A client token used to deduplicate retry requests and prevent
|
|
8149
|
+
# duplicate batches from being created.
|
|
8150
|
+
#
|
|
8151
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
8152
|
+
# not need to pass this option.
|
|
8153
|
+
# @return [String]
|
|
8154
|
+
#
|
|
8155
|
+
# @!attribute [rw] tags
|
|
8156
|
+
# AWS tags to associate with the batch resource. These tags are not
|
|
8157
|
+
# inherited by individual runs. To tag individual runs, use
|
|
8158
|
+
# `defaultRunSetting.runTags`.
|
|
8159
|
+
# @return [Hash<String,String>]
|
|
8160
|
+
#
|
|
8161
|
+
# @!attribute [rw] default_run_setting
|
|
8162
|
+
# Shared configuration applied to all runs in the batch. See
|
|
8163
|
+
# `DefaultRunSetting`.
|
|
8164
|
+
# @return [Types::DefaultRunSetting]
|
|
8165
|
+
#
|
|
8166
|
+
# @!attribute [rw] batch_run_settings
|
|
8167
|
+
# The individual run configurations. Specify exactly one of
|
|
8168
|
+
# `inlineSettings` or `s3UriSettings`. See `BatchRunSettings`.
|
|
8169
|
+
# @return [Types::BatchRunSettings]
|
|
8170
|
+
#
|
|
8171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartRunBatchRequest AWS API Documentation
|
|
8172
|
+
#
|
|
8173
|
+
class StartRunBatchRequest < Struct.new(
|
|
8174
|
+
:batch_name,
|
|
8175
|
+
:request_id,
|
|
8176
|
+
:tags,
|
|
8177
|
+
:default_run_setting,
|
|
8178
|
+
:batch_run_settings)
|
|
8179
|
+
SENSITIVE = []
|
|
8180
|
+
include Aws::Structure
|
|
8181
|
+
end
|
|
8182
|
+
|
|
8183
|
+
# @!attribute [rw] id
|
|
8184
|
+
# The identifier portion of the run batch ARN.
|
|
8185
|
+
# @return [String]
|
|
8186
|
+
#
|
|
8187
|
+
# @!attribute [rw] arn
|
|
8188
|
+
# The unique ARN of the run batch.
|
|
8189
|
+
# @return [String]
|
|
8190
|
+
#
|
|
8191
|
+
# @!attribute [rw] status
|
|
8192
|
+
# The initial status of the run batch.
|
|
8193
|
+
# @return [String]
|
|
8194
|
+
#
|
|
8195
|
+
# @!attribute [rw] uuid
|
|
8196
|
+
# The universally unique identifier (UUID) for the run batch.
|
|
8197
|
+
# @return [String]
|
|
8198
|
+
#
|
|
8199
|
+
# @!attribute [rw] tags
|
|
8200
|
+
# AWS tags associated with the run batch.
|
|
8201
|
+
# @return [Hash<String,String>]
|
|
8202
|
+
#
|
|
8203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartRunBatchResponse AWS API Documentation
|
|
8204
|
+
#
|
|
8205
|
+
class StartRunBatchResponse < Struct.new(
|
|
8206
|
+
:id,
|
|
8207
|
+
:arn,
|
|
8208
|
+
:status,
|
|
8209
|
+
:uuid,
|
|
8210
|
+
:tags)
|
|
8211
|
+
SENSITIVE = []
|
|
8212
|
+
include Aws::Structure
|
|
8213
|
+
end
|
|
8214
|
+
|
|
7233
8215
|
# @!attribute [rw] workflow_id
|
|
7234
8216
|
# The run's workflow ID. The `workflowId` is not the UUID.
|
|
7235
8217
|
# @return [String]
|
|
@@ -7395,6 +8377,15 @@ module Aws::Omics
|
|
|
7395
8377
|
# [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html
|
|
7396
8378
|
# @return [String]
|
|
7397
8379
|
#
|
|
8380
|
+
# @!attribute [rw] networking_mode
|
|
8381
|
+
# Optional configuration for run networking behavior. If not
|
|
8382
|
+
# specified, this will default to RESTRICTED.
|
|
8383
|
+
# @return [String]
|
|
8384
|
+
#
|
|
8385
|
+
# @!attribute [rw] configuration_name
|
|
8386
|
+
# Optional configuration name to use for the workflow run.
|
|
8387
|
+
# @return [String]
|
|
8388
|
+
#
|
|
7398
8389
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartRunRequest AWS API Documentation
|
|
7399
8390
|
#
|
|
7400
8391
|
class StartRunRequest < Struct.new(
|
|
@@ -7416,7 +8407,9 @@ module Aws::Omics
|
|
|
7416
8407
|
:retention_mode,
|
|
7417
8408
|
:storage_type,
|
|
7418
8409
|
:workflow_owner_id,
|
|
7419
|
-
:workflow_version_name
|
|
8410
|
+
:workflow_version_name,
|
|
8411
|
+
:networking_mode,
|
|
8412
|
+
:configuration_name)
|
|
7420
8413
|
SENSITIVE = []
|
|
7421
8414
|
include Aws::Structure
|
|
7422
8415
|
end
|
|
@@ -7445,6 +8438,14 @@ module Aws::Omics
|
|
|
7445
8438
|
# The destination for workflow outputs.
|
|
7446
8439
|
# @return [String]
|
|
7447
8440
|
#
|
|
8441
|
+
# @!attribute [rw] configuration
|
|
8442
|
+
# Configuration details for the workflow run.
|
|
8443
|
+
# @return [Types::ConfigurationDetails]
|
|
8444
|
+
#
|
|
8445
|
+
# @!attribute [rw] networking_mode
|
|
8446
|
+
# Networking mode for the workflow run.
|
|
8447
|
+
# @return [String]
|
|
8448
|
+
#
|
|
7448
8449
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartRunResponse AWS API Documentation
|
|
7449
8450
|
#
|
|
7450
8451
|
class StartRunResponse < Struct.new(
|
|
@@ -7453,7 +8454,9 @@ module Aws::Omics
|
|
|
7453
8454
|
:status,
|
|
7454
8455
|
:tags,
|
|
7455
8456
|
:uuid,
|
|
7456
|
-
:run_output_uri
|
|
8457
|
+
:run_output_uri,
|
|
8458
|
+
:configuration,
|
|
8459
|
+
:networking_mode)
|
|
7457
8460
|
SENSITIVE = []
|
|
7458
8461
|
include Aws::Structure
|
|
7459
8462
|
end
|
|
@@ -7525,6 +8528,50 @@ module Aws::Omics
|
|
|
7525
8528
|
class Unknown < StoreOptions; end
|
|
7526
8529
|
end
|
|
7527
8530
|
|
|
8531
|
+
# A summary of the submissions in a batch.
|
|
8532
|
+
#
|
|
8533
|
+
# @!attribute [rw] successful_start_submission_count
|
|
8534
|
+
# The number of successful start submissions.
|
|
8535
|
+
# @return [Integer]
|
|
8536
|
+
#
|
|
8537
|
+
# @!attribute [rw] failed_start_submission_count
|
|
8538
|
+
# The number of failed start submissions.
|
|
8539
|
+
# @return [Integer]
|
|
8540
|
+
#
|
|
8541
|
+
# @!attribute [rw] pending_start_submission_count
|
|
8542
|
+
# The number of pending start submissions.
|
|
8543
|
+
# @return [Integer]
|
|
8544
|
+
#
|
|
8545
|
+
# @!attribute [rw] successful_cancel_submission_count
|
|
8546
|
+
# The number of successful cancel submissions.
|
|
8547
|
+
# @return [Integer]
|
|
8548
|
+
#
|
|
8549
|
+
# @!attribute [rw] failed_cancel_submission_count
|
|
8550
|
+
# The number of failed cancel submissions.
|
|
8551
|
+
# @return [Integer]
|
|
8552
|
+
#
|
|
8553
|
+
# @!attribute [rw] successful_delete_submission_count
|
|
8554
|
+
# The number of successful delete submissions.
|
|
8555
|
+
# @return [Integer]
|
|
8556
|
+
#
|
|
8557
|
+
# @!attribute [rw] failed_delete_submission_count
|
|
8558
|
+
# The number of failed delete submissions.
|
|
8559
|
+
# @return [Integer]
|
|
8560
|
+
#
|
|
8561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/SubmissionSummary AWS API Documentation
|
|
8562
|
+
#
|
|
8563
|
+
class SubmissionSummary < Struct.new(
|
|
8564
|
+
:successful_start_submission_count,
|
|
8565
|
+
:failed_start_submission_count,
|
|
8566
|
+
:pending_start_submission_count,
|
|
8567
|
+
:successful_cancel_submission_count,
|
|
8568
|
+
:failed_cancel_submission_count,
|
|
8569
|
+
:successful_delete_submission_count,
|
|
8570
|
+
:failed_delete_submission_count)
|
|
8571
|
+
SENSITIVE = []
|
|
8572
|
+
include Aws::Structure
|
|
8573
|
+
end
|
|
8574
|
+
|
|
7528
8575
|
# @!attribute [rw] resource_arn
|
|
7529
8576
|
# The resource's ARN.
|
|
7530
8577
|
# @return [String]
|
|
@@ -8472,6 +9519,49 @@ module Aws::Omics
|
|
|
8472
9519
|
class Unknown < VersionOptions; end
|
|
8473
9520
|
end
|
|
8474
9521
|
|
|
9522
|
+
# VPC configuration for workflow runs.
|
|
9523
|
+
#
|
|
9524
|
+
# @!attribute [rw] security_group_ids
|
|
9525
|
+
# List of security group IDs. Maximum of 5 security groups allowed.
|
|
9526
|
+
# @return [Array<String>]
|
|
9527
|
+
#
|
|
9528
|
+
# @!attribute [rw] subnet_ids
|
|
9529
|
+
# List of subnet IDs. Maximum of 16 subnets allowed.
|
|
9530
|
+
# @return [Array<String>]
|
|
9531
|
+
#
|
|
9532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/VpcConfig AWS API Documentation
|
|
9533
|
+
#
|
|
9534
|
+
class VpcConfig < Struct.new(
|
|
9535
|
+
:security_group_ids,
|
|
9536
|
+
:subnet_ids)
|
|
9537
|
+
SENSITIVE = []
|
|
9538
|
+
include Aws::Structure
|
|
9539
|
+
end
|
|
9540
|
+
|
|
9541
|
+
# VPC configuration for workflow runs with computed VPC ID.
|
|
9542
|
+
#
|
|
9543
|
+
# @!attribute [rw] security_group_ids
|
|
9544
|
+
# List of security group IDs.
|
|
9545
|
+
# @return [Array<String>]
|
|
9546
|
+
#
|
|
9547
|
+
# @!attribute [rw] subnet_ids
|
|
9548
|
+
# List of subnet IDs.
|
|
9549
|
+
# @return [Array<String>]
|
|
9550
|
+
#
|
|
9551
|
+
# @!attribute [rw] vpc_id
|
|
9552
|
+
# VPC ID computed from the provided subnet IDs.
|
|
9553
|
+
# @return [String]
|
|
9554
|
+
#
|
|
9555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/VpcConfigResponse AWS API Documentation
|
|
9556
|
+
#
|
|
9557
|
+
class VpcConfigResponse < Struct.new(
|
|
9558
|
+
:security_group_ids,
|
|
9559
|
+
:subnet_ids,
|
|
9560
|
+
:vpc_id)
|
|
9561
|
+
SENSITIVE = []
|
|
9562
|
+
include Aws::Structure
|
|
9563
|
+
end
|
|
9564
|
+
|
|
8475
9565
|
# A workflow.
|
|
8476
9566
|
#
|
|
8477
9567
|
# @!attribute [rw] arn
|