aws-sdk-wellarchitected 1.29.0 → 1.30.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-wellarchitected/client.rb +1077 -95
- data/lib/aws-sdk-wellarchitected/client_api.rb +485 -0
- data/lib/aws-sdk-wellarchitected/endpoints.rb +196 -0
- data/lib/aws-sdk-wellarchitected/plugins/endpoints.rb +28 -0
- data/lib/aws-sdk-wellarchitected/types.rb +1379 -121
- data/lib/aws-sdk-wellarchitected.rb +1 -1
- metadata +2 -2
@@ -503,9 +503,9 @@ module Aws::WellArchitected
|
|
503
503
|
# Each lens is identified by its LensSummary$LensAlias.
|
504
504
|
#
|
505
505
|
# @option params [required, String] :shared_with
|
506
|
-
# The Amazon Web Services account ID,
|
507
|
-
#
|
508
|
-
# is shared.
|
506
|
+
# The Amazon Web Services account ID, organization ID, or organizational
|
507
|
+
# unit (OU) ID with which the workload, lens, profile, or review
|
508
|
+
# template is shared.
|
509
509
|
#
|
510
510
|
# @option params [required, String] :client_request_token
|
511
511
|
# A unique case-sensitive string used to ensure that this request is
|
@@ -752,9 +752,9 @@ module Aws::WellArchitected
|
|
752
752
|
# The profile ARN.
|
753
753
|
#
|
754
754
|
# @option params [required, String] :shared_with
|
755
|
-
# The Amazon Web Services account ID,
|
756
|
-
#
|
757
|
-
# is shared.
|
755
|
+
# The Amazon Web Services account ID, organization ID, or organizational
|
756
|
+
# unit (OU) ID with which the workload, lens, profile, or review
|
757
|
+
# template is shared.
|
758
758
|
#
|
759
759
|
# @option params [required, String] :client_request_token
|
760
760
|
# A unique case-sensitive string used to ensure that this request is
|
@@ -800,6 +800,158 @@ module Aws::WellArchitected
|
|
800
800
|
req.send_request(options)
|
801
801
|
end
|
802
802
|
|
803
|
+
# Create a review template.
|
804
|
+
#
|
805
|
+
# <note markdown="1"> **Disclaimer**
|
806
|
+
#
|
807
|
+
# Do not include or gather personal identifiable information (PII) of
|
808
|
+
# end users or other identifiable individuals in or via your review
|
809
|
+
# templates. If your review template or those shared with you and used
|
810
|
+
# in your account do include or collect PII you are responsible for:
|
811
|
+
# ensuring that the included PII is processed in accordance with
|
812
|
+
# applicable law, providing adequate privacy notices, and obtaining
|
813
|
+
# necessary consents for processing such data.
|
814
|
+
#
|
815
|
+
# </note>
|
816
|
+
#
|
817
|
+
# @option params [required, String] :template_name
|
818
|
+
# Name of the review template.
|
819
|
+
#
|
820
|
+
# @option params [required, String] :description
|
821
|
+
# The review template description.
|
822
|
+
#
|
823
|
+
# @option params [required, Array<String>] :lenses
|
824
|
+
# Lenses applied to the review template.
|
825
|
+
#
|
826
|
+
# @option params [String] :notes
|
827
|
+
# The notes associated with the workload.
|
828
|
+
#
|
829
|
+
# For a review template, these are the notes that will be associated
|
830
|
+
# with the workload when the template is applied.
|
831
|
+
#
|
832
|
+
# @option params [Hash<String,String>] :tags
|
833
|
+
# The tags assigned to the review template.
|
834
|
+
#
|
835
|
+
# @option params [required, String] :client_request_token
|
836
|
+
# A unique case-sensitive string used to ensure that this request is
|
837
|
+
# idempotent (executes only once).
|
838
|
+
#
|
839
|
+
# You should not reuse the same token for other requests. If you retry a
|
840
|
+
# request with the same client request token and the same parameters
|
841
|
+
# after the original request has completed successfully, the result of
|
842
|
+
# the original request is returned.
|
843
|
+
#
|
844
|
+
# This token is listed as required, however, if you do not specify it,
|
845
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
846
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
847
|
+
# provide this token or the request will fail.
|
848
|
+
#
|
849
|
+
# **A suitable default value is auto-generated.** You should normally
|
850
|
+
# not need to pass this option.**
|
851
|
+
#
|
852
|
+
# @return [Types::CreateReviewTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
853
|
+
#
|
854
|
+
# * {Types::CreateReviewTemplateOutput#template_arn #template_arn} => String
|
855
|
+
#
|
856
|
+
# @example Request syntax with placeholder values
|
857
|
+
#
|
858
|
+
# resp = client.create_review_template({
|
859
|
+
# template_name: "TemplateName", # required
|
860
|
+
# description: "TemplateDescription", # required
|
861
|
+
# lenses: ["LensAlias"], # required
|
862
|
+
# notes: "Notes",
|
863
|
+
# tags: {
|
864
|
+
# "TagKey" => "TagValue",
|
865
|
+
# },
|
866
|
+
# client_request_token: "ClientRequestToken", # required
|
867
|
+
# })
|
868
|
+
#
|
869
|
+
# @example Response structure
|
870
|
+
#
|
871
|
+
# resp.template_arn #=> String
|
872
|
+
#
|
873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateReviewTemplate AWS API Documentation
|
874
|
+
#
|
875
|
+
# @overload create_review_template(params = {})
|
876
|
+
# @param [Hash] params ({})
|
877
|
+
def create_review_template(params = {}, options = {})
|
878
|
+
req = build_request(:create_review_template, params)
|
879
|
+
req.send_request(options)
|
880
|
+
end
|
881
|
+
|
882
|
+
# Create a review template share.
|
883
|
+
#
|
884
|
+
# The owner of a review template can share it with other Amazon Web
|
885
|
+
# Services accounts, users, an organization, and organizational units
|
886
|
+
# (OUs) in the same Amazon Web Services Region.
|
887
|
+
#
|
888
|
+
# Shared access to a review template is not removed until the review
|
889
|
+
# template share invitation is deleted.
|
890
|
+
#
|
891
|
+
# If you share a review template with an organization or OU, all
|
892
|
+
# accounts in the organization or OU are granted access to the review
|
893
|
+
# template.
|
894
|
+
#
|
895
|
+
# <note markdown="1"> **Disclaimer**
|
896
|
+
#
|
897
|
+
# By sharing your review template with other Amazon Web Services
|
898
|
+
# accounts, you acknowledge that Amazon Web Services will make your
|
899
|
+
# review template available to those other accounts.
|
900
|
+
#
|
901
|
+
# </note>
|
902
|
+
#
|
903
|
+
# @option params [required, String] :template_arn
|
904
|
+
# The review template ARN.
|
905
|
+
#
|
906
|
+
# @option params [required, String] :shared_with
|
907
|
+
# The Amazon Web Services account ID, organization ID, or organizational
|
908
|
+
# unit (OU) ID with which the workload, lens, profile, or review
|
909
|
+
# template is shared.
|
910
|
+
#
|
911
|
+
# @option params [required, String] :client_request_token
|
912
|
+
# A unique case-sensitive string used to ensure that this request is
|
913
|
+
# idempotent (executes only once).
|
914
|
+
#
|
915
|
+
# You should not reuse the same token for other requests. If you retry a
|
916
|
+
# request with the same client request token and the same parameters
|
917
|
+
# after the original request has completed successfully, the result of
|
918
|
+
# the original request is returned.
|
919
|
+
#
|
920
|
+
# This token is listed as required, however, if you do not specify it,
|
921
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
922
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
923
|
+
# provide this token or the request will fail.
|
924
|
+
#
|
925
|
+
# **A suitable default value is auto-generated.** You should normally
|
926
|
+
# not need to pass this option.**
|
927
|
+
#
|
928
|
+
# @return [Types::CreateTemplateShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
929
|
+
#
|
930
|
+
# * {Types::CreateTemplateShareOutput#template_arn #template_arn} => String
|
931
|
+
# * {Types::CreateTemplateShareOutput#share_id #share_id} => String
|
932
|
+
#
|
933
|
+
# @example Request syntax with placeholder values
|
934
|
+
#
|
935
|
+
# resp = client.create_template_share({
|
936
|
+
# template_arn: "TemplateArn", # required
|
937
|
+
# shared_with: "SharedWith", # required
|
938
|
+
# client_request_token: "ClientRequestToken", # required
|
939
|
+
# })
|
940
|
+
#
|
941
|
+
# @example Response structure
|
942
|
+
#
|
943
|
+
# resp.template_arn #=> String
|
944
|
+
# resp.share_id #=> String
|
945
|
+
#
|
946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateTemplateShare AWS API Documentation
|
947
|
+
#
|
948
|
+
# @overload create_template_share(params = {})
|
949
|
+
# @param [Hash] params ({})
|
950
|
+
def create_template_share(params = {}, options = {})
|
951
|
+
req = build_request(:create_template_share, params)
|
952
|
+
req.send_request(options)
|
953
|
+
end
|
954
|
+
|
803
955
|
# Create a new workload.
|
804
956
|
#
|
805
957
|
# The owner of a workload can share the workload with other Amazon Web
|
@@ -816,6 +968,17 @@ module Aws::WellArchitected
|
|
816
968
|
# You also must specify `ReviewOwner`, even though the parameter is
|
817
969
|
# listed as not being required in the following section.
|
818
970
|
#
|
971
|
+
# When creating a workload using a review template, you must have the
|
972
|
+
# following IAM permissions:
|
973
|
+
#
|
974
|
+
# * `wellarchitected:GetReviewTemplate`
|
975
|
+
#
|
976
|
+
# * `wellarchitected:GetReviewTemplateAnswer`
|
977
|
+
#
|
978
|
+
# * `wellarchitected:ListReviewTemplateAnswers`
|
979
|
+
#
|
980
|
+
# * `wellarchitected:GetReviewTemplateLensReview`
|
981
|
+
#
|
819
982
|
#
|
820
983
|
#
|
821
984
|
# [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html
|
@@ -924,9 +1087,15 @@ module Aws::WellArchitected
|
|
924
1087
|
# The list of lenses associated with the workload. Each lens is
|
925
1088
|
# identified by its LensSummary$LensAlias.
|
926
1089
|
#
|
1090
|
+
# If a review template that specifies lenses is applied to the workload,
|
1091
|
+
# those lenses are applied to the workload in addition to these lenses.
|
1092
|
+
#
|
927
1093
|
# @option params [String] :notes
|
928
1094
|
# The notes associated with the workload.
|
929
1095
|
#
|
1096
|
+
# For a review template, these are the notes that will be associated
|
1097
|
+
# with the workload when the template is applied.
|
1098
|
+
#
|
930
1099
|
# @option params [required, String] :client_request_token
|
931
1100
|
# A unique case-sensitive string used to ensure that this request is
|
932
1101
|
# idempotent (executes only once).
|
@@ -957,6 +1126,9 @@ module Aws::WellArchitected
|
|
957
1126
|
# @option params [Array<String>] :profile_arns
|
958
1127
|
# The list of profile ARNs associated with the workload.
|
959
1128
|
#
|
1129
|
+
# @option params [Array<String>] :review_template_arns
|
1130
|
+
# The list of review template ARNs to associate with the workload.
|
1131
|
+
#
|
960
1132
|
# @return [Types::CreateWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
961
1133
|
#
|
962
1134
|
# * {Types::CreateWorkloadOutput#workload_id #workload_id} => String
|
@@ -988,6 +1160,7 @@ module Aws::WellArchitected
|
|
988
1160
|
# },
|
989
1161
|
# applications: ["ApplicationArn"],
|
990
1162
|
# profile_arns: ["ProfileArn"],
|
1163
|
+
# review_template_arns: ["TemplateArn"],
|
991
1164
|
# })
|
992
1165
|
#
|
993
1166
|
# @example Response structure
|
@@ -1026,9 +1199,9 @@ module Aws::WellArchitected
|
|
1026
1199
|
# Web Services Region.
|
1027
1200
|
#
|
1028
1201
|
# @option params [required, String] :shared_with
|
1029
|
-
# The Amazon Web Services account ID,
|
1030
|
-
#
|
1031
|
-
# is shared.
|
1202
|
+
# The Amazon Web Services account ID, organization ID, or organizational
|
1203
|
+
# unit (OU) ID with which the workload, lens, profile, or review
|
1204
|
+
# template is shared.
|
1032
1205
|
#
|
1033
1206
|
# @option params [required, String] :permission_type
|
1034
1207
|
# Permission granted on a share request.
|
@@ -1315,6 +1488,102 @@ module Aws::WellArchitected
|
|
1315
1488
|
req.send_request(options)
|
1316
1489
|
end
|
1317
1490
|
|
1491
|
+
# Delete a review template.
|
1492
|
+
#
|
1493
|
+
# Only the owner of a review template can delete it.
|
1494
|
+
#
|
1495
|
+
# After the review template is deleted, Amazon Web Services accounts,
|
1496
|
+
# users, organizations, and organizational units (OUs) that you shared
|
1497
|
+
# the review template with will no longer be able to apply it to new
|
1498
|
+
# workloads.
|
1499
|
+
#
|
1500
|
+
# @option params [required, String] :template_arn
|
1501
|
+
# The review template ARN.
|
1502
|
+
#
|
1503
|
+
# @option params [required, String] :client_request_token
|
1504
|
+
# A unique case-sensitive string used to ensure that this request is
|
1505
|
+
# idempotent (executes only once).
|
1506
|
+
#
|
1507
|
+
# You should not reuse the same token for other requests. If you retry a
|
1508
|
+
# request with the same client request token and the same parameters
|
1509
|
+
# after the original request has completed successfully, the result of
|
1510
|
+
# the original request is returned.
|
1511
|
+
#
|
1512
|
+
# This token is listed as required, however, if you do not specify it,
|
1513
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1514
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1515
|
+
# provide this token or the request will fail.
|
1516
|
+
#
|
1517
|
+
# **A suitable default value is auto-generated.** You should normally
|
1518
|
+
# not need to pass this option.**
|
1519
|
+
#
|
1520
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1521
|
+
#
|
1522
|
+
# @example Request syntax with placeholder values
|
1523
|
+
#
|
1524
|
+
# resp = client.delete_review_template({
|
1525
|
+
# template_arn: "TemplateArn", # required
|
1526
|
+
# client_request_token: "ClientRequestToken", # required
|
1527
|
+
# })
|
1528
|
+
#
|
1529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteReviewTemplate AWS API Documentation
|
1530
|
+
#
|
1531
|
+
# @overload delete_review_template(params = {})
|
1532
|
+
# @param [Hash] params ({})
|
1533
|
+
def delete_review_template(params = {}, options = {})
|
1534
|
+
req = build_request(:delete_review_template, params)
|
1535
|
+
req.send_request(options)
|
1536
|
+
end
|
1537
|
+
|
1538
|
+
# Delete a review template share.
|
1539
|
+
#
|
1540
|
+
# After the review template share is deleted, Amazon Web Services
|
1541
|
+
# accounts, users, organizations, and organizational units (OUs) that
|
1542
|
+
# you shared the review template with will no longer be able to apply it
|
1543
|
+
# to new workloads.
|
1544
|
+
#
|
1545
|
+
# @option params [required, String] :share_id
|
1546
|
+
# The ID associated with the share.
|
1547
|
+
#
|
1548
|
+
# @option params [required, String] :template_arn
|
1549
|
+
# The review template ARN.
|
1550
|
+
#
|
1551
|
+
# @option params [required, String] :client_request_token
|
1552
|
+
# A unique case-sensitive string used to ensure that this request is
|
1553
|
+
# idempotent (executes only once).
|
1554
|
+
#
|
1555
|
+
# You should not reuse the same token for other requests. If you retry a
|
1556
|
+
# request with the same client request token and the same parameters
|
1557
|
+
# after the original request has completed successfully, the result of
|
1558
|
+
# the original request is returned.
|
1559
|
+
#
|
1560
|
+
# This token is listed as required, however, if you do not specify it,
|
1561
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1562
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1563
|
+
# provide this token or the request will fail.
|
1564
|
+
#
|
1565
|
+
# **A suitable default value is auto-generated.** You should normally
|
1566
|
+
# not need to pass this option.**
|
1567
|
+
#
|
1568
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1569
|
+
#
|
1570
|
+
# @example Request syntax with placeholder values
|
1571
|
+
#
|
1572
|
+
# resp = client.delete_template_share({
|
1573
|
+
# share_id: "ShareId", # required
|
1574
|
+
# template_arn: "TemplateArn", # required
|
1575
|
+
# client_request_token: "ClientRequestToken", # required
|
1576
|
+
# })
|
1577
|
+
#
|
1578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteTemplateShare AWS API Documentation
|
1579
|
+
#
|
1580
|
+
# @overload delete_template_share(params = {})
|
1581
|
+
# @param [Hash] params ({})
|
1582
|
+
def delete_template_share(params = {}, options = {})
|
1583
|
+
req = build_request(:delete_template_share, params)
|
1584
|
+
req.send_request(options)
|
1585
|
+
end
|
1586
|
+
|
1318
1587
|
# Delete an existing workload.
|
1319
1588
|
#
|
1320
1589
|
# @option params [required, String] :workload_id
|
@@ -2106,93 +2375,275 @@ module Aws::WellArchitected
|
|
2106
2375
|
req.send_request(options)
|
2107
2376
|
end
|
2108
2377
|
|
2109
|
-
# Get
|
2378
|
+
# Get review template.
|
2110
2379
|
#
|
2111
|
-
# @option params [required, String] :
|
2112
|
-
# The
|
2113
|
-
# Web Services Region.
|
2380
|
+
# @option params [required, String] :template_arn
|
2381
|
+
# The review template ARN.
|
2114
2382
|
#
|
2115
|
-
# @return [Types::
|
2383
|
+
# @return [Types::GetReviewTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2116
2384
|
#
|
2117
|
-
# * {Types::
|
2385
|
+
# * {Types::GetReviewTemplateOutput#review_template #review_template} => Types::ReviewTemplate
|
2118
2386
|
#
|
2119
2387
|
# @example Request syntax with placeholder values
|
2120
2388
|
#
|
2121
|
-
# resp = client.
|
2122
|
-
#
|
2389
|
+
# resp = client.get_review_template({
|
2390
|
+
# template_arn: "TemplateArn", # required
|
2123
2391
|
# })
|
2124
2392
|
#
|
2125
2393
|
# @example Response structure
|
2126
2394
|
#
|
2127
|
-
# resp.
|
2128
|
-
# resp.
|
2129
|
-
# resp.
|
2130
|
-
# resp.
|
2131
|
-
# resp.
|
2132
|
-
# resp.
|
2133
|
-
# resp.
|
2134
|
-
# resp.
|
2135
|
-
# resp.
|
2136
|
-
# resp.
|
2137
|
-
# resp.
|
2138
|
-
# resp.
|
2139
|
-
# resp.
|
2140
|
-
# resp.
|
2141
|
-
#
|
2142
|
-
#
|
2143
|
-
#
|
2144
|
-
#
|
2145
|
-
# resp.workload.notes #=> String
|
2146
|
-
# resp.workload.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
|
2147
|
-
# resp.workload.risk_counts #=> Hash
|
2148
|
-
# resp.workload.risk_counts["Risk"] #=> Integer
|
2149
|
-
# resp.workload.pillar_priorities #=> Array
|
2150
|
-
# resp.workload.pillar_priorities[0] #=> String
|
2151
|
-
# resp.workload.lenses #=> Array
|
2152
|
-
# resp.workload.lenses[0] #=> String
|
2153
|
-
# resp.workload.owner #=> String
|
2154
|
-
# resp.workload.share_invitation_id #=> String
|
2155
|
-
# resp.workload.tags #=> Hash
|
2156
|
-
# resp.workload.tags["TagKey"] #=> String
|
2157
|
-
# resp.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
|
2158
|
-
# resp.workload.discovery_config.workload_resource_definition #=> Array
|
2159
|
-
# resp.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
|
2160
|
-
# resp.workload.applications #=> Array
|
2161
|
-
# resp.workload.applications[0] #=> String
|
2162
|
-
# resp.workload.profiles #=> Array
|
2163
|
-
# resp.workload.profiles[0].profile_arn #=> String
|
2164
|
-
# resp.workload.profiles[0].profile_version #=> String
|
2165
|
-
# resp.workload.prioritized_risk_counts #=> Hash
|
2166
|
-
# resp.workload.prioritized_risk_counts["Risk"] #=> Integer
|
2167
|
-
#
|
2168
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkload AWS API Documentation
|
2169
|
-
#
|
2170
|
-
# @overload get_workload(params = {})
|
2395
|
+
# resp.review_template.description #=> String
|
2396
|
+
# resp.review_template.lenses #=> Array
|
2397
|
+
# resp.review_template.lenses[0] #=> String
|
2398
|
+
# resp.review_template.notes #=> String
|
2399
|
+
# resp.review_template.question_counts #=> Hash
|
2400
|
+
# resp.review_template.question_counts["Question"] #=> Integer
|
2401
|
+
# resp.review_template.owner #=> String
|
2402
|
+
# resp.review_template.updated_at #=> Time
|
2403
|
+
# resp.review_template.template_arn #=> String
|
2404
|
+
# resp.review_template.template_name #=> String
|
2405
|
+
# resp.review_template.tags #=> Hash
|
2406
|
+
# resp.review_template.tags["TagKey"] #=> String
|
2407
|
+
# resp.review_template.update_status #=> String, one of "CURRENT", "LENS_NOT_CURRENT"
|
2408
|
+
# resp.review_template.share_invitation_id #=> String
|
2409
|
+
#
|
2410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetReviewTemplate AWS API Documentation
|
2411
|
+
#
|
2412
|
+
# @overload get_review_template(params = {})
|
2171
2413
|
# @param [Hash] params ({})
|
2172
|
-
def
|
2173
|
-
req = build_request(:
|
2414
|
+
def get_review_template(params = {}, options = {})
|
2415
|
+
req = build_request(:get_review_template, params)
|
2174
2416
|
req.send_request(options)
|
2175
2417
|
end
|
2176
2418
|
|
2177
|
-
#
|
2419
|
+
# Get review template answer.
|
2178
2420
|
#
|
2179
|
-
#
|
2180
|
-
#
|
2421
|
+
# @option params [required, String] :template_arn
|
2422
|
+
# The review template ARN.
|
2181
2423
|
#
|
2182
|
-
#
|
2183
|
-
#
|
2184
|
-
# accounts until it's published with CreateLensVersion.
|
2424
|
+
# @option params [required, String] :lens_alias
|
2425
|
+
# The alias of the lens.
|
2185
2426
|
#
|
2186
|
-
#
|
2187
|
-
#
|
2427
|
+
# For Amazon Web Services official lenses, this is either the lens
|
2428
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
2429
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2430
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
2431
|
+
# on Amazon Web Services official lenses.
|
2188
2432
|
#
|
2189
|
-
#
|
2433
|
+
# For custom lenses, this is the lens ARN, such as
|
2434
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2190
2435
|
#
|
2191
|
-
#
|
2436
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2192
2437
|
#
|
2193
|
-
#
|
2194
|
-
#
|
2195
|
-
#
|
2438
|
+
# @option params [required, String] :question_id
|
2439
|
+
# The ID of the question.
|
2440
|
+
#
|
2441
|
+
# @return [Types::GetReviewTemplateAnswerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2442
|
+
#
|
2443
|
+
# * {Types::GetReviewTemplateAnswerOutput#template_arn #template_arn} => String
|
2444
|
+
# * {Types::GetReviewTemplateAnswerOutput#lens_alias #lens_alias} => String
|
2445
|
+
# * {Types::GetReviewTemplateAnswerOutput#answer #answer} => Types::ReviewTemplateAnswer
|
2446
|
+
#
|
2447
|
+
# @example Request syntax with placeholder values
|
2448
|
+
#
|
2449
|
+
# resp = client.get_review_template_answer({
|
2450
|
+
# template_arn: "TemplateArn", # required
|
2451
|
+
# lens_alias: "LensAlias", # required
|
2452
|
+
# question_id: "QuestionId", # required
|
2453
|
+
# })
|
2454
|
+
#
|
2455
|
+
# @example Response structure
|
2456
|
+
#
|
2457
|
+
# resp.template_arn #=> String
|
2458
|
+
# resp.lens_alias #=> String
|
2459
|
+
# resp.answer.question_id #=> String
|
2460
|
+
# resp.answer.pillar_id #=> String
|
2461
|
+
# resp.answer.question_title #=> String
|
2462
|
+
# resp.answer.question_description #=> String
|
2463
|
+
# resp.answer.improvement_plan_url #=> String
|
2464
|
+
# resp.answer.helpful_resource_url #=> String
|
2465
|
+
# resp.answer.helpful_resource_display_text #=> String
|
2466
|
+
# resp.answer.choices #=> Array
|
2467
|
+
# resp.answer.choices[0].choice_id #=> String
|
2468
|
+
# resp.answer.choices[0].title #=> String
|
2469
|
+
# resp.answer.choices[0].description #=> String
|
2470
|
+
# resp.answer.choices[0].helpful_resource.display_text #=> String
|
2471
|
+
# resp.answer.choices[0].helpful_resource.url #=> String
|
2472
|
+
# resp.answer.choices[0].improvement_plan.display_text #=> String
|
2473
|
+
# resp.answer.choices[0].improvement_plan.url #=> String
|
2474
|
+
# resp.answer.choices[0].additional_resources #=> Array
|
2475
|
+
# resp.answer.choices[0].additional_resources[0].type #=> String, one of "HELPFUL_RESOURCE", "IMPROVEMENT_PLAN"
|
2476
|
+
# resp.answer.choices[0].additional_resources[0].content #=> Array
|
2477
|
+
# resp.answer.choices[0].additional_resources[0].content[0].display_text #=> String
|
2478
|
+
# resp.answer.choices[0].additional_resources[0].content[0].url #=> String
|
2479
|
+
# resp.answer.selected_choices #=> Array
|
2480
|
+
# resp.answer.selected_choices[0] #=> String
|
2481
|
+
# resp.answer.choice_answers #=> Array
|
2482
|
+
# resp.answer.choice_answers[0].choice_id #=> String
|
2483
|
+
# resp.answer.choice_answers[0].status #=> String, one of "SELECTED", "NOT_APPLICABLE", "UNSELECTED"
|
2484
|
+
# resp.answer.choice_answers[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
|
2485
|
+
# resp.answer.choice_answers[0].notes #=> String
|
2486
|
+
# resp.answer.is_applicable #=> Boolean
|
2487
|
+
# resp.answer.answer_status #=> String, one of "UNANSWERED", "ANSWERED"
|
2488
|
+
# resp.answer.notes #=> String
|
2489
|
+
# resp.answer.reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
|
2490
|
+
#
|
2491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetReviewTemplateAnswer AWS API Documentation
|
2492
|
+
#
|
2493
|
+
# @overload get_review_template_answer(params = {})
|
2494
|
+
# @param [Hash] params ({})
|
2495
|
+
def get_review_template_answer(params = {}, options = {})
|
2496
|
+
req = build_request(:get_review_template_answer, params)
|
2497
|
+
req.send_request(options)
|
2498
|
+
end
|
2499
|
+
|
2500
|
+
# Get a lens review associated with a review template.
|
2501
|
+
#
|
2502
|
+
# @option params [required, String] :template_arn
|
2503
|
+
# The review template ARN.
|
2504
|
+
#
|
2505
|
+
# @option params [required, String] :lens_alias
|
2506
|
+
# The alias of the lens.
|
2507
|
+
#
|
2508
|
+
# For Amazon Web Services official lenses, this is either the lens
|
2509
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
2510
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
2511
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
2512
|
+
# on Amazon Web Services official lenses.
|
2513
|
+
#
|
2514
|
+
# For custom lenses, this is the lens ARN, such as
|
2515
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
2516
|
+
#
|
2517
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2518
|
+
#
|
2519
|
+
# @return [Types::GetReviewTemplateLensReviewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2520
|
+
#
|
2521
|
+
# * {Types::GetReviewTemplateLensReviewOutput#template_arn #template_arn} => String
|
2522
|
+
# * {Types::GetReviewTemplateLensReviewOutput#lens_review #lens_review} => Types::ReviewTemplateLensReview
|
2523
|
+
#
|
2524
|
+
# @example Request syntax with placeholder values
|
2525
|
+
#
|
2526
|
+
# resp = client.get_review_template_lens_review({
|
2527
|
+
# template_arn: "TemplateArn", # required
|
2528
|
+
# lens_alias: "LensAlias", # required
|
2529
|
+
# })
|
2530
|
+
#
|
2531
|
+
# @example Response structure
|
2532
|
+
#
|
2533
|
+
# resp.template_arn #=> String
|
2534
|
+
# resp.lens_review.lens_alias #=> String
|
2535
|
+
# resp.lens_review.lens_arn #=> String
|
2536
|
+
# resp.lens_review.lens_version #=> String
|
2537
|
+
# resp.lens_review.lens_name #=> String
|
2538
|
+
# resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
|
2539
|
+
# resp.lens_review.pillar_review_summaries #=> Array
|
2540
|
+
# resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
|
2541
|
+
# resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
|
2542
|
+
# resp.lens_review.pillar_review_summaries[0].notes #=> String
|
2543
|
+
# resp.lens_review.pillar_review_summaries[0].question_counts #=> Hash
|
2544
|
+
# resp.lens_review.pillar_review_summaries[0].question_counts["Question"] #=> Integer
|
2545
|
+
# resp.lens_review.updated_at #=> Time
|
2546
|
+
# resp.lens_review.notes #=> String
|
2547
|
+
# resp.lens_review.question_counts #=> Hash
|
2548
|
+
# resp.lens_review.question_counts["Question"] #=> Integer
|
2549
|
+
# resp.lens_review.next_token #=> String
|
2550
|
+
#
|
2551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetReviewTemplateLensReview AWS API Documentation
|
2552
|
+
#
|
2553
|
+
# @overload get_review_template_lens_review(params = {})
|
2554
|
+
# @param [Hash] params ({})
|
2555
|
+
def get_review_template_lens_review(params = {}, options = {})
|
2556
|
+
req = build_request(:get_review_template_lens_review, params)
|
2557
|
+
req.send_request(options)
|
2558
|
+
end
|
2559
|
+
|
2560
|
+
# Get an existing workload.
|
2561
|
+
#
|
2562
|
+
# @option params [required, String] :workload_id
|
2563
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2564
|
+
# Web Services Region.
|
2565
|
+
#
|
2566
|
+
# @return [Types::GetWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2567
|
+
#
|
2568
|
+
# * {Types::GetWorkloadOutput#workload #workload} => Types::Workload
|
2569
|
+
#
|
2570
|
+
# @example Request syntax with placeholder values
|
2571
|
+
#
|
2572
|
+
# resp = client.get_workload({
|
2573
|
+
# workload_id: "WorkloadId", # required
|
2574
|
+
# })
|
2575
|
+
#
|
2576
|
+
# @example Response structure
|
2577
|
+
#
|
2578
|
+
# resp.workload.workload_id #=> String
|
2579
|
+
# resp.workload.workload_arn #=> String
|
2580
|
+
# resp.workload.workload_name #=> String
|
2581
|
+
# resp.workload.description #=> String
|
2582
|
+
# resp.workload.environment #=> String, one of "PRODUCTION", "PREPRODUCTION"
|
2583
|
+
# resp.workload.updated_at #=> Time
|
2584
|
+
# resp.workload.account_ids #=> Array
|
2585
|
+
# resp.workload.account_ids[0] #=> String
|
2586
|
+
# resp.workload.aws_regions #=> Array
|
2587
|
+
# resp.workload.aws_regions[0] #=> String
|
2588
|
+
# resp.workload.non_aws_regions #=> Array
|
2589
|
+
# resp.workload.non_aws_regions[0] #=> String
|
2590
|
+
# resp.workload.architectural_design #=> String
|
2591
|
+
# resp.workload.review_owner #=> String
|
2592
|
+
# resp.workload.review_restriction_date #=> Time
|
2593
|
+
# resp.workload.is_review_owner_update_acknowledged #=> Boolean
|
2594
|
+
# resp.workload.industry_type #=> String
|
2595
|
+
# resp.workload.industry #=> String
|
2596
|
+
# resp.workload.notes #=> String
|
2597
|
+
# resp.workload.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
|
2598
|
+
# resp.workload.risk_counts #=> Hash
|
2599
|
+
# resp.workload.risk_counts["Risk"] #=> Integer
|
2600
|
+
# resp.workload.pillar_priorities #=> Array
|
2601
|
+
# resp.workload.pillar_priorities[0] #=> String
|
2602
|
+
# resp.workload.lenses #=> Array
|
2603
|
+
# resp.workload.lenses[0] #=> String
|
2604
|
+
# resp.workload.owner #=> String
|
2605
|
+
# resp.workload.share_invitation_id #=> String
|
2606
|
+
# resp.workload.tags #=> Hash
|
2607
|
+
# resp.workload.tags["TagKey"] #=> String
|
2608
|
+
# resp.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
|
2609
|
+
# resp.workload.discovery_config.workload_resource_definition #=> Array
|
2610
|
+
# resp.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
|
2611
|
+
# resp.workload.applications #=> Array
|
2612
|
+
# resp.workload.applications[0] #=> String
|
2613
|
+
# resp.workload.profiles #=> Array
|
2614
|
+
# resp.workload.profiles[0].profile_arn #=> String
|
2615
|
+
# resp.workload.profiles[0].profile_version #=> String
|
2616
|
+
# resp.workload.prioritized_risk_counts #=> Hash
|
2617
|
+
# resp.workload.prioritized_risk_counts["Risk"] #=> Integer
|
2618
|
+
#
|
2619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkload AWS API Documentation
|
2620
|
+
#
|
2621
|
+
# @overload get_workload(params = {})
|
2622
|
+
# @param [Hash] params ({})
|
2623
|
+
def get_workload(params = {}, options = {})
|
2624
|
+
req = build_request(:get_workload, params)
|
2625
|
+
req.send_request(options)
|
2626
|
+
end
|
2627
|
+
|
2628
|
+
# Import a new custom lens or update an existing custom lens.
|
2629
|
+
#
|
2630
|
+
# To update an existing custom lens, specify its ARN as the `LensAlias`.
|
2631
|
+
# If no ARN is specified, a new custom lens is created.
|
2632
|
+
#
|
2633
|
+
# The new or updated lens will have a status of `DRAFT`. The lens cannot
|
2634
|
+
# be applied to workloads or shared with other Amazon Web Services
|
2635
|
+
# accounts until it's published with CreateLensVersion.
|
2636
|
+
#
|
2637
|
+
# Lenses are defined in JSON. For more information, see [JSON format
|
2638
|
+
# specification][1] in the *Well-Architected Tool User Guide*.
|
2639
|
+
#
|
2640
|
+
# A custom lens cannot exceed 500 KB in size.
|
2641
|
+
#
|
2642
|
+
# <note markdown="1"> **Disclaimer**
|
2643
|
+
#
|
2644
|
+
# Do not include or gather personal identifiable information (PII) of
|
2645
|
+
# end users or other identifiable individuals in or via your custom
|
2646
|
+
# lenses. If your custom lens or those shared with you and used in your
|
2196
2647
|
# account do include or collect PII you are responsible for: ensuring
|
2197
2648
|
# that the included PII is processed in accordance with applicable law,
|
2198
2649
|
# providing adequate privacy notices, and obtaining necessary consents
|
@@ -2692,8 +3143,8 @@ module Aws::WellArchitected
|
|
2692
3143
|
# Each lens is identified by its LensSummary$LensAlias.
|
2693
3144
|
#
|
2694
3145
|
# @option params [String] :shared_with_prefix
|
2695
|
-
# The Amazon Web Services account ID,
|
2696
|
-
#
|
3146
|
+
# The Amazon Web Services account ID, organization ID, or organizational
|
3147
|
+
# unit (OU) ID with which the lens is shared.
|
2697
3148
|
#
|
2698
3149
|
# @option params [String] :next_token
|
2699
3150
|
# The token to use to retrieve the next set of results.
|
@@ -2870,6 +3321,13 @@ module Aws::WellArchitected
|
|
2870
3321
|
# @option params [Integer] :max_results
|
2871
3322
|
# The maximum number of results to return for this request.
|
2872
3323
|
#
|
3324
|
+
# @option params [String] :resource_arn
|
3325
|
+
# The ARN for the related resource for the notification.
|
3326
|
+
#
|
3327
|
+
# <note markdown="1"> Only one of `WorkloadID` or `ResourceARN` should be specified.
|
3328
|
+
#
|
3329
|
+
# </note>
|
3330
|
+
#
|
2873
3331
|
# @return [Types::ListNotificationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2874
3332
|
#
|
2875
3333
|
# * {Types::ListNotificationsOutput#notification_summaries #notification_summaries} => Array<Types::NotificationSummary>
|
@@ -2883,6 +3341,7 @@ module Aws::WellArchitected
|
|
2883
3341
|
# workload_id: "WorkloadId",
|
2884
3342
|
# next_token: "NextToken",
|
2885
3343
|
# max_results: 1,
|
3344
|
+
# resource_arn: "ResourceArn",
|
2886
3345
|
# })
|
2887
3346
|
#
|
2888
3347
|
# @example Response structure
|
@@ -2895,6 +3354,8 @@ module Aws::WellArchitected
|
|
2895
3354
|
# resp.notification_summaries[0].lens_upgrade_summary.lens_arn #=> String
|
2896
3355
|
# resp.notification_summaries[0].lens_upgrade_summary.current_lens_version #=> String
|
2897
3356
|
# resp.notification_summaries[0].lens_upgrade_summary.latest_lens_version #=> String
|
3357
|
+
# resp.notification_summaries[0].lens_upgrade_summary.resource_arn #=> String
|
3358
|
+
# resp.notification_summaries[0].lens_upgrade_summary.resource_name #=> String
|
2898
3359
|
# resp.next_token #=> String
|
2899
3360
|
#
|
2900
3361
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListNotifications AWS API Documentation
|
@@ -2960,8 +3421,8 @@ module Aws::WellArchitected
|
|
2960
3421
|
# The profile ARN.
|
2961
3422
|
#
|
2962
3423
|
# @option params [String] :shared_with_prefix
|
2963
|
-
# The Amazon Web Services account ID,
|
2964
|
-
#
|
3424
|
+
# The Amazon Web Services account ID, organization ID, or organizational
|
3425
|
+
# unit (OU) ID with which the profile is shared.
|
2965
3426
|
#
|
2966
3427
|
# @option params [String] :next_token
|
2967
3428
|
# The token to use to retrieve the next set of results.
|
@@ -3010,7 +3471,8 @@ module Aws::WellArchitected
|
|
3010
3471
|
# List profiles.
|
3011
3472
|
#
|
3012
3473
|
# @option params [String] :profile_name_prefix
|
3013
|
-
#
|
3474
|
+
# An optional string added to the beginning of each profile name
|
3475
|
+
# returned in the results.
|
3014
3476
|
#
|
3015
3477
|
# @option params [String] :profile_owner_type
|
3016
3478
|
# Profile owner type.
|
@@ -3058,7 +3520,146 @@ module Aws::WellArchitected
|
|
3058
3520
|
req.send_request(options)
|
3059
3521
|
end
|
3060
3522
|
|
3061
|
-
# List the
|
3523
|
+
# List the answers of a review template.
|
3524
|
+
#
|
3525
|
+
# @option params [required, String] :template_arn
|
3526
|
+
# The ARN of the review template.
|
3527
|
+
#
|
3528
|
+
# @option params [required, String] :lens_alias
|
3529
|
+
# The alias of the lens.
|
3530
|
+
#
|
3531
|
+
# For Amazon Web Services official lenses, this is either the lens
|
3532
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
3533
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
3534
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
3535
|
+
# on Amazon Web Services official lenses.
|
3536
|
+
#
|
3537
|
+
# For custom lenses, this is the lens ARN, such as
|
3538
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
3539
|
+
#
|
3540
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
3541
|
+
#
|
3542
|
+
# @option params [String] :pillar_id
|
3543
|
+
# The ID used to identify a pillar, for example, `security`.
|
3544
|
+
#
|
3545
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
3546
|
+
#
|
3547
|
+
# @option params [String] :next_token
|
3548
|
+
# The token to use to retrieve the next set of results.
|
3549
|
+
#
|
3550
|
+
# @option params [Integer] :max_results
|
3551
|
+
# The maximum number of results to return for this request.
|
3552
|
+
#
|
3553
|
+
# @return [Types::ListReviewTemplateAnswersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3554
|
+
#
|
3555
|
+
# * {Types::ListReviewTemplateAnswersOutput#template_arn #template_arn} => String
|
3556
|
+
# * {Types::ListReviewTemplateAnswersOutput#lens_alias #lens_alias} => String
|
3557
|
+
# * {Types::ListReviewTemplateAnswersOutput#answer_summaries #answer_summaries} => Array<Types::ReviewTemplateAnswerSummary>
|
3558
|
+
# * {Types::ListReviewTemplateAnswersOutput#next_token #next_token} => String
|
3559
|
+
#
|
3560
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3561
|
+
#
|
3562
|
+
# @example Request syntax with placeholder values
|
3563
|
+
#
|
3564
|
+
# resp = client.list_review_template_answers({
|
3565
|
+
# template_arn: "TemplateArn", # required
|
3566
|
+
# lens_alias: "LensAlias", # required
|
3567
|
+
# pillar_id: "PillarId",
|
3568
|
+
# next_token: "NextToken",
|
3569
|
+
# max_results: 1,
|
3570
|
+
# })
|
3571
|
+
#
|
3572
|
+
# @example Response structure
|
3573
|
+
#
|
3574
|
+
# resp.template_arn #=> String
|
3575
|
+
# resp.lens_alias #=> String
|
3576
|
+
# resp.answer_summaries #=> Array
|
3577
|
+
# resp.answer_summaries[0].question_id #=> String
|
3578
|
+
# resp.answer_summaries[0].pillar_id #=> String
|
3579
|
+
# resp.answer_summaries[0].question_title #=> String
|
3580
|
+
# resp.answer_summaries[0].choices #=> Array
|
3581
|
+
# resp.answer_summaries[0].choices[0].choice_id #=> String
|
3582
|
+
# resp.answer_summaries[0].choices[0].title #=> String
|
3583
|
+
# resp.answer_summaries[0].choices[0].description #=> String
|
3584
|
+
# resp.answer_summaries[0].choices[0].helpful_resource.display_text #=> String
|
3585
|
+
# resp.answer_summaries[0].choices[0].helpful_resource.url #=> String
|
3586
|
+
# resp.answer_summaries[0].choices[0].improvement_plan.display_text #=> String
|
3587
|
+
# resp.answer_summaries[0].choices[0].improvement_plan.url #=> String
|
3588
|
+
# resp.answer_summaries[0].choices[0].additional_resources #=> Array
|
3589
|
+
# resp.answer_summaries[0].choices[0].additional_resources[0].type #=> String, one of "HELPFUL_RESOURCE", "IMPROVEMENT_PLAN"
|
3590
|
+
# resp.answer_summaries[0].choices[0].additional_resources[0].content #=> Array
|
3591
|
+
# resp.answer_summaries[0].choices[0].additional_resources[0].content[0].display_text #=> String
|
3592
|
+
# resp.answer_summaries[0].choices[0].additional_resources[0].content[0].url #=> String
|
3593
|
+
# resp.answer_summaries[0].selected_choices #=> Array
|
3594
|
+
# resp.answer_summaries[0].selected_choices[0] #=> String
|
3595
|
+
# resp.answer_summaries[0].choice_answer_summaries #=> Array
|
3596
|
+
# resp.answer_summaries[0].choice_answer_summaries[0].choice_id #=> String
|
3597
|
+
# resp.answer_summaries[0].choice_answer_summaries[0].status #=> String, one of "SELECTED", "NOT_APPLICABLE", "UNSELECTED"
|
3598
|
+
# resp.answer_summaries[0].choice_answer_summaries[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
|
3599
|
+
# resp.answer_summaries[0].is_applicable #=> Boolean
|
3600
|
+
# resp.answer_summaries[0].answer_status #=> String, one of "UNANSWERED", "ANSWERED"
|
3601
|
+
# resp.answer_summaries[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
|
3602
|
+
# resp.answer_summaries[0].question_type #=> String, one of "PRIORITIZED", "NON_PRIORITIZED"
|
3603
|
+
# resp.next_token #=> String
|
3604
|
+
#
|
3605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListReviewTemplateAnswers AWS API Documentation
|
3606
|
+
#
|
3607
|
+
# @overload list_review_template_answers(params = {})
|
3608
|
+
# @param [Hash] params ({})
|
3609
|
+
def list_review_template_answers(params = {}, options = {})
|
3610
|
+
req = build_request(:list_review_template_answers, params)
|
3611
|
+
req.send_request(options)
|
3612
|
+
end
|
3613
|
+
|
3614
|
+
# List review templates.
|
3615
|
+
#
|
3616
|
+
# @option params [String] :next_token
|
3617
|
+
# The token to use to retrieve the next set of results.
|
3618
|
+
#
|
3619
|
+
# @option params [Integer] :max_results
|
3620
|
+
# The maximum number of results to return for this request.
|
3621
|
+
#
|
3622
|
+
# @return [Types::ListReviewTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3623
|
+
#
|
3624
|
+
# * {Types::ListReviewTemplatesOutput#review_templates #review_templates} => Array<Types::ReviewTemplateSummary>
|
3625
|
+
# * {Types::ListReviewTemplatesOutput#next_token #next_token} => String
|
3626
|
+
#
|
3627
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3628
|
+
#
|
3629
|
+
# @example Request syntax with placeholder values
|
3630
|
+
#
|
3631
|
+
# resp = client.list_review_templates({
|
3632
|
+
# next_token: "NextToken",
|
3633
|
+
# max_results: 1,
|
3634
|
+
# })
|
3635
|
+
#
|
3636
|
+
# @example Response structure
|
3637
|
+
#
|
3638
|
+
# resp.review_templates #=> Array
|
3639
|
+
# resp.review_templates[0].description #=> String
|
3640
|
+
# resp.review_templates[0].lenses #=> Array
|
3641
|
+
# resp.review_templates[0].lenses[0] #=> String
|
3642
|
+
# resp.review_templates[0].owner #=> String
|
3643
|
+
# resp.review_templates[0].updated_at #=> Time
|
3644
|
+
# resp.review_templates[0].template_arn #=> String
|
3645
|
+
# resp.review_templates[0].template_name #=> String
|
3646
|
+
# resp.review_templates[0].update_status #=> String, one of "CURRENT", "LENS_NOT_CURRENT"
|
3647
|
+
# resp.next_token #=> String
|
3648
|
+
#
|
3649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListReviewTemplates AWS API Documentation
|
3650
|
+
#
|
3651
|
+
# @overload list_review_templates(params = {})
|
3652
|
+
# @param [Hash] params ({})
|
3653
|
+
def list_review_templates(params = {}, options = {})
|
3654
|
+
req = build_request(:list_review_templates, params)
|
3655
|
+
req.send_request(options)
|
3656
|
+
end
|
3657
|
+
|
3658
|
+
# List the share invitations.
|
3659
|
+
#
|
3660
|
+
# `WorkloadNamePrefix`, `LensNamePrefix`, `ProfileNamePrefix`, and
|
3661
|
+
# `TemplateNamePrefix` are mutually exclusive. Use the parameter that
|
3662
|
+
# matches your `ShareResourceType`.
|
3062
3663
|
#
|
3063
3664
|
# @option params [String] :workload_name_prefix
|
3064
3665
|
# An optional string added to the beginning of each workload name
|
@@ -3078,7 +3679,12 @@ module Aws::WellArchitected
|
|
3078
3679
|
# The maximum number of results to return for this request.
|
3079
3680
|
#
|
3080
3681
|
# @option params [String] :profile_name_prefix
|
3081
|
-
#
|
3682
|
+
# An optional string added to the beginning of each profile name
|
3683
|
+
# returned in the results.
|
3684
|
+
#
|
3685
|
+
# @option params [String] :template_name_prefix
|
3686
|
+
# An optional string added to the beginning of each review template name
|
3687
|
+
# returned in the results.
|
3082
3688
|
#
|
3083
3689
|
# @return [Types::ListShareInvitationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3084
3690
|
#
|
@@ -3092,10 +3698,11 @@ module Aws::WellArchitected
|
|
3092
3698
|
# resp = client.list_share_invitations({
|
3093
3699
|
# workload_name_prefix: "WorkloadNamePrefix",
|
3094
3700
|
# lens_name_prefix: "LensNamePrefix",
|
3095
|
-
# share_resource_type: "WORKLOAD", # accepts WORKLOAD, LENS, PROFILE
|
3701
|
+
# share_resource_type: "WORKLOAD", # accepts WORKLOAD, LENS, PROFILE, TEMPLATE
|
3096
3702
|
# next_token: "NextToken",
|
3097
3703
|
# max_results: 1,
|
3098
3704
|
# profile_name_prefix: "ProfileNamePrefix",
|
3705
|
+
# template_name_prefix: "TemplateNamePrefix",
|
3099
3706
|
# })
|
3100
3707
|
#
|
3101
3708
|
# @example Response structure
|
@@ -3105,13 +3712,15 @@ module Aws::WellArchitected
|
|
3105
3712
|
# resp.share_invitation_summaries[0].shared_by #=> String
|
3106
3713
|
# resp.share_invitation_summaries[0].shared_with #=> String
|
3107
3714
|
# resp.share_invitation_summaries[0].permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
|
3108
|
-
# resp.share_invitation_summaries[0].share_resource_type #=> String, one of "WORKLOAD", "LENS", "PROFILE"
|
3715
|
+
# resp.share_invitation_summaries[0].share_resource_type #=> String, one of "WORKLOAD", "LENS", "PROFILE", "TEMPLATE"
|
3109
3716
|
# resp.share_invitation_summaries[0].workload_name #=> String
|
3110
3717
|
# resp.share_invitation_summaries[0].workload_id #=> String
|
3111
3718
|
# resp.share_invitation_summaries[0].lens_name #=> String
|
3112
3719
|
# resp.share_invitation_summaries[0].lens_arn #=> String
|
3113
3720
|
# resp.share_invitation_summaries[0].profile_name #=> String
|
3114
3721
|
# resp.share_invitation_summaries[0].profile_arn #=> String
|
3722
|
+
# resp.share_invitation_summaries[0].template_name #=> String
|
3723
|
+
# resp.share_invitation_summaries[0].template_arn #=> String
|
3115
3724
|
# resp.next_token #=> String
|
3116
3725
|
#
|
3117
3726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitations AWS API Documentation
|
@@ -3125,8 +3734,8 @@ module Aws::WellArchitected
|
|
3125
3734
|
|
3126
3735
|
# List the tags for a resource.
|
3127
3736
|
#
|
3128
|
-
# <note markdown="1"> The WorkloadArn parameter can be a workload ARN, a custom lens ARN,
|
3129
|
-
#
|
3737
|
+
# <note markdown="1"> The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a
|
3738
|
+
# profile ARN, or review template ARN.
|
3130
3739
|
#
|
3131
3740
|
# </note>
|
3132
3741
|
#
|
@@ -3157,6 +3766,61 @@ module Aws::WellArchitected
|
|
3157
3766
|
req.send_request(options)
|
3158
3767
|
end
|
3159
3768
|
|
3769
|
+
# List review template shares.
|
3770
|
+
#
|
3771
|
+
# @option params [required, String] :template_arn
|
3772
|
+
# The review template ARN.
|
3773
|
+
#
|
3774
|
+
# @option params [String] :shared_with_prefix
|
3775
|
+
# The Amazon Web Services account ID, organization ID, or organizational
|
3776
|
+
# unit (OU) ID with which the profile is shared.
|
3777
|
+
#
|
3778
|
+
# @option params [String] :next_token
|
3779
|
+
# The token to use to retrieve the next set of results.
|
3780
|
+
#
|
3781
|
+
# @option params [Integer] :max_results
|
3782
|
+
# The maximum number of results to return for this request.
|
3783
|
+
#
|
3784
|
+
# @option params [String] :status
|
3785
|
+
# The status of the share request.
|
3786
|
+
#
|
3787
|
+
# @return [Types::ListTemplateSharesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3788
|
+
#
|
3789
|
+
# * {Types::ListTemplateSharesOutput#template_arn #template_arn} => String
|
3790
|
+
# * {Types::ListTemplateSharesOutput#template_share_summaries #template_share_summaries} => Array<Types::TemplateShareSummary>
|
3791
|
+
# * {Types::ListTemplateSharesOutput#next_token #next_token} => String
|
3792
|
+
#
|
3793
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3794
|
+
#
|
3795
|
+
# @example Request syntax with placeholder values
|
3796
|
+
#
|
3797
|
+
# resp = client.list_template_shares({
|
3798
|
+
# template_arn: "TemplateArn", # required
|
3799
|
+
# shared_with_prefix: "SharedWithPrefix",
|
3800
|
+
# next_token: "NextToken",
|
3801
|
+
# max_results: 1,
|
3802
|
+
# status: "ACCEPTED", # accepts ACCEPTED, REJECTED, PENDING, REVOKED, EXPIRED, ASSOCIATING, ASSOCIATED, FAILED
|
3803
|
+
# })
|
3804
|
+
#
|
3805
|
+
# @example Response structure
|
3806
|
+
#
|
3807
|
+
# resp.template_arn #=> String
|
3808
|
+
# resp.template_share_summaries #=> Array
|
3809
|
+
# resp.template_share_summaries[0].share_id #=> String
|
3810
|
+
# resp.template_share_summaries[0].shared_with #=> String
|
3811
|
+
# resp.template_share_summaries[0].status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED", "ASSOCIATING", "ASSOCIATED", "FAILED"
|
3812
|
+
# resp.template_share_summaries[0].status_message #=> String
|
3813
|
+
# resp.next_token #=> String
|
3814
|
+
#
|
3815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListTemplateShares AWS API Documentation
|
3816
|
+
#
|
3817
|
+
# @overload list_template_shares(params = {})
|
3818
|
+
# @param [Hash] params ({})
|
3819
|
+
def list_template_shares(params = {}, options = {})
|
3820
|
+
req = build_request(:list_template_shares, params)
|
3821
|
+
req.send_request(options)
|
3822
|
+
end
|
3823
|
+
|
3160
3824
|
# List the workload shares associated with the workload.
|
3161
3825
|
#
|
3162
3826
|
# @option params [required, String] :workload_id
|
@@ -3164,8 +3828,8 @@ module Aws::WellArchitected
|
|
3164
3828
|
# Web Services Region.
|
3165
3829
|
#
|
3166
3830
|
# @option params [String] :shared_with_prefix
|
3167
|
-
# The Amazon Web Services account ID,
|
3168
|
-
#
|
3831
|
+
# The Amazon Web Services account ID, organization ID, or organizational
|
3832
|
+
# unit (OU) ID with which the workload is shared.
|
3169
3833
|
#
|
3170
3834
|
# @option params [String] :next_token
|
3171
3835
|
# The token to use to retrieve the next set of results.
|
@@ -3272,8 +3936,8 @@ module Aws::WellArchitected
|
|
3272
3936
|
|
3273
3937
|
# Adds one or more tags to the specified resource.
|
3274
3938
|
#
|
3275
|
-
# <note markdown="1"> The WorkloadArn parameter can be a workload ARN, a custom lens ARN,
|
3276
|
-
#
|
3939
|
+
# <note markdown="1"> The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a
|
3940
|
+
# profile ARN, or review template ARN.
|
3277
3941
|
#
|
3278
3942
|
# </note>
|
3279
3943
|
#
|
@@ -3305,8 +3969,8 @@ module Aws::WellArchitected
|
|
3305
3969
|
|
3306
3970
|
# Deletes specified tags from a resource.
|
3307
3971
|
#
|
3308
|
-
# <note markdown="1"> The WorkloadArn parameter can be a workload ARN, a custom lens ARN,
|
3309
|
-
#
|
3972
|
+
# <note markdown="1"> The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a
|
3973
|
+
# profile ARN, or review template ARN.
|
3310
3974
|
#
|
3311
3975
|
# </note>
|
3312
3976
|
#
|
@@ -3375,6 +4039,9 @@ module Aws::WellArchitected
|
|
3375
4039
|
# @option params [String] :notes
|
3376
4040
|
# The notes associated with the workload.
|
3377
4041
|
#
|
4042
|
+
# For a review template, these are the notes that will be associated
|
4043
|
+
# with the workload when the template is applied.
|
4044
|
+
#
|
3378
4045
|
# @option params [Boolean] :is_applicable
|
3379
4046
|
# Defines whether this question is applicable to a lens review.
|
3380
4047
|
#
|
@@ -3503,9 +4170,15 @@ module Aws::WellArchitected
|
|
3503
4170
|
# @option params [String] :lens_notes
|
3504
4171
|
# The notes associated with the workload.
|
3505
4172
|
#
|
4173
|
+
# For a review template, these are the notes that will be associated
|
4174
|
+
# with the workload when the template is applied.
|
4175
|
+
#
|
3506
4176
|
# @option params [Hash<String,String>] :pillar_notes
|
3507
4177
|
# List of pillar notes of a lens review in a workload.
|
3508
4178
|
#
|
4179
|
+
# For a review template, these are the notes that will be associated
|
4180
|
+
# with the workload when the template is applied.
|
4181
|
+
#
|
3509
4182
|
# @return [Types::UpdateLensReviewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3510
4183
|
#
|
3511
4184
|
# * {Types::UpdateLensReviewOutput#workload_id #workload_id} => String
|
@@ -3620,6 +4293,259 @@ module Aws::WellArchitected
|
|
3620
4293
|
req.send_request(options)
|
3621
4294
|
end
|
3622
4295
|
|
4296
|
+
# Update a review template.
|
4297
|
+
#
|
4298
|
+
# @option params [required, String] :template_arn
|
4299
|
+
# The review template ARN.
|
4300
|
+
#
|
4301
|
+
# @option params [String] :template_name
|
4302
|
+
# The review template name.
|
4303
|
+
#
|
4304
|
+
# @option params [String] :description
|
4305
|
+
# The review template description.
|
4306
|
+
#
|
4307
|
+
# @option params [String] :notes
|
4308
|
+
# The notes associated with the workload.
|
4309
|
+
#
|
4310
|
+
# For a review template, these are the notes that will be associated
|
4311
|
+
# with the workload when the template is applied.
|
4312
|
+
#
|
4313
|
+
# @option params [Array<String>] :lenses_to_associate
|
4314
|
+
# A list of lens aliases or ARNs to apply to the review template.
|
4315
|
+
#
|
4316
|
+
# @option params [Array<String>] :lenses_to_disassociate
|
4317
|
+
# A list of lens aliases or ARNs to unapply to the review template. The
|
4318
|
+
# `wellarchitected` lens cannot be unapplied.
|
4319
|
+
#
|
4320
|
+
# @return [Types::UpdateReviewTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4321
|
+
#
|
4322
|
+
# * {Types::UpdateReviewTemplateOutput#review_template #review_template} => Types::ReviewTemplate
|
4323
|
+
#
|
4324
|
+
# @example Request syntax with placeholder values
|
4325
|
+
#
|
4326
|
+
# resp = client.update_review_template({
|
4327
|
+
# template_arn: "TemplateArn", # required
|
4328
|
+
# template_name: "TemplateName",
|
4329
|
+
# description: "TemplateDescription",
|
4330
|
+
# notes: "Notes",
|
4331
|
+
# lenses_to_associate: ["LensAlias"],
|
4332
|
+
# lenses_to_disassociate: ["LensAlias"],
|
4333
|
+
# })
|
4334
|
+
#
|
4335
|
+
# @example Response structure
|
4336
|
+
#
|
4337
|
+
# resp.review_template.description #=> String
|
4338
|
+
# resp.review_template.lenses #=> Array
|
4339
|
+
# resp.review_template.lenses[0] #=> String
|
4340
|
+
# resp.review_template.notes #=> String
|
4341
|
+
# resp.review_template.question_counts #=> Hash
|
4342
|
+
# resp.review_template.question_counts["Question"] #=> Integer
|
4343
|
+
# resp.review_template.owner #=> String
|
4344
|
+
# resp.review_template.updated_at #=> Time
|
4345
|
+
# resp.review_template.template_arn #=> String
|
4346
|
+
# resp.review_template.template_name #=> String
|
4347
|
+
# resp.review_template.tags #=> Hash
|
4348
|
+
# resp.review_template.tags["TagKey"] #=> String
|
4349
|
+
# resp.review_template.update_status #=> String, one of "CURRENT", "LENS_NOT_CURRENT"
|
4350
|
+
# resp.review_template.share_invitation_id #=> String
|
4351
|
+
#
|
4352
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateReviewTemplate AWS API Documentation
|
4353
|
+
#
|
4354
|
+
# @overload update_review_template(params = {})
|
4355
|
+
# @param [Hash] params ({})
|
4356
|
+
def update_review_template(params = {}, options = {})
|
4357
|
+
req = build_request(:update_review_template, params)
|
4358
|
+
req.send_request(options)
|
4359
|
+
end
|
4360
|
+
|
4361
|
+
# Update a review template answer.
|
4362
|
+
#
|
4363
|
+
# @option params [required, String] :template_arn
|
4364
|
+
# The review template ARN.
|
4365
|
+
#
|
4366
|
+
# @option params [required, String] :lens_alias
|
4367
|
+
# The alias of the lens.
|
4368
|
+
#
|
4369
|
+
# For Amazon Web Services official lenses, this is either the lens
|
4370
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
4371
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
4372
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
4373
|
+
# on Amazon Web Services official lenses.
|
4374
|
+
#
|
4375
|
+
# For custom lenses, this is the lens ARN, such as
|
4376
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
4377
|
+
#
|
4378
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
4379
|
+
#
|
4380
|
+
# @option params [required, String] :question_id
|
4381
|
+
# The ID of the question.
|
4382
|
+
#
|
4383
|
+
# @option params [Array<String>] :selected_choices
|
4384
|
+
# List of selected choice IDs in a question answer.
|
4385
|
+
#
|
4386
|
+
# The values entered replace the previously selected choices.
|
4387
|
+
#
|
4388
|
+
# @option params [Hash<String,Types::ChoiceUpdate>] :choice_updates
|
4389
|
+
# A list of choices to be updated.
|
4390
|
+
#
|
4391
|
+
# @option params [String] :notes
|
4392
|
+
# The notes associated with the workload.
|
4393
|
+
#
|
4394
|
+
# For a review template, these are the notes that will be associated
|
4395
|
+
# with the workload when the template is applied.
|
4396
|
+
#
|
4397
|
+
# @option params [Boolean] :is_applicable
|
4398
|
+
# Defines whether this question is applicable to a lens review.
|
4399
|
+
#
|
4400
|
+
# @option params [String] :reason
|
4401
|
+
# The update reason.
|
4402
|
+
#
|
4403
|
+
# @return [Types::UpdateReviewTemplateAnswerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4404
|
+
#
|
4405
|
+
# * {Types::UpdateReviewTemplateAnswerOutput#template_arn #template_arn} => String
|
4406
|
+
# * {Types::UpdateReviewTemplateAnswerOutput#lens_alias #lens_alias} => String
|
4407
|
+
# * {Types::UpdateReviewTemplateAnswerOutput#answer #answer} => Types::ReviewTemplateAnswer
|
4408
|
+
#
|
4409
|
+
# @example Request syntax with placeholder values
|
4410
|
+
#
|
4411
|
+
# resp = client.update_review_template_answer({
|
4412
|
+
# template_arn: "TemplateArn", # required
|
4413
|
+
# lens_alias: "LensAlias", # required
|
4414
|
+
# question_id: "QuestionId", # required
|
4415
|
+
# selected_choices: ["ChoiceId"],
|
4416
|
+
# choice_updates: {
|
4417
|
+
# "ChoiceId" => {
|
4418
|
+
# status: "SELECTED", # required, accepts SELECTED, NOT_APPLICABLE, UNSELECTED
|
4419
|
+
# reason: "OUT_OF_SCOPE", # accepts OUT_OF_SCOPE, BUSINESS_PRIORITIES, ARCHITECTURE_CONSTRAINTS, OTHER, NONE
|
4420
|
+
# notes: "ChoiceNotes",
|
4421
|
+
# },
|
4422
|
+
# },
|
4423
|
+
# notes: "Notes",
|
4424
|
+
# is_applicable: false,
|
4425
|
+
# reason: "OUT_OF_SCOPE", # accepts OUT_OF_SCOPE, BUSINESS_PRIORITIES, ARCHITECTURE_CONSTRAINTS, OTHER, NONE
|
4426
|
+
# })
|
4427
|
+
#
|
4428
|
+
# @example Response structure
|
4429
|
+
#
|
4430
|
+
# resp.template_arn #=> String
|
4431
|
+
# resp.lens_alias #=> String
|
4432
|
+
# resp.answer.question_id #=> String
|
4433
|
+
# resp.answer.pillar_id #=> String
|
4434
|
+
# resp.answer.question_title #=> String
|
4435
|
+
# resp.answer.question_description #=> String
|
4436
|
+
# resp.answer.improvement_plan_url #=> String
|
4437
|
+
# resp.answer.helpful_resource_url #=> String
|
4438
|
+
# resp.answer.helpful_resource_display_text #=> String
|
4439
|
+
# resp.answer.choices #=> Array
|
4440
|
+
# resp.answer.choices[0].choice_id #=> String
|
4441
|
+
# resp.answer.choices[0].title #=> String
|
4442
|
+
# resp.answer.choices[0].description #=> String
|
4443
|
+
# resp.answer.choices[0].helpful_resource.display_text #=> String
|
4444
|
+
# resp.answer.choices[0].helpful_resource.url #=> String
|
4445
|
+
# resp.answer.choices[0].improvement_plan.display_text #=> String
|
4446
|
+
# resp.answer.choices[0].improvement_plan.url #=> String
|
4447
|
+
# resp.answer.choices[0].additional_resources #=> Array
|
4448
|
+
# resp.answer.choices[0].additional_resources[0].type #=> String, one of "HELPFUL_RESOURCE", "IMPROVEMENT_PLAN"
|
4449
|
+
# resp.answer.choices[0].additional_resources[0].content #=> Array
|
4450
|
+
# resp.answer.choices[0].additional_resources[0].content[0].display_text #=> String
|
4451
|
+
# resp.answer.choices[0].additional_resources[0].content[0].url #=> String
|
4452
|
+
# resp.answer.selected_choices #=> Array
|
4453
|
+
# resp.answer.selected_choices[0] #=> String
|
4454
|
+
# resp.answer.choice_answers #=> Array
|
4455
|
+
# resp.answer.choice_answers[0].choice_id #=> String
|
4456
|
+
# resp.answer.choice_answers[0].status #=> String, one of "SELECTED", "NOT_APPLICABLE", "UNSELECTED"
|
4457
|
+
# resp.answer.choice_answers[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
|
4458
|
+
# resp.answer.choice_answers[0].notes #=> String
|
4459
|
+
# resp.answer.is_applicable #=> Boolean
|
4460
|
+
# resp.answer.answer_status #=> String, one of "UNANSWERED", "ANSWERED"
|
4461
|
+
# resp.answer.notes #=> String
|
4462
|
+
# resp.answer.reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
|
4463
|
+
#
|
4464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateReviewTemplateAnswer AWS API Documentation
|
4465
|
+
#
|
4466
|
+
# @overload update_review_template_answer(params = {})
|
4467
|
+
# @param [Hash] params ({})
|
4468
|
+
def update_review_template_answer(params = {}, options = {})
|
4469
|
+
req = build_request(:update_review_template_answer, params)
|
4470
|
+
req.send_request(options)
|
4471
|
+
end
|
4472
|
+
|
4473
|
+
# Update a lens review associated with a review template.
|
4474
|
+
#
|
4475
|
+
# @option params [required, String] :template_arn
|
4476
|
+
# The review template ARN.
|
4477
|
+
#
|
4478
|
+
# @option params [required, String] :lens_alias
|
4479
|
+
# The alias of the lens.
|
4480
|
+
#
|
4481
|
+
# For Amazon Web Services official lenses, this is either the lens
|
4482
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
4483
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
4484
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
4485
|
+
# on Amazon Web Services official lenses.
|
4486
|
+
#
|
4487
|
+
# For custom lenses, this is the lens ARN, such as
|
4488
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
4489
|
+
#
|
4490
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
4491
|
+
#
|
4492
|
+
# @option params [String] :lens_notes
|
4493
|
+
# The notes associated with the workload.
|
4494
|
+
#
|
4495
|
+
# For a review template, these are the notes that will be associated
|
4496
|
+
# with the workload when the template is applied.
|
4497
|
+
#
|
4498
|
+
# @option params [Hash<String,String>] :pillar_notes
|
4499
|
+
# List of pillar notes of a lens review in a workload.
|
4500
|
+
#
|
4501
|
+
# For a review template, these are the notes that will be associated
|
4502
|
+
# with the workload when the template is applied.
|
4503
|
+
#
|
4504
|
+
# @return [Types::UpdateReviewTemplateLensReviewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4505
|
+
#
|
4506
|
+
# * {Types::UpdateReviewTemplateLensReviewOutput#template_arn #template_arn} => String
|
4507
|
+
# * {Types::UpdateReviewTemplateLensReviewOutput#lens_review #lens_review} => Types::ReviewTemplateLensReview
|
4508
|
+
#
|
4509
|
+
# @example Request syntax with placeholder values
|
4510
|
+
#
|
4511
|
+
# resp = client.update_review_template_lens_review({
|
4512
|
+
# template_arn: "TemplateArn", # required
|
4513
|
+
# lens_alias: "LensAlias", # required
|
4514
|
+
# lens_notes: "Notes",
|
4515
|
+
# pillar_notes: {
|
4516
|
+
# "PillarId" => "Notes",
|
4517
|
+
# },
|
4518
|
+
# })
|
4519
|
+
#
|
4520
|
+
# @example Response structure
|
4521
|
+
#
|
4522
|
+
# resp.template_arn #=> String
|
4523
|
+
# resp.lens_review.lens_alias #=> String
|
4524
|
+
# resp.lens_review.lens_arn #=> String
|
4525
|
+
# resp.lens_review.lens_version #=> String
|
4526
|
+
# resp.lens_review.lens_name #=> String
|
4527
|
+
# resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
|
4528
|
+
# resp.lens_review.pillar_review_summaries #=> Array
|
4529
|
+
# resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
|
4530
|
+
# resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
|
4531
|
+
# resp.lens_review.pillar_review_summaries[0].notes #=> String
|
4532
|
+
# resp.lens_review.pillar_review_summaries[0].question_counts #=> Hash
|
4533
|
+
# resp.lens_review.pillar_review_summaries[0].question_counts["Question"] #=> Integer
|
4534
|
+
# resp.lens_review.updated_at #=> Time
|
4535
|
+
# resp.lens_review.notes #=> String
|
4536
|
+
# resp.lens_review.question_counts #=> Hash
|
4537
|
+
# resp.lens_review.question_counts["Question"] #=> Integer
|
4538
|
+
# resp.lens_review.next_token #=> String
|
4539
|
+
#
|
4540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateReviewTemplateLensReview AWS API Documentation
|
4541
|
+
#
|
4542
|
+
# @overload update_review_template_lens_review(params = {})
|
4543
|
+
# @param [Hash] params ({})
|
4544
|
+
def update_review_template_lens_review(params = {}, options = {})
|
4545
|
+
req = build_request(:update_review_template_lens_review, params)
|
4546
|
+
req.send_request(options)
|
4547
|
+
end
|
4548
|
+
|
3623
4549
|
# Update a workload or custom lens share invitation.
|
3624
4550
|
#
|
3625
4551
|
# <note markdown="1"> This API operation can be called independently of any resource.
|
@@ -3647,11 +4573,12 @@ module Aws::WellArchitected
|
|
3647
4573
|
# @example Response structure
|
3648
4574
|
#
|
3649
4575
|
# resp.share_invitation.share_invitation_id #=> String
|
3650
|
-
# resp.share_invitation.share_resource_type #=> String, one of "WORKLOAD", "LENS", "PROFILE"
|
4576
|
+
# resp.share_invitation.share_resource_type #=> String, one of "WORKLOAD", "LENS", "PROFILE", "TEMPLATE"
|
3651
4577
|
# resp.share_invitation.workload_id #=> String
|
3652
4578
|
# resp.share_invitation.lens_alias #=> String
|
3653
4579
|
# resp.share_invitation.lens_arn #=> String
|
3654
4580
|
# resp.share_invitation.profile_arn #=> String
|
4581
|
+
# resp.share_invitation.template_arn #=> String
|
3655
4582
|
#
|
3656
4583
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitation AWS API Documentation
|
3657
4584
|
#
|
@@ -3779,6 +4706,9 @@ module Aws::WellArchitected
|
|
3779
4706
|
# @option params [String] :notes
|
3780
4707
|
# The notes associated with the workload.
|
3781
4708
|
#
|
4709
|
+
# For a review template, these are the notes that will be associated
|
4710
|
+
# with the workload when the template is applied.
|
4711
|
+
#
|
3782
4712
|
# @option params [String] :improvement_status
|
3783
4713
|
# The improvement status for a workload.
|
3784
4714
|
#
|
@@ -4025,6 +4955,58 @@ module Aws::WellArchitected
|
|
4025
4955
|
req.send_request(options)
|
4026
4956
|
end
|
4027
4957
|
|
4958
|
+
# Upgrade the lens review of a review template.
|
4959
|
+
#
|
4960
|
+
# @option params [required, String] :template_arn
|
4961
|
+
# The ARN of the review template.
|
4962
|
+
#
|
4963
|
+
# @option params [required, String] :lens_alias
|
4964
|
+
# The alias of the lens.
|
4965
|
+
#
|
4966
|
+
# For Amazon Web Services official lenses, this is either the lens
|
4967
|
+
# alias, such as `serverless`, or the lens ARN, such as
|
4968
|
+
# `arn:aws:wellarchitected:us-east-1::lens/serverless`. Note that some
|
4969
|
+
# operations (such as ExportLens and CreateLensShare) are not permitted
|
4970
|
+
# on Amazon Web Services official lenses.
|
4971
|
+
#
|
4972
|
+
# For custom lenses, this is the lens ARN, such as
|
4973
|
+
# `arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef`.
|
4974
|
+
#
|
4975
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
4976
|
+
#
|
4977
|
+
# @option params [String] :client_request_token
|
4978
|
+
# A unique case-sensitive string used to ensure that this request is
|
4979
|
+
# idempotent (executes only once).
|
4980
|
+
#
|
4981
|
+
# You should not reuse the same token for other requests. If you retry a
|
4982
|
+
# request with the same client request token and the same parameters
|
4983
|
+
# after the original request has completed successfully, the result of
|
4984
|
+
# the original request is returned.
|
4985
|
+
#
|
4986
|
+
# This token is listed as required, however, if you do not specify it,
|
4987
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
4988
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
4989
|
+
# provide this token or the request will fail.
|
4990
|
+
#
|
4991
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4992
|
+
#
|
4993
|
+
# @example Request syntax with placeholder values
|
4994
|
+
#
|
4995
|
+
# resp = client.upgrade_review_template_lens_review({
|
4996
|
+
# template_arn: "TemplateArn", # required
|
4997
|
+
# lens_alias: "LensAlias", # required
|
4998
|
+
# client_request_token: "ClientRequestToken",
|
4999
|
+
# })
|
5000
|
+
#
|
5001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpgradeReviewTemplateLensReview AWS API Documentation
|
5002
|
+
#
|
5003
|
+
# @overload upgrade_review_template_lens_review(params = {})
|
5004
|
+
# @param [Hash] params ({})
|
5005
|
+
def upgrade_review_template_lens_review(params = {}, options = {})
|
5006
|
+
req = build_request(:upgrade_review_template_lens_review, params)
|
5007
|
+
req.send_request(options)
|
5008
|
+
end
|
5009
|
+
|
4028
5010
|
# @!endgroup
|
4029
5011
|
|
4030
5012
|
# @param params ({})
|
@@ -4038,7 +5020,7 @@ module Aws::WellArchitected
|
|
4038
5020
|
params: params,
|
4039
5021
|
config: config)
|
4040
5022
|
context[:gem_name] = 'aws-sdk-wellarchitected'
|
4041
|
-
context[:gem_version] = '1.
|
5023
|
+
context[:gem_version] = '1.30.0'
|
4042
5024
|
Seahorse::Client::Request.new(handlers, context)
|
4043
5025
|
end
|
4044
5026
|
|