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.
466 467 468 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 466 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.
509 510 511 512 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 509 def associate_lenses(params = {}, = {}) req = build_request(:associate_lenses, params) req.send_request() end |
#associate_profiles(params = {}) ⇒ Struct
Associate a profile with a workload.
536 537 538 539 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 536 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.
628 629 630 631 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 628 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.
703 704 705 706 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 703 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.
758 759 760 761 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 758 def create_milestone(params = {}, = {}) req = build_request(:create_milestone, params) req.send_request() end |
#create_profile(params = {}) ⇒ Types::CreateProfileOutput
Create a profile.
825 826 827 828 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 825 def create_profile(params = {}, = {}) req = build_request(:create_profile, params) req.send_request() end |
#create_profile_share(params = {}) ⇒ Types::CreateProfileShareOutput
Create a profile share.
879 880 881 882 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 879 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.
958 959 960 961 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 958 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.
1031 1032 1033 1034 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1031 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
1264 1265 1266 1267 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1264 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.
1338 1339 1340 1341 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1338 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.
1409 1410 1411 1412 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1409 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.
1480 1481 1482 1483 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1480 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.
1531 1532 1533 1534 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1531 def delete_profile(params = {}, = {}) req = build_request(:delete_profile, params) req.send_request() end |
#delete_profile_share(params = {}) ⇒ Struct
Delete a profile share.
1575 1576 1577 1578 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1575 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.
1622 1623 1624 1625 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1622 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.
1671 1672 1673 1674 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1671 def delete_template_share(params = {}, = {}) req = build_request(:delete_template_share, params) req.send_request() end |
#delete_workload(params = {}) ⇒ Struct
Delete an existing workload.
1712 1713 1714 1715 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1712 def delete_workload(params = {}, = {}) req = build_request(:delete_workload, params) req.send_request() end |
#delete_workload_share(params = {}) ⇒ Struct
Delete a workload share.
1757 1758 1759 1760 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1757 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.
1795 1796 1797 1798 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1795 def disassociate_lenses(params = {}, = {}) req = build_request(:disassociate_lenses, params) req.send_request() end |
#disassociate_profiles(params = {}) ⇒ Struct
Disassociate a profile from a workload.
1822 1823 1824 1825 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1822 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.
1887 1888 1889 1890 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1887 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.
1981 1982 1983 1984 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1981 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.
2055 2056 2057 2058 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2055 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.
2083 2084 2085 2086 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2083 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.
2133 2134 2135 2136 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2133 def get_lens(params = {}, = {}) req = build_request(:get_lens, params) req.send_request() end |
#get_lens_review(params = {}) ⇒ Types::GetLensReviewOutput
Get lens review.
2213 2214 2215 2216 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2213 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.
2269 2270 2271 2272 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2269 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.
2333 2334 2335 2336 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2333 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.
2416 2417 2418 2419 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2416 def get_milestone(params = {}, = {}) req = build_request(:get_milestone, params) req.send_request() end |
#get_profile(params = {}) ⇒ Types::GetProfileOutput
Get profile information.
2469 2470 2471 2472 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2469 def get_profile(params = {}, = {}) req = build_request(:get_profile, params) req.send_request() end |
#get_profile_template(params = {}) ⇒ Types::GetProfileTemplateOutput
Get profile template.
2500 2501 2502 2503 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2500 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.
2541 2542 2543 2544 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2541 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.
2622 2623 2624 2625 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2622 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.
2682 2683 2684 2685 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2682 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.
2754 2755 2756 2757 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2754 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.
2851 2852 2853 2854 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2851 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.
2959 2960 2961 2962 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2959 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.
3032 3033 3034 3035 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3032 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.
3104 3105 3106 3107 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3104 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.
3195 3196 3197 3198 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3195 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.
3259 3260 3261 3262 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3259 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.
3323 3324 3325 3326 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3323 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.
3381 3382 3383 3384 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3381 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.
3442 3443 3444 3445 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3442 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.
3500 3501 3502 3503 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3500 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.
3548 3549 3550 3551 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3548 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.
3601 3602 3603 3604 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3601 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.
3653 3654 3655 3656 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3653 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.
3744 3745 3746 3747 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3744 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.
3788 3789 3790 3791 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3788 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.
3865 3866 3867 3868 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3865 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.
3899 3900 3901 3902 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3899 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.
3954 3955 3956 3957 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3954 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.
4011 4012 4013 4014 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4011 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.
4067 4068 4069 4070 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4067 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.
4100 4101 4102 4103 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4100 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
4137 4138 4139 4140 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4137 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.
4255 4256 4257 4258 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4255 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.
4291 4292 4293 4294 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4291 def update_global_settings(params = {}, = {}) req = build_request(:update_global_settings, params) req.send_request() end |
#update_integration(params = {}) ⇒ Struct
Update integration features.
4336 4337 4338 4339 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4336 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.
4435 4436 4437 4438 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4435 def update_lens_review(params = {}, = {}) req = build_request(:update_lens_review, params) req.send_request() end |
#update_profile(params = {}) ⇒ Types::UpdateProfileOutput
Update a profile.
4497 4498 4499 4500 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4497 def update_profile(params = {}, = {}) req = build_request(:update_profile, params) req.send_request() end |
#update_review_template(params = {}) ⇒ Types::UpdateReviewTemplateOutput
Update a review template.
4562 4563 4564 4565 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4562 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.
4674 4675 4676 4677 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4674 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.
4750 4751 4752 4753 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4750 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.
4793 4794 4795 4796 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4793 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.
5016 5017 5018 5019 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5016 def update_workload(params = {}, = {}) req = build_request(:update_workload, params) req.send_request() end |
#update_workload_share(params = {}) ⇒ Types::UpdateWorkloadShareOutput
Update a workload share.
5061 5062 5063 5064 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5061 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.
5120 5121 5122 5123 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5120 def upgrade_lens_review(params = {}, = {}) req = build_request(:upgrade_lens_review, params) req.send_request() end |
#upgrade_profile_version(params = {}) ⇒ Struct
Upgrade a profile.
5171 5172 5173 5174 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5171 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.
5223 5224 5225 5226 |
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5223 def upgrade_review_template_lens_review(params = {}, = {}) req = build_request(:upgrade_review_template_lens_review, params) req.send_request() end |