class Amazonite::Lambda::InvocationRequest

Included Modules

Defined in:

lambda/invocation_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(function_name : String, invocation_type : InvocationType | Nil = nil, log_type : LogType | Nil = nil, client_context : String | Nil = nil, durable_execution_name : String | Nil = nil, payload : String | Nil = nil, qualifier : String | Nil = nil, tenant_id : String | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def client_context : String | Nil #

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.


[View source]
def client_context=(client_context : String | Nil) #

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.


[View source]
def durable_execution_name : String | Nil #

A unique name for the durable execution. If you invoke a durable function using a name that already exists with the same payload, Lambda returns the existing execution instead of creating a duplicate. If the payload differs, Lambda returns a DurableExecutionAlreadyStartedException error.

If not specified, Lambda generates a unique identifier automatically. For more information, see Execution names.


[View source]
def durable_execution_name=(durable_execution_name : String | Nil) #

A unique name for the durable execution. If you invoke a durable function using a name that already exists with the same payload, Lambda returns the existing execution instead of creating a duplicate. If the payload differs, Lambda returns a DurableExecutionAlreadyStartedException error.

If not specified, Lambda generates a unique identifier automatically. For more information, see Execution names.


[View source]
def function_name : String #

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.


[View source]
def function_name=(function_name : String) #

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.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def invocation_type : InvocationType | Nil #

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.


[View source]
def invocation_type=(invocation_type : InvocationType | Nil) #

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.


[View source]
def log_type : LogType | Nil #

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


[View source]
def log_type=(log_type : LogType | Nil) #

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


[View source]
def payload : String | Nil #

The JSON that you want to provide to your Lambda function as input. The maximum payload size is 6 MB for synchronous invocations and 1 MB for asynchronous invocations.

You can enter the JSON directly. For example, --payload '{ "key": "value" }'. You can also specify a file path. For example, --payload file://payload.json.


[View source]
def payload=(payload : String | Nil) #

The JSON that you want to provide to your Lambda function as input. The maximum payload size is 6 MB for synchronous invocations and 1 MB for asynchronous invocations.

You can enter the JSON directly. For example, --payload '{ "key": "value" }'. You can also specify a file path. For example, --payload file://payload.json.


[View source]
def qualifier : String | Nil #

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


[View source]
def qualifier=(qualifier : String | Nil) #

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


[View source]
def tenant_id : String | Nil #

The identifier of the tenant in a multi-tenant Lambda function.


[View source]
def tenant_id=(tenant_id : String | Nil) #

The identifier of the tenant in a multi-tenant Lambda function.


[View source]
def validate! : Nil #

[View source]