aws-sdk-wellarchitected 1.18.0 → 1.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -190,14 +190,6 @@ module Aws::WellArchitected
190
190
 
191
191
  # Input to associate lens reviews.
192
192
  #
193
- # @note When making an API call, you may pass AssociateLensesInput
194
- # data as a hash:
195
- #
196
- # {
197
- # workload_id: "WorkloadId", # required
198
- # lens_aliases: ["LensAlias"], # required
199
- # }
200
- #
201
193
  # @!attribute [rw] workload_id
202
194
  # The ID assigned to the workload. This ID is unique within an Amazon
203
195
  # Web Services Region.
@@ -219,6 +211,149 @@ module Aws::WellArchitected
219
211
  include Aws::Structure
220
212
  end
221
213
 
214
+ # Account details for a Well-Architected best practice in relation to
215
+ # Trusted Advisor checks.
216
+ #
217
+ # @!attribute [rw] id
218
+ # Trusted Advisor check ID.
219
+ # @return [String]
220
+ #
221
+ # @!attribute [rw] name
222
+ # Trusted Advisor check name.
223
+ # @return [String]
224
+ #
225
+ # @!attribute [rw] description
226
+ # Trusted Advisor check description.
227
+ # @return [String]
228
+ #
229
+ # @!attribute [rw] provider
230
+ # Provider of the check related to the best practice.
231
+ # @return [String]
232
+ #
233
+ # @!attribute [rw] lens_arn
234
+ # Well-Architected Lens ARN associated to the check.
235
+ # @return [String]
236
+ #
237
+ # @!attribute [rw] pillar_id
238
+ # The ID used to identify a pillar, for example, `security`.
239
+ #
240
+ # A pillar is identified by its PillarReviewSummary$PillarId.
241
+ # @return [String]
242
+ #
243
+ # @!attribute [rw] question_id
244
+ # The ID of the question.
245
+ # @return [String]
246
+ #
247
+ # @!attribute [rw] choice_id
248
+ # The ID of a choice.
249
+ # @return [String]
250
+ #
251
+ # @!attribute [rw] status
252
+ # Status associated to the check.
253
+ # @return [String]
254
+ #
255
+ # @!attribute [rw] account_id
256
+ # An Amazon Web Services account ID.
257
+ # @return [String]
258
+ #
259
+ # @!attribute [rw] flagged_resources
260
+ # Count of flagged resources associated to the check.
261
+ # @return [Integer]
262
+ #
263
+ # @!attribute [rw] reason
264
+ # Reason associated to the check.
265
+ # @return [String]
266
+ #
267
+ # @!attribute [rw] updated_at
268
+ # The date and time recorded.
269
+ # @return [Time]
270
+ #
271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CheckDetail AWS API Documentation
272
+ #
273
+ class CheckDetail < Struct.new(
274
+ :id,
275
+ :name,
276
+ :description,
277
+ :provider,
278
+ :lens_arn,
279
+ :pillar_id,
280
+ :question_id,
281
+ :choice_id,
282
+ :status,
283
+ :account_id,
284
+ :flagged_resources,
285
+ :reason,
286
+ :updated_at)
287
+ SENSITIVE = []
288
+ include Aws::Structure
289
+ end
290
+
291
+ # Trusted Advisor check summary.
292
+ #
293
+ # @!attribute [rw] id
294
+ # Trusted Advisor check ID.
295
+ # @return [String]
296
+ #
297
+ # @!attribute [rw] name
298
+ # Trusted Advisor check name.
299
+ # @return [String]
300
+ #
301
+ # @!attribute [rw] provider
302
+ # Provider of the check related to the best practice.
303
+ # @return [String]
304
+ #
305
+ # @!attribute [rw] description
306
+ # Trusted Advisor check description.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] updated_at
310
+ # The date and time recorded.
311
+ # @return [Time]
312
+ #
313
+ # @!attribute [rw] lens_arn
314
+ # Well-Architected Lens ARN associated to the check.
315
+ # @return [String]
316
+ #
317
+ # @!attribute [rw] pillar_id
318
+ # The ID used to identify a pillar, for example, `security`.
319
+ #
320
+ # A pillar is identified by its PillarReviewSummary$PillarId.
321
+ # @return [String]
322
+ #
323
+ # @!attribute [rw] question_id
324
+ # The ID of the question.
325
+ # @return [String]
326
+ #
327
+ # @!attribute [rw] choice_id
328
+ # The ID of a choice.
329
+ # @return [String]
330
+ #
331
+ # @!attribute [rw] status
332
+ # Status associated to the check.
333
+ # @return [String]
334
+ #
335
+ # @!attribute [rw] account_summary
336
+ # Account summary associated to the check.
337
+ # @return [Hash<String,Integer>]
338
+ #
339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CheckSummary AWS API Documentation
340
+ #
341
+ class CheckSummary < Struct.new(
342
+ :id,
343
+ :name,
344
+ :provider,
345
+ :description,
346
+ :updated_at,
347
+ :lens_arn,
348
+ :pillar_id,
349
+ :question_id,
350
+ :choice_id,
351
+ :status,
352
+ :account_summary)
353
+ SENSITIVE = []
354
+ include Aws::Structure
355
+ end
356
+
222
357
  # A choice available to answer question.
223
358
  #
224
359
  # @!attribute [rw] choice_id
@@ -363,15 +498,6 @@ module Aws::WellArchitected
363
498
 
364
499
  # A list of choices to be updated.
365
500
  #
366
- # @note When making an API call, you may pass ChoiceUpdate
367
- # data as a hash:
368
- #
369
- # {
370
- # status: "SELECTED", # required, accepts SELECTED, NOT_APPLICABLE, UNSELECTED
371
- # reason: "OUT_OF_SCOPE", # accepts OUT_OF_SCOPE, BUSINESS_PRIORITIES, ARCHITECTURE_CONSTRAINTS, OTHER, NONE
372
- # notes: "ChoiceNotes",
373
- # }
374
- #
375
501
  # @!attribute [rw] status
376
502
  # The status of a choice.
377
503
  # @return [String]
@@ -419,15 +545,6 @@ module Aws::WellArchitected
419
545
  include Aws::Structure
420
546
  end
421
547
 
422
- # @note When making an API call, you may pass CreateLensShareInput
423
- # data as a hash:
424
- #
425
- # {
426
- # lens_alias: "LensAlias", # required
427
- # shared_with: "SharedWith", # required
428
- # client_request_token: "ClientRequestToken", # required
429
- # }
430
- #
431
548
  # @!attribute [rw] lens_alias
432
549
  # The alias of the lens.
433
550
  #
@@ -442,8 +559,8 @@ module Aws::WellArchitected
442
559
  # @return [String]
443
560
  #
444
561
  # @!attribute [rw] shared_with
445
- # The Amazon Web Services account ID or IAM role with which the
446
- # workload is shared.
562
+ # The Amazon Web Services account ID, IAM role, organization ID, or
563
+ # organizational unit (OU) ID with which the workload is shared.
447
564
  # @return [String]
448
565
  #
449
566
  # @!attribute [rw] client_request_token
@@ -486,16 +603,6 @@ module Aws::WellArchitected
486
603
  include Aws::Structure
487
604
  end
488
605
 
489
- # @note When making an API call, you may pass CreateLensVersionInput
490
- # data as a hash:
491
- #
492
- # {
493
- # lens_alias: "LensAlias", # required
494
- # lens_version: "LensVersion", # required
495
- # is_major_version: false,
496
- # client_request_token: "ClientRequestToken", # required
497
- # }
498
- #
499
606
  # @!attribute [rw] lens_alias
500
607
  # The alias of the lens.
501
608
  #
@@ -565,15 +672,6 @@ module Aws::WellArchitected
565
672
 
566
673
  # Input for milestone creation.
567
674
  #
568
- # @note When making an API call, you may pass CreateMilestoneInput
569
- # data as a hash:
570
- #
571
- # {
572
- # workload_id: "WorkloadId", # required
573
- # milestone_name: "MilestoneName", # required
574
- # client_request_token: "ClientRequestToken", # required
575
- # }
576
- #
577
675
  # @!attribute [rw] workload_id
578
676
  # The ID assigned to the workload. This ID is unique within an Amazon
579
677
  # Web Services Region.
@@ -637,29 +735,6 @@ module Aws::WellArchitected
637
735
 
638
736
  # Input for workload creation.
639
737
  #
640
- # @note When making an API call, you may pass CreateWorkloadInput
641
- # data as a hash:
642
- #
643
- # {
644
- # workload_name: "WorkloadName", # required
645
- # description: "WorkloadDescription", # required
646
- # environment: "PRODUCTION", # required, accepts PRODUCTION, PREPRODUCTION
647
- # account_ids: ["AwsAccountId"],
648
- # aws_regions: ["AwsRegion"],
649
- # non_aws_regions: ["WorkloadNonAwsRegion"],
650
- # pillar_priorities: ["PillarId"],
651
- # architectural_design: "WorkloadArchitecturalDesign",
652
- # review_owner: "WorkloadReviewOwner",
653
- # industry_type: "WorkloadIndustryType",
654
- # industry: "WorkloadIndustry",
655
- # lenses: ["LensAlias"], # required
656
- # notes: "Notes",
657
- # client_request_token: "ClientRequestToken", # required
658
- # tags: {
659
- # "TagKey" => "TagValue",
660
- # },
661
- # }
662
- #
663
738
  # @!attribute [rw] workload_name
664
739
  # The name of the workload.
665
740
  #
@@ -802,6 +877,15 @@ module Aws::WellArchitected
802
877
  # The tags to be associated with the workload.
803
878
  # @return [Hash<String,String>]
804
879
  #
880
+ # @!attribute [rw] discovery_config
881
+ # Well-Architected discovery configuration settings associated to the
882
+ # workload.
883
+ # @return [Types::WorkloadDiscoveryConfig]
884
+ #
885
+ # @!attribute [rw] applications
886
+ # List of AppRegistry application ARNs associated to the workload.
887
+ # @return [Array<String>]
888
+ #
805
889
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadInput AWS API Documentation
806
890
  #
807
891
  class CreateWorkloadInput < Struct.new(
@@ -819,7 +903,9 @@ module Aws::WellArchitected
819
903
  :lenses,
820
904
  :notes,
821
905
  :client_request_token,
822
- :tags)
906
+ :tags,
907
+ :discovery_config,
908
+ :applications)
823
909
  SENSITIVE = []
824
910
  include Aws::Structure
825
911
  end
@@ -846,24 +932,14 @@ module Aws::WellArchitected
846
932
 
847
933
  # Input for Create Workload Share
848
934
  #
849
- # @note When making an API call, you may pass CreateWorkloadShareInput
850
- # data as a hash:
851
- #
852
- # {
853
- # workload_id: "WorkloadId", # required
854
- # shared_with: "SharedWith", # required
855
- # permission_type: "READONLY", # required, accepts READONLY, CONTRIBUTOR
856
- # client_request_token: "ClientRequestToken", # required
857
- # }
858
- #
859
935
  # @!attribute [rw] workload_id
860
936
  # The ID assigned to the workload. This ID is unique within an Amazon
861
937
  # Web Services Region.
862
938
  # @return [String]
863
939
  #
864
940
  # @!attribute [rw] shared_with
865
- # The Amazon Web Services account ID or IAM role with which the
866
- # workload is shared.
941
+ # The Amazon Web Services account ID, IAM role, organization ID, or
942
+ # organizational unit (OU) ID with which the workload is shared.
867
943
  # @return [String]
868
944
  #
869
945
  # @!attribute [rw] permission_type
@@ -919,15 +995,6 @@ module Aws::WellArchitected
919
995
  include Aws::Structure
920
996
  end
921
997
 
922
- # @note When making an API call, you may pass DeleteLensInput
923
- # data as a hash:
924
- #
925
- # {
926
- # lens_alias: "LensAlias", # required
927
- # client_request_token: "ClientRequestToken", # required
928
- # lens_status: "ALL", # required, accepts ALL, DRAFT, PUBLISHED
929
- # }
930
- #
931
998
  # @!attribute [rw] lens_alias
932
999
  # The alias of the lens.
933
1000
  #
@@ -973,15 +1040,6 @@ module Aws::WellArchitected
973
1040
  include Aws::Structure
974
1041
  end
975
1042
 
976
- # @note When making an API call, you may pass DeleteLensShareInput
977
- # data as a hash:
978
- #
979
- # {
980
- # share_id: "ShareId", # required
981
- # lens_alias: "LensAlias", # required
982
- # client_request_token: "ClientRequestToken", # required
983
- # }
984
- #
985
1043
  # @!attribute [rw] share_id
986
1044
  # The ID associated with the workload share.
987
1045
  # @return [String]
@@ -1029,14 +1087,6 @@ module Aws::WellArchitected
1029
1087
 
1030
1088
  # Input for workload deletion.
1031
1089
  #
1032
- # @note When making an API call, you may pass DeleteWorkloadInput
1033
- # data as a hash:
1034
- #
1035
- # {
1036
- # workload_id: "WorkloadId", # required
1037
- # client_request_token: "ClientRequestToken", # required
1038
- # }
1039
- #
1040
1090
  # @!attribute [rw] workload_id
1041
1091
  # The ID assigned to the workload. This ID is unique within an Amazon
1042
1092
  # Web Services Region.
@@ -1071,15 +1121,6 @@ module Aws::WellArchitected
1071
1121
 
1072
1122
  # Input for Delete Workload Share
1073
1123
  #
1074
- # @note When making an API call, you may pass DeleteWorkloadShareInput
1075
- # data as a hash:
1076
- #
1077
- # {
1078
- # share_id: "ShareId", # required
1079
- # workload_id: "WorkloadId", # required
1080
- # client_request_token: "ClientRequestToken", # required
1081
- # }
1082
- #
1083
1124
  # @!attribute [rw] share_id
1084
1125
  # The ID associated with the workload share.
1085
1126
  # @return [String]
@@ -1119,14 +1160,6 @@ module Aws::WellArchitected
1119
1160
 
1120
1161
  # Input to disassociate lens reviews.
1121
1162
  #
1122
- # @note When making an API call, you may pass DisassociateLensesInput
1123
- # data as a hash:
1124
- #
1125
- # {
1126
- # workload_id: "WorkloadId", # required
1127
- # lens_aliases: ["LensAlias"], # required
1128
- # }
1129
- #
1130
1163
  # @!attribute [rw] workload_id
1131
1164
  # The ID assigned to the workload. This ID is unique within an Amazon
1132
1165
  # Web Services Region.
@@ -1148,14 +1181,6 @@ module Aws::WellArchitected
1148
1181
  include Aws::Structure
1149
1182
  end
1150
1183
 
1151
- # @note When making an API call, you may pass ExportLensInput
1152
- # data as a hash:
1153
- #
1154
- # {
1155
- # lens_alias: "LensAlias", # required
1156
- # lens_version: "LensVersion",
1157
- # }
1158
- #
1159
1184
  # @!attribute [rw] lens_alias
1160
1185
  # The alias of the lens.
1161
1186
  #
@@ -1196,16 +1221,6 @@ module Aws::WellArchitected
1196
1221
 
1197
1222
  # Input to get answer.
1198
1223
  #
1199
- # @note When making an API call, you may pass GetAnswerInput
1200
- # data as a hash:
1201
- #
1202
- # {
1203
- # workload_id: "WorkloadId", # required
1204
- # lens_alias: "LensAlias", # required
1205
- # question_id: "QuestionId", # required
1206
- # milestone_number: 1,
1207
- # }
1208
- #
1209
1224
  # @!attribute [rw] workload_id
1210
1225
  # The ID assigned to the workload. This ID is unique within an Amazon
1211
1226
  # Web Services Region.
@@ -1291,14 +1306,6 @@ module Aws::WellArchitected
1291
1306
  include Aws::Structure
1292
1307
  end
1293
1308
 
1294
- # @note When making an API call, you may pass GetLensInput
1295
- # data as a hash:
1296
- #
1297
- # {
1298
- # lens_alias: "LensAlias", # required
1299
- # lens_version: "LensVersion",
1300
- # }
1301
- #
1302
1309
  # @!attribute [rw] lens_alias
1303
1310
  # The alias of the lens.
1304
1311
  #
@@ -1339,15 +1346,6 @@ module Aws::WellArchitected
1339
1346
 
1340
1347
  # Input to get lens review.
1341
1348
  #
1342
- # @note When making an API call, you may pass GetLensReviewInput
1343
- # data as a hash:
1344
- #
1345
- # {
1346
- # workload_id: "WorkloadId", # required
1347
- # lens_alias: "LensAlias", # required
1348
- # milestone_number: 1,
1349
- # }
1350
- #
1351
1349
  # @!attribute [rw] workload_id
1352
1350
  # The ID assigned to the workload. This ID is unique within an Amazon
1353
1351
  # Web Services Region.
@@ -1411,15 +1409,6 @@ module Aws::WellArchitected
1411
1409
 
1412
1410
  # Input to get lens review report.
1413
1411
  #
1414
- # @note When making an API call, you may pass GetLensReviewReportInput
1415
- # data as a hash:
1416
- #
1417
- # {
1418
- # workload_id: "WorkloadId", # required
1419
- # lens_alias: "LensAlias", # required
1420
- # milestone_number: 1,
1421
- # }
1422
- #
1423
1412
  # @!attribute [rw] workload_id
1424
1413
  # The ID assigned to the workload. This ID is unique within an Amazon
1425
1414
  # Web Services Region.
@@ -1481,15 +1470,6 @@ module Aws::WellArchitected
1481
1470
  include Aws::Structure
1482
1471
  end
1483
1472
 
1484
- # @note When making an API call, you may pass GetLensVersionDifferenceInput
1485
- # data as a hash:
1486
- #
1487
- # {
1488
- # lens_alias: "LensAlias", # required
1489
- # base_lens_version: "LensVersion",
1490
- # target_lens_version: "LensVersion",
1491
- # }
1492
- #
1493
1473
  # @!attribute [rw] lens_alias
1494
1474
  # The alias of the lens.
1495
1475
  #
@@ -1569,14 +1549,6 @@ module Aws::WellArchitected
1569
1549
 
1570
1550
  # Input to get a milestone.
1571
1551
  #
1572
- # @note When making an API call, you may pass GetMilestoneInput
1573
- # data as a hash:
1574
- #
1575
- # {
1576
- # workload_id: "WorkloadId", # required
1577
- # milestone_number: 1, # required
1578
- # }
1579
- #
1580
1552
  # @!attribute [rw] workload_id
1581
1553
  # The ID assigned to the workload. This ID is unique within an Amazon
1582
1554
  # Web Services Region.
@@ -1619,13 +1591,6 @@ module Aws::WellArchitected
1619
1591
 
1620
1592
  # Input to get a workload.
1621
1593
  #
1622
- # @note When making an API call, you may pass GetWorkloadInput
1623
- # data as a hash:
1624
- #
1625
- # {
1626
- # workload_id: "WorkloadId", # required
1627
- # }
1628
- #
1629
1594
  # @!attribute [rw] workload_id
1630
1595
  # The ID assigned to the workload. This ID is unique within an Amazon
1631
1596
  # Web Services Region.
@@ -1653,18 +1618,6 @@ module Aws::WellArchitected
1653
1618
  include Aws::Structure
1654
1619
  end
1655
1620
 
1656
- # @note When making an API call, you may pass ImportLensInput
1657
- # data as a hash:
1658
- #
1659
- # {
1660
- # lens_alias: "LensAlias",
1661
- # json_string: "LensJSON", # required
1662
- # client_request_token: "ClientRequestToken", # required
1663
- # tags: {
1664
- # "TagKey" => "TagValue",
1665
- # },
1666
- # }
1667
- #
1668
1621
  # @!attribute [rw] lens_alias
1669
1622
  # The alias of the lens.
1670
1623
  #
@@ -1998,8 +1951,8 @@ module Aws::WellArchitected
1998
1951
  # @return [String]
1999
1952
  #
2000
1953
  # @!attribute [rw] shared_with
2001
- # The Amazon Web Services account ID or IAM role with which the
2002
- # workload is shared.
1954
+ # The Amazon Web Services account ID, IAM role, organization ID, or
1955
+ # organizational unit (OU) ID with which the workload is shared.
2003
1956
  # @return [String]
2004
1957
  #
2005
1958
  # @!attribute [rw] status
@@ -2144,18 +2097,6 @@ module Aws::WellArchitected
2144
2097
 
2145
2098
  # Input to list answers.
2146
2099
  #
2147
- # @note When making an API call, you may pass ListAnswersInput
2148
- # data as a hash:
2149
- #
2150
- # {
2151
- # workload_id: "WorkloadId", # required
2152
- # lens_alias: "LensAlias", # required
2153
- # pillar_id: "PillarId",
2154
- # milestone_number: 1,
2155
- # next_token: "NextToken",
2156
- # max_results: 1,
2157
- # }
2158
- #
2159
2100
  # @!attribute [rw] workload_id
2160
2101
  # The ID assigned to the workload. This ID is unique within an Amazon
2161
2102
  # Web Services Region.
@@ -2258,19 +2199,133 @@ module Aws::WellArchitected
2258
2199
  include Aws::Structure
2259
2200
  end
2260
2201
 
2261
- # Input to list lens review improvements.
2202
+ # @!attribute [rw] workload_id
2203
+ # The ID assigned to the workload. This ID is unique within an Amazon
2204
+ # Web Services Region.
2205
+ # @return [String]
2206
+ #
2207
+ # @!attribute [rw] next_token
2208
+ # The token to use to retrieve the next set of results.
2209
+ # @return [String]
2210
+ #
2211
+ # @!attribute [rw] max_results
2212
+ # The maximum number of results to return for this request.
2213
+ # @return [Integer]
2214
+ #
2215
+ # @!attribute [rw] lens_arn
2216
+ # Well-Architected Lens ARN.
2217
+ # @return [String]
2218
+ #
2219
+ # @!attribute [rw] pillar_id
2220
+ # The ID used to identify a pillar, for example, `security`.
2221
+ #
2222
+ # A pillar is identified by its PillarReviewSummary$PillarId.
2223
+ # @return [String]
2224
+ #
2225
+ # @!attribute [rw] question_id
2226
+ # The ID of the question.
2227
+ # @return [String]
2228
+ #
2229
+ # @!attribute [rw] choice_id
2230
+ # The ID of a choice.
2231
+ # @return [String]
2232
+ #
2233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListCheckDetailsInput AWS API Documentation
2234
+ #
2235
+ class ListCheckDetailsInput < Struct.new(
2236
+ :workload_id,
2237
+ :next_token,
2238
+ :max_results,
2239
+ :lens_arn,
2240
+ :pillar_id,
2241
+ :question_id,
2242
+ :choice_id)
2243
+ SENSITIVE = []
2244
+ include Aws::Structure
2245
+ end
2246
+
2247
+ # @!attribute [rw] check_details
2248
+ # The details about the Trusted Advisor checks related to the
2249
+ # Well-Architected best practice.
2250
+ # @return [Array<Types::CheckDetail>]
2251
+ #
2252
+ # @!attribute [rw] next_token
2253
+ # The token to use to retrieve the next set of results.
2254
+ # @return [String]
2255
+ #
2256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListCheckDetailsOutput AWS API Documentation
2257
+ #
2258
+ class ListCheckDetailsOutput < Struct.new(
2259
+ :check_details,
2260
+ :next_token)
2261
+ SENSITIVE = []
2262
+ include Aws::Structure
2263
+ end
2264
+
2265
+ # @!attribute [rw] workload_id
2266
+ # The ID assigned to the workload. This ID is unique within an Amazon
2267
+ # Web Services Region.
2268
+ # @return [String]
2269
+ #
2270
+ # @!attribute [rw] next_token
2271
+ # The token to use to retrieve the next set of results.
2272
+ # @return [String]
2273
+ #
2274
+ # @!attribute [rw] max_results
2275
+ # The maximum number of results to return for this request.
2276
+ # @return [Integer]
2277
+ #
2278
+ # @!attribute [rw] lens_arn
2279
+ # Well-Architected Lens ARN.
2280
+ # @return [String]
2281
+ #
2282
+ # @!attribute [rw] pillar_id
2283
+ # The ID used to identify a pillar, for example, `security`.
2284
+ #
2285
+ # A pillar is identified by its PillarReviewSummary$PillarId.
2286
+ # @return [String]
2287
+ #
2288
+ # @!attribute [rw] question_id
2289
+ # The ID of the question.
2290
+ # @return [String]
2291
+ #
2292
+ # @!attribute [rw] choice_id
2293
+ # The ID of a choice.
2294
+ # @return [String]
2295
+ #
2296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListCheckSummariesInput AWS API Documentation
2297
+ #
2298
+ class ListCheckSummariesInput < Struct.new(
2299
+ :workload_id,
2300
+ :next_token,
2301
+ :max_results,
2302
+ :lens_arn,
2303
+ :pillar_id,
2304
+ :question_id,
2305
+ :choice_id)
2306
+ SENSITIVE = []
2307
+ include Aws::Structure
2308
+ end
2309
+
2310
+ # @!attribute [rw] check_summaries
2311
+ # List of Trusted Advisor summaries related to the Well-Architected
2312
+ # best practice.
2313
+ # @return [Array<Types::CheckSummary>]
2262
2314
  #
2263
- # @note When making an API call, you may pass ListLensReviewImprovementsInput
2264
- # data as a hash:
2315
+ # @!attribute [rw] next_token
2316
+ # The token to use to retrieve the next set of results.
2317
+ # @return [String]
2265
2318
  #
2266
- # {
2267
- # workload_id: "WorkloadId", # required
2268
- # lens_alias: "LensAlias", # required
2269
- # pillar_id: "PillarId",
2270
- # milestone_number: 1,
2271
- # next_token: "NextToken",
2272
- # max_results: 1,
2273
- # }
2319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListCheckSummariesOutput AWS API Documentation
2320
+ #
2321
+ class ListCheckSummariesOutput < Struct.new(
2322
+ :check_summaries,
2323
+ :next_token)
2324
+ SENSITIVE = []
2325
+ include Aws::Structure
2326
+ end
2327
+
2328
+ # Input to list lens review improvements.
2274
2329
  #
2275
2330
  # @!attribute [rw] workload_id
2276
2331
  # The ID assigned to the workload. This ID is unique within an Amazon
@@ -2376,16 +2431,6 @@ module Aws::WellArchitected
2376
2431
 
2377
2432
  # Input to list lens reviews.
2378
2433
  #
2379
- # @note When making an API call, you may pass ListLensReviewsInput
2380
- # data as a hash:
2381
- #
2382
- # {
2383
- # workload_id: "WorkloadId", # required
2384
- # milestone_number: 1,
2385
- # next_token: "NextToken",
2386
- # max_results: 1,
2387
- # }
2388
- #
2389
2434
  # @!attribute [rw] workload_id
2390
2435
  # The ID assigned to the workload. This ID is unique within an Amazon
2391
2436
  # Web Services Region.
@@ -2448,17 +2493,6 @@ module Aws::WellArchitected
2448
2493
  include Aws::Structure
2449
2494
  end
2450
2495
 
2451
- # @note When making an API call, you may pass ListLensSharesInput
2452
- # data as a hash:
2453
- #
2454
- # {
2455
- # lens_alias: "LensAlias", # required
2456
- # shared_with_prefix: "SharedWithPrefix",
2457
- # next_token: "NextToken",
2458
- # max_results: 1,
2459
- # status: "ACCEPTED", # accepts ACCEPTED, REJECTED, PENDING, REVOKED, EXPIRED, ASSOCIATING, ASSOCIATED, FAILED
2460
- # }
2461
- #
2462
2496
  # @!attribute [rw] lens_alias
2463
2497
  # The alias of the lens.
2464
2498
  #
@@ -2473,8 +2507,8 @@ module Aws::WellArchitected
2473
2507
  # @return [String]
2474
2508
  #
2475
2509
  # @!attribute [rw] shared_with_prefix
2476
- # The Amazon Web Services account ID or IAM role with which the lens
2477
- # is shared.
2510
+ # The Amazon Web Services account ID, IAM role, organization ID, or
2511
+ # organizational unit (OU) ID with which the lens is shared.
2478
2512
  # @return [String]
2479
2513
  #
2480
2514
  # @!attribute [rw] next_token
@@ -2520,17 +2554,6 @@ module Aws::WellArchitected
2520
2554
 
2521
2555
  # Input to list lenses.
2522
2556
  #
2523
- # @note When making an API call, you may pass ListLensesInput
2524
- # data as a hash:
2525
- #
2526
- # {
2527
- # next_token: "NextToken",
2528
- # max_results: 1,
2529
- # lens_type: "AWS_OFFICIAL", # accepts AWS_OFFICIAL, CUSTOM_SHARED, CUSTOM_SELF
2530
- # lens_status: "ALL", # accepts ALL, DRAFT, PUBLISHED
2531
- # lens_name: "LensName",
2532
- # }
2533
- #
2534
2557
  # @!attribute [rw] next_token
2535
2558
  # The token to use to retrieve the next set of results.
2536
2559
  # @return [String]
@@ -2584,15 +2607,6 @@ module Aws::WellArchitected
2584
2607
 
2585
2608
  # Input to list all milestones for a workload.
2586
2609
  #
2587
- # @note When making an API call, you may pass ListMilestonesInput
2588
- # data as a hash:
2589
- #
2590
- # {
2591
- # workload_id: "WorkloadId", # required
2592
- # next_token: "NextToken",
2593
- # max_results: 1,
2594
- # }
2595
- #
2596
2610
  # @!attribute [rw] workload_id
2597
2611
  # The ID assigned to the workload. This ID is unique within an Amazon
2598
2612
  # Web Services Region.
@@ -2641,15 +2655,6 @@ module Aws::WellArchitected
2641
2655
  include Aws::Structure
2642
2656
  end
2643
2657
 
2644
- # @note When making an API call, you may pass ListNotificationsInput
2645
- # data as a hash:
2646
- #
2647
- # {
2648
- # workload_id: "WorkloadId",
2649
- # next_token: "NextToken",
2650
- # max_results: 1,
2651
- # }
2652
- #
2653
2658
  # @!attribute [rw] workload_id
2654
2659
  # The ID assigned to the workload. This ID is unique within an Amazon
2655
2660
  # Web Services Region.
@@ -2692,17 +2697,6 @@ module Aws::WellArchitected
2692
2697
 
2693
2698
  # Input for List Share Invitations
2694
2699
  #
2695
- # @note When making an API call, you may pass ListShareInvitationsInput
2696
- # data as a hash:
2697
- #
2698
- # {
2699
- # workload_name_prefix: "WorkloadNamePrefix",
2700
- # lens_name_prefix: "LensNamePrefix",
2701
- # share_resource_type: "WORKLOAD", # accepts WORKLOAD, LENS
2702
- # next_token: "NextToken",
2703
- # max_results: 1,
2704
- # }
2705
- #
2706
2700
  # @!attribute [rw] workload_name_prefix
2707
2701
  # An optional string added to the beginning of each workload name
2708
2702
  # returned in the results.
@@ -2756,13 +2750,6 @@ module Aws::WellArchitected
2756
2750
  include Aws::Structure
2757
2751
  end
2758
2752
 
2759
- # @note When making an API call, you may pass ListTagsForResourceInput
2760
- # data as a hash:
2761
- #
2762
- # {
2763
- # workload_arn: "WorkloadArn", # required
2764
- # }
2765
- #
2766
2753
  # @!attribute [rw] workload_arn
2767
2754
  # The ARN for the workload.
2768
2755
  # @return [String]
@@ -2789,25 +2776,14 @@ module Aws::WellArchitected
2789
2776
 
2790
2777
  # Input for List Workload Share
2791
2778
  #
2792
- # @note When making an API call, you may pass ListWorkloadSharesInput
2793
- # data as a hash:
2794
- #
2795
- # {
2796
- # workload_id: "WorkloadId", # required
2797
- # shared_with_prefix: "SharedWithPrefix",
2798
- # next_token: "NextToken",
2799
- # max_results: 1,
2800
- # status: "ACCEPTED", # accepts ACCEPTED, REJECTED, PENDING, REVOKED, EXPIRED, ASSOCIATING, ASSOCIATED, FAILED
2801
- # }
2802
- #
2803
2779
  # @!attribute [rw] workload_id
2804
2780
  # The ID assigned to the workload. This ID is unique within an Amazon
2805
2781
  # Web Services Region.
2806
2782
  # @return [String]
2807
2783
  #
2808
2784
  # @!attribute [rw] shared_with_prefix
2809
- # The Amazon Web Services account ID or IAM role with which the
2810
- # workload is shared.
2785
+ # The Amazon Web Services account ID, IAM role, organization ID, or
2786
+ # organizational unit (OU) ID with which the workload is shared.
2811
2787
  # @return [String]
2812
2788
  #
2813
2789
  # @!attribute [rw] next_token
@@ -2861,15 +2837,6 @@ module Aws::WellArchitected
2861
2837
 
2862
2838
  # Input to list all workloads.
2863
2839
  #
2864
- # @note When making an API call, you may pass ListWorkloadsInput
2865
- # data as a hash:
2866
- #
2867
- # {
2868
- # workload_name_prefix: "WorkloadNamePrefix",
2869
- # next_token: "NextToken",
2870
- # max_results: 1,
2871
- # }
2872
- #
2873
2840
  # @!attribute [rw] workload_name_prefix
2874
2841
  # An optional string added to the beginning of each workload name
2875
2842
  # returned in the results.
@@ -3197,8 +3164,8 @@ module Aws::WellArchitected
3197
3164
  # @return [String]
3198
3165
  #
3199
3166
  # @!attribute [rw] shared_with
3200
- # The Amazon Web Services account ID or IAM role with which the
3201
- # workload is shared.
3167
+ # The Amazon Web Services account ID, IAM role, organization ID, or
3168
+ # organizational unit (OU) ID with which the workload is shared.
3202
3169
  # @return [String]
3203
3170
  #
3204
3171
  # @!attribute [rw] permission_type
@@ -3246,16 +3213,6 @@ module Aws::WellArchitected
3246
3213
  include Aws::Structure
3247
3214
  end
3248
3215
 
3249
- # @note When making an API call, you may pass TagResourceInput
3250
- # data as a hash:
3251
- #
3252
- # {
3253
- # workload_arn: "WorkloadArn", # required
3254
- # tags: { # required
3255
- # "TagKey" => "TagValue",
3256
- # },
3257
- # }
3258
- #
3259
3216
  # @!attribute [rw] workload_arn
3260
3217
  # The ARN for the workload.
3261
3218
  # @return [String]
@@ -3301,14 +3258,6 @@ module Aws::WellArchitected
3301
3258
  include Aws::Structure
3302
3259
  end
3303
3260
 
3304
- # @note When making an API call, you may pass UntagResourceInput
3305
- # data as a hash:
3306
- #
3307
- # {
3308
- # workload_arn: "WorkloadArn", # required
3309
- # tag_keys: ["TagKey"], # required
3310
- # }
3311
- #
3312
3261
  # @!attribute [rw] workload_arn
3313
3262
  # The ARN for the workload.
3314
3263
  # @return [String]
@@ -3333,26 +3282,6 @@ module Aws::WellArchitected
3333
3282
 
3334
3283
  # Input to update answer.
3335
3284
  #
3336
- # @note When making an API call, you may pass UpdateAnswerInput
3337
- # data as a hash:
3338
- #
3339
- # {
3340
- # workload_id: "WorkloadId", # required
3341
- # lens_alias: "LensAlias", # required
3342
- # question_id: "QuestionId", # required
3343
- # selected_choices: ["ChoiceId"],
3344
- # choice_updates: {
3345
- # "ChoiceId" => {
3346
- # status: "SELECTED", # required, accepts SELECTED, NOT_APPLICABLE, UNSELECTED
3347
- # reason: "OUT_OF_SCOPE", # accepts OUT_OF_SCOPE, BUSINESS_PRIORITIES, ARCHITECTURE_CONSTRAINTS, OTHER, NONE
3348
- # notes: "ChoiceNotes",
3349
- # },
3350
- # },
3351
- # notes: "Notes",
3352
- # is_applicable: false,
3353
- # reason: "OUT_OF_SCOPE", # accepts OUT_OF_SCOPE, BUSINESS_PRIORITIES, ARCHITECTURE_CONSTRAINTS, OTHER, NONE
3354
- # }
3355
- #
3356
3285
  # @!attribute [rw] workload_id
3357
3286
  # The ID assigned to the workload. This ID is unique within an Amazon
3358
3287
  # Web Services Region.
@@ -3452,13 +3381,6 @@ module Aws::WellArchitected
3452
3381
  include Aws::Structure
3453
3382
  end
3454
3383
 
3455
- # @note When making an API call, you may pass UpdateGlobalSettingsInput
3456
- # data as a hash:
3457
- #
3458
- # {
3459
- # organization_sharing_status: "ENABLED", # accepts ENABLED, DISABLED
3460
- # }
3461
- #
3462
3384
  # @!attribute [rw] organization_sharing_status
3463
3385
  # The status of organization sharing settings.
3464
3386
  # @return [String]
@@ -3473,18 +3395,6 @@ module Aws::WellArchitected
3473
3395
 
3474
3396
  # Input for update lens review.
3475
3397
  #
3476
- # @note When making an API call, you may pass UpdateLensReviewInput
3477
- # data as a hash:
3478
- #
3479
- # {
3480
- # workload_id: "WorkloadId", # required
3481
- # lens_alias: "LensAlias", # required
3482
- # lens_notes: "Notes",
3483
- # pillar_notes: {
3484
- # "PillarId" => "Notes",
3485
- # },
3486
- # }
3487
- #
3488
3398
  # @!attribute [rw] workload_id
3489
3399
  # The ID assigned to the workload. This ID is unique within an Amazon
3490
3400
  # Web Services Region.
@@ -3544,14 +3454,6 @@ module Aws::WellArchitected
3544
3454
 
3545
3455
  # Input for Update Share Invitation
3546
3456
  #
3547
- # @note When making an API call, you may pass UpdateShareInvitationInput
3548
- # data as a hash:
3549
- #
3550
- # {
3551
- # share_invitation_id: "ShareInvitationId", # required
3552
- # share_invitation_action: "ACCEPT", # required, accepts ACCEPT, REJECT
3553
- # }
3554
- #
3555
3457
  # @!attribute [rw] share_invitation_id
3556
3458
  # The ID assigned to the share invitation.
3557
3459
  # @return [String]
@@ -3570,7 +3472,7 @@ module Aws::WellArchitected
3570
3472
  end
3571
3473
 
3572
3474
  # @!attribute [rw] share_invitation
3573
- # The updated workload share invitation.
3475
+ # The updated workload or custom lens share invitation.
3574
3476
  # @return [Types::ShareInvitation]
3575
3477
  #
3576
3478
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitationOutput AWS API Documentation
@@ -3583,27 +3485,6 @@ module Aws::WellArchitected
3583
3485
 
3584
3486
  # Input to update a workload.
3585
3487
  #
3586
- # @note When making an API call, you may pass UpdateWorkloadInput
3587
- # data as a hash:
3588
- #
3589
- # {
3590
- # workload_id: "WorkloadId", # required
3591
- # workload_name: "WorkloadName",
3592
- # description: "WorkloadDescription",
3593
- # environment: "PRODUCTION", # accepts PRODUCTION, PREPRODUCTION
3594
- # account_ids: ["AwsAccountId"],
3595
- # aws_regions: ["AwsRegion"],
3596
- # non_aws_regions: ["WorkloadNonAwsRegion"],
3597
- # pillar_priorities: ["PillarId"],
3598
- # architectural_design: "WorkloadArchitecturalDesign",
3599
- # review_owner: "WorkloadReviewOwner",
3600
- # is_review_owner_update_acknowledged: false,
3601
- # industry_type: "WorkloadIndustryType",
3602
- # industry: "WorkloadIndustry",
3603
- # notes: "Notes",
3604
- # improvement_status: "NOT_APPLICABLE", # accepts NOT_APPLICABLE, NOT_STARTED, IN_PROGRESS, COMPLETE, RISK_ACKNOWLEDGED
3605
- # }
3606
- #
3607
3488
  # @!attribute [rw] workload_id
3608
3489
  # The ID assigned to the workload. This ID is unique within an Amazon
3609
3490
  # Web Services Region.
@@ -3737,6 +3618,15 @@ module Aws::WellArchitected
3737
3618
  # The improvement status for a workload.
3738
3619
  # @return [String]
3739
3620
  #
3621
+ # @!attribute [rw] discovery_config
3622
+ # Well-Architected discovery configuration settings to associate to
3623
+ # the workload.
3624
+ # @return [Types::WorkloadDiscoveryConfig]
3625
+ #
3626
+ # @!attribute [rw] applications
3627
+ # List of AppRegistry application ARNs to associate to the workload.
3628
+ # @return [Array<String>]
3629
+ #
3740
3630
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkloadInput AWS API Documentation
3741
3631
  #
3742
3632
  class UpdateWorkloadInput < Struct.new(
@@ -3754,7 +3644,9 @@ module Aws::WellArchitected
3754
3644
  :industry_type,
3755
3645
  :industry,
3756
3646
  :notes,
3757
- :improvement_status)
3647
+ :improvement_status,
3648
+ :discovery_config,
3649
+ :applications)
3758
3650
  SENSITIVE = []
3759
3651
  include Aws::Structure
3760
3652
  end
@@ -3775,15 +3667,6 @@ module Aws::WellArchitected
3775
3667
 
3776
3668
  # Input for Update Workload Share
3777
3669
  #
3778
- # @note When making an API call, you may pass UpdateWorkloadShareInput
3779
- # data as a hash:
3780
- #
3781
- # {
3782
- # share_id: "ShareId", # required
3783
- # workload_id: "WorkloadId", # required
3784
- # permission_type: "READONLY", # required, accepts READONLY, CONTRIBUTOR
3785
- # }
3786
- #
3787
3670
  # @!attribute [rw] share_id
3788
3671
  # The ID associated with the workload share.
3789
3672
  # @return [String]
@@ -3827,16 +3710,6 @@ module Aws::WellArchitected
3827
3710
  include Aws::Structure
3828
3711
  end
3829
3712
 
3830
- # @note When making an API call, you may pass UpgradeLensReviewInput
3831
- # data as a hash:
3832
- #
3833
- # {
3834
- # workload_id: "WorkloadId", # required
3835
- # lens_alias: "LensAlias", # required
3836
- # milestone_name: "MilestoneName", # required
3837
- # client_request_token: "ClientRequestToken",
3838
- # }
3839
- #
3840
3713
  # @!attribute [rw] workload_id
3841
3714
  # The ID assigned to the workload. This ID is unique within an Amazon
3842
3715
  # Web Services Region.
@@ -4114,6 +3987,14 @@ module Aws::WellArchitected
4114
3987
  # The tags associated with the workload.
4115
3988
  # @return [Hash<String,String>]
4116
3989
  #
3990
+ # @!attribute [rw] discovery_config
3991
+ # Discovery configuration associated to the workload.
3992
+ # @return [Types::WorkloadDiscoveryConfig]
3993
+ #
3994
+ # @!attribute [rw] applications
3995
+ # List of AppRegistry application ARNs associated to the workload.
3996
+ # @return [Array<String>]
3997
+ #
4117
3998
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/Workload AWS API Documentation
4118
3999
  #
4119
4000
  class Workload < Struct.new(
@@ -4139,7 +4020,24 @@ module Aws::WellArchitected
4139
4020
  :lenses,
4140
4021
  :owner,
4141
4022
  :share_invitation_id,
4142
- :tags)
4023
+ :tags,
4024
+ :discovery_config,
4025
+ :applications)
4026
+ SENSITIVE = []
4027
+ include Aws::Structure
4028
+ end
4029
+
4030
+ # Discovery configuration associated to the workload.
4031
+ #
4032
+ # @!attribute [rw] trusted_advisor_integration_status
4033
+ # Discovery integration status in respect to Trusted Advisor for the
4034
+ # workload.
4035
+ # @return [String]
4036
+ #
4037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/WorkloadDiscoveryConfig AWS API Documentation
4038
+ #
4039
+ class WorkloadDiscoveryConfig < Struct.new(
4040
+ :trusted_advisor_integration_status)
4143
4041
  SENSITIVE = []
4144
4042
  include Aws::Structure
4145
4043
  end
@@ -4155,8 +4053,8 @@ module Aws::WellArchitected
4155
4053
  # @return [String]
4156
4054
  #
4157
4055
  # @!attribute [rw] shared_with
4158
- # The Amazon Web Services account ID or IAM role with which the
4159
- # workload is shared.
4056
+ # The Amazon Web Services account ID, IAM role, organization ID, or
4057
+ # organizational unit (OU) ID with which the workload is shared.
4160
4058
  # @return [String]
4161
4059
  #
4162
4060
  # @!attribute [rw] permission_type
@@ -4201,8 +4099,8 @@ module Aws::WellArchitected
4201
4099
  # @return [String]
4202
4100
  #
4203
4101
  # @!attribute [rw] shared_with
4204
- # The Amazon Web Services account ID or IAM role with which the
4205
- # workload is shared.
4102
+ # The Amazon Web Services account ID, IAM role, organization ID, or
4103
+ # organizational unit (OU) ID with which the workload is shared.
4206
4104
  # @return [String]
4207
4105
  #
4208
4106
  # @!attribute [rw] permission_type