|
409 | 409 | {"shape":"ResourceNotFoundException"}, |
410 | 410 | {"shape":"InternalServerException"} |
411 | 411 | ], |
412 | | - "documentation":"<p>Executes a command in a runtime session container. Returns streaming output with contentStart, contentDelta, and contentStop events.</p>" |
| 412 | + "documentation":"<p>Executes a command in a runtime session container and streams the output back to the caller. This operation allows you to run shell commands within the agent runtime environment and receive real-time streaming responses including standard output and standard error.</p> <p>To invoke a command, you must specify the agent runtime ARN and a runtime session ID. The command execution supports streaming responses, allowing you to receive output as it becomes available through <code>contentStart</code>, <code>contentDelta</code>, and <code>contentStop</code> events.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:InvokeAgentRuntimeCommand</code> permission.</p>" |
413 | 413 | }, |
414 | 414 | "InvokeCodeInterpreter":{ |
415 | 415 | "name":"InvokeCodeInterpreter", |
|
1399 | 1399 | "members":{ |
1400 | 1400 | "stdout":{ |
1401 | 1401 | "shape":"String", |
1402 | | - "documentation":"<p>Standard output content</p>" |
| 1402 | + "documentation":"<p>The standard output content from the command execution. This field contains the incremental output written to stdout by the executing command.</p>" |
1403 | 1403 | }, |
1404 | 1404 | "stderr":{ |
1405 | 1405 | "shape":"String", |
1406 | | - "documentation":"<p>Standard error content</p>" |
| 1406 | + "documentation":"<p>The standard error content from the command execution. This field contains the incremental output written to stderr by the executing command.</p>" |
1407 | 1407 | } |
1408 | 1408 | }, |
1409 | | - "documentation":"<p>Content event containing stdout or stderr output</p>" |
| 1409 | + "documentation":"<p>An event that contains incremental output from a command execution. This event streams standard output and standard error content as it becomes available during command execution.</p>" |
1410 | 1410 | }, |
1411 | 1411 | "ContentStartEvent":{ |
1412 | 1412 | "type":"structure", |
1413 | 1413 | "members":{}, |
1414 | | - "documentation":"<p>First event indicating command execution has started</p>" |
| 1414 | + "documentation":"<p>An event that signals the start of content streaming from a command execution. This event is sent when the command begins producing output.</p>" |
1415 | 1415 | }, |
1416 | 1416 | "ContentStopEvent":{ |
1417 | 1417 | "type":"structure", |
|
1422 | 1422 | "members":{ |
1423 | 1423 | "exitCode":{ |
1424 | 1424 | "shape":"Integer", |
1425 | | - "documentation":"<p>Exit code: 0 = success, -1 = platform error, >0 = command error</p>" |
| 1425 | + "documentation":"<p>The exit code returned by the executed command. An exit code of 0 indicates successful execution, -1 indicates a platform error, and values greater than 0 indicate command-specific errors.</p>" |
1426 | 1426 | }, |
1427 | 1427 | "status":{ |
1428 | 1428 | "shape":"CommandExecutionStatus", |
1429 | | - "documentation":"<p>Execution status</p>" |
| 1429 | + "documentation":"<p>The final status of the command execution. Valid values are <code>COMPLETED</code> for successful completion or <code>TIMED_OUT</code> if the command exceeded the specified timeout.</p>" |
1430 | 1430 | } |
1431 | 1431 | }, |
1432 | | - "documentation":"<p>Final event indicating command execution has completed</p>" |
| 1432 | + "documentation":"<p>An event that signals the completion of a command execution. This event contains the final status and exit code of the executed command.</p>" |
1433 | 1433 | }, |
1434 | 1434 | "ContentTextString":{ |
1435 | 1435 | "type":"string", |
|
1679 | 1679 | "evaluationTarget":{ |
1680 | 1680 | "shape":"EvaluationTarget", |
1681 | 1681 | "documentation":"<p> The specific trace or span IDs to evaluate within the provided input. Allows targeting evaluation at different levels: individual tool calls, single request-response interactions (traces), or entire conversation sessions. </p>" |
| 1682 | + }, |
| 1683 | + "evaluationReferenceInputs":{ |
| 1684 | + "shape":"EvaluationReferenceInputs", |
| 1685 | + "documentation":"<p> Ground truth data to compare against agent responses during evaluation. Allows to provide expected responses, assertions, and expected tool trajectories at different evaluation levels. Session-level reference inputs apply to the entire conversation, while trace-level reference inputs target specific request-response interactions identified by trace ID. </p>" |
1682 | 1686 | } |
1683 | 1687 | } |
1684 | 1688 | }, |
|
1692 | 1696 | } |
1693 | 1697 | } |
1694 | 1698 | }, |
| 1699 | + "EvaluationContent":{ |
| 1700 | + "type":"structure", |
| 1701 | + "members":{ |
| 1702 | + "text":{ |
| 1703 | + "shape":"EvaluationContentTextString", |
| 1704 | + "documentation":"<p> The text content of the ground truth data. Used for expected response text and assertion statements. </p>" |
| 1705 | + } |
| 1706 | + }, |
| 1707 | + "documentation":"<p> A content block for ground truth data in evaluation reference inputs. Supports text content for expected responses and assertions. </p>", |
| 1708 | + "union":true |
| 1709 | + }, |
| 1710 | + "EvaluationContentList":{ |
| 1711 | + "type":"list", |
| 1712 | + "member":{"shape":"EvaluationContent"}, |
| 1713 | + "max":100, |
| 1714 | + "min":1 |
| 1715 | + }, |
| 1716 | + "EvaluationContentTextString":{ |
| 1717 | + "type":"string", |
| 1718 | + "max":100000, |
| 1719 | + "min":1 |
| 1720 | + }, |
1695 | 1721 | "EvaluationErrorCode":{ |
1696 | 1722 | "type":"string", |
1697 | 1723 | "max":1024, |
|
1702 | 1728 | "max":2048, |
1703 | 1729 | "min":0 |
1704 | 1730 | }, |
| 1731 | + "EvaluationExpectedTrajectory":{ |
| 1732 | + "type":"structure", |
| 1733 | + "members":{ |
| 1734 | + "toolNames":{ |
| 1735 | + "shape":"EvaluationToolNames", |
| 1736 | + "documentation":"<p> The list of tool names representing the expected tool call sequence. </p>" |
| 1737 | + } |
| 1738 | + }, |
| 1739 | + "documentation":"<p> The expected tool call trajectory for trajectory-based evaluation. </p>" |
| 1740 | + }, |
1705 | 1741 | "EvaluationExplanation":{ |
1706 | 1742 | "type":"string", |
1707 | 1743 | "max":2048, |
|
1719 | 1755 | "documentation":"<p> The input data structure containing agent session spans in OpenTelemetry format. Supports traces from frameworks like Strands (AgentCore Runtime) and LangGraph with OpenInference instrumentation for comprehensive evaluation. </p>", |
1720 | 1756 | "union":true |
1721 | 1757 | }, |
| 1758 | + "EvaluationReferenceInput":{ |
| 1759 | + "type":"structure", |
| 1760 | + "required":["context"], |
| 1761 | + "members":{ |
| 1762 | + "context":{"shape":"Context"}, |
| 1763 | + "expectedResponse":{ |
| 1764 | + "shape":"EvaluationContent", |
| 1765 | + "documentation":"<p> The expected response for trace-level evaluation. Built-in evaluators that support this field compare the agent's actual response against this value for assessment. Custom evaluators can access it through the <code>{expected_response}</code> placeholder in their instructions. </p>" |
| 1766 | + }, |
| 1767 | + "assertions":{ |
| 1768 | + "shape":"EvaluationContentList", |
| 1769 | + "documentation":"<p> A list of assertion statements for session-level evaluation. Each assertion describes an expected behavior or outcome the agent should demonstrate during the session. </p>" |
| 1770 | + }, |
| 1771 | + "expectedTrajectory":{ |
| 1772 | + "shape":"EvaluationExpectedTrajectory", |
| 1773 | + "documentation":"<p> The expected tool call sequence for session-level trajectory evaluation. Contains a list of tool names representing the tools the agent is expected to invoke. </p>" |
| 1774 | + } |
| 1775 | + }, |
| 1776 | + "documentation":"<p> A reference input containing ground truth data for evaluation, scoped to a specific context level (session or trace) through its span context. </p>" |
| 1777 | + }, |
| 1778 | + "EvaluationReferenceInputs":{ |
| 1779 | + "type":"list", |
| 1780 | + "member":{"shape":"EvaluationReferenceInput"}, |
| 1781 | + "max":1000, |
| 1782 | + "min":1, |
| 1783 | + "sensitive":true |
| 1784 | + }, |
1722 | 1785 | "EvaluationResultContent":{ |
1723 | 1786 | "type":"structure", |
1724 | 1787 | "required":[ |
|
1767 | 1830 | "errorCode":{ |
1768 | 1831 | "shape":"EvaluationErrorCode", |
1769 | 1832 | "documentation":"<p> The error code indicating the type of failure that occurred during evaluation. Used to programmatically identify and handle different categories of evaluation errors. </p>" |
| 1833 | + }, |
| 1834 | + "ignoredReferenceInputFields":{ |
| 1835 | + "shape":"IgnoredReferenceInputFields", |
| 1836 | + "documentation":"<p> The list of reference input field names that were provided but not used by the evaluator. Helps identify which ground truth data was not consumed during evaluation. </p>" |
1770 | 1837 | } |
1771 | 1838 | }, |
1772 | 1839 | "documentation":"<p> The comprehensive result of an evaluation containing the score, explanation, evaluator metadata, and execution details. Provides both quantitative ratings and qualitative insights about agent performance. </p>" |
|
1790 | 1857 | "documentation":"<p> The specification of which trace or span IDs to evaluate within the provided input data. Allows precise targeting of evaluation at different levels: tool calls, traces, or sessions. </p>", |
1791 | 1858 | "union":true |
1792 | 1859 | }, |
| 1860 | + "EvaluationToolName":{ |
| 1861 | + "type":"string", |
| 1862 | + "max":500, |
| 1863 | + "min":1 |
| 1864 | + }, |
| 1865 | + "EvaluationToolNames":{ |
| 1866 | + "type":"list", |
| 1867 | + "member":{"shape":"EvaluationToolName"}, |
| 1868 | + "max":1000, |
| 1869 | + "min":0 |
| 1870 | + }, |
1793 | 1871 | "EvaluatorArn":{ |
1794 | 1872 | "type":"string", |
1795 | 1873 | "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$|^arn:aws:bedrock-agentcore:::evaluator/Builtin.[a-zA-Z0-9_-]+" |
|
2469 | 2547 | "type":"integer", |
2470 | 2548 | "box":true |
2471 | 2549 | }, |
| 2550 | + "IgnoredReferenceInputField":{ |
| 2551 | + "type":"string", |
| 2552 | + "max":1000, |
| 2553 | + "min":1 |
| 2554 | + }, |
| 2555 | + "IgnoredReferenceInputFields":{ |
| 2556 | + "type":"list", |
| 2557 | + "member":{"shape":"IgnoredReferenceInputField"}, |
| 2558 | + "max":100, |
| 2559 | + "min":0 |
| 2560 | + }, |
2472 | 2561 | "InputContentBlock":{ |
2473 | 2562 | "type":"structure", |
2474 | 2563 | "required":["path"], |
|
2540 | 2629 | }, |
2541 | 2630 | "runtimeSessionId":{ |
2542 | 2631 | "shape":"SessionType", |
2543 | | - "documentation":"<p>Runtime session identifier</p>", |
| 2632 | + "documentation":"<p>The unique identifier of the runtime session in which to execute the command. This session ID is used to maintain state and context across multiple command invocations.</p>", |
2544 | 2633 | "idempotencyToken":true, |
2545 | 2634 | "location":"header", |
2546 | 2635 | "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" |
|
2571 | 2660 | }, |
2572 | 2661 | "agentRuntimeArn":{ |
2573 | 2662 | "shape":"String", |
2574 | | - "documentation":"<p>ARN of the agent runtime</p>", |
| 2663 | + "documentation":"<p>The Amazon Resource Name (ARN) of the agent runtime on which to execute the command. This identifies the specific agent runtime environment where the command will run.</p>", |
2575 | 2664 | "location":"uri", |
2576 | 2665 | "locationName":"agentRuntimeArn" |
2577 | 2666 | }, |
2578 | 2667 | "qualifier":{ |
2579 | 2668 | "shape":"String", |
2580 | | - "documentation":"<p>Version or alias qualifier</p>", |
| 2669 | + "documentation":"<p>The qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.</p>", |
2581 | 2670 | "location":"querystring", |
2582 | 2671 | "locationName":"qualifier" |
2583 | 2672 | }, |
2584 | 2673 | "accountId":{ |
2585 | 2674 | "shape":"InvokeAgentRuntimeCommandRequestAccountIdString", |
2586 | | - "documentation":"<p>Account ID (12 digits)</p>", |
| 2675 | + "documentation":"<p>The identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for <code>agentRuntimeArn</code>.</p>", |
2587 | 2676 | "location":"querystring", |
2588 | 2677 | "locationName":"accountId" |
2589 | 2678 | }, |
2590 | 2679 | "body":{ |
2591 | 2680 | "shape":"InvokeAgentRuntimeCommandRequestBody", |
2592 | | - "documentation":"<p>Request body containing command and timeout</p>" |
| 2681 | + "documentation":"<p>The request body containing the command to execute and optional configuration parameters such as timeout settings.</p>" |
2593 | 2682 | } |
2594 | 2683 | }, |
2595 | | - "documentation":"<p>Request for InvokeAgentRuntimeCommand operation</p>", |
| 2684 | + "documentation":"<p>Request for InvokeAgentRuntimeCommand operation.</p>", |
2596 | 2685 | "payload":"body" |
2597 | 2686 | }, |
2598 | 2687 | "InvokeAgentRuntimeCommandRequestAccountIdString":{ |
|
2610 | 2699 | "members":{ |
2611 | 2700 | "command":{ |
2612 | 2701 | "shape":"InvokeAgentRuntimeCommandRequestBodyCommandString", |
2613 | | - "documentation":"<p>The command to execute in the runtime container</p>" |
| 2702 | + "documentation":"<p>The shell command to execute on the agent runtime. This command is executed in the runtime environment and its output is streamed back to the caller.</p>" |
2614 | 2703 | }, |
2615 | 2704 | "timeout":{ |
2616 | 2705 | "shape":"Integer", |
2617 | | - "documentation":"<p>Command timeout in seconds (default: 300, min:1, max: 3600)</p>" |
| 2706 | + "documentation":"<p>The maximum duration in seconds to wait for the command to complete. If the command execution exceeds this timeout, it will be terminated. Default is 300 seconds. Minimum is 1 second. Maximum is 3600 seconds.</p>" |
2618 | 2707 | } |
2619 | 2708 | }, |
2620 | | - "documentation":"<p>Request body for InvokeAgentRuntimeCommand</p>" |
| 2709 | + "documentation":"<p>The request body structure for the <code>InvokeAgentRuntimeCommand</code> operation, containing the command to execute and optional configuration parameters.</p>" |
2621 | 2710 | }, |
2622 | 2711 | "InvokeAgentRuntimeCommandRequestBodyCommandString":{ |
2623 | 2712 | "type":"string", |
|
2648 | 2737 | "members":{ |
2649 | 2738 | "runtimeSessionId":{ |
2650 | 2739 | "shape":"SessionId", |
2651 | | - "documentation":"<p>Runtime session identifier</p>", |
| 2740 | + "documentation":"<p>The unique identifier of the runtime session in which the command was executed.</p>", |
2652 | 2741 | "location":"header", |
2653 | 2742 | "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" |
2654 | 2743 | }, |
|
2689 | 2778 | }, |
2690 | 2779 | "stream":{ |
2691 | 2780 | "shape":"InvokeAgentRuntimeCommandStreamOutput", |
2692 | | - "documentation":"<p>Streaming output containing command execution events</p>" |
| 2781 | + "documentation":"<p>The streaming output from the command execution. This stream contains events that provide real-time updates including standard output, standard error, and completion status.</p>" |
2693 | 2782 | } |
2694 | 2783 | }, |
2695 | | - "documentation":"<p>Response for InvokeAgentRuntimeCommand operation</p>", |
| 2784 | + "documentation":"<p>Response for InvokeAgentRuntimeCommand operation.</p>", |
2696 | 2785 | "payload":"stream" |
2697 | 2786 | }, |
2698 | 2787 | "InvokeAgentRuntimeCommandStreamOutput":{ |
2699 | 2788 | "type":"structure", |
2700 | 2789 | "members":{ |
2701 | 2790 | "chunk":{ |
2702 | 2791 | "shape":"ResponseChunk", |
2703 | | - "documentation":"<p>Response chunk containing command execution events</p>" |
| 2792 | + "documentation":"<p>A response chunk containing command execution events such as content start, content delta, or content stop events.</p>" |
2704 | 2793 | }, |
2705 | 2794 | "accessDeniedException":{ |
2706 | 2795 | "shape":"AccessDeniedException", |
2707 | | - "documentation":"<p>Exception events for error streaming</p>" |
| 2796 | + "documentation":"<p>Exception events for error streaming.</p>" |
2708 | 2797 | }, |
2709 | 2798 | "internalServerException":{"shape":"InternalServerException"}, |
2710 | 2799 | "resourceNotFoundException":{"shape":"ResourceNotFoundException"}, |
|
2713 | 2802 | "validationException":{"shape":"ValidationException"}, |
2714 | 2803 | "runtimeClientError":{"shape":"RuntimeClientError"} |
2715 | 2804 | }, |
2716 | | - "documentation":"<p>Streaming output for InvokeAgentRuntimeCommand operation Delivers typed events: contentStart (first), contentDelta (middle), contentStop (last)</p>", |
| 2805 | + "documentation":"<p>The streaming output union for the <code>InvokeAgentRuntimeCommand</code> operation. This union delivers typed events: <code>contentStart</code> (first), <code>contentDelta</code> (middle), and <code>contentStop</code> (last).</p>", |
2717 | 2806 | "eventstream":true |
2718 | 2807 | }, |
2719 | 2808 | "InvokeAgentRuntimeRequest":{ |
|
3841 | 3930 | "members":{ |
3842 | 3931 | "contentStart":{ |
3843 | 3932 | "shape":"ContentStartEvent", |
3844 | | - "documentation":"<p>First chunk - indicates command execution has started</p>" |
| 3933 | + "documentation":"<p>An event indicating the start of content streaming from the command execution. This is the first chunk received.</p>" |
3845 | 3934 | }, |
3846 | 3935 | "contentDelta":{ |
3847 | 3936 | "shape":"ContentDeltaEvent", |
3848 | | - "documentation":"<p>Middle chunks - stdout/stderr output</p>" |
| 3937 | + "documentation":"<p>An event containing incremental output (stdout or stderr) from the command execution. These are the middle chunks.</p>" |
3849 | 3938 | }, |
3850 | 3939 | "contentStop":{ |
3851 | 3940 | "shape":"ContentStopEvent", |
3852 | | - "documentation":"<p>Last chunk - indicates command execution has completed</p>" |
| 3941 | + "documentation":"<p>An event indicating the completion of the command execution, including the exit code and final status. This is the last chunk received.</p>" |
3853 | 3942 | } |
3854 | 3943 | }, |
3855 | | - "documentation":"<p>Response chunk containing exactly one of: contentStart, contentDelta, or contentStop</p>", |
| 3944 | + "documentation":"<p>A structure representing a response chunk that contains exactly one of the possible event types: <code>contentStart</code>, <code>contentDelta</code>, or <code>contentStop</code>.</p>", |
3856 | 3945 | "event":true |
3857 | 3946 | }, |
3858 | 3947 | "ResponseStream":{ |
|
0 commit comments