Skip to content

UpdateAgentActionGroupRequest

Source code in docs_src/capo_bedrock_agent/types/update_agent_action_group_request.py
class UpdateAgentActionGroupRequest(TypedDict, closed=True):
    agent_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the agent for which to update the action group.</p>"""
    agent_version: "capo_bedrock_agent.types.draft_version.DraftVersion"
    """<p>The unique identifier of the agent version for which to update the action group.</p>"""
    action_group_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the action group.</p>"""
    action_group_name: "capo_bedrock_agent.types.name.Name"
    """<p>Specifies a new name for the action group.</p>"""
    description: NotRequired["capo_bedrock_agent.types.description.Description"]
    """<p>Specifies a new name for the action group.</p>"""
    parent_action_group_signature: NotRequired[
        "capo_bedrock_agent.types.action_group_signature.ActionGroupSignature"
    ]
    """<p>Update the built-in or computer use action for this action group. If you specify a value, you must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields empty for this action group. </p> <ul> <li> <p>To allow your agent to request the user for additional information when trying to complete a task, set this field to <code>AMAZON.UserInput</code>. </p> </li> <li> <p>To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to <code>AMAZON.CodeInterpreter</code>.</p> </li> <li> <p>To allow your agent to use an Anthropic computer use tool, specify one of the following values. </p> <important> <p> Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>. </p> </important> <ul> <li> <p> <code>ANTHROPIC.Computer</code> - Gives the agent permission to use the mouse and keyboard and take screenshots.</p> </li> <li> <p> <code>ANTHROPIC.TextEditor</code> - Gives the agent permission to view, create and edit files.</p> </li> <li> <p> <code>ANTHROPIC.Bash</code> - Gives the agent permission to run commands in a bash shell.</p> </li> </ul> </li> </ul> <p>During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information.</p>"""
    parent_action_group_signature_params: NotRequired[
        "capo_bedrock_agent.types.action_group_signature_params.ActionGroupSignatureParams"
    ]
    """<p>The configuration settings for a computer use action.</p> <important> <p> Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>. </p> </important>"""
    action_group_executor: NotRequired[
        "capo_bedrock_agent.types.action_group_executor.ActionGroupExecutor"
    ]
    """<p>The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.</p>"""
    action_group_state: NotRequired[
        "capo_bedrock_agent.types.action_group_state.ActionGroupState"
    ]
    """<p>Specifies whether the action group is available for the agent to invoke or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>"""
    api_schema: NotRequired["capo_bedrock_agent.types.api_schema.APISchema"]
    """<p>Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</p>"""
    function_schema: NotRequired[
        "capo_bedrock_agent.types.function_schema.FunctionSchema"
    ]
    """<p>Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.</p>"""

action_group_executor instance-attribute

action_group_executor: NotRequired[ActionGroupExecutor]

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

action_group_id instance-attribute

action_group_id: Id

The unique identifier of the action group.

action_group_name instance-attribute

action_group_name: Name

Specifies a new name for the action group.

action_group_state instance-attribute

action_group_state: NotRequired[ActionGroupState]

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

agent_id instance-attribute

agent_id: Id

The unique identifier of the agent for which to update the action group.

agent_version instance-attribute

agent_version: DraftVersion

The unique identifier of the agent version for which to update the action group.

api_schema instance-attribute

api_schema: NotRequired[APISchema]

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

description instance-attribute

description: NotRequired[Description]

Specifies a new name for the action group.

function_schema instance-attribute

function_schema: NotRequired[FunctionSchema]

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

parent_action_group_signature instance-attribute

parent_action_group_signature: NotRequired[ActionGroupSignature]

Update the built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.

  • To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.

  • To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.

  • To allow your agent to use an Anthropic computer use tool, specify one of the following values.

    Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

    • ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.

    • ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.

    • ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.

During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

parent_action_group_signature_params instance-attribute

parent_action_group_signature_params: NotRequired[ActionGroupSignatureParams]

The configuration settings for a computer use action.

Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.