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

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.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::InstanceProfileCredentials 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)
  • :account_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 —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :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_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_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_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :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_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



466
467
468
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 466

def initialize(*args)
  super
end

Instance Method Details

#associate_lenses(params = {}) ⇒ Struct

Associate a lens to a workload.

Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.

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:



509
510
511
512
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 509

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

#associate_profiles(params = {}) ⇒ Struct

Associate a profile with a workload.

Examples:

Request syntax with placeholder values


resp = client.associate_profiles({
  workload_id: "WorkloadId", # required
  profile_arns: ["ProfileArn"], # 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.

  • :profile_arns (required, Array<String>) —

    The list of profile ARNs to associate with the workload.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



536
537
538
539
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 536

def associate_profiles(params = {}, options = {})
  req = build_request(:associate_profiles, 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, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template 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:

See Also:



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

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:

See Also:



703
704
705
706
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 703

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:

See Also:



758
759
760
761
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 758

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

#create_profile(params = {}) ⇒ Types::CreateProfileOutput

Create a profile.

Examples:

Request syntax with placeholder values


resp = client.create_profile({
  profile_name: "ProfileName", # required
  profile_description: "ProfileDescription", # required
  profile_questions: [ # required
    {
      question_id: "QuestionId",
      selected_choice_ids: ["ChoiceId"],
    },
  ],
  client_request_token: "ClientRequestToken", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.profile_arn #=> String
resp.profile_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :profile_name (required, String) —

    Name of the profile.

  • :profile_description (required, String) —

    The profile description.

  • :profile_questions (required, Array<Types::ProfileQuestionUpdate>) —

    The profile questions.

  • :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 assigned to the profile.

Returns:

See Also:



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

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

#create_profile_share(params = {}) ⇒ Types::CreateProfileShareOutput

Create a profile share.

Examples:

Request syntax with placeholder values


resp = client.create_profile_share({
  profile_arn: "ProfileArn", # required
  shared_with: "SharedWith", # required
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.share_id #=> String
resp.profile_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :profile_arn (required, String) —

    The profile ARN.

  • :shared_with (required, String) —

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template 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:

See Also:



879
880
881
882
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 879

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

#create_review_template(params = {}) ⇒ Types::CreateReviewTemplateOutput

Create a review template.

Disclaimer

Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

Examples:

Request syntax with placeholder values


resp = client.create_review_template({
  template_name: "TemplateName", # required
  description: "TemplateDescription", # required
  lenses: ["LensAlias"], # required
  notes: "Notes",
  tags: {
    "TagKey" => "TagValue",
  },
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.template_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :template_name (required, String) —

    Name of the review template.

  • :description (required, String) —

    The review template description.

  • :lenses (required, Array<String>) —

    Lenses applied to the review template.

  • :notes (String) —

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

  • :tags (Hash<String,String>) —

    The tags assigned to the review template.

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

See Also:



958
959
960
961
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 958

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

#create_template_share(params = {}) ⇒ Types::CreateTemplateShareOutput

Create a review template share.

The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region.

Shared access to a review template is not removed until the review template share invitation is deleted.

If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.

Disclaimer

By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.

Examples:

Request syntax with placeholder values


resp = client.create_template_share({
  template_arn: "TemplateArn", # required
  shared_with: "SharedWith", # required
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.template_arn #=> String
resp.share_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :template_arn (required, String) —

    The review template ARN.

  • :shared_with (required, String) —

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template 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:

See Also:



1031
1032
1033
1034
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1031

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

When creating a workload using a review template, you must have the following IAM permissions:

  • wellarchitected:GetReviewTemplate

  • wellarchitected:GetReviewTemplateAnswer

  • wellarchitected:ListReviewTemplateAnswers

  • wellarchitected:GetReviewTemplateLensReview

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
    workload_resource_definition: ["WORKLOAD_METADATA"], # accepts WORKLOAD_METADATA, APP_REGISTRY
  },
  applications: ["ApplicationArn"],
  profile_arns: ["ProfileArn"],
  review_template_arns: ["TemplateArn"],
  jira_configuration: {
    issue_management_status: "ENABLED", # accepts ENABLED, DISABLED, INHERIT
    issue_management_type: "AUTO", # accepts AUTO, MANUAL
    jira_project_key: "JiraProjectKey",
  },
})

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.

    If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

  • :notes (String) —

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

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

  • :profile_arns (Array<String>) —

    The list of profile ARNs associated with the workload.

  • :review_template_arns (Array<String>) —

    The list of review template ARNs to associate with the workload.

  • :jira_configuration (Types::WorkloadJiraConfigurationInput) —

    Jira configuration settings when creating a workload.

Returns:

See Also:



1264
1265
1266
1267
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1264

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, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

  • :permission_type (required, String) —

    Permission granted on a share request.

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

See Also:



1338
1339
1340
1341
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1338

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

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



1409
1410
1411
1412
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1409

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

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



1480
1481
1482
1483
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1480

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

#delete_profile(params = {}) ⇒ Struct

Delete a profile.

Disclaimer

By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.

Examples:

Request syntax with placeholder values


resp = client.delete_profile({
  profile_arn: "ProfileArn", # required
  client_request_token: "ClientRequestToken", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :profile_arn (required, String) —

    The profile ARN.

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



1531
1532
1533
1534
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1531

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

#delete_profile_share(params = {}) ⇒ Struct

Delete a profile share.

Examples:

Request syntax with placeholder values


resp = client.delete_profile_share({
  share_id: "ShareId", # required
  profile_arn: "ProfileArn", # required
  client_request_token: "ClientRequestToken", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :share_id (required, String) —

    The ID associated with the share.

  • :profile_arn (required, String) —

    The profile ARN.

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



1575
1576
1577
1578
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1575

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

#delete_review_template(params = {}) ⇒ Struct

Delete a review template.

Only the owner of a review template can delete it.

After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

Examples:

Request syntax with placeholder values


resp = client.delete_review_template({
  template_arn: "TemplateArn", # required
  client_request_token: "ClientRequestToken", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :template_arn (required, String) —

    The review template ARN.

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



1622
1623
1624
1625
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1622

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

#delete_template_share(params = {}) ⇒ Struct

Delete a review template share.

After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

Examples:

Request syntax with placeholder values


resp = client.delete_template_share({
  share_id: "ShareId", # required
  template_arn: "TemplateArn", # required
  client_request_token: "ClientRequestToken", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :share_id (required, String) —

    The ID associated with the share.

  • :template_arn (required, String) —

    The review template ARN.

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



1671
1672
1673
1674
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1671

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



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

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



1757
1758
1759
1760
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1757

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:



1795
1796
1797
1798
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1795

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

#disassociate_profiles(params = {}) ⇒ Struct

Disassociate a profile from a workload.

Examples:

Request syntax with placeholder values


resp = client.disassociate_profiles({
  workload_id: "WorkloadId", # required
  profile_arns: ["ProfileArn"], # 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.

  • :profile_arns (required, Array<String>) —

    The list of profile ARNs to disassociate from the workload.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1822
1823
1824
1825
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1822

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

See Also:



1887
1888
1889
1890
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1887

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"
resp.answer.jira_configuration.jira_issue_url #=> String
resp.answer.jira_configuration.last_synced_time #=> Time

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:

See Also:



1981
1982
1983
1984
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 1981

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:

See Also:



2055
2056
2057
2058
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2055

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

#get_global_settings(params = {}) ⇒ Types::GetGlobalSettingsOutput

Global settings for all workloads.

Examples:

Response structure


resp.organization_sharing_status #=> String, one of "ENABLED", "DISABLED"
resp.discovery_integration_status #=> String, one of "ENABLED", "DISABLED"
resp.jira_configuration.integration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
resp.jira_configuration.issue_management_status #=> String, one of "ENABLED", "DISABLED"
resp.jira_configuration.issue_management_type #=> String, one of "AUTO", "MANUAL"
resp.jira_configuration.subdomain #=> String
resp.jira_configuration.jira_project_key #=> String
resp.jira_configuration.status_message #=> String

Parameters:

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

    ({})

Returns:

See Also:



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

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

See Also:



2133
2134
2135
2136
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2133

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.pillar_review_summaries[0].prioritized_risk_counts #=> Hash
resp.lens_review.pillar_review_summaries[0].prioritized_risk_counts["Risk"] #=> Integer
resp.lens_review.jira_configuration.selected_pillars #=> Array
resp.lens_review.jira_configuration.selected_pillars[0].pillar_id #=> String
resp.lens_review.jira_configuration.selected_pillars[0].selected_question_ids #=> Array
resp.lens_review.jira_configuration.selected_pillars[0].selected_question_ids[0] #=> String
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
resp.lens_review.profiles #=> Array
resp.lens_review.profiles[0].profile_arn #=> String
resp.lens_review.profiles[0].profile_version #=> String
resp.lens_review.prioritized_risk_counts #=> Hash
resp.lens_review.prioritized_risk_counts["Risk"] #=> 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.

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

See Also:



2213
2214
2215
2216
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2213

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:

See Also:



2269
2270
2271
2272
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2269

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:

See Also:



2333
2334
2335
2336
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2333

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
resp.milestone.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
resp.milestone.workload.discovery_config.workload_resource_definition #=> Array
resp.milestone.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
resp.milestone.workload.applications #=> Array
resp.milestone.workload.applications[0] #=> String
resp.milestone.workload.profiles #=> Array
resp.milestone.workload.profiles[0].profile_arn #=> String
resp.milestone.workload.profiles[0].profile_version #=> String
resp.milestone.workload.prioritized_risk_counts #=> Hash
resp.milestone.workload.prioritized_risk_counts["Risk"] #=> Integer
resp.milestone.workload.jira_configuration.issue_management_status #=> String, one of "ENABLED", "DISABLED", "INHERIT"
resp.milestone.workload.jira_configuration.issue_management_type #=> String, one of "AUTO", "MANUAL"
resp.milestone.workload.jira_configuration.jira_project_key #=> String
resp.milestone.workload.jira_configuration.status_message #=> 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:

See Also:



2416
2417
2418
2419
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2416

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

#get_profile(params = {}) ⇒ Types::GetProfileOutput

Get profile information.

Examples:

Request syntax with placeholder values


resp = client.get_profile({
  profile_arn: "ProfileArn", # required
  profile_version: "ProfileVersion",
})

Response structure


resp.profile.profile_arn #=> String
resp.profile.profile_version #=> String
resp.profile.profile_name #=> String
resp.profile.profile_description #=> String
resp.profile.profile_questions #=> Array
resp.profile.profile_questions[0].question_id #=> String
resp.profile.profile_questions[0].question_title #=> String
resp.profile.profile_questions[0].question_description #=> String
resp.profile.profile_questions[0].question_choices #=> Array
resp.profile.profile_questions[0].question_choices[0].choice_id #=> String
resp.profile.profile_questions[0].question_choices[0].choice_title #=> String
resp.profile.profile_questions[0].question_choices[0].choice_description #=> String
resp.profile.profile_questions[0].selected_choice_ids #=> Array
resp.profile.profile_questions[0].selected_choice_ids[0] #=> String
resp.profile.profile_questions[0].min_selected_choices #=> Integer
resp.profile.profile_questions[0].max_selected_choices #=> Integer
resp.profile.owner #=> String
resp.profile.created_at #=> Time
resp.profile.updated_at #=> Time
resp.profile.share_invitation_id #=> String
resp.profile.tags #=> Hash
resp.profile.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :profile_arn (required, String) —

    The profile ARN.

  • :profile_version (String) —

    The profile version.

Returns:

See Also:



2469
2470
2471
2472
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2469

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

#get_profile_template(params = {}) ⇒ Types::GetProfileTemplateOutput

Get profile template.

Examples:

Response structure


resp.profile_template.template_name #=> String
resp.profile_template.template_questions #=> Array
resp.profile_template.template_questions[0].question_id #=> String
resp.profile_template.template_questions[0].question_title #=> String
resp.profile_template.template_questions[0].question_description #=> String
resp.profile_template.template_questions[0].question_choices #=> Array
resp.profile_template.template_questions[0].question_choices[0].choice_id #=> String
resp.profile_template.template_questions[0].question_choices[0].choice_title #=> String
resp.profile_template.template_questions[0].question_choices[0].choice_description #=> String
resp.profile_template.template_questions[0].min_selected_choices #=> Integer
resp.profile_template.template_questions[0].max_selected_choices #=> Integer
resp.profile_template.created_at #=> Time
resp.profile_template.updated_at #=> Time

Parameters:

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

    ({})

Returns:

See Also:



2500
2501
2502
2503
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2500

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

#get_review_template(params = {}) ⇒ Types::GetReviewTemplateOutput

Get review template.

Examples:

Request syntax with placeholder values


resp = client.get_review_template({
  template_arn: "TemplateArn", # required
})

Response structure


resp.review_template.description #=> String
resp.review_template.lenses #=> Array
resp.review_template.lenses[0] #=> String
resp.review_template.notes #=> String
resp.review_template.question_counts #=> Hash
resp.review_template.question_counts["Question"] #=> Integer
resp.review_template.owner #=> String
resp.review_template.updated_at #=> Time
resp.review_template.template_arn #=> String
resp.review_template.template_name #=> String
resp.review_template.tags #=> Hash
resp.review_template.tags["TagKey"] #=> String
resp.review_template.update_status #=> String, one of "CURRENT", "LENS_NOT_CURRENT"
resp.review_template.share_invitation_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :template_arn (required, String) —

    The review template ARN.

Returns:

See Also:



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

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

#get_review_template_answer(params = {}) ⇒ Types::GetReviewTemplateAnswerOutput

Get review template answer.

Examples:

Request syntax with placeholder values


resp = client.get_review_template_answer({
  template_arn: "TemplateArn", # required
  lens_alias: "LensAlias", # required
  question_id: "QuestionId", # required
})

Response structure


resp.template_arn #=> 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.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.answer_status #=> String, one of "UNANSWERED", "ANSWERED"
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):

  • :template_arn (required, String) —

    The review template ARN.

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

Returns:

See Also:



2622
2623
2624
2625
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2622

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

#get_review_template_lens_review(params = {}) ⇒ Types::GetReviewTemplateLensReviewOutput

Get a lens review associated with a review template.

Examples:

Request syntax with placeholder values


resp = client.get_review_template_lens_review({
  template_arn: "TemplateArn", # required
  lens_alias: "LensAlias", # required
})

Response structure


resp.template_arn #=> 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].question_counts #=> Hash
resp.lens_review.pillar_review_summaries[0].question_counts["Question"] #=> Integer
resp.lens_review.updated_at #=> Time
resp.lens_review.notes #=> String
resp.lens_review.question_counts #=> Hash
resp.lens_review.question_counts["Question"] #=> Integer
resp.lens_review.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :template_arn (required, String) —

    The review template ARN.

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

Returns:

See Also:



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

def get_review_template_lens_review(params = {}, options = {})
  req = build_request(:get_review_template_lens_review, 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
resp.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
resp.workload.discovery_config.workload_resource_definition #=> Array
resp.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
resp.workload.applications #=> Array
resp.workload.applications[0] #=> String
resp.workload.profiles #=> Array
resp.workload.profiles[0].profile_arn #=> String
resp.workload.profiles[0].profile_version #=> String
resp.workload.prioritized_risk_counts #=> Hash
resp.workload.prioritized_risk_counts["Risk"] #=> Integer
resp.workload.jira_configuration.issue_management_status #=> String, one of "ENABLED", "DISABLED", "INHERIT"
resp.workload.jira_configuration.issue_management_type #=> String, one of "AUTO", "MANUAL"
resp.workload.jira_configuration.jira_project_key #=> String
resp.workload.jira_configuration.status_message #=> 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:

See Also:



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

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

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

See Also:



2851
2852
2853
2854
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 2851

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,
  question_priority: "PRIORITIZED", # accepts PRIORITIZED, NONE
})

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.answer_summaries[0].question_type #=> String, one of "PRIORITIZED", "NON_PRIORITIZED"
resp.answer_summaries[0].jira_configuration.jira_issue_url #=> String
resp.answer_summaries[0].jira_configuration.last_synced_time #=> 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.

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

  • :question_priority (String) —

    The priority of the question.

Returns:

See Also:



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

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

See Also:



3032
3033
3034
3035
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3032

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]. #=> Hash
resp.check_summaries[0].["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:

See Also:



3104
3105
3106
3107
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3104

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 the improvements of a particular lens review.

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,
  question_priority: "PRIORITIZED", # accepts PRIORITIZED, NONE
})

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.improvement_summaries[0].jira_configuration.jira_issue_url #=> String
resp.improvement_summaries[0].jira_configuration.last_synced_time #=> 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.

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

  • :question_priority (String) —

    The priority of the question.

Returns:

See Also:



3195
3196
3197
3198
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3195

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.lens_review_summaries[0].profiles #=> Array
resp.lens_review_summaries[0].profiles[0].profile_arn #=> String
resp.lens_review_summaries[0].profiles[0].profile_version #=> String
resp.lens_review_summaries[0].prioritized_risk_counts #=> Hash
resp.lens_review_summaries[0].prioritized_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:

See Also:



3259
3260
3261
3262
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3259

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, 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 the share request.

Returns:

See Also:



3323
3324
3325
3326
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3323

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:

See Also:



3381
3382
3383
3384
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3381

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.milestone_summaries[0].workload_summary.profiles #=> Array
resp.milestone_summaries[0].workload_summary.profiles[0].profile_arn #=> String
resp.milestone_summaries[0].workload_summary.profiles[0].profile_version #=> String
resp.milestone_summaries[0].workload_summary.prioritized_risk_counts #=> Hash
resp.milestone_summaries[0].workload_summary.prioritized_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.

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



3442
3443
3444
3445
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3442

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,
  resource_arn: "ResourceArn",
})

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.notification_summaries[0].lens_upgrade_summary.resource_arn #=> String
resp.notification_summaries[0].lens_upgrade_summary.resource_name #=> 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.

  • :resource_arn (String) —

    The ARN for the related resource for the notification.

    Only one of WorkloadID or ResourceARN should be specified.

Returns:

See Also:



3500
3501
3502
3503
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3500

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

#list_profile_notifications(params = {}) ⇒ Types::ListProfileNotificationsOutput

List profile notifications.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.notification_summaries #=> Array
resp.notification_summaries[0].current_profile_version #=> String
resp.notification_summaries[0].latest_profile_version #=> String
resp.notification_summaries[0].type #=> String, one of "PROFILE_ANSWERS_UPDATED", "PROFILE_DELETED"
resp.notification_summaries[0].profile_arn #=> String
resp.notification_summaries[0].profile_name #=> String
resp.notification_summaries[0].workload_id #=> String
resp.notification_summaries[0].workload_name #=> 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:

See Also:



3548
3549
3550
3551
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3548

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

#list_profile_shares(params = {}) ⇒ Types::ListProfileSharesOutput

List profile shares.

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

Examples:

Request syntax with placeholder values


resp = client.list_profile_shares({
  profile_arn: "ProfileArn", # 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.profile_share_summaries #=> Array
resp.profile_share_summaries[0].share_id #=> String
resp.profile_share_summaries[0].shared_with #=> String
resp.profile_share_summaries[0].status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED", "ASSOCIATING", "ASSOCIATED", "FAILED"
resp.profile_share_summaries[0].status_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :profile_arn (required, String) —

    The profile ARN.

  • :shared_with_prefix (String) —

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile 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 the share request.

Returns:

See Also:



3601
3602
3603
3604
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3601

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

#list_profiles(params = {}) ⇒ Types::ListProfilesOutput

List profiles.

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_profiles({
  profile_name_prefix: "ProfileNamePrefix",
  profile_owner_type: "SELF", # accepts SELF, SHARED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.profile_summaries #=> Array
resp.profile_summaries[0].profile_arn #=> String
resp.profile_summaries[0].profile_version #=> String
resp.profile_summaries[0].profile_name #=> String
resp.profile_summaries[0].profile_description #=> String
resp.profile_summaries[0].owner #=> String
resp.profile_summaries[0].created_at #=> Time
resp.profile_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :profile_name_prefix (String) —

    An optional string added to the beginning of each profile name returned in the results.

  • :profile_owner_type (String) —

    Profile owner type.

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



3653
3654
3655
3656
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3653

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

#list_review_template_answers(params = {}) ⇒ Types::ListReviewTemplateAnswersOutput

List the answers of a review template.

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

Examples:

Request syntax with placeholder values


resp = client.list_review_template_answers({
  template_arn: "TemplateArn", # required
  lens_alias: "LensAlias", # required
  pillar_id: "PillarId",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.template_arn #=> String
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].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].answer_status #=> String, one of "UNANSWERED", "ANSWERED"
resp.answer_summaries[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
resp.answer_summaries[0].question_type #=> String, one of "PRIORITIZED", "NON_PRIORITIZED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :template_arn (required, String) —

    The ARN of the review template.

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

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



3744
3745
3746
3747
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3744

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

#list_review_templates(params = {}) ⇒ Types::ListReviewTemplatesOutput

List review templates.

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

Examples:

Request syntax with placeholder values


resp = client.list_review_templates({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.review_templates #=> Array
resp.review_templates[0].description #=> String
resp.review_templates[0].lenses #=> Array
resp.review_templates[0].lenses[0] #=> String
resp.review_templates[0].owner #=> String
resp.review_templates[0].updated_at #=> Time
resp.review_templates[0].template_arn #=> String
resp.review_templates[0].template_name #=> String
resp.review_templates[0].update_status #=> String, one of "CURRENT", "LENS_NOT_CURRENT"
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:



3788
3789
3790
3791
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3788

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

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

List the share invitations.

WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.

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

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, PROFILE, TEMPLATE
  next_token: "NextToken",
  max_results: 1,
  profile_name_prefix: "ProfileNamePrefix",
  template_name_prefix: "TemplateNamePrefix",
})

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", "PROFILE", "TEMPLATE"
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.share_invitation_summaries[0].profile_name #=> String
resp.share_invitation_summaries[0].profile_arn #=> String
resp.share_invitation_summaries[0].template_name #=> String
resp.share_invitation_summaries[0].template_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.

  • :profile_name_prefix (String) —

    An optional string added to the beginning of each profile name returned in the results.

  • :template_name_prefix (String) —

    An optional string added to the beginning of each review template name returned in the results.

Returns:

See Also:



3865
3866
3867
3868
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3865

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 a workload ARN, a custom lens ARN, a profile ARN, or review template 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:

See Also:



3899
3900
3901
3902
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3899

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

#list_template_shares(params = {}) ⇒ Types::ListTemplateSharesOutput

List review template shares.

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

Examples:

Request syntax with placeholder values


resp = client.list_template_shares({
  template_arn: "TemplateArn", # 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.template_arn #=> String
resp.template_share_summaries #=> Array
resp.template_share_summaries[0].share_id #=> String
resp.template_share_summaries[0].shared_with #=> String
resp.template_share_summaries[0].status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED", "ASSOCIATING", "ASSOCIATED", "FAILED"
resp.template_share_summaries[0].status_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :template_arn (required, String) —

    The review template ARN.

  • :shared_with_prefix (String) —

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile 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 the share request.

Returns:

See Also:



3954
3955
3956
3957
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 3954

def list_template_shares(params = {}, options = {})
  req = build_request(:list_template_shares, 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, 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 the share request.

Returns:

See Also:



4011
4012
4013
4014
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4011

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.workload_summaries[0].profiles #=> Array
resp.workload_summaries[0].profiles[0].profile_arn #=> String
resp.workload_summaries[0].profiles[0].profile_version #=> String
resp.workload_summaries[0].prioritized_risk_counts #=> Hash
resp.workload_summaries[0].prioritized_risk_counts["Risk"] #=> Integer
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:



4067
4068
4069
4070
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4067

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 a workload ARN, a custom lens ARN, a profile ARN, or review template 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:



4100
4101
4102
4103
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4100

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 a workload ARN, a custom lens ARN, a profile ARN, or review template 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:



4137
4138
4139
4140
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4137

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"
resp.answer.jira_configuration.jira_issue_url #=> String
resp.answer.jira_configuration.last_synced_time #=> Time

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.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

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



4255
4256
4257
4258
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4255

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

#update_global_settings(params = {}) ⇒ Struct

Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

Examples:

Request syntax with placeholder values


resp = client.update_global_settings({
  organization_sharing_status: "ENABLED", # accepts ENABLED, DISABLED
  discovery_integration_status: "ENABLED", # accepts ENABLED, DISABLED
  jira_configuration: {
    issue_management_status: "ENABLED", # accepts ENABLED, DISABLED
    issue_management_type: "AUTO", # accepts AUTO, MANUAL
    jira_project_key: "JiraProjectKey",
    integration_status: "NOT_CONFIGURED", # accepts NOT_CONFIGURED
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :organization_sharing_status (String) —

    The status of organization sharing settings.

  • :discovery_integration_status (String) —

    The status of discovery support settings.

  • :jira_configuration (Types::AccountJiraConfigurationInput) —

    The status of Jira integration settings.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4291
4292
4293
4294
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4291

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

#update_integration(params = {}) ⇒ Struct

Update integration features.

Examples:

Request syntax with placeholder values


resp = client.update_integration({
  workload_id: "WorkloadId", # required
  client_request_token: "ClientRequestToken", # required
  integrating_service: "JIRA", # required, accepts JIRA
})

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

  • :integrating_service (required, String) —

    Which integrated service to update.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4336
4337
4338
4339
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4336

def update_integration(params = {}, options = {})
  req = build_request(:update_integration, 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",
  },
  jira_configuration: {
    selected_pillars: [
      {
        pillar_id: "PillarId",
        selected_question_ids: ["SelectedQuestionId"],
      },
    ],
  },
})

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.pillar_review_summaries[0].prioritized_risk_counts #=> Hash
resp.lens_review.pillar_review_summaries[0].prioritized_risk_counts["Risk"] #=> Integer
resp.lens_review.jira_configuration.selected_pillars #=> Array
resp.lens_review.jira_configuration.selected_pillars[0].pillar_id #=> String
resp.lens_review.jira_configuration.selected_pillars[0].selected_question_ids #=> Array
resp.lens_review.jira_configuration.selected_pillars[0].selected_question_ids[0] #=> String
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
resp.lens_review.profiles #=> Array
resp.lens_review.profiles[0].profile_arn #=> String
resp.lens_review.profiles[0].profile_version #=> String
resp.lens_review.prioritized_risk_counts #=> Hash
resp.lens_review.prioritized_risk_counts["Risk"] #=> 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.

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

    For a review template, these are the notes that will be associated with the workload when the template is applied.

  • :pillar_notes (Hash<String,String>) —

    List of pillar notes of a lens review in a workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

  • :jira_configuration (Types::JiraSelectedQuestionConfiguration) —

    Configuration of the Jira integration.

Returns:

See Also:



4435
4436
4437
4438
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4435

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

#update_profile(params = {}) ⇒ Types::UpdateProfileOutput

Update a profile.

Examples:

Request syntax with placeholder values


resp = client.update_profile({
  profile_arn: "ProfileArn", # required
  profile_description: "ProfileDescription",
  profile_questions: [
    {
      question_id: "QuestionId",
      selected_choice_ids: ["ChoiceId"],
    },
  ],
})

Response structure


resp.profile.profile_arn #=> String
resp.profile.profile_version #=> String
resp.profile.profile_name #=> String
resp.profile.profile_description #=> String
resp.profile.profile_questions #=> Array
resp.profile.profile_questions[0].question_id #=> String
resp.profile.profile_questions[0].question_title #=> String
resp.profile.profile_questions[0].question_description #=> String
resp.profile.profile_questions[0].question_choices #=> Array
resp.profile.profile_questions[0].question_choices[0].choice_id #=> String
resp.profile.profile_questions[0].question_choices[0].choice_title #=> String
resp.profile.profile_questions[0].question_choices[0].choice_description #=> String
resp.profile.profile_questions[0].selected_choice_ids #=> Array
resp.profile.profile_questions[0].selected_choice_ids[0] #=> String
resp.profile.profile_questions[0].min_selected_choices #=> Integer
resp.profile.profile_questions[0].max_selected_choices #=> Integer
resp.profile.owner #=> String
resp.profile.created_at #=> Time
resp.profile.updated_at #=> Time
resp.profile.share_invitation_id #=> String
resp.profile.tags #=> Hash
resp.profile.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :profile_arn (required, String) —

    The profile ARN.

  • :profile_description (String) —

    The profile description.

  • :profile_questions (Array<Types::ProfileQuestionUpdate>) —

    Profile questions.

Returns:

See Also:



4497
4498
4499
4500
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4497

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

#update_review_template(params = {}) ⇒ Types::UpdateReviewTemplateOutput

Update a review template.

Examples:

Request syntax with placeholder values


resp = client.update_review_template({
  template_arn: "TemplateArn", # required
  template_name: "TemplateName",
  description: "TemplateDescription",
  notes: "Notes",
  lenses_to_associate: ["LensAlias"],
  lenses_to_disassociate: ["LensAlias"],
})

Response structure


resp.review_template.description #=> String
resp.review_template.lenses #=> Array
resp.review_template.lenses[0] #=> String
resp.review_template.notes #=> String
resp.review_template.question_counts #=> Hash
resp.review_template.question_counts["Question"] #=> Integer
resp.review_template.owner #=> String
resp.review_template.updated_at #=> Time
resp.review_template.template_arn #=> String
resp.review_template.template_name #=> String
resp.review_template.tags #=> Hash
resp.review_template.tags["TagKey"] #=> String
resp.review_template.update_status #=> String, one of "CURRENT", "LENS_NOT_CURRENT"
resp.review_template.share_invitation_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :template_arn (required, String) —

    The review template ARN.

  • :template_name (String) —

    The review template name.

  • :description (String) —

    The review template description.

  • :notes (String) —

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

  • :lenses_to_associate (Array<String>) —

    A list of lens aliases or ARNs to apply to the review template.

  • :lenses_to_disassociate (Array<String>) —

    A list of lens aliases or ARNs to unapply to the review template. The wellarchitected lens cannot be unapplied.

Returns:

See Also:



4562
4563
4564
4565
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4562

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

#update_review_template_answer(params = {}) ⇒ Types::UpdateReviewTemplateAnswerOutput

Update a review template answer.

Examples:

Request syntax with placeholder values


resp = client.update_review_template_answer({
  template_arn: "TemplateArn", # 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.template_arn #=> 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.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.answer_status #=> String, one of "UNANSWERED", "ANSWERED"
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):

  • :template_arn (required, String) —

    The review template ARN.

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

  • :notes (String) —

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

  • :is_applicable (Boolean) —

    Defines whether this question is applicable to a lens review.

  • :reason (String) —

    The update reason.

Returns:

See Also:



4674
4675
4676
4677
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4674

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

#update_review_template_lens_review(params = {}) ⇒ Types::UpdateReviewTemplateLensReviewOutput

Update a lens review associated with a review template.

Examples:

Request syntax with placeholder values


resp = client.update_review_template_lens_review({
  template_arn: "TemplateArn", # required
  lens_alias: "LensAlias", # required
  lens_notes: "Notes",
  pillar_notes: {
    "PillarId" => "Notes",
  },
})

Response structure


resp.template_arn #=> 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].question_counts #=> Hash
resp.lens_review.pillar_review_summaries[0].question_counts["Question"] #=> Integer
resp.lens_review.updated_at #=> Time
resp.lens_review.notes #=> String
resp.lens_review.question_counts #=> Hash
resp.lens_review.question_counts["Question"] #=> Integer
resp.lens_review.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :template_arn (required, String) —

    The review template ARN.

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

    For a review template, these are the notes that will be associated with the workload when the template is applied.

  • :pillar_notes (Hash<String,String>) —

    List of pillar notes of a lens review in a workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

Returns:

See Also:



4750
4751
4752
4753
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4750

def update_review_template_lens_review(params = {}, options = {})
  req = build_request(:update_review_template_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", "PROFILE", "TEMPLATE"
resp.share_invitation.workload_id #=> String
resp.share_invitation.lens_alias #=> String
resp.share_invitation.lens_arn #=> String
resp.share_invitation.profile_arn #=> String
resp.share_invitation.template_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:

See Also:



4793
4794
4795
4796
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 4793

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
    workload_resource_definition: ["WORKLOAD_METADATA"], # accepts WORKLOAD_METADATA, APP_REGISTRY
  },
  applications: ["ApplicationArn"],
  jira_configuration: {
    issue_management_status: "ENABLED", # accepts ENABLED, DISABLED, INHERIT
    issue_management_type: "AUTO", # accepts AUTO, MANUAL
    jira_project_key: "JiraProjectKey",
  },
})

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
resp.workload.discovery_config.trusted_advisor_integration_status #=> String, one of "ENABLED", "DISABLED"
resp.workload.discovery_config.workload_resource_definition #=> Array
resp.workload.discovery_config.workload_resource_definition[0] #=> String, one of "WORKLOAD_METADATA", "APP_REGISTRY"
resp.workload.applications #=> Array
resp.workload.applications[0] #=> String
resp.workload.profiles #=> Array
resp.workload.profiles[0].profile_arn #=> String
resp.workload.profiles[0].profile_version #=> String
resp.workload.prioritized_risk_counts #=> Hash
resp.workload.prioritized_risk_counts["Risk"] #=> Integer
resp.workload.jira_configuration.issue_management_status #=> String, one of "ENABLED", "DISABLED", "INHERIT"
resp.workload.jira_configuration.issue_management_type #=> String, one of "AUTO", "MANUAL"
resp.workload.jira_configuration.jira_project_key #=> String
resp.workload.jira_configuration.status_message #=> 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.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

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

  • :jira_configuration (Types::WorkloadJiraConfigurationInput) —

    Configuration of the Jira integration.

Returns:

See Also:



5016
5017
5018
5019
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5016

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 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 share request.

Returns:

See Also:



5061
5062
5063
5064
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5061

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:



5120
5121
5122
5123
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5120

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

#upgrade_profile_version(params = {}) ⇒ Struct

Upgrade a profile.

Examples:

Request syntax with placeholder values


resp = client.upgrade_profile_version({
  workload_id: "WorkloadId", # required
  profile_arn: "ProfileArn", # required
  milestone_name: "MilestoneName",
  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.

  • :profile_arn (required, String) —

    The profile ARN.

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5171
5172
5173
5174
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5171

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

#upgrade_review_template_lens_review(params = {}) ⇒ Struct

Upgrade the lens review of a review template.

Examples:

Request syntax with placeholder values


resp = client.upgrade_review_template_lens_review({
  template_arn: "TemplateArn", # required
  lens_alias: "LensAlias", # required
  client_request_token: "ClientRequestToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :template_arn (required, String) —

    The ARN of the review template.

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



5223
5224
5225
5226
 
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/client.rb', line 5223

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