aws-sdk-launchwizard 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,793 @@
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/version-3/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/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/request_compression.rb'
32
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
33
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
34
+ require 'aws-sdk-core/plugins/sign.rb'
35
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
36
+
37
+ Aws::Plugins::GlobalConfiguration.add_identifier(:launchwizard)
38
+
39
+ module Aws::LaunchWizard
40
+ # An API client for LaunchWizard. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::LaunchWizard::Client.new(
43
+ # region: region_name,
44
+ # credentials: credentials,
45
+ # # ...
46
+ # )
47
+ #
48
+ # For details on configuring region and credentials see
49
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
50
+ #
51
+ # See {#initialize} for a full list of supported configuration options.
52
+ class Client < Seahorse::Client::Base
53
+
54
+ include Aws::ClientStubs
55
+
56
+ @identifier = :launchwizard
57
+
58
+ set_api(ClientApi::API)
59
+
60
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
61
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
62
+ add_plugin(Aws::Plugins::Logging)
63
+ add_plugin(Aws::Plugins::ParamConverter)
64
+ add_plugin(Aws::Plugins::ParamValidator)
65
+ add_plugin(Aws::Plugins::UserAgent)
66
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
67
+ add_plugin(Aws::Plugins::RetryErrors)
68
+ add_plugin(Aws::Plugins::GlobalConfiguration)
69
+ add_plugin(Aws::Plugins::RegionalEndpoint)
70
+ add_plugin(Aws::Plugins::EndpointDiscovery)
71
+ add_plugin(Aws::Plugins::EndpointPattern)
72
+ add_plugin(Aws::Plugins::ResponsePaging)
73
+ add_plugin(Aws::Plugins::StubResponses)
74
+ add_plugin(Aws::Plugins::IdempotencyToken)
75
+ add_plugin(Aws::Plugins::JsonvalueConverter)
76
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
77
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
78
+ add_plugin(Aws::Plugins::TransferEncoding)
79
+ add_plugin(Aws::Plugins::HttpChecksum)
80
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
81
+ add_plugin(Aws::Plugins::RequestCompression)
82
+ add_plugin(Aws::Plugins::DefaultsMode)
83
+ add_plugin(Aws::Plugins::RecursionDetection)
84
+ add_plugin(Aws::Plugins::Sign)
85
+ add_plugin(Aws::Plugins::Protocols::RestJson)
86
+ add_plugin(Aws::LaunchWizard::Plugins::Endpoints)
87
+
88
+ # @overload initialize(options)
89
+ # @param [Hash] options
90
+ # @option options [required, Aws::CredentialProvider] :credentials
91
+ # Your AWS credentials. This can be an instance of any one of the
92
+ # following classes:
93
+ #
94
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
95
+ # credentials.
96
+ #
97
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
98
+ # shared file, such as `~/.aws/config`.
99
+ #
100
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
101
+ #
102
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
103
+ # assume a role after providing credentials via the web.
104
+ #
105
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
106
+ # access token generated from `aws login`.
107
+ #
108
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
109
+ # process that outputs to stdout.
110
+ #
111
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
112
+ # from an EC2 IMDS on an EC2 instance.
113
+ #
114
+ # * `Aws::ECSCredentials` - Used for loading credentials from
115
+ # instances running in ECS.
116
+ #
117
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
118
+ # from the Cognito Identity service.
119
+ #
120
+ # When `:credentials` are not configured directly, the following
121
+ # locations will be searched for credentials:
122
+ #
123
+ # * `Aws.config[:credentials]`
124
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
125
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
126
+ # * `~/.aws/credentials`
127
+ # * `~/.aws/config`
128
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
129
+ # are very aggressive. Construct and pass an instance of
130
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
131
+ # enable retries and extended timeouts. Instance profile credential
132
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
133
+ # to true.
134
+ #
135
+ # @option options [required, String] :region
136
+ # The AWS region to connect to. The configured `:region` is
137
+ # used to determine the service `:endpoint`. When not passed,
138
+ # a default `:region` is searched for in the following locations:
139
+ #
140
+ # * `Aws.config[:region]`
141
+ # * `ENV['AWS_REGION']`
142
+ # * `ENV['AMAZON_REGION']`
143
+ # * `ENV['AWS_DEFAULT_REGION']`
144
+ # * `~/.aws/credentials`
145
+ # * `~/.aws/config`
146
+ #
147
+ # @option options [String] :access_key_id
148
+ #
149
+ # @option options [Boolean] :active_endpoint_cache (false)
150
+ # When set to `true`, a thread polling for endpoints will be running in
151
+ # the background every 60 secs (default). Defaults to `false`.
152
+ #
153
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
154
+ # Used only in `adaptive` retry mode. When true, the request will sleep
155
+ # until there is sufficent client side capacity to retry the request.
156
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
157
+ # not retry instead of sleeping.
158
+ #
159
+ # @option options [Boolean] :client_side_monitoring (false)
160
+ # When `true`, client-side metrics will be collected for all API requests from
161
+ # this client.
162
+ #
163
+ # @option options [String] :client_side_monitoring_client_id ("")
164
+ # Allows you to provide an identifier for this client which will be attached to
165
+ # all generated client side metrics. Defaults to an empty string.
166
+ #
167
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
168
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
169
+ # side monitoring agent is running on, where client metrics will be published via UDP.
170
+ #
171
+ # @option options [Integer] :client_side_monitoring_port (31000)
172
+ # Required for publishing client metrics. The port that the client side monitoring
173
+ # agent is running on, where client metrics will be published via UDP.
174
+ #
175
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
176
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
177
+ # will use the Client Side Monitoring Agent Publisher.
178
+ #
179
+ # @option options [Boolean] :convert_params (true)
180
+ # When `true`, an attempt is made to coerce request parameters into
181
+ # the required types.
182
+ #
183
+ # @option options [Boolean] :correct_clock_skew (true)
184
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
185
+ # a clock skew correction and retry requests with skewed client clocks.
186
+ #
187
+ # @option options [String] :defaults_mode ("legacy")
188
+ # See {Aws::DefaultsModeConfiguration} for a list of the
189
+ # accepted modes and the configuration defaults that are included.
190
+ #
191
+ # @option options [Boolean] :disable_host_prefix_injection (false)
192
+ # Set to true to disable SDK automatically adding host prefix
193
+ # to default service endpoint when available.
194
+ #
195
+ # @option options [Boolean] :disable_request_compression (false)
196
+ # When set to 'true' the request body will not be compressed
197
+ # for supported operations.
198
+ #
199
+ # @option options [String] :endpoint
200
+ # The client endpoint is normally constructed from the `:region`
201
+ # option. You should only configure an `:endpoint` when connecting
202
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
203
+ #
204
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
205
+ # Used for the maximum size limit of the LRU cache storing endpoints data
206
+ # for endpoint discovery enabled operations. Defaults to 1000.
207
+ #
208
+ # @option options [Integer] :endpoint_cache_max_threads (10)
209
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
210
+ #
211
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
212
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
213
+ # Use this option to config the time interval in seconds for making
214
+ # requests fetching endpoints information. Defaults to 60 sec.
215
+ #
216
+ # @option options [Boolean] :endpoint_discovery (false)
217
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
218
+ #
219
+ # @option options [Boolean] :ignore_configured_endpoint_urls
220
+ # Setting to true disables use of endpoint URLs provided via environment
221
+ # variables and the shared configuration file.
222
+ #
223
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
224
+ # The log formatter.
225
+ #
226
+ # @option options [Symbol] :log_level (:info)
227
+ # The log level to send messages to the `:logger` at.
228
+ #
229
+ # @option options [Logger] :logger
230
+ # The Logger instance to send log messages to. If this option
231
+ # is not set, logging will be disabled.
232
+ #
233
+ # @option options [Integer] :max_attempts (3)
234
+ # An integer representing the maximum number attempts that will be made for
235
+ # a single request, including the initial attempt. For example,
236
+ # setting this value to 5 will result in a request being retried up to
237
+ # 4 times. Used in `standard` and `adaptive` retry modes.
238
+ #
239
+ # @option options [String] :profile ("default")
240
+ # Used when loading credentials from the shared credentials file
241
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
242
+ #
243
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
244
+ # The minimum size in bytes that triggers compression for request
245
+ # bodies. The value must be non-negative integer value between 0
246
+ # and 10485780 bytes inclusive.
247
+ #
248
+ # @option options [Proc] :retry_backoff
249
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
250
+ # This option is only used in the `legacy` retry mode.
251
+ #
252
+ # @option options [Float] :retry_base_delay (0.3)
253
+ # The base delay in seconds used by the default backoff function. This option
254
+ # is only used in the `legacy` retry mode.
255
+ #
256
+ # @option options [Symbol] :retry_jitter (:none)
257
+ # A delay randomiser function used by the default backoff function.
258
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
259
+ # otherwise a Proc that takes and returns a number. This option is only used
260
+ # in the `legacy` retry mode.
261
+ #
262
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
263
+ #
264
+ # @option options [Integer] :retry_limit (3)
265
+ # The maximum number of times to retry failed requests. Only
266
+ # ~ 500 level server errors and certain ~ 400 level client errors
267
+ # are retried. Generally, these are throttling errors, data
268
+ # checksum errors, networking errors, timeout errors, auth errors,
269
+ # endpoint discovery, and errors from expired credentials.
270
+ # This option is only used in the `legacy` retry mode.
271
+ #
272
+ # @option options [Integer] :retry_max_delay (0)
273
+ # The maximum number of seconds to delay between retries (0 for no limit)
274
+ # used by the default backoff function. This option is only used in the
275
+ # `legacy` retry mode.
276
+ #
277
+ # @option options [String] :retry_mode ("legacy")
278
+ # Specifies which retry algorithm to use. Values are:
279
+ #
280
+ # * `legacy` - The pre-existing retry behavior. This is default value if
281
+ # no retry mode is provided.
282
+ #
283
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
284
+ # This includes support for retry quotas, which limit the number of
285
+ # unsuccessful retries a client can make.
286
+ #
287
+ # * `adaptive` - An experimental retry mode that includes all the
288
+ # functionality of `standard` mode along with automatic client side
289
+ # throttling. This is a provisional mode that may change behavior
290
+ # in the future.
291
+ #
292
+ #
293
+ # @option options [String] :sdk_ua_app_id
294
+ # A unique and opaque application ID that is appended to the
295
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
296
+ # maximum length of 50.
297
+ #
298
+ # @option options [String] :secret_access_key
299
+ #
300
+ # @option options [String] :session_token
301
+ #
302
+ # @option options [Boolean] :stub_responses (false)
303
+ # Causes the client to return stubbed responses. By default
304
+ # fake responses are generated and returned. You can specify
305
+ # the response data to return or errors to raise by calling
306
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
307
+ #
308
+ # ** Please note ** When response stubbing is enabled, no HTTP
309
+ # requests are made, and retries are disabled.
310
+ #
311
+ # @option options [Aws::TokenProvider] :token_provider
312
+ # A Bearer Token Provider. This can be an instance of any one of the
313
+ # following classes:
314
+ #
315
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
316
+ # tokens.
317
+ #
318
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
319
+ # access token generated from `aws login`.
320
+ #
321
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
322
+ # will be used to search for tokens configured for your profile in shared configuration files.
323
+ #
324
+ # @option options [Boolean] :use_dualstack_endpoint
325
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
326
+ # will be used if available.
327
+ #
328
+ # @option options [Boolean] :use_fips_endpoint
329
+ # When set to `true`, fips compatible endpoints will be used if available.
330
+ # When a `fips` region is used, the region is normalized and this config
331
+ # is set to `true`.
332
+ #
333
+ # @option options [Boolean] :validate_params (true)
334
+ # When `true`, request parameters are validated before
335
+ # sending the request.
336
+ #
337
+ # @option options [Aws::LaunchWizard::EndpointProvider] :endpoint_provider
338
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::LaunchWizard::EndpointParameters`
339
+ #
340
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
341
+ # requests through. Formatted like 'http://proxy.com:123'.
342
+ #
343
+ # @option options [Float] :http_open_timeout (15) The number of
344
+ # seconds to wait when opening a HTTP session before raising a
345
+ # `Timeout::Error`.
346
+ #
347
+ # @option options [Float] :http_read_timeout (60) The default
348
+ # number of seconds to wait for response data. This value can
349
+ # safely be set per-request on the session.
350
+ #
351
+ # @option options [Float] :http_idle_timeout (5) The number of
352
+ # seconds a connection is allowed to sit idle before it is
353
+ # considered stale. Stale connections are closed and removed
354
+ # from the pool before making a request.
355
+ #
356
+ # @option options [Float] :http_continue_timeout (1) The number of
357
+ # seconds to wait for a 100-continue response before sending the
358
+ # request body. This option has no effect unless the request has
359
+ # "Expect" header set to "100-continue". Defaults to `nil` which
360
+ # disables this behaviour. This value can safely be set per
361
+ # request on the session.
362
+ #
363
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
364
+ # in seconds.
365
+ #
366
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
367
+ # HTTP debug output will be sent to the `:logger`.
368
+ #
369
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
370
+ # SSL peer certificates are verified when establishing a
371
+ # connection.
372
+ #
373
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
374
+ # certificate authority bundle file that should be used when
375
+ # verifying peer certificates. If you do not pass
376
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
377
+ # will be used if available.
378
+ #
379
+ # @option options [String] :ssl_ca_directory Full path of the
380
+ # directory that contains the unbundled SSL certificate
381
+ # authority files for verifying peer certificates. If you do
382
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
383
+ # system default will be used if available.
384
+ #
385
+ def initialize(*args)
386
+ super
387
+ end
388
+
389
+ # @!group API Operations
390
+
391
+ # Creates a deployment for the given workload. Deployments created by
392
+ # this operation are not available in the Launch Wizard console to use
393
+ # the `Clone deployment` action on.
394
+ #
395
+ # @option params [required, String] :deployment_pattern_name
396
+ # The name of the deployment pattern supported by a given workload. You
397
+ # can use the [ `ListWorkloadDeploymentPatterns` ][1] operation to
398
+ # discover supported values for this parameter.
399
+ #
400
+ #
401
+ #
402
+ # [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html
403
+ #
404
+ # @option params [Boolean] :dry_run
405
+ # Checks whether you have the required permissions for the action,
406
+ # without actually making the request, and provides an error response.
407
+ # If you have the required permissions, the error response is
408
+ # `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.
409
+ #
410
+ # @option params [required, String] :name
411
+ # The name of the deployment.
412
+ #
413
+ # @option params [required, Hash<String,String>] :specifications
414
+ # The settings specified for the deployment. For more information on the
415
+ # specifications required for creating a deployment, see [Workload
416
+ # specifications][1].
417
+ #
418
+ #
419
+ #
420
+ # [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications.html
421
+ #
422
+ # @option params [required, String] :workload_name
423
+ # The name of the workload. You can use the [
424
+ # `ListWorkloadDeploymentPatterns` ][1] operation to discover supported
425
+ # values for this parameter.
426
+ #
427
+ #
428
+ #
429
+ # [1]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html
430
+ #
431
+ # @return [Types::CreateDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
432
+ #
433
+ # * {Types::CreateDeploymentOutput#deployment_id #deployment_id} => String
434
+ #
435
+ # @example Request syntax with placeholder values
436
+ #
437
+ # resp = client.create_deployment({
438
+ # deployment_pattern_name: "DeploymentPatternName", # required
439
+ # dry_run: false,
440
+ # name: "DeploymentName", # required
441
+ # specifications: { # required
442
+ # "KeyString" => "ValueString",
443
+ # },
444
+ # workload_name: "WorkloadName", # required
445
+ # })
446
+ #
447
+ # @example Response structure
448
+ #
449
+ # resp.deployment_id #=> String
450
+ #
451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/CreateDeployment AWS API Documentation
452
+ #
453
+ # @overload create_deployment(params = {})
454
+ # @param [Hash] params ({})
455
+ def create_deployment(params = {}, options = {})
456
+ req = build_request(:create_deployment, params)
457
+ req.send_request(options)
458
+ end
459
+
460
+ # Deletes a deployment.
461
+ #
462
+ # @option params [required, String] :deployment_id
463
+ # The ID of the deployment.
464
+ #
465
+ # @return [Types::DeleteDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
466
+ #
467
+ # * {Types::DeleteDeploymentOutput#status #status} => String
468
+ # * {Types::DeleteDeploymentOutput#status_reason #status_reason} => String
469
+ #
470
+ # @example Request syntax with placeholder values
471
+ #
472
+ # resp = client.delete_deployment({
473
+ # deployment_id: "DeploymentId", # required
474
+ # })
475
+ #
476
+ # @example Response structure
477
+ #
478
+ # resp.status #=> String, one of "COMPLETED", "CREATING", "DELETE_IN_PROGRESS", "DELETE_INITIATING", "DELETE_FAILED", "DELETED", "FAILED", "IN_PROGRESS", "VALIDATING"
479
+ # resp.status_reason #=> String
480
+ #
481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/DeleteDeployment AWS API Documentation
482
+ #
483
+ # @overload delete_deployment(params = {})
484
+ # @param [Hash] params ({})
485
+ def delete_deployment(params = {}, options = {})
486
+ req = build_request(:delete_deployment, params)
487
+ req.send_request(options)
488
+ end
489
+
490
+ # Returns information about the deployment.
491
+ #
492
+ # @option params [required, String] :deployment_id
493
+ # The ID of the deployment.
494
+ #
495
+ # @return [Types::GetDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
496
+ #
497
+ # * {Types::GetDeploymentOutput#deployment #deployment} => Types::DeploymentData
498
+ #
499
+ # @example Request syntax with placeholder values
500
+ #
501
+ # resp = client.get_deployment({
502
+ # deployment_id: "DeploymentId", # required
503
+ # })
504
+ #
505
+ # @example Response structure
506
+ #
507
+ # resp.deployment.created_at #=> Time
508
+ # resp.deployment.deleted_at #=> Time
509
+ # resp.deployment.id #=> String
510
+ # resp.deployment.name #=> String
511
+ # resp.deployment.pattern_name #=> String
512
+ # resp.deployment.resource_group #=> String
513
+ # resp.deployment.specifications #=> Hash
514
+ # resp.deployment.specifications["KeyString"] #=> String
515
+ # resp.deployment.status #=> String, one of "COMPLETED", "CREATING", "DELETE_IN_PROGRESS", "DELETE_INITIATING", "DELETE_FAILED", "DELETED", "FAILED", "IN_PROGRESS", "VALIDATING"
516
+ # resp.deployment.workload_name #=> String
517
+ #
518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetDeployment AWS API Documentation
519
+ #
520
+ # @overload get_deployment(params = {})
521
+ # @param [Hash] params ({})
522
+ def get_deployment(params = {}, options = {})
523
+ req = build_request(:get_deployment, params)
524
+ req.send_request(options)
525
+ end
526
+
527
+ # Returns information about a workload.
528
+ #
529
+ # @option params [required, String] :workload_name
530
+ # The name of the workload.
531
+ #
532
+ # @return [Types::GetWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
533
+ #
534
+ # * {Types::GetWorkloadOutput#workload #workload} => Types::WorkloadData
535
+ #
536
+ # @example Request syntax with placeholder values
537
+ #
538
+ # resp = client.get_workload({
539
+ # workload_name: "WorkloadName", # required
540
+ # })
541
+ #
542
+ # @example Response structure
543
+ #
544
+ # resp.workload.description #=> String
545
+ # resp.workload.display_name #=> String
546
+ # resp.workload.documentation_url #=> String
547
+ # resp.workload.icon_url #=> String
548
+ # resp.workload.status #=> String, one of "ACTIVE", "INACTIVE", "DISABLED", "DELETED"
549
+ # resp.workload.status_message #=> String
550
+ # resp.workload.workload_name #=> String
551
+ #
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetWorkload AWS API Documentation
553
+ #
554
+ # @overload get_workload(params = {})
555
+ # @param [Hash] params ({})
556
+ def get_workload(params = {}, options = {})
557
+ req = build_request(:get_workload, params)
558
+ req.send_request(options)
559
+ end
560
+
561
+ # Lists the events of a deployment.
562
+ #
563
+ # @option params [required, String] :deployment_id
564
+ # The ID of the deployment.
565
+ #
566
+ # @option params [Integer] :max_results
567
+ # The maximum number of items to return for this request. To get the
568
+ # next page of items, make another request with the token returned in
569
+ # the output.
570
+ #
571
+ # @option params [String] :next_token
572
+ # The token returned from a previous paginated request. Pagination
573
+ # continues from the end of the items returned by the previous request.
574
+ #
575
+ # @return [Types::ListDeploymentEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
576
+ #
577
+ # * {Types::ListDeploymentEventsOutput#deployment_events #deployment_events} => Array&lt;Types::DeploymentEventDataSummary&gt;
578
+ # * {Types::ListDeploymentEventsOutput#next_token #next_token} => String
579
+ #
580
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
581
+ #
582
+ # @example Request syntax with placeholder values
583
+ #
584
+ # resp = client.list_deployment_events({
585
+ # deployment_id: "DeploymentId", # required
586
+ # max_results: 1,
587
+ # next_token: "NextToken",
588
+ # })
589
+ #
590
+ # @example Response structure
591
+ #
592
+ # resp.deployment_events #=> Array
593
+ # resp.deployment_events[0].description #=> String
594
+ # resp.deployment_events[0].name #=> String
595
+ # resp.deployment_events[0].status #=> String, one of "CANCELED", "CANCELING", "COMPLETED", "CREATED", "FAILED", "IN_PROGRESS", "PENDING", "TIMED_OUT"
596
+ # resp.deployment_events[0].status_reason #=> String
597
+ # resp.deployment_events[0].timestamp #=> Time
598
+ # resp.next_token #=> String
599
+ #
600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeploymentEvents AWS API Documentation
601
+ #
602
+ # @overload list_deployment_events(params = {})
603
+ # @param [Hash] params ({})
604
+ def list_deployment_events(params = {}, options = {})
605
+ req = build_request(:list_deployment_events, params)
606
+ req.send_request(options)
607
+ end
608
+
609
+ # Lists the deployments that have been created.
610
+ #
611
+ # @option params [Array<Types::DeploymentFilter>] :filters
612
+ # Filters to scope the results. The following filters are supported:
613
+ #
614
+ # * `WORKLOAD_NAME`
615
+ #
616
+ # * `DEPLOYMENT_STATUS`
617
+ #
618
+ # @option params [Integer] :max_results
619
+ # The maximum number of items to return for this request. To get the
620
+ # next page of items, make another request with the token returned in
621
+ # the output.
622
+ #
623
+ # @option params [String] :next_token
624
+ # The token returned from a previous paginated request. Pagination
625
+ # continues from the end of the items returned by the previous request.
626
+ #
627
+ # @return [Types::ListDeploymentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
628
+ #
629
+ # * {Types::ListDeploymentsOutput#deployments #deployments} => Array&lt;Types::DeploymentDataSummary&gt;
630
+ # * {Types::ListDeploymentsOutput#next_token #next_token} => String
631
+ #
632
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
633
+ #
634
+ # @example Request syntax with placeholder values
635
+ #
636
+ # resp = client.list_deployments({
637
+ # filters: [
638
+ # {
639
+ # name: "WORKLOAD_NAME", # accepts WORKLOAD_NAME, DEPLOYMENT_STATUS
640
+ # values: ["DeploymentFilterValuesMemberString"],
641
+ # },
642
+ # ],
643
+ # max_results: 1,
644
+ # next_token: "NextToken",
645
+ # })
646
+ #
647
+ # @example Response structure
648
+ #
649
+ # resp.deployments #=> Array
650
+ # resp.deployments[0].created_at #=> Time
651
+ # resp.deployments[0].id #=> String
652
+ # resp.deployments[0].name #=> String
653
+ # resp.deployments[0].pattern_name #=> String
654
+ # resp.deployments[0].status #=> String, one of "COMPLETED", "CREATING", "DELETE_IN_PROGRESS", "DELETE_INITIATING", "DELETE_FAILED", "DELETED", "FAILED", "IN_PROGRESS", "VALIDATING"
655
+ # resp.deployments[0].workload_name #=> String
656
+ # resp.next_token #=> String
657
+ #
658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeployments AWS API Documentation
659
+ #
660
+ # @overload list_deployments(params = {})
661
+ # @param [Hash] params ({})
662
+ def list_deployments(params = {}, options = {})
663
+ req = build_request(:list_deployments, params)
664
+ req.send_request(options)
665
+ end
666
+
667
+ # Lists the workload deployment patterns.
668
+ #
669
+ # @option params [Integer] :max_results
670
+ # The maximum number of items to return for this request. To get the
671
+ # next page of items, make another request with the token returned in
672
+ # the output.
673
+ #
674
+ # @option params [String] :next_token
675
+ # The token returned from a previous paginated request. Pagination
676
+ # continues from the end of the items returned by the previous request.
677
+ #
678
+ # @option params [required, String] :workload_name
679
+ # The name of the workload.
680
+ #
681
+ # @return [Types::ListWorkloadDeploymentPatternsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
682
+ #
683
+ # * {Types::ListWorkloadDeploymentPatternsOutput#next_token #next_token} => String
684
+ # * {Types::ListWorkloadDeploymentPatternsOutput#workload_deployment_patterns #workload_deployment_patterns} => Array&lt;Types::WorkloadDeploymentPatternDataSummary&gt;
685
+ #
686
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
687
+ #
688
+ # @example Request syntax with placeholder values
689
+ #
690
+ # resp = client.list_workload_deployment_patterns({
691
+ # max_results: 1,
692
+ # next_token: "NextToken",
693
+ # workload_name: "WorkloadName", # required
694
+ # })
695
+ #
696
+ # @example Response structure
697
+ #
698
+ # resp.next_token #=> String
699
+ # resp.workload_deployment_patterns #=> Array
700
+ # resp.workload_deployment_patterns[0].deployment_pattern_name #=> String
701
+ # resp.workload_deployment_patterns[0].description #=> String
702
+ # resp.workload_deployment_patterns[0].display_name #=> String
703
+ # resp.workload_deployment_patterns[0].status #=> String, one of "ACTIVE", "INACTIVE", "DISABLED", "DELETED"
704
+ # resp.workload_deployment_patterns[0].status_message #=> String
705
+ # resp.workload_deployment_patterns[0].workload_name #=> String
706
+ # resp.workload_deployment_patterns[0].workload_version_name #=> String
707
+ #
708
+ # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloadDeploymentPatterns AWS API Documentation
709
+ #
710
+ # @overload list_workload_deployment_patterns(params = {})
711
+ # @param [Hash] params ({})
712
+ def list_workload_deployment_patterns(params = {}, options = {})
713
+ req = build_request(:list_workload_deployment_patterns, params)
714
+ req.send_request(options)
715
+ end
716
+
717
+ # Lists the workloads.
718
+ #
719
+ # @option params [Integer] :max_results
720
+ # The maximum number of items to return for this request. To get the
721
+ # next page of items, make another request with the token returned in
722
+ # the output.
723
+ #
724
+ # @option params [String] :next_token
725
+ # The token returned from a previous paginated request. Pagination
726
+ # continues from the end of the items returned by the previous request.
727
+ #
728
+ # @return [Types::ListWorkloadsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
729
+ #
730
+ # * {Types::ListWorkloadsOutput#next_token #next_token} => String
731
+ # * {Types::ListWorkloadsOutput#workloads #workloads} => Array&lt;Types::WorkloadDataSummary&gt;
732
+ #
733
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
734
+ #
735
+ # @example Request syntax with placeholder values
736
+ #
737
+ # resp = client.list_workloads({
738
+ # max_results: 1,
739
+ # next_token: "NextToken",
740
+ # })
741
+ #
742
+ # @example Response structure
743
+ #
744
+ # resp.next_token #=> String
745
+ # resp.workloads #=> Array
746
+ # resp.workloads[0].display_name #=> String
747
+ # resp.workloads[0].workload_name #=> String
748
+ #
749
+ # @see http://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloads AWS API Documentation
750
+ #
751
+ # @overload list_workloads(params = {})
752
+ # @param [Hash] params ({})
753
+ def list_workloads(params = {}, options = {})
754
+ req = build_request(:list_workloads, params)
755
+ req.send_request(options)
756
+ end
757
+
758
+ # @!endgroup
759
+
760
+ # @param params ({})
761
+ # @api private
762
+ def build_request(operation_name, params = {})
763
+ handlers = @handlers.for(operation_name)
764
+ context = Seahorse::Client::RequestContext.new(
765
+ operation_name: operation_name,
766
+ operation: config.api.operation(operation_name),
767
+ client: self,
768
+ params: params,
769
+ config: config)
770
+ context[:gem_name] = 'aws-sdk-launchwizard'
771
+ context[:gem_version] = '1.0.0'
772
+ Seahorse::Client::Request.new(handlers, context)
773
+ end
774
+
775
+ # @api private
776
+ # @deprecated
777
+ def waiter_names
778
+ []
779
+ end
780
+
781
+ class << self
782
+
783
+ # @api private
784
+ attr_reader :identifier
785
+
786
+ # @api private
787
+ def errors_module
788
+ Errors
789
+ end
790
+
791
+ end
792
+ end
793
+ end