Class: Aws::WellArchitected::Client

Inherits:
Seahorse::Client::Base 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

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

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.
  • :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.

  • :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.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :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 (Integer) — 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.

  • :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.



324
325
326
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

#associate_lenses(params = {}) ⇒ Struct

Associate a lens to a workload.

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 AWS Region.

  • :lens_aliases (required, Array<String>)

    List of lens aliases to associate or disassociate with a workload.

    Identify a lens using its LensSummary$LensAlias.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



354
355
356
357
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 354

def associate_lenses(params = {}, options = {})
  req = build_request(:associate_lenses, 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 AWS 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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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:

See Also:



409
410
411
412
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 409

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 AWS accounts and IAM users in the same AWS Region. Only the owner of a workload can delete it.

For more information, see Defining a Workload in the AWS Well-Architected Tool User Guide.

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", # required
  industry_type: "WorkloadIndustryType",
  industry: "WorkloadIndustry",
  lenses: ["LensAlias"], # required
  notes: "Notes",
  client_request_token: "ClientRequestToken", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

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 a 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 AWS account IDs associated with the workload.

  • :aws_regions (Array<String>)

    The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.

  • :non_aws_regions (Array<String>)

    The list of non-AWS 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 (required, 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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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.

Returns:

See Also:



587
588
589
590
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 587

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 AWS accounts and IAM users in the same AWS Region. Shared access to a workload is not removed until the workload invitation is deleted.

For more information, see Sharing a Workload in the AWS 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 AWS Region.

  • :shared_with (required, String)

    The AWS account ID or IAM role 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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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:

See Also:



655
656
657
658
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 655

def create_workload_share(params = {}, options = {})
  req = build_request(:create_workload_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 AWS 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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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:



696
697
698
699
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 696

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 AWS 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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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:



741
742
743
744
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 741

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.

The AWS 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 AWS Region.

  • :lens_aliases (required, Array<String>)

    List of lens aliases to associate or disassociate with a workload.

    Identify a lens using its LensSummary$LensAlias.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



775
776
777
778
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 775

def disassociate_lenses(params = {}, options = {})
  req = build_request(:disassociate_lenses, 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.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.choices #=> Array
resp.answer.choices[0].choice_id #=> String
resp.answer.choices[0].title #=> String
resp.answer.choices[0].description #=> 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 AWS Region.

  • :lens_alias (required, String)

    The alias of the lens, for example, serverless.

    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:

See Also:



846
847
848
849
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 846

def get_answer(params = {}, options = {})
  req = build_request(:get_answer, 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_version #=> String
resp.lens_review.lens_name #=> String
resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
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 AWS Region.

  • :lens_alias (required, String)

    The alias of the lens, for example, serverless.

    Each lens is identified by its LensSummary$LensAlias.

  • :milestone_number (Integer)

    The milestone number.

    A workload can have a maximum of 100 milestones.

Returns:

See Also:



905
906
907
908
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 905

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.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 AWS Region.

  • :lens_alias (required, String)

    The alias of the lens, for example, serverless.

    Each lens is identified by its LensSummary$LensAlias.

  • :milestone_number (Integer)

    The milestone number.

    A workload can have a maximum of 100 milestones.

Returns:

See Also:



951
952
953
954
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 951

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", # required
})

Response structure


resp.lens_alias #=> String
resp.base_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].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 example, serverless.

    Each lens is identified by its LensSummary$LensAlias.

  • :base_lens_version (required, String)

    The base version of the lens.

Returns:

See Also:



997
998
999
1000
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 997

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. #=> Array
resp.milestone.workload.[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

Parameters:

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

    ({})

Options Hash (params):

  • :workload_id (required, String)

    The ID assigned to the workload. This ID is unique within an AWS Region.

  • :milestone_number (required, Integer)

    The milestone number.

    A workload can have a maximum of 100 milestones.

Returns:

See Also:



1066
1067
1068
1069
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1066

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. #=> Array
resp.workload.[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

Parameters:

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

    ({})

Options Hash (params):

  • :workload_id (required, String)

    The ID assigned to the workload. This ID is unique within an AWS Region.

Returns:

See Also:



1124
1125
1126
1127
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1124

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

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

List of answers.

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.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].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 AWS Region.

  • :lens_alias (required, String)

    The alias of the lens, for example, serverless.

    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:

See Also:



1205
1206
1207
1208
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1205

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

  • :lens_alias (required, String)

    The alias of the lens, for example, serverless.

    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:

See Also:



1275
1276
1277
1278
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1275

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.

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_version #=> String
resp.lens_review_summaries[0].lens_name #=> String
resp.lens_review_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
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 AWS 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:

See Also:



1333
1334
1335
1336
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1333

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

Response structure


resp.lens_summaries #=> Array
resp.lens_summaries[0].lens_alias #=> String
resp.lens_summaries[0].lens_version #=> String
resp.lens_summaries[0].lens_name #=> String
resp.lens_summaries[0].description #=> String
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.

Returns:

See Also:



1373
1374
1375
1376
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1373

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 AWS 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:

See Also:



1429
1430
1431
1432
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1429

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.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 AWS 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:

See Also:



1476
1477
1478
1479
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1476

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",
  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].workload_name #=> String
resp.share_invitation_summaries[0].workload_id #=> 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.

  • :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:

See Also:



1523
1524
1525
1526
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1523

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.

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:

See Also:



1552
1553
1554
1555
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1552

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,
})

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"
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 AWS Region.

  • :shared_with_prefix (String)

    The AWS account ID or IAM role 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.

Returns:

See Also:



1603
1604
1605
1606
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1603

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

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

List workloads. Paginated.

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:

See Also:



1654
1655
1656
1657
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1654

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.

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:



1682
1683
1684
1685
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1682

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.

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:



1714
1715
1716
1717
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1714

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.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.choices #=> Array
resp.answer.choices[0].choice_id #=> String
resp.answer.choices[0].title #=> String
resp.answer.choices[0].description #=> 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 AWS Region.

  • :lens_alias (required, String)

    The alias of the lens, for example, serverless.

    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:

See Also:



1806
1807
1808
1809
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1806

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

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

Update lens review.

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_version #=> String
resp.lens_review.lens_name #=> String
resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
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 AWS Region.

  • :lens_alias (required, String)

    The alias of the lens, for example, serverless.

    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:

See Also:



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

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 invitation.

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.workload_id #=> 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:

See Also:



1900
1901
1902
1903
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1900

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
})

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. #=> Array
resp.workload.[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

Parameters:

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

    ({})

Options Hash (params):

  • :workload_id (required, String)

    The ID assigned to the workload. This ID is unique within an AWS Region.

  • :workload_name (String)

    The name of the workload.

    The name must be unique within an account within a 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 AWS account IDs associated with the workload.

  • :aws_regions (Array<String>)

    The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.

  • :non_aws_regions (Array<String>)

    The list of non-AWS 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.

Returns:

See Also:



2083
2084
2085
2086
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2083

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"
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 AWS Region.

  • :permission_type (required, String)

    Permission granted on a workload share.

Returns:

See Also:



2128
2129
2130
2131
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2128

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.

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 AWS Region.

  • :lens_alias (required, String)

    The alias of the lens, for example, serverless.

    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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2178
2179
2180
2181
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2178

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