aws-sdk-mainframemodernization 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1966 @@
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/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
33
+ require 'aws-sdk-core/plugins/signature_v4.rb'
34
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
+
36
+ Aws::Plugins::GlobalConfiguration.add_identifier(:mainframemodernization)
37
+
38
+ module Aws::MainframeModernization
39
+ # An API client for MainframeModernization. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::MainframeModernization::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
51
+ class Client < Seahorse::Client::Base
52
+
53
+ include Aws::ClientStubs
54
+
55
+ @identifier = :mainframemodernization
56
+
57
+ set_api(ClientApi::API)
58
+
59
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
60
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
61
+ add_plugin(Aws::Plugins::Logging)
62
+ add_plugin(Aws::Plugins::ParamConverter)
63
+ add_plugin(Aws::Plugins::ParamValidator)
64
+ add_plugin(Aws::Plugins::UserAgent)
65
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
66
+ add_plugin(Aws::Plugins::RetryErrors)
67
+ add_plugin(Aws::Plugins::GlobalConfiguration)
68
+ add_plugin(Aws::Plugins::RegionalEndpoint)
69
+ add_plugin(Aws::Plugins::EndpointDiscovery)
70
+ add_plugin(Aws::Plugins::EndpointPattern)
71
+ add_plugin(Aws::Plugins::ResponsePaging)
72
+ add_plugin(Aws::Plugins::StubResponses)
73
+ add_plugin(Aws::Plugins::IdempotencyToken)
74
+ add_plugin(Aws::Plugins::JsonvalueConverter)
75
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
76
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
77
+ add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
82
+ add_plugin(Aws::Plugins::SignatureV4)
83
+ add_plugin(Aws::Plugins::Protocols::RestJson)
84
+
85
+ # @overload initialize(options)
86
+ # @param [Hash] options
87
+ # @option options [required, Aws::CredentialProvider] :credentials
88
+ # Your AWS credentials. This can be an instance of any one of the
89
+ # following classes:
90
+ #
91
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
92
+ # credentials.
93
+ #
94
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
95
+ # shared file, such as `~/.aws/config`.
96
+ #
97
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
98
+ #
99
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
100
+ # assume a role after providing credentials via the web.
101
+ #
102
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
103
+ # access token generated from `aws login`.
104
+ #
105
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
106
+ # process that outputs to stdout.
107
+ #
108
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
109
+ # from an EC2 IMDS on an EC2 instance.
110
+ #
111
+ # * `Aws::ECSCredentials` - Used for loading credentials from
112
+ # instances running in ECS.
113
+ #
114
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
115
+ # from the Cognito Identity service.
116
+ #
117
+ # When `:credentials` are not configured directly, the following
118
+ # locations will be searched for credentials:
119
+ #
120
+ # * `Aws.config[:credentials]`
121
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
122
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
123
+ # * `~/.aws/credentials`
124
+ # * `~/.aws/config`
125
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
126
+ # are very aggressive. Construct and pass an instance of
127
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
128
+ # enable retries and extended timeouts. Instance profile credential
129
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
130
+ # to true.
131
+ #
132
+ # @option options [required, String] :region
133
+ # The AWS region to connect to. The configured `:region` is
134
+ # used to determine the service `:endpoint`. When not passed,
135
+ # a default `:region` is searched for in the following locations:
136
+ #
137
+ # * `Aws.config[:region]`
138
+ # * `ENV['AWS_REGION']`
139
+ # * `ENV['AMAZON_REGION']`
140
+ # * `ENV['AWS_DEFAULT_REGION']`
141
+ # * `~/.aws/credentials`
142
+ # * `~/.aws/config`
143
+ #
144
+ # @option options [String] :access_key_id
145
+ #
146
+ # @option options [Boolean] :active_endpoint_cache (false)
147
+ # When set to `true`, a thread polling for endpoints will be running in
148
+ # the background every 60 secs (default). Defaults to `false`.
149
+ #
150
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
151
+ # Used only in `adaptive` retry mode. When true, the request will sleep
152
+ # until there is sufficent client side capacity to retry the request.
153
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
154
+ # not retry instead of sleeping.
155
+ #
156
+ # @option options [Boolean] :client_side_monitoring (false)
157
+ # When `true`, client-side metrics will be collected for all API requests from
158
+ # this client.
159
+ #
160
+ # @option options [String] :client_side_monitoring_client_id ("")
161
+ # Allows you to provide an identifier for this client which will be attached to
162
+ # all generated client side metrics. Defaults to an empty string.
163
+ #
164
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
165
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
166
+ # side monitoring agent is running on, where client metrics will be published via UDP.
167
+ #
168
+ # @option options [Integer] :client_side_monitoring_port (31000)
169
+ # Required for publishing client metrics. The port that the client side monitoring
170
+ # agent is running on, where client metrics will be published via UDP.
171
+ #
172
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
173
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
174
+ # will use the Client Side Monitoring Agent Publisher.
175
+ #
176
+ # @option options [Boolean] :convert_params (true)
177
+ # When `true`, an attempt is made to coerce request parameters into
178
+ # the required types.
179
+ #
180
+ # @option options [Boolean] :correct_clock_skew (true)
181
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
182
+ # a clock skew correction and retry requests with skewed client clocks.
183
+ #
184
+ # @option options [String] :defaults_mode ("legacy")
185
+ # See {Aws::DefaultsModeConfiguration} for a list of the
186
+ # accepted modes and the configuration defaults that are included.
187
+ #
188
+ # @option options [Boolean] :disable_host_prefix_injection (false)
189
+ # Set to true to disable SDK automatically adding host prefix
190
+ # to default service endpoint when available.
191
+ #
192
+ # @option options [String] :endpoint
193
+ # The client endpoint is normally constructed from the `:region`
194
+ # option. You should only configure an `:endpoint` when connecting
195
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
196
+ #
197
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
198
+ # Used for the maximum size limit of the LRU cache storing endpoints data
199
+ # for endpoint discovery enabled operations. Defaults to 1000.
200
+ #
201
+ # @option options [Integer] :endpoint_cache_max_threads (10)
202
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
203
+ #
204
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
205
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
206
+ # Use this option to config the time interval in seconds for making
207
+ # requests fetching endpoints information. Defaults to 60 sec.
208
+ #
209
+ # @option options [Boolean] :endpoint_discovery (false)
210
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
211
+ #
212
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
213
+ # The log formatter.
214
+ #
215
+ # @option options [Symbol] :log_level (:info)
216
+ # The log level to send messages to the `:logger` at.
217
+ #
218
+ # @option options [Logger] :logger
219
+ # The Logger instance to send log messages to. If this option
220
+ # is not set, logging will be disabled.
221
+ #
222
+ # @option options [Integer] :max_attempts (3)
223
+ # An integer representing the maximum number attempts that will be made for
224
+ # a single request, including the initial attempt. For example,
225
+ # setting this value to 5 will result in a request being retried up to
226
+ # 4 times. Used in `standard` and `adaptive` retry modes.
227
+ #
228
+ # @option options [String] :profile ("default")
229
+ # Used when loading credentials from the shared credentials file
230
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
231
+ #
232
+ # @option options [Proc] :retry_backoff
233
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
234
+ # This option is only used in the `legacy` retry mode.
235
+ #
236
+ # @option options [Float] :retry_base_delay (0.3)
237
+ # The base delay in seconds used by the default backoff function. This option
238
+ # is only used in the `legacy` retry mode.
239
+ #
240
+ # @option options [Symbol] :retry_jitter (:none)
241
+ # A delay randomiser function used by the default backoff function.
242
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
243
+ # otherwise a Proc that takes and returns a number. This option is only used
244
+ # in the `legacy` retry mode.
245
+ #
246
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
247
+ #
248
+ # @option options [Integer] :retry_limit (3)
249
+ # The maximum number of times to retry failed requests. Only
250
+ # ~ 500 level server errors and certain ~ 400 level client errors
251
+ # are retried. Generally, these are throttling errors, data
252
+ # checksum errors, networking errors, timeout errors, auth errors,
253
+ # endpoint discovery, and errors from expired credentials.
254
+ # This option is only used in the `legacy` retry mode.
255
+ #
256
+ # @option options [Integer] :retry_max_delay (0)
257
+ # The maximum number of seconds to delay between retries (0 for no limit)
258
+ # used by the default backoff function. This option is only used in the
259
+ # `legacy` retry mode.
260
+ #
261
+ # @option options [String] :retry_mode ("legacy")
262
+ # Specifies which retry algorithm to use. Values are:
263
+ #
264
+ # * `legacy` - The pre-existing retry behavior. This is default value if
265
+ # no retry mode is provided.
266
+ #
267
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
268
+ # This includes support for retry quotas, which limit the number of
269
+ # unsuccessful retries a client can make.
270
+ #
271
+ # * `adaptive` - An experimental retry mode that includes all the
272
+ # functionality of `standard` mode along with automatic client side
273
+ # throttling. This is a provisional mode that may change behavior
274
+ # in the future.
275
+ #
276
+ #
277
+ # @option options [String] :secret_access_key
278
+ #
279
+ # @option options [String] :session_token
280
+ #
281
+ # @option options [Boolean] :stub_responses (false)
282
+ # Causes the client to return stubbed responses. By default
283
+ # fake responses are generated and returned. You can specify
284
+ # the response data to return or errors to raise by calling
285
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
286
+ #
287
+ # ** Please note ** When response stubbing is enabled, no HTTP
288
+ # requests are made, and retries are disabled.
289
+ #
290
+ # @option options [Boolean] :use_dualstack_endpoint
291
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
292
+ # will be used if available.
293
+ #
294
+ # @option options [Boolean] :use_fips_endpoint
295
+ # When set to `true`, fips compatible endpoints will be used if available.
296
+ # When a `fips` region is used, the region is normalized and this config
297
+ # is set to `true`.
298
+ #
299
+ # @option options [Boolean] :validate_params (true)
300
+ # When `true`, request parameters are validated before
301
+ # sending the request.
302
+ #
303
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
304
+ # requests through. Formatted like 'http://proxy.com:123'.
305
+ #
306
+ # @option options [Float] :http_open_timeout (15) The number of
307
+ # seconds to wait when opening a HTTP session before raising a
308
+ # `Timeout::Error`.
309
+ #
310
+ # @option options [Float] :http_read_timeout (60) The default
311
+ # number of seconds to wait for response data. This value can
312
+ # safely be set per-request on the session.
313
+ #
314
+ # @option options [Float] :http_idle_timeout (5) The number of
315
+ # seconds a connection is allowed to sit idle before it is
316
+ # considered stale. Stale connections are closed and removed
317
+ # from the pool before making a request.
318
+ #
319
+ # @option options [Float] :http_continue_timeout (1) The number of
320
+ # seconds to wait for a 100-continue response before sending the
321
+ # request body. This option has no effect unless the request has
322
+ # "Expect" header set to "100-continue". Defaults to `nil` which
323
+ # disables this behaviour. This value can safely be set per
324
+ # request on the session.
325
+ #
326
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
327
+ # in seconds.
328
+ #
329
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
330
+ # HTTP debug output will be sent to the `:logger`.
331
+ #
332
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
333
+ # SSL peer certificates are verified when establishing a
334
+ # connection.
335
+ #
336
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
337
+ # certificate authority bundle file that should be used when
338
+ # verifying peer certificates. If you do not pass
339
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
340
+ # will be used if available.
341
+ #
342
+ # @option options [String] :ssl_ca_directory Full path of the
343
+ # directory that contains the unbundled SSL certificate
344
+ # authority files for verifying peer certificates. If you do
345
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
346
+ # system default will be used if available.
347
+ #
348
+ def initialize(*args)
349
+ super
350
+ end
351
+
352
+ # @!group API Operations
353
+
354
+ # Cancels the running of a specific batch job execution.
355
+ #
356
+ # @option params [required, String] :application_id
357
+ # The unique identifier of the application.
358
+ #
359
+ # @option params [required, String] :execution_id
360
+ # The unique identifier of the batch job execution.
361
+ #
362
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
363
+ #
364
+ # @example Request syntax with placeholder values
365
+ #
366
+ # resp = client.cancel_batch_job_execution({
367
+ # application_id: "Identifier", # required
368
+ # execution_id: "Identifier", # required
369
+ # })
370
+ #
371
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CancelBatchJobExecution AWS API Documentation
372
+ #
373
+ # @overload cancel_batch_job_execution(params = {})
374
+ # @param [Hash] params ({})
375
+ def cancel_batch_job_execution(params = {}, options = {})
376
+ req = build_request(:cancel_batch_job_execution, params)
377
+ req.send_request(options)
378
+ end
379
+
380
+ # Creates a new application with given parameters. Requires an existing
381
+ # environment and application definition file.
382
+ #
383
+ # @option params [String] :client_token
384
+ # Unique, case-sensitive identifier the service generates to ensure the
385
+ # idempotency of the request to create an application. The service
386
+ # generates the clientToken when the API call is triggered. The token
387
+ # expires after one hour, so if you retry the API within this timeframe
388
+ # with the same clientToken, you will get the same response. The service
389
+ # also handles deleting the clientToken after it expires.
390
+ #
391
+ # **A suitable default value is auto-generated.** You should normally
392
+ # not need to pass this option.**
393
+ #
394
+ # @option params [required, Types::Definition] :definition
395
+ # The application definition for this application. You can specify
396
+ # either inline JSON or an S3 bucket location.
397
+ #
398
+ # @option params [String] :description
399
+ # The description of the application.
400
+ #
401
+ # @option params [required, String] :engine_type
402
+ # The type of the target platform for this application.
403
+ #
404
+ # @option params [required, String] :name
405
+ # The unique identifier of the application.
406
+ #
407
+ # @option params [Hash<String,String>] :tags
408
+ # A list of tags to apply to the application.
409
+ #
410
+ # @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
411
+ #
412
+ # * {Types::CreateApplicationResponse#application_arn #application_arn} => String
413
+ # * {Types::CreateApplicationResponse#application_id #application_id} => String
414
+ # * {Types::CreateApplicationResponse#application_version #application_version} => Integer
415
+ #
416
+ # @example Request syntax with placeholder values
417
+ #
418
+ # resp = client.create_application({
419
+ # client_token: "String",
420
+ # definition: { # required
421
+ # content: "StringFree65000",
422
+ # s3_location: "String2000",
423
+ # },
424
+ # description: "EntityDescription",
425
+ # engine_type: "microfocus", # required, accepts microfocus, bluage
426
+ # name: "EntityName", # required
427
+ # tags: {
428
+ # "TagKey" => "TagValue",
429
+ # },
430
+ # })
431
+ #
432
+ # @example Response structure
433
+ #
434
+ # resp.application_arn #=> String
435
+ # resp.application_id #=> String
436
+ # resp.application_version #=> Integer
437
+ #
438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateApplication AWS API Documentation
439
+ #
440
+ # @overload create_application(params = {})
441
+ # @param [Hash] params ({})
442
+ def create_application(params = {}, options = {})
443
+ req = build_request(:create_application, params)
444
+ req.send_request(options)
445
+ end
446
+
447
+ # Starts a data set import task for a specific application.
448
+ #
449
+ # @option params [required, String] :application_id
450
+ # The unique identifier of the application for which you want to import
451
+ # data sets.
452
+ #
453
+ # @option params [String] :client_token
454
+ # Unique, case-sensitive identifier you provide to ensure the
455
+ # idempotency of the request to create a data set import. The service
456
+ # generates the clientToken when the API call is triggered. The token
457
+ # expires after one hour, so if you retry the API within this timeframe
458
+ # with the same clientToken, you will get the same response. The service
459
+ # also handles deleting the clientToken after it expires.
460
+ #
461
+ # **A suitable default value is auto-generated.** You should normally
462
+ # not need to pass this option.**
463
+ #
464
+ # @option params [required, Types::DataSetImportConfig] :import_config
465
+ # The data set import task configuration.
466
+ #
467
+ # @return [Types::CreateDataSetImportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
468
+ #
469
+ # * {Types::CreateDataSetImportTaskResponse#task_id #task_id} => String
470
+ #
471
+ # @example Request syntax with placeholder values
472
+ #
473
+ # resp = client.create_data_set_import_task({
474
+ # application_id: "Identifier", # required
475
+ # client_token: "String",
476
+ # import_config: { # required
477
+ # data_sets: [
478
+ # {
479
+ # data_set: { # required
480
+ # dataset_name: "String", # required
481
+ # dataset_org: { # required
482
+ # gdg: {
483
+ # limit: 1,
484
+ # roll_disposition: "String",
485
+ # },
486
+ # vsam: {
487
+ # alternate_keys: [
488
+ # {
489
+ # allow_duplicates: false,
490
+ # length: 1, # required
491
+ # name: "String",
492
+ # offset: 1, # required
493
+ # },
494
+ # ],
495
+ # compressed: false,
496
+ # encoding: "String",
497
+ # format: "String", # required
498
+ # primary_key: {
499
+ # length: 1, # required
500
+ # name: "String",
501
+ # offset: 1, # required
502
+ # },
503
+ # },
504
+ # },
505
+ # record_length: { # required
506
+ # max: 1, # required
507
+ # min: 1, # required
508
+ # },
509
+ # relative_path: "String",
510
+ # storage_type: "String",
511
+ # },
512
+ # external_location: { # required
513
+ # s3_location: "String2000",
514
+ # },
515
+ # },
516
+ # ],
517
+ # s3_location: "String2000",
518
+ # },
519
+ # })
520
+ #
521
+ # @example Response structure
522
+ #
523
+ # resp.task_id #=> String
524
+ #
525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateDataSetImportTask AWS API Documentation
526
+ #
527
+ # @overload create_data_set_import_task(params = {})
528
+ # @param [Hash] params ({})
529
+ def create_data_set_import_task(params = {}, options = {})
530
+ req = build_request(:create_data_set_import_task, params)
531
+ req.send_request(options)
532
+ end
533
+
534
+ # Creates and starts a deployment to deploy an application into an
535
+ # environment.
536
+ #
537
+ # @option params [required, String] :application_id
538
+ # The application identifier.
539
+ #
540
+ # @option params [required, Integer] :application_version
541
+ # The version of the application to deploy.
542
+ #
543
+ # @option params [String] :client_token
544
+ # Unique, case-sensitive identifier you provide to ensure the
545
+ # idempotency of the request to create a deployment. The service
546
+ # generates the clientToken when the API call is triggered. The token
547
+ # expires after one hour, so if you retry the API within this timeframe
548
+ # with the same clientToken, you will get the same response. The service
549
+ # also handles deleting the clientToken after it expires.
550
+ #
551
+ # **A suitable default value is auto-generated.** You should normally
552
+ # not need to pass this option.**
553
+ #
554
+ # @option params [required, String] :environment_id
555
+ # The identifier of the environment where this application will be
556
+ # deployed.
557
+ #
558
+ # @return [Types::CreateDeploymentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
559
+ #
560
+ # * {Types::CreateDeploymentResponse#deployment_id #deployment_id} => String
561
+ #
562
+ # @example Request syntax with placeholder values
563
+ #
564
+ # resp = client.create_deployment({
565
+ # application_id: "Identifier", # required
566
+ # application_version: 1, # required
567
+ # client_token: "String",
568
+ # environment_id: "Identifier", # required
569
+ # })
570
+ #
571
+ # @example Response structure
572
+ #
573
+ # resp.deployment_id #=> String
574
+ #
575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateDeployment AWS API Documentation
576
+ #
577
+ # @overload create_deployment(params = {})
578
+ # @param [Hash] params ({})
579
+ def create_deployment(params = {}, options = {})
580
+ req = build_request(:create_deployment, params)
581
+ req.send_request(options)
582
+ end
583
+
584
+ # Creates a runtime environment for a given runtime engine.
585
+ #
586
+ # @option params [String] :client_token
587
+ # Unique, case-sensitive identifier you provide to ensure the
588
+ # idempotency of the request to create an environment. The service
589
+ # generates the clientToken when the API call is triggered. The token
590
+ # expires after one hour, so if you retry the API within this timeframe
591
+ # with the same clientToken, you will get the same response. The service
592
+ # also handles deleting the clientToken after it expires.
593
+ #
594
+ # **A suitable default value is auto-generated.** You should normally
595
+ # not need to pass this option.**
596
+ #
597
+ # @option params [String] :description
598
+ # The description of the environment.
599
+ #
600
+ # @option params [required, String] :engine_type
601
+ # The engine type for the environment.
602
+ #
603
+ # @option params [String] :engine_version
604
+ # The version of the engine type for the environment.
605
+ #
606
+ # @option params [Types::HighAvailabilityConfig] :high_availability_config
607
+ # The details of a high availability configuration for this runtime
608
+ # environment.
609
+ #
610
+ # @option params [required, String] :instance_type
611
+ # The type of instance for the environment.
612
+ #
613
+ # @option params [required, String] :name
614
+ # The unique identifier of the environment.
615
+ #
616
+ # @option params [String] :preferred_maintenance_window
617
+ # Configures a desired maintenance window for the environment. If you do
618
+ # not provide a value, a random system-generated value will be assigned.
619
+ #
620
+ # @option params [Boolean] :publicly_accessible
621
+ # Specifies whether the environment is publicly accessible.
622
+ #
623
+ # @option params [Array<String>] :security_group_ids
624
+ # The list of security groups for the VPC associated with this
625
+ # environment.
626
+ #
627
+ # @option params [Array<Types::StorageConfiguration>] :storage_configurations
628
+ # Optional. The storage configurations for this environment.
629
+ #
630
+ # @option params [Array<String>] :subnet_ids
631
+ # The list of subnets associated with the VPC for this environment.
632
+ #
633
+ # @option params [Hash<String,String>] :tags
634
+ # The tags for the environment.
635
+ #
636
+ # @return [Types::CreateEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
637
+ #
638
+ # * {Types::CreateEnvironmentResponse#environment_id #environment_id} => String
639
+ #
640
+ # @example Request syntax with placeholder values
641
+ #
642
+ # resp = client.create_environment({
643
+ # client_token: "String",
644
+ # description: "EntityDescription",
645
+ # engine_type: "microfocus", # required, accepts microfocus, bluage
646
+ # engine_version: "EngineVersion",
647
+ # high_availability_config: {
648
+ # desired_capacity: 1, # required
649
+ # },
650
+ # instance_type: "String20", # required
651
+ # name: "EntityName", # required
652
+ # preferred_maintenance_window: "String50",
653
+ # publicly_accessible: false,
654
+ # security_group_ids: ["String50"],
655
+ # storage_configurations: [
656
+ # {
657
+ # efs: {
658
+ # file_system_id: "String200", # required
659
+ # mount_point: "String200", # required
660
+ # },
661
+ # fsx: {
662
+ # file_system_id: "String200", # required
663
+ # mount_point: "String200", # required
664
+ # },
665
+ # },
666
+ # ],
667
+ # subnet_ids: ["String50"],
668
+ # tags: {
669
+ # "TagKey" => "TagValue",
670
+ # },
671
+ # })
672
+ #
673
+ # @example Response structure
674
+ #
675
+ # resp.environment_id #=> String
676
+ #
677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateEnvironment AWS API Documentation
678
+ #
679
+ # @overload create_environment(params = {})
680
+ # @param [Hash] params ({})
681
+ def create_environment(params = {}, options = {})
682
+ req = build_request(:create_environment, params)
683
+ req.send_request(options)
684
+ end
685
+
686
+ # Deletes a specific application. You cannot delete a running
687
+ # application.
688
+ #
689
+ # @option params [required, String] :application_id
690
+ # The unique identifier of the application you want to delete.
691
+ #
692
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
693
+ #
694
+ # @example Request syntax with placeholder values
695
+ #
696
+ # resp = client.delete_application({
697
+ # application_id: "Identifier", # required
698
+ # })
699
+ #
700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeleteApplication AWS API Documentation
701
+ #
702
+ # @overload delete_application(params = {})
703
+ # @param [Hash] params ({})
704
+ def delete_application(params = {}, options = {})
705
+ req = build_request(:delete_application, params)
706
+ req.send_request(options)
707
+ end
708
+
709
+ # Deletes a specific application from a specified environment where it
710
+ # has been previously deployed. You cannot delete an environment using
711
+ # DeleteEnvironment, if any application has ever been deployed to it.
712
+ # This API removes the association of the application with the
713
+ # environment so you can delete the environment smoothly.
714
+ #
715
+ # @option params [required, String] :application_id
716
+ # The unique identifier of the application you want to delete.
717
+ #
718
+ # @option params [required, String] :environment_id
719
+ # The unique identifier of the runtime environment where the application
720
+ # was previously deployed.
721
+ #
722
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
723
+ #
724
+ # @example Request syntax with placeholder values
725
+ #
726
+ # resp = client.delete_application_from_environment({
727
+ # application_id: "Identifier", # required
728
+ # environment_id: "Identifier", # required
729
+ # })
730
+ #
731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeleteApplicationFromEnvironment AWS API Documentation
732
+ #
733
+ # @overload delete_application_from_environment(params = {})
734
+ # @param [Hash] params ({})
735
+ def delete_application_from_environment(params = {}, options = {})
736
+ req = build_request(:delete_application_from_environment, params)
737
+ req.send_request(options)
738
+ end
739
+
740
+ # Deletes a specific environment. The environment cannot contain
741
+ # deployed applications. If it does, you must delete those applications
742
+ # before you delete the environment.
743
+ #
744
+ # @option params [required, String] :environment_id
745
+ # The unique identifier of the runtime environment you want to delete.
746
+ #
747
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
748
+ #
749
+ # @example Request syntax with placeholder values
750
+ #
751
+ # resp = client.delete_environment({
752
+ # environment_id: "Identifier", # required
753
+ # })
754
+ #
755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeleteEnvironment AWS API Documentation
756
+ #
757
+ # @overload delete_environment(params = {})
758
+ # @param [Hash] params ({})
759
+ def delete_environment(params = {}, options = {})
760
+ req = build_request(:delete_environment, params)
761
+ req.send_request(options)
762
+ end
763
+
764
+ # Describes the details of a specific application.
765
+ #
766
+ # @option params [required, String] :application_id
767
+ # The identifier of the application.
768
+ #
769
+ # @return [Types::GetApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
770
+ #
771
+ # * {Types::GetApplicationResponse#application_arn #application_arn} => String
772
+ # * {Types::GetApplicationResponse#application_id #application_id} => String
773
+ # * {Types::GetApplicationResponse#creation_time #creation_time} => Time
774
+ # * {Types::GetApplicationResponse#deployed_version #deployed_version} => Types::DeployedVersionSummary
775
+ # * {Types::GetApplicationResponse#description #description} => String
776
+ # * {Types::GetApplicationResponse#engine_type #engine_type} => String
777
+ # * {Types::GetApplicationResponse#environment_id #environment_id} => String
778
+ # * {Types::GetApplicationResponse#last_start_time #last_start_time} => Time
779
+ # * {Types::GetApplicationResponse#latest_version #latest_version} => Types::ApplicationVersionSummary
780
+ # * {Types::GetApplicationResponse#listener_arns #listener_arns} => Array&lt;String&gt;
781
+ # * {Types::GetApplicationResponse#listener_ports #listener_ports} => Array&lt;Integer&gt;
782
+ # * {Types::GetApplicationResponse#load_balancer_dns_name #load_balancer_dns_name} => String
783
+ # * {Types::GetApplicationResponse#log_groups #log_groups} => Array&lt;Types::LogGroupSummary&gt;
784
+ # * {Types::GetApplicationResponse#name #name} => String
785
+ # * {Types::GetApplicationResponse#status #status} => String
786
+ # * {Types::GetApplicationResponse#status_reason #status_reason} => String
787
+ # * {Types::GetApplicationResponse#tags #tags} => Hash&lt;String,String&gt;
788
+ # * {Types::GetApplicationResponse#target_group_arns #target_group_arns} => Array&lt;String&gt;
789
+ #
790
+ # @example Request syntax with placeholder values
791
+ #
792
+ # resp = client.get_application({
793
+ # application_id: "Identifier", # required
794
+ # })
795
+ #
796
+ # @example Response structure
797
+ #
798
+ # resp.application_arn #=> String
799
+ # resp.application_id #=> String
800
+ # resp.creation_time #=> Time
801
+ # resp.deployed_version.application_version #=> Integer
802
+ # resp.deployed_version.status #=> String, one of "Deploying", "Succeeded", "Failed"
803
+ # resp.deployed_version.status_reason #=> String
804
+ # resp.description #=> String
805
+ # resp.engine_type #=> String, one of "microfocus", "bluage"
806
+ # resp.environment_id #=> String
807
+ # resp.last_start_time #=> Time
808
+ # resp.latest_version.application_version #=> Integer
809
+ # resp.latest_version.creation_time #=> Time
810
+ # resp.latest_version.status #=> String, one of "Creating", "Available", "Failed"
811
+ # resp.latest_version.status_reason #=> String
812
+ # resp.listener_arns #=> Array
813
+ # resp.listener_arns[0] #=> String
814
+ # resp.listener_ports #=> Array
815
+ # resp.listener_ports[0] #=> Integer
816
+ # resp.load_balancer_dns_name #=> String
817
+ # resp.log_groups #=> Array
818
+ # resp.log_groups[0].log_group_name #=> String
819
+ # resp.log_groups[0].log_type #=> String
820
+ # resp.name #=> String
821
+ # resp.status #=> String, one of "Creating", "Created", "Available", "Ready", "Starting", "Running", "Stopping", "Stopped", "Failed", "Deleting"
822
+ # resp.status_reason #=> String
823
+ # resp.tags #=> Hash
824
+ # resp.tags["TagKey"] #=> String
825
+ # resp.target_group_arns #=> Array
826
+ # resp.target_group_arns[0] #=> String
827
+ #
828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetApplication AWS API Documentation
829
+ #
830
+ # @overload get_application(params = {})
831
+ # @param [Hash] params ({})
832
+ def get_application(params = {}, options = {})
833
+ req = build_request(:get_application, params)
834
+ req.send_request(options)
835
+ end
836
+
837
+ # Returns details about a specific version of a specific application.
838
+ #
839
+ # @option params [required, String] :application_id
840
+ # The unique identifier of the application.
841
+ #
842
+ # @option params [required, Integer] :application_version
843
+ # The specific version of the application.
844
+ #
845
+ # @return [Types::GetApplicationVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
846
+ #
847
+ # * {Types::GetApplicationVersionResponse#application_version #application_version} => Integer
848
+ # * {Types::GetApplicationVersionResponse#creation_time #creation_time} => Time
849
+ # * {Types::GetApplicationVersionResponse#definition_content #definition_content} => String
850
+ # * {Types::GetApplicationVersionResponse#description #description} => String
851
+ # * {Types::GetApplicationVersionResponse#name #name} => String
852
+ # * {Types::GetApplicationVersionResponse#status #status} => String
853
+ # * {Types::GetApplicationVersionResponse#status_reason #status_reason} => String
854
+ #
855
+ # @example Request syntax with placeholder values
856
+ #
857
+ # resp = client.get_application_version({
858
+ # application_id: "Identifier", # required
859
+ # application_version: 1, # required
860
+ # })
861
+ #
862
+ # @example Response structure
863
+ #
864
+ # resp.application_version #=> Integer
865
+ # resp.creation_time #=> Time
866
+ # resp.definition_content #=> String
867
+ # resp.description #=> String
868
+ # resp.name #=> String
869
+ # resp.status #=> String, one of "Creating", "Available", "Failed"
870
+ # resp.status_reason #=> String
871
+ #
872
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetApplicationVersion AWS API Documentation
873
+ #
874
+ # @overload get_application_version(params = {})
875
+ # @param [Hash] params ({})
876
+ def get_application_version(params = {}, options = {})
877
+ req = build_request(:get_application_version, params)
878
+ req.send_request(options)
879
+ end
880
+
881
+ # Gets the details of a specific batch job execution for a specific
882
+ # application.
883
+ #
884
+ # @option params [required, String] :application_id
885
+ # The identifier of the application.
886
+ #
887
+ # @option params [required, String] :execution_id
888
+ # The unique identifier of the batch job execution.
889
+ #
890
+ # @return [Types::GetBatchJobExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
891
+ #
892
+ # * {Types::GetBatchJobExecutionResponse#application_id #application_id} => String
893
+ # * {Types::GetBatchJobExecutionResponse#end_time #end_time} => Time
894
+ # * {Types::GetBatchJobExecutionResponse#execution_id #execution_id} => String
895
+ # * {Types::GetBatchJobExecutionResponse#job_id #job_id} => String
896
+ # * {Types::GetBatchJobExecutionResponse#job_name #job_name} => String
897
+ # * {Types::GetBatchJobExecutionResponse#job_type #job_type} => String
898
+ # * {Types::GetBatchJobExecutionResponse#job_user #job_user} => String
899
+ # * {Types::GetBatchJobExecutionResponse#start_time #start_time} => Time
900
+ # * {Types::GetBatchJobExecutionResponse#status #status} => String
901
+ # * {Types::GetBatchJobExecutionResponse#status_reason #status_reason} => String
902
+ #
903
+ # @example Request syntax with placeholder values
904
+ #
905
+ # resp = client.get_batch_job_execution({
906
+ # application_id: "Identifier", # required
907
+ # execution_id: "Identifier", # required
908
+ # })
909
+ #
910
+ # @example Response structure
911
+ #
912
+ # resp.application_id #=> String
913
+ # resp.end_time #=> Time
914
+ # resp.execution_id #=> String
915
+ # resp.job_id #=> String
916
+ # resp.job_name #=> String
917
+ # resp.job_type #=> String, one of "VSE", "JES2", "JES3"
918
+ # resp.job_user #=> String
919
+ # resp.start_time #=> Time
920
+ # resp.status #=> String, one of "Submitting", "Holding", "Dispatching", "Running", "Cancelling", "Cancelled", "Succeeded", "Failed", "Succeeded With Warning"
921
+ # resp.status_reason #=> String
922
+ #
923
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetBatchJobExecution AWS API Documentation
924
+ #
925
+ # @overload get_batch_job_execution(params = {})
926
+ # @param [Hash] params ({})
927
+ def get_batch_job_execution(params = {}, options = {})
928
+ req = build_request(:get_batch_job_execution, params)
929
+ req.send_request(options)
930
+ end
931
+
932
+ # Gets the details of a specific data set.
933
+ #
934
+ # @option params [required, String] :application_id
935
+ # The unique identifier of the application that this data set is
936
+ # associated with.
937
+ #
938
+ # @option params [required, String] :data_set_name
939
+ # The name of the data set.
940
+ #
941
+ # @return [Types::GetDataSetDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
942
+ #
943
+ # * {Types::GetDataSetDetailsResponse#blocksize #blocksize} => Integer
944
+ # * {Types::GetDataSetDetailsResponse#creation_time #creation_time} => Time
945
+ # * {Types::GetDataSetDetailsResponse#data_set_name #data_set_name} => String
946
+ # * {Types::GetDataSetDetailsResponse#data_set_org #data_set_org} => Types::DatasetDetailOrgAttributes
947
+ # * {Types::GetDataSetDetailsResponse#last_referenced_time #last_referenced_time} => Time
948
+ # * {Types::GetDataSetDetailsResponse#last_updated_time #last_updated_time} => Time
949
+ # * {Types::GetDataSetDetailsResponse#location #location} => String
950
+ # * {Types::GetDataSetDetailsResponse#record_length #record_length} => Integer
951
+ #
952
+ # @example Request syntax with placeholder values
953
+ #
954
+ # resp = client.get_data_set_details({
955
+ # application_id: "Identifier", # required
956
+ # data_set_name: "String200", # required
957
+ # })
958
+ #
959
+ # @example Response structure
960
+ #
961
+ # resp.blocksize #=> Integer
962
+ # resp.creation_time #=> Time
963
+ # resp.data_set_name #=> String
964
+ # resp.data_set_org.gdg.limit #=> Integer
965
+ # resp.data_set_org.gdg.roll_disposition #=> String
966
+ # resp.data_set_org.vsam.alternate_keys #=> Array
967
+ # resp.data_set_org.vsam.alternate_keys[0].allow_duplicates #=> Boolean
968
+ # resp.data_set_org.vsam.alternate_keys[0].length #=> Integer
969
+ # resp.data_set_org.vsam.alternate_keys[0].name #=> String
970
+ # resp.data_set_org.vsam.alternate_keys[0].offset #=> Integer
971
+ # resp.data_set_org.vsam.cache_at_startup #=> Boolean
972
+ # resp.data_set_org.vsam.compressed #=> Boolean
973
+ # resp.data_set_org.vsam.encoding #=> String
974
+ # resp.data_set_org.vsam.primary_key.length #=> Integer
975
+ # resp.data_set_org.vsam.primary_key.name #=> String
976
+ # resp.data_set_org.vsam.primary_key.offset #=> Integer
977
+ # resp.data_set_org.vsam.record_format #=> String
978
+ # resp.last_referenced_time #=> Time
979
+ # resp.last_updated_time #=> Time
980
+ # resp.location #=> String
981
+ # resp.record_length #=> Integer
982
+ #
983
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetDataSetDetails AWS API Documentation
984
+ #
985
+ # @overload get_data_set_details(params = {})
986
+ # @param [Hash] params ({})
987
+ def get_data_set_details(params = {}, options = {})
988
+ req = build_request(:get_data_set_details, params)
989
+ req.send_request(options)
990
+ end
991
+
992
+ # Gets the status of a data set import task initiated with the
993
+ # CreateDataSetImportTask operation.
994
+ #
995
+ # @option params [required, String] :application_id
996
+ # The application identifier.
997
+ #
998
+ # @option params [required, String] :task_id
999
+ # The task identifier returned by the CreateDataSetImportTask operation.
1000
+ #
1001
+ # @return [Types::GetDataSetImportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1002
+ #
1003
+ # * {Types::GetDataSetImportTaskResponse#status #status} => String
1004
+ # * {Types::GetDataSetImportTaskResponse#summary #summary} => Types::DataSetImportSummary
1005
+ # * {Types::GetDataSetImportTaskResponse#task_id #task_id} => String
1006
+ #
1007
+ # @example Request syntax with placeholder values
1008
+ #
1009
+ # resp = client.get_data_set_import_task({
1010
+ # application_id: "Identifier", # required
1011
+ # task_id: "Identifier", # required
1012
+ # })
1013
+ #
1014
+ # @example Response structure
1015
+ #
1016
+ # resp.status #=> String, one of "Creating", "Running", "Completed"
1017
+ # resp.summary.failed #=> Integer
1018
+ # resp.summary.in_progress #=> Integer
1019
+ # resp.summary.pending #=> Integer
1020
+ # resp.summary.succeeded #=> Integer
1021
+ # resp.summary.total #=> Integer
1022
+ # resp.task_id #=> String
1023
+ #
1024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetDataSetImportTask AWS API Documentation
1025
+ #
1026
+ # @overload get_data_set_import_task(params = {})
1027
+ # @param [Hash] params ({})
1028
+ def get_data_set_import_task(params = {}, options = {})
1029
+ req = build_request(:get_data_set_import_task, params)
1030
+ req.send_request(options)
1031
+ end
1032
+
1033
+ # Gets details of a specific deployment with a given deployment
1034
+ # identifier.
1035
+ #
1036
+ # @option params [required, String] :application_id
1037
+ # The unique identifier of the application.
1038
+ #
1039
+ # @option params [required, String] :deployment_id
1040
+ # The unique identifier for the deployment.
1041
+ #
1042
+ # @return [Types::GetDeploymentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1043
+ #
1044
+ # * {Types::GetDeploymentResponse#application_id #application_id} => String
1045
+ # * {Types::GetDeploymentResponse#application_version #application_version} => Integer
1046
+ # * {Types::GetDeploymentResponse#creation_time #creation_time} => Time
1047
+ # * {Types::GetDeploymentResponse#deployment_id #deployment_id} => String
1048
+ # * {Types::GetDeploymentResponse#environment_id #environment_id} => String
1049
+ # * {Types::GetDeploymentResponse#status #status} => String
1050
+ # * {Types::GetDeploymentResponse#status_reason #status_reason} => String
1051
+ #
1052
+ # @example Request syntax with placeholder values
1053
+ #
1054
+ # resp = client.get_deployment({
1055
+ # application_id: "Identifier", # required
1056
+ # deployment_id: "Identifier", # required
1057
+ # })
1058
+ #
1059
+ # @example Response structure
1060
+ #
1061
+ # resp.application_id #=> String
1062
+ # resp.application_version #=> Integer
1063
+ # resp.creation_time #=> Time
1064
+ # resp.deployment_id #=> String
1065
+ # resp.environment_id #=> String
1066
+ # resp.status #=> String, one of "Deploying", "Succeeded", "Failed"
1067
+ # resp.status_reason #=> String
1068
+ #
1069
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetDeployment AWS API Documentation
1070
+ #
1071
+ # @overload get_deployment(params = {})
1072
+ # @param [Hash] params ({})
1073
+ def get_deployment(params = {}, options = {})
1074
+ req = build_request(:get_deployment, params)
1075
+ req.send_request(options)
1076
+ end
1077
+
1078
+ # Describes a specific runtime environment.
1079
+ #
1080
+ # @option params [required, String] :environment_id
1081
+ # The unique identifier of the runtime environment.
1082
+ #
1083
+ # @return [Types::GetEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1084
+ #
1085
+ # * {Types::GetEnvironmentResponse#actual_capacity #actual_capacity} => Integer
1086
+ # * {Types::GetEnvironmentResponse#creation_time #creation_time} => Time
1087
+ # * {Types::GetEnvironmentResponse#description #description} => String
1088
+ # * {Types::GetEnvironmentResponse#engine_type #engine_type} => String
1089
+ # * {Types::GetEnvironmentResponse#engine_version #engine_version} => String
1090
+ # * {Types::GetEnvironmentResponse#environment_arn #environment_arn} => String
1091
+ # * {Types::GetEnvironmentResponse#environment_id #environment_id} => String
1092
+ # * {Types::GetEnvironmentResponse#high_availability_config #high_availability_config} => Types::HighAvailabilityConfig
1093
+ # * {Types::GetEnvironmentResponse#instance_type #instance_type} => String
1094
+ # * {Types::GetEnvironmentResponse#load_balancer_arn #load_balancer_arn} => String
1095
+ # * {Types::GetEnvironmentResponse#name #name} => String
1096
+ # * {Types::GetEnvironmentResponse#pending_maintenance #pending_maintenance} => Types::PendingMaintenance
1097
+ # * {Types::GetEnvironmentResponse#preferred_maintenance_window #preferred_maintenance_window} => String
1098
+ # * {Types::GetEnvironmentResponse#publicly_accessible #publicly_accessible} => Boolean
1099
+ # * {Types::GetEnvironmentResponse#security_group_ids #security_group_ids} => Array&lt;String&gt;
1100
+ # * {Types::GetEnvironmentResponse#status #status} => String
1101
+ # * {Types::GetEnvironmentResponse#status_reason #status_reason} => String
1102
+ # * {Types::GetEnvironmentResponse#storage_configurations #storage_configurations} => Array&lt;Types::StorageConfiguration&gt;
1103
+ # * {Types::GetEnvironmentResponse#subnet_ids #subnet_ids} => Array&lt;String&gt;
1104
+ # * {Types::GetEnvironmentResponse#tags #tags} => Hash&lt;String,String&gt;
1105
+ # * {Types::GetEnvironmentResponse#vpc_id #vpc_id} => String
1106
+ #
1107
+ # @example Request syntax with placeholder values
1108
+ #
1109
+ # resp = client.get_environment({
1110
+ # environment_id: "Identifier", # required
1111
+ # })
1112
+ #
1113
+ # @example Response structure
1114
+ #
1115
+ # resp.actual_capacity #=> Integer
1116
+ # resp.creation_time #=> Time
1117
+ # resp.description #=> String
1118
+ # resp.engine_type #=> String, one of "microfocus", "bluage"
1119
+ # resp.engine_version #=> String
1120
+ # resp.environment_arn #=> String
1121
+ # resp.environment_id #=> String
1122
+ # resp.high_availability_config.desired_capacity #=> Integer
1123
+ # resp.instance_type #=> String
1124
+ # resp.load_balancer_arn #=> String
1125
+ # resp.name #=> String
1126
+ # resp.pending_maintenance.engine_version #=> String
1127
+ # resp.pending_maintenance.schedule.end_time #=> Time
1128
+ # resp.pending_maintenance.schedule.start_time #=> Time
1129
+ # resp.preferred_maintenance_window #=> String
1130
+ # resp.publicly_accessible #=> Boolean
1131
+ # resp.security_group_ids #=> Array
1132
+ # resp.security_group_ids[0] #=> String
1133
+ # resp.status #=> String, one of "Creating", "Available", "Deleting", "Failed"
1134
+ # resp.status_reason #=> String
1135
+ # resp.storage_configurations #=> Array
1136
+ # resp.storage_configurations[0].efs.file_system_id #=> String
1137
+ # resp.storage_configurations[0].efs.mount_point #=> String
1138
+ # resp.storage_configurations[0].fsx.file_system_id #=> String
1139
+ # resp.storage_configurations[0].fsx.mount_point #=> String
1140
+ # resp.subnet_ids #=> Array
1141
+ # resp.subnet_ids[0] #=> String
1142
+ # resp.tags #=> Hash
1143
+ # resp.tags["TagKey"] #=> String
1144
+ # resp.vpc_id #=> String
1145
+ #
1146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetEnvironment AWS API Documentation
1147
+ #
1148
+ # @overload get_environment(params = {})
1149
+ # @param [Hash] params ({})
1150
+ def get_environment(params = {}, options = {})
1151
+ req = build_request(:get_environment, params)
1152
+ req.send_request(options)
1153
+ end
1154
+
1155
+ # Returns a list of the application versions for a specific application.
1156
+ #
1157
+ # @option params [required, String] :application_id
1158
+ # The unique identifier of the application.
1159
+ #
1160
+ # @option params [Integer] :max_results
1161
+ # The maximum number of application versions to return.
1162
+ #
1163
+ # @option params [String] :next_token
1164
+ # A pagination token returned from a previous call to this operation.
1165
+ # This specifies the next item to return. To return to the beginning of
1166
+ # the list, exclude this parameter.
1167
+ #
1168
+ # @return [Types::ListApplicationVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1169
+ #
1170
+ # * {Types::ListApplicationVersionsResponse#application_versions #application_versions} => Array&lt;Types::ApplicationVersionSummary&gt;
1171
+ # * {Types::ListApplicationVersionsResponse#next_token #next_token} => String
1172
+ #
1173
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1174
+ #
1175
+ # @example Request syntax with placeholder values
1176
+ #
1177
+ # resp = client.list_application_versions({
1178
+ # application_id: "Identifier", # required
1179
+ # max_results: 1,
1180
+ # next_token: "NextToken",
1181
+ # })
1182
+ #
1183
+ # @example Response structure
1184
+ #
1185
+ # resp.application_versions #=> Array
1186
+ # resp.application_versions[0].application_version #=> Integer
1187
+ # resp.application_versions[0].creation_time #=> Time
1188
+ # resp.application_versions[0].status #=> String, one of "Creating", "Available", "Failed"
1189
+ # resp.application_versions[0].status_reason #=> String
1190
+ # resp.next_token #=> String
1191
+ #
1192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListApplicationVersions AWS API Documentation
1193
+ #
1194
+ # @overload list_application_versions(params = {})
1195
+ # @param [Hash] params ({})
1196
+ def list_application_versions(params = {}, options = {})
1197
+ req = build_request(:list_application_versions, params)
1198
+ req.send_request(options)
1199
+ end
1200
+
1201
+ # Lists the applications associated with a specific Amazon Web Services
1202
+ # account. You can provide the unique identifier of a specific
1203
+ # environment in a query parameter to see all applications associated
1204
+ # with that environment.
1205
+ #
1206
+ # @option params [String] :environment_id
1207
+ # The unique identifier of the runtime environment where the
1208
+ # applications are deployed.
1209
+ #
1210
+ # @option params [Integer] :max_results
1211
+ # The maximum number of applications to return.
1212
+ #
1213
+ # @option params [Array<String>] :names
1214
+ # The names of the applications.
1215
+ #
1216
+ # @option params [String] :next_token
1217
+ # A pagination token to control the number of applications displayed in
1218
+ # the list.
1219
+ #
1220
+ # @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1221
+ #
1222
+ # * {Types::ListApplicationsResponse#applications #applications} => Array&lt;Types::ApplicationSummary&gt;
1223
+ # * {Types::ListApplicationsResponse#next_token #next_token} => String
1224
+ #
1225
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1226
+ #
1227
+ # @example Request syntax with placeholder values
1228
+ #
1229
+ # resp = client.list_applications({
1230
+ # environment_id: "Identifier",
1231
+ # max_results: 1,
1232
+ # names: ["EntityName"],
1233
+ # next_token: "NextToken",
1234
+ # })
1235
+ #
1236
+ # @example Response structure
1237
+ #
1238
+ # resp.applications #=> Array
1239
+ # resp.applications[0].application_arn #=> String
1240
+ # resp.applications[0].application_id #=> String
1241
+ # resp.applications[0].application_version #=> Integer
1242
+ # resp.applications[0].creation_time #=> Time
1243
+ # resp.applications[0].deployment_status #=> String, one of "Deploying", "Deployed"
1244
+ # resp.applications[0].description #=> String
1245
+ # resp.applications[0].engine_type #=> String, one of "microfocus", "bluage"
1246
+ # resp.applications[0].environment_id #=> String
1247
+ # resp.applications[0].last_start_time #=> Time
1248
+ # resp.applications[0].name #=> String
1249
+ # resp.applications[0].status #=> String, one of "Creating", "Created", "Available", "Ready", "Starting", "Running", "Stopping", "Stopped", "Failed", "Deleting"
1250
+ # resp.applications[0].version_status #=> String, one of "Creating", "Available", "Failed"
1251
+ # resp.next_token #=> String
1252
+ #
1253
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListApplications AWS API Documentation
1254
+ #
1255
+ # @overload list_applications(params = {})
1256
+ # @param [Hash] params ({})
1257
+ def list_applications(params = {}, options = {})
1258
+ req = build_request(:list_applications, params)
1259
+ req.send_request(options)
1260
+ end
1261
+
1262
+ # Lists all the available batch job definitions based on the batch job
1263
+ # resources uploaded during the application creation. The listed batch
1264
+ # job definitions can then be used to start a batch job.
1265
+ #
1266
+ # @option params [required, String] :application_id
1267
+ # The identifier of the application.
1268
+ #
1269
+ # @option params [Integer] :max_results
1270
+ # The maximum number of batch job definitions to return.
1271
+ #
1272
+ # @option params [String] :next_token
1273
+ # A pagination token returned from a previous call to this operation.
1274
+ # This specifies the next item to return. To return to the beginning of
1275
+ # the list, exclude this parameter.
1276
+ #
1277
+ # @option params [String] :prefix
1278
+ # If the batch job definition is a FileBatchJobDefinition, the prefix
1279
+ # allows you to search on the file names of FileBatchJobDefinitions.
1280
+ #
1281
+ # @return [Types::ListBatchJobDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1282
+ #
1283
+ # * {Types::ListBatchJobDefinitionsResponse#batch_job_definitions #batch_job_definitions} => Array&lt;Types::BatchJobDefinition&gt;
1284
+ # * {Types::ListBatchJobDefinitionsResponse#next_token #next_token} => String
1285
+ #
1286
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1287
+ #
1288
+ # @example Request syntax with placeholder values
1289
+ #
1290
+ # resp = client.list_batch_job_definitions({
1291
+ # application_id: "Identifier", # required
1292
+ # max_results: 1,
1293
+ # next_token: "NextToken",
1294
+ # prefix: "String",
1295
+ # })
1296
+ #
1297
+ # @example Response structure
1298
+ #
1299
+ # resp.batch_job_definitions #=> Array
1300
+ # resp.batch_job_definitions[0].file_batch_job_definition.file_name #=> String
1301
+ # resp.batch_job_definitions[0].file_batch_job_definition.folder_path #=> String
1302
+ # resp.batch_job_definitions[0].script_batch_job_definition.script_name #=> String
1303
+ # resp.next_token #=> String
1304
+ #
1305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListBatchJobDefinitions AWS API Documentation
1306
+ #
1307
+ # @overload list_batch_job_definitions(params = {})
1308
+ # @param [Hash] params ({})
1309
+ def list_batch_job_definitions(params = {}, options = {})
1310
+ req = build_request(:list_batch_job_definitions, params)
1311
+ req.send_request(options)
1312
+ end
1313
+
1314
+ # Lists historical, current, and scheduled batch job executions for a
1315
+ # specific application.
1316
+ #
1317
+ # @option params [required, String] :application_id
1318
+ # The unique identifier of the application.
1319
+ #
1320
+ # @option params [Array<String>] :execution_ids
1321
+ # The unique identifier of each batch job execution.
1322
+ #
1323
+ # @option params [String] :job_name
1324
+ # The name of each batch job execution.
1325
+ #
1326
+ # @option params [Integer] :max_results
1327
+ # The maximum number of batch job executions to return.
1328
+ #
1329
+ # @option params [String] :next_token
1330
+ # A pagination token to control the number of batch job executions
1331
+ # displayed in the list.
1332
+ #
1333
+ # @option params [Time,DateTime,Date,Integer,String] :started_after
1334
+ # The time after which the batch job executions started.
1335
+ #
1336
+ # @option params [Time,DateTime,Date,Integer,String] :started_before
1337
+ # The time before the batch job executions started.
1338
+ #
1339
+ # @option params [String] :status
1340
+ # The status of the batch job executions.
1341
+ #
1342
+ # @return [Types::ListBatchJobExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1343
+ #
1344
+ # * {Types::ListBatchJobExecutionsResponse#batch_job_executions #batch_job_executions} => Array&lt;Types::BatchJobExecutionSummary&gt;
1345
+ # * {Types::ListBatchJobExecutionsResponse#next_token #next_token} => String
1346
+ #
1347
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1348
+ #
1349
+ # @example Request syntax with placeholder values
1350
+ #
1351
+ # resp = client.list_batch_job_executions({
1352
+ # application_id: "Identifier", # required
1353
+ # execution_ids: ["Identifier"],
1354
+ # job_name: "String100",
1355
+ # max_results: 1,
1356
+ # next_token: "NextToken",
1357
+ # started_after: Time.now,
1358
+ # started_before: Time.now,
1359
+ # status: "Submitting", # accepts Submitting, Holding, Dispatching, Running, Cancelling, Cancelled, Succeeded, Failed, Succeeded With Warning
1360
+ # })
1361
+ #
1362
+ # @example Response structure
1363
+ #
1364
+ # resp.batch_job_executions #=> Array
1365
+ # resp.batch_job_executions[0].application_id #=> String
1366
+ # resp.batch_job_executions[0].end_time #=> Time
1367
+ # resp.batch_job_executions[0].execution_id #=> String
1368
+ # resp.batch_job_executions[0].job_id #=> String
1369
+ # resp.batch_job_executions[0].job_name #=> String
1370
+ # resp.batch_job_executions[0].job_type #=> String, one of "VSE", "JES2", "JES3"
1371
+ # resp.batch_job_executions[0].start_time #=> Time
1372
+ # resp.batch_job_executions[0].status #=> String, one of "Submitting", "Holding", "Dispatching", "Running", "Cancelling", "Cancelled", "Succeeded", "Failed", "Succeeded With Warning"
1373
+ # resp.next_token #=> String
1374
+ #
1375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListBatchJobExecutions AWS API Documentation
1376
+ #
1377
+ # @overload list_batch_job_executions(params = {})
1378
+ # @param [Hash] params ({})
1379
+ def list_batch_job_executions(params = {}, options = {})
1380
+ req = build_request(:list_batch_job_executions, params)
1381
+ req.send_request(options)
1382
+ end
1383
+
1384
+ # Lists the data set imports for the specified application.
1385
+ #
1386
+ # @option params [required, String] :application_id
1387
+ # The unique identifier of the application.
1388
+ #
1389
+ # @option params [Integer] :max_results
1390
+ # The maximum number of objects to return.
1391
+ #
1392
+ # @option params [String] :next_token
1393
+ # A pagination token returned from a previous call to this operation.
1394
+ # This specifies the next item to return. To return to the beginning of
1395
+ # the list, exclude this parameter.
1396
+ #
1397
+ # @return [Types::ListDataSetImportHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1398
+ #
1399
+ # * {Types::ListDataSetImportHistoryResponse#data_set_import_tasks #data_set_import_tasks} => Array&lt;Types::DataSetImportTask&gt;
1400
+ # * {Types::ListDataSetImportHistoryResponse#next_token #next_token} => String
1401
+ #
1402
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1403
+ #
1404
+ # @example Request syntax with placeholder values
1405
+ #
1406
+ # resp = client.list_data_set_import_history({
1407
+ # application_id: "Identifier", # required
1408
+ # max_results: 1,
1409
+ # next_token: "NextToken",
1410
+ # })
1411
+ #
1412
+ # @example Response structure
1413
+ #
1414
+ # resp.data_set_import_tasks #=> Array
1415
+ # resp.data_set_import_tasks[0].status #=> String, one of "Creating", "Running", "Completed"
1416
+ # resp.data_set_import_tasks[0].summary.failed #=> Integer
1417
+ # resp.data_set_import_tasks[0].summary.in_progress #=> Integer
1418
+ # resp.data_set_import_tasks[0].summary.pending #=> Integer
1419
+ # resp.data_set_import_tasks[0].summary.succeeded #=> Integer
1420
+ # resp.data_set_import_tasks[0].summary.total #=> Integer
1421
+ # resp.data_set_import_tasks[0].task_id #=> String
1422
+ # resp.next_token #=> String
1423
+ #
1424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListDataSetImportHistory AWS API Documentation
1425
+ #
1426
+ # @overload list_data_set_import_history(params = {})
1427
+ # @param [Hash] params ({})
1428
+ def list_data_set_import_history(params = {}, options = {})
1429
+ req = build_request(:list_data_set_import_history, params)
1430
+ req.send_request(options)
1431
+ end
1432
+
1433
+ # Lists the data sets imported for a specific application. In Amazon Web
1434
+ # Services Mainframe Modernization, data sets are associated with
1435
+ # applications deployed on environments. This is known as importing data
1436
+ # sets. Currently, Amazon Web Services Mainframe Modernization can
1437
+ # import data sets into catalogs using [CreateDataSetImportTask][1].
1438
+ #
1439
+ #
1440
+ #
1441
+ # [1]: https://docs.aws.amazon.com/m2/latest/APIReference/API_CreateDataSetImportTask.html
1442
+ #
1443
+ # @option params [required, String] :application_id
1444
+ # The unique identifier of the application for which you want to list
1445
+ # the associated data sets.
1446
+ #
1447
+ # @option params [Integer] :max_results
1448
+ # The maximum number of objects to return.
1449
+ #
1450
+ # @option params [String] :next_token
1451
+ # A pagination token returned from a previous call to this operation.
1452
+ # This specifies the next item to return. To return to the beginning of
1453
+ # the list, exclude this parameter.
1454
+ #
1455
+ # @option params [String] :prefix
1456
+ # The prefix of the data set name, which you can use to filter the list
1457
+ # of data sets.
1458
+ #
1459
+ # @return [Types::ListDataSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1460
+ #
1461
+ # * {Types::ListDataSetsResponse#data_sets #data_sets} => Array&lt;Types::DataSetSummary&gt;
1462
+ # * {Types::ListDataSetsResponse#next_token #next_token} => String
1463
+ #
1464
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1465
+ #
1466
+ # @example Request syntax with placeholder values
1467
+ #
1468
+ # resp = client.list_data_sets({
1469
+ # application_id: "Identifier", # required
1470
+ # max_results: 1,
1471
+ # next_token: "NextToken",
1472
+ # prefix: "String200",
1473
+ # })
1474
+ #
1475
+ # @example Response structure
1476
+ #
1477
+ # resp.data_sets #=> Array
1478
+ # resp.data_sets[0].creation_time #=> Time
1479
+ # resp.data_sets[0].data_set_name #=> String
1480
+ # resp.data_sets[0].data_set_org #=> String
1481
+ # resp.data_sets[0].format #=> String
1482
+ # resp.data_sets[0].last_referenced_time #=> Time
1483
+ # resp.data_sets[0].last_updated_time #=> Time
1484
+ # resp.next_token #=> String
1485
+ #
1486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListDataSets AWS API Documentation
1487
+ #
1488
+ # @overload list_data_sets(params = {})
1489
+ # @param [Hash] params ({})
1490
+ def list_data_sets(params = {}, options = {})
1491
+ req = build_request(:list_data_sets, params)
1492
+ req.send_request(options)
1493
+ end
1494
+
1495
+ # Returns a list of all deployments of a specific application. A
1496
+ # deployment is a combination of a specific application and a specific
1497
+ # version of that application. Each deployment is mapped to a particular
1498
+ # application version.
1499
+ #
1500
+ # @option params [required, String] :application_id
1501
+ # The application identifier.
1502
+ #
1503
+ # @option params [Integer] :max_results
1504
+ # The maximum number of objects to return.
1505
+ #
1506
+ # @option params [String] :next_token
1507
+ # A pagination token returned from a previous call to this operation.
1508
+ # This specifies the next item to return. To return to the beginning of
1509
+ # the list, exclude this parameter.
1510
+ #
1511
+ # @return [Types::ListDeploymentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1512
+ #
1513
+ # * {Types::ListDeploymentsResponse#deployments #deployments} => Array&lt;Types::DeploymentSummary&gt;
1514
+ # * {Types::ListDeploymentsResponse#next_token #next_token} => String
1515
+ #
1516
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1517
+ #
1518
+ # @example Request syntax with placeholder values
1519
+ #
1520
+ # resp = client.list_deployments({
1521
+ # application_id: "Identifier", # required
1522
+ # max_results: 1,
1523
+ # next_token: "NextToken",
1524
+ # })
1525
+ #
1526
+ # @example Response structure
1527
+ #
1528
+ # resp.deployments #=> Array
1529
+ # resp.deployments[0].application_id #=> String
1530
+ # resp.deployments[0].application_version #=> Integer
1531
+ # resp.deployments[0].creation_time #=> Time
1532
+ # resp.deployments[0].deployment_id #=> String
1533
+ # resp.deployments[0].environment_id #=> String
1534
+ # resp.deployments[0].status #=> String, one of "Deploying", "Succeeded", "Failed"
1535
+ # resp.deployments[0].status_reason #=> String
1536
+ # resp.next_token #=> String
1537
+ #
1538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListDeployments AWS API Documentation
1539
+ #
1540
+ # @overload list_deployments(params = {})
1541
+ # @param [Hash] params ({})
1542
+ def list_deployments(params = {}, options = {})
1543
+ req = build_request(:list_deployments, params)
1544
+ req.send_request(options)
1545
+ end
1546
+
1547
+ # Lists the available engine versions.
1548
+ #
1549
+ # @option params [String] :engine_type
1550
+ # The type of target platform.
1551
+ #
1552
+ # @option params [Integer] :max_results
1553
+ # The maximum number of objects to return.
1554
+ #
1555
+ # @option params [String] :next_token
1556
+ # A pagination token returned from a previous call to this operation.
1557
+ # This specifies the next item to return. To return to the beginning of
1558
+ # the list, exclude this parameter.
1559
+ #
1560
+ # @return [Types::ListEngineVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1561
+ #
1562
+ # * {Types::ListEngineVersionsResponse#engine_versions #engine_versions} => Array&lt;Types::EngineVersionsSummary&gt;
1563
+ # * {Types::ListEngineVersionsResponse#next_token #next_token} => String
1564
+ #
1565
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1566
+ #
1567
+ # @example Request syntax with placeholder values
1568
+ #
1569
+ # resp = client.list_engine_versions({
1570
+ # engine_type: "microfocus", # accepts microfocus, bluage
1571
+ # max_results: 1,
1572
+ # next_token: "NextToken",
1573
+ # })
1574
+ #
1575
+ # @example Response structure
1576
+ #
1577
+ # resp.engine_versions #=> Array
1578
+ # resp.engine_versions[0].engine_type #=> String
1579
+ # resp.engine_versions[0].engine_version #=> String
1580
+ # resp.next_token #=> String
1581
+ #
1582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListEngineVersions AWS API Documentation
1583
+ #
1584
+ # @overload list_engine_versions(params = {})
1585
+ # @param [Hash] params ({})
1586
+ def list_engine_versions(params = {}, options = {})
1587
+ req = build_request(:list_engine_versions, params)
1588
+ req.send_request(options)
1589
+ end
1590
+
1591
+ # Lists the runtime environments.
1592
+ #
1593
+ # @option params [String] :engine_type
1594
+ # The engine type for the environment.
1595
+ #
1596
+ # @option params [Integer] :max_results
1597
+ # The maximum number of environments to return.
1598
+ #
1599
+ # @option params [Array<String>] :names
1600
+ # The name of the environment.
1601
+ #
1602
+ # @option params [String] :next_token
1603
+ # A pagination token to control the number of environments displayed in
1604
+ # the list.
1605
+ #
1606
+ # @return [Types::ListEnvironmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1607
+ #
1608
+ # * {Types::ListEnvironmentsResponse#environments #environments} => Array&lt;Types::EnvironmentSummary&gt;
1609
+ # * {Types::ListEnvironmentsResponse#next_token #next_token} => String
1610
+ #
1611
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1612
+ #
1613
+ # @example Request syntax with placeholder values
1614
+ #
1615
+ # resp = client.list_environments({
1616
+ # engine_type: "microfocus", # accepts microfocus, bluage
1617
+ # max_results: 1,
1618
+ # names: ["EntityName"],
1619
+ # next_token: "NextToken",
1620
+ # })
1621
+ #
1622
+ # @example Response structure
1623
+ #
1624
+ # resp.environments #=> Array
1625
+ # resp.environments[0].creation_time #=> Time
1626
+ # resp.environments[0].engine_type #=> String, one of "microfocus", "bluage"
1627
+ # resp.environments[0].engine_version #=> String
1628
+ # resp.environments[0].environment_arn #=> String
1629
+ # resp.environments[0].environment_id #=> String
1630
+ # resp.environments[0].instance_type #=> String
1631
+ # resp.environments[0].name #=> String
1632
+ # resp.environments[0].status #=> String, one of "Creating", "Available", "Deleting", "Failed"
1633
+ # resp.next_token #=> String
1634
+ #
1635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListEnvironments AWS API Documentation
1636
+ #
1637
+ # @overload list_environments(params = {})
1638
+ # @param [Hash] params ({})
1639
+ def list_environments(params = {}, options = {})
1640
+ req = build_request(:list_environments, params)
1641
+ req.send_request(options)
1642
+ end
1643
+
1644
+ # Lists the tags for the specified resource.
1645
+ #
1646
+ # @option params [required, String] :resource_arn
1647
+ # The Amazon Resource Name (ARN) of the resource.
1648
+ #
1649
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1650
+ #
1651
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
1652
+ #
1653
+ # @example Request syntax with placeholder values
1654
+ #
1655
+ # resp = client.list_tags_for_resource({
1656
+ # resource_arn: "Arn", # required
1657
+ # })
1658
+ #
1659
+ # @example Response structure
1660
+ #
1661
+ # resp.tags #=> Hash
1662
+ # resp.tags["TagKey"] #=> String
1663
+ #
1664
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListTagsForResource AWS API Documentation
1665
+ #
1666
+ # @overload list_tags_for_resource(params = {})
1667
+ # @param [Hash] params ({})
1668
+ def list_tags_for_resource(params = {}, options = {})
1669
+ req = build_request(:list_tags_for_resource, params)
1670
+ req.send_request(options)
1671
+ end
1672
+
1673
+ # Starts an application that is currently stopped.
1674
+ #
1675
+ # @option params [required, String] :application_id
1676
+ # The unique identifier of the application you want to start.
1677
+ #
1678
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1679
+ #
1680
+ # @example Request syntax with placeholder values
1681
+ #
1682
+ # resp = client.start_application({
1683
+ # application_id: "Identifier", # required
1684
+ # })
1685
+ #
1686
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/StartApplication AWS API Documentation
1687
+ #
1688
+ # @overload start_application(params = {})
1689
+ # @param [Hash] params ({})
1690
+ def start_application(params = {}, options = {})
1691
+ req = build_request(:start_application, params)
1692
+ req.send_request(options)
1693
+ end
1694
+
1695
+ # Starts a batch job and returns the unique identifier of this execution
1696
+ # of the batch job. The associated application must be running in order
1697
+ # to start the batch job.
1698
+ #
1699
+ # @option params [required, String] :application_id
1700
+ # The unique identifier of the application associated with this batch
1701
+ # job.
1702
+ #
1703
+ # @option params [required, Types::BatchJobIdentifier] :batch_job_identifier
1704
+ # The unique identifier of the batch job.
1705
+ #
1706
+ # @option params [Hash<String,String>] :job_params
1707
+ # The collection of batch job parameters. For details about limits for
1708
+ # keys and values, see [Coding variables in JCL][1].
1709
+ #
1710
+ #
1711
+ #
1712
+ # [1]: https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl
1713
+ #
1714
+ # @return [Types::StartBatchJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1715
+ #
1716
+ # * {Types::StartBatchJobResponse#execution_id #execution_id} => String
1717
+ #
1718
+ # @example Request syntax with placeholder values
1719
+ #
1720
+ # resp = client.start_batch_job({
1721
+ # application_id: "Identifier", # required
1722
+ # batch_job_identifier: { # required
1723
+ # file_batch_job_identifier: {
1724
+ # file_name: "String", # required
1725
+ # folder_path: "String",
1726
+ # },
1727
+ # script_batch_job_identifier: {
1728
+ # script_name: "String", # required
1729
+ # },
1730
+ # },
1731
+ # job_params: {
1732
+ # "BatchParamKey" => "BatchParamValue",
1733
+ # },
1734
+ # })
1735
+ #
1736
+ # @example Response structure
1737
+ #
1738
+ # resp.execution_id #=> String
1739
+ #
1740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/StartBatchJob AWS API Documentation
1741
+ #
1742
+ # @overload start_batch_job(params = {})
1743
+ # @param [Hash] params ({})
1744
+ def start_batch_job(params = {}, options = {})
1745
+ req = build_request(:start_batch_job, params)
1746
+ req.send_request(options)
1747
+ end
1748
+
1749
+ # Stops a running application.
1750
+ #
1751
+ # @option params [required, String] :application_id
1752
+ # The unique identifier of the application you want to stop.
1753
+ #
1754
+ # @option params [Boolean] :force_stop
1755
+ # Stopping an application process can take a long time. Setting this
1756
+ # parameter to true lets you force stop the application so you don't
1757
+ # need to wait until the process finishes to apply another action on the
1758
+ # application. The default value is false.
1759
+ #
1760
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1761
+ #
1762
+ # @example Request syntax with placeholder values
1763
+ #
1764
+ # resp = client.stop_application({
1765
+ # application_id: "Identifier", # required
1766
+ # force_stop: false,
1767
+ # })
1768
+ #
1769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/StopApplication AWS API Documentation
1770
+ #
1771
+ # @overload stop_application(params = {})
1772
+ # @param [Hash] params ({})
1773
+ def stop_application(params = {}, options = {})
1774
+ req = build_request(:stop_application, params)
1775
+ req.send_request(options)
1776
+ end
1777
+
1778
+ # Adds one or more tags to the specified resource.
1779
+ #
1780
+ # @option params [required, String] :resource_arn
1781
+ # The Amazon Resource Name (ARN) of the resource.
1782
+ #
1783
+ # @option params [required, Hash<String,String>] :tags
1784
+ # The tags to add to the resource.
1785
+ #
1786
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1787
+ #
1788
+ # @example Request syntax with placeholder values
1789
+ #
1790
+ # resp = client.tag_resource({
1791
+ # resource_arn: "Arn", # required
1792
+ # tags: { # required
1793
+ # "TagKey" => "TagValue",
1794
+ # },
1795
+ # })
1796
+ #
1797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/TagResource AWS API Documentation
1798
+ #
1799
+ # @overload tag_resource(params = {})
1800
+ # @param [Hash] params ({})
1801
+ def tag_resource(params = {}, options = {})
1802
+ req = build_request(:tag_resource, params)
1803
+ req.send_request(options)
1804
+ end
1805
+
1806
+ # Removes one or more tags from the specified resource.
1807
+ #
1808
+ # @option params [required, String] :resource_arn
1809
+ # The Amazon Resource Name (ARN) of the resource.
1810
+ #
1811
+ # @option params [required, Array<String>] :tag_keys
1812
+ # The keys of the tags to remove.
1813
+ #
1814
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1815
+ #
1816
+ # @example Request syntax with placeholder values
1817
+ #
1818
+ # resp = client.untag_resource({
1819
+ # resource_arn: "Arn", # required
1820
+ # tag_keys: ["TagKey"], # required
1821
+ # })
1822
+ #
1823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/UntagResource AWS API Documentation
1824
+ #
1825
+ # @overload untag_resource(params = {})
1826
+ # @param [Hash] params ({})
1827
+ def untag_resource(params = {}, options = {})
1828
+ req = build_request(:untag_resource, params)
1829
+ req.send_request(options)
1830
+ end
1831
+
1832
+ # Updates an application and creates a new version.
1833
+ #
1834
+ # @option params [required, String] :application_id
1835
+ # The unique identifier of the application you want to update.
1836
+ #
1837
+ # @option params [required, Integer] :current_application_version
1838
+ # The current version of the application to update.
1839
+ #
1840
+ # @option params [Types::Definition] :definition
1841
+ # The application definition for this application. You can specify
1842
+ # either inline JSON or an S3 bucket location.
1843
+ #
1844
+ # @option params [String] :description
1845
+ # The description of the application to update.
1846
+ #
1847
+ # @return [Types::UpdateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1848
+ #
1849
+ # * {Types::UpdateApplicationResponse#application_version #application_version} => Integer
1850
+ #
1851
+ # @example Request syntax with placeholder values
1852
+ #
1853
+ # resp = client.update_application({
1854
+ # application_id: "Identifier", # required
1855
+ # current_application_version: 1, # required
1856
+ # definition: {
1857
+ # content: "StringFree65000",
1858
+ # s3_location: "String2000",
1859
+ # },
1860
+ # description: "EntityDescription",
1861
+ # })
1862
+ #
1863
+ # @example Response structure
1864
+ #
1865
+ # resp.application_version #=> Integer
1866
+ #
1867
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/UpdateApplication AWS API Documentation
1868
+ #
1869
+ # @overload update_application(params = {})
1870
+ # @param [Hash] params ({})
1871
+ def update_application(params = {}, options = {})
1872
+ req = build_request(:update_application, params)
1873
+ req.send_request(options)
1874
+ end
1875
+
1876
+ # Updates the configuration details for a specific environment.
1877
+ #
1878
+ # @option params [Boolean] :apply_during_maintenance_window
1879
+ # Indicates whether to update the environment during the maintenance
1880
+ # window. The default is false. Currently, Amazon Web Services Mainframe
1881
+ # Modernization accepts the `engineVersion` parameter only if
1882
+ # `applyDuringMaintenanceWindow` is true. If any parameter other than
1883
+ # `engineVersion` is provided in `UpdateEnvironmentRequest`, it will
1884
+ # fail if `applyDuringMaintenanceWindow` is set to true.
1885
+ #
1886
+ # @option params [Integer] :desired_capacity
1887
+ # The desired capacity for the environment to update.
1888
+ #
1889
+ # @option params [String] :engine_version
1890
+ # The version of the runtime engine for the environment.
1891
+ #
1892
+ # @option params [required, String] :environment_id
1893
+ # The unique identifier of the runtime environment that you want to
1894
+ # update.
1895
+ #
1896
+ # @option params [String] :instance_type
1897
+ # The instance type for the environment to update.
1898
+ #
1899
+ # @option params [String] :preferred_maintenance_window
1900
+ # Configures a desired maintenance window for the environment. If you do
1901
+ # not provide a value, a random system-generated value will be assigned.
1902
+ #
1903
+ # @return [Types::UpdateEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1904
+ #
1905
+ # * {Types::UpdateEnvironmentResponse#environment_id #environment_id} => String
1906
+ #
1907
+ # @example Request syntax with placeholder values
1908
+ #
1909
+ # resp = client.update_environment({
1910
+ # apply_during_maintenance_window: false,
1911
+ # desired_capacity: 1,
1912
+ # engine_version: "EngineVersion",
1913
+ # environment_id: "Identifier", # required
1914
+ # instance_type: "String20",
1915
+ # preferred_maintenance_window: "String",
1916
+ # })
1917
+ #
1918
+ # @example Response structure
1919
+ #
1920
+ # resp.environment_id #=> String
1921
+ #
1922
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/UpdateEnvironment AWS API Documentation
1923
+ #
1924
+ # @overload update_environment(params = {})
1925
+ # @param [Hash] params ({})
1926
+ def update_environment(params = {}, options = {})
1927
+ req = build_request(:update_environment, params)
1928
+ req.send_request(options)
1929
+ end
1930
+
1931
+ # @!endgroup
1932
+
1933
+ # @param params ({})
1934
+ # @api private
1935
+ def build_request(operation_name, params = {})
1936
+ handlers = @handlers.for(operation_name)
1937
+ context = Seahorse::Client::RequestContext.new(
1938
+ operation_name: operation_name,
1939
+ operation: config.api.operation(operation_name),
1940
+ client: self,
1941
+ params: params,
1942
+ config: config)
1943
+ context[:gem_name] = 'aws-sdk-mainframemodernization'
1944
+ context[:gem_version] = '1.0.0'
1945
+ Seahorse::Client::Request.new(handlers, context)
1946
+ end
1947
+
1948
+ # @api private
1949
+ # @deprecated
1950
+ def waiter_names
1951
+ []
1952
+ end
1953
+
1954
+ class << self
1955
+
1956
+ # @api private
1957
+ attr_reader :identifier
1958
+
1959
+ # @api private
1960
+ def errors_module
1961
+ Errors
1962
+ end
1963
+
1964
+ end
1965
+ end
1966
+ end