Package software.amazon.awssdk.services.lambda.model

Interface InvokeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<InvokeRequest.Builder,InvokeRequest>, LambdaRequest.Builder, SdkBuilder<InvokeRequest.Builder,InvokeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
InvokeRequest
public static interface InvokeRequest.Builder extends LambdaRequest.Builder, SdkPojo, CopyableBuilder<InvokeRequest.Builder,InvokeRequest>

  • Method Details

    • functionName

      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.

      Parameters:
      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.

      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

      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:

    • logType

      InvokeRequest.Builder logType(String logType)

      Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

      Parameters:
      logType - Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logType

      InvokeRequest.Builder logType(LogType logType)

      Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

      Parameters:
      logType - Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

      Parameters:
      clientContext - Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
      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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      InvokeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.