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,3377 @@
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
+ module Aws::MainframeModernization
11
+ module Types
12
+
13
+ # The account or role doesn't have the right permissions to make the
14
+ # request.
15
+ #
16
+ # @!attribute [rw] message
17
+ # @return [String]
18
+ #
19
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/AccessDeniedException AWS API Documentation
20
+ #
21
+ class AccessDeniedException < Struct.new(
22
+ :message)
23
+ SENSITIVE = []
24
+ include Aws::Structure
25
+ end
26
+
27
+ # Defines an alternate key. This value is optional. A legacy data set
28
+ # might not have any alternate key defined but if those alternate keys
29
+ # definitions exist, provide them, as some applications will make use of
30
+ # them.
31
+ #
32
+ # @note When making an API call, you may pass AlternateKey
33
+ # data as a hash:
34
+ #
35
+ # {
36
+ # allow_duplicates: false,
37
+ # length: 1, # required
38
+ # name: "String",
39
+ # offset: 1, # required
40
+ # }
41
+ #
42
+ # @!attribute [rw] allow_duplicates
43
+ # Indicates whether the alternate key values are supposed to be unique
44
+ # for the given data set.
45
+ # @return [Boolean]
46
+ #
47
+ # @!attribute [rw] length
48
+ # A strictly positive integer value representing the length of the
49
+ # alternate key.
50
+ # @return [Integer]
51
+ #
52
+ # @!attribute [rw] name
53
+ # The name of the alternate key.
54
+ # @return [String]
55
+ #
56
+ # @!attribute [rw] offset
57
+ # A positive integer value representing the offset to mark the start
58
+ # of the alternate key part in the record byte array.
59
+ # @return [Integer]
60
+ #
61
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/AlternateKey AWS API Documentation
62
+ #
63
+ class AlternateKey < Struct.new(
64
+ :allow_duplicates,
65
+ :length,
66
+ :name,
67
+ :offset)
68
+ SENSITIVE = []
69
+ include Aws::Structure
70
+ end
71
+
72
+ # A subset of the possible application attributes. Used in the
73
+ # application list.
74
+ #
75
+ # @!attribute [rw] application_arn
76
+ # The Amazon Resource Name (ARN) of the application.
77
+ # @return [String]
78
+ #
79
+ # @!attribute [rw] application_id
80
+ # The unique identifier of the application.
81
+ # @return [String]
82
+ #
83
+ # @!attribute [rw] application_version
84
+ # The version of the application.
85
+ # @return [Integer]
86
+ #
87
+ # @!attribute [rw] creation_time
88
+ # The timestamp when the application was created.
89
+ # @return [Time]
90
+ #
91
+ # @!attribute [rw] deployment_status
92
+ # Indicates whether there is an ongoing deployment or if the
93
+ # application has ever deployed successfully.
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] description
97
+ # The description of the application.
98
+ # @return [String]
99
+ #
100
+ # @!attribute [rw] engine_type
101
+ # The type of the target platform for this application.
102
+ # @return [String]
103
+ #
104
+ # @!attribute [rw] environment_id
105
+ # The unique identifier of the runtime environment that hosts this
106
+ # application.
107
+ # @return [String]
108
+ #
109
+ # @!attribute [rw] last_start_time
110
+ # The timestamp when the application was last started. Null until the
111
+ # application has started running for the first time.
112
+ # @return [Time]
113
+ #
114
+ # @!attribute [rw] name
115
+ # The name of the application.
116
+ # @return [String]
117
+ #
118
+ # @!attribute [rw] status
119
+ # The status of the application.
120
+ # @return [String]
121
+ #
122
+ # @!attribute [rw] version_status
123
+ # Indicates the status of the latest version of the application.
124
+ # @return [String]
125
+ #
126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ApplicationSummary AWS API Documentation
127
+ #
128
+ class ApplicationSummary < Struct.new(
129
+ :application_arn,
130
+ :application_id,
131
+ :application_version,
132
+ :creation_time,
133
+ :deployment_status,
134
+ :description,
135
+ :engine_type,
136
+ :environment_id,
137
+ :last_start_time,
138
+ :name,
139
+ :status,
140
+ :version_status)
141
+ SENSITIVE = []
142
+ include Aws::Structure
143
+ end
144
+
145
+ # Defines an application version summary.
146
+ #
147
+ # @!attribute [rw] application_version
148
+ # The application version.
149
+ # @return [Integer]
150
+ #
151
+ # @!attribute [rw] creation_time
152
+ # The timestamp when the application version was created.
153
+ # @return [Time]
154
+ #
155
+ # @!attribute [rw] status
156
+ # The status of the application.
157
+ # @return [String]
158
+ #
159
+ # @!attribute [rw] status_reason
160
+ # The reason for the reported status.
161
+ # @return [String]
162
+ #
163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ApplicationVersionSummary AWS API Documentation
164
+ #
165
+ class ApplicationVersionSummary < Struct.new(
166
+ :application_version,
167
+ :creation_time,
168
+ :status,
169
+ :status_reason)
170
+ SENSITIVE = []
171
+ include Aws::Structure
172
+ end
173
+
174
+ # Defines the details of a batch job.
175
+ #
176
+ # @note BatchJobDefinition is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of BatchJobDefinition corresponding to the set member.
177
+ #
178
+ # @!attribute [rw] file_batch_job_definition
179
+ # Specifies a file containing a batch job definition.
180
+ # @return [Types::FileBatchJobDefinition]
181
+ #
182
+ # @!attribute [rw] script_batch_job_definition
183
+ # A script containing a batch job definition.
184
+ # @return [Types::ScriptBatchJobDefinition]
185
+ #
186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/BatchJobDefinition AWS API Documentation
187
+ #
188
+ class BatchJobDefinition < Struct.new(
189
+ :file_batch_job_definition,
190
+ :script_batch_job_definition,
191
+ :unknown)
192
+ SENSITIVE = []
193
+ include Aws::Structure
194
+ include Aws::Structure::Union
195
+
196
+ class FileBatchJobDefinition < BatchJobDefinition; end
197
+ class ScriptBatchJobDefinition < BatchJobDefinition; end
198
+ class Unknown < BatchJobDefinition; end
199
+ end
200
+
201
+ # A subset of the possible batch job attributes. Used in the batch job
202
+ # list.
203
+ #
204
+ # @!attribute [rw] application_id
205
+ # The unique identifier of the application that hosts this batch job.
206
+ # @return [String]
207
+ #
208
+ # @!attribute [rw] end_time
209
+ # The timestamp when this batch job execution ended.
210
+ # @return [Time]
211
+ #
212
+ # @!attribute [rw] execution_id
213
+ # The unique identifier of this execution of the batch job.
214
+ # @return [String]
215
+ #
216
+ # @!attribute [rw] job_id
217
+ # The unique identifier of a particular batch job.
218
+ # @return [String]
219
+ #
220
+ # @!attribute [rw] job_name
221
+ # The name of a particular batch job.
222
+ # @return [String]
223
+ #
224
+ # @!attribute [rw] job_type
225
+ # The type of a particular batch job execution.
226
+ # @return [String]
227
+ #
228
+ # @!attribute [rw] start_time
229
+ # The timestamp when a particular batch job execution started.
230
+ # @return [Time]
231
+ #
232
+ # @!attribute [rw] status
233
+ # The status of a particular batch job execution.
234
+ # @return [String]
235
+ #
236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/BatchJobExecutionSummary AWS API Documentation
237
+ #
238
+ class BatchJobExecutionSummary < Struct.new(
239
+ :application_id,
240
+ :end_time,
241
+ :execution_id,
242
+ :job_id,
243
+ :job_name,
244
+ :job_type,
245
+ :start_time,
246
+ :status)
247
+ SENSITIVE = []
248
+ include Aws::Structure
249
+ end
250
+
251
+ # Identifies a specific batch job.
252
+ #
253
+ # @note BatchJobIdentifier is a union - when making an API calls you must set exactly one of the members.
254
+ #
255
+ # @!attribute [rw] file_batch_job_identifier
256
+ # Specifies a file associated with a specific batch job.
257
+ # @return [Types::FileBatchJobIdentifier]
258
+ #
259
+ # @!attribute [rw] script_batch_job_identifier
260
+ # A batch job identifier in which the batch job to run is identified
261
+ # by the script name.
262
+ # @return [Types::ScriptBatchJobIdentifier]
263
+ #
264
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/BatchJobIdentifier AWS API Documentation
265
+ #
266
+ class BatchJobIdentifier < Struct.new(
267
+ :file_batch_job_identifier,
268
+ :script_batch_job_identifier,
269
+ :unknown)
270
+ SENSITIVE = []
271
+ include Aws::Structure
272
+ include Aws::Structure::Union
273
+
274
+ class FileBatchJobIdentifier < BatchJobIdentifier; end
275
+ class ScriptBatchJobIdentifier < BatchJobIdentifier; end
276
+ class Unknown < BatchJobIdentifier; end
277
+ end
278
+
279
+ # @note When making an API call, you may pass CancelBatchJobExecutionRequest
280
+ # data as a hash:
281
+ #
282
+ # {
283
+ # application_id: "Identifier", # required
284
+ # execution_id: "Identifier", # required
285
+ # }
286
+ #
287
+ # @!attribute [rw] application_id
288
+ # The unique identifier of the application.
289
+ # @return [String]
290
+ #
291
+ # @!attribute [rw] execution_id
292
+ # The unique identifier of the batch job execution.
293
+ # @return [String]
294
+ #
295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CancelBatchJobExecutionRequest AWS API Documentation
296
+ #
297
+ class CancelBatchJobExecutionRequest < Struct.new(
298
+ :application_id,
299
+ :execution_id)
300
+ SENSITIVE = []
301
+ include Aws::Structure
302
+ end
303
+
304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CancelBatchJobExecutionResponse AWS API Documentation
305
+ #
306
+ class CancelBatchJobExecutionResponse < Aws::EmptyStructure; end
307
+
308
+ # The parameters provided in the request conflict with existing
309
+ # resources.
310
+ #
311
+ # @!attribute [rw] message
312
+ # @return [String]
313
+ #
314
+ # @!attribute [rw] resource_id
315
+ # The ID of the conflicting resource.
316
+ # @return [String]
317
+ #
318
+ # @!attribute [rw] resource_type
319
+ # The type of the conflicting resource.
320
+ # @return [String]
321
+ #
322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ConflictException AWS API Documentation
323
+ #
324
+ class ConflictException < Struct.new(
325
+ :message,
326
+ :resource_id,
327
+ :resource_type)
328
+ SENSITIVE = []
329
+ include Aws::Structure
330
+ end
331
+
332
+ # @note When making an API call, you may pass CreateApplicationRequest
333
+ # data as a hash:
334
+ #
335
+ # {
336
+ # client_token: "String",
337
+ # definition: { # required
338
+ # content: "StringFree65000",
339
+ # s3_location: "String2000",
340
+ # },
341
+ # description: "EntityDescription",
342
+ # engine_type: "microfocus", # required, accepts microfocus, bluage
343
+ # name: "EntityName", # required
344
+ # tags: {
345
+ # "TagKey" => "TagValue",
346
+ # },
347
+ # }
348
+ #
349
+ # @!attribute [rw] client_token
350
+ # Unique, case-sensitive identifier the service generates to ensure
351
+ # the idempotency of the request to create an application. The service
352
+ # generates the clientToken when the API call is triggered. The token
353
+ # expires after one hour, so if you retry the API within this
354
+ # timeframe with the same clientToken, you will get the same response.
355
+ # The service also handles deleting the clientToken after it expires.
356
+ #
357
+ # **A suitable default value is auto-generated.** You should normally
358
+ # not need to pass this option.
359
+ # @return [String]
360
+ #
361
+ # @!attribute [rw] definition
362
+ # The application definition for this application. You can specify
363
+ # either inline JSON or an S3 bucket location.
364
+ # @return [Types::Definition]
365
+ #
366
+ # @!attribute [rw] description
367
+ # The description of the application.
368
+ # @return [String]
369
+ #
370
+ # @!attribute [rw] engine_type
371
+ # The type of the target platform for this application.
372
+ # @return [String]
373
+ #
374
+ # @!attribute [rw] name
375
+ # The unique identifier of the application.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] tags
379
+ # A list of tags to apply to the application.
380
+ # @return [Hash<String,String>]
381
+ #
382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateApplicationRequest AWS API Documentation
383
+ #
384
+ class CreateApplicationRequest < Struct.new(
385
+ :client_token,
386
+ :definition,
387
+ :description,
388
+ :engine_type,
389
+ :name,
390
+ :tags)
391
+ SENSITIVE = []
392
+ include Aws::Structure
393
+ end
394
+
395
+ # @!attribute [rw] application_arn
396
+ # The Amazon Resource Name (ARN) of the application.
397
+ # @return [String]
398
+ #
399
+ # @!attribute [rw] application_id
400
+ # The unique application identifier.
401
+ # @return [String]
402
+ #
403
+ # @!attribute [rw] application_version
404
+ # The version number of the application.
405
+ # @return [Integer]
406
+ #
407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateApplicationResponse AWS API Documentation
408
+ #
409
+ class CreateApplicationResponse < Struct.new(
410
+ :application_arn,
411
+ :application_id,
412
+ :application_version)
413
+ SENSITIVE = []
414
+ include Aws::Structure
415
+ end
416
+
417
+ # @note When making an API call, you may pass CreateDataSetImportTaskRequest
418
+ # data as a hash:
419
+ #
420
+ # {
421
+ # application_id: "Identifier", # required
422
+ # client_token: "String",
423
+ # import_config: { # required
424
+ # data_sets: [
425
+ # {
426
+ # data_set: { # required
427
+ # dataset_name: "String", # required
428
+ # dataset_org: { # required
429
+ # gdg: {
430
+ # limit: 1,
431
+ # roll_disposition: "String",
432
+ # },
433
+ # vsam: {
434
+ # alternate_keys: [
435
+ # {
436
+ # allow_duplicates: false,
437
+ # length: 1, # required
438
+ # name: "String",
439
+ # offset: 1, # required
440
+ # },
441
+ # ],
442
+ # compressed: false,
443
+ # encoding: "String",
444
+ # format: "String", # required
445
+ # primary_key: {
446
+ # length: 1, # required
447
+ # name: "String",
448
+ # offset: 1, # required
449
+ # },
450
+ # },
451
+ # },
452
+ # record_length: { # required
453
+ # max: 1, # required
454
+ # min: 1, # required
455
+ # },
456
+ # relative_path: "String",
457
+ # storage_type: "String",
458
+ # },
459
+ # external_location: { # required
460
+ # s3_location: "String2000",
461
+ # },
462
+ # },
463
+ # ],
464
+ # s3_location: "String2000",
465
+ # },
466
+ # }
467
+ #
468
+ # @!attribute [rw] application_id
469
+ # The unique identifier of the application for which you want to
470
+ # import data sets.
471
+ # @return [String]
472
+ #
473
+ # @!attribute [rw] client_token
474
+ # Unique, case-sensitive identifier you provide to ensure the
475
+ # idempotency of the request to create a data set import. The service
476
+ # generates the clientToken when the API call is triggered. The token
477
+ # expires after one hour, so if you retry the API within this
478
+ # timeframe with the same clientToken, you will get the same response.
479
+ # The service also handles deleting the clientToken after it expires.
480
+ #
481
+ # **A suitable default value is auto-generated.** You should normally
482
+ # not need to pass this option.
483
+ # @return [String]
484
+ #
485
+ # @!attribute [rw] import_config
486
+ # The data set import task configuration.
487
+ # @return [Types::DataSetImportConfig]
488
+ #
489
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateDataSetImportTaskRequest AWS API Documentation
490
+ #
491
+ class CreateDataSetImportTaskRequest < Struct.new(
492
+ :application_id,
493
+ :client_token,
494
+ :import_config)
495
+ SENSITIVE = []
496
+ include Aws::Structure
497
+ end
498
+
499
+ # @!attribute [rw] task_id
500
+ # The task identifier. This operation is asynchronous. Use this
501
+ # identifier with the GetDataSetImportTask operation to obtain the
502
+ # status of this task.
503
+ # @return [String]
504
+ #
505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateDataSetImportTaskResponse AWS API Documentation
506
+ #
507
+ class CreateDataSetImportTaskResponse < Struct.new(
508
+ :task_id)
509
+ SENSITIVE = []
510
+ include Aws::Structure
511
+ end
512
+
513
+ # @note When making an API call, you may pass CreateDeploymentRequest
514
+ # data as a hash:
515
+ #
516
+ # {
517
+ # application_id: "Identifier", # required
518
+ # application_version: 1, # required
519
+ # client_token: "String",
520
+ # environment_id: "Identifier", # required
521
+ # }
522
+ #
523
+ # @!attribute [rw] application_id
524
+ # The application identifier.
525
+ # @return [String]
526
+ #
527
+ # @!attribute [rw] application_version
528
+ # The version of the application to deploy.
529
+ # @return [Integer]
530
+ #
531
+ # @!attribute [rw] client_token
532
+ # Unique, case-sensitive identifier you provide to ensure the
533
+ # idempotency of the request to create a deployment. The service
534
+ # generates the clientToken when the API call is triggered. The token
535
+ # expires after one hour, so if you retry the API within this
536
+ # timeframe with the same clientToken, you will get the same response.
537
+ # The service also handles deleting the clientToken after it expires.
538
+ #
539
+ # **A suitable default value is auto-generated.** You should normally
540
+ # not need to pass this option.
541
+ # @return [String]
542
+ #
543
+ # @!attribute [rw] environment_id
544
+ # The identifier of the environment where this application will be
545
+ # deployed.
546
+ # @return [String]
547
+ #
548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateDeploymentRequest AWS API Documentation
549
+ #
550
+ class CreateDeploymentRequest < Struct.new(
551
+ :application_id,
552
+ :application_version,
553
+ :client_token,
554
+ :environment_id)
555
+ SENSITIVE = []
556
+ include Aws::Structure
557
+ end
558
+
559
+ # @!attribute [rw] deployment_id
560
+ # The unique identifier of the deployment.
561
+ # @return [String]
562
+ #
563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateDeploymentResponse AWS API Documentation
564
+ #
565
+ class CreateDeploymentResponse < Struct.new(
566
+ :deployment_id)
567
+ SENSITIVE = []
568
+ include Aws::Structure
569
+ end
570
+
571
+ # @note When making an API call, you may pass CreateEnvironmentRequest
572
+ # data as a hash:
573
+ #
574
+ # {
575
+ # client_token: "String",
576
+ # description: "EntityDescription",
577
+ # engine_type: "microfocus", # required, accepts microfocus, bluage
578
+ # engine_version: "EngineVersion",
579
+ # high_availability_config: {
580
+ # desired_capacity: 1, # required
581
+ # },
582
+ # instance_type: "String20", # required
583
+ # name: "EntityName", # required
584
+ # preferred_maintenance_window: "String50",
585
+ # publicly_accessible: false,
586
+ # security_group_ids: ["String50"],
587
+ # storage_configurations: [
588
+ # {
589
+ # efs: {
590
+ # file_system_id: "String200", # required
591
+ # mount_point: "String200", # required
592
+ # },
593
+ # fsx: {
594
+ # file_system_id: "String200", # required
595
+ # mount_point: "String200", # required
596
+ # },
597
+ # },
598
+ # ],
599
+ # subnet_ids: ["String50"],
600
+ # tags: {
601
+ # "TagKey" => "TagValue",
602
+ # },
603
+ # }
604
+ #
605
+ # @!attribute [rw] client_token
606
+ # Unique, case-sensitive identifier you provide to ensure the
607
+ # idempotency of the request to create an environment. The service
608
+ # generates the clientToken when the API call is triggered. The token
609
+ # expires after one hour, so if you retry the API within this
610
+ # timeframe with the same clientToken, you will get the same response.
611
+ # The service also handles deleting the clientToken after it expires.
612
+ #
613
+ # **A suitable default value is auto-generated.** You should normally
614
+ # not need to pass this option.
615
+ # @return [String]
616
+ #
617
+ # @!attribute [rw] description
618
+ # The description of the environment.
619
+ # @return [String]
620
+ #
621
+ # @!attribute [rw] engine_type
622
+ # The engine type for the environment.
623
+ # @return [String]
624
+ #
625
+ # @!attribute [rw] engine_version
626
+ # The version of the engine type for the environment.
627
+ # @return [String]
628
+ #
629
+ # @!attribute [rw] high_availability_config
630
+ # The details of a high availability configuration for this runtime
631
+ # environment.
632
+ # @return [Types::HighAvailabilityConfig]
633
+ #
634
+ # @!attribute [rw] instance_type
635
+ # The type of instance for the environment.
636
+ # @return [String]
637
+ #
638
+ # @!attribute [rw] name
639
+ # The unique identifier of the environment.
640
+ # @return [String]
641
+ #
642
+ # @!attribute [rw] preferred_maintenance_window
643
+ # Configures a desired maintenance window for the environment. If you
644
+ # do not provide a value, a random system-generated value will be
645
+ # assigned.
646
+ # @return [String]
647
+ #
648
+ # @!attribute [rw] publicly_accessible
649
+ # Specifies whether the environment is publicly accessible.
650
+ # @return [Boolean]
651
+ #
652
+ # @!attribute [rw] security_group_ids
653
+ # The list of security groups for the VPC associated with this
654
+ # environment.
655
+ # @return [Array<String>]
656
+ #
657
+ # @!attribute [rw] storage_configurations
658
+ # Optional. The storage configurations for this environment.
659
+ # @return [Array<Types::StorageConfiguration>]
660
+ #
661
+ # @!attribute [rw] subnet_ids
662
+ # The list of subnets associated with the VPC for this environment.
663
+ # @return [Array<String>]
664
+ #
665
+ # @!attribute [rw] tags
666
+ # The tags for the environment.
667
+ # @return [Hash<String,String>]
668
+ #
669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateEnvironmentRequest AWS API Documentation
670
+ #
671
+ class CreateEnvironmentRequest < Struct.new(
672
+ :client_token,
673
+ :description,
674
+ :engine_type,
675
+ :engine_version,
676
+ :high_availability_config,
677
+ :instance_type,
678
+ :name,
679
+ :preferred_maintenance_window,
680
+ :publicly_accessible,
681
+ :security_group_ids,
682
+ :storage_configurations,
683
+ :subnet_ids,
684
+ :tags)
685
+ SENSITIVE = []
686
+ include Aws::Structure
687
+ end
688
+
689
+ # @!attribute [rw] environment_id
690
+ # The identifier of this environment.
691
+ # @return [String]
692
+ #
693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/CreateEnvironmentResponse AWS API Documentation
694
+ #
695
+ class CreateEnvironmentResponse < Struct.new(
696
+ :environment_id)
697
+ SENSITIVE = []
698
+ include Aws::Structure
699
+ end
700
+
701
+ # Defines a data set.
702
+ #
703
+ # @note When making an API call, you may pass DataSet
704
+ # data as a hash:
705
+ #
706
+ # {
707
+ # dataset_name: "String", # required
708
+ # dataset_org: { # required
709
+ # gdg: {
710
+ # limit: 1,
711
+ # roll_disposition: "String",
712
+ # },
713
+ # vsam: {
714
+ # alternate_keys: [
715
+ # {
716
+ # allow_duplicates: false,
717
+ # length: 1, # required
718
+ # name: "String",
719
+ # offset: 1, # required
720
+ # },
721
+ # ],
722
+ # compressed: false,
723
+ # encoding: "String",
724
+ # format: "String", # required
725
+ # primary_key: {
726
+ # length: 1, # required
727
+ # name: "String",
728
+ # offset: 1, # required
729
+ # },
730
+ # },
731
+ # },
732
+ # record_length: { # required
733
+ # max: 1, # required
734
+ # min: 1, # required
735
+ # },
736
+ # relative_path: "String",
737
+ # storage_type: "String",
738
+ # }
739
+ #
740
+ # @!attribute [rw] dataset_name
741
+ # The logical identifier for a specific data set (in mainframe
742
+ # format).
743
+ # @return [String]
744
+ #
745
+ # @!attribute [rw] dataset_org
746
+ # The type of dataset. Possible values include VSAM, IS, PS, GDG, PO,
747
+ # PS, UNKNOWN etc.
748
+ # @return [Types::DatasetOrgAttributes]
749
+ #
750
+ # @!attribute [rw] record_length
751
+ # The length of a record.
752
+ # @return [Types::RecordLength]
753
+ #
754
+ # @!attribute [rw] relative_path
755
+ # The relative location of the data set in the database or file
756
+ # system.
757
+ # @return [String]
758
+ #
759
+ # @!attribute [rw] storage_type
760
+ # The storage type of the data set: database or file system. For Micro
761
+ # Focus, database corresponds to datastore and file system corresponds
762
+ # to EFS/FSX. For Blu Age, there is no support of file system and
763
+ # database corresponds to Blusam.
764
+ # @return [String]
765
+ #
766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DataSet AWS API Documentation
767
+ #
768
+ class DataSet < Struct.new(
769
+ :dataset_name,
770
+ :dataset_org,
771
+ :record_length,
772
+ :relative_path,
773
+ :storage_type)
774
+ SENSITIVE = []
775
+ include Aws::Structure
776
+ end
777
+
778
+ # Identifies one or more data sets you want to import with the
779
+ # CreateDataSetImportTask operation.
780
+ #
781
+ # @note DataSetImportConfig is a union - when making an API calls you must set exactly one of the members.
782
+ #
783
+ # @!attribute [rw] data_sets
784
+ # The data sets.
785
+ # @return [Array<Types::DataSetImportItem>]
786
+ #
787
+ # @!attribute [rw] s3_location
788
+ # The Amazon S3 location of the data sets.
789
+ # @return [String]
790
+ #
791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DataSetImportConfig AWS API Documentation
792
+ #
793
+ class DataSetImportConfig < Struct.new(
794
+ :data_sets,
795
+ :s3_location,
796
+ :unknown)
797
+ SENSITIVE = []
798
+ include Aws::Structure
799
+ include Aws::Structure::Union
800
+
801
+ class DataSets < DataSetImportConfig; end
802
+ class S3Location < DataSetImportConfig; end
803
+ class Unknown < DataSetImportConfig; end
804
+ end
805
+
806
+ # Identifies a specific data set to import from an external location.
807
+ #
808
+ # @note When making an API call, you may pass DataSetImportItem
809
+ # data as a hash:
810
+ #
811
+ # {
812
+ # data_set: { # required
813
+ # dataset_name: "String", # required
814
+ # dataset_org: { # required
815
+ # gdg: {
816
+ # limit: 1,
817
+ # roll_disposition: "String",
818
+ # },
819
+ # vsam: {
820
+ # alternate_keys: [
821
+ # {
822
+ # allow_duplicates: false,
823
+ # length: 1, # required
824
+ # name: "String",
825
+ # offset: 1, # required
826
+ # },
827
+ # ],
828
+ # compressed: false,
829
+ # encoding: "String",
830
+ # format: "String", # required
831
+ # primary_key: {
832
+ # length: 1, # required
833
+ # name: "String",
834
+ # offset: 1, # required
835
+ # },
836
+ # },
837
+ # },
838
+ # record_length: { # required
839
+ # max: 1, # required
840
+ # min: 1, # required
841
+ # },
842
+ # relative_path: "String",
843
+ # storage_type: "String",
844
+ # },
845
+ # external_location: { # required
846
+ # s3_location: "String2000",
847
+ # },
848
+ # }
849
+ #
850
+ # @!attribute [rw] data_set
851
+ # The data set.
852
+ # @return [Types::DataSet]
853
+ #
854
+ # @!attribute [rw] external_location
855
+ # The location of the data set.
856
+ # @return [Types::ExternalLocation]
857
+ #
858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DataSetImportItem AWS API Documentation
859
+ #
860
+ class DataSetImportItem < Struct.new(
861
+ :data_set,
862
+ :external_location)
863
+ SENSITIVE = []
864
+ include Aws::Structure
865
+ end
866
+
867
+ # Represents a summary of data set imports.
868
+ #
869
+ # @!attribute [rw] failed
870
+ # The number of data set imports that have failed.
871
+ # @return [Integer]
872
+ #
873
+ # @!attribute [rw] in_progress
874
+ # The number of data set imports that are in progress.
875
+ # @return [Integer]
876
+ #
877
+ # @!attribute [rw] pending
878
+ # The number of data set imports that are pending.
879
+ # @return [Integer]
880
+ #
881
+ # @!attribute [rw] succeeded
882
+ # The number of data set imports that have succeeded.
883
+ # @return [Integer]
884
+ #
885
+ # @!attribute [rw] total
886
+ # The total number of data set imports.
887
+ # @return [Integer]
888
+ #
889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DataSetImportSummary AWS API Documentation
890
+ #
891
+ class DataSetImportSummary < Struct.new(
892
+ :failed,
893
+ :in_progress,
894
+ :pending,
895
+ :succeeded,
896
+ :total)
897
+ SENSITIVE = []
898
+ include Aws::Structure
899
+ end
900
+
901
+ # Contains information about a data set import task.
902
+ #
903
+ # @!attribute [rw] status
904
+ # The status of the data set import task.
905
+ # @return [String]
906
+ #
907
+ # @!attribute [rw] summary
908
+ # A summary of the data set import task.
909
+ # @return [Types::DataSetImportSummary]
910
+ #
911
+ # @!attribute [rw] task_id
912
+ # The identifier of the data set import task.
913
+ # @return [String]
914
+ #
915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DataSetImportTask AWS API Documentation
916
+ #
917
+ class DataSetImportTask < Struct.new(
918
+ :status,
919
+ :summary,
920
+ :task_id)
921
+ SENSITIVE = []
922
+ include Aws::Structure
923
+ end
924
+
925
+ # A subset of the possible data set attributes.
926
+ #
927
+ # @!attribute [rw] creation_time
928
+ # The timestamp when the data set was created.
929
+ # @return [Time]
930
+ #
931
+ # @!attribute [rw] data_set_name
932
+ # The name of the data set.
933
+ # @return [String]
934
+ #
935
+ # @!attribute [rw] data_set_org
936
+ # The type of data set. Possible values include VSAM, IS, PS, GDG, PO,
937
+ # PS, or unknown.
938
+ # @return [String]
939
+ #
940
+ # @!attribute [rw] format
941
+ # The format of the data set.
942
+ # @return [String]
943
+ #
944
+ # @!attribute [rw] last_referenced_time
945
+ # The last time the data set was referenced.
946
+ # @return [Time]
947
+ #
948
+ # @!attribute [rw] last_updated_time
949
+ # The last time the data set was updated.
950
+ # @return [Time]
951
+ #
952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DataSetSummary AWS API Documentation
953
+ #
954
+ class DataSetSummary < Struct.new(
955
+ :creation_time,
956
+ :data_set_name,
957
+ :data_set_org,
958
+ :format,
959
+ :last_referenced_time,
960
+ :last_updated_time)
961
+ SENSITIVE = []
962
+ include Aws::Structure
963
+ end
964
+
965
+ # Additional details about the data set. Different attributes correspond
966
+ # to different data set organizations. The values are populated based on
967
+ # datasetOrg, storageType and backend (Blu Age or Micro Focus).
968
+ #
969
+ # @note DatasetDetailOrgAttributes is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DatasetDetailOrgAttributes corresponding to the set member.
970
+ #
971
+ # @!attribute [rw] gdg
972
+ # The generation data group of the data set.
973
+ # @return [Types::GdgDetailAttributes]
974
+ #
975
+ # @!attribute [rw] vsam
976
+ # The details of a VSAM data set.
977
+ # @return [Types::VsamDetailAttributes]
978
+ #
979
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DatasetDetailOrgAttributes AWS API Documentation
980
+ #
981
+ class DatasetDetailOrgAttributes < Struct.new(
982
+ :gdg,
983
+ :vsam,
984
+ :unknown)
985
+ SENSITIVE = []
986
+ include Aws::Structure
987
+ include Aws::Structure::Union
988
+
989
+ class Gdg < DatasetDetailOrgAttributes; end
990
+ class Vsam < DatasetDetailOrgAttributes; end
991
+ class Unknown < DatasetDetailOrgAttributes; end
992
+ end
993
+
994
+ # Additional details about the data set. Different attributes correspond
995
+ # to different data set organizations. The values are populated based on
996
+ # datasetOrg, storageType and backend (Blu Age or Micro Focus).
997
+ #
998
+ # @note DatasetOrgAttributes is a union - when making an API calls you must set exactly one of the members.
999
+ #
1000
+ # @!attribute [rw] gdg
1001
+ # The generation data group of the data set.
1002
+ # @return [Types::GdgAttributes]
1003
+ #
1004
+ # @!attribute [rw] vsam
1005
+ # The details of a VSAM data set.
1006
+ # @return [Types::VsamAttributes]
1007
+ #
1008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DatasetOrgAttributes AWS API Documentation
1009
+ #
1010
+ class DatasetOrgAttributes < Struct.new(
1011
+ :gdg,
1012
+ :vsam,
1013
+ :unknown)
1014
+ SENSITIVE = []
1015
+ include Aws::Structure
1016
+ include Aws::Structure::Union
1017
+
1018
+ class Gdg < DatasetOrgAttributes; end
1019
+ class Vsam < DatasetOrgAttributes; end
1020
+ class Unknown < DatasetOrgAttributes; end
1021
+ end
1022
+
1023
+ # The application definition for a particular application.
1024
+ #
1025
+ # @note Definition is a union - when making an API calls you must set exactly one of the members.
1026
+ #
1027
+ # @!attribute [rw] content
1028
+ # The content of the application definition. This is a JSON object
1029
+ # that contains the resource configuration/definitions that identify
1030
+ # an application.
1031
+ # @return [String]
1032
+ #
1033
+ # @!attribute [rw] s3_location
1034
+ # The S3 bucket that contains the application definition.
1035
+ # @return [String]
1036
+ #
1037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/Definition AWS API Documentation
1038
+ #
1039
+ class Definition < Struct.new(
1040
+ :content,
1041
+ :s3_location,
1042
+ :unknown)
1043
+ SENSITIVE = []
1044
+ include Aws::Structure
1045
+ include Aws::Structure::Union
1046
+
1047
+ class Content < Definition; end
1048
+ class S3Location < Definition; end
1049
+ class Unknown < Definition; end
1050
+ end
1051
+
1052
+ # @note When making an API call, you may pass DeleteApplicationFromEnvironmentRequest
1053
+ # data as a hash:
1054
+ #
1055
+ # {
1056
+ # application_id: "Identifier", # required
1057
+ # environment_id: "Identifier", # required
1058
+ # }
1059
+ #
1060
+ # @!attribute [rw] application_id
1061
+ # The unique identifier of the application you want to delete.
1062
+ # @return [String]
1063
+ #
1064
+ # @!attribute [rw] environment_id
1065
+ # The unique identifier of the runtime environment where the
1066
+ # application was previously deployed.
1067
+ # @return [String]
1068
+ #
1069
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeleteApplicationFromEnvironmentRequest AWS API Documentation
1070
+ #
1071
+ class DeleteApplicationFromEnvironmentRequest < Struct.new(
1072
+ :application_id,
1073
+ :environment_id)
1074
+ SENSITIVE = []
1075
+ include Aws::Structure
1076
+ end
1077
+
1078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeleteApplicationFromEnvironmentResponse AWS API Documentation
1079
+ #
1080
+ class DeleteApplicationFromEnvironmentResponse < Aws::EmptyStructure; end
1081
+
1082
+ # @note When making an API call, you may pass DeleteApplicationRequest
1083
+ # data as a hash:
1084
+ #
1085
+ # {
1086
+ # application_id: "Identifier", # required
1087
+ # }
1088
+ #
1089
+ # @!attribute [rw] application_id
1090
+ # The unique identifier of the application you want to delete.
1091
+ # @return [String]
1092
+ #
1093
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeleteApplicationRequest AWS API Documentation
1094
+ #
1095
+ class DeleteApplicationRequest < Struct.new(
1096
+ :application_id)
1097
+ SENSITIVE = []
1098
+ include Aws::Structure
1099
+ end
1100
+
1101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeleteApplicationResponse AWS API Documentation
1102
+ #
1103
+ class DeleteApplicationResponse < Aws::EmptyStructure; end
1104
+
1105
+ # @note When making an API call, you may pass DeleteEnvironmentRequest
1106
+ # data as a hash:
1107
+ #
1108
+ # {
1109
+ # environment_id: "Identifier", # required
1110
+ # }
1111
+ #
1112
+ # @!attribute [rw] environment_id
1113
+ # The unique identifier of the runtime environment you want to delete.
1114
+ # @return [String]
1115
+ #
1116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeleteEnvironmentRequest AWS API Documentation
1117
+ #
1118
+ class DeleteEnvironmentRequest < Struct.new(
1119
+ :environment_id)
1120
+ SENSITIVE = []
1121
+ include Aws::Structure
1122
+ end
1123
+
1124
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeleteEnvironmentResponse AWS API Documentation
1125
+ #
1126
+ class DeleteEnvironmentResponse < Aws::EmptyStructure; end
1127
+
1128
+ # Contains a summary of a deployed application.
1129
+ #
1130
+ # @!attribute [rw] application_version
1131
+ # The version of the deployed application.
1132
+ # @return [Integer]
1133
+ #
1134
+ # @!attribute [rw] status
1135
+ # The status of the deployment.
1136
+ # @return [String]
1137
+ #
1138
+ # @!attribute [rw] status_reason
1139
+ # The reason for the reported status.
1140
+ # @return [String]
1141
+ #
1142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeployedVersionSummary AWS API Documentation
1143
+ #
1144
+ class DeployedVersionSummary < Struct.new(
1145
+ :application_version,
1146
+ :status,
1147
+ :status_reason)
1148
+ SENSITIVE = []
1149
+ include Aws::Structure
1150
+ end
1151
+
1152
+ # A subset of information about a specific deployment.
1153
+ #
1154
+ # @!attribute [rw] application_id
1155
+ # The unique identifier of the application.
1156
+ # @return [String]
1157
+ #
1158
+ # @!attribute [rw] application_version
1159
+ # The version of the application.
1160
+ # @return [Integer]
1161
+ #
1162
+ # @!attribute [rw] creation_time
1163
+ # The timestamp when the deployment was created.
1164
+ # @return [Time]
1165
+ #
1166
+ # @!attribute [rw] deployment_id
1167
+ # The unique identifier of the deployment.
1168
+ # @return [String]
1169
+ #
1170
+ # @!attribute [rw] environment_id
1171
+ # The unique identifier of the environment.
1172
+ # @return [String]
1173
+ #
1174
+ # @!attribute [rw] status
1175
+ # The current status of the deployment.
1176
+ # @return [String]
1177
+ #
1178
+ # @!attribute [rw] status_reason
1179
+ # The reason for the reported status.
1180
+ # @return [String]
1181
+ #
1182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/DeploymentSummary AWS API Documentation
1183
+ #
1184
+ class DeploymentSummary < Struct.new(
1185
+ :application_id,
1186
+ :application_version,
1187
+ :creation_time,
1188
+ :deployment_id,
1189
+ :environment_id,
1190
+ :status,
1191
+ :status_reason)
1192
+ SENSITIVE = []
1193
+ include Aws::Structure
1194
+ end
1195
+
1196
+ # Defines the storage configuration for an Amazon EFS file system.
1197
+ #
1198
+ # @note When making an API call, you may pass EfsStorageConfiguration
1199
+ # data as a hash:
1200
+ #
1201
+ # {
1202
+ # file_system_id: "String200", # required
1203
+ # mount_point: "String200", # required
1204
+ # }
1205
+ #
1206
+ # @!attribute [rw] file_system_id
1207
+ # The file system identifier.
1208
+ # @return [String]
1209
+ #
1210
+ # @!attribute [rw] mount_point
1211
+ # The mount point for the file system.
1212
+ # @return [String]
1213
+ #
1214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/EfsStorageConfiguration AWS API Documentation
1215
+ #
1216
+ class EfsStorageConfiguration < Struct.new(
1217
+ :file_system_id,
1218
+ :mount_point)
1219
+ SENSITIVE = []
1220
+ include Aws::Structure
1221
+ end
1222
+
1223
+ # A subset of information about the engine version for a specific
1224
+ # application.
1225
+ #
1226
+ # @!attribute [rw] engine_type
1227
+ # The type of target platform for the application.
1228
+ # @return [String]
1229
+ #
1230
+ # @!attribute [rw] engine_version
1231
+ # The version of the engine type used by the application.
1232
+ # @return [String]
1233
+ #
1234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/EngineVersionsSummary AWS API Documentation
1235
+ #
1236
+ class EngineVersionsSummary < Struct.new(
1237
+ :engine_type,
1238
+ :engine_version)
1239
+ SENSITIVE = []
1240
+ include Aws::Structure
1241
+ end
1242
+
1243
+ # Contains a subset of the possible environment attributes. Used in the
1244
+ # environment list.
1245
+ #
1246
+ # @!attribute [rw] creation_time
1247
+ # The timestamp when the environment was created.
1248
+ # @return [Time]
1249
+ #
1250
+ # @!attribute [rw] engine_type
1251
+ # The target platform for the environment.
1252
+ # @return [String]
1253
+ #
1254
+ # @!attribute [rw] engine_version
1255
+ # The version of the runtime engine.
1256
+ # @return [String]
1257
+ #
1258
+ # @!attribute [rw] environment_arn
1259
+ # The Amazon Resource Name (ARN) of a particular runtime environment.
1260
+ # @return [String]
1261
+ #
1262
+ # @!attribute [rw] environment_id
1263
+ # The unique identifier of a particular runtime environment.
1264
+ # @return [String]
1265
+ #
1266
+ # @!attribute [rw] instance_type
1267
+ # The instance type of the environment.
1268
+ # @return [String]
1269
+ #
1270
+ # @!attribute [rw] name
1271
+ # The name of the environment.
1272
+ # @return [String]
1273
+ #
1274
+ # @!attribute [rw] status
1275
+ # The status of the environment
1276
+ # @return [String]
1277
+ #
1278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/EnvironmentSummary AWS API Documentation
1279
+ #
1280
+ class EnvironmentSummary < Struct.new(
1281
+ :creation_time,
1282
+ :engine_type,
1283
+ :engine_version,
1284
+ :environment_arn,
1285
+ :environment_id,
1286
+ :instance_type,
1287
+ :name,
1288
+ :status)
1289
+ SENSITIVE = []
1290
+ include Aws::Structure
1291
+ end
1292
+
1293
+ # Defines an external storage location.
1294
+ #
1295
+ # @note ExternalLocation is a union - when making an API calls you must set exactly one of the members.
1296
+ #
1297
+ # @!attribute [rw] s3_location
1298
+ # The URI of the Amazon S3 bucket.
1299
+ # @return [String]
1300
+ #
1301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ExternalLocation AWS API Documentation
1302
+ #
1303
+ class ExternalLocation < Struct.new(
1304
+ :s3_location,
1305
+ :unknown)
1306
+ SENSITIVE = []
1307
+ include Aws::Structure
1308
+ include Aws::Structure::Union
1309
+
1310
+ class S3Location < ExternalLocation; end
1311
+ class Unknown < ExternalLocation; end
1312
+ end
1313
+
1314
+ # A file containing a batch job definition.
1315
+ #
1316
+ # @!attribute [rw] file_name
1317
+ # The name of the file containing the batch job definition.
1318
+ # @return [String]
1319
+ #
1320
+ # @!attribute [rw] folder_path
1321
+ # The path to the file containing the batch job definition.
1322
+ # @return [String]
1323
+ #
1324
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/FileBatchJobDefinition AWS API Documentation
1325
+ #
1326
+ class FileBatchJobDefinition < Struct.new(
1327
+ :file_name,
1328
+ :folder_path)
1329
+ SENSITIVE = []
1330
+ include Aws::Structure
1331
+ end
1332
+
1333
+ # A batch job identifier in which the batch job to run is identified by
1334
+ # the file name and the relative path to the file name.
1335
+ #
1336
+ # @note When making an API call, you may pass FileBatchJobIdentifier
1337
+ # data as a hash:
1338
+ #
1339
+ # {
1340
+ # file_name: "String", # required
1341
+ # folder_path: "String",
1342
+ # }
1343
+ #
1344
+ # @!attribute [rw] file_name
1345
+ # The file name for the batch job identifier.
1346
+ # @return [String]
1347
+ #
1348
+ # @!attribute [rw] folder_path
1349
+ # The relative path to the file name for the batch job identifier.
1350
+ # @return [String]
1351
+ #
1352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/FileBatchJobIdentifier AWS API Documentation
1353
+ #
1354
+ class FileBatchJobIdentifier < Struct.new(
1355
+ :file_name,
1356
+ :folder_path)
1357
+ SENSITIVE = []
1358
+ include Aws::Structure
1359
+ end
1360
+
1361
+ # Defines the storage configuration for an Amazon FSx file system.
1362
+ #
1363
+ # @note When making an API call, you may pass FsxStorageConfiguration
1364
+ # data as a hash:
1365
+ #
1366
+ # {
1367
+ # file_system_id: "String200", # required
1368
+ # mount_point: "String200", # required
1369
+ # }
1370
+ #
1371
+ # @!attribute [rw] file_system_id
1372
+ # The file system identifier.
1373
+ # @return [String]
1374
+ #
1375
+ # @!attribute [rw] mount_point
1376
+ # The mount point for the file system.
1377
+ # @return [String]
1378
+ #
1379
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/FsxStorageConfiguration AWS API Documentation
1380
+ #
1381
+ class FsxStorageConfiguration < Struct.new(
1382
+ :file_system_id,
1383
+ :mount_point)
1384
+ SENSITIVE = []
1385
+ include Aws::Structure
1386
+ end
1387
+
1388
+ # The required attributes for a generation data group data set. A
1389
+ # generation data set is one of a collection of successive, historically
1390
+ # related, catalogued data sets that together are known as a generation
1391
+ # data group (GDG). Use this structure when you want to import a GDG.
1392
+ # For more information on GDG, see [Generation data sets][1].
1393
+ #
1394
+ #
1395
+ #
1396
+ # [1]: https://www.ibm.com/docs/en/zos/2.3.0?topic=guide-generation-data-sets
1397
+ #
1398
+ # @note When making an API call, you may pass GdgAttributes
1399
+ # data as a hash:
1400
+ #
1401
+ # {
1402
+ # limit: 1,
1403
+ # roll_disposition: "String",
1404
+ # }
1405
+ #
1406
+ # @!attribute [rw] limit
1407
+ # The maximum number of generation data sets, up to 255, in a GDG.
1408
+ # @return [Integer]
1409
+ #
1410
+ # @!attribute [rw] roll_disposition
1411
+ # The disposition of the data set in the catalog.
1412
+ # @return [String]
1413
+ #
1414
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GdgAttributes AWS API Documentation
1415
+ #
1416
+ class GdgAttributes < Struct.new(
1417
+ :limit,
1418
+ :roll_disposition)
1419
+ SENSITIVE = []
1420
+ include Aws::Structure
1421
+ end
1422
+
1423
+ # The required attributes for a generation data group data set. A
1424
+ # generation data set is one of a collection of successive, historically
1425
+ # related, catalogued data sets that together are known as a generation
1426
+ # data group (GDG). Use this structure when you want to import a GDG.
1427
+ # For more information on GDG, see [Generation data sets][1].
1428
+ #
1429
+ #
1430
+ #
1431
+ # [1]: https://www.ibm.com/docs/en/zos/2.3.0?topic=guide-generation-data-sets
1432
+ #
1433
+ # @!attribute [rw] limit
1434
+ # The maximum number of generation data sets, up to 255, in a GDG.
1435
+ # @return [Integer]
1436
+ #
1437
+ # @!attribute [rw] roll_disposition
1438
+ # The disposition of the data set in the catalog.
1439
+ # @return [String]
1440
+ #
1441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GdgDetailAttributes AWS API Documentation
1442
+ #
1443
+ class GdgDetailAttributes < Struct.new(
1444
+ :limit,
1445
+ :roll_disposition)
1446
+ SENSITIVE = []
1447
+ include Aws::Structure
1448
+ end
1449
+
1450
+ # @note When making an API call, you may pass GetApplicationRequest
1451
+ # data as a hash:
1452
+ #
1453
+ # {
1454
+ # application_id: "Identifier", # required
1455
+ # }
1456
+ #
1457
+ # @!attribute [rw] application_id
1458
+ # The identifier of the application.
1459
+ # @return [String]
1460
+ #
1461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetApplicationRequest AWS API Documentation
1462
+ #
1463
+ class GetApplicationRequest < Struct.new(
1464
+ :application_id)
1465
+ SENSITIVE = []
1466
+ include Aws::Structure
1467
+ end
1468
+
1469
+ # @!attribute [rw] application_arn
1470
+ # The Amazon Resource Name (ARN) of the application.
1471
+ # @return [String]
1472
+ #
1473
+ # @!attribute [rw] application_id
1474
+ # The identifier of the application.
1475
+ # @return [String]
1476
+ #
1477
+ # @!attribute [rw] creation_time
1478
+ # The timestamp when this application was created.
1479
+ # @return [Time]
1480
+ #
1481
+ # @!attribute [rw] deployed_version
1482
+ # The version of the application that is deployed.
1483
+ # @return [Types::DeployedVersionSummary]
1484
+ #
1485
+ # @!attribute [rw] description
1486
+ # The description of the application.
1487
+ # @return [String]
1488
+ #
1489
+ # @!attribute [rw] engine_type
1490
+ # The type of the target platform for the application.
1491
+ # @return [String]
1492
+ #
1493
+ # @!attribute [rw] environment_id
1494
+ # The identifier of the environment where the application will be
1495
+ # deployed.
1496
+ # @return [String]
1497
+ #
1498
+ # @!attribute [rw] last_start_time
1499
+ # The timestamp when the application was last started. Null until the
1500
+ # application has started running for the first time.
1501
+ # @return [Time]
1502
+ #
1503
+ # @!attribute [rw] latest_version
1504
+ # The latest version of the application.
1505
+ # @return [Types::ApplicationVersionSummary]
1506
+ #
1507
+ # @!attribute [rw] listener_arns
1508
+ # The Amazon Resource Name (ARN) for the network load balancer
1509
+ # listener created in your Amazon Web Services account. Amazon Web
1510
+ # Services Mainframe Modernization creates this listener on your
1511
+ # behalf the first time you deploy an application.
1512
+ # @return [Array<String>]
1513
+ #
1514
+ # @!attribute [rw] listener_ports
1515
+ # The port associated with the network load balancer listener created
1516
+ # in your Amazon Web Services account.
1517
+ # @return [Array<Integer>]
1518
+ #
1519
+ # @!attribute [rw] load_balancer_dns_name
1520
+ # The public DNS name of the load balancer created in your Amazon Web
1521
+ # Services account.
1522
+ # @return [String]
1523
+ #
1524
+ # @!attribute [rw] log_groups
1525
+ # The list of log summaries. Each log summary includes the log type as
1526
+ # well as the log group identifier. These are CloudWatch logs. The
1527
+ # Amazon Web Services Mainframe Modernization application log is
1528
+ # pushed to CloudWatch under the customer's account.
1529
+ # @return [Array<Types::LogGroupSummary>]
1530
+ #
1531
+ # @!attribute [rw] name
1532
+ # The unique identifier of the application.
1533
+ # @return [String]
1534
+ #
1535
+ # @!attribute [rw] status
1536
+ # The status of the application.
1537
+ # @return [String]
1538
+ #
1539
+ # @!attribute [rw] status_reason
1540
+ # The reason for the reported status.
1541
+ # @return [String]
1542
+ #
1543
+ # @!attribute [rw] tags
1544
+ # A list of tags associated with the application.
1545
+ # @return [Hash<String,String>]
1546
+ #
1547
+ # @!attribute [rw] target_group_arns
1548
+ # Returns the Amazon Resource Names (ARNs) of the target groups that
1549
+ # are attached to the network load balancer.
1550
+ # @return [Array<String>]
1551
+ #
1552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetApplicationResponse AWS API Documentation
1553
+ #
1554
+ class GetApplicationResponse < Struct.new(
1555
+ :application_arn,
1556
+ :application_id,
1557
+ :creation_time,
1558
+ :deployed_version,
1559
+ :description,
1560
+ :engine_type,
1561
+ :environment_id,
1562
+ :last_start_time,
1563
+ :latest_version,
1564
+ :listener_arns,
1565
+ :listener_ports,
1566
+ :load_balancer_dns_name,
1567
+ :log_groups,
1568
+ :name,
1569
+ :status,
1570
+ :status_reason,
1571
+ :tags,
1572
+ :target_group_arns)
1573
+ SENSITIVE = []
1574
+ include Aws::Structure
1575
+ end
1576
+
1577
+ # @note When making an API call, you may pass GetApplicationVersionRequest
1578
+ # data as a hash:
1579
+ #
1580
+ # {
1581
+ # application_id: "Identifier", # required
1582
+ # application_version: 1, # required
1583
+ # }
1584
+ #
1585
+ # @!attribute [rw] application_id
1586
+ # The unique identifier of the application.
1587
+ # @return [String]
1588
+ #
1589
+ # @!attribute [rw] application_version
1590
+ # The specific version of the application.
1591
+ # @return [Integer]
1592
+ #
1593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetApplicationVersionRequest AWS API Documentation
1594
+ #
1595
+ class GetApplicationVersionRequest < Struct.new(
1596
+ :application_id,
1597
+ :application_version)
1598
+ SENSITIVE = []
1599
+ include Aws::Structure
1600
+ end
1601
+
1602
+ # @!attribute [rw] application_version
1603
+ # The specific version of the application.
1604
+ # @return [Integer]
1605
+ #
1606
+ # @!attribute [rw] creation_time
1607
+ # The timestamp when the application version was created.
1608
+ # @return [Time]
1609
+ #
1610
+ # @!attribute [rw] definition_content
1611
+ # The content of the application definition. This is a JSON object
1612
+ # that contains the resource configuration/definitions that identify
1613
+ # an application.
1614
+ # @return [String]
1615
+ #
1616
+ # @!attribute [rw] description
1617
+ # The application description.
1618
+ # @return [String]
1619
+ #
1620
+ # @!attribute [rw] name
1621
+ # The name of the application version.
1622
+ # @return [String]
1623
+ #
1624
+ # @!attribute [rw] status
1625
+ # The status of the application version.
1626
+ # @return [String]
1627
+ #
1628
+ # @!attribute [rw] status_reason
1629
+ # The reason for the reported status.
1630
+ # @return [String]
1631
+ #
1632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetApplicationVersionResponse AWS API Documentation
1633
+ #
1634
+ class GetApplicationVersionResponse < Struct.new(
1635
+ :application_version,
1636
+ :creation_time,
1637
+ :definition_content,
1638
+ :description,
1639
+ :name,
1640
+ :status,
1641
+ :status_reason)
1642
+ SENSITIVE = []
1643
+ include Aws::Structure
1644
+ end
1645
+
1646
+ # @note When making an API call, you may pass GetBatchJobExecutionRequest
1647
+ # data as a hash:
1648
+ #
1649
+ # {
1650
+ # application_id: "Identifier", # required
1651
+ # execution_id: "Identifier", # required
1652
+ # }
1653
+ #
1654
+ # @!attribute [rw] application_id
1655
+ # The identifier of the application.
1656
+ # @return [String]
1657
+ #
1658
+ # @!attribute [rw] execution_id
1659
+ # The unique identifier of the batch job execution.
1660
+ # @return [String]
1661
+ #
1662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetBatchJobExecutionRequest AWS API Documentation
1663
+ #
1664
+ class GetBatchJobExecutionRequest < Struct.new(
1665
+ :application_id,
1666
+ :execution_id)
1667
+ SENSITIVE = []
1668
+ include Aws::Structure
1669
+ end
1670
+
1671
+ # @!attribute [rw] application_id
1672
+ # The identifier of the application.
1673
+ # @return [String]
1674
+ #
1675
+ # @!attribute [rw] end_time
1676
+ # The timestamp when the batch job execution ended.
1677
+ # @return [Time]
1678
+ #
1679
+ # @!attribute [rw] execution_id
1680
+ # The unique identifier for this batch job execution.
1681
+ # @return [String]
1682
+ #
1683
+ # @!attribute [rw] job_id
1684
+ # The unique identifier for this batch job.
1685
+ # @return [String]
1686
+ #
1687
+ # @!attribute [rw] job_name
1688
+ # The name of this batch job.
1689
+ # @return [String]
1690
+ #
1691
+ # @!attribute [rw] job_type
1692
+ # The type of job.
1693
+ # @return [String]
1694
+ #
1695
+ # @!attribute [rw] job_user
1696
+ # The user for the job.
1697
+ # @return [String]
1698
+ #
1699
+ # @!attribute [rw] start_time
1700
+ # The timestamp when the batch job execution started.
1701
+ # @return [Time]
1702
+ #
1703
+ # @!attribute [rw] status
1704
+ # The status of the batch job execution.
1705
+ # @return [String]
1706
+ #
1707
+ # @!attribute [rw] status_reason
1708
+ # The reason for the reported status.
1709
+ # @return [String]
1710
+ #
1711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetBatchJobExecutionResponse AWS API Documentation
1712
+ #
1713
+ class GetBatchJobExecutionResponse < Struct.new(
1714
+ :application_id,
1715
+ :end_time,
1716
+ :execution_id,
1717
+ :job_id,
1718
+ :job_name,
1719
+ :job_type,
1720
+ :job_user,
1721
+ :start_time,
1722
+ :status,
1723
+ :status_reason)
1724
+ SENSITIVE = []
1725
+ include Aws::Structure
1726
+ end
1727
+
1728
+ # @note When making an API call, you may pass GetDataSetDetailsRequest
1729
+ # data as a hash:
1730
+ #
1731
+ # {
1732
+ # application_id: "Identifier", # required
1733
+ # data_set_name: "String200", # required
1734
+ # }
1735
+ #
1736
+ # @!attribute [rw] application_id
1737
+ # The unique identifier of the application that this data set is
1738
+ # associated with.
1739
+ # @return [String]
1740
+ #
1741
+ # @!attribute [rw] data_set_name
1742
+ # The name of the data set.
1743
+ # @return [String]
1744
+ #
1745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetDataSetDetailsRequest AWS API Documentation
1746
+ #
1747
+ class GetDataSetDetailsRequest < Struct.new(
1748
+ :application_id,
1749
+ :data_set_name)
1750
+ SENSITIVE = []
1751
+ include Aws::Structure
1752
+ end
1753
+
1754
+ # @!attribute [rw] blocksize
1755
+ # The size of the block on disk.
1756
+ # @return [Integer]
1757
+ #
1758
+ # @!attribute [rw] creation_time
1759
+ # The timestamp when the data set was created.
1760
+ # @return [Time]
1761
+ #
1762
+ # @!attribute [rw] data_set_name
1763
+ # The name of the data set.
1764
+ # @return [String]
1765
+ #
1766
+ # @!attribute [rw] data_set_org
1767
+ # The type of data set. Possible values include VSAM, IS, PS, GDG, PO,
1768
+ # PS, or unknown.
1769
+ # @return [Types::DatasetDetailOrgAttributes]
1770
+ #
1771
+ # @!attribute [rw] last_referenced_time
1772
+ # The last time the data set was referenced.
1773
+ # @return [Time]
1774
+ #
1775
+ # @!attribute [rw] last_updated_time
1776
+ # The last time the data set was updated.
1777
+ # @return [Time]
1778
+ #
1779
+ # @!attribute [rw] location
1780
+ # The locaion where the data set is stored.
1781
+ # @return [String]
1782
+ #
1783
+ # @!attribute [rw] record_length
1784
+ # The length of records in the data set.
1785
+ # @return [Integer]
1786
+ #
1787
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetDataSetDetailsResponse AWS API Documentation
1788
+ #
1789
+ class GetDataSetDetailsResponse < Struct.new(
1790
+ :blocksize,
1791
+ :creation_time,
1792
+ :data_set_name,
1793
+ :data_set_org,
1794
+ :last_referenced_time,
1795
+ :last_updated_time,
1796
+ :location,
1797
+ :record_length)
1798
+ SENSITIVE = []
1799
+ include Aws::Structure
1800
+ end
1801
+
1802
+ # @note When making an API call, you may pass GetDataSetImportTaskRequest
1803
+ # data as a hash:
1804
+ #
1805
+ # {
1806
+ # application_id: "Identifier", # required
1807
+ # task_id: "Identifier", # required
1808
+ # }
1809
+ #
1810
+ # @!attribute [rw] application_id
1811
+ # The application identifier.
1812
+ # @return [String]
1813
+ #
1814
+ # @!attribute [rw] task_id
1815
+ # The task identifier returned by the CreateDataSetImportTask
1816
+ # operation.
1817
+ # @return [String]
1818
+ #
1819
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetDataSetImportTaskRequest AWS API Documentation
1820
+ #
1821
+ class GetDataSetImportTaskRequest < Struct.new(
1822
+ :application_id,
1823
+ :task_id)
1824
+ SENSITIVE = []
1825
+ include Aws::Structure
1826
+ end
1827
+
1828
+ # @!attribute [rw] status
1829
+ # The status of the task.
1830
+ # @return [String]
1831
+ #
1832
+ # @!attribute [rw] summary
1833
+ # A summary of the status of the task.
1834
+ # @return [Types::DataSetImportSummary]
1835
+ #
1836
+ # @!attribute [rw] task_id
1837
+ # The task identifier.
1838
+ # @return [String]
1839
+ #
1840
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetDataSetImportTaskResponse AWS API Documentation
1841
+ #
1842
+ class GetDataSetImportTaskResponse < Struct.new(
1843
+ :status,
1844
+ :summary,
1845
+ :task_id)
1846
+ SENSITIVE = []
1847
+ include Aws::Structure
1848
+ end
1849
+
1850
+ # @note When making an API call, you may pass GetDeploymentRequest
1851
+ # data as a hash:
1852
+ #
1853
+ # {
1854
+ # application_id: "Identifier", # required
1855
+ # deployment_id: "Identifier", # required
1856
+ # }
1857
+ #
1858
+ # @!attribute [rw] application_id
1859
+ # The unique identifier of the application.
1860
+ # @return [String]
1861
+ #
1862
+ # @!attribute [rw] deployment_id
1863
+ # The unique identifier for the deployment.
1864
+ # @return [String]
1865
+ #
1866
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetDeploymentRequest AWS API Documentation
1867
+ #
1868
+ class GetDeploymentRequest < Struct.new(
1869
+ :application_id,
1870
+ :deployment_id)
1871
+ SENSITIVE = []
1872
+ include Aws::Structure
1873
+ end
1874
+
1875
+ # @!attribute [rw] application_id
1876
+ # The unique identifier of the application.
1877
+ # @return [String]
1878
+ #
1879
+ # @!attribute [rw] application_version
1880
+ # The application version.
1881
+ # @return [Integer]
1882
+ #
1883
+ # @!attribute [rw] creation_time
1884
+ # The timestamp when the deployment was created.
1885
+ # @return [Time]
1886
+ #
1887
+ # @!attribute [rw] deployment_id
1888
+ # The unique identifier of the deployment.
1889
+ # @return [String]
1890
+ #
1891
+ # @!attribute [rw] environment_id
1892
+ # The unique identifier of the runtime environment.
1893
+ # @return [String]
1894
+ #
1895
+ # @!attribute [rw] status
1896
+ # The status of the deployment.
1897
+ # @return [String]
1898
+ #
1899
+ # @!attribute [rw] status_reason
1900
+ # The reason for the reported status.
1901
+ # @return [String]
1902
+ #
1903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetDeploymentResponse AWS API Documentation
1904
+ #
1905
+ class GetDeploymentResponse < Struct.new(
1906
+ :application_id,
1907
+ :application_version,
1908
+ :creation_time,
1909
+ :deployment_id,
1910
+ :environment_id,
1911
+ :status,
1912
+ :status_reason)
1913
+ SENSITIVE = []
1914
+ include Aws::Structure
1915
+ end
1916
+
1917
+ # @note When making an API call, you may pass GetEnvironmentRequest
1918
+ # data as a hash:
1919
+ #
1920
+ # {
1921
+ # environment_id: "Identifier", # required
1922
+ # }
1923
+ #
1924
+ # @!attribute [rw] environment_id
1925
+ # The unique identifier of the runtime environment.
1926
+ # @return [String]
1927
+ #
1928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetEnvironmentRequest AWS API Documentation
1929
+ #
1930
+ class GetEnvironmentRequest < Struct.new(
1931
+ :environment_id)
1932
+ SENSITIVE = []
1933
+ include Aws::Structure
1934
+ end
1935
+
1936
+ # @!attribute [rw] actual_capacity
1937
+ # The number of instances included in the runtime environment. A
1938
+ # standalone runtime environment has a maxiumum of one instance.
1939
+ # Currently, a high availability runtime environment has a maximum of
1940
+ # two instances.
1941
+ # @return [Integer]
1942
+ #
1943
+ # @!attribute [rw] creation_time
1944
+ # The timestamp when the runtime environment was created.
1945
+ # @return [Time]
1946
+ #
1947
+ # @!attribute [rw] description
1948
+ # The description of the runtime environment.
1949
+ # @return [String]
1950
+ #
1951
+ # @!attribute [rw] engine_type
1952
+ # The target platform for the runtime environment.
1953
+ # @return [String]
1954
+ #
1955
+ # @!attribute [rw] engine_version
1956
+ # The version of the runtime engine.
1957
+ # @return [String]
1958
+ #
1959
+ # @!attribute [rw] environment_arn
1960
+ # The Amazon Resource Name (ARN) of the runtime environment.
1961
+ # @return [String]
1962
+ #
1963
+ # @!attribute [rw] environment_id
1964
+ # The unique identifier of the runtime environment.
1965
+ # @return [String]
1966
+ #
1967
+ # @!attribute [rw] high_availability_config
1968
+ # The desired capacity of the high availability configuration for the
1969
+ # runtime environment.
1970
+ # @return [Types::HighAvailabilityConfig]
1971
+ #
1972
+ # @!attribute [rw] instance_type
1973
+ # The type of instance underlying the runtime environment.
1974
+ # @return [String]
1975
+ #
1976
+ # @!attribute [rw] load_balancer_arn
1977
+ # The Amazon Resource Name (ARN) for the load balancer used with the
1978
+ # runtime environment.
1979
+ # @return [String]
1980
+ #
1981
+ # @!attribute [rw] name
1982
+ # The name of the runtime environment.
1983
+ # @return [String]
1984
+ #
1985
+ # @!attribute [rw] pending_maintenance
1986
+ # Indicates the pending maintenance scheduled on this environment.
1987
+ # @return [Types::PendingMaintenance]
1988
+ #
1989
+ # @!attribute [rw] preferred_maintenance_window
1990
+ # Configures a desired maintenance window for the environment. If you
1991
+ # do not provide a value, a random system-generated value will be
1992
+ # assigned.
1993
+ # @return [String]
1994
+ #
1995
+ # @!attribute [rw] publicly_accessible
1996
+ # Whether applications running in this runtime environment are
1997
+ # publicly accessible.
1998
+ # @return [Boolean]
1999
+ #
2000
+ # @!attribute [rw] security_group_ids
2001
+ # The unique identifiers of the security groups assigned to this
2002
+ # runtime environment.
2003
+ # @return [Array<String>]
2004
+ #
2005
+ # @!attribute [rw] status
2006
+ # The status of the runtime environment.
2007
+ # @return [String]
2008
+ #
2009
+ # @!attribute [rw] status_reason
2010
+ # The reason for the reported status.
2011
+ # @return [String]
2012
+ #
2013
+ # @!attribute [rw] storage_configurations
2014
+ # The storage configurations defined for the runtime environment.
2015
+ # @return [Array<Types::StorageConfiguration>]
2016
+ #
2017
+ # @!attribute [rw] subnet_ids
2018
+ # The unique identifiers of the subnets assigned to this runtime
2019
+ # environment.
2020
+ # @return [Array<String>]
2021
+ #
2022
+ # @!attribute [rw] tags
2023
+ # The tags defined for this runtime environment.
2024
+ # @return [Hash<String,String>]
2025
+ #
2026
+ # @!attribute [rw] vpc_id
2027
+ # The unique identifier for the VPC used with this runtime
2028
+ # environment.
2029
+ # @return [String]
2030
+ #
2031
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/GetEnvironmentResponse AWS API Documentation
2032
+ #
2033
+ class GetEnvironmentResponse < Struct.new(
2034
+ :actual_capacity,
2035
+ :creation_time,
2036
+ :description,
2037
+ :engine_type,
2038
+ :engine_version,
2039
+ :environment_arn,
2040
+ :environment_id,
2041
+ :high_availability_config,
2042
+ :instance_type,
2043
+ :load_balancer_arn,
2044
+ :name,
2045
+ :pending_maintenance,
2046
+ :preferred_maintenance_window,
2047
+ :publicly_accessible,
2048
+ :security_group_ids,
2049
+ :status,
2050
+ :status_reason,
2051
+ :storage_configurations,
2052
+ :subnet_ids,
2053
+ :tags,
2054
+ :vpc_id)
2055
+ SENSITIVE = []
2056
+ include Aws::Structure
2057
+ end
2058
+
2059
+ # Defines the details of a high availability configuration.
2060
+ #
2061
+ # @note When making an API call, you may pass HighAvailabilityConfig
2062
+ # data as a hash:
2063
+ #
2064
+ # {
2065
+ # desired_capacity: 1, # required
2066
+ # }
2067
+ #
2068
+ # @!attribute [rw] desired_capacity
2069
+ # The number of instances in a high availability configuration.
2070
+ # @return [Integer]
2071
+ #
2072
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/HighAvailabilityConfig AWS API Documentation
2073
+ #
2074
+ class HighAvailabilityConfig < Struct.new(
2075
+ :desired_capacity)
2076
+ SENSITIVE = []
2077
+ include Aws::Structure
2078
+ end
2079
+
2080
+ # An unexpected error occurred during the processing of the request.
2081
+ #
2082
+ # @!attribute [rw] message
2083
+ # @return [String]
2084
+ #
2085
+ # @!attribute [rw] retry_after_seconds
2086
+ # The number of seconds to wait before retrying the request.
2087
+ # @return [Integer]
2088
+ #
2089
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/InternalServerException AWS API Documentation
2090
+ #
2091
+ class InternalServerException < Struct.new(
2092
+ :message,
2093
+ :retry_after_seconds)
2094
+ SENSITIVE = []
2095
+ include Aws::Structure
2096
+ end
2097
+
2098
+ # @note When making an API call, you may pass ListApplicationVersionsRequest
2099
+ # data as a hash:
2100
+ #
2101
+ # {
2102
+ # application_id: "Identifier", # required
2103
+ # max_results: 1,
2104
+ # next_token: "NextToken",
2105
+ # }
2106
+ #
2107
+ # @!attribute [rw] application_id
2108
+ # The unique identifier of the application.
2109
+ # @return [String]
2110
+ #
2111
+ # @!attribute [rw] max_results
2112
+ # The maximum number of application versions to return.
2113
+ # @return [Integer]
2114
+ #
2115
+ # @!attribute [rw] next_token
2116
+ # A pagination token returned from a previous call to this operation.
2117
+ # This specifies the next item to return. To return to the beginning
2118
+ # of the list, exclude this parameter.
2119
+ # @return [String]
2120
+ #
2121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListApplicationVersionsRequest AWS API Documentation
2122
+ #
2123
+ class ListApplicationVersionsRequest < Struct.new(
2124
+ :application_id,
2125
+ :max_results,
2126
+ :next_token)
2127
+ SENSITIVE = []
2128
+ include Aws::Structure
2129
+ end
2130
+
2131
+ # @!attribute [rw] application_versions
2132
+ # The list of application versions.
2133
+ # @return [Array<Types::ApplicationVersionSummary>]
2134
+ #
2135
+ # @!attribute [rw] next_token
2136
+ # If there are more items to return, this contains a token that is
2137
+ # passed to a subsequent call to this operation to retrieve the next
2138
+ # set of items.
2139
+ # @return [String]
2140
+ #
2141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListApplicationVersionsResponse AWS API Documentation
2142
+ #
2143
+ class ListApplicationVersionsResponse < Struct.new(
2144
+ :application_versions,
2145
+ :next_token)
2146
+ SENSITIVE = []
2147
+ include Aws::Structure
2148
+ end
2149
+
2150
+ # @note When making an API call, you may pass ListApplicationsRequest
2151
+ # data as a hash:
2152
+ #
2153
+ # {
2154
+ # environment_id: "Identifier",
2155
+ # max_results: 1,
2156
+ # names: ["EntityName"],
2157
+ # next_token: "NextToken",
2158
+ # }
2159
+ #
2160
+ # @!attribute [rw] environment_id
2161
+ # The unique identifier of the runtime environment where the
2162
+ # applications are deployed.
2163
+ # @return [String]
2164
+ #
2165
+ # @!attribute [rw] max_results
2166
+ # The maximum number of applications to return.
2167
+ # @return [Integer]
2168
+ #
2169
+ # @!attribute [rw] names
2170
+ # The names of the applications.
2171
+ # @return [Array<String>]
2172
+ #
2173
+ # @!attribute [rw] next_token
2174
+ # A pagination token to control the number of applications displayed
2175
+ # in the list.
2176
+ # @return [String]
2177
+ #
2178
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListApplicationsRequest AWS API Documentation
2179
+ #
2180
+ class ListApplicationsRequest < Struct.new(
2181
+ :environment_id,
2182
+ :max_results,
2183
+ :names,
2184
+ :next_token)
2185
+ SENSITIVE = []
2186
+ include Aws::Structure
2187
+ end
2188
+
2189
+ # @!attribute [rw] applications
2190
+ # Returns a list of summary details for all the applications in an
2191
+ # environment.
2192
+ # @return [Array<Types::ApplicationSummary>]
2193
+ #
2194
+ # @!attribute [rw] next_token
2195
+ # A pagination token that's returned when the response doesn't
2196
+ # contain all applications.
2197
+ # @return [String]
2198
+ #
2199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListApplicationsResponse AWS API Documentation
2200
+ #
2201
+ class ListApplicationsResponse < Struct.new(
2202
+ :applications,
2203
+ :next_token)
2204
+ SENSITIVE = []
2205
+ include Aws::Structure
2206
+ end
2207
+
2208
+ # @note When making an API call, you may pass ListBatchJobDefinitionsRequest
2209
+ # data as a hash:
2210
+ #
2211
+ # {
2212
+ # application_id: "Identifier", # required
2213
+ # max_results: 1,
2214
+ # next_token: "NextToken",
2215
+ # prefix: "String",
2216
+ # }
2217
+ #
2218
+ # @!attribute [rw] application_id
2219
+ # The identifier of the application.
2220
+ # @return [String]
2221
+ #
2222
+ # @!attribute [rw] max_results
2223
+ # The maximum number of batch job definitions to return.
2224
+ # @return [Integer]
2225
+ #
2226
+ # @!attribute [rw] next_token
2227
+ # A pagination token returned from a previous call to this operation.
2228
+ # This specifies the next item to return. To return to the beginning
2229
+ # of the list, exclude this parameter.
2230
+ # @return [String]
2231
+ #
2232
+ # @!attribute [rw] prefix
2233
+ # If the batch job definition is a FileBatchJobDefinition, the prefix
2234
+ # allows you to search on the file names of FileBatchJobDefinitions.
2235
+ # @return [String]
2236
+ #
2237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListBatchJobDefinitionsRequest AWS API Documentation
2238
+ #
2239
+ class ListBatchJobDefinitionsRequest < Struct.new(
2240
+ :application_id,
2241
+ :max_results,
2242
+ :next_token,
2243
+ :prefix)
2244
+ SENSITIVE = []
2245
+ include Aws::Structure
2246
+ end
2247
+
2248
+ # @!attribute [rw] batch_job_definitions
2249
+ # The list of batch job definitions.
2250
+ # @return [Array<Types::BatchJobDefinition>]
2251
+ #
2252
+ # @!attribute [rw] next_token
2253
+ # If there are more items to return, this contains a token that is
2254
+ # passed to a subsequent call to this operation to retrieve the next
2255
+ # set of items.
2256
+ # @return [String]
2257
+ #
2258
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListBatchJobDefinitionsResponse AWS API Documentation
2259
+ #
2260
+ class ListBatchJobDefinitionsResponse < Struct.new(
2261
+ :batch_job_definitions,
2262
+ :next_token)
2263
+ SENSITIVE = []
2264
+ include Aws::Structure
2265
+ end
2266
+
2267
+ # @note When making an API call, you may pass ListBatchJobExecutionsRequest
2268
+ # data as a hash:
2269
+ #
2270
+ # {
2271
+ # application_id: "Identifier", # required
2272
+ # execution_ids: ["Identifier"],
2273
+ # job_name: "String100",
2274
+ # max_results: 1,
2275
+ # next_token: "NextToken",
2276
+ # started_after: Time.now,
2277
+ # started_before: Time.now,
2278
+ # status: "Submitting", # accepts Submitting, Holding, Dispatching, Running, Cancelling, Cancelled, Succeeded, Failed, Succeeded With Warning
2279
+ # }
2280
+ #
2281
+ # @!attribute [rw] application_id
2282
+ # The unique identifier of the application.
2283
+ # @return [String]
2284
+ #
2285
+ # @!attribute [rw] execution_ids
2286
+ # The unique identifier of each batch job execution.
2287
+ # @return [Array<String>]
2288
+ #
2289
+ # @!attribute [rw] job_name
2290
+ # The name of each batch job execution.
2291
+ # @return [String]
2292
+ #
2293
+ # @!attribute [rw] max_results
2294
+ # The maximum number of batch job executions to return.
2295
+ # @return [Integer]
2296
+ #
2297
+ # @!attribute [rw] next_token
2298
+ # A pagination token to control the number of batch job executions
2299
+ # displayed in the list.
2300
+ # @return [String]
2301
+ #
2302
+ # @!attribute [rw] started_after
2303
+ # The time after which the batch job executions started.
2304
+ # @return [Time]
2305
+ #
2306
+ # @!attribute [rw] started_before
2307
+ # The time before the batch job executions started.
2308
+ # @return [Time]
2309
+ #
2310
+ # @!attribute [rw] status
2311
+ # The status of the batch job executions.
2312
+ # @return [String]
2313
+ #
2314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListBatchJobExecutionsRequest AWS API Documentation
2315
+ #
2316
+ class ListBatchJobExecutionsRequest < Struct.new(
2317
+ :application_id,
2318
+ :execution_ids,
2319
+ :job_name,
2320
+ :max_results,
2321
+ :next_token,
2322
+ :started_after,
2323
+ :started_before,
2324
+ :status)
2325
+ SENSITIVE = []
2326
+ include Aws::Structure
2327
+ end
2328
+
2329
+ # @!attribute [rw] batch_job_executions
2330
+ # Returns a list of batch job executions for an application.
2331
+ # @return [Array<Types::BatchJobExecutionSummary>]
2332
+ #
2333
+ # @!attribute [rw] next_token
2334
+ # A pagination token that's returned when the response doesn't
2335
+ # contain all batch job executions.
2336
+ # @return [String]
2337
+ #
2338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListBatchJobExecutionsResponse AWS API Documentation
2339
+ #
2340
+ class ListBatchJobExecutionsResponse < Struct.new(
2341
+ :batch_job_executions,
2342
+ :next_token)
2343
+ SENSITIVE = []
2344
+ include Aws::Structure
2345
+ end
2346
+
2347
+ # @note When making an API call, you may pass ListDataSetImportHistoryRequest
2348
+ # data as a hash:
2349
+ #
2350
+ # {
2351
+ # application_id: "Identifier", # required
2352
+ # max_results: 1,
2353
+ # next_token: "NextToken",
2354
+ # }
2355
+ #
2356
+ # @!attribute [rw] application_id
2357
+ # The unique identifier of the application.
2358
+ # @return [String]
2359
+ #
2360
+ # @!attribute [rw] max_results
2361
+ # The maximum number of objects to return.
2362
+ # @return [Integer]
2363
+ #
2364
+ # @!attribute [rw] next_token
2365
+ # A pagination token returned from a previous call to this operation.
2366
+ # This specifies the next item to return. To return to the beginning
2367
+ # of the list, exclude this parameter.
2368
+ # @return [String]
2369
+ #
2370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListDataSetImportHistoryRequest AWS API Documentation
2371
+ #
2372
+ class ListDataSetImportHistoryRequest < Struct.new(
2373
+ :application_id,
2374
+ :max_results,
2375
+ :next_token)
2376
+ SENSITIVE = []
2377
+ include Aws::Structure
2378
+ end
2379
+
2380
+ # @!attribute [rw] data_set_import_tasks
2381
+ # The data set import tasks.
2382
+ # @return [Array<Types::DataSetImportTask>]
2383
+ #
2384
+ # @!attribute [rw] next_token
2385
+ # If there are more items to return, this contains a token that is
2386
+ # passed to a subsequent call to this operation to retrieve the next
2387
+ # set of items.
2388
+ # @return [String]
2389
+ #
2390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListDataSetImportHistoryResponse AWS API Documentation
2391
+ #
2392
+ class ListDataSetImportHistoryResponse < Struct.new(
2393
+ :data_set_import_tasks,
2394
+ :next_token)
2395
+ SENSITIVE = []
2396
+ include Aws::Structure
2397
+ end
2398
+
2399
+ # @note When making an API call, you may pass ListDataSetsRequest
2400
+ # data as a hash:
2401
+ #
2402
+ # {
2403
+ # application_id: "Identifier", # required
2404
+ # max_results: 1,
2405
+ # next_token: "NextToken",
2406
+ # prefix: "String200",
2407
+ # }
2408
+ #
2409
+ # @!attribute [rw] application_id
2410
+ # The unique identifier of the application for which you want to list
2411
+ # the associated data sets.
2412
+ # @return [String]
2413
+ #
2414
+ # @!attribute [rw] max_results
2415
+ # The maximum number of objects to return.
2416
+ # @return [Integer]
2417
+ #
2418
+ # @!attribute [rw] next_token
2419
+ # A pagination token returned from a previous call to this operation.
2420
+ # This specifies the next item to return. To return to the beginning
2421
+ # of the list, exclude this parameter.
2422
+ # @return [String]
2423
+ #
2424
+ # @!attribute [rw] prefix
2425
+ # The prefix of the data set name, which you can use to filter the
2426
+ # list of data sets.
2427
+ # @return [String]
2428
+ #
2429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListDataSetsRequest AWS API Documentation
2430
+ #
2431
+ class ListDataSetsRequest < Struct.new(
2432
+ :application_id,
2433
+ :max_results,
2434
+ :next_token,
2435
+ :prefix)
2436
+ SENSITIVE = []
2437
+ include Aws::Structure
2438
+ end
2439
+
2440
+ # @!attribute [rw] data_sets
2441
+ # The list of data sets, containing ionformation including the
2442
+ # creating time, the data set name, the data set organization, the
2443
+ # data set format, and the last time the data set was referenced or
2444
+ # updated.
2445
+ # @return [Array<Types::DataSetSummary>]
2446
+ #
2447
+ # @!attribute [rw] next_token
2448
+ # If there are more items to return, this contains a token that is
2449
+ # passed to a subsequent call to this operation to retrieve the next
2450
+ # set of items.
2451
+ # @return [String]
2452
+ #
2453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListDataSetsResponse AWS API Documentation
2454
+ #
2455
+ class ListDataSetsResponse < Struct.new(
2456
+ :data_sets,
2457
+ :next_token)
2458
+ SENSITIVE = []
2459
+ include Aws::Structure
2460
+ end
2461
+
2462
+ # @note When making an API call, you may pass ListDeploymentsRequest
2463
+ # data as a hash:
2464
+ #
2465
+ # {
2466
+ # application_id: "Identifier", # required
2467
+ # max_results: 1,
2468
+ # next_token: "NextToken",
2469
+ # }
2470
+ #
2471
+ # @!attribute [rw] application_id
2472
+ # The application identifier.
2473
+ # @return [String]
2474
+ #
2475
+ # @!attribute [rw] max_results
2476
+ # The maximum number of objects to return.
2477
+ # @return [Integer]
2478
+ #
2479
+ # @!attribute [rw] next_token
2480
+ # A pagination token returned from a previous call to this operation.
2481
+ # This specifies the next item to return. To return to the beginning
2482
+ # of the list, exclude this parameter.
2483
+ # @return [String]
2484
+ #
2485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListDeploymentsRequest AWS API Documentation
2486
+ #
2487
+ class ListDeploymentsRequest < Struct.new(
2488
+ :application_id,
2489
+ :max_results,
2490
+ :next_token)
2491
+ SENSITIVE = []
2492
+ include Aws::Structure
2493
+ end
2494
+
2495
+ # @!attribute [rw] deployments
2496
+ # The list of deployments that is returned.
2497
+ # @return [Array<Types::DeploymentSummary>]
2498
+ #
2499
+ # @!attribute [rw] next_token
2500
+ # If there are more items to return, this contains a token that is
2501
+ # passed to a subsequent call to this operation to retrieve the next
2502
+ # set of items.
2503
+ # @return [String]
2504
+ #
2505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListDeploymentsResponse AWS API Documentation
2506
+ #
2507
+ class ListDeploymentsResponse < Struct.new(
2508
+ :deployments,
2509
+ :next_token)
2510
+ SENSITIVE = []
2511
+ include Aws::Structure
2512
+ end
2513
+
2514
+ # @note When making an API call, you may pass ListEngineVersionsRequest
2515
+ # data as a hash:
2516
+ #
2517
+ # {
2518
+ # engine_type: "microfocus", # accepts microfocus, bluage
2519
+ # max_results: 1,
2520
+ # next_token: "NextToken",
2521
+ # }
2522
+ #
2523
+ # @!attribute [rw] engine_type
2524
+ # The type of target platform.
2525
+ # @return [String]
2526
+ #
2527
+ # @!attribute [rw] max_results
2528
+ # The maximum number of objects to return.
2529
+ # @return [Integer]
2530
+ #
2531
+ # @!attribute [rw] next_token
2532
+ # A pagination token returned from a previous call to this operation.
2533
+ # This specifies the next item to return. To return to the beginning
2534
+ # of the list, exclude this parameter.
2535
+ # @return [String]
2536
+ #
2537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListEngineVersionsRequest AWS API Documentation
2538
+ #
2539
+ class ListEngineVersionsRequest < Struct.new(
2540
+ :engine_type,
2541
+ :max_results,
2542
+ :next_token)
2543
+ SENSITIVE = []
2544
+ include Aws::Structure
2545
+ end
2546
+
2547
+ # @!attribute [rw] engine_versions
2548
+ # Returns the engine versions.
2549
+ # @return [Array<Types::EngineVersionsSummary>]
2550
+ #
2551
+ # @!attribute [rw] next_token
2552
+ # If there are more items to return, this contains a token that is
2553
+ # passed to a subsequent call to this operation to retrieve the next
2554
+ # set of items.
2555
+ # @return [String]
2556
+ #
2557
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListEngineVersionsResponse AWS API Documentation
2558
+ #
2559
+ class ListEngineVersionsResponse < Struct.new(
2560
+ :engine_versions,
2561
+ :next_token)
2562
+ SENSITIVE = []
2563
+ include Aws::Structure
2564
+ end
2565
+
2566
+ # @note When making an API call, you may pass ListEnvironmentsRequest
2567
+ # data as a hash:
2568
+ #
2569
+ # {
2570
+ # engine_type: "microfocus", # accepts microfocus, bluage
2571
+ # max_results: 1,
2572
+ # names: ["EntityName"],
2573
+ # next_token: "NextToken",
2574
+ # }
2575
+ #
2576
+ # @!attribute [rw] engine_type
2577
+ # The engine type for the environment.
2578
+ # @return [String]
2579
+ #
2580
+ # @!attribute [rw] max_results
2581
+ # The maximum number of environments to return.
2582
+ # @return [Integer]
2583
+ #
2584
+ # @!attribute [rw] names
2585
+ # The name of the environment.
2586
+ # @return [Array<String>]
2587
+ #
2588
+ # @!attribute [rw] next_token
2589
+ # A pagination token to control the number of environments displayed
2590
+ # in the list.
2591
+ # @return [String]
2592
+ #
2593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListEnvironmentsRequest AWS API Documentation
2594
+ #
2595
+ class ListEnvironmentsRequest < Struct.new(
2596
+ :engine_type,
2597
+ :max_results,
2598
+ :names,
2599
+ :next_token)
2600
+ SENSITIVE = []
2601
+ include Aws::Structure
2602
+ end
2603
+
2604
+ # @!attribute [rw] environments
2605
+ # Returns a list of summary details for all the environments in your
2606
+ # account.
2607
+ # @return [Array<Types::EnvironmentSummary>]
2608
+ #
2609
+ # @!attribute [rw] next_token
2610
+ # A pagination token that's returned when the response doesn't
2611
+ # contain all the environments.
2612
+ # @return [String]
2613
+ #
2614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListEnvironmentsResponse AWS API Documentation
2615
+ #
2616
+ class ListEnvironmentsResponse < Struct.new(
2617
+ :environments,
2618
+ :next_token)
2619
+ SENSITIVE = []
2620
+ include Aws::Structure
2621
+ end
2622
+
2623
+ # @note When making an API call, you may pass ListTagsForResourceRequest
2624
+ # data as a hash:
2625
+ #
2626
+ # {
2627
+ # resource_arn: "Arn", # required
2628
+ # }
2629
+ #
2630
+ # @!attribute [rw] resource_arn
2631
+ # The Amazon Resource Name (ARN) of the resource.
2632
+ # @return [String]
2633
+ #
2634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListTagsForResourceRequest AWS API Documentation
2635
+ #
2636
+ class ListTagsForResourceRequest < Struct.new(
2637
+ :resource_arn)
2638
+ SENSITIVE = []
2639
+ include Aws::Structure
2640
+ end
2641
+
2642
+ # @!attribute [rw] tags
2643
+ # The tags for the resource.
2644
+ # @return [Hash<String,String>]
2645
+ #
2646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListTagsForResourceResponse AWS API Documentation
2647
+ #
2648
+ class ListTagsForResourceResponse < Struct.new(
2649
+ :tags)
2650
+ SENSITIVE = []
2651
+ include Aws::Structure
2652
+ end
2653
+
2654
+ # A subset of the attributes about a log group. In CloudWatch a log
2655
+ # group is a group of log streams that share the same retention,
2656
+ # monitoring, and access control settings.
2657
+ #
2658
+ # @!attribute [rw] log_group_name
2659
+ # The name of the log group.
2660
+ # @return [String]
2661
+ #
2662
+ # @!attribute [rw] log_type
2663
+ # The type of log.
2664
+ # @return [String]
2665
+ #
2666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/LogGroupSummary AWS API Documentation
2667
+ #
2668
+ class LogGroupSummary < Struct.new(
2669
+ :log_group_name,
2670
+ :log_type)
2671
+ SENSITIVE = []
2672
+ include Aws::Structure
2673
+ end
2674
+
2675
+ # The information about the maintenance schedule.
2676
+ #
2677
+ # @!attribute [rw] end_time
2678
+ # The time the scheduled maintenance is to end.
2679
+ # @return [Time]
2680
+ #
2681
+ # @!attribute [rw] start_time
2682
+ # The time the scheduled maintenance is to start.
2683
+ # @return [Time]
2684
+ #
2685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/MaintenanceSchedule AWS API Documentation
2686
+ #
2687
+ class MaintenanceSchedule < Struct.new(
2688
+ :end_time,
2689
+ :start_time)
2690
+ SENSITIVE = []
2691
+ include Aws::Structure
2692
+ end
2693
+
2694
+ # The scheduled maintenance for a runtime engine.
2695
+ #
2696
+ # @!attribute [rw] engine_version
2697
+ # The specific runtime engine that the maintenance schedule applies
2698
+ # to.
2699
+ # @return [String]
2700
+ #
2701
+ # @!attribute [rw] schedule
2702
+ # The maintenance schedule for the engine version.
2703
+ # @return [Types::MaintenanceSchedule]
2704
+ #
2705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/PendingMaintenance AWS API Documentation
2706
+ #
2707
+ class PendingMaintenance < Struct.new(
2708
+ :engine_version,
2709
+ :schedule)
2710
+ SENSITIVE = []
2711
+ include Aws::Structure
2712
+ end
2713
+
2714
+ # The primary key for a KSDS data set.
2715
+ #
2716
+ # @note When making an API call, you may pass PrimaryKey
2717
+ # data as a hash:
2718
+ #
2719
+ # {
2720
+ # length: 1, # required
2721
+ # name: "String",
2722
+ # offset: 1, # required
2723
+ # }
2724
+ #
2725
+ # @!attribute [rw] length
2726
+ # A strictly positive integer value representing the length of the
2727
+ # primary key.
2728
+ # @return [Integer]
2729
+ #
2730
+ # @!attribute [rw] name
2731
+ # A name for the Primary Key.
2732
+ # @return [String]
2733
+ #
2734
+ # @!attribute [rw] offset
2735
+ # A positive integer value representing the offset to mark the start
2736
+ # of the primary key in the record byte array.
2737
+ # @return [Integer]
2738
+ #
2739
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/PrimaryKey AWS API Documentation
2740
+ #
2741
+ class PrimaryKey < Struct.new(
2742
+ :length,
2743
+ :name,
2744
+ :offset)
2745
+ SENSITIVE = []
2746
+ include Aws::Structure
2747
+ end
2748
+
2749
+ # The length of the records in the data set.
2750
+ #
2751
+ # @note When making an API call, you may pass RecordLength
2752
+ # data as a hash:
2753
+ #
2754
+ # {
2755
+ # max: 1, # required
2756
+ # min: 1, # required
2757
+ # }
2758
+ #
2759
+ # @!attribute [rw] max
2760
+ # The maximum record length. In case of fixed, both minimum and
2761
+ # maximum are the same.
2762
+ # @return [Integer]
2763
+ #
2764
+ # @!attribute [rw] min
2765
+ # The minimum record length of a record.
2766
+ # @return [Integer]
2767
+ #
2768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/RecordLength AWS API Documentation
2769
+ #
2770
+ class RecordLength < Struct.new(
2771
+ :max,
2772
+ :min)
2773
+ SENSITIVE = []
2774
+ include Aws::Structure
2775
+ end
2776
+
2777
+ # The specified resource was not found.
2778
+ #
2779
+ # @!attribute [rw] message
2780
+ # @return [String]
2781
+ #
2782
+ # @!attribute [rw] resource_id
2783
+ # The ID of the missing resource.
2784
+ # @return [String]
2785
+ #
2786
+ # @!attribute [rw] resource_type
2787
+ # The type of the missing resource.
2788
+ # @return [String]
2789
+ #
2790
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ResourceNotFoundException AWS API Documentation
2791
+ #
2792
+ class ResourceNotFoundException < Struct.new(
2793
+ :message,
2794
+ :resource_id,
2795
+ :resource_type)
2796
+ SENSITIVE = []
2797
+ include Aws::Structure
2798
+ end
2799
+
2800
+ # A batch job definition contained in a script.
2801
+ #
2802
+ # @!attribute [rw] script_name
2803
+ # The name of the script containing the batch job definition.
2804
+ # @return [String]
2805
+ #
2806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ScriptBatchJobDefinition AWS API Documentation
2807
+ #
2808
+ class ScriptBatchJobDefinition < Struct.new(
2809
+ :script_name)
2810
+ SENSITIVE = []
2811
+ include Aws::Structure
2812
+ end
2813
+
2814
+ # A batch job identifier in which the batch job to run is identified by
2815
+ # the script name.
2816
+ #
2817
+ # @note When making an API call, you may pass ScriptBatchJobIdentifier
2818
+ # data as a hash:
2819
+ #
2820
+ # {
2821
+ # script_name: "String", # required
2822
+ # }
2823
+ #
2824
+ # @!attribute [rw] script_name
2825
+ # The name of the script containing the batch job definition.
2826
+ # @return [String]
2827
+ #
2828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ScriptBatchJobIdentifier AWS API Documentation
2829
+ #
2830
+ class ScriptBatchJobIdentifier < Struct.new(
2831
+ :script_name)
2832
+ SENSITIVE = []
2833
+ include Aws::Structure
2834
+ end
2835
+
2836
+ # One or more quotas for Amazon Web Services Mainframe Modernization
2837
+ # exceeds the limit.
2838
+ #
2839
+ # @!attribute [rw] message
2840
+ # @return [String]
2841
+ #
2842
+ # @!attribute [rw] quota_code
2843
+ # The identifier of the exceeded quota.
2844
+ # @return [String]
2845
+ #
2846
+ # @!attribute [rw] resource_id
2847
+ # The ID of the resource that is exceeding the quota limit.
2848
+ # @return [String]
2849
+ #
2850
+ # @!attribute [rw] resource_type
2851
+ # The type of resource that is exceeding the quota limit for Amazon
2852
+ # Web Services Mainframe Modernization.
2853
+ # @return [String]
2854
+ #
2855
+ # @!attribute [rw] service_code
2856
+ # A code that identifies the service that the exceeded quota belongs
2857
+ # to.
2858
+ # @return [String]
2859
+ #
2860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ServiceQuotaExceededException AWS API Documentation
2861
+ #
2862
+ class ServiceQuotaExceededException < Struct.new(
2863
+ :message,
2864
+ :quota_code,
2865
+ :resource_id,
2866
+ :resource_type,
2867
+ :service_code)
2868
+ SENSITIVE = []
2869
+ include Aws::Structure
2870
+ end
2871
+
2872
+ # @note When making an API call, you may pass StartApplicationRequest
2873
+ # data as a hash:
2874
+ #
2875
+ # {
2876
+ # application_id: "Identifier", # required
2877
+ # }
2878
+ #
2879
+ # @!attribute [rw] application_id
2880
+ # The unique identifier of the application you want to start.
2881
+ # @return [String]
2882
+ #
2883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/StartApplicationRequest AWS API Documentation
2884
+ #
2885
+ class StartApplicationRequest < Struct.new(
2886
+ :application_id)
2887
+ SENSITIVE = []
2888
+ include Aws::Structure
2889
+ end
2890
+
2891
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/StartApplicationResponse AWS API Documentation
2892
+ #
2893
+ class StartApplicationResponse < Aws::EmptyStructure; end
2894
+
2895
+ # @note When making an API call, you may pass StartBatchJobRequest
2896
+ # data as a hash:
2897
+ #
2898
+ # {
2899
+ # application_id: "Identifier", # required
2900
+ # batch_job_identifier: { # required
2901
+ # file_batch_job_identifier: {
2902
+ # file_name: "String", # required
2903
+ # folder_path: "String",
2904
+ # },
2905
+ # script_batch_job_identifier: {
2906
+ # script_name: "String", # required
2907
+ # },
2908
+ # },
2909
+ # job_params: {
2910
+ # "BatchParamKey" => "BatchParamValue",
2911
+ # },
2912
+ # }
2913
+ #
2914
+ # @!attribute [rw] application_id
2915
+ # The unique identifier of the application associated with this batch
2916
+ # job.
2917
+ # @return [String]
2918
+ #
2919
+ # @!attribute [rw] batch_job_identifier
2920
+ # The unique identifier of the batch job.
2921
+ # @return [Types::BatchJobIdentifier]
2922
+ #
2923
+ # @!attribute [rw] job_params
2924
+ # The collection of batch job parameters. For details about limits for
2925
+ # keys and values, see [Coding variables in JCL][1].
2926
+ #
2927
+ #
2928
+ #
2929
+ # [1]: https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl
2930
+ # @return [Hash<String,String>]
2931
+ #
2932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/StartBatchJobRequest AWS API Documentation
2933
+ #
2934
+ class StartBatchJobRequest < Struct.new(
2935
+ :application_id,
2936
+ :batch_job_identifier,
2937
+ :job_params)
2938
+ SENSITIVE = []
2939
+ include Aws::Structure
2940
+ end
2941
+
2942
+ # @!attribute [rw] execution_id
2943
+ # The unique identifier of this execution of the batch job.
2944
+ # @return [String]
2945
+ #
2946
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/StartBatchJobResponse AWS API Documentation
2947
+ #
2948
+ class StartBatchJobResponse < Struct.new(
2949
+ :execution_id)
2950
+ SENSITIVE = []
2951
+ include Aws::Structure
2952
+ end
2953
+
2954
+ # @note When making an API call, you may pass StopApplicationRequest
2955
+ # data as a hash:
2956
+ #
2957
+ # {
2958
+ # application_id: "Identifier", # required
2959
+ # force_stop: false,
2960
+ # }
2961
+ #
2962
+ # @!attribute [rw] application_id
2963
+ # The unique identifier of the application you want to stop.
2964
+ # @return [String]
2965
+ #
2966
+ # @!attribute [rw] force_stop
2967
+ # Stopping an application process can take a long time. Setting this
2968
+ # parameter to true lets you force stop the application so you don't
2969
+ # need to wait until the process finishes to apply another action on
2970
+ # the application. The default value is false.
2971
+ # @return [Boolean]
2972
+ #
2973
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/StopApplicationRequest AWS API Documentation
2974
+ #
2975
+ class StopApplicationRequest < Struct.new(
2976
+ :application_id,
2977
+ :force_stop)
2978
+ SENSITIVE = []
2979
+ include Aws::Structure
2980
+ end
2981
+
2982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/StopApplicationResponse AWS API Documentation
2983
+ #
2984
+ class StopApplicationResponse < Aws::EmptyStructure; end
2985
+
2986
+ # Defines the storage configuration for an environment.
2987
+ #
2988
+ # @note StorageConfiguration is a union - when making an API calls you must set exactly one of the members.
2989
+ #
2990
+ # @note StorageConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of StorageConfiguration corresponding to the set member.
2991
+ #
2992
+ # @!attribute [rw] efs
2993
+ # Defines the storage configuration for an Amazon EFS file system.
2994
+ # @return [Types::EfsStorageConfiguration]
2995
+ #
2996
+ # @!attribute [rw] fsx
2997
+ # Defines the storage configuration for an Amazon FSx file system.
2998
+ # @return [Types::FsxStorageConfiguration]
2999
+ #
3000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/StorageConfiguration AWS API Documentation
3001
+ #
3002
+ class StorageConfiguration < Struct.new(
3003
+ :efs,
3004
+ :fsx,
3005
+ :unknown)
3006
+ SENSITIVE = []
3007
+ include Aws::Structure
3008
+ include Aws::Structure::Union
3009
+
3010
+ class Efs < StorageConfiguration; end
3011
+ class Fsx < StorageConfiguration; end
3012
+ class Unknown < StorageConfiguration; end
3013
+ end
3014
+
3015
+ # @note When making an API call, you may pass TagResourceRequest
3016
+ # data as a hash:
3017
+ #
3018
+ # {
3019
+ # resource_arn: "Arn", # required
3020
+ # tags: { # required
3021
+ # "TagKey" => "TagValue",
3022
+ # },
3023
+ # }
3024
+ #
3025
+ # @!attribute [rw] resource_arn
3026
+ # The Amazon Resource Name (ARN) of the resource.
3027
+ # @return [String]
3028
+ #
3029
+ # @!attribute [rw] tags
3030
+ # The tags to add to the resource.
3031
+ # @return [Hash<String,String>]
3032
+ #
3033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/TagResourceRequest AWS API Documentation
3034
+ #
3035
+ class TagResourceRequest < Struct.new(
3036
+ :resource_arn,
3037
+ :tags)
3038
+ SENSITIVE = []
3039
+ include Aws::Structure
3040
+ end
3041
+
3042
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/TagResourceResponse AWS API Documentation
3043
+ #
3044
+ class TagResourceResponse < Aws::EmptyStructure; end
3045
+
3046
+ # The number of requests made exceeds the limit.
3047
+ #
3048
+ # @!attribute [rw] message
3049
+ # @return [String]
3050
+ #
3051
+ # @!attribute [rw] quota_code
3052
+ # The identifier of the throttled reuqest.
3053
+ # @return [String]
3054
+ #
3055
+ # @!attribute [rw] retry_after_seconds
3056
+ # The number of seconds to wait before retrying the request.
3057
+ # @return [Integer]
3058
+ #
3059
+ # @!attribute [rw] service_code
3060
+ # The identifier of the service that the throttled request was made
3061
+ # to.
3062
+ # @return [String]
3063
+ #
3064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ThrottlingException AWS API Documentation
3065
+ #
3066
+ class ThrottlingException < Struct.new(
3067
+ :message,
3068
+ :quota_code,
3069
+ :retry_after_seconds,
3070
+ :service_code)
3071
+ SENSITIVE = []
3072
+ include Aws::Structure
3073
+ end
3074
+
3075
+ # @note When making an API call, you may pass UntagResourceRequest
3076
+ # data as a hash:
3077
+ #
3078
+ # {
3079
+ # resource_arn: "Arn", # required
3080
+ # tag_keys: ["TagKey"], # required
3081
+ # }
3082
+ #
3083
+ # @!attribute [rw] resource_arn
3084
+ # The Amazon Resource Name (ARN) of the resource.
3085
+ # @return [String]
3086
+ #
3087
+ # @!attribute [rw] tag_keys
3088
+ # The keys of the tags to remove.
3089
+ # @return [Array<String>]
3090
+ #
3091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/UntagResourceRequest AWS API Documentation
3092
+ #
3093
+ class UntagResourceRequest < Struct.new(
3094
+ :resource_arn,
3095
+ :tag_keys)
3096
+ SENSITIVE = []
3097
+ include Aws::Structure
3098
+ end
3099
+
3100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/UntagResourceResponse AWS API Documentation
3101
+ #
3102
+ class UntagResourceResponse < Aws::EmptyStructure; end
3103
+
3104
+ # @note When making an API call, you may pass UpdateApplicationRequest
3105
+ # data as a hash:
3106
+ #
3107
+ # {
3108
+ # application_id: "Identifier", # required
3109
+ # current_application_version: 1, # required
3110
+ # definition: {
3111
+ # content: "StringFree65000",
3112
+ # s3_location: "String2000",
3113
+ # },
3114
+ # description: "EntityDescription",
3115
+ # }
3116
+ #
3117
+ # @!attribute [rw] application_id
3118
+ # The unique identifier of the application you want to update.
3119
+ # @return [String]
3120
+ #
3121
+ # @!attribute [rw] current_application_version
3122
+ # The current version of the application to update.
3123
+ # @return [Integer]
3124
+ #
3125
+ # @!attribute [rw] definition
3126
+ # The application definition for this application. You can specify
3127
+ # either inline JSON or an S3 bucket location.
3128
+ # @return [Types::Definition]
3129
+ #
3130
+ # @!attribute [rw] description
3131
+ # The description of the application to update.
3132
+ # @return [String]
3133
+ #
3134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/UpdateApplicationRequest AWS API Documentation
3135
+ #
3136
+ class UpdateApplicationRequest < Struct.new(
3137
+ :application_id,
3138
+ :current_application_version,
3139
+ :definition,
3140
+ :description)
3141
+ SENSITIVE = []
3142
+ include Aws::Structure
3143
+ end
3144
+
3145
+ # @!attribute [rw] application_version
3146
+ # The new version of the application.
3147
+ # @return [Integer]
3148
+ #
3149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/UpdateApplicationResponse AWS API Documentation
3150
+ #
3151
+ class UpdateApplicationResponse < Struct.new(
3152
+ :application_version)
3153
+ SENSITIVE = []
3154
+ include Aws::Structure
3155
+ end
3156
+
3157
+ # @note When making an API call, you may pass UpdateEnvironmentRequest
3158
+ # data as a hash:
3159
+ #
3160
+ # {
3161
+ # apply_during_maintenance_window: false,
3162
+ # desired_capacity: 1,
3163
+ # engine_version: "EngineVersion",
3164
+ # environment_id: "Identifier", # required
3165
+ # instance_type: "String20",
3166
+ # preferred_maintenance_window: "String",
3167
+ # }
3168
+ #
3169
+ # @!attribute [rw] apply_during_maintenance_window
3170
+ # Indicates whether to update the environment during the maintenance
3171
+ # window. The default is false. Currently, Amazon Web Services
3172
+ # Mainframe Modernization accepts the `engineVersion` parameter only
3173
+ # if `applyDuringMaintenanceWindow` is true. If any parameter other
3174
+ # than `engineVersion` is provided in `UpdateEnvironmentRequest`, it
3175
+ # will fail if `applyDuringMaintenanceWindow` is set to true.
3176
+ # @return [Boolean]
3177
+ #
3178
+ # @!attribute [rw] desired_capacity
3179
+ # The desired capacity for the environment to update.
3180
+ # @return [Integer]
3181
+ #
3182
+ # @!attribute [rw] engine_version
3183
+ # The version of the runtime engine for the environment.
3184
+ # @return [String]
3185
+ #
3186
+ # @!attribute [rw] environment_id
3187
+ # The unique identifier of the runtime environment that you want to
3188
+ # update.
3189
+ # @return [String]
3190
+ #
3191
+ # @!attribute [rw] instance_type
3192
+ # The instance type for the environment to update.
3193
+ # @return [String]
3194
+ #
3195
+ # @!attribute [rw] preferred_maintenance_window
3196
+ # Configures a desired maintenance window for the environment. If you
3197
+ # do not provide a value, a random system-generated value will be
3198
+ # assigned.
3199
+ # @return [String]
3200
+ #
3201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/UpdateEnvironmentRequest AWS API Documentation
3202
+ #
3203
+ class UpdateEnvironmentRequest < Struct.new(
3204
+ :apply_during_maintenance_window,
3205
+ :desired_capacity,
3206
+ :engine_version,
3207
+ :environment_id,
3208
+ :instance_type,
3209
+ :preferred_maintenance_window)
3210
+ SENSITIVE = []
3211
+ include Aws::Structure
3212
+ end
3213
+
3214
+ # @!attribute [rw] environment_id
3215
+ # The unique identifier of the runtime environment that was updated.
3216
+ # @return [String]
3217
+ #
3218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/UpdateEnvironmentResponse AWS API Documentation
3219
+ #
3220
+ class UpdateEnvironmentResponse < Struct.new(
3221
+ :environment_id)
3222
+ SENSITIVE = []
3223
+ include Aws::Structure
3224
+ end
3225
+
3226
+ # One or more parameters provided in the request is not valid.
3227
+ #
3228
+ # @!attribute [rw] field_list
3229
+ # The list of fields that failed service validation.
3230
+ # @return [Array<Types::ValidationExceptionField>]
3231
+ #
3232
+ # @!attribute [rw] message
3233
+ # @return [String]
3234
+ #
3235
+ # @!attribute [rw] reason
3236
+ # The reason why it failed service validation.
3237
+ # @return [String]
3238
+ #
3239
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ValidationException AWS API Documentation
3240
+ #
3241
+ class ValidationException < Struct.new(
3242
+ :field_list,
3243
+ :message,
3244
+ :reason)
3245
+ SENSITIVE = []
3246
+ include Aws::Structure
3247
+ end
3248
+
3249
+ # Contains information about a validation exception field.
3250
+ #
3251
+ # @!attribute [rw] message
3252
+ # The message of the exception field.
3253
+ # @return [String]
3254
+ #
3255
+ # @!attribute [rw] name
3256
+ # The name of the exception field.
3257
+ # @return [String]
3258
+ #
3259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ValidationExceptionField AWS API Documentation
3260
+ #
3261
+ class ValidationExceptionField < Struct.new(
3262
+ :message,
3263
+ :name)
3264
+ SENSITIVE = []
3265
+ include Aws::Structure
3266
+ end
3267
+
3268
+ # The attributes of a VSAM type data set.
3269
+ #
3270
+ # @note When making an API call, you may pass VsamAttributes
3271
+ # data as a hash:
3272
+ #
3273
+ # {
3274
+ # alternate_keys: [
3275
+ # {
3276
+ # allow_duplicates: false,
3277
+ # length: 1, # required
3278
+ # name: "String",
3279
+ # offset: 1, # required
3280
+ # },
3281
+ # ],
3282
+ # compressed: false,
3283
+ # encoding: "String",
3284
+ # format: "String", # required
3285
+ # primary_key: {
3286
+ # length: 1, # required
3287
+ # name: "String",
3288
+ # offset: 1, # required
3289
+ # },
3290
+ # }
3291
+ #
3292
+ # @!attribute [rw] alternate_keys
3293
+ # The alternate key definitions, if any. A legacy dataset might not
3294
+ # have any alternate key defined, but if those alternate keys
3295
+ # definitions exist, provide them as some applications will make use
3296
+ # of them.
3297
+ # @return [Array<Types::AlternateKey>]
3298
+ #
3299
+ # @!attribute [rw] compressed
3300
+ # Indicates whether indexes for this dataset are stored as compressed
3301
+ # values. If you have a large data set (typically &gt; 100 Mb),
3302
+ # consider setting this flag to True.
3303
+ # @return [Boolean]
3304
+ #
3305
+ # @!attribute [rw] encoding
3306
+ # The character set used by the data set. Can be ASCII, EBCDIC, or
3307
+ # unknown.
3308
+ # @return [String]
3309
+ #
3310
+ # @!attribute [rw] format
3311
+ # The record format of the data set.
3312
+ # @return [String]
3313
+ #
3314
+ # @!attribute [rw] primary_key
3315
+ # The primary key of the data set.
3316
+ # @return [Types::PrimaryKey]
3317
+ #
3318
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/VsamAttributes AWS API Documentation
3319
+ #
3320
+ class VsamAttributes < Struct.new(
3321
+ :alternate_keys,
3322
+ :compressed,
3323
+ :encoding,
3324
+ :format,
3325
+ :primary_key)
3326
+ SENSITIVE = []
3327
+ include Aws::Structure
3328
+ end
3329
+
3330
+ # The attributes of a VSAM type data set.
3331
+ #
3332
+ # @!attribute [rw] alternate_keys
3333
+ # The alternate key definitions, if any. A legacy dataset might not
3334
+ # have any alternate key defined, but if those alternate keys
3335
+ # definitions exist, provide them as some applications will make use
3336
+ # of them.
3337
+ # @return [Array<Types::AlternateKey>]
3338
+ #
3339
+ # @!attribute [rw] cache_at_startup
3340
+ # If set to True, enforces loading the data set into cache before it’s
3341
+ # used by the application.
3342
+ # @return [Boolean]
3343
+ #
3344
+ # @!attribute [rw] compressed
3345
+ # Indicates whether indexes for this dataset are stored as compressed
3346
+ # values. If you have a large data set (typically &gt; 100 Mb),
3347
+ # consider setting this flag to True.
3348
+ # @return [Boolean]
3349
+ #
3350
+ # @!attribute [rw] encoding
3351
+ # The character set used by the data set. Can be ASCII, EBCDIC, or
3352
+ # unknown.
3353
+ # @return [String]
3354
+ #
3355
+ # @!attribute [rw] primary_key
3356
+ # The primary key of the data set.
3357
+ # @return [Types::PrimaryKey]
3358
+ #
3359
+ # @!attribute [rw] record_format
3360
+ # The record format of the data set.
3361
+ # @return [String]
3362
+ #
3363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/VsamDetailAttributes AWS API Documentation
3364
+ #
3365
+ class VsamDetailAttributes < Struct.new(
3366
+ :alternate_keys,
3367
+ :cache_at_startup,
3368
+ :compressed,
3369
+ :encoding,
3370
+ :primary_key,
3371
+ :record_format)
3372
+ SENSITIVE = []
3373
+ include Aws::Structure
3374
+ end
3375
+
3376
+ end
3377
+ end