Skip to content

Commit cb00eaf

Browse files
author
AWS
committed
AWSMainframeModernization Update: Add AuthSecretsManagerArn optional parameter to batch job APIs, expand batch parameter limits, and introduce clientToken constraints.
1 parent 51e10d4 commit cb00eaf

File tree

2 files changed

+58
-23
lines changed

2 files changed

+58
-23
lines changed

‎.changes/next-release/feature-AWSMainframeModernization-d118f92.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWSMainframeModernization",
4+
"contributor": "",
5+
"description": "Add AuthSecretsManagerArn optional parameter to batch job APIs, expand batch parameter limits, and introduce clientToken constraints."
6+
}

‎services/m2/src/main/resources/codegen-resources/service-2.json

Lines changed: 52 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@
55
"endpointPrefix":"m2",
66
"jsonVersion":"1.1",
77
"protocol":"rest-json",
8+
"protocols":["rest-json"],
89
"serviceFullName":"AWSMainframeModernization",
910
"serviceId":"m2",
1011
"signatureVersion":"v4",
1112
"signingName":"m2",
12-
"uid":"m2-2021-04-28"
13+
"uid":"m2-2021-04-28",
14+
"auth":["aws.auth#sigv4"]
1315
},
1416
"operations":{
1517
"CancelBatchJobExecution":{
@@ -402,7 +404,7 @@
402404
{"shape":"ValidationException"},
403405
{"shape":"InternalServerException"}
404406
],
405-
"documentation":"<p>Lists all the job steps for JCL files to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.</p>"
407+
"documentation":"<p>Lists all the job steps for a JCL file to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.</p>"
406408
},
407409
"ListDataSetImportHistory":{
408410
"name":"ListDataSetImportHistory",
@@ -833,6 +835,11 @@
833835
"member":{"shape":"Arn"},
834836
"min":1
835837
},
838+
"AuthSecretsManagerArn":{
839+
"type":"string",
840+
"max":2048,
841+
"min":20
842+
},
836843
"BatchJobDefinition":{
837844
"type":"structure",
838845
"members":{
@@ -932,7 +939,7 @@
932939
},
933940
"restartBatchJobIdentifier":{
934941
"shape":"RestartBatchJobIdentifier",
935-
"documentation":"<p>Specifies the required information for restart, including execution ID and jobsteprestartmarker.</p>"
942+
"documentation":"<p>Specifies the required information for restart, including <code>executionId</code> and <code>JobStepRestartMarker</code>.</p>"
936943
},
937944
"s3BatchJobIdentifier":{
938945
"shape":"S3BatchJobIdentifier",
@@ -968,15 +975,15 @@
968975
},
969976
"BatchParamKey":{
970977
"type":"string",
971-
"documentation":"<p>See https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl to get details about limits for both keys and values: 8 for keys (variable names), 44 for values (variable values) In addition, keys will be only alphabetic characters and digits, without any space or special characters (dash, underscore, etc ...)</p> <p>Parameter key: the first character must be alphabetic. Can be of up to 8 alphanumeric characters.</p>",
978+
"documentation":"<p>See https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl to get details about limits for both keys and values: 8 for keys (variable names), 44 for values (variable values) In addition, keys will be only alphabetic characters and digits, without any space or special characters (dash, underscore, etc ...)</p> <p>For BluAge Engine: There is no limit in length of keys and values. Additional validation may be applied in code, per engine. Parameter key: the first character must be alphabetic. Can be of up to 32 alphanumeric characters.</p>",
972979
"max":32,
973980
"min":1,
974-
"pattern":"^[A-Za-z][A-Za-z0-9]{1,7}$"
981+
"pattern":"^[A-Za-z][A-Za-z0-9]{1,31}$"
975982
},
976983
"BatchParamValue":{
977984
"type":"string",
978-
"documentation":"<p>Parameter value can be of up to 44 alphanumeric characters.</p>",
979-
"max":80,
985+
"documentation":"<p>Parameter value can be of up to 1024 alphanumeric characters.</p>",
986+
"max":1024,
980987
"min":0
981988
},
982989
"Boolean":{"type":"boolean"},
@@ -993,6 +1000,10 @@
9931000
"location":"uri",
9941001
"locationName":"applicationId"
9951002
},
1003+
"authSecretsManagerArn":{
1004+
"shape":"AuthSecretsManagerArn",
1005+
"documentation":"<p>The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Cancel Batch Job Execution operation.</p>"
1006+
},
9961007
"executionId":{
9971008
"shape":"Identifier",
9981009
"documentation":"<p>The unique identifier of the batch job execution.</p>",
@@ -1010,6 +1021,13 @@
10101021
"type":"integer",
10111022
"box":true
10121023
},
1024+
"ClientToken":{
1025+
"type":"string",
1026+
"documentation":"<p>A client token is a unique, case-sensitive string of up to 128 ASCII characters with ASCII values of 33-126 inclusive. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.</p>",
1027+
"max":128,
1028+
"min":0,
1029+
"pattern":"^[!-~]+$"
1030+
},
10131031
"ConflictException":{
10141032
"type":"structure",
10151033
"required":["message"],
@@ -1040,8 +1058,8 @@
10401058
],
10411059
"members":{
10421060
"clientToken":{
1043-
"shape":"String",
1044-
"documentation":"<p>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. </p>",
1061+
"shape":"ClientToken",
1062+
"documentation":"<p>A client token is a unique, case-sensitive string of up to 128 ASCII characters with ASCII values of 33-126 inclusive. It's generated by the client to ensure idempotent operations, allowing for safe retries without unintended side effects.</p>",
10451063
"idempotencyToken":true
10461064
},
10471065
"definition":{
@@ -1110,7 +1128,7 @@
11101128
"locationName":"applicationId"
11111129
},
11121130
"clientToken":{
1113-
"shape":"String",
1131+
"shape":"ClientToken",
11141132
"documentation":"<p> 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. </p>",
11151133
"idempotencyToken":true
11161134
},
@@ -1149,7 +1167,7 @@
11491167
"documentation":"<p>The version of the application to deploy.</p>"
11501168
},
11511169
"clientToken":{
1152-
"shape":"String",
1170+
"shape":"ClientToken",
11531171
"documentation":"<p>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. </p>",
11541172
"idempotencyToken":true
11551173
},
@@ -1178,7 +1196,7 @@
11781196
],
11791197
"members":{
11801198
"clientToken":{
1181-
"shape":"String",
1199+
"shape":"ClientToken",
11821200
"documentation":"<p>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. </p>",
11831201
"idempotencyToken":true
11841202
},
@@ -1697,7 +1715,8 @@
16971715
"Available",
16981716
"Updating",
16991717
"Deleting",
1700-
"Failed"
1718+
"Failed",
1719+
"UnHealthy"
17011720
]
17021721
},
17031722
"EnvironmentSummary":{
@@ -2076,7 +2095,7 @@
20762095
},
20772096
"jobStepRestartMarker":{
20782097
"shape":"JobStepRestartMarker",
2079-
"documentation":"<p>The restart steps information for the most recent restart operation.</p>"
2098+
"documentation":"<p>The step/procedure step information for the restart batch job operation.</p>"
20802099
},
20812100
"jobType":{
20822101
"shape":"BatchJobType",
@@ -2367,7 +2386,7 @@
23672386
},
23682387
"status":{
23692388
"shape":"EnvironmentLifecycle",
2370-
"documentation":"<p>The status of the runtime environment.</p>"
2389+
"documentation":"<p>The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be <code>Unhealthy</code>.</p>"
23712390
},
23722391
"statusReason":{
23732392
"shape":"String",
@@ -2492,22 +2511,22 @@
24922511
"members":{
24932512
"fromProcStep":{
24942513
"shape":"String",
2495-
"documentation":"<p>The procedure step name that a job was restarted from.</p>"
2514+
"documentation":"<p>The procedure step name that a batch job was restarted from.</p>"
24962515
},
24972516
"fromStep":{
24982517
"shape":"String",
2499-
"documentation":"<p>The step name that a batch job restart was from.</p>"
2518+
"documentation":"<p>The step name that a batch job was restarted from.</p>"
25002519
},
25012520
"toProcStep":{
25022521
"shape":"String",
25032522
"documentation":"<p>The procedure step name that a batch job was restarted to.</p>"
25042523
},
25052524
"toStep":{
25062525
"shape":"String",
2507-
"documentation":"<p>The step name that a job was restarted to.</p>"
2526+
"documentation":"<p>The step name that a batch job was restarted to.</p>"
25082527
}
25092528
},
2510-
"documentation":"<p>Provides restart step information for the most recent restart operation.</p>"
2529+
"documentation":"<p>Provides step/procedure step information for a restart batch job operation.</p>"
25112530
},
25122531
"ListApplicationVersionsRequest":{
25132532
"type":"structure",
@@ -2715,9 +2734,15 @@
27152734
"location":"uri",
27162735
"locationName":"applicationId"
27172736
},
2737+
"authSecretsManagerArn":{
2738+
"shape":"AuthSecretsManagerArn",
2739+
"documentation":"<p>The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for List Batch Job Restart Points operation.</p>",
2740+
"location":"querystring",
2741+
"locationName":"authSecretsManagerArn"
2742+
},
27182743
"executionId":{
27192744
"shape":"Identifier",
2720-
"documentation":"<p>The unique identifier of each batch job execution.</p>",
2745+
"documentation":"<p>The unique identifier of the batch job execution.</p>",
27212746
"location":"uri",
27222747
"locationName":"executionId"
27232748
}
@@ -3177,14 +3202,14 @@
31773202
"members":{
31783203
"executionId":{
31793204
"shape":"Identifier",
3180-
"documentation":"<p>The executionId from the StartBatchJob response when the job ran for the first time.</p>"
3205+
"documentation":"<p>The <code>executionId</code> from the <code>StartBatchJob</code> response when the job ran for the first time.</p>"
31813206
},
31823207
"jobStepRestartMarker":{
31833208
"shape":"JobStepRestartMarker",
3184-
"documentation":"<p>The restart step information for the most recent restart operation.</p>"
3209+
"documentation":"<p>The step/procedure step information for a restart batch job operation.</p>"
31853210
}
31863211
},
3187-
"documentation":"<p>An identifier for the StartBatchJob API to show that it is a restart operation.</p>"
3212+
"documentation":"<p>An identifier for the <code>StartBatchJob</code> API to show that it is a restart operation.</p>"
31883213
},
31893214
"S3BatchJobIdentifier":{
31903215
"type":"structure",
@@ -3301,6 +3326,10 @@
33013326
"location":"uri",
33023327
"locationName":"applicationId"
33033328
},
3329+
"authSecretsManagerArn":{
3330+
"shape":"AuthSecretsManagerArn",
3331+
"documentation":"<p>The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.</p>"
3332+
},
33043333
"batchJobIdentifier":{
33053334
"shape":"BatchJobIdentifier",
33063335
"documentation":"<p>The unique identifier of the batch job.</p>"

0 commit comments

Comments
 (0)