aws-sdk-wellarchitected 1.23.0 → 1.24.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 +704 -19
- data/lib/aws-sdk-wellarchitected/client_api.rb +464 -0
- data/lib/aws-sdk-wellarchitected/endpoints.rb +182 -0
- data/lib/aws-sdk-wellarchitected/plugins/endpoints.rb +26 -0
- data/lib/aws-sdk-wellarchitected/types.rb +1020 -63
- data/lib/aws-sdk-wellarchitected.rb +1 -1
- metadata +2 -2
@@ -187,6 +187,10 @@ module Aws::WellArchitected
|
|
187
187
|
# workload.
|
188
188
|
# @return [String]
|
189
189
|
#
|
190
|
+
# @!attribute [rw] question_type
|
191
|
+
# The type of the question.
|
192
|
+
# @return [String]
|
193
|
+
#
|
190
194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/AnswerSummary AWS API Documentation
|
191
195
|
#
|
192
196
|
class AnswerSummary < Struct.new(
|
@@ -198,7 +202,8 @@ module Aws::WellArchitected
|
|
198
202
|
:choice_answer_summaries,
|
199
203
|
:is_applicable,
|
200
204
|
:risk,
|
201
|
-
:reason
|
205
|
+
:reason,
|
206
|
+
:question_type)
|
202
207
|
SENSITIVE = []
|
203
208
|
include Aws::Structure
|
204
209
|
end
|
@@ -226,6 +231,24 @@ module Aws::WellArchitected
|
|
226
231
|
include Aws::Structure
|
227
232
|
end
|
228
233
|
|
234
|
+
# @!attribute [rw] workload_id
|
235
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
236
|
+
# Web Services Region.
|
237
|
+
# @return [String]
|
238
|
+
#
|
239
|
+
# @!attribute [rw] profile_arns
|
240
|
+
# The list of profile ARNs to associate with the workload.
|
241
|
+
# @return [Array<String>]
|
242
|
+
#
|
243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/AssociateProfilesInput AWS API Documentation
|
244
|
+
#
|
245
|
+
class AssociateProfilesInput < Struct.new(
|
246
|
+
:workload_id,
|
247
|
+
:profile_arns)
|
248
|
+
SENSITIVE = []
|
249
|
+
include Aws::Structure
|
250
|
+
end
|
251
|
+
|
229
252
|
# A best practice, or question choice, that has been identified as a
|
230
253
|
# risk in this question.
|
231
254
|
#
|
@@ -663,7 +686,8 @@ module Aws::WellArchitected
|
|
663
686
|
#
|
664
687
|
# @!attribute [rw] shared_with
|
665
688
|
# The Amazon Web Services account ID, IAM role, organization ID, or
|
666
|
-
# organizational unit (OU) ID with which the workload
|
689
|
+
# organizational unit (OU) ID with which the workload, lens, or
|
690
|
+
# profile is shared.
|
667
691
|
# @return [String]
|
668
692
|
#
|
669
693
|
# @!attribute [rw] client_request_token
|
@@ -695,7 +719,7 @@ module Aws::WellArchitected
|
|
695
719
|
end
|
696
720
|
|
697
721
|
# @!attribute [rw] share_id
|
698
|
-
# The ID associated with the
|
722
|
+
# The ID associated with the share.
|
699
723
|
# @return [String]
|
700
724
|
#
|
701
725
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensShareOutput AWS API Documentation
|
@@ -838,6 +862,124 @@ module Aws::WellArchitected
|
|
838
862
|
include Aws::Structure
|
839
863
|
end
|
840
864
|
|
865
|
+
# @!attribute [rw] profile_name
|
866
|
+
# Name of the profile.
|
867
|
+
# @return [String]
|
868
|
+
#
|
869
|
+
# @!attribute [rw] profile_description
|
870
|
+
# The profile description.
|
871
|
+
# @return [String]
|
872
|
+
#
|
873
|
+
# @!attribute [rw] profile_questions
|
874
|
+
# The profile questions.
|
875
|
+
# @return [Array<Types::ProfileQuestionUpdate>]
|
876
|
+
#
|
877
|
+
# @!attribute [rw] client_request_token
|
878
|
+
# A unique case-sensitive string used to ensure that this request is
|
879
|
+
# idempotent (executes only once).
|
880
|
+
#
|
881
|
+
# You should not reuse the same token for other requests. If you retry
|
882
|
+
# a request with the same client request token and the same parameters
|
883
|
+
# after the original request has completed successfully, the result of
|
884
|
+
# the original request is returned.
|
885
|
+
#
|
886
|
+
# This token is listed as required, however, if you do not specify it,
|
887
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
888
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
889
|
+
# provide this token or the request will fail.
|
890
|
+
#
|
891
|
+
# **A suitable default value is auto-generated.** You should normally
|
892
|
+
# not need to pass this option.
|
893
|
+
# @return [String]
|
894
|
+
#
|
895
|
+
# @!attribute [rw] tags
|
896
|
+
# The tags assigned to the profile.
|
897
|
+
# @return [Hash<String,String>]
|
898
|
+
#
|
899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateProfileInput AWS API Documentation
|
900
|
+
#
|
901
|
+
class CreateProfileInput < Struct.new(
|
902
|
+
:profile_name,
|
903
|
+
:profile_description,
|
904
|
+
:profile_questions,
|
905
|
+
:client_request_token,
|
906
|
+
:tags)
|
907
|
+
SENSITIVE = []
|
908
|
+
include Aws::Structure
|
909
|
+
end
|
910
|
+
|
911
|
+
# @!attribute [rw] profile_arn
|
912
|
+
# The profile ARN.
|
913
|
+
# @return [String]
|
914
|
+
#
|
915
|
+
# @!attribute [rw] profile_version
|
916
|
+
# Version of the profile.
|
917
|
+
# @return [String]
|
918
|
+
#
|
919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateProfileOutput AWS API Documentation
|
920
|
+
#
|
921
|
+
class CreateProfileOutput < Struct.new(
|
922
|
+
:profile_arn,
|
923
|
+
:profile_version)
|
924
|
+
SENSITIVE = []
|
925
|
+
include Aws::Structure
|
926
|
+
end
|
927
|
+
|
928
|
+
# @!attribute [rw] profile_arn
|
929
|
+
# The profile ARN.
|
930
|
+
# @return [String]
|
931
|
+
#
|
932
|
+
# @!attribute [rw] shared_with
|
933
|
+
# The Amazon Web Services account ID, IAM role, organization ID, or
|
934
|
+
# organizational unit (OU) ID with which the workload, lens, or
|
935
|
+
# profile is shared.
|
936
|
+
# @return [String]
|
937
|
+
#
|
938
|
+
# @!attribute [rw] client_request_token
|
939
|
+
# A unique case-sensitive string used to ensure that this request is
|
940
|
+
# idempotent (executes only once).
|
941
|
+
#
|
942
|
+
# You should not reuse the same token for other requests. If you retry
|
943
|
+
# a request with the same client request token and the same parameters
|
944
|
+
# after the original request has completed successfully, the result of
|
945
|
+
# the original request is returned.
|
946
|
+
#
|
947
|
+
# This token is listed as required, however, if you do not specify it,
|
948
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
949
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
950
|
+
# provide this token or the request will fail.
|
951
|
+
#
|
952
|
+
# **A suitable default value is auto-generated.** You should normally
|
953
|
+
# not need to pass this option.
|
954
|
+
# @return [String]
|
955
|
+
#
|
956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateProfileShareInput AWS API Documentation
|
957
|
+
#
|
958
|
+
class CreateProfileShareInput < Struct.new(
|
959
|
+
:profile_arn,
|
960
|
+
:shared_with,
|
961
|
+
:client_request_token)
|
962
|
+
SENSITIVE = []
|
963
|
+
include Aws::Structure
|
964
|
+
end
|
965
|
+
|
966
|
+
# @!attribute [rw] share_id
|
967
|
+
# The ID associated with the share.
|
968
|
+
# @return [String]
|
969
|
+
#
|
970
|
+
# @!attribute [rw] profile_arn
|
971
|
+
# The profile ARN.
|
972
|
+
# @return [String]
|
973
|
+
#
|
974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateProfileShareOutput AWS API Documentation
|
975
|
+
#
|
976
|
+
class CreateProfileShareOutput < Struct.new(
|
977
|
+
:share_id,
|
978
|
+
:profile_arn)
|
979
|
+
SENSITIVE = []
|
980
|
+
include Aws::Structure
|
981
|
+
end
|
982
|
+
|
841
983
|
# Input for workload creation.
|
842
984
|
#
|
843
985
|
# @!attribute [rw] workload_name
|
@@ -991,6 +1133,10 @@ module Aws::WellArchitected
|
|
991
1133
|
# List of AppRegistry application ARNs associated to the workload.
|
992
1134
|
# @return [Array<String>]
|
993
1135
|
#
|
1136
|
+
# @!attribute [rw] profile_arns
|
1137
|
+
# The list of profile ARNs associated with the workload.
|
1138
|
+
# @return [Array<String>]
|
1139
|
+
#
|
994
1140
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadInput AWS API Documentation
|
995
1141
|
#
|
996
1142
|
class CreateWorkloadInput < Struct.new(
|
@@ -1010,7 +1156,8 @@ module Aws::WellArchitected
|
|
1010
1156
|
:client_request_token,
|
1011
1157
|
:tags,
|
1012
1158
|
:discovery_config,
|
1013
|
-
:applications
|
1159
|
+
:applications,
|
1160
|
+
:profile_arns)
|
1014
1161
|
SENSITIVE = []
|
1015
1162
|
include Aws::Structure
|
1016
1163
|
end
|
@@ -1044,11 +1191,12 @@ module Aws::WellArchitected
|
|
1044
1191
|
#
|
1045
1192
|
# @!attribute [rw] shared_with
|
1046
1193
|
# The Amazon Web Services account ID, IAM role, organization ID, or
|
1047
|
-
# organizational unit (OU) ID with which the workload
|
1194
|
+
# organizational unit (OU) ID with which the workload, lens, or
|
1195
|
+
# profile is shared.
|
1048
1196
|
# @return [String]
|
1049
1197
|
#
|
1050
1198
|
# @!attribute [rw] permission_type
|
1051
|
-
# Permission granted on a
|
1199
|
+
# Permission granted on a share request.
|
1052
1200
|
# @return [String]
|
1053
1201
|
#
|
1054
1202
|
# @!attribute [rw] client_request_token
|
@@ -1088,7 +1236,7 @@ module Aws::WellArchitected
|
|
1088
1236
|
# @return [String]
|
1089
1237
|
#
|
1090
1238
|
# @!attribute [rw] share_id
|
1091
|
-
# The ID associated with the
|
1239
|
+
# The ID associated with the share.
|
1092
1240
|
# @return [String]
|
1093
1241
|
#
|
1094
1242
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadShareOutput AWS API Documentation
|
@@ -1148,7 +1296,7 @@ module Aws::WellArchitected
|
|
1148
1296
|
end
|
1149
1297
|
|
1150
1298
|
# @!attribute [rw] share_id
|
1151
|
-
# The ID associated with the
|
1299
|
+
# The ID associated with the share.
|
1152
1300
|
# @return [String]
|
1153
1301
|
#
|
1154
1302
|
# @!attribute [rw] lens_alias
|
@@ -1194,6 +1342,73 @@ module Aws::WellArchitected
|
|
1194
1342
|
include Aws::Structure
|
1195
1343
|
end
|
1196
1344
|
|
1345
|
+
# @!attribute [rw] profile_arn
|
1346
|
+
# The profile ARN.
|
1347
|
+
# @return [String]
|
1348
|
+
#
|
1349
|
+
# @!attribute [rw] client_request_token
|
1350
|
+
# A unique case-sensitive string used to ensure that this request is
|
1351
|
+
# idempotent (executes only once).
|
1352
|
+
#
|
1353
|
+
# You should not reuse the same token for other requests. If you retry
|
1354
|
+
# a request with the same client request token and the same parameters
|
1355
|
+
# after the original request has completed successfully, the result of
|
1356
|
+
# the original request is returned.
|
1357
|
+
#
|
1358
|
+
# This token is listed as required, however, if you do not specify it,
|
1359
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1360
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1361
|
+
# provide this token or the request will fail.
|
1362
|
+
#
|
1363
|
+
# **A suitable default value is auto-generated.** You should normally
|
1364
|
+
# not need to pass this option.
|
1365
|
+
# @return [String]
|
1366
|
+
#
|
1367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteProfileInput AWS API Documentation
|
1368
|
+
#
|
1369
|
+
class DeleteProfileInput < Struct.new(
|
1370
|
+
:profile_arn,
|
1371
|
+
:client_request_token)
|
1372
|
+
SENSITIVE = []
|
1373
|
+
include Aws::Structure
|
1374
|
+
end
|
1375
|
+
|
1376
|
+
# @!attribute [rw] share_id
|
1377
|
+
# The ID associated with the share.
|
1378
|
+
# @return [String]
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] profile_arn
|
1381
|
+
# The profile ARN.
|
1382
|
+
# @return [String]
|
1383
|
+
#
|
1384
|
+
# @!attribute [rw] client_request_token
|
1385
|
+
# A unique case-sensitive string used to ensure that this request is
|
1386
|
+
# idempotent (executes only once).
|
1387
|
+
#
|
1388
|
+
# You should not reuse the same token for other requests. If you retry
|
1389
|
+
# a request with the same client request token and the same parameters
|
1390
|
+
# after the original request has completed successfully, the result of
|
1391
|
+
# the original request is returned.
|
1392
|
+
#
|
1393
|
+
# This token is listed as required, however, if you do not specify it,
|
1394
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1395
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1396
|
+
# provide this token or the request will fail.
|
1397
|
+
#
|
1398
|
+
# **A suitable default value is auto-generated.** You should normally
|
1399
|
+
# not need to pass this option.
|
1400
|
+
# @return [String]
|
1401
|
+
#
|
1402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteProfileShareInput AWS API Documentation
|
1403
|
+
#
|
1404
|
+
class DeleteProfileShareInput < Struct.new(
|
1405
|
+
:share_id,
|
1406
|
+
:profile_arn,
|
1407
|
+
:client_request_token)
|
1408
|
+
SENSITIVE = []
|
1409
|
+
include Aws::Structure
|
1410
|
+
end
|
1411
|
+
|
1197
1412
|
# Input for workload deletion.
|
1198
1413
|
#
|
1199
1414
|
# @!attribute [rw] workload_id
|
@@ -1231,7 +1446,7 @@ module Aws::WellArchitected
|
|
1231
1446
|
# Input for Delete Workload Share
|
1232
1447
|
#
|
1233
1448
|
# @!attribute [rw] share_id
|
1234
|
-
# The ID associated with the
|
1449
|
+
# The ID associated with the share.
|
1235
1450
|
# @return [String]
|
1236
1451
|
#
|
1237
1452
|
# @!attribute [rw] workload_id
|
@@ -1290,6 +1505,24 @@ module Aws::WellArchitected
|
|
1290
1505
|
include Aws::Structure
|
1291
1506
|
end
|
1292
1507
|
|
1508
|
+
# @!attribute [rw] workload_id
|
1509
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1510
|
+
# Web Services Region.
|
1511
|
+
# @return [String]
|
1512
|
+
#
|
1513
|
+
# @!attribute [rw] profile_arns
|
1514
|
+
# The list of profile ARNs to disassociate from the workload.
|
1515
|
+
# @return [Array<String>]
|
1516
|
+
#
|
1517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DisassociateProfilesInput AWS API Documentation
|
1518
|
+
#
|
1519
|
+
class DisassociateProfilesInput < Struct.new(
|
1520
|
+
:workload_id,
|
1521
|
+
:profile_arns)
|
1522
|
+
SENSITIVE = []
|
1523
|
+
include Aws::Structure
|
1524
|
+
end
|
1525
|
+
|
1293
1526
|
# @!attribute [rw] lens_alias
|
1294
1527
|
# The alias of the lens.
|
1295
1528
|
#
|
@@ -1773,6 +2006,53 @@ module Aws::WellArchitected
|
|
1773
2006
|
include Aws::Structure
|
1774
2007
|
end
|
1775
2008
|
|
2009
|
+
# @!attribute [rw] profile_arn
|
2010
|
+
# The profile ARN.
|
2011
|
+
# @return [String]
|
2012
|
+
#
|
2013
|
+
# @!attribute [rw] profile_version
|
2014
|
+
# The profile version.
|
2015
|
+
# @return [String]
|
2016
|
+
#
|
2017
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetProfileInput AWS API Documentation
|
2018
|
+
#
|
2019
|
+
class GetProfileInput < Struct.new(
|
2020
|
+
:profile_arn,
|
2021
|
+
:profile_version)
|
2022
|
+
SENSITIVE = []
|
2023
|
+
include Aws::Structure
|
2024
|
+
end
|
2025
|
+
|
2026
|
+
# @!attribute [rw] profile
|
2027
|
+
# The profile.
|
2028
|
+
# @return [Types::Profile]
|
2029
|
+
#
|
2030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetProfileOutput AWS API Documentation
|
2031
|
+
#
|
2032
|
+
class GetProfileOutput < Struct.new(
|
2033
|
+
:profile)
|
2034
|
+
SENSITIVE = []
|
2035
|
+
include Aws::Structure
|
2036
|
+
end
|
2037
|
+
|
2038
|
+
# @api private
|
2039
|
+
#
|
2040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetProfileTemplateInput AWS API Documentation
|
2041
|
+
#
|
2042
|
+
class GetProfileTemplateInput < Aws::EmptyStructure; end
|
2043
|
+
|
2044
|
+
# @!attribute [rw] profile_template
|
2045
|
+
# The profile template.
|
2046
|
+
# @return [Types::ProfileTemplate]
|
2047
|
+
#
|
2048
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetProfileTemplateOutput AWS API Documentation
|
2049
|
+
#
|
2050
|
+
class GetProfileTemplateOutput < Struct.new(
|
2051
|
+
:profile_template)
|
2052
|
+
SENSITIVE = []
|
2053
|
+
include Aws::Structure
|
2054
|
+
end
|
2055
|
+
|
1776
2056
|
# Input to get a workload.
|
1777
2057
|
#
|
1778
2058
|
# @!attribute [rw] workload_id
|
@@ -2054,6 +2334,15 @@ module Aws::WellArchitected
|
|
2054
2334
|
# The token to use to retrieve the next set of results.
|
2055
2335
|
# @return [String]
|
2056
2336
|
#
|
2337
|
+
# @!attribute [rw] profiles
|
2338
|
+
# The profiles associated with the workload.
|
2339
|
+
# @return [Array<Types::WorkloadProfile>]
|
2340
|
+
#
|
2341
|
+
# @!attribute [rw] prioritized_risk_counts
|
2342
|
+
# A map from risk names to the count of how many questions have that
|
2343
|
+
# rating.
|
2344
|
+
# @return [Hash<String,Integer>]
|
2345
|
+
#
|
2057
2346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensReview AWS API Documentation
|
2058
2347
|
#
|
2059
2348
|
class LensReview < Struct.new(
|
@@ -2066,7 +2355,9 @@ module Aws::WellArchitected
|
|
2066
2355
|
:updated_at,
|
2067
2356
|
:notes,
|
2068
2357
|
:risk_counts,
|
2069
|
-
:next_token
|
2358
|
+
:next_token,
|
2359
|
+
:profiles,
|
2360
|
+
:prioritized_risk_counts)
|
2070
2361
|
SENSITIVE = []
|
2071
2362
|
include Aws::Structure
|
2072
2363
|
end
|
@@ -2153,6 +2444,15 @@ module Aws::WellArchitected
|
|
2153
2444
|
# rating.
|
2154
2445
|
# @return [Hash<String,Integer>]
|
2155
2446
|
#
|
2447
|
+
# @!attribute [rw] profiles
|
2448
|
+
# The profiles associated with the workload.
|
2449
|
+
# @return [Array<Types::WorkloadProfile>]
|
2450
|
+
#
|
2451
|
+
# @!attribute [rw] prioritized_risk_counts
|
2452
|
+
# A map from risk names to the count of how many questions have that
|
2453
|
+
# rating.
|
2454
|
+
# @return [Hash<String,Integer>]
|
2455
|
+
#
|
2156
2456
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensReviewSummary AWS API Documentation
|
2157
2457
|
#
|
2158
2458
|
class LensReviewSummary < Struct.new(
|
@@ -2162,7 +2462,9 @@ module Aws::WellArchitected
|
|
2162
2462
|
:lens_name,
|
2163
2463
|
:lens_status,
|
2164
2464
|
:updated_at,
|
2165
|
-
:risk_counts
|
2465
|
+
:risk_counts,
|
2466
|
+
:profiles,
|
2467
|
+
:prioritized_risk_counts)
|
2166
2468
|
SENSITIVE = []
|
2167
2469
|
include Aws::Structure
|
2168
2470
|
end
|
@@ -2170,16 +2472,17 @@ module Aws::WellArchitected
|
|
2170
2472
|
# A lens share summary return object.
|
2171
2473
|
#
|
2172
2474
|
# @!attribute [rw] share_id
|
2173
|
-
# The ID associated with the
|
2475
|
+
# The ID associated with the share.
|
2174
2476
|
# @return [String]
|
2175
2477
|
#
|
2176
2478
|
# @!attribute [rw] shared_with
|
2177
2479
|
# The Amazon Web Services account ID, IAM role, organization ID, or
|
2178
|
-
# organizational unit (OU) ID with which the workload
|
2480
|
+
# organizational unit (OU) ID with which the workload, lens, or
|
2481
|
+
# profile is shared.
|
2179
2482
|
# @return [String]
|
2180
2483
|
#
|
2181
2484
|
# @!attribute [rw] status
|
2182
|
-
# The status of
|
2485
|
+
# The status of the share request.
|
2183
2486
|
# @return [String]
|
2184
2487
|
#
|
2185
2488
|
# @!attribute [rw] status_message
|
@@ -2364,6 +2667,10 @@ module Aws::WellArchitected
|
|
2364
2667
|
# The maximum number of results to return for this request.
|
2365
2668
|
# @return [Integer]
|
2366
2669
|
#
|
2670
|
+
# @!attribute [rw] question_priority
|
2671
|
+
# The priority of the question.
|
2672
|
+
# @return [String]
|
2673
|
+
#
|
2367
2674
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListAnswersInput AWS API Documentation
|
2368
2675
|
#
|
2369
2676
|
class ListAnswersInput < Struct.new(
|
@@ -2372,7 +2679,8 @@ module Aws::WellArchitected
|
|
2372
2679
|
:pillar_id,
|
2373
2680
|
:milestone_number,
|
2374
2681
|
:next_token,
|
2375
|
-
:max_results
|
2682
|
+
:max_results,
|
2683
|
+
:question_priority)
|
2376
2684
|
SENSITIVE = []
|
2377
2685
|
include Aws::Structure
|
2378
2686
|
end
|
@@ -2598,6 +2906,10 @@ module Aws::WellArchitected
|
|
2598
2906
|
# The maximum number of results to return for this request.
|
2599
2907
|
# @return [Integer]
|
2600
2908
|
#
|
2909
|
+
# @!attribute [rw] question_priority
|
2910
|
+
# The priority of the question.
|
2911
|
+
# @return [String]
|
2912
|
+
#
|
2601
2913
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovementsInput AWS API Documentation
|
2602
2914
|
#
|
2603
2915
|
class ListLensReviewImprovementsInput < Struct.new(
|
@@ -2606,7 +2918,8 @@ module Aws::WellArchitected
|
|
2606
2918
|
:pillar_id,
|
2607
2919
|
:milestone_number,
|
2608
2920
|
:next_token,
|
2609
|
-
:max_results
|
2921
|
+
:max_results,
|
2922
|
+
:question_priority)
|
2610
2923
|
SENSITIVE = []
|
2611
2924
|
include Aws::Structure
|
2612
2925
|
end
|
@@ -2757,7 +3070,7 @@ module Aws::WellArchitected
|
|
2757
3070
|
# @return [Integer]
|
2758
3071
|
#
|
2759
3072
|
# @!attribute [rw] status
|
2760
|
-
# The status of
|
3073
|
+
# The status of the share request.
|
2761
3074
|
# @return [String]
|
2762
3075
|
#
|
2763
3076
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensSharesInput AWS API Documentation
|
@@ -2932,20 +3245,9 @@ module Aws::WellArchitected
|
|
2932
3245
|
include Aws::Structure
|
2933
3246
|
end
|
2934
3247
|
|
2935
|
-
#
|
2936
|
-
#
|
2937
|
-
#
|
2938
|
-
# An optional string added to the beginning of each workload name
|
2939
|
-
# returned in the results.
|
2940
|
-
# @return [String]
|
2941
|
-
#
|
2942
|
-
# @!attribute [rw] lens_name_prefix
|
2943
|
-
# An optional string added to the beginning of each lens name returned
|
2944
|
-
# in the results.
|
2945
|
-
# @return [String]
|
2946
|
-
#
|
2947
|
-
# @!attribute [rw] share_resource_type
|
2948
|
-
# The type of share invitations to be returned.
|
3248
|
+
# @!attribute [rw] workload_id
|
3249
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3250
|
+
# Web Services Region.
|
2949
3251
|
# @return [String]
|
2950
3252
|
#
|
2951
3253
|
# @!attribute [rw] next_token
|
@@ -2956,38 +3258,188 @@ module Aws::WellArchitected
|
|
2956
3258
|
# The maximum number of results to return for this request.
|
2957
3259
|
# @return [Integer]
|
2958
3260
|
#
|
2959
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/
|
3261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListProfileNotificationsInput AWS API Documentation
|
2960
3262
|
#
|
2961
|
-
class
|
2962
|
-
:
|
2963
|
-
:lens_name_prefix,
|
2964
|
-
:share_resource_type,
|
3263
|
+
class ListProfileNotificationsInput < Struct.new(
|
3264
|
+
:workload_id,
|
2965
3265
|
:next_token,
|
2966
3266
|
:max_results)
|
2967
3267
|
SENSITIVE = []
|
2968
3268
|
include Aws::Structure
|
2969
3269
|
end
|
2970
3270
|
|
2971
|
-
#
|
2972
|
-
#
|
2973
|
-
#
|
2974
|
-
# List of share invitation summaries in a workload.
|
2975
|
-
# @return [Array<Types::ShareInvitationSummary>]
|
3271
|
+
# @!attribute [rw] notification_summaries
|
3272
|
+
# Notification summaries.
|
3273
|
+
# @return [Array<Types::ProfileNotificationSummary>]
|
2976
3274
|
#
|
2977
3275
|
# @!attribute [rw] next_token
|
2978
3276
|
# The token to use to retrieve the next set of results.
|
2979
3277
|
# @return [String]
|
2980
3278
|
#
|
2981
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/
|
3279
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListProfileNotificationsOutput AWS API Documentation
|
2982
3280
|
#
|
2983
|
-
class
|
2984
|
-
:
|
3281
|
+
class ListProfileNotificationsOutput < Struct.new(
|
3282
|
+
:notification_summaries,
|
2985
3283
|
:next_token)
|
2986
3284
|
SENSITIVE = []
|
2987
3285
|
include Aws::Structure
|
2988
3286
|
end
|
2989
3287
|
|
2990
|
-
# @!attribute [rw]
|
3288
|
+
# @!attribute [rw] profile_arn
|
3289
|
+
# The profile ARN.
|
3290
|
+
# @return [String]
|
3291
|
+
#
|
3292
|
+
# @!attribute [rw] shared_with_prefix
|
3293
|
+
# The Amazon Web Services account ID, IAM role, organization ID, or
|
3294
|
+
# organizational unit (OU) ID with which the profile is shared.
|
3295
|
+
# @return [String]
|
3296
|
+
#
|
3297
|
+
# @!attribute [rw] next_token
|
3298
|
+
# The token to use to retrieve the next set of results.
|
3299
|
+
# @return [String]
|
3300
|
+
#
|
3301
|
+
# @!attribute [rw] max_results
|
3302
|
+
# The maximum number of results to return for this request.
|
3303
|
+
# @return [Integer]
|
3304
|
+
#
|
3305
|
+
# @!attribute [rw] status
|
3306
|
+
# The status of the share request.
|
3307
|
+
# @return [String]
|
3308
|
+
#
|
3309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListProfileSharesInput AWS API Documentation
|
3310
|
+
#
|
3311
|
+
class ListProfileSharesInput < Struct.new(
|
3312
|
+
:profile_arn,
|
3313
|
+
:shared_with_prefix,
|
3314
|
+
:next_token,
|
3315
|
+
:max_results,
|
3316
|
+
:status)
|
3317
|
+
SENSITIVE = []
|
3318
|
+
include Aws::Structure
|
3319
|
+
end
|
3320
|
+
|
3321
|
+
# @!attribute [rw] profile_share_summaries
|
3322
|
+
# Profile share summaries.
|
3323
|
+
# @return [Array<Types::ProfileShareSummary>]
|
3324
|
+
#
|
3325
|
+
# @!attribute [rw] next_token
|
3326
|
+
# The token to use to retrieve the next set of results.
|
3327
|
+
# @return [String]
|
3328
|
+
#
|
3329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListProfileSharesOutput AWS API Documentation
|
3330
|
+
#
|
3331
|
+
class ListProfileSharesOutput < Struct.new(
|
3332
|
+
:profile_share_summaries,
|
3333
|
+
:next_token)
|
3334
|
+
SENSITIVE = []
|
3335
|
+
include Aws::Structure
|
3336
|
+
end
|
3337
|
+
|
3338
|
+
# @!attribute [rw] profile_name_prefix
|
3339
|
+
# Prefix for profile name.
|
3340
|
+
# @return [String]
|
3341
|
+
#
|
3342
|
+
# @!attribute [rw] profile_owner_type
|
3343
|
+
# Profile owner type.
|
3344
|
+
# @return [String]
|
3345
|
+
#
|
3346
|
+
# @!attribute [rw] next_token
|
3347
|
+
# The token to use to retrieve the next set of results.
|
3348
|
+
# @return [String]
|
3349
|
+
#
|
3350
|
+
# @!attribute [rw] max_results
|
3351
|
+
# The maximum number of results to return for this request.
|
3352
|
+
# @return [Integer]
|
3353
|
+
#
|
3354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListProfilesInput AWS API Documentation
|
3355
|
+
#
|
3356
|
+
class ListProfilesInput < Struct.new(
|
3357
|
+
:profile_name_prefix,
|
3358
|
+
:profile_owner_type,
|
3359
|
+
:next_token,
|
3360
|
+
:max_results)
|
3361
|
+
SENSITIVE = []
|
3362
|
+
include Aws::Structure
|
3363
|
+
end
|
3364
|
+
|
3365
|
+
# @!attribute [rw] profile_summaries
|
3366
|
+
# Profile summaries.
|
3367
|
+
# @return [Array<Types::ProfileSummary>]
|
3368
|
+
#
|
3369
|
+
# @!attribute [rw] next_token
|
3370
|
+
# The token to use to retrieve the next set of results.
|
3371
|
+
# @return [String]
|
3372
|
+
#
|
3373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListProfilesOutput AWS API Documentation
|
3374
|
+
#
|
3375
|
+
class ListProfilesOutput < Struct.new(
|
3376
|
+
:profile_summaries,
|
3377
|
+
:next_token)
|
3378
|
+
SENSITIVE = []
|
3379
|
+
include Aws::Structure
|
3380
|
+
end
|
3381
|
+
|
3382
|
+
# Input for List Share Invitations
|
3383
|
+
#
|
3384
|
+
# @!attribute [rw] workload_name_prefix
|
3385
|
+
# An optional string added to the beginning of each workload name
|
3386
|
+
# returned in the results.
|
3387
|
+
# @return [String]
|
3388
|
+
#
|
3389
|
+
# @!attribute [rw] lens_name_prefix
|
3390
|
+
# An optional string added to the beginning of each lens name returned
|
3391
|
+
# in the results.
|
3392
|
+
# @return [String]
|
3393
|
+
#
|
3394
|
+
# @!attribute [rw] share_resource_type
|
3395
|
+
# The type of share invitations to be returned.
|
3396
|
+
# @return [String]
|
3397
|
+
#
|
3398
|
+
# @!attribute [rw] next_token
|
3399
|
+
# The token to use to retrieve the next set of results.
|
3400
|
+
# @return [String]
|
3401
|
+
#
|
3402
|
+
# @!attribute [rw] max_results
|
3403
|
+
# The maximum number of results to return for this request.
|
3404
|
+
# @return [Integer]
|
3405
|
+
#
|
3406
|
+
# @!attribute [rw] profile_name_prefix
|
3407
|
+
# Profile name prefix.
|
3408
|
+
# @return [String]
|
3409
|
+
#
|
3410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitationsInput AWS API Documentation
|
3411
|
+
#
|
3412
|
+
class ListShareInvitationsInput < Struct.new(
|
3413
|
+
:workload_name_prefix,
|
3414
|
+
:lens_name_prefix,
|
3415
|
+
:share_resource_type,
|
3416
|
+
:next_token,
|
3417
|
+
:max_results,
|
3418
|
+
:profile_name_prefix)
|
3419
|
+
SENSITIVE = []
|
3420
|
+
include Aws::Structure
|
3421
|
+
end
|
3422
|
+
|
3423
|
+
# Input for List Share Invitations
|
3424
|
+
#
|
3425
|
+
# @!attribute [rw] share_invitation_summaries
|
3426
|
+
# List of share invitation summaries in a workload.
|
3427
|
+
# @return [Array<Types::ShareInvitationSummary>]
|
3428
|
+
#
|
3429
|
+
# @!attribute [rw] next_token
|
3430
|
+
# The token to use to retrieve the next set of results.
|
3431
|
+
# @return [String]
|
3432
|
+
#
|
3433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitationsOutput AWS API Documentation
|
3434
|
+
#
|
3435
|
+
class ListShareInvitationsOutput < Struct.new(
|
3436
|
+
:share_invitation_summaries,
|
3437
|
+
:next_token)
|
3438
|
+
SENSITIVE = []
|
3439
|
+
include Aws::Structure
|
3440
|
+
end
|
3441
|
+
|
3442
|
+
# @!attribute [rw] workload_arn
|
2991
3443
|
# The ARN for the workload.
|
2992
3444
|
# @return [String]
|
2993
3445
|
#
|
@@ -3032,7 +3484,7 @@ module Aws::WellArchitected
|
|
3032
3484
|
# @return [Integer]
|
3033
3485
|
#
|
3034
3486
|
# @!attribute [rw] status
|
3035
|
-
# The status of
|
3487
|
+
# The status of the share request.
|
3036
3488
|
# @return [String]
|
3037
3489
|
#
|
3038
3490
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadSharesInput AWS API Documentation
|
@@ -3280,13 +3732,381 @@ module Aws::WellArchitected
|
|
3280
3732
|
# rating.
|
3281
3733
|
# @return [Hash<String,Integer>]
|
3282
3734
|
#
|
3735
|
+
# @!attribute [rw] prioritized_risk_counts
|
3736
|
+
# A map from risk names to the count of how many questions have that
|
3737
|
+
# rating.
|
3738
|
+
# @return [Hash<String,Integer>]
|
3739
|
+
#
|
3283
3740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/PillarReviewSummary AWS API Documentation
|
3284
3741
|
#
|
3285
3742
|
class PillarReviewSummary < Struct.new(
|
3286
3743
|
:pillar_id,
|
3287
3744
|
:pillar_name,
|
3288
3745
|
:notes,
|
3289
|
-
:risk_counts
|
3746
|
+
:risk_counts,
|
3747
|
+
:prioritized_risk_counts)
|
3748
|
+
SENSITIVE = []
|
3749
|
+
include Aws::Structure
|
3750
|
+
end
|
3751
|
+
|
3752
|
+
# A profile.
|
3753
|
+
#
|
3754
|
+
# @!attribute [rw] profile_arn
|
3755
|
+
# The profile ARN.
|
3756
|
+
# @return [String]
|
3757
|
+
#
|
3758
|
+
# @!attribute [rw] profile_version
|
3759
|
+
# The profile version.
|
3760
|
+
# @return [String]
|
3761
|
+
#
|
3762
|
+
# @!attribute [rw] profile_name
|
3763
|
+
# The profile name.
|
3764
|
+
# @return [String]
|
3765
|
+
#
|
3766
|
+
# @!attribute [rw] profile_description
|
3767
|
+
# The profile description.
|
3768
|
+
# @return [String]
|
3769
|
+
#
|
3770
|
+
# @!attribute [rw] profile_questions
|
3771
|
+
# Profile questions.
|
3772
|
+
# @return [Array<Types::ProfileQuestion>]
|
3773
|
+
#
|
3774
|
+
# @!attribute [rw] owner
|
3775
|
+
# An Amazon Web Services account ID.
|
3776
|
+
# @return [String]
|
3777
|
+
#
|
3778
|
+
# @!attribute [rw] created_at
|
3779
|
+
# The date and time recorded.
|
3780
|
+
# @return [Time]
|
3781
|
+
#
|
3782
|
+
# @!attribute [rw] updated_at
|
3783
|
+
# The date and time recorded.
|
3784
|
+
# @return [Time]
|
3785
|
+
#
|
3786
|
+
# @!attribute [rw] share_invitation_id
|
3787
|
+
# The ID assigned to the share invitation.
|
3788
|
+
# @return [String]
|
3789
|
+
#
|
3790
|
+
# @!attribute [rw] tags
|
3791
|
+
# The tags assigned to the profile.
|
3792
|
+
# @return [Hash<String,String>]
|
3793
|
+
#
|
3794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/Profile AWS API Documentation
|
3795
|
+
#
|
3796
|
+
class Profile < Struct.new(
|
3797
|
+
:profile_arn,
|
3798
|
+
:profile_version,
|
3799
|
+
:profile_name,
|
3800
|
+
:profile_description,
|
3801
|
+
:profile_questions,
|
3802
|
+
:owner,
|
3803
|
+
:created_at,
|
3804
|
+
:updated_at,
|
3805
|
+
:share_invitation_id,
|
3806
|
+
:tags)
|
3807
|
+
SENSITIVE = []
|
3808
|
+
include Aws::Structure
|
3809
|
+
end
|
3810
|
+
|
3811
|
+
# The profile choice.
|
3812
|
+
#
|
3813
|
+
# @!attribute [rw] choice_id
|
3814
|
+
# The ID of a choice.
|
3815
|
+
# @return [String]
|
3816
|
+
#
|
3817
|
+
# @!attribute [rw] choice_title
|
3818
|
+
# The title of a choice.
|
3819
|
+
# @return [String]
|
3820
|
+
#
|
3821
|
+
# @!attribute [rw] choice_description
|
3822
|
+
# The description of a choice.
|
3823
|
+
# @return [String]
|
3824
|
+
#
|
3825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ProfileChoice AWS API Documentation
|
3826
|
+
#
|
3827
|
+
class ProfileChoice < Struct.new(
|
3828
|
+
:choice_id,
|
3829
|
+
:choice_title,
|
3830
|
+
:choice_description)
|
3831
|
+
SENSITIVE = []
|
3832
|
+
include Aws::Structure
|
3833
|
+
end
|
3834
|
+
|
3835
|
+
# The profile notification summary.
|
3836
|
+
#
|
3837
|
+
# @!attribute [rw] current_profile_version
|
3838
|
+
# The current profile version.
|
3839
|
+
# @return [String]
|
3840
|
+
#
|
3841
|
+
# @!attribute [rw] latest_profile_version
|
3842
|
+
# The latest profile version.
|
3843
|
+
# @return [String]
|
3844
|
+
#
|
3845
|
+
# @!attribute [rw] type
|
3846
|
+
# Type of notification.
|
3847
|
+
# @return [String]
|
3848
|
+
#
|
3849
|
+
# @!attribute [rw] profile_arn
|
3850
|
+
# The profile ARN.
|
3851
|
+
# @return [String]
|
3852
|
+
#
|
3853
|
+
# @!attribute [rw] profile_name
|
3854
|
+
# The profile name.
|
3855
|
+
# @return [String]
|
3856
|
+
#
|
3857
|
+
# @!attribute [rw] workload_id
|
3858
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3859
|
+
# Web Services Region.
|
3860
|
+
# @return [String]
|
3861
|
+
#
|
3862
|
+
# @!attribute [rw] workload_name
|
3863
|
+
# The name of the workload.
|
3864
|
+
#
|
3865
|
+
# The name must be unique within an account within an Amazon Web
|
3866
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
3867
|
+
# for uniqueness.
|
3868
|
+
# @return [String]
|
3869
|
+
#
|
3870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ProfileNotificationSummary AWS API Documentation
|
3871
|
+
#
|
3872
|
+
class ProfileNotificationSummary < Struct.new(
|
3873
|
+
:current_profile_version,
|
3874
|
+
:latest_profile_version,
|
3875
|
+
:type,
|
3876
|
+
:profile_arn,
|
3877
|
+
:profile_name,
|
3878
|
+
:workload_id,
|
3879
|
+
:workload_name)
|
3880
|
+
SENSITIVE = []
|
3881
|
+
include Aws::Structure
|
3882
|
+
end
|
3883
|
+
|
3884
|
+
# A profile question.
|
3885
|
+
#
|
3886
|
+
# @!attribute [rw] question_id
|
3887
|
+
# The ID of the question.
|
3888
|
+
# @return [String]
|
3889
|
+
#
|
3890
|
+
# @!attribute [rw] question_title
|
3891
|
+
# The title of the question.
|
3892
|
+
# @return [String]
|
3893
|
+
#
|
3894
|
+
# @!attribute [rw] question_description
|
3895
|
+
# The description of the question.
|
3896
|
+
# @return [String]
|
3897
|
+
#
|
3898
|
+
# @!attribute [rw] question_choices
|
3899
|
+
# The question choices.
|
3900
|
+
# @return [Array<Types::ProfileChoice>]
|
3901
|
+
#
|
3902
|
+
# @!attribute [rw] selected_choice_ids
|
3903
|
+
# The selected choices.
|
3904
|
+
# @return [Array<String>]
|
3905
|
+
#
|
3906
|
+
# @!attribute [rw] min_selected_choices
|
3907
|
+
# The minimum number of selected choices.
|
3908
|
+
# @return [Integer]
|
3909
|
+
#
|
3910
|
+
# @!attribute [rw] max_selected_choices
|
3911
|
+
# The maximum number of selected choices.
|
3912
|
+
# @return [Integer]
|
3913
|
+
#
|
3914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ProfileQuestion AWS API Documentation
|
3915
|
+
#
|
3916
|
+
class ProfileQuestion < Struct.new(
|
3917
|
+
:question_id,
|
3918
|
+
:question_title,
|
3919
|
+
:question_description,
|
3920
|
+
:question_choices,
|
3921
|
+
:selected_choice_ids,
|
3922
|
+
:min_selected_choices,
|
3923
|
+
:max_selected_choices)
|
3924
|
+
SENSITIVE = []
|
3925
|
+
include Aws::Structure
|
3926
|
+
end
|
3927
|
+
|
3928
|
+
# An update to a profile question.
|
3929
|
+
#
|
3930
|
+
# @!attribute [rw] question_id
|
3931
|
+
# The ID of the question.
|
3932
|
+
# @return [String]
|
3933
|
+
#
|
3934
|
+
# @!attribute [rw] selected_choice_ids
|
3935
|
+
# The selected choices.
|
3936
|
+
# @return [Array<String>]
|
3937
|
+
#
|
3938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ProfileQuestionUpdate AWS API Documentation
|
3939
|
+
#
|
3940
|
+
class ProfileQuestionUpdate < Struct.new(
|
3941
|
+
:question_id,
|
3942
|
+
:selected_choice_ids)
|
3943
|
+
SENSITIVE = []
|
3944
|
+
include Aws::Structure
|
3945
|
+
end
|
3946
|
+
|
3947
|
+
# Summary of a profile share.
|
3948
|
+
#
|
3949
|
+
# @!attribute [rw] share_id
|
3950
|
+
# The ID associated with the share.
|
3951
|
+
# @return [String]
|
3952
|
+
#
|
3953
|
+
# @!attribute [rw] shared_with
|
3954
|
+
# The Amazon Web Services account ID, IAM role, organization ID, or
|
3955
|
+
# organizational unit (OU) ID with which the workload, lens, or
|
3956
|
+
# profile is shared.
|
3957
|
+
# @return [String]
|
3958
|
+
#
|
3959
|
+
# @!attribute [rw] status
|
3960
|
+
# The status of the share request.
|
3961
|
+
# @return [String]
|
3962
|
+
#
|
3963
|
+
# @!attribute [rw] status_message
|
3964
|
+
# Profile share invitation status message.
|
3965
|
+
# @return [String]
|
3966
|
+
#
|
3967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ProfileShareSummary AWS API Documentation
|
3968
|
+
#
|
3969
|
+
class ProfileShareSummary < Struct.new(
|
3970
|
+
:share_id,
|
3971
|
+
:shared_with,
|
3972
|
+
:status,
|
3973
|
+
:status_message)
|
3974
|
+
SENSITIVE = []
|
3975
|
+
include Aws::Structure
|
3976
|
+
end
|
3977
|
+
|
3978
|
+
# Summary of a profile.
|
3979
|
+
#
|
3980
|
+
# @!attribute [rw] profile_arn
|
3981
|
+
# The profile ARN.
|
3982
|
+
# @return [String]
|
3983
|
+
#
|
3984
|
+
# @!attribute [rw] profile_version
|
3985
|
+
# The profile version.
|
3986
|
+
# @return [String]
|
3987
|
+
#
|
3988
|
+
# @!attribute [rw] profile_name
|
3989
|
+
# The profile name.
|
3990
|
+
# @return [String]
|
3991
|
+
#
|
3992
|
+
# @!attribute [rw] profile_description
|
3993
|
+
# The profile description.
|
3994
|
+
# @return [String]
|
3995
|
+
#
|
3996
|
+
# @!attribute [rw] owner
|
3997
|
+
# An Amazon Web Services account ID.
|
3998
|
+
# @return [String]
|
3999
|
+
#
|
4000
|
+
# @!attribute [rw] created_at
|
4001
|
+
# The date and time recorded.
|
4002
|
+
# @return [Time]
|
4003
|
+
#
|
4004
|
+
# @!attribute [rw] updated_at
|
4005
|
+
# The date and time recorded.
|
4006
|
+
# @return [Time]
|
4007
|
+
#
|
4008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ProfileSummary AWS API Documentation
|
4009
|
+
#
|
4010
|
+
class ProfileSummary < Struct.new(
|
4011
|
+
:profile_arn,
|
4012
|
+
:profile_version,
|
4013
|
+
:profile_name,
|
4014
|
+
:profile_description,
|
4015
|
+
:owner,
|
4016
|
+
:created_at,
|
4017
|
+
:updated_at)
|
4018
|
+
SENSITIVE = []
|
4019
|
+
include Aws::Structure
|
4020
|
+
end
|
4021
|
+
|
4022
|
+
# The profile template.
|
4023
|
+
#
|
4024
|
+
# @!attribute [rw] template_name
|
4025
|
+
# The name of the profile template.
|
4026
|
+
# @return [String]
|
4027
|
+
#
|
4028
|
+
# @!attribute [rw] template_questions
|
4029
|
+
# Profile template questions.
|
4030
|
+
# @return [Array<Types::ProfileTemplateQuestion>]
|
4031
|
+
#
|
4032
|
+
# @!attribute [rw] created_at
|
4033
|
+
# The date and time recorded.
|
4034
|
+
# @return [Time]
|
4035
|
+
#
|
4036
|
+
# @!attribute [rw] updated_at
|
4037
|
+
# The date and time recorded.
|
4038
|
+
# @return [Time]
|
4039
|
+
#
|
4040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ProfileTemplate AWS API Documentation
|
4041
|
+
#
|
4042
|
+
class ProfileTemplate < Struct.new(
|
4043
|
+
:template_name,
|
4044
|
+
:template_questions,
|
4045
|
+
:created_at,
|
4046
|
+
:updated_at)
|
4047
|
+
SENSITIVE = []
|
4048
|
+
include Aws::Structure
|
4049
|
+
end
|
4050
|
+
|
4051
|
+
# A profile template choice.
|
4052
|
+
#
|
4053
|
+
# @!attribute [rw] choice_id
|
4054
|
+
# The ID of a choice.
|
4055
|
+
# @return [String]
|
4056
|
+
#
|
4057
|
+
# @!attribute [rw] choice_title
|
4058
|
+
# The title of a choice.
|
4059
|
+
# @return [String]
|
4060
|
+
#
|
4061
|
+
# @!attribute [rw] choice_description
|
4062
|
+
# The description of a choice.
|
4063
|
+
# @return [String]
|
4064
|
+
#
|
4065
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ProfileTemplateChoice AWS API Documentation
|
4066
|
+
#
|
4067
|
+
class ProfileTemplateChoice < Struct.new(
|
4068
|
+
:choice_id,
|
4069
|
+
:choice_title,
|
4070
|
+
:choice_description)
|
4071
|
+
SENSITIVE = []
|
4072
|
+
include Aws::Structure
|
4073
|
+
end
|
4074
|
+
|
4075
|
+
# A profile template question.
|
4076
|
+
#
|
4077
|
+
# @!attribute [rw] question_id
|
4078
|
+
# The ID of the question.
|
4079
|
+
# @return [String]
|
4080
|
+
#
|
4081
|
+
# @!attribute [rw] question_title
|
4082
|
+
# The title of the question.
|
4083
|
+
# @return [String]
|
4084
|
+
#
|
4085
|
+
# @!attribute [rw] question_description
|
4086
|
+
# The description of the question.
|
4087
|
+
# @return [String]
|
4088
|
+
#
|
4089
|
+
# @!attribute [rw] question_choices
|
4090
|
+
# The question choices.
|
4091
|
+
# @return [Array<Types::ProfileTemplateChoice>]
|
4092
|
+
#
|
4093
|
+
# @!attribute [rw] min_selected_choices
|
4094
|
+
# The minimum number of choices selected.
|
4095
|
+
# @return [Integer]
|
4096
|
+
#
|
4097
|
+
# @!attribute [rw] max_selected_choices
|
4098
|
+
# The maximum number of choices selected.
|
4099
|
+
# @return [Integer]
|
4100
|
+
#
|
4101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ProfileTemplateQuestion AWS API Documentation
|
4102
|
+
#
|
4103
|
+
class ProfileTemplateQuestion < Struct.new(
|
4104
|
+
:question_id,
|
4105
|
+
:question_title,
|
4106
|
+
:question_description,
|
4107
|
+
:question_choices,
|
4108
|
+
:min_selected_choices,
|
4109
|
+
:max_selected_choices)
|
3290
4110
|
SENSITIVE = []
|
3291
4111
|
include Aws::Structure
|
3292
4112
|
end
|
@@ -3432,6 +4252,10 @@ module Aws::WellArchitected
|
|
3432
4252
|
# The ARN for the lens.
|
3433
4253
|
# @return [String]
|
3434
4254
|
#
|
4255
|
+
# @!attribute [rw] profile_arn
|
4256
|
+
# The profile ARN.
|
4257
|
+
# @return [String]
|
4258
|
+
#
|
3435
4259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ShareInvitation AWS API Documentation
|
3436
4260
|
#
|
3437
4261
|
class ShareInvitation < Struct.new(
|
@@ -3439,7 +4263,8 @@ module Aws::WellArchitected
|
|
3439
4263
|
:share_resource_type,
|
3440
4264
|
:workload_id,
|
3441
4265
|
:lens_alias,
|
3442
|
-
:lens_arn
|
4266
|
+
:lens_arn,
|
4267
|
+
:profile_arn)
|
3443
4268
|
SENSITIVE = []
|
3444
4269
|
include Aws::Structure
|
3445
4270
|
end
|
@@ -3456,11 +4281,12 @@ module Aws::WellArchitected
|
|
3456
4281
|
#
|
3457
4282
|
# @!attribute [rw] shared_with
|
3458
4283
|
# The Amazon Web Services account ID, IAM role, organization ID, or
|
3459
|
-
# organizational unit (OU) ID with which the workload
|
4284
|
+
# organizational unit (OU) ID with which the workload, lens, or
|
4285
|
+
# profile is shared.
|
3460
4286
|
# @return [String]
|
3461
4287
|
#
|
3462
4288
|
# @!attribute [rw] permission_type
|
3463
|
-
# Permission granted on a
|
4289
|
+
# Permission granted on a share request.
|
3464
4290
|
# @return [String]
|
3465
4291
|
#
|
3466
4292
|
# @!attribute [rw] share_resource_type
|
@@ -3488,6 +4314,14 @@ module Aws::WellArchitected
|
|
3488
4314
|
# The ARN for the lens.
|
3489
4315
|
# @return [String]
|
3490
4316
|
#
|
4317
|
+
# @!attribute [rw] profile_name
|
4318
|
+
# The profile name.
|
4319
|
+
# @return [String]
|
4320
|
+
#
|
4321
|
+
# @!attribute [rw] profile_arn
|
4322
|
+
# The profile ARN.
|
4323
|
+
# @return [String]
|
4324
|
+
#
|
3491
4325
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ShareInvitationSummary AWS API Documentation
|
3492
4326
|
#
|
3493
4327
|
class ShareInvitationSummary < Struct.new(
|
@@ -3499,7 +4333,9 @@ module Aws::WellArchitected
|
|
3499
4333
|
:workload_name,
|
3500
4334
|
:workload_id,
|
3501
4335
|
:lens_name,
|
3502
|
-
:lens_arn
|
4336
|
+
:lens_arn,
|
4337
|
+
:profile_name,
|
4338
|
+
:profile_arn)
|
3503
4339
|
SENSITIVE = []
|
3504
4340
|
include Aws::Structure
|
3505
4341
|
end
|
@@ -3754,6 +4590,40 @@ module Aws::WellArchitected
|
|
3754
4590
|
include Aws::Structure
|
3755
4591
|
end
|
3756
4592
|
|
4593
|
+
# @!attribute [rw] profile_arn
|
4594
|
+
# The profile ARN.
|
4595
|
+
# @return [String]
|
4596
|
+
#
|
4597
|
+
# @!attribute [rw] profile_description
|
4598
|
+
# The profile description.
|
4599
|
+
# @return [String]
|
4600
|
+
#
|
4601
|
+
# @!attribute [rw] profile_questions
|
4602
|
+
# Profile questions.
|
4603
|
+
# @return [Array<Types::ProfileQuestionUpdate>]
|
4604
|
+
#
|
4605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateProfileInput AWS API Documentation
|
4606
|
+
#
|
4607
|
+
class UpdateProfileInput < Struct.new(
|
4608
|
+
:profile_arn,
|
4609
|
+
:profile_description,
|
4610
|
+
:profile_questions)
|
4611
|
+
SENSITIVE = []
|
4612
|
+
include Aws::Structure
|
4613
|
+
end
|
4614
|
+
|
4615
|
+
# @!attribute [rw] profile
|
4616
|
+
# The profile.
|
4617
|
+
# @return [Types::Profile]
|
4618
|
+
#
|
4619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateProfileOutput AWS API Documentation
|
4620
|
+
#
|
4621
|
+
class UpdateProfileOutput < Struct.new(
|
4622
|
+
:profile)
|
4623
|
+
SENSITIVE = []
|
4624
|
+
include Aws::Structure
|
4625
|
+
end
|
4626
|
+
|
3757
4627
|
# Input for Update Share Invitation
|
3758
4628
|
#
|
3759
4629
|
# @!attribute [rw] share_invitation_id
|
@@ -3970,7 +4840,7 @@ module Aws::WellArchitected
|
|
3970
4840
|
# Input for Update Workload Share
|
3971
4841
|
#
|
3972
4842
|
# @!attribute [rw] share_id
|
3973
|
-
# The ID associated with the
|
4843
|
+
# The ID associated with the share.
|
3974
4844
|
# @return [String]
|
3975
4845
|
#
|
3976
4846
|
# @!attribute [rw] workload_id
|
@@ -3979,7 +4849,7 @@ module Aws::WellArchitected
|
|
3979
4849
|
# @return [String]
|
3980
4850
|
#
|
3981
4851
|
# @!attribute [rw] permission_type
|
3982
|
-
# Permission granted on a
|
4852
|
+
# Permission granted on a share request.
|
3983
4853
|
# @return [String]
|
3984
4854
|
#
|
3985
4855
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkloadShareInput AWS API Documentation
|
@@ -4064,6 +4934,50 @@ module Aws::WellArchitected
|
|
4064
4934
|
include Aws::Structure
|
4065
4935
|
end
|
4066
4936
|
|
4937
|
+
# @!attribute [rw] workload_id
|
4938
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
4939
|
+
# Web Services Region.
|
4940
|
+
# @return [String]
|
4941
|
+
#
|
4942
|
+
# @!attribute [rw] profile_arn
|
4943
|
+
# The profile ARN.
|
4944
|
+
# @return [String]
|
4945
|
+
#
|
4946
|
+
# @!attribute [rw] milestone_name
|
4947
|
+
# The name of the milestone in a workload.
|
4948
|
+
#
|
4949
|
+
# Milestone names must be unique within a workload.
|
4950
|
+
# @return [String]
|
4951
|
+
#
|
4952
|
+
# @!attribute [rw] client_request_token
|
4953
|
+
# A unique case-sensitive string used to ensure that this request is
|
4954
|
+
# idempotent (executes only once).
|
4955
|
+
#
|
4956
|
+
# You should not reuse the same token for other requests. If you retry
|
4957
|
+
# a request with the same client request token and the same parameters
|
4958
|
+
# after the original request has completed successfully, the result of
|
4959
|
+
# the original request is returned.
|
4960
|
+
#
|
4961
|
+
# This token is listed as required, however, if you do not specify it,
|
4962
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
4963
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
4964
|
+
# provide this token or the request will fail.
|
4965
|
+
#
|
4966
|
+
# **A suitable default value is auto-generated.** You should normally
|
4967
|
+
# not need to pass this option.
|
4968
|
+
# @return [String]
|
4969
|
+
#
|
4970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpgradeProfileVersionInput AWS API Documentation
|
4971
|
+
#
|
4972
|
+
class UpgradeProfileVersionInput < Struct.new(
|
4973
|
+
:workload_id,
|
4974
|
+
:profile_arn,
|
4975
|
+
:milestone_name,
|
4976
|
+
:client_request_token)
|
4977
|
+
SENSITIVE = []
|
4978
|
+
include Aws::Structure
|
4979
|
+
end
|
4980
|
+
|
4067
4981
|
# The user input is not valid.
|
4068
4982
|
#
|
4069
4983
|
# @!attribute [rw] message
|
@@ -4299,6 +5213,15 @@ module Aws::WellArchitected
|
|
4299
5213
|
# List of AppRegistry application ARNs associated to the workload.
|
4300
5214
|
# @return [Array<String>]
|
4301
5215
|
#
|
5216
|
+
# @!attribute [rw] profiles
|
5217
|
+
# Profile associated with a workload.
|
5218
|
+
# @return [Array<Types::WorkloadProfile>]
|
5219
|
+
#
|
5220
|
+
# @!attribute [rw] prioritized_risk_counts
|
5221
|
+
# A map from risk names to the count of how many questions have that
|
5222
|
+
# rating.
|
5223
|
+
# @return [Hash<String,Integer>]
|
5224
|
+
#
|
4302
5225
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/Workload AWS API Documentation
|
4303
5226
|
#
|
4304
5227
|
class Workload < Struct.new(
|
@@ -4326,7 +5249,9 @@ module Aws::WellArchitected
|
|
4326
5249
|
:share_invitation_id,
|
4327
5250
|
:tags,
|
4328
5251
|
:discovery_config,
|
4329
|
-
:applications
|
5252
|
+
:applications,
|
5253
|
+
:profiles,
|
5254
|
+
:prioritized_risk_counts)
|
4330
5255
|
SENSITIVE = []
|
4331
5256
|
include Aws::Structure
|
4332
5257
|
end
|
@@ -4354,10 +5279,29 @@ module Aws::WellArchitected
|
|
4354
5279
|
include Aws::Structure
|
4355
5280
|
end
|
4356
5281
|
|
5282
|
+
# The profile associated with a workload.
|
5283
|
+
#
|
5284
|
+
# @!attribute [rw] profile_arn
|
5285
|
+
# The profile ARN.
|
5286
|
+
# @return [String]
|
5287
|
+
#
|
5288
|
+
# @!attribute [rw] profile_version
|
5289
|
+
# The profile version.
|
5290
|
+
# @return [String]
|
5291
|
+
#
|
5292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/WorkloadProfile AWS API Documentation
|
5293
|
+
#
|
5294
|
+
class WorkloadProfile < Struct.new(
|
5295
|
+
:profile_arn,
|
5296
|
+
:profile_version)
|
5297
|
+
SENSITIVE = []
|
5298
|
+
include Aws::Structure
|
5299
|
+
end
|
5300
|
+
|
4357
5301
|
# A workload share return object.
|
4358
5302
|
#
|
4359
5303
|
# @!attribute [rw] share_id
|
4360
|
-
# The ID associated with the
|
5304
|
+
# The ID associated with the share.
|
4361
5305
|
# @return [String]
|
4362
5306
|
#
|
4363
5307
|
# @!attribute [rw] shared_by
|
@@ -4366,15 +5310,16 @@ module Aws::WellArchitected
|
|
4366
5310
|
#
|
4367
5311
|
# @!attribute [rw] shared_with
|
4368
5312
|
# The Amazon Web Services account ID, IAM role, organization ID, or
|
4369
|
-
# organizational unit (OU) ID with which the workload
|
5313
|
+
# organizational unit (OU) ID with which the workload, lens, or
|
5314
|
+
# profile is shared.
|
4370
5315
|
# @return [String]
|
4371
5316
|
#
|
4372
5317
|
# @!attribute [rw] permission_type
|
4373
|
-
# Permission granted on a
|
5318
|
+
# Permission granted on a share request.
|
4374
5319
|
# @return [String]
|
4375
5320
|
#
|
4376
5321
|
# @!attribute [rw] status
|
4377
|
-
# The status of
|
5322
|
+
# The status of the share request.
|
4378
5323
|
# @return [String]
|
4379
5324
|
#
|
4380
5325
|
# @!attribute [rw] workload_name
|
@@ -4407,20 +5352,21 @@ module Aws::WellArchitected
|
|
4407
5352
|
# A workload share summary return object.
|
4408
5353
|
#
|
4409
5354
|
# @!attribute [rw] share_id
|
4410
|
-
# The ID associated with the
|
5355
|
+
# The ID associated with the share.
|
4411
5356
|
# @return [String]
|
4412
5357
|
#
|
4413
5358
|
# @!attribute [rw] shared_with
|
4414
5359
|
# The Amazon Web Services account ID, IAM role, organization ID, or
|
4415
|
-
# organizational unit (OU) ID with which the workload
|
5360
|
+
# organizational unit (OU) ID with which the workload, lens, or
|
5361
|
+
# profile is shared.
|
4416
5362
|
# @return [String]
|
4417
5363
|
#
|
4418
5364
|
# @!attribute [rw] permission_type
|
4419
|
-
# Permission granted on a
|
5365
|
+
# Permission granted on a share request.
|
4420
5366
|
# @return [String]
|
4421
5367
|
#
|
4422
5368
|
# @!attribute [rw] status
|
4423
|
-
# The status of
|
5369
|
+
# The status of the share request.
|
4424
5370
|
# @return [String]
|
4425
5371
|
#
|
4426
5372
|
# @!attribute [rw] status_message
|
@@ -4480,6 +5426,15 @@ module Aws::WellArchitected
|
|
4480
5426
|
# The improvement status for a workload.
|
4481
5427
|
# @return [String]
|
4482
5428
|
#
|
5429
|
+
# @!attribute [rw] profiles
|
5430
|
+
# Profile associated with a workload.
|
5431
|
+
# @return [Array<Types::WorkloadProfile>]
|
5432
|
+
#
|
5433
|
+
# @!attribute [rw] prioritized_risk_counts
|
5434
|
+
# A map from risk names to the count of how many questions have that
|
5435
|
+
# rating.
|
5436
|
+
# @return [Hash<String,Integer>]
|
5437
|
+
#
|
4483
5438
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/WorkloadSummary AWS API Documentation
|
4484
5439
|
#
|
4485
5440
|
class WorkloadSummary < Struct.new(
|
@@ -4490,7 +5445,9 @@ module Aws::WellArchitected
|
|
4490
5445
|
:updated_at,
|
4491
5446
|
:lenses,
|
4492
5447
|
:risk_counts,
|
4493
|
-
:improvement_status
|
5448
|
+
:improvement_status,
|
5449
|
+
:profiles,
|
5450
|
+
:prioritized_risk_counts)
|
4494
5451
|
SENSITIVE = []
|
4495
5452
|
include Aws::Structure
|
4496
5453
|
end
|