public static interface InvokeRequest.Builder extends LambdaRequest.Builder, 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 Lambda function name.
|
InvokeRequest.Builder |
invocationType(InvocationType invocationType)
By default, the
Invoke API assumes RequestResponse invocation type. |
InvokeRequest.Builder |
invocationType(String invocationType)
By default, the
Invoke API assumes RequestResponse invocation type. |
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 |
payload(ByteBuffer payload)
JSON that you want to provide to your Lambda function as input.
|
InvokeRequest.Builder |
payload(String payload) |
InvokeRequest.Builder |
qualifier(String qualifier)
You can use this optional parameter to specify a Lambda function version or alias name.
|
InvokeRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
InvokeRequest.Builder functionName(String functionName)
The Lambda function name.
You can specify a 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 a partial ARN (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
characters in length.
functionName
- The Lambda function name.
You can specify a 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 a partial ARN (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
characters in length.
InvokeRequest.Builder invocationType(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.
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.InvocationType
,
InvocationType
InvokeRequest.Builder invocationType(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.
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.InvocationType
,
InvocationType
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
. 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
,
LogType
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
. 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
,
LogType
InvokeRequest.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
- 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.
InvokeRequest.Builder payload(ByteBuffer payload)
JSON that you want to provide to your Lambda function as input.
To preserve immutability, the remaining bytes in the provided buffer will be copied into a new buffer when set.
payload
- JSON that you want to provide to your Lambda function as input.InvokeRequest.Builder payload(String payload)
InvokeRequest.Builder qualifier(String qualifier)
You can use this optional parameter to specify a Lambda function version or alias name. If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function. If you specify an 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.
qualifier
- You can use this optional parameter to specify a Lambda function version or alias name. If you specify
a function version, the API uses the qualified function ARN to invoke a specific Lambda function. If
you specify an 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.
InvokeRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.