aws-sdk-omics 1.12.0 → 1.14.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 +548 -27
- data/lib/aws-sdk-omics/client_api.rb +425 -15
- data/lib/aws-sdk-omics/endpoints.rb +140 -0
- data/lib/aws-sdk-omics/plugins/endpoints.rb +20 -0
- data/lib/aws-sdk-omics/types.rb +760 -5
- data/lib/aws-sdk-omics/waiters.rb +126 -17
- data/lib/aws-sdk-omics.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-omics/client.rb
CHANGED
@@ -414,6 +414,34 @@ module Aws::Omics
|
|
414
414
|
req.send_request(options)
|
415
415
|
end
|
416
416
|
|
417
|
+
# Accepts a share for an analytics store.
|
418
|
+
#
|
419
|
+
# @option params [required, String] :share_id
|
420
|
+
# The ID for a share offer for analytics store data.
|
421
|
+
#
|
422
|
+
# @return [Types::AcceptShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
423
|
+
#
|
424
|
+
# * {Types::AcceptShareResponse#status #status} => String
|
425
|
+
#
|
426
|
+
# @example Request syntax with placeholder values
|
427
|
+
#
|
428
|
+
# resp = client.accept_share({
|
429
|
+
# share_id: "String", # required
|
430
|
+
# })
|
431
|
+
#
|
432
|
+
# @example Response structure
|
433
|
+
#
|
434
|
+
# resp.status #=> String, one of "PENDING", "ACTIVATING", "ACTIVE", "DELETING", "DELETED", "FAILED"
|
435
|
+
#
|
436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/AcceptShare AWS API Documentation
|
437
|
+
#
|
438
|
+
# @overload accept_share(params = {})
|
439
|
+
# @param [Hash] params ({})
|
440
|
+
def accept_share(params = {}, options = {})
|
441
|
+
req = build_request(:accept_share, params)
|
442
|
+
req.send_request(options)
|
443
|
+
end
|
444
|
+
|
417
445
|
# Deletes one or more read sets.
|
418
446
|
#
|
419
447
|
# @option params [required, Array<String>] :ids
|
@@ -572,6 +600,10 @@ module Aws::Omics
|
|
572
600
|
# @option params [Hash<String,String>] :tags
|
573
601
|
# Tags for the store.
|
574
602
|
#
|
603
|
+
# @option params [String] :version_name
|
604
|
+
# The name given to an annotation store version to distinguish it from
|
605
|
+
# other versions.
|
606
|
+
#
|
575
607
|
# @option params [Types::SseConfig] :sse_config
|
576
608
|
# Server-side encryption (SSE) settings for the store.
|
577
609
|
#
|
@@ -589,6 +621,7 @@ module Aws::Omics
|
|
589
621
|
# * {Types::CreateAnnotationStoreResponse#store_options #store_options} => Types::StoreOptions
|
590
622
|
# * {Types::CreateAnnotationStoreResponse#status #status} => String
|
591
623
|
# * {Types::CreateAnnotationStoreResponse#name #name} => String
|
624
|
+
# * {Types::CreateAnnotationStoreResponse#version_name #version_name} => String
|
592
625
|
# * {Types::CreateAnnotationStoreResponse#creation_time #creation_time} => Time
|
593
626
|
#
|
594
627
|
# @example Request syntax with placeholder values
|
@@ -597,11 +630,12 @@ module Aws::Omics
|
|
597
630
|
# reference: {
|
598
631
|
# reference_arn: "ReferenceArn",
|
599
632
|
# },
|
600
|
-
# name: "
|
601
|
-
# description: "
|
633
|
+
# name: "StoreName",
|
634
|
+
# description: "Description",
|
602
635
|
# tags: {
|
603
636
|
# "TagKey" => "TagValue",
|
604
637
|
# },
|
638
|
+
# version_name: "VersionName",
|
605
639
|
# sse_config: {
|
606
640
|
# type: "KMS", # required, accepts KMS
|
607
641
|
# key_arn: "SseConfigKeyArnString",
|
@@ -635,6 +669,7 @@ module Aws::Omics
|
|
635
669
|
# resp.store_options.tsv_store_options.schema[0]["SchemaItemKeyString"] #=> String, one of "LONG", "INT", "STRING", "FLOAT", "DOUBLE", "BOOLEAN"
|
636
670
|
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
637
671
|
# resp.name #=> String
|
672
|
+
# resp.version_name #=> String
|
638
673
|
# resp.creation_time #=> Time
|
639
674
|
#
|
640
675
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateAnnotationStore AWS API Documentation
|
@@ -646,6 +681,83 @@ module Aws::Omics
|
|
646
681
|
req.send_request(options)
|
647
682
|
end
|
648
683
|
|
684
|
+
# Creates a new version of an annotation store.
|
685
|
+
#
|
686
|
+
# @option params [required, String] :name
|
687
|
+
# The name of an annotation store version from which versions are being
|
688
|
+
# created.
|
689
|
+
#
|
690
|
+
# @option params [required, String] :version_name
|
691
|
+
# The name given to an annotation store version to distinguish it from
|
692
|
+
# other versions.
|
693
|
+
#
|
694
|
+
# @option params [String] :description
|
695
|
+
# The description of an annotation store version.
|
696
|
+
#
|
697
|
+
# @option params [Types::VersionOptions] :version_options
|
698
|
+
# The options for an annotation store version.
|
699
|
+
#
|
700
|
+
# @option params [Hash<String,String>] :tags
|
701
|
+
# Any tags added to annotation store version.
|
702
|
+
#
|
703
|
+
# @return [Types::CreateAnnotationStoreVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
704
|
+
#
|
705
|
+
# * {Types::CreateAnnotationStoreVersionResponse#id #id} => String
|
706
|
+
# * {Types::CreateAnnotationStoreVersionResponse#version_name #version_name} => String
|
707
|
+
# * {Types::CreateAnnotationStoreVersionResponse#store_id #store_id} => String
|
708
|
+
# * {Types::CreateAnnotationStoreVersionResponse#version_options #version_options} => Types::VersionOptions
|
709
|
+
# * {Types::CreateAnnotationStoreVersionResponse#name #name} => String
|
710
|
+
# * {Types::CreateAnnotationStoreVersionResponse#status #status} => String
|
711
|
+
# * {Types::CreateAnnotationStoreVersionResponse#creation_time #creation_time} => Time
|
712
|
+
#
|
713
|
+
# @example Request syntax with placeholder values
|
714
|
+
#
|
715
|
+
# resp = client.create_annotation_store_version({
|
716
|
+
# name: "StoreName", # required
|
717
|
+
# version_name: "VersionName", # required
|
718
|
+
# description: "Description",
|
719
|
+
# version_options: {
|
720
|
+
# tsv_version_options: {
|
721
|
+
# annotation_type: "GENERIC", # accepts GENERIC, CHR_POS, CHR_POS_REF_ALT, CHR_START_END_ONE_BASE, CHR_START_END_REF_ALT_ONE_BASE, CHR_START_END_ZERO_BASE, CHR_START_END_REF_ALT_ZERO_BASE
|
722
|
+
# format_to_header: {
|
723
|
+
# "CHR" => "FormatToHeaderValueString",
|
724
|
+
# },
|
725
|
+
# schema: [
|
726
|
+
# {
|
727
|
+
# "SchemaItemKeyString" => "LONG", # accepts LONG, INT, STRING, FLOAT, DOUBLE, BOOLEAN
|
728
|
+
# },
|
729
|
+
# ],
|
730
|
+
# },
|
731
|
+
# },
|
732
|
+
# tags: {
|
733
|
+
# "TagKey" => "TagValue",
|
734
|
+
# },
|
735
|
+
# })
|
736
|
+
#
|
737
|
+
# @example Response structure
|
738
|
+
#
|
739
|
+
# resp.id #=> String
|
740
|
+
# resp.version_name #=> String
|
741
|
+
# resp.store_id #=> String
|
742
|
+
# resp.version_options.tsv_version_options.annotation_type #=> String, one of "GENERIC", "CHR_POS", "CHR_POS_REF_ALT", "CHR_START_END_ONE_BASE", "CHR_START_END_REF_ALT_ONE_BASE", "CHR_START_END_ZERO_BASE", "CHR_START_END_REF_ALT_ZERO_BASE"
|
743
|
+
# resp.version_options.tsv_version_options.format_to_header #=> Hash
|
744
|
+
# resp.version_options.tsv_version_options.format_to_header["FormatToHeaderKey"] #=> String
|
745
|
+
# resp.version_options.tsv_version_options.schema #=> Array
|
746
|
+
# resp.version_options.tsv_version_options.schema[0] #=> Hash
|
747
|
+
# resp.version_options.tsv_version_options.schema[0]["SchemaItemKeyString"] #=> String, one of "LONG", "INT", "STRING", "FLOAT", "DOUBLE", "BOOLEAN"
|
748
|
+
# resp.name #=> String
|
749
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
750
|
+
# resp.creation_time #=> Time
|
751
|
+
#
|
752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateAnnotationStoreVersion AWS API Documentation
|
753
|
+
#
|
754
|
+
# @overload create_annotation_store_version(params = {})
|
755
|
+
# @param [Hash] params ({})
|
756
|
+
def create_annotation_store_version(params = {}, options = {})
|
757
|
+
req = build_request(:create_annotation_store_version, params)
|
758
|
+
req.send_request(options)
|
759
|
+
end
|
760
|
+
|
649
761
|
# Begins a multipart read set upload.
|
650
762
|
#
|
651
763
|
# @option params [required, String] :sequence_store_id
|
@@ -927,6 +1039,49 @@ module Aws::Omics
|
|
927
1039
|
req.send_request(options)
|
928
1040
|
end
|
929
1041
|
|
1042
|
+
# Creates a share offer that can be accepted outside the account by a
|
1043
|
+
# subscriber. The share is created by the owner and accepted by the
|
1044
|
+
# principal subscriber.
|
1045
|
+
#
|
1046
|
+
# @option params [required, String] :resource_arn
|
1047
|
+
# The resource ARN for the analytics store to be shared.
|
1048
|
+
#
|
1049
|
+
# @option params [required, String] :principal_subscriber
|
1050
|
+
# The principal subscriber is the account being given access to the
|
1051
|
+
# analytics store data through the share offer.
|
1052
|
+
#
|
1053
|
+
# @option params [String] :share_name
|
1054
|
+
# A name given to the share.
|
1055
|
+
#
|
1056
|
+
# @return [Types::CreateShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1057
|
+
#
|
1058
|
+
# * {Types::CreateShareResponse#share_id #share_id} => String
|
1059
|
+
# * {Types::CreateShareResponse#status #status} => String
|
1060
|
+
# * {Types::CreateShareResponse#share_name #share_name} => String
|
1061
|
+
#
|
1062
|
+
# @example Request syntax with placeholder values
|
1063
|
+
#
|
1064
|
+
# resp = client.create_share({
|
1065
|
+
# resource_arn: "String", # required
|
1066
|
+
# principal_subscriber: "String", # required
|
1067
|
+
# share_name: "ShareName",
|
1068
|
+
# })
|
1069
|
+
#
|
1070
|
+
# @example Response structure
|
1071
|
+
#
|
1072
|
+
# resp.share_id #=> String
|
1073
|
+
# resp.status #=> String, one of "PENDING", "ACTIVATING", "ACTIVE", "DELETING", "DELETED", "FAILED"
|
1074
|
+
# resp.share_name #=> String
|
1075
|
+
#
|
1076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateShare AWS API Documentation
|
1077
|
+
#
|
1078
|
+
# @overload create_share(params = {})
|
1079
|
+
# @param [Hash] params ({})
|
1080
|
+
def create_share(params = {}, options = {})
|
1081
|
+
req = build_request(:create_share, params)
|
1082
|
+
req.send_request(options)
|
1083
|
+
end
|
1084
|
+
|
930
1085
|
# Creates a variant store.
|
931
1086
|
#
|
932
1087
|
# @option params [required, Types::ReferenceItem] :reference
|
@@ -958,8 +1113,8 @@ module Aws::Omics
|
|
958
1113
|
# reference: { # required
|
959
1114
|
# reference_arn: "ReferenceArn",
|
960
1115
|
# },
|
961
|
-
# name: "
|
962
|
-
# description: "
|
1116
|
+
# name: "StoreName",
|
1117
|
+
# description: "Description",
|
963
1118
|
# tags: {
|
964
1119
|
# "TagKey" => "TagValue",
|
965
1120
|
# },
|
@@ -1104,6 +1259,46 @@ module Aws::Omics
|
|
1104
1259
|
req.send_request(options)
|
1105
1260
|
end
|
1106
1261
|
|
1262
|
+
# Deletes one or multiple versions of an annotation store.
|
1263
|
+
#
|
1264
|
+
# @option params [required, String] :name
|
1265
|
+
# The name of the annotation store from which versions are being
|
1266
|
+
# deleted.
|
1267
|
+
#
|
1268
|
+
# @option params [required, Array<String>] :versions
|
1269
|
+
# The versions of an annotation store to be deleted.
|
1270
|
+
#
|
1271
|
+
# @option params [Boolean] :force
|
1272
|
+
# Forces the deletion of an annotation store version when imports are
|
1273
|
+
# in-progress..
|
1274
|
+
#
|
1275
|
+
# @return [Types::DeleteAnnotationStoreVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1276
|
+
#
|
1277
|
+
# * {Types::DeleteAnnotationStoreVersionsResponse#errors #errors} => Array<Types::VersionDeleteError>
|
1278
|
+
#
|
1279
|
+
# @example Request syntax with placeholder values
|
1280
|
+
#
|
1281
|
+
# resp = client.delete_annotation_store_versions({
|
1282
|
+
# name: "String", # required
|
1283
|
+
# versions: ["VersionName"], # required
|
1284
|
+
# force: false,
|
1285
|
+
# })
|
1286
|
+
#
|
1287
|
+
# @example Response structure
|
1288
|
+
#
|
1289
|
+
# resp.errors #=> Array
|
1290
|
+
# resp.errors[0].version_name #=> String
|
1291
|
+
# resp.errors[0].message #=> String
|
1292
|
+
#
|
1293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteAnnotationStoreVersions AWS API Documentation
|
1294
|
+
#
|
1295
|
+
# @overload delete_annotation_store_versions(params = {})
|
1296
|
+
# @param [Hash] params ({})
|
1297
|
+
def delete_annotation_store_versions(params = {}, options = {})
|
1298
|
+
req = build_request(:delete_annotation_store_versions, params)
|
1299
|
+
req.send_request(options)
|
1300
|
+
end
|
1301
|
+
|
1107
1302
|
# Deletes a genome reference.
|
1108
1303
|
#
|
1109
1304
|
# @option params [required, String] :id
|
@@ -1218,6 +1413,34 @@ module Aws::Omics
|
|
1218
1413
|
req.send_request(options)
|
1219
1414
|
end
|
1220
1415
|
|
1416
|
+
# Deletes a share of an analytics store.
|
1417
|
+
#
|
1418
|
+
# @option params [required, String] :share_id
|
1419
|
+
# The ID for the share request to be deleted.
|
1420
|
+
#
|
1421
|
+
# @return [Types::DeleteShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1422
|
+
#
|
1423
|
+
# * {Types::DeleteShareResponse#status #status} => String
|
1424
|
+
#
|
1425
|
+
# @example Request syntax with placeholder values
|
1426
|
+
#
|
1427
|
+
# resp = client.delete_share({
|
1428
|
+
# share_id: "String", # required
|
1429
|
+
# })
|
1430
|
+
#
|
1431
|
+
# @example Response structure
|
1432
|
+
#
|
1433
|
+
# resp.status #=> String, one of "PENDING", "ACTIVATING", "ACTIVE", "DELETING", "DELETED", "FAILED"
|
1434
|
+
#
|
1435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteShare AWS API Documentation
|
1436
|
+
#
|
1437
|
+
# @overload delete_share(params = {})
|
1438
|
+
# @param [Hash] params ({})
|
1439
|
+
def delete_share(params = {}, options = {})
|
1440
|
+
req = build_request(:delete_share, params)
|
1441
|
+
req.send_request(options)
|
1442
|
+
end
|
1443
|
+
|
1221
1444
|
# Deletes a variant store.
|
1222
1445
|
#
|
1223
1446
|
# @option params [required, String] :name
|
@@ -1281,6 +1504,7 @@ module Aws::Omics
|
|
1281
1504
|
#
|
1282
1505
|
# * {Types::GetAnnotationImportResponse#id #id} => String
|
1283
1506
|
# * {Types::GetAnnotationImportResponse#destination_name #destination_name} => String
|
1507
|
+
# * {Types::GetAnnotationImportResponse#version_name #version_name} => String
|
1284
1508
|
# * {Types::GetAnnotationImportResponse#role_arn #role_arn} => String
|
1285
1509
|
# * {Types::GetAnnotationImportResponse#status #status} => String
|
1286
1510
|
# * {Types::GetAnnotationImportResponse#status_message #status_message} => String
|
@@ -1302,6 +1526,7 @@ module Aws::Omics
|
|
1302
1526
|
#
|
1303
1527
|
# resp.id #=> String
|
1304
1528
|
# resp.destination_name #=> String
|
1529
|
+
# resp.version_name #=> String
|
1305
1530
|
# resp.role_arn #=> String
|
1306
1531
|
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
|
1307
1532
|
# resp.status_message #=> String
|
@@ -1361,6 +1586,7 @@ module Aws::Omics
|
|
1361
1586
|
# * {Types::GetAnnotationStoreResponse#store_format #store_format} => String
|
1362
1587
|
# * {Types::GetAnnotationStoreResponse#status_message #status_message} => String
|
1363
1588
|
# * {Types::GetAnnotationStoreResponse#store_size_bytes #store_size_bytes} => Integer
|
1589
|
+
# * {Types::GetAnnotationStoreResponse#num_versions #num_versions} => Integer
|
1364
1590
|
#
|
1365
1591
|
# @example Request syntax with placeholder values
|
1366
1592
|
#
|
@@ -1391,6 +1617,7 @@ module Aws::Omics
|
|
1391
1617
|
# resp.store_format #=> String, one of "GFF", "TSV", "VCF"
|
1392
1618
|
# resp.status_message #=> String
|
1393
1619
|
# resp.store_size_bytes #=> Integer
|
1620
|
+
# resp.num_versions #=> Integer
|
1394
1621
|
#
|
1395
1622
|
#
|
1396
1623
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -1407,6 +1634,76 @@ module Aws::Omics
|
|
1407
1634
|
req.send_request(options)
|
1408
1635
|
end
|
1409
1636
|
|
1637
|
+
# Retrieves the metadata for an annotation store version.
|
1638
|
+
#
|
1639
|
+
# @option params [required, String] :name
|
1640
|
+
# The name given to an annotation store version to distinguish it from
|
1641
|
+
# others.
|
1642
|
+
#
|
1643
|
+
# @option params [required, String] :version_name
|
1644
|
+
# The name given to an annotation store version to distinguish it from
|
1645
|
+
# others.
|
1646
|
+
#
|
1647
|
+
# @return [Types::GetAnnotationStoreVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1648
|
+
#
|
1649
|
+
# * {Types::GetAnnotationStoreVersionResponse#store_id #store_id} => String
|
1650
|
+
# * {Types::GetAnnotationStoreVersionResponse#id #id} => String
|
1651
|
+
# * {Types::GetAnnotationStoreVersionResponse#status #status} => String
|
1652
|
+
# * {Types::GetAnnotationStoreVersionResponse#version_arn #version_arn} => String
|
1653
|
+
# * {Types::GetAnnotationStoreVersionResponse#name #name} => String
|
1654
|
+
# * {Types::GetAnnotationStoreVersionResponse#version_name #version_name} => String
|
1655
|
+
# * {Types::GetAnnotationStoreVersionResponse#description #description} => String
|
1656
|
+
# * {Types::GetAnnotationStoreVersionResponse#creation_time #creation_time} => Time
|
1657
|
+
# * {Types::GetAnnotationStoreVersionResponse#update_time #update_time} => Time
|
1658
|
+
# * {Types::GetAnnotationStoreVersionResponse#tags #tags} => Hash<String,String>
|
1659
|
+
# * {Types::GetAnnotationStoreVersionResponse#version_options #version_options} => Types::VersionOptions
|
1660
|
+
# * {Types::GetAnnotationStoreVersionResponse#status_message #status_message} => String
|
1661
|
+
# * {Types::GetAnnotationStoreVersionResponse#version_size_bytes #version_size_bytes} => Integer
|
1662
|
+
#
|
1663
|
+
# @example Request syntax with placeholder values
|
1664
|
+
#
|
1665
|
+
# resp = client.get_annotation_store_version({
|
1666
|
+
# name: "String", # required
|
1667
|
+
# version_name: "String", # required
|
1668
|
+
# })
|
1669
|
+
#
|
1670
|
+
# @example Response structure
|
1671
|
+
#
|
1672
|
+
# resp.store_id #=> String
|
1673
|
+
# resp.id #=> String
|
1674
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
1675
|
+
# resp.version_arn #=> String
|
1676
|
+
# resp.name #=> String
|
1677
|
+
# resp.version_name #=> String
|
1678
|
+
# resp.description #=> String
|
1679
|
+
# resp.creation_time #=> Time
|
1680
|
+
# resp.update_time #=> Time
|
1681
|
+
# resp.tags #=> Hash
|
1682
|
+
# resp.tags["TagKey"] #=> String
|
1683
|
+
# resp.version_options.tsv_version_options.annotation_type #=> String, one of "GENERIC", "CHR_POS", "CHR_POS_REF_ALT", "CHR_START_END_ONE_BASE", "CHR_START_END_REF_ALT_ONE_BASE", "CHR_START_END_ZERO_BASE", "CHR_START_END_REF_ALT_ZERO_BASE"
|
1684
|
+
# resp.version_options.tsv_version_options.format_to_header #=> Hash
|
1685
|
+
# resp.version_options.tsv_version_options.format_to_header["FormatToHeaderKey"] #=> String
|
1686
|
+
# resp.version_options.tsv_version_options.schema #=> Array
|
1687
|
+
# resp.version_options.tsv_version_options.schema[0] #=> Hash
|
1688
|
+
# resp.version_options.tsv_version_options.schema[0]["SchemaItemKeyString"] #=> String, one of "LONG", "INT", "STRING", "FLOAT", "DOUBLE", "BOOLEAN"
|
1689
|
+
# resp.status_message #=> String
|
1690
|
+
# resp.version_size_bytes #=> Integer
|
1691
|
+
#
|
1692
|
+
#
|
1693
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1694
|
+
#
|
1695
|
+
# * annotation_store_version_created
|
1696
|
+
# * annotation_store_version_deleted
|
1697
|
+
#
|
1698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetAnnotationStoreVersion AWS API Documentation
|
1699
|
+
#
|
1700
|
+
# @overload get_annotation_store_version(params = {})
|
1701
|
+
# @param [Hash] params ({})
|
1702
|
+
def get_annotation_store_version(params = {}, options = {})
|
1703
|
+
req = build_request(:get_annotation_store_version, params)
|
1704
|
+
req.send_request(options)
|
1705
|
+
end
|
1706
|
+
|
1410
1707
|
# Gets a file from a read set.
|
1411
1708
|
#
|
1412
1709
|
# @option params [required, String] :id
|
@@ -1918,6 +2215,7 @@ module Aws::Omics
|
|
1918
2215
|
# * {Types::GetRunResponse#status_message #status_message} => String
|
1919
2216
|
# * {Types::GetRunResponse#tags #tags} => Hash<String,String>
|
1920
2217
|
# * {Types::GetRunResponse#accelerators #accelerators} => String
|
2218
|
+
# * {Types::GetRunResponse#retention_mode #retention_mode} => String
|
1921
2219
|
#
|
1922
2220
|
# @example Request syntax with placeholder values
|
1923
2221
|
#
|
@@ -1953,6 +2251,7 @@ module Aws::Omics
|
|
1953
2251
|
# resp.tags #=> Hash
|
1954
2252
|
# resp.tags["TagKey"] #=> String
|
1955
2253
|
# resp.accelerators #=> String, one of "GPU"
|
2254
|
+
# resp.retention_mode #=> String, one of "RETAIN", "REMOVE"
|
1956
2255
|
#
|
1957
2256
|
#
|
1958
2257
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -2115,6 +2414,42 @@ module Aws::Omics
|
|
2115
2414
|
req.send_request(options)
|
2116
2415
|
end
|
2117
2416
|
|
2417
|
+
# Retrieves the metadata for a share.
|
2418
|
+
#
|
2419
|
+
# @option params [required, String] :share_id
|
2420
|
+
# The generated ID for a share.
|
2421
|
+
#
|
2422
|
+
# @return [Types::GetShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2423
|
+
#
|
2424
|
+
# * {Types::GetShareResponse#share #share} => Types::ShareDetails
|
2425
|
+
#
|
2426
|
+
# @example Request syntax with placeholder values
|
2427
|
+
#
|
2428
|
+
# resp = client.get_share({
|
2429
|
+
# share_id: "String", # required
|
2430
|
+
# })
|
2431
|
+
#
|
2432
|
+
# @example Response structure
|
2433
|
+
#
|
2434
|
+
# resp.share.share_id #=> String
|
2435
|
+
# resp.share.resource_arn #=> String
|
2436
|
+
# resp.share.principal_subscriber #=> String
|
2437
|
+
# resp.share.owner_id #=> String
|
2438
|
+
# resp.share.status #=> String, one of "PENDING", "ACTIVATING", "ACTIVE", "DELETING", "DELETED", "FAILED"
|
2439
|
+
# resp.share.status_message #=> String
|
2440
|
+
# resp.share.share_name #=> String
|
2441
|
+
# resp.share.creation_time #=> Time
|
2442
|
+
# resp.share.update_time #=> Time
|
2443
|
+
#
|
2444
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetShare AWS API Documentation
|
2445
|
+
#
|
2446
|
+
# @overload get_share(params = {})
|
2447
|
+
# @param [Hash] params ({})
|
2448
|
+
def get_share(params = {}, options = {})
|
2449
|
+
req = build_request(:get_share, params)
|
2450
|
+
req.send_request(options)
|
2451
|
+
end
|
2452
|
+
|
2118
2453
|
# Gets information about a variant import job.
|
2119
2454
|
#
|
2120
2455
|
# @option params [required, String] :job_id
|
@@ -2346,6 +2681,7 @@ module Aws::Omics
|
|
2346
2681
|
# resp.annotation_import_jobs #=> Array
|
2347
2682
|
# resp.annotation_import_jobs[0].id #=> String
|
2348
2683
|
# resp.annotation_import_jobs[0].destination_name #=> String
|
2684
|
+
# resp.annotation_import_jobs[0].version_name #=> String
|
2349
2685
|
# resp.annotation_import_jobs[0].role_arn #=> String
|
2350
2686
|
# resp.annotation_import_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
|
2351
2687
|
# resp.annotation_import_jobs[0].creation_time #=> Time
|
@@ -2365,6 +2701,65 @@ module Aws::Omics
|
|
2365
2701
|
req.send_request(options)
|
2366
2702
|
end
|
2367
2703
|
|
2704
|
+
# Lists the versions of an annotation store.
|
2705
|
+
#
|
2706
|
+
# @option params [required, String] :name
|
2707
|
+
# The name of an annotation store.
|
2708
|
+
#
|
2709
|
+
# @option params [Integer] :max_results
|
2710
|
+
# The maximum number of annotation store versions to return in one page
|
2711
|
+
# of results.
|
2712
|
+
#
|
2713
|
+
# @option params [String] :next_token
|
2714
|
+
# Specifies the pagination token from a previous request to retrieve the
|
2715
|
+
# next page of results.
|
2716
|
+
#
|
2717
|
+
# @option params [Types::ListAnnotationStoreVersionsFilter] :filter
|
2718
|
+
# A filter to apply to the list of annotation store versions.
|
2719
|
+
#
|
2720
|
+
# @return [Types::ListAnnotationStoreVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2721
|
+
#
|
2722
|
+
# * {Types::ListAnnotationStoreVersionsResponse#annotation_store_versions #annotation_store_versions} => Array<Types::AnnotationStoreVersionItem>
|
2723
|
+
# * {Types::ListAnnotationStoreVersionsResponse#next_token #next_token} => String
|
2724
|
+
#
|
2725
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2726
|
+
#
|
2727
|
+
# @example Request syntax with placeholder values
|
2728
|
+
#
|
2729
|
+
# resp = client.list_annotation_store_versions({
|
2730
|
+
# name: "String", # required
|
2731
|
+
# max_results: 1,
|
2732
|
+
# next_token: "ListAnnotationStoreVersionsRequestNextTokenString",
|
2733
|
+
# filter: {
|
2734
|
+
# status: "CREATING", # accepts CREATING, UPDATING, DELETING, ACTIVE, FAILED
|
2735
|
+
# },
|
2736
|
+
# })
|
2737
|
+
#
|
2738
|
+
# @example Response structure
|
2739
|
+
#
|
2740
|
+
# resp.annotation_store_versions #=> Array
|
2741
|
+
# resp.annotation_store_versions[0].store_id #=> String
|
2742
|
+
# resp.annotation_store_versions[0].id #=> String
|
2743
|
+
# resp.annotation_store_versions[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
2744
|
+
# resp.annotation_store_versions[0].version_arn #=> String
|
2745
|
+
# resp.annotation_store_versions[0].name #=> String
|
2746
|
+
# resp.annotation_store_versions[0].version_name #=> String
|
2747
|
+
# resp.annotation_store_versions[0].description #=> String
|
2748
|
+
# resp.annotation_store_versions[0].creation_time #=> Time
|
2749
|
+
# resp.annotation_store_versions[0].update_time #=> Time
|
2750
|
+
# resp.annotation_store_versions[0].status_message #=> String
|
2751
|
+
# resp.annotation_store_versions[0].version_size_bytes #=> Integer
|
2752
|
+
# resp.next_token #=> String
|
2753
|
+
#
|
2754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListAnnotationStoreVersions AWS API Documentation
|
2755
|
+
#
|
2756
|
+
# @overload list_annotation_store_versions(params = {})
|
2757
|
+
# @param [Hash] params ({})
|
2758
|
+
def list_annotation_store_versions(params = {}, options = {})
|
2759
|
+
req = build_request(:list_annotation_store_versions, params)
|
2760
|
+
req.send_request(options)
|
2761
|
+
end
|
2762
|
+
|
2368
2763
|
# Retrieves a list of annotation stores.
|
2369
2764
|
#
|
2370
2765
|
# @option params [Array<String>] :ids
|
@@ -3163,6 +3558,64 @@ module Aws::Omics
|
|
3163
3558
|
req.send_request(options)
|
3164
3559
|
end
|
3165
3560
|
|
3561
|
+
# Lists all shares associated with an account.
|
3562
|
+
#
|
3563
|
+
# @option params [required, String] :resource_owner
|
3564
|
+
# The account that owns the analytics store shared.
|
3565
|
+
#
|
3566
|
+
# @option params [Types::Filter] :filter
|
3567
|
+
# Attributes used to filter for a specific subset of shares.
|
3568
|
+
#
|
3569
|
+
# @option params [String] :next_token
|
3570
|
+
# Next token returned in the response of a previous
|
3571
|
+
# ListReadSetUploadPartsRequest call. Used to get the next page of
|
3572
|
+
# results.
|
3573
|
+
#
|
3574
|
+
# @option params [Integer] :max_results
|
3575
|
+
# The maximum number of shares to return in one page of results.
|
3576
|
+
#
|
3577
|
+
# @return [Types::ListSharesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3578
|
+
#
|
3579
|
+
# * {Types::ListSharesResponse#shares #shares} => Array<Types::ShareDetails>
|
3580
|
+
# * {Types::ListSharesResponse#next_token #next_token} => String
|
3581
|
+
#
|
3582
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3583
|
+
#
|
3584
|
+
# @example Request syntax with placeholder values
|
3585
|
+
#
|
3586
|
+
# resp = client.list_shares({
|
3587
|
+
# resource_owner: "SELF", # required, accepts SELF, OTHER
|
3588
|
+
# filter: {
|
3589
|
+
# resource_arns: ["String"],
|
3590
|
+
# status: ["PENDING"], # accepts PENDING, ACTIVATING, ACTIVE, DELETING, DELETED, FAILED
|
3591
|
+
# },
|
3592
|
+
# next_token: "String",
|
3593
|
+
# max_results: 1,
|
3594
|
+
# })
|
3595
|
+
#
|
3596
|
+
# @example Response structure
|
3597
|
+
#
|
3598
|
+
# resp.shares #=> Array
|
3599
|
+
# resp.shares[0].share_id #=> String
|
3600
|
+
# resp.shares[0].resource_arn #=> String
|
3601
|
+
# resp.shares[0].principal_subscriber #=> String
|
3602
|
+
# resp.shares[0].owner_id #=> String
|
3603
|
+
# resp.shares[0].status #=> String, one of "PENDING", "ACTIVATING", "ACTIVE", "DELETING", "DELETED", "FAILED"
|
3604
|
+
# resp.shares[0].status_message #=> String
|
3605
|
+
# resp.shares[0].share_name #=> String
|
3606
|
+
# resp.shares[0].creation_time #=> Time
|
3607
|
+
# resp.shares[0].update_time #=> Time
|
3608
|
+
# resp.next_token #=> String
|
3609
|
+
#
|
3610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListShares AWS API Documentation
|
3611
|
+
#
|
3612
|
+
# @overload list_shares(params = {})
|
3613
|
+
# @param [Hash] params ({})
|
3614
|
+
def list_shares(params = {}, options = {})
|
3615
|
+
req = build_request(:list_shares, params)
|
3616
|
+
req.send_request(options)
|
3617
|
+
end
|
3618
|
+
|
3166
3619
|
# Retrieves a list of tags for a resource.
|
3167
3620
|
#
|
3168
3621
|
# @option params [required, String] :resource_arn
|
@@ -3374,6 +3827,9 @@ module Aws::Omics
|
|
3374
3827
|
# @option params [required, Array<Types::AnnotationImportItemSource>] :items
|
3375
3828
|
# Items to import.
|
3376
3829
|
#
|
3830
|
+
# @option params [String] :version_name
|
3831
|
+
# The name of the annotation store version.
|
3832
|
+
#
|
3377
3833
|
# @option params [Types::FormatOptions] :format_options
|
3378
3834
|
# Formatting options for the annotation file.
|
3379
3835
|
#
|
@@ -3397,6 +3853,7 @@ module Aws::Omics
|
|
3397
3853
|
# source: "S3Uri", # required
|
3398
3854
|
# },
|
3399
3855
|
# ],
|
3856
|
+
# version_name: "VersionName",
|
3400
3857
|
# format_options: {
|
3401
3858
|
# tsv_options: {
|
3402
3859
|
# read_options: {
|
@@ -3664,16 +4121,22 @@ module Aws::Omics
|
|
3664
4121
|
req.send_request(options)
|
3665
4122
|
end
|
3666
4123
|
|
3667
|
-
# Starts a run.
|
4124
|
+
# Starts a workflow run. To duplicate a run, specify the run's ID and a
|
4125
|
+
# role ARN. The remaining parameters are copied from the previous run.
|
4126
|
+
#
|
4127
|
+
# The total number of runs in your account is subject to a quota per
|
4128
|
+
# Region. To avoid needing to delete runs manually, you can set the
|
4129
|
+
# retention mode to `REMOVE`. Runs with this setting are deleted
|
4130
|
+
# automatically when the run quoata is exceeded.
|
3668
4131
|
#
|
3669
4132
|
# @option params [String] :workflow_id
|
3670
4133
|
# The run's workflow ID.
|
3671
4134
|
#
|
3672
4135
|
# @option params [String] :workflow_type
|
3673
|
-
# The run's
|
4136
|
+
# The run's workflow type.
|
3674
4137
|
#
|
3675
4138
|
# @option params [String] :run_id
|
3676
|
-
# The run
|
4139
|
+
# The ID of a run to duplicate.
|
3677
4140
|
#
|
3678
4141
|
# @option params [required, String] :role_arn
|
3679
4142
|
# A service role for the run.
|
@@ -3714,6 +4177,9 @@ module Aws::Omics
|
|
3714
4177
|
# **A suitable default value is auto-generated.** You should normally
|
3715
4178
|
# not need to pass this option.**
|
3716
4179
|
#
|
4180
|
+
# @option params [String] :retention_mode
|
4181
|
+
# The retention mode for the run.
|
4182
|
+
#
|
3717
4183
|
# @return [Types::StartRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3718
4184
|
#
|
3719
4185
|
# * {Types::StartRunResponse#arn #arn} => String
|
@@ -3740,6 +4206,7 @@ module Aws::Omics
|
|
3740
4206
|
# "TagKey" => "TagValue",
|
3741
4207
|
# },
|
3742
4208
|
# request_id: "RunRequestId", # required
|
4209
|
+
# retention_mode: "RETAIN", # accepts RETAIN, REMOVE
|
3743
4210
|
# })
|
3744
4211
|
#
|
3745
4212
|
# @example Response structure
|
@@ -3887,7 +4354,7 @@ module Aws::Omics
|
|
3887
4354
|
#
|
3888
4355
|
# resp = client.update_annotation_store({
|
3889
4356
|
# name: "String", # required
|
3890
|
-
# description: "
|
4357
|
+
# description: "Description",
|
3891
4358
|
# })
|
3892
4359
|
#
|
3893
4360
|
# @example Response structure
|
@@ -3916,6 +4383,56 @@ module Aws::Omics
|
|
3916
4383
|
req.send_request(options)
|
3917
4384
|
end
|
3918
4385
|
|
4386
|
+
# Updates the description of an annotation store version.
|
4387
|
+
#
|
4388
|
+
# @option params [required, String] :name
|
4389
|
+
# The name of an annotation store.
|
4390
|
+
#
|
4391
|
+
# @option params [required, String] :version_name
|
4392
|
+
# The name of an annotation store version.
|
4393
|
+
#
|
4394
|
+
# @option params [String] :description
|
4395
|
+
# The description of an annotation store.
|
4396
|
+
#
|
4397
|
+
# @return [Types::UpdateAnnotationStoreVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4398
|
+
#
|
4399
|
+
# * {Types::UpdateAnnotationStoreVersionResponse#store_id #store_id} => String
|
4400
|
+
# * {Types::UpdateAnnotationStoreVersionResponse#id #id} => String
|
4401
|
+
# * {Types::UpdateAnnotationStoreVersionResponse#status #status} => String
|
4402
|
+
# * {Types::UpdateAnnotationStoreVersionResponse#name #name} => String
|
4403
|
+
# * {Types::UpdateAnnotationStoreVersionResponse#version_name #version_name} => String
|
4404
|
+
# * {Types::UpdateAnnotationStoreVersionResponse#description #description} => String
|
4405
|
+
# * {Types::UpdateAnnotationStoreVersionResponse#creation_time #creation_time} => Time
|
4406
|
+
# * {Types::UpdateAnnotationStoreVersionResponse#update_time #update_time} => Time
|
4407
|
+
#
|
4408
|
+
# @example Request syntax with placeholder values
|
4409
|
+
#
|
4410
|
+
# resp = client.update_annotation_store_version({
|
4411
|
+
# name: "String", # required
|
4412
|
+
# version_name: "String", # required
|
4413
|
+
# description: "Description",
|
4414
|
+
# })
|
4415
|
+
#
|
4416
|
+
# @example Response structure
|
4417
|
+
#
|
4418
|
+
# resp.store_id #=> String
|
4419
|
+
# resp.id #=> String
|
4420
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
4421
|
+
# resp.name #=> String
|
4422
|
+
# resp.version_name #=> String
|
4423
|
+
# resp.description #=> String
|
4424
|
+
# resp.creation_time #=> Time
|
4425
|
+
# resp.update_time #=> Time
|
4426
|
+
#
|
4427
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateAnnotationStoreVersion AWS API Documentation
|
4428
|
+
#
|
4429
|
+
# @overload update_annotation_store_version(params = {})
|
4430
|
+
# @param [Hash] params ({})
|
4431
|
+
def update_annotation_store_version(params = {}, options = {})
|
4432
|
+
req = build_request(:update_annotation_store_version, params)
|
4433
|
+
req.send_request(options)
|
4434
|
+
end
|
4435
|
+
|
3919
4436
|
# Updates a run group.
|
3920
4437
|
#
|
3921
4438
|
# @option params [required, String] :id
|
@@ -3980,7 +4497,7 @@ module Aws::Omics
|
|
3980
4497
|
#
|
3981
4498
|
# resp = client.update_variant_store({
|
3982
4499
|
# name: "String", # required
|
3983
|
-
# description: "
|
4500
|
+
# description: "Description",
|
3984
4501
|
# })
|
3985
4502
|
#
|
3986
4503
|
# @example Response structure
|
@@ -4091,7 +4608,7 @@ module Aws::Omics
|
|
4091
4608
|
params: params,
|
4092
4609
|
config: config)
|
4093
4610
|
context[:gem_name] = 'aws-sdk-omics'
|
4094
|
-
context[:gem_version] = '1.
|
4611
|
+
context[:gem_version] = '1.14.0'
|
4095
4612
|
Seahorse::Client::Request.new(handlers, context)
|
4096
4613
|
end
|
4097
4614
|
|
@@ -4157,23 +4674,25 @@ module Aws::Omics
|
|
4157
4674
|
# The following table lists the valid waiter names, the operations they call,
|
4158
4675
|
# and the default `:delay` and `:max_attempts` values.
|
4159
4676
|
#
|
4160
|
-
# | waiter_name | params
|
4161
|
-
# | --------------------------------- |
|
4162
|
-
# | annotation_import_job_created | {Client#get_annotation_import_job}
|
4163
|
-
# | annotation_store_created | {Client#get_annotation_store}
|
4164
|
-
# | annotation_store_deleted | {Client#get_annotation_store}
|
4165
|
-
# |
|
4166
|
-
# |
|
4167
|
-
# |
|
4168
|
-
# |
|
4169
|
-
# |
|
4170
|
-
# |
|
4171
|
-
# |
|
4172
|
-
# |
|
4173
|
-
# |
|
4174
|
-
# |
|
4175
|
-
# |
|
4176
|
-
# |
|
4677
|
+
# | waiter_name | params | :delay | :max_attempts |
|
4678
|
+
# | --------------------------------- | ------------------------------------- | -------- | ------------- |
|
4679
|
+
# | annotation_import_job_created | {Client#get_annotation_import_job} | 30 | 20 |
|
4680
|
+
# | annotation_store_created | {Client#get_annotation_store} | 30 | 20 |
|
4681
|
+
# | annotation_store_deleted | {Client#get_annotation_store} | 30 | 20 |
|
4682
|
+
# | annotation_store_version_created | {Client#get_annotation_store_version} | 30 | 20 |
|
4683
|
+
# | annotation_store_version_deleted | {Client#get_annotation_store_version} | 30 | 20 |
|
4684
|
+
# | read_set_activation_job_completed | {Client#get_read_set_activation_job} | 30 | 20 |
|
4685
|
+
# | read_set_export_job_completed | {Client#get_read_set_export_job} | 30 | 20 |
|
4686
|
+
# | read_set_import_job_completed | {Client#get_read_set_import_job} | 30 | 20 |
|
4687
|
+
# | reference_import_job_completed | {Client#get_reference_import_job} | 30 | 20 |
|
4688
|
+
# | run_completed | {Client#get_run} | 30 | 20 |
|
4689
|
+
# | run_running | {Client#get_run} | 30 | 20 |
|
4690
|
+
# | task_completed | {Client#get_run_task} | 30 | 20 |
|
4691
|
+
# | task_running | {Client#get_run_task} | 30 | 20 |
|
4692
|
+
# | variant_import_job_created | {Client#get_variant_import_job} | 30 | 20 |
|
4693
|
+
# | variant_store_created | {Client#get_variant_store} | 30 | 20 |
|
4694
|
+
# | variant_store_deleted | {Client#get_variant_store} | 30 | 20 |
|
4695
|
+
# | workflow_active | {Client#get_workflow} | 3 | 10 |
|
4177
4696
|
#
|
4178
4697
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
4179
4698
|
# because the waiter has entered a state that it will not transition
|
@@ -4227,6 +4746,8 @@ module Aws::Omics
|
|
4227
4746
|
annotation_import_job_created: Waiters::AnnotationImportJobCreated,
|
4228
4747
|
annotation_store_created: Waiters::AnnotationStoreCreated,
|
4229
4748
|
annotation_store_deleted: Waiters::AnnotationStoreDeleted,
|
4749
|
+
annotation_store_version_created: Waiters::AnnotationStoreVersionCreated,
|
4750
|
+
annotation_store_version_deleted: Waiters::AnnotationStoreVersionDeleted,
|
4230
4751
|
read_set_activation_job_completed: Waiters::ReadSetActivationJobCompleted,
|
4231
4752
|
read_set_export_job_completed: Waiters::ReadSetExportJobCompleted,
|
4232
4753
|
read_set_import_job_completed: Waiters::ReadSetImportJobCompleted,
|