Package software.amazon.awssdk.services.lambda.model

Class InvokeResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.lambda.model.InvokeResponse

All Implemented Interfaces:

ToCopyableBuilder<InvokeResponse.Builder,InvokeResponse>

@Generated("software.amazon.awssdk:codegen")
public class InvokeResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<InvokeResponse.Builder,InvokeResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InvokeResponse.Builder

Method Summary

Modifier and Type	Method	Description
static InvokeResponse.Builder	builder()
boolean	equals(Object obj)
String	functionError()	Indicates whether an error occurred while executing the Lambda function.
int	hashCode()
String	logResult()	It is the base64-encoded logs for the Lambda function invocation.
ByteBuffer	payload()	It is the JSON representation of the object returned by the Lambda function.
static Class<? extends InvokeResponse.Builder>	serializableBuilderClass()
Integer	statusCode()	The HTTP status code will be in the 200 range for successful request.
InvokeResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

statusCode

public Integer statusCode()

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:

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.

functionError

public String functionError()

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:

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.

logResult

public String logResult()

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:

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.

payload

public ByteBuffer payload()

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.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer . Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

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.

toBuilder

public InvokeResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<InvokeResponse.Builder,InvokeResponse>

Returns:

a builder for type T

builder

public static InvokeResponse.Builder builder()

serializableBuilderClass

public static Class<? extends InvokeResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object