aws-sdk-wellarchitected 1.29.0 → 1.30.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 +1077 -95
- data/lib/aws-sdk-wellarchitected/client_api.rb +485 -0
- data/lib/aws-sdk-wellarchitected/endpoints.rb +196 -0
- data/lib/aws-sdk-wellarchitected/plugins/endpoints.rb +28 -0
- data/lib/aws-sdk-wellarchitected/types.rb +1379 -121
- data/lib/aws-sdk-wellarchitected.rb +1 -1
- metadata +2 -2
@@ -117,6 +117,9 @@ module Aws::WellArchitected
|
|
117
117
|
#
|
118
118
|
# @!attribute [rw] notes
|
119
119
|
# The notes associated with the workload.
|
120
|
+
#
|
121
|
+
# For a review template, these are the notes that will be associated
|
122
|
+
# with the workload when the template is applied.
|
120
123
|
# @return [String]
|
121
124
|
#
|
122
125
|
# @!attribute [rw] reason
|
@@ -685,9 +688,9 @@ module Aws::WellArchitected
|
|
685
688
|
# @return [String]
|
686
689
|
#
|
687
690
|
# @!attribute [rw] shared_with
|
688
|
-
# The Amazon Web Services account ID,
|
689
|
-
# organizational unit (OU) ID with which the workload, lens,
|
690
|
-
#
|
691
|
+
# The Amazon Web Services account ID, organization ID, or
|
692
|
+
# organizational unit (OU) ID with which the workload, lens, profile,
|
693
|
+
# or review template is shared.
|
691
694
|
# @return [String]
|
692
695
|
#
|
693
696
|
# @!attribute [rw] client_request_token
|
@@ -930,9 +933,9 @@ module Aws::WellArchitected
|
|
930
933
|
# @return [String]
|
931
934
|
#
|
932
935
|
# @!attribute [rw] shared_with
|
933
|
-
# The Amazon Web Services account ID,
|
934
|
-
# organizational unit (OU) ID with which the workload, lens,
|
935
|
-
#
|
936
|
+
# The Amazon Web Services account ID, organization ID, or
|
937
|
+
# organizational unit (OU) ID with which the workload, lens, profile,
|
938
|
+
# or review template is shared.
|
936
939
|
# @return [String]
|
937
940
|
#
|
938
941
|
# @!attribute [rw] client_request_token
|
@@ -980,6 +983,127 @@ module Aws::WellArchitected
|
|
980
983
|
include Aws::Structure
|
981
984
|
end
|
982
985
|
|
986
|
+
# @!attribute [rw] template_name
|
987
|
+
# Name of the review template.
|
988
|
+
# @return [String]
|
989
|
+
#
|
990
|
+
# @!attribute [rw] description
|
991
|
+
# The review template description.
|
992
|
+
# @return [String]
|
993
|
+
#
|
994
|
+
# @!attribute [rw] lenses
|
995
|
+
# Lenses applied to the review template.
|
996
|
+
# @return [Array<String>]
|
997
|
+
#
|
998
|
+
# @!attribute [rw] notes
|
999
|
+
# The notes associated with the workload.
|
1000
|
+
#
|
1001
|
+
# For a review template, these are the notes that will be associated
|
1002
|
+
# with the workload when the template is applied.
|
1003
|
+
# @return [String]
|
1004
|
+
#
|
1005
|
+
# @!attribute [rw] tags
|
1006
|
+
# The tags assigned to the review template.
|
1007
|
+
# @return [Hash<String,String>]
|
1008
|
+
#
|
1009
|
+
# @!attribute [rw] client_request_token
|
1010
|
+
# A unique case-sensitive string used to ensure that this request is
|
1011
|
+
# idempotent (executes only once).
|
1012
|
+
#
|
1013
|
+
# You should not reuse the same token for other requests. If you retry
|
1014
|
+
# a request with the same client request token and the same parameters
|
1015
|
+
# after the original request has completed successfully, the result of
|
1016
|
+
# the original request is returned.
|
1017
|
+
#
|
1018
|
+
# This token is listed as required, however, if you do not specify it,
|
1019
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1020
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1021
|
+
# provide this token or the request will fail.
|
1022
|
+
#
|
1023
|
+
# **A suitable default value is auto-generated.** You should normally
|
1024
|
+
# not need to pass this option.
|
1025
|
+
# @return [String]
|
1026
|
+
#
|
1027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateReviewTemplateInput AWS API Documentation
|
1028
|
+
#
|
1029
|
+
class CreateReviewTemplateInput < Struct.new(
|
1030
|
+
:template_name,
|
1031
|
+
:description,
|
1032
|
+
:lenses,
|
1033
|
+
:notes,
|
1034
|
+
:tags,
|
1035
|
+
:client_request_token)
|
1036
|
+
SENSITIVE = []
|
1037
|
+
include Aws::Structure
|
1038
|
+
end
|
1039
|
+
|
1040
|
+
# @!attribute [rw] template_arn
|
1041
|
+
# The review template ARN.
|
1042
|
+
# @return [String]
|
1043
|
+
#
|
1044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateReviewTemplateOutput AWS API Documentation
|
1045
|
+
#
|
1046
|
+
class CreateReviewTemplateOutput < Struct.new(
|
1047
|
+
:template_arn)
|
1048
|
+
SENSITIVE = []
|
1049
|
+
include Aws::Structure
|
1050
|
+
end
|
1051
|
+
|
1052
|
+
# @!attribute [rw] template_arn
|
1053
|
+
# The review template ARN.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1056
|
+
# @!attribute [rw] shared_with
|
1057
|
+
# The Amazon Web Services account ID, organization ID, or
|
1058
|
+
# organizational unit (OU) ID with which the workload, lens, profile,
|
1059
|
+
# or review template is shared.
|
1060
|
+
# @return [String]
|
1061
|
+
#
|
1062
|
+
# @!attribute [rw] client_request_token
|
1063
|
+
# A unique case-sensitive string used to ensure that this request is
|
1064
|
+
# idempotent (executes only once).
|
1065
|
+
#
|
1066
|
+
# You should not reuse the same token for other requests. If you retry
|
1067
|
+
# a request with the same client request token and the same parameters
|
1068
|
+
# after the original request has completed successfully, the result of
|
1069
|
+
# the original request is returned.
|
1070
|
+
#
|
1071
|
+
# This token is listed as required, however, if you do not specify it,
|
1072
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1073
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1074
|
+
# provide this token or the request will fail.
|
1075
|
+
#
|
1076
|
+
# **A suitable default value is auto-generated.** You should normally
|
1077
|
+
# not need to pass this option.
|
1078
|
+
# @return [String]
|
1079
|
+
#
|
1080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateTemplateShareInput AWS API Documentation
|
1081
|
+
#
|
1082
|
+
class CreateTemplateShareInput < Struct.new(
|
1083
|
+
:template_arn,
|
1084
|
+
:shared_with,
|
1085
|
+
:client_request_token)
|
1086
|
+
SENSITIVE = []
|
1087
|
+
include Aws::Structure
|
1088
|
+
end
|
1089
|
+
|
1090
|
+
# @!attribute [rw] template_arn
|
1091
|
+
# The review template ARN.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] share_id
|
1095
|
+
# The ID associated with the share.
|
1096
|
+
# @return [String]
|
1097
|
+
#
|
1098
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateTemplateShareOutput AWS API Documentation
|
1099
|
+
#
|
1100
|
+
class CreateTemplateShareOutput < Struct.new(
|
1101
|
+
:template_arn,
|
1102
|
+
:share_id)
|
1103
|
+
SENSITIVE = []
|
1104
|
+
include Aws::Structure
|
1105
|
+
end
|
1106
|
+
|
983
1107
|
# Input for workload creation.
|
984
1108
|
#
|
985
1109
|
# @!attribute [rw] workload_name
|
@@ -1096,10 +1220,17 @@ module Aws::WellArchitected
|
|
1096
1220
|
# @!attribute [rw] lenses
|
1097
1221
|
# The list of lenses associated with the workload. Each lens is
|
1098
1222
|
# identified by its LensSummary$LensAlias.
|
1223
|
+
#
|
1224
|
+
# If a review template that specifies lenses is applied to the
|
1225
|
+
# workload, those lenses are applied to the workload in addition to
|
1226
|
+
# these lenses.
|
1099
1227
|
# @return [Array<String>]
|
1100
1228
|
#
|
1101
1229
|
# @!attribute [rw] notes
|
1102
1230
|
# The notes associated with the workload.
|
1231
|
+
#
|
1232
|
+
# For a review template, these are the notes that will be associated
|
1233
|
+
# with the workload when the template is applied.
|
1103
1234
|
# @return [String]
|
1104
1235
|
#
|
1105
1236
|
# @!attribute [rw] client_request_token
|
@@ -1137,6 +1268,10 @@ module Aws::WellArchitected
|
|
1137
1268
|
# The list of profile ARNs associated with the workload.
|
1138
1269
|
# @return [Array<String>]
|
1139
1270
|
#
|
1271
|
+
# @!attribute [rw] review_template_arns
|
1272
|
+
# The list of review template ARNs to associate with the workload.
|
1273
|
+
# @return [Array<String>]
|
1274
|
+
#
|
1140
1275
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadInput AWS API Documentation
|
1141
1276
|
#
|
1142
1277
|
class CreateWorkloadInput < Struct.new(
|
@@ -1157,7 +1292,8 @@ module Aws::WellArchitected
|
|
1157
1292
|
:tags,
|
1158
1293
|
:discovery_config,
|
1159
1294
|
:applications,
|
1160
|
-
:profile_arns
|
1295
|
+
:profile_arns,
|
1296
|
+
:review_template_arns)
|
1161
1297
|
SENSITIVE = []
|
1162
1298
|
include Aws::Structure
|
1163
1299
|
end
|
@@ -1190,9 +1326,9 @@ module Aws::WellArchitected
|
|
1190
1326
|
# @return [String]
|
1191
1327
|
#
|
1192
1328
|
# @!attribute [rw] shared_with
|
1193
|
-
# The Amazon Web Services account ID,
|
1194
|
-
# organizational unit (OU) ID with which the workload, lens,
|
1195
|
-
#
|
1329
|
+
# The Amazon Web Services account ID, organization ID, or
|
1330
|
+
# organizational unit (OU) ID with which the workload, lens, profile,
|
1331
|
+
# or review template is shared.
|
1196
1332
|
# @return [String]
|
1197
1333
|
#
|
1198
1334
|
# @!attribute [rw] permission_type
|
@@ -1409,6 +1545,73 @@ module Aws::WellArchitected
|
|
1409
1545
|
include Aws::Structure
|
1410
1546
|
end
|
1411
1547
|
|
1548
|
+
# @!attribute [rw] template_arn
|
1549
|
+
# The review template ARN.
|
1550
|
+
# @return [String]
|
1551
|
+
#
|
1552
|
+
# @!attribute [rw] client_request_token
|
1553
|
+
# A unique case-sensitive string used to ensure that this request is
|
1554
|
+
# idempotent (executes only once).
|
1555
|
+
#
|
1556
|
+
# You should not reuse the same token for other requests. If you retry
|
1557
|
+
# a request with the same client request token and the same parameters
|
1558
|
+
# after the original request has completed successfully, the result of
|
1559
|
+
# the original request is returned.
|
1560
|
+
#
|
1561
|
+
# This token is listed as required, however, if you do not specify it,
|
1562
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1563
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1564
|
+
# provide this token or the request will fail.
|
1565
|
+
#
|
1566
|
+
# **A suitable default value is auto-generated.** You should normally
|
1567
|
+
# not need to pass this option.
|
1568
|
+
# @return [String]
|
1569
|
+
#
|
1570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteReviewTemplateInput AWS API Documentation
|
1571
|
+
#
|
1572
|
+
class DeleteReviewTemplateInput < Struct.new(
|
1573
|
+
:template_arn,
|
1574
|
+
:client_request_token)
|
1575
|
+
SENSITIVE = []
|
1576
|
+
include Aws::Structure
|
1577
|
+
end
|
1578
|
+
|
1579
|
+
# @!attribute [rw] share_id
|
1580
|
+
# The ID associated with the share.
|
1581
|
+
# @return [String]
|
1582
|
+
#
|
1583
|
+
# @!attribute [rw] template_arn
|
1584
|
+
# The review template ARN.
|
1585
|
+
# @return [String]
|
1586
|
+
#
|
1587
|
+
# @!attribute [rw] client_request_token
|
1588
|
+
# A unique case-sensitive string used to ensure that this request is
|
1589
|
+
# idempotent (executes only once).
|
1590
|
+
#
|
1591
|
+
# You should not reuse the same token for other requests. If you retry
|
1592
|
+
# a request with the same client request token and the same parameters
|
1593
|
+
# after the original request has completed successfully, the result of
|
1594
|
+
# the original request is returned.
|
1595
|
+
#
|
1596
|
+
# This token is listed as required, however, if you do not specify it,
|
1597
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1598
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1599
|
+
# provide this token or the request will fail.
|
1600
|
+
#
|
1601
|
+
# **A suitable default value is auto-generated.** You should normally
|
1602
|
+
# not need to pass this option.
|
1603
|
+
# @return [String]
|
1604
|
+
#
|
1605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteTemplateShareInput AWS API Documentation
|
1606
|
+
#
|
1607
|
+
class DeleteTemplateShareInput < Struct.new(
|
1608
|
+
:share_id,
|
1609
|
+
:template_arn,
|
1610
|
+
:client_request_token)
|
1611
|
+
SENSITIVE = []
|
1612
|
+
include Aws::Structure
|
1613
|
+
end
|
1614
|
+
|
1412
1615
|
# Input for workload deletion.
|
1413
1616
|
#
|
1414
1617
|
# @!attribute [rw] workload_id
|
@@ -2053,35 +2256,43 @@ module Aws::WellArchitected
|
|
2053
2256
|
include Aws::Structure
|
2054
2257
|
end
|
2055
2258
|
|
2056
|
-
#
|
2057
|
-
#
|
2058
|
-
# @!attribute [rw] workload_id
|
2059
|
-
# The ID assigned to the workload. This ID is unique within an Amazon
|
2060
|
-
# Web Services Region.
|
2259
|
+
# @!attribute [rw] template_arn
|
2260
|
+
# The review template ARN.
|
2061
2261
|
# @return [String]
|
2062
2262
|
#
|
2063
|
-
#
|
2263
|
+
# @!attribute [rw] lens_alias
|
2264
|
+
# The alias of the lens.
|
2064
2265
|
#
|
2065
|
-
|
2066
|
-
|
2067
|
-
|
2068
|
-
|
2069
|
-
|
2070
|
-
|
2071
|
-
# Output of a get workload call.
|
2266
|
+
# For Amazon Web Services official lenses, this is either the lens
|
2267
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
2268
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2269
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2270
|
+
# permitted on Amazon Web Services official lenses.
|
2072
2271
|
#
|
2073
|
-
#
|
2074
|
-
#
|
2075
|
-
# @return [Types::Workload]
|
2272
|
+
# For custom lenses, this is the lens ARN, such as
|
2273
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2076
2274
|
#
|
2077
|
-
#
|
2275
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2276
|
+
# @return [String]
|
2078
2277
|
#
|
2079
|
-
|
2080
|
-
|
2278
|
+
# @!attribute [rw] question_id
|
2279
|
+
# The ID of the question.
|
2280
|
+
# @return [String]
|
2281
|
+
#
|
2282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetReviewTemplateAnswerInput AWS API Documentation
|
2283
|
+
#
|
2284
|
+
class GetReviewTemplateAnswerInput < Struct.new(
|
2285
|
+
:template_arn,
|
2286
|
+
:lens_alias,
|
2287
|
+
:question_id)
|
2081
2288
|
SENSITIVE = []
|
2082
2289
|
include Aws::Structure
|
2083
2290
|
end
|
2084
2291
|
|
2292
|
+
# @!attribute [rw] template_arn
|
2293
|
+
# The review template ARN.
|
2294
|
+
# @return [String]
|
2295
|
+
#
|
2085
2296
|
# @!attribute [rw] lens_alias
|
2086
2297
|
# The alias of the lens.
|
2087
2298
|
#
|
@@ -2097,63 +2308,190 @@ module Aws::WellArchitected
|
|
2097
2308
|
# Each lens is identified by its LensSummary$LensAlias.
|
2098
2309
|
# @return [String]
|
2099
2310
|
#
|
2100
|
-
# @!attribute [rw]
|
2101
|
-
#
|
2102
|
-
# @return [
|
2103
|
-
#
|
2104
|
-
# @!attribute [rw] client_request_token
|
2105
|
-
# A unique case-sensitive string used to ensure that this request is
|
2106
|
-
# idempotent (executes only once).
|
2107
|
-
#
|
2108
|
-
# You should not reuse the same token for other requests. If you retry
|
2109
|
-
# a request with the same client request token and the same parameters
|
2110
|
-
# after the original request has completed successfully, the result of
|
2111
|
-
# the original request is returned.
|
2311
|
+
# @!attribute [rw] answer
|
2312
|
+
# An answer of the question.
|
2313
|
+
# @return [Types::ReviewTemplateAnswer]
|
2112
2314
|
#
|
2113
|
-
#
|
2114
|
-
# the Amazon Web Services SDKs automatically generate one for you. If
|
2115
|
-
# you are not using the Amazon Web Services SDK or the CLI, you must
|
2116
|
-
# provide this token or the request will fail.
|
2315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetReviewTemplateAnswerOutput AWS API Documentation
|
2117
2316
|
#
|
2118
|
-
|
2119
|
-
|
2317
|
+
class GetReviewTemplateAnswerOutput < Struct.new(
|
2318
|
+
:template_arn,
|
2319
|
+
:lens_alias,
|
2320
|
+
:answer)
|
2321
|
+
SENSITIVE = []
|
2322
|
+
include Aws::Structure
|
2323
|
+
end
|
2324
|
+
|
2325
|
+
# @!attribute [rw] template_arn
|
2326
|
+
# The review template ARN.
|
2120
2327
|
# @return [String]
|
2121
2328
|
#
|
2122
|
-
#
|
2123
|
-
# Tags to associate to a lens.
|
2124
|
-
# @return [Hash<String,String>]
|
2125
|
-
#
|
2126
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImportLensInput AWS API Documentation
|
2329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetReviewTemplateInput AWS API Documentation
|
2127
2330
|
#
|
2128
|
-
class
|
2129
|
-
:
|
2130
|
-
:json_string,
|
2131
|
-
:client_request_token,
|
2132
|
-
:tags)
|
2331
|
+
class GetReviewTemplateInput < Struct.new(
|
2332
|
+
:template_arn)
|
2133
2333
|
SENSITIVE = []
|
2134
2334
|
include Aws::Structure
|
2135
2335
|
end
|
2136
2336
|
|
2137
|
-
# @!attribute [rw]
|
2138
|
-
# The
|
2337
|
+
# @!attribute [rw] template_arn
|
2338
|
+
# The review template ARN.
|
2139
2339
|
# @return [String]
|
2140
2340
|
#
|
2141
|
-
# @!attribute [rw]
|
2142
|
-
# The
|
2341
|
+
# @!attribute [rw] lens_alias
|
2342
|
+
# The alias of the lens.
|
2343
|
+
#
|
2344
|
+
# For Amazon Web Services official lenses, this is either the lens
|
2345
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
2346
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2347
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2348
|
+
# permitted on Amazon Web Services official lenses.
|
2349
|
+
#
|
2350
|
+
# For custom lenses, this is the lens ARN, such as
|
2351
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2352
|
+
#
|
2353
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2143
2354
|
# @return [String]
|
2144
2355
|
#
|
2145
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/
|
2356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetReviewTemplateLensReviewInput AWS API Documentation
|
2146
2357
|
#
|
2147
|
-
class
|
2148
|
-
:
|
2149
|
-
:
|
2358
|
+
class GetReviewTemplateLensReviewInput < Struct.new(
|
2359
|
+
:template_arn,
|
2360
|
+
:lens_alias)
|
2150
2361
|
SENSITIVE = []
|
2151
2362
|
include Aws::Structure
|
2152
2363
|
end
|
2153
2364
|
|
2154
|
-
#
|
2365
|
+
# @!attribute [rw] template_arn
|
2366
|
+
# The review template ARN.
|
2367
|
+
# @return [String]
|
2155
2368
|
#
|
2156
|
-
# @!attribute [rw]
|
2369
|
+
# @!attribute [rw] lens_review
|
2370
|
+
# A lens review of a question.
|
2371
|
+
# @return [Types::ReviewTemplateLensReview]
|
2372
|
+
#
|
2373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetReviewTemplateLensReviewOutput AWS API Documentation
|
2374
|
+
#
|
2375
|
+
class GetReviewTemplateLensReviewOutput < Struct.new(
|
2376
|
+
:template_arn,
|
2377
|
+
:lens_review)
|
2378
|
+
SENSITIVE = []
|
2379
|
+
include Aws::Structure
|
2380
|
+
end
|
2381
|
+
|
2382
|
+
# @!attribute [rw] review_template
|
2383
|
+
# The review template.
|
2384
|
+
# @return [Types::ReviewTemplate]
|
2385
|
+
#
|
2386
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetReviewTemplateOutput AWS API Documentation
|
2387
|
+
#
|
2388
|
+
class GetReviewTemplateOutput < Struct.new(
|
2389
|
+
:review_template)
|
2390
|
+
SENSITIVE = []
|
2391
|
+
include Aws::Structure
|
2392
|
+
end
|
2393
|
+
|
2394
|
+
# Input to get a workload.
|
2395
|
+
#
|
2396
|
+
# @!attribute [rw] workload_id
|
2397
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2398
|
+
# Web Services Region.
|
2399
|
+
# @return [String]
|
2400
|
+
#
|
2401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkloadInput AWS API Documentation
|
2402
|
+
#
|
2403
|
+
class GetWorkloadInput < Struct.new(
|
2404
|
+
:workload_id)
|
2405
|
+
SENSITIVE = []
|
2406
|
+
include Aws::Structure
|
2407
|
+
end
|
2408
|
+
|
2409
|
+
# Output of a get workload call.
|
2410
|
+
#
|
2411
|
+
# @!attribute [rw] workload
|
2412
|
+
# A workload return object.
|
2413
|
+
# @return [Types::Workload]
|
2414
|
+
#
|
2415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkloadOutput AWS API Documentation
|
2416
|
+
#
|
2417
|
+
class GetWorkloadOutput < Struct.new(
|
2418
|
+
:workload)
|
2419
|
+
SENSITIVE = []
|
2420
|
+
include Aws::Structure
|
2421
|
+
end
|
2422
|
+
|
2423
|
+
# @!attribute [rw] lens_alias
|
2424
|
+
# The alias of the lens.
|
2425
|
+
#
|
2426
|
+
# For Amazon Web Services official lenses, this is either the lens
|
2427
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
2428
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2429
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
2430
|
+
# permitted on Amazon Web Services official lenses.
|
2431
|
+
#
|
2432
|
+
# For custom lenses, this is the lens ARN, such as
|
2433
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2434
|
+
#
|
2435
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2436
|
+
# @return [String]
|
2437
|
+
#
|
2438
|
+
# @!attribute [rw] json_string
|
2439
|
+
# The JSON representation of a lens.
|
2440
|
+
# @return [String]
|
2441
|
+
#
|
2442
|
+
# @!attribute [rw] client_request_token
|
2443
|
+
# A unique case-sensitive string used to ensure that this request is
|
2444
|
+
# idempotent (executes only once).
|
2445
|
+
#
|
2446
|
+
# You should not reuse the same token for other requests. If you retry
|
2447
|
+
# a request with the same client request token and the same parameters
|
2448
|
+
# after the original request has completed successfully, the result of
|
2449
|
+
# the original request is returned.
|
2450
|
+
#
|
2451
|
+
# This token is listed as required, however, if you do not specify it,
|
2452
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
2453
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
2454
|
+
# provide this token or the request will fail.
|
2455
|
+
#
|
2456
|
+
# **A suitable default value is auto-generated.** You should normally
|
2457
|
+
# not need to pass this option.
|
2458
|
+
# @return [String]
|
2459
|
+
#
|
2460
|
+
# @!attribute [rw] tags
|
2461
|
+
# Tags to associate to a lens.
|
2462
|
+
# @return [Hash<String,String>]
|
2463
|
+
#
|
2464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImportLensInput AWS API Documentation
|
2465
|
+
#
|
2466
|
+
class ImportLensInput < Struct.new(
|
2467
|
+
:lens_alias,
|
2468
|
+
:json_string,
|
2469
|
+
:client_request_token,
|
2470
|
+
:tags)
|
2471
|
+
SENSITIVE = []
|
2472
|
+
include Aws::Structure
|
2473
|
+
end
|
2474
|
+
|
2475
|
+
# @!attribute [rw] lens_arn
|
2476
|
+
# The ARN for the lens that was created or updated.
|
2477
|
+
# @return [String]
|
2478
|
+
#
|
2479
|
+
# @!attribute [rw] status
|
2480
|
+
# The status of the imported lens.
|
2481
|
+
# @return [String]
|
2482
|
+
#
|
2483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImportLensOutput AWS API Documentation
|
2484
|
+
#
|
2485
|
+
class ImportLensOutput < Struct.new(
|
2486
|
+
:lens_arn,
|
2487
|
+
:status)
|
2488
|
+
SENSITIVE = []
|
2489
|
+
include Aws::Structure
|
2490
|
+
end
|
2491
|
+
|
2492
|
+
# An improvement summary of a lens review in a workload.
|
2493
|
+
#
|
2494
|
+
# @!attribute [rw] question_id
|
2157
2495
|
# The ID of the question.
|
2158
2496
|
# @return [String]
|
2159
2497
|
#
|
@@ -2323,6 +2661,9 @@ module Aws::WellArchitected
|
|
2323
2661
|
#
|
2324
2662
|
# @!attribute [rw] notes
|
2325
2663
|
# The notes associated with the workload.
|
2664
|
+
#
|
2665
|
+
# For a review template, these are the notes that will be associated
|
2666
|
+
# with the workload when the template is applied.
|
2326
2667
|
# @return [String]
|
2327
2668
|
#
|
2328
2669
|
# @!attribute [rw] risk_counts
|
@@ -2476,9 +2817,9 @@ module Aws::WellArchitected
|
|
2476
2817
|
# @return [String]
|
2477
2818
|
#
|
2478
2819
|
# @!attribute [rw] shared_with
|
2479
|
-
# The Amazon Web Services account ID,
|
2480
|
-
# organizational unit (OU) ID with which the workload, lens,
|
2481
|
-
#
|
2820
|
+
# The Amazon Web Services account ID, organization ID, or
|
2821
|
+
# organizational unit (OU) ID with which the workload, lens, profile,
|
2822
|
+
# or review template is shared.
|
2482
2823
|
# @return [String]
|
2483
2824
|
#
|
2484
2825
|
# @!attribute [rw] status
|
@@ -2612,6 +2953,18 @@ module Aws::WellArchitected
|
|
2612
2953
|
# The latest version of the lens.
|
2613
2954
|
# @return [String]
|
2614
2955
|
#
|
2956
|
+
# @!attribute [rw] resource_arn
|
2957
|
+
# `ResourceArn` of the lens being upgraded
|
2958
|
+
# @return [String]
|
2959
|
+
#
|
2960
|
+
# @!attribute [rw] resource_name
|
2961
|
+
# The name of the workload.
|
2962
|
+
#
|
2963
|
+
# The name must be unique within an account within an Amazon Web
|
2964
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
2965
|
+
# for uniqueness.
|
2966
|
+
# @return [String]
|
2967
|
+
#
|
2615
2968
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensUpgradeSummary AWS API Documentation
|
2616
2969
|
#
|
2617
2970
|
class LensUpgradeSummary < Struct.new(
|
@@ -2620,7 +2973,9 @@ module Aws::WellArchitected
|
|
2620
2973
|
:lens_alias,
|
2621
2974
|
:lens_arn,
|
2622
2975
|
:current_lens_version,
|
2623
|
-
:latest_lens_version
|
2976
|
+
:latest_lens_version,
|
2977
|
+
:resource_arn,
|
2978
|
+
:resource_name)
|
2624
2979
|
SENSITIVE = []
|
2625
2980
|
include Aws::Structure
|
2626
2981
|
end
|
@@ -3057,7 +3412,7 @@ module Aws::WellArchitected
|
|
3057
3412
|
# @return [String]
|
3058
3413
|
#
|
3059
3414
|
# @!attribute [rw] shared_with_prefix
|
3060
|
-
# The Amazon Web Services account ID,
|
3415
|
+
# The Amazon Web Services account ID, organization ID, or
|
3061
3416
|
# organizational unit (OU) ID with which the lens is shared.
|
3062
3417
|
# @return [String]
|
3063
3418
|
#
|
@@ -3218,12 +3573,21 @@ module Aws::WellArchitected
|
|
3218
3573
|
# The maximum number of results to return for this request.
|
3219
3574
|
# @return [Integer]
|
3220
3575
|
#
|
3576
|
+
# @!attribute [rw] resource_arn
|
3577
|
+
# The ARN for the related resource for the notification.
|
3578
|
+
#
|
3579
|
+
# <note markdown="1"> Only one of `WorkloadID` or `ResourceARN` should be specified.
|
3580
|
+
#
|
3581
|
+
# </note>
|
3582
|
+
# @return [String]
|
3583
|
+
#
|
3221
3584
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListNotificationsInput AWS API Documentation
|
3222
3585
|
#
|
3223
3586
|
class ListNotificationsInput < Struct.new(
|
3224
3587
|
:workload_id,
|
3225
3588
|
:next_token,
|
3226
|
-
:max_results
|
3589
|
+
:max_results,
|
3590
|
+
:resource_arn)
|
3227
3591
|
SENSITIVE = []
|
3228
3592
|
include Aws::Structure
|
3229
3593
|
end
|
@@ -3290,7 +3654,7 @@ module Aws::WellArchitected
|
|
3290
3654
|
# @return [String]
|
3291
3655
|
#
|
3292
3656
|
# @!attribute [rw] shared_with_prefix
|
3293
|
-
# The Amazon Web Services account ID,
|
3657
|
+
# The Amazon Web Services account ID, organization ID, or
|
3294
3658
|
# organizational unit (OU) ID with which the profile is shared.
|
3295
3659
|
# @return [String]
|
3296
3660
|
#
|
@@ -3336,7 +3700,8 @@ module Aws::WellArchitected
|
|
3336
3700
|
end
|
3337
3701
|
|
3338
3702
|
# @!attribute [rw] profile_name_prefix
|
3339
|
-
#
|
3703
|
+
# An optional string added to the beginning of each profile name
|
3704
|
+
# returned in the results.
|
3340
3705
|
# @return [String]
|
3341
3706
|
#
|
3342
3707
|
# @!attribute [rw] profile_owner_type
|
@@ -3379,6 +3744,123 @@ module Aws::WellArchitected
|
|
3379
3744
|
include Aws::Structure
|
3380
3745
|
end
|
3381
3746
|
|
3747
|
+
# @!attribute [rw] template_arn
|
3748
|
+
# The ARN of the review template.
|
3749
|
+
# @return [String]
|
3750
|
+
#
|
3751
|
+
# @!attribute [rw] lens_alias
|
3752
|
+
# The alias of the lens.
|
3753
|
+
#
|
3754
|
+
# For Amazon Web Services official lenses, this is either the lens
|
3755
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
3756
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
3757
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
3758
|
+
# permitted on Amazon Web Services official lenses.
|
3759
|
+
#
|
3760
|
+
# For custom lenses, this is the lens ARN, such as
|
3761
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
3762
|
+
#
|
3763
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
3764
|
+
# @return [String]
|
3765
|
+
#
|
3766
|
+
# @!attribute [rw] pillar_id
|
3767
|
+
# The ID used to identify a pillar, for example, `security`.
|
3768
|
+
#
|
3769
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
3770
|
+
# @return [String]
|
3771
|
+
#
|
3772
|
+
# @!attribute [rw] next_token
|
3773
|
+
# The token to use to retrieve the next set of results.
|
3774
|
+
# @return [String]
|
3775
|
+
#
|
3776
|
+
# @!attribute [rw] max_results
|
3777
|
+
# The maximum number of results to return for this request.
|
3778
|
+
# @return [Integer]
|
3779
|
+
#
|
3780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListReviewTemplateAnswersInput AWS API Documentation
|
3781
|
+
#
|
3782
|
+
class ListReviewTemplateAnswersInput < Struct.new(
|
3783
|
+
:template_arn,
|
3784
|
+
:lens_alias,
|
3785
|
+
:pillar_id,
|
3786
|
+
:next_token,
|
3787
|
+
:max_results)
|
3788
|
+
SENSITIVE = []
|
3789
|
+
include Aws::Structure
|
3790
|
+
end
|
3791
|
+
|
3792
|
+
# @!attribute [rw] template_arn
|
3793
|
+
# The ARN of the review template.
|
3794
|
+
# @return [String]
|
3795
|
+
#
|
3796
|
+
# @!attribute [rw] lens_alias
|
3797
|
+
# The alias of the lens.
|
3798
|
+
#
|
3799
|
+
# For Amazon Web Services official lenses, this is either the lens
|
3800
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
3801
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
3802
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
3803
|
+
# permitted on Amazon Web Services official lenses.
|
3804
|
+
#
|
3805
|
+
# For custom lenses, this is the lens ARN, such as
|
3806
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
3807
|
+
#
|
3808
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
3809
|
+
# @return [String]
|
3810
|
+
#
|
3811
|
+
# @!attribute [rw] answer_summaries
|
3812
|
+
# List of answer summaries of a lens review in a review template.
|
3813
|
+
# @return [Array<Types::ReviewTemplateAnswerSummary>]
|
3814
|
+
#
|
3815
|
+
# @!attribute [rw] next_token
|
3816
|
+
# The token to use to retrieve the next set of results.
|
3817
|
+
# @return [String]
|
3818
|
+
#
|
3819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListReviewTemplateAnswersOutput AWS API Documentation
|
3820
|
+
#
|
3821
|
+
class ListReviewTemplateAnswersOutput < Struct.new(
|
3822
|
+
:template_arn,
|
3823
|
+
:lens_alias,
|
3824
|
+
:answer_summaries,
|
3825
|
+
:next_token)
|
3826
|
+
SENSITIVE = []
|
3827
|
+
include Aws::Structure
|
3828
|
+
end
|
3829
|
+
|
3830
|
+
# @!attribute [rw] next_token
|
3831
|
+
# The token to use to retrieve the next set of results.
|
3832
|
+
# @return [String]
|
3833
|
+
#
|
3834
|
+
# @!attribute [rw] max_results
|
3835
|
+
# The maximum number of results to return for this request.
|
3836
|
+
# @return [Integer]
|
3837
|
+
#
|
3838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListReviewTemplatesInput AWS API Documentation
|
3839
|
+
#
|
3840
|
+
class ListReviewTemplatesInput < Struct.new(
|
3841
|
+
:next_token,
|
3842
|
+
:max_results)
|
3843
|
+
SENSITIVE = []
|
3844
|
+
include Aws::Structure
|
3845
|
+
end
|
3846
|
+
|
3847
|
+
# @!attribute [rw] review_templates
|
3848
|
+
# List of review templates.
|
3849
|
+
# @return [Array<Types::ReviewTemplateSummary>]
|
3850
|
+
#
|
3851
|
+
# @!attribute [rw] next_token
|
3852
|
+
# The token to use to retrieve the next set of results.
|
3853
|
+
# @return [String]
|
3854
|
+
#
|
3855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListReviewTemplatesOutput AWS API Documentation
|
3856
|
+
#
|
3857
|
+
class ListReviewTemplatesOutput < Struct.new(
|
3858
|
+
:review_templates,
|
3859
|
+
:next_token)
|
3860
|
+
SENSITIVE = []
|
3861
|
+
include Aws::Structure
|
3862
|
+
end
|
3863
|
+
|
3382
3864
|
# Input for List Share Invitations
|
3383
3865
|
#
|
3384
3866
|
# @!attribute [rw] workload_name_prefix
|
@@ -3404,7 +3886,13 @@ module Aws::WellArchitected
|
|
3404
3886
|
# @return [Integer]
|
3405
3887
|
#
|
3406
3888
|
# @!attribute [rw] profile_name_prefix
|
3407
|
-
#
|
3889
|
+
# An optional string added to the beginning of each profile name
|
3890
|
+
# returned in the results.
|
3891
|
+
# @return [String]
|
3892
|
+
#
|
3893
|
+
# @!attribute [rw] template_name_prefix
|
3894
|
+
# An optional string added to the beginning of each review template
|
3895
|
+
# name returned in the results.
|
3408
3896
|
# @return [String]
|
3409
3897
|
#
|
3410
3898
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitationsInput AWS API Documentation
|
@@ -3415,7 +3903,8 @@ module Aws::WellArchitected
|
|
3415
3903
|
:share_resource_type,
|
3416
3904
|
:next_token,
|
3417
3905
|
:max_results,
|
3418
|
-
:profile_name_prefix
|
3906
|
+
:profile_name_prefix,
|
3907
|
+
:template_name_prefix)
|
3419
3908
|
SENSITIVE = []
|
3420
3909
|
include Aws::Structure
|
3421
3910
|
end
|
@@ -3463,16 +3952,13 @@ module Aws::WellArchitected
|
|
3463
3952
|
include Aws::Structure
|
3464
3953
|
end
|
3465
3954
|
|
3466
|
-
#
|
3467
|
-
#
|
3468
|
-
# @!attribute [rw] workload_id
|
3469
|
-
# The ID assigned to the workload. This ID is unique within an Amazon
|
3470
|
-
# Web Services Region.
|
3955
|
+
# @!attribute [rw] template_arn
|
3956
|
+
# The review template ARN.
|
3471
3957
|
# @return [String]
|
3472
3958
|
#
|
3473
3959
|
# @!attribute [rw] shared_with_prefix
|
3474
|
-
# The Amazon Web Services account ID,
|
3475
|
-
# organizational unit (OU) ID with which the
|
3960
|
+
# The Amazon Web Services account ID, organization ID, or
|
3961
|
+
# organizational unit (OU) ID with which the profile is shared.
|
3476
3962
|
# @return [String]
|
3477
3963
|
#
|
3478
3964
|
# @!attribute [rw] next_token
|
@@ -3487,10 +3973,10 @@ module Aws::WellArchitected
|
|
3487
3973
|
# The status of the share request.
|
3488
3974
|
# @return [String]
|
3489
3975
|
#
|
3490
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/
|
3976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListTemplateSharesInput AWS API Documentation
|
3491
3977
|
#
|
3492
|
-
class
|
3493
|
-
:
|
3978
|
+
class ListTemplateSharesInput < Struct.new(
|
3979
|
+
:template_arn,
|
3494
3980
|
:shared_with_prefix,
|
3495
3981
|
:next_token,
|
3496
3982
|
:max_results,
|
@@ -3499,25 +3985,83 @@ module Aws::WellArchitected
|
|
3499
3985
|
include Aws::Structure
|
3500
3986
|
end
|
3501
3987
|
|
3502
|
-
#
|
3503
|
-
#
|
3504
|
-
# @!attribute [rw] workload_id
|
3505
|
-
# The ID assigned to the workload. This ID is unique within an Amazon
|
3506
|
-
# Web Services Region.
|
3988
|
+
# @!attribute [rw] template_arn
|
3989
|
+
# The review template ARN.
|
3507
3990
|
# @return [String]
|
3508
3991
|
#
|
3509
|
-
# @!attribute [rw]
|
3510
|
-
# A
|
3511
|
-
# @return [Array<Types::
|
3992
|
+
# @!attribute [rw] template_share_summaries
|
3993
|
+
# A review template share summary return object.
|
3994
|
+
# @return [Array<Types::TemplateShareSummary>]
|
3512
3995
|
#
|
3513
3996
|
# @!attribute [rw] next_token
|
3514
3997
|
# The token to use to retrieve the next set of results.
|
3515
3998
|
# @return [String]
|
3516
3999
|
#
|
3517
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/
|
4000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListTemplateSharesOutput AWS API Documentation
|
3518
4001
|
#
|
3519
|
-
class
|
3520
|
-
:
|
4002
|
+
class ListTemplateSharesOutput < Struct.new(
|
4003
|
+
:template_arn,
|
4004
|
+
:template_share_summaries,
|
4005
|
+
:next_token)
|
4006
|
+
SENSITIVE = []
|
4007
|
+
include Aws::Structure
|
4008
|
+
end
|
4009
|
+
|
4010
|
+
# Input for List Workload Share
|
4011
|
+
#
|
4012
|
+
# @!attribute [rw] workload_id
|
4013
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
4014
|
+
# Web Services Region.
|
4015
|
+
# @return [String]
|
4016
|
+
#
|
4017
|
+
# @!attribute [rw] shared_with_prefix
|
4018
|
+
# The Amazon Web Services account ID, organization ID, or
|
4019
|
+
# organizational unit (OU) ID with which the workload is shared.
|
4020
|
+
# @return [String]
|
4021
|
+
#
|
4022
|
+
# @!attribute [rw] next_token
|
4023
|
+
# The token to use to retrieve the next set of results.
|
4024
|
+
# @return [String]
|
4025
|
+
#
|
4026
|
+
# @!attribute [rw] max_results
|
4027
|
+
# The maximum number of results to return for this request.
|
4028
|
+
# @return [Integer]
|
4029
|
+
#
|
4030
|
+
# @!attribute [rw] status
|
4031
|
+
# The status of the share request.
|
4032
|
+
# @return [String]
|
4033
|
+
#
|
4034
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadSharesInput AWS API Documentation
|
4035
|
+
#
|
4036
|
+
class ListWorkloadSharesInput < Struct.new(
|
4037
|
+
:workload_id,
|
4038
|
+
:shared_with_prefix,
|
4039
|
+
:next_token,
|
4040
|
+
:max_results,
|
4041
|
+
:status)
|
4042
|
+
SENSITIVE = []
|
4043
|
+
include Aws::Structure
|
4044
|
+
end
|
4045
|
+
|
4046
|
+
# Input for List Workload Share
|
4047
|
+
#
|
4048
|
+
# @!attribute [rw] workload_id
|
4049
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
4050
|
+
# Web Services Region.
|
4051
|
+
# @return [String]
|
4052
|
+
#
|
4053
|
+
# @!attribute [rw] workload_share_summaries
|
4054
|
+
# A list of workload share summaries.
|
4055
|
+
# @return [Array<Types::WorkloadShareSummary>]
|
4056
|
+
#
|
4057
|
+
# @!attribute [rw] next_token
|
4058
|
+
# The token to use to retrieve the next set of results.
|
4059
|
+
# @return [String]
|
4060
|
+
#
|
4061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadSharesOutput AWS API Documentation
|
4062
|
+
#
|
4063
|
+
class ListWorkloadSharesOutput < Struct.new(
|
4064
|
+
:workload_id,
|
3521
4065
|
:workload_share_summaries,
|
3522
4066
|
:next_token)
|
3523
4067
|
SENSITIVE = []
|
@@ -3725,6 +4269,9 @@ module Aws::WellArchitected
|
|
3725
4269
|
#
|
3726
4270
|
# @!attribute [rw] notes
|
3727
4271
|
# The notes associated with the workload.
|
4272
|
+
#
|
4273
|
+
# For a review template, these are the notes that will be associated
|
4274
|
+
# with the workload when the template is applied.
|
3728
4275
|
# @return [String]
|
3729
4276
|
#
|
3730
4277
|
# @!attribute [rw] risk_counts
|
@@ -3951,9 +4498,9 @@ module Aws::WellArchitected
|
|
3951
4498
|
# @return [String]
|
3952
4499
|
#
|
3953
4500
|
# @!attribute [rw] shared_with
|
3954
|
-
# The Amazon Web Services account ID,
|
3955
|
-
# organizational unit (OU) ID with which the workload, lens,
|
3956
|
-
#
|
4501
|
+
# The Amazon Web Services account ID, organization ID, or
|
4502
|
+
# organizational unit (OU) ID with which the workload, lens, profile,
|
4503
|
+
# or review template is shared.
|
3957
4504
|
# @return [String]
|
3958
4505
|
#
|
3959
4506
|
# @!attribute [rw] status
|
@@ -4166,20 +4713,408 @@ module Aws::WellArchitected
|
|
4166
4713
|
# Description of the error.
|
4167
4714
|
# @return [String]
|
4168
4715
|
#
|
4169
|
-
# @!attribute [rw] resource_id
|
4170
|
-
# Identifier of the resource affected.
|
4716
|
+
# @!attribute [rw] resource_id
|
4717
|
+
# Identifier of the resource affected.
|
4718
|
+
# @return [String]
|
4719
|
+
#
|
4720
|
+
# @!attribute [rw] resource_type
|
4721
|
+
# Type of the resource affected.
|
4722
|
+
# @return [String]
|
4723
|
+
#
|
4724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ResourceNotFoundException AWS API Documentation
|
4725
|
+
#
|
4726
|
+
class ResourceNotFoundException < Struct.new(
|
4727
|
+
:message,
|
4728
|
+
:resource_id,
|
4729
|
+
:resource_type)
|
4730
|
+
SENSITIVE = []
|
4731
|
+
include Aws::Structure
|
4732
|
+
end
|
4733
|
+
|
4734
|
+
# A review template.
|
4735
|
+
#
|
4736
|
+
# @!attribute [rw] description
|
4737
|
+
# The review template description.
|
4738
|
+
# @return [String]
|
4739
|
+
#
|
4740
|
+
# @!attribute [rw] lenses
|
4741
|
+
# The lenses applied to the review template.
|
4742
|
+
# @return [Array<String>]
|
4743
|
+
#
|
4744
|
+
# @!attribute [rw] notes
|
4745
|
+
# The notes associated with the workload.
|
4746
|
+
#
|
4747
|
+
# For a review template, these are the notes that will be associated
|
4748
|
+
# with the workload when the template is applied.
|
4749
|
+
# @return [String]
|
4750
|
+
#
|
4751
|
+
# @!attribute [rw] question_counts
|
4752
|
+
# A count of how many total questions are answered and unanswered in
|
4753
|
+
# the review template.
|
4754
|
+
# @return [Hash<String,Integer>]
|
4755
|
+
#
|
4756
|
+
# @!attribute [rw] owner
|
4757
|
+
# An Amazon Web Services account ID.
|
4758
|
+
# @return [String]
|
4759
|
+
#
|
4760
|
+
# @!attribute [rw] updated_at
|
4761
|
+
# The date and time recorded.
|
4762
|
+
# @return [Time]
|
4763
|
+
#
|
4764
|
+
# @!attribute [rw] template_arn
|
4765
|
+
# The review template ARN.
|
4766
|
+
# @return [String]
|
4767
|
+
#
|
4768
|
+
# @!attribute [rw] template_name
|
4769
|
+
# The name of the review template.
|
4770
|
+
# @return [String]
|
4771
|
+
#
|
4772
|
+
# @!attribute [rw] tags
|
4773
|
+
# The tags assigned to the review template.
|
4774
|
+
# @return [Hash<String,String>]
|
4775
|
+
#
|
4776
|
+
# @!attribute [rw] update_status
|
4777
|
+
# The latest status of a review template.
|
4778
|
+
# @return [String]
|
4779
|
+
#
|
4780
|
+
# @!attribute [rw] share_invitation_id
|
4781
|
+
# The ID assigned to the template share invitation.
|
4782
|
+
# @return [String]
|
4783
|
+
#
|
4784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ReviewTemplate AWS API Documentation
|
4785
|
+
#
|
4786
|
+
class ReviewTemplate < Struct.new(
|
4787
|
+
:description,
|
4788
|
+
:lenses,
|
4789
|
+
:notes,
|
4790
|
+
:question_counts,
|
4791
|
+
:owner,
|
4792
|
+
:updated_at,
|
4793
|
+
:template_arn,
|
4794
|
+
:template_name,
|
4795
|
+
:tags,
|
4796
|
+
:update_status,
|
4797
|
+
:share_invitation_id)
|
4798
|
+
SENSITIVE = []
|
4799
|
+
include Aws::Structure
|
4800
|
+
end
|
4801
|
+
|
4802
|
+
# An answer of the question.
|
4803
|
+
#
|
4804
|
+
# @!attribute [rw] question_id
|
4805
|
+
# The ID of the question.
|
4806
|
+
# @return [String]
|
4807
|
+
#
|
4808
|
+
# @!attribute [rw] pillar_id
|
4809
|
+
# The ID used to identify a pillar, for example, `security`.
|
4810
|
+
#
|
4811
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
4812
|
+
# @return [String]
|
4813
|
+
#
|
4814
|
+
# @!attribute [rw] question_title
|
4815
|
+
# The title of the question.
|
4816
|
+
# @return [String]
|
4817
|
+
#
|
4818
|
+
# @!attribute [rw] question_description
|
4819
|
+
# The description of the question.
|
4820
|
+
# @return [String]
|
4821
|
+
#
|
4822
|
+
# @!attribute [rw] improvement_plan_url
|
4823
|
+
# The improvement plan URL for a question in an Amazon Web Services
|
4824
|
+
# official lenses.
|
4825
|
+
#
|
4826
|
+
# This value is only available if the question has been answered.
|
4827
|
+
#
|
4828
|
+
# This value does not apply to custom lenses.
|
4829
|
+
# @return [String]
|
4830
|
+
#
|
4831
|
+
# @!attribute [rw] helpful_resource_url
|
4832
|
+
# The helpful resource URL.
|
4833
|
+
#
|
4834
|
+
# For Amazon Web Services official lenses, this is the helpful
|
4835
|
+
# resource URL for a question or choice.
|
4836
|
+
#
|
4837
|
+
# For custom lenses, this is the helpful resource URL for a question
|
4838
|
+
# and is only provided if `HelpfulResourceDisplayText` was specified
|
4839
|
+
# for the question.
|
4840
|
+
# @return [String]
|
4841
|
+
#
|
4842
|
+
# @!attribute [rw] helpful_resource_display_text
|
4843
|
+
# The helpful resource text to be displayed for a custom lens.
|
4844
|
+
#
|
4845
|
+
# <note markdown="1"> This field does not apply to Amazon Web Services official lenses.
|
4846
|
+
#
|
4847
|
+
# </note>
|
4848
|
+
# @return [String]
|
4849
|
+
#
|
4850
|
+
# @!attribute [rw] choices
|
4851
|
+
# List of choices available for a question.
|
4852
|
+
# @return [Array<Types::Choice>]
|
4853
|
+
#
|
4854
|
+
# @!attribute [rw] selected_choices
|
4855
|
+
# List of selected choice IDs in a question answer.
|
4856
|
+
#
|
4857
|
+
# The values entered replace the previously selected choices.
|
4858
|
+
# @return [Array<String>]
|
4859
|
+
#
|
4860
|
+
# @!attribute [rw] choice_answers
|
4861
|
+
# A list of selected choices to a question in your review template.
|
4862
|
+
# @return [Array<Types::ChoiceAnswer>]
|
4863
|
+
#
|
4864
|
+
# @!attribute [rw] is_applicable
|
4865
|
+
# Defines whether this question is applicable to a lens review.
|
4866
|
+
# @return [Boolean]
|
4867
|
+
#
|
4868
|
+
# @!attribute [rw] answer_status
|
4869
|
+
# The status of whether or not this question has been answered.
|
4870
|
+
# @return [String]
|
4871
|
+
#
|
4872
|
+
# @!attribute [rw] notes
|
4873
|
+
# The notes associated with the workload.
|
4874
|
+
#
|
4875
|
+
# For a review template, these are the notes that will be associated
|
4876
|
+
# with the workload when the template is applied.
|
4877
|
+
# @return [String]
|
4878
|
+
#
|
4879
|
+
# @!attribute [rw] reason
|
4880
|
+
# The reason why the question is not applicable to your review
|
4881
|
+
# template.
|
4882
|
+
# @return [String]
|
4883
|
+
#
|
4884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ReviewTemplateAnswer AWS API Documentation
|
4885
|
+
#
|
4886
|
+
class ReviewTemplateAnswer < Struct.new(
|
4887
|
+
:question_id,
|
4888
|
+
:pillar_id,
|
4889
|
+
:question_title,
|
4890
|
+
:question_description,
|
4891
|
+
:improvement_plan_url,
|
4892
|
+
:helpful_resource_url,
|
4893
|
+
:helpful_resource_display_text,
|
4894
|
+
:choices,
|
4895
|
+
:selected_choices,
|
4896
|
+
:choice_answers,
|
4897
|
+
:is_applicable,
|
4898
|
+
:answer_status,
|
4899
|
+
:notes,
|
4900
|
+
:reason)
|
4901
|
+
SENSITIVE = []
|
4902
|
+
include Aws::Structure
|
4903
|
+
end
|
4904
|
+
|
4905
|
+
# The summary of review template answers.
|
4906
|
+
#
|
4907
|
+
# @!attribute [rw] question_id
|
4908
|
+
# The ID of the question.
|
4909
|
+
# @return [String]
|
4910
|
+
#
|
4911
|
+
# @!attribute [rw] pillar_id
|
4912
|
+
# The ID used to identify a pillar, for example, `security`.
|
4913
|
+
#
|
4914
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
4915
|
+
# @return [String]
|
4916
|
+
#
|
4917
|
+
# @!attribute [rw] question_title
|
4918
|
+
# The title of the question.
|
4919
|
+
# @return [String]
|
4920
|
+
#
|
4921
|
+
# @!attribute [rw] choices
|
4922
|
+
# List of choices available for a question.
|
4923
|
+
# @return [Array<Types::Choice>]
|
4924
|
+
#
|
4925
|
+
# @!attribute [rw] selected_choices
|
4926
|
+
# List of selected choice IDs in a question answer.
|
4927
|
+
#
|
4928
|
+
# The values entered replace the previously selected choices.
|
4929
|
+
# @return [Array<String>]
|
4930
|
+
#
|
4931
|
+
# @!attribute [rw] choice_answer_summaries
|
4932
|
+
# A list of selected choices to a question in the review template.
|
4933
|
+
# @return [Array<Types::ChoiceAnswerSummary>]
|
4934
|
+
#
|
4935
|
+
# @!attribute [rw] is_applicable
|
4936
|
+
# Defines whether this question is applicable to a lens review.
|
4937
|
+
# @return [Boolean]
|
4938
|
+
#
|
4939
|
+
# @!attribute [rw] answer_status
|
4940
|
+
# The status of whether or not this question has been answered.
|
4941
|
+
# @return [String]
|
4942
|
+
#
|
4943
|
+
# @!attribute [rw] reason
|
4944
|
+
# The reason why a choice is not-applicable to a question in the
|
4945
|
+
# review template.
|
4946
|
+
# @return [String]
|
4947
|
+
#
|
4948
|
+
# @!attribute [rw] question_type
|
4949
|
+
# The type of question.
|
4950
|
+
# @return [String]
|
4951
|
+
#
|
4952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ReviewTemplateAnswerSummary AWS API Documentation
|
4953
|
+
#
|
4954
|
+
class ReviewTemplateAnswerSummary < Struct.new(
|
4955
|
+
:question_id,
|
4956
|
+
:pillar_id,
|
4957
|
+
:question_title,
|
4958
|
+
:choices,
|
4959
|
+
:selected_choices,
|
4960
|
+
:choice_answer_summaries,
|
4961
|
+
:is_applicable,
|
4962
|
+
:answer_status,
|
4963
|
+
:reason,
|
4964
|
+
:question_type)
|
4965
|
+
SENSITIVE = []
|
4966
|
+
include Aws::Structure
|
4967
|
+
end
|
4968
|
+
|
4969
|
+
# The lens review of a review template.
|
4970
|
+
#
|
4971
|
+
# @!attribute [rw] lens_alias
|
4972
|
+
# The alias of the lens.
|
4973
|
+
#
|
4974
|
+
# For Amazon Web Services official lenses, this is either the lens
|
4975
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
4976
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
4977
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
4978
|
+
# permitted on Amazon Web Services official lenses.
|
4979
|
+
#
|
4980
|
+
# For custom lenses, this is the lens ARN, such as
|
4981
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
4982
|
+
#
|
4983
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
4984
|
+
# @return [String]
|
4985
|
+
#
|
4986
|
+
# @!attribute [rw] lens_arn
|
4987
|
+
# The lens ARN.
|
4988
|
+
# @return [String]
|
4989
|
+
#
|
4990
|
+
# @!attribute [rw] lens_version
|
4991
|
+
# The version of the lens.
|
4992
|
+
# @return [String]
|
4993
|
+
#
|
4994
|
+
# @!attribute [rw] lens_name
|
4995
|
+
# The full name of the lens.
|
4996
|
+
# @return [String]
|
4997
|
+
#
|
4998
|
+
# @!attribute [rw] lens_status
|
4999
|
+
# The status of the lens.
|
5000
|
+
# @return [String]
|
5001
|
+
#
|
5002
|
+
# @!attribute [rw] pillar_review_summaries
|
5003
|
+
# Pillar review summaries of a lens review.
|
5004
|
+
# @return [Array<Types::ReviewTemplatePillarReviewSummary>]
|
5005
|
+
#
|
5006
|
+
# @!attribute [rw] updated_at
|
5007
|
+
# The date and time recorded.
|
5008
|
+
# @return [Time]
|
5009
|
+
#
|
5010
|
+
# @!attribute [rw] notes
|
5011
|
+
# The notes associated with the workload.
|
5012
|
+
#
|
5013
|
+
# For a review template, these are the notes that will be associated
|
5014
|
+
# with the workload when the template is applied.
|
5015
|
+
# @return [String]
|
5016
|
+
#
|
5017
|
+
# @!attribute [rw] question_counts
|
5018
|
+
# A count of how many questions are answered and unanswered in the
|
5019
|
+
# lens review.
|
5020
|
+
# @return [Hash<String,Integer>]
|
5021
|
+
#
|
5022
|
+
# @!attribute [rw] next_token
|
5023
|
+
# The token to use to retrieve the next set of results.
|
5024
|
+
# @return [String]
|
5025
|
+
#
|
5026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ReviewTemplateLensReview AWS API Documentation
|
5027
|
+
#
|
5028
|
+
class ReviewTemplateLensReview < Struct.new(
|
5029
|
+
:lens_alias,
|
5030
|
+
:lens_arn,
|
5031
|
+
:lens_version,
|
5032
|
+
:lens_name,
|
5033
|
+
:lens_status,
|
5034
|
+
:pillar_review_summaries,
|
5035
|
+
:updated_at,
|
5036
|
+
:notes,
|
5037
|
+
:question_counts,
|
5038
|
+
:next_token)
|
5039
|
+
SENSITIVE = []
|
5040
|
+
include Aws::Structure
|
5041
|
+
end
|
5042
|
+
|
5043
|
+
# Summary of a review template.
|
5044
|
+
#
|
5045
|
+
# @!attribute [rw] pillar_id
|
5046
|
+
# The ID used to identify a pillar, for example, `security`.
|
5047
|
+
#
|
5048
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
5049
|
+
# @return [String]
|
5050
|
+
#
|
5051
|
+
# @!attribute [rw] pillar_name
|
5052
|
+
# The name of the pillar.
|
5053
|
+
# @return [String]
|
5054
|
+
#
|
5055
|
+
# @!attribute [rw] notes
|
5056
|
+
# The notes associated with the workload.
|
5057
|
+
#
|
5058
|
+
# For a review template, these are the notes that will be associated
|
5059
|
+
# with the workload when the template is applied.
|
5060
|
+
# @return [String]
|
5061
|
+
#
|
5062
|
+
# @!attribute [rw] question_counts
|
5063
|
+
# A count of how many questions are answered and unanswered in the
|
5064
|
+
# requested pillar of the lens review.
|
5065
|
+
# @return [Hash<String,Integer>]
|
5066
|
+
#
|
5067
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ReviewTemplatePillarReviewSummary AWS API Documentation
|
5068
|
+
#
|
5069
|
+
class ReviewTemplatePillarReviewSummary < Struct.new(
|
5070
|
+
:pillar_id,
|
5071
|
+
:pillar_name,
|
5072
|
+
:notes,
|
5073
|
+
:question_counts)
|
5074
|
+
SENSITIVE = []
|
5075
|
+
include Aws::Structure
|
5076
|
+
end
|
5077
|
+
|
5078
|
+
# Summary of a review template.
|
5079
|
+
#
|
5080
|
+
# @!attribute [rw] description
|
5081
|
+
# Description of the review template.
|
5082
|
+
# @return [String]
|
5083
|
+
#
|
5084
|
+
# @!attribute [rw] lenses
|
5085
|
+
# Lenses associated with the review template.
|
5086
|
+
# @return [Array<String>]
|
5087
|
+
#
|
5088
|
+
# @!attribute [rw] owner
|
5089
|
+
# An Amazon Web Services account ID.
|
5090
|
+
# @return [String]
|
5091
|
+
#
|
5092
|
+
# @!attribute [rw] updated_at
|
5093
|
+
# The date and time recorded.
|
5094
|
+
# @return [Time]
|
5095
|
+
#
|
5096
|
+
# @!attribute [rw] template_arn
|
5097
|
+
# The review template ARN.
|
5098
|
+
# @return [String]
|
5099
|
+
#
|
5100
|
+
# @!attribute [rw] template_name
|
5101
|
+
# The name of the review template.
|
4171
5102
|
# @return [String]
|
4172
5103
|
#
|
4173
|
-
# @!attribute [rw]
|
4174
|
-
#
|
5104
|
+
# @!attribute [rw] update_status
|
5105
|
+
# The latest status of a review template.
|
4175
5106
|
# @return [String]
|
4176
5107
|
#
|
4177
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/
|
5108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ReviewTemplateSummary AWS API Documentation
|
4178
5109
|
#
|
4179
|
-
class
|
4180
|
-
:
|
4181
|
-
:
|
4182
|
-
:
|
5110
|
+
class ReviewTemplateSummary < Struct.new(
|
5111
|
+
:description,
|
5112
|
+
:lenses,
|
5113
|
+
:owner,
|
5114
|
+
:updated_at,
|
5115
|
+
:template_arn,
|
5116
|
+
:template_name,
|
5117
|
+
:update_status)
|
4183
5118
|
SENSITIVE = []
|
4184
5119
|
include Aws::Structure
|
4185
5120
|
end
|
@@ -4256,6 +5191,10 @@ module Aws::WellArchitected
|
|
4256
5191
|
# The profile ARN.
|
4257
5192
|
# @return [String]
|
4258
5193
|
#
|
5194
|
+
# @!attribute [rw] template_arn
|
5195
|
+
# The review template ARN.
|
5196
|
+
# @return [String]
|
5197
|
+
#
|
4259
5198
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ShareInvitation AWS API Documentation
|
4260
5199
|
#
|
4261
5200
|
class ShareInvitation < Struct.new(
|
@@ -4264,7 +5203,8 @@ module Aws::WellArchitected
|
|
4264
5203
|
:workload_id,
|
4265
5204
|
:lens_alias,
|
4266
5205
|
:lens_arn,
|
4267
|
-
:profile_arn
|
5206
|
+
:profile_arn,
|
5207
|
+
:template_arn)
|
4268
5208
|
SENSITIVE = []
|
4269
5209
|
include Aws::Structure
|
4270
5210
|
end
|
@@ -4280,9 +5220,9 @@ module Aws::WellArchitected
|
|
4280
5220
|
# @return [String]
|
4281
5221
|
#
|
4282
5222
|
# @!attribute [rw] shared_with
|
4283
|
-
# The Amazon Web Services account ID,
|
4284
|
-
# organizational unit (OU) ID with which the workload, lens,
|
4285
|
-
#
|
5223
|
+
# The Amazon Web Services account ID, organization ID, or
|
5224
|
+
# organizational unit (OU) ID with which the workload, lens, profile,
|
5225
|
+
# or review template is shared.
|
4286
5226
|
# @return [String]
|
4287
5227
|
#
|
4288
5228
|
# @!attribute [rw] permission_type
|
@@ -4322,6 +5262,14 @@ module Aws::WellArchitected
|
|
4322
5262
|
# The profile ARN.
|
4323
5263
|
# @return [String]
|
4324
5264
|
#
|
5265
|
+
# @!attribute [rw] template_name
|
5266
|
+
# The name of the review template.
|
5267
|
+
# @return [String]
|
5268
|
+
#
|
5269
|
+
# @!attribute [rw] template_arn
|
5270
|
+
# The review template ARN.
|
5271
|
+
# @return [String]
|
5272
|
+
#
|
4325
5273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ShareInvitationSummary AWS API Documentation
|
4326
5274
|
#
|
4327
5275
|
class ShareInvitationSummary < Struct.new(
|
@@ -4335,7 +5283,9 @@ module Aws::WellArchitected
|
|
4335
5283
|
:lens_name,
|
4336
5284
|
:lens_arn,
|
4337
5285
|
:profile_name,
|
4338
|
-
:profile_arn
|
5286
|
+
:profile_arn,
|
5287
|
+
:template_name,
|
5288
|
+
:template_arn)
|
4339
5289
|
SENSITIVE = []
|
4340
5290
|
include Aws::Structure
|
4341
5291
|
end
|
@@ -4361,6 +5311,37 @@ module Aws::WellArchitected
|
|
4361
5311
|
#
|
4362
5312
|
class TagResourceOutput < Aws::EmptyStructure; end
|
4363
5313
|
|
5314
|
+
# Summary of a review template share.
|
5315
|
+
#
|
5316
|
+
# @!attribute [rw] share_id
|
5317
|
+
# The ID associated with the share.
|
5318
|
+
# @return [String]
|
5319
|
+
#
|
5320
|
+
# @!attribute [rw] shared_with
|
5321
|
+
# The Amazon Web Services account ID, organization ID, or
|
5322
|
+
# organizational unit (OU) ID with which the workload, lens, profile,
|
5323
|
+
# or review template is shared.
|
5324
|
+
# @return [String]
|
5325
|
+
#
|
5326
|
+
# @!attribute [rw] status
|
5327
|
+
# The status of the share request.
|
5328
|
+
# @return [String]
|
5329
|
+
#
|
5330
|
+
# @!attribute [rw] status_message
|
5331
|
+
# Review template share invitation status message.
|
5332
|
+
# @return [String]
|
5333
|
+
#
|
5334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/TemplateShareSummary AWS API Documentation
|
5335
|
+
#
|
5336
|
+
class TemplateShareSummary < Struct.new(
|
5337
|
+
:share_id,
|
5338
|
+
:shared_with,
|
5339
|
+
:status,
|
5340
|
+
:status_message)
|
5341
|
+
SENSITIVE = []
|
5342
|
+
include Aws::Structure
|
5343
|
+
end
|
5344
|
+
|
4364
5345
|
# Request was denied due to request throttling.
|
4365
5346
|
#
|
4366
5347
|
# @!attribute [rw] message
|
@@ -4446,6 +5427,9 @@ module Aws::WellArchitected
|
|
4446
5427
|
#
|
4447
5428
|
# @!attribute [rw] notes
|
4448
5429
|
# The notes associated with the workload.
|
5430
|
+
#
|
5431
|
+
# For a review template, these are the notes that will be associated
|
5432
|
+
# with the workload when the template is applied.
|
4449
5433
|
# @return [String]
|
4450
5434
|
#
|
4451
5435
|
# @!attribute [rw] is_applicable
|
@@ -4553,10 +5537,16 @@ module Aws::WellArchitected
|
|
4553
5537
|
#
|
4554
5538
|
# @!attribute [rw] lens_notes
|
4555
5539
|
# The notes associated with the workload.
|
5540
|
+
#
|
5541
|
+
# For a review template, these are the notes that will be associated
|
5542
|
+
# with the workload when the template is applied.
|
4556
5543
|
# @return [String]
|
4557
5544
|
#
|
4558
5545
|
# @!attribute [rw] pillar_notes
|
4559
5546
|
# List of pillar notes of a lens review in a workload.
|
5547
|
+
#
|
5548
|
+
# For a review template, these are the notes that will be associated
|
5549
|
+
# with the workload when the template is applied.
|
4560
5550
|
# @return [Hash<String,String>]
|
4561
5551
|
#
|
4562
5552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateLensReviewInput AWS API Documentation
|
@@ -4624,6 +5614,216 @@ module Aws::WellArchitected
|
|
4624
5614
|
include Aws::Structure
|
4625
5615
|
end
|
4626
5616
|
|
5617
|
+
# @!attribute [rw] template_arn
|
5618
|
+
# The review template ARN.
|
5619
|
+
# @return [String]
|
5620
|
+
#
|
5621
|
+
# @!attribute [rw] lens_alias
|
5622
|
+
# The alias of the lens.
|
5623
|
+
#
|
5624
|
+
# For Amazon Web Services official lenses, this is either the lens
|
5625
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
5626
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
5627
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
5628
|
+
# permitted on Amazon Web Services official lenses.
|
5629
|
+
#
|
5630
|
+
# For custom lenses, this is the lens ARN, such as
|
5631
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
5632
|
+
#
|
5633
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
5634
|
+
# @return [String]
|
5635
|
+
#
|
5636
|
+
# @!attribute [rw] question_id
|
5637
|
+
# The ID of the question.
|
5638
|
+
# @return [String]
|
5639
|
+
#
|
5640
|
+
# @!attribute [rw] selected_choices
|
5641
|
+
# List of selected choice IDs in a question answer.
|
5642
|
+
#
|
5643
|
+
# The values entered replace the previously selected choices.
|
5644
|
+
# @return [Array<String>]
|
5645
|
+
#
|
5646
|
+
# @!attribute [rw] choice_updates
|
5647
|
+
# A list of choices to be updated.
|
5648
|
+
# @return [Hash<String,Types::ChoiceUpdate>]
|
5649
|
+
#
|
5650
|
+
# @!attribute [rw] notes
|
5651
|
+
# The notes associated with the workload.
|
5652
|
+
#
|
5653
|
+
# For a review template, these are the notes that will be associated
|
5654
|
+
# with the workload when the template is applied.
|
5655
|
+
# @return [String]
|
5656
|
+
#
|
5657
|
+
# @!attribute [rw] is_applicable
|
5658
|
+
# Defines whether this question is applicable to a lens review.
|
5659
|
+
# @return [Boolean]
|
5660
|
+
#
|
5661
|
+
# @!attribute [rw] reason
|
5662
|
+
# The update reason.
|
5663
|
+
# @return [String]
|
5664
|
+
#
|
5665
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateReviewTemplateAnswerInput AWS API Documentation
|
5666
|
+
#
|
5667
|
+
class UpdateReviewTemplateAnswerInput < Struct.new(
|
5668
|
+
:template_arn,
|
5669
|
+
:lens_alias,
|
5670
|
+
:question_id,
|
5671
|
+
:selected_choices,
|
5672
|
+
:choice_updates,
|
5673
|
+
:notes,
|
5674
|
+
:is_applicable,
|
5675
|
+
:reason)
|
5676
|
+
SENSITIVE = []
|
5677
|
+
include Aws::Structure
|
5678
|
+
end
|
5679
|
+
|
5680
|
+
# @!attribute [rw] template_arn
|
5681
|
+
# The review template ARN.
|
5682
|
+
# @return [String]
|
5683
|
+
#
|
5684
|
+
# @!attribute [rw] lens_alias
|
5685
|
+
# The alias of the lens.
|
5686
|
+
#
|
5687
|
+
# For Amazon Web Services official lenses, this is either the lens
|
5688
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
5689
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
5690
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
5691
|
+
# permitted on Amazon Web Services official lenses.
|
5692
|
+
#
|
5693
|
+
# For custom lenses, this is the lens ARN, such as
|
5694
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
5695
|
+
#
|
5696
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
5697
|
+
# @return [String]
|
5698
|
+
#
|
5699
|
+
# @!attribute [rw] answer
|
5700
|
+
# An answer of the question.
|
5701
|
+
# @return [Types::ReviewTemplateAnswer]
|
5702
|
+
#
|
5703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateReviewTemplateAnswerOutput AWS API Documentation
|
5704
|
+
#
|
5705
|
+
class UpdateReviewTemplateAnswerOutput < Struct.new(
|
5706
|
+
:template_arn,
|
5707
|
+
:lens_alias,
|
5708
|
+
:answer)
|
5709
|
+
SENSITIVE = []
|
5710
|
+
include Aws::Structure
|
5711
|
+
end
|
5712
|
+
|
5713
|
+
# @!attribute [rw] template_arn
|
5714
|
+
# The review template ARN.
|
5715
|
+
# @return [String]
|
5716
|
+
#
|
5717
|
+
# @!attribute [rw] template_name
|
5718
|
+
# The review template name.
|
5719
|
+
# @return [String]
|
5720
|
+
#
|
5721
|
+
# @!attribute [rw] description
|
5722
|
+
# The review template description.
|
5723
|
+
# @return [String]
|
5724
|
+
#
|
5725
|
+
# @!attribute [rw] notes
|
5726
|
+
# The notes associated with the workload.
|
5727
|
+
#
|
5728
|
+
# For a review template, these are the notes that will be associated
|
5729
|
+
# with the workload when the template is applied.
|
5730
|
+
# @return [String]
|
5731
|
+
#
|
5732
|
+
# @!attribute [rw] lenses_to_associate
|
5733
|
+
# A list of lens aliases or ARNs to apply to the review template.
|
5734
|
+
# @return [Array<String>]
|
5735
|
+
#
|
5736
|
+
# @!attribute [rw] lenses_to_disassociate
|
5737
|
+
# A list of lens aliases or ARNs to unapply to the review template.
|
5738
|
+
# The `wellarchitected` lens cannot be unapplied.
|
5739
|
+
# @return [Array<String>]
|
5740
|
+
#
|
5741
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateReviewTemplateInput AWS API Documentation
|
5742
|
+
#
|
5743
|
+
class UpdateReviewTemplateInput < Struct.new(
|
5744
|
+
:template_arn,
|
5745
|
+
:template_name,
|
5746
|
+
:description,
|
5747
|
+
:notes,
|
5748
|
+
:lenses_to_associate,
|
5749
|
+
:lenses_to_disassociate)
|
5750
|
+
SENSITIVE = []
|
5751
|
+
include Aws::Structure
|
5752
|
+
end
|
5753
|
+
|
5754
|
+
# @!attribute [rw] template_arn
|
5755
|
+
# The review template ARN.
|
5756
|
+
# @return [String]
|
5757
|
+
#
|
5758
|
+
# @!attribute [rw] lens_alias
|
5759
|
+
# The alias of the lens.
|
5760
|
+
#
|
5761
|
+
# For Amazon Web Services official lenses, this is either the lens
|
5762
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
5763
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
5764
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
5765
|
+
# permitted on Amazon Web Services official lenses.
|
5766
|
+
#
|
5767
|
+
# For custom lenses, this is the lens ARN, such as
|
5768
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
5769
|
+
#
|
5770
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
5771
|
+
# @return [String]
|
5772
|
+
#
|
5773
|
+
# @!attribute [rw] lens_notes
|
5774
|
+
# The notes associated with the workload.
|
5775
|
+
#
|
5776
|
+
# For a review template, these are the notes that will be associated
|
5777
|
+
# with the workload when the template is applied.
|
5778
|
+
# @return [String]
|
5779
|
+
#
|
5780
|
+
# @!attribute [rw] pillar_notes
|
5781
|
+
# List of pillar notes of a lens review in a workload.
|
5782
|
+
#
|
5783
|
+
# For a review template, these are the notes that will be associated
|
5784
|
+
# with the workload when the template is applied.
|
5785
|
+
# @return [Hash<String,String>]
|
5786
|
+
#
|
5787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateReviewTemplateLensReviewInput AWS API Documentation
|
5788
|
+
#
|
5789
|
+
class UpdateReviewTemplateLensReviewInput < Struct.new(
|
5790
|
+
:template_arn,
|
5791
|
+
:lens_alias,
|
5792
|
+
:lens_notes,
|
5793
|
+
:pillar_notes)
|
5794
|
+
SENSITIVE = []
|
5795
|
+
include Aws::Structure
|
5796
|
+
end
|
5797
|
+
|
5798
|
+
# @!attribute [rw] template_arn
|
5799
|
+
# The review template ARN.
|
5800
|
+
# @return [String]
|
5801
|
+
#
|
5802
|
+
# @!attribute [rw] lens_review
|
5803
|
+
# A lens review of a question.
|
5804
|
+
# @return [Types::ReviewTemplateLensReview]
|
5805
|
+
#
|
5806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateReviewTemplateLensReviewOutput AWS API Documentation
|
5807
|
+
#
|
5808
|
+
class UpdateReviewTemplateLensReviewOutput < Struct.new(
|
5809
|
+
:template_arn,
|
5810
|
+
:lens_review)
|
5811
|
+
SENSITIVE = []
|
5812
|
+
include Aws::Structure
|
5813
|
+
end
|
5814
|
+
|
5815
|
+
# @!attribute [rw] review_template
|
5816
|
+
# A review template.
|
5817
|
+
# @return [Types::ReviewTemplate]
|
5818
|
+
#
|
5819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateReviewTemplateOutput AWS API Documentation
|
5820
|
+
#
|
5821
|
+
class UpdateReviewTemplateOutput < Struct.new(
|
5822
|
+
:review_template)
|
5823
|
+
SENSITIVE = []
|
5824
|
+
include Aws::Structure
|
5825
|
+
end
|
5826
|
+
|
4627
5827
|
# Input for Update Share Invitation
|
4628
5828
|
#
|
4629
5829
|
# @!attribute [rw] share_invitation_id
|
@@ -4784,6 +5984,9 @@ module Aws::WellArchitected
|
|
4784
5984
|
#
|
4785
5985
|
# @!attribute [rw] notes
|
4786
5986
|
# The notes associated with the workload.
|
5987
|
+
#
|
5988
|
+
# For a review template, these are the notes that will be associated
|
5989
|
+
# with the workload when the template is applied.
|
4787
5990
|
# @return [String]
|
4788
5991
|
#
|
4789
5992
|
# @!attribute [rw] improvement_status
|
@@ -4978,6 +6181,50 @@ module Aws::WellArchitected
|
|
4978
6181
|
include Aws::Structure
|
4979
6182
|
end
|
4980
6183
|
|
6184
|
+
# @!attribute [rw] template_arn
|
6185
|
+
# The ARN of the review template.
|
6186
|
+
# @return [String]
|
6187
|
+
#
|
6188
|
+
# @!attribute [rw] lens_alias
|
6189
|
+
# The alias of the lens.
|
6190
|
+
#
|
6191
|
+
# For Amazon Web Services official lenses, this is either the lens
|
6192
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
6193
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
6194
|
+
# operations (such as ExportLens and CreateLensShare) are not
|
6195
|
+
# permitted on Amazon Web Services official lenses.
|
6196
|
+
#
|
6197
|
+
# For custom lenses, this is the lens ARN, such as
|
6198
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
6199
|
+
#
|
6200
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
6201
|
+
# @return [String]
|
6202
|
+
#
|
6203
|
+
# @!attribute [rw] client_request_token
|
6204
|
+
# A unique case-sensitive string used to ensure that this request is
|
6205
|
+
# idempotent (executes only once).
|
6206
|
+
#
|
6207
|
+
# You should not reuse the same token for other requests. If you retry
|
6208
|
+
# a request with the same client request token and the same parameters
|
6209
|
+
# after the original request has completed successfully, the result of
|
6210
|
+
# the original request is returned.
|
6211
|
+
#
|
6212
|
+
# This token is listed as required, however, if you do not specify it,
|
6213
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
6214
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
6215
|
+
# provide this token or the request will fail.
|
6216
|
+
# @return [String]
|
6217
|
+
#
|
6218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpgradeReviewTemplateLensReviewInput AWS API Documentation
|
6219
|
+
#
|
6220
|
+
class UpgradeReviewTemplateLensReviewInput < Struct.new(
|
6221
|
+
:template_arn,
|
6222
|
+
:lens_alias,
|
6223
|
+
:client_request_token)
|
6224
|
+
SENSITIVE = []
|
6225
|
+
include Aws::Structure
|
6226
|
+
end
|
6227
|
+
|
4981
6228
|
# The user input is not valid.
|
4982
6229
|
#
|
4983
6230
|
# @!attribute [rw] message
|
@@ -5171,6 +6418,9 @@ module Aws::WellArchitected
|
|
5171
6418
|
#
|
5172
6419
|
# @!attribute [rw] notes
|
5173
6420
|
# The notes associated with the workload.
|
6421
|
+
#
|
6422
|
+
# For a review template, these are the notes that will be associated
|
6423
|
+
# with the workload when the template is applied.
|
5174
6424
|
# @return [String]
|
5175
6425
|
#
|
5176
6426
|
# @!attribute [rw] improvement_status
|
@@ -5191,6 +6441,10 @@ module Aws::WellArchitected
|
|
5191
6441
|
# @!attribute [rw] lenses
|
5192
6442
|
# The list of lenses associated with the workload. Each lens is
|
5193
6443
|
# identified by its LensSummary$LensAlias.
|
6444
|
+
#
|
6445
|
+
# If a review template that specifies lenses is applied to the
|
6446
|
+
# workload, those lenses are applied to the workload in addition to
|
6447
|
+
# these lenses.
|
5194
6448
|
# @return [Array<String>]
|
5195
6449
|
#
|
5196
6450
|
# @!attribute [rw] owner
|
@@ -5309,9 +6563,9 @@ module Aws::WellArchitected
|
|
5309
6563
|
# @return [String]
|
5310
6564
|
#
|
5311
6565
|
# @!attribute [rw] shared_with
|
5312
|
-
# The Amazon Web Services account ID,
|
5313
|
-
# organizational unit (OU) ID with which the workload, lens,
|
5314
|
-
#
|
6566
|
+
# The Amazon Web Services account ID, organization ID, or
|
6567
|
+
# organizational unit (OU) ID with which the workload, lens, profile,
|
6568
|
+
# or review template is shared.
|
5315
6569
|
# @return [String]
|
5316
6570
|
#
|
5317
6571
|
# @!attribute [rw] permission_type
|
@@ -5356,9 +6610,9 @@ module Aws::WellArchitected
|
|
5356
6610
|
# @return [String]
|
5357
6611
|
#
|
5358
6612
|
# @!attribute [rw] shared_with
|
5359
|
-
# The Amazon Web Services account ID,
|
5360
|
-
# organizational unit (OU) ID with which the workload, lens,
|
5361
|
-
#
|
6613
|
+
# The Amazon Web Services account ID, organization ID, or
|
6614
|
+
# organizational unit (OU) ID with which the workload, lens, profile,
|
6615
|
+
# or review template is shared.
|
5362
6616
|
# @return [String]
|
5363
6617
|
#
|
5364
6618
|
# @!attribute [rw] permission_type
|
@@ -5415,6 +6669,10 @@ module Aws::WellArchitected
|
|
5415
6669
|
# @!attribute [rw] lenses
|
5416
6670
|
# The list of lenses associated with the workload. Each lens is
|
5417
6671
|
# identified by its LensSummary$LensAlias.
|
6672
|
+
#
|
6673
|
+
# If a review template that specifies lenses is applied to the
|
6674
|
+
# workload, those lenses are applied to the workload in addition to
|
6675
|
+
# these lenses.
|
5418
6676
|
# @return [Array<String>]
|
5419
6677
|
#
|
5420
6678
|
# @!attribute [rw] risk_counts
|