Skip to content
v2.273.0

Timeout Class ​

Timeout for a task or heartbeat.

Example ​

ts
new tasks.GlueStartJobRun(this, 'Task', {
  glueJobName: 'my-glue-job',
  arguments: sfn.TaskInput.fromObject({
    key: 'value',
  }),
  taskTimeout: sfn.Timeout.duration(Duration.minutes(30)),
  notifyDelayAfter: Duration.minutes(5),
});

Initializer ​

ts
new Timeout()
python
Timeout()
java
new Timeout()
csharp
new Timeout()
go
NewTimeout()

Properties ​

jsonataExpressionstringjsonata_expressionstrjsonataExpressionStringJsonataExpressionstringJsonataExpression*string#
JSONata expression for this timeout.
pathstringpathstrpathStringPathstringPath*string#
Path for this timeout.
secondsnumbersecondsint | floatsecondsNumberSecondsdoubleSeconds*float64#
Seconds for this timeout.

Methods ​

at(path: string): Timeout // chainable@staticmethod def at(path: str) -> Timeoutpublic static Timeout at(String path)public static Timeout At(string path)func At(Path *string) Timeoutstatic#
Use a dynamic timeout specified by a path in the state input.

The path must select a field whose value is a positive integer.

duration(duration: Duration): Timeout // chainable@staticmethod def duration(duration: Duration) -> Timeoutpublic static Timeout duration(Duration duration)public static Timeout Duration(Duration duration)func Duration(Duration Duration) Timeoutstatic#
Use a duration as timeout.
jsonata(jsonataExpression: string): Timeout // chainable@staticmethod def jsonata(jsonata_expression: str) -> Timeoutpublic static Timeout jsonata(String jsonataExpression)public static Timeout Jsonata(string jsonataExpression)func Jsonata(JsonataExpression *string) Timeoutstatic#
Use a dynamic timeout specified by a JSONata expression.

The JSONata expression value must be a positive integer.