aws-sdk-wellarchitected 1.20.0 → 1.22.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-wellarchitected/client.rb +235 -86
- data/lib/aws-sdk-wellarchitected/client_api.rb +94 -0
- data/lib/aws-sdk-wellarchitected/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-wellarchitected/endpoints.rb +14 -0
- data/lib/aws-sdk-wellarchitected/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-wellarchitected/types.rb +413 -101
- data/lib/aws-sdk-wellarchitected.rb +1 -1
- metadata +2 -2
@@ -413,9 +413,18 @@ module Aws::WellArchitected
|
|
413
413
|
# Create a lens share.
|
414
414
|
#
|
415
415
|
# The owner of a lens can share it with other Amazon Web Services
|
416
|
-
# accounts,
|
417
|
-
#
|
418
|
-
#
|
416
|
+
# accounts, users, an organization, and organizational units (OUs) in
|
417
|
+
# the same Amazon Web Services Region. Lenses provided by Amazon Web
|
418
|
+
# Services (Amazon Web Services Official Content) cannot be shared.
|
419
|
+
#
|
420
|
+
# Shared access to a lens is not removed until the lens invitation is
|
421
|
+
# deleted.
|
422
|
+
#
|
423
|
+
# If you share a lens with an organization or OU, all accounts in the
|
424
|
+
# organization or OU are granted access to the lens.
|
425
|
+
#
|
426
|
+
# For more information, see [Sharing a custom lens][1] in the
|
427
|
+
# *Well-Architected Tool User Guide*.
|
419
428
|
#
|
420
429
|
# <note markdown="1"> **Disclaimer**
|
421
430
|
#
|
@@ -428,15 +437,21 @@ module Aws::WellArchitected
|
|
428
437
|
#
|
429
438
|
# </note>
|
430
439
|
#
|
440
|
+
#
|
441
|
+
#
|
442
|
+
# [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-sharing.html
|
443
|
+
#
|
431
444
|
# @option params [required, String] :lens_alias
|
432
445
|
# The alias of the lens.
|
433
446
|
#
|
434
447
|
# For Amazon Web Services official lenses, this is either the lens
|
435
448
|
# alias, such as `serverless`, or the lens ARN, such as
|
436
|
-
# `arn:aws:wellarchitected:us-
|
449
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
450
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
451
|
+
# on Amazon Web Services official lenses.
|
437
452
|
#
|
438
453
|
# For custom lenses, this is the lens ARN, such as
|
439
|
-
# `arn:aws:wellarchitected:us-
|
454
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
440
455
|
#
|
441
456
|
# Each lens is identified by its LensSummary$LensAlias.
|
442
457
|
#
|
@@ -450,8 +465,8 @@ module Aws::WellArchitected
|
|
450
465
|
#
|
451
466
|
# You should not reuse the same token for other requests. If you retry a
|
452
467
|
# request with the same client request token and the same parameters
|
453
|
-
# after
|
454
|
-
# request is returned.
|
468
|
+
# after the original request has completed successfully, the result of
|
469
|
+
# the original request is returned.
|
455
470
|
#
|
456
471
|
# This token is listed as required, however, if you do not specify it,
|
457
472
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -490,9 +505,10 @@ module Aws::WellArchitected
|
|
490
505
|
#
|
491
506
|
# A lens can have up to 100 versions.
|
492
507
|
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
508
|
+
# Use this operation to publish a new lens version after you have
|
509
|
+
# imported a lens. The `LensAlias` is used to identify the lens to be
|
510
|
+
# published. The owner of a lens can share the lens with other Amazon
|
511
|
+
# Web Services accounts and users in the same Amazon Web Services
|
496
512
|
# Region. Only the owner of a lens can delete it.
|
497
513
|
#
|
498
514
|
# @option params [required, String] :lens_alias
|
@@ -500,10 +516,12 @@ module Aws::WellArchitected
|
|
500
516
|
#
|
501
517
|
# For Amazon Web Services official lenses, this is either the lens
|
502
518
|
# alias, such as `serverless`, or the lens ARN, such as
|
503
|
-
# `arn:aws:wellarchitected:us-
|
519
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
520
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
521
|
+
# on Amazon Web Services official lenses.
|
504
522
|
#
|
505
523
|
# For custom lenses, this is the lens ARN, such as
|
506
|
-
# `arn:aws:wellarchitected:us-
|
524
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
507
525
|
#
|
508
526
|
# Each lens is identified by its LensSummary$LensAlias.
|
509
527
|
#
|
@@ -519,8 +537,8 @@ module Aws::WellArchitected
|
|
519
537
|
#
|
520
538
|
# You should not reuse the same token for other requests. If you retry a
|
521
539
|
# request with the same client request token and the same parameters
|
522
|
-
# after
|
523
|
-
# request is returned.
|
540
|
+
# after the original request has completed successfully, the result of
|
541
|
+
# the original request is returned.
|
524
542
|
#
|
525
543
|
# This token is listed as required, however, if you do not specify it,
|
526
544
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -575,8 +593,8 @@ module Aws::WellArchitected
|
|
575
593
|
#
|
576
594
|
# You should not reuse the same token for other requests. If you retry a
|
577
595
|
# request with the same client request token and the same parameters
|
578
|
-
# after
|
579
|
-
# request is returned.
|
596
|
+
# after the original request has completed successfully, the result of
|
597
|
+
# the original request is returned.
|
580
598
|
#
|
581
599
|
# This token is listed as required, however, if you do not specify it,
|
582
600
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -616,13 +634,19 @@ module Aws::WellArchitected
|
|
616
634
|
# Create a new workload.
|
617
635
|
#
|
618
636
|
# The owner of a workload can share the workload with other Amazon Web
|
619
|
-
# Services accounts,
|
620
|
-
#
|
621
|
-
#
|
637
|
+
# Services accounts, users, an organization, and organizational units
|
638
|
+
# (OUs) in the same Amazon Web Services Region. Only the owner of a
|
639
|
+
# workload can delete it.
|
622
640
|
#
|
623
641
|
# For more information, see [Defining a Workload][1] in the
|
624
642
|
# *Well-Architected Tool User Guide*.
|
625
643
|
#
|
644
|
+
# Either `AwsRegions`, `NonAwsRegions`, or both must be specified when
|
645
|
+
# creating a workload.
|
646
|
+
#
|
647
|
+
# You also must specify `ReviewOwner`, even though the parameter is
|
648
|
+
# listed as not being required in the following section.
|
649
|
+
#
|
626
650
|
#
|
627
651
|
#
|
628
652
|
# [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html
|
@@ -740,8 +764,8 @@ module Aws::WellArchitected
|
|
740
764
|
#
|
741
765
|
# You should not reuse the same token for other requests. If you retry a
|
742
766
|
# request with the same client request token and the same parameters
|
743
|
-
# after
|
744
|
-
# request is returned.
|
767
|
+
# after the original request has completed successfully, the result of
|
768
|
+
# the original request is returned.
|
745
769
|
#
|
746
770
|
# This token is listed as required, however, if you do not specify it,
|
747
771
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -788,6 +812,7 @@ module Aws::WellArchitected
|
|
788
812
|
# },
|
789
813
|
# discovery_config: {
|
790
814
|
# trusted_advisor_integration_status: "ENABLED", # accepts ENABLED, DISABLED
|
815
|
+
# workload_resource_definition: ["WORKLOAD_METADATA"], # accepts WORKLOAD_METADATA, APP_REGISTRY
|
791
816
|
# },
|
792
817
|
# applications: ["ApplicationArn"],
|
793
818
|
# })
|
@@ -809,11 +834,14 @@ module Aws::WellArchitected
|
|
809
834
|
# Create a workload share.
|
810
835
|
#
|
811
836
|
# The owner of a workload can share it with other Amazon Web Services
|
812
|
-
# accounts and
|
837
|
+
# accounts and users in the same Amazon Web Services Region. Shared
|
813
838
|
# access to a workload is not removed until the workload invitation is
|
814
839
|
# deleted.
|
815
840
|
#
|
816
|
-
#
|
841
|
+
# If you share a workload with an organization or OU, all accounts in
|
842
|
+
# the organization or OU are granted access to the workload.
|
843
|
+
#
|
844
|
+
# For more information, see [Sharing a workload][1] in the
|
817
845
|
# *Well-Architected Tool User Guide*.
|
818
846
|
#
|
819
847
|
#
|
@@ -837,8 +865,8 @@ module Aws::WellArchitected
|
|
837
865
|
#
|
838
866
|
# You should not reuse the same token for other requests. If you retry a
|
839
867
|
# request with the same client request token and the same parameters
|
840
|
-
# after
|
841
|
-
# request is returned.
|
868
|
+
# after the original request has completed successfully, the result of
|
869
|
+
# the original request is returned.
|
842
870
|
#
|
843
871
|
# This token is listed as required, however, if you do not specify it,
|
844
872
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -879,9 +907,9 @@ module Aws::WellArchitected
|
|
879
907
|
# Delete an existing lens.
|
880
908
|
#
|
881
909
|
# Only the owner of a lens can delete it. After the lens is deleted,
|
882
|
-
# Amazon Web Services accounts and
|
883
|
-
#
|
884
|
-
#
|
910
|
+
# Amazon Web Services accounts and users that you shared the lens with
|
911
|
+
# can continue to use it, but they will no longer be able to apply it to
|
912
|
+
# new workloads.
|
885
913
|
#
|
886
914
|
# <note markdown="1"> **Disclaimer**
|
887
915
|
#
|
@@ -899,10 +927,12 @@ module Aws::WellArchitected
|
|
899
927
|
#
|
900
928
|
# For Amazon Web Services official lenses, this is either the lens
|
901
929
|
# alias, such as `serverless`, or the lens ARN, such as
|
902
|
-
# `arn:aws:wellarchitected:us-
|
930
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
931
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
932
|
+
# on Amazon Web Services official lenses.
|
903
933
|
#
|
904
934
|
# For custom lenses, this is the lens ARN, such as
|
905
|
-
# `arn:aws:wellarchitected:us-
|
935
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
906
936
|
#
|
907
937
|
# Each lens is identified by its LensSummary$LensAlias.
|
908
938
|
#
|
@@ -912,8 +942,8 @@ module Aws::WellArchitected
|
|
912
942
|
#
|
913
943
|
# You should not reuse the same token for other requests. If you retry a
|
914
944
|
# request with the same client request token and the same parameters
|
915
|
-
# after
|
916
|
-
# request is returned.
|
945
|
+
# after the original request has completed successfully, the result of
|
946
|
+
# the original request is returned.
|
917
947
|
#
|
918
948
|
# This token is listed as required, however, if you do not specify it,
|
919
949
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -947,10 +977,10 @@ module Aws::WellArchitected
|
|
947
977
|
|
948
978
|
# Delete a lens share.
|
949
979
|
#
|
950
|
-
# After the lens share is deleted, Amazon Web Services accounts,
|
951
|
-
#
|
952
|
-
#
|
953
|
-
#
|
980
|
+
# After the lens share is deleted, Amazon Web Services accounts, users,
|
981
|
+
# organizations, and organizational units (OUs) that you shared the lens
|
982
|
+
# with can continue to use it, but they will no longer be able to apply
|
983
|
+
# it to new workloads.
|
954
984
|
#
|
955
985
|
# <note markdown="1"> **Disclaimer**
|
956
986
|
#
|
@@ -971,10 +1001,12 @@ module Aws::WellArchitected
|
|
971
1001
|
#
|
972
1002
|
# For Amazon Web Services official lenses, this is either the lens
|
973
1003
|
# alias, such as `serverless`, or the lens ARN, such as
|
974
|
-
# `arn:aws:wellarchitected:us-
|
1004
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1005
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1006
|
+
# on Amazon Web Services official lenses.
|
975
1007
|
#
|
976
1008
|
# For custom lenses, this is the lens ARN, such as
|
977
|
-
# `arn:aws:wellarchitected:us-
|
1009
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
978
1010
|
#
|
979
1011
|
# Each lens is identified by its LensSummary$LensAlias.
|
980
1012
|
#
|
@@ -984,8 +1016,8 @@ module Aws::WellArchitected
|
|
984
1016
|
#
|
985
1017
|
# You should not reuse the same token for other requests. If you retry a
|
986
1018
|
# request with the same client request token and the same parameters
|
987
|
-
# after
|
988
|
-
# request is returned.
|
1019
|
+
# after the original request has completed successfully, the result of
|
1020
|
+
# the original request is returned.
|
989
1021
|
#
|
990
1022
|
# This token is listed as required, however, if you do not specify it,
|
991
1023
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1026,8 +1058,8 @@ module Aws::WellArchitected
|
|
1026
1058
|
#
|
1027
1059
|
# You should not reuse the same token for other requests. If you retry a
|
1028
1060
|
# request with the same client request token and the same parameters
|
1029
|
-
# after
|
1030
|
-
# request is returned.
|
1061
|
+
# after the original request has completed successfully, the result of
|
1062
|
+
# the original request is returned.
|
1031
1063
|
#
|
1032
1064
|
# This token is listed as required, however, if you do not specify it,
|
1033
1065
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1070,8 +1102,8 @@ module Aws::WellArchitected
|
|
1070
1102
|
#
|
1071
1103
|
# You should not reuse the same token for other requests. If you retry a
|
1072
1104
|
# request with the same client request token and the same parameters
|
1073
|
-
# after
|
1074
|
-
# request is returned.
|
1105
|
+
# after the original request has completed successfully, the result of
|
1106
|
+
# the original request is returned.
|
1075
1107
|
#
|
1076
1108
|
# This token is listed as required, however, if you do not specify it,
|
1077
1109
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1140,9 +1172,11 @@ module Aws::WellArchitected
|
|
1140
1172
|
|
1141
1173
|
# Export an existing lens.
|
1142
1174
|
#
|
1175
|
+
# Only the owner of a lens can export it. Lenses provided by Amazon Web
|
1176
|
+
# Services (Amazon Web Services Official Content) cannot be exported.
|
1177
|
+
#
|
1143
1178
|
# Lenses are defined in JSON. For more information, see [JSON format
|
1144
|
-
# specification][1] in the *Well-Architected Tool User Guide*.
|
1145
|
-
# owner of a lens can export it.
|
1179
|
+
# specification][1] in the *Well-Architected Tool User Guide*.
|
1146
1180
|
#
|
1147
1181
|
# <note markdown="1"> **Disclaimer**
|
1148
1182
|
#
|
@@ -1165,10 +1199,12 @@ module Aws::WellArchitected
|
|
1165
1199
|
#
|
1166
1200
|
# For Amazon Web Services official lenses, this is either the lens
|
1167
1201
|
# alias, such as `serverless`, or the lens ARN, such as
|
1168
|
-
# `arn:aws:wellarchitected:us-
|
1202
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1203
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1204
|
+
# on Amazon Web Services official lenses.
|
1169
1205
|
#
|
1170
1206
|
# For custom lenses, this is the lens ARN, such as
|
1171
|
-
# `arn:aws:wellarchitected:us-
|
1207
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1172
1208
|
#
|
1173
1209
|
# Each lens is identified by its LensSummary$LensAlias.
|
1174
1210
|
#
|
@@ -1210,10 +1246,12 @@ module Aws::WellArchitected
|
|
1210
1246
|
#
|
1211
1247
|
# For Amazon Web Services official lenses, this is either the lens
|
1212
1248
|
# alias, such as `serverless`, or the lens ARN, such as
|
1213
|
-
# `arn:aws:wellarchitected:us-
|
1249
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1250
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1251
|
+
# on Amazon Web Services official lenses.
|
1214
1252
|
#
|
1215
1253
|
# For custom lenses, this is the lens ARN, such as
|
1216
|
-
# `arn:aws:wellarchitected:us-
|
1254
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1217
1255
|
#
|
1218
1256
|
# Each lens is identified by its LensSummary$LensAlias.
|
1219
1257
|
#
|
@@ -1289,6 +1327,80 @@ module Aws::WellArchitected
|
|
1289
1327
|
req.send_request(options)
|
1290
1328
|
end
|
1291
1329
|
|
1330
|
+
# Get a consolidated report of your workloads.
|
1331
|
+
#
|
1332
|
+
# You can optionally choose to include workloads that have been shared
|
1333
|
+
# with you.
|
1334
|
+
#
|
1335
|
+
# @option params [required, String] :format
|
1336
|
+
# The format of the consolidated report.
|
1337
|
+
#
|
1338
|
+
# For `PDF`, `Base64String` is returned. For `JSON`, `Metrics` is
|
1339
|
+
# returned.
|
1340
|
+
#
|
1341
|
+
# @option params [Boolean] :include_shared_resources
|
1342
|
+
# Set to `true` to have shared resources included in the report.
|
1343
|
+
#
|
1344
|
+
# @option params [String] :next_token
|
1345
|
+
# The token to use to retrieve the next set of results.
|
1346
|
+
#
|
1347
|
+
# @option params [Integer] :max_results
|
1348
|
+
# The maximum number of results to return for this request.
|
1349
|
+
#
|
1350
|
+
# @return [Types::GetConsolidatedReportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1351
|
+
#
|
1352
|
+
# * {Types::GetConsolidatedReportOutput#metrics #metrics} => Array<Types::ConsolidatedReportMetric>
|
1353
|
+
# * {Types::GetConsolidatedReportOutput#next_token #next_token} => String
|
1354
|
+
# * {Types::GetConsolidatedReportOutput#base_64_string #base_64_string} => String
|
1355
|
+
#
|
1356
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1357
|
+
#
|
1358
|
+
# @example Request syntax with placeholder values
|
1359
|
+
#
|
1360
|
+
# resp = client.get_consolidated_report({
|
1361
|
+
# format: "PDF", # required, accepts PDF, JSON
|
1362
|
+
# include_shared_resources: false,
|
1363
|
+
# next_token: "NextToken",
|
1364
|
+
# max_results: 1,
|
1365
|
+
# })
|
1366
|
+
#
|
1367
|
+
# @example Response structure
|
1368
|
+
#
|
1369
|
+
# resp.metrics #=> Array
|
1370
|
+
# resp.metrics[0].metric_type #=> String, one of "WORKLOAD"
|
1371
|
+
# resp.metrics[0].risk_counts #=> Hash
|
1372
|
+
# resp.metrics[0].risk_counts["Risk"] #=> Integer
|
1373
|
+
# resp.metrics[0].workload_id #=> String
|
1374
|
+
# resp.metrics[0].workload_name #=> String
|
1375
|
+
# resp.metrics[0].workload_arn #=> String
|
1376
|
+
# resp.metrics[0].updated_at #=> Time
|
1377
|
+
# resp.metrics[0].lenses #=> Array
|
1378
|
+
# resp.metrics[0].lenses[0].lens_arn #=> String
|
1379
|
+
# resp.metrics[0].lenses[0].pillars #=> Array
|
1380
|
+
# resp.metrics[0].lenses[0].pillars[0].pillar_id #=> String
|
1381
|
+
# resp.metrics[0].lenses[0].pillars[0].risk_counts #=> Hash
|
1382
|
+
# resp.metrics[0].lenses[0].pillars[0].risk_counts["Risk"] #=> Integer
|
1383
|
+
# resp.metrics[0].lenses[0].pillars[0].questions #=> Array
|
1384
|
+
# resp.metrics[0].lenses[0].pillars[0].questions[0].question_id #=> String
|
1385
|
+
# resp.metrics[0].lenses[0].pillars[0].questions[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
|
1386
|
+
# resp.metrics[0].lenses[0].pillars[0].questions[0].best_practices #=> Array
|
1387
|
+
# resp.metrics[0].lenses[0].pillars[0].questions[0].best_practices[0].choice_id #=> String
|
1388
|
+
# resp.metrics[0].lenses[0].pillars[0].questions[0].best_practices[0].choice_title #=> String
|
1389
|
+
# resp.metrics[0].lenses[0].risk_counts #=> Hash
|
1390
|
+
# resp.metrics[0].lenses[0].risk_counts["Risk"] #=> Integer
|
1391
|
+
# resp.metrics[0].lenses_applied_count #=> Integer
|
1392
|
+
# resp.next_token #=> String
|
1393
|
+
# resp.base_64_string #=> String
|
1394
|
+
#
|
1395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetConsolidatedReport AWS API Documentation
|
1396
|
+
#
|
1397
|
+
# @overload get_consolidated_report(params = {})
|
1398
|
+
# @param [Hash] params ({})
|
1399
|
+
def get_consolidated_report(params = {}, options = {})
|
1400
|
+
req = build_request(:get_consolidated_report, params)
|
1401
|
+
req.send_request(options)
|
1402
|
+
end
|
1403
|
+
|
1292
1404
|
# Get an existing lens.
|
1293
1405
|
#
|
1294
1406
|
# @option params [required, String] :lens_alias
|
@@ -1296,10 +1408,12 @@ module Aws::WellArchitected
|
|
1296
1408
|
#
|
1297
1409
|
# For Amazon Web Services official lenses, this is either the lens
|
1298
1410
|
# alias, such as `serverless`, or the lens ARN, such as
|
1299
|
-
# `arn:aws:wellarchitected:us-
|
1411
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1412
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1413
|
+
# on Amazon Web Services official lenses.
|
1300
1414
|
#
|
1301
1415
|
# For custom lenses, this is the lens ARN, such as
|
1302
|
-
# `arn:aws:wellarchitected:us-
|
1416
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1303
1417
|
#
|
1304
1418
|
# Each lens is identified by its LensSummary$LensAlias.
|
1305
1419
|
#
|
@@ -1348,10 +1462,12 @@ module Aws::WellArchitected
|
|
1348
1462
|
#
|
1349
1463
|
# For Amazon Web Services official lenses, this is either the lens
|
1350
1464
|
# alias, such as `serverless`, or the lens ARN, such as
|
1351
|
-
# `arn:aws:wellarchitected:us-
|
1465
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1466
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1467
|
+
# on Amazon Web Services official lenses.
|
1352
1468
|
#
|
1353
1469
|
# For custom lenses, this is the lens ARN, such as
|
1354
|
-
# `arn:aws:wellarchitected:us-
|
1470
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1355
1471
|
#
|
1356
1472
|
# Each lens is identified by its LensSummary$LensAlias.
|
1357
1473
|
#
|
@@ -1415,10 +1531,12 @@ module Aws::WellArchitected
|
|
1415
1531
|
#
|
1416
1532
|
# For Amazon Web Services official lenses, this is either the lens
|
1417
1533
|
# alias, such as `serverless`, or the lens ARN, such as
|
1418
|
-
# `arn:aws:wellarchitected:us-
|
1534
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1535
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1536
|
+
# on Amazon Web Services official lenses.
|
1419
1537
|
#
|
1420
1538
|
# For custom lenses, this is the lens ARN, such as
|
1421
|
-
# `arn:aws:wellarchitected:us-
|
1539
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1422
1540
|
#
|
1423
1541
|
# Each lens is identified by its LensSummary$LensAlias.
|
1424
1542
|
#
|
@@ -1465,10 +1583,12 @@ module Aws::WellArchitected
|
|
1465
1583
|
#
|
1466
1584
|
# For Amazon Web Services official lenses, this is either the lens
|
1467
1585
|
# alias, such as `serverless`, or the lens ARN, such as
|
1468
|
-
# `arn:aws:wellarchitected:us-
|
1586
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1587
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1588
|
+
# on Amazon Web Services official lenses.
|
1469
1589
|
#
|
1470
1590
|
# For custom lenses, this is the lens ARN, such as
|
1471
|
-
# `arn:aws:wellarchitected:us-
|
1591
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1472
1592
|
#
|
1473
1593
|
# Each lens is identified by its LensSummary$LensAlias.
|
1474
1594
|
#
|
@@ -1580,6 +1700,8 @@ module Aws::WellArchitected
|
|
1580
1700
|
# resp.milestone.workload.tags #=> Hash
|
1581
1701
|
# resp.milestone.workload.tags["TagKey"] #=> String
|
1582
1702
|
# resp.milestone.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
|
1703
|
+
# resp.milestone.workload.discovery_config.workload_resource_definition #=> Array
|
1704
|
+
# resp.milestone.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
|
1583
1705
|
# resp.milestone.workload.applications #=> Array
|
1584
1706
|
# resp.milestone.workload.applications[0] #=> String
|
1585
1707
|
#
|
@@ -1641,6 +1763,8 @@ module Aws::WellArchitected
|
|
1641
1763
|
# resp.workload.tags #=> Hash
|
1642
1764
|
# resp.workload.tags["TagKey"] #=> String
|
1643
1765
|
# resp.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
|
1766
|
+
# resp.workload.discovery_config.workload_resource_definition #=> Array
|
1767
|
+
# resp.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
|
1644
1768
|
# resp.workload.applications #=> Array
|
1645
1769
|
# resp.workload.applications[0] #=> String
|
1646
1770
|
#
|
@@ -1653,10 +1777,14 @@ module Aws::WellArchitected
|
|
1653
1777
|
req.send_request(options)
|
1654
1778
|
end
|
1655
1779
|
|
1656
|
-
# Import a new lens.
|
1780
|
+
# Import a new custom lens or update an existing custom lens.
|
1781
|
+
#
|
1782
|
+
# To update an existing custom lens, specify its ARN as the `LensAlias`.
|
1783
|
+
# If no ARN is specified, a new custom lens is created.
|
1657
1784
|
#
|
1658
|
-
# The lens
|
1659
|
-
#
|
1785
|
+
# The new or updated lens will have a status of `DRAFT`. The lens cannot
|
1786
|
+
# be applied to workloads or shared with other Amazon Web Services
|
1787
|
+
# accounts until it's published with CreateLensVersion.
|
1660
1788
|
#
|
1661
1789
|
# Lenses are defined in JSON. For more information, see [JSON format
|
1662
1790
|
# specification][1] in the *Well-Architected Tool User Guide*.
|
@@ -1684,10 +1812,12 @@ module Aws::WellArchitected
|
|
1684
1812
|
#
|
1685
1813
|
# For Amazon Web Services official lenses, this is either the lens
|
1686
1814
|
# alias, such as `serverless`, or the lens ARN, such as
|
1687
|
-
# `arn:aws:wellarchitected:us-
|
1815
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1816
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1817
|
+
# on Amazon Web Services official lenses.
|
1688
1818
|
#
|
1689
1819
|
# For custom lenses, this is the lens ARN, such as
|
1690
|
-
# `arn:aws:wellarchitected:us-
|
1820
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1691
1821
|
#
|
1692
1822
|
# Each lens is identified by its LensSummary$LensAlias.
|
1693
1823
|
#
|
@@ -1700,8 +1830,8 @@ module Aws::WellArchitected
|
|
1700
1830
|
#
|
1701
1831
|
# You should not reuse the same token for other requests. If you retry a
|
1702
1832
|
# request with the same client request token and the same parameters
|
1703
|
-
# after
|
1704
|
-
# request is returned.
|
1833
|
+
# after the original request has completed successfully, the result of
|
1834
|
+
# the original request is returned.
|
1705
1835
|
#
|
1706
1836
|
# This token is listed as required, however, if you do not specify it,
|
1707
1837
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -1744,7 +1874,7 @@ module Aws::WellArchitected
|
|
1744
1874
|
req.send_request(options)
|
1745
1875
|
end
|
1746
1876
|
|
1747
|
-
# List of answers.
|
1877
|
+
# List of answers for a particular workload and lens.
|
1748
1878
|
#
|
1749
1879
|
# @option params [required, String] :workload_id
|
1750
1880
|
# The ID assigned to the workload. This ID is unique within an Amazon
|
@@ -1755,10 +1885,12 @@ module Aws::WellArchitected
|
|
1755
1885
|
#
|
1756
1886
|
# For Amazon Web Services official lenses, this is either the lens
|
1757
1887
|
# alias, such as `serverless`, or the lens ARN, such as
|
1758
|
-
# `arn:aws:wellarchitected:us-
|
1888
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
1889
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
1890
|
+
# on Amazon Web Services official lenses.
|
1759
1891
|
#
|
1760
1892
|
# For custom lenses, this is the lens ARN, such as
|
1761
|
-
# `arn:aws:wellarchitected:us-
|
1893
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
1762
1894
|
#
|
1763
1895
|
# Each lens is identified by its LensSummary$LensAlias.
|
1764
1896
|
#
|
@@ -1999,10 +2131,12 @@ module Aws::WellArchitected
|
|
1999
2131
|
#
|
2000
2132
|
# For Amazon Web Services official lenses, this is either the lens
|
2001
2133
|
# alias, such as `serverless`, or the lens ARN, such as
|
2002
|
-
# `arn:aws:wellarchitected:us-
|
2134
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2135
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
2136
|
+
# on Amazon Web Services official lenses.
|
2003
2137
|
#
|
2004
2138
|
# For custom lenses, this is the lens ARN, such as
|
2005
|
-
# `arn:aws:wellarchitected:us-
|
2139
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2006
2140
|
#
|
2007
2141
|
# Each lens is identified by its LensSummary$LensAlias.
|
2008
2142
|
#
|
@@ -2071,7 +2205,7 @@ module Aws::WellArchitected
|
|
2071
2205
|
req.send_request(options)
|
2072
2206
|
end
|
2073
2207
|
|
2074
|
-
# List lens reviews.
|
2208
|
+
# List lens reviews for a particular workload.
|
2075
2209
|
#
|
2076
2210
|
# @option params [required, String] :workload_id
|
2077
2211
|
# The ID assigned to the workload. This ID is unique within an Amazon
|
@@ -2137,10 +2271,12 @@ module Aws::WellArchitected
|
|
2137
2271
|
#
|
2138
2272
|
# For Amazon Web Services official lenses, this is either the lens
|
2139
2273
|
# alias, such as `serverless`, or the lens ARN, such as
|
2140
|
-
# `arn:aws:wellarchitected:us-
|
2274
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2275
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
2276
|
+
# on Amazon Web Services official lenses.
|
2141
2277
|
#
|
2142
2278
|
# For custom lenses, this is the lens ARN, such as
|
2143
|
-
# `arn:aws:wellarchitected:us-
|
2279
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2144
2280
|
#
|
2145
2281
|
# Each lens is identified by its LensSummary$LensAlias.
|
2146
2282
|
#
|
@@ -2504,7 +2640,7 @@ module Aws::WellArchitected
|
|
2504
2640
|
req.send_request(options)
|
2505
2641
|
end
|
2506
2642
|
|
2507
|
-
#
|
2643
|
+
# Paginated list of workloads.
|
2508
2644
|
#
|
2509
2645
|
# @option params [String] :workload_name_prefix
|
2510
2646
|
# An optional string added to the beginning of each workload name
|
@@ -2636,10 +2772,12 @@ module Aws::WellArchitected
|
|
2636
2772
|
#
|
2637
2773
|
# For Amazon Web Services official lenses, this is either the lens
|
2638
2774
|
# alias, such as `serverless`, or the lens ARN, such as
|
2639
|
-
# `arn:aws:wellarchitected:us-
|
2775
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2776
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
2777
|
+
# on Amazon Web Services official lenses.
|
2640
2778
|
#
|
2641
2779
|
# For custom lenses, this is the lens ARN, such as
|
2642
|
-
# `arn:aws:wellarchitected:us-
|
2780
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2643
2781
|
#
|
2644
2782
|
# Each lens is identified by its LensSummary$LensAlias.
|
2645
2783
|
#
|
@@ -2737,17 +2875,21 @@ module Aws::WellArchitected
|
|
2737
2875
|
end
|
2738
2876
|
|
2739
2877
|
# Updates whether the Amazon Web Services account is opted into
|
2740
|
-
# organization sharing features.
|
2878
|
+
# organization sharing and discovery integration features.
|
2741
2879
|
#
|
2742
2880
|
# @option params [String] :organization_sharing_status
|
2743
2881
|
# The status of organization sharing settings.
|
2744
2882
|
#
|
2883
|
+
# @option params [String] :discovery_integration_status
|
2884
|
+
# The status of discovery support settings.
|
2885
|
+
#
|
2745
2886
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2746
2887
|
#
|
2747
2888
|
# @example Request syntax with placeholder values
|
2748
2889
|
#
|
2749
2890
|
# resp = client.update_global_settings({
|
2750
2891
|
# organization_sharing_status: "ENABLED", # accepts ENABLED, DISABLED
|
2892
|
+
# discovery_integration_status: "ENABLED", # accepts ENABLED, DISABLED
|
2751
2893
|
# })
|
2752
2894
|
#
|
2753
2895
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateGlobalSettings AWS API Documentation
|
@@ -2759,7 +2901,7 @@ module Aws::WellArchitected
|
|
2759
2901
|
req.send_request(options)
|
2760
2902
|
end
|
2761
2903
|
|
2762
|
-
# Update lens review.
|
2904
|
+
# Update lens review for a particular workload.
|
2763
2905
|
#
|
2764
2906
|
# @option params [required, String] :workload_id
|
2765
2907
|
# The ID assigned to the workload. This ID is unique within an Amazon
|
@@ -2770,10 +2912,12 @@ module Aws::WellArchitected
|
|
2770
2912
|
#
|
2771
2913
|
# For Amazon Web Services official lenses, this is either the lens
|
2772
2914
|
# alias, such as `serverless`, or the lens ARN, such as
|
2773
|
-
# `arn:aws:wellarchitected:us-
|
2915
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2916
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
2917
|
+
# on Amazon Web Services official lenses.
|
2774
2918
|
#
|
2775
2919
|
# For custom lenses, this is the lens ARN, such as
|
2776
|
-
# `arn:aws:wellarchitected:us-
|
2920
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2777
2921
|
#
|
2778
2922
|
# Each lens is identified by its LensSummary$LensAlias.
|
2779
2923
|
#
|
@@ -3020,6 +3164,7 @@ module Aws::WellArchitected
|
|
3020
3164
|
# improvement_status: "NOT_APPLICABLE", # accepts NOT_APPLICABLE, NOT_STARTED, IN_PROGRESS, COMPLETE, RISK_ACKNOWLEDGED
|
3021
3165
|
# discovery_config: {
|
3022
3166
|
# trusted_advisor_integration_status: "ENABLED", # accepts ENABLED, DISABLED
|
3167
|
+
# workload_resource_definition: ["WORKLOAD_METADATA"], # accepts WORKLOAD_METADATA, APP_REGISTRY
|
3023
3168
|
# },
|
3024
3169
|
# applications: ["ApplicationArn"],
|
3025
3170
|
# })
|
@@ -3057,6 +3202,8 @@ module Aws::WellArchitected
|
|
3057
3202
|
# resp.workload.tags #=> Hash
|
3058
3203
|
# resp.workload.tags["TagKey"] #=> String
|
3059
3204
|
# resp.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
|
3205
|
+
# resp.workload.discovery_config.workload_resource_definition #=> Array
|
3206
|
+
# resp.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
|
3060
3207
|
# resp.workload.applications #=> Array
|
3061
3208
|
# resp.workload.applications[0] #=> String
|
3062
3209
|
#
|
@@ -3114,7 +3261,7 @@ module Aws::WellArchitected
|
|
3114
3261
|
req.send_request(options)
|
3115
3262
|
end
|
3116
3263
|
|
3117
|
-
# Upgrade lens review.
|
3264
|
+
# Upgrade lens review for a particular workload.
|
3118
3265
|
#
|
3119
3266
|
# @option params [required, String] :workload_id
|
3120
3267
|
# The ID assigned to the workload. This ID is unique within an Amazon
|
@@ -3125,10 +3272,12 @@ module Aws::WellArchitected
|
|
3125
3272
|
#
|
3126
3273
|
# For Amazon Web Services official lenses, this is either the lens
|
3127
3274
|
# alias, such as `serverless`, or the lens ARN, such as
|
3128
|
-
# `arn:aws:wellarchitected:us-
|
3275
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
3276
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
3277
|
+
# on Amazon Web Services official lenses.
|
3129
3278
|
#
|
3130
3279
|
# For custom lenses, this is the lens ARN, such as
|
3131
|
-
# `arn:aws:wellarchitected:us-
|
3280
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
3132
3281
|
#
|
3133
3282
|
# Each lens is identified by its LensSummary$LensAlias.
|
3134
3283
|
#
|
@@ -3143,8 +3292,8 @@ module Aws::WellArchitected
|
|
3143
3292
|
#
|
3144
3293
|
# You should not reuse the same token for other requests. If you retry a
|
3145
3294
|
# request with the same client request token and the same parameters
|
3146
|
-
# after
|
3147
|
-
# request is returned.
|
3295
|
+
# after the original request has completed successfully, the result of
|
3296
|
+
# the original request is returned.
|
3148
3297
|
#
|
3149
3298
|
# This token is listed as required, however, if you do not specify it,
|
3150
3299
|
# the Amazon Web Services SDKs automatically generate one for you. If
|
@@ -3184,7 +3333,7 @@ module Aws::WellArchitected
|
|
3184
3333
|
params: params,
|
3185
3334
|
config: config)
|
3186
3335
|
context[:gem_name] = 'aws-sdk-wellarchitected'
|
3187
|
-
context[:gem_version] = '1.
|
3336
|
+
context[:gem_version] = '1.22.0'
|
3188
3337
|
Seahorse::Client::Request.new(handlers, context)
|
3189
3338
|
end
|
3190
3339
|
|