Skip to content

ActionGroupInvocationInput

Source code in docs_src/capo_bedrock_agent_runtime/types/action_group_invocation_input.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class ActionGroupInvocationInput(TypedDict, closed=True):
    action_group_name: NotRequired[
        "capo_bedrock_agent_runtime.types.action_group_name.ActionGroupName"
    ]
    """<p>The name of the action group.</p>"""
    verb: NotRequired["capo_bedrock_agent_runtime.types.verb.Verb"]
    """<p>The API method being used, based off the action group.</p>"""
    api_path: NotRequired["capo_bedrock_agent_runtime.types.api_path.ApiPath"]
    """<p>The path to the API to call, based off the action group.</p>"""
    parameters: NotRequired["capo_bedrock_agent_runtime.types.parameters.Parameters"]
    """<p>The parameters in the Lambda input event.</p>"""
    request_body: NotRequired[
        "capo_bedrock_agent_runtime.types.request_body.RequestBody"
    ]
    """<p>The parameters in the request body for the Lambda input event.</p>"""
    function: NotRequired["capo_bedrock_agent_runtime.types.function.Function"]
    """<p>The function in the action group to call.</p>"""
    execution_type: NotRequired[
        "capo_bedrock_agent_runtime.types.execution_type.ExecutionType"
    ]
    """<p>How fulfillment of the action is handled. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/action-handle.html">Handling fulfillment of the action</a>.</p>"""
    invocation_id: NotRequired["str"]
    """<p>The unique identifier of the invocation. Only returned if the <code>executionType</code> is <code>RETURN_CONTROL</code>.</p>"""

action_group_name instance-attribute 

action_group_name: NotRequired[ActionGroupName]

The name of the action group.

api_path instance-attribute 

api_path: NotRequired[ApiPath]

The path to the API to call, based off the action group.

execution_type instance-attribute 

execution_type: NotRequired[ExecutionType]

How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.

function instance-attribute 

function: NotRequired[Function]

The function in the action group to call.

invocation_id instance-attribute 

invocation_id: NotRequired[str]

The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.

parameters instance-attribute 

parameters: NotRequired[Parameters]

The parameters in the Lambda input event.

request_body instance-attribute 

request_body: NotRequired[RequestBody]

The parameters in the request body for the Lambda input event.

verb instance-attribute 

verb: NotRequired[Verb]

The API method being used, based off the action group.