Client
wellarchitected | R Documentation |
AWS Well-Architected Tool¶
Description¶
Well-Architected Tool
This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.
Usage¶
Arguments¶
config
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to
true
to force the request to use path-style addressing, i.e.http://s3.amazonaws.com/BUCKET/KEY
.sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint
Optional shorthand for complete URL to use for the constructed client.
region
Optional shorthand for AWS Region used in instantiating the client.
Value¶
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've
assigned to the client. The available operations are listed in the
Operations section.
Service syntax¶
svc <- wellarchitected(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations¶
- associate_lenses
- Associate a lens to a workload
- associate_profiles
- Associate a profile with a workload
- create_lens_share
- Create a lens share
- create_lens_version
- Create a new lens version
- create_milestone
- Create a milestone for an existing workload
- create_profile
- Create a profile
- create_profile_share
- Create a profile share
- create_review_template
- Create a review template
- create_template_share
- Create a review template share
- create_workload
- Create a new workload
- create_workload_share
- Create a workload share
- delete_lens
- Delete an existing lens
- delete_lens_share
- Delete a lens share
- delete_profile
- Delete a profile
- delete_profile_share
- Delete a profile share
- delete_review_template
- Delete a review template
- delete_template_share
- Delete a review template share
- delete_workload
- Delete an existing workload
- delete_workload_share
- Delete a workload share
- disassociate_lenses
- Disassociate a lens from a workload
- disassociate_profiles
- Disassociate a profile from a workload
- export_lens
- Export an existing lens
- get_answer
- Get the answer to a specific question in a workload review
- get_consolidated_report
- Get a consolidated report of your workloads
- get_global_settings
- Global settings for all workloads
- get_lens
- Get an existing lens
- get_lens_review
- Get lens review
- get_lens_review_report
- Get lens review report
- get_lens_version_difference
- Get lens version differences
- get_milestone
- Get a milestone for an existing workload
- get_profile
- Get profile information
- get_profile_template
- Get profile template
- get_review_template
- Get review template
- get_review_template_answer
- Get review template answer
- get_review_template_lens_review
- Get a lens review associated with a review template
- get_workload
- Get an existing workload
- import_lens
- Import a new custom lens or update an existing custom lens
- list_answers
- List of answers for a particular workload and lens
- list_check_details
- List of Trusted Advisor check details by account related to the workload
- list_check_summaries
- List of Trusted Advisor checks summarized for all accounts related to the workload
- list_lenses
- List the available lenses
- list_lens_review_improvements
- List the improvements of a particular lens review
- list_lens_reviews
- List lens reviews for a particular workload
- list_lens_shares
- List the lens shares associated with the lens
- list_milestones
- List all milestones for an existing workload
- list_notifications
- List lens notifications
- list_profile_notifications
- List profile notifications
- list_profiles
- List profiles
- list_profile_shares
- List profile shares
- list_review_template_answers
- List the answers of a review template
- list_review_templates
- List review templates
- list_share_invitations
- List the share invitations
- list_tags_for_resource
- List the tags for a resource
- list_template_shares
- List review template shares
- list_workloads
- Paginated list of workloads
- list_workload_shares
- List the workload shares associated with the workload
- tag_resource
- Adds one or more tags to the specified resource
- untag_resource
- Deletes specified tags from a resource
- update_answer
- Update the answer to a specific question in a workload review
- update_global_settings
- Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features
- update_integration
- Update integration features
- update_lens_review
- Update lens review for a particular workload
- update_profile
- Update a profile
- update_review_template
- Update a review template
- update_review_template_answer
- Update a review template answer
- update_review_template_lens_review
- Update a lens review associated with a review template
- update_share_invitation
- Update a workload or custom lens share invitation
- update_workload
- Update an existing workload
- update_workload_share
- Update a workload share
- upgrade_lens_review
- Upgrade lens review for a particular workload
- upgrade_profile_version
- Upgrade a profile
- upgrade_review_template_lens_review
- Upgrade the lens review of a review template