aws-sdk-wellarchitected 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: dc23d33ab9a10b86f45673bdc11b5a9d7400c45421e3e752ee407c6d42ad0490
4
+ data.tar.gz: b8f8731c70fe30b80ad7fb892daa4b6a616135ede445407cac80eca510507f90
5
+ SHA512:
6
+ metadata.gz: ba2b76a54b25b587e7965ad5f51b904ff5435ab6281cb3b193153b2ba93381d3faff838e754cd79f2215449977f77529eebe2d630d0423a30e93c5f97b901ada
7
+ data.tar.gz: 9a087328c8d2ea8347a9381d92df678aa4636fc5bc29d94a57ac67d15e810f532c273049d5f091cefcd94b7fc144b82802828a5004920b631d83609be36704b9
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-wellarchitected/types'
15
+ require_relative 'aws-sdk-wellarchitected/client_api'
16
+ require_relative 'aws-sdk-wellarchitected/client'
17
+ require_relative 'aws-sdk-wellarchitected/errors'
18
+ require_relative 'aws-sdk-wellarchitected/resource'
19
+ require_relative 'aws-sdk-wellarchitected/customizations'
20
+
21
+ # This module provides support for AWS Well-Architected Tool. This module is available in the
22
+ # `aws-sdk-wellarchitected` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # well_architected = Aws::WellArchitected::Client.new
31
+ # resp = well_architected.associate_lenses(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from AWS Well-Architected Tool are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::WellArchitected::Errors::ServiceError
43
+ # # rescues all AWS Well-Architected Tool API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::WellArchitected
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,2083 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:wellarchitected)
34
+
35
+ module Aws::WellArchitected
36
+ # An API client for WellArchitected. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::WellArchitected::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :wellarchitected
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # Associate a lens to a workload.
331
+ #
332
+ # @option params [required, String] :workload_id
333
+ # The ID assigned to the workload. This ID is unique within an AWS
334
+ # Region.
335
+ #
336
+ # @option params [required, Array<String>] :lens_aliases
337
+ # List of lens aliases to associate or disassociate with a workload.
338
+ #
339
+ # Identify a lens using its LensSummary$LensAlias.
340
+ #
341
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
342
+ #
343
+ # @example Request syntax with placeholder values
344
+ #
345
+ # resp = client.associate_lenses({
346
+ # workload_id: "WorkloadId", # required
347
+ # lens_aliases: ["LensAlias"], # required
348
+ # })
349
+ #
350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/AssociateLenses AWS API Documentation
351
+ #
352
+ # @overload associate_lenses(params = {})
353
+ # @param [Hash] params ({})
354
+ def associate_lenses(params = {}, options = {})
355
+ req = build_request(:associate_lenses, params)
356
+ req.send_request(options)
357
+ end
358
+
359
+ # Create a milestone for an existing workload.
360
+ #
361
+ # @option params [required, String] :workload_id
362
+ # The ID assigned to the workload. This ID is unique within an AWS
363
+ # Region.
364
+ #
365
+ # @option params [required, String] :milestone_name
366
+ # The name of the milestone in a workload.
367
+ #
368
+ # Milestone names must be unique within a workload.
369
+ #
370
+ # @option params [required, String] :client_request_token
371
+ # A unique case-sensitive string used to ensure that this request is
372
+ # idempotent (executes only once).
373
+ #
374
+ # You should not reuse the same token for other requests. If you retry a
375
+ # request with the same client request token and the same parameters
376
+ # after it has completed successfully, the result of the original
377
+ # request is returned.
378
+ #
379
+ # This token is listed as required, however, if you do not specify it,
380
+ # the AWS SDKs automatically generate one for you. If you are not using
381
+ # the AWS SDK or the AWS CLI, you must provide this token or the request
382
+ # will fail.
383
+ #
384
+ # **A suitable default value is auto-generated.** You should normally
385
+ # not need to pass this option.**
386
+ #
387
+ # @return [Types::CreateMilestoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
388
+ #
389
+ # * {Types::CreateMilestoneOutput#workload_id #workload_id} => String
390
+ # * {Types::CreateMilestoneOutput#milestone_number #milestone_number} => Integer
391
+ #
392
+ # @example Request syntax with placeholder values
393
+ #
394
+ # resp = client.create_milestone({
395
+ # workload_id: "WorkloadId", # required
396
+ # milestone_name: "MilestoneName", # required
397
+ # client_request_token: "ClientRequestToken", # required
398
+ # })
399
+ #
400
+ # @example Response structure
401
+ #
402
+ # resp.workload_id #=> String
403
+ # resp.milestone_number #=> Integer
404
+ #
405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateMilestone AWS API Documentation
406
+ #
407
+ # @overload create_milestone(params = {})
408
+ # @param [Hash] params ({})
409
+ def create_milestone(params = {}, options = {})
410
+ req = build_request(:create_milestone, params)
411
+ req.send_request(options)
412
+ end
413
+
414
+ # Create a new workload.
415
+ #
416
+ # The owner of a workload can share the workload with other AWS accounts
417
+ # and IAM users in the same AWS Region. Only the owner of a workload can
418
+ # delete it.
419
+ #
420
+ # For more information, see [Defining a Workload][1] in the *AWS
421
+ # Well-Architected Tool User Guide*.
422
+ #
423
+ #
424
+ #
425
+ # [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html
426
+ #
427
+ # @option params [required, String] :workload_name
428
+ # The name of the workload.
429
+ #
430
+ # The name must be unique within an account within a Region. Spaces and
431
+ # capitalization are ignored when checking for uniqueness.
432
+ #
433
+ # @option params [required, String] :description
434
+ # The description for the workload.
435
+ #
436
+ # @option params [required, String] :environment
437
+ # The environment for the workload.
438
+ #
439
+ # @option params [Array<String>] :account_ids
440
+ # The list of AWS account IDs associated with the workload.
441
+ #
442
+ # @option params [Array<String>] :aws_regions
443
+ # The list of AWS Regions associated with the workload, for example,
444
+ # `us-east-2`, or `ca-central-1`.
445
+ #
446
+ # @option params [Array<String>] :non_aws_regions
447
+ # The list of non-AWS Regions associated with the workload.
448
+ #
449
+ # @option params [Array<String>] :pillar_priorities
450
+ # The priorities of the pillars, which are used to order items in the
451
+ # improvement plan. Each pillar is represented by its
452
+ # PillarReviewSummary$PillarId.
453
+ #
454
+ # @option params [String] :architectural_design
455
+ # The URL of the architectural design for the workload.
456
+ #
457
+ # @option params [required, String] :review_owner
458
+ # The review owner of the workload. The name, email address, or
459
+ # identifier for the primary group or individual that owns the workload
460
+ # review process.
461
+ #
462
+ # @option params [String] :industry_type
463
+ # The industry type for the workload.
464
+ #
465
+ # If specified, must be one of the following:
466
+ #
467
+ # * `Agriculture`
468
+ #
469
+ # * `Automobile`
470
+ #
471
+ # * `Defense`
472
+ #
473
+ # * `Design and Engineering`
474
+ #
475
+ # * `Digital Advertising`
476
+ #
477
+ # * `Education`
478
+ #
479
+ # * `Environmental Protection`
480
+ #
481
+ # * `Financial Services`
482
+ #
483
+ # * `Gaming`
484
+ #
485
+ # * `General Public Services`
486
+ #
487
+ # * `Healthcare`
488
+ #
489
+ # * `Hospitality`
490
+ #
491
+ # * `InfoTech`
492
+ #
493
+ # * `Justice and Public Safety`
494
+ #
495
+ # * `Life Sciences`
496
+ #
497
+ # * `Manufacturing`
498
+ #
499
+ # * `Media & Entertainment`
500
+ #
501
+ # * `Mining & Resources`
502
+ #
503
+ # * `Oil & Gas`
504
+ #
505
+ # * `Power & Utilities`
506
+ #
507
+ # * `Professional Services`
508
+ #
509
+ # * `Real Estate & Construction`
510
+ #
511
+ # * `Retail & Wholesale`
512
+ #
513
+ # * `Social Protection`
514
+ #
515
+ # * `Telecommunications`
516
+ #
517
+ # * `Travel, Transportation & Logistics`
518
+ #
519
+ # * `Other`
520
+ #
521
+ # @option params [String] :industry
522
+ # The industry for the workload.
523
+ #
524
+ # @option params [required, Array<String>] :lenses
525
+ # The list of lenses associated with the workload. Each lens is
526
+ # identified by its LensSummary$LensAlias.
527
+ #
528
+ # @option params [String] :notes
529
+ # The notes associated with the workload.
530
+ #
531
+ # @option params [required, String] :client_request_token
532
+ # A unique case-sensitive string used to ensure that this request is
533
+ # idempotent (executes only once).
534
+ #
535
+ # You should not reuse the same token for other requests. If you retry a
536
+ # request with the same client request token and the same parameters
537
+ # after it has completed successfully, the result of the original
538
+ # request is returned.
539
+ #
540
+ # This token is listed as required, however, if you do not specify it,
541
+ # the AWS SDKs automatically generate one for you. If you are not using
542
+ # the AWS SDK or the AWS CLI, you must provide this token or the request
543
+ # will fail.
544
+ #
545
+ # **A suitable default value is auto-generated.** You should normally
546
+ # not need to pass this option.**
547
+ #
548
+ # @return [Types::CreateWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
549
+ #
550
+ # * {Types::CreateWorkloadOutput#workload_id #workload_id} => String
551
+ # * {Types::CreateWorkloadOutput#workload_arn #workload_arn} => String
552
+ #
553
+ # @example Request syntax with placeholder values
554
+ #
555
+ # resp = client.create_workload({
556
+ # workload_name: "WorkloadName", # required
557
+ # description: "WorkloadDescription", # required
558
+ # environment: "PRODUCTION", # required, accepts PRODUCTION, PREPRODUCTION
559
+ # account_ids: ["AwsAccountId"],
560
+ # aws_regions: ["AwsRegion"],
561
+ # non_aws_regions: ["WorkloadNonAwsRegion"],
562
+ # pillar_priorities: ["PillarId"],
563
+ # architectural_design: "WorkloadArchitecturalDesign",
564
+ # review_owner: "WorkloadReviewOwner", # required
565
+ # industry_type: "WorkloadIndustryType",
566
+ # industry: "WorkloadIndustry",
567
+ # lenses: ["LensAlias"], # required
568
+ # notes: "Notes",
569
+ # client_request_token: "ClientRequestToken", # required
570
+ # })
571
+ #
572
+ # @example Response structure
573
+ #
574
+ # resp.workload_id #=> String
575
+ # resp.workload_arn #=> String
576
+ #
577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkload AWS API Documentation
578
+ #
579
+ # @overload create_workload(params = {})
580
+ # @param [Hash] params ({})
581
+ def create_workload(params = {}, options = {})
582
+ req = build_request(:create_workload, params)
583
+ req.send_request(options)
584
+ end
585
+
586
+ # Create a workload share.
587
+ #
588
+ # The owner of a workload can share it with other AWS accounts and IAM
589
+ # users in the same AWS Region. Shared access to a workload is not
590
+ # removed until the workload invitation is deleted.
591
+ #
592
+ # For more information, see [Sharing a Workload][1] in the *AWS
593
+ # Well-Architected Tool User Guide*.
594
+ #
595
+ #
596
+ #
597
+ # [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html
598
+ #
599
+ # @option params [required, String] :workload_id
600
+ # The ID assigned to the workload. This ID is unique within an AWS
601
+ # Region.
602
+ #
603
+ # @option params [required, String] :shared_with
604
+ # The AWS account ID or IAM role with which the workload is shared.
605
+ #
606
+ # @option params [required, String] :permission_type
607
+ # Permission granted on a workload share.
608
+ #
609
+ # @option params [required, String] :client_request_token
610
+ # A unique case-sensitive string used to ensure that this request is
611
+ # idempotent (executes only once).
612
+ #
613
+ # You should not reuse the same token for other requests. If you retry a
614
+ # request with the same client request token and the same parameters
615
+ # after it has completed successfully, the result of the original
616
+ # request is returned.
617
+ #
618
+ # This token is listed as required, however, if you do not specify it,
619
+ # the AWS SDKs automatically generate one for you. If you are not using
620
+ # the AWS SDK or the AWS CLI, you must provide this token or the request
621
+ # will fail.
622
+ #
623
+ # **A suitable default value is auto-generated.** You should normally
624
+ # not need to pass this option.**
625
+ #
626
+ # @return [Types::CreateWorkloadShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
627
+ #
628
+ # * {Types::CreateWorkloadShareOutput#workload_id #workload_id} => String
629
+ # * {Types::CreateWorkloadShareOutput#share_id #share_id} => String
630
+ #
631
+ # @example Request syntax with placeholder values
632
+ #
633
+ # resp = client.create_workload_share({
634
+ # workload_id: "WorkloadId", # required
635
+ # shared_with: "SharedWith", # required
636
+ # permission_type: "READONLY", # required, accepts READONLY, CONTRIBUTOR
637
+ # client_request_token: "ClientRequestToken", # required
638
+ # })
639
+ #
640
+ # @example Response structure
641
+ #
642
+ # resp.workload_id #=> String
643
+ # resp.share_id #=> String
644
+ #
645
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadShare AWS API Documentation
646
+ #
647
+ # @overload create_workload_share(params = {})
648
+ # @param [Hash] params ({})
649
+ def create_workload_share(params = {}, options = {})
650
+ req = build_request(:create_workload_share, params)
651
+ req.send_request(options)
652
+ end
653
+
654
+ # Delete an existing workload.
655
+ #
656
+ # @option params [required, String] :workload_id
657
+ # The ID assigned to the workload. This ID is unique within an AWS
658
+ # Region.
659
+ #
660
+ # @option params [required, String] :client_request_token
661
+ # A unique case-sensitive string used to ensure that this request is
662
+ # idempotent (executes only once).
663
+ #
664
+ # You should not reuse the same token for other requests. If you retry a
665
+ # request with the same client request token and the same parameters
666
+ # after it has completed successfully, the result of the original
667
+ # request is returned.
668
+ #
669
+ # This token is listed as required, however, if you do not specify it,
670
+ # the AWS SDKs automatically generate one for you. If you are not using
671
+ # the AWS SDK or the AWS CLI, you must provide this token or the request
672
+ # will fail.
673
+ #
674
+ # **A suitable default value is auto-generated.** You should normally
675
+ # not need to pass this option.**
676
+ #
677
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
678
+ #
679
+ # @example Request syntax with placeholder values
680
+ #
681
+ # resp = client.delete_workload({
682
+ # workload_id: "WorkloadId", # required
683
+ # client_request_token: "ClientRequestToken", # required
684
+ # })
685
+ #
686
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteWorkload AWS API Documentation
687
+ #
688
+ # @overload delete_workload(params = {})
689
+ # @param [Hash] params ({})
690
+ def delete_workload(params = {}, options = {})
691
+ req = build_request(:delete_workload, params)
692
+ req.send_request(options)
693
+ end
694
+
695
+ # Delete a workload share.
696
+ #
697
+ # @option params [required, String] :share_id
698
+ # The ID associated with the workload share.
699
+ #
700
+ # @option params [required, String] :workload_id
701
+ # The ID assigned to the workload. This ID is unique within an AWS
702
+ # Region.
703
+ #
704
+ # @option params [required, String] :client_request_token
705
+ # A unique case-sensitive string used to ensure that this request is
706
+ # idempotent (executes only once).
707
+ #
708
+ # You should not reuse the same token for other requests. If you retry a
709
+ # request with the same client request token and the same parameters
710
+ # after it has completed successfully, the result of the original
711
+ # request is returned.
712
+ #
713
+ # This token is listed as required, however, if you do not specify it,
714
+ # the AWS SDKs automatically generate one for you. If you are not using
715
+ # the AWS SDK or the AWS CLI, you must provide this token or the request
716
+ # will fail.
717
+ #
718
+ # **A suitable default value is auto-generated.** You should normally
719
+ # not need to pass this option.**
720
+ #
721
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
722
+ #
723
+ # @example Request syntax with placeholder values
724
+ #
725
+ # resp = client.delete_workload_share({
726
+ # share_id: "ShareId", # required
727
+ # workload_id: "WorkloadId", # required
728
+ # client_request_token: "ClientRequestToken", # required
729
+ # })
730
+ #
731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteWorkloadShare AWS API Documentation
732
+ #
733
+ # @overload delete_workload_share(params = {})
734
+ # @param [Hash] params ({})
735
+ def delete_workload_share(params = {}, options = {})
736
+ req = build_request(:delete_workload_share, params)
737
+ req.send_request(options)
738
+ end
739
+
740
+ # Disassociate a lens from a workload.
741
+ #
742
+ # <note markdown="1"> The AWS Well-Architected Framework lens (`wellarchitected`) cannot be
743
+ # removed from a workload.
744
+ #
745
+ # </note>
746
+ #
747
+ # @option params [required, String] :workload_id
748
+ # The ID assigned to the workload. This ID is unique within an AWS
749
+ # Region.
750
+ #
751
+ # @option params [required, Array<String>] :lens_aliases
752
+ # List of lens aliases to associate or disassociate with a workload.
753
+ #
754
+ # Identify a lens using its LensSummary$LensAlias.
755
+ #
756
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
757
+ #
758
+ # @example Request syntax with placeholder values
759
+ #
760
+ # resp = client.disassociate_lenses({
761
+ # workload_id: "WorkloadId", # required
762
+ # lens_aliases: ["LensAlias"], # required
763
+ # })
764
+ #
765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DisassociateLenses AWS API Documentation
766
+ #
767
+ # @overload disassociate_lenses(params = {})
768
+ # @param [Hash] params ({})
769
+ def disassociate_lenses(params = {}, options = {})
770
+ req = build_request(:disassociate_lenses, params)
771
+ req.send_request(options)
772
+ end
773
+
774
+ # Get lens review.
775
+ #
776
+ # @option params [required, String] :workload_id
777
+ # The ID assigned to the workload. This ID is unique within an AWS
778
+ # Region.
779
+ #
780
+ # @option params [required, String] :lens_alias
781
+ # The alias of the lens, for example, `serverless`.
782
+ #
783
+ # Each lens is identified by its LensSummary$LensAlias.
784
+ #
785
+ # @option params [required, String] :question_id
786
+ # The ID of the question.
787
+ #
788
+ # @option params [Integer] :milestone_number
789
+ # The milestone number.
790
+ #
791
+ # A workload can have a maximum of 100 milestones.
792
+ #
793
+ # @return [Types::GetAnswerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
794
+ #
795
+ # * {Types::GetAnswerOutput#workload_id #workload_id} => String
796
+ # * {Types::GetAnswerOutput#milestone_number #milestone_number} => Integer
797
+ # * {Types::GetAnswerOutput#lens_alias #lens_alias} => String
798
+ # * {Types::GetAnswerOutput#answer #answer} => Types::Answer
799
+ #
800
+ # @example Request syntax with placeholder values
801
+ #
802
+ # resp = client.get_answer({
803
+ # workload_id: "WorkloadId", # required
804
+ # lens_alias: "LensAlias", # required
805
+ # question_id: "QuestionId", # required
806
+ # milestone_number: 1,
807
+ # })
808
+ #
809
+ # @example Response structure
810
+ #
811
+ # resp.workload_id #=> String
812
+ # resp.milestone_number #=> Integer
813
+ # resp.lens_alias #=> String
814
+ # resp.answer.question_id #=> String
815
+ # resp.answer.pillar_id #=> String
816
+ # resp.answer.question_title #=> String
817
+ # resp.answer.question_description #=> String
818
+ # resp.answer.improvement_plan_url #=> String
819
+ # resp.answer.helpful_resource_url #=> String
820
+ # resp.answer.choices #=> Array
821
+ # resp.answer.choices[0].choice_id #=> String
822
+ # resp.answer.choices[0].title #=> String
823
+ # resp.answer.choices[0].description #=> String
824
+ # resp.answer.selected_choices #=> Array
825
+ # resp.answer.selected_choices[0] #=> String
826
+ # resp.answer.is_applicable #=> Boolean
827
+ # resp.answer.risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
828
+ # resp.answer.notes #=> String
829
+ #
830
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetAnswer AWS API Documentation
831
+ #
832
+ # @overload get_answer(params = {})
833
+ # @param [Hash] params ({})
834
+ def get_answer(params = {}, options = {})
835
+ req = build_request(:get_answer, params)
836
+ req.send_request(options)
837
+ end
838
+
839
+ # Get lens review.
840
+ #
841
+ # @option params [required, String] :workload_id
842
+ # The ID assigned to the workload. This ID is unique within an AWS
843
+ # Region.
844
+ #
845
+ # @option params [required, String] :lens_alias
846
+ # The alias of the lens, for example, `serverless`.
847
+ #
848
+ # Each lens is identified by its LensSummary$LensAlias.
849
+ #
850
+ # @option params [Integer] :milestone_number
851
+ # The milestone number.
852
+ #
853
+ # A workload can have a maximum of 100 milestones.
854
+ #
855
+ # @return [Types::GetLensReviewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
856
+ #
857
+ # * {Types::GetLensReviewOutput#workload_id #workload_id} => String
858
+ # * {Types::GetLensReviewOutput#milestone_number #milestone_number} => Integer
859
+ # * {Types::GetLensReviewOutput#lens_review #lens_review} => Types::LensReview
860
+ #
861
+ # @example Request syntax with placeholder values
862
+ #
863
+ # resp = client.get_lens_review({
864
+ # workload_id: "WorkloadId", # required
865
+ # lens_alias: "LensAlias", # required
866
+ # milestone_number: 1,
867
+ # })
868
+ #
869
+ # @example Response structure
870
+ #
871
+ # resp.workload_id #=> String
872
+ # resp.milestone_number #=> Integer
873
+ # resp.lens_review.lens_alias #=> String
874
+ # resp.lens_review.lens_version #=> String
875
+ # resp.lens_review.lens_name #=> String
876
+ # resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
877
+ # resp.lens_review.pillar_review_summaries #=> Array
878
+ # resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
879
+ # resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
880
+ # resp.lens_review.pillar_review_summaries[0].notes #=> String
881
+ # resp.lens_review.pillar_review_summaries[0].risk_counts #=> Hash
882
+ # resp.lens_review.pillar_review_summaries[0].risk_counts["Risk"] #=> Integer
883
+ # resp.lens_review.updated_at #=> Time
884
+ # resp.lens_review.notes #=> String
885
+ # resp.lens_review.risk_counts #=> Hash
886
+ # resp.lens_review.risk_counts["Risk"] #=> Integer
887
+ # resp.lens_review.next_token #=> String
888
+ #
889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReview AWS API Documentation
890
+ #
891
+ # @overload get_lens_review(params = {})
892
+ # @param [Hash] params ({})
893
+ def get_lens_review(params = {}, options = {})
894
+ req = build_request(:get_lens_review, params)
895
+ req.send_request(options)
896
+ end
897
+
898
+ # Get lens review report.
899
+ #
900
+ # @option params [required, String] :workload_id
901
+ # The ID assigned to the workload. This ID is unique within an AWS
902
+ # Region.
903
+ #
904
+ # @option params [required, String] :lens_alias
905
+ # The alias of the lens, for example, `serverless`.
906
+ #
907
+ # Each lens is identified by its LensSummary$LensAlias.
908
+ #
909
+ # @option params [Integer] :milestone_number
910
+ # The milestone number.
911
+ #
912
+ # A workload can have a maximum of 100 milestones.
913
+ #
914
+ # @return [Types::GetLensReviewReportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
915
+ #
916
+ # * {Types::GetLensReviewReportOutput#workload_id #workload_id} => String
917
+ # * {Types::GetLensReviewReportOutput#milestone_number #milestone_number} => Integer
918
+ # * {Types::GetLensReviewReportOutput#lens_review_report #lens_review_report} => Types::LensReviewReport
919
+ #
920
+ # @example Request syntax with placeholder values
921
+ #
922
+ # resp = client.get_lens_review_report({
923
+ # workload_id: "WorkloadId", # required
924
+ # lens_alias: "LensAlias", # required
925
+ # milestone_number: 1,
926
+ # })
927
+ #
928
+ # @example Response structure
929
+ #
930
+ # resp.workload_id #=> String
931
+ # resp.milestone_number #=> Integer
932
+ # resp.lens_review_report.lens_alias #=> String
933
+ # resp.lens_review_report.base_64_string #=> String
934
+ #
935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReviewReport AWS API Documentation
936
+ #
937
+ # @overload get_lens_review_report(params = {})
938
+ # @param [Hash] params ({})
939
+ def get_lens_review_report(params = {}, options = {})
940
+ req = build_request(:get_lens_review_report, params)
941
+ req.send_request(options)
942
+ end
943
+
944
+ # Get lens version differences.
945
+ #
946
+ # @option params [required, String] :lens_alias
947
+ # The alias of the lens, for example, `serverless`.
948
+ #
949
+ # Each lens is identified by its LensSummary$LensAlias.
950
+ #
951
+ # @option params [required, String] :base_lens_version
952
+ # The base version of the lens.
953
+ #
954
+ # @return [Types::GetLensVersionDifferenceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
955
+ #
956
+ # * {Types::GetLensVersionDifferenceOutput#lens_alias #lens_alias} => String
957
+ # * {Types::GetLensVersionDifferenceOutput#base_lens_version #base_lens_version} => String
958
+ # * {Types::GetLensVersionDifferenceOutput#latest_lens_version #latest_lens_version} => String
959
+ # * {Types::GetLensVersionDifferenceOutput#version_differences #version_differences} => Types::VersionDifferences
960
+ #
961
+ # @example Request syntax with placeholder values
962
+ #
963
+ # resp = client.get_lens_version_difference({
964
+ # lens_alias: "LensAlias", # required
965
+ # base_lens_version: "LensVersion", # required
966
+ # })
967
+ #
968
+ # @example Response structure
969
+ #
970
+ # resp.lens_alias #=> String
971
+ # resp.base_lens_version #=> String
972
+ # resp.latest_lens_version #=> String
973
+ # resp.version_differences.pillar_differences #=> Array
974
+ # resp.version_differences.pillar_differences[0].pillar_id #=> String
975
+ # resp.version_differences.pillar_differences[0].difference_status #=> String, one of "UPDATED", "NEW", "DELETED"
976
+ # resp.version_differences.pillar_differences[0].question_differences #=> Array
977
+ # resp.version_differences.pillar_differences[0].question_differences[0].question_id #=> String
978
+ # resp.version_differences.pillar_differences[0].question_differences[0].question_title #=> String
979
+ # resp.version_differences.pillar_differences[0].question_differences[0].difference_status #=> String, one of "UPDATED", "NEW", "DELETED"
980
+ #
981
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensVersionDifference AWS API Documentation
982
+ #
983
+ # @overload get_lens_version_difference(params = {})
984
+ # @param [Hash] params ({})
985
+ def get_lens_version_difference(params = {}, options = {})
986
+ req = build_request(:get_lens_version_difference, params)
987
+ req.send_request(options)
988
+ end
989
+
990
+ # Get a milestone for an existing workload.
991
+ #
992
+ # @option params [required, String] :workload_id
993
+ # The ID assigned to the workload. This ID is unique within an AWS
994
+ # Region.
995
+ #
996
+ # @option params [required, Integer] :milestone_number
997
+ # The milestone number.
998
+ #
999
+ # A workload can have a maximum of 100 milestones.
1000
+ #
1001
+ # @return [Types::GetMilestoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1002
+ #
1003
+ # * {Types::GetMilestoneOutput#workload_id #workload_id} => String
1004
+ # * {Types::GetMilestoneOutput#milestone #milestone} => Types::Milestone
1005
+ #
1006
+ # @example Request syntax with placeholder values
1007
+ #
1008
+ # resp = client.get_milestone({
1009
+ # workload_id: "WorkloadId", # required
1010
+ # milestone_number: 1, # required
1011
+ # })
1012
+ #
1013
+ # @example Response structure
1014
+ #
1015
+ # resp.workload_id #=> String
1016
+ # resp.milestone.milestone_number #=> Integer
1017
+ # resp.milestone.milestone_name #=> String
1018
+ # resp.milestone.recorded_at #=> Time
1019
+ # resp.milestone.workload.workload_id #=> String
1020
+ # resp.milestone.workload.workload_arn #=> String
1021
+ # resp.milestone.workload.workload_name #=> String
1022
+ # resp.milestone.workload.description #=> String
1023
+ # resp.milestone.workload.environment #=> String, one of "PRODUCTION", "PREPRODUCTION"
1024
+ # resp.milestone.workload.updated_at #=> Time
1025
+ # resp.milestone.workload.account_ids #=> Array
1026
+ # resp.milestone.workload.account_ids[0] #=> String
1027
+ # resp.milestone.workload.aws_regions #=> Array
1028
+ # resp.milestone.workload.aws_regions[0] #=> String
1029
+ # resp.milestone.workload.non_aws_regions #=> Array
1030
+ # resp.milestone.workload.non_aws_regions[0] #=> String
1031
+ # resp.milestone.workload.architectural_design #=> String
1032
+ # resp.milestone.workload.review_owner #=> String
1033
+ # resp.milestone.workload.review_restriction_date #=> Time
1034
+ # resp.milestone.workload.is_review_owner_update_acknowledged #=> Boolean
1035
+ # resp.milestone.workload.industry_type #=> String
1036
+ # resp.milestone.workload.industry #=> String
1037
+ # resp.milestone.workload.notes #=> String
1038
+ # resp.milestone.workload.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
1039
+ # resp.milestone.workload.risk_counts #=> Hash
1040
+ # resp.milestone.workload.risk_counts["Risk"] #=> Integer
1041
+ # resp.milestone.workload.pillar_priorities #=> Array
1042
+ # resp.milestone.workload.pillar_priorities[0] #=> String
1043
+ # resp.milestone.workload.lenses #=> Array
1044
+ # resp.milestone.workload.lenses[0] #=> String
1045
+ # resp.milestone.workload.owner #=> String
1046
+ # resp.milestone.workload.share_invitation_id #=> String
1047
+ #
1048
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetMilestone AWS API Documentation
1049
+ #
1050
+ # @overload get_milestone(params = {})
1051
+ # @param [Hash] params ({})
1052
+ def get_milestone(params = {}, options = {})
1053
+ req = build_request(:get_milestone, params)
1054
+ req.send_request(options)
1055
+ end
1056
+
1057
+ # Get an existing workload.
1058
+ #
1059
+ # @option params [required, String] :workload_id
1060
+ # The ID assigned to the workload. This ID is unique within an AWS
1061
+ # Region.
1062
+ #
1063
+ # @return [Types::GetWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1064
+ #
1065
+ # * {Types::GetWorkloadOutput#workload #workload} => Types::Workload
1066
+ #
1067
+ # @example Request syntax with placeholder values
1068
+ #
1069
+ # resp = client.get_workload({
1070
+ # workload_id: "WorkloadId", # required
1071
+ # })
1072
+ #
1073
+ # @example Response structure
1074
+ #
1075
+ # resp.workload.workload_id #=> String
1076
+ # resp.workload.workload_arn #=> String
1077
+ # resp.workload.workload_name #=> String
1078
+ # resp.workload.description #=> String
1079
+ # resp.workload.environment #=> String, one of "PRODUCTION", "PREPRODUCTION"
1080
+ # resp.workload.updated_at #=> Time
1081
+ # resp.workload.account_ids #=> Array
1082
+ # resp.workload.account_ids[0] #=> String
1083
+ # resp.workload.aws_regions #=> Array
1084
+ # resp.workload.aws_regions[0] #=> String
1085
+ # resp.workload.non_aws_regions #=> Array
1086
+ # resp.workload.non_aws_regions[0] #=> String
1087
+ # resp.workload.architectural_design #=> String
1088
+ # resp.workload.review_owner #=> String
1089
+ # resp.workload.review_restriction_date #=> Time
1090
+ # resp.workload.is_review_owner_update_acknowledged #=> Boolean
1091
+ # resp.workload.industry_type #=> String
1092
+ # resp.workload.industry #=> String
1093
+ # resp.workload.notes #=> String
1094
+ # resp.workload.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
1095
+ # resp.workload.risk_counts #=> Hash
1096
+ # resp.workload.risk_counts["Risk"] #=> Integer
1097
+ # resp.workload.pillar_priorities #=> Array
1098
+ # resp.workload.pillar_priorities[0] #=> String
1099
+ # resp.workload.lenses #=> Array
1100
+ # resp.workload.lenses[0] #=> String
1101
+ # resp.workload.owner #=> String
1102
+ # resp.workload.share_invitation_id #=> String
1103
+ #
1104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkload AWS API Documentation
1105
+ #
1106
+ # @overload get_workload(params = {})
1107
+ # @param [Hash] params ({})
1108
+ def get_workload(params = {}, options = {})
1109
+ req = build_request(:get_workload, params)
1110
+ req.send_request(options)
1111
+ end
1112
+
1113
+ # List of answers.
1114
+ #
1115
+ # @option params [required, String] :workload_id
1116
+ # The ID assigned to the workload. This ID is unique within an AWS
1117
+ # Region.
1118
+ #
1119
+ # @option params [required, String] :lens_alias
1120
+ # The alias of the lens, for example, `serverless`.
1121
+ #
1122
+ # Each lens is identified by its LensSummary$LensAlias.
1123
+ #
1124
+ # @option params [String] :pillar_id
1125
+ # The ID used to identify a pillar, for example, `security`.
1126
+ #
1127
+ # A pillar is identified by its PillarReviewSummary$PillarId.
1128
+ #
1129
+ # @option params [Integer] :milestone_number
1130
+ # The milestone number.
1131
+ #
1132
+ # A workload can have a maximum of 100 milestones.
1133
+ #
1134
+ # @option params [String] :next_token
1135
+ # The token to use to retrieve the next set of results.
1136
+ #
1137
+ # @option params [Integer] :max_results
1138
+ # The maximum number of results to return for this request.
1139
+ #
1140
+ # @return [Types::ListAnswersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1141
+ #
1142
+ # * {Types::ListAnswersOutput#workload_id #workload_id} => String
1143
+ # * {Types::ListAnswersOutput#milestone_number #milestone_number} => Integer
1144
+ # * {Types::ListAnswersOutput#lens_alias #lens_alias} => String
1145
+ # * {Types::ListAnswersOutput#answer_summaries #answer_summaries} => Array&lt;Types::AnswerSummary&gt;
1146
+ # * {Types::ListAnswersOutput#next_token #next_token} => String
1147
+ #
1148
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1149
+ #
1150
+ # @example Request syntax with placeholder values
1151
+ #
1152
+ # resp = client.list_answers({
1153
+ # workload_id: "WorkloadId", # required
1154
+ # lens_alias: "LensAlias", # required
1155
+ # pillar_id: "PillarId",
1156
+ # milestone_number: 1,
1157
+ # next_token: "NextToken",
1158
+ # max_results: 1,
1159
+ # })
1160
+ #
1161
+ # @example Response structure
1162
+ #
1163
+ # resp.workload_id #=> String
1164
+ # resp.milestone_number #=> Integer
1165
+ # resp.lens_alias #=> String
1166
+ # resp.answer_summaries #=> Array
1167
+ # resp.answer_summaries[0].question_id #=> String
1168
+ # resp.answer_summaries[0].pillar_id #=> String
1169
+ # resp.answer_summaries[0].question_title #=> String
1170
+ # resp.answer_summaries[0].choices #=> Array
1171
+ # resp.answer_summaries[0].choices[0].choice_id #=> String
1172
+ # resp.answer_summaries[0].choices[0].title #=> String
1173
+ # resp.answer_summaries[0].choices[0].description #=> String
1174
+ # resp.answer_summaries[0].selected_choices #=> Array
1175
+ # resp.answer_summaries[0].selected_choices[0] #=> String
1176
+ # resp.answer_summaries[0].is_applicable #=> Boolean
1177
+ # resp.answer_summaries[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
1178
+ # resp.next_token #=> String
1179
+ #
1180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListAnswers AWS API Documentation
1181
+ #
1182
+ # @overload list_answers(params = {})
1183
+ # @param [Hash] params ({})
1184
+ def list_answers(params = {}, options = {})
1185
+ req = build_request(:list_answers, params)
1186
+ req.send_request(options)
1187
+ end
1188
+
1189
+ # List lens review improvements.
1190
+ #
1191
+ # @option params [required, String] :workload_id
1192
+ # The ID assigned to the workload. This ID is unique within an AWS
1193
+ # Region.
1194
+ #
1195
+ # @option params [required, String] :lens_alias
1196
+ # The alias of the lens, for example, `serverless`.
1197
+ #
1198
+ # Each lens is identified by its LensSummary$LensAlias.
1199
+ #
1200
+ # @option params [String] :pillar_id
1201
+ # The ID used to identify a pillar, for example, `security`.
1202
+ #
1203
+ # A pillar is identified by its PillarReviewSummary$PillarId.
1204
+ #
1205
+ # @option params [Integer] :milestone_number
1206
+ # The milestone number.
1207
+ #
1208
+ # A workload can have a maximum of 100 milestones.
1209
+ #
1210
+ # @option params [String] :next_token
1211
+ # The token to use to retrieve the next set of results.
1212
+ #
1213
+ # @option params [Integer] :max_results
1214
+ # The maximum number of results to return for this request.
1215
+ #
1216
+ # @return [Types::ListLensReviewImprovementsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1217
+ #
1218
+ # * {Types::ListLensReviewImprovementsOutput#workload_id #workload_id} => String
1219
+ # * {Types::ListLensReviewImprovementsOutput#milestone_number #milestone_number} => Integer
1220
+ # * {Types::ListLensReviewImprovementsOutput#lens_alias #lens_alias} => String
1221
+ # * {Types::ListLensReviewImprovementsOutput#improvement_summaries #improvement_summaries} => Array&lt;Types::ImprovementSummary&gt;
1222
+ # * {Types::ListLensReviewImprovementsOutput#next_token #next_token} => String
1223
+ #
1224
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1225
+ #
1226
+ # @example Request syntax with placeholder values
1227
+ #
1228
+ # resp = client.list_lens_review_improvements({
1229
+ # workload_id: "WorkloadId", # required
1230
+ # lens_alias: "LensAlias", # required
1231
+ # pillar_id: "PillarId",
1232
+ # milestone_number: 1,
1233
+ # next_token: "NextToken",
1234
+ # max_results: 1,
1235
+ # })
1236
+ #
1237
+ # @example Response structure
1238
+ #
1239
+ # resp.workload_id #=> String
1240
+ # resp.milestone_number #=> Integer
1241
+ # resp.lens_alias #=> String
1242
+ # resp.improvement_summaries #=> Array
1243
+ # resp.improvement_summaries[0].question_id #=> String
1244
+ # resp.improvement_summaries[0].pillar_id #=> String
1245
+ # resp.improvement_summaries[0].question_title #=> String
1246
+ # resp.improvement_summaries[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
1247
+ # resp.improvement_summaries[0].improvement_plan_url #=> String
1248
+ # resp.next_token #=> String
1249
+ #
1250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovements AWS API Documentation
1251
+ #
1252
+ # @overload list_lens_review_improvements(params = {})
1253
+ # @param [Hash] params ({})
1254
+ def list_lens_review_improvements(params = {}, options = {})
1255
+ req = build_request(:list_lens_review_improvements, params)
1256
+ req.send_request(options)
1257
+ end
1258
+
1259
+ # List lens reviews.
1260
+ #
1261
+ # @option params [required, String] :workload_id
1262
+ # The ID assigned to the workload. This ID is unique within an AWS
1263
+ # Region.
1264
+ #
1265
+ # @option params [Integer] :milestone_number
1266
+ # The milestone number.
1267
+ #
1268
+ # A workload can have a maximum of 100 milestones.
1269
+ #
1270
+ # @option params [String] :next_token
1271
+ # The token to use to retrieve the next set of results.
1272
+ #
1273
+ # @option params [Integer] :max_results
1274
+ # The maximum number of results to return for this request.
1275
+ #
1276
+ # @return [Types::ListLensReviewsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1277
+ #
1278
+ # * {Types::ListLensReviewsOutput#workload_id #workload_id} => String
1279
+ # * {Types::ListLensReviewsOutput#milestone_number #milestone_number} => Integer
1280
+ # * {Types::ListLensReviewsOutput#lens_review_summaries #lens_review_summaries} => Array&lt;Types::LensReviewSummary&gt;
1281
+ # * {Types::ListLensReviewsOutput#next_token #next_token} => String
1282
+ #
1283
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1284
+ #
1285
+ # @example Request syntax with placeholder values
1286
+ #
1287
+ # resp = client.list_lens_reviews({
1288
+ # workload_id: "WorkloadId", # required
1289
+ # milestone_number: 1,
1290
+ # next_token: "NextToken",
1291
+ # max_results: 1,
1292
+ # })
1293
+ #
1294
+ # @example Response structure
1295
+ #
1296
+ # resp.workload_id #=> String
1297
+ # resp.milestone_number #=> Integer
1298
+ # resp.lens_review_summaries #=> Array
1299
+ # resp.lens_review_summaries[0].lens_alias #=> String
1300
+ # resp.lens_review_summaries[0].lens_version #=> String
1301
+ # resp.lens_review_summaries[0].lens_name #=> String
1302
+ # resp.lens_review_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
1303
+ # resp.lens_review_summaries[0].updated_at #=> Time
1304
+ # resp.lens_review_summaries[0].risk_counts #=> Hash
1305
+ # resp.lens_review_summaries[0].risk_counts["Risk"] #=> Integer
1306
+ # resp.next_token #=> String
1307
+ #
1308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviews AWS API Documentation
1309
+ #
1310
+ # @overload list_lens_reviews(params = {})
1311
+ # @param [Hash] params ({})
1312
+ def list_lens_reviews(params = {}, options = {})
1313
+ req = build_request(:list_lens_reviews, params)
1314
+ req.send_request(options)
1315
+ end
1316
+
1317
+ # List the available lenses.
1318
+ #
1319
+ # @option params [String] :next_token
1320
+ # The token to use to retrieve the next set of results.
1321
+ #
1322
+ # @option params [Integer] :max_results
1323
+ # The maximum number of results to return for this request.
1324
+ #
1325
+ # @return [Types::ListLensesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1326
+ #
1327
+ # * {Types::ListLensesOutput#lens_summaries #lens_summaries} => Array&lt;Types::LensSummary&gt;
1328
+ # * {Types::ListLensesOutput#next_token #next_token} => String
1329
+ #
1330
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1331
+ #
1332
+ # @example Request syntax with placeholder values
1333
+ #
1334
+ # resp = client.list_lenses({
1335
+ # next_token: "NextToken",
1336
+ # max_results: 1,
1337
+ # })
1338
+ #
1339
+ # @example Response structure
1340
+ #
1341
+ # resp.lens_summaries #=> Array
1342
+ # resp.lens_summaries[0].lens_alias #=> String
1343
+ # resp.lens_summaries[0].lens_version #=> String
1344
+ # resp.lens_summaries[0].lens_name #=> String
1345
+ # resp.lens_summaries[0].description #=> String
1346
+ # resp.next_token #=> String
1347
+ #
1348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLenses AWS API Documentation
1349
+ #
1350
+ # @overload list_lenses(params = {})
1351
+ # @param [Hash] params ({})
1352
+ def list_lenses(params = {}, options = {})
1353
+ req = build_request(:list_lenses, params)
1354
+ req.send_request(options)
1355
+ end
1356
+
1357
+ # List all milestones for an existing workload.
1358
+ #
1359
+ # @option params [required, String] :workload_id
1360
+ # The ID assigned to the workload. This ID is unique within an AWS
1361
+ # Region.
1362
+ #
1363
+ # @option params [String] :next_token
1364
+ # The token to use to retrieve the next set of results.
1365
+ #
1366
+ # @option params [Integer] :max_results
1367
+ # The maximum number of results to return for this request.
1368
+ #
1369
+ # @return [Types::ListMilestonesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1370
+ #
1371
+ # * {Types::ListMilestonesOutput#workload_id #workload_id} => String
1372
+ # * {Types::ListMilestonesOutput#milestone_summaries #milestone_summaries} => Array&lt;Types::MilestoneSummary&gt;
1373
+ # * {Types::ListMilestonesOutput#next_token #next_token} => String
1374
+ #
1375
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1376
+ #
1377
+ # @example Request syntax with placeholder values
1378
+ #
1379
+ # resp = client.list_milestones({
1380
+ # workload_id: "WorkloadId", # required
1381
+ # next_token: "NextToken",
1382
+ # max_results: 1,
1383
+ # })
1384
+ #
1385
+ # @example Response structure
1386
+ #
1387
+ # resp.workload_id #=> String
1388
+ # resp.milestone_summaries #=> Array
1389
+ # resp.milestone_summaries[0].milestone_number #=> Integer
1390
+ # resp.milestone_summaries[0].milestone_name #=> String
1391
+ # resp.milestone_summaries[0].recorded_at #=> Time
1392
+ # resp.milestone_summaries[0].workload_summary.workload_id #=> String
1393
+ # resp.milestone_summaries[0].workload_summary.workload_arn #=> String
1394
+ # resp.milestone_summaries[0].workload_summary.workload_name #=> String
1395
+ # resp.milestone_summaries[0].workload_summary.owner #=> String
1396
+ # resp.milestone_summaries[0].workload_summary.updated_at #=> Time
1397
+ # resp.milestone_summaries[0].workload_summary.lenses #=> Array
1398
+ # resp.milestone_summaries[0].workload_summary.lenses[0] #=> String
1399
+ # resp.milestone_summaries[0].workload_summary.risk_counts #=> Hash
1400
+ # resp.milestone_summaries[0].workload_summary.risk_counts["Risk"] #=> Integer
1401
+ # resp.milestone_summaries[0].workload_summary.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
1402
+ # resp.next_token #=> String
1403
+ #
1404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListMilestones AWS API Documentation
1405
+ #
1406
+ # @overload list_milestones(params = {})
1407
+ # @param [Hash] params ({})
1408
+ def list_milestones(params = {}, options = {})
1409
+ req = build_request(:list_milestones, params)
1410
+ req.send_request(options)
1411
+ end
1412
+
1413
+ # List lens notifications.
1414
+ #
1415
+ # @option params [String] :workload_id
1416
+ # The ID assigned to the workload. This ID is unique within an AWS
1417
+ # Region.
1418
+ #
1419
+ # @option params [String] :next_token
1420
+ # The token to use to retrieve the next set of results.
1421
+ #
1422
+ # @option params [Integer] :max_results
1423
+ # The maximum number of results to return for this request.
1424
+ #
1425
+ # @return [Types::ListNotificationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1426
+ #
1427
+ # * {Types::ListNotificationsOutput#notification_summaries #notification_summaries} => Array&lt;Types::NotificationSummary&gt;
1428
+ # * {Types::ListNotificationsOutput#next_token #next_token} => String
1429
+ #
1430
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1431
+ #
1432
+ # @example Request syntax with placeholder values
1433
+ #
1434
+ # resp = client.list_notifications({
1435
+ # workload_id: "WorkloadId",
1436
+ # next_token: "NextToken",
1437
+ # max_results: 1,
1438
+ # })
1439
+ #
1440
+ # @example Response structure
1441
+ #
1442
+ # resp.notification_summaries #=> Array
1443
+ # resp.notification_summaries[0].type #=> String, one of "LENS_VERSION_UPGRADED", "LENS_VERSION_DEPRECATED"
1444
+ # resp.notification_summaries[0].lens_upgrade_summary.workload_id #=> String
1445
+ # resp.notification_summaries[0].lens_upgrade_summary.workload_name #=> String
1446
+ # resp.notification_summaries[0].lens_upgrade_summary.lens_alias #=> String
1447
+ # resp.notification_summaries[0].lens_upgrade_summary.current_lens_version #=> String
1448
+ # resp.notification_summaries[0].lens_upgrade_summary.latest_lens_version #=> String
1449
+ # resp.next_token #=> String
1450
+ #
1451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListNotifications AWS API Documentation
1452
+ #
1453
+ # @overload list_notifications(params = {})
1454
+ # @param [Hash] params ({})
1455
+ def list_notifications(params = {}, options = {})
1456
+ req = build_request(:list_notifications, params)
1457
+ req.send_request(options)
1458
+ end
1459
+
1460
+ # List the workload invitations.
1461
+ #
1462
+ # @option params [String] :workload_name_prefix
1463
+ # An optional string added to the beginning of each workload name
1464
+ # returned in the results.
1465
+ #
1466
+ # @option params [String] :next_token
1467
+ # The token to use to retrieve the next set of results.
1468
+ #
1469
+ # @option params [Integer] :max_results
1470
+ # The maximum number of results to return for this request.
1471
+ #
1472
+ # @return [Types::ListShareInvitationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1473
+ #
1474
+ # * {Types::ListShareInvitationsOutput#share_invitation_summaries #share_invitation_summaries} => Array&lt;Types::ShareInvitationSummary&gt;
1475
+ # * {Types::ListShareInvitationsOutput#next_token #next_token} => String
1476
+ #
1477
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1478
+ #
1479
+ # @example Request syntax with placeholder values
1480
+ #
1481
+ # resp = client.list_share_invitations({
1482
+ # workload_name_prefix: "WorkloadNamePrefix",
1483
+ # next_token: "NextToken",
1484
+ # max_results: 1,
1485
+ # })
1486
+ #
1487
+ # @example Response structure
1488
+ #
1489
+ # resp.share_invitation_summaries #=> Array
1490
+ # resp.share_invitation_summaries[0].share_invitation_id #=> String
1491
+ # resp.share_invitation_summaries[0].shared_by #=> String
1492
+ # resp.share_invitation_summaries[0].shared_with #=> String
1493
+ # resp.share_invitation_summaries[0].permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
1494
+ # resp.share_invitation_summaries[0].workload_name #=> String
1495
+ # resp.share_invitation_summaries[0].workload_id #=> String
1496
+ # resp.next_token #=> String
1497
+ #
1498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitations AWS API Documentation
1499
+ #
1500
+ # @overload list_share_invitations(params = {})
1501
+ # @param [Hash] params ({})
1502
+ def list_share_invitations(params = {}, options = {})
1503
+ req = build_request(:list_share_invitations, params)
1504
+ req.send_request(options)
1505
+ end
1506
+
1507
+ # List the workload shares associated with the workload.
1508
+ #
1509
+ # @option params [required, String] :workload_id
1510
+ # The ID assigned to the workload. This ID is unique within an AWS
1511
+ # Region.
1512
+ #
1513
+ # @option params [String] :shared_with_prefix
1514
+ # The AWS account ID or IAM role with which the workload is shared.
1515
+ #
1516
+ # @option params [String] :next_token
1517
+ # The token to use to retrieve the next set of results.
1518
+ #
1519
+ # @option params [Integer] :max_results
1520
+ # The maximum number of results to return for this request.
1521
+ #
1522
+ # @return [Types::ListWorkloadSharesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1523
+ #
1524
+ # * {Types::ListWorkloadSharesOutput#workload_id #workload_id} => String
1525
+ # * {Types::ListWorkloadSharesOutput#workload_share_summaries #workload_share_summaries} => Array&lt;Types::WorkloadShareSummary&gt;
1526
+ # * {Types::ListWorkloadSharesOutput#next_token #next_token} => String
1527
+ #
1528
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1529
+ #
1530
+ # @example Request syntax with placeholder values
1531
+ #
1532
+ # resp = client.list_workload_shares({
1533
+ # workload_id: "WorkloadId", # required
1534
+ # shared_with_prefix: "SharedWithPrefix",
1535
+ # next_token: "NextToken",
1536
+ # max_results: 1,
1537
+ # })
1538
+ #
1539
+ # @example Response structure
1540
+ #
1541
+ # resp.workload_id #=> String
1542
+ # resp.workload_share_summaries #=> Array
1543
+ # resp.workload_share_summaries[0].share_id #=> String
1544
+ # resp.workload_share_summaries[0].shared_with #=> String
1545
+ # resp.workload_share_summaries[0].permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
1546
+ # resp.workload_share_summaries[0].status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED"
1547
+ # resp.next_token #=> String
1548
+ #
1549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadShares AWS API Documentation
1550
+ #
1551
+ # @overload list_workload_shares(params = {})
1552
+ # @param [Hash] params ({})
1553
+ def list_workload_shares(params = {}, options = {})
1554
+ req = build_request(:list_workload_shares, params)
1555
+ req.send_request(options)
1556
+ end
1557
+
1558
+ # List workloads. Paginated.
1559
+ #
1560
+ # @option params [String] :workload_name_prefix
1561
+ # An optional string added to the beginning of each workload name
1562
+ # returned in the results.
1563
+ #
1564
+ # @option params [String] :next_token
1565
+ # The token to use to retrieve the next set of results.
1566
+ #
1567
+ # @option params [Integer] :max_results
1568
+ # The maximum number of results to return for this request.
1569
+ #
1570
+ # @return [Types::ListWorkloadsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1571
+ #
1572
+ # * {Types::ListWorkloadsOutput#workload_summaries #workload_summaries} => Array&lt;Types::WorkloadSummary&gt;
1573
+ # * {Types::ListWorkloadsOutput#next_token #next_token} => String
1574
+ #
1575
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1576
+ #
1577
+ # @example Request syntax with placeholder values
1578
+ #
1579
+ # resp = client.list_workloads({
1580
+ # workload_name_prefix: "WorkloadNamePrefix",
1581
+ # next_token: "NextToken",
1582
+ # max_results: 1,
1583
+ # })
1584
+ #
1585
+ # @example Response structure
1586
+ #
1587
+ # resp.workload_summaries #=> Array
1588
+ # resp.workload_summaries[0].workload_id #=> String
1589
+ # resp.workload_summaries[0].workload_arn #=> String
1590
+ # resp.workload_summaries[0].workload_name #=> String
1591
+ # resp.workload_summaries[0].owner #=> String
1592
+ # resp.workload_summaries[0].updated_at #=> Time
1593
+ # resp.workload_summaries[0].lenses #=> Array
1594
+ # resp.workload_summaries[0].lenses[0] #=> String
1595
+ # resp.workload_summaries[0].risk_counts #=> Hash
1596
+ # resp.workload_summaries[0].risk_counts["Risk"] #=> Integer
1597
+ # resp.workload_summaries[0].improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
1598
+ # resp.next_token #=> String
1599
+ #
1600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloads AWS API Documentation
1601
+ #
1602
+ # @overload list_workloads(params = {})
1603
+ # @param [Hash] params ({})
1604
+ def list_workloads(params = {}, options = {})
1605
+ req = build_request(:list_workloads, params)
1606
+ req.send_request(options)
1607
+ end
1608
+
1609
+ # Update the answer.
1610
+ #
1611
+ # @option params [required, String] :workload_id
1612
+ # The ID assigned to the workload. This ID is unique within an AWS
1613
+ # Region.
1614
+ #
1615
+ # @option params [required, String] :lens_alias
1616
+ # The alias of the lens, for example, `serverless`.
1617
+ #
1618
+ # Each lens is identified by its LensSummary$LensAlias.
1619
+ #
1620
+ # @option params [required, String] :question_id
1621
+ # The ID of the question.
1622
+ #
1623
+ # @option params [Array<String>] :selected_choices
1624
+ # List of selected choice IDs in a question answer.
1625
+ #
1626
+ # @option params [String] :notes
1627
+ # The notes associated with the workload.
1628
+ #
1629
+ # @option params [Boolean] :is_applicable
1630
+ # Defines whether this question is applicable to a lens review.
1631
+ #
1632
+ # @return [Types::UpdateAnswerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1633
+ #
1634
+ # * {Types::UpdateAnswerOutput#workload_id #workload_id} => String
1635
+ # * {Types::UpdateAnswerOutput#lens_alias #lens_alias} => String
1636
+ # * {Types::UpdateAnswerOutput#answer #answer} => Types::Answer
1637
+ #
1638
+ # @example Request syntax with placeholder values
1639
+ #
1640
+ # resp = client.update_answer({
1641
+ # workload_id: "WorkloadId", # required
1642
+ # lens_alias: "LensAlias", # required
1643
+ # question_id: "QuestionId", # required
1644
+ # selected_choices: ["ChoiceId"],
1645
+ # notes: "Notes",
1646
+ # is_applicable: false,
1647
+ # })
1648
+ #
1649
+ # @example Response structure
1650
+ #
1651
+ # resp.workload_id #=> String
1652
+ # resp.lens_alias #=> String
1653
+ # resp.answer.question_id #=> String
1654
+ # resp.answer.pillar_id #=> String
1655
+ # resp.answer.question_title #=> String
1656
+ # resp.answer.question_description #=> String
1657
+ # resp.answer.improvement_plan_url #=> String
1658
+ # resp.answer.helpful_resource_url #=> String
1659
+ # resp.answer.choices #=> Array
1660
+ # resp.answer.choices[0].choice_id #=> String
1661
+ # resp.answer.choices[0].title #=> String
1662
+ # resp.answer.choices[0].description #=> String
1663
+ # resp.answer.selected_choices #=> Array
1664
+ # resp.answer.selected_choices[0] #=> String
1665
+ # resp.answer.is_applicable #=> Boolean
1666
+ # resp.answer.risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
1667
+ # resp.answer.notes #=> String
1668
+ #
1669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateAnswer AWS API Documentation
1670
+ #
1671
+ # @overload update_answer(params = {})
1672
+ # @param [Hash] params ({})
1673
+ def update_answer(params = {}, options = {})
1674
+ req = build_request(:update_answer, params)
1675
+ req.send_request(options)
1676
+ end
1677
+
1678
+ # Update lens review.
1679
+ #
1680
+ # @option params [required, String] :workload_id
1681
+ # The ID assigned to the workload. This ID is unique within an AWS
1682
+ # Region.
1683
+ #
1684
+ # @option params [required, String] :lens_alias
1685
+ # The alias of the lens, for example, `serverless`.
1686
+ #
1687
+ # Each lens is identified by its LensSummary$LensAlias.
1688
+ #
1689
+ # @option params [String] :lens_notes
1690
+ # The notes associated with the workload.
1691
+ #
1692
+ # @option params [Hash<String,String>] :pillar_notes
1693
+ # List of pillar notes of a lens review in a workload.
1694
+ #
1695
+ # @return [Types::UpdateLensReviewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1696
+ #
1697
+ # * {Types::UpdateLensReviewOutput#workload_id #workload_id} => String
1698
+ # * {Types::UpdateLensReviewOutput#lens_review #lens_review} => Types::LensReview
1699
+ #
1700
+ # @example Request syntax with placeholder values
1701
+ #
1702
+ # resp = client.update_lens_review({
1703
+ # workload_id: "WorkloadId", # required
1704
+ # lens_alias: "LensAlias", # required
1705
+ # lens_notes: "Notes",
1706
+ # pillar_notes: {
1707
+ # "PillarId" => "Notes",
1708
+ # },
1709
+ # })
1710
+ #
1711
+ # @example Response structure
1712
+ #
1713
+ # resp.workload_id #=> String
1714
+ # resp.lens_review.lens_alias #=> String
1715
+ # resp.lens_review.lens_version #=> String
1716
+ # resp.lens_review.lens_name #=> String
1717
+ # resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
1718
+ # resp.lens_review.pillar_review_summaries #=> Array
1719
+ # resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
1720
+ # resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
1721
+ # resp.lens_review.pillar_review_summaries[0].notes #=> String
1722
+ # resp.lens_review.pillar_review_summaries[0].risk_counts #=> Hash
1723
+ # resp.lens_review.pillar_review_summaries[0].risk_counts["Risk"] #=> Integer
1724
+ # resp.lens_review.updated_at #=> Time
1725
+ # resp.lens_review.notes #=> String
1726
+ # resp.lens_review.risk_counts #=> Hash
1727
+ # resp.lens_review.risk_counts["Risk"] #=> Integer
1728
+ # resp.lens_review.next_token #=> String
1729
+ #
1730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateLensReview AWS API Documentation
1731
+ #
1732
+ # @overload update_lens_review(params = {})
1733
+ # @param [Hash] params ({})
1734
+ def update_lens_review(params = {}, options = {})
1735
+ req = build_request(:update_lens_review, params)
1736
+ req.send_request(options)
1737
+ end
1738
+
1739
+ # Update a workload invitation.
1740
+ #
1741
+ # @option params [required, String] :share_invitation_id
1742
+ # The ID assigned to the share invitation.
1743
+ #
1744
+ # @option params [required, String] :share_invitation_action
1745
+ # Share invitation action taken by contributor.
1746
+ #
1747
+ # @return [Types::UpdateShareInvitationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1748
+ #
1749
+ # * {Types::UpdateShareInvitationOutput#share_invitation #share_invitation} => Types::ShareInvitation
1750
+ #
1751
+ # @example Request syntax with placeholder values
1752
+ #
1753
+ # resp = client.update_share_invitation({
1754
+ # share_invitation_id: "ShareInvitationId", # required
1755
+ # share_invitation_action: "ACCEPT", # required, accepts ACCEPT, REJECT
1756
+ # })
1757
+ #
1758
+ # @example Response structure
1759
+ #
1760
+ # resp.share_invitation.share_invitation_id #=> String
1761
+ # resp.share_invitation.workload_id #=> String
1762
+ #
1763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitation AWS API Documentation
1764
+ #
1765
+ # @overload update_share_invitation(params = {})
1766
+ # @param [Hash] params ({})
1767
+ def update_share_invitation(params = {}, options = {})
1768
+ req = build_request(:update_share_invitation, params)
1769
+ req.send_request(options)
1770
+ end
1771
+
1772
+ # Update an existing workload.
1773
+ #
1774
+ # @option params [required, String] :workload_id
1775
+ # The ID assigned to the workload. This ID is unique within an AWS
1776
+ # Region.
1777
+ #
1778
+ # @option params [String] :workload_name
1779
+ # The name of the workload.
1780
+ #
1781
+ # The name must be unique within an account within a Region. Spaces and
1782
+ # capitalization are ignored when checking for uniqueness.
1783
+ #
1784
+ # @option params [String] :description
1785
+ # The description for the workload.
1786
+ #
1787
+ # @option params [String] :environment
1788
+ # The environment for the workload.
1789
+ #
1790
+ # @option params [Array<String>] :account_ids
1791
+ # The list of AWS account IDs associated with the workload.
1792
+ #
1793
+ # @option params [Array<String>] :aws_regions
1794
+ # The list of AWS Regions associated with the workload, for example,
1795
+ # `us-east-2`, or `ca-central-1`.
1796
+ #
1797
+ # @option params [Array<String>] :non_aws_regions
1798
+ # The list of non-AWS Regions associated with the workload.
1799
+ #
1800
+ # @option params [Array<String>] :pillar_priorities
1801
+ # The priorities of the pillars, which are used to order items in the
1802
+ # improvement plan. Each pillar is represented by its
1803
+ # PillarReviewSummary$PillarId.
1804
+ #
1805
+ # @option params [String] :architectural_design
1806
+ # The URL of the architectural design for the workload.
1807
+ #
1808
+ # @option params [String] :review_owner
1809
+ # The review owner of the workload. The name, email address, or
1810
+ # identifier for the primary group or individual that owns the workload
1811
+ # review process.
1812
+ #
1813
+ # @option params [Boolean] :is_review_owner_update_acknowledged
1814
+ # Flag indicating whether the workload owner has acknowledged that the
1815
+ # *Review owner* field is required.
1816
+ #
1817
+ # If a **Review owner** is not added to the workload within 60 days of
1818
+ # acknowledgement, access to the workload is restricted until an owner
1819
+ # is added.
1820
+ #
1821
+ # @option params [String] :industry_type
1822
+ # The industry type for the workload.
1823
+ #
1824
+ # If specified, must be one of the following:
1825
+ #
1826
+ # * `Agriculture`
1827
+ #
1828
+ # * `Automobile`
1829
+ #
1830
+ # * `Defense`
1831
+ #
1832
+ # * `Design and Engineering`
1833
+ #
1834
+ # * `Digital Advertising`
1835
+ #
1836
+ # * `Education`
1837
+ #
1838
+ # * `Environmental Protection`
1839
+ #
1840
+ # * `Financial Services`
1841
+ #
1842
+ # * `Gaming`
1843
+ #
1844
+ # * `General Public Services`
1845
+ #
1846
+ # * `Healthcare`
1847
+ #
1848
+ # * `Hospitality`
1849
+ #
1850
+ # * `InfoTech`
1851
+ #
1852
+ # * `Justice and Public Safety`
1853
+ #
1854
+ # * `Life Sciences`
1855
+ #
1856
+ # * `Manufacturing`
1857
+ #
1858
+ # * `Media & Entertainment`
1859
+ #
1860
+ # * `Mining & Resources`
1861
+ #
1862
+ # * `Oil & Gas`
1863
+ #
1864
+ # * `Power & Utilities`
1865
+ #
1866
+ # * `Professional Services`
1867
+ #
1868
+ # * `Real Estate & Construction`
1869
+ #
1870
+ # * `Retail & Wholesale`
1871
+ #
1872
+ # * `Social Protection`
1873
+ #
1874
+ # * `Telecommunications`
1875
+ #
1876
+ # * `Travel, Transportation & Logistics`
1877
+ #
1878
+ # * `Other`
1879
+ #
1880
+ # @option params [String] :industry
1881
+ # The industry for the workload.
1882
+ #
1883
+ # @option params [String] :notes
1884
+ # The notes associated with the workload.
1885
+ #
1886
+ # @option params [String] :improvement_status
1887
+ # The improvement status for a workload.
1888
+ #
1889
+ # @return [Types::UpdateWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1890
+ #
1891
+ # * {Types::UpdateWorkloadOutput#workload #workload} => Types::Workload
1892
+ #
1893
+ # @example Request syntax with placeholder values
1894
+ #
1895
+ # resp = client.update_workload({
1896
+ # workload_id: "WorkloadId", # required
1897
+ # workload_name: "WorkloadName",
1898
+ # description: "WorkloadDescription",
1899
+ # environment: "PRODUCTION", # accepts PRODUCTION, PREPRODUCTION
1900
+ # account_ids: ["AwsAccountId"],
1901
+ # aws_regions: ["AwsRegion"],
1902
+ # non_aws_regions: ["WorkloadNonAwsRegion"],
1903
+ # pillar_priorities: ["PillarId"],
1904
+ # architectural_design: "WorkloadArchitecturalDesign",
1905
+ # review_owner: "WorkloadReviewOwner",
1906
+ # is_review_owner_update_acknowledged: false,
1907
+ # industry_type: "WorkloadIndustryType",
1908
+ # industry: "WorkloadIndustry",
1909
+ # notes: "Notes",
1910
+ # improvement_status: "NOT_APPLICABLE", # accepts NOT_APPLICABLE, NOT_STARTED, IN_PROGRESS, COMPLETE, RISK_ACKNOWLEDGED
1911
+ # })
1912
+ #
1913
+ # @example Response structure
1914
+ #
1915
+ # resp.workload.workload_id #=> String
1916
+ # resp.workload.workload_arn #=> String
1917
+ # resp.workload.workload_name #=> String
1918
+ # resp.workload.description #=> String
1919
+ # resp.workload.environment #=> String, one of "PRODUCTION", "PREPRODUCTION"
1920
+ # resp.workload.updated_at #=> Time
1921
+ # resp.workload.account_ids #=> Array
1922
+ # resp.workload.account_ids[0] #=> String
1923
+ # resp.workload.aws_regions #=> Array
1924
+ # resp.workload.aws_regions[0] #=> String
1925
+ # resp.workload.non_aws_regions #=> Array
1926
+ # resp.workload.non_aws_regions[0] #=> String
1927
+ # resp.workload.architectural_design #=> String
1928
+ # resp.workload.review_owner #=> String
1929
+ # resp.workload.review_restriction_date #=> Time
1930
+ # resp.workload.is_review_owner_update_acknowledged #=> Boolean
1931
+ # resp.workload.industry_type #=> String
1932
+ # resp.workload.industry #=> String
1933
+ # resp.workload.notes #=> String
1934
+ # resp.workload.improvement_status #=> String, one of "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED"
1935
+ # resp.workload.risk_counts #=> Hash
1936
+ # resp.workload.risk_counts["Risk"] #=> Integer
1937
+ # resp.workload.pillar_priorities #=> Array
1938
+ # resp.workload.pillar_priorities[0] #=> String
1939
+ # resp.workload.lenses #=> Array
1940
+ # resp.workload.lenses[0] #=> String
1941
+ # resp.workload.owner #=> String
1942
+ # resp.workload.share_invitation_id #=> String
1943
+ #
1944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkload AWS API Documentation
1945
+ #
1946
+ # @overload update_workload(params = {})
1947
+ # @param [Hash] params ({})
1948
+ def update_workload(params = {}, options = {})
1949
+ req = build_request(:update_workload, params)
1950
+ req.send_request(options)
1951
+ end
1952
+
1953
+ # Update a workload share.
1954
+ #
1955
+ # @option params [required, String] :share_id
1956
+ # The ID associated with the workload share.
1957
+ #
1958
+ # @option params [required, String] :workload_id
1959
+ # The ID assigned to the workload. This ID is unique within an AWS
1960
+ # Region.
1961
+ #
1962
+ # @option params [required, String] :permission_type
1963
+ # Permission granted on a workload share.
1964
+ #
1965
+ # @return [Types::UpdateWorkloadShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1966
+ #
1967
+ # * {Types::UpdateWorkloadShareOutput#workload_id #workload_id} => String
1968
+ # * {Types::UpdateWorkloadShareOutput#workload_share #workload_share} => Types::WorkloadShare
1969
+ #
1970
+ # @example Request syntax with placeholder values
1971
+ #
1972
+ # resp = client.update_workload_share({
1973
+ # share_id: "ShareId", # required
1974
+ # workload_id: "WorkloadId", # required
1975
+ # permission_type: "READONLY", # required, accepts READONLY, CONTRIBUTOR
1976
+ # })
1977
+ #
1978
+ # @example Response structure
1979
+ #
1980
+ # resp.workload_id #=> String
1981
+ # resp.workload_share.share_id #=> String
1982
+ # resp.workload_share.shared_by #=> String
1983
+ # resp.workload_share.shared_with #=> String
1984
+ # resp.workload_share.permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
1985
+ # resp.workload_share.status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED"
1986
+ # resp.workload_share.workload_name #=> String
1987
+ # resp.workload_share.workload_id #=> String
1988
+ #
1989
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkloadShare AWS API Documentation
1990
+ #
1991
+ # @overload update_workload_share(params = {})
1992
+ # @param [Hash] params ({})
1993
+ def update_workload_share(params = {}, options = {})
1994
+ req = build_request(:update_workload_share, params)
1995
+ req.send_request(options)
1996
+ end
1997
+
1998
+ # Upgrade lens review.
1999
+ #
2000
+ # @option params [required, String] :workload_id
2001
+ # The ID assigned to the workload. This ID is unique within an AWS
2002
+ # Region.
2003
+ #
2004
+ # @option params [required, String] :lens_alias
2005
+ # The alias of the lens, for example, `serverless`.
2006
+ #
2007
+ # Each lens is identified by its LensSummary$LensAlias.
2008
+ #
2009
+ # @option params [required, String] :milestone_name
2010
+ # The name of the milestone in a workload.
2011
+ #
2012
+ # Milestone names must be unique within a workload.
2013
+ #
2014
+ # @option params [String] :client_request_token
2015
+ # A unique case-sensitive string used to ensure that this request is
2016
+ # idempotent (executes only once).
2017
+ #
2018
+ # You should not reuse the same token for other requests. If you retry a
2019
+ # request with the same client request token and the same parameters
2020
+ # after it has completed successfully, the result of the original
2021
+ # request is returned.
2022
+ #
2023
+ # This token is listed as required, however, if you do not specify it,
2024
+ # the AWS SDKs automatically generate one for you. If you are not using
2025
+ # the AWS SDK or the AWS CLI, you must provide this token or the request
2026
+ # will fail.
2027
+ #
2028
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2029
+ #
2030
+ # @example Request syntax with placeholder values
2031
+ #
2032
+ # resp = client.upgrade_lens_review({
2033
+ # workload_id: "WorkloadId", # required
2034
+ # lens_alias: "LensAlias", # required
2035
+ # milestone_name: "MilestoneName", # required
2036
+ # client_request_token: "ClientRequestToken",
2037
+ # })
2038
+ #
2039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpgradeLensReview AWS API Documentation
2040
+ #
2041
+ # @overload upgrade_lens_review(params = {})
2042
+ # @param [Hash] params ({})
2043
+ def upgrade_lens_review(params = {}, options = {})
2044
+ req = build_request(:upgrade_lens_review, params)
2045
+ req.send_request(options)
2046
+ end
2047
+
2048
+ # @!endgroup
2049
+
2050
+ # @param params ({})
2051
+ # @api private
2052
+ def build_request(operation_name, params = {})
2053
+ handlers = @handlers.for(operation_name)
2054
+ context = Seahorse::Client::RequestContext.new(
2055
+ operation_name: operation_name,
2056
+ operation: config.api.operation(operation_name),
2057
+ client: self,
2058
+ params: params,
2059
+ config: config)
2060
+ context[:gem_name] = 'aws-sdk-wellarchitected'
2061
+ context[:gem_version] = '1.0.0'
2062
+ Seahorse::Client::Request.new(handlers, context)
2063
+ end
2064
+
2065
+ # @api private
2066
+ # @deprecated
2067
+ def waiter_names
2068
+ []
2069
+ end
2070
+
2071
+ class << self
2072
+
2073
+ # @api private
2074
+ attr_reader :identifier
2075
+
2076
+ # @api private
2077
+ def errors_module
2078
+ Errors
2079
+ end
2080
+
2081
+ end
2082
+ end
2083
+ end