Class: Aws::Lambda::Types::GetDurableExecutionResponse

Inherits:

Struct

• Object
• Struct
• Aws::Lambda::Types::GetDurableExecutionResponse

Defined in:

gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:input_payload, :result]

Instance Attribute Summary

• #durable_config ⇒ Types::DurableConfig

  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_name ⇒ String

  The name of the durable execution.

• #end_timestamp ⇒ Time

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

• #error ⇒ Types::ErrorObject

  Error information if the durable execution failed.

• #execution_data_included ⇒ Boolean

  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.

• #input_payload ⇒ String

  The JSON input payload that was provided when the durable execution was started.

• #result ⇒ String

  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.

• #status ⇒ String

  The current status of the durable execution.

• #trace_header ⇒ Types::TraceHeader

  The trace headers associated with the durable execution.

• #version ⇒ String

  The version of the Lambda function that was invoked for this durable execution.

Instance Attribute Details

#durable_config ⇒ Types::DurableConfig

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.

Returns:

• (Types::DurableConfig)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#durable_execution_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#end_timestamp ⇒ Time

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).

Returns:

• (Time)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#error ⇒ Types::ErrorObject

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.

Returns:

• (Types::ErrorObject)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#execution_data_included ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#function_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#input_payload ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#result ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#start_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#trace_header ⇒ Types::TraceHeader

The trace headers associated with the durable execution.

Returns:

• (Types::TraceHeader)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end

#version ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 4538

class GetDurableExecutionResponse < Struct.new(
  :durable_execution_arn,
  :durable_execution_name,
  :function_arn,
  :input_payload,
  :result,
  :error,
  :start_timestamp,
  :status,
  :end_timestamp,
  :version,
  :trace_header,
  :execution_data_included,
  :durable_config)
  SENSITIVE = [:input_payload, :result]
  include Aws::Structure
end