Class: Aws::BedrockAgent::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::BedrockAgent::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-bedrockagent/client.rb
Overview
An API client for BedrockAgent. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::BedrockAgent::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#associate_agent_knowledge_base(params = {}) ⇒ Types::AssociateAgentKnowledgeBaseResponse
Associate a Knowledge Base to an existing Amazon Bedrock Agent.
-
#create_agent(params = {}) ⇒ Types::CreateAgentResponse
Creates an Amazon Bedrock Agent.
-
#create_agent_action_group(params = {}) ⇒ Types::CreateAgentActionGroupResponse
Creates an Action Group for existing Amazon Bedrock Agent.
-
#create_agent_alias(params = {}) ⇒ Types::CreateAgentAliasResponse
Creates an Alias for an existing Amazon Bedrock Agent.
-
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Create a new data source.
-
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Create a new knowledge base.
-
#delete_agent(params = {}) ⇒ Types::DeleteAgentResponse
Deletes an Agent for existing Amazon Bedrock Agent.
-
#delete_agent_action_group(params = {}) ⇒ Struct
Deletes an Action Group for existing Amazon Bedrock Agent.
-
#delete_agent_alias(params = {}) ⇒ Types::DeleteAgentAliasResponse
Deletes an Alias for a Amazon Bedrock Agent.
-
#delete_agent_version(params = {}) ⇒ Types::DeleteAgentVersionResponse
Deletes an Agent version for existing Amazon Bedrock Agent.
-
#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse
Delete an existing data source.
-
#delete_knowledge_base(params = {}) ⇒ Types::DeleteKnowledgeBaseResponse
Delete an existing knowledge base.
-
#disassociate_agent_knowledge_base(params = {}) ⇒ Struct
Disassociate an existing Knowledge Base from an Amazon Bedrock Agent.
-
#get_agent(params = {}) ⇒ Types::GetAgentResponse
Gets an Agent for existing Amazon Bedrock Agent.
-
#get_agent_action_group(params = {}) ⇒ Types::GetAgentActionGroupResponse
Gets an Action Group for existing Amazon Bedrock Agent Version.
-
#get_agent_alias(params = {}) ⇒ Types::GetAgentAliasResponse
Describes an Alias for a Amazon Bedrock Agent.
-
#get_agent_knowledge_base(params = {}) ⇒ Types::GetAgentKnowledgeBaseResponse
Gets a knowledge base associated to an existing Amazon Bedrock Agent Version.
-
#get_agent_version(params = {}) ⇒ Types::GetAgentVersionResponse
Gets an Agent version for existing Amazon Bedrock Agent.
-
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Get an existing data source.
-
#get_ingestion_job(params = {}) ⇒ Types::GetIngestionJobResponse
Get an ingestion job.
-
#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse
Get an existing knowledge base.
-
#list_agent_action_groups(params = {}) ⇒ Types::ListAgentActionGroupsResponse
Lists an Action Group for existing Amazon Bedrock Agent Version.
-
#list_agent_aliases(params = {}) ⇒ Types::ListAgentAliasesResponse
Lists all the Aliases for an Amazon Bedrock Agent.
-
#list_agent_knowledge_bases(params = {}) ⇒ Types::ListAgentKnowledgeBasesResponse
List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version.
-
#list_agent_versions(params = {}) ⇒ Types::ListAgentVersionsResponse
Lists Agent Versions.
-
#list_agents(params = {}) ⇒ Types::ListAgentsResponse
Lists Agents.
-
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
List data sources.
-
#list_ingestion_jobs(params = {}) ⇒ Types::ListIngestionJobsResponse
List ingestion jobs.
-
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
List Knowledge Bases.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List tags for a resource.
-
#prepare_agent(params = {}) ⇒ Types::PrepareAgentResponse
Prepares an existing Amazon Bedrock Agent to receive runtime requests.
-
#start_ingestion_job(params = {}) ⇒ Types::StartIngestionJobResponse
Start a new ingestion job.
-
#tag_resource(params = {}) ⇒ Struct
Tag a resource.
-
#untag_resource(params = {}) ⇒ Struct
Untag a resource.
-
#update_agent(params = {}) ⇒ Types::UpdateAgentResponse
Updates an existing Amazon Bedrock Agent.
-
#update_agent_action_group(params = {}) ⇒ Types::UpdateAgentActionGroupResponse
Updates an existing Action Group for Amazon Bedrock Agent.
-
#update_agent_alias(params = {}) ⇒ Types::UpdateAgentAliasResponse
Updates an existing Alias for an Amazon Bedrock Agent.
-
#update_agent_knowledge_base(params = {}) ⇒ Types::UpdateAgentKnowledgeBaseResponse
Updates an existing Knowledge Base associated to an Amazon Bedrock Agent.
-
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Update an existing data source.
-
#update_knowledge_base(params = {}) ⇒ Types::UpdateKnowledgeBaseResponse
Update an existing knowledge base.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 385 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2666 2667 2668 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2666 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2669 2670 2671 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2669 def errors_module Errors end |
Instance Method Details
#associate_agent_knowledge_base(params = {}) ⇒ Types::AssociateAgentKnowledgeBaseResponse
Associate a Knowledge Base to an existing Amazon Bedrock Agent
436 437 438 439 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 436 def associate_agent_knowledge_base(params = {}, = {}) req = build_request(:associate_agent_knowledge_base, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2644 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-bedrockagent' context[:gem_version] = '1.0.0' Seahorse::Client::Request.new(handlers, context) end |
#create_agent(params = {}) ⇒ Types::CreateAgentResponse
Creates an Amazon Bedrock Agent
554 555 556 557 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 554 def create_agent(params = {}, = {}) req = build_request(:create_agent, params) req.send_request() end |
#create_agent_action_group(params = {}) ⇒ Types::CreateAgentActionGroupResponse
Creates an Action Group for existing Amazon Bedrock Agent
638 639 640 641 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 638 def create_agent_action_group(params = {}, = {}) req = build_request(:create_agent_action_group, params) req.send_request() end |
#create_agent_alias(params = {}) ⇒ Types::CreateAgentAliasResponse
Creates an Alias for an existing Amazon Bedrock Agent
710 711 712 713 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 710 def create_agent_alias(params = {}, = {}) req = build_request(:create_agent_alias, params) req.send_request() end |
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Create a new data source
795 796 797 798 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 795 def create_data_source(params = {}, = {}) req = build_request(:create_data_source, params) req.send_request() end |
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Create a new knowledge base
915 916 917 918 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 915 def create_knowledge_base(params = {}, = {}) req = build_request(:create_knowledge_base, params) req.send_request() end |
#delete_agent(params = {}) ⇒ Types::DeleteAgentResponse
Deletes an Agent for existing Amazon Bedrock Agent
950 951 952 953 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 950 def delete_agent(params = {}, = {}) req = build_request(:delete_agent, params) req.send_request() end |
#delete_agent_action_group(params = {}) ⇒ Struct
Deletes an Action Group for existing Amazon Bedrock Agent.
985 986 987 988 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 985 def delete_agent_action_group(params = {}, = {}) req = build_request(:delete_agent_action_group, params) req.send_request() end |
#delete_agent_alias(params = {}) ⇒ Types::DeleteAgentAliasResponse
Deletes an Alias for a Amazon Bedrock Agent
1021 1022 1023 1024 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1021 def delete_agent_alias(params = {}, = {}) req = build_request(:delete_agent_alias, params) req.send_request() end |
#delete_agent_version(params = {}) ⇒ Types::DeleteAgentVersionResponse
Deletes an Agent version for existing Amazon Bedrock Agent
1062 1063 1064 1065 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1062 def delete_agent_version(params = {}, = {}) req = build_request(:delete_agent_version, params) req.send_request() end |
#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse
Delete an existing data source
1098 1099 1100 1101 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1098 def delete_data_source(params = {}, = {}) req = build_request(:delete_data_source, params) req.send_request() end |
#delete_knowledge_base(params = {}) ⇒ Types::DeleteKnowledgeBaseResponse
Delete an existing knowledge base
1128 1129 1130 1131 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1128 def delete_knowledge_base(params = {}, = {}) req = build_request(:delete_knowledge_base, params) req.send_request() end |
#disassociate_agent_knowledge_base(params = {}) ⇒ Struct
Disassociate an existing Knowledge Base from an Amazon Bedrock Agent
1159 1160 1161 1162 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1159 def disassociate_agent_knowledge_base(params = {}, = {}) req = build_request(:disassociate_agent_knowledge_base, params) req.send_request() end |
#get_agent(params = {}) ⇒ Types::GetAgentResponse
Gets an Agent for existing Amazon Bedrock Agent
1218 1219 1220 1221 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1218 def get_agent(params = {}, = {}) req = build_request(:get_agent, params) req.send_request() end |
#get_agent_action_group(params = {}) ⇒ Types::GetAgentActionGroupResponse
Gets an Action Group for existing Amazon Bedrock Agent Version
1267 1268 1269 1270 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1267 def get_agent_action_group(params = {}, = {}) req = build_request(:get_agent_action_group, params) req.send_request() end |
#get_agent_alias(params = {}) ⇒ Types::GetAgentAliasResponse
Describes an Alias for a Amazon Bedrock Agent
1314 1315 1316 1317 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1314 def get_agent_alias(params = {}, = {}) req = build_request(:get_agent_alias, params) req.send_request() end |
#get_agent_knowledge_base(params = {}) ⇒ Types::GetAgentKnowledgeBaseResponse
Gets a knowledge base associated to an existing Amazon Bedrock Agent Version
1357 1358 1359 1360 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1357 def get_agent_knowledge_base(params = {}, = {}) req = build_request(:get_agent_knowledge_base, params) req.send_request() end |
#get_agent_version(params = {}) ⇒ Types::GetAgentVersionResponse
Gets an Agent version for existing Amazon Bedrock Agent
1418 1419 1420 1421 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1418 def get_agent_version(params = {}, = {}) req = build_request(:get_agent_version, params) req.send_request() end |
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Get an existing data source
1464 1465 1466 1467 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1464 def get_data_source(params = {}, = {}) req = build_request(:get_data_source, params) req.send_request() end |
#get_ingestion_job(params = {}) ⇒ Types::GetIngestionJobResponse
Get an ingestion job
1513 1514 1515 1516 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1513 def get_ingestion_job(params = {}, = {}) req = build_request(:get_ingestion_job, params) req.send_request() end |
#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse
Get an existing knowledge base
1569 1570 1571 1572 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1569 def get_knowledge_base(params = {}, = {}) req = build_request(:get_knowledge_base, params) req.send_request() end |
#list_agent_action_groups(params = {}) ⇒ Types::ListAgentActionGroupsResponse
Lists an Action Group for existing Amazon Bedrock Agent Version
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1618 1619 1620 1621 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1618 def list_agent_action_groups(params = {}, = {}) req = build_request(:list_agent_action_groups, params) req.send_request() end |
#list_agent_aliases(params = {}) ⇒ Types::ListAgentAliasesResponse
Lists all the Aliases for an Amazon Bedrock Agent
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1666 1667 1668 1669 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1666 def list_agent_aliases(params = {}, = {}) req = build_request(:list_agent_aliases, params) req.send_request() end |
#list_agent_knowledge_bases(params = {}) ⇒ Types::ListAgentKnowledgeBasesResponse
List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1715 1716 1717 1718 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1715 def list_agent_knowledge_bases(params = {}, = {}) req = build_request(:list_agent_knowledge_bases, params) req.send_request() end |
#list_agent_versions(params = {}) ⇒ Types::ListAgentVersionsResponse
Lists Agent Versions
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1761 1762 1763 1764 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1761 def list_agent_versions(params = {}, = {}) req = build_request(:list_agent_versions, params) req.send_request() end |
#list_agents(params = {}) ⇒ Types::ListAgentsResponse
Lists Agents
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1803 1804 1805 1806 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1803 def list_agents(params = {}, = {}) req = build_request(:list_agents, params) req.send_request() end |
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
List data sources
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1849 1850 1851 1852 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1849 def list_data_sources(params = {}, = {}) req = build_request(:list_data_sources, params) req.send_request() end |
#list_ingestion_jobs(params = {}) ⇒ Types::ListIngestionJobsResponse
List ingestion jobs
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1922 1923 1924 1925 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1922 def list_ingestion_jobs(params = {}, = {}) req = build_request(:list_ingestion_jobs, params) req.send_request() end |
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
List Knowledge Bases
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1963 1964 1965 1966 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1963 def list_knowledge_bases(params = {}, = {}) req = build_request(:list_knowledge_bases, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List tags for a resource
1992 1993 1994 1995 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 1992 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#prepare_agent(params = {}) ⇒ Types::PrepareAgentResponse
Prepares an existing Amazon Bedrock Agent to receive runtime requests
2026 2027 2028 2029 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2026 def prepare_agent(params = {}, = {}) req = build_request(:prepare_agent, params) req.send_request() end |
#start_ingestion_job(params = {}) ⇒ Types::StartIngestionJobResponse
Start a new ingestion job
2082 2083 2084 2085 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2082 def start_ingestion_job(params = {}, = {}) req = build_request(:start_ingestion_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tag a resource
2110 2111 2112 2113 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2110 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untag a resource
2136 2137 2138 2139 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2136 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent(params = {}) ⇒ Types::UpdateAgentResponse
Updates an existing Amazon Bedrock Agent
2245 2246 2247 2248 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2245 def update_agent(params = {}, = {}) req = build_request(:update_agent, params) req.send_request() end |
#update_agent_action_group(params = {}) ⇒ Types::UpdateAgentActionGroupResponse
Updates an existing Action Group for Amazon Bedrock Agent
2327 2328 2329 2330 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2327 def update_agent_action_group(params = {}, = {}) req = build_request(:update_agent_action_group, params) req.send_request() end |
#update_agent_alias(params = {}) ⇒ Types::UpdateAgentAliasResponse
Updates an existing Alias for an Amazon Bedrock Agent
2390 2391 2392 2393 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2390 def update_agent_alias(params = {}, = {}) req = build_request(:update_agent_alias, params) req.send_request() end |
#update_agent_knowledge_base(params = {}) ⇒ Types::UpdateAgentKnowledgeBaseResponse
Updates an existing Knowledge Base associated to an Amazon Bedrock Agent
2442 2443 2444 2445 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2442 def update_agent_knowledge_base(params = {}, = {}) req = build_request(:update_agent_knowledge_base, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Update an existing data source
2524 2525 2526 2527 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2524 def update_data_source(params = {}, = {}) req = build_request(:update_data_source, params) req.send_request() end |
#update_knowledge_base(params = {}) ⇒ Types::UpdateKnowledgeBaseResponse
Update an existing knowledge base
2635 2636 2637 2638 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2635 def update_knowledge_base(params = {}, = {}) req = build_request(:update_knowledge_base, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2659 2660 2661 |
# File 'lib/aws-sdk-bedrockagent/client.rb', line 2659 def waiter_names [] end |