aws-sdk-bedrockagentcore 1.0.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.
@@ -0,0 +1,2482 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::BedrockAgentCore
11
+ module Types
12
+
13
+ # The exception that occurs when you do not have sufficient permissions
14
+ # to perform an action. Verify that your IAM policy includes the
15
+ # necessary permissions for the operation you are trying to perform.
16
+ #
17
+ # @!attribute [rw] message
18
+ # @return [String]
19
+ #
20
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/AccessDeniedException AWS API Documentation
21
+ #
22
+ class AccessDeniedException < Struct.new(
23
+ :message,
24
+ :event_type)
25
+ SENSITIVE = []
26
+ include Aws::Structure
27
+ end
28
+
29
+ # Contains summary information about an actor in a memory store.
30
+ #
31
+ # @!attribute [rw] actor_id
32
+ # The unique identifier of the actor.
33
+ # @return [String]
34
+ #
35
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ActorSummary AWS API Documentation
36
+ #
37
+ class ActorSummary < Struct.new(
38
+ :actor_id)
39
+ SENSITIVE = []
40
+ include Aws::Structure
41
+ end
42
+
43
+ # The configuration for a stream that enables programmatic control of a
44
+ # browser session in Amazon Bedrock. This stream provides a
45
+ # bidirectional communication channel for sending commands to the
46
+ # browser and receiving responses, allowing agents to automate web
47
+ # interactions such as navigation, form filling, and element clicking.
48
+ #
49
+ # @!attribute [rw] stream_endpoint
50
+ # The endpoint URL for the automation stream. This URL is used to
51
+ # establish a WebSocket connection to the stream for sending commands
52
+ # and receiving responses.
53
+ # @return [String]
54
+ #
55
+ # @!attribute [rw] stream_status
56
+ # The current status of the automation stream. This indicates whether
57
+ # the stream is available for use. Possible values include ACTIVE,
58
+ # CONNECTING, and DISCONNECTED.
59
+ # @return [String]
60
+ #
61
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/AutomationStream AWS API Documentation
62
+ #
63
+ class AutomationStream < Struct.new(
64
+ :stream_endpoint,
65
+ :stream_status)
66
+ SENSITIVE = []
67
+ include Aws::Structure
68
+ end
69
+
70
+ # Contains information about an update to an automation stream.
71
+ #
72
+ # @!attribute [rw] stream_status
73
+ # The status of the automation stream.
74
+ # @return [String]
75
+ #
76
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/AutomationStreamUpdate AWS API Documentation
77
+ #
78
+ class AutomationStreamUpdate < Struct.new(
79
+ :stream_status)
80
+ SENSITIVE = []
81
+ include Aws::Structure
82
+ end
83
+
84
+ # Contains information about a branch in a memory store. Branches allow
85
+ # for organizing events into different conversation threads or paths.
86
+ #
87
+ # @!attribute [rw] root_event_id
88
+ # The identifier of the root event for this branch.
89
+ # @return [String]
90
+ #
91
+ # @!attribute [rw] name
92
+ # The name of the branch.
93
+ # @return [String]
94
+ #
95
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/Branch AWS API Documentation
96
+ #
97
+ class Branch < Struct.new(
98
+ :root_event_id,
99
+ :name)
100
+ SENSITIVE = []
101
+ include Aws::Structure
102
+ end
103
+
104
+ # Contains filter criteria for branches when listing events.
105
+ #
106
+ # @!attribute [rw] name
107
+ # The name of the branch to filter by.
108
+ # @return [String]
109
+ #
110
+ # @!attribute [rw] include_parent_branches
111
+ # Specifies whether to include parent branches in the results. Set to
112
+ # true to include parent branches, or false to exclude them.
113
+ # @return [Boolean]
114
+ #
115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/BranchFilter AWS API Documentation
116
+ #
117
+ class BranchFilter < Struct.new(
118
+ :name,
119
+ :include_parent_branches)
120
+ SENSITIVE = []
121
+ include Aws::Structure
122
+ end
123
+
124
+ # The collection of streams associated with a browser session in Amazon
125
+ # Bedrock. These streams provide different ways to interact with and
126
+ # observe the browser session, including programmatic control and visual
127
+ # representation of the browser content.
128
+ #
129
+ # @!attribute [rw] automation_stream
130
+ # The stream that enables programmatic control of the browser. This
131
+ # stream allows agents to perform actions such as navigating to URLs,
132
+ # clicking elements, and filling forms.
133
+ # @return [Types::AutomationStream]
134
+ #
135
+ # @!attribute [rw] live_view_stream
136
+ # The stream that provides a visual representation of the browser
137
+ # content. This stream allows agents to observe the current state of
138
+ # the browser, including rendered web pages and visual elements.
139
+ # @return [Types::LiveViewStream]
140
+ #
141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/BrowserSessionStream AWS API Documentation
142
+ #
143
+ class BrowserSessionStream < Struct.new(
144
+ :automation_stream,
145
+ :live_view_stream)
146
+ SENSITIVE = []
147
+ include Aws::Structure
148
+ end
149
+
150
+ # A condensed representation of a browser session in Amazon Bedrock.
151
+ # This structure contains key information about a browser session,
152
+ # including identifiers, status, and timestamps, without the full
153
+ # details of the session configuration and streams.
154
+ #
155
+ # @!attribute [rw] browser_identifier
156
+ # The unique identifier of the browser associated with the session.
157
+ # This identifier specifies which browser environment is used for the
158
+ # session.
159
+ # @return [String]
160
+ #
161
+ # @!attribute [rw] session_id
162
+ # The unique identifier of the browser session. This identifier is
163
+ # used in operations that interact with the session.
164
+ # @return [String]
165
+ #
166
+ # @!attribute [rw] name
167
+ # The name of the browser session. This name helps identify and manage
168
+ # the session.
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] status
172
+ # The current status of the browser session. Possible values include
173
+ # ACTIVE, STOPPING, and STOPPED.
174
+ # @return [String]
175
+ #
176
+ # @!attribute [rw] created_at
177
+ # The timestamp when the browser session was created. This value is in
178
+ # ISO 8601 format.
179
+ # @return [Time]
180
+ #
181
+ # @!attribute [rw] last_updated_at
182
+ # The timestamp when the browser session was last updated. This value
183
+ # is in ISO 8601 format.
184
+ # @return [Time]
185
+ #
186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/BrowserSessionSummary AWS API Documentation
187
+ #
188
+ class BrowserSessionSummary < Struct.new(
189
+ :browser_identifier,
190
+ :session_id,
191
+ :name,
192
+ :status,
193
+ :created_at,
194
+ :last_updated_at)
195
+ SENSITIVE = []
196
+ include Aws::Structure
197
+ end
198
+
199
+ # The output produced by executing code in a code interpreter session in
200
+ # Amazon Bedrock. This structure contains the results of code execution,
201
+ # including textual output, structured data, and error information.
202
+ # Agents use these results to generate responses that incorporate
203
+ # computation, data analysis, and visualization.
204
+ #
205
+ # @!attribute [rw] content
206
+ # The textual content of the execution result. This includes standard
207
+ # output from the code execution, such as print statements, console
208
+ # output, and text representations of results.
209
+ # @return [Array<Types::ContentBlock>]
210
+ #
211
+ # @!attribute [rw] structured_content
212
+ # The structured content of the execution result. This includes
213
+ # additional metadata about the execution, such as execution time,
214
+ # memory usage, and structured representations of output data. The
215
+ # format depends on the specific code interpreter and execution
216
+ # context.
217
+ # @return [Types::ToolResultStructuredContent]
218
+ #
219
+ # @!attribute [rw] is_error
220
+ # Indicates whether the result represents an error. If true, the
221
+ # content contains error messages or exception information. If false,
222
+ # the content contains successful execution results.
223
+ # @return [Boolean]
224
+ #
225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/CodeInterpreterResult AWS API Documentation
226
+ #
227
+ class CodeInterpreterResult < Struct.new(
228
+ :content,
229
+ :structured_content,
230
+ :is_error,
231
+ :event_type)
232
+ SENSITIVE = []
233
+ include Aws::Structure
234
+ end
235
+
236
+ # A condensed representation of a code interpreter session in Amazon
237
+ # Bedrock. This structure contains key information about a code
238
+ # interpreter session, including identifiers, status, and timestamps,
239
+ # without the full details of the session configuration.
240
+ #
241
+ # @!attribute [rw] code_interpreter_identifier
242
+ # The unique identifier of the code interpreter associated with the
243
+ # session. This identifier specifies which code interpreter
244
+ # environment is used for the session.
245
+ # @return [String]
246
+ #
247
+ # @!attribute [rw] session_id
248
+ # The unique identifier of the code interpreter session. This
249
+ # identifier is used in operations that interact with the session.
250
+ # @return [String]
251
+ #
252
+ # @!attribute [rw] name
253
+ # The name of the code interpreter session. This name helps identify
254
+ # and manage the session.
255
+ # @return [String]
256
+ #
257
+ # @!attribute [rw] status
258
+ # The current status of the code interpreter session. Possible values
259
+ # include ACTIVE, STOPPING, and STOPPED.
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] created_at
263
+ # The timestamp when the code interpreter session was created. This
264
+ # value is in ISO 8601 format.
265
+ # @return [Time]
266
+ #
267
+ # @!attribute [rw] last_updated_at
268
+ # The timestamp when the code interpreter session was last updated.
269
+ # This value is in ISO 8601 format.
270
+ # @return [Time]
271
+ #
272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/CodeInterpreterSessionSummary AWS API Documentation
273
+ #
274
+ class CodeInterpreterSessionSummary < Struct.new(
275
+ :code_interpreter_identifier,
276
+ :session_id,
277
+ :name,
278
+ :status,
279
+ :created_at,
280
+ :last_updated_at)
281
+ SENSITIVE = []
282
+ include Aws::Structure
283
+ end
284
+
285
+ # The exception that occurs when the request conflicts with the current
286
+ # state of the resource. This can happen when trying to modify a
287
+ # resource that is currently being modified by another request, or when
288
+ # trying to create a resource that already exists.
289
+ #
290
+ # @!attribute [rw] message
291
+ # @return [String]
292
+ #
293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ConflictException AWS API Documentation
294
+ #
295
+ class ConflictException < Struct.new(
296
+ :message,
297
+ :event_type)
298
+ SENSITIVE = []
299
+ include Aws::Structure
300
+ end
301
+
302
+ # Contains the content of a memory item.
303
+ #
304
+ # @note Content is a union - when making an API calls you must set exactly one of the members.
305
+ #
306
+ # @note Content is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Content corresponding to the set member.
307
+ #
308
+ # @!attribute [rw] text
309
+ # The text content of the memory item.
310
+ # @return [String]
311
+ #
312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/Content AWS API Documentation
313
+ #
314
+ class Content < Struct.new(
315
+ :text,
316
+ :unknown)
317
+ SENSITIVE = [:text]
318
+ include Aws::Structure
319
+ include Aws::Structure::Union
320
+
321
+ class Text < Content; end
322
+ class Unknown < Content; end
323
+ end
324
+
325
+ # A block of content in a response.
326
+ #
327
+ # @!attribute [rw] type
328
+ # The type of content in the block.
329
+ # @return [String]
330
+ #
331
+ # @!attribute [rw] text
332
+ # The text content of the block.
333
+ # @return [String]
334
+ #
335
+ # @!attribute [rw] data
336
+ # The binary data content of the block.
337
+ # @return [String]
338
+ #
339
+ # @!attribute [rw] mime_type
340
+ # The MIME type of the content.
341
+ # @return [String]
342
+ #
343
+ # @!attribute [rw] uri
344
+ # The URI of the content.
345
+ # @return [String]
346
+ #
347
+ # @!attribute [rw] name
348
+ # The name of the content block.
349
+ # @return [String]
350
+ #
351
+ # @!attribute [rw] description
352
+ # The description of the content block.
353
+ # @return [String]
354
+ #
355
+ # @!attribute [rw] size
356
+ # The size of the content in bytes.
357
+ # @return [Integer]
358
+ #
359
+ # @!attribute [rw] resource
360
+ # The resource associated with the content block.
361
+ # @return [Types::ResourceContent]
362
+ #
363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ContentBlock AWS API Documentation
364
+ #
365
+ class ContentBlock < Struct.new(
366
+ :type,
367
+ :text,
368
+ :data,
369
+ :mime_type,
370
+ :uri,
371
+ :name,
372
+ :description,
373
+ :size,
374
+ :resource)
375
+ SENSITIVE = []
376
+ include Aws::Structure
377
+ end
378
+
379
+ # Contains conversational content for an event payload.
380
+ #
381
+ # @!attribute [rw] content
382
+ # The content of the conversation message.
383
+ # @return [Types::Content]
384
+ #
385
+ # @!attribute [rw] role
386
+ # The role of the participant in the conversation (for example,
387
+ # "user" or "assistant").
388
+ # @return [String]
389
+ #
390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/Conversational AWS API Documentation
391
+ #
392
+ class Conversational < Struct.new(
393
+ :content,
394
+ :role)
395
+ SENSITIVE = []
396
+ include Aws::Structure
397
+ end
398
+
399
+ # @!attribute [rw] memory_id
400
+ # The identifier of the memory store in which to create the event.
401
+ # @return [String]
402
+ #
403
+ # @!attribute [rw] actor_id
404
+ # The identifier of the actor associated with this event. An actor
405
+ # represents an entity that participates in sessions and generates
406
+ # events.
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] session_id
410
+ # The identifier of the session in which this event occurs. A session
411
+ # represents a sequence of related events.
412
+ # @return [String]
413
+ #
414
+ # @!attribute [rw] event_timestamp
415
+ # The timestamp when the event occurred. If not specified, the current
416
+ # time is used.
417
+ # @return [Time]
418
+ #
419
+ # @!attribute [rw] payload
420
+ # The content payload of the event. This can include conversational
421
+ # data or binary content.
422
+ # @return [Array<Types::PayloadType>]
423
+ #
424
+ # @!attribute [rw] branch
425
+ # The branch information for this event. Branches allow for organizing
426
+ # events into different conversation threads or paths.
427
+ # @return [Types::Branch]
428
+ #
429
+ # @!attribute [rw] client_token
430
+ # A unique, case-sensitive identifier to ensure that the operation
431
+ # completes no more than one time. If this token matches a previous
432
+ # request, AgentCore ignores the request, but does not return an
433
+ # error.
434
+ #
435
+ # **A suitable default value is auto-generated.** You should normally
436
+ # not need to pass this option.
437
+ # @return [String]
438
+ #
439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/CreateEventInput AWS API Documentation
440
+ #
441
+ class CreateEventInput < Struct.new(
442
+ :memory_id,
443
+ :actor_id,
444
+ :session_id,
445
+ :event_timestamp,
446
+ :payload,
447
+ :branch,
448
+ :client_token)
449
+ SENSITIVE = []
450
+ include Aws::Structure
451
+ end
452
+
453
+ # @!attribute [rw] event
454
+ # The event that was created.
455
+ # @return [Types::Event]
456
+ #
457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/CreateEventOutput AWS API Documentation
458
+ #
459
+ class CreateEventOutput < Struct.new(
460
+ :event)
461
+ SENSITIVE = []
462
+ include Aws::Structure
463
+ end
464
+
465
+ # @!attribute [rw] memory_id
466
+ # The identifier of the memory store from which to delete the event.
467
+ # @return [String]
468
+ #
469
+ # @!attribute [rw] session_id
470
+ # The identifier of the session containing the event to delete.
471
+ # @return [String]
472
+ #
473
+ # @!attribute [rw] event_id
474
+ # The identifier of the event to delete.
475
+ # @return [String]
476
+ #
477
+ # @!attribute [rw] actor_id
478
+ # The identifier of the actor associated with the event to delete.
479
+ # @return [String]
480
+ #
481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/DeleteEventInput AWS API Documentation
482
+ #
483
+ class DeleteEventInput < Struct.new(
484
+ :memory_id,
485
+ :session_id,
486
+ :event_id,
487
+ :actor_id)
488
+ SENSITIVE = []
489
+ include Aws::Structure
490
+ end
491
+
492
+ # @!attribute [rw] event_id
493
+ # The identifier of the event that was deleted.
494
+ # @return [String]
495
+ #
496
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/DeleteEventOutput AWS API Documentation
497
+ #
498
+ class DeleteEventOutput < Struct.new(
499
+ :event_id)
500
+ SENSITIVE = []
501
+ include Aws::Structure
502
+ end
503
+
504
+ # @!attribute [rw] memory_id
505
+ # The identifier of the memory store from which to delete the memory
506
+ # record.
507
+ # @return [String]
508
+ #
509
+ # @!attribute [rw] memory_record_id
510
+ # The identifier of the memory record to delete.
511
+ # @return [String]
512
+ #
513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/DeleteMemoryRecordInput AWS API Documentation
514
+ #
515
+ class DeleteMemoryRecordInput < Struct.new(
516
+ :memory_id,
517
+ :memory_record_id)
518
+ SENSITIVE = []
519
+ include Aws::Structure
520
+ end
521
+
522
+ # @!attribute [rw] memory_record_id
523
+ # The identifier of the memory record that was deleted.
524
+ # @return [String]
525
+ #
526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/DeleteMemoryRecordOutput AWS API Documentation
527
+ #
528
+ class DeleteMemoryRecordOutput < Struct.new(
529
+ :memory_record_id)
530
+ SENSITIVE = []
531
+ include Aws::Structure
532
+ end
533
+
534
+ # Contains information about an event in a memory store.
535
+ #
536
+ # @!attribute [rw] memory_id
537
+ # The identifier of the memory store containing the event.
538
+ # @return [String]
539
+ #
540
+ # @!attribute [rw] actor_id
541
+ # The identifier of the actor associated with the event.
542
+ # @return [String]
543
+ #
544
+ # @!attribute [rw] session_id
545
+ # The identifier of the session containing the event.
546
+ # @return [String]
547
+ #
548
+ # @!attribute [rw] event_id
549
+ # The unique identifier of the event.
550
+ # @return [String]
551
+ #
552
+ # @!attribute [rw] event_timestamp
553
+ # The timestamp when the event occurred.
554
+ # @return [Time]
555
+ #
556
+ # @!attribute [rw] payload
557
+ # The content payload of the event.
558
+ # @return [Array<Types::PayloadType>]
559
+ #
560
+ # @!attribute [rw] branch
561
+ # The branch information for the event.
562
+ # @return [Types::Branch]
563
+ #
564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/Event AWS API Documentation
565
+ #
566
+ class Event < Struct.new(
567
+ :memory_id,
568
+ :actor_id,
569
+ :session_id,
570
+ :event_id,
571
+ :event_timestamp,
572
+ :payload,
573
+ :branch)
574
+ SENSITIVE = []
575
+ include Aws::Structure
576
+ end
577
+
578
+ # Contains filter criteria for listing events.
579
+ #
580
+ # @!attribute [rw] branch
581
+ # The branch filter criteria to apply when listing events.
582
+ # @return [Types::BranchFilter]
583
+ #
584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/FilterInput AWS API Documentation
585
+ #
586
+ class FilterInput < Struct.new(
587
+ :branch)
588
+ SENSITIVE = []
589
+ include Aws::Structure
590
+ end
591
+
592
+ # @!attribute [rw] browser_identifier
593
+ # The unique identifier of the browser associated with the session.
594
+ # @return [String]
595
+ #
596
+ # @!attribute [rw] session_id
597
+ # The unique identifier of the browser session to retrieve.
598
+ # @return [String]
599
+ #
600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetBrowserSessionRequest AWS API Documentation
601
+ #
602
+ class GetBrowserSessionRequest < Struct.new(
603
+ :browser_identifier,
604
+ :session_id)
605
+ SENSITIVE = []
606
+ include Aws::Structure
607
+ end
608
+
609
+ # @!attribute [rw] browser_identifier
610
+ # The identifier of the browser.
611
+ # @return [String]
612
+ #
613
+ # @!attribute [rw] session_id
614
+ # The identifier of the browser session.
615
+ # @return [String]
616
+ #
617
+ # @!attribute [rw] name
618
+ # The name of the browser session.
619
+ # @return [String]
620
+ #
621
+ # @!attribute [rw] created_at
622
+ # The time at which the browser session was created.
623
+ # @return [Time]
624
+ #
625
+ # @!attribute [rw] view_port
626
+ # The configuration that defines the dimensions of a browser viewport
627
+ # in a browser session. The viewport determines the visible area of
628
+ # web content and affects how web pages are rendered and displayed.
629
+ # Proper viewport configuration ensures that web content is displayed
630
+ # correctly for the agent's browsing tasks.
631
+ # @return [Types::ViewPort]
632
+ #
633
+ # @!attribute [rw] session_timeout_seconds
634
+ # The timeout period for the browser session in seconds.
635
+ # @return [Integer]
636
+ #
637
+ # @!attribute [rw] status
638
+ # The current status of the browser session. Possible values include
639
+ # ACTIVE, STOPPING, and STOPPED.
640
+ # @return [String]
641
+ #
642
+ # @!attribute [rw] streams
643
+ # The streams associated with this browser session. These include the
644
+ # automation stream and live view stream.
645
+ # @return [Types::BrowserSessionStream]
646
+ #
647
+ # @!attribute [rw] session_replay_artifact
648
+ # The artifact containing the session replay information.
649
+ # @return [String]
650
+ #
651
+ # @!attribute [rw] last_updated_at
652
+ # The time at which the browser session was last updated.
653
+ # @return [Time]
654
+ #
655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetBrowserSessionResponse AWS API Documentation
656
+ #
657
+ class GetBrowserSessionResponse < Struct.new(
658
+ :browser_identifier,
659
+ :session_id,
660
+ :name,
661
+ :created_at,
662
+ :view_port,
663
+ :session_timeout_seconds,
664
+ :status,
665
+ :streams,
666
+ :session_replay_artifact,
667
+ :last_updated_at)
668
+ SENSITIVE = []
669
+ include Aws::Structure
670
+ end
671
+
672
+ # @!attribute [rw] code_interpreter_identifier
673
+ # The unique identifier of the code interpreter associated with the
674
+ # session.
675
+ # @return [String]
676
+ #
677
+ # @!attribute [rw] session_id
678
+ # The unique identifier of the code interpreter session to retrieve.
679
+ # @return [String]
680
+ #
681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetCodeInterpreterSessionRequest AWS API Documentation
682
+ #
683
+ class GetCodeInterpreterSessionRequest < Struct.new(
684
+ :code_interpreter_identifier,
685
+ :session_id)
686
+ SENSITIVE = []
687
+ include Aws::Structure
688
+ end
689
+
690
+ # @!attribute [rw] code_interpreter_identifier
691
+ # The identifier of the code interpreter.
692
+ # @return [String]
693
+ #
694
+ # @!attribute [rw] session_id
695
+ # The identifier of the code interpreter session.
696
+ # @return [String]
697
+ #
698
+ # @!attribute [rw] name
699
+ # The name of the code interpreter session.
700
+ # @return [String]
701
+ #
702
+ # @!attribute [rw] created_at
703
+ # The time at which the code interpreter session was created.
704
+ # @return [Time]
705
+ #
706
+ # @!attribute [rw] session_timeout_seconds
707
+ # The timeout period for the code interpreter session in seconds.
708
+ # @return [Integer]
709
+ #
710
+ # @!attribute [rw] status
711
+ # The current status of the code interpreter session. Possible values
712
+ # include ACTIVE, STOPPING, and STOPPED.
713
+ # @return [String]
714
+ #
715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetCodeInterpreterSessionResponse AWS API Documentation
716
+ #
717
+ class GetCodeInterpreterSessionResponse < Struct.new(
718
+ :code_interpreter_identifier,
719
+ :session_id,
720
+ :name,
721
+ :created_at,
722
+ :session_timeout_seconds,
723
+ :status)
724
+ SENSITIVE = []
725
+ include Aws::Structure
726
+ end
727
+
728
+ # @!attribute [rw] memory_id
729
+ # The identifier of the memory store containing the event.
730
+ # @return [String]
731
+ #
732
+ # @!attribute [rw] session_id
733
+ # The identifier of the session containing the event.
734
+ # @return [String]
735
+ #
736
+ # @!attribute [rw] actor_id
737
+ # The identifier of the actor associated with the event.
738
+ # @return [String]
739
+ #
740
+ # @!attribute [rw] event_id
741
+ # The identifier of the event to retrieve.
742
+ # @return [String]
743
+ #
744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetEventInput AWS API Documentation
745
+ #
746
+ class GetEventInput < Struct.new(
747
+ :memory_id,
748
+ :session_id,
749
+ :actor_id,
750
+ :event_id)
751
+ SENSITIVE = []
752
+ include Aws::Structure
753
+ end
754
+
755
+ # @!attribute [rw] event
756
+ # The requested event information.
757
+ # @return [Types::Event]
758
+ #
759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetEventOutput AWS API Documentation
760
+ #
761
+ class GetEventOutput < Struct.new(
762
+ :event)
763
+ SENSITIVE = []
764
+ include Aws::Structure
765
+ end
766
+
767
+ # @!attribute [rw] memory_id
768
+ # The identifier of the memory store containing the memory record.
769
+ # @return [String]
770
+ #
771
+ # @!attribute [rw] memory_record_id
772
+ # The identifier of the memory record to retrieve.
773
+ # @return [String]
774
+ #
775
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetMemoryRecordInput AWS API Documentation
776
+ #
777
+ class GetMemoryRecordInput < Struct.new(
778
+ :memory_id,
779
+ :memory_record_id)
780
+ SENSITIVE = []
781
+ include Aws::Structure
782
+ end
783
+
784
+ # @!attribute [rw] memory_record
785
+ # The requested memory record.
786
+ # @return [Types::MemoryRecord]
787
+ #
788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetMemoryRecordOutput AWS API Documentation
789
+ #
790
+ class GetMemoryRecordOutput < Struct.new(
791
+ :memory_record)
792
+ SENSITIVE = []
793
+ include Aws::Structure
794
+ end
795
+
796
+ # @!attribute [rw] workload_identity_token
797
+ # The identity token of the workload you want to get the API Key of.
798
+ # @return [String]
799
+ #
800
+ # @!attribute [rw] resource_credential_provider_name
801
+ # The credential provider name of the resource you are retrieving the
802
+ # API Key of.
803
+ # @return [String]
804
+ #
805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetResourceApiKeyRequest AWS API Documentation
806
+ #
807
+ class GetResourceApiKeyRequest < Struct.new(
808
+ :workload_identity_token,
809
+ :resource_credential_provider_name)
810
+ SENSITIVE = [:workload_identity_token]
811
+ include Aws::Structure
812
+ end
813
+
814
+ # @!attribute [rw] api_key
815
+ # The API Key associated with the resource requested.
816
+ # @return [String]
817
+ #
818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetResourceApiKeyResponse AWS API Documentation
819
+ #
820
+ class GetResourceApiKeyResponse < Struct.new(
821
+ :api_key)
822
+ SENSITIVE = [:api_key]
823
+ include Aws::Structure
824
+ end
825
+
826
+ # @!attribute [rw] workload_identity_token
827
+ # The identity token of the workload you want to retrive the Oauth2
828
+ # Token of.
829
+ # @return [String]
830
+ #
831
+ # @!attribute [rw] user_id
832
+ # The user ID of the user you're retrieving the token on behalf of.
833
+ # @return [String]
834
+ #
835
+ # @!attribute [rw] resource_credential_provider_name
836
+ # Reference to the credential provider
837
+ # @return [String]
838
+ #
839
+ # @!attribute [rw] scopes
840
+ # The OAuth scopes requested
841
+ # @return [Array<String>]
842
+ #
843
+ # @!attribute [rw] oauth2_flow
844
+ # The type of flow to be performed
845
+ # @return [String]
846
+ #
847
+ # @!attribute [rw] resource_oauth_2_return_url
848
+ # Callback url to redirect after token retrieval completes. Should be
849
+ # one of the provideded urls during WorkloadIdentity creation
850
+ # @return [String]
851
+ #
852
+ # @!attribute [rw] force_authentication
853
+ # If true, always initiate a new 3LO flow
854
+ # @return [Boolean]
855
+ #
856
+ # @!attribute [rw] custom_parameters
857
+ # Gives the ability to send extra/custom parameters to the resource
858
+ # credentials provider during the authorization process. Standard
859
+ # OAuth2 flow parameters will not be overriden.
860
+ # @return [Hash<String,String>]
861
+ #
862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetResourceOauth2TokenRequest AWS API Documentation
863
+ #
864
+ class GetResourceOauth2TokenRequest < Struct.new(
865
+ :workload_identity_token,
866
+ :user_id,
867
+ :resource_credential_provider_name,
868
+ :scopes,
869
+ :oauth2_flow,
870
+ :resource_oauth_2_return_url,
871
+ :force_authentication,
872
+ :custom_parameters)
873
+ SENSITIVE = [:workload_identity_token, :custom_parameters]
874
+ include Aws::Structure
875
+ end
876
+
877
+ # @!attribute [rw] authorization_url
878
+ # The URL for the authorization process, provided if the Access token
879
+ # requires user Authorization.
880
+ # @return [String]
881
+ #
882
+ # @!attribute [rw] access_token
883
+ # OAuth2 token ready for use
884
+ # @return [String]
885
+ #
886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetResourceOauth2TokenResponse AWS API Documentation
887
+ #
888
+ class GetResourceOauth2TokenResponse < Struct.new(
889
+ :authorization_url,
890
+ :access_token)
891
+ SENSITIVE = [:access_token]
892
+ include Aws::Structure
893
+ end
894
+
895
+ # @!attribute [rw] workload_name
896
+ # Unique identifier for the registered agent
897
+ # @return [String]
898
+ #
899
+ # @!attribute [rw] user_token
900
+ # OAuth2 token issued by the user's identity provider
901
+ # @return [String]
902
+ #
903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetWorkloadAccessTokenForJWTRequest AWS API Documentation
904
+ #
905
+ class GetWorkloadAccessTokenForJWTRequest < Struct.new(
906
+ :workload_name,
907
+ :user_token)
908
+ SENSITIVE = [:user_token]
909
+ include Aws::Structure
910
+ end
911
+
912
+ # @!attribute [rw] workload_access_token
913
+ # Opaque token representing both agent and user identity
914
+ # @return [String]
915
+ #
916
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetWorkloadAccessTokenForJWTResponse AWS API Documentation
917
+ #
918
+ class GetWorkloadAccessTokenForJWTResponse < Struct.new(
919
+ :workload_access_token)
920
+ SENSITIVE = [:workload_access_token]
921
+ include Aws::Structure
922
+ end
923
+
924
+ # @!attribute [rw] workload_name
925
+ # The name of the worklaod you want to get the access token of.
926
+ # @return [String]
927
+ #
928
+ # @!attribute [rw] user_id
929
+ # The user id of the user you are retrieving the access token for.
930
+ # @return [String]
931
+ #
932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetWorkloadAccessTokenForUserIdRequest AWS API Documentation
933
+ #
934
+ class GetWorkloadAccessTokenForUserIdRequest < Struct.new(
935
+ :workload_name,
936
+ :user_id)
937
+ SENSITIVE = []
938
+ include Aws::Structure
939
+ end
940
+
941
+ # @!attribute [rw] workload_access_token
942
+ # The workload access token of the named workload.
943
+ # @return [String]
944
+ #
945
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetWorkloadAccessTokenForUserIdResponse AWS API Documentation
946
+ #
947
+ class GetWorkloadAccessTokenForUserIdResponse < Struct.new(
948
+ :workload_access_token)
949
+ SENSITIVE = [:workload_access_token]
950
+ include Aws::Structure
951
+ end
952
+
953
+ # @!attribute [rw] workload_name
954
+ # Unique identifier for the registered agent
955
+ # @return [String]
956
+ #
957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetWorkloadAccessTokenRequest AWS API Documentation
958
+ #
959
+ class GetWorkloadAccessTokenRequest < Struct.new(
960
+ :workload_name)
961
+ SENSITIVE = []
962
+ include Aws::Structure
963
+ end
964
+
965
+ # @!attribute [rw] workload_access_token
966
+ # Opaque token representing both agent and user identity
967
+ # @return [String]
968
+ #
969
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetWorkloadAccessTokenResponse AWS API Documentation
970
+ #
971
+ class GetWorkloadAccessTokenResponse < Struct.new(
972
+ :workload_access_token)
973
+ SENSITIVE = [:workload_access_token]
974
+ include Aws::Structure
975
+ end
976
+
977
+ # A block of input content.
978
+ #
979
+ # @!attribute [rw] path
980
+ # The path to the input content.
981
+ # @return [String]
982
+ #
983
+ # @!attribute [rw] text
984
+ # The text input content.
985
+ # @return [String]
986
+ #
987
+ # @!attribute [rw] blob
988
+ # The binary input content.
989
+ # @return [String]
990
+ #
991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/InputContentBlock AWS API Documentation
992
+ #
993
+ class InputContentBlock < Struct.new(
994
+ :path,
995
+ :text,
996
+ :blob)
997
+ SENSITIVE = [:blob]
998
+ include Aws::Structure
999
+ end
1000
+
1001
+ # The exception that occurs when the service encounters an unexpected
1002
+ # internal error. This is a temporary condition that will resolve itself
1003
+ # with retries. We recommend implementing exponential backoff retry
1004
+ # logic in your application.
1005
+ #
1006
+ # @!attribute [rw] message
1007
+ # @return [String]
1008
+ #
1009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/InternalServerException AWS API Documentation
1010
+ #
1011
+ class InternalServerException < Struct.new(
1012
+ :message,
1013
+ :event_type)
1014
+ SENSITIVE = []
1015
+ include Aws::Structure
1016
+ end
1017
+
1018
+ # The input fails to satisfy the constraints specified by AgentCore.
1019
+ # Check your input values and try again.
1020
+ #
1021
+ # @!attribute [rw] message
1022
+ # @return [String]
1023
+ #
1024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/InvalidInputException AWS API Documentation
1025
+ #
1026
+ class InvalidInputException < Struct.new(
1027
+ :message)
1028
+ SENSITIVE = []
1029
+ include Aws::Structure
1030
+ end
1031
+
1032
+ # @!attribute [rw] content_type
1033
+ # The MIME type of the input data in the payload. This tells the agent
1034
+ # runtime how to interpret the payload data. Common values include
1035
+ # application/json for JSON data.
1036
+ # @return [String]
1037
+ #
1038
+ # @!attribute [rw] accept
1039
+ # The desired MIME type for the response from the agent runtime. This
1040
+ # tells the agent runtime what format to use for the response data.
1041
+ # Common values include application/json for JSON data.
1042
+ # @return [String]
1043
+ #
1044
+ # @!attribute [rw] mcp_session_id
1045
+ # The identifier of the MCP session.
1046
+ # @return [String]
1047
+ #
1048
+ # @!attribute [rw] runtime_session_id
1049
+ # The identifier of the runtime session.
1050
+ #
1051
+ # **A suitable default value is auto-generated.** You should normally
1052
+ # not need to pass this option.
1053
+ # @return [String]
1054
+ #
1055
+ # @!attribute [rw] mcp_protocol_version
1056
+ # The version of the MCP protocol being used.
1057
+ # @return [String]
1058
+ #
1059
+ # @!attribute [rw] runtime_user_id
1060
+ # The identifier of the runtime user.
1061
+ # @return [String]
1062
+ #
1063
+ # @!attribute [rw] trace_id
1064
+ # The trace identifier for request tracking.
1065
+ # @return [String]
1066
+ #
1067
+ # @!attribute [rw] trace_parent
1068
+ # The parent trace information for distributed tracing.
1069
+ # @return [String]
1070
+ #
1071
+ # @!attribute [rw] trace_state
1072
+ # The trace state information for distributed tracing.
1073
+ # @return [String]
1074
+ #
1075
+ # @!attribute [rw] baggage
1076
+ # Additional context information for distributed tracing.
1077
+ # @return [String]
1078
+ #
1079
+ # @!attribute [rw] agent_runtime_arn
1080
+ # The Amazon Web Services Resource Name (ARN) of the agent runtime to
1081
+ # invoke. The ARN uniquely identifies the agent runtime resource in
1082
+ # Amazon Bedrock.
1083
+ # @return [String]
1084
+ #
1085
+ # @!attribute [rw] qualifier
1086
+ # The qualifier to use for the agent runtime. This can be a version
1087
+ # number or an alias name that points to a specific version. If not
1088
+ # specified, Amazon Bedrock uses the default version of the agent
1089
+ # runtime.
1090
+ # @return [String]
1091
+ #
1092
+ # @!attribute [rw] payload
1093
+ # The input data to send to the agent runtime. The format of this data
1094
+ # depends on the specific agent configuration and must match the
1095
+ # specified content type. For most agents, this is a JSON object
1096
+ # containing the user's request.
1097
+ # @return [String]
1098
+ #
1099
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/InvokeAgentRuntimeRequest AWS API Documentation
1100
+ #
1101
+ class InvokeAgentRuntimeRequest < Struct.new(
1102
+ :content_type,
1103
+ :accept,
1104
+ :mcp_session_id,
1105
+ :runtime_session_id,
1106
+ :mcp_protocol_version,
1107
+ :runtime_user_id,
1108
+ :trace_id,
1109
+ :trace_parent,
1110
+ :trace_state,
1111
+ :baggage,
1112
+ :agent_runtime_arn,
1113
+ :qualifier,
1114
+ :payload)
1115
+ SENSITIVE = [:payload]
1116
+ include Aws::Structure
1117
+ end
1118
+
1119
+ # @!attribute [rw] runtime_session_id
1120
+ # The identifier of the runtime session.
1121
+ # @return [String]
1122
+ #
1123
+ # @!attribute [rw] mcp_session_id
1124
+ # The identifier of the MCP session.
1125
+ # @return [String]
1126
+ #
1127
+ # @!attribute [rw] mcp_protocol_version
1128
+ # The version of the MCP protocol being used.
1129
+ # @return [String]
1130
+ #
1131
+ # @!attribute [rw] trace_id
1132
+ # The trace identifier for request tracking.
1133
+ # @return [String]
1134
+ #
1135
+ # @!attribute [rw] trace_parent
1136
+ # The parent trace information for distributed tracing.
1137
+ # @return [String]
1138
+ #
1139
+ # @!attribute [rw] trace_state
1140
+ # The trace state information for distributed tracing.
1141
+ # @return [String]
1142
+ #
1143
+ # @!attribute [rw] baggage
1144
+ # Additional context information for distributed tracing.
1145
+ # @return [String]
1146
+ #
1147
+ # @!attribute [rw] content_type
1148
+ # The MIME type of the response data. This indicates how to interpret
1149
+ # the response data. Common values include application/json for JSON
1150
+ # data.
1151
+ # @return [String]
1152
+ #
1153
+ # @!attribute [rw] response
1154
+ # The response data from the agent runtime. The format of this data
1155
+ # depends on the specific agent configuration and the requested accept
1156
+ # type. For most agents, this is a JSON object containing the agent's
1157
+ # response to the user's request.
1158
+ # @return [IO]
1159
+ #
1160
+ # @!attribute [rw] status_code
1161
+ # The HTTP status code of the response. A status code of 200 indicates
1162
+ # a successful operation. Other status codes indicate various error
1163
+ # conditions.
1164
+ # @return [Integer]
1165
+ #
1166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/InvokeAgentRuntimeResponse AWS API Documentation
1167
+ #
1168
+ class InvokeAgentRuntimeResponse < Struct.new(
1169
+ :runtime_session_id,
1170
+ :mcp_session_id,
1171
+ :mcp_protocol_version,
1172
+ :trace_id,
1173
+ :trace_parent,
1174
+ :trace_state,
1175
+ :baggage,
1176
+ :content_type,
1177
+ :response,
1178
+ :status_code)
1179
+ SENSITIVE = [:response]
1180
+ include Aws::Structure
1181
+ end
1182
+
1183
+ # @!attribute [rw] code_interpreter_identifier
1184
+ # The unique identifier of the code interpreter associated with the
1185
+ # session. This must match the identifier used when creating the
1186
+ # session with `StartCodeInterpreterSession`.
1187
+ # @return [String]
1188
+ #
1189
+ # @!attribute [rw] session_id
1190
+ # The unique identifier of the code interpreter session to use. This
1191
+ # must be an active session created with
1192
+ # `StartCodeInterpreterSession`. If the session has expired or been
1193
+ # stopped, the request will fail.
1194
+ # @return [String]
1195
+ #
1196
+ # @!attribute [rw] name
1197
+ # The name of the code interpreter to invoke.
1198
+ # @return [String]
1199
+ #
1200
+ # @!attribute [rw] arguments
1201
+ # The arguments for the code interpreter. This includes the code to
1202
+ # execute and any additional parameters such as the programming
1203
+ # language, whether to clear the execution context, and other
1204
+ # execution options. The structure of this parameter depends on the
1205
+ # specific code interpreter being used.
1206
+ # @return [Types::ToolArguments]
1207
+ #
1208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/InvokeCodeInterpreterRequest AWS API Documentation
1209
+ #
1210
+ class InvokeCodeInterpreterRequest < Struct.new(
1211
+ :code_interpreter_identifier,
1212
+ :session_id,
1213
+ :name,
1214
+ :arguments)
1215
+ SENSITIVE = []
1216
+ include Aws::Structure
1217
+ end
1218
+
1219
+ # @!attribute [rw] session_id
1220
+ # The identifier of the code interpreter session.
1221
+ # @return [String]
1222
+ #
1223
+ # @!attribute [rw] stream
1224
+ # The stream containing the results of the code execution. This
1225
+ # includes output, errors, and execution status.
1226
+ # @return [Types::CodeInterpreterStreamOutput]
1227
+ #
1228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/InvokeCodeInterpreterResponse AWS API Documentation
1229
+ #
1230
+ class InvokeCodeInterpreterResponse < Struct.new(
1231
+ :session_id,
1232
+ :stream)
1233
+ SENSITIVE = []
1234
+ include Aws::Structure
1235
+ end
1236
+
1237
+ # @!attribute [rw] memory_id
1238
+ # The identifier of the memory store for which to list actors.
1239
+ # @return [String]
1240
+ #
1241
+ # @!attribute [rw] max_results
1242
+ # The maximum number of results to return in a single call. Minimum
1243
+ # value of 1, maximum value of 100. Default is 20.
1244
+ # @return [Integer]
1245
+ #
1246
+ # @!attribute [rw] next_token
1247
+ # The token for the next set of results. Use the value returned in the
1248
+ # previous response in the next request to retrieve the next set of
1249
+ # results.
1250
+ # @return [String]
1251
+ #
1252
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListActorsInput AWS API Documentation
1253
+ #
1254
+ class ListActorsInput < Struct.new(
1255
+ :memory_id,
1256
+ :max_results,
1257
+ :next_token)
1258
+ SENSITIVE = []
1259
+ include Aws::Structure
1260
+ end
1261
+
1262
+ # @!attribute [rw] actor_summaries
1263
+ # The list of actor summaries.
1264
+ # @return [Array<Types::ActorSummary>]
1265
+ #
1266
+ # @!attribute [rw] next_token
1267
+ # The token to use in a subsequent request to get the next set of
1268
+ # results. This value is null when there are no more results to
1269
+ # return.
1270
+ # @return [String]
1271
+ #
1272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListActorsOutput AWS API Documentation
1273
+ #
1274
+ class ListActorsOutput < Struct.new(
1275
+ :actor_summaries,
1276
+ :next_token)
1277
+ SENSITIVE = []
1278
+ include Aws::Structure
1279
+ end
1280
+
1281
+ # @!attribute [rw] browser_identifier
1282
+ # The unique identifier of the browser to list sessions for. If
1283
+ # specified, only sessions for this browser are returned. If not
1284
+ # specified, sessions for all browsers are returned.
1285
+ # @return [String]
1286
+ #
1287
+ # @!attribute [rw] max_results
1288
+ # The maximum number of results to return in a single call. The
1289
+ # default value is 10. Valid values range from 1 to 100. To retrieve
1290
+ # the remaining results, make another call with the returned
1291
+ # `nextToken` value.
1292
+ # @return [Integer]
1293
+ #
1294
+ # @!attribute [rw] next_token
1295
+ # The token for the next set of results. Use the value returned in the
1296
+ # previous response in the next request to retrieve the next set of
1297
+ # results. If not specified, Amazon Bedrock returns the first page of
1298
+ # results.
1299
+ # @return [String]
1300
+ #
1301
+ # @!attribute [rw] status
1302
+ # The status of the browser sessions to list. Valid values include
1303
+ # ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any
1304
+ # status are returned.
1305
+ # @return [String]
1306
+ #
1307
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListBrowserSessionsRequest AWS API Documentation
1308
+ #
1309
+ class ListBrowserSessionsRequest < Struct.new(
1310
+ :browser_identifier,
1311
+ :max_results,
1312
+ :next_token,
1313
+ :status)
1314
+ SENSITIVE = []
1315
+ include Aws::Structure
1316
+ end
1317
+
1318
+ # @!attribute [rw] items
1319
+ # The list of browser sessions that match the specified criteria.
1320
+ # @return [Array<Types::BrowserSessionSummary>]
1321
+ #
1322
+ # @!attribute [rw] next_token
1323
+ # The token to use in a subsequent `ListBrowserSessions` request to
1324
+ # get the next set of results.
1325
+ # @return [String]
1326
+ #
1327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListBrowserSessionsResponse AWS API Documentation
1328
+ #
1329
+ class ListBrowserSessionsResponse < Struct.new(
1330
+ :items,
1331
+ :next_token)
1332
+ SENSITIVE = []
1333
+ include Aws::Structure
1334
+ end
1335
+
1336
+ # @!attribute [rw] code_interpreter_identifier
1337
+ # The unique identifier of the code interpreter to list sessions for.
1338
+ # If specified, only sessions for this code interpreter are returned.
1339
+ # If not specified, sessions for all code interpreters are returned.
1340
+ # @return [String]
1341
+ #
1342
+ # @!attribute [rw] max_results
1343
+ # The maximum number of results to return in a single call. The
1344
+ # default value is 10. Valid values range from 1 to 100. To retrieve
1345
+ # the remaining results, make another call with the returned
1346
+ # `nextToken` value.
1347
+ # @return [Integer]
1348
+ #
1349
+ # @!attribute [rw] next_token
1350
+ # The token for the next set of results. Use the value returned in the
1351
+ # previous response in the next request to retrieve the next set of
1352
+ # results. If not specified, Amazon Bedrock returns the first page of
1353
+ # results.
1354
+ # @return [String]
1355
+ #
1356
+ # @!attribute [rw] status
1357
+ # The status of the code interpreter sessions to list. Valid values
1358
+ # include ACTIVE, STOPPING, and STOPPED. If not specified, sessions
1359
+ # with any status are returned.
1360
+ # @return [String]
1361
+ #
1362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListCodeInterpreterSessionsRequest AWS API Documentation
1363
+ #
1364
+ class ListCodeInterpreterSessionsRequest < Struct.new(
1365
+ :code_interpreter_identifier,
1366
+ :max_results,
1367
+ :next_token,
1368
+ :status)
1369
+ SENSITIVE = []
1370
+ include Aws::Structure
1371
+ end
1372
+
1373
+ # @!attribute [rw] items
1374
+ # The list of code interpreter sessions that match the specified
1375
+ # criteria.
1376
+ # @return [Array<Types::CodeInterpreterSessionSummary>]
1377
+ #
1378
+ # @!attribute [rw] next_token
1379
+ # The token to use in a subsequent `ListCodeInterpreterSessions`
1380
+ # request to get the next set of results.
1381
+ # @return [String]
1382
+ #
1383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListCodeInterpreterSessionsResponse AWS API Documentation
1384
+ #
1385
+ class ListCodeInterpreterSessionsResponse < Struct.new(
1386
+ :items,
1387
+ :next_token)
1388
+ SENSITIVE = []
1389
+ include Aws::Structure
1390
+ end
1391
+
1392
+ # @!attribute [rw] memory_id
1393
+ # The identifier of the memory store for which to list events.
1394
+ # @return [String]
1395
+ #
1396
+ # @!attribute [rw] session_id
1397
+ # The identifier of the session for which to list events. If
1398
+ # specified, only events from this session are returned.
1399
+ # @return [String]
1400
+ #
1401
+ # @!attribute [rw] actor_id
1402
+ # The identifier of the actor for which to list events. If specified,
1403
+ # only events from this actor are returned.
1404
+ # @return [String]
1405
+ #
1406
+ # @!attribute [rw] include_payloads
1407
+ # Specifies whether to include event payloads in the response. Set to
1408
+ # true to include payloads, or false to exclude them.
1409
+ # @return [Boolean]
1410
+ #
1411
+ # @!attribute [rw] filter
1412
+ # Filter criteria to apply when listing events.
1413
+ # @return [Types::FilterInput]
1414
+ #
1415
+ # @!attribute [rw] max_results
1416
+ # The maximum number of results to return in a single call. Minimum
1417
+ # value of 1, maximum value of 100. Default is 20.
1418
+ # @return [Integer]
1419
+ #
1420
+ # @!attribute [rw] next_token
1421
+ # The token for the next set of results. Use the value returned in the
1422
+ # previous response in the next request to retrieve the next set of
1423
+ # results.
1424
+ # @return [String]
1425
+ #
1426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListEventsInput AWS API Documentation
1427
+ #
1428
+ class ListEventsInput < Struct.new(
1429
+ :memory_id,
1430
+ :session_id,
1431
+ :actor_id,
1432
+ :include_payloads,
1433
+ :filter,
1434
+ :max_results,
1435
+ :next_token)
1436
+ SENSITIVE = []
1437
+ include Aws::Structure
1438
+ end
1439
+
1440
+ # @!attribute [rw] events
1441
+ # The list of events that match the specified criteria.
1442
+ # @return [Array<Types::Event>]
1443
+ #
1444
+ # @!attribute [rw] next_token
1445
+ # The token to use in a subsequent request to get the next set of
1446
+ # results. This value is null when there are no more results to
1447
+ # return.
1448
+ # @return [String]
1449
+ #
1450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListEventsOutput AWS API Documentation
1451
+ #
1452
+ class ListEventsOutput < Struct.new(
1453
+ :events,
1454
+ :next_token)
1455
+ SENSITIVE = []
1456
+ include Aws::Structure
1457
+ end
1458
+
1459
+ # @!attribute [rw] memory_id
1460
+ # The identifier of the memory store for which to list memory records.
1461
+ # @return [String]
1462
+ #
1463
+ # @!attribute [rw] namespace
1464
+ # The namespace to filter memory records by. If specified, only memory
1465
+ # records in this namespace are returned.
1466
+ # @return [String]
1467
+ #
1468
+ # @!attribute [rw] memory_strategy_id
1469
+ # The memory strategy identifier to filter memory records by. If
1470
+ # specified, only memory records with this strategy ID are returned.
1471
+ # @return [String]
1472
+ #
1473
+ # @!attribute [rw] max_results
1474
+ # The maximum number of results to return in a single call. Minimum
1475
+ # value of 1, maximum value of 100. Default is 20.
1476
+ # @return [Integer]
1477
+ #
1478
+ # @!attribute [rw] next_token
1479
+ # The token for the next set of results. Use the value returned in the
1480
+ # previous response in the next request to retrieve the next set of
1481
+ # results.
1482
+ # @return [String]
1483
+ #
1484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListMemoryRecordsInput AWS API Documentation
1485
+ #
1486
+ class ListMemoryRecordsInput < Struct.new(
1487
+ :memory_id,
1488
+ :namespace,
1489
+ :memory_strategy_id,
1490
+ :max_results,
1491
+ :next_token)
1492
+ SENSITIVE = []
1493
+ include Aws::Structure
1494
+ end
1495
+
1496
+ # @!attribute [rw] memory_record_summaries
1497
+ # The list of memory record summaries that match the specified
1498
+ # criteria.
1499
+ # @return [Array<Types::MemoryRecordSummary>]
1500
+ #
1501
+ # @!attribute [rw] next_token
1502
+ # The token to use in a subsequent request to get the next set of
1503
+ # results. This value is null when there are no more results to
1504
+ # return.
1505
+ # @return [String]
1506
+ #
1507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListMemoryRecordsOutput AWS API Documentation
1508
+ #
1509
+ class ListMemoryRecordsOutput < Struct.new(
1510
+ :memory_record_summaries,
1511
+ :next_token)
1512
+ SENSITIVE = []
1513
+ include Aws::Structure
1514
+ end
1515
+
1516
+ # @!attribute [rw] memory_id
1517
+ # The identifier of the memory store for which to list sessions.
1518
+ # @return [String]
1519
+ #
1520
+ # @!attribute [rw] actor_id
1521
+ # The identifier of the actor for which to list sessions. If
1522
+ # specified, only sessions involving this actor are returned.
1523
+ # @return [String]
1524
+ #
1525
+ # @!attribute [rw] max_results
1526
+ # The maximum number of results to return in a single call. Minimum
1527
+ # value of 1, maximum value of 100. Default is 20.
1528
+ # @return [Integer]
1529
+ #
1530
+ # @!attribute [rw] next_token
1531
+ # The token for the next set of results. Use the value returned in the
1532
+ # previous response in the next request to retrieve the next set of
1533
+ # results.
1534
+ # @return [String]
1535
+ #
1536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListSessionsInput AWS API Documentation
1537
+ #
1538
+ class ListSessionsInput < Struct.new(
1539
+ :memory_id,
1540
+ :actor_id,
1541
+ :max_results,
1542
+ :next_token)
1543
+ SENSITIVE = []
1544
+ include Aws::Structure
1545
+ end
1546
+
1547
+ # @!attribute [rw] session_summaries
1548
+ # The list of session summaries that match the specified criteria.
1549
+ # @return [Array<Types::SessionSummary>]
1550
+ #
1551
+ # @!attribute [rw] next_token
1552
+ # The token to use in a subsequent request to get the next set of
1553
+ # results. This value is null when there are no more results to
1554
+ # return.
1555
+ # @return [String]
1556
+ #
1557
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListSessionsOutput AWS API Documentation
1558
+ #
1559
+ class ListSessionsOutput < Struct.new(
1560
+ :session_summaries,
1561
+ :next_token)
1562
+ SENSITIVE = []
1563
+ include Aws::Structure
1564
+ end
1565
+
1566
+ # The configuration for a stream that provides a visual representation
1567
+ # of a browser session in Amazon Bedrock. This stream enables agents to
1568
+ # observe the current state of the browser, including rendered web
1569
+ # pages, visual elements, and the results of interactions.
1570
+ #
1571
+ # @!attribute [rw] stream_endpoint
1572
+ # The endpoint URL for the live view stream. This URL is used to
1573
+ # establish a connection to receive visual updates from the browser
1574
+ # session.
1575
+ # @return [String]
1576
+ #
1577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/LiveViewStream AWS API Documentation
1578
+ #
1579
+ class LiveViewStream < Struct.new(
1580
+ :stream_endpoint)
1581
+ SENSITIVE = []
1582
+ include Aws::Structure
1583
+ end
1584
+
1585
+ # Contains the content of a memory record.
1586
+ #
1587
+ # @note MemoryContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MemoryContent corresponding to the set member.
1588
+ #
1589
+ # @!attribute [rw] text
1590
+ # The text content of the memory record.
1591
+ # @return [String]
1592
+ #
1593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/MemoryContent AWS API Documentation
1594
+ #
1595
+ class MemoryContent < Struct.new(
1596
+ :text,
1597
+ :unknown)
1598
+ SENSITIVE = [:text]
1599
+ include Aws::Structure
1600
+ include Aws::Structure::Union
1601
+
1602
+ class Text < MemoryContent; end
1603
+ class Unknown < MemoryContent; end
1604
+ end
1605
+
1606
+ # Contains information about a memory record in a memory store.
1607
+ #
1608
+ # @!attribute [rw] memory_record_id
1609
+ # The unique identifier of the memory record.
1610
+ # @return [String]
1611
+ #
1612
+ # @!attribute [rw] content
1613
+ # The content of the memory record.
1614
+ # @return [Types::MemoryContent]
1615
+ #
1616
+ # @!attribute [rw] memory_strategy_id
1617
+ # The identifier of the memory strategy associated with this record.
1618
+ # @return [String]
1619
+ #
1620
+ # @!attribute [rw] namespaces
1621
+ # The namespaces associated with this memory record. Namespaces help
1622
+ # organize and categorize memory records.
1623
+ # @return [Array<String>]
1624
+ #
1625
+ # @!attribute [rw] created_at
1626
+ # The timestamp when the memory record was created.
1627
+ # @return [Time]
1628
+ #
1629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/MemoryRecord AWS API Documentation
1630
+ #
1631
+ class MemoryRecord < Struct.new(
1632
+ :memory_record_id,
1633
+ :content,
1634
+ :memory_strategy_id,
1635
+ :namespaces,
1636
+ :created_at)
1637
+ SENSITIVE = []
1638
+ include Aws::Structure
1639
+ end
1640
+
1641
+ # Contains summary information about a memory record.
1642
+ #
1643
+ # @!attribute [rw] memory_record_id
1644
+ # The unique identifier of the memory record.
1645
+ # @return [String]
1646
+ #
1647
+ # @!attribute [rw] content
1648
+ # The content of the memory record.
1649
+ # @return [Types::MemoryContent]
1650
+ #
1651
+ # @!attribute [rw] memory_strategy_id
1652
+ # The identifier of the memory strategy associated with this record.
1653
+ # @return [String]
1654
+ #
1655
+ # @!attribute [rw] namespaces
1656
+ # The namespaces associated with this memory record.
1657
+ # @return [Array<String>]
1658
+ #
1659
+ # @!attribute [rw] created_at
1660
+ # The timestamp when the memory record was created.
1661
+ # @return [Time]
1662
+ #
1663
+ # @!attribute [rw] score
1664
+ # The relevance score of the memory record when returned as part of a
1665
+ # search result. Higher values indicate greater relevance to the
1666
+ # search query.
1667
+ # @return [Float]
1668
+ #
1669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/MemoryRecordSummary AWS API Documentation
1670
+ #
1671
+ class MemoryRecordSummary < Struct.new(
1672
+ :memory_record_id,
1673
+ :content,
1674
+ :memory_strategy_id,
1675
+ :namespaces,
1676
+ :created_at,
1677
+ :score)
1678
+ SENSITIVE = []
1679
+ include Aws::Structure
1680
+ end
1681
+
1682
+ # Contains the payload content for an event.
1683
+ #
1684
+ # @note PayloadType is a union - when making an API calls you must set exactly one of the members.
1685
+ #
1686
+ # @note PayloadType is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PayloadType corresponding to the set member.
1687
+ #
1688
+ # @!attribute [rw] conversational
1689
+ # The conversational content of the payload.
1690
+ # @return [Types::Conversational]
1691
+ #
1692
+ # @!attribute [rw] blob
1693
+ # The binary content of the payload.
1694
+ # @return [Hash,Array,String,Numeric,Boolean]
1695
+ #
1696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/PayloadType AWS API Documentation
1697
+ #
1698
+ class PayloadType < Struct.new(
1699
+ :conversational,
1700
+ :blob,
1701
+ :unknown)
1702
+ SENSITIVE = []
1703
+ include Aws::Structure
1704
+ include Aws::Structure::Union
1705
+
1706
+ class Conversational < PayloadType; end
1707
+ class Blob < PayloadType; end
1708
+ class Unknown < PayloadType; end
1709
+ end
1710
+
1711
+ # Contains information about resource content.
1712
+ #
1713
+ # @!attribute [rw] type
1714
+ # The type of resource content.
1715
+ # @return [String]
1716
+ #
1717
+ # @!attribute [rw] uri
1718
+ # The URI of the resource content.
1719
+ # @return [String]
1720
+ #
1721
+ # @!attribute [rw] mime_type
1722
+ # The MIME type of the resource content.
1723
+ # @return [String]
1724
+ #
1725
+ # @!attribute [rw] text
1726
+ # The text resource content.
1727
+ # @return [String]
1728
+ #
1729
+ # @!attribute [rw] blob
1730
+ # The binary resource content.
1731
+ # @return [String]
1732
+ #
1733
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ResourceContent AWS API Documentation
1734
+ #
1735
+ class ResourceContent < Struct.new(
1736
+ :type,
1737
+ :uri,
1738
+ :mime_type,
1739
+ :text,
1740
+ :blob)
1741
+ SENSITIVE = []
1742
+ include Aws::Structure
1743
+ end
1744
+
1745
+ # The exception that occurs when the specified resource does not exist.
1746
+ # This can happen when using an invalid identifier or when trying to
1747
+ # access a resource that has been deleted.
1748
+ #
1749
+ # @!attribute [rw] message
1750
+ # @return [String]
1751
+ #
1752
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ResourceNotFoundException AWS API Documentation
1753
+ #
1754
+ class ResourceNotFoundException < Struct.new(
1755
+ :message,
1756
+ :event_type)
1757
+ SENSITIVE = []
1758
+ include Aws::Structure
1759
+ end
1760
+
1761
+ # @!attribute [rw] memory_id
1762
+ # The identifier of the memory store from which to retrieve memory
1763
+ # records.
1764
+ # @return [String]
1765
+ #
1766
+ # @!attribute [rw] namespace
1767
+ # The namespace to filter memory records by. If specified, only memory
1768
+ # records in this namespace are searched.
1769
+ # @return [String]
1770
+ #
1771
+ # @!attribute [rw] search_criteria
1772
+ # The search criteria to use for finding relevant memory records. This
1773
+ # includes the search query, memory strategy ID, and other search
1774
+ # parameters.
1775
+ # @return [Types::SearchCriteria]
1776
+ #
1777
+ # @!attribute [rw] next_token
1778
+ # The token for the next set of results. Use the value returned in the
1779
+ # previous response in the next request to retrieve the next set of
1780
+ # results.
1781
+ # @return [String]
1782
+ #
1783
+ # @!attribute [rw] max_results
1784
+ # The maximum number of results to return in a single call. Minimum
1785
+ # value of 1, maximum value of 100. Default is 20.
1786
+ # @return [Integer]
1787
+ #
1788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/RetrieveMemoryRecordsInput AWS API Documentation
1789
+ #
1790
+ class RetrieveMemoryRecordsInput < Struct.new(
1791
+ :memory_id,
1792
+ :namespace,
1793
+ :search_criteria,
1794
+ :next_token,
1795
+ :max_results)
1796
+ SENSITIVE = []
1797
+ include Aws::Structure
1798
+ end
1799
+
1800
+ # @!attribute [rw] memory_record_summaries
1801
+ # The list of memory record summaries that match the search criteria,
1802
+ # ordered by relevance.
1803
+ # @return [Array<Types::MemoryRecordSummary>]
1804
+ #
1805
+ # @!attribute [rw] next_token
1806
+ # The token to use in a subsequent request to get the next set of
1807
+ # results. This value is null when there are no more results to
1808
+ # return.
1809
+ # @return [String]
1810
+ #
1811
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/RetrieveMemoryRecordsOutput AWS API Documentation
1812
+ #
1813
+ class RetrieveMemoryRecordsOutput < Struct.new(
1814
+ :memory_record_summaries,
1815
+ :next_token)
1816
+ SENSITIVE = []
1817
+ include Aws::Structure
1818
+ end
1819
+
1820
+ # The exception that occurs when there is an error in the runtime
1821
+ # client. This can happen due to network issues, invalid configuration,
1822
+ # or other client-side problems. Check the error message for specific
1823
+ # details about the error.
1824
+ #
1825
+ # @!attribute [rw] message
1826
+ # @return [String]
1827
+ #
1828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/RuntimeClientError AWS API Documentation
1829
+ #
1830
+ class RuntimeClientError < Struct.new(
1831
+ :message)
1832
+ SENSITIVE = []
1833
+ include Aws::Structure
1834
+ end
1835
+
1836
+ # Contains search criteria for retrieving memory records.
1837
+ #
1838
+ # @!attribute [rw] search_query
1839
+ # The search query to use for finding relevant memory records.
1840
+ # @return [String]
1841
+ #
1842
+ # @!attribute [rw] memory_strategy_id
1843
+ # The memory strategy identifier to filter memory records by.
1844
+ # @return [String]
1845
+ #
1846
+ # @!attribute [rw] top_k
1847
+ # The maximum number of top-scoring memory records to return. This
1848
+ # value is used for semantic search ranking.
1849
+ # @return [Integer]
1850
+ #
1851
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/SearchCriteria AWS API Documentation
1852
+ #
1853
+ class SearchCriteria < Struct.new(
1854
+ :search_query,
1855
+ :memory_strategy_id,
1856
+ :top_k)
1857
+ SENSITIVE = [:search_query]
1858
+ include Aws::Structure
1859
+ end
1860
+
1861
+ # The service encountered an internal error. Try your request again
1862
+ # later.
1863
+ #
1864
+ # @!attribute [rw] message
1865
+ # @return [String]
1866
+ #
1867
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ServiceException AWS API Documentation
1868
+ #
1869
+ class ServiceException < Struct.new(
1870
+ :message)
1871
+ SENSITIVE = []
1872
+ include Aws::Structure
1873
+ end
1874
+
1875
+ # The exception that occurs when the request would cause a service quota
1876
+ # to be exceeded. Review your service quotas and either reduce your
1877
+ # request rate or request a quota increase.
1878
+ #
1879
+ # @!attribute [rw] message
1880
+ # @return [String]
1881
+ #
1882
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ServiceQuotaExceededException AWS API Documentation
1883
+ #
1884
+ class ServiceQuotaExceededException < Struct.new(
1885
+ :message,
1886
+ :event_type)
1887
+ SENSITIVE = []
1888
+ include Aws::Structure
1889
+ end
1890
+
1891
+ # Contains summary information about a session in a memory store.
1892
+ #
1893
+ # @!attribute [rw] session_id
1894
+ # The unique identifier of the session.
1895
+ # @return [String]
1896
+ #
1897
+ # @!attribute [rw] actor_id
1898
+ # The identifier of the actor associated with the session.
1899
+ # @return [String]
1900
+ #
1901
+ # @!attribute [rw] created_at
1902
+ # The timestamp when the session was created.
1903
+ # @return [Time]
1904
+ #
1905
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/SessionSummary AWS API Documentation
1906
+ #
1907
+ class SessionSummary < Struct.new(
1908
+ :session_id,
1909
+ :actor_id,
1910
+ :created_at)
1911
+ SENSITIVE = []
1912
+ include Aws::Structure
1913
+ end
1914
+
1915
+ # @!attribute [rw] browser_identifier
1916
+ # The unique identifier of the browser to use for this session. This
1917
+ # identifier specifies which browser environment to initialize for the
1918
+ # session.
1919
+ # @return [String]
1920
+ #
1921
+ # @!attribute [rw] name
1922
+ # The name of the browser session. This name helps you identify and
1923
+ # manage the session. The name does not need to be unique.
1924
+ # @return [String]
1925
+ #
1926
+ # @!attribute [rw] session_timeout_seconds
1927
+ # The time in seconds after which the session automatically terminates
1928
+ # if there is no activity. The default value is 3600 seconds (1 hour).
1929
+ # The minimum allowed value is 60 seconds, and the maximum allowed
1930
+ # value is 28800 seconds (8 hours).
1931
+ # @return [Integer]
1932
+ #
1933
+ # @!attribute [rw] view_port
1934
+ # The dimensions of the browser viewport for this session. This
1935
+ # determines the visible area of the web content and affects how web
1936
+ # pages are rendered. If not specified, Amazon Bedrock uses a default
1937
+ # viewport size.
1938
+ # @return [Types::ViewPort]
1939
+ #
1940
+ # @!attribute [rw] client_token
1941
+ # A unique, case-sensitive identifier to ensure that the API request
1942
+ # completes no more than one time. If this token matches a previous
1943
+ # request, Amazon Bedrock ignores the request, but does not return an
1944
+ # error. This parameter helps prevent the creation of duplicate
1945
+ # sessions if there are temporary network issues.
1946
+ #
1947
+ # **A suitable default value is auto-generated.** You should normally
1948
+ # not need to pass this option.
1949
+ # @return [String]
1950
+ #
1951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/StartBrowserSessionRequest AWS API Documentation
1952
+ #
1953
+ class StartBrowserSessionRequest < Struct.new(
1954
+ :browser_identifier,
1955
+ :name,
1956
+ :session_timeout_seconds,
1957
+ :view_port,
1958
+ :client_token)
1959
+ SENSITIVE = []
1960
+ include Aws::Structure
1961
+ end
1962
+
1963
+ # @!attribute [rw] browser_identifier
1964
+ # The identifier of the browser.
1965
+ # @return [String]
1966
+ #
1967
+ # @!attribute [rw] session_id
1968
+ # The unique identifier of the created browser session.
1969
+ # @return [String]
1970
+ #
1971
+ # @!attribute [rw] created_at
1972
+ # The timestamp when the browser session was created.
1973
+ # @return [Time]
1974
+ #
1975
+ # @!attribute [rw] streams
1976
+ # The streams associated with this browser session. These include the
1977
+ # automation stream and live view stream.
1978
+ # @return [Types::BrowserSessionStream]
1979
+ #
1980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/StartBrowserSessionResponse AWS API Documentation
1981
+ #
1982
+ class StartBrowserSessionResponse < Struct.new(
1983
+ :browser_identifier,
1984
+ :session_id,
1985
+ :created_at,
1986
+ :streams)
1987
+ SENSITIVE = []
1988
+ include Aws::Structure
1989
+ end
1990
+
1991
+ # @!attribute [rw] code_interpreter_identifier
1992
+ # The unique identifier of the code interpreter to use for this
1993
+ # session. This identifier specifies which code interpreter
1994
+ # environment to initialize for the session.
1995
+ # @return [String]
1996
+ #
1997
+ # @!attribute [rw] name
1998
+ # The name of the code interpreter session. This name helps you
1999
+ # identify and manage the session. The name does not need to be
2000
+ # unique.
2001
+ # @return [String]
2002
+ #
2003
+ # @!attribute [rw] session_timeout_seconds
2004
+ # The time in seconds after which the session automatically terminates
2005
+ # if there is no activity. The default value is 3600 seconds (1 hour).
2006
+ # The minimum allowed value is 60 seconds, and the maximum allowed
2007
+ # value is 28800 seconds (8 hours).
2008
+ # @return [Integer]
2009
+ #
2010
+ # @!attribute [rw] client_token
2011
+ # A unique, case-sensitive identifier to ensure that the API request
2012
+ # completes no more than one time. If this token matches a previous
2013
+ # request, Amazon Bedrock ignores the request, but does not return an
2014
+ # error. This parameter helps prevent the creation of duplicate
2015
+ # sessions if there are temporary network issues.
2016
+ #
2017
+ # **A suitable default value is auto-generated.** You should normally
2018
+ # not need to pass this option.
2019
+ # @return [String]
2020
+ #
2021
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/StartCodeInterpreterSessionRequest AWS API Documentation
2022
+ #
2023
+ class StartCodeInterpreterSessionRequest < Struct.new(
2024
+ :code_interpreter_identifier,
2025
+ :name,
2026
+ :session_timeout_seconds,
2027
+ :client_token)
2028
+ SENSITIVE = []
2029
+ include Aws::Structure
2030
+ end
2031
+
2032
+ # @!attribute [rw] code_interpreter_identifier
2033
+ # The identifier of the code interpreter.
2034
+ # @return [String]
2035
+ #
2036
+ # @!attribute [rw] session_id
2037
+ # The unique identifier of the created code interpreter session.
2038
+ # @return [String]
2039
+ #
2040
+ # @!attribute [rw] created_at
2041
+ # The time at which the code interpreter session was created.
2042
+ # @return [Time]
2043
+ #
2044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/StartCodeInterpreterSessionResponse AWS API Documentation
2045
+ #
2046
+ class StartCodeInterpreterSessionResponse < Struct.new(
2047
+ :code_interpreter_identifier,
2048
+ :session_id,
2049
+ :created_at)
2050
+ SENSITIVE = []
2051
+ include Aws::Structure
2052
+ end
2053
+
2054
+ # @!attribute [rw] browser_identifier
2055
+ # The unique identifier of the browser associated with the session.
2056
+ # @return [String]
2057
+ #
2058
+ # @!attribute [rw] session_id
2059
+ # The unique identifier of the browser session to stop.
2060
+ # @return [String]
2061
+ #
2062
+ # @!attribute [rw] client_token
2063
+ # A unique, case-sensitive identifier to ensure that the API request
2064
+ # completes no more than one time. If this token matches a previous
2065
+ # request, Amazon Bedrock ignores the request, but does not return an
2066
+ # error.
2067
+ #
2068
+ # **A suitable default value is auto-generated.** You should normally
2069
+ # not need to pass this option.
2070
+ # @return [String]
2071
+ #
2072
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/StopBrowserSessionRequest AWS API Documentation
2073
+ #
2074
+ class StopBrowserSessionRequest < Struct.new(
2075
+ :browser_identifier,
2076
+ :session_id,
2077
+ :client_token)
2078
+ SENSITIVE = []
2079
+ include Aws::Structure
2080
+ end
2081
+
2082
+ # @!attribute [rw] browser_identifier
2083
+ # The identifier of the browser.
2084
+ # @return [String]
2085
+ #
2086
+ # @!attribute [rw] session_id
2087
+ # The identifier of the browser session.
2088
+ # @return [String]
2089
+ #
2090
+ # @!attribute [rw] last_updated_at
2091
+ # The time at which the browser session was last updated.
2092
+ # @return [Time]
2093
+ #
2094
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/StopBrowserSessionResponse AWS API Documentation
2095
+ #
2096
+ class StopBrowserSessionResponse < Struct.new(
2097
+ :browser_identifier,
2098
+ :session_id,
2099
+ :last_updated_at)
2100
+ SENSITIVE = []
2101
+ include Aws::Structure
2102
+ end
2103
+
2104
+ # @!attribute [rw] code_interpreter_identifier
2105
+ # The unique identifier of the code interpreter associated with the
2106
+ # session.
2107
+ # @return [String]
2108
+ #
2109
+ # @!attribute [rw] session_id
2110
+ # The unique identifier of the code interpreter session to stop.
2111
+ # @return [String]
2112
+ #
2113
+ # @!attribute [rw] client_token
2114
+ # A unique, case-sensitive identifier to ensure that the API request
2115
+ # completes no more than one time. If this token matches a previous
2116
+ # request, Amazon Bedrock ignores the request, but does not return an
2117
+ # error.
2118
+ #
2119
+ # **A suitable default value is auto-generated.** You should normally
2120
+ # not need to pass this option.
2121
+ # @return [String]
2122
+ #
2123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/StopCodeInterpreterSessionRequest AWS API Documentation
2124
+ #
2125
+ class StopCodeInterpreterSessionRequest < Struct.new(
2126
+ :code_interpreter_identifier,
2127
+ :session_id,
2128
+ :client_token)
2129
+ SENSITIVE = []
2130
+ include Aws::Structure
2131
+ end
2132
+
2133
+ # @!attribute [rw] code_interpreter_identifier
2134
+ # The identifier of the code interpreter.
2135
+ # @return [String]
2136
+ #
2137
+ # @!attribute [rw] session_id
2138
+ # The identifier of the code interpreter session.
2139
+ # @return [String]
2140
+ #
2141
+ # @!attribute [rw] last_updated_at
2142
+ # The timestamp when the code interpreter session was last updated.
2143
+ # @return [Time]
2144
+ #
2145
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/StopCodeInterpreterSessionResponse AWS API Documentation
2146
+ #
2147
+ class StopCodeInterpreterSessionResponse < Struct.new(
2148
+ :code_interpreter_identifier,
2149
+ :session_id,
2150
+ :last_updated_at)
2151
+ SENSITIVE = []
2152
+ include Aws::Structure
2153
+ end
2154
+
2155
+ # Contains information about an update to a stream.
2156
+ #
2157
+ # @note StreamUpdate is a union - when making an API calls you must set exactly one of the members.
2158
+ #
2159
+ # @!attribute [rw] automation_stream_update
2160
+ # The update to an automation stream.
2161
+ # @return [Types::AutomationStreamUpdate]
2162
+ #
2163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/StreamUpdate AWS API Documentation
2164
+ #
2165
+ class StreamUpdate < Struct.new(
2166
+ :automation_stream_update,
2167
+ :unknown)
2168
+ SENSITIVE = []
2169
+ include Aws::Structure
2170
+ include Aws::Structure::Union
2171
+
2172
+ class AutomationStreamUpdate < StreamUpdate; end
2173
+ class Unknown < StreamUpdate; end
2174
+ end
2175
+
2176
+ # The request was denied due to request throttling. Reduce the frequency
2177
+ # of requests and try again.
2178
+ #
2179
+ # @!attribute [rw] message
2180
+ # @return [String]
2181
+ #
2182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ThrottledException AWS API Documentation
2183
+ #
2184
+ class ThrottledException < Struct.new(
2185
+ :message)
2186
+ SENSITIVE = []
2187
+ include Aws::Structure
2188
+ end
2189
+
2190
+ # The exception that occurs when the request was denied due to request
2191
+ # throttling. This happens when you exceed the allowed request rate for
2192
+ # an operation. Reduce the frequency of requests or implement
2193
+ # exponential backoff retry logic in your application.
2194
+ #
2195
+ # @!attribute [rw] message
2196
+ # @return [String]
2197
+ #
2198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ThrottlingException AWS API Documentation
2199
+ #
2200
+ class ThrottlingException < Struct.new(
2201
+ :message,
2202
+ :event_type)
2203
+ SENSITIVE = []
2204
+ include Aws::Structure
2205
+ end
2206
+
2207
+ # The collection of arguments that specify the operation to perform and
2208
+ # its parameters when invoking a tool in Amazon Bedrock. Different tools
2209
+ # require different arguments, and this structure provides a flexible
2210
+ # way to pass the appropriate arguments to each tool type.
2211
+ #
2212
+ # @!attribute [rw] code
2213
+ # The code to execute in a code interpreter session. This is the
2214
+ # source code in the specified programming language that will be
2215
+ # executed by the code interpreter.
2216
+ # @return [String]
2217
+ #
2218
+ # @!attribute [rw] language
2219
+ # The programming language of the code to execute. This tells the code
2220
+ # interpreter which language runtime to use for execution. Common
2221
+ # values include 'python', 'javascript', and 'r'.
2222
+ # @return [String]
2223
+ #
2224
+ # @!attribute [rw] clear_context
2225
+ # Whether to clear the context for the tool.
2226
+ # @return [Boolean]
2227
+ #
2228
+ # @!attribute [rw] command
2229
+ # The command to execute with the tool.
2230
+ # @return [String]
2231
+ #
2232
+ # @!attribute [rw] path
2233
+ # The path for the tool operation.
2234
+ # @return [String]
2235
+ #
2236
+ # @!attribute [rw] paths
2237
+ # The paths for the tool operation.
2238
+ # @return [Array<String>]
2239
+ #
2240
+ # @!attribute [rw] content
2241
+ # The content for the tool operation.
2242
+ # @return [Array<Types::InputContentBlock>]
2243
+ #
2244
+ # @!attribute [rw] directory_path
2245
+ # The directory path for the tool operation.
2246
+ # @return [String]
2247
+ #
2248
+ # @!attribute [rw] task_id
2249
+ # The identifier of the task for the tool operation.
2250
+ # @return [String]
2251
+ #
2252
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ToolArguments AWS API Documentation
2253
+ #
2254
+ class ToolArguments < Struct.new(
2255
+ :code,
2256
+ :language,
2257
+ :clear_context,
2258
+ :command,
2259
+ :path,
2260
+ :paths,
2261
+ :content,
2262
+ :directory_path,
2263
+ :task_id)
2264
+ SENSITIVE = []
2265
+ include Aws::Structure
2266
+ end
2267
+
2268
+ # Contains structured content from a tool result.
2269
+ #
2270
+ # @!attribute [rw] task_id
2271
+ # The identifier of the task that produced the result.
2272
+ # @return [String]
2273
+ #
2274
+ # @!attribute [rw] task_status
2275
+ # The status of the task that produced the result.
2276
+ # @return [String]
2277
+ #
2278
+ # @!attribute [rw] stdout
2279
+ # The standard output from the tool execution.
2280
+ # @return [String]
2281
+ #
2282
+ # @!attribute [rw] stderr
2283
+ # The standard error output from the tool execution.
2284
+ # @return [String]
2285
+ #
2286
+ # @!attribute [rw] exit_code
2287
+ # The exit code from the tool execution.
2288
+ # @return [Integer]
2289
+ #
2290
+ # @!attribute [rw] execution_time
2291
+ # The execution time of the tool operation in milliseconds.
2292
+ # @return [Float]
2293
+ #
2294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ToolResultStructuredContent AWS API Documentation
2295
+ #
2296
+ class ToolResultStructuredContent < Struct.new(
2297
+ :task_id,
2298
+ :task_status,
2299
+ :stdout,
2300
+ :stderr,
2301
+ :exit_code,
2302
+ :execution_time)
2303
+ SENSITIVE = []
2304
+ include Aws::Structure
2305
+ end
2306
+
2307
+ # This exception is thrown when the JWT bearer token is invalid or not
2308
+ # found for OAuth bearer token based access
2309
+ #
2310
+ # @!attribute [rw] message
2311
+ # @return [String]
2312
+ #
2313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/UnauthorizedException AWS API Documentation
2314
+ #
2315
+ class UnauthorizedException < Struct.new(
2316
+ :message)
2317
+ SENSITIVE = []
2318
+ include Aws::Structure
2319
+ end
2320
+
2321
+ # @!attribute [rw] browser_identifier
2322
+ # The identifier of the browser.
2323
+ # @return [String]
2324
+ #
2325
+ # @!attribute [rw] session_id
2326
+ # The identifier of the browser session.
2327
+ # @return [String]
2328
+ #
2329
+ # @!attribute [rw] stream_update
2330
+ # The update to apply to the browser stream.
2331
+ # @return [Types::StreamUpdate]
2332
+ #
2333
+ # @!attribute [rw] client_token
2334
+ # A unique, case-sensitive identifier to ensure that the operation
2335
+ # completes no more than one time. If this token matches a previous
2336
+ # request, Amazon Bedrock ignores the request, but does not return an
2337
+ # error.
2338
+ #
2339
+ # **A suitable default value is auto-generated.** You should normally
2340
+ # not need to pass this option.
2341
+ # @return [String]
2342
+ #
2343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/UpdateBrowserStreamRequest AWS API Documentation
2344
+ #
2345
+ class UpdateBrowserStreamRequest < Struct.new(
2346
+ :browser_identifier,
2347
+ :session_id,
2348
+ :stream_update,
2349
+ :client_token)
2350
+ SENSITIVE = []
2351
+ include Aws::Structure
2352
+ end
2353
+
2354
+ # @!attribute [rw] browser_identifier
2355
+ # The identifier of the browser.
2356
+ # @return [String]
2357
+ #
2358
+ # @!attribute [rw] session_id
2359
+ # The identifier of the browser session.
2360
+ # @return [String]
2361
+ #
2362
+ # @!attribute [rw] streams
2363
+ # The collection of streams associated with a browser session in
2364
+ # Amazon Bedrock. These streams provide different ways to interact
2365
+ # with and observe the browser session, including programmatic control
2366
+ # and visual representation of the browser content.
2367
+ # @return [Types::BrowserSessionStream]
2368
+ #
2369
+ # @!attribute [rw] updated_at
2370
+ # The time at which the browser stream was updated.
2371
+ # @return [Time]
2372
+ #
2373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/UpdateBrowserStreamResponse AWS API Documentation
2374
+ #
2375
+ class UpdateBrowserStreamResponse < Struct.new(
2376
+ :browser_identifier,
2377
+ :session_id,
2378
+ :streams,
2379
+ :updated_at)
2380
+ SENSITIVE = []
2381
+ include Aws::Structure
2382
+ end
2383
+
2384
+ # The exception that occurs when the input fails to satisfy the
2385
+ # constraints specified by the service. Check the error message for
2386
+ # details about which input parameter is invalid and correct your
2387
+ # request.
2388
+ #
2389
+ # @!attribute [rw] message
2390
+ # @return [String]
2391
+ #
2392
+ # @!attribute [rw] reason
2393
+ # @return [String]
2394
+ #
2395
+ # @!attribute [rw] field_list
2396
+ # @return [Array<Types::ValidationExceptionField>]
2397
+ #
2398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ValidationException AWS API Documentation
2399
+ #
2400
+ class ValidationException < Struct.new(
2401
+ :message,
2402
+ :reason,
2403
+ :field_list,
2404
+ :event_type)
2405
+ SENSITIVE = []
2406
+ include Aws::Structure
2407
+ end
2408
+
2409
+ # Stores information about a field passed inside a request that resulted
2410
+ # in an exception.
2411
+ #
2412
+ # @!attribute [rw] name
2413
+ # The name of the field.
2414
+ # @return [String]
2415
+ #
2416
+ # @!attribute [rw] message
2417
+ # A message describing why this field failed validation.
2418
+ # @return [String]
2419
+ #
2420
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ValidationExceptionField AWS API Documentation
2421
+ #
2422
+ class ValidationExceptionField < Struct.new(
2423
+ :name,
2424
+ :message)
2425
+ SENSITIVE = []
2426
+ include Aws::Structure
2427
+ end
2428
+
2429
+ # The configuration that defines the dimensions of a browser viewport in
2430
+ # a browser session. The viewport determines the visible area of web
2431
+ # content and affects how web pages are rendered and displayed. Proper
2432
+ # viewport configuration ensures that web content is displayed correctly
2433
+ # for the agent's browsing tasks.
2434
+ #
2435
+ # @!attribute [rw] width
2436
+ # The width of the viewport in pixels. This value determines the
2437
+ # horizontal dimension of the visible area. Valid values range from
2438
+ # 800 to 1920 pixels.
2439
+ # @return [Integer]
2440
+ #
2441
+ # @!attribute [rw] height
2442
+ # The height of the viewport in pixels. This value determines the
2443
+ # vertical dimension of the visible area. Valid values range from 600
2444
+ # to 1080 pixels.
2445
+ # @return [Integer]
2446
+ #
2447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ViewPort AWS API Documentation
2448
+ #
2449
+ class ViewPort < Struct.new(
2450
+ :width,
2451
+ :height)
2452
+ SENSITIVE = []
2453
+ include Aws::Structure
2454
+ end
2455
+
2456
+ # Contains output from a code interpreter stream.
2457
+ #
2458
+ # EventStream is an Enumerator of Events.
2459
+ # #event_types #=> Array, returns all modeled event types in the stream
2460
+ #
2461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/CodeInterpreterStreamOutput AWS API Documentation
2462
+ #
2463
+ class CodeInterpreterStreamOutput < Enumerator
2464
+
2465
+ def event_types
2466
+ [
2467
+ :result,
2468
+ :access_denied_exception,
2469
+ :conflict_exception,
2470
+ :internal_server_exception,
2471
+ :resource_not_found_exception,
2472
+ :service_quota_exceeded_exception,
2473
+ :throttling_exception,
2474
+ :validation_exception
2475
+ ]
2476
+ end
2477
+
2478
+ end
2479
+
2480
+ end
2481
+ end
2482
+