public static interface InvokeRequest.Builder extends LambdaRequest.Builder, SdkPojo, CopyableBuilder<InvokeRequest.Builder,InvokeRequest>
Modifier and Type | Method and Description |
---|---|
InvokeRequest.Builder |
clientContext(String clientContext)
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context
object.
|
InvokeRequest.Builder |
functionName(String functionName)
The name of the Lambda function, version, or alias.
|
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)
Set to
Tail to include the execution log in the response. |
InvokeRequest.Builder |
logType(String logType)
Set to
Tail to include the execution log in the response. |
InvokeRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
InvokeRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
InvokeRequest.Builder |
payload(SdkBytes payload)
The 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.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
InvokeRequest.Builder functionName(String functionName)
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. 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, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. 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. The API response includes the function response and additional
data.
Event
- Invoke the function asynchronously. Send events that fail multiple times to the
function's dead-letter queue (if it's configured). The API response only includes a status code.
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. The API response includes the function response
and additional data.
Event
- Invoke the function asynchronously. Send events that fail multiple times to the
function's dead-letter queue (if it's configured). The API response only includes a status code.
DryRun
- Validate parameter values and verify that the user or role has permission to
invoke the function.
InvocationType
,
InvocationType
InvokeRequest.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. The API response includes the function response and additional
data.
Event
- Invoke the function asynchronously. Send events that fail multiple times to the
function's dead-letter queue (if it's configured). The API response only includes a status code.
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. The API response includes the function response
and additional data.
Event
- Invoke the function asynchronously. Send events that fail multiple times to the
function's dead-letter queue (if it's configured). The API response only includes a status code.
DryRun
- Validate parameter values and verify that the user or role has permission to
invoke the function.
InvocationType
,
InvocationType
InvokeRequest.Builder logType(String logType)
Set to Tail
to include the execution log in the response.
InvokeRequest.Builder logType(LogType logType)
Set to Tail
to include the execution log in the response.
InvokeRequest.Builder clientContext(String clientContext)
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
clientContext
- Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the
context object.InvokeRequest.Builder payload(SdkBytes payload)
The JSON that you want to provide to your Lambda function as input.
payload
- The 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)
overrideConfiguration
in interface AwsRequest.Builder
InvokeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2021. All rights reserved.