Module: Aws::BedrockAgentCore::Types

Defined in:
gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb

Defined Under Namespace

Classes: AccessDeniedException, ActorSummary, AutomationStream, AutomationStreamUpdate, BasicAuth, BatchCreateMemoryRecordsInput, BatchCreateMemoryRecordsOutput, BatchDeleteMemoryRecordsInput, BatchDeleteMemoryRecordsOutput, BatchUpdateMemoryRecordsInput, BatchUpdateMemoryRecordsOutput, Branch, BranchFilter, BrowserExtension, BrowserProfileConfiguration, BrowserSessionStream, BrowserSessionSummary, CodeInterpreterResult, CodeInterpreterSessionSummary, CodeInterpreterStreamOutput, CompleteResourceTokenAuthRequest, CompleteResourceTokenAuthResponse, ConflictException, Content, ContentBlock, Context, Conversational, CreateEventInput, CreateEventOutput, DeleteEventInput, DeleteEventOutput, DeleteMemoryRecordInput, DeleteMemoryRecordOutput, DuplicateIdException, EvaluateRequest, EvaluateResponse, EvaluationInput, EvaluationResultContent, EvaluationTarget, Event, EventMetadataFilterExpression, ExternalProxy, ExtractionJob, ExtractionJobFilterInput, ExtractionJobMessages, ExtractionJobMetadata, FilterInput, GetAgentCardRequest, GetAgentCardResponse, GetBrowserSessionRequest, GetBrowserSessionResponse, GetCodeInterpreterSessionRequest, GetCodeInterpreterSessionResponse, GetEventInput, GetEventOutput, GetMemoryRecordInput, GetMemoryRecordOutput, GetResourceApiKeyRequest, GetResourceApiKeyResponse, GetResourceOauth2TokenRequest, GetResourceOauth2TokenResponse, GetWorkloadAccessTokenForJWTRequest, GetWorkloadAccessTokenForJWTResponse, GetWorkloadAccessTokenForUserIdRequest, GetWorkloadAccessTokenForUserIdResponse, GetWorkloadAccessTokenRequest, GetWorkloadAccessTokenResponse, InputContentBlock, InternalServerException, InvalidInputException, InvokeAgentRuntimeRequest, InvokeAgentRuntimeResponse, InvokeCodeInterpreterRequest, InvokeCodeInterpreterResponse, LeftExpression, ListActorsInput, ListActorsOutput, ListBrowserSessionsRequest, ListBrowserSessionsResponse, ListCodeInterpreterSessionsRequest, ListCodeInterpreterSessionsResponse, ListEventsInput, ListEventsOutput, ListMemoryExtractionJobsInput, ListMemoryExtractionJobsOutput, ListMemoryRecordsInput, ListMemoryRecordsOutput, ListSessionsInput, ListSessionsOutput, LiveViewStream, MemoryContent, MemoryMetadataFilterExpression, MemoryRecord, MemoryRecordCreateInput, MemoryRecordDeleteInput, MemoryRecordOutput, MemoryRecordSummary, MemoryRecordUpdateInput, MessageMetadata, MetadataValue, PayloadType, Proxy, ProxyBypass, ProxyConfiguration, ProxyCredentials, ResourceContent, ResourceLocation, ResourceNotFoundException, RetrieveMemoryRecordsInput, RetrieveMemoryRecordsOutput, RetryableConflictException, RightExpression, RuntimeClientError, S3Location, SaveBrowserSessionProfileRequest, SaveBrowserSessionProfileResponse, SearchCriteria, ServiceException, ServiceQuotaExceededException, SessionSummary, SpanContext, StartBrowserSessionRequest, StartBrowserSessionResponse, StartCodeInterpreterSessionRequest, StartCodeInterpreterSessionResponse, StartMemoryExtractionJobInput, StartMemoryExtractionJobOutput, StopBrowserSessionRequest, StopBrowserSessionResponse, StopCodeInterpreterSessionRequest, StopCodeInterpreterSessionResponse, StopRuntimeSessionRequest, StopRuntimeSessionResponse, StreamUpdate, ThrottledException, ThrottlingException, TokenUsage, ToolArguments, ToolResultStructuredContent, UnauthorizedException, UpdateBrowserStreamRequest, UpdateBrowserStreamResponse, UserIdentifier, ValidationException, ValidationExceptionField, ViewPort

Instance Attribute Summary collapse

Instance Attribute Details

#automation_stream_update ⇒ Types::AutomationStreamUpdate

The update to an automation stream.

Returns:



3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 3657

class StreamUpdate < Struct.new(
  :automation_stream_update,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AutomationStreamUpdate < StreamUpdate; end
  class Unknown < StreamUpdate; end
end

#basic_auth ⇒ Types::BasicAuth

HTTP Basic Authentication credentials (username and password) stored in Amazon Web Services Secrets Manager.

Returns:



2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2833

class ProxyCredentials < Struct.new(
  :basic_auth,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuth < ProxyCredentials; end
  class Unknown < ProxyCredentials; end
end

#blob ⇒ Hash, ...

The binary content of the payload.

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2737

class PayloadType < Struct.new(
  :conversational,
  :blob,
  :unknown)
  SENSITIVE = [:blob]
  include Aws::Structure
  include Aws::Structure::Union

  class Conversational < PayloadType; end
  class Blob < PayloadType; end
  class Unknown < PayloadType; end
end

#content ⇒ Array<Types::ContentBlock>

The textual content of the execution result. This includes standard output from the code execution, such as print statements, console output, and text representations of results.

Returns:



412
413
414
415
416
417
418
419
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 412

class CodeInterpreterResult < Struct.new(
  :content,
  :structured_content,
  :is_error,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#conversational ⇒ Types::Conversational

The conversational content of the payload.

Returns:



2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2737

class PayloadType < Struct.new(
  :conversational,
  :blob,
  :unknown)
  SENSITIVE = [:blob]
  include Aws::Structure
  include Aws::Structure::Union

  class Conversational < PayloadType; end
  class Blob < PayloadType; end
  class Unknown < PayloadType; end
end

#external_proxy ⇒ Types::ExternalProxy

Configuration for an external customer-managed proxy server.

Returns:



2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2763

class Proxy < Struct.new(
  :external_proxy,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ExternalProxy < Proxy; end
  class Unknown < Proxy; end
end

#field_list ⇒ Array<Types::ValidationExceptionField>

Returns:



3956
3957
3958
3959
3960
3961
3962
3963
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 3956

class ValidationException < Struct.new(
  :message,
  :reason,
  :field_list,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#is_error ⇒ Boolean

Indicates whether the result represents an error. If true, the content contains error messages or exception information. If false, the content contains successful execution results.

Returns:

  • (Boolean) 


412
413
414
415
416
417
418
419
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 412

class CodeInterpreterResult < Struct.new(
  :content,
  :structured_content,
  :is_error,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

Returns:

  • (String) 


22
23
24
25
26
27
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 22

class AccessDeniedException < Struct.new(
  :message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#messages_list ⇒ Array<Types::MessageMetadata>

The list of messages that compose this extraction job.

Returns:



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 1159

class ExtractionJobMessages < Struct.new(
  :messages_list,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class MessagesList < ExtractionJobMessages; end
  class Unknown < ExtractionJobMessages; end
end

#metadata_key ⇒ String

Key associated with the metadata in an event.

Returns:

  • (String) 


2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2010

class LeftExpression < Struct.new(
  :metadata_key,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class MetadataKey < LeftExpression; end
  class Unknown < LeftExpression; end
end

#metadata_value ⇒ Types::MetadataValue

Value associated with the key in eventMetadata.

Returns:



3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 3003

class RightExpression < Struct.new(
  :metadata_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class MetadataValue < RightExpression; end
  class Unknown < RightExpression; end
end

#reason ⇒ String

Returns:

  • (String) 


3956
3957
3958
3959
3960
3961
3962
3963
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 3956

class ValidationException < Struct.new(
  :message,
  :reason,
  :field_list,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#s3 ⇒ Types::S3Location

The Amazon S3 location of the resource. Use this when the resource is stored in an Amazon S3 bucket.

Returns:



2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2891

class ResourceLocation < Struct.new(
  :s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3 < ResourceLocation; end
  class Unknown < ResourceLocation; end
end

#session_spans ⇒ Array<Hash,Array,String,Numeric,Boolean>

The collection of spans representing agent execution traces within a session. Each span contains detailed information about tool calls, model interactions, and other agent activities that can be evaluated for quality and performance.

Returns:

  • (Array<Hash,Array,String,Numeric,Boolean>) 


853
854
855
856
857
858
859
860
861
862
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 853

class EvaluationInput < Struct.new(
  :session_spans,
  :unknown)
  SENSITIVE = [:session_spans]
  include Aws::Structure
  include Aws::Structure::Union

  class SessionSpans < EvaluationInput; end
  class Unknown < EvaluationInput; end
end

#span_context ⇒ Types::SpanContext

The span context information that uniquely identifies the trace and span being evaluated, including session ID, trace ID, and span ID for precise targeting within the agent's execution flow.

Returns:



604
605
606
607
608
609
610
611
612
613
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 604

class Context < Struct.new(
  :span_context,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SpanContext < Context; end
  class Unknown < Context; end
end

#span_ids ⇒ Array<String>

The list of specific span IDs to evaluate within the provided traces. Used to target evaluation at individual tool calls or specific operations within the agent's execution flow.

Returns:

  • (Array<String>) 


974
975
976
977
978
979
980
981
982
983
984
985
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 974

class EvaluationTarget < Struct.new(
  :span_ids,
  :trace_ids,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SpanIds < EvaluationTarget; end
  class TraceIds < EvaluationTarget; end
  class Unknown < EvaluationTarget; end
end

#string_value ⇒ String

Value associated with the eventMetadata key.

Returns:

  • (String) 


2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2710

class MetadataValue < Struct.new(
  :string_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < MetadataValue; end
  class Unknown < MetadataValue; end
end

#structured_content ⇒ Types::ToolResultStructuredContent

The structured content of the execution result. This includes additional metadata about the execution, such as execution time, memory usage, and structured representations of output data. The format depends on the specific code interpreter and execution context.

Returns:



412
413
414
415
416
417
418
419
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 412

class CodeInterpreterResult < Struct.new(
  :content,
  :structured_content,
  :is_error,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#text ⇒ String

The text content of the memory record.

Returns:

  • (String) 


525
526
527
528
529
530
531
532
533
534
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 525

class Content < Struct.new(
  :text,
  :unknown)
  SENSITIVE = [:text]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < Content; end
  class Unknown < Content; end
end

#trace_ids ⇒ Array<String>

The list of trace IDs to evaluate, representing complete request-response interactions. Used to evaluate entire conversation turns or specific agent interactions within a session.

Returns:

  • (Array<String>) 


974
975
976
977
978
979
980
981
982
983
984
985
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 974

class EvaluationTarget < Struct.new(
  :span_ids,
  :trace_ids,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SpanIds < EvaluationTarget; end
  class TraceIds < EvaluationTarget; end
  class Unknown < EvaluationTarget; end
end

#user_id ⇒ String

The ID of the user for whom you have retrieved a workload access token for

Returns:

  • (String) 


3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 3927

class UserIdentifier < Struct.new(
  :user_token,
  :user_id,
  :unknown)
  SENSITIVE = [:user_token]
  include Aws::Structure
  include Aws::Structure::Union

  class UserToken < UserIdentifier; end
  class UserId < UserIdentifier; end
  class Unknown < UserIdentifier; end
end

#user_token ⇒ String

The OAuth2.0 token issued by the user’s identity provider

Returns:

  • (String) 


3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 3927

class UserIdentifier < Struct.new(
  :user_token,
  :user_id,
  :unknown)
  SENSITIVE = [:user_token]
  include Aws::Structure
  include Aws::Structure::Union

  class UserToken < UserIdentifier; end
  class UserId < UserIdentifier; end
  class Unknown < UserIdentifier; end
end