Skip to content

InvokeWithResponseStreamRequest

Source code in docs_src/capo_lambda/types/invoke_with_response_stream_request.py
class InvokeWithResponseStreamRequest(TypedDict, closed=True):
    function_name: "capo_lambda.types.namespaced_function_name.NamespacedFunctionName"
    """<p>The name or ARN of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code>.</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>"""
    log_type: NotRequired["capo_lambda.types.log_type.LogType"]
    """<p>Set to <code>Tail</code> to include the execution log in the response. Applies to synchronously invoked functions only.</p>"""
    client_context: NotRequired["capo_lambda.types.string.String"]
    """<p>Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.</p>"""
    qualifier: NotRequired[
        "capo_lambda.types.numeric_latest_published_or_alias_qualifier.NumericLatestPublishedOrAliasQualifier"
    ]
    """<p>The alias name.</p>"""
    payload: NotRequired["capo_lambda.types.blob.Blob"]
    """<p>The JSON that you want to provide to your Lambda function as input.</p> <p>You can enter the JSON directly. For example, <code>--payload '{ "key": "value" }'</code>. You can also specify a file path. For example, <code>--payload file://payload.json</code>.</p>"""
    tenant_id: NotRequired["capo_lambda.types.tenant_id.TenantId"]
    """<p>The identifier of the tenant in a multi-tenant Lambda function.</p>"""
    invocation_type: NotRequired[
        "capo_lambda.types.response_streaming_invocation_type.ResponseStreamingInvocationType"
    ]
    """<p>Use one of the following options:</p> <ul> <li> <p> <code>RequestResponse</code> (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.</p> </li> <li> <p> <code>DryRun</code> – Validate parameter values and verify that the IAM user or role has permission to invoke the function.</p> </li> </ul>"""

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

The alias name.

tenant_id instance-attribute

tenant_id: NotRequired[TenantId]

The identifier of the tenant in a multi-tenant Lambda function.