aws-sdk-wellarchitected 1.20.0 → 1.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-wellarchitected/client.rb +222 -85
- data/lib/aws-sdk-wellarchitected/client_api.rb +87 -0
- data/lib/aws-sdk-wellarchitected/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-wellarchitected/endpoints.rb +14 -0
- data/lib/aws-sdk-wellarchitected/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-wellarchitected/types.rb +398 -99
- data/lib/aws-sdk-wellarchitected.rb +1 -1
- metadata +2 -2
@@ -413,9 +413,18 @@ module Aws::WellArchitected
|
|
413
413
|
# Create a lens share.
|
414
414
|
#
|
415
415
|
# The owner of a lens can share it with other Amazon Web Services
|
416
|
-
# accounts,
|
417
|
-
#
|
418
|
-
#
|
416
|
+
# accounts, users, an organization, and organizational units (OUs) in
|
417
|
+
# the same Amazon Web Services Region. Lenses provided by Amazon Web
|
418
|
+
# Services (Amazon Web Services Official Content) cannot be shared.
|
419
|
+
#
|
420
|
+
# Shared access to a lens is not removed until the lens invitation is
|
421
|
+
# deleted.
|
422
|
+
#
|
423
|
+
# If you share a lens with an organization or OU, all accounts in the
|
424
|
+
# organization or OU are granted access to the lens.
|
425
|
+
#
|
426
|
+
# For more information, see [Sharing a custom lens][1] in the
|
427
|
+
# *Well-Architected Tool User Guide*.
|
419
428
|
#
|
420
429
|
# <note markdown="1"> **Disclaimer**
|
421
430
|
#
|
@@ -428,15 +437,21 @@ module Aws::WellArchitected
|
|
428
437
|
#
|
429
438
|
# </note>
|
430
439
|
#
|
440
|
+
#
|
441
|
+
#
|
442
|
+
# [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-sharing.html
|
443
|
+
#
|
431
444
|
# @option params [required, String] :lens_alias
|
432
445
|
# The alias of the lens.
|
433
446
|
#
|
434
447
|
# For Amazon Web Services official lenses, this is either the lens
|
435
448
|
# alias, such as `serverless`, or the lens ARN, such as
|
436
|
-
# `arn:aws:wellarchitected:us-
|
449
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
450
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
451
|
+
# on Amazon Web Services official lenses.
|
437
452
|
#
|
438
453
|
# For custom lenses, this is the lens ARN, such as
|
439
|
-
# `arn:aws:wellarchitected:us-
|
454
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
440
455
|
#
|
441
456
|
# Each lens is identified by its LensSummary$LensAlias.
|
442
457
|
#
|
@@ -450,8 +465,8 @@ module Aws::WellArchitected
|
|
450
465
|
#
|
451
466
|
# You should not reuse the same token for other requests. If you retry a
|
452
467
|
# request with the same client request token and the same parameters
|
453
|
-
# after
|
454
|
-
# request is returned.
|
468
|
+
# after the original request has completed successfully, the result of
|
469
|
+
# the original request is returned.
|
455
470
|
#
|
456
471
|
# This token is listed as required, however, if you do not specify it,
|
457
472
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -490,9 +505,10 @@ module Aws::WellArchitected
|
|
490
505
|
#
|
491
506
|
# A lens can have up to 100 versions.
|
492
507
|
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
508
|
+
# Use this operation to publish a new lens version after you have
|
509
|
+
# imported a lens. The `LensAlias` is used to identify the lens to be
|
510
|
+
# published. The owner of a lens can share the lens with other Amazon
|
511
|
+
# Web Services accounts and users in the same Amazon Web Services
|
496
512
|
# Region. Only the owner of a lens can delete it.
|
497
513
|
#
|
498
514
|
# @option params [required, String] :lens_alias
|
@@ -500,10 +516,12 @@ module Aws::WellArchitected
|
|
500
516
|
#
|
501
517
|
# For Amazon Web Services official lenses, this is either the lens
|
502
518
|
# alias, such as `serverless`, or the lens ARN, such as
|
503
|
-
# `arn:aws:wellarchitected:us-
|
519
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
520
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
521
|
+
# on Amazon Web Services official lenses.
|
504
522
|
#
|
505
523
|
# For custom lenses, this is the lens ARN, such as
|
506
|
-
# `arn:aws:wellarchitected:us-
|
524
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
507
525
|
#
|
508
526
|
# Each lens is identified by its LensSummary$LensAlias.
|
509
527
|
#
|
@@ -519,8 +537,8 @@ module Aws::WellArchitected
|
|
519
537
|
#
|
520
538
|
# You should not reuse the same token for other requests. If you retry a
|
521
539
|
# request with the same client request token and the same parameters
|
522
|
-
# after
|
523
|
-
# request is returned.
|
540
|
+
# after the original request has completed successfully, the result of
|
541
|
+
# the original request is returned.
|
524
542
|
#
|
525
543
|
# This token is listed as required, however, if you do not specify it,
|
526
544
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -575,8 +593,8 @@ module Aws::WellArchitected
|
|
575
593
|
#
|
576
594
|
# You should not reuse the same token for other requests. If you retry a
|
577
595
|
# request with the same client request token and the same parameters
|
578
|
-
# after
|
579
|
-
# request is returned.
|
596
|
+
# after the original request has completed successfully, the result of
|
597
|
+
# the original request is returned.
|
580
598
|
#
|
581
599
|
# This token is listed as required, however, if you do not specify it,
|
582
600
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -616,13 +634,19 @@ module Aws::WellArchitected
|
|
616
634
|
# Create a new workload.
|
617
635
|
#
|
618
636
|
# The owner of a workload can share the workload with other Amazon Web
|
619
|
-
# Services accounts,
|
620
|
-
#
|
621
|
-
#
|
637
|
+
# Services accounts, users, an organization, and organizational units
|
638
|
+
# (OUs) in the same Amazon Web Services Region. Only the owner of a
|
639
|
+
# workload can delete it.
|
622
640
|
#
|
623
641
|
# For more information, see [Defining a Workload][1] in the
|
624
642
|
# *Well-Architected Tool User Guide*.
|
625
643
|
#
|
644
|
+
# Either `AwsRegions`, `NonAwsRegions`, or both must be specified when
|
645
|
+
# creating a workload.
|
646
|
+
#
|
647
|
+
# You also must specify `ReviewOwner`, even though the parameter is
|
648
|
+
# listed as not being required in the following section.
|
649
|
+
#
|
626
650
|
#
|
627
651
|
#
|
628
652
|
# [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html
|
@@ -740,8 +764,8 @@ module Aws::WellArchitected
|
|
740
764
|
#
|
741
765
|
# You should not reuse the same token for other requests. If you retry a
|
742
766
|
# request with the same client request token and the same parameters
|
743
|
-
# after
|
744
|
-
# request is returned.
|
767
|
+
# after the original request has completed successfully, the result of
|
768
|
+
# the original request is returned.
|
745
769
|
#
|
746
770
|
# This token is listed as required, however, if you do not specify it,
|
747
771
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -809,11 +833,14 @@ module Aws::WellArchitected
|
|
809
833
|
# Create a workload share.
|
810
834
|
#
|
811
835
|
# The owner of a workload can share it with other Amazon Web Services
|
812
|
-
# accounts and
|
836
|
+
# accounts and users in the same Amazon Web Services Region. Shared
|
813
837
|
# access to a workload is not removed until the workload invitation is
|
814
838
|
# deleted.
|
815
839
|
#
|
816
|
-
#
|
840
|
+
# If you share a workload with an organization or OU, all accounts in
|
841
|
+
# the organization or OU are granted access to the workload.
|
842
|
+
#
|
843
|
+
# For more information, see [Sharing a workload][1] in the
|
817
844
|
# *Well-Architected Tool User Guide*.
|
818
845
|
#
|
819
846
|
#
|
@@ -837,8 +864,8 @@ module Aws::WellArchitected
|
|
837
864
|
#
|
838
865
|
# You should not reuse the same token for other requests. If you retry a
|
839
866
|
# request with the same client request token and the same parameters
|
840
|
-
# after
|
841
|
-
# request is returned.
|
867
|
+
# after the original request has completed successfully, the result of
|
868
|
+
# the original request is returned.
|
842
869
|
#
|
843
870
|
# This token is listed as required, however, if you do not specify it,
|
844
871
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -879,9 +906,9 @@ module Aws::WellArchitected
|
|
879
906
|
# Delete an existing lens.
|
880
907
|
#
|
881
908
|
# Only the owner of a lens can delete it. After the lens is deleted,
|
882
|
-
# Amazon Web Services accounts and
|
883
|
-
#
|
884
|
-
#
|
909
|
+
# Amazon Web Services accounts and users that you shared the lens with
|
910
|
+
# can continue to use it, but they will no longer be able to apply it to
|
911
|
+
# new workloads.
|
885
912
|
#
|
886
913
|
# <note markdown="1"> **Disclaimer**
|
887
914
|
#
|
@@ -899,10 +926,12 @@ module Aws::WellArchitected
|
|
899
926
|
#
|
900
927
|
# For Amazon Web Services official lenses, this is either the lens
|
901
928
|
# alias, such as `serverless`, or the lens ARN, such as
|
902
|
-
# `arn:aws:wellarchitected:us-
|
929
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
930
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
931
|
+
# on Amazon Web Services official lenses.
|
903
932
|
#
|
904
933
|
# For custom lenses, this is the lens ARN, such as
|
905
|
-
# `arn:aws:wellarchitected:us-
|
934
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
906
935
|
#
|
907
936
|
# Each lens is identified by its LensSummary$LensAlias.
|
908
937
|
#
|
@@ -912,8 +941,8 @@ module Aws::WellArchitected
|
|
912
941
|
#
|
913
942
|
# You should not reuse the same token for other requests. If you retry a
|
914
943
|
# request with the same client request token and the same parameters
|
915
|
-
# after
|
916
|
-
# request is returned.
|
944
|
+
# after the original request has completed successfully, the result of
|
945
|
+
# the original request is returned.
|
917
946
|
#
|
918
947
|
# This token is listed as required, however, if you do not specify it,
|
919
948
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -947,10 +976,10 @@ module Aws::WellArchitected
|
|
947
976
|
|
948
977
|
# Delete a lens share.
|
949
978
|
#
|
950
|
-
# After the lens share is deleted, Amazon Web Services accounts,
|
951
|
-
#
|
952
|
-
#
|
953
|
-
#
|
979
|
+
# After the lens share is deleted, Amazon Web Services accounts, users,
|
980
|
+
# organizations, and organizational units (OUs) that you shared the lens
|
981
|
+
# with can continue to use it, but they will no longer be able to apply
|
982
|
+
# it to new workloads.
|
954
983
|
#
|
955
984
|
# <note markdown="1"> **Disclaimer**
|
956
985
|
#
|
@@ -971,10 +1000,12 @@ module Aws::WellArchitected
|
|
971
1000
|
#
|
972
1001
|
# For Amazon Web Services official lenses, this is either the lens
|
973
1002
|
# alias, such as `serverless`, or the lens ARN, such as
|
974
|
-
# `arn:aws:wellarchitected:us-
|
1003
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1004
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1005
|
+
# on Amazon Web Services official lenses.
|
975
1006
|
#
|
976
1007
|
# For custom lenses, this is the lens ARN, such as
|
977
|
-
# `arn:aws:wellarchitected:us-
|
1008
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
978
1009
|
#
|
979
1010
|
# Each lens is identified by its LensSummary$LensAlias.
|
980
1011
|
#
|
@@ -984,8 +1015,8 @@ module Aws::WellArchitected
|
|
984
1015
|
#
|
985
1016
|
# You should not reuse the same token for other requests. If you retry a
|
986
1017
|
# request with the same client request token and the same parameters
|
987
|
-
# after
|
988
|
-
# request is returned.
|
1018
|
+
# after the original request has completed successfully, the result of
|
1019
|
+
# the original request is returned.
|
989
1020
|
#
|
990
1021
|
# This token is listed as required, however, if you do not specify it,
|
991
1022
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1026,8 +1057,8 @@ module Aws::WellArchitected
|
|
1026
1057
|
#
|
1027
1058
|
# You should not reuse the same token for other requests. If you retry a
|
1028
1059
|
# request with the same client request token and the same parameters
|
1029
|
-
# after
|
1030
|
-
# request is returned.
|
1060
|
+
# after the original request has completed successfully, the result of
|
1061
|
+
# the original request is returned.
|
1031
1062
|
#
|
1032
1063
|
# This token is listed as required, however, if you do not specify it,
|
1033
1064
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1070,8 +1101,8 @@ module Aws::WellArchitected
|
|
1070
1101
|
#
|
1071
1102
|
# You should not reuse the same token for other requests. If you retry a
|
1072
1103
|
# request with the same client request token and the same parameters
|
1073
|
-
# after
|
1074
|
-
# request is returned.
|
1104
|
+
# after the original request has completed successfully, the result of
|
1105
|
+
# the original request is returned.
|
1075
1106
|
#
|
1076
1107
|
# This token is listed as required, however, if you do not specify it,
|
1077
1108
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1140,9 +1171,11 @@ module Aws::WellArchitected
|
|
1140
1171
|
|
1141
1172
|
# Export an existing lens.
|
1142
1173
|
#
|
1174
|
+
# Only the owner of a lens can export it. Lenses provided by Amazon Web
|
1175
|
+
# Services (Amazon Web Services Official Content) cannot be exported.
|
1176
|
+
#
|
1143
1177
|
# Lenses are defined in JSON. For more information, see [JSON format
|
1144
|
-
# specification][1] in the *Well-Architected Tool User Guide*.
|
1145
|
-
# owner of a lens can export it.
|
1178
|
+
# specification][1] in the *Well-Architected Tool User Guide*.
|
1146
1179
|
#
|
1147
1180
|
# <note markdown="1"> **Disclaimer**
|
1148
1181
|
#
|
@@ -1165,10 +1198,12 @@ module Aws::WellArchitected
|
|
1165
1198
|
#
|
1166
1199
|
# For Amazon Web Services official lenses, this is either the lens
|
1167
1200
|
# alias, such as `serverless`, or the lens ARN, such as
|
1168
|
-
# `arn:aws:wellarchitected:us-
|
1201
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1202
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1203
|
+
# on Amazon Web Services official lenses.
|
1169
1204
|
#
|
1170
1205
|
# For custom lenses, this is the lens ARN, such as
|
1171
|
-
# `arn:aws:wellarchitected:us-
|
1206
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1172
1207
|
#
|
1173
1208
|
# Each lens is identified by its LensSummary$LensAlias.
|
1174
1209
|
#
|
@@ -1210,10 +1245,12 @@ module Aws::WellArchitected
|
|
1210
1245
|
#
|
1211
1246
|
# For Amazon Web Services official lenses, this is either the lens
|
1212
1247
|
# alias, such as `serverless`, or the lens ARN, such as
|
1213
|
-
# `arn:aws:wellarchitected:us-
|
1248
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1249
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1250
|
+
# on Amazon Web Services official lenses.
|
1214
1251
|
#
|
1215
1252
|
# For custom lenses, this is the lens ARN, such as
|
1216
|
-
# `arn:aws:wellarchitected:us-
|
1253
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1217
1254
|
#
|
1218
1255
|
# Each lens is identified by its LensSummary$LensAlias.
|
1219
1256
|
#
|
@@ -1289,6 +1326,80 @@ module Aws::WellArchitected
|
|
1289
1326
|
req.send_request(options)
|
1290
1327
|
end
|
1291
1328
|
|
1329
|
+
# Get a consolidated report of your workloads.
|
1330
|
+
#
|
1331
|
+
# You can optionally choose to include workloads that have been shared
|
1332
|
+
# with you.
|
1333
|
+
#
|
1334
|
+
# @option params [required, String] :format
|
1335
|
+
# The format of the consolidated report.
|
1336
|
+
#
|
1337
|
+
# For `PDF`, `Base64String` is returned. For `JSON`, `Metrics` is
|
1338
|
+
# returned.
|
1339
|
+
#
|
1340
|
+
# @option params [Boolean] :include_shared_resources
|
1341
|
+
# Set to `true` to have shared resources included in the report.
|
1342
|
+
#
|
1343
|
+
# @option params [String] :next_token
|
1344
|
+
# The token to use to retrieve the next set of results.
|
1345
|
+
#
|
1346
|
+
# @option params [Integer] :max_results
|
1347
|
+
# The maximum number of results to return for this request.
|
1348
|
+
#
|
1349
|
+
# @return [Types::GetConsolidatedReportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1350
|
+
#
|
1351
|
+
# * {Types::GetConsolidatedReportOutput#metrics #metrics} => Array<Types::ConsolidatedReportMetric>
|
1352
|
+
# * {Types::GetConsolidatedReportOutput#next_token #next_token} => String
|
1353
|
+
# * {Types::GetConsolidatedReportOutput#base_64_string #base_64_string} => String
|
1354
|
+
#
|
1355
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1356
|
+
#
|
1357
|
+
# @example Request syntax with placeholder values
|
1358
|
+
#
|
1359
|
+
# resp = client.get_consolidated_report({
|
1360
|
+
# format: "PDF", # required, accepts PDF, JSON
|
1361
|
+
# include_shared_resources: false,
|
1362
|
+
# next_token: "NextToken",
|
1363
|
+
# max_results: 1,
|
1364
|
+
# })
|
1365
|
+
#
|
1366
|
+
# @example Response structure
|
1367
|
+
#
|
1368
|
+
# resp.metrics #=> Array
|
1369
|
+
# resp.metrics[0].metric_type #=> String, one of "WORKLOAD"
|
1370
|
+
# resp.metrics[0].risk_counts #=> Hash
|
1371
|
+
# resp.metrics[0].risk_counts["Risk"] #=> Integer
|
1372
|
+
# resp.metrics[0].workload_id #=> String
|
1373
|
+
# resp.metrics[0].workload_name #=> String
|
1374
|
+
# resp.metrics[0].workload_arn #=> String
|
1375
|
+
# resp.metrics[0].updated_at #=> Time
|
1376
|
+
# resp.metrics[0].lenses #=> Array
|
1377
|
+
# resp.metrics[0].lenses[0].lens_arn #=> String
|
1378
|
+
# resp.metrics[0].lenses[0].pillars #=> Array
|
1379
|
+
# resp.metrics[0].lenses[0].pillars[0].pillar_id #=> String
|
1380
|
+
# resp.metrics[0].lenses[0].pillars[0].risk_counts #=> Hash
|
1381
|
+
# resp.metrics[0].lenses[0].pillars[0].risk_counts["Risk"] #=> Integer
|
1382
|
+
# resp.metrics[0].lenses[0].pillars[0].questions #=> Array
|
1383
|
+
# resp.metrics[0].lenses[0].pillars[0].questions[0].question_id #=> String
|
1384
|
+
# resp.metrics[0].lenses[0].pillars[0].questions[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
|
1385
|
+
# resp.metrics[0].lenses[0].pillars[0].questions[0].best_practices #=> Array
|
1386
|
+
# resp.metrics[0].lenses[0].pillars[0].questions[0].best_practices[0].choice_id #=> String
|
1387
|
+
# resp.metrics[0].lenses[0].pillars[0].questions[0].best_practices[0].choice_title #=> String
|
1388
|
+
# resp.metrics[0].lenses[0].risk_counts #=> Hash
|
1389
|
+
# resp.metrics[0].lenses[0].risk_counts["Risk"] #=> Integer
|
1390
|
+
# resp.metrics[0].lenses_applied_count #=> Integer
|
1391
|
+
# resp.next_token #=> String
|
1392
|
+
# resp.base_64_string #=> String
|
1393
|
+
#
|
1394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetConsolidatedReport AWS API Documentation
|
1395
|
+
#
|
1396
|
+
# @overload get_consolidated_report(params = {})
|
1397
|
+
# @param [Hash] params ({})
|
1398
|
+
def get_consolidated_report(params = {}, options = {})
|
1399
|
+
req = build_request(:get_consolidated_report, params)
|
1400
|
+
req.send_request(options)
|
1401
|
+
end
|
1402
|
+
|
1292
1403
|
# Get an existing lens.
|
1293
1404
|
#
|
1294
1405
|
# @option params [required, String] :lens_alias
|
@@ -1296,10 +1407,12 @@ module Aws::WellArchitected
|
|
1296
1407
|
#
|
1297
1408
|
# For Amazon Web Services official lenses, this is either the lens
|
1298
1409
|
# alias, such as `serverless`, or the lens ARN, such as
|
1299
|
-
# `arn:aws:wellarchitected:us-
|
1410
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1411
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1412
|
+
# on Amazon Web Services official lenses.
|
1300
1413
|
#
|
1301
1414
|
# For custom lenses, this is the lens ARN, such as
|
1302
|
-
# `arn:aws:wellarchitected:us-
|
1415
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1303
1416
|
#
|
1304
1417
|
# Each lens is identified by its LensSummary$LensAlias.
|
1305
1418
|
#
|
@@ -1348,10 +1461,12 @@ module Aws::WellArchitected
|
|
1348
1461
|
#
|
1349
1462
|
# For Amazon Web Services official lenses, this is either the lens
|
1350
1463
|
# alias, such as `serverless`, or the lens ARN, such as
|
1351
|
-
# `arn:aws:wellarchitected:us-
|
1464
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1465
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1466
|
+
# on Amazon Web Services official lenses.
|
1352
1467
|
#
|
1353
1468
|
# For custom lenses, this is the lens ARN, such as
|
1354
|
-
# `arn:aws:wellarchitected:us-
|
1469
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1355
1470
|
#
|
1356
1471
|
# Each lens is identified by its LensSummary$LensAlias.
|
1357
1472
|
#
|
@@ -1415,10 +1530,12 @@ module Aws::WellArchitected
|
|
1415
1530
|
#
|
1416
1531
|
# For Amazon Web Services official lenses, this is either the lens
|
1417
1532
|
# alias, such as `serverless`, or the lens ARN, such as
|
1418
|
-
# `arn:aws:wellarchitected:us-
|
1533
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1534
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1535
|
+
# on Amazon Web Services official lenses.
|
1419
1536
|
#
|
1420
1537
|
# For custom lenses, this is the lens ARN, such as
|
1421
|
-
# `arn:aws:wellarchitected:us-
|
1538
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1422
1539
|
#
|
1423
1540
|
# Each lens is identified by its LensSummary$LensAlias.
|
1424
1541
|
#
|
@@ -1465,10 +1582,12 @@ module Aws::WellArchitected
|
|
1465
1582
|
#
|
1466
1583
|
# For Amazon Web Services official lenses, this is either the lens
|
1467
1584
|
# alias, such as `serverless`, or the lens ARN, such as
|
1468
|
-
# `arn:aws:wellarchitected:us-
|
1585
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1586
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1587
|
+
# on Amazon Web Services official lenses.
|
1469
1588
|
#
|
1470
1589
|
# For custom lenses, this is the lens ARN, such as
|
1471
|
-
# `arn:aws:wellarchitected:us-
|
1590
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1472
1591
|
#
|
1473
1592
|
# Each lens is identified by its LensSummary$LensAlias.
|
1474
1593
|
#
|
@@ -1653,10 +1772,14 @@ module Aws::WellArchitected
|
|
1653
1772
|
req.send_request(options)
|
1654
1773
|
end
|
1655
1774
|
|
1656
|
-
# Import a new lens.
|
1775
|
+
# Import a new custom lens or update an existing custom lens.
|
1776
|
+
#
|
1777
|
+
# To update an existing custom lens, specify its ARN as the `LensAlias`.
|
1778
|
+
# If no ARN is specified, a new custom lens is created.
|
1657
1779
|
#
|
1658
|
-
# The lens
|
1659
|
-
#
|
1780
|
+
# The new or updated lens will have a status of `DRAFT`. The lens cannot
|
1781
|
+
# be applied to workloads or shared with other Amazon Web Services
|
1782
|
+
# accounts until it's published with CreateLensVersion.
|
1660
1783
|
#
|
1661
1784
|
# Lenses are defined in JSON. For more information, see [JSON format
|
1662
1785
|
# specification][1] in the *Well-Architected Tool User Guide*.
|
@@ -1684,10 +1807,12 @@ module Aws::WellArchitected
|
|
1684
1807
|
#
|
1685
1808
|
# For Amazon Web Services official lenses, this is either the lens
|
1686
1809
|
# alias, such as `serverless`, or the lens ARN, such as
|
1687
|
-
# `arn:aws:wellarchitected:us-
|
1810
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1811
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1812
|
+
# on Amazon Web Services official lenses.
|
1688
1813
|
#
|
1689
1814
|
# For custom lenses, this is the lens ARN, such as
|
1690
|
-
# `arn:aws:wellarchitected:us-
|
1815
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1691
1816
|
#
|
1692
1817
|
# Each lens is identified by its LensSummary$LensAlias.
|
1693
1818
|
#
|
@@ -1700,8 +1825,8 @@ module Aws::WellArchitected
|
|
1700
1825
|
#
|
1701
1826
|
# You should not reuse the same token for other requests. If you retry a
|
1702
1827
|
# request with the same client request token and the same parameters
|
1703
|
-
# after
|
1704
|
-
# request is returned.
|
1828
|
+
# after the original request has completed successfully, the result of
|
1829
|
+
# the original request is returned.
|
1705
1830
|
#
|
1706
1831
|
# This token is listed as required, however, if you do not specify it,
|
1707
1832
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1744,7 +1869,7 @@ module Aws::WellArchitected
|
|
1744
1869
|
req.send_request(options)
|
1745
1870
|
end
|
1746
1871
|
|
1747
|
-
# List of answers.
|
1872
|
+
# List of answers for a particular workload and lens.
|
1748
1873
|
#
|
1749
1874
|
# @option params [required, String] :workload_id
|
1750
1875
|
# The ID assigned to the workload. This ID is unique within an Amazon
|
@@ -1755,10 +1880,12 @@ module Aws::WellArchitected
|
|
1755
1880
|
#
|
1756
1881
|
# For Amazon Web Services official lenses, this is either the lens
|
1757
1882
|
# alias, such as `serverless`, or the lens ARN, such as
|
1758
|
-
# `arn:aws:wellarchitected:us-
|
1883
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1884
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1885
|
+
# on Amazon Web Services official lenses.
|
1759
1886
|
#
|
1760
1887
|
# For custom lenses, this is the lens ARN, such as
|
1761
|
-
# `arn:aws:wellarchitected:us-
|
1888
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1762
1889
|
#
|
1763
1890
|
# Each lens is identified by its LensSummary$LensAlias.
|
1764
1891
|
#
|
@@ -1999,10 +2126,12 @@ module Aws::WellArchitected
|
|
1999
2126
|
#
|
2000
2127
|
# For Amazon Web Services official lenses, this is either the lens
|
2001
2128
|
# alias, such as `serverless`, or the lens ARN, such as
|
2002
|
-
# `arn:aws:wellarchitected:us-
|
2129
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2130
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
2131
|
+
# on Amazon Web Services official lenses.
|
2003
2132
|
#
|
2004
2133
|
# For custom lenses, this is the lens ARN, such as
|
2005
|
-
# `arn:aws:wellarchitected:us-
|
2134
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2006
2135
|
#
|
2007
2136
|
# Each lens is identified by its LensSummary$LensAlias.
|
2008
2137
|
#
|
@@ -2071,7 +2200,7 @@ module Aws::WellArchitected
|
|
2071
2200
|
req.send_request(options)
|
2072
2201
|
end
|
2073
2202
|
|
2074
|
-
# List lens reviews.
|
2203
|
+
# List lens reviews for a particular workload.
|
2075
2204
|
#
|
2076
2205
|
# @option params [required, String] :workload_id
|
2077
2206
|
# The ID assigned to the workload. This ID is unique within an Amazon
|
@@ -2137,10 +2266,12 @@ module Aws::WellArchitected
|
|
2137
2266
|
#
|
2138
2267
|
# For Amazon Web Services official lenses, this is either the lens
|
2139
2268
|
# alias, such as `serverless`, or the lens ARN, such as
|
2140
|
-
# `arn:aws:wellarchitected:us-
|
2269
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2270
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
2271
|
+
# on Amazon Web Services official lenses.
|
2141
2272
|
#
|
2142
2273
|
# For custom lenses, this is the lens ARN, such as
|
2143
|
-
# `arn:aws:wellarchitected:us-
|
2274
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2144
2275
|
#
|
2145
2276
|
# Each lens is identified by its LensSummary$LensAlias.
|
2146
2277
|
#
|
@@ -2504,7 +2635,7 @@ module Aws::WellArchitected
|
|
2504
2635
|
req.send_request(options)
|
2505
2636
|
end
|
2506
2637
|
|
2507
|
-
#
|
2638
|
+
# Paginated list of workloads.
|
2508
2639
|
#
|
2509
2640
|
# @option params [String] :workload_name_prefix
|
2510
2641
|
# An optional string added to the beginning of each workload name
|
@@ -2636,10 +2767,12 @@ module Aws::WellArchitected
|
|
2636
2767
|
#
|
2637
2768
|
# For Amazon Web Services official lenses, this is either the lens
|
2638
2769
|
# alias, such as `serverless`, or the lens ARN, such as
|
2639
|
-
# `arn:aws:wellarchitected:us-
|
2770
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2771
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
2772
|
+
# on Amazon Web Services official lenses.
|
2640
2773
|
#
|
2641
2774
|
# For custom lenses, this is the lens ARN, such as
|
2642
|
-
# `arn:aws:wellarchitected:us-
|
2775
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2643
2776
|
#
|
2644
2777
|
# Each lens is identified by its LensSummary$LensAlias.
|
2645
2778
|
#
|
@@ -2759,7 +2892,7 @@ module Aws::WellArchitected
|
|
2759
2892
|
req.send_request(options)
|
2760
2893
|
end
|
2761
2894
|
|
2762
|
-
# Update lens review.
|
2895
|
+
# Update lens review for a particular workload.
|
2763
2896
|
#
|
2764
2897
|
# @option params [required, String] :workload_id
|
2765
2898
|
# The ID assigned to the workload. This ID is unique within an Amazon
|
@@ -2770,10 +2903,12 @@ module Aws::WellArchitected
|
|
2770
2903
|
#
|
2771
2904
|
# For Amazon Web Services official lenses, this is either the lens
|
2772
2905
|
# alias, such as `serverless`, or the lens ARN, such as
|
2773
|
-
# `arn:aws:wellarchitected:us-
|
2906
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2907
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
2908
|
+
# on Amazon Web Services official lenses.
|
2774
2909
|
#
|
2775
2910
|
# For custom lenses, this is the lens ARN, such as
|
2776
|
-
# `arn:aws:wellarchitected:us-
|
2911
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2777
2912
|
#
|
2778
2913
|
# Each lens is identified by its LensSummary$LensAlias.
|
2779
2914
|
#
|
@@ -3114,7 +3249,7 @@ module Aws::WellArchitected
|
|
3114
3249
|
req.send_request(options)
|
3115
3250
|
end
|
3116
3251
|
|
3117
|
-
# Upgrade lens review.
|
3252
|
+
# Upgrade lens review for a particular workload.
|
3118
3253
|
#
|
3119
3254
|
# @option params [required, String] :workload_id
|
3120
3255
|
# The ID assigned to the workload. This ID is unique within an Amazon
|
@@ -3125,10 +3260,12 @@ module Aws::WellArchitected
|
|
3125
3260
|
#
|
3126
3261
|
# For Amazon Web Services official lenses, this is either the lens
|
3127
3262
|
# alias, such as `serverless`, or the lens ARN, such as
|
3128
|
-
# `arn:aws:wellarchitected:us-
|
3263
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
3264
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
3265
|
+
# on Amazon Web Services official lenses.
|
3129
3266
|
#
|
3130
3267
|
# For custom lenses, this is the lens ARN, such as
|
3131
|
-
# `arn:aws:wellarchitected:us-
|
3268
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
3132
3269
|
#
|
3133
3270
|
# Each lens is identified by its LensSummary$LensAlias.
|
3134
3271
|
#
|
@@ -3143,8 +3280,8 @@ module Aws::WellArchitected
|
|
3143
3280
|
#
|
3144
3281
|
# You should not reuse the same token for other requests. If you retry a
|
3145
3282
|
# request with the same client request token and the same parameters
|
3146
|
-
# after
|
3147
|
-
# request is returned.
|
3283
|
+
# after the original request has completed successfully, the result of
|
3284
|
+
# the original request is returned.
|
3148
3285
|
#
|
3149
3286
|
# This token is listed as required, however, if you do not specify it,
|
3150
3287
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -3184,7 +3321,7 @@ module Aws::WellArchitected
|
|
3184
3321
|
params: params,
|
3185
3322
|
config: config)
|
3186
3323
|
context[:gem_name] = 'aws-sdk-wellarchitected'
|
3187
|
-
context[:gem_version] = '1.
|
3324
|
+
context[:gem_version] = '1.21.0'
|
3188
3325
|
Seahorse::Client::Request.new(handlers, context)
|
3189
3326
|
end
|
3190
3327
|
|