Interface InvokeRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<InvokeRequest.Builder,InvokeRequest>,LambdaRequest.Builder,SdkBuilder<InvokeRequest.Builder,InvokeRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- InvokeRequest
@Mutable @NotThreadSafe public static interface InvokeRequest.Builder extends LambdaRequest.Builder, SdkPojo, CopyableBuilder<InvokeRequest.Builder,InvokeRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InvokeRequest.BuilderclientContext(String clientContext)Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.InvokeRequest.BuilderfunctionName(String functionName)The name or ARN of the Lambda function, version, or alias.InvokeRequest.BuilderinvocationType(String invocationType)Choose from the following options.InvokeRequest.BuilderinvocationType(InvocationType invocationType)Choose from the following options.InvokeRequest.BuilderlogType(String logType)Set toTailto include the execution log in the response.InvokeRequest.BuilderlogType(LogType logType)Set toTailto include the execution log in the response.InvokeRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)InvokeRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)InvokeRequest.Builderpayload(SdkBytes payload)The JSON that you want to provide to your Lambda function as input.InvokeRequest.Builderqualifier(String qualifier)Specify a version or alias to invoke a published version of the function.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.lambda.model.LambdaRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
functionName
InvokeRequest.Builder functionName(String functionName)
The name or ARN 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.
- Parameters:
functionName- The name or ARN 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
invocationType
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 one is 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.
- 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. 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 one is 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InvocationType,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 one is 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.
- 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. 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 one is 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InvocationType,InvocationType
-
-
logType
InvokeRequest.Builder logType(String logType)
Set to
Tailto include the execution log in the response. Applies to synchronously invoked functions only.
-
logType
InvokeRequest.Builder logType(LogType logType)
Set to
Tailto include the execution log in the response. Applies to synchronously invoked functions only.
-
clientContext
InvokeRequest.Builder clientContext(String clientContext)
Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the
ClientContextobject to your function for synchronous invocations only.- Parameters:
clientContext- Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes theClientContextobject to your function for synchronous invocations only.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
payload
InvokeRequest.Builder payload(SdkBytes payload)
The JSON that you want to provide to your Lambda function as input.
You can enter the JSON directly. For example,
--payload '{ "key": "value" }'. You can also specify a file path. For example,--payload file://payload.json.- Parameters:
payload- The JSON that you want to provide to your Lambda function as input.You can enter the JSON directly. For example,
--payload '{ "key": "value" }'. You can also specify a file path. For example,--payload file://payload.json.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
qualifier
InvokeRequest.Builder qualifier(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.
-
overrideConfiguration
InvokeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
InvokeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-