Skip to content

Bedrock Agent Runtime  >  Structures  >  ApiInvocationInput

ApiInvocationInput

Structure Class

ApiInvocationInput dataclass

Contains information about the API operation that the agent predicts should be called.

This data type is used in the following API operations:

Attributes

action_group instance-attribute 
action_group: str

The action group that the API operation belongs to.

action_invocation_type class-attribute instance-attribute 
action_invocation_type: ActionInvocationType | None = None

Contains information about the API operation to invoke.

agent_id class-attribute instance-attribute 
agent_id: str | None = None

The agent's ID.

api_path class-attribute instance-attribute 
api_path: str | None = field(repr=False, default=None)

The path to the API operation.

collaborator_name class-attribute instance-attribute 
collaborator_name: str | None = field(repr=False, default=None)

The agent collaborator's name.

http_method class-attribute instance-attribute 
http_method: str | None = None

The HTTP method of the API operation.

parameters class-attribute instance-attribute 
parameters: list[ApiParameter] | None = None

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

request_body class-attribute instance-attribute 
request_body: ApiRequestBody | None = None

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