Class: Aws::Lambda::Types::InvokeWithResponseStreamRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[:payload]

Instance Attribute Summary collapse

Instance Attribute Details

#client_contextString

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

Returns:

  • (String)


3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
# File 'lib/aws-sdk-lambda/types.rb', line 3690

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

#function_nameString

The name or ARN of the Lambda function.

**Name formats**

  • **Function name** – ‘my-function`.

  • **Function ARN** – ‘arn:aws:lambda:us-west-2:123456789012:function:my-function`.

  • **Partial ARN** – ‘123456789012:function:my-function`.

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)


3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
# File 'lib/aws-sdk-lambda/types.rb', line 3690

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

#invocation_typeString

Use one of the following options:

  • ‘RequestResponse` (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.

  • ‘DryRun` – Validate parameter values and verify that the IAM user or role has permission to invoke the function.

Returns:

  • (String)


3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
# File 'lib/aws-sdk-lambda/types.rb', line 3690

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

#log_typeString

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

Returns:

  • (String)


3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
# File 'lib/aws-sdk-lambda/types.rb', line 3690

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

#payloadString

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

You can enter the JSON directly. For example, ‘–payload ’{ “key”: “value” }‘`. You can also specify a file path. For example, `–payload file://payload.json`.

Returns:

  • (String)


3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
# File 'lib/aws-sdk-lambda/types.rb', line 3690

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

#qualifierString

The alias name.

Returns:

  • (String)


3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
# File 'lib/aws-sdk-lambda/types.rb', line 3690

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