You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Lambda::Types::InvocationResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb

Overview

Upon success, returns an empty response. Otherwise, throws an exception.

Instance Attribute Summary collapse

Instance Attribute Details

#function_errorString

Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled or Unhandled. Handled errors are errors that are reported by the function while the Unhandled errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled error, see Programming Model.

Returns:

  • (String)


1317
1318
1319
1320
1321
1322
1323
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1317

class InvocationResponse < Struct.new(
  :status_code,
  :function_error,
  :log_result,
  :payload)
  include Aws::Structure
end

#log_resultString

It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is RequestResponse and the logs were requested.

Returns:

  • (String)


1317
1318
1319
1320
1321
1322
1323
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1317

class InvocationResponse < Struct.new(
  :status_code,
  :function_error,
  :log_result,
  :payload)
  include Aws::Structure
end

#payloadString

It is the JSON representation of the object returned by the Lambda function. This is present only if the invocation type is RequestResponse.

In the event of a function error this field contains a message describing the error. For the Handled errors the Lambda function will report this message. For Unhandled errors AWS Lambda reports the message.

Returns:

  • (String)


1317
1318
1319
1320
1321
1322
1323
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1317

class InvocationResponse < Struct.new(
  :status_code,
  :function_error,
  :log_result,
  :payload)
  include Aws::Structure
end

#status_codeInteger

The HTTP status code will be in the 200 range for successful request. For the RequestResponse invocation type this status code will be 200. For the Event invocation type this status code will be 202. For the DryRun invocation type the status code will be 204.

Returns:

  • (Integer)


1317
1318
1319
1320
1321
1322
1323
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1317

class InvocationResponse < Struct.new(
  :status_code,
  :function_error,
  :log_result,
  :payload)
  include Aws::Structure
end