public static interface InvokeRequest.Builder extends LambdaRequest.Builder, SdkPojo, CopyableBuilder<InvokeRequest.Builder,InvokeRequest>
| Modifier and Type | Method and Description |
|---|---|
InvokeRequest.Builder |
clientContext(String clientContext)
Using the
ClientContext you can pass client-specific information to the Lambda function you are
invoking. |
InvokeRequest.Builder |
functionName(String functionName)
The name of the Lambda function.
|
InvokeRequest.Builder |
invocationType(InvocationType invocationType)
Choose from the following options.
|
InvokeRequest.Builder |
invocationType(String invocationType)
Choose from the following options.
|
InvokeRequest.Builder |
logType(LogType logType)
You can set this optional parameter to
Tail in the request only if you specify the
InvocationType parameter with value RequestResponse. |
InvokeRequest.Builder |
logType(String logType)
You can set this optional parameter to
Tail in the request only if you specify the
InvocationType parameter with value RequestResponse. |
InvokeRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
InvokeRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
InvokeRequest.Builder |
payload(SdkBytes payload)
JSON that you want to provide to your Lambda function as input.
|
InvokeRequest.Builder |
qualifier(String qualifier)
Specify a version or alias to invoke a published version of the function.
|
buildoverrideConfigurationcopyapplyMutation, buildInvokeRequest.Builder functionName(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.
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.
InvokeRequest.Builder invocationType(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.
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.
InvocationType,
InvocationTypeInvokeRequest.Builder invocationType(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.
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.
InvocationType,
InvocationTypeInvokeRequest.Builder logType(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.
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.LogType,
LogTypeInvokeRequest.Builder logType(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.
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.LogType,
LogTypeInvokeRequest.Builder clientContext(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.
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.
InvokeRequest.Builder payload(SdkBytes payload)
JSON that you want to provide to your Lambda function as input.
payload - JSON that you want to provide to your Lambda function as input.InvokeRequest.Builder qualifier(String qualifier)
Specify a version or alias to invoke a published version of the function.
qualifier - Specify a version or alias to invoke a published version of the function.InvokeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.InvokeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.