com.amazonaws.services.lambda.model

Class InvokeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lambda.model.InvokeRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class InvokeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the Invoke operation.

Invokes a specific Lambda function version.

If you don't provide the Qualifier parameter, it uses the unqualified function ARN which results in invocation of the $LATEST version of the Lambda function (when you create a Lambda function, the $LATEST is the version). The AWS Lambda versioning and aliases feature allows you to publish multiple versions of a Lambda function and also create aliases for each function version. So each your Lambda function version can be invoked using multiple ARNs. For more information, see AWS Lambda Function Versioning and Aliases . Using the Qualifier parameter, you can specify a function version or alias name to invoke specific function version. If you specify function version, the API uses the qualified function ARN to invoke a specific function version. If you specify alias name, the API uses the alias ARN to invoke the function version to which the alias points.

This operation requires permission for the lambda:InvokeFunction action.

See Also:

AWSLambda.invoke(InvokeRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
InvokeRequest()

Method Summary

Methods

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 Lambda function name.
String	getInvocationType() By default, the Invoke API assumes "RequestResponse" invocation type.
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() You can use this optional paramter to specify a Lambda function version or alias name.
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 Lambda function name.
void	setInvocationType(InvocationType invocationType) By default, the Invoke API assumes "RequestResponse" invocation type.
void	setInvocationType(String invocationType) By default, the Invoke API assumes "RequestResponse" invocation type.
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) You can use this optional paramter to specify a Lambda function version or alias name.
String	toString() Returns a string representation of this object; useful for testing and debugging.
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 Lambda function name.
InvokeRequest	withInvocationType(InvocationType invocationType) By default, the Invoke API assumes "RequestResponse" invocation type.
InvokeRequest	withInvocationType(String invocationType) By default, the Invoke API assumes "RequestResponse" invocation type.
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) You can use this optional paramter to specify a Lambda function version or alias name.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

InvokeRequest

public InvokeRequest()

Method Detail

getFunctionName

public String getFunctionName()

The Lambda function name.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

Returns:

The Lambda function name.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

setFunctionName

public void setFunctionName(String functionName)

The Lambda function name.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

Parameters:

functionName - The Lambda function name.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

withFunctionName

public InvokeRequest withFunctionName(String functionName)

The Lambda function name.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

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

Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

Parameters:

functionName - The Lambda function name.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

Returns:

A reference to this updated object so that method calls can be chained together.

getInvocationType

public String getInvocationType()

By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

Constraints:
Allowed Values: Event, RequestResponse, DryRun

Returns:

By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

See Also:

InvocationType

setInvocationType

public void setInvocationType(String invocationType)

By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

Constraints:
Allowed Values: Event, RequestResponse, DryRun

Parameters:

invocationType - By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

See Also:

InvocationType

withInvocationType

public InvokeRequest withInvocationType(String invocationType)

By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

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

Constraints:
Allowed Values: Event, RequestResponse, DryRun

Parameters:

invocationType - By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

InvocationType

setInvocationType

public void setInvocationType(InvocationType invocationType)

By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

Constraints:
Allowed Values: Event, RequestResponse, DryRun

Parameters:

invocationType - By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

See Also:

InvocationType

withInvocationType

public InvokeRequest withInvocationType(InvocationType invocationType)

By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

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

Constraints:
Allowed Values: Event, RequestResponse, DryRun

Parameters:

invocationType - By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

InvocationType

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-results header.

Constraints:
Allowed Values: None, Tail

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-results header.

See Also:

LogType

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-results header.

Constraints:
Allowed Values: None, Tail

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-results 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-results header.

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

Constraints:
Allowed Values: None, Tail

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-results header.

Returns:

A reference to this updated 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-results header.

Constraints:
Allowed Values: None, Tail

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-results 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-results header.

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

Constraints:
Allowed Values: None, Tail

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-results header.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LogType

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, go to PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded.

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, go to PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded.

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, go to PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded.

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, go to PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded.

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, go to PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded.

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

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, go to PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded.

Returns:

A reference to this updated object so that method calls can be chained together.

getPayload

public ByteBuffer getPayload()

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

Returns:

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

setPayload

public void setPayload(ByteBuffer payload)

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

Parameters:

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

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

Parameters:

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

Returns:

A reference to this updated 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.

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.

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getQualifier

public String getQualifier()

You can use this optional paramter to specify a Lambda function version or alias name. If you specify function version, the API uses qualified function ARN to invoke a specific Lambda function. If you specify alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.

Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)

Returns:

You can use this optional paramter to specify a Lambda function version or alias name. If you specify function version, the API uses qualified function ARN to invoke a specific Lambda function. If you specify alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.

setQualifier

public void setQualifier(String qualifier)

You can use this optional paramter to specify a Lambda function version or alias name. If you specify function version, the API uses qualified function ARN to invoke a specific Lambda function. If you specify alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.

Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)

Parameters:

qualifier - You can use this optional paramter to specify a Lambda function version or alias name. If you specify function version, the API uses qualified function ARN to invoke a specific Lambda function. If you specify alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.

withQualifier

public InvokeRequest withQualifier(String qualifier)

You can use this optional paramter to specify a Lambda function version or alias name. If you specify function version, the API uses qualified function ARN to invoke a specific Lambda function. If you specify alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.

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

Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)

Parameters:

qualifier - You can use this optional paramter to specify a Lambda function version or alias name. If you specify function version, the API uses qualified function ARN to invoke a specific Lambda function. If you specify alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public InvokeRequest clone()

Overrides:

clone in class AmazonWebServiceRequest