ApiResult ¶

class ApiResult(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 for the API operation.</p>"""
    api_path: NotRequired["capo_bedrock_agent_runtime.types.api_path.ApiPath"]
    """<p>The path to the API operation.</p>"""
    confirmation_state: NotRequired[
        "capo_bedrock_agent_runtime.types.confirmation_state.ConfirmationState"
    ]
    """<p>Controls the API operations or functions to invoke based on the user confirmation.</p>"""
    response_state: NotRequired[
        "capo_bedrock_agent_runtime.types.response_state.ResponseState"
    ]
    """<p>Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt</p>"""
    http_status_code: NotRequired["int"]
    """<p>http status code from API execution response (for example: 200, 400, 500).</p>"""
    response_body: NotRequired[
        "capo_bedrock_agent_runtime.types.response_body.ResponseBody"
    ]
    """<p>The response body from the API operation. The key of the object is the content type (currently, only <code>TEXT</code> is supported). The response may be returned directly or from the Lambda function.</p>"""
    agent_id: NotRequired["str"]
    """<p>The agent's ID.</p>"""