com.amazonaws.services.lambda.model

Class InvokeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lambda.model.InvokeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InvokeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
InvokeRequest()

Method Summary

Modifier and Type	Method and Description
InvokeRequest	clone()
boolean	equals(Object obj)
String	getClientContext() Using the ClientContext you can pass client-specific information to the Lambda function you are invoking.
String	getFunctionName() The name of the Lambda function.
String	getInvocationType() Choose from the following options.
String	getLogType() You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse.
ByteBuffer	getPayload() JSON that you want to provide to your Lambda function as input.
String	getQualifier() Specify a version or alias to invoke a published version of the function.
int	hashCode()
void	setClientContext(String clientContext) Using the ClientContext you can pass client-specific information to the Lambda function you are invoking.
void	setFunctionName(String functionName) The name of the Lambda function.
void	setInvocationType(InvocationType invocationType) Choose from the following options.
void	setInvocationType(String invocationType) Choose from the following options.
void	setLogType(LogType logType) You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse.
void	setLogType(String logType) You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse.
void	setPayload(ByteBuffer payload) JSON that you want to provide to your Lambda function as input.
void	setPayload(String payload) JSON that you want to provide to your Lambda function as input.
void	setQualifier(String qualifier) Specify a version or alias to invoke a published version of the function.
String	toString() Returns a string representation of this object.
InvokeRequest	withClientContext(String clientContext) Using the ClientContext you can pass client-specific information to the Lambda function you are invoking.
InvokeRequest	withFunctionName(String functionName) The name of the Lambda function.
InvokeRequest	withInvocationType(InvocationType invocationType) Choose from the following options.
InvokeRequest	withInvocationType(String invocationType) Choose from the following options.
InvokeRequest	withLogType(LogType logType) You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse.
InvokeRequest	withLogType(String logType) You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse.
InvokeRequest	withPayload(ByteBuffer payload) JSON that you want to provide to your Lambda function as input.
InvokeRequest	withPayload(String payload) JSON that you want to provide to your Lambda function as input.
InvokeRequest	withQualifier(String qualifier) Specify a version or alias to invoke a published version of the function.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InvokeRequest

public InvokeRequest()

Method Detail

setFunctionName

public void setFunctionName(String functionName)

The name of the Lambda function.

Name formats

• Function name - MyFunction.

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

• Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Parameters:

functionName - The name of the Lambda function.

Name formats

• Function name - MyFunction.

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

• Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

getFunctionName

public String getFunctionName()

The name of the Lambda function.

Name formats

• Function name - MyFunction.

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

• Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

The name of the Lambda function.

Name formats

• Function name - MyFunction.

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

• Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

withFunctionName

public InvokeRequest withFunctionName(String functionName)

The name of the Lambda function.

Name formats

• Function name - MyFunction.

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

• Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Parameters:

functionName - The name of the Lambda function.

Name formats

• Function name - MyFunction.

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

• Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInvocationType

public void setInvocationType(String invocationType)

Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

Parameters:

invocationType - Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

See Also:

InvocationType

getInvocationType

public String getInvocationType()

Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

Returns:

Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

See Also:

InvocationType

withInvocationType

public InvokeRequest withInvocationType(String invocationType)

Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

Parameters:

invocationType - Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InvocationType

setInvocationType

public void setInvocationType(InvocationType invocationType)

Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

Parameters:

invocationType - Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

See Also:

InvocationType

withInvocationType

public InvokeRequest withInvocationType(InvocationType invocationType)

Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

Parameters:

invocationType - Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InvocationType

setLogType

public void setLogType(String logType)

You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

Parameters:

logType - You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

See Also:

LogType

getLogType

public String getLogType()

You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

Returns:

You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

See Also:

LogType

withLogType

public InvokeRequest withLogType(String logType)

You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

Parameters:

logType - You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LogType

setLogType

public void setLogType(LogType logType)

You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

Parameters:

logType - You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

See Also:

LogType

withLogType

public InvokeRequest withLogType(LogType logType)

You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

Parameters:

logType - You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LogType

setClientContext

public void setClientContext(String clientContext)

Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.

ClientContext information is returned only if you use the synchronous (RequestResponse) invocation type.

Parameters:

clientContext - Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.

ClientContext information is returned only if you use the synchronous ( RequestResponse) invocation type.

getClientContext

public String getClientContext()

Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.

ClientContext information is returned only if you use the synchronous (RequestResponse) invocation type.

Returns:

Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.

ClientContext information is returned only if you use the synchronous ( RequestResponse) invocation type.

withClientContext

public InvokeRequest withClientContext(String clientContext)

Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.

ClientContext information is returned only if you use the synchronous (RequestResponse) invocation type.

Parameters:

clientContext - Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.

ClientContext information is returned only if you use the synchronous ( RequestResponse) invocation type.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPayload

public void setPayload(ByteBuffer payload)

JSON that you want to provide to your Lambda function as input.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

payload - JSON that you want to provide to your Lambda function as input.

getPayload

public ByteBuffer getPayload()

JSON that you want to provide to your Lambda function as input.

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:

JSON that you want to provide to your Lambda function as input.

withPayload

public InvokeRequest withPayload(ByteBuffer payload)

JSON that you want to provide to your Lambda function as input.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

payload - JSON that you want to provide to your Lambda function as input.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPayload

public void setPayload(String payload)

JSON that you want to provide to your Lambda function as input.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

payload - JSON that you want to provide to your Lambda function as input.

withPayload

public InvokeRequest withPayload(String payload)

JSON that you want to provide to your Lambda function as input.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

payload - JSON that you want to provide to your Lambda function as input.

Returns:

Returns a reference to this object so that method calls can be chained together.

setQualifier

public void setQualifier(String qualifier)

Specify a version or alias to invoke a published version of the function.

Parameters:

qualifier - Specify a version or alias to invoke a published version of the function.

getQualifier

public String getQualifier()

Specify a version or alias to invoke a published version of the function.

Returns:

Specify a version or alias to invoke a published version of the function.

withQualifier

public InvokeRequest withQualifier(String qualifier)

Specify a version or alias to invoke a published version of the function.

Parameters:

qualifier - Specify a version or alias to invoke a published version of the function.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public InvokeRequest clone()

Overrides:

clone in class AmazonWebServiceRequest