Skip to content

ApiInvocationInput

Source code in docs_src/capo_bedrock_agent_runtime/types/api_invocation_input.py
class ApiInvocationInput(TypedDict, closed=True):
    action_group: "str"
    """<p>The action group that the API operation belongs to.</p>"""
    http_method: NotRequired["str"]
    """<p>The HTTP method of the API operation.</p>"""
    api_path: NotRequired["capo_bedrock_agent_runtime.types.api_path.ApiPath"]
    """<p>The path to the API operation.</p>"""
    parameters: NotRequired[
        "capo_bedrock_agent_runtime.types.api_parameters.ApiParameters"
    ]
    """<p>The parameters to provide for the API request, as the agent elicited from the user.</p>"""
    request_body: NotRequired[
        "capo_bedrock_agent_runtime.types.api_request_body.ApiRequestBody"
    ]
    """<p>The request body to provide for the API request, as the agent elicited from the user.</p>"""
    action_invocation_type: NotRequired[
        "capo_bedrock_agent_runtime.types.action_invocation_type.ActionInvocationType"
    ]
    """<p>Contains information about the API operation to invoke.</p>"""
    agent_id: NotRequired["str"]
    """<p>The agent's ID.</p>"""
    collaborator_name: NotRequired["capo_bedrock_agent_runtime.types.name.Name"]
    """<p>The agent collaborator's name.</p>"""

action_group instance-attribute

action_group: str

The action group that the API operation belongs to.

action_invocation_type instance-attribute

action_invocation_type: NotRequired[ActionInvocationType]

Contains information about the API operation to invoke.

agent_id instance-attribute

agent_id: NotRequired[str]

The agent's ID.

api_path instance-attribute

api_path: NotRequired[ApiPath]

The path to the API operation.

collaborator_name instance-attribute

collaborator_name: NotRequired[Name]

The agent collaborator's name.

http_method instance-attribute

http_method: NotRequired[str]

The HTTP method of the API operation.

parameters instance-attribute

parameters: NotRequired[ApiParameters]

The parameters to provide for the API request, as the agent elicited from the user.

request_body instance-attribute

request_body: NotRequired[ApiRequestBody]

The request body to provide for the API request, as the agent elicited from the user.