Class: Aws::Lambda::Types::InvocationRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Lambda::Types::InvocationRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-lambda/types.rb
Overview
When making an API call, you may pass InvocationRequest data as a 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
-
#client_context ⇒ String
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
-
#function_name ⇒ String
The name of the Lambda function, version, or alias.
-
#invocation_type ⇒ String
Choose from the following options.
-
#log_type ⇒ String
Set to ‘Tail` to include the execution log in the response.
-
#payload ⇒ String
The JSON that you want to provide to your Lambda function as input.
-
#qualifier ⇒ String
Specify a version or alias to invoke a published version of the function.
Instance Attribute Details
#client_context ⇒ String
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
1547 1548 1549 1550 1551 1552 1553 1554 1555 |
# File 'lib/aws-sdk-lambda/types.rb', line 1547 class InvocationRequest < Struct.new( :function_name, :invocation_type, :log_type, :client_context, :payload, :qualifier) include Aws::Structure end |
#function_name ⇒ String
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.
1547 1548 1549 1550 1551 1552 1553 1554 1555 |
# File 'lib/aws-sdk-lambda/types.rb', line 1547 class InvocationRequest < Struct.new( :function_name, :invocation_type, :log_type, :client_context, :payload, :qualifier) include Aws::Structure end |
#invocation_type ⇒ String
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.
1547 1548 1549 1550 1551 1552 1553 1554 1555 |
# File 'lib/aws-sdk-lambda/types.rb', line 1547 class InvocationRequest < Struct.new( :function_name, :invocation_type, :log_type, :client_context, :payload, :qualifier) include Aws::Structure end |
#log_type ⇒ String
Set to ‘Tail` to include the execution log in the response.
1547 1548 1549 1550 1551 1552 1553 1554 1555 |
# File 'lib/aws-sdk-lambda/types.rb', line 1547 class InvocationRequest < Struct.new( :function_name, :invocation_type, :log_type, :client_context, :payload, :qualifier) include Aws::Structure end |
#payload ⇒ String
The JSON that you want to provide to your Lambda function as input.
1547 1548 1549 1550 1551 1552 1553 1554 1555 |
# File 'lib/aws-sdk-lambda/types.rb', line 1547 class InvocationRequest < Struct.new( :function_name, :invocation_type, :log_type, :client_context, :payload, :qualifier) include Aws::Structure end |
#qualifier ⇒ String
Specify a version or alias to invoke a published version of the function.
1547 1548 1549 1550 1551 1552 1553 1554 1555 |
# File 'lib/aws-sdk-lambda/types.rb', line 1547 class InvocationRequest < Struct.new( :function_name, :invocation_type, :log_type, :client_context, :payload, :qualifier) include Aws::Structure end |