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.
466 467 468 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 466 def initialize(*args) super end |
Instance Method Details
#create_agent_runtime(params = {}) ⇒ Types::CreateAgentRuntimeResponse
Creates an Amazon Secure Agent.
558 559 560 561 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 558 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.
614 615 616 617 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 614 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.
652 653 654 655 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 652 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.
723 724 725 726 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 723 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.
785 786 787 788 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 785 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.
919 920 921 922 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 919 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.
1113 1114 1115 1116 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1113 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.
1257 1258 1259 1260 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1257 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.
1334 1335 1336 1337 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1334 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.
1373 1374 1375 1376 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1373 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.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1401 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.
1442 1443 1444 1445 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1442 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.
1464 1465 1466 1467 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1464 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.
1504 1505 1506 1507 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1504 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.
1544 1545 1546 1547 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1544 def delete_code_interpreter(params = {}, = {}) req = build_request(:delete_code_interpreter, params) req.send_request() end |
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayResponse
Deletes a Gateway.
1578 1579 1580 1581 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1578 def delete_gateway(params = {}, = {}) req = build_request(:delete_gateway, params) req.send_request() end |
#delete_gateway_target(params = {}) ⇒ Types::DeleteGatewayTargetResponse
Deletes a Gateway Target.
1617 1618 1619 1620 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1617 def delete_gateway_target(params = {}, = {}) req = build_request(:delete_gateway_target, params) req.send_request() end |
#delete_memory(params = {}) ⇒ Types::DeleteMemoryOutput
Deletes a memory.
1656 1657 1658 1659 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1656 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.
1678 1679 1680 1681 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1678 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.
1700 1701 1702 1703 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1700 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.
1765 1766 1767 1768 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1765 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.
1818 1819 1820 1821 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1818 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.
1854 1855 1856 1857 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1854 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.
1902 1903 1904 1905 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1902 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.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1946 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.
2015 2016 2017 2018 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2015 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.
2102 2103 2104 2105 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2102 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
2166 2167 2168 2169 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2166 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.
2241 2242 2243 2244 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2241 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.
2274 2275 2276 2277 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2274 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.
2311 2312 2313 2314 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2311 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.
2361 2362 2363 2364 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2361 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.
2408 2409 2410 2411 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2408 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.
2451 2452 2453 2454 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2451 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.
2491 2492 2493 2494 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2491 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.
2542 2543 2544 2545 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2542 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.
2589 2590 2591 2592 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2589 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.
2639 2640 2641 2642 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2639 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.
2686 2687 2688 2689 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2686 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.
2730 2731 2732 2733 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2730 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.
2771 2772 2773 2774 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2771 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.
2809 2810 2811 2812 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2809 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.
2850 2851 2852 2853 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2850 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.
2944 2945 2946 2947 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2944 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.
3005 3006 3007 3008 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3005 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.
3046 3047 3048 3049 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3046 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.
3167 3168 3169 3170 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3167 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.
3347 3348 3349 3350 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3347 def update_gateway_target(params = {}, = {}) req = build_request(:update_gateway_target, params) req.send_request() end |
#update_memory(params = {}) ⇒ Types::UpdateMemoryOutput
Update memory.
3527 3528 3529 3530 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3527 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.
3644 3645 3646 3647 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3644 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.
3686 3687 3688 3689 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3686 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 |
3801 3802 3803 3804 3805 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3801 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |