Class: Aws::WellArchitected::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::WellArchitected::Client

show all

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

#config, #handlers

API Operations collapse

#associate_lenses(params = {}) ⇒ Struct
Associate a lens to 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_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_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.
#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_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_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 lens review improvements.
#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_share_invitations(params = {}) ⇒ Types::ListShareInvitationsOutput
List the workload invitations.
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List the tags for a resource.
#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
Updates whether the Amazon Web Services account is opted into organization sharing features.
#update_lens_review(params = {}) ⇒ Types::UpdateLensReviewOutput
Update lens review for a particular workload.
#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.

Instance Method Summary collapse

#initialize(options) ⇒ Client constructor
A new instance of Client.

Constructor Details

#initialize(options) ⇒ `Client`

Returns a new instance of Client.

Parameters:

options (Hash)

Options Hash (options):

:credentials (required, Aws::CredentialProvider) —
Your AWS credentials. This can be an instance of any one of the following classes:
- Aws::Credentials - Used for configuring static, non-refreshing credentials.
- Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.
- Aws::AssumeRoleCredentials - Used when you need to assume a role.
- Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.
- Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.
- Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.
- Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- Aws::ECSCredentials - Used for loading credentials from instances running in ECS.
- Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.
When :credentials are not configured directly, the following locations will be searched for credentials:
- Aws.config[:credentials]
- The :access_key_id, :secret_access_key, and :session_token options.
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- ~/.aws/credentials
- ~/.aws/config
- EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
:region (required, String) —
The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:
- Aws.config[:region]
- ENV['AWS_REGION']
- ENV['AMAZON_REGION']
- ENV['AWS_DEFAULT_REGION']
- ~/.aws/credentials
- ~/.aws/config
:access_key_id (String)
:active_endpoint_cache (Boolean) — default: false —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.
:adaptive_retry_wait_to_fill (Boolean) — default: true —
Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.
:client_side_monitoring (Boolean) — default: false —
When true, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_host (String) — default: "127.0.0.1" —
Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_port (Integer) — default: 31000 —
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types.
:correct_clock_skew (Boolean) — default: true —
Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.
:defaults_mode (String) — default: "legacy" —
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
:disable_host_prefix_injection (Boolean) — default: false —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
:endpoint (String) —
The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.
:endpoint_cache_max_entries (Integer) — default: 1000 —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 60 —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
:endpoint_discovery (Boolean) — default: false —
When set to true, endpoint discovery will be enabled for operations when available.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —
The log formatter.
:log_level (Symbol) — default: :info —
The log level to send messages to the :logger at.
:logger (Logger) —
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:max_attempts (Integer) — default: 3 —
An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.
:profile (String) — default: "default" —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.
:retry_backoff (Proc) —
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.
:retry_base_delay (Float) — default: 0.3 —
The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.
:retry_jitter (Symbol) — default: :none —
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

@see https://www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.
:retry_max_delay (Integer) — default: 0 —
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.
:retry_mode (String) — default: "legacy" —
Specifies which retry algorithm to use. Values are:
- legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.
- standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.
- adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
:secret_access_key (String)
:session_token (String)
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
:token_provider (Aws::TokenProvider) —
A Bearer Token Provider. This can be an instance of any one of the following classes:
- Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.
- Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.
When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.
:use_dualstack_endpoint (Boolean) —
When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.
:use_fips_endpoint (Boolean) —
When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request.
:endpoint_provider (Aws::WellArchitected::EndpointProvider) —
The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::WellArchitected::EndpointParameters
:http_proxy (URI::HTTP, String) —
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
:http_open_timeout (Float) — default: 15 —
The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.
:http_read_timeout (Float) — default: 60 —
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_idle_timeout (Float) — default: 5 —
The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
:http_continue_timeout (Float) — default: 1 —
The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.
:ssl_timeout (Float) — default: nil —
Sets the SSL timeout in seconds.
:http_wire_trace (Boolean) — default: false —
When true, HTTP debug output will be sent to the :logger.
:ssl_verify_peer (Boolean) — default: true —
When true, SSL peer certificates are verified when establishing a connection.
:ssl_ca_bundle (String) —
Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.
:ssl_ca_directory (String) —
Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



365
366
367

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 365

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.

Disclaimer

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.

Examples:

Request syntax with placeholder values


resp = client.associate_lenses({
  workload_id: "WorkloadId", # required
  lens_aliases: ["LensAlias"], # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:lens_aliases (required, Array<String>) —
List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.

Identify a lens using its LensSummary$LensAlias.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 408

def associate_lenses(params = {}, options = {})
  req = build_request(:associate_lenses, params)
  req.send_request(options)
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.

Disclaimer

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.

Examples:

Request syntax with placeholder values


resp = client.create_lens_share({
  lens_alias: "LensAlias", # required
  shared_with: "SharedWith", # required
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.share_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:shared_with (required, String) —
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
:client_request_token (required, String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::CreateLensShareOutput) —
Returns a response object which responds to the following methods:
- #share_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 499

def create_lens_share(params = {}, options = {})
  req = build_request(:create_lens_share, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_lens_version({
  lens_alias: "LensAlias", # required
  lens_version: "LensVersion", # required
  is_major_version: false,
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.lens_arn #=> String
resp.lens_version #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:lens_version (required, String) —
The version of the lens being created.
:is_major_version (Boolean) —
Set to true if this new major lens version.
:client_request_token (required, String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::CreateLensVersionOutput) —
Returns a response object which responds to the following methods:
- #lens_arn => String
- #lens_version => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 574

def create_lens_version(params = {}, options = {})
  req = build_request(:create_lens_version, params)
  req.send_request(options)
end

#create_milestone(params = {}) ⇒ `Types::CreateMilestoneOutput`

Create a milestone for an existing workload.

Examples:

Request syntax with placeholder values


resp = client.create_milestone({
  workload_id: "WorkloadId", # required
  milestone_name: "MilestoneName", # required
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.workload_id #=> String
resp.milestone_number #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:milestone_name (required, String) —
The name of the milestone in a workload.

Milestone names must be unique within a workload.
:client_request_token (required, String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::CreateMilestoneOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #milestone_number => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 629

def create_milestone(params = {}, options = {})
  req = build_request(:create_milestone, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_workload({
  workload_name: "WorkloadName", # required
  description: "WorkloadDescription", # required
  environment: "PRODUCTION", # required, accepts PRODUCTION, PREPRODUCTION
  account_ids: ["AwsAccountId"],
  aws_regions: ["AwsRegion"],
  non_aws_regions: ["WorkloadNonAwsRegion"],
  pillar_priorities: ["PillarId"],
  architectural_design: "WorkloadArchitecturalDesign",
  review_owner: "WorkloadReviewOwner",
  industry_type: "WorkloadIndustryType",
  industry: "WorkloadIndustry",
  lenses: ["LensAlias"], # required
  notes: "Notes",
  client_request_token: "ClientRequestToken", # required
  tags: {
    "TagKey" => "TagValue",
  },
  discovery_config: {
    trusted_advisor_integration_status: "ENABLED", # accepts ENABLED, DISABLED
  },
  applications: ["ApplicationArn"],
})

Response structure


resp.workload_id #=> String
resp.workload_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_name (required, String) —
The name of the workload.

The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
:description (required, String) —
The description for the workload.
:environment (required, String) —
The environment for the workload.
:account_ids (Array<String>) —
The list of Amazon Web Services account IDs associated with the workload.
:aws_regions (Array<String>) —
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.
:non_aws_regions (Array<String>) —
The list of non-Amazon Web Services Regions associated with the workload.
:pillar_priorities (Array<String>) —
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
:architectural_design (String) —
The URL of the architectural design for the workload.
:review_owner (String) —
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
:industry_type (String) —
The industry type for the workload.

If specified, must be one of the following:
- Agriculture
- Automobile
- Defense
- Design and Engineering
- Digital Advertising
- Education
- Environmental Protection
- Financial Services
- Gaming
- General Public Services
- Healthcare
- Hospitality
- InfoTech
- Justice and Public Safety
- Life Sciences
- Manufacturing
- Media & Entertainment
- Mining & Resources
- Oil & Gas
- Power & Utilities
- Professional Services
- Real Estate & Construction
- Retail & Wholesale
- Social Protection
- Telecommunications
- Travel, Transportation & Logistics
- Other
:industry (String) —
The industry for the workload.
:lenses (required, Array<String>) —
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
:notes (String) —
The notes associated with the workload.
:client_request_token (required, String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

A suitable default value is auto-generated. You should normally not need to pass this option.**
:tags (Hash<String,String>) —
The tags to be associated with the workload.
:discovery_config (Types::WorkloadDiscoveryConfig) —
Well-Architected discovery configuration settings associated to the workload.
:applications (Array<String>) —
List of AppRegistry application ARNs associated to the workload.

Returns:

(Types::CreateWorkloadOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #workload_arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 828

def create_workload(params = {}, options = {})
  req = build_request(:create_workload, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_workload_share({
  workload_id: "WorkloadId", # required
  shared_with: "SharedWith", # required
  permission_type: "READONLY", # required, accepts READONLY, CONTRIBUTOR
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.workload_id #=> String
resp.share_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:shared_with (required, String) —
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
:permission_type (required, String) —
Permission granted on a workload share.
:client_request_token (required, String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::CreateWorkloadShareOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #share_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 901

def create_workload_share(params = {}, options = {})
  req = build_request(:create_workload_share, params)
  req.send_request(options)
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.

Disclaimer

Examples:

Request syntax with placeholder values


resp = client.delete_lens({
  lens_alias: "LensAlias", # required
  client_request_token: "ClientRequestToken", # required
  lens_status: "ALL", # required, accepts ALL, DRAFT, PUBLISHED
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:client_request_token (required, String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

A suitable default value is auto-generated. You should normally not need to pass this option.**
:lens_status (required, String) —
The status of the lens to be deleted.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 972

def delete_lens(params = {}, options = {})
  req = build_request(:delete_lens, params)
  req.send_request(options)
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.

Disclaimer

Examples:

Request syntax with placeholder values


resp = client.delete_lens_share({
  share_id: "ShareId", # required
  lens_alias: "LensAlias", # required
  client_request_token: "ClientRequestToken", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:share_id (required, String) —
The ID associated with the workload share.
:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:client_request_token (required, String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1043

def delete_lens_share(params = {}, options = {})
  req = build_request(:delete_lens_share, params)
  req.send_request(options)
end

#delete_workload(params = {}) ⇒ `Struct`

Delete an existing workload.

Examples:

Request syntax with placeholder values


resp = client.delete_workload({
  workload_id: "WorkloadId", # required
  client_request_token: "ClientRequestToken", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:client_request_token (required, String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1084

def delete_workload(params = {}, options = {})
  req = build_request(:delete_workload, params)
  req.send_request(options)
end

#delete_workload_share(params = {}) ⇒ `Struct`

Delete a workload share.

Examples:

Request syntax with placeholder values


resp = client.delete_workload_share({
  share_id: "ShareId", # required
  workload_id: "WorkloadId", # required
  client_request_token: "ClientRequestToken", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:share_id (required, String) —
The ID associated with the workload share.
:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:client_request_token (required, String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1129

def delete_workload_share(params = {}, options = {})
  req = build_request(:delete_workload_share, params)
  req.send_request(options)
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.

The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.

Examples:

Request syntax with placeholder values


resp = client.disassociate_lenses({
  workload_id: "WorkloadId", # required
  lens_aliases: ["LensAlias"], # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:lens_aliases (required, Array<String>) —
List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.

Identify a lens using its LensSummary$LensAlias.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1167

def disassociate_lenses(params = {}, options = {})
  req = build_request(:disassociate_lenses, params)
  req.send_request(options)
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.

Disclaimer

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.

Examples:

Request syntax with placeholder values


resp = client.export_lens({
  lens_alias: "LensAlias", # required
  lens_version: "LensVersion",
})

Response structure


resp.lens_json #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:lens_version (String) —
The lens version to be exported.

Returns:

(Types::ExportLensOutput) —
Returns a response object which responds to the following methods:
- #lens_json => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1232

def export_lens(params = {}, options = {})
  req = build_request(:export_lens, params)
  req.send_request(options)
end

#get_answer(params = {}) ⇒ `Types::GetAnswerOutput`

Get the answer to a specific question in a workload review.

Examples:

Request syntax with placeholder values


resp = client.get_answer({
  workload_id: "WorkloadId", # required
  lens_alias: "LensAlias", # required
  question_id: "QuestionId", # required
  milestone_number: 1,
})

Response structure


resp.workload_id #=> String
resp.milestone_number #=> Integer
resp.lens_alias #=> String
resp.lens_arn #=> String
resp.answer.question_id #=> String
resp.answer.pillar_id #=> String
resp.answer.question_title #=> String
resp.answer.question_description #=> String
resp.answer.improvement_plan_url #=> String
resp.answer.helpful_resource_url #=> String
resp.answer.helpful_resource_display_text #=> String
resp.answer.choices #=> Array
resp.answer.choices[0].choice_id #=> String
resp.answer.choices[0].title #=> String
resp.answer.choices[0].description #=> String
resp.answer.choices[0].helpful_resource.display_text #=> String
resp.answer.choices[0].helpful_resource.url #=> String
resp.answer.choices[0].improvement_plan.display_text #=> String
resp.answer.choices[0].improvement_plan.url #=> String
resp.answer.choices[0].additional_resources #=> Array
resp.answer.choices[0].additional_resources[0].type #=> String, one of "HELPFUL_RESOURCE", "IMPROVEMENT_PLAN"
resp.answer.choices[0].additional_resources[0].content #=> Array
resp.answer.choices[0].additional_resources[0].content[0].display_text #=> String
resp.answer.choices[0].additional_resources[0].content[0].url #=> String
resp.answer.selected_choices #=> Array
resp.answer.selected_choices[0] #=> String
resp.answer.choice_answers #=> Array
resp.answer.choice_answers[0].choice_id #=> String
resp.answer.choice_answers[0].status #=> String, one of "SELECTED", "NOT_APPLICABLE", "UNSELECTED"
resp.answer.choice_answers[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
resp.answer.choice_answers[0].notes #=> String
resp.answer.is_applicable #=> Boolean
resp.answer.risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
resp.answer.notes #=> String
resp.answer.reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:question_id (required, String) —
The ID of the question.
:milestone_number (Integer) —
The milestone number.

A workload can have a maximum of 100 milestones.

Returns:

(Types::GetAnswerOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #milestone_number => Integer
- #lens_alias => String
- #lens_arn => String
- #answer => Types::Answer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1324

def get_answer(params = {}, options = {})
  req = build_request(:get_answer, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_consolidated_report({
  format: "PDF", # required, accepts PDF, JSON
  include_shared_resources: false,
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.metrics #=> Array
resp.metrics[0].metric_type #=> String, one of "WORKLOAD"
resp.metrics[0].risk_counts #=> Hash
resp.metrics[0].risk_counts["Risk"] #=> Integer
resp.metrics[0].workload_id #=> String
resp.metrics[0].workload_name #=> String
resp.metrics[0].workload_arn #=> String
resp.metrics[0].updated_at #=> Time
resp.metrics[0].lenses #=> Array
resp.metrics[0].lenses[0].lens_arn #=> String
resp.metrics[0].lenses[0].pillars #=> Array
resp.metrics[0].lenses[0].pillars[0].pillar_id #=> String
resp.metrics[0].lenses[0].pillars[0].risk_counts #=> Hash
resp.metrics[0].lenses[0].pillars[0].risk_counts["Risk"] #=> Integer
resp.metrics[0].lenses[0].pillars[0].questions #=> Array
resp.metrics[0].lenses[0].pillars[0].questions[0].question_id #=> String
resp.metrics[0].lenses[0].pillars[0].questions[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
resp.metrics[0].lenses[0].pillars[0].questions[0].best_practices #=> Array
resp.metrics[0].lenses[0].pillars[0].questions[0].best_practices[0].choice_id #=> String
resp.metrics[0].lenses[0].pillars[0].questions[0].best_practices[0].choice_title #=> String
resp.metrics[0].lenses[0].risk_counts #=> Hash
resp.metrics[0].lenses[0].risk_counts["Risk"] #=> Integer
resp.metrics[0].lenses_applied_count #=> Integer
resp.next_token #=> String
resp.base_64_string #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:format (required, String) —
The format of the consolidated report.

For PDF, Base64String is returned. For JSON, Metrics is returned.
:include_shared_resources (Boolean) —
Set to true to have shared resources included in the report.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.

Returns:

(Types::GetConsolidatedReportOutput) —
Returns a response object which responds to the following methods:
- #metrics => Array<Types::ConsolidatedReportMetric>
- #next_token => String
- #base_64_string => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1398

def get_consolidated_report(params = {}, options = {})
  req = build_request(:get_consolidated_report, params)
  req.send_request(options)
end

#get_lens(params = {}) ⇒ `Types::GetLensOutput`

Get an existing lens.

Examples:

Request syntax with placeholder values


resp = client.get_lens({
  lens_alias: "LensAlias", # required
  lens_version: "LensVersion",
})

Response structure


resp.lens.lens_arn #=> String
resp.lens.lens_version #=> String
resp.lens.name #=> String
resp.lens.description #=> String
resp.lens.owner #=> String
resp.lens.share_invitation_id #=> String
resp.lens.tags #=> Hash
resp.lens.tags["TagKey"] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:lens_version (String) —
The lens version to be retrieved.

Returns:

(Types::GetLensOutput) —
Returns a response object which responds to the following methods:
- #lens => Types::Lens

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1448

def get_lens(params = {}, options = {})
  req = build_request(:get_lens, params)
  req.send_request(options)
end

#get_lens_review(params = {}) ⇒ `Types::GetLensReviewOutput`

Get lens review.

Examples:

Request syntax with placeholder values


resp = client.get_lens_review({
  workload_id: "WorkloadId", # required
  lens_alias: "LensAlias", # required
  milestone_number: 1,
})

Response structure


resp.workload_id #=> String
resp.milestone_number #=> Integer
resp.lens_review.lens_alias #=> String
resp.lens_review.lens_arn #=> String
resp.lens_review.lens_version #=> String
resp.lens_review.lens_name #=> String
resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
resp.lens_review.pillar_review_summaries #=> Array
resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
resp.lens_review.pillar_review_summaries[0].notes #=> String
resp.lens_review.pillar_review_summaries[0].risk_counts #=> Hash
resp.lens_review.pillar_review_summaries[0].risk_counts["Risk"] #=> Integer
resp.lens_review.updated_at #=> Time
resp.lens_review.notes #=> String
resp.lens_review.risk_counts #=> Hash
resp.lens_review.risk_counts["Risk"] #=> Integer
resp.lens_review.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:milestone_number (Integer) —
The milestone number.

A workload can have a maximum of 100 milestones.

Returns:

(Types::GetLensReviewOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #milestone_number => Integer
- #lens_review => Types::LensReview

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1517

def get_lens_review(params = {}, options = {})
  req = build_request(:get_lens_review, params)
  req.send_request(options)
end

#get_lens_review_report(params = {}) ⇒ `Types::GetLensReviewReportOutput`

Get lens review report.

Examples:

Request syntax with placeholder values


resp = client.get_lens_review_report({
  workload_id: "WorkloadId", # required
  lens_alias: "LensAlias", # required
  milestone_number: 1,
})

Response structure


resp.workload_id #=> String
resp.milestone_number #=> Integer
resp.lens_review_report.lens_alias #=> String
resp.lens_review_report.lens_arn #=> String
resp.lens_review_report.base_64_string #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:milestone_number (Integer) —
The milestone number.

A workload can have a maximum of 100 milestones.

Returns:

(Types::GetLensReviewReportOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #milestone_number => Integer
- #lens_review_report => Types::LensReviewReport

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1573

def get_lens_review_report(params = {}, options = {})
  req = build_request(:get_lens_review_report, params)
  req.send_request(options)
end

#get_lens_version_difference(params = {}) ⇒ `Types::GetLensVersionDifferenceOutput`

Get lens version differences.

Examples:

Request syntax with placeholder values


resp = client.get_lens_version_difference({
  lens_alias: "LensAlias", # required
  base_lens_version: "LensVersion",
  target_lens_version: "LensVersion",
})

Response structure


resp.lens_alias #=> String
resp.lens_arn #=> String
resp.base_lens_version #=> String
resp.target_lens_version #=> String
resp.latest_lens_version #=> String
resp.version_differences.pillar_differences #=> Array
resp.version_differences.pillar_differences[0].pillar_id #=> String
resp.version_differences.pillar_differences[0].pillar_name #=> String
resp.version_differences.pillar_differences[0].difference_status #=> String, one of "UPDATED", "NEW", "DELETED"
resp.version_differences.pillar_differences[0].question_differences #=> Array
resp.version_differences.pillar_differences[0].question_differences[0].question_id #=> String
resp.version_differences.pillar_differences[0].question_differences[0].question_title #=> String
resp.version_differences.pillar_differences[0].question_differences[0].difference_status #=> String, one of "UPDATED", "NEW", "DELETED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:base_lens_version (String) —
The base version of the lens.
:target_lens_version (String) —
The lens version to target a difference for.

Returns:

(Types::GetLensVersionDifferenceOutput) —
Returns a response object which responds to the following methods:
- #lens_alias => String
- #lens_arn => String
- #base_lens_version => String
- #target_lens_version => String
- #latest_lens_version => String
- #version_differences => Types::VersionDifferences

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1637

def get_lens_version_difference(params = {}, options = {})
  req = build_request(:get_lens_version_difference, params)
  req.send_request(options)
end

#get_milestone(params = {}) ⇒ `Types::GetMilestoneOutput`

Get a milestone for an existing workload.

Examples:

Request syntax with placeholder values


resp = client.get_milestone({
  workload_id: "WorkloadId", # required
  milestone_number: 1, # required
})

Response structure


resp.workload_id #=> String
resp.milestone.milestone_number #=> Integer
resp.milestone.milestone_name #=> String
resp.milestone.recorded_at #=> Time
resp.milestone.workload.workload_id #=> String
resp.milestone.workload.workload_arn #=> String
resp.milestone.workload.workload_name #=> String
resp.milestone.workload.description #=> String
resp.milestone.workload.environment #=> String, one of "PRODUCTION", "PREPRODUCTION"
resp.milestone.workload.updated_at #=> Time
resp.milestone.workload.account_ids #=> Array
resp.milestone.workload.account_ids[0] #=> String
resp.milestone.workload.aws_regions #=> Array
resp.milestone.workload.aws_regions[0] #=> String
resp.milestone.workload.non_aws_regions #=> Array
resp.milestone.workload.non_aws_regions[0] #=> String
resp.milestone.workload.architectural_design #=> String
resp.milestone.workload.review_owner #=> String
resp.milestone.workload.review_restriction_date #=> Time
resp.milestone.workload.is_review_owner_update_acknowledged #=> Boolean
resp.milestone.workload.industry_type #=> String
resp.milestone.workload.industry #=> String
resp.milestone.workload.notes #=> String
resp.milestone.workload.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
resp.milestone.workload.risk_counts #=> Hash
resp.milestone.workload.risk_counts["Risk"] #=> Integer
resp.milestone.workload.pillar_priorities #=> Array
resp.milestone.workload.pillar_priorities[0] #=> String
resp.milestone.workload.lenses #=> Array
resp.milestone.workload.lenses[0] #=> String
resp.milestone.workload.owner #=> String
resp.milestone.workload.share_invitation_id #=> String
resp.milestone.workload.tags #=> Hash
resp.milestone.workload.tags["TagKey"] #=> String
resp.milestone.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
resp.milestone.workload.applications #=> Array
resp.milestone.workload.applications[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:milestone_number (required, Integer) —
The milestone number.

A workload can have a maximum of 100 milestones.

Returns:

(Types::GetMilestoneOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #milestone => Types::Milestone

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1709

def get_milestone(params = {}, options = {})
  req = build_request(:get_milestone, params)
  req.send_request(options)
end

#get_workload(params = {}) ⇒ `Types::GetWorkloadOutput`

Get an existing workload.

Examples:

Request syntax with placeholder values


resp = client.get_workload({
  workload_id: "WorkloadId", # required
})

Response structure


resp.workload.workload_id #=> String
resp.workload.workload_arn #=> String
resp.workload.workload_name #=> String
resp.workload.description #=> String
resp.workload.environment #=> String, one of "PRODUCTION", "PREPRODUCTION"
resp.workload.updated_at #=> Time
resp.workload.account_ids #=> Array
resp.workload.account_ids[0] #=> String
resp.workload.aws_regions #=> Array
resp.workload.aws_regions[0] #=> String
resp.workload.non_aws_regions #=> Array
resp.workload.non_aws_regions[0] #=> String
resp.workload.architectural_design #=> String
resp.workload.review_owner #=> String
resp.workload.review_restriction_date #=> Time
resp.workload.is_review_owner_update_acknowledged #=> Boolean
resp.workload.industry_type #=> String
resp.workload.industry #=> String
resp.workload.notes #=> String
resp.workload.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
resp.workload.risk_counts #=> Hash
resp.workload.risk_counts["Risk"] #=> Integer
resp.workload.pillar_priorities #=> Array
resp.workload.pillar_priorities[0] #=> String
resp.workload.lenses #=> Array
resp.workload.lenses[0] #=> String
resp.workload.owner #=> String
resp.workload.share_invitation_id #=> String
resp.workload.tags #=> Hash
resp.workload.tags["TagKey"] #=> String
resp.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
resp.workload.applications #=> Array
resp.workload.applications[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

Returns:

(Types::GetWorkloadOutput) —
Returns a response object which responds to the following methods:
- #workload => Types::Workload

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1770

def get_workload(params = {}, options = {})
  req = build_request(:get_workload, params)
  req.send_request(options)
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.

Disclaimer

Examples:

Request syntax with placeholder values


resp = client.import_lens({
  lens_alias: "LensAlias",
  json_string: "LensJSON", # required
  client_request_token: "ClientRequestToken", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.lens_arn #=> String
resp.status #=> String, one of "IN_PROGRESS", "COMPLETE", "ERROR"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:lens_alias (String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:json_string (required, String) —
The JSON representation of a lens.
:client_request_token (required, String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

A suitable default value is auto-generated. You should normally not need to pass this option.**
:tags (Hash<String,String>) —
Tags to associate to a lens.

Returns:

(Types::ImportLensOutput) —
Returns a response object which responds to the following methods:
- #lens_arn => String
- #status => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1867

def import_lens(params = {}, options = {})
  req = build_request(:import_lens, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_answers({
  workload_id: "WorkloadId", # required
  lens_alias: "LensAlias", # required
  pillar_id: "PillarId",
  milestone_number: 1,
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.workload_id #=> String
resp.milestone_number #=> Integer
resp.lens_alias #=> String
resp.lens_arn #=> String
resp.answer_summaries #=> Array
resp.answer_summaries[0].question_id #=> String
resp.answer_summaries[0].pillar_id #=> String
resp.answer_summaries[0].question_title #=> String
resp.answer_summaries[0].choices #=> Array
resp.answer_summaries[0].choices[0].choice_id #=> String
resp.answer_summaries[0].choices[0].title #=> String
resp.answer_summaries[0].choices[0].description #=> String
resp.answer_summaries[0].choices[0].helpful_resource.display_text #=> String
resp.answer_summaries[0].choices[0].helpful_resource.url #=> String
resp.answer_summaries[0].choices[0].improvement_plan.display_text #=> String
resp.answer_summaries[0].choices[0].improvement_plan.url #=> String
resp.answer_summaries[0].choices[0].additional_resources #=> Array
resp.answer_summaries[0].choices[0].additional_resources[0].type #=> String, one of "HELPFUL_RESOURCE", "IMPROVEMENT_PLAN"
resp.answer_summaries[0].choices[0].additional_resources[0].content #=> Array
resp.answer_summaries[0].choices[0].additional_resources[0].content[0].display_text #=> String
resp.answer_summaries[0].choices[0].additional_resources[0].content[0].url #=> String
resp.answer_summaries[0].selected_choices #=> Array
resp.answer_summaries[0].selected_choices[0] #=> String
resp.answer_summaries[0].choice_answer_summaries #=> Array
resp.answer_summaries[0].choice_answer_summaries[0].choice_id #=> String
resp.answer_summaries[0].choice_answer_summaries[0].status #=> String, one of "SELECTED", "NOT_APPLICABLE", "UNSELECTED"
resp.answer_summaries[0].choice_answer_summaries[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
resp.answer_summaries[0].is_applicable #=> Boolean
resp.answer_summaries[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
resp.answer_summaries[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:pillar_id (String) —
The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.
:milestone_number (Integer) —
The milestone number.

A workload can have a maximum of 100 milestones.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.

Returns:

(Types::ListAnswersOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #milestone_number => Integer
- #lens_alias => String
- #lens_arn => String
- #answer_summaries => Array<Types::AnswerSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1968

def list_answers(params = {}, options = {})
  req = build_request(:list_answers, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_check_details({
  workload_id: "WorkloadId", # required
  next_token: "NextToken",
  max_results: 1,
  lens_arn: "LensArn", # required
  pillar_id: "PillarId", # required
  question_id: "QuestionId", # required
  choice_id: "ChoiceId", # required
})

Response structure


resp.check_details #=> Array
resp.check_details[0].id #=> String
resp.check_details[0].name #=> String
resp.check_details[0].description #=> String
resp.check_details[0].provider #=> String, one of "TRUSTED_ADVISOR"
resp.check_details[0].lens_arn #=> String
resp.check_details[0].pillar_id #=> String
resp.check_details[0].question_id #=> String
resp.check_details[0].choice_id #=> String
resp.check_details[0].status #=> String, one of "OKAY", "WARNING", "ERROR", "NOT_AVAILABLE", "FETCH_FAILED"
resp.check_details[0].account_id #=> String
resp.check_details[0].flagged_resources #=> Integer
resp.check_details[0].reason #=> String, one of "ASSUME_ROLE_ERROR", "ACCESS_DENIED", "UNKNOWN_ERROR", "PREMIUM_SUPPORT_REQUIRED"
resp.check_details[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.
:lens_arn (required, String) —
Well-Architected Lens ARN.
:pillar_id (required, String) —
The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.
:question_id (required, String) —
The ID of the question.
:choice_id (required, String) —
The ID of a choice.

Returns:

(Types::ListCheckDetailsOutput) —
Returns a response object which responds to the following methods:
- #check_details => Array<Types::CheckDetail>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2041

def list_check_details(params = {}, options = {})
  req = build_request(:list_check_details, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_check_summaries({
  workload_id: "WorkloadId", # required
  next_token: "NextToken",
  max_results: 1,
  lens_arn: "LensArn", # required
  pillar_id: "PillarId", # required
  question_id: "QuestionId", # required
  choice_id: "ChoiceId", # required
})

Response structure


resp.check_summaries #=> Array
resp.check_summaries[0].id #=> String
resp.check_summaries[0].name #=> String
resp.check_summaries[0].provider #=> String, one of "TRUSTED_ADVISOR"
resp.check_summaries[0].description #=> String
resp.check_summaries[0].updated_at #=> Time
resp.check_summaries[0].lens_arn #=> String
resp.check_summaries[0].pillar_id #=> String
resp.check_summaries[0].question_id #=> String
resp.check_summaries[0].choice_id #=> String
resp.check_summaries[0].status #=> String, one of "OKAY", "WARNING", "ERROR", "NOT_AVAILABLE", "FETCH_FAILED"
resp.check_summaries[0].account_summary #=> Hash
resp.check_summaries[0].account_summary["CheckStatus"] #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.
:lens_arn (required, String) —
Well-Architected Lens ARN.
:pillar_id (required, String) —
The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.
:question_id (required, String) —
The ID of the question.
:choice_id (required, String) —
The ID of a choice.

Returns:

(Types::ListCheckSummariesOutput) —
Returns a response object which responds to the following methods:
- #check_summaries => Array<Types::CheckSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2113

def list_check_summaries(params = {}, options = {})
  req = build_request(:list_check_summaries, params)
  req.send_request(options)
end

#list_lens_review_improvements(params = {}) ⇒ `Types::ListLensReviewImprovementsOutput`

List lens review improvements.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_lens_review_improvements({
  workload_id: "WorkloadId", # required
  lens_alias: "LensAlias", # required
  pillar_id: "PillarId",
  milestone_number: 1,
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.workload_id #=> String
resp.milestone_number #=> Integer
resp.lens_alias #=> String
resp.lens_arn #=> String
resp.improvement_summaries #=> Array
resp.improvement_summaries[0].question_id #=> String
resp.improvement_summaries[0].pillar_id #=> String
resp.improvement_summaries[0].question_title #=> String
resp.improvement_summaries[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
resp.improvement_summaries[0].improvement_plan_url #=> String
resp.improvement_summaries[0].improvement_plans #=> Array
resp.improvement_summaries[0].improvement_plans[0].choice_id #=> String
resp.improvement_summaries[0].improvement_plans[0].display_text #=> String
resp.improvement_summaries[0].improvement_plans[0].improvement_plan_url #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:pillar_id (String) —
The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.
:milestone_number (Integer) —
The milestone number.

A workload can have a maximum of 100 milestones.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.

Returns:

(Types::ListLensReviewImprovementsOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #milestone_number => Integer
- #lens_alias => String
- #lens_arn => String
- #improvement_summaries => Array<Types::ImprovementSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2198

def list_lens_review_improvements(params = {}, options = {})
  req = build_request(:list_lens_review_improvements, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_lens_reviews({
  workload_id: "WorkloadId", # required
  milestone_number: 1,
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.workload_id #=> String
resp.milestone_number #=> Integer
resp.lens_review_summaries #=> Array
resp.lens_review_summaries[0].lens_alias #=> String
resp.lens_review_summaries[0].lens_arn #=> String
resp.lens_review_summaries[0].lens_version #=> String
resp.lens_review_summaries[0].lens_name #=> String
resp.lens_review_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
resp.lens_review_summaries[0].updated_at #=> Time
resp.lens_review_summaries[0].risk_counts #=> Hash
resp.lens_review_summaries[0].risk_counts["Risk"] #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:milestone_number (Integer) —
The milestone number.

A workload can have a maximum of 100 milestones.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.

Returns:

(Types::ListLensReviewsOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #milestone_number => Integer
- #lens_review_summaries => Array<Types::LensReviewSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2257

def list_lens_reviews(params = {}, options = {})
  req = build_request(:list_lens_reviews, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_lens_shares({
  lens_alias: "LensAlias", # required
  shared_with_prefix: "SharedWithPrefix",
  next_token: "NextToken",
  max_results: 1,
  status: "ACCEPTED", # accepts ACCEPTED, REJECTED, PENDING, REVOKED, EXPIRED, ASSOCIATING, ASSOCIATED, FAILED
})

Response structure


resp.lens_share_summaries #=> Array
resp.lens_share_summaries[0].share_id #=> String
resp.lens_share_summaries[0].shared_with #=> String
resp.lens_share_summaries[0].status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED", "ASSOCIATING", "ASSOCIATED", "FAILED"
resp.lens_share_summaries[0].status_message #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:shared_with_prefix (String) —
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.
:status (String) —
The status of a workload share.

Returns:

(Types::ListLensSharesOutput) —
Returns a response object which responds to the following methods:
- #lens_share_summaries => Array<Types::LensShareSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2321

def list_lens_shares(params = {}, options = {})
  req = build_request(:list_lens_shares, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_lenses({
  next_token: "NextToken",
  max_results: 1,
  lens_type: "AWS_OFFICIAL", # accepts AWS_OFFICIAL, CUSTOM_SHARED, CUSTOM_SELF
  lens_status: "ALL", # accepts ALL, DRAFT, PUBLISHED
  lens_name: "LensName",
})

Response structure


resp.lens_summaries #=> Array
resp.lens_summaries[0].lens_arn #=> String
resp.lens_summaries[0].lens_alias #=> String
resp.lens_summaries[0].lens_name #=> String
resp.lens_summaries[0].lens_type #=> String, one of "AWS_OFFICIAL", "CUSTOM_SHARED", "CUSTOM_SELF"
resp.lens_summaries[0].description #=> String
resp.lens_summaries[0].created_at #=> Time
resp.lens_summaries[0].updated_at #=> Time
resp.lens_summaries[0].lens_version #=> String
resp.lens_summaries[0].owner #=> String
resp.lens_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.
:lens_type (String) —
The type of lenses to be returned.
:lens_status (String) —
The status of lenses to be returned.
:lens_name (String) —
The full name of the lens.

Returns:

(Types::ListLensesOutput) —
Returns a response object which responds to the following methods:
- #lens_summaries => Array<Types::LensSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2379

def list_lenses(params = {}, options = {})
  req = build_request(:list_lenses, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_milestones({
  workload_id: "WorkloadId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.workload_id #=> String
resp.milestone_summaries #=> Array
resp.milestone_summaries[0].milestone_number #=> Integer
resp.milestone_summaries[0].milestone_name #=> String
resp.milestone_summaries[0].recorded_at #=> Time
resp.milestone_summaries[0].workload_summary.workload_id #=> String
resp.milestone_summaries[0].workload_summary.workload_arn #=> String
resp.milestone_summaries[0].workload_summary.workload_name #=> String
resp.milestone_summaries[0].workload_summary.owner #=> String
resp.milestone_summaries[0].workload_summary.updated_at #=> Time
resp.milestone_summaries[0].workload_summary.lenses #=> Array
resp.milestone_summaries[0].workload_summary.lenses[0] #=> String
resp.milestone_summaries[0].workload_summary.risk_counts #=> Hash
resp.milestone_summaries[0].workload_summary.risk_counts["Risk"] #=> Integer
resp.milestone_summaries[0].workload_summary.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.

Returns:

(Types::ListMilestonesOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #milestone_summaries => Array<Types::MilestoneSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2435

def list_milestones(params = {}, options = {})
  req = build_request(:list_milestones, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_notifications({
  workload_id: "WorkloadId",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.notification_summaries #=> Array
resp.notification_summaries[0].type #=> String, one of "LENS_VERSION_UPGRADED", "LENS_VERSION_DEPRECATED"
resp.notification_summaries[0].lens_upgrade_summary.workload_id #=> String
resp.notification_summaries[0].lens_upgrade_summary.workload_name #=> String
resp.notification_summaries[0].lens_upgrade_summary.lens_alias #=> String
resp.notification_summaries[0].lens_upgrade_summary.lens_arn #=> String
resp.notification_summaries[0].lens_upgrade_summary.current_lens_version #=> String
resp.notification_summaries[0].lens_upgrade_summary.latest_lens_version #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.

Returns:

(Types::ListNotificationsOutput) —
Returns a response object which responds to the following methods:
- #notification_summaries => Array<Types::NotificationSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2483

def list_notifications(params = {}, options = {})
  req = build_request(:list_notifications, params)
  req.send_request(options)
end

#list_share_invitations(params = {}) ⇒ `Types::ListShareInvitationsOutput`

List the workload invitations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_share_invitations({
  workload_name_prefix: "WorkloadNamePrefix",
  lens_name_prefix: "LensNamePrefix",
  share_resource_type: "WORKLOAD", # accepts WORKLOAD, LENS
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.share_invitation_summaries #=> Array
resp.share_invitation_summaries[0].share_invitation_id #=> String
resp.share_invitation_summaries[0].shared_by #=> String
resp.share_invitation_summaries[0].shared_with #=> String
resp.share_invitation_summaries[0].permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
resp.share_invitation_summaries[0].share_resource_type #=> String, one of "WORKLOAD", "LENS"
resp.share_invitation_summaries[0].workload_name #=> String
resp.share_invitation_summaries[0].workload_id #=> String
resp.share_invitation_summaries[0].lens_name #=> String
resp.share_invitation_summaries[0].lens_arn #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_name_prefix (String) —
An optional string added to the beginning of each workload name returned in the results.
:lens_name_prefix (String) —
An optional string added to the beginning of each lens name returned in the results.
:share_resource_type (String) —
The type of share invitations to be returned.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.

Returns:

(Types::ListShareInvitationsOutput) —
Returns a response object which responds to the following methods:
- #share_invitation_summaries => Array<Types::ShareInvitationSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2542

def list_share_invitations(params = {}, options = {})
  req = build_request(:list_share_invitations, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceOutput`

List the tags for a resource.

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  workload_arn: "WorkloadArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_arn (required, String) —
The ARN for the workload.

Returns:

(Types::ListTagsForResourceOutput) —
Returns a response object which responds to the following methods:
- #tags => Hash<String,String>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2576

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_workload_shares({
  workload_id: "WorkloadId", # required
  shared_with_prefix: "SharedWithPrefix",
  next_token: "NextToken",
  max_results: 1,
  status: "ACCEPTED", # accepts ACCEPTED, REJECTED, PENDING, REVOKED, EXPIRED, ASSOCIATING, ASSOCIATED, FAILED
})

Response structure


resp.workload_id #=> String
resp.workload_share_summaries #=> Array
resp.workload_share_summaries[0].share_id #=> String
resp.workload_share_summaries[0].shared_with #=> String
resp.workload_share_summaries[0].permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
resp.workload_share_summaries[0].status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED", "ASSOCIATING", "ASSOCIATED", "FAILED"
resp.workload_share_summaries[0].status_message #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:shared_with_prefix (String) —
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.
:status (String) —
The status of a workload share.

Returns:

(Types::ListWorkloadSharesOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #workload_share_summaries => Array<Types::WorkloadShareSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2633

def list_workload_shares(params = {}, options = {})
  req = build_request(:list_workload_shares, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_workloads({
  workload_name_prefix: "WorkloadNamePrefix",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.workload_summaries #=> Array
resp.workload_summaries[0].workload_id #=> String
resp.workload_summaries[0].workload_arn #=> String
resp.workload_summaries[0].workload_name #=> String
resp.workload_summaries[0].owner #=> String
resp.workload_summaries[0].updated_at #=> Time
resp.workload_summaries[0].lenses #=> Array
resp.workload_summaries[0].lenses[0] #=> String
resp.workload_summaries[0].risk_counts #=> Hash
resp.workload_summaries[0].risk_counts["Risk"] #=> Integer
resp.workload_summaries[0].improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_name_prefix (String) —
An optional string added to the beginning of each workload name returned in the results.
:next_token (String) —
The token to use to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return for this request.

Returns:

(Types::ListWorkloadsOutput) —
Returns a response object which responds to the following methods:
- #workload_summaries => Array<Types::WorkloadSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2684

def list_workloads(params = {}, options = {})
  req = build_request(:list_workloads, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ `Struct`

Adds one or more tags to the specified resource.

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  workload_arn: "WorkloadArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_arn (required, String) —
The ARN for the workload.
:tags (required, Hash<String,String>) —
The tags for the resource.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2717

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ `Struct`

Deletes specified tags from a resource.

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

To specify multiple tags, use separate tagKeys parameters, for example:

DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  workload_arn: "WorkloadArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_arn (required, String) —
The ARN for the workload.
:tag_keys (required, Array<String>) —
A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2754

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_answer(params = {}) ⇒ `Types::UpdateAnswerOutput`

Update the answer to a specific question in a workload review.

Examples:

Request syntax with placeholder values


resp = client.update_answer({
  workload_id: "WorkloadId", # required
  lens_alias: "LensAlias", # required
  question_id: "QuestionId", # required
  selected_choices: ["ChoiceId"],
  choice_updates: {
    "ChoiceId" => {
      status: "SELECTED", # required, accepts SELECTED, NOT_APPLICABLE, UNSELECTED
      reason: "OUT_OF_SCOPE", # accepts OUT_OF_SCOPE, BUSINESS_PRIORITIES, ARCHITECTURE_CONSTRAINTS, OTHER, NONE
      notes: "ChoiceNotes",
    },
  },
  notes: "Notes",
  is_applicable: false,
  reason: "OUT_OF_SCOPE", # accepts OUT_OF_SCOPE, BUSINESS_PRIORITIES, ARCHITECTURE_CONSTRAINTS, OTHER, NONE
})

Response structure


resp.workload_id #=> String
resp.lens_alias #=> String
resp.lens_arn #=> String
resp.answer.question_id #=> String
resp.answer.pillar_id #=> String
resp.answer.question_title #=> String
resp.answer.question_description #=> String
resp.answer.improvement_plan_url #=> String
resp.answer.helpful_resource_url #=> String
resp.answer.helpful_resource_display_text #=> String
resp.answer.choices #=> Array
resp.answer.choices[0].choice_id #=> String
resp.answer.choices[0].title #=> String
resp.answer.choices[0].description #=> String
resp.answer.choices[0].helpful_resource.display_text #=> String
resp.answer.choices[0].helpful_resource.url #=> String
resp.answer.choices[0].improvement_plan.display_text #=> String
resp.answer.choices[0].improvement_plan.url #=> String
resp.answer.choices[0].additional_resources #=> Array
resp.answer.choices[0].additional_resources[0].type #=> String, one of "HELPFUL_RESOURCE", "IMPROVEMENT_PLAN"
resp.answer.choices[0].additional_resources[0].content #=> Array
resp.answer.choices[0].additional_resources[0].content[0].display_text #=> String
resp.answer.choices[0].additional_resources[0].content[0].url #=> String
resp.answer.selected_choices #=> Array
resp.answer.selected_choices[0] #=> String
resp.answer.choice_answers #=> Array
resp.answer.choice_answers[0].choice_id #=> String
resp.answer.choice_answers[0].status #=> String, one of "SELECTED", "NOT_APPLICABLE", "UNSELECTED"
resp.answer.choice_answers[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
resp.answer.choice_answers[0].notes #=> String
resp.answer.is_applicable #=> Boolean
resp.answer.risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
resp.answer.notes #=> String
resp.answer.reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:question_id (required, String) —
The ID of the question.
:selected_choices (Array<String>) —
List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.
:choice_updates (Hash<String,Types::ChoiceUpdate>) —
A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
:notes (String) —
The notes associated with the workload.
:is_applicable (Boolean) —
Defines whether this question is applicable to a lens review.
:reason (String) —
The reason why a question is not applicable to your workload.

Returns:

(Types::UpdateAnswerOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #lens_alias => String
- #lens_arn => String
- #answer => Types::Answer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2867

def update_answer(params = {}, options = {})
  req = build_request(:update_answer, params)
  req.send_request(options)
end

#update_global_settings(params = {}) ⇒ `Struct`

Updates whether the Amazon Web Services account is opted into organization sharing features.

Examples:

Request syntax with placeholder values


resp = client.update_global_settings({
  organization_sharing_status: "ENABLED", # accepts ENABLED, DISABLED
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:organization_sharing_status (String) —
The status of organization sharing settings.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2890

def update_global_settings(params = {}, options = {})
  req = build_request(:update_global_settings, params)
  req.send_request(options)
end

#update_lens_review(params = {}) ⇒ `Types::UpdateLensReviewOutput`

Update lens review for a particular workload.

Examples:

Request syntax with placeholder values


resp = client.update_lens_review({
  workload_id: "WorkloadId", # required
  lens_alias: "LensAlias", # required
  lens_notes: "Notes",
  pillar_notes: {
    "PillarId" => "Notes",
  },
})

Response structure


resp.workload_id #=> String
resp.lens_review.lens_alias #=> String
resp.lens_review.lens_arn #=> String
resp.lens_review.lens_version #=> String
resp.lens_review.lens_name #=> String
resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
resp.lens_review.pillar_review_summaries #=> Array
resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
resp.lens_review.pillar_review_summaries[0].notes #=> String
resp.lens_review.pillar_review_summaries[0].risk_counts #=> Hash
resp.lens_review.pillar_review_summaries[0].risk_counts["Risk"] #=> Integer
resp.lens_review.updated_at #=> Time
resp.lens_review.notes #=> String
resp.lens_review.risk_counts #=> Hash
resp.lens_review.risk_counts["Risk"] #=> Integer
resp.lens_review.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:lens_notes (String) —
The notes associated with the workload.
:pillar_notes (Hash<String,String>) —
List of pillar notes of a lens review in a workload.

Returns:

(Types::UpdateLensReviewOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #lens_review => Types::LensReview

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2961

def update_lens_review(params = {}, options = {})
  req = build_request(:update_lens_review, params)
  req.send_request(options)
end

#update_share_invitation(params = {}) ⇒ `Types::UpdateShareInvitationOutput`

Update a workload or custom lens share invitation.

This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

Examples:

Request syntax with placeholder values


resp = client.update_share_invitation({
  share_invitation_id: "ShareInvitationId", # required
  share_invitation_action: "ACCEPT", # required, accepts ACCEPT, REJECT
})

Response structure


resp.share_invitation.share_invitation_id #=> String
resp.share_invitation.share_resource_type #=> String, one of "WORKLOAD", "LENS"
resp.share_invitation.workload_id #=> String
resp.share_invitation.lens_alias #=> String
resp.share_invitation.lens_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:share_invitation_id (required, String) —
The ID assigned to the share invitation.
:share_invitation_action (required, String) —
Share invitation action taken by contributor.

Returns:

(Types::UpdateShareInvitationOutput) —
Returns a response object which responds to the following methods:
- #share_invitation => Types::ShareInvitation

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3002

def update_share_invitation(params = {}, options = {})
  req = build_request(:update_share_invitation, params)
  req.send_request(options)
end

#update_workload(params = {}) ⇒ `Types::UpdateWorkloadOutput`

Update an existing workload.

Examples:

Request syntax with placeholder values


resp = client.update_workload({
  workload_id: "WorkloadId", # required
  workload_name: "WorkloadName",
  description: "WorkloadDescription",
  environment: "PRODUCTION", # accepts PRODUCTION, PREPRODUCTION
  account_ids: ["AwsAccountId"],
  aws_regions: ["AwsRegion"],
  non_aws_regions: ["WorkloadNonAwsRegion"],
  pillar_priorities: ["PillarId"],
  architectural_design: "WorkloadArchitecturalDesign",
  review_owner: "WorkloadReviewOwner",
  is_review_owner_update_acknowledged: false,
  industry_type: "WorkloadIndustryType",
  industry: "WorkloadIndustry",
  notes: "Notes",
  improvement_status: "NOT_APPLICABLE", # accepts NOT_APPLICABLE, NOT_STARTED, IN_PROGRESS, COMPLETE, RISK_ACKNOWLEDGED
  discovery_config: {
    trusted_advisor_integration_status: "ENABLED", # accepts ENABLED, DISABLED
  },
  applications: ["ApplicationArn"],
})

Response structure


resp.workload.workload_id #=> String
resp.workload.workload_arn #=> String
resp.workload.workload_name #=> String
resp.workload.description #=> String
resp.workload.environment #=> String, one of "PRODUCTION", "PREPRODUCTION"
resp.workload.updated_at #=> Time
resp.workload.account_ids #=> Array
resp.workload.account_ids[0] #=> String
resp.workload.aws_regions #=> Array
resp.workload.aws_regions[0] #=> String
resp.workload.non_aws_regions #=> Array
resp.workload.non_aws_regions[0] #=> String
resp.workload.architectural_design #=> String
resp.workload.review_owner #=> String
resp.workload.review_restriction_date #=> Time
resp.workload.is_review_owner_update_acknowledged #=> Boolean
resp.workload.industry_type #=> String
resp.workload.industry #=> String
resp.workload.notes #=> String
resp.workload.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
resp.workload.risk_counts #=> Hash
resp.workload.risk_counts["Risk"] #=> Integer
resp.workload.pillar_priorities #=> Array
resp.workload.pillar_priorities[0] #=> String
resp.workload.lenses #=> Array
resp.workload.lenses[0] #=> String
resp.workload.owner #=> String
resp.workload.share_invitation_id #=> String
resp.workload.tags #=> Hash
resp.workload.tags["TagKey"] #=> String
resp.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
resp.workload.applications #=> Array
resp.workload.applications[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:workload_name (String) —
The name of the workload.

The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
:description (String) —
The description for the workload.
:environment (String) —
The environment for the workload.
:account_ids (Array<String>) —
The list of Amazon Web Services account IDs associated with the workload.
:aws_regions (Array<String>) —
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.
:non_aws_regions (Array<String>) —
The list of non-Amazon Web Services Regions associated with the workload.
:pillar_priorities (Array<String>) —
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
:architectural_design (String) —
The URL of the architectural design for the workload.
:review_owner (String) —
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
:is_review_owner_update_acknowledged (Boolean) —
Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
:industry_type (String) —
The industry type for the workload.

If specified, must be one of the following:
- Agriculture
- Automobile
- Defense
- Design and Engineering
- Digital Advertising
- Education
- Environmental Protection
- Financial Services
- Gaming
- General Public Services
- Healthcare
- Hospitality
- InfoTech
- Justice and Public Safety
- Life Sciences
- Manufacturing
- Media & Entertainment
- Mining & Resources
- Oil & Gas
- Power & Utilities
- Professional Services
- Real Estate & Construction
- Retail & Wholesale
- Social Protection
- Telecommunications
- Travel, Transportation & Logistics
- Other
:industry (String) —
The industry for the workload.
:notes (String) —
The notes associated with the workload.
:improvement_status (String) —
The improvement status for a workload.
:discovery_config (Types::WorkloadDiscoveryConfig) —
Well-Architected discovery configuration settings to associate to the workload.
:applications (Array<String>) —
List of AppRegistry application ARNs to associate to the workload.

Returns:

(Types::UpdateWorkloadOutput) —
Returns a response object which responds to the following methods:
- #workload => Types::Workload

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3202

def update_workload(params = {}, options = {})
  req = build_request(:update_workload, params)
  req.send_request(options)
end

#update_workload_share(params = {}) ⇒ `Types::UpdateWorkloadShareOutput`

Update a workload share.

Examples:

Request syntax with placeholder values


resp = client.update_workload_share({
  share_id: "ShareId", # required
  workload_id: "WorkloadId", # required
  permission_type: "READONLY", # required, accepts READONLY, CONTRIBUTOR
})

Response structure


resp.workload_id #=> String
resp.workload_share.share_id #=> String
resp.workload_share.shared_by #=> String
resp.workload_share.shared_with #=> String
resp.workload_share.permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
resp.workload_share.status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED", "ASSOCIATING", "ASSOCIATED", "FAILED"
resp.workload_share.workload_name #=> String
resp.workload_share.workload_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:share_id (required, String) —
The ID associated with the workload share.
:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:permission_type (required, String) —
Permission granted on a workload share.

Returns:

(Types::UpdateWorkloadShareOutput) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #workload_share => Types::WorkloadShare

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3247

def update_workload_share(params = {}, options = {})
  req = build_request(:update_workload_share, params)
  req.send_request(options)
end

#upgrade_lens_review(params = {}) ⇒ `Struct`

Upgrade lens review for a particular workload.

Examples:

Request syntax with placeholder values


resp = client.upgrade_lens_review({
  workload_id: "WorkloadId", # required
  lens_alias: "LensAlias", # required
  milestone_name: "MilestoneName", # required
  client_request_token: "ClientRequestToken",
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:workload_id (required, String) —
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
:lens_alias (required, String) —
The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.
:milestone_name (required, String) —
The name of the milestone in a workload.

Milestone names must be unique within a workload.
:client_request_token (String) —
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3306

def upgrade_lens_review(params = {}, options = {})
  req = build_request(:upgrade_lens_review, params)
  req.send_request(options)
end

Class: Aws::WellArchitected::Client

Overview

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options) ⇒ Client

Instance Method Details

#associate_lenses(params = {}) ⇒ Struct

#create_lens_share(params = {}) ⇒ Types::CreateLensShareOutput

#create_lens_version(params = {}) ⇒ Types::CreateLensVersionOutput

#create_milestone(params = {}) ⇒ Types::CreateMilestoneOutput

#create_workload(params = {}) ⇒ Types::CreateWorkloadOutput

#create_workload_share(params = {}) ⇒ Types::CreateWorkloadShareOutput

#delete_lens(params = {}) ⇒ Struct

#delete_lens_share(params = {}) ⇒ Struct

#delete_workload(params = {}) ⇒ Struct

#delete_workload_share(params = {}) ⇒ Struct

#disassociate_lenses(params = {}) ⇒ Struct

#export_lens(params = {}) ⇒ Types::ExportLensOutput

#get_answer(params = {}) ⇒ Types::GetAnswerOutput

#get_consolidated_report(params = {}) ⇒ Types::GetConsolidatedReportOutput

#get_lens(params = {}) ⇒ Types::GetLensOutput

#get_lens_review(params = {}) ⇒ Types::GetLensReviewOutput

#get_lens_review_report(params = {}) ⇒ Types::GetLensReviewReportOutput

#get_lens_version_difference(params = {}) ⇒ Types::GetLensVersionDifferenceOutput

#get_milestone(params = {}) ⇒ Types::GetMilestoneOutput

#get_workload(params = {}) ⇒ Types::GetWorkloadOutput

#import_lens(params = {}) ⇒ Types::ImportLensOutput

#list_answers(params = {}) ⇒ Types::ListAnswersOutput

#list_check_details(params = {}) ⇒ Types::ListCheckDetailsOutput

#list_check_summaries(params = {}) ⇒ Types::ListCheckSummariesOutput

#list_lens_review_improvements(params = {}) ⇒ Types::ListLensReviewImprovementsOutput

#list_lens_reviews(params = {}) ⇒ Types::ListLensReviewsOutput

#list_lens_shares(params = {}) ⇒ Types::ListLensSharesOutput

#list_lenses(params = {}) ⇒ Types::ListLensesOutput

#list_milestones(params = {}) ⇒ Types::ListMilestonesOutput

#list_notifications(params = {}) ⇒ Types::ListNotificationsOutput

#list_share_invitations(params = {}) ⇒ Types::ListShareInvitationsOutput

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

#list_workload_shares(params = {}) ⇒ Types::ListWorkloadSharesOutput

#list_workloads(params = {}) ⇒ Types::ListWorkloadsOutput

#tag_resource(params = {}) ⇒ Struct

#untag_resource(params = {}) ⇒ Struct

#update_answer(params = {}) ⇒ Types::UpdateAnswerOutput

#update_global_settings(params = {}) ⇒ Struct

#update_lens_review(params = {}) ⇒ Types::UpdateLensReviewOutput

#update_share_invitation(params = {}) ⇒ Types::UpdateShareInvitationOutput

#update_workload(params = {}) ⇒ Types::UpdateWorkloadOutput

#update_workload_share(params = {}) ⇒ Types::UpdateWorkloadShareOutput

#upgrade_lens_review(params = {}) ⇒ Struct

#initialize(options) ⇒ `Client`

#associate_lenses(params = {}) ⇒ `Struct`

#create_lens_share(params = {}) ⇒ `Types::CreateLensShareOutput`

#create_lens_version(params = {}) ⇒ `Types::CreateLensVersionOutput`

#create_milestone(params = {}) ⇒ `Types::CreateMilestoneOutput`

#create_workload(params = {}) ⇒ `Types::CreateWorkloadOutput`

#create_workload_share(params = {}) ⇒ `Types::CreateWorkloadShareOutput`

#delete_lens(params = {}) ⇒ `Struct`

#delete_lens_share(params = {}) ⇒ `Struct`

#delete_workload(params = {}) ⇒ `Struct`

#delete_workload_share(params = {}) ⇒ `Struct`

#disassociate_lenses(params = {}) ⇒ `Struct`

#export_lens(params = {}) ⇒ `Types::ExportLensOutput`

#get_answer(params = {}) ⇒ `Types::GetAnswerOutput`

#get_consolidated_report(params = {}) ⇒ `Types::GetConsolidatedReportOutput`

#get_lens(params = {}) ⇒ `Types::GetLensOutput`

#get_lens_review(params = {}) ⇒ `Types::GetLensReviewOutput`

#get_lens_review_report(params = {}) ⇒ `Types::GetLensReviewReportOutput`

#get_lens_version_difference(params = {}) ⇒ `Types::GetLensVersionDifferenceOutput`

#get_milestone(params = {}) ⇒ `Types::GetMilestoneOutput`

#get_workload(params = {}) ⇒ `Types::GetWorkloadOutput`

#import_lens(params = {}) ⇒ `Types::ImportLensOutput`

#list_answers(params = {}) ⇒ `Types::ListAnswersOutput`

#list_check_details(params = {}) ⇒ `Types::ListCheckDetailsOutput`

#list_check_summaries(params = {}) ⇒ `Types::ListCheckSummariesOutput`

#list_lens_review_improvements(params = {}) ⇒ `Types::ListLensReviewImprovementsOutput`

#list_lens_reviews(params = {}) ⇒ `Types::ListLensReviewsOutput`

#list_lens_shares(params = {}) ⇒ `Types::ListLensSharesOutput`

#list_lenses(params = {}) ⇒ `Types::ListLensesOutput`

#list_milestones(params = {}) ⇒ `Types::ListMilestonesOutput`

#list_notifications(params = {}) ⇒ `Types::ListNotificationsOutput`

#list_share_invitations(params = {}) ⇒ `Types::ListShareInvitationsOutput`

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceOutput`

#list_workload_shares(params = {}) ⇒ `Types::ListWorkloadSharesOutput`

#list_workloads(params = {}) ⇒ `Types::ListWorkloadsOutput`

#tag_resource(params = {}) ⇒ `Struct`

#untag_resource(params = {}) ⇒ `Struct`

#update_answer(params = {}) ⇒ `Types::UpdateAnswerOutput`

#update_global_settings(params = {}) ⇒ `Struct`

#update_lens_review(params = {}) ⇒ `Types::UpdateLensReviewOutput`

#update_share_invitation(params = {}) ⇒ `Types::UpdateShareInvitationOutput`

#update_workload(params = {}) ⇒ `Types::UpdateWorkloadOutput`

#update_workload_share(params = {}) ⇒ `Types::UpdateWorkloadShareOutput`

#upgrade_lens_review(params = {}) ⇒ `Struct`