AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb

Overview

Note:

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",
}

Constant Summary collapse

SENSITIVE =
[:payload]

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)


2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2959

class InvocationRequest < Struct.new(
  :function_name,
  :invocation_type,
  :log_type,
  :client_context,
  :payload,
  :qualifier)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#function_nameString

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:

  • (String)


2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2959

class InvocationRequest < Struct.new(
  :function_name,
  :invocation_type,
  :log_type,
  :client_context,
  :payload,
  :qualifier)
  SENSITIVE = [:payload]
  include Aws::Structure
end

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

Returns:

  • (String)


2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2959

class InvocationRequest < Struct.new(
  :function_name,
  :invocation_type,
  :log_type,
  :client_context,
  :payload,
  :qualifier)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#log_typeString

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

Returns:

  • (String)


2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2959

class InvocationRequest < Struct.new(
  :function_name,
  :invocation_type,
  :log_type,
  :client_context,
  :payload,
  :qualifier)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#payloadString

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

Returns:

  • (String)


2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2959

class InvocationRequest < Struct.new(
  :function_name,
  :invocation_type,
  :log_type,
  :client_context,
  :payload,
  :qualifier)
  SENSITIVE = [:payload]
  include Aws::Structure
end

#qualifierString

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

Returns:

  • (String)


2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2959

class InvocationRequest < Struct.new(
  :function_name,
  :invocation_type,
  :log_type,
  :client_context,
  :payload,
  :qualifier)
  SENSITIVE = [:payload]
  include Aws::Structure
end