class Amazonite::Lambda::GetDurableExecutionResponse

Amazonite::Lambda::GetDurableExecutionResponse
Reference
Object

Overview

The response from the GetDurableExecution operation, containing detailed information about the durable execution.

Included Modules

JSON::Serializable

Defined in:

lambda/get_durable_execution_response.cr

Constructors

.new(durable_execution_arn : String, durable_execution_name : String, function_arn : String, start_timestamp : Time, status : ExecutionStatus, input_payload : String | Nil = nil, result : String | Nil = nil, error : ErrorObject | Nil = nil, end_timestamp : Time | Nil = nil, version : String | Nil = nil, trace_header : TraceHeader | Nil = nil, execution_data_included : Bool | Nil = nil, durable_config : DurableConfig | Nil = nil)
.new(pull : JSON::PullParser)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

#==(other : self)
Returns true if this reference is the same as other.
#durable_config : DurableConfig | Nil
Configuration settings for the durable execution, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.
#durable_config=(durable_config : DurableConfig | Nil)
Configuration settings for the durable execution, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.
#durable_execution_arn : String
The Amazon Resource Name (ARN) of the durable execution.
#durable_execution_arn=(durable_execution_arn : String)
The Amazon Resource Name (ARN) of the durable execution.
#durable_execution_name : String
The name of the durable execution.
#durable_execution_name=(durable_execution_name : String)
The name of the durable execution.
#end_timestamp : Time | Nil
The date and time when the durable execution ended, in Unix timestamp format.
#end_timestamp=(end_timestamp : Time | Nil)
The date and time when the durable execution ended, in Unix timestamp format.
#error : ErrorObject | Nil
Error information if the durable execution failed.
#error=(error : ErrorObject | Nil)
Error information if the durable execution failed.
#execution_data_included : Bool | Nil
Indicates whether execution data is included in this response.
#execution_data_included=(execution_data_included : Bool | Nil)
Indicates whether execution data is included in this response.
#function_arn : String
The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.
#function_arn=(function_arn : String)
The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.
#hash(hasher)
See Object#hash(hasher)
#input_payload : String | Nil
The JSON input payload that was provided when the durable execution was started.
#input_payload=(input_payload : String | Nil)
The JSON input payload that was provided when the durable execution was started.
#result : String | Nil
The JSON result returned by the durable execution if it completed successfully.
#result=(result : String | Nil)
The JSON result returned by the durable execution if it completed successfully.
#start_timestamp : Time
The date and time when the durable execution started, in Unix timestamp format.
#start_timestamp=(start_timestamp : Time)
The date and time when the durable execution started, in Unix timestamp format.
#status : ExecutionStatus
The current status of the durable execution.
#status=(status : ExecutionStatus)
The current status of the durable execution.
#trace_header : TraceHeader | Nil
The trace headers associated with the durable execution.
#trace_header=(trace_header : TraceHeader | Nil)
The trace headers associated with the durable execution.
#validate! : Nil
#version : String | Nil
The version of the Lambda function that was invoked for this durable execution.
#version=(version : String | Nil)
The version of the Lambda function that was invoked for this durable execution.

Constructor Detail

def self.new(durable_execution_arn : String, durable_execution_name : String, function_arn : String, start_timestamp : Time, status : ExecutionStatus, input_payload : String | Nil = nil, result : String | Nil = nil, error : ErrorObject | Nil = nil, end_timestamp : Time | Nil = nil, version : String | Nil = nil, trace_header : TraceHeader | Nil = nil, execution_data_included : Bool | Nil = nil, durable_config : DurableConfig | Nil = nil) #

[View source]

def self.new(pull : JSON::PullParser) #

[View source]

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #

Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.

def durable_config : DurableConfig | Nil #

Configuration settings for the durable execution, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

[View source]

def durable_config=(durable_config : DurableConfig | Nil) #

[View source]

def durable_execution_arn : String #

The Amazon Resource Name (ARN) of the durable execution.

[View source]

def durable_execution_arn=(durable_execution_arn : String) #

The Amazon Resource Name (ARN) of the durable execution.

[View source]

def durable_execution_name : String #

The name of the durable execution. This is either the name you provided when invoking the function, or a system-generated unique identifier if no name was provided.

[View source]

def durable_execution_name=(durable_execution_name : String) #

The name of the durable execution. This is either the name you provided when invoking the function, or a system-generated unique identifier if no name was provided.

[View source]

def end_timestamp : Time | Nil #

The date and time when the durable execution ended, in Unix timestamp format. This field is only present if the execution has completed (status is SUCCEEDED, FAILED, TIMED_OUT, or STOPPED).

[View source]

def end_timestamp=(end_timestamp : Time | Nil) #

The date and time when the durable execution ended, in Unix timestamp format. This field is only present if the execution has completed (status is SUCCEEDED, FAILED, TIMED_OUT, or STOPPED).

[View source]

def error : ErrorObject | Nil #

Error information if the durable execution failed. This field is only present when the execution status is FAILED, TIMED_OUT, or STOPPED. The combined size of all error fields is limited to 256 KB.

[View source]

def error=(error : ErrorObject | Nil) #

[View source]

def execution_data_included : Bool | Nil #

Indicates whether execution data is included in this response. Returns false when IncludeExecutionData is set to false in the request.

[View source]

def execution_data_included=(execution_data_included : Bool | Nil) #

Indicates whether execution data is included in this response. Returns false when IncludeExecutionData is set to false in the request.

[View source]

def function_arn : String #

The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.

[View source]

def function_arn=(function_arn : String) #

The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.

[View source]

def hash(hasher) #

Description copied from class Reference

See Object#hash(hasher)

def input_payload : String | Nil #

The JSON input payload that was provided when the durable execution was started. For asynchronous invocations, this is limited to 256 KB. For synchronous invocations, this can be up to 6 MB.

[View source]

def input_payload=(input_payload : String | Nil) #

The JSON input payload that was provided when the durable execution was started. For asynchronous invocations, this is limited to 256 KB. For synchronous invocations, this can be up to 6 MB.

[View source]

def result : String | Nil #

The JSON result returned by the durable execution if it completed successfully. This field is only present when the execution status is SUCCEEDED. The result is limited to 256 KB.

[View source]

def result=(result : String | Nil) #

The JSON result returned by the durable execution if it completed successfully. This field is only present when the execution status is SUCCEEDED. The result is limited to 256 KB.

[View source]

def start_timestamp : Time #

The date and time when the durable execution started, in Unix timestamp format.

[View source]

def start_timestamp=(start_timestamp : Time) #

The date and time when the durable execution started, in Unix timestamp format.

[View source]

def status : ExecutionStatus #

The current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.

[View source]

def status=(status : ExecutionStatus) #

The current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.

[View source]

def trace_header : TraceHeader | Nil #

The trace headers associated with the durable execution.

[View source]

def trace_header=(trace_header : TraceHeader | Nil) #

The trace headers associated with the durable execution.

[View source]

def validate! : Nil #

[View source]

def version : String | Nil #

The version of the Lambda function that was invoked for this durable execution. This ensures that all replays during the execution use the same function version.

[View source]

def version=(version : String | Nil) #

The version of the Lambda function that was invoked for this durable execution. This ensures that all replays during the execution use the same function version.

[View source]