Module: Aws::BedrockAgent::Types

Defined in:
lib/aws-sdk-bedrockagent/types.rb

Defined Under Namespace

Classes: APISchema, AccessDeniedException, ActionGroupExecutor, ActionGroupSummary, Agent, AgentActionGroup, AgentAlias, AgentAliasHistoryEvent, AgentAliasRoutingConfigurationListItem, AgentAliasSummary, AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentSummary, AgentVersion, AgentVersionSummary, AssociateAgentKnowledgeBaseRequest, AssociateAgentKnowledgeBaseResponse, ChunkingConfiguration, ConflictException, CreateAgentActionGroupRequest, CreateAgentActionGroupResponse, CreateAgentAliasRequest, CreateAgentAliasResponse, CreateAgentRequest, CreateAgentResponse, CreateDataSourceRequest, CreateDataSourceResponse, CreateKnowledgeBaseRequest, CreateKnowledgeBaseResponse, DataSource, DataSourceConfiguration, DataSourceSummary, DeleteAgentActionGroupRequest, DeleteAgentActionGroupResponse, DeleteAgentAliasRequest, DeleteAgentAliasResponse, DeleteAgentRequest, DeleteAgentResponse, DeleteAgentVersionRequest, DeleteAgentVersionResponse, DeleteDataSourceRequest, DeleteDataSourceResponse, DeleteKnowledgeBaseRequest, DeleteKnowledgeBaseResponse, DisassociateAgentKnowledgeBaseRequest, DisassociateAgentKnowledgeBaseResponse, FixedSizeChunkingConfiguration, Function, FunctionSchema, GetAgentActionGroupRequest, GetAgentActionGroupResponse, GetAgentAliasRequest, GetAgentAliasResponse, GetAgentKnowledgeBaseRequest, GetAgentKnowledgeBaseResponse, GetAgentRequest, GetAgentResponse, GetAgentVersionRequest, GetAgentVersionResponse, GetDataSourceRequest, GetDataSourceResponse, GetIngestionJobRequest, GetIngestionJobResponse, GetKnowledgeBaseRequest, GetKnowledgeBaseResponse, InferenceConfiguration, IngestionJob, IngestionJobFilter, IngestionJobSortBy, IngestionJobStatistics, IngestionJobSummary, InternalServerException, KnowledgeBase, KnowledgeBaseConfiguration, KnowledgeBaseSummary, ListAgentActionGroupsRequest, ListAgentActionGroupsResponse, ListAgentAliasesRequest, ListAgentAliasesResponse, ListAgentKnowledgeBasesRequest, ListAgentKnowledgeBasesResponse, ListAgentVersionsRequest, ListAgentVersionsResponse, ListAgentsRequest, ListAgentsResponse, ListDataSourcesRequest, ListDataSourcesResponse, ListIngestionJobsRequest, ListIngestionJobsResponse, ListKnowledgeBasesRequest, ListKnowledgeBasesResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, MongoDbAtlasConfiguration, MongoDbAtlasFieldMapping, OpenSearchServerlessConfiguration, OpenSearchServerlessFieldMapping, ParameterDetail, PineconeConfiguration, PineconeFieldMapping, PrepareAgentRequest, PrepareAgentResponse, PromptConfiguration, PromptOverrideConfiguration, RdsConfiguration, RdsFieldMapping, RedisEnterpriseCloudConfiguration, RedisEnterpriseCloudFieldMapping, ResourceNotFoundException, S3DataSourceConfiguration, S3Identifier, ServerSideEncryptionConfiguration, ServiceQuotaExceededException, StartIngestionJobRequest, StartIngestionJobResponse, StorageConfiguration, TagResourceRequest, TagResourceResponse, ThrottlingException, UntagResourceRequest, UntagResourceResponse, UpdateAgentActionGroupRequest, UpdateAgentActionGroupResponse, UpdateAgentAliasRequest, UpdateAgentAliasResponse, UpdateAgentKnowledgeBaseRequest, UpdateAgentKnowledgeBaseResponse, UpdateAgentRequest, UpdateAgentResponse, UpdateDataSourceRequest, UpdateDataSourceResponse, UpdateKnowledgeBaseRequest, UpdateKnowledgeBaseResponse, ValidationException, ValidationExceptionField, VectorIngestionConfiguration, VectorKnowledgeBaseConfiguration

Instance Attribute Summary collapse

Instance Attribute Details

#custom_control ⇒ String

To return the action group invocation results directly in the ‘InvokeAgent` response, specify `RETURN_CONTROL`.

Returns:

  • (String) 


95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 95

class ActionGroupExecutor < Struct.new(
  :custom_control,
  :lambda,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CustomControl < ActionGroupExecutor; end
  class Lambda < ActionGroupExecutor; end
  class Unknown < ActionGroupExecutor; end
end

#functions ⇒ Array<Types::Function>

A list of functions that each define an action in the action group.

Returns:



1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 1842

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

  class Functions < FunctionSchema; end
  class Unknown < FunctionSchema; end
end

#lambda ⇒ String

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

Returns:

  • (String) 


95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 95

class ActionGroupExecutor < Struct.new(
  :custom_control,
  :lambda,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CustomControl < ActionGroupExecutor; end
  class Lambda < ActionGroupExecutor; end
  class Unknown < ActionGroupExecutor; end
end

#payload ⇒ String

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see [Action group OpenAPI schemas].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html

Returns:

  • (String) 


49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 49

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

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#s3 ⇒ Types::S3Identifier

Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see [Action group OpenAPI schemas].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 49

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

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end