You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lambda::Types::InvocationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing InvocationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  function_name: "NamespacedFunctionName", # required
  invocation_type: "Event", # accepts Event, RequestResponse, DryRun
  log_type: "None", # accepts None, Tail
  client_context: "String",
  payload: "data",
  qualifier: "Qualifier",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_contextString

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

Returns:

  • (String)

    Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

#function_nameString

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

Name formats .title

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

  • (String)

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

#invocation_typeString

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.

    Possible values:

    • Event
    • RequestResponse
    • DryRun

Returns:

  • (String)

    Choose from the following options.

#log_typeString

Set to Tail to include the execution log in the response.

Possible values:

  • None
  • Tail

Returns:

  • (String)

    Set to Tail to include the execution log in the response.

#payloadString

The JSON that you want to provide to your Lambda function as input.

Returns:

  • (String)

    The JSON that you want to provide to your Lambda function as input.

#qualifierString

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

Returns:

  • (String)

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