/
m2.jl
1326 lines (1201 loc) · 41.2 KB
/
m2.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: m2
using AWS.Compat
using AWS.UUIDs
"""
cancel_batch_job_execution(application_id, execution_id)
cancel_batch_job_execution(application_id, execution_id, params::Dict{String,<:Any})
Cancels the running of a specific batch job execution.
# Arguments
- `application_id`: The unique identifier of the application.
- `execution_id`: The unique identifier of the batch job execution.
"""
function cancel_batch_job_execution(
applicationId, executionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"POST",
"/applications/$(applicationId)/batch-job-executions/$(executionId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_batch_job_execution(
applicationId,
executionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/batch-job-executions/$(executionId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application(definition, engine_type, name)
create_application(definition, engine_type, name, params::Dict{String,<:Any})
Creates a new application with given parameters. Requires an existing runtime environment
and application definition file.
# Arguments
- `definition`: The application definition for this application. You can specify either
inline JSON or an S3 bucket location.
- `engine_type`: The type of the target platform for this application.
- `name`: The unique identifier of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier the service generates to ensure the
idempotency of the request to create an application. The service generates the clientToken
when the API call is triggered. The token expires after one hour, so if you retry the API
within this timeframe with the same clientToken, you will get the same response. The
service also handles deleting the clientToken after it expires.
- `"description"`: The description of the application.
- `"kmsKeyId"`: The identifier of a customer managed key.
- `"roleArn"`: The Amazon Resource Name (ARN) of the role associated with the application.
- `"tags"`: A list of tags to apply to the application.
"""
function create_application(
definition, engineType, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"POST",
"/applications",
Dict{String,Any}(
"definition" => definition,
"engineType" => engineType,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
definition,
engineType,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"definition" => definition,
"engineType" => engineType,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_set_import_task(application_id, import_config)
create_data_set_import_task(application_id, import_config, params::Dict{String,<:Any})
Starts a data set import task for a specific application.
# Arguments
- `application_id`: The unique identifier of the application for which you want to import
data sets.
- `import_config`: The data set import task configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier you provide to ensure the idempotency
of the request to create a data set import. The service generates the clientToken when the
API call is triggered. The token expires after one hour, so if you retry the API within
this timeframe with the same clientToken, you will get the same response. The service also
handles deleting the clientToken after it expires.
"""
function create_data_set_import_task(
applicationId, importConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"POST",
"/applications/$(applicationId)/dataset-import-task",
Dict{String,Any}("importConfig" => importConfig, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_set_import_task(
applicationId,
importConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/dataset-import-task",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"importConfig" => importConfig, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_deployment(application_id, application_version, environment_id)
create_deployment(application_id, application_version, environment_id, params::Dict{String,<:Any})
Creates and starts a deployment to deploy an application into a runtime environment.
# Arguments
- `application_id`: The application identifier.
- `application_version`: The version of the application to deploy.
- `environment_id`: The identifier of the runtime environment where you want to deploy this
application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier you provide to ensure the idempotency
of the request to create a deployment. The service generates the clientToken when the API
call is triggered. The token expires after one hour, so if you retry the API within this
timeframe with the same clientToken, you will get the same response. The service also
handles deleting the clientToken after it expires.
"""
function create_deployment(
applicationId,
applicationVersion,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/deployments",
Dict{String,Any}(
"applicationVersion" => applicationVersion,
"environmentId" => environmentId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_deployment(
applicationId,
applicationVersion,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/applications/$(applicationId)/deployments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"applicationVersion" => applicationVersion,
"environmentId" => environmentId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment(engine_type, instance_type, name)
create_environment(engine_type, instance_type, name, params::Dict{String,<:Any})
Creates a runtime environment for a given runtime engine.
# Arguments
- `engine_type`: The engine type for the runtime environment.
- `instance_type`: The type of instance for the runtime environment.
- `name`: The name of the runtime environment. Must be unique within the account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier you provide to ensure the idempotency
of the request to create an environment. The service generates the clientToken when the API
call is triggered. The token expires after one hour, so if you retry the API within this
timeframe with the same clientToken, you will get the same response. The service also
handles deleting the clientToken after it expires.
- `"description"`: The description of the runtime environment.
- `"engineVersion"`: The version of the engine type for the runtime environment.
- `"highAvailabilityConfig"`: The details of a high availability configuration for this
runtime environment.
- `"kmsKeyId"`: The identifier of a customer managed key.
- `"preferredMaintenanceWindow"`: Configures the maintenance window you want for the
runtime environment. If you do not provide a value, a random system-generated value will be
assigned.
- `"publiclyAccessible"`: Specifies whether the runtime environment is publicly accessible.
- `"securityGroupIds"`: The list of security groups for the VPC associated with this
runtime environment.
- `"storageConfigurations"`: Optional. The storage configurations for this runtime
environment.
- `"subnetIds"`: The list of subnets associated with the VPC for this runtime environment.
- `"tags"`: The tags for the runtime environment.
"""
function create_environment(
engineType, instanceType, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"POST",
"/environments",
Dict{String,Any}(
"engineType" => engineType,
"instanceType" => instanceType,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment(
engineType,
instanceType,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"POST",
"/environments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"engineType" => engineType,
"instanceType" => instanceType,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_id)
delete_application(application_id, params::Dict{String,<:Any})
Deletes a specific application. You cannot delete a running application.
# Arguments
- `application_id`: The unique identifier of the application you want to delete.
"""
function delete_application(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"DELETE",
"/applications/$(applicationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"DELETE",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_from_environment(application_id, environment_id)
delete_application_from_environment(application_id, environment_id, params::Dict{String,<:Any})
Deletes a specific application from the specific runtime environment where it was
previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any
application has ever been deployed to it. This API removes the association of the
application with the runtime environment so you can delete the environment smoothly.
# Arguments
- `application_id`: The unique identifier of the application you want to delete.
- `environment_id`: The unique identifier of the runtime environment where the application
was previously deployed.
"""
function delete_application_from_environment(
applicationId, environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"DELETE",
"/applications/$(applicationId)/environment/$(environmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_from_environment(
applicationId,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"DELETE",
"/applications/$(applicationId)/environment/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment(environment_id)
delete_environment(environment_id, params::Dict{String,<:Any})
Deletes a specific runtime environment. The environment cannot contain deployed
applications. If it does, you must delete those applications before you delete the
environment.
# Arguments
- `environment_id`: The unique identifier of the runtime environment you want to delete.
"""
function delete_environment(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"DELETE",
"/environments/$(environmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"DELETE",
"/environments/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application(application_id)
get_application(application_id, params::Dict{String,<:Any})
Describes the details of a specific application.
# Arguments
- `application_id`: The identifier of the application.
"""
function get_application(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET",
"/applications/$(applicationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application_version(application_id, application_version)
get_application_version(application_id, application_version, params::Dict{String,<:Any})
Returns details about a specific version of a specific application.
# Arguments
- `application_id`: The unique identifier of the application.
- `application_version`: The specific version of the application.
"""
function get_application_version(
applicationId, applicationVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/versions/$(applicationVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_version(
applicationId,
applicationVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/versions/$(applicationVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_batch_job_execution(application_id, execution_id)
get_batch_job_execution(application_id, execution_id, params::Dict{String,<:Any})
Gets the details of a specific batch job execution for a specific application.
# Arguments
- `application_id`: The identifier of the application.
- `execution_id`: The unique identifier of the batch job execution.
"""
function get_batch_job_execution(
applicationId, executionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-executions/$(executionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_batch_job_execution(
applicationId,
executionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-executions/$(executionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_set_details(application_id, data_set_name)
get_data_set_details(application_id, data_set_name, params::Dict{String,<:Any})
Gets the details of a specific data set.
# Arguments
- `application_id`: The unique identifier of the application that this data set is
associated with.
- `data_set_name`: The name of the data set.
"""
function get_data_set_details(
applicationId, dataSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/datasets/$(dataSetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_set_details(
applicationId,
dataSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/datasets/$(dataSetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_set_import_task(application_id, task_id)
get_data_set_import_task(application_id, task_id, params::Dict{String,<:Any})
Gets the status of a data set import task initiated with the CreateDataSetImportTask
operation.
# Arguments
- `application_id`: The application identifier.
- `task_id`: The task identifier returned by the CreateDataSetImportTask operation.
"""
function get_data_set_import_task(
applicationId, taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/dataset-import-tasks/$(taskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_set_import_task(
applicationId,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/dataset-import-tasks/$(taskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deployment(application_id, deployment_id)
get_deployment(application_id, deployment_id, params::Dict{String,<:Any})
Gets details of a specific deployment with a given deployment identifier.
# Arguments
- `application_id`: The unique identifier of the application.
- `deployment_id`: The unique identifier for the deployment.
"""
function get_deployment(
applicationId, deploymentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/deployments/$(deploymentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deployment(
applicationId,
deploymentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/deployments/$(deploymentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment(environment_id)
get_environment(environment_id, params::Dict{String,<:Any})
Describes a specific runtime environment.
# Arguments
- `environment_id`: The unique identifier of the runtime environment.
"""
function get_environment(environmentId; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET",
"/environments/$(environmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/environments/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_versions(application_id)
list_application_versions(application_id, params::Dict{String,<:Any})
Returns a list of the application versions for a specific application.
# Arguments
- `application_id`: The unique identifier of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of application versions to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
"""
function list_application_versions(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_versions(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
Lists the applications associated with a specific Amazon Web Services account. You can
provide the unique identifier of a specific runtime environment in a query parameter to see
all applications associated with that environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"environmentId"`: The unique identifier of the runtime environment where the
applications are deployed.
- `"maxResults"`: The maximum number of applications to return.
- `"names"`: The names of the applications.
- `"nextToken"`: A pagination token to control the number of applications displayed in the
list.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET", "/applications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_batch_job_definitions(application_id)
list_batch_job_definitions(application_id, params::Dict{String,<:Any})
Lists all the available batch job definitions based on the batch job resources uploaded
during the application creation. You can use the batch job definitions in the list to start
a batch job.
# Arguments
- `application_id`: The identifier of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of batch job definitions to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
- `"prefix"`: If the batch job definition is a FileBatchJobDefinition, the prefix allows
you to search on the file names of FileBatchJobDefinitions.
"""
function list_batch_job_definitions(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-definitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_batch_job_definitions(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-definitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_batch_job_executions(application_id)
list_batch_job_executions(application_id, params::Dict{String,<:Any})
Lists historical, current, and scheduled batch job executions for a specific application.
# Arguments
- `application_id`: The unique identifier of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"executionIds"`: The unique identifier of each batch job execution.
- `"jobName"`: The name of each batch job execution.
- `"maxResults"`: The maximum number of batch job executions to return.
- `"nextToken"`: A pagination token to control the number of batch job executions displayed
in the list.
- `"startedAfter"`: The time after which the batch job executions started.
- `"startedBefore"`: The time before the batch job executions started.
- `"status"`: The status of the batch job executions.
"""
function list_batch_job_executions(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-executions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_batch_job_executions(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/batch-job-executions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_set_import_history(application_id)
list_data_set_import_history(application_id, params::Dict{String,<:Any})
Lists the data set imports for the specified application.
# Arguments
- `application_id`: The unique identifier of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
"""
function list_data_set_import_history(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/applications/$(applicationId)/dataset-import-tasks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_set_import_history(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/dataset-import-tasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_sets(application_id)
list_data_sets(application_id, params::Dict{String,<:Any})
Lists the data sets imported for a specific application. In Amazon Web Services Mainframe
Modernization, data sets are associated with applications deployed on runtime environments.
This is known as importing data sets. Currently, Amazon Web Services Mainframe
Modernization can import data sets into catalogs using CreateDataSetImportTask.
# Arguments
- `application_id`: The unique identifier of the application for which you want to list the
associated data sets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
- `"prefix"`: The prefix of the data set name, which you can use to filter the list of data
sets.
"""
function list_data_sets(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET",
"/applications/$(applicationId)/datasets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_sets(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/datasets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_deployments(application_id)
list_deployments(application_id, params::Dict{String,<:Any})
Returns a list of all deployments of a specific application. A deployment is a combination
of a specific application and a specific version of that application. Each deployment is
mapped to a particular application version.
# Arguments
- `application_id`: The application identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
"""
function list_deployments(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET",
"/applications/$(applicationId)/deployments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_deployments(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return m2(
"GET",
"/applications/$(applicationId)/deployments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_engine_versions()
list_engine_versions(params::Dict{String,<:Any})
Lists the available engine versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"engineType"`: The type of target platform.
- `"maxResults"`: The maximum number of objects to return.
- `"nextToken"`: A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the list, exclude this
parameter.
"""
function list_engine_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET", "/engine-versions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_engine_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(
"GET",
"/engine-versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environments()
list_environments(params::Dict{String,<:Any})
Lists the runtime environments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"engineType"`: The engine type for the runtime environment.
- `"maxResults"`: The maximum number of runtime environments to return.
- `"names"`: The names of the runtime environments. Must be unique within the account.
- `"nextToken"`: A pagination token to control the number of runtime environments displayed
in the list.
"""
function list_environments(; aws_config::AbstractAWSConfig=global_aws_config())
return m2(
"GET", "/environments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_environments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return m2(