aws-sdk-bedrockagentruntime 1.54.0 → 1.56.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagentruntime/client.rb +588 -1
- data/lib/aws-sdk-bedrockagentruntime/client_api.rb +341 -0
- data/lib/aws-sdk-bedrockagentruntime/types.rb +990 -10
- data/lib/aws-sdk-bedrockagentruntime.rb +1 -1
- data/sig/client.rbs +107 -0
- data/sig/types.rbs +261 -7
- metadata +1 -1
@@ -158,6 +158,10 @@ module Aws::BedrockAgentRuntime
|
|
158
158
|
# Contains the JSON-formatted string returned by the API invoked by the
|
159
159
|
# action group.
|
160
160
|
#
|
161
|
+
# @!attribute [rw] metadata
|
162
|
+
# Contains information about the action group output.
|
163
|
+
# @return [Types::Metadata]
|
164
|
+
#
|
161
165
|
# @!attribute [rw] text
|
162
166
|
# The JSON-formatted string returned by the API invoked by the action
|
163
167
|
# group.
|
@@ -166,8 +170,9 @@ module Aws::BedrockAgentRuntime
|
|
166
170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ActionGroupInvocationOutput AWS API Documentation
|
167
171
|
#
|
168
172
|
class ActionGroupInvocationOutput < Struct.new(
|
173
|
+
:metadata,
|
169
174
|
:text)
|
170
|
-
SENSITIVE = [:text]
|
175
|
+
SENSITIVE = [:metadata, :text]
|
171
176
|
include Aws::Structure
|
172
177
|
end
|
173
178
|
|
@@ -329,6 +334,10 @@ module Aws::BedrockAgentRuntime
|
|
329
334
|
# The output's agent collaborator name.
|
330
335
|
# @return [String]
|
331
336
|
#
|
337
|
+
# @!attribute [rw] metadata
|
338
|
+
# Contains information about the output from the agent collaborator.
|
339
|
+
# @return [Types::Metadata]
|
340
|
+
#
|
332
341
|
# @!attribute [rw] output
|
333
342
|
# The output's output.
|
334
343
|
# @return [Types::AgentCollaboratorOutputPayload]
|
@@ -338,8 +347,9 @@ module Aws::BedrockAgentRuntime
|
|
338
347
|
class AgentCollaboratorInvocationOutput < Struct.new(
|
339
348
|
:agent_collaborator_alias_arn,
|
340
349
|
:agent_collaborator_name,
|
350
|
+
:metadata,
|
341
351
|
:output)
|
342
|
-
SENSITIVE = []
|
352
|
+
SENSITIVE = [:metadata]
|
343
353
|
include Aws::Structure
|
344
354
|
end
|
345
355
|
|
@@ -868,14 +878,19 @@ module Aws::BedrockAgentRuntime
|
|
868
878
|
# Contains output files, if generated by code execution.
|
869
879
|
# @return [Array<String>]
|
870
880
|
#
|
881
|
+
# @!attribute [rw] metadata
|
882
|
+
# Contains information about the output from the code interpreter.
|
883
|
+
# @return [Types::Metadata]
|
884
|
+
#
|
871
885
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/CodeInterpreterInvocationOutput AWS API Documentation
|
872
886
|
#
|
873
887
|
class CodeInterpreterInvocationOutput < Struct.new(
|
874
888
|
:execution_error,
|
875
889
|
:execution_output,
|
876
890
|
:execution_timeout,
|
877
|
-
:files
|
878
|
-
|
891
|
+
:files,
|
892
|
+
:metadata)
|
893
|
+
SENSITIVE = [:metadata]
|
879
894
|
include Aws::Structure
|
880
895
|
end
|
881
896
|
|
@@ -990,6 +1005,37 @@ module Aws::BedrockAgentRuntime
|
|
990
1005
|
include Aws::Structure
|
991
1006
|
end
|
992
1007
|
|
1008
|
+
# Contains information about a condition evaluation result during an
|
1009
|
+
# async execution. This event is generated when a condition node in the
|
1010
|
+
# flow evaluates its conditions.
|
1011
|
+
#
|
1012
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
1013
|
+
# subject to change.
|
1014
|
+
#
|
1015
|
+
# </note>
|
1016
|
+
#
|
1017
|
+
# @!attribute [rw] node_name
|
1018
|
+
# The name of the condition node that evaluated the conditions.
|
1019
|
+
# @return [String]
|
1020
|
+
#
|
1021
|
+
# @!attribute [rw] satisfied_conditions
|
1022
|
+
# A list of conditions that were satisfied during the evaluation.
|
1023
|
+
# @return [Array<Types::SatisfiedCondition>]
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] timestamp
|
1026
|
+
# The timestamp when the condition evaluation occurred.
|
1027
|
+
# @return [Time]
|
1028
|
+
#
|
1029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ConditionResultEvent AWS API Documentation
|
1030
|
+
#
|
1031
|
+
class ConditionResultEvent < Struct.new(
|
1032
|
+
:node_name,
|
1033
|
+
:satisfied_conditions,
|
1034
|
+
:timestamp)
|
1035
|
+
SENSITIVE = [:satisfied_conditions]
|
1036
|
+
include Aws::Structure
|
1037
|
+
end
|
1038
|
+
|
993
1039
|
# There was a conflict performing an operation. Resolve the conflict and
|
994
1040
|
# retry your request.
|
995
1041
|
#
|
@@ -1435,10 +1481,18 @@ module Aws::BedrockAgentRuntime
|
|
1435
1481
|
|
1436
1482
|
# Contains information about the failure of the interaction.
|
1437
1483
|
#
|
1484
|
+
# @!attribute [rw] failure_code
|
1485
|
+
# The failure code for the trace.
|
1486
|
+
# @return [Integer]
|
1487
|
+
#
|
1438
1488
|
# @!attribute [rw] failure_reason
|
1439
1489
|
# The reason the interaction failed.
|
1440
1490
|
# @return [String]
|
1441
1491
|
#
|
1492
|
+
# @!attribute [rw] metadata
|
1493
|
+
# Information about the failure that occurred.
|
1494
|
+
# @return [Types::Metadata]
|
1495
|
+
#
|
1442
1496
|
# @!attribute [rw] trace_id
|
1443
1497
|
# The unique identifier of the trace.
|
1444
1498
|
# @return [String]
|
@@ -1446,9 +1500,11 @@ module Aws::BedrockAgentRuntime
|
|
1446
1500
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FailureTrace AWS API Documentation
|
1447
1501
|
#
|
1448
1502
|
class FailureTrace < Struct.new(
|
1503
|
+
:failure_code,
|
1449
1504
|
:failure_reason,
|
1505
|
+
:metadata,
|
1450
1506
|
:trace_id)
|
1451
|
-
SENSITIVE = [:failure_reason]
|
1507
|
+
SENSITIVE = [:failure_reason, :metadata]
|
1452
1508
|
include Aws::Structure
|
1453
1509
|
end
|
1454
1510
|
|
@@ -1542,6 +1598,10 @@ module Aws::BedrockAgentRuntime
|
|
1542
1598
|
|
1543
1599
|
# Contains details about the response to the user.
|
1544
1600
|
#
|
1601
|
+
# @!attribute [rw] metadata
|
1602
|
+
# Contains information about the invoke agent operation.
|
1603
|
+
# @return [Types::Metadata]
|
1604
|
+
#
|
1545
1605
|
# @!attribute [rw] text
|
1546
1606
|
# The text in the response to the user.
|
1547
1607
|
# @return [String]
|
@@ -1549,8 +1609,9 @@ module Aws::BedrockAgentRuntime
|
|
1549
1609
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FinalResponse AWS API Documentation
|
1550
1610
|
#
|
1551
1611
|
class FinalResponse < Struct.new(
|
1612
|
+
:metadata,
|
1552
1613
|
:text)
|
1553
|
-
SENSITIVE = [:text]
|
1614
|
+
SENSITIVE = [:metadata, :text]
|
1554
1615
|
include Aws::Structure
|
1555
1616
|
end
|
1556
1617
|
|
@@ -1569,6 +1630,282 @@ module Aws::BedrockAgentRuntime
|
|
1569
1630
|
include Aws::Structure
|
1570
1631
|
end
|
1571
1632
|
|
1633
|
+
# Contains the content of an async execution input or output field.
|
1634
|
+
#
|
1635
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
1636
|
+
# subject to change.
|
1637
|
+
#
|
1638
|
+
# </note>
|
1639
|
+
#
|
1640
|
+
# @note FlowExecutionContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FlowExecutionContent corresponding to the set member.
|
1641
|
+
#
|
1642
|
+
# @!attribute [rw] document
|
1643
|
+
# The document content of the field, which can contain text or
|
1644
|
+
# structured data.
|
1645
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
1646
|
+
#
|
1647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowExecutionContent AWS API Documentation
|
1648
|
+
#
|
1649
|
+
class FlowExecutionContent < Struct.new(
|
1650
|
+
:document,
|
1651
|
+
:unknown)
|
1652
|
+
SENSITIVE = []
|
1653
|
+
include Aws::Structure
|
1654
|
+
include Aws::Structure::Union
|
1655
|
+
|
1656
|
+
class Document < FlowExecutionContent; end
|
1657
|
+
class Unknown < FlowExecutionContent; end
|
1658
|
+
end
|
1659
|
+
|
1660
|
+
# Contains information about an error that occurred during an async
|
1661
|
+
# execution.
|
1662
|
+
#
|
1663
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
1664
|
+
# subject to change.
|
1665
|
+
#
|
1666
|
+
# </note>
|
1667
|
+
#
|
1668
|
+
# @!attribute [rw] error
|
1669
|
+
# The error code for the type of error that occurred.
|
1670
|
+
# @return [String]
|
1671
|
+
#
|
1672
|
+
# @!attribute [rw] message
|
1673
|
+
# A descriptive message that provides details about the error.
|
1674
|
+
# @return [String]
|
1675
|
+
#
|
1676
|
+
# @!attribute [rw] node_name
|
1677
|
+
# The name of the node in the flow where the error occurred (if
|
1678
|
+
# applicable).
|
1679
|
+
# @return [String]
|
1680
|
+
#
|
1681
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowExecutionError AWS API Documentation
|
1682
|
+
#
|
1683
|
+
class FlowExecutionError < Struct.new(
|
1684
|
+
:error,
|
1685
|
+
:message,
|
1686
|
+
:node_name)
|
1687
|
+
SENSITIVE = []
|
1688
|
+
include Aws::Structure
|
1689
|
+
end
|
1690
|
+
|
1691
|
+
# Represents an event that occurred during an async execution. This is a
|
1692
|
+
# union type that can contain one of several event types, such as node
|
1693
|
+
# input and output events; flow input and output events; condition node
|
1694
|
+
# result events, or failure events.
|
1695
|
+
#
|
1696
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
1697
|
+
# subject to change.
|
1698
|
+
#
|
1699
|
+
# </note>
|
1700
|
+
#
|
1701
|
+
# @note FlowExecutionEvent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FlowExecutionEvent corresponding to the set member.
|
1702
|
+
#
|
1703
|
+
# @!attribute [rw] condition_result_event
|
1704
|
+
# Contains information about a condition evaluation result during the
|
1705
|
+
# async execution. This event is generated when a condition node in
|
1706
|
+
# the flow evaluates its conditions.
|
1707
|
+
# @return [Types::ConditionResultEvent]
|
1708
|
+
#
|
1709
|
+
# @!attribute [rw] flow_failure_event
|
1710
|
+
# Contains information about a failure that occurred at the flow level
|
1711
|
+
# during execution.
|
1712
|
+
# @return [Types::FlowFailureEvent]
|
1713
|
+
#
|
1714
|
+
# @!attribute [rw] flow_input_event
|
1715
|
+
# Contains information about the inputs provided to the flow at the
|
1716
|
+
# start of execution.
|
1717
|
+
# @return [Types::FlowExecutionInputEvent]
|
1718
|
+
#
|
1719
|
+
# @!attribute [rw] flow_output_event
|
1720
|
+
# Contains information about the outputs produced by the flow at the
|
1721
|
+
# end of execution.
|
1722
|
+
# @return [Types::FlowExecutionOutputEvent]
|
1723
|
+
#
|
1724
|
+
# @!attribute [rw] node_failure_event
|
1725
|
+
# Contains information about a failure that occurred at a specific
|
1726
|
+
# node during execution.
|
1727
|
+
# @return [Types::NodeFailureEvent]
|
1728
|
+
#
|
1729
|
+
# @!attribute [rw] node_input_event
|
1730
|
+
# Contains information about the inputs provided to a specific node
|
1731
|
+
# during execution.
|
1732
|
+
# @return [Types::NodeInputEvent]
|
1733
|
+
#
|
1734
|
+
# @!attribute [rw] node_output_event
|
1735
|
+
# Contains information about the outputs produced by a specific node
|
1736
|
+
# during execution.
|
1737
|
+
# @return [Types::NodeOutputEvent]
|
1738
|
+
#
|
1739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowExecutionEvent AWS API Documentation
|
1740
|
+
#
|
1741
|
+
class FlowExecutionEvent < Struct.new(
|
1742
|
+
:condition_result_event,
|
1743
|
+
:flow_failure_event,
|
1744
|
+
:flow_input_event,
|
1745
|
+
:flow_output_event,
|
1746
|
+
:node_failure_event,
|
1747
|
+
:node_input_event,
|
1748
|
+
:node_output_event,
|
1749
|
+
:unknown)
|
1750
|
+
SENSITIVE = [:condition_result_event, :flow_failure_event, :flow_input_event, :flow_output_event, :node_failure_event, :node_input_event, :node_output_event]
|
1751
|
+
include Aws::Structure
|
1752
|
+
include Aws::Structure::Union
|
1753
|
+
|
1754
|
+
class ConditionResultEvent < FlowExecutionEvent; end
|
1755
|
+
class FlowFailureEvent < FlowExecutionEvent; end
|
1756
|
+
class FlowInputEvent < FlowExecutionEvent; end
|
1757
|
+
class FlowOutputEvent < FlowExecutionEvent; end
|
1758
|
+
class NodeFailureEvent < FlowExecutionEvent; end
|
1759
|
+
class NodeInputEvent < FlowExecutionEvent; end
|
1760
|
+
class NodeOutputEvent < FlowExecutionEvent; end
|
1761
|
+
class Unknown < FlowExecutionEvent; end
|
1762
|
+
end
|
1763
|
+
|
1764
|
+
# Contains information about the inputs provided to the flow at the
|
1765
|
+
# start of async execution.
|
1766
|
+
#
|
1767
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
1768
|
+
# subject to change.
|
1769
|
+
#
|
1770
|
+
# </note>
|
1771
|
+
#
|
1772
|
+
# @!attribute [rw] fields
|
1773
|
+
# A list of input fields provided to the flow.
|
1774
|
+
# @return [Array<Types::FlowInputField>]
|
1775
|
+
#
|
1776
|
+
# @!attribute [rw] node_name
|
1777
|
+
# The name of the node that receives the inputs.
|
1778
|
+
# @return [String]
|
1779
|
+
#
|
1780
|
+
# @!attribute [rw] timestamp
|
1781
|
+
# The timestamp when the inputs are provided.
|
1782
|
+
# @return [Time]
|
1783
|
+
#
|
1784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowExecutionInputEvent AWS API Documentation
|
1785
|
+
#
|
1786
|
+
class FlowExecutionInputEvent < Struct.new(
|
1787
|
+
:fields,
|
1788
|
+
:node_name,
|
1789
|
+
:timestamp)
|
1790
|
+
SENSITIVE = [:fields]
|
1791
|
+
include Aws::Structure
|
1792
|
+
end
|
1793
|
+
|
1794
|
+
# Contains information about the outputs produced by the flow during an
|
1795
|
+
# async execution.
|
1796
|
+
#
|
1797
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
1798
|
+
# subject to change.
|
1799
|
+
#
|
1800
|
+
# </note>
|
1801
|
+
#
|
1802
|
+
# @!attribute [rw] fields
|
1803
|
+
# A list of output fields produced by the flow.
|
1804
|
+
# @return [Array<Types::FlowOutputField>]
|
1805
|
+
#
|
1806
|
+
# @!attribute [rw] node_name
|
1807
|
+
# The name of the node that produces the outputs.
|
1808
|
+
# @return [String]
|
1809
|
+
#
|
1810
|
+
# @!attribute [rw] timestamp
|
1811
|
+
# The timestamp when the outputs are produced.
|
1812
|
+
# @return [Time]
|
1813
|
+
#
|
1814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowExecutionOutputEvent AWS API Documentation
|
1815
|
+
#
|
1816
|
+
class FlowExecutionOutputEvent < Struct.new(
|
1817
|
+
:fields,
|
1818
|
+
:node_name,
|
1819
|
+
:timestamp)
|
1820
|
+
SENSITIVE = [:fields]
|
1821
|
+
include Aws::Structure
|
1822
|
+
end
|
1823
|
+
|
1824
|
+
# Contains summary information about a flow's async execution,
|
1825
|
+
# including its status, timestamps, and identifiers.
|
1826
|
+
#
|
1827
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
1828
|
+
# subject to change.
|
1829
|
+
#
|
1830
|
+
# </note>
|
1831
|
+
#
|
1832
|
+
# @!attribute [rw] created_at
|
1833
|
+
# The timestamp when the async execution was created.
|
1834
|
+
# @return [Time]
|
1835
|
+
#
|
1836
|
+
# @!attribute [rw] ended_at
|
1837
|
+
# The timestamp when the async execution ended. This field is only
|
1838
|
+
# populated when the execution has completed, failed, timed out, or
|
1839
|
+
# been aborted.
|
1840
|
+
# @return [Time]
|
1841
|
+
#
|
1842
|
+
# @!attribute [rw] execution_arn
|
1843
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the async
|
1844
|
+
# execution.
|
1845
|
+
# @return [String]
|
1846
|
+
#
|
1847
|
+
# @!attribute [rw] flow_alias_identifier
|
1848
|
+
# The unique identifier of the flow alias used for the execution.
|
1849
|
+
# @return [String]
|
1850
|
+
#
|
1851
|
+
# @!attribute [rw] flow_identifier
|
1852
|
+
# The unique identifier of the flow.
|
1853
|
+
# @return [String]
|
1854
|
+
#
|
1855
|
+
# @!attribute [rw] flow_version
|
1856
|
+
# The version of the flow used for the execution.
|
1857
|
+
# @return [String]
|
1858
|
+
#
|
1859
|
+
# @!attribute [rw] status
|
1860
|
+
# The current status of the async execution.
|
1861
|
+
#
|
1862
|
+
# Async executions time out after 24 hours.
|
1863
|
+
# @return [String]
|
1864
|
+
#
|
1865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowExecutionSummary AWS API Documentation
|
1866
|
+
#
|
1867
|
+
class FlowExecutionSummary < Struct.new(
|
1868
|
+
:created_at,
|
1869
|
+
:ended_at,
|
1870
|
+
:execution_arn,
|
1871
|
+
:flow_alias_identifier,
|
1872
|
+
:flow_identifier,
|
1873
|
+
:flow_version,
|
1874
|
+
:status)
|
1875
|
+
SENSITIVE = []
|
1876
|
+
include Aws::Structure
|
1877
|
+
end
|
1878
|
+
|
1879
|
+
# Contains information about a failure that occurred at the flow level
|
1880
|
+
# during an async execution.
|
1881
|
+
#
|
1882
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
1883
|
+
# subject to change.
|
1884
|
+
#
|
1885
|
+
# </note>
|
1886
|
+
#
|
1887
|
+
# @!attribute [rw] error_code
|
1888
|
+
# The error code that identifies the type of failure that occurred.
|
1889
|
+
# @return [String]
|
1890
|
+
#
|
1891
|
+
# @!attribute [rw] error_message
|
1892
|
+
# A descriptive message that provides details about the failure.
|
1893
|
+
# @return [String]
|
1894
|
+
#
|
1895
|
+
# @!attribute [rw] timestamp
|
1896
|
+
# The timestamp when the failure occurred.
|
1897
|
+
# @return [Time]
|
1898
|
+
#
|
1899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowFailureEvent AWS API Documentation
|
1900
|
+
#
|
1901
|
+
class FlowFailureEvent < Struct.new(
|
1902
|
+
:error_code,
|
1903
|
+
:error_message,
|
1904
|
+
:timestamp)
|
1905
|
+
SENSITIVE = []
|
1906
|
+
include Aws::Structure
|
1907
|
+
end
|
1908
|
+
|
1572
1909
|
# Contains information about an input into the prompt flow and where to
|
1573
1910
|
# send it.
|
1574
1911
|
#
|
@@ -1621,6 +1958,32 @@ module Aws::BedrockAgentRuntime
|
|
1621
1958
|
class Unknown < FlowInputContent; end
|
1622
1959
|
end
|
1623
1960
|
|
1961
|
+
# Represents an input field provided to a flow during an async
|
1962
|
+
# execution.
|
1963
|
+
#
|
1964
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
1965
|
+
# subject to change.
|
1966
|
+
#
|
1967
|
+
# </note>
|
1968
|
+
#
|
1969
|
+
# @!attribute [rw] content
|
1970
|
+
# The content of the input field, which can contain text or structured
|
1971
|
+
# data.
|
1972
|
+
# @return [Types::FlowExecutionContent]
|
1973
|
+
#
|
1974
|
+
# @!attribute [rw] name
|
1975
|
+
# The name of the input field as defined in the flow's input schema.
|
1976
|
+
# @return [String]
|
1977
|
+
#
|
1978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowInputField AWS API Documentation
|
1979
|
+
#
|
1980
|
+
class FlowInputField < Struct.new(
|
1981
|
+
:content,
|
1982
|
+
:name)
|
1983
|
+
SENSITIVE = [:content]
|
1984
|
+
include Aws::Structure
|
1985
|
+
end
|
1986
|
+
|
1624
1987
|
# The content structure containing input information for multi-turn flow
|
1625
1988
|
# interactions.
|
1626
1989
|
#
|
@@ -1718,6 +2081,33 @@ module Aws::BedrockAgentRuntime
|
|
1718
2081
|
include Aws::Structure
|
1719
2082
|
end
|
1720
2083
|
|
2084
|
+
# Represents an output field produced by a flow during an async
|
2085
|
+
# execution.
|
2086
|
+
#
|
2087
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
2088
|
+
# subject to change.
|
2089
|
+
#
|
2090
|
+
# </note>
|
2091
|
+
#
|
2092
|
+
# @!attribute [rw] content
|
2093
|
+
# The content of the output field, which can contain text or
|
2094
|
+
# structured data.
|
2095
|
+
# @return [Types::FlowExecutionContent]
|
2096
|
+
#
|
2097
|
+
# @!attribute [rw] name
|
2098
|
+
# The name of the output field as defined in the flow's output
|
2099
|
+
# schema.
|
2100
|
+
# @return [String]
|
2101
|
+
#
|
2102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowOutputField AWS API Documentation
|
2103
|
+
#
|
2104
|
+
class FlowOutputField < Struct.new(
|
2105
|
+
:content,
|
2106
|
+
:name)
|
2107
|
+
SENSITIVE = [:content]
|
2108
|
+
include Aws::Structure
|
2109
|
+
end
|
2110
|
+
|
1721
2111
|
# Contains information about an input or output for a node in the flow.
|
1722
2112
|
# For more information, see [Track each step in your prompt flow by
|
1723
2113
|
# viewing its trace in Amazon Bedrock][1].
|
@@ -2448,6 +2838,154 @@ module Aws::BedrockAgentRuntime
|
|
2448
2838
|
include Aws::Structure
|
2449
2839
|
end
|
2450
2840
|
|
2841
|
+
# @!attribute [rw] execution_identifier
|
2842
|
+
# The unique identifier of the async execution.
|
2843
|
+
# @return [String]
|
2844
|
+
#
|
2845
|
+
# @!attribute [rw] flow_alias_identifier
|
2846
|
+
# The unique identifier of the flow alias used for the async
|
2847
|
+
# execution.
|
2848
|
+
# @return [String]
|
2849
|
+
#
|
2850
|
+
# @!attribute [rw] flow_identifier
|
2851
|
+
# The unique identifier of the flow.
|
2852
|
+
# @return [String]
|
2853
|
+
#
|
2854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshotRequest AWS API Documentation
|
2855
|
+
#
|
2856
|
+
class GetExecutionFlowSnapshotRequest < Struct.new(
|
2857
|
+
:execution_identifier,
|
2858
|
+
:flow_alias_identifier,
|
2859
|
+
:flow_identifier)
|
2860
|
+
SENSITIVE = []
|
2861
|
+
include Aws::Structure
|
2862
|
+
end
|
2863
|
+
|
2864
|
+
# @!attribute [rw] customer_encryption_key_arn
|
2865
|
+
# The Amazon Resource Name (ARN) of the customer managed KMS key
|
2866
|
+
# that's used to encrypt the flow snapshot.
|
2867
|
+
# @return [String]
|
2868
|
+
#
|
2869
|
+
# @!attribute [rw] definition
|
2870
|
+
# The flow definition used for the async execution, including the
|
2871
|
+
# nodes, connections, and configuration at the time when the execution
|
2872
|
+
# started.
|
2873
|
+
#
|
2874
|
+
# The definition returns as a string that follows the structure of a
|
2875
|
+
# [FlowDefinition][1] object.
|
2876
|
+
#
|
2877
|
+
#
|
2878
|
+
#
|
2879
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_FlowDefinition.html
|
2880
|
+
# @return [String]
|
2881
|
+
#
|
2882
|
+
# @!attribute [rw] execution_role_arn
|
2883
|
+
# The Amazon Resource Name (ARN) of the IAM service role that's used
|
2884
|
+
# by the async execution.
|
2885
|
+
# @return [String]
|
2886
|
+
#
|
2887
|
+
# @!attribute [rw] flow_alias_identifier
|
2888
|
+
# The unique identifier of the flow alias used for the async
|
2889
|
+
# execution.
|
2890
|
+
# @return [String]
|
2891
|
+
#
|
2892
|
+
# @!attribute [rw] flow_identifier
|
2893
|
+
# The unique identifier of the flow.
|
2894
|
+
# @return [String]
|
2895
|
+
#
|
2896
|
+
# @!attribute [rw] flow_version
|
2897
|
+
# The version of the flow used for the async execution.
|
2898
|
+
# @return [String]
|
2899
|
+
#
|
2900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshotResponse AWS API Documentation
|
2901
|
+
#
|
2902
|
+
class GetExecutionFlowSnapshotResponse < Struct.new(
|
2903
|
+
:customer_encryption_key_arn,
|
2904
|
+
:definition,
|
2905
|
+
:execution_role_arn,
|
2906
|
+
:flow_alias_identifier,
|
2907
|
+
:flow_identifier,
|
2908
|
+
:flow_version)
|
2909
|
+
SENSITIVE = []
|
2910
|
+
include Aws::Structure
|
2911
|
+
end
|
2912
|
+
|
2913
|
+
# @!attribute [rw] execution_identifier
|
2914
|
+
# The unique identifier of the async execution to retrieve.
|
2915
|
+
# @return [String]
|
2916
|
+
#
|
2917
|
+
# @!attribute [rw] flow_alias_identifier
|
2918
|
+
# The unique identifier of the flow alias used for the execution.
|
2919
|
+
# @return [String]
|
2920
|
+
#
|
2921
|
+
# @!attribute [rw] flow_identifier
|
2922
|
+
# The unique identifier of the flow.
|
2923
|
+
# @return [String]
|
2924
|
+
#
|
2925
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetFlowExecutionRequest AWS API Documentation
|
2926
|
+
#
|
2927
|
+
class GetFlowExecutionRequest < Struct.new(
|
2928
|
+
:execution_identifier,
|
2929
|
+
:flow_alias_identifier,
|
2930
|
+
:flow_identifier)
|
2931
|
+
SENSITIVE = []
|
2932
|
+
include Aws::Structure
|
2933
|
+
end
|
2934
|
+
|
2935
|
+
# @!attribute [rw] ended_at
|
2936
|
+
# The timestamp when the async execution ended. This field is only
|
2937
|
+
# populated when the execution has completed, failed, timed out, or
|
2938
|
+
# been aborted.
|
2939
|
+
# @return [Time]
|
2940
|
+
#
|
2941
|
+
# @!attribute [rw] errors
|
2942
|
+
# A list of errors that occurred during the async execution. Each
|
2943
|
+
# error includes an error code, message, and the node where the error
|
2944
|
+
# occurred, if applicable.
|
2945
|
+
# @return [Array<Types::FlowExecutionError>]
|
2946
|
+
#
|
2947
|
+
# @!attribute [rw] execution_arn
|
2948
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the async
|
2949
|
+
# execution.
|
2950
|
+
# @return [String]
|
2951
|
+
#
|
2952
|
+
# @!attribute [rw] flow_alias_identifier
|
2953
|
+
# The unique identifier of the flow alias used for the execution.
|
2954
|
+
# @return [String]
|
2955
|
+
#
|
2956
|
+
# @!attribute [rw] flow_identifier
|
2957
|
+
# The unique identifier of the flow.
|
2958
|
+
# @return [String]
|
2959
|
+
#
|
2960
|
+
# @!attribute [rw] flow_version
|
2961
|
+
# The version of the flow used for the execution.
|
2962
|
+
# @return [String]
|
2963
|
+
#
|
2964
|
+
# @!attribute [rw] started_at
|
2965
|
+
# The timestamp when the async execution started.
|
2966
|
+
# @return [Time]
|
2967
|
+
#
|
2968
|
+
# @!attribute [rw] status
|
2969
|
+
# The current status of the async execution.
|
2970
|
+
#
|
2971
|
+
# Async executions time out after 24 hours.
|
2972
|
+
# @return [String]
|
2973
|
+
#
|
2974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetFlowExecutionResponse AWS API Documentation
|
2975
|
+
#
|
2976
|
+
class GetFlowExecutionResponse < Struct.new(
|
2977
|
+
:ended_at,
|
2978
|
+
:errors,
|
2979
|
+
:execution_arn,
|
2980
|
+
:flow_alias_identifier,
|
2981
|
+
:flow_identifier,
|
2982
|
+
:flow_version,
|
2983
|
+
:started_at,
|
2984
|
+
:status)
|
2985
|
+
SENSITIVE = []
|
2986
|
+
include Aws::Structure
|
2987
|
+
end
|
2988
|
+
|
2451
2989
|
# @!attribute [rw] invocation_identifier
|
2452
2990
|
# The unique identifier for the invocation in UUID format.
|
2453
2991
|
# @return [String]
|
@@ -2836,6 +3374,10 @@ module Aws::BedrockAgentRuntime
|
|
2836
3374
|
# The details of the input assessments used in the Guardrail Trace.
|
2837
3375
|
# @return [Array<Types::GuardrailAssessment>]
|
2838
3376
|
#
|
3377
|
+
# @!attribute [rw] metadata
|
3378
|
+
# Contains information about the Guardrail output.
|
3379
|
+
# @return [Types::Metadata]
|
3380
|
+
#
|
2839
3381
|
# @!attribute [rw] output_assessments
|
2840
3382
|
# The details of the output assessments used in the Guardrail Trace.
|
2841
3383
|
# @return [Array<Types::GuardrailAssessment>]
|
@@ -2849,9 +3391,10 @@ module Aws::BedrockAgentRuntime
|
|
2849
3391
|
class GuardrailTrace < Struct.new(
|
2850
3392
|
:action,
|
2851
3393
|
:input_assessments,
|
3394
|
+
:metadata,
|
2852
3395
|
:output_assessments,
|
2853
3396
|
:trace_id)
|
2854
|
-
SENSITIVE = [:input_assessments, :output_assessments]
|
3397
|
+
SENSITIVE = [:input_assessments, :metadata, :output_assessments]
|
2855
3398
|
include Aws::Structure
|
2856
3399
|
end
|
2857
3400
|
|
@@ -4046,6 +4589,10 @@ module Aws::BedrockAgentRuntime
|
|
4046
4589
|
|
4047
4590
|
# Contains details about the results from looking up the knowledge base.
|
4048
4591
|
#
|
4592
|
+
# @!attribute [rw] metadata
|
4593
|
+
# Contains information about the knowledge base output.
|
4594
|
+
# @return [Types::Metadata]
|
4595
|
+
#
|
4049
4596
|
# @!attribute [rw] retrieved_references
|
4050
4597
|
# Contains metadata about the sources cited for the generated
|
4051
4598
|
# response.
|
@@ -4054,8 +4601,9 @@ module Aws::BedrockAgentRuntime
|
|
4054
4601
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/KnowledgeBaseLookupOutput AWS API Documentation
|
4055
4602
|
#
|
4056
4603
|
class KnowledgeBaseLookupOutput < Struct.new(
|
4604
|
+
:metadata,
|
4057
4605
|
:retrieved_references)
|
4058
|
-
SENSITIVE = []
|
4606
|
+
SENSITIVE = [:metadata]
|
4059
4607
|
include Aws::Structure
|
4060
4608
|
end
|
4061
4609
|
|
@@ -4285,6 +4833,119 @@ module Aws::BedrockAgentRuntime
|
|
4285
4833
|
include Aws::Structure
|
4286
4834
|
end
|
4287
4835
|
|
4836
|
+
# @!attribute [rw] event_type
|
4837
|
+
# The type of events to retrieve. Specify `Node` for node-level events
|
4838
|
+
# or `Flow` for flow-level events.
|
4839
|
+
# @return [String]
|
4840
|
+
#
|
4841
|
+
# @!attribute [rw] execution_identifier
|
4842
|
+
# The unique identifier of the async execution.
|
4843
|
+
# @return [String]
|
4844
|
+
#
|
4845
|
+
# @!attribute [rw] flow_alias_identifier
|
4846
|
+
# The unique identifier of the flow alias used for the execution.
|
4847
|
+
# @return [String]
|
4848
|
+
#
|
4849
|
+
# @!attribute [rw] flow_identifier
|
4850
|
+
# The unique identifier of the flow.
|
4851
|
+
# @return [String]
|
4852
|
+
#
|
4853
|
+
# @!attribute [rw] max_results
|
4854
|
+
# The maximum number of events to return in a single response. If more
|
4855
|
+
# events exist than the specified maxResults value, a token is
|
4856
|
+
# included in the response so that the remaining results can be
|
4857
|
+
# retrieved.
|
4858
|
+
# @return [Integer]
|
4859
|
+
#
|
4860
|
+
# @!attribute [rw] next_token
|
4861
|
+
# A token to retrieve the next set of results. This value is returned
|
4862
|
+
# in the response if more results are available.
|
4863
|
+
# @return [String]
|
4864
|
+
#
|
4865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEventsRequest AWS API Documentation
|
4866
|
+
#
|
4867
|
+
class ListFlowExecutionEventsRequest < Struct.new(
|
4868
|
+
:event_type,
|
4869
|
+
:execution_identifier,
|
4870
|
+
:flow_alias_identifier,
|
4871
|
+
:flow_identifier,
|
4872
|
+
:max_results,
|
4873
|
+
:next_token)
|
4874
|
+
SENSITIVE = []
|
4875
|
+
include Aws::Structure
|
4876
|
+
end
|
4877
|
+
|
4878
|
+
# @!attribute [rw] flow_execution_events
|
4879
|
+
# A list of events that occurred during the async execution. Events
|
4880
|
+
# can include node inputs and outputs, flow inputs and outputs,
|
4881
|
+
# condition results, and failure events.
|
4882
|
+
# @return [Array<Types::FlowExecutionEvent>]
|
4883
|
+
#
|
4884
|
+
# @!attribute [rw] next_token
|
4885
|
+
# A token to retrieve the next set of results. This value is returned
|
4886
|
+
# if more results are available.
|
4887
|
+
# @return [String]
|
4888
|
+
#
|
4889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEventsResponse AWS API Documentation
|
4890
|
+
#
|
4891
|
+
class ListFlowExecutionEventsResponse < Struct.new(
|
4892
|
+
:flow_execution_events,
|
4893
|
+
:next_token)
|
4894
|
+
SENSITIVE = []
|
4895
|
+
include Aws::Structure
|
4896
|
+
end
|
4897
|
+
|
4898
|
+
# @!attribute [rw] flow_alias_identifier
|
4899
|
+
# The unique identifier of the flow alias to list executions for.
|
4900
|
+
# @return [String]
|
4901
|
+
#
|
4902
|
+
# @!attribute [rw] flow_identifier
|
4903
|
+
# The unique identifier of the flow to list executions for.
|
4904
|
+
# @return [String]
|
4905
|
+
#
|
4906
|
+
# @!attribute [rw] max_results
|
4907
|
+
# The maximum number of async executions to return in a single
|
4908
|
+
# response. If more executions exist than the specified maxResults
|
4909
|
+
# value, a token is included in the response so that the remaining
|
4910
|
+
# results can be retrieved.
|
4911
|
+
# @return [Integer]
|
4912
|
+
#
|
4913
|
+
# @!attribute [rw] next_token
|
4914
|
+
# A token to retrieve the next set of results. This value is returned
|
4915
|
+
# in the response if more results are available.
|
4916
|
+
# @return [String]
|
4917
|
+
#
|
4918
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ListFlowExecutionsRequest AWS API Documentation
|
4919
|
+
#
|
4920
|
+
class ListFlowExecutionsRequest < Struct.new(
|
4921
|
+
:flow_alias_identifier,
|
4922
|
+
:flow_identifier,
|
4923
|
+
:max_results,
|
4924
|
+
:next_token)
|
4925
|
+
SENSITIVE = []
|
4926
|
+
include Aws::Structure
|
4927
|
+
end
|
4928
|
+
|
4929
|
+
# @!attribute [rw] flow_execution_summaries
|
4930
|
+
# A list of async execution summaries. Each summary includes the
|
4931
|
+
# execution ARN, flow identifier, flow alias identifier, flow version,
|
4932
|
+
# status, and timestamps.
|
4933
|
+
# @return [Array<Types::FlowExecutionSummary>]
|
4934
|
+
#
|
4935
|
+
# @!attribute [rw] next_token
|
4936
|
+
# A token to retrieve the next set of results. This value is returned
|
4937
|
+
# if more results are available.
|
4938
|
+
# @return [String]
|
4939
|
+
#
|
4940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ListFlowExecutionsResponse AWS API Documentation
|
4941
|
+
#
|
4942
|
+
class ListFlowExecutionsResponse < Struct.new(
|
4943
|
+
:flow_execution_summaries,
|
4944
|
+
:next_token)
|
4945
|
+
SENSITIVE = []
|
4946
|
+
include Aws::Structure
|
4947
|
+
end
|
4948
|
+
|
4288
4949
|
# @!attribute [rw] invocation_identifier
|
4289
4950
|
# The unique identifier (in UUID format) for the invocation to list
|
4290
4951
|
# invocation steps for.
|
@@ -4536,15 +5197,51 @@ module Aws::BedrockAgentRuntime
|
|
4536
5197
|
include Aws::Structure
|
4537
5198
|
end
|
4538
5199
|
|
4539
|
-
# Provides
|
5200
|
+
# Provides information about the execution process for different types
|
5201
|
+
# of invocations, such as model invocation, knowledge base invocation,
|
5202
|
+
# agent collaborator invocation, guardrail invocation, and code
|
5203
|
+
# interpreter Invocation.
|
5204
|
+
#
|
5205
|
+
# @!attribute [rw] client_request_id
|
5206
|
+
# A unique identifier associated with the downstream invocation. This
|
5207
|
+
# ID can be used for tracing, debugging, and identifying specific
|
5208
|
+
# invocations in customer logs or systems.
|
5209
|
+
# @return [String]
|
5210
|
+
#
|
5211
|
+
# @!attribute [rw] end_time
|
5212
|
+
# In the final response, `endTime` is the end time of the agent
|
5213
|
+
# invocation operation.
|
5214
|
+
# @return [Time]
|
5215
|
+
#
|
5216
|
+
# @!attribute [rw] operation_total_time_ms
|
5217
|
+
# The total time it took for the agent to complete execution. This
|
5218
|
+
# field is only set for the final response.
|
5219
|
+
# @return [Integer]
|
5220
|
+
#
|
5221
|
+
# @!attribute [rw] start_time
|
5222
|
+
# In the final response, `startTime` is the start time of the agent
|
5223
|
+
# invocation operation.
|
5224
|
+
# @return [Time]
|
5225
|
+
#
|
5226
|
+
# @!attribute [rw] total_time_ms
|
5227
|
+
# The total execution time for the specific invocation being processed
|
5228
|
+
# (model, knowledge base, guardrail, agent collaborator, or code
|
5229
|
+
# interpreter). It represents how long the individual invocation took.
|
5230
|
+
# @return [Integer]
|
4540
5231
|
#
|
4541
5232
|
# @!attribute [rw] usage
|
4542
|
-
#
|
5233
|
+
# Specific to model invocation and contains details about the usage of
|
5234
|
+
# a foundation model.
|
4543
5235
|
# @return [Types::Usage]
|
4544
5236
|
#
|
4545
5237
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Metadata AWS API Documentation
|
4546
5238
|
#
|
4547
5239
|
class Metadata < Struct.new(
|
5240
|
+
:client_request_id,
|
5241
|
+
:end_time,
|
5242
|
+
:operation_total_time_ms,
|
5243
|
+
:start_time,
|
5244
|
+
:total_time_ms,
|
4548
5245
|
:usage)
|
4549
5246
|
SENSITIVE = [:usage]
|
4550
5247
|
include Aws::Structure
|
@@ -4711,6 +5408,178 @@ module Aws::BedrockAgentRuntime
|
|
4711
5408
|
include Aws::Structure
|
4712
5409
|
end
|
4713
5410
|
|
5411
|
+
# Contains the content of a flow node's input or output field for an
|
5412
|
+
# async execution.
|
5413
|
+
#
|
5414
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
5415
|
+
# subject to change.
|
5416
|
+
#
|
5417
|
+
# </note>
|
5418
|
+
#
|
5419
|
+
# @note NodeExecutionContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of NodeExecutionContent corresponding to the set member.
|
5420
|
+
#
|
5421
|
+
# @!attribute [rw] document
|
5422
|
+
# The document content of the field, which can contain text or
|
5423
|
+
# structured data.
|
5424
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
5425
|
+
#
|
5426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/NodeExecutionContent AWS API Documentation
|
5427
|
+
#
|
5428
|
+
class NodeExecutionContent < Struct.new(
|
5429
|
+
:document,
|
5430
|
+
:unknown)
|
5431
|
+
SENSITIVE = []
|
5432
|
+
include Aws::Structure
|
5433
|
+
include Aws::Structure::Union
|
5434
|
+
|
5435
|
+
class Document < NodeExecutionContent; end
|
5436
|
+
class Unknown < NodeExecutionContent; end
|
5437
|
+
end
|
5438
|
+
|
5439
|
+
# Contains information about a failure that occurred at a specific node
|
5440
|
+
# during a flow's async execution.
|
5441
|
+
#
|
5442
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
5443
|
+
# subject to change.
|
5444
|
+
#
|
5445
|
+
# </note>
|
5446
|
+
#
|
5447
|
+
# @!attribute [rw] error_code
|
5448
|
+
# The error code that identifies the type of failure that occurred at
|
5449
|
+
# the node.
|
5450
|
+
# @return [String]
|
5451
|
+
#
|
5452
|
+
# @!attribute [rw] error_message
|
5453
|
+
# A descriptive message that provides details about the node failure.
|
5454
|
+
# @return [String]
|
5455
|
+
#
|
5456
|
+
# @!attribute [rw] node_name
|
5457
|
+
# The name of the node where the failure occurred.
|
5458
|
+
# @return [String]
|
5459
|
+
#
|
5460
|
+
# @!attribute [rw] timestamp
|
5461
|
+
# The timestamp when the node failure occurred.
|
5462
|
+
# @return [Time]
|
5463
|
+
#
|
5464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/NodeFailureEvent AWS API Documentation
|
5465
|
+
#
|
5466
|
+
class NodeFailureEvent < Struct.new(
|
5467
|
+
:error_code,
|
5468
|
+
:error_message,
|
5469
|
+
:node_name,
|
5470
|
+
:timestamp)
|
5471
|
+
SENSITIVE = []
|
5472
|
+
include Aws::Structure
|
5473
|
+
end
|
5474
|
+
|
5475
|
+
# Contains information about the inputs provided to a specific node
|
5476
|
+
# during a flow's async execution.
|
5477
|
+
#
|
5478
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
5479
|
+
# subject to change.
|
5480
|
+
#
|
5481
|
+
# </note>
|
5482
|
+
#
|
5483
|
+
# @!attribute [rw] fields
|
5484
|
+
# A list of input fields provided to the node.
|
5485
|
+
# @return [Array<Types::NodeInputField>]
|
5486
|
+
#
|
5487
|
+
# @!attribute [rw] node_name
|
5488
|
+
# The name of the node that received the inputs.
|
5489
|
+
# @return [String]
|
5490
|
+
#
|
5491
|
+
# @!attribute [rw] timestamp
|
5492
|
+
# The timestamp when the inputs were provided to the node.
|
5493
|
+
# @return [Time]
|
5494
|
+
#
|
5495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/NodeInputEvent AWS API Documentation
|
5496
|
+
#
|
5497
|
+
class NodeInputEvent < Struct.new(
|
5498
|
+
:fields,
|
5499
|
+
:node_name,
|
5500
|
+
:timestamp)
|
5501
|
+
SENSITIVE = [:fields]
|
5502
|
+
include Aws::Structure
|
5503
|
+
end
|
5504
|
+
|
5505
|
+
# Represents an input field provided to a node during a flow's async
|
5506
|
+
# execution.
|
5507
|
+
#
|
5508
|
+
# @!attribute [rw] content
|
5509
|
+
# The content of the input field, which can contain text or structured
|
5510
|
+
# data.
|
5511
|
+
# @return [Types::NodeExecutionContent]
|
5512
|
+
#
|
5513
|
+
# @!attribute [rw] name
|
5514
|
+
# The name of the input field as defined in the node's input schema.
|
5515
|
+
# @return [String]
|
5516
|
+
#
|
5517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/NodeInputField AWS API Documentation
|
5518
|
+
#
|
5519
|
+
class NodeInputField < Struct.new(
|
5520
|
+
:content,
|
5521
|
+
:name)
|
5522
|
+
SENSITIVE = [:content]
|
5523
|
+
include Aws::Structure
|
5524
|
+
end
|
5525
|
+
|
5526
|
+
# Contains information about the outputs produced by a specific node
|
5527
|
+
# during a flow's async execution.
|
5528
|
+
#
|
5529
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
5530
|
+
# subject to change.
|
5531
|
+
#
|
5532
|
+
# </note>
|
5533
|
+
#
|
5534
|
+
# @!attribute [rw] fields
|
5535
|
+
# A list of output fields produced by the node.
|
5536
|
+
# @return [Array<Types::NodeOutputField>]
|
5537
|
+
#
|
5538
|
+
# @!attribute [rw] node_name
|
5539
|
+
# The name of the node that produced the outputs.
|
5540
|
+
# @return [String]
|
5541
|
+
#
|
5542
|
+
# @!attribute [rw] timestamp
|
5543
|
+
# The timestamp when the outputs were produced by the node.
|
5544
|
+
# @return [Time]
|
5545
|
+
#
|
5546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/NodeOutputEvent AWS API Documentation
|
5547
|
+
#
|
5548
|
+
class NodeOutputEvent < Struct.new(
|
5549
|
+
:fields,
|
5550
|
+
:node_name,
|
5551
|
+
:timestamp)
|
5552
|
+
SENSITIVE = [:fields]
|
5553
|
+
include Aws::Structure
|
5554
|
+
end
|
5555
|
+
|
5556
|
+
# Represents an output field produced by a node during a flow's async
|
5557
|
+
# execution.
|
5558
|
+
#
|
5559
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
5560
|
+
# subject to change.
|
5561
|
+
#
|
5562
|
+
# </note>
|
5563
|
+
#
|
5564
|
+
# @!attribute [rw] content
|
5565
|
+
# The content of the output field, which can contain text or
|
5566
|
+
# structured data.
|
5567
|
+
# @return [Types::NodeExecutionContent]
|
5568
|
+
#
|
5569
|
+
# @!attribute [rw] name
|
5570
|
+
# The name of the output field as defined in the node's output
|
5571
|
+
# schema.
|
5572
|
+
# @return [String]
|
5573
|
+
#
|
5574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/NodeOutputField AWS API Documentation
|
5575
|
+
#
|
5576
|
+
class NodeOutputField < Struct.new(
|
5577
|
+
:content,
|
5578
|
+
:name)
|
5579
|
+
SENSITIVE = [:content]
|
5580
|
+
include Aws::Structure
|
5581
|
+
end
|
5582
|
+
|
4714
5583
|
# Contains the result or output of an action group or knowledge base, or
|
4715
5584
|
# the response to the user.
|
4716
5585
|
#
|
@@ -6942,6 +7811,26 @@ module Aws::BedrockAgentRuntime
|
|
6942
7811
|
include Aws::Structure
|
6943
7812
|
end
|
6944
7813
|
|
7814
|
+
# Represents a condition that was satisfied during a condition node
|
7815
|
+
# evaluation in a flow's async execution.
|
7816
|
+
#
|
7817
|
+
# <note markdown="1"> Asynchronous flows is in preview release for Amazon Bedrock and is
|
7818
|
+
# subject to change.
|
7819
|
+
#
|
7820
|
+
# </note>
|
7821
|
+
#
|
7822
|
+
# @!attribute [rw] condition_name
|
7823
|
+
# The name of the condition that was satisfied.
|
7824
|
+
# @return [String]
|
7825
|
+
#
|
7826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/SatisfiedCondition AWS API Documentation
|
7827
|
+
#
|
7828
|
+
class SatisfiedCondition < Struct.new(
|
7829
|
+
:condition_name)
|
7830
|
+
SENSITIVE = []
|
7831
|
+
include Aws::Structure
|
7832
|
+
end
|
7833
|
+
|
6945
7834
|
# The number of requests exceeds the service quota. Resubmit your
|
6946
7835
|
# request later.
|
6947
7836
|
#
|
@@ -7127,6 +8016,97 @@ module Aws::BedrockAgentRuntime
|
|
7127
8016
|
include Aws::Structure
|
7128
8017
|
end
|
7129
8018
|
|
8019
|
+
# @!attribute [rw] flow_alias_identifier
|
8020
|
+
# The unique identifier of the flow alias to use for the async
|
8021
|
+
# execution.
|
8022
|
+
# @return [String]
|
8023
|
+
#
|
8024
|
+
# @!attribute [rw] flow_execution_name
|
8025
|
+
# The unique name for the async execution. If you don't provide one,
|
8026
|
+
# a system-generated name is used.
|
8027
|
+
# @return [String]
|
8028
|
+
#
|
8029
|
+
# @!attribute [rw] flow_identifier
|
8030
|
+
# The unique identifier of the flow to execute.
|
8031
|
+
# @return [String]
|
8032
|
+
#
|
8033
|
+
# @!attribute [rw] inputs
|
8034
|
+
# The input data required for the async execution. This must match the
|
8035
|
+
# input schema defined in the flow.
|
8036
|
+
# @return [Array<Types::FlowInput>]
|
8037
|
+
#
|
8038
|
+
# @!attribute [rw] model_performance_configuration
|
8039
|
+
# The performance settings for the foundation model used in the async
|
8040
|
+
# execution.
|
8041
|
+
# @return [Types::ModelPerformanceConfiguration]
|
8042
|
+
#
|
8043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/StartFlowExecutionRequest AWS API Documentation
|
8044
|
+
#
|
8045
|
+
class StartFlowExecutionRequest < Struct.new(
|
8046
|
+
:flow_alias_identifier,
|
8047
|
+
:flow_execution_name,
|
8048
|
+
:flow_identifier,
|
8049
|
+
:inputs,
|
8050
|
+
:model_performance_configuration)
|
8051
|
+
SENSITIVE = []
|
8052
|
+
include Aws::Structure
|
8053
|
+
end
|
8054
|
+
|
8055
|
+
# @!attribute [rw] execution_arn
|
8056
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the async
|
8057
|
+
# execution.
|
8058
|
+
# @return [String]
|
8059
|
+
#
|
8060
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/StartFlowExecutionResponse AWS API Documentation
|
8061
|
+
#
|
8062
|
+
class StartFlowExecutionResponse < Struct.new(
|
8063
|
+
:execution_arn)
|
8064
|
+
SENSITIVE = []
|
8065
|
+
include Aws::Structure
|
8066
|
+
end
|
8067
|
+
|
8068
|
+
# @!attribute [rw] execution_identifier
|
8069
|
+
# The unique identifier of the async execution to stop.
|
8070
|
+
# @return [String]
|
8071
|
+
#
|
8072
|
+
# @!attribute [rw] flow_alias_identifier
|
8073
|
+
# The unique identifier of the flow alias used for the execution.
|
8074
|
+
# @return [String]
|
8075
|
+
#
|
8076
|
+
# @!attribute [rw] flow_identifier
|
8077
|
+
# The unique identifier of the flow.
|
8078
|
+
# @return [String]
|
8079
|
+
#
|
8080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/StopFlowExecutionRequest AWS API Documentation
|
8081
|
+
#
|
8082
|
+
class StopFlowExecutionRequest < Struct.new(
|
8083
|
+
:execution_identifier,
|
8084
|
+
:flow_alias_identifier,
|
8085
|
+
:flow_identifier)
|
8086
|
+
SENSITIVE = []
|
8087
|
+
include Aws::Structure
|
8088
|
+
end
|
8089
|
+
|
8090
|
+
# @!attribute [rw] execution_arn
|
8091
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the async
|
8092
|
+
# execution that was stopped.
|
8093
|
+
# @return [String]
|
8094
|
+
#
|
8095
|
+
# @!attribute [rw] status
|
8096
|
+
# The updated status of the async execution after the stop request.
|
8097
|
+
# This will typically be ABORTED if the execution was successfully
|
8098
|
+
# stopped.
|
8099
|
+
# @return [String]
|
8100
|
+
#
|
8101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/StopFlowExecutionResponse AWS API Documentation
|
8102
|
+
#
|
8103
|
+
class StopFlowExecutionResponse < Struct.new(
|
8104
|
+
:execution_arn,
|
8105
|
+
:status)
|
8106
|
+
SENSITIVE = []
|
8107
|
+
include Aws::Structure
|
8108
|
+
end
|
8109
|
+
|
7130
8110
|
# Configurations for streaming.
|
7131
8111
|
#
|
7132
8112
|
# @!attribute [rw] apply_guardrail_interval
|