aws-sdk-wellarchitected 1.20.0 → 1.22.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-wellarchitected/client.rb +235 -86
- data/lib/aws-sdk-wellarchitected/client_api.rb +94 -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 +413 -101
- data/lib/aws-sdk-wellarchitected.rb +1 -1
- metadata +2 -2
@@ -24,15 +24,18 @@ module Aws::WellArchitected
|
|
24
24
|
include Aws::Structure
|
25
25
|
end
|
26
26
|
|
27
|
-
# The choice level additional resources.
|
27
|
+
# The choice level additional resources for a custom lens.
|
28
|
+
#
|
29
|
+
# This field does not apply to Amazon Web Services official lenses.
|
28
30
|
#
|
29
31
|
# @!attribute [rw] type
|
30
|
-
# Type of additional resource.
|
32
|
+
# Type of additional resource for a custom lens.
|
31
33
|
# @return [String]
|
32
34
|
#
|
33
35
|
# @!attribute [rw] content
|
34
36
|
# The URLs for additional resources, either helpful resources or
|
35
|
-
# improvement plans. Up to five additional URLs can
|
37
|
+
# improvement plans, for a custom lens. Up to five additional URLs can
|
38
|
+
# be specified.
|
36
39
|
# @return [Array<Types::ChoiceContent>]
|
37
40
|
#
|
38
41
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/AdditionalResources AWS API Documentation
|
@@ -65,17 +68,29 @@ module Aws::WellArchitected
|
|
65
68
|
# @return [String]
|
66
69
|
#
|
67
70
|
# @!attribute [rw] improvement_plan_url
|
68
|
-
# The improvement plan URL for a question
|
71
|
+
# The improvement plan URL for a question in an Amazon Web Services
|
72
|
+
# official lenses.
|
69
73
|
#
|
70
74
|
# This value is only available if the question has been answered.
|
75
|
+
#
|
76
|
+
# This value does not apply to custom lenses.
|
71
77
|
# @return [String]
|
72
78
|
#
|
73
79
|
# @!attribute [rw] helpful_resource_url
|
74
|
-
# The helpful resource URL
|
80
|
+
# The helpful resource URL.
|
81
|
+
#
|
82
|
+
# For Amazon Web Services official lenses, this is the helpful
|
83
|
+
# resource URL for a question or choice.
|
84
|
+
#
|
85
|
+
# For custom lenses, this is the helpful resource URL for a question
|
86
|
+
# and is only provided if `HelpfulResourceDisplayText` was specified
|
87
|
+
# for the question.
|
75
88
|
# @return [String]
|
76
89
|
#
|
77
90
|
# @!attribute [rw] helpful_resource_display_text
|
78
|
-
# The helpful resource text to be displayed.
|
91
|
+
# The helpful resource text to be displayed for a custom lens.
|
92
|
+
#
|
93
|
+
# This field does not apply to Amazon Web Services official lenses.
|
79
94
|
# @return [String]
|
80
95
|
#
|
81
96
|
# @!attribute [rw] choices
|
@@ -211,6 +226,26 @@ module Aws::WellArchitected
|
|
211
226
|
include Aws::Structure
|
212
227
|
end
|
213
228
|
|
229
|
+
# A best practice, or question choice, that has been identified as a
|
230
|
+
# risk in this question.
|
231
|
+
#
|
232
|
+
# @!attribute [rw] choice_id
|
233
|
+
# The ID of a choice.
|
234
|
+
# @return [String]
|
235
|
+
#
|
236
|
+
# @!attribute [rw] choice_title
|
237
|
+
# The title of a choice.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/BestPractice AWS API Documentation
|
241
|
+
#
|
242
|
+
class BestPractice < Struct.new(
|
243
|
+
:choice_id,
|
244
|
+
:choice_title)
|
245
|
+
SENSITIVE = []
|
246
|
+
include Aws::Structure
|
247
|
+
end
|
248
|
+
|
214
249
|
# Account details for a Well-Architected best practice in relation to
|
215
250
|
# Trusted Advisor checks.
|
216
251
|
#
|
@@ -369,17 +404,24 @@ module Aws::WellArchitected
|
|
369
404
|
# @return [String]
|
370
405
|
#
|
371
406
|
# @!attribute [rw] helpful_resource
|
372
|
-
# The
|
407
|
+
# The helpful resource (both text and URL) for a particular choice.
|
408
|
+
#
|
409
|
+
# This field only applies to custom lenses. Each choice can have only
|
410
|
+
# one helpful resource.
|
373
411
|
# @return [Types::ChoiceContent]
|
374
412
|
#
|
375
413
|
# @!attribute [rw] improvement_plan
|
376
|
-
# The
|
414
|
+
# The improvement plan (both text and URL) for a particular choice.
|
415
|
+
#
|
416
|
+
# This field only applies to custom lenses. Each choice can have only
|
417
|
+
# one improvement plan.
|
377
418
|
# @return [Types::ChoiceContent]
|
378
419
|
#
|
379
420
|
# @!attribute [rw] additional_resources
|
380
|
-
# The additional resources for a choice
|
381
|
-
#
|
382
|
-
#
|
421
|
+
# The additional resources for a choice in a custom lens.
|
422
|
+
#
|
423
|
+
# A choice can have up to two additional resources: one of type
|
424
|
+
# `HELPFUL_RESOURCE`, one of type `IMPROVEMENT_PLAN`, or both.
|
383
425
|
# @return [Array<Types::AdditionalResources>]
|
384
426
|
#
|
385
427
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/Choice AWS API Documentation
|
@@ -481,9 +523,12 @@ module Aws::WellArchitected
|
|
481
523
|
# @return [String]
|
482
524
|
#
|
483
525
|
# @!attribute [rw] improvement_plan_url
|
484
|
-
# The improvement plan URL for a question
|
526
|
+
# The improvement plan URL for a question in an Amazon Web Services
|
527
|
+
# official lenses.
|
485
528
|
#
|
486
529
|
# This value is only available if the question has been answered.
|
530
|
+
#
|
531
|
+
# This value does not apply to custom lenses.
|
487
532
|
# @return [String]
|
488
533
|
#
|
489
534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ChoiceImprovementPlan AWS API Documentation
|
@@ -521,7 +566,7 @@ module Aws::WellArchitected
|
|
521
566
|
include Aws::Structure
|
522
567
|
end
|
523
568
|
|
524
|
-
# The resource already
|
569
|
+
# The resource has already been processed, was deleted, or is too large.
|
525
570
|
#
|
526
571
|
# @!attribute [rw] message
|
527
572
|
# Description of the error.
|
@@ -545,15 +590,73 @@ module Aws::WellArchitected
|
|
545
590
|
include Aws::Structure
|
546
591
|
end
|
547
592
|
|
593
|
+
# A metric that contributes to the consolidated report.
|
594
|
+
#
|
595
|
+
# @!attribute [rw] metric_type
|
596
|
+
# The metric type of a metric in the consolidated report. Currently
|
597
|
+
# only WORKLOAD metric types are supported.
|
598
|
+
# @return [String]
|
599
|
+
#
|
600
|
+
# @!attribute [rw] risk_counts
|
601
|
+
# A map from risk names to the count of how many questions have that
|
602
|
+
# rating.
|
603
|
+
# @return [Hash<String,Integer>]
|
604
|
+
#
|
605
|
+
# @!attribute [rw] workload_id
|
606
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
607
|
+
# Web Services Region.
|
608
|
+
# @return [String]
|
609
|
+
#
|
610
|
+
# @!attribute [rw] workload_name
|
611
|
+
# The name of the workload.
|
612
|
+
#
|
613
|
+
# The name must be unique within an account within an Amazon Web
|
614
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
615
|
+
# for uniqueness.
|
616
|
+
# @return [String]
|
617
|
+
#
|
618
|
+
# @!attribute [rw] workload_arn
|
619
|
+
# The ARN for the workload.
|
620
|
+
# @return [String]
|
621
|
+
#
|
622
|
+
# @!attribute [rw] updated_at
|
623
|
+
# The date and time recorded.
|
624
|
+
# @return [Time]
|
625
|
+
#
|
626
|
+
# @!attribute [rw] lenses
|
627
|
+
# The metrics for the lenses in the workload.
|
628
|
+
# @return [Array<Types::LensMetric>]
|
629
|
+
#
|
630
|
+
# @!attribute [rw] lenses_applied_count
|
631
|
+
# The total number of lenses applied to the workload.
|
632
|
+
# @return [Integer]
|
633
|
+
#
|
634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ConsolidatedReportMetric AWS API Documentation
|
635
|
+
#
|
636
|
+
class ConsolidatedReportMetric < Struct.new(
|
637
|
+
:metric_type,
|
638
|
+
:risk_counts,
|
639
|
+
:workload_id,
|
640
|
+
:workload_name,
|
641
|
+
:workload_arn,
|
642
|
+
:updated_at,
|
643
|
+
:lenses,
|
644
|
+
:lenses_applied_count)
|
645
|
+
SENSITIVE = []
|
646
|
+
include Aws::Structure
|
647
|
+
end
|
648
|
+
|
548
649
|
# @!attribute [rw] lens_alias
|
549
650
|
# The alias of the lens.
|
550
651
|
#
|
551
652
|
# For Amazon Web Services official lenses, this is either the lens
|
552
653
|
# alias, such as `serverless`, or the lens ARN, such as
|
553
|
-
# `arn:aws:wellarchitected:us-
|
654
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
655
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
656
|
+
# permitted on Amazon Web Services official lenses.
|
554
657
|
#
|
555
658
|
# For custom lenses, this is the lens ARN, such as
|
556
|
-
# `arn:aws:wellarchitected:us-
|
659
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
557
660
|
#
|
558
661
|
# Each lens is identified by its LensSummary$LensAlias.
|
559
662
|
# @return [String]
|
@@ -569,8 +672,8 @@ module Aws::WellArchitected
|
|
569
672
|
#
|
570
673
|
# You should not reuse the same token for other requests. If you retry
|
571
674
|
# a request with the same client request token and the same parameters
|
572
|
-
# after
|
573
|
-
# request is returned.
|
675
|
+
# after the original request has completed successfully, the result of
|
676
|
+
# the original request is returned.
|
574
677
|
#
|
575
678
|
# This token is listed as required, however, if you do not specify it,
|
576
679
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -608,10 +711,12 @@ module Aws::WellArchitected
|
|
608
711
|
#
|
609
712
|
# For Amazon Web Services official lenses, this is either the lens
|
610
713
|
# alias, such as `serverless`, or the lens ARN, such as
|
611
|
-
# `arn:aws:wellarchitected:us-
|
714
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
715
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
716
|
+
# permitted on Amazon Web Services official lenses.
|
612
717
|
#
|
613
718
|
# For custom lenses, this is the lens ARN, such as
|
614
|
-
# `arn:aws:wellarchitected:us-
|
719
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
615
720
|
#
|
616
721
|
# Each lens is identified by its LensSummary$LensAlias.
|
617
722
|
# @return [String]
|
@@ -630,8 +735,8 @@ module Aws::WellArchitected
|
|
630
735
|
#
|
631
736
|
# You should not reuse the same token for other requests. If you retry
|
632
737
|
# a request with the same client request token and the same parameters
|
633
|
-
# after
|
634
|
-
# request is returned.
|
738
|
+
# after the original request has completed successfully, the result of
|
739
|
+
# the original request is returned.
|
635
740
|
#
|
636
741
|
# This token is listed as required, however, if you do not specify it,
|
637
742
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -689,8 +794,8 @@ module Aws::WellArchitected
|
|
689
794
|
#
|
690
795
|
# You should not reuse the same token for other requests. If you retry
|
691
796
|
# a request with the same client request token and the same parameters
|
692
|
-
# after
|
693
|
-
# request is returned.
|
797
|
+
# after the original request has completed successfully, the result of
|
798
|
+
# the original request is returned.
|
694
799
|
#
|
695
800
|
# This token is listed as required, however, if you do not specify it,
|
696
801
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -861,8 +966,8 @@ module Aws::WellArchitected
|
|
861
966
|
#
|
862
967
|
# You should not reuse the same token for other requests. If you retry
|
863
968
|
# a request with the same client request token and the same parameters
|
864
|
-
# after
|
865
|
-
# request is returned.
|
969
|
+
# after the original request has completed successfully, the result of
|
970
|
+
# the original request is returned.
|
866
971
|
#
|
867
972
|
# This token is listed as required, however, if you do not specify it,
|
868
973
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -952,8 +1057,8 @@ module Aws::WellArchitected
|
|
952
1057
|
#
|
953
1058
|
# You should not reuse the same token for other requests. If you retry
|
954
1059
|
# a request with the same client request token and the same parameters
|
955
|
-
# after
|
956
|
-
# request is returned.
|
1060
|
+
# after the original request has completed successfully, the result of
|
1061
|
+
# the original request is returned.
|
957
1062
|
#
|
958
1063
|
# This token is listed as required, however, if you do not specify it,
|
959
1064
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1000,10 +1105,12 @@ module Aws::WellArchitected
|
|
1000
1105
|
#
|
1001
1106
|
# For Amazon Web Services official lenses, this is either the lens
|
1002
1107
|
# alias, such as `serverless`, or the lens ARN, such as
|
1003
|
-
# `arn:aws:wellarchitected:us-
|
1108
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1109
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
1110
|
+
# permitted on Amazon Web Services official lenses.
|
1004
1111
|
#
|
1005
1112
|
# For custom lenses, this is the lens ARN, such as
|
1006
|
-
# `arn:aws:wellarchitected:us-
|
1113
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1007
1114
|
#
|
1008
1115
|
# Each lens is identified by its LensSummary$LensAlias.
|
1009
1116
|
# @return [String]
|
@@ -1014,8 +1121,8 @@ module Aws::WellArchitected
|
|
1014
1121
|
#
|
1015
1122
|
# You should not reuse the same token for other requests. If you retry
|
1016
1123
|
# a request with the same client request token and the same parameters
|
1017
|
-
# after
|
1018
|
-
# request is returned.
|
1124
|
+
# after the original request has completed successfully, the result of
|
1125
|
+
# the original request is returned.
|
1019
1126
|
#
|
1020
1127
|
# This token is listed as required, however, if you do not specify it,
|
1021
1128
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1049,10 +1156,12 @@ module Aws::WellArchitected
|
|
1049
1156
|
#
|
1050
1157
|
# For Amazon Web Services official lenses, this is either the lens
|
1051
1158
|
# alias, such as `serverless`, or the lens ARN, such as
|
1052
|
-
# `arn:aws:wellarchitected:us-
|
1159
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1160
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
1161
|
+
# permitted on Amazon Web Services official lenses.
|
1053
1162
|
#
|
1054
1163
|
# For custom lenses, this is the lens ARN, such as
|
1055
|
-
# `arn:aws:wellarchitected:us-
|
1164
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1056
1165
|
#
|
1057
1166
|
# Each lens is identified by its LensSummary$LensAlias.
|
1058
1167
|
# @return [String]
|
@@ -1063,8 +1172,8 @@ module Aws::WellArchitected
|
|
1063
1172
|
#
|
1064
1173
|
# You should not reuse the same token for other requests. If you retry
|
1065
1174
|
# a request with the same client request token and the same parameters
|
1066
|
-
# after
|
1067
|
-
# request is returned.
|
1175
|
+
# after the original request has completed successfully, the result of
|
1176
|
+
# the original request is returned.
|
1068
1177
|
#
|
1069
1178
|
# This token is listed as required, however, if you do not specify it,
|
1070
1179
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1098,8 +1207,8 @@ module Aws::WellArchitected
|
|
1098
1207
|
#
|
1099
1208
|
# You should not reuse the same token for other requests. If you retry
|
1100
1209
|
# a request with the same client request token and the same parameters
|
1101
|
-
# after
|
1102
|
-
# request is returned.
|
1210
|
+
# after the original request has completed successfully, the result of
|
1211
|
+
# the original request is returned.
|
1103
1212
|
#
|
1104
1213
|
# This token is listed as required, however, if you do not specify it,
|
1105
1214
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1136,8 +1245,8 @@ module Aws::WellArchitected
|
|
1136
1245
|
#
|
1137
1246
|
# You should not reuse the same token for other requests. If you retry
|
1138
1247
|
# a request with the same client request token and the same parameters
|
1139
|
-
# after
|
1140
|
-
# request is returned.
|
1248
|
+
# after the original request has completed successfully, the result of
|
1249
|
+
# the original request is returned.
|
1141
1250
|
#
|
1142
1251
|
# This token is listed as required, however, if you do not specify it,
|
1143
1252
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1186,10 +1295,12 @@ module Aws::WellArchitected
|
|
1186
1295
|
#
|
1187
1296
|
# For Amazon Web Services official lenses, this is either the lens
|
1188
1297
|
# alias, such as `serverless`, or the lens ARN, such as
|
1189
|
-
# `arn:aws:wellarchitected:us-
|
1298
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1299
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
1300
|
+
# permitted on Amazon Web Services official lenses.
|
1190
1301
|
#
|
1191
1302
|
# For custom lenses, this is the lens ARN, such as
|
1192
|
-
# `arn:aws:wellarchitected:us-
|
1303
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1193
1304
|
#
|
1194
1305
|
# Each lens is identified by its LensSummary$LensAlias.
|
1195
1306
|
# @return [String]
|
@@ -1208,7 +1319,7 @@ module Aws::WellArchitected
|
|
1208
1319
|
end
|
1209
1320
|
|
1210
1321
|
# @!attribute [rw] lens_json
|
1211
|
-
# The JSON
|
1322
|
+
# The JSON representation of a lens.
|
1212
1323
|
# @return [String]
|
1213
1324
|
#
|
1214
1325
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ExportLensOutput AWS API Documentation
|
@@ -1231,10 +1342,12 @@ module Aws::WellArchitected
|
|
1231
1342
|
#
|
1232
1343
|
# For Amazon Web Services official lenses, this is either the lens
|
1233
1344
|
# alias, such as `serverless`, or the lens ARN, such as
|
1234
|
-
# `arn:aws:wellarchitected:us-
|
1345
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1346
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
1347
|
+
# permitted on Amazon Web Services official lenses.
|
1235
1348
|
#
|
1236
1349
|
# For custom lenses, this is the lens ARN, such as
|
1237
|
-
# `arn:aws:wellarchitected:us-
|
1350
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1238
1351
|
#
|
1239
1352
|
# Each lens is identified by its LensSummary$LensAlias.
|
1240
1353
|
# @return [String]
|
@@ -1278,10 +1391,12 @@ module Aws::WellArchitected
|
|
1278
1391
|
#
|
1279
1392
|
# For Amazon Web Services official lenses, this is either the lens
|
1280
1393
|
# alias, such as `serverless`, or the lens ARN, such as
|
1281
|
-
# `arn:aws:wellarchitected:us-
|
1394
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1395
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
1396
|
+
# permitted on Amazon Web Services official lenses.
|
1282
1397
|
#
|
1283
1398
|
# For custom lenses, this is the lens ARN, such as
|
1284
|
-
# `arn:aws:wellarchitected:us-
|
1399
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1285
1400
|
#
|
1286
1401
|
# Each lens is identified by its LensSummary$LensAlias.
|
1287
1402
|
# @return [String]
|
@@ -1306,15 +1421,76 @@ module Aws::WellArchitected
|
|
1306
1421
|
include Aws::Structure
|
1307
1422
|
end
|
1308
1423
|
|
1424
|
+
# @!attribute [rw] format
|
1425
|
+
# The format of the consolidated report.
|
1426
|
+
#
|
1427
|
+
# For `PDF`, `Base64String` is returned. For `JSON`, `Metrics` is
|
1428
|
+
# returned.
|
1429
|
+
# @return [String]
|
1430
|
+
#
|
1431
|
+
# @!attribute [rw] include_shared_resources
|
1432
|
+
# Set to `true` to have shared resources included in the report.
|
1433
|
+
# @return [Boolean]
|
1434
|
+
#
|
1435
|
+
# @!attribute [rw] next_token
|
1436
|
+
# The token to use to retrieve the next set of results.
|
1437
|
+
# @return [String]
|
1438
|
+
#
|
1439
|
+
# @!attribute [rw] max_results
|
1440
|
+
# The maximum number of results to return for this request.
|
1441
|
+
# @return [Integer]
|
1442
|
+
#
|
1443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetConsolidatedReportInput AWS API Documentation
|
1444
|
+
#
|
1445
|
+
class GetConsolidatedReportInput < Struct.new(
|
1446
|
+
:format,
|
1447
|
+
:include_shared_resources,
|
1448
|
+
:next_token,
|
1449
|
+
:max_results)
|
1450
|
+
SENSITIVE = []
|
1451
|
+
include Aws::Structure
|
1452
|
+
end
|
1453
|
+
|
1454
|
+
# @!attribute [rw] metrics
|
1455
|
+
# The metrics that make up the consolidated report.
|
1456
|
+
#
|
1457
|
+
# Only returned when `JSON` format is requested.
|
1458
|
+
# @return [Array<Types::ConsolidatedReportMetric>]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] next_token
|
1461
|
+
# The token to use to retrieve the next set of results.
|
1462
|
+
# @return [String]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] base_64_string
|
1465
|
+
# The Base64-encoded string representation of a lens review report.
|
1466
|
+
#
|
1467
|
+
# This data can be used to create a PDF file.
|
1468
|
+
#
|
1469
|
+
# Only returned by GetConsolidatedReport when `PDF` format is
|
1470
|
+
# requested.
|
1471
|
+
# @return [String]
|
1472
|
+
#
|
1473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetConsolidatedReportOutput AWS API Documentation
|
1474
|
+
#
|
1475
|
+
class GetConsolidatedReportOutput < Struct.new(
|
1476
|
+
:metrics,
|
1477
|
+
:next_token,
|
1478
|
+
:base_64_string)
|
1479
|
+
SENSITIVE = []
|
1480
|
+
include Aws::Structure
|
1481
|
+
end
|
1482
|
+
|
1309
1483
|
# @!attribute [rw] lens_alias
|
1310
1484
|
# The alias of the lens.
|
1311
1485
|
#
|
1312
1486
|
# For Amazon Web Services official lenses, this is either the lens
|
1313
1487
|
# alias, such as `serverless`, or the lens ARN, such as
|
1314
|
-
# `arn:aws:wellarchitected:us-
|
1488
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1489
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
1490
|
+
# permitted on Amazon Web Services official lenses.
|
1315
1491
|
#
|
1316
1492
|
# For custom lenses, this is the lens ARN, such as
|
1317
|
-
# `arn:aws:wellarchitected:us-
|
1493
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1318
1494
|
#
|
1319
1495
|
# Each lens is identified by its LensSummary$LensAlias.
|
1320
1496
|
# @return [String]
|
@@ -1356,10 +1532,12 @@ module Aws::WellArchitected
|
|
1356
1532
|
#
|
1357
1533
|
# For Amazon Web Services official lenses, this is either the lens
|
1358
1534
|
# alias, such as `serverless`, or the lens ARN, such as
|
1359
|
-
# `arn:aws:wellarchitected:us-
|
1535
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1536
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
1537
|
+
# permitted on Amazon Web Services official lenses.
|
1360
1538
|
#
|
1361
1539
|
# For custom lenses, this is the lens ARN, such as
|
1362
|
-
# `arn:aws:wellarchitected:us-
|
1540
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1363
1541
|
#
|
1364
1542
|
# Each lens is identified by its LensSummary$LensAlias.
|
1365
1543
|
# @return [String]
|
@@ -1419,10 +1597,12 @@ module Aws::WellArchitected
|
|
1419
1597
|
#
|
1420
1598
|
# For Amazon Web Services official lenses, this is either the lens
|
1421
1599
|
# alias, such as `serverless`, or the lens ARN, such as
|
1422
|
-
# `arn:aws:wellarchitected:us-
|
1600
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1601
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
1602
|
+
# permitted on Amazon Web Services official lenses.
|
1423
1603
|
#
|
1424
1604
|
# For custom lenses, this is the lens ARN, such as
|
1425
|
-
# `arn:aws:wellarchitected:us-
|
1605
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1426
1606
|
#
|
1427
1607
|
# Each lens is identified by its LensSummary$LensAlias.
|
1428
1608
|
# @return [String]
|
@@ -1475,10 +1655,12 @@ module Aws::WellArchitected
|
|
1475
1655
|
#
|
1476
1656
|
# For Amazon Web Services official lenses, this is either the lens
|
1477
1657
|
# alias, such as `serverless`, or the lens ARN, such as
|
1478
|
-
# `arn:aws:wellarchitected:us-
|
1658
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1659
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
1660
|
+
# permitted on Amazon Web Services official lenses.
|
1479
1661
|
#
|
1480
1662
|
# For custom lenses, this is the lens ARN, such as
|
1481
|
-
# `arn:aws:wellarchitected:us-
|
1663
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1482
1664
|
#
|
1483
1665
|
# Each lens is identified by its LensSummary$LensAlias.
|
1484
1666
|
# @return [String]
|
@@ -1506,10 +1688,12 @@ module Aws::WellArchitected
|
|
1506
1688
|
#
|
1507
1689
|
# For Amazon Web Services official lenses, this is either the lens
|
1508
1690
|
# alias, such as `serverless`, or the lens ARN, such as
|
1509
|
-
# `arn:aws:wellarchitected:us-
|
1691
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1692
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
1693
|
+
# permitted on Amazon Web Services official lenses.
|
1510
1694
|
#
|
1511
1695
|
# For custom lenses, this is the lens ARN, such as
|
1512
|
-
# `arn:aws:wellarchitected:us-
|
1696
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1513
1697
|
#
|
1514
1698
|
# Each lens is identified by its LensSummary$LensAlias.
|
1515
1699
|
# @return [String]
|
@@ -1623,10 +1807,12 @@ module Aws::WellArchitected
|
|
1623
1807
|
#
|
1624
1808
|
# For Amazon Web Services official lenses, this is either the lens
|
1625
1809
|
# alias, such as `serverless`, or the lens ARN, such as
|
1626
|
-
# `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
|
1812
|
+
# permitted on Amazon Web Services official lenses.
|
1627
1813
|
#
|
1628
1814
|
# For custom lenses, this is the lens ARN, such as
|
1629
|
-
# `arn:aws:wellarchitected:us-
|
1815
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1630
1816
|
#
|
1631
1817
|
# Each lens is identified by its LensSummary$LensAlias.
|
1632
1818
|
# @return [String]
|
@@ -1641,8 +1827,8 @@ module Aws::WellArchitected
|
|
1641
1827
|
#
|
1642
1828
|
# You should not reuse the same token for other requests. If you retry
|
1643
1829
|
# a request with the same client request token and the same parameters
|
1644
|
-
# after
|
1645
|
-
# request is returned.
|
1830
|
+
# after the original request has completed successfully, the result of
|
1831
|
+
# the original request is returned.
|
1646
1832
|
#
|
1647
1833
|
# This token is listed as required, however, if you do not specify it,
|
1648
1834
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1669,7 +1855,7 @@ module Aws::WellArchitected
|
|
1669
1855
|
end
|
1670
1856
|
|
1671
1857
|
# @!attribute [rw] lens_arn
|
1672
|
-
# The ARN for the lens.
|
1858
|
+
# The ARN for the lens that was created or updated.
|
1673
1859
|
# @return [String]
|
1674
1860
|
#
|
1675
1861
|
# @!attribute [rw] status
|
@@ -1706,9 +1892,12 @@ module Aws::WellArchitected
|
|
1706
1892
|
# @return [String]
|
1707
1893
|
#
|
1708
1894
|
# @!attribute [rw] improvement_plan_url
|
1709
|
-
# The improvement plan URL for a question
|
1895
|
+
# The improvement plan URL for a question in an Amazon Web Services
|
1896
|
+
# official lenses.
|
1710
1897
|
#
|
1711
1898
|
# This value is only available if the question has been answered.
|
1899
|
+
#
|
1900
|
+
# This value does not apply to custom lenses.
|
1712
1901
|
# @return [String]
|
1713
1902
|
#
|
1714
1903
|
# @!attribute [rw] improvement_plans
|
@@ -1786,6 +1975,31 @@ module Aws::WellArchitected
|
|
1786
1975
|
include Aws::Structure
|
1787
1976
|
end
|
1788
1977
|
|
1978
|
+
# A metric for a particular lens in a workload.
|
1979
|
+
#
|
1980
|
+
# @!attribute [rw] lens_arn
|
1981
|
+
# The lens ARN.
|
1982
|
+
# @return [String]
|
1983
|
+
#
|
1984
|
+
# @!attribute [rw] pillars
|
1985
|
+
# The metrics for the pillars in a lens.
|
1986
|
+
# @return [Array<Types::PillarMetric>]
|
1987
|
+
#
|
1988
|
+
# @!attribute [rw] risk_counts
|
1989
|
+
# A map from risk names to the count of how many questions have that
|
1990
|
+
# rating.
|
1991
|
+
# @return [Hash<String,Integer>]
|
1992
|
+
#
|
1993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensMetric AWS API Documentation
|
1994
|
+
#
|
1995
|
+
class LensMetric < Struct.new(
|
1996
|
+
:lens_arn,
|
1997
|
+
:pillars,
|
1998
|
+
:risk_counts)
|
1999
|
+
SENSITIVE = []
|
2000
|
+
include Aws::Structure
|
2001
|
+
end
|
2002
|
+
|
1789
2003
|
# A lens review of a question.
|
1790
2004
|
#
|
1791
2005
|
# @!attribute [rw] lens_alias
|
@@ -1793,10 +2007,12 @@ module Aws::WellArchitected
|
|
1793
2007
|
#
|
1794
2008
|
# For Amazon Web Services official lenses, this is either the lens
|
1795
2009
|
# alias, such as `serverless`, or the lens ARN, such as
|
1796
|
-
# `arn:aws:wellarchitected:us-
|
2010
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2011
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2012
|
+
# permitted on Amazon Web Services official lenses.
|
1797
2013
|
#
|
1798
2014
|
# For custom lenses, this is the lens ARN, such as
|
1799
|
-
# `arn:aws:wellarchitected:us-
|
2015
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1800
2016
|
#
|
1801
2017
|
# Each lens is identified by its LensSummary$LensAlias.
|
1802
2018
|
# @return [String]
|
@@ -1830,7 +2046,7 @@ module Aws::WellArchitected
|
|
1830
2046
|
# @return [String]
|
1831
2047
|
#
|
1832
2048
|
# @!attribute [rw] risk_counts
|
1833
|
-
# A map from risk names to the count of how questions have that
|
2049
|
+
# A map from risk names to the count of how many questions have that
|
1834
2050
|
# rating.
|
1835
2051
|
# @return [Hash<String,Integer>]
|
1836
2052
|
#
|
@@ -1862,10 +2078,12 @@ module Aws::WellArchitected
|
|
1862
2078
|
#
|
1863
2079
|
# For Amazon Web Services official lenses, this is either the lens
|
1864
2080
|
# alias, such as `serverless`, or the lens ARN, such as
|
1865
|
-
# `arn:aws:wellarchitected:us-
|
2081
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2082
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2083
|
+
# permitted on Amazon Web Services official lenses.
|
1866
2084
|
#
|
1867
2085
|
# For custom lenses, this is the lens ARN, such as
|
1868
|
-
# `arn:aws:wellarchitected:us-
|
2086
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1869
2087
|
#
|
1870
2088
|
# Each lens is identified by its LensSummary$LensAlias.
|
1871
2089
|
# @return [String]
|
@@ -1878,6 +2096,9 @@ module Aws::WellArchitected
|
|
1878
2096
|
# The Base64-encoded string representation of a lens review report.
|
1879
2097
|
#
|
1880
2098
|
# This data can be used to create a PDF file.
|
2099
|
+
#
|
2100
|
+
# Only returned by GetConsolidatedReport when `PDF` format is
|
2101
|
+
# requested.
|
1881
2102
|
# @return [String]
|
1882
2103
|
#
|
1883
2104
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensReviewReport AWS API Documentation
|
@@ -1897,10 +2118,12 @@ module Aws::WellArchitected
|
|
1897
2118
|
#
|
1898
2119
|
# For Amazon Web Services official lenses, this is either the lens
|
1899
2120
|
# alias, such as `serverless`, or the lens ARN, such as
|
1900
|
-
# `arn:aws:wellarchitected:us-
|
2121
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2122
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2123
|
+
# permitted on Amazon Web Services official lenses.
|
1901
2124
|
#
|
1902
2125
|
# For custom lenses, this is the lens ARN, such as
|
1903
|
-
# `arn:aws:wellarchitected:us-
|
2126
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1904
2127
|
#
|
1905
2128
|
# Each lens is identified by its LensSummary$LensAlias.
|
1906
2129
|
# @return [String]
|
@@ -1926,7 +2149,7 @@ module Aws::WellArchitected
|
|
1926
2149
|
# @return [Time]
|
1927
2150
|
#
|
1928
2151
|
# @!attribute [rw] risk_counts
|
1929
|
-
# A map from risk names to the count of how questions have that
|
2152
|
+
# A map from risk names to the count of how many questions have that
|
1930
2153
|
# rating.
|
1931
2154
|
# @return [Hash<String,Integer>]
|
1932
2155
|
#
|
@@ -1985,10 +2208,12 @@ module Aws::WellArchitected
|
|
1985
2208
|
#
|
1986
2209
|
# For Amazon Web Services official lenses, this is either the lens
|
1987
2210
|
# alias, such as `serverless`, or the lens ARN, such as
|
1988
|
-
# `arn:aws:wellarchitected:us-
|
2211
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2212
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2213
|
+
# permitted on Amazon Web Services official lenses.
|
1989
2214
|
#
|
1990
2215
|
# For custom lenses, this is the lens ARN, such as
|
1991
|
-
# `arn:aws:wellarchitected:us-
|
2216
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1992
2217
|
#
|
1993
2218
|
# Each lens is identified by its LensSummary$LensAlias.
|
1994
2219
|
# @return [String]
|
@@ -2062,10 +2287,12 @@ module Aws::WellArchitected
|
|
2062
2287
|
#
|
2063
2288
|
# For Amazon Web Services official lenses, this is either the lens
|
2064
2289
|
# alias, such as `serverless`, or the lens ARN, such as
|
2065
|
-
# `arn:aws:wellarchitected:us-
|
2290
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2291
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2292
|
+
# permitted on Amazon Web Services official lenses.
|
2066
2293
|
#
|
2067
2294
|
# For custom lenses, this is the lens ARN, such as
|
2068
|
-
# `arn:aws:wellarchitected:us-
|
2295
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2069
2296
|
#
|
2070
2297
|
# Each lens is identified by its LensSummary$LensAlias.
|
2071
2298
|
# @return [String]
|
@@ -2107,10 +2334,12 @@ module Aws::WellArchitected
|
|
2107
2334
|
#
|
2108
2335
|
# For Amazon Web Services official lenses, this is either the lens
|
2109
2336
|
# alias, such as `serverless`, or the lens ARN, such as
|
2110
|
-
# `arn:aws:wellarchitected:us-
|
2337
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2338
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2339
|
+
# permitted on Amazon Web Services official lenses.
|
2111
2340
|
#
|
2112
2341
|
# For custom lenses, this is the lens ARN, such as
|
2113
|
-
# `arn:aws:wellarchitected:us-
|
2342
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2114
2343
|
#
|
2115
2344
|
# Each lens is identified by its LensSummary$LensAlias.
|
2116
2345
|
# @return [String]
|
@@ -2166,10 +2395,12 @@ module Aws::WellArchitected
|
|
2166
2395
|
#
|
2167
2396
|
# For Amazon Web Services official lenses, this is either the lens
|
2168
2397
|
# alias, such as `serverless`, or the lens ARN, such as
|
2169
|
-
# `arn:aws:wellarchitected:us-
|
2398
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2399
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2400
|
+
# permitted on Amazon Web Services official lenses.
|
2170
2401
|
#
|
2171
2402
|
# For custom lenses, this is the lens ARN, such as
|
2172
|
-
# `arn:aws:wellarchitected:us-
|
2403
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2173
2404
|
#
|
2174
2405
|
# Each lens is identified by its LensSummary$LensAlias.
|
2175
2406
|
# @return [String]
|
@@ -2337,10 +2568,12 @@ module Aws::WellArchitected
|
|
2337
2568
|
#
|
2338
2569
|
# For Amazon Web Services official lenses, this is either the lens
|
2339
2570
|
# alias, such as `serverless`, or the lens ARN, such as
|
2340
|
-
# `arn:aws:wellarchitected:us-
|
2571
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2572
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2573
|
+
# permitted on Amazon Web Services official lenses.
|
2341
2574
|
#
|
2342
2575
|
# For custom lenses, this is the lens ARN, such as
|
2343
|
-
# `arn:aws:wellarchitected:us-
|
2576
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2344
2577
|
#
|
2345
2578
|
# Each lens is identified by its LensSummary$LensAlias.
|
2346
2579
|
# @return [String]
|
@@ -2396,10 +2629,12 @@ module Aws::WellArchitected
|
|
2396
2629
|
#
|
2397
2630
|
# For Amazon Web Services official lenses, this is either the lens
|
2398
2631
|
# alias, such as `serverless`, or the lens ARN, such as
|
2399
|
-
# `arn:aws:wellarchitected:us-
|
2632
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2633
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2634
|
+
# permitted on Amazon Web Services official lenses.
|
2400
2635
|
#
|
2401
2636
|
# For custom lenses, this is the lens ARN, such as
|
2402
|
-
# `arn:aws:wellarchitected:us-
|
2637
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2403
2638
|
#
|
2404
2639
|
# Each lens is identified by its LensSummary$LensAlias.
|
2405
2640
|
# @return [String]
|
@@ -2498,10 +2733,12 @@ module Aws::WellArchitected
|
|
2498
2733
|
#
|
2499
2734
|
# For Amazon Web Services official lenses, this is either the lens
|
2500
2735
|
# alias, such as `serverless`, or the lens ARN, such as
|
2501
|
-
# `arn:aws:wellarchitected:us-
|
2736
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2737
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2738
|
+
# permitted on Amazon Web Services official lenses.
|
2502
2739
|
#
|
2503
2740
|
# For custom lenses, this is the lens ARN, such as
|
2504
|
-
# `arn:aws:wellarchitected:us-
|
2741
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2505
2742
|
#
|
2506
2743
|
# Each lens is identified by its LensSummary$LensAlias.
|
2507
2744
|
# @return [String]
|
@@ -2995,6 +3232,33 @@ module Aws::WellArchitected
|
|
2995
3232
|
include Aws::Structure
|
2996
3233
|
end
|
2997
3234
|
|
3235
|
+
# A metric for a particular pillar in a lens.
|
3236
|
+
#
|
3237
|
+
# @!attribute [rw] pillar_id
|
3238
|
+
# The ID used to identify a pillar, for example, `security`.
|
3239
|
+
#
|
3240
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
3241
|
+
# @return [String]
|
3242
|
+
#
|
3243
|
+
# @!attribute [rw] risk_counts
|
3244
|
+
# A map from risk names to the count of how many questions have that
|
3245
|
+
# rating.
|
3246
|
+
# @return [Hash<String,Integer>]
|
3247
|
+
#
|
3248
|
+
# @!attribute [rw] questions
|
3249
|
+
# The questions that have been identified as risks in the pillar.
|
3250
|
+
# @return [Array<Types::QuestionMetric>]
|
3251
|
+
#
|
3252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/PillarMetric AWS API Documentation
|
3253
|
+
#
|
3254
|
+
class PillarMetric < Struct.new(
|
3255
|
+
:pillar_id,
|
3256
|
+
:risk_counts,
|
3257
|
+
:questions)
|
3258
|
+
SENSITIVE = []
|
3259
|
+
include Aws::Structure
|
3260
|
+
end
|
3261
|
+
|
2998
3262
|
# A pillar review summary of a lens review.
|
2999
3263
|
#
|
3000
3264
|
# @!attribute [rw] pillar_id
|
@@ -3012,7 +3276,7 @@ module Aws::WellArchitected
|
|
3012
3276
|
# @return [String]
|
3013
3277
|
#
|
3014
3278
|
# @!attribute [rw] risk_counts
|
3015
|
-
# A map from risk names to the count of how questions have that
|
3279
|
+
# A map from risk names to the count of how many questions have that
|
3016
3280
|
# rating.
|
3017
3281
|
# @return [Hash<String,Integer>]
|
3018
3282
|
#
|
@@ -3051,6 +3315,31 @@ module Aws::WellArchitected
|
|
3051
3315
|
include Aws::Structure
|
3052
3316
|
end
|
3053
3317
|
|
3318
|
+
# A metric for a particular question in the pillar.
|
3319
|
+
#
|
3320
|
+
# @!attribute [rw] question_id
|
3321
|
+
# The ID of the question.
|
3322
|
+
# @return [String]
|
3323
|
+
#
|
3324
|
+
# @!attribute [rw] risk
|
3325
|
+
# The risk for a given workload, lens review, pillar, or question.
|
3326
|
+
# @return [String]
|
3327
|
+
#
|
3328
|
+
# @!attribute [rw] best_practices
|
3329
|
+
# The best practices, or choices, that have been identified as
|
3330
|
+
# contributing to risk in a question.
|
3331
|
+
# @return [Array<Types::BestPractice>]
|
3332
|
+
#
|
3333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/QuestionMetric AWS API Documentation
|
3334
|
+
#
|
3335
|
+
class QuestionMetric < Struct.new(
|
3336
|
+
:question_id,
|
3337
|
+
:risk,
|
3338
|
+
:best_practices)
|
3339
|
+
SENSITIVE = []
|
3340
|
+
include Aws::Structure
|
3341
|
+
end
|
3342
|
+
|
3054
3343
|
# The requested resource was not found.
|
3055
3344
|
#
|
3056
3345
|
# @!attribute [rw] message
|
@@ -3129,10 +3418,12 @@ module Aws::WellArchitected
|
|
3129
3418
|
#
|
3130
3419
|
# For Amazon Web Services official lenses, this is either the lens
|
3131
3420
|
# alias, such as `serverless`, or the lens ARN, such as
|
3132
|
-
# `arn:aws:wellarchitected:us-
|
3421
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
3422
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
3423
|
+
# permitted on Amazon Web Services official lenses.
|
3133
3424
|
#
|
3134
3425
|
# For custom lenses, this is the lens ARN, such as
|
3135
|
-
# `arn:aws:wellarchitected:us-
|
3426
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
3136
3427
|
#
|
3137
3428
|
# Each lens is identified by its LensSummary$LensAlias.
|
3138
3429
|
# @return [String]
|
@@ -3292,10 +3583,12 @@ module Aws::WellArchitected
|
|
3292
3583
|
#
|
3293
3584
|
# For Amazon Web Services official lenses, this is either the lens
|
3294
3585
|
# alias, such as `serverless`, or the lens ARN, such as
|
3295
|
-
# `arn:aws:wellarchitected:us-
|
3586
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
3587
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
3588
|
+
# permitted on Amazon Web Services official lenses.
|
3296
3589
|
#
|
3297
3590
|
# For custom lenses, this is the lens ARN, such as
|
3298
|
-
# `arn:aws:wellarchitected:us-
|
3591
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
3299
3592
|
#
|
3300
3593
|
# Each lens is identified by its LensSummary$LensAlias.
|
3301
3594
|
# @return [String]
|
@@ -3354,10 +3647,12 @@ module Aws::WellArchitected
|
|
3354
3647
|
#
|
3355
3648
|
# For Amazon Web Services official lenses, this is either the lens
|
3356
3649
|
# alias, such as `serverless`, or the lens ARN, such as
|
3357
|
-
# `arn:aws:wellarchitected:us-
|
3650
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
3651
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
3652
|
+
# permitted on Amazon Web Services official lenses.
|
3358
3653
|
#
|
3359
3654
|
# For custom lenses, this is the lens ARN, such as
|
3360
|
-
# `arn:aws:wellarchitected:us-
|
3655
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
3361
3656
|
#
|
3362
3657
|
# Each lens is identified by its LensSummary$LensAlias.
|
3363
3658
|
# @return [String]
|
@@ -3385,10 +3680,15 @@ module Aws::WellArchitected
|
|
3385
3680
|
# The status of organization sharing settings.
|
3386
3681
|
# @return [String]
|
3387
3682
|
#
|
3683
|
+
# @!attribute [rw] discovery_integration_status
|
3684
|
+
# The status of discovery support settings.
|
3685
|
+
# @return [String]
|
3686
|
+
#
|
3388
3687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateGlobalSettingsInput AWS API Documentation
|
3389
3688
|
#
|
3390
3689
|
class UpdateGlobalSettingsInput < Struct.new(
|
3391
|
-
:organization_sharing_status
|
3690
|
+
:organization_sharing_status,
|
3691
|
+
:discovery_integration_status)
|
3392
3692
|
SENSITIVE = []
|
3393
3693
|
include Aws::Structure
|
3394
3694
|
end
|
@@ -3405,10 +3705,12 @@ module Aws::WellArchitected
|
|
3405
3705
|
#
|
3406
3706
|
# For Amazon Web Services official lenses, this is either the lens
|
3407
3707
|
# alias, such as `serverless`, or the lens ARN, such as
|
3408
|
-
# `arn:aws:wellarchitected:us-
|
3708
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
3709
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
3710
|
+
# permitted on Amazon Web Services official lenses.
|
3409
3711
|
#
|
3410
3712
|
# For custom lenses, this is the lens ARN, such as
|
3411
|
-
# `arn:aws:wellarchitected:us-
|
3713
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
3412
3714
|
#
|
3413
3715
|
# Each lens is identified by its LensSummary$LensAlias.
|
3414
3716
|
# @return [String]
|
@@ -3720,10 +4022,12 @@ module Aws::WellArchitected
|
|
3720
4022
|
#
|
3721
4023
|
# For Amazon Web Services official lenses, this is either the lens
|
3722
4024
|
# alias, such as `serverless`, or the lens ARN, such as
|
3723
|
-
# `arn:aws:wellarchitected:us-
|
4025
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
4026
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
4027
|
+
# permitted on Amazon Web Services official lenses.
|
3724
4028
|
#
|
3725
4029
|
# For custom lenses, this is the lens ARN, such as
|
3726
|
-
# `arn:aws:wellarchitected:us-
|
4030
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
3727
4031
|
#
|
3728
4032
|
# Each lens is identified by its LensSummary$LensAlias.
|
3729
4033
|
# @return [String]
|
@@ -3740,8 +4044,8 @@ module Aws::WellArchitected
|
|
3740
4044
|
#
|
3741
4045
|
# You should not reuse the same token for other requests. If you retry
|
3742
4046
|
# a request with the same client request token and the same parameters
|
3743
|
-
# after
|
3744
|
-
# request is returned.
|
4047
|
+
# after the original request has completed successfully, the result of
|
4048
|
+
# the original request is returned.
|
3745
4049
|
#
|
3746
4050
|
# This token is listed as required, however, if you do not specify it,
|
3747
4051
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -3960,7 +4264,7 @@ module Aws::WellArchitected
|
|
3960
4264
|
# @return [String]
|
3961
4265
|
#
|
3962
4266
|
# @!attribute [rw] risk_counts
|
3963
|
-
# A map from risk names to the count of how questions have that
|
4267
|
+
# A map from risk names to the count of how many questions have that
|
3964
4268
|
# rating.
|
3965
4269
|
# @return [Hash<String,Integer>]
|
3966
4270
|
#
|
@@ -4034,10 +4338,18 @@ module Aws::WellArchitected
|
|
4034
4338
|
# workload.
|
4035
4339
|
# @return [String]
|
4036
4340
|
#
|
4341
|
+
# @!attribute [rw] workload_resource_definition
|
4342
|
+
# The mode to use for identifying resources associated with the
|
4343
|
+
# workload.
|
4344
|
+
#
|
4345
|
+
# You can specify `WORKLOAD_METADATA`, `APP_REGISTRY`, or both.
|
4346
|
+
# @return [Array<String>]
|
4347
|
+
#
|
4037
4348
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/WorkloadDiscoveryConfig AWS API Documentation
|
4038
4349
|
#
|
4039
4350
|
class WorkloadDiscoveryConfig < Struct.new(
|
4040
|
-
:trusted_advisor_integration_status
|
4351
|
+
:trusted_advisor_integration_status,
|
4352
|
+
:workload_resource_definition)
|
4041
4353
|
SENSITIVE = []
|
4042
4354
|
include Aws::Structure
|
4043
4355
|
end
|
@@ -4160,7 +4472,7 @@ module Aws::WellArchitected
|
|
4160
4472
|
# @return [Array<String>]
|
4161
4473
|
#
|
4162
4474
|
# @!attribute [rw] risk_counts
|
4163
|
-
# A map from risk names to the count of how questions have that
|
4475
|
+
# A map from risk names to the count of how many questions have that
|
4164
4476
|
# rating.
|
4165
4477
|
# @return [Hash<String,Integer>]
|
4166
4478
|
#
|