Skip to content

Commit 296a002

Browse files
author
awstools
committedJan 22, 2025
docs(client-glue): Docs Update for timeout changes
1 parent 8d5c63a commit 296a002

File tree

4 files changed

+30
-16
lines changed

4 files changed

+30
-16
lines changed
 

‎clients/client-glue/src/models/models_0.ts

+6-2
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,11 @@ export interface Action {
6565

6666
/**
6767
* <p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can
68-
* consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default
69-
* is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.</p>
68+
* consume resources before it is terminated and enters <code>TIMEOUT</code> status. This overrides the timeout value set in the parent job.</p>
69+
* <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>
70+
* <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>
71+
* <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>
72+
* <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>
7073
* @public
7174
*/
7275
Timeout?: number | undefined;
@@ -8789,6 +8792,7 @@ export interface JobRun {
87898792
* <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>
87908793
* <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>
87918794
* <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>
8795+
* <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>
87928796
* @public
87938797
*/
87948798
Timeout?: number | undefined;

‎clients/client-glue/src/models/models_1.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3708,7 +3708,7 @@ export interface CreateSessionRequest {
37083708
/**
37093709
* <p>
37103710
* The number of minutes before session times out. Default for Spark ETL
3711-
* jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type.
3711+
* jobs is 48 hours (2880 minutes).
37123712
* Consult the documentation for other job types.
37133713
* </p>
37143714
* @public

‎clients/client-glue/src/models/models_3.ts

+16-6
Original file line numberDiff line numberDiff line change
@@ -708,6 +708,7 @@ export interface StartJobRunRequest {
708708
* <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>
709709
* <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>
710710
* <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>
711+
* <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>
711712
* @public
712713
*/
713714
Timeout?: number | undefined;
@@ -3906,8 +3907,11 @@ export interface CreateJobRequest {
39063907
/**
39073908
* <p>The job timeout in minutes. This is the maximum time that a job run
39083909
* can consume resources before it is terminated and enters <code>TIMEOUT</code>
3909-
* status. The default is 2,880 minutes (48 hours) for batch jobs.</p>
3910-
* <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>
3910+
* status.</p>
3911+
* <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>
3912+
* <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>
3913+
* <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>
3914+
* <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>
39113915
* @public
39123916
*/
39133917
Timeout?: number | undefined;
@@ -4189,8 +4193,11 @@ export interface Job {
41894193
/**
41904194
* <p>The job timeout in minutes. This is the maximum time that a job run
41914195
* can consume resources before it is terminated and enters <code>TIMEOUT</code>
4192-
* status. The default is 2,880 minutes (48 hours) for batch jobs.</p>
4193-
* <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>
4196+
* status.</p>
4197+
* <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>
4198+
* <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>
4199+
* <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>
4200+
* <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>
41944201
* @public
41954202
*/
41964203
Timeout?: number | undefined;
@@ -4436,8 +4443,11 @@ export interface JobUpdate {
44364443
/**
44374444
* <p>The job timeout in minutes. This is the maximum time that a job run
44384445
* can consume resources before it is terminated and enters <code>TIMEOUT</code>
4439-
* status. The default is 2,880 minutes (48 hours) for batch jobs.</p>
4440-
* <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>
4446+
* status.</p>
4447+
* <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>
4448+
* <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>
4449+
* <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>
4450+
* <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>
44414451
* @public
44424452
*/
44434453
Timeout?: number | undefined;

‎codegen/sdk-codegen/aws-models/glue.json

+7-7
Original file line numberDiff line numberDiff line change
@@ -1838,7 +1838,7 @@
18381838
"Timeout": {
18391839
"target": "com.amazonaws.glue#Timeout",
18401840
"traits": {
1841-
"smithy.api#documentation": "<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default\n is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.</p>"
1841+
"smithy.api#documentation": "<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters <code>TIMEOUT</code> status. This overrides the timeout value set in the parent job.</p>\n <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>\n <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>\n <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>\n <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
18421842
}
18431843
},
18441844
"SecurityConfiguration": {
@@ -10707,7 +10707,7 @@
1070710707
"Timeout": {
1070810708
"target": "com.amazonaws.glue#Timeout",
1070910709
"traits": {
10710-
"smithy.api#documentation": "<p>The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters <code>TIMEOUT</code>\n status. The default is 2,880 minutes (48 hours) for batch jobs.</p>\n <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
10710+
"smithy.api#documentation": "<p>The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters <code>TIMEOUT</code>\n status.</p>\n <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>\n <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>\n <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>\n <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
1071110711
}
1071210712
},
1071310713
"MaxCapacity": {
@@ -11591,7 +11591,7 @@
1159111591
"Timeout": {
1159211592
"target": "com.amazonaws.glue#Timeout",
1159311593
"traits": {
11594-
"smithy.api#documentation": "<p>\n The number of minutes before session times out. Default for Spark ETL\n jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type.\n Consult the documentation for other job types.\n </p>"
11594+
"smithy.api#documentation": "<p>\n The number of minutes before session times out. Default for Spark ETL\n jobs is 48 hours (2880 minutes).\n Consult the documentation for other job types.\n </p>"
1159511595
}
1159611596
},
1159711597
"IdleTimeout": {
@@ -27064,7 +27064,7 @@
2706427064
"Timeout": {
2706527065
"target": "com.amazonaws.glue#Timeout",
2706627066
"traits": {
27067-
"smithy.api#documentation": "<p>The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters <code>TIMEOUT</code>\n status. The default is 2,880 minutes (48 hours) for batch jobs.</p>\n <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
27067+
"smithy.api#documentation": "<p>The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters <code>TIMEOUT</code>\n status.</p>\n <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>\n <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>\n <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>\n <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
2706827068
}
2706927069
},
2707027070
"MaxCapacity": {
@@ -27420,7 +27420,7 @@
2742027420
"Timeout": {
2742127421
"target": "com.amazonaws.glue#Timeout",
2742227422
"traits": {
27423-
"smithy.api#documentation": "<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job.</p>\n <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>\n <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>\n <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>"
27423+
"smithy.api#documentation": "<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job.</p>\n <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>\n <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>\n <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>\n <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
2742427424
}
2742527425
},
2742627426
"MaxCapacity": {
@@ -27654,7 +27654,7 @@
2765427654
"Timeout": {
2765527655
"target": "com.amazonaws.glue#Timeout",
2765627656
"traits": {
27657-
"smithy.api#documentation": "<p>The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters <code>TIMEOUT</code>\n status. The default is 2,880 minutes (48 hours) for batch jobs.</p>\n <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
27657+
"smithy.api#documentation": "<p>The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters <code>TIMEOUT</code>\n status.</p>\n <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>\n <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>\n <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>\n <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
2765827658
}
2765927659
},
2766027660
"MaxCapacity": {
@@ -38519,7 +38519,7 @@
3851938519
"Timeout": {
3852038520
"target": "com.amazonaws.glue#Timeout",
3852138521
"traits": {
38522-
"smithy.api#documentation": "<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job. </p>\n <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>\n <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>\n <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>"
38522+
"smithy.api#documentation": "<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job. </p>\n <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p>\n <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p>\n <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>\n <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
3852338523
}
3852438524
},
3852538525
"MaxCapacity": {

0 commit comments

Comments
 (0)
Please sign in to comment.