aws-sdk-wellarchitected 1.23.0 → 1.25.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 +704 -19
- data/lib/aws-sdk-wellarchitected/client_api.rb +464 -0
- data/lib/aws-sdk-wellarchitected/endpoints.rb +183 -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
@@ -415,6 +415,33 @@ module Aws::WellArchitected
|
|
415
415
|
req.send_request(options)
|
416
416
|
end
|
417
417
|
|
418
|
+
# Associate a profile with a workload.
|
419
|
+
#
|
420
|
+
# @option params [required, String] :workload_id
|
421
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
422
|
+
# Web Services Region.
|
423
|
+
#
|
424
|
+
# @option params [required, Array<String>] :profile_arns
|
425
|
+
# The list of profile ARNs to associate with the workload.
|
426
|
+
#
|
427
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
428
|
+
#
|
429
|
+
# @example Request syntax with placeholder values
|
430
|
+
#
|
431
|
+
# resp = client.associate_profiles({
|
432
|
+
# workload_id: "WorkloadId", # required
|
433
|
+
# profile_arns: ["ProfileArn"], # required
|
434
|
+
# })
|
435
|
+
#
|
436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/AssociateProfiles AWS API Documentation
|
437
|
+
#
|
438
|
+
# @overload associate_profiles(params = {})
|
439
|
+
# @param [Hash] params ({})
|
440
|
+
def associate_profiles(params = {}, options = {})
|
441
|
+
req = build_request(:associate_profiles, params)
|
442
|
+
req.send_request(options)
|
443
|
+
end
|
444
|
+
|
418
445
|
# Create a lens share.
|
419
446
|
#
|
420
447
|
# The owner of a lens can share it with other Amazon Web Services
|
@@ -462,7 +489,8 @@ module Aws::WellArchitected
|
|
462
489
|
#
|
463
490
|
# @option params [required, String] :shared_with
|
464
491
|
# The Amazon Web Services account ID, IAM role, organization ID, or
|
465
|
-
# organizational unit (OU) ID with which the workload
|
492
|
+
# organizational unit (OU) ID with which the workload, lens, or profile
|
493
|
+
# is shared.
|
466
494
|
#
|
467
495
|
# @option params [required, String] :client_request_token
|
468
496
|
# A unique case-sensitive string used to ensure that this request is
|
@@ -636,6 +664,127 @@ module Aws::WellArchitected
|
|
636
664
|
req.send_request(options)
|
637
665
|
end
|
638
666
|
|
667
|
+
# Create a profile.
|
668
|
+
#
|
669
|
+
# @option params [required, String] :profile_name
|
670
|
+
# Name of the profile.
|
671
|
+
#
|
672
|
+
# @option params [required, String] :profile_description
|
673
|
+
# The profile description.
|
674
|
+
#
|
675
|
+
# @option params [required, Array<Types::ProfileQuestionUpdate>] :profile_questions
|
676
|
+
# The profile questions.
|
677
|
+
#
|
678
|
+
# @option params [required, String] :client_request_token
|
679
|
+
# A unique case-sensitive string used to ensure that this request is
|
680
|
+
# idempotent (executes only once).
|
681
|
+
#
|
682
|
+
# You should not reuse the same token for other requests. If you retry a
|
683
|
+
# request with the same client request token and the same parameters
|
684
|
+
# after the original request has completed successfully, the result of
|
685
|
+
# the original request is returned.
|
686
|
+
#
|
687
|
+
# This token is listed as required, however, if you do not specify it,
|
688
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
689
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
690
|
+
# provide this token or the request will fail.
|
691
|
+
#
|
692
|
+
# **A suitable default value is auto-generated.** You should normally
|
693
|
+
# not need to pass this option.**
|
694
|
+
#
|
695
|
+
# @option params [Hash<String,String>] :tags
|
696
|
+
# The tags assigned to the profile.
|
697
|
+
#
|
698
|
+
# @return [Types::CreateProfileOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
699
|
+
#
|
700
|
+
# * {Types::CreateProfileOutput#profile_arn #profile_arn} => String
|
701
|
+
# * {Types::CreateProfileOutput#profile_version #profile_version} => String
|
702
|
+
#
|
703
|
+
# @example Request syntax with placeholder values
|
704
|
+
#
|
705
|
+
# resp = client.create_profile({
|
706
|
+
# profile_name: "ProfileName", # required
|
707
|
+
# profile_description: "ProfileDescription", # required
|
708
|
+
# profile_questions: [ # required
|
709
|
+
# {
|
710
|
+
# question_id: "QuestionId",
|
711
|
+
# selected_choice_ids: ["ChoiceId"],
|
712
|
+
# },
|
713
|
+
# ],
|
714
|
+
# client_request_token: "ClientRequestToken", # required
|
715
|
+
# tags: {
|
716
|
+
# "TagKey" => "TagValue",
|
717
|
+
# },
|
718
|
+
# })
|
719
|
+
#
|
720
|
+
# @example Response structure
|
721
|
+
#
|
722
|
+
# resp.profile_arn #=> String
|
723
|
+
# resp.profile_version #=> String
|
724
|
+
#
|
725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateProfile AWS API Documentation
|
726
|
+
#
|
727
|
+
# @overload create_profile(params = {})
|
728
|
+
# @param [Hash] params ({})
|
729
|
+
def create_profile(params = {}, options = {})
|
730
|
+
req = build_request(:create_profile, params)
|
731
|
+
req.send_request(options)
|
732
|
+
end
|
733
|
+
|
734
|
+
# Create a profile share.
|
735
|
+
#
|
736
|
+
# @option params [required, String] :profile_arn
|
737
|
+
# The profile ARN.
|
738
|
+
#
|
739
|
+
# @option params [required, String] :shared_with
|
740
|
+
# The Amazon Web Services account ID, IAM role, organization ID, or
|
741
|
+
# organizational unit (OU) ID with which the workload, lens, or profile
|
742
|
+
# is shared.
|
743
|
+
#
|
744
|
+
# @option params [required, String] :client_request_token
|
745
|
+
# A unique case-sensitive string used to ensure that this request is
|
746
|
+
# idempotent (executes only once).
|
747
|
+
#
|
748
|
+
# You should not reuse the same token for other requests. If you retry a
|
749
|
+
# request with the same client request token and the same parameters
|
750
|
+
# after the original request has completed successfully, the result of
|
751
|
+
# the original request is returned.
|
752
|
+
#
|
753
|
+
# This token is listed as required, however, if you do not specify it,
|
754
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
755
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
756
|
+
# provide this token or the request will fail.
|
757
|
+
#
|
758
|
+
# **A suitable default value is auto-generated.** You should normally
|
759
|
+
# not need to pass this option.**
|
760
|
+
#
|
761
|
+
# @return [Types::CreateProfileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
762
|
+
#
|
763
|
+
# * {Types::CreateProfileShareOutput#share_id #share_id} => String
|
764
|
+
# * {Types::CreateProfileShareOutput#profile_arn #profile_arn} => String
|
765
|
+
#
|
766
|
+
# @example Request syntax with placeholder values
|
767
|
+
#
|
768
|
+
# resp = client.create_profile_share({
|
769
|
+
# profile_arn: "ProfileArn", # required
|
770
|
+
# shared_with: "SharedWith", # required
|
771
|
+
# client_request_token: "ClientRequestToken", # required
|
772
|
+
# })
|
773
|
+
#
|
774
|
+
# @example Response structure
|
775
|
+
#
|
776
|
+
# resp.share_id #=> String
|
777
|
+
# resp.profile_arn #=> String
|
778
|
+
#
|
779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateProfileShare AWS API Documentation
|
780
|
+
#
|
781
|
+
# @overload create_profile_share(params = {})
|
782
|
+
# @param [Hash] params ({})
|
783
|
+
def create_profile_share(params = {}, options = {})
|
784
|
+
req = build_request(:create_profile_share, params)
|
785
|
+
req.send_request(options)
|
786
|
+
end
|
787
|
+
|
639
788
|
# Create a new workload.
|
640
789
|
#
|
641
790
|
# The owner of a workload can share the workload with other Amazon Web
|
@@ -790,6 +939,9 @@ module Aws::WellArchitected
|
|
790
939
|
# @option params [Array<String>] :applications
|
791
940
|
# List of AppRegistry application ARNs associated to the workload.
|
792
941
|
#
|
942
|
+
# @option params [Array<String>] :profile_arns
|
943
|
+
# The list of profile ARNs associated with the workload.
|
944
|
+
#
|
793
945
|
# @return [Types::CreateWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
794
946
|
#
|
795
947
|
# * {Types::CreateWorkloadOutput#workload_id #workload_id} => String
|
@@ -820,6 +972,7 @@ module Aws::WellArchitected
|
|
820
972
|
# workload_resource_definition: ["WORKLOAD_METADATA"], # accepts WORKLOAD_METADATA, APP_REGISTRY
|
821
973
|
# },
|
822
974
|
# applications: ["ApplicationArn"],
|
975
|
+
# profile_arns: ["ProfileArn"],
|
823
976
|
# })
|
824
977
|
#
|
825
978
|
# @example Response structure
|
@@ -859,10 +1012,11 @@ module Aws::WellArchitected
|
|
859
1012
|
#
|
860
1013
|
# @option params [required, String] :shared_with
|
861
1014
|
# The Amazon Web Services account ID, IAM role, organization ID, or
|
862
|
-
# organizational unit (OU) ID with which the workload
|
1015
|
+
# organizational unit (OU) ID with which the workload, lens, or profile
|
1016
|
+
# is shared.
|
863
1017
|
#
|
864
1018
|
# @option params [required, String] :permission_type
|
865
|
-
# Permission granted on a
|
1019
|
+
# Permission granted on a share request.
|
866
1020
|
#
|
867
1021
|
# @option params [required, String] :client_request_token
|
868
1022
|
# A unique case-sensitive string used to ensure that this request is
|
@@ -999,7 +1153,7 @@ module Aws::WellArchitected
|
|
999
1153
|
# </note>
|
1000
1154
|
#
|
1001
1155
|
# @option params [required, String] :share_id
|
1002
|
-
# The ID associated with the
|
1156
|
+
# The ID associated with the share.
|
1003
1157
|
#
|
1004
1158
|
# @option params [required, String] :lens_alias
|
1005
1159
|
# The alias of the lens.
|
@@ -1051,6 +1205,101 @@ module Aws::WellArchitected
|
|
1051
1205
|
req.send_request(options)
|
1052
1206
|
end
|
1053
1207
|
|
1208
|
+
# Delete a profile.
|
1209
|
+
#
|
1210
|
+
# <note markdown="1"> **Disclaimer**
|
1211
|
+
#
|
1212
|
+
# By sharing your profile with other Amazon Web Services accounts, you
|
1213
|
+
# acknowledge that Amazon Web Services will make your profile available
|
1214
|
+
# to those other accounts. Those other accounts may continue to access
|
1215
|
+
# and use your shared profile even if you delete the profile from your
|
1216
|
+
# own Amazon Web Services account or terminate your Amazon Web Services
|
1217
|
+
# account.
|
1218
|
+
#
|
1219
|
+
# </note>
|
1220
|
+
#
|
1221
|
+
# @option params [required, String] :profile_arn
|
1222
|
+
# The profile ARN.
|
1223
|
+
#
|
1224
|
+
# @option params [required, String] :client_request_token
|
1225
|
+
# A unique case-sensitive string used to ensure that this request is
|
1226
|
+
# idempotent (executes only once).
|
1227
|
+
#
|
1228
|
+
# You should not reuse the same token for other requests. If you retry a
|
1229
|
+
# request with the same client request token and the same parameters
|
1230
|
+
# after the original request has completed successfully, the result of
|
1231
|
+
# the original request is returned.
|
1232
|
+
#
|
1233
|
+
# This token is listed as required, however, if you do not specify it,
|
1234
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1235
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1236
|
+
# provide this token or the request will fail.
|
1237
|
+
#
|
1238
|
+
# **A suitable default value is auto-generated.** You should normally
|
1239
|
+
# not need to pass this option.**
|
1240
|
+
#
|
1241
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1242
|
+
#
|
1243
|
+
# @example Request syntax with placeholder values
|
1244
|
+
#
|
1245
|
+
# resp = client.delete_profile({
|
1246
|
+
# profile_arn: "ProfileArn", # required
|
1247
|
+
# client_request_token: "ClientRequestToken", # required
|
1248
|
+
# })
|
1249
|
+
#
|
1250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteProfile AWS API Documentation
|
1251
|
+
#
|
1252
|
+
# @overload delete_profile(params = {})
|
1253
|
+
# @param [Hash] params ({})
|
1254
|
+
def delete_profile(params = {}, options = {})
|
1255
|
+
req = build_request(:delete_profile, params)
|
1256
|
+
req.send_request(options)
|
1257
|
+
end
|
1258
|
+
|
1259
|
+
# Delete a profile share.
|
1260
|
+
#
|
1261
|
+
# @option params [required, String] :share_id
|
1262
|
+
# The ID associated with the share.
|
1263
|
+
#
|
1264
|
+
# @option params [required, String] :profile_arn
|
1265
|
+
# The profile ARN.
|
1266
|
+
#
|
1267
|
+
# @option params [required, String] :client_request_token
|
1268
|
+
# A unique case-sensitive string used to ensure that this request is
|
1269
|
+
# idempotent (executes only once).
|
1270
|
+
#
|
1271
|
+
# You should not reuse the same token for other requests. If you retry a
|
1272
|
+
# request with the same client request token and the same parameters
|
1273
|
+
# after the original request has completed successfully, the result of
|
1274
|
+
# the original request is returned.
|
1275
|
+
#
|
1276
|
+
# This token is listed as required, however, if you do not specify it,
|
1277
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1278
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1279
|
+
# provide this token or the request will fail.
|
1280
|
+
#
|
1281
|
+
# **A suitable default value is auto-generated.** You should normally
|
1282
|
+
# not need to pass this option.**
|
1283
|
+
#
|
1284
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1285
|
+
#
|
1286
|
+
# @example Request syntax with placeholder values
|
1287
|
+
#
|
1288
|
+
# resp = client.delete_profile_share({
|
1289
|
+
# share_id: "ShareId", # required
|
1290
|
+
# profile_arn: "ProfileArn", # required
|
1291
|
+
# client_request_token: "ClientRequestToken", # required
|
1292
|
+
# })
|
1293
|
+
#
|
1294
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteProfileShare AWS API Documentation
|
1295
|
+
#
|
1296
|
+
# @overload delete_profile_share(params = {})
|
1297
|
+
# @param [Hash] params ({})
|
1298
|
+
def delete_profile_share(params = {}, options = {})
|
1299
|
+
req = build_request(:delete_profile_share, params)
|
1300
|
+
req.send_request(options)
|
1301
|
+
end
|
1302
|
+
|
1054
1303
|
# Delete an existing workload.
|
1055
1304
|
#
|
1056
1305
|
# @option params [required, String] :workload_id
|
@@ -1095,7 +1344,7 @@ module Aws::WellArchitected
|
|
1095
1344
|
# Delete a workload share.
|
1096
1345
|
#
|
1097
1346
|
# @option params [required, String] :share_id
|
1098
|
-
# The ID associated with the
|
1347
|
+
# The ID associated with the share.
|
1099
1348
|
#
|
1100
1349
|
# @option params [required, String] :workload_id
|
1101
1350
|
# The ID assigned to the workload. This ID is unique within an Amazon
|
@@ -1175,6 +1424,33 @@ module Aws::WellArchitected
|
|
1175
1424
|
req.send_request(options)
|
1176
1425
|
end
|
1177
1426
|
|
1427
|
+
# Disassociate a profile from a workload.
|
1428
|
+
#
|
1429
|
+
# @option params [required, String] :workload_id
|
1430
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1431
|
+
# Web Services Region.
|
1432
|
+
#
|
1433
|
+
# @option params [required, Array<String>] :profile_arns
|
1434
|
+
# The list of profile ARNs to disassociate from the workload.
|
1435
|
+
#
|
1436
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1437
|
+
#
|
1438
|
+
# @example Request syntax with placeholder values
|
1439
|
+
#
|
1440
|
+
# resp = client.disassociate_profiles({
|
1441
|
+
# workload_id: "WorkloadId", # required
|
1442
|
+
# profile_arns: ["ProfileArn"], # required
|
1443
|
+
# })
|
1444
|
+
#
|
1445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DisassociateProfiles AWS API Documentation
|
1446
|
+
#
|
1447
|
+
# @overload disassociate_profiles(params = {})
|
1448
|
+
# @param [Hash] params ({})
|
1449
|
+
def disassociate_profiles(params = {}, options = {})
|
1450
|
+
req = build_request(:disassociate_profiles, params)
|
1451
|
+
req.send_request(options)
|
1452
|
+
end
|
1453
|
+
|
1178
1454
|
# Export an existing lens.
|
1179
1455
|
#
|
1180
1456
|
# Only the owner of a lens can export it. Lenses provided by Amazon Web
|
@@ -1510,11 +1786,18 @@ module Aws::WellArchitected
|
|
1510
1786
|
# resp.lens_review.pillar_review_summaries[0].notes #=> String
|
1511
1787
|
# resp.lens_review.pillar_review_summaries[0].risk_counts #=> Hash
|
1512
1788
|
# resp.lens_review.pillar_review_summaries[0].risk_counts["Risk"] #=> Integer
|
1789
|
+
# resp.lens_review.pillar_review_summaries[0].prioritized_risk_counts #=> Hash
|
1790
|
+
# resp.lens_review.pillar_review_summaries[0].prioritized_risk_counts["Risk"] #=> Integer
|
1513
1791
|
# resp.lens_review.updated_at #=> Time
|
1514
1792
|
# resp.lens_review.notes #=> String
|
1515
1793
|
# resp.lens_review.risk_counts #=> Hash
|
1516
1794
|
# resp.lens_review.risk_counts["Risk"] #=> Integer
|
1517
1795
|
# resp.lens_review.next_token #=> String
|
1796
|
+
# resp.lens_review.profiles #=> Array
|
1797
|
+
# resp.lens_review.profiles[0].profile_arn #=> String
|
1798
|
+
# resp.lens_review.profiles[0].profile_version #=> String
|
1799
|
+
# resp.lens_review.prioritized_risk_counts #=> Hash
|
1800
|
+
# resp.lens_review.prioritized_risk_counts["Risk"] #=> Integer
|
1518
1801
|
#
|
1519
1802
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReview AWS API Documentation
|
1520
1803
|
#
|
@@ -1709,6 +1992,11 @@ module Aws::WellArchitected
|
|
1709
1992
|
# resp.milestone.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
|
1710
1993
|
# resp.milestone.workload.applications #=> Array
|
1711
1994
|
# resp.milestone.workload.applications[0] #=> String
|
1995
|
+
# resp.milestone.workload.profiles #=> Array
|
1996
|
+
# resp.milestone.workload.profiles[0].profile_arn #=> String
|
1997
|
+
# resp.milestone.workload.profiles[0].profile_version #=> String
|
1998
|
+
# resp.milestone.workload.prioritized_risk_counts #=> Hash
|
1999
|
+
# resp.milestone.workload.prioritized_risk_counts["Risk"] #=> Integer
|
1712
2000
|
#
|
1713
2001
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetMilestone AWS API Documentation
|
1714
2002
|
#
|
@@ -1719,6 +2007,90 @@ module Aws::WellArchitected
|
|
1719
2007
|
req.send_request(options)
|
1720
2008
|
end
|
1721
2009
|
|
2010
|
+
# Get profile information.
|
2011
|
+
#
|
2012
|
+
# @option params [required, String] :profile_arn
|
2013
|
+
# The profile ARN.
|
2014
|
+
#
|
2015
|
+
# @option params [String] :profile_version
|
2016
|
+
# The profile version.
|
2017
|
+
#
|
2018
|
+
# @return [Types::GetProfileOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2019
|
+
#
|
2020
|
+
# * {Types::GetProfileOutput#profile #profile} => Types::Profile
|
2021
|
+
#
|
2022
|
+
# @example Request syntax with placeholder values
|
2023
|
+
#
|
2024
|
+
# resp = client.get_profile({
|
2025
|
+
# profile_arn: "ProfileArn", # required
|
2026
|
+
# profile_version: "ProfileVersion",
|
2027
|
+
# })
|
2028
|
+
#
|
2029
|
+
# @example Response structure
|
2030
|
+
#
|
2031
|
+
# resp.profile.profile_arn #=> String
|
2032
|
+
# resp.profile.profile_version #=> String
|
2033
|
+
# resp.profile.profile_name #=> String
|
2034
|
+
# resp.profile.profile_description #=> String
|
2035
|
+
# resp.profile.profile_questions #=> Array
|
2036
|
+
# resp.profile.profile_questions[0].question_id #=> String
|
2037
|
+
# resp.profile.profile_questions[0].question_title #=> String
|
2038
|
+
# resp.profile.profile_questions[0].question_description #=> String
|
2039
|
+
# resp.profile.profile_questions[0].question_choices #=> Array
|
2040
|
+
# resp.profile.profile_questions[0].question_choices[0].choice_id #=> String
|
2041
|
+
# resp.profile.profile_questions[0].question_choices[0].choice_title #=> String
|
2042
|
+
# resp.profile.profile_questions[0].question_choices[0].choice_description #=> String
|
2043
|
+
# resp.profile.profile_questions[0].selected_choice_ids #=> Array
|
2044
|
+
# resp.profile.profile_questions[0].selected_choice_ids[0] #=> String
|
2045
|
+
# resp.profile.profile_questions[0].min_selected_choices #=> Integer
|
2046
|
+
# resp.profile.profile_questions[0].max_selected_choices #=> Integer
|
2047
|
+
# resp.profile.owner #=> String
|
2048
|
+
# resp.profile.created_at #=> Time
|
2049
|
+
# resp.profile.updated_at #=> Time
|
2050
|
+
# resp.profile.share_invitation_id #=> String
|
2051
|
+
# resp.profile.tags #=> Hash
|
2052
|
+
# resp.profile.tags["TagKey"] #=> String
|
2053
|
+
#
|
2054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetProfile AWS API Documentation
|
2055
|
+
#
|
2056
|
+
# @overload get_profile(params = {})
|
2057
|
+
# @param [Hash] params ({})
|
2058
|
+
def get_profile(params = {}, options = {})
|
2059
|
+
req = build_request(:get_profile, params)
|
2060
|
+
req.send_request(options)
|
2061
|
+
end
|
2062
|
+
|
2063
|
+
# Get profile template.
|
2064
|
+
#
|
2065
|
+
# @return [Types::GetProfileTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2066
|
+
#
|
2067
|
+
# * {Types::GetProfileTemplateOutput#profile_template #profile_template} => Types::ProfileTemplate
|
2068
|
+
#
|
2069
|
+
# @example Response structure
|
2070
|
+
#
|
2071
|
+
# resp.profile_template.template_name #=> String
|
2072
|
+
# resp.profile_template.template_questions #=> Array
|
2073
|
+
# resp.profile_template.template_questions[0].question_id #=> String
|
2074
|
+
# resp.profile_template.template_questions[0].question_title #=> String
|
2075
|
+
# resp.profile_template.template_questions[0].question_description #=> String
|
2076
|
+
# resp.profile_template.template_questions[0].question_choices #=> Array
|
2077
|
+
# resp.profile_template.template_questions[0].question_choices[0].choice_id #=> String
|
2078
|
+
# resp.profile_template.template_questions[0].question_choices[0].choice_title #=> String
|
2079
|
+
# resp.profile_template.template_questions[0].question_choices[0].choice_description #=> String
|
2080
|
+
# resp.profile_template.template_questions[0].min_selected_choices #=> Integer
|
2081
|
+
# resp.profile_template.template_questions[0].max_selected_choices #=> Integer
|
2082
|
+
# resp.profile_template.created_at #=> Time
|
2083
|
+
# resp.profile_template.updated_at #=> Time
|
2084
|
+
#
|
2085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetProfileTemplate AWS API Documentation
|
2086
|
+
#
|
2087
|
+
# @overload get_profile_template(params = {})
|
2088
|
+
# @param [Hash] params ({})
|
2089
|
+
def get_profile_template(params = {}, options = {})
|
2090
|
+
req = build_request(:get_profile_template, params)
|
2091
|
+
req.send_request(options)
|
2092
|
+
end
|
2093
|
+
|
1722
2094
|
# Get an existing workload.
|
1723
2095
|
#
|
1724
2096
|
# @option params [required, String] :workload_id
|
@@ -1772,6 +2144,11 @@ module Aws::WellArchitected
|
|
1772
2144
|
# resp.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
|
1773
2145
|
# resp.workload.applications #=> Array
|
1774
2146
|
# resp.workload.applications[0] #=> String
|
2147
|
+
# resp.workload.profiles #=> Array
|
2148
|
+
# resp.workload.profiles[0].profile_arn #=> String
|
2149
|
+
# resp.workload.profiles[0].profile_version #=> String
|
2150
|
+
# resp.workload.prioritized_risk_counts #=> Hash
|
2151
|
+
# resp.workload.prioritized_risk_counts["Risk"] #=> Integer
|
1775
2152
|
#
|
1776
2153
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkload AWS API Documentation
|
1777
2154
|
#
|
@@ -1915,6 +2292,9 @@ module Aws::WellArchitected
|
|
1915
2292
|
# @option params [Integer] :max_results
|
1916
2293
|
# The maximum number of results to return for this request.
|
1917
2294
|
#
|
2295
|
+
# @option params [String] :question_priority
|
2296
|
+
# The priority of the question.
|
2297
|
+
#
|
1918
2298
|
# @return [Types::ListAnswersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1919
2299
|
#
|
1920
2300
|
# * {Types::ListAnswersOutput#workload_id #workload_id} => String
|
@@ -1935,6 +2315,7 @@ module Aws::WellArchitected
|
|
1935
2315
|
# milestone_number: 1,
|
1936
2316
|
# next_token: "NextToken",
|
1937
2317
|
# max_results: 1,
|
2318
|
+
# question_priority: "PRIORITIZED", # accepts PRIORITIZED, NONE
|
1938
2319
|
# })
|
1939
2320
|
#
|
1940
2321
|
# @example Response structure
|
@@ -1969,6 +2350,7 @@ module Aws::WellArchitected
|
|
1969
2350
|
# resp.answer_summaries[0].is_applicable #=> Boolean
|
1970
2351
|
# resp.answer_summaries[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
|
1971
2352
|
# resp.answer_summaries[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
|
2353
|
+
# resp.answer_summaries[0].question_type #=> String, one of "PRIORITIZED", "NON_PRIORITIZED"
|
1972
2354
|
# resp.next_token #=> String
|
1973
2355
|
#
|
1974
2356
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListAnswers AWS API Documentation
|
@@ -2161,6 +2543,9 @@ module Aws::WellArchitected
|
|
2161
2543
|
# @option params [Integer] :max_results
|
2162
2544
|
# The maximum number of results to return for this request.
|
2163
2545
|
#
|
2546
|
+
# @option params [String] :question_priority
|
2547
|
+
# The priority of the question.
|
2548
|
+
#
|
2164
2549
|
# @return [Types::ListLensReviewImprovementsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2165
2550
|
#
|
2166
2551
|
# * {Types::ListLensReviewImprovementsOutput#workload_id #workload_id} => String
|
@@ -2181,6 +2566,7 @@ module Aws::WellArchitected
|
|
2181
2566
|
# milestone_number: 1,
|
2182
2567
|
# next_token: "NextToken",
|
2183
2568
|
# max_results: 1,
|
2569
|
+
# question_priority: "PRIORITIZED", # accepts PRIORITIZED, NONE
|
2184
2570
|
# })
|
2185
2571
|
#
|
2186
2572
|
# @example Response structure
|
@@ -2258,6 +2644,11 @@ module Aws::WellArchitected
|
|
2258
2644
|
# resp.lens_review_summaries[0].updated_at #=> Time
|
2259
2645
|
# resp.lens_review_summaries[0].risk_counts #=> Hash
|
2260
2646
|
# resp.lens_review_summaries[0].risk_counts["Risk"] #=> Integer
|
2647
|
+
# resp.lens_review_summaries[0].profiles #=> Array
|
2648
|
+
# resp.lens_review_summaries[0].profiles[0].profile_arn #=> String
|
2649
|
+
# resp.lens_review_summaries[0].profiles[0].profile_version #=> String
|
2650
|
+
# resp.lens_review_summaries[0].prioritized_risk_counts #=> Hash
|
2651
|
+
# resp.lens_review_summaries[0].prioritized_risk_counts["Risk"] #=> Integer
|
2261
2652
|
# resp.next_token #=> String
|
2262
2653
|
#
|
2263
2654
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviews AWS API Documentation
|
@@ -2296,7 +2687,7 @@ module Aws::WellArchitected
|
|
2296
2687
|
# The maximum number of results to return for this request.
|
2297
2688
|
#
|
2298
2689
|
# @option params [String] :status
|
2299
|
-
# The status of
|
2690
|
+
# The status of the share request.
|
2300
2691
|
#
|
2301
2692
|
# @return [Types::ListLensSharesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2302
2693
|
#
|
@@ -2436,6 +2827,11 @@ module Aws::WellArchitected
|
|
2436
2827
|
# resp.milestone_summaries[0].workload_summary.risk_counts #=> Hash
|
2437
2828
|
# resp.milestone_summaries[0].workload_summary.risk_counts["Risk"] #=> Integer
|
2438
2829
|
# resp.milestone_summaries[0].workload_summary.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
|
2830
|
+
# resp.milestone_summaries[0].workload_summary.profiles #=> Array
|
2831
|
+
# resp.milestone_summaries[0].workload_summary.profiles[0].profile_arn #=> String
|
2832
|
+
# resp.milestone_summaries[0].workload_summary.profiles[0].profile_version #=> String
|
2833
|
+
# resp.milestone_summaries[0].workload_summary.prioritized_risk_counts #=> Hash
|
2834
|
+
# resp.milestone_summaries[0].workload_summary.prioritized_risk_counts["Risk"] #=> Integer
|
2439
2835
|
# resp.next_token #=> String
|
2440
2836
|
#
|
2441
2837
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListMilestones AWS API Documentation
|
@@ -2495,6 +2891,158 @@ module Aws::WellArchitected
|
|
2495
2891
|
req.send_request(options)
|
2496
2892
|
end
|
2497
2893
|
|
2894
|
+
# List profile notifications.
|
2895
|
+
#
|
2896
|
+
# @option params [String] :workload_id
|
2897
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2898
|
+
# Web Services Region.
|
2899
|
+
#
|
2900
|
+
# @option params [String] :next_token
|
2901
|
+
# The token to use to retrieve the next set of results.
|
2902
|
+
#
|
2903
|
+
# @option params [Integer] :max_results
|
2904
|
+
# The maximum number of results to return for this request.
|
2905
|
+
#
|
2906
|
+
# @return [Types::ListProfileNotificationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2907
|
+
#
|
2908
|
+
# * {Types::ListProfileNotificationsOutput#notification_summaries #notification_summaries} => Array<Types::ProfileNotificationSummary>
|
2909
|
+
# * {Types::ListProfileNotificationsOutput#next_token #next_token} => String
|
2910
|
+
#
|
2911
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2912
|
+
#
|
2913
|
+
# @example Request syntax with placeholder values
|
2914
|
+
#
|
2915
|
+
# resp = client.list_profile_notifications({
|
2916
|
+
# workload_id: "WorkloadId",
|
2917
|
+
# next_token: "NextToken",
|
2918
|
+
# max_results: 1,
|
2919
|
+
# })
|
2920
|
+
#
|
2921
|
+
# @example Response structure
|
2922
|
+
#
|
2923
|
+
# resp.notification_summaries #=> Array
|
2924
|
+
# resp.notification_summaries[0].current_profile_version #=> String
|
2925
|
+
# resp.notification_summaries[0].latest_profile_version #=> String
|
2926
|
+
# resp.notification_summaries[0].type #=> String, one of "PROFILE_ANSWERS_UPDATED", "PROFILE_DELETED"
|
2927
|
+
# resp.notification_summaries[0].profile_arn #=> String
|
2928
|
+
# resp.notification_summaries[0].profile_name #=> String
|
2929
|
+
# resp.notification_summaries[0].workload_id #=> String
|
2930
|
+
# resp.notification_summaries[0].workload_name #=> String
|
2931
|
+
# resp.next_token #=> String
|
2932
|
+
#
|
2933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListProfileNotifications AWS API Documentation
|
2934
|
+
#
|
2935
|
+
# @overload list_profile_notifications(params = {})
|
2936
|
+
# @param [Hash] params ({})
|
2937
|
+
def list_profile_notifications(params = {}, options = {})
|
2938
|
+
req = build_request(:list_profile_notifications, params)
|
2939
|
+
req.send_request(options)
|
2940
|
+
end
|
2941
|
+
|
2942
|
+
# List profile shares.
|
2943
|
+
#
|
2944
|
+
# @option params [required, String] :profile_arn
|
2945
|
+
# The profile ARN.
|
2946
|
+
#
|
2947
|
+
# @option params [String] :shared_with_prefix
|
2948
|
+
# The Amazon Web Services account ID, IAM role, organization ID, or
|
2949
|
+
# organizational unit (OU) ID with which the profile is shared.
|
2950
|
+
#
|
2951
|
+
# @option params [String] :next_token
|
2952
|
+
# The token to use to retrieve the next set of results.
|
2953
|
+
#
|
2954
|
+
# @option params [Integer] :max_results
|
2955
|
+
# The maximum number of results to return for this request.
|
2956
|
+
#
|
2957
|
+
# @option params [String] :status
|
2958
|
+
# The status of the share request.
|
2959
|
+
#
|
2960
|
+
# @return [Types::ListProfileSharesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2961
|
+
#
|
2962
|
+
# * {Types::ListProfileSharesOutput#profile_share_summaries #profile_share_summaries} => Array<Types::ProfileShareSummary>
|
2963
|
+
# * {Types::ListProfileSharesOutput#next_token #next_token} => String
|
2964
|
+
#
|
2965
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2966
|
+
#
|
2967
|
+
# @example Request syntax with placeholder values
|
2968
|
+
#
|
2969
|
+
# resp = client.list_profile_shares({
|
2970
|
+
# profile_arn: "ProfileArn", # required
|
2971
|
+
# shared_with_prefix: "SharedWithPrefix",
|
2972
|
+
# next_token: "NextToken",
|
2973
|
+
# max_results: 1,
|
2974
|
+
# status: "ACCEPTED", # accepts ACCEPTED, REJECTED, PENDING, REVOKED, EXPIRED, ASSOCIATING, ASSOCIATED, FAILED
|
2975
|
+
# })
|
2976
|
+
#
|
2977
|
+
# @example Response structure
|
2978
|
+
#
|
2979
|
+
# resp.profile_share_summaries #=> Array
|
2980
|
+
# resp.profile_share_summaries[0].share_id #=> String
|
2981
|
+
# resp.profile_share_summaries[0].shared_with #=> String
|
2982
|
+
# resp.profile_share_summaries[0].status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED", "ASSOCIATING", "ASSOCIATED", "FAILED"
|
2983
|
+
# resp.profile_share_summaries[0].status_message #=> String
|
2984
|
+
# resp.next_token #=> String
|
2985
|
+
#
|
2986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListProfileShares AWS API Documentation
|
2987
|
+
#
|
2988
|
+
# @overload list_profile_shares(params = {})
|
2989
|
+
# @param [Hash] params ({})
|
2990
|
+
def list_profile_shares(params = {}, options = {})
|
2991
|
+
req = build_request(:list_profile_shares, params)
|
2992
|
+
req.send_request(options)
|
2993
|
+
end
|
2994
|
+
|
2995
|
+
# List profiles.
|
2996
|
+
#
|
2997
|
+
# @option params [String] :profile_name_prefix
|
2998
|
+
# Prefix for profile name.
|
2999
|
+
#
|
3000
|
+
# @option params [String] :profile_owner_type
|
3001
|
+
# Profile owner type.
|
3002
|
+
#
|
3003
|
+
# @option params [String] :next_token
|
3004
|
+
# The token to use to retrieve the next set of results.
|
3005
|
+
#
|
3006
|
+
# @option params [Integer] :max_results
|
3007
|
+
# The maximum number of results to return for this request.
|
3008
|
+
#
|
3009
|
+
# @return [Types::ListProfilesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3010
|
+
#
|
3011
|
+
# * {Types::ListProfilesOutput#profile_summaries #profile_summaries} => Array<Types::ProfileSummary>
|
3012
|
+
# * {Types::ListProfilesOutput#next_token #next_token} => String
|
3013
|
+
#
|
3014
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3015
|
+
#
|
3016
|
+
# @example Request syntax with placeholder values
|
3017
|
+
#
|
3018
|
+
# resp = client.list_profiles({
|
3019
|
+
# profile_name_prefix: "ProfileNamePrefix",
|
3020
|
+
# profile_owner_type: "SELF", # accepts SELF, SHARED
|
3021
|
+
# next_token: "NextToken",
|
3022
|
+
# max_results: 1,
|
3023
|
+
# })
|
3024
|
+
#
|
3025
|
+
# @example Response structure
|
3026
|
+
#
|
3027
|
+
# resp.profile_summaries #=> Array
|
3028
|
+
# resp.profile_summaries[0].profile_arn #=> String
|
3029
|
+
# resp.profile_summaries[0].profile_version #=> String
|
3030
|
+
# resp.profile_summaries[0].profile_name #=> String
|
3031
|
+
# resp.profile_summaries[0].profile_description #=> String
|
3032
|
+
# resp.profile_summaries[0].owner #=> String
|
3033
|
+
# resp.profile_summaries[0].created_at #=> Time
|
3034
|
+
# resp.profile_summaries[0].updated_at #=> Time
|
3035
|
+
# resp.next_token #=> String
|
3036
|
+
#
|
3037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListProfiles AWS API Documentation
|
3038
|
+
#
|
3039
|
+
# @overload list_profiles(params = {})
|
3040
|
+
# @param [Hash] params ({})
|
3041
|
+
def list_profiles(params = {}, options = {})
|
3042
|
+
req = build_request(:list_profiles, params)
|
3043
|
+
req.send_request(options)
|
3044
|
+
end
|
3045
|
+
|
2498
3046
|
# List the workload invitations.
|
2499
3047
|
#
|
2500
3048
|
# @option params [String] :workload_name_prefix
|
@@ -2514,6 +3062,9 @@ module Aws::WellArchitected
|
|
2514
3062
|
# @option params [Integer] :max_results
|
2515
3063
|
# The maximum number of results to return for this request.
|
2516
3064
|
#
|
3065
|
+
# @option params [String] :profile_name_prefix
|
3066
|
+
# Profile name prefix.
|
3067
|
+
#
|
2517
3068
|
# @return [Types::ListShareInvitationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2518
3069
|
#
|
2519
3070
|
# * {Types::ListShareInvitationsOutput#share_invitation_summaries #share_invitation_summaries} => Array<Types::ShareInvitationSummary>
|
@@ -2526,9 +3077,10 @@ module Aws::WellArchitected
|
|
2526
3077
|
# resp = client.list_share_invitations({
|
2527
3078
|
# workload_name_prefix: "WorkloadNamePrefix",
|
2528
3079
|
# lens_name_prefix: "LensNamePrefix",
|
2529
|
-
# share_resource_type: "WORKLOAD", # accepts WORKLOAD, LENS
|
3080
|
+
# share_resource_type: "WORKLOAD", # accepts WORKLOAD, LENS, PROFILE
|
2530
3081
|
# next_token: "NextToken",
|
2531
3082
|
# max_results: 1,
|
3083
|
+
# profile_name_prefix: "ProfileNamePrefix",
|
2532
3084
|
# })
|
2533
3085
|
#
|
2534
3086
|
# @example Response structure
|
@@ -2538,11 +3090,13 @@ module Aws::WellArchitected
|
|
2538
3090
|
# resp.share_invitation_summaries[0].shared_by #=> String
|
2539
3091
|
# resp.share_invitation_summaries[0].shared_with #=> String
|
2540
3092
|
# resp.share_invitation_summaries[0].permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
|
2541
|
-
# resp.share_invitation_summaries[0].share_resource_type #=> String, one of "WORKLOAD", "LENS"
|
3093
|
+
# resp.share_invitation_summaries[0].share_resource_type #=> String, one of "WORKLOAD", "LENS", "PROFILE"
|
2542
3094
|
# resp.share_invitation_summaries[0].workload_name #=> String
|
2543
3095
|
# resp.share_invitation_summaries[0].workload_id #=> String
|
2544
3096
|
# resp.share_invitation_summaries[0].lens_name #=> String
|
2545
3097
|
# resp.share_invitation_summaries[0].lens_arn #=> String
|
3098
|
+
# resp.share_invitation_summaries[0].profile_name #=> String
|
3099
|
+
# resp.share_invitation_summaries[0].profile_arn #=> String
|
2546
3100
|
# resp.next_token #=> String
|
2547
3101
|
#
|
2548
3102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitations AWS API Documentation
|
@@ -2556,8 +3110,8 @@ module Aws::WellArchitected
|
|
2556
3110
|
|
2557
3111
|
# List the tags for a resource.
|
2558
3112
|
#
|
2559
|
-
# <note markdown="1"> The WorkloadArn parameter can be
|
2560
|
-
#
|
3113
|
+
# <note markdown="1"> The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or
|
3114
|
+
# a profile ARN.
|
2561
3115
|
#
|
2562
3116
|
# </note>
|
2563
3117
|
#
|
@@ -2605,7 +3159,7 @@ module Aws::WellArchitected
|
|
2605
3159
|
# The maximum number of results to return for this request.
|
2606
3160
|
#
|
2607
3161
|
# @option params [String] :status
|
2608
|
-
# The status of
|
3162
|
+
# The status of the share request.
|
2609
3163
|
#
|
2610
3164
|
# @return [Types::ListWorkloadSharesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2611
3165
|
#
|
@@ -2685,6 +3239,11 @@ module Aws::WellArchitected
|
|
2685
3239
|
# resp.workload_summaries[0].risk_counts #=> Hash
|
2686
3240
|
# resp.workload_summaries[0].risk_counts["Risk"] #=> Integer
|
2687
3241
|
# resp.workload_summaries[0].improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
|
3242
|
+
# resp.workload_summaries[0].profiles #=> Array
|
3243
|
+
# resp.workload_summaries[0].profiles[0].profile_arn #=> String
|
3244
|
+
# resp.workload_summaries[0].profiles[0].profile_version #=> String
|
3245
|
+
# resp.workload_summaries[0].prioritized_risk_counts #=> Hash
|
3246
|
+
# resp.workload_summaries[0].prioritized_risk_counts["Risk"] #=> Integer
|
2688
3247
|
# resp.next_token #=> String
|
2689
3248
|
#
|
2690
3249
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloads AWS API Documentation
|
@@ -2698,8 +3257,8 @@ module Aws::WellArchitected
|
|
2698
3257
|
|
2699
3258
|
# Adds one or more tags to the specified resource.
|
2700
3259
|
#
|
2701
|
-
# <note markdown="1"> The WorkloadArn parameter can be
|
2702
|
-
#
|
3260
|
+
# <note markdown="1"> The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or
|
3261
|
+
# a profile ARN.
|
2703
3262
|
#
|
2704
3263
|
# </note>
|
2705
3264
|
#
|
@@ -2731,8 +3290,8 @@ module Aws::WellArchitected
|
|
2731
3290
|
|
2732
3291
|
# Deletes specified tags from a resource.
|
2733
3292
|
#
|
2734
|
-
# <note markdown="1"> The WorkloadArn parameter can be
|
2735
|
-
#
|
3293
|
+
# <note markdown="1"> The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or
|
3294
|
+
# a profile ARN.
|
2736
3295
|
#
|
2737
3296
|
# </note>
|
2738
3297
|
#
|
@@ -2962,11 +3521,18 @@ module Aws::WellArchitected
|
|
2962
3521
|
# resp.lens_review.pillar_review_summaries[0].notes #=> String
|
2963
3522
|
# resp.lens_review.pillar_review_summaries[0].risk_counts #=> Hash
|
2964
3523
|
# resp.lens_review.pillar_review_summaries[0].risk_counts["Risk"] #=> Integer
|
3524
|
+
# resp.lens_review.pillar_review_summaries[0].prioritized_risk_counts #=> Hash
|
3525
|
+
# resp.lens_review.pillar_review_summaries[0].prioritized_risk_counts["Risk"] #=> Integer
|
2965
3526
|
# resp.lens_review.updated_at #=> Time
|
2966
3527
|
# resp.lens_review.notes #=> String
|
2967
3528
|
# resp.lens_review.risk_counts #=> Hash
|
2968
3529
|
# resp.lens_review.risk_counts["Risk"] #=> Integer
|
2969
3530
|
# resp.lens_review.next_token #=> String
|
3531
|
+
# resp.lens_review.profiles #=> Array
|
3532
|
+
# resp.lens_review.profiles[0].profile_arn #=> String
|
3533
|
+
# resp.lens_review.profiles[0].profile_version #=> String
|
3534
|
+
# resp.lens_review.prioritized_risk_counts #=> Hash
|
3535
|
+
# resp.lens_review.prioritized_risk_counts["Risk"] #=> Integer
|
2970
3536
|
#
|
2971
3537
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateLensReview AWS API Documentation
|
2972
3538
|
#
|
@@ -2977,6 +3543,68 @@ module Aws::WellArchitected
|
|
2977
3543
|
req.send_request(options)
|
2978
3544
|
end
|
2979
3545
|
|
3546
|
+
# Update a profile.
|
3547
|
+
#
|
3548
|
+
# @option params [required, String] :profile_arn
|
3549
|
+
# The profile ARN.
|
3550
|
+
#
|
3551
|
+
# @option params [String] :profile_description
|
3552
|
+
# The profile description.
|
3553
|
+
#
|
3554
|
+
# @option params [Array<Types::ProfileQuestionUpdate>] :profile_questions
|
3555
|
+
# Profile questions.
|
3556
|
+
#
|
3557
|
+
# @return [Types::UpdateProfileOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3558
|
+
#
|
3559
|
+
# * {Types::UpdateProfileOutput#profile #profile} => Types::Profile
|
3560
|
+
#
|
3561
|
+
# @example Request syntax with placeholder values
|
3562
|
+
#
|
3563
|
+
# resp = client.update_profile({
|
3564
|
+
# profile_arn: "ProfileArn", # required
|
3565
|
+
# profile_description: "ProfileDescription",
|
3566
|
+
# profile_questions: [
|
3567
|
+
# {
|
3568
|
+
# question_id: "QuestionId",
|
3569
|
+
# selected_choice_ids: ["ChoiceId"],
|
3570
|
+
# },
|
3571
|
+
# ],
|
3572
|
+
# })
|
3573
|
+
#
|
3574
|
+
# @example Response structure
|
3575
|
+
#
|
3576
|
+
# resp.profile.profile_arn #=> String
|
3577
|
+
# resp.profile.profile_version #=> String
|
3578
|
+
# resp.profile.profile_name #=> String
|
3579
|
+
# resp.profile.profile_description #=> String
|
3580
|
+
# resp.profile.profile_questions #=> Array
|
3581
|
+
# resp.profile.profile_questions[0].question_id #=> String
|
3582
|
+
# resp.profile.profile_questions[0].question_title #=> String
|
3583
|
+
# resp.profile.profile_questions[0].question_description #=> String
|
3584
|
+
# resp.profile.profile_questions[0].question_choices #=> Array
|
3585
|
+
# resp.profile.profile_questions[0].question_choices[0].choice_id #=> String
|
3586
|
+
# resp.profile.profile_questions[0].question_choices[0].choice_title #=> String
|
3587
|
+
# resp.profile.profile_questions[0].question_choices[0].choice_description #=> String
|
3588
|
+
# resp.profile.profile_questions[0].selected_choice_ids #=> Array
|
3589
|
+
# resp.profile.profile_questions[0].selected_choice_ids[0] #=> String
|
3590
|
+
# resp.profile.profile_questions[0].min_selected_choices #=> Integer
|
3591
|
+
# resp.profile.profile_questions[0].max_selected_choices #=> Integer
|
3592
|
+
# resp.profile.owner #=> String
|
3593
|
+
# resp.profile.created_at #=> Time
|
3594
|
+
# resp.profile.updated_at #=> Time
|
3595
|
+
# resp.profile.share_invitation_id #=> String
|
3596
|
+
# resp.profile.tags #=> Hash
|
3597
|
+
# resp.profile.tags["TagKey"] #=> String
|
3598
|
+
#
|
3599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateProfile AWS API Documentation
|
3600
|
+
#
|
3601
|
+
# @overload update_profile(params = {})
|
3602
|
+
# @param [Hash] params ({})
|
3603
|
+
def update_profile(params = {}, options = {})
|
3604
|
+
req = build_request(:update_profile, params)
|
3605
|
+
req.send_request(options)
|
3606
|
+
end
|
3607
|
+
|
2980
3608
|
# Update a workload or custom lens share invitation.
|
2981
3609
|
#
|
2982
3610
|
# <note markdown="1"> This API operation can be called independently of any resource.
|
@@ -3004,10 +3632,11 @@ module Aws::WellArchitected
|
|
3004
3632
|
# @example Response structure
|
3005
3633
|
#
|
3006
3634
|
# resp.share_invitation.share_invitation_id #=> String
|
3007
|
-
# resp.share_invitation.share_resource_type #=> String, one of "WORKLOAD", "LENS"
|
3635
|
+
# resp.share_invitation.share_resource_type #=> String, one of "WORKLOAD", "LENS", "PROFILE"
|
3008
3636
|
# resp.share_invitation.workload_id #=> String
|
3009
3637
|
# resp.share_invitation.lens_alias #=> String
|
3010
3638
|
# resp.share_invitation.lens_arn #=> String
|
3639
|
+
# resp.share_invitation.profile_arn #=> String
|
3011
3640
|
#
|
3012
3641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitation AWS API Documentation
|
3013
3642
|
#
|
@@ -3211,6 +3840,11 @@ module Aws::WellArchitected
|
|
3211
3840
|
# resp.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
|
3212
3841
|
# resp.workload.applications #=> Array
|
3213
3842
|
# resp.workload.applications[0] #=> String
|
3843
|
+
# resp.workload.profiles #=> Array
|
3844
|
+
# resp.workload.profiles[0].profile_arn #=> String
|
3845
|
+
# resp.workload.profiles[0].profile_version #=> String
|
3846
|
+
# resp.workload.prioritized_risk_counts #=> Hash
|
3847
|
+
# resp.workload.prioritized_risk_counts["Risk"] #=> Integer
|
3214
3848
|
#
|
3215
3849
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkload AWS API Documentation
|
3216
3850
|
#
|
@@ -3224,14 +3858,14 @@ module Aws::WellArchitected
|
|
3224
3858
|
# Update a workload share.
|
3225
3859
|
#
|
3226
3860
|
# @option params [required, String] :share_id
|
3227
|
-
# The ID associated with the
|
3861
|
+
# The ID associated with the share.
|
3228
3862
|
#
|
3229
3863
|
# @option params [required, String] :workload_id
|
3230
3864
|
# The ID assigned to the workload. This ID is unique within an Amazon
|
3231
3865
|
# Web Services Region.
|
3232
3866
|
#
|
3233
3867
|
# @option params [required, String] :permission_type
|
3234
|
-
# Permission granted on a
|
3868
|
+
# Permission granted on a share request.
|
3235
3869
|
#
|
3236
3870
|
# @return [Types::UpdateWorkloadShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3237
3871
|
#
|
@@ -3325,6 +3959,57 @@ module Aws::WellArchitected
|
|
3325
3959
|
req.send_request(options)
|
3326
3960
|
end
|
3327
3961
|
|
3962
|
+
# Upgrade a profile.
|
3963
|
+
#
|
3964
|
+
# @option params [required, String] :workload_id
|
3965
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3966
|
+
# Web Services Region.
|
3967
|
+
#
|
3968
|
+
# @option params [required, String] :profile_arn
|
3969
|
+
# The profile ARN.
|
3970
|
+
#
|
3971
|
+
# @option params [String] :milestone_name
|
3972
|
+
# The name of the milestone in a workload.
|
3973
|
+
#
|
3974
|
+
# Milestone names must be unique within a workload.
|
3975
|
+
#
|
3976
|
+
# @option params [String] :client_request_token
|
3977
|
+
# A unique case-sensitive string used to ensure that this request is
|
3978
|
+
# idempotent (executes only once).
|
3979
|
+
#
|
3980
|
+
# You should not reuse the same token for other requests. If you retry a
|
3981
|
+
# request with the same client request token and the same parameters
|
3982
|
+
# after the original request has completed successfully, the result of
|
3983
|
+
# the original request is returned.
|
3984
|
+
#
|
3985
|
+
# This token is listed as required, however, if you do not specify it,
|
3986
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
3987
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
3988
|
+
# provide this token or the request will fail.
|
3989
|
+
#
|
3990
|
+
# **A suitable default value is auto-generated.** You should normally
|
3991
|
+
# not need to pass this option.**
|
3992
|
+
#
|
3993
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3994
|
+
#
|
3995
|
+
# @example Request syntax with placeholder values
|
3996
|
+
#
|
3997
|
+
# resp = client.upgrade_profile_version({
|
3998
|
+
# workload_id: "WorkloadId", # required
|
3999
|
+
# profile_arn: "ProfileArn", # required
|
4000
|
+
# milestone_name: "MilestoneName",
|
4001
|
+
# client_request_token: "ClientRequestToken",
|
4002
|
+
# })
|
4003
|
+
#
|
4004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpgradeProfileVersion AWS API Documentation
|
4005
|
+
#
|
4006
|
+
# @overload upgrade_profile_version(params = {})
|
4007
|
+
# @param [Hash] params ({})
|
4008
|
+
def upgrade_profile_version(params = {}, options = {})
|
4009
|
+
req = build_request(:upgrade_profile_version, params)
|
4010
|
+
req.send_request(options)
|
4011
|
+
end
|
4012
|
+
|
3328
4013
|
# @!endgroup
|
3329
4014
|
|
3330
4015
|
# @param params ({})
|
@@ -3338,7 +4023,7 @@ module Aws::WellArchitected
|
|
3338
4023
|
params: params,
|
3339
4024
|
config: config)
|
3340
4025
|
context[:gem_name] = 'aws-sdk-wellarchitected'
|
3341
|
-
context[:gem_version] = '1.
|
4026
|
+
context[:gem_version] = '1.25.0'
|
3342
4027
|
Seahorse::Client::Request.new(handlers, context)
|
3343
4028
|
end
|
3344
4029
|
|