Class: Aws::WellArchitected::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::WellArchitected::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb
Overview
An API client for WellArchitected. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::WellArchitected::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_lenses(params = {}) ⇒ Struct
Associate a lens to a workload.
-
#associate_profiles(params = {}) ⇒ Struct
Associate a profile with a workload.
-
#create_lens_share(params = {}) ⇒ Types::CreateLensShareOutput
Create a lens share.
-
#create_lens_version(params = {}) ⇒ Types::CreateLensVersionOutput
Create a new lens version.
-
#create_milestone(params = {}) ⇒ Types::CreateMilestoneOutput
Create a milestone for an existing workload.
-
#create_profile(params = {}) ⇒ Types::CreateProfileOutput
Create a profile.
-
#create_profile_share(params = {}) ⇒ Types::CreateProfileShareOutput
Create a profile share.
-
#create_review_template(params = {}) ⇒ Types::CreateReviewTemplateOutput
Create a review template.
-
#create_template_share(params = {}) ⇒ Types::CreateTemplateShareOutput
Create a review template share.
-
#create_workload(params = {}) ⇒ Types::CreateWorkloadOutput
Create a new workload.
-
#create_workload_share(params = {}) ⇒ Types::CreateWorkloadShareOutput
Create a workload share.
-
#delete_lens(params = {}) ⇒ Struct
Delete an existing lens.
-
#delete_lens_share(params = {}) ⇒ Struct
Delete a lens share.
-
#delete_profile(params = {}) ⇒ Struct
Delete a profile.
-
#delete_profile_share(params = {}) ⇒ Struct
Delete a profile share.
-
#delete_review_template(params = {}) ⇒ Struct
Delete a review template.
-
#delete_template_share(params = {}) ⇒ Struct
Delete a review template share.
-
#delete_workload(params = {}) ⇒ Struct
Delete an existing workload.
-
#delete_workload_share(params = {}) ⇒ Struct
Delete a workload share.
-
#disassociate_lenses(params = {}) ⇒ Struct
Disassociate a lens from a workload.
-
#disassociate_profiles(params = {}) ⇒ Struct
Disassociate a profile from a workload.
-
#export_lens(params = {}) ⇒ Types::ExportLensOutput
Export an existing lens.
-
#get_answer(params = {}) ⇒ Types::GetAnswerOutput
Get the answer to a specific question in a workload review.
-
#get_consolidated_report(params = {}) ⇒ Types::GetConsolidatedReportOutput
Get a consolidated report of your workloads.
-
#get_global_settings(params = {}) ⇒ Types::GetGlobalSettingsOutput
Global settings for all workloads.
-
#get_lens(params = {}) ⇒ Types::GetLensOutput
Get an existing lens.
-
#get_lens_review(params = {}) ⇒ Types::GetLensReviewOutput
Get lens review.
-
#get_lens_review_report(params = {}) ⇒ Types::GetLensReviewReportOutput
Get lens review report.
-
#get_lens_version_difference(params = {}) ⇒ Types::GetLensVersionDifferenceOutput
Get lens version differences.
-
#get_milestone(params = {}) ⇒ Types::GetMilestoneOutput
Get a milestone for an existing workload.
-
#get_profile(params = {}) ⇒ Types::GetProfileOutput
Get profile information.
-
#get_profile_template(params = {}) ⇒ Types::GetProfileTemplateOutput
Get profile template.
-
#get_review_template(params = {}) ⇒ Types::GetReviewTemplateOutput
Get review template.
-
#get_review_template_answer(params = {}) ⇒ Types::GetReviewTemplateAnswerOutput
Get review template answer.
-
#get_review_template_lens_review(params = {}) ⇒ Types::GetReviewTemplateLensReviewOutput
Get a lens review associated with a review template.
-
#get_workload(params = {}) ⇒ Types::GetWorkloadOutput
Get an existing workload.
-
#import_lens(params = {}) ⇒ Types::ImportLensOutput
Import a new custom lens or update an existing custom lens.
-
#list_answers(params = {}) ⇒ Types::ListAnswersOutput
List of answers for a particular workload and lens.
-
#list_check_details(params = {}) ⇒ Types::ListCheckDetailsOutput
List of Trusted Advisor check details by account related to the workload.
-
#list_check_summaries(params = {}) ⇒ Types::ListCheckSummariesOutput
List of Trusted Advisor checks summarized for all accounts related to the workload.
-
#list_lens_review_improvements(params = {}) ⇒ Types::ListLensReviewImprovementsOutput
List the improvements of a particular lens review.
-
#list_lens_reviews(params = {}) ⇒ Types::ListLensReviewsOutput
List lens reviews for a particular workload.
-
#list_lens_shares(params = {}) ⇒ Types::ListLensSharesOutput
List the lens shares associated with the lens.
-
#list_lenses(params = {}) ⇒ Types::ListLensesOutput
List the available lenses.
-
#list_milestones(params = {}) ⇒ Types::ListMilestonesOutput
List all milestones for an existing workload.
-
#list_notifications(params = {}) ⇒ Types::ListNotificationsOutput
List lens notifications.
-
#list_profile_notifications(params = {}) ⇒ Types::ListProfileNotificationsOutput
List profile notifications.
-
#list_profile_shares(params = {}) ⇒ Types::ListProfileSharesOutput
List profile shares.
-
#list_profiles(params = {}) ⇒ Types::ListProfilesOutput
List profiles.
-
#list_review_template_answers(params = {}) ⇒ Types::ListReviewTemplateAnswersOutput
List the answers of a review template.
-
#list_review_templates(params = {}) ⇒ Types::ListReviewTemplatesOutput
List review templates.
-
#list_share_invitations(params = {}) ⇒ Types::ListShareInvitationsOutput
List the share invitations.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List the tags for a resource.
-
#list_template_shares(params = {}) ⇒ Types::ListTemplateSharesOutput
List review template shares.
-
#list_workload_shares(params = {}) ⇒ Types::ListWorkloadSharesOutput
List the workload shares associated with the workload.
-
#list_workloads(params = {}) ⇒ Types::ListWorkloadsOutput
Paginated list of workloads.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
-
#update_answer(params = {}) ⇒ Types::UpdateAnswerOutput
Update the answer to a specific question in a workload review.
-
#update_global_settings(params = {}) ⇒ Struct
Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
-
#update_integration(params = {}) ⇒ Struct
Update integration features.
-
#update_lens_review(params = {}) ⇒ Types::UpdateLensReviewOutput
Update lens review for a particular workload.
-
#update_profile(params = {}) ⇒ Types::UpdateProfileOutput
Update a profile.
-
#update_review_template(params = {}) ⇒ Types::UpdateReviewTemplateOutput
Update a review template.
-
#update_review_template_answer(params = {}) ⇒ Types::UpdateReviewTemplateAnswerOutput
Update a review template answer.
-
#update_review_template_lens_review(params = {}) ⇒ Types::UpdateReviewTemplateLensReviewOutput
Update a lens review associated with a review template.
-
#update_share_invitation(params = {}) ⇒ Types::UpdateShareInvitationOutput
Update a workload or custom lens share invitation.
-
#update_workload(params = {}) ⇒ Types::UpdateWorkloadOutput
Update an existing workload.
-
#update_workload_share(params = {}) ⇒ Types::UpdateWorkloadShareOutput
Update a workload share.
-
#upgrade_lens_review(params = {}) ⇒ Struct
Upgrade lens review for a particular workload.
-
#upgrade_profile_version(params = {}) ⇒ Struct
Upgrade a profile.
-
#upgrade_review_template_lens_review(params = {}) ⇒ Struct
Upgrade the lens review of a review template.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#associate_lenses(params = {}) ⇒ Struct
Associate a lens to a workload.
Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.
By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.
428 429 430 431 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 428 def associate_lenses(params = {}, = {}) req = build_request(:associate_lenses, params) req.send_request() end |
#associate_profiles(params = {}) ⇒ Struct
Associate a profile with a workload.
455 456 457 458 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 455 def associate_profiles(params = {}, = {}) req = build_request(:associate_profiles, params) req.send_request() end |
#create_lens_share(params = {}) ⇒ Types::CreateLensShareOutput
Create a lens share.
The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.
Shared access to a lens is not removed until the lens invitation is deleted.
If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the lens.
For more information, see Sharing a custom lens in the Well-Architected Tool User Guide.
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
547 548 549 550 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 547 def create_lens_share(params = {}, = {}) req = build_request(:create_lens_share, params) req.send_request() end |
#create_lens_version(params = {}) ⇒ Types::CreateLensVersionOutput
Create a new lens version.
A lens can have up to 100 versions.
Use this operation to publish a new lens version after you have
imported a lens. The LensAlias
is used to identify the lens to be
published. The owner of a lens can share the lens with other Amazon
Web Services accounts and users in the same Amazon Web Services
Region. Only the owner of a lens can delete it.
622 623 624 625 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 622 def create_lens_version(params = {}, = {}) req = build_request(:create_lens_version, params) req.send_request() end |
#create_milestone(params = {}) ⇒ Types::CreateMilestoneOutput
Create a milestone for an existing workload.
677 678 679 680 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 677 def create_milestone(params = {}, = {}) req = build_request(:create_milestone, params) req.send_request() end |
#create_profile(params = {}) ⇒ Types::CreateProfileOutput
Create a profile.
744 745 746 747 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 744 def create_profile(params = {}, = {}) req = build_request(:create_profile, params) req.send_request() end |
#create_profile_share(params = {}) ⇒ Types::CreateProfileShareOutput
Create a profile share.
798 799 800 801 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 798 def create_profile_share(params = {}, = {}) req = build_request(:create_profile_share, params) req.send_request() end |
#create_review_template(params = {}) ⇒ Types::CreateReviewTemplateOutput
Create a review template.
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
877 878 879 880 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 877 def create_review_template(params = {}, = {}) req = build_request(:create_review_template, params) req.send_request() end |
#create_template_share(params = {}) ⇒ Types::CreateTemplateShareOutput
Create a review template share.
The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region.
Shared access to a review template is not removed until the review template share invitation is deleted.
If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.
By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.
950 951 952 953 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 950 def create_template_share(params = {}, = {}) req = build_request(:create_template_share, params) req.send_request() end |
#create_workload(params = {}) ⇒ Types::CreateWorkloadOutput
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the Well-Architected Tool User Guide.
Either AwsRegions
, NonAwsRegions
, or both must be specified when
creating a workload.
You also must specify ReviewOwner
, even though the parameter is
listed as not being required in the following section.
When creating a workload using a review template, you must have the following IAM permissions:
wellarchitected:GetReviewTemplate
wellarchitected:GetReviewTemplateAnswer
wellarchitected:ListReviewTemplateAnswers
wellarchitected:GetReviewTemplateLensReview
1183 1184 1185 1186 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1183 def create_workload(params = {}, = {}) req = build_request(:create_workload, params) req.send_request() end |
#create_workload_share(params = {}) ⇒ Types::CreateWorkloadShareOutput
Create a workload share.
The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.
If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.
For more information, see Sharing a workload in the Well-Architected Tool User Guide.
1257 1258 1259 1260 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1257 def create_workload_share(params = {}, = {}) req = build_request(:create_workload_share, params) req.send_request() end |
#delete_lens(params = {}) ⇒ Struct
Delete an existing lens.
Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
1328 1329 1330 1331 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1328 def delete_lens(params = {}, = {}) req = build_request(:delete_lens, params) req.send_request() end |
#delete_lens_share(params = {}) ⇒ Struct
Delete a lens share.
After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
1399 1400 1401 1402 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1399 def delete_lens_share(params = {}, = {}) req = build_request(:delete_lens_share, params) req.send_request() end |
#delete_profile(params = {}) ⇒ Struct
Delete a profile.
By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.
1450 1451 1452 1453 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1450 def delete_profile(params = {}, = {}) req = build_request(:delete_profile, params) req.send_request() end |
#delete_profile_share(params = {}) ⇒ Struct
Delete a profile share.
1494 1495 1496 1497 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1494 def delete_profile_share(params = {}, = {}) req = build_request(:delete_profile_share, params) req.send_request() end |
#delete_review_template(params = {}) ⇒ Struct
Delete a review template.
Only the owner of a review template can delete it.
After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.
1541 1542 1543 1544 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1541 def delete_review_template(params = {}, = {}) req = build_request(:delete_review_template, params) req.send_request() end |
#delete_template_share(params = {}) ⇒ Struct
Delete a review template share.
After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.
1590 1591 1592 1593 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1590 def delete_template_share(params = {}, = {}) req = build_request(:delete_template_share, params) req.send_request() end |
#delete_workload(params = {}) ⇒ Struct
Delete an existing workload.
1631 1632 1633 1634 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1631 def delete_workload(params = {}, = {}) req = build_request(:delete_workload, params) req.send_request() end |
#delete_workload_share(params = {}) ⇒ Struct
Delete a workload share.
1676 1677 1678 1679 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1676 def delete_workload_share(params = {}, = {}) req = build_request(:delete_workload_share, params) req.send_request() end |
#disassociate_lenses(params = {}) ⇒ Struct
Disassociate a lens from a workload.
Up to 10 lenses can be disassociated from a workload in a single API operation.
wellarchitected
) cannot be removed from a workload.
1714 1715 1716 1717 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1714 def disassociate_lenses(params = {}, = {}) req = build_request(:disassociate_lenses, params) req.send_request() end |
#disassociate_profiles(params = {}) ⇒ Struct
Disassociate a profile from a workload.
1741 1742 1743 1744 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1741 def disassociate_profiles(params = {}, = {}) req = build_request(:disassociate_profiles, params) req.send_request() end |
#export_lens(params = {}) ⇒ Types::ExportLensOutput
Export an existing lens.
Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
1806 1807 1808 1809 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1806 def export_lens(params = {}, = {}) req = build_request(:export_lens, params) req.send_request() end |
#get_answer(params = {}) ⇒ Types::GetAnswerOutput
Get the answer to a specific question in a workload review.
1900 1901 1902 1903 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1900 def get_answer(params = {}, = {}) req = build_request(:get_answer, params) req.send_request() end |
#get_consolidated_report(params = {}) ⇒ Types::GetConsolidatedReportOutput
Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1974 1975 1976 1977 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1974 def get_consolidated_report(params = {}, = {}) req = build_request(:get_consolidated_report, params) req.send_request() end |
#get_global_settings(params = {}) ⇒ Types::GetGlobalSettingsOutput
Global settings for all workloads.
2002 2003 2004 2005 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2002 def get_global_settings(params = {}, = {}) req = build_request(:get_global_settings, params) req.send_request() end |
#get_lens(params = {}) ⇒ Types::GetLensOutput
Get an existing lens.
2052 2053 2054 2055 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2052 def get_lens(params = {}, = {}) req = build_request(:get_lens, params) req.send_request() end |
#get_lens_review(params = {}) ⇒ Types::GetLensReviewOutput
Get lens review.
2132 2133 2134 2135 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2132 def get_lens_review(params = {}, = {}) req = build_request(:get_lens_review, params) req.send_request() end |
#get_lens_review_report(params = {}) ⇒ Types::GetLensReviewReportOutput
Get lens review report.
2188 2189 2190 2191 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2188 def get_lens_review_report(params = {}, = {}) req = build_request(:get_lens_review_report, params) req.send_request() end |
#get_lens_version_difference(params = {}) ⇒ Types::GetLensVersionDifferenceOutput
Get lens version differences.
2252 2253 2254 2255 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2252 def get_lens_version_difference(params = {}, = {}) req = build_request(:get_lens_version_difference, params) req.send_request() end |
#get_milestone(params = {}) ⇒ Types::GetMilestoneOutput
Get a milestone for an existing workload.
2335 2336 2337 2338 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2335 def get_milestone(params = {}, = {}) req = build_request(:get_milestone, params) req.send_request() end |
#get_profile(params = {}) ⇒ Types::GetProfileOutput
Get profile information.
2388 2389 2390 2391 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2388 def get_profile(params = {}, = {}) req = build_request(:get_profile, params) req.send_request() end |
#get_profile_template(params = {}) ⇒ Types::GetProfileTemplateOutput
Get profile template.
2419 2420 2421 2422 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2419 def get_profile_template(params = {}, = {}) req = build_request(:get_profile_template, params) req.send_request() end |
#get_review_template(params = {}) ⇒ Types::GetReviewTemplateOutput
Get review template.
2460 2461 2462 2463 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2460 def get_review_template(params = {}, = {}) req = build_request(:get_review_template, params) req.send_request() end |
#get_review_template_answer(params = {}) ⇒ Types::GetReviewTemplateAnswerOutput
Get review template answer.
2541 2542 2543 2544 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2541 def get_review_template_answer(params = {}, = {}) req = build_request(:get_review_template_answer, params) req.send_request() end |
#get_review_template_lens_review(params = {}) ⇒ Types::GetReviewTemplateLensReviewOutput
Get a lens review associated with a review template.
2601 2602 2603 2604 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2601 def get_review_template_lens_review(params = {}, = {}) req = build_request(:get_review_template_lens_review, params) req.send_request() end |
#get_workload(params = {}) ⇒ Types::GetWorkloadOutput
Get an existing workload.
2673 2674 2675 2676 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2673 def get_workload(params = {}, = {}) req = build_request(:get_workload, params) req.send_request() end |
#import_lens(params = {}) ⇒ Types::ImportLensOutput
Import a new custom lens or update an existing custom lens.
To update an existing custom lens, specify its ARN as the LensAlias
.
If no ARN is specified, a new custom lens is created.
The new or updated lens will have a status of DRAFT
. The lens cannot
be applied to workloads or shared with other Amazon Web Services
accounts until it's published with CreateLensVersion.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
A custom lens cannot exceed 500 KB in size.
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2770 def import_lens(params = {}, = {}) req = build_request(:import_lens, params) req.send_request() end |
#list_answers(params = {}) ⇒ Types::ListAnswersOutput
List of answers for a particular workload and lens.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2878 2879 2880 2881 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2878 def list_answers(params = {}, = {}) req = build_request(:list_answers, params) req.send_request() end |
#list_check_details(params = {}) ⇒ Types::ListCheckDetailsOutput
List of Trusted Advisor check details by account related to the workload.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2951 2952 2953 2954 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2951 def list_check_details(params = {}, = {}) req = build_request(:list_check_details, params) req.send_request() end |
#list_check_summaries(params = {}) ⇒ Types::ListCheckSummariesOutput
List of Trusted Advisor checks summarized for all accounts related to the workload.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3023 3024 3025 3026 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3023 def list_check_summaries(params = {}, = {}) req = build_request(:list_check_summaries, params) req.send_request() end |
#list_lens_review_improvements(params = {}) ⇒ Types::ListLensReviewImprovementsOutput
List the improvements of a particular lens review.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3114 3115 3116 3117 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3114 def list_lens_review_improvements(params = {}, = {}) req = build_request(:list_lens_review_improvements, params) req.send_request() end |
#list_lens_reviews(params = {}) ⇒ Types::ListLensReviewsOutput
List lens reviews for a particular workload.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3178 3179 3180 3181 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3178 def list_lens_reviews(params = {}, = {}) req = build_request(:list_lens_reviews, params) req.send_request() end |
#list_lens_shares(params = {}) ⇒ Types::ListLensSharesOutput
List the lens shares associated with the lens.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3242 3243 3244 3245 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3242 def list_lens_shares(params = {}, = {}) req = build_request(:list_lens_shares, params) req.send_request() end |
#list_lenses(params = {}) ⇒ Types::ListLensesOutput
List the available lenses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3300 3301 3302 3303 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3300 def list_lenses(params = {}, = {}) req = build_request(:list_lenses, params) req.send_request() end |
#list_milestones(params = {}) ⇒ Types::ListMilestonesOutput
List all milestones for an existing workload.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3361 3362 3363 3364 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3361 def list_milestones(params = {}, = {}) req = build_request(:list_milestones, params) req.send_request() end |
#list_notifications(params = {}) ⇒ Types::ListNotificationsOutput
List lens notifications.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3419 3420 3421 3422 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3419 def list_notifications(params = {}, = {}) req = build_request(:list_notifications, params) req.send_request() end |
#list_profile_notifications(params = {}) ⇒ Types::ListProfileNotificationsOutput
List profile notifications.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3467 3468 3469 3470 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3467 def list_profile_notifications(params = {}, = {}) req = build_request(:list_profile_notifications, params) req.send_request() end |
#list_profile_shares(params = {}) ⇒ Types::ListProfileSharesOutput
List profile shares.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3520 3521 3522 3523 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3520 def list_profile_shares(params = {}, = {}) req = build_request(:list_profile_shares, params) req.send_request() end |
#list_profiles(params = {}) ⇒ Types::ListProfilesOutput
List profiles.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3572 3573 3574 3575 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3572 def list_profiles(params = {}, = {}) req = build_request(:list_profiles, params) req.send_request() end |
#list_review_template_answers(params = {}) ⇒ Types::ListReviewTemplateAnswersOutput
List the answers of a review template.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3663 3664 3665 3666 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3663 def list_review_template_answers(params = {}, = {}) req = build_request(:list_review_template_answers, params) req.send_request() end |
#list_review_templates(params = {}) ⇒ Types::ListReviewTemplatesOutput
List review templates.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3707 3708 3709 3710 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3707 def list_review_templates(params = {}, = {}) req = build_request(:list_review_templates, params) req.send_request() end |
#list_share_invitations(params = {}) ⇒ Types::ListShareInvitationsOutput
List the share invitations.
WorkloadNamePrefix
, LensNamePrefix
, ProfileNamePrefix
, and
TemplateNamePrefix
are mutually exclusive. Use the parameter that
matches your ShareResourceType
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3784 3785 3786 3787 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3784 def list_share_invitations(params = {}, = {}) req = build_request(:list_share_invitations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List the tags for a resource.
3818 3819 3820 3821 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3818 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_template_shares(params = {}) ⇒ Types::ListTemplateSharesOutput
List review template shares.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3873 3874 3875 3876 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3873 def list_template_shares(params = {}, = {}) req = build_request(:list_template_shares, params) req.send_request() end |
#list_workload_shares(params = {}) ⇒ Types::ListWorkloadSharesOutput
List the workload shares associated with the workload.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3930 3931 3932 3933 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3930 def list_workload_shares(params = {}, = {}) req = build_request(:list_workload_shares, params) req.send_request() end |
#list_workloads(params = {}) ⇒ Types::ListWorkloadsOutput
Paginated list of workloads.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3986 3987 3988 3989 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3986 def list_workloads(params = {}, = {}) req = build_request(:list_workloads, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to the specified resource.
4019 4020 4021 4022 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4019 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
4056 4057 4058 4059 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4056 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_answer(params = {}) ⇒ Types::UpdateAnswerOutput
Update the answer to a specific question in a workload review.
4174 4175 4176 4177 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4174 def update_answer(params = {}, = {}) req = build_request(:update_answer, params) req.send_request() end |
#update_global_settings(params = {}) ⇒ Struct
Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
4210 4211 4212 4213 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4210 def update_global_settings(params = {}, = {}) req = build_request(:update_global_settings, params) req.send_request() end |
#update_integration(params = {}) ⇒ Struct
Update integration features.
4255 4256 4257 4258 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4255 def update_integration(params = {}, = {}) req = build_request(:update_integration, params) req.send_request() end |
#update_lens_review(params = {}) ⇒ Types::UpdateLensReviewOutput
Update lens review for a particular workload.
4354 4355 4356 4357 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4354 def update_lens_review(params = {}, = {}) req = build_request(:update_lens_review, params) req.send_request() end |
#update_profile(params = {}) ⇒ Types::UpdateProfileOutput
Update a profile.
4416 4417 4418 4419 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4416 def update_profile(params = {}, = {}) req = build_request(:update_profile, params) req.send_request() end |
#update_review_template(params = {}) ⇒ Types::UpdateReviewTemplateOutput
Update a review template.
4481 4482 4483 4484 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4481 def update_review_template(params = {}, = {}) req = build_request(:update_review_template, params) req.send_request() end |
#update_review_template_answer(params = {}) ⇒ Types::UpdateReviewTemplateAnswerOutput
Update a review template answer.
4593 4594 4595 4596 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4593 def update_review_template_answer(params = {}, = {}) req = build_request(:update_review_template_answer, params) req.send_request() end |
#update_review_template_lens_review(params = {}) ⇒ Types::UpdateReviewTemplateLensReviewOutput
Update a lens review associated with a review template.
4669 4670 4671 4672 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4669 def update_review_template_lens_review(params = {}, = {}) req = build_request(:update_review_template_lens_review, params) req.send_request() end |
#update_share_invitation(params = {}) ⇒ Types::UpdateShareInvitationOutput
Update a workload or custom lens share invitation.
4712 4713 4714 4715 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4712 def update_share_invitation(params = {}, = {}) req = build_request(:update_share_invitation, params) req.send_request() end |
#update_workload(params = {}) ⇒ Types::UpdateWorkloadOutput
Update an existing workload.
4935 4936 4937 4938 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4935 def update_workload(params = {}, = {}) req = build_request(:update_workload, params) req.send_request() end |
#update_workload_share(params = {}) ⇒ Types::UpdateWorkloadShareOutput
Update a workload share.
4980 4981 4982 4983 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4980 def update_workload_share(params = {}, = {}) req = build_request(:update_workload_share, params) req.send_request() end |
#upgrade_lens_review(params = {}) ⇒ Struct
Upgrade lens review for a particular workload.
5039 5040 5041 5042 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5039 def upgrade_lens_review(params = {}, = {}) req = build_request(:upgrade_lens_review, params) req.send_request() end |
#upgrade_profile_version(params = {}) ⇒ Struct
Upgrade a profile.
5090 5091 5092 5093 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5090 def upgrade_profile_version(params = {}, = {}) req = build_request(:upgrade_profile_version, params) req.send_request() end |
#upgrade_review_template_lens_review(params = {}) ⇒ Struct
Upgrade the lens review of a review template.
5142 5143 5144 5145 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5142 def upgrade_review_template_lens_review(params = {}, = {}) req = build_request(:upgrade_review_template_lens_review, params) req.send_request() end |