Class InvokeRequest

    • Method Detail

      • functionName

        public final String functionName()

        The name or ARN of the Lambda function, version, or alias.

        Name formats

        • Function namemy-function (name-only), my-function:v1 (with alias).

        • Function ARNarn:aws:lambda:us-west-2:123456789012:function:my-function.

        • Partial ARN123456789012: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:
        The name or ARN of the Lambda function, version, or alias.

        Name formats

        • Function namemy-function (name-only), my-function:v1 (with alias).

        • Function ARNarn:aws:lambda:us-west-2:123456789012:function:my-function.

        • Partial ARN123456789012: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.

      • invocationType

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, invocationType will return InvocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invocationTypeAsString().

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

        See Also:
        InvocationType
      • invocationTypeAsString

        public final String invocationTypeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, invocationType will return InvocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invocationTypeAsString().

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

        See Also:
        InvocationType
      • logType

        public final LogType logType()

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

        If the service returns an enum value that is not available in the current SDK version, logType will return LogType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logTypeAsString().

        Returns:
        Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
        See Also:
        LogType
      • logTypeAsString

        public final String logTypeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, logType will return LogType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logTypeAsString().

        Returns:
        Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
        See Also:
        LogType
      • clientContext

        public final 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 ClientContext object to your function for synchronous invocations only.

        Returns:
        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 ClientContext object to your function for synchronous invocations only.
      • payload

        public final 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.

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

      • qualifier

        public final String qualifier()

        Specify a version or alias to invoke a published version of the function.

        Returns:
        Specify a version or alias to invoke a published version of the function.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object