Class: Aws::BedrockAgentCoreControl::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::BedrockAgentCoreControl::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb
Overview
An API client for BedrockAgentCoreControl. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::BedrockAgentCoreControl::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_agent_runtime(params = {}) ⇒ Types::CreateAgentRuntimeResponse
Creates an Amazon Secure Agent.
-
#create_agent_runtime_endpoint(params = {}) ⇒ Types::CreateAgentRuntimeEndpointResponse
Creates an Amazon Secure AgentEndpoint.
-
#create_api_key_credential_provider(params = {}) ⇒ Types::CreateApiKeyCredentialProviderResponse
Creates a new API key credential provider.
-
#create_browser(params = {}) ⇒ Types::CreateBrowserResponse
Creates a custom browser.
-
#create_code_interpreter(params = {}) ⇒ Types::CreateCodeInterpreterResponse
Creates a custom code interpreter.
-
#create_gateway(params = {}) ⇒ Types::CreateGatewayResponse
Creates a gateway for Amazon Bedrock Agent.
-
#create_gateway_target(params = {}) ⇒ Types::CreateGatewayTargetResponse
Creates a target for a gateway.
-
#create_memory(params = {}) ⇒ Types::CreateMemoryOutput
Creates a new memory.
-
#create_oauth_2_credential_provider(params = {}) ⇒ Types::CreateOauth2CredentialProviderResponse
Creates a new OAuth2 credential provider.
-
#create_workload_identity(params = {}) ⇒ Types::CreateWorkloadIdentityResponse
Creates a new workload identity.
-
#delete_agent_runtime(params = {}) ⇒ Types::DeleteAgentRuntimeResponse
Deletes an Amazon Secure Agent.
-
#delete_agent_runtime_endpoint(params = {}) ⇒ Types::DeleteAgentRuntimeEndpointResponse
Deletes an Amazon Secure AgentEndpoint.
-
#delete_api_key_credential_provider(params = {}) ⇒ Struct
Deletes an API key credential provider.
-
#delete_browser(params = {}) ⇒ Types::DeleteBrowserResponse
Deletes a custom browser.
-
#delete_code_interpreter(params = {}) ⇒ Types::DeleteCodeInterpreterResponse
Deletes a custom code interpreter.
-
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayResponse
Deletes a Gateway.
-
#delete_gateway_target(params = {}) ⇒ Types::DeleteGatewayTargetResponse
Deletes a Gateway Target.
-
#delete_memory(params = {}) ⇒ Types::DeleteMemoryOutput
Deletes a memory.
-
#delete_oauth_2_credential_provider(params = {}) ⇒ Struct
Deletes an OAuth2 credential provider.
-
#delete_workload_identity(params = {}) ⇒ Struct
Deletes a workload identity.
-
#get_agent_runtime(params = {}) ⇒ Types::GetAgentRuntimeResponse
Gets an Amazon Secure Agent.
-
#get_agent_runtime_endpoint(params = {}) ⇒ Types::GetAgentRuntimeEndpointResponse
Gets information about an Amazon Secure AgentEndpoint.
-
#get_api_key_credential_provider(params = {}) ⇒ Types::GetApiKeyCredentialProviderResponse
Retrieves information about an API key credential provider.
-
#get_browser(params = {}) ⇒ Types::GetBrowserResponse
Gets information about a custom browser.
-
#get_code_interpreter(params = {}) ⇒ Types::GetCodeInterpreterResponse
Gets information about a custom code interpreter.
-
#get_gateway(params = {}) ⇒ Types::GetGatewayResponse
Retrieves information about a specific Gateway.
-
#get_gateway_target(params = {}) ⇒ Types::GetGatewayTargetResponse
Retrieves information about a specific Gateway Target.
-
#get_memory(params = {}) ⇒ Types::GetMemoryOutput
Retrieve an existing memory.
-
#get_oauth_2_credential_provider(params = {}) ⇒ Types::GetOauth2CredentialProviderResponse
Retrieves information about an OAuth2 credential provider.
-
#get_token_vault(params = {}) ⇒ Types::GetTokenVaultResponse
Retrieves information about a token vault.
-
#get_workload_identity(params = {}) ⇒ Types::GetWorkloadIdentityResponse
Retrieves information about a workload identity.
-
#list_agent_runtime_endpoints(params = {}) ⇒ Types::ListAgentRuntimeEndpointsResponse
Lists all endpoints for a specific Amazon Secure Agent.
-
#list_agent_runtime_versions(params = {}) ⇒ Types::ListAgentRuntimeVersionsResponse
Lists all versions of a specific Amazon Secure Agent.
-
#list_agent_runtimes(params = {}) ⇒ Types::ListAgentRuntimesResponse
Lists all Amazon Secure Agents in your account.
-
#list_api_key_credential_providers(params = {}) ⇒ Types::ListApiKeyCredentialProvidersResponse
Lists all API key credential providers in your account.
-
#list_browsers(params = {}) ⇒ Types::ListBrowsersResponse
Lists all custom browsers in your account.
-
#list_code_interpreters(params = {}) ⇒ Types::ListCodeInterpretersResponse
Lists all custom code interpreters in your account.
-
#list_gateway_targets(params = {}) ⇒ Types::ListGatewayTargetsResponse
Lists all targets for a specific Gateway.
-
#list_gateways(params = {}) ⇒ Types::ListGatewaysResponse
Lists all Gateways in the account.
-
#list_memories(params = {}) ⇒ Types::ListMemoriesOutput
Lists the memory present.
-
#list_oauth_2_credential_providers(params = {}) ⇒ Types::ListOauth2CredentialProvidersResponse
Lists all OAuth2 credential providers in your account.
-
#list_workload_identities(params = {}) ⇒ Types::ListWorkloadIdentitiesResponse
Lists all workload identities in your account.
-
#set_token_vault_cmk(params = {}) ⇒ Types::SetTokenVaultCMKResponse
Sets the customer master key (CMK) for a token vault.
-
#update_agent_runtime(params = {}) ⇒ Types::UpdateAgentRuntimeResponse
Updates an existing Amazon Secure Agent.
-
#update_agent_runtime_endpoint(params = {}) ⇒ Types::UpdateAgentRuntimeEndpointResponse
Updates an existing Amazon Secure AgentEndpoint.
-
#update_api_key_credential_provider(params = {}) ⇒ Types::UpdateApiKeyCredentialProviderResponse
Updates an existing API key credential provider.
-
#update_gateway(params = {}) ⇒ Types::UpdateGatewayResponse
Updates an existing Gateway.
-
#update_gateway_target(params = {}) ⇒ Types::UpdateGatewayTargetResponse
Updates an existing Gateway Target.
-
#update_memory(params = {}) ⇒ Types::UpdateMemoryOutput
Update memory.
-
#update_oauth_2_credential_provider(params = {}) ⇒ Types::UpdateOauth2CredentialProviderResponse
Updates an existing OAuth2 credential provider.
-
#update_workload_identity(params = {}) ⇒ Types::UpdateWorkloadIdentityResponse
Updates an existing workload identity.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
476 477 478 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 476 def initialize(*args) super end |
Instance Method Details
#create_agent_runtime(params = {}) ⇒ Types::CreateAgentRuntimeResponse
Creates an Amazon Secure Agent.
568 569 570 571 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 568 def create_agent_runtime(params = {}, = {}) req = build_request(:create_agent_runtime, params) req.send_request() end |
#create_agent_runtime_endpoint(params = {}) ⇒ Types::CreateAgentRuntimeEndpointResponse
Creates an Amazon Secure AgentEndpoint.
624 625 626 627 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 624 def create_agent_runtime_endpoint(params = {}, = {}) req = build_request(:create_agent_runtime_endpoint, params) req.send_request() end |
#create_api_key_credential_provider(params = {}) ⇒ Types::CreateApiKeyCredentialProviderResponse
Creates a new API key credential provider.
662 663 664 665 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 662 def create_api_key_credential_provider(params = {}, = {}) req = build_request(:create_api_key_credential_provider, params) req.send_request() end |
#create_browser(params = {}) ⇒ Types::CreateBrowserResponse
Creates a custom browser.
733 734 735 736 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 733 def create_browser(params = {}, = {}) req = build_request(:create_browser, params) req.send_request() end |
#create_code_interpreter(params = {}) ⇒ Types::CreateCodeInterpreterResponse
Creates a custom code interpreter.
795 796 797 798 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 795 def create_code_interpreter(params = {}, = {}) req = build_request(:create_code_interpreter, params) req.send_request() end |
#create_gateway(params = {}) ⇒ Types::CreateGatewayResponse
Creates a gateway for Amazon Bedrock Agent. A gateway serves as an integration point between your agent and external services.
To create a gateway, you must specify a name, protocol type, and IAM role. The role grants the gateway permission to access Amazon Web Services services and resources.
929 930 931 932 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 929 def create_gateway(params = {}, = {}) req = build_request(:create_gateway, params) req.send_request() end |
#create_gateway_target(params = {}) ⇒ Types::CreateGatewayTargetResponse
Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.
To create a target, you must specify the gateway identifier and target configuration.
1123 1124 1125 1126 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1123 def create_gateway_target(params = {}, = {}) req = build_request(:create_gateway_target, params) req.send_request() end |
#create_memory(params = {}) ⇒ Types::CreateMemoryOutput
Creates a new memory.
1267 1268 1269 1270 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1267 def create_memory(params = {}, = {}) req = build_request(:create_memory, params) req.send_request() end |
#create_oauth_2_credential_provider(params = {}) ⇒ Types::CreateOauth2CredentialProviderResponse
Creates a new OAuth2 credential provider.
1344 1345 1346 1347 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1344 def create_oauth_2_credential_provider(params = {}, = {}) req = build_request(:create_oauth_2_credential_provider, params) req.send_request() end |
#create_workload_identity(params = {}) ⇒ Types::CreateWorkloadIdentityResponse
Creates a new workload identity.
1383 1384 1385 1386 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1383 def create_workload_identity(params = {}, = {}) req = build_request(:create_workload_identity, params) req.send_request() end |
#delete_agent_runtime(params = {}) ⇒ Types::DeleteAgentRuntimeResponse
Deletes an Amazon Secure Agent.
1411 1412 1413 1414 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1411 def delete_agent_runtime(params = {}, = {}) req = build_request(:delete_agent_runtime, params) req.send_request() end |
#delete_agent_runtime_endpoint(params = {}) ⇒ Types::DeleteAgentRuntimeEndpointResponse
Deletes an Amazon Secure AgentEndpoint.
1452 1453 1454 1455 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1452 def delete_agent_runtime_endpoint(params = {}, = {}) req = build_request(:delete_agent_runtime_endpoint, params) req.send_request() end |
#delete_api_key_credential_provider(params = {}) ⇒ Struct
Deletes an API key credential provider.
1474 1475 1476 1477 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1474 def delete_api_key_credential_provider(params = {}, = {}) req = build_request(:delete_api_key_credential_provider, params) req.send_request() end |
#delete_browser(params = {}) ⇒ Types::DeleteBrowserResponse
Deletes a custom browser.
1514 1515 1516 1517 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1514 def delete_browser(params = {}, = {}) req = build_request(:delete_browser, params) req.send_request() end |
#delete_code_interpreter(params = {}) ⇒ Types::DeleteCodeInterpreterResponse
Deletes a custom code interpreter.
1554 1555 1556 1557 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1554 def delete_code_interpreter(params = {}, = {}) req = build_request(:delete_code_interpreter, params) req.send_request() end |
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayResponse
Deletes a Gateway.
1588 1589 1590 1591 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1588 def delete_gateway(params = {}, = {}) req = build_request(:delete_gateway, params) req.send_request() end |
#delete_gateway_target(params = {}) ⇒ Types::DeleteGatewayTargetResponse
Deletes a Gateway Target.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1627 def delete_gateway_target(params = {}, = {}) req = build_request(:delete_gateway_target, params) req.send_request() end |
#delete_memory(params = {}) ⇒ Types::DeleteMemoryOutput
Deletes a memory.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1666 def delete_memory(params = {}, = {}) req = build_request(:delete_memory, params) req.send_request() end |
#delete_oauth_2_credential_provider(params = {}) ⇒ Struct
Deletes an OAuth2 credential provider.
1688 1689 1690 1691 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1688 def delete_oauth_2_credential_provider(params = {}, = {}) req = build_request(:delete_oauth_2_credential_provider, params) req.send_request() end |
#delete_workload_identity(params = {}) ⇒ Struct
Deletes a workload identity.
1710 1711 1712 1713 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1710 def delete_workload_identity(params = {}, = {}) req = build_request(:delete_workload_identity, params) req.send_request() end |
#get_agent_runtime(params = {}) ⇒ Types::GetAgentRuntimeResponse
Gets an Amazon Secure Agent.
1775 1776 1777 1778 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1775 def get_agent_runtime(params = {}, = {}) req = build_request(:get_agent_runtime, params) req.send_request() end |
#get_agent_runtime_endpoint(params = {}) ⇒ Types::GetAgentRuntimeEndpointResponse
Gets information about an Amazon Secure AgentEndpoint.
1828 1829 1830 1831 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1828 def get_agent_runtime_endpoint(params = {}, = {}) req = build_request(:get_agent_runtime_endpoint, params) req.send_request() end |
#get_api_key_credential_provider(params = {}) ⇒ Types::GetApiKeyCredentialProviderResponse
Retrieves information about an API key credential provider.
1864 1865 1866 1867 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1864 def get_api_key_credential_provider(params = {}, = {}) req = build_request(:get_api_key_credential_provider, params) req.send_request() end |
#get_browser(params = {}) ⇒ Types::GetBrowserResponse
Gets information about a custom browser.
1912 1913 1914 1915 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1912 def get_browser(params = {}, = {}) req = build_request(:get_browser, params) req.send_request() end |
#get_code_interpreter(params = {}) ⇒ Types::GetCodeInterpreterResponse
Gets information about a custom code interpreter.
1956 1957 1958 1959 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1956 def get_code_interpreter(params = {}, = {}) req = build_request(:get_code_interpreter, params) req.send_request() end |
#get_gateway(params = {}) ⇒ Types::GetGatewayResponse
Retrieves information about a specific Gateway.
2025 2026 2027 2028 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2025 def get_gateway(params = {}, = {}) req = build_request(:get_gateway, params) req.send_request() end |
#get_gateway_target(params = {}) ⇒ Types::GetGatewayTargetResponse
Retrieves information about a specific Gateway Target.
2112 2113 2114 2115 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2112 def get_gateway_target(params = {}, = {}) req = build_request(:get_gateway_target, params) req.send_request() end |
#get_memory(params = {}) ⇒ Types::GetMemoryOutput
Retrieve an existing memory.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- memory_created
2176 2177 2178 2179 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2176 def get_memory(params = {}, = {}) req = build_request(:get_memory, params) req.send_request() end |
#get_oauth_2_credential_provider(params = {}) ⇒ Types::GetOauth2CredentialProviderResponse
Retrieves information about an OAuth2 credential provider.
2251 2252 2253 2254 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2251 def get_oauth_2_credential_provider(params = {}, = {}) req = build_request(:get_oauth_2_credential_provider, params) req.send_request() end |
#get_token_vault(params = {}) ⇒ Types::GetTokenVaultResponse
Retrieves information about a token vault.
2284 2285 2286 2287 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2284 def get_token_vault(params = {}, = {}) req = build_request(:get_token_vault, params) req.send_request() end |
#get_workload_identity(params = {}) ⇒ Types::GetWorkloadIdentityResponse
Retrieves information about a workload identity.
2321 2322 2323 2324 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2321 def get_workload_identity(params = {}, = {}) req = build_request(:get_workload_identity, params) req.send_request() end |
#list_agent_runtime_endpoints(params = {}) ⇒ Types::ListAgentRuntimeEndpointsResponse
Lists all endpoints for a specific Amazon Secure Agent.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2371 2372 2373 2374 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2371 def list_agent_runtime_endpoints(params = {}, = {}) req = build_request(:list_agent_runtime_endpoints, params) req.send_request() end |
#list_agent_runtime_versions(params = {}) ⇒ Types::ListAgentRuntimeVersionsResponse
Lists all versions of a specific Amazon Secure Agent.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2418 2419 2420 2421 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2418 def list_agent_runtime_versions(params = {}, = {}) req = build_request(:list_agent_runtime_versions, params) req.send_request() end |
#list_agent_runtimes(params = {}) ⇒ Types::ListAgentRuntimesResponse
Lists all Amazon Secure Agents in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2461 2462 2463 2464 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2461 def list_agent_runtimes(params = {}, = {}) req = build_request(:list_agent_runtimes, params) req.send_request() end |
#list_api_key_credential_providers(params = {}) ⇒ Types::ListApiKeyCredentialProvidersResponse
Lists all API key credential providers in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2501 2502 2503 2504 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2501 def list_api_key_credential_providers(params = {}, = {}) req = build_request(:list_api_key_credential_providers, params) req.send_request() end |
#list_browsers(params = {}) ⇒ Types::ListBrowsersResponse
Lists all custom browsers in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2552 2553 2554 2555 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2552 def list_browsers(params = {}, = {}) req = build_request(:list_browsers, params) req.send_request() end |
#list_code_interpreters(params = {}) ⇒ Types::ListCodeInterpretersResponse
Lists all custom code interpreters in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2599 2600 2601 2602 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2599 def list_code_interpreters(params = {}, = {}) req = build_request(:list_code_interpreters, params) req.send_request() end |
#list_gateway_targets(params = {}) ⇒ Types::ListGatewayTargetsResponse
Lists all targets for a specific Gateway.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2649 2650 2651 2652 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2649 def list_gateway_targets(params = {}, = {}) req = build_request(:list_gateway_targets, params) req.send_request() end |
#list_gateways(params = {}) ⇒ Types::ListGatewaysResponse
Lists all Gateways in the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2696 2697 2698 2699 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2696 def list_gateways(params = {}, = {}) req = build_request(:list_gateways, params) req.send_request() end |
#list_memories(params = {}) ⇒ Types::ListMemoriesOutput
Lists the memory present.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2740 2741 2742 2743 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2740 def list_memories(params = {}, = {}) req = build_request(:list_memories, params) req.send_request() end |
#list_oauth_2_credential_providers(params = {}) ⇒ Types::ListOauth2CredentialProvidersResponse
Lists all OAuth2 credential providers in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2781 2782 2783 2784 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2781 def list_oauth_2_credential_providers(params = {}, = {}) req = build_request(:list_oauth_2_credential_providers, params) req.send_request() end |
#list_workload_identities(params = {}) ⇒ Types::ListWorkloadIdentitiesResponse
Lists all workload identities in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2819 2820 2821 2822 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2819 def list_workload_identities(params = {}, = {}) req = build_request(:list_workload_identities, params) req.send_request() end |
#set_token_vault_cmk(params = {}) ⇒ Types::SetTokenVaultCMKResponse
Sets the customer master key (CMK) for a token vault.
2860 2861 2862 2863 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2860 def set_token_vault_cmk(params = {}, = {}) req = build_request(:set_token_vault_cmk, params) req.send_request() end |
#update_agent_runtime(params = {}) ⇒ Types::UpdateAgentRuntimeResponse
Updates an existing Amazon Secure Agent.
2954 2955 2956 2957 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2954 def update_agent_runtime(params = {}, = {}) req = build_request(:update_agent_runtime, params) req.send_request() end |
#update_agent_runtime_endpoint(params = {}) ⇒ Types::UpdateAgentRuntimeEndpointResponse
Updates an existing Amazon Secure AgentEndpoint.
3015 3016 3017 3018 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3015 def update_agent_runtime_endpoint(params = {}, = {}) req = build_request(:update_agent_runtime_endpoint, params) req.send_request() end |
#update_api_key_credential_provider(params = {}) ⇒ Types::UpdateApiKeyCredentialProviderResponse
Updates an existing API key credential provider.
3056 3057 3058 3059 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3056 def update_api_key_credential_provider(params = {}, = {}) req = build_request(:update_api_key_credential_provider, params) req.send_request() end |
#update_gateway(params = {}) ⇒ Types::UpdateGatewayResponse
Updates an existing Gateway.
3177 3178 3179 3180 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3177 def update_gateway(params = {}, = {}) req = build_request(:update_gateway, params) req.send_request() end |
#update_gateway_target(params = {}) ⇒ Types::UpdateGatewayTargetResponse
Updates an existing Gateway Target.
3357 3358 3359 3360 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3357 def update_gateway_target(params = {}, = {}) req = build_request(:update_gateway_target, params) req.send_request() end |
#update_memory(params = {}) ⇒ Types::UpdateMemoryOutput
Update memory.
3537 3538 3539 3540 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3537 def update_memory(params = {}, = {}) req = build_request(:update_memory, params) req.send_request() end |
#update_oauth_2_credential_provider(params = {}) ⇒ Types::UpdateOauth2CredentialProviderResponse
Updates an existing OAuth2 credential provider.
3654 3655 3656 3657 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3654 def update_oauth_2_credential_provider(params = {}, = {}) req = build_request(:update_oauth_2_credential_provider, params) req.send_request() end |
#update_workload_identity(params = {}) ⇒ Types::UpdateWorkloadIdentityResponse
Updates an existing workload identity.
3696 3697 3698 3699 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3696 def update_workload_identity(params = {}, = {}) req = build_request(:update_workload_identity, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
memory_created | #get_memory | 2 | 60 |
3811 3812 3813 3814 3815 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3811 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |