InvokeWithResponseStreamRequest
¶
Source code in docs_src/capo_lambda/types/invoke_with_response_stream_request.py
client_context
instance-attribute
¶
client_context: NotRequired[String]
Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
function_name
instance-attribute
¶
function_name: NamespacedFunctionName
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.
invocation_type
instance-attribute
¶
invocation_type: NotRequired[ResponseStreamingInvocationType]
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.
log_type
instance-attribute
¶
log_type: NotRequired[LogType]
Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
payload
instance-attribute
¶
payload: NotRequired[Blob]
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.
qualifier
instance-attribute
¶
qualifier: NotRequired[NumericLatestPublishedOrAliasQualifier]
The alias name.