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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_context ⇒ String

Using the ‘ClientContext` you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a `ClientContext` JSON, see

PutEvents][1

in the *Amazon Mobile Analytics API Reference and

User Guide*.

The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.

[1]: docs.aws.amazon.com/mobileanalytics/latest/ug/PutEvents.html

Returns:

  • (String) 


1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/aws-sdk-lambda/types.rb', line 1401

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

#function_name ⇒ String

The Lambda function name.

You can specify a function name (for example, ‘Thumbnail`) or you can specify Amazon Resource Name (ARN) of the function (for example, `arn:aws:lambda:us-west-2:account-id:function:ThumbNail`). AWS Lambda also allows you to specify a partial ARN (for example, `account-id:Thumbnail`). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

  • (String) 


1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/aws-sdk-lambda/types.rb', line 1401

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

#invocation_type ⇒ String

By default, the ‘Invoke` API assumes `RequestResponse` invocation type. You can optionally request asynchronous execution by specifying `Event` as the `InvocationType`. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying `DryRun` as the `InvocationType`. This is useful in a cross-account scenario when you want to verify access to a function without running it.

Returns:

  • (String) 


1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/aws-sdk-lambda/types.rb', line 1401

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

#log_type ⇒ String

You can set this optional parameter to ‘Tail` in the request only if you specify the `InvocationType` parameter with value `RequestResponse`. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the `x-amz-log-result` header.

Returns:

  • (String) 


1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/aws-sdk-lambda/types.rb', line 1401

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

#payload ⇒ String

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

Returns:

  • (String) 


1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/aws-sdk-lambda/types.rb', line 1401

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

#qualifier ⇒ String

You can use this optional parameter to specify a Lambda function version or alias name. If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don’t provide this parameter, then the API uses unqualified function ARN which results in invocation of the ‘$LATEST` version.

Returns:

  • (String) 


1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/aws-sdk-lambda/types.rb', line 1401

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