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
-
#add_dataset_examples(params = {}) ⇒ Types::AddDatasetExamplesResponse
Adds examples to the dataset's DRAFT.
-
#batch_put_gateway_rate_limits(params = {}) ⇒ Types::BatchPutGatewayRateLimitsResponse
Atomically creates or updates multiple rate limits for a gateway.
-
#create_agent_runtime(params = {}) ⇒ Types::CreateAgentRuntimeResponse
Creates an Amazon Bedrock AgentCore Runtime.
-
#create_agent_runtime_endpoint(params = {}) ⇒ Types::CreateAgentRuntimeEndpointResponse
Creates an AgentCore Runtime endpoint.
-
#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_browser_profile(params = {}) ⇒ Types::CreateBrowserProfileResponse
Creates a browser profile in Amazon Bedrock AgentCore.
-
#create_capacity_provider(params = {}) ⇒ Types::CreateCapacityProviderOutput
Creates a capacity provider.
-
#create_code_interpreter(params = {}) ⇒ Types::CreateCodeInterpreterResponse
Creates a custom code interpreter.
-
#create_configuration_bundle(params = {}) ⇒ Types::CreateConfigurationBundleResponse
Creates a new configuration bundle resource.
-
#create_consent_portal(params = {}) ⇒ Types::CreateConsentPortalResponse
Creates a new consent portal.
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a new dataset resource asynchronously.
-
#create_dataset_version(params = {}) ⇒ Types::CreateDatasetVersionResponse
Publishes the current DRAFT as a new numbered version.
-
#create_evaluator(params = {}) ⇒ Types::CreateEvaluatorResponse
Creates a custom evaluator for agent quality assessment.
-
#create_gateway(params = {}) ⇒ Types::CreateGatewayResponse
Creates a gateway for Amazon Bedrock Agent.
-
#create_gateway_rate_limit(params = {}) ⇒ Types::CreateGatewayRateLimitResponse
Creates a rate limit for a gateway.
-
#create_gateway_rule(params = {}) ⇒ Types::CreateGatewayRuleResponse
Creates a rule for a gateway.
-
#create_gateway_target(params = {}) ⇒ Types::CreateGatewayTargetResponse
Creates a target for a gateway.
-
#create_harness(params = {}) ⇒ Types::CreateHarnessResponse
Operation to create a harness.
-
#create_harness_endpoint(params = {}) ⇒ Types::CreateHarnessEndpointResponse
Operation to create a harness endpoint.
-
#create_memory(params = {}) ⇒ Types::CreateMemoryOutput
Creates a new Amazon Bedrock AgentCore Memory resource.
-
#create_oauth_2_credential_provider(params = {}) ⇒ Types::CreateOauth2CredentialProviderResponse
Creates a new OAuth2 credential provider.
-
#create_online_evaluation_config(params = {}) ⇒ Types::CreateOnlineEvaluationConfigResponse
Creates an online evaluation configuration for continuous monitoring of agent performance.
-
#create_payment_connector(params = {}) ⇒ Types::CreatePaymentConnectorResponse
Creates a new payment connector for a payment manager.
-
#create_payment_credential_provider(params = {}) ⇒ Types::CreatePaymentCredentialProviderResponse
Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.
-
#create_payment_manager(params = {}) ⇒ Types::CreatePaymentManagerResponse
Creates a new payment manager in your Amazon Web Services account.
-
#create_policy(params = {}) ⇒ Types::CreatePolicyResponse
Creates a policy within the AgentCore Policy system.
-
#create_policy_engine(params = {}) ⇒ Types::CreatePolicyEngineResponse
Creates a new policy engine within the AgentCore Policy system.
-
#create_registry(params = {}) ⇒ Types::CreateRegistryResponse
Creates a new registry in your Amazon Web Services account.
-
#create_registry_record(params = {}) ⇒ Types::CreateRegistryRecordResponse
Creates a new registry record within the specified registry.
-
#create_workload_identity(params = {}) ⇒ Types::CreateWorkloadIdentityResponse
Creates a new workload identity.
-
#delete_agent_runtime(params = {}) ⇒ Types::DeleteAgentRuntimeResponse
Deletes an Amazon Bedrock AgentCore Runtime, or a single version of an AgentCore Runtime when you provide the version qualifier.
-
#delete_agent_runtime_endpoint(params = {}) ⇒ Types::DeleteAgentRuntimeEndpointResponse
Deletes an AgentCore Runtime endpoint.
-
#delete_api_key_credential_provider(params = {}) ⇒ Struct
Deletes an API key credential provider.
-
#delete_browser(params = {}) ⇒ Types::DeleteBrowserResponse
Deletes a custom browser.
-
#delete_browser_profile(params = {}) ⇒ Types::DeleteBrowserProfileResponse
Deletes a browser profile.
-
#delete_capacity_provider(params = {}) ⇒ Types::DeleteCapacityProviderOutput
Deletes a capacity provider.
-
#delete_code_interpreter(params = {}) ⇒ Types::DeleteCodeInterpreterResponse
Deletes a custom code interpreter.
-
#delete_configuration_bundle(params = {}) ⇒ Types::DeleteConfigurationBundleResponse
Deletes a configuration bundle and all of its versions.
-
#delete_consent_portal(params = {}) ⇒ Struct
Deletes a consent portal.
-
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a dataset version or an entire dataset asynchronously.
-
#delete_dataset_examples(params = {}) ⇒ Types::DeleteDatasetExamplesResponse
Deletes specific examples by ID from DRAFT.
-
#delete_evaluator(params = {}) ⇒ Types::DeleteEvaluatorResponse
Deletes a custom evaluator.
-
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayResponse
Deletes a gateway.
-
#delete_gateway_rate_limit(params = {}) ⇒ Types::DeleteGatewayRateLimitResponse
Deletes a gateway rate limit.
-
#delete_gateway_rule(params = {}) ⇒ Types::DeleteGatewayRuleResponse
Deletes a gateway rule.
-
#delete_gateway_target(params = {}) ⇒ Types::DeleteGatewayTargetResponse
Deletes a gateway target.
-
#delete_harness(params = {}) ⇒ Types::DeleteHarnessResponse
Operation to delete a Harness.
-
#delete_harness_endpoint(params = {}) ⇒ Types::DeleteHarnessEndpointResponse
Operation to delete a harness endpoint.
-
#delete_memory(params = {}) ⇒ Types::DeleteMemoryOutput
Deletes an Amazon Bedrock AgentCore Memory resource.
-
#delete_oauth_2_credential_provider(params = {}) ⇒ Struct
Deletes an OAuth2 credential provider.
-
#delete_online_evaluation_config(params = {}) ⇒ Types::DeleteOnlineEvaluationConfigResponse
Deletes an online evaluation configuration and stops any ongoing evaluation processes associated with it.
-
#delete_payment_connector(params = {}) ⇒ Types::DeletePaymentConnectorResponse
Deletes a payment connector.
-
#delete_payment_credential_provider(params = {}) ⇒ Struct
Deletes a payment credential provider and its associated stored credentials.
-
#delete_payment_manager(params = {}) ⇒ Types::DeletePaymentManagerResponse
Deletes a payment manager.
-
#delete_policy(params = {}) ⇒ Types::DeletePolicyResponse
Deletes an existing policy from the AgentCore Policy system.
-
#delete_policy_engine(params = {}) ⇒ Types::DeletePolicyEngineResponse
Deletes an existing policy engine from the AgentCore Policy system.
-
#delete_registry(params = {}) ⇒ Types::DeleteRegistryResponse
Deletes a registry.
-
#delete_registry_record(params = {}) ⇒ Struct
Deletes a registry record.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the resource-based policy for a specified resource.
-
#delete_workload_identity(params = {}) ⇒ Struct
Deletes a workload identity.
-
#get_agent_insight_store(params = {}) ⇒ Types::GetAgentInsightStoreResponse
Returns the account's service-defined default Agent Insight Store.
-
#get_agent_runtime(params = {}) ⇒ Types::GetAgentRuntimeResponse
Gets an Amazon Bedrock AgentCore Runtime.
-
#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_browser_profile(params = {}) ⇒ Types::GetBrowserProfileResponse
Gets information about a browser profile.
-
#get_capacity_provider(params = {}) ⇒ Types::GetCapacityProviderOutput
Retrieves information about a capacity provider, including its status, permissions configuration, and compute configuration.
-
#get_code_interpreter(params = {}) ⇒ Types::GetCodeInterpreterResponse
Gets information about a custom code interpreter.
-
#get_configuration_bundle(params = {}) ⇒ Types::GetConfigurationBundleResponse
Gets the latest version of a configuration bundle.
-
#get_configuration_bundle_version(params = {}) ⇒ Types::GetConfigurationBundleVersionResponse
Gets a specific version of a configuration bundle by its version identifier.
-
#get_consent_portal(params = {}) ⇒ Types::GetConsentPortalResponse
Retrieves information about a consent portal.
-
#get_dataset(params = {}) ⇒ Types::GetDatasetResponse
Retrieves dataset metadata.
-
#get_evaluator(params = {}) ⇒ Types::GetEvaluatorResponse
Retrieves detailed information about an evaluator, including its configuration, status, and metadata.
-
#get_gateway(params = {}) ⇒ Types::GetGatewayResponse
Retrieves information about a specific Gateway.
-
#get_gateway_rate_limit(params = {}) ⇒ Types::GetGatewayRateLimitResponse
Retrieves information about a gateway rate limit.
-
#get_gateway_rule(params = {}) ⇒ Types::GetGatewayRuleResponse
Retrieves detailed information about a specific gateway rule.
-
#get_gateway_target(params = {}) ⇒ Types::GetGatewayTargetResponse
Retrieves information about a specific gateway target.
-
#get_harness(params = {}) ⇒ Types::GetHarnessResponse
Operation to get a single harness.
-
#get_harness_endpoint(params = {}) ⇒ Types::GetHarnessEndpointResponse
Operation to get a single harness endpoint.
-
#get_memory(params = {}) ⇒ Types::GetMemoryOutput
Retrieve an existing Amazon Bedrock AgentCore Memory resource.
-
#get_oauth_2_credential_provider(params = {}) ⇒ Types::GetOauth2CredentialProviderResponse
Retrieves information about an OAuth2 credential provider.
-
#get_online_evaluation_config(params = {}) ⇒ Types::GetOnlineEvaluationConfigResponse
Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.
-
#get_payment_connector(params = {}) ⇒ Types::GetPaymentConnectorResponse
Retrieves information about a specific payment connector.
-
#get_payment_credential_provider(params = {}) ⇒ Types::GetPaymentCredentialProviderResponse
Retrieves information about a specific payment credential provider.
-
#get_payment_manager(params = {}) ⇒ Types::GetPaymentManagerResponse
Retrieves information about a specific payment manager.
-
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Retrieves detailed information about a specific policy within the AgentCore Policy system.
-
#get_policy_engine(params = {}) ⇒ Types::GetPolicyEngineResponse
Retrieves detailed information about a specific policy engine within the AgentCore Policy system.
-
#get_policy_engine_summary(params = {}) ⇒ Types::GetPolicyEngineSummaryResponse
Retrieves a metadata-only summary of a specific policy engine without decrypting customer content.
-
#get_policy_generation(params = {}) ⇒ Types::GetPolicyGenerationResponse
Retrieves information about a policy generation request within the AgentCore Policy system.
-
#get_policy_generation_summary(params = {}) ⇒ Types::GetPolicyGenerationSummaryResponse
Retrieves a metadata-only summary of a specific policy generation request without decrypting customer content.
-
#get_policy_summary(params = {}) ⇒ Types::GetPolicySummaryResponse
Retrieves a metadata-only summary of a specific policy without decrypting customer content.
-
#get_registry(params = {}) ⇒ Types::GetRegistryResponse
Retrieves information about a specific registry.
-
#get_registry_record(params = {}) ⇒ Types::GetRegistryRecordResponse
Retrieves information about a specific registry record.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves the resource-based policy for a specified resource.
-
#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_insight_stores(params = {}) ⇒ Types::ListAgentInsightStoresResponse
Lists the account's service-defined default Agent Insight Store.
-
#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_runtime_versions_by_capacity_provider(params = {}) ⇒ Types::ListAgentRuntimeVersionsByCapacityProviderOutput
Lists the agent runtime versions that are associated with a capacity provider.
-
#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_browser_profiles(params = {}) ⇒ Types::ListBrowserProfilesResponse
Lists all browser profiles in your account.
-
#list_browsers(params = {}) ⇒ Types::ListBrowsersResponse
Lists all custom browsers in your account.
-
#list_capacity_providers(params = {}) ⇒ Types::ListCapacityProvidersOutput
Lists the capacity providers in your account and returns summary information for each one.
-
#list_code_interpreters(params = {}) ⇒ Types::ListCodeInterpretersResponse
Lists all custom code interpreters in your account.
-
#list_configuration_bundle_versions(params = {}) ⇒ Types::ListConfigurationBundleVersionsResponse
Lists all versions of a configuration bundle, with optional filtering by branch name or creation source.
-
#list_configuration_bundles(params = {}) ⇒ Types::ListConfigurationBundlesResponse
Lists all configuration bundles in the account.
-
#list_consent_portals(params = {}) ⇒ Types::ListConsentPortalsResponse
Lists all of the consent portals in your account.
-
#list_dataset_examples(params = {}) ⇒ Types::ListDatasetExamplesResponse
Returns paginated examples from the dataset.
-
#list_dataset_versions(params = {}) ⇒ Types::ListDatasetVersionsResponse
Lists all published versions of a dataset, sorted by version number descending (newest first).
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Lists all datasets in the caller's account, paginated.
-
#list_evaluators(params = {}) ⇒ Types::ListEvaluatorsResponse
Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.
-
#list_gateway_rate_limits(params = {}) ⇒ Types::ListGatewayRateLimitsResponse
Lists all rate limits for a gateway.
-
#list_gateway_rules(params = {}) ⇒ Types::ListGatewayRulesResponse
Lists all rules for a gateway.
-
#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_harness_endpoints(params = {}) ⇒ Types::ListHarnessEndpointsResponse
Operation to list the endpoints of a harness.
-
#list_harness_versions(params = {}) ⇒ Types::ListHarnessVersionsResponse
Operation to list the versions of a Harness.
-
#list_harnesses(params = {}) ⇒ Types::ListHarnessesResponse
Operation to list harnesses.
-
#list_memories(params = {}) ⇒ Types::ListMemoriesOutput
Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.
-
#list_oauth_2_credential_providers(params = {}) ⇒ Types::ListOauth2CredentialProvidersResponse
Lists all OAuth2 credential providers in your account.
-
#list_online_evaluation_configs(params = {}) ⇒ Types::ListOnlineEvaluationConfigsResponse
Lists all online evaluation configurations in the account, providing summary information about each configuration's status and settings.
-
#list_payment_connectors(params = {}) ⇒ Types::ListPaymentConnectorsResponse
Lists all payment connectors for a specified payment manager.
-
#list_payment_credential_providers(params = {}) ⇒ Types::ListPaymentCredentialProvidersResponse
Lists all payment credential providers in the account.
-
#list_payment_managers(params = {}) ⇒ Types::ListPaymentManagersResponse
Lists all payment managers in the account.
-
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Retrieves a list of policies within the AgentCore Policy engine.
-
#list_policy_engine_summaries(params = {}) ⇒ Types::ListPolicyEngineSummariesResponse
Retrieves a paginated list of metadata-only policy engine summaries without decrypting customer content.
-
#list_policy_engines(params = {}) ⇒ Types::ListPolicyEnginesResponse
Retrieves a list of policy engines within the AgentCore Policy system.
-
#list_policy_generation_assets(params = {}) ⇒ Types::ListPolicyGenerationAssetsResponse
Retrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system.
-
#list_policy_generation_summaries(params = {}) ⇒ Types::ListPolicyGenerationSummariesResponse
Retrieves a paginated list of metadata-only policy generation summaries within a policy engine without decrypting customer content.
-
#list_policy_generations(params = {}) ⇒ Types::ListPolicyGenerationsResponse
Retrieves a list of policy generation requests within the AgentCore Policy system.
-
#list_policy_summaries(params = {}) ⇒ Types::ListPolicySummariesResponse
Retrieves a paginated list of metadata-only policy summaries within a policy engine without decrypting customer content.
-
#list_registries(params = {}) ⇒ Types::ListRegistriesResponse
Lists all registries in the account.
-
#list_registry_records(params = {}) ⇒ Types::ListRegistryRecordsResponse
Lists registry records within a registry.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags associated with the specified resource.
-
#list_workload_identities(params = {}) ⇒ Types::ListWorkloadIdentitiesResponse
Lists all workload identities in your account.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Creates or updates a resource-based policy for a resource with the specified resourceArn.
-
#reset_token_vault_key_material(params = {}) ⇒ Types::ResetTokenVaultKeyMaterialResponse
Resets the key material for a token vault whose customer managed KMS key has been deleted, and re-encrypts the token vault with an Amazon Web Services managed key so that you can use the token vault again.
-
#rotate_payment_connector_credentials(params = {}) ⇒ Types::RotatePaymentConnectorCredentialsResponse
Replaces the service-managed credentials of a payment connector with newly issued credentials.
-
#set_token_vault_cmk(params = {}) ⇒ Types::SetTokenVaultCMKResponse
Sets the customer master key (CMK) for a token vault.
-
#start_policy_generation(params = {}) ⇒ Types::StartPolicyGenerationResponse
Initiates the AI-powered generation of Dogwood policies from natural language descriptions within the AgentCore Policy system.
-
#submit_registry_record_for_approval(params = {}) ⇒ Types::SubmitRegistryRecordForApprovalResponse
Submits a registry record for approval.
-
#synchronize_gateway_targets(params = {}) ⇒ Types::SynchronizeGatewayTargetsResponse
Synchronizes the gateway targets by fetching the latest tool definitions from the target endpoints.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified resourceArn.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
-
#update_agent_insight_store(params = {}) ⇒ Types::UpdateAgentInsightStoreResponse
Updates the enablement status or encryption configuration of an Agent Insight Store.
-
#update_agent_runtime(params = {}) ⇒ Types::UpdateAgentRuntimeResponse
Updates an existing Amazon Secure Agent.
-
#update_agent_runtime_endpoint(params = {}) ⇒ Types::UpdateAgentRuntimeEndpointResponse
Updates an existing Amazon Bedrock AgentCore Runtime endpoint.
-
#update_api_key_credential_provider(params = {}) ⇒ Types::UpdateApiKeyCredentialProviderResponse
Updates an existing API key credential provider.
-
#update_capacity_provider(params = {}) ⇒ Types::UpdateCapacityProviderOutput
Updates a capacity provider.
-
#update_configuration_bundle(params = {}) ⇒ Types::UpdateConfigurationBundleResponse
Updates a configuration bundle by creating a new version with the specified changes.
-
#update_consent_portal(params = {}) ⇒ Types::UpdateConsentPortalResponse
Updates an existing consent portal.
-
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Updates a dataset's metadata.
-
#update_dataset_examples(params = {}) ⇒ Types::UpdateDatasetExamplesResponse
Updates multiple existing examples in-place on DRAFT.
-
#update_evaluator(params = {}) ⇒ Types::UpdateEvaluatorResponse
Updates a custom evaluator's configuration, description, or evaluation level.
-
#update_gateway(params = {}) ⇒ Types::UpdateGatewayResponse
Updates an existing gateway.
-
#update_gateway_rate_limit(params = {}) ⇒ Types::UpdateGatewayRateLimitResponse
Updates the entries of a gateway rate limit.
-
#update_gateway_rule(params = {}) ⇒ Types::UpdateGatewayRuleResponse
Updates a gateway rule's priority, conditions, actions, or description.
-
#update_gateway_target(params = {}) ⇒ Types::UpdateGatewayTargetResponse
Updates an existing gateway target.
-
#update_harness(params = {}) ⇒ Types::UpdateHarnessResponse
Operation to update a harness.
-
#update_harness_endpoint(params = {}) ⇒ Types::UpdateHarnessEndpointResponse
Operation to update a harness endpoint.
-
#update_memory(params = {}) ⇒ Types::UpdateMemoryOutput
Update an Amazon Bedrock AgentCore Memory resource memory.
-
#update_oauth_2_credential_provider(params = {}) ⇒ Types::UpdateOauth2CredentialProviderResponse
Updates an existing OAuth2 credential provider.
-
#update_online_evaluation_config(params = {}) ⇒ Types::UpdateOnlineEvaluationConfigResponse
Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status.
-
#update_payment_connector(params = {}) ⇒ Types::UpdatePaymentConnectorResponse
Updates an existing payment connector.
-
#update_payment_credential_provider(params = {}) ⇒ Types::UpdatePaymentCredentialProviderResponse
Updates an existing payment credential provider with new authentication credentials.
-
#update_payment_manager(params = {}) ⇒ Types::UpdatePaymentManagerResponse
Updates an existing payment manager.
-
#update_policy(params = {}) ⇒ Types::UpdatePolicyResponse
Updates an existing policy within the AgentCore Policy system.
-
#update_policy_engine(params = {}) ⇒ Types::UpdatePolicyEngineResponse
Updates an existing policy engine within the AgentCore Policy system.
-
#update_registry(params = {}) ⇒ Types::UpdateRegistryResponse
Updates an existing registry.
-
#update_registry_record(params = {}) ⇒ Types::UpdateRegistryRecordResponse
Updates an existing registry record.
-
#update_registry_record_status(params = {}) ⇒ Types::UpdateRegistryRecordStatusResponse
Updates the status of a registry record.
-
#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.
Parameters:
- options (Hash)
Options Hash (options):
-
:plugins
(Array<Seahorse::Client::Plugin>)
— default:
[]]
—
A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.
-
:credentials
(required, Aws::CredentialProvider)
—
Your AWS credentials used for authentication. This can be any class that includes and implements
Aws::CredentialProvider, or instance of any one of the following classes:Aws::Credentials- Used for configuring static, non-refreshing credentials.Aws::SharedCredentials- Used for loading static credentials from a shared file, such as~/.aws/config.Aws::AssumeRoleCredentials- Used when you need to assume a role.Aws::AssumeRoleWebIdentityCredentials- Used when you need to assume a role after providing credentials via the web.Aws::SSOCredentials- Used for loading credentials from AWS SSO using an access token generated fromaws login.Aws::ProcessCredentials- Used for loading credentials from a process that outputs to stdout.Aws::InstanceProfileCredentials- Used for loading credentials from an EC2 IMDS on an EC2 instance.Aws::ECSCredentials- Used for loading credentials from instances running in ECS.Aws::CognitoIdentityCredentials- Used for loading credentials from the Cognito Identity service.
When
:credentialsare not configured directly, the following locations will be searched for credentials:Aws.config[:credentials]The
:access_key_id,:secret_access_key,:session_token, and:account_idoptions.ENV['AWS_ACCESS_KEY_ID'],ENV['AWS_SECRET_ACCESS_KEY'],ENV['AWS_SESSION_TOKEN'], andENV['AWS_ACCOUNT_ID'].~/.aws/credentials~/.aws/configEC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of
Aws::InstanceProfileCredentialsorAws::ECSCredentialsto enable retries and extended timeouts. Instance profile credential fetching can be disabled by settingENV['AWS_EC2_METADATA_DISABLED']totrue.
-
:region
(required, String)
—
The AWS region to connect to. The configured
:regionis used to determine the service:endpoint. When not passed, a default:regionis searched for in the following locations:Aws.config[:region]ENV['AWS_REGION']ENV['AMAZON_REGION']ENV['AWS_DEFAULT_REGION']~/.aws/credentials~/.aws/config
- :access_key_id (String)
- :account_id (String)
-
:active_endpoint_cache
(Boolean)
— default:
false
—
When set to
true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults tofalse. -
:adaptive_retry_wait_to_fill
(Boolean)
— default:
true
—
Used only in
adaptiveretry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise aRetryCapacityNotAvailableErrorand will not retry instead of sleeping. -
:auth_scheme_preference
(Array<String>)
—
A list of preferred authentication schemes to use when making a request. Supported values are:
sigv4,sigv4a,httpBearerAuth, andnoAuth. When set usingENV['AWS_AUTH_SCHEME_PREFERENCE']or in shared config asauth_scheme_preference, the value should be a comma-separated list. -
:client_side_monitoring
(Boolean)
— default:
false
—
When
true, client-side metrics will be collected for all API requests from this client. -
:client_side_monitoring_client_id
(String)
— default:
""
—
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
-
:client_side_monitoring_host
(String)
— default:
"127.0.0.1"
—
Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_port
(Integer)
— default:
31000
—
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_publisher
(Aws::ClientSideMonitoring::Publisher)
— default:
Aws::ClientSideMonitoring::Publisher
—
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
-
:convert_params
(Boolean)
— default:
true
—
When
true, an attempt is made to coerce request parameters into the required types. -
:correct_clock_skew
(Boolean)
— default:
true
—
Used only in
standardandadaptiveretry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only whendisable_clock_skew_correctionis not set. -
:defaults_mode
(String)
— default:
"legacy"
—
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
-
:disable_clock_skew_correction
(Boolean)
—
Used only in
standardandadaptiveretry modes. Whentrue, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default. -
:disable_host_prefix_injection
(Boolean)
— default:
false
—
When
true, the SDK will not prepend the modeled host prefix to the endpoint. -
:disable_request_compression
(Boolean)
— default:
false
—
When set to 'true' the request body will not be compressed for supported operations.
-
:endpoint
(String, URI::HTTPS, URI::HTTP)
—
Normally you should not configure the
:endpointoption directly. This is normally constructed from the:regionoption. Configuring:endpointis normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:'http://example.com' 'https://example.com' 'http://example.com:123' -
:endpoint_cache_max_entries
(Integer)
— default:
1000
—
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
-
:endpoint_cache_max_threads
(Integer)
— default:
10
—
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
-
:endpoint_cache_poll_interval
(Integer)
— default:
60
—
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
-
:endpoint_discovery
(Boolean)
— default:
false
—
When set to
true, endpoint discovery will be enabled for operations when available. -
:ignore_configured_endpoint_urls
(Boolean)
—
Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
-
:log_formatter
(Aws::Log::Formatter)
— default:
Aws::Log::Formatter.default
—
The log formatter.
-
:log_level
(Symbol)
— default:
:info
—
The log level to send messages to the
:loggerat. -
:logger
(Logger)
—
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
-
:max_attempts
(Integer)
— default:
3
—
An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in
standardandadaptiveretry modes. Defaults to 3, except for DynamoDB and DynamoDB Streams, which default to 4. -
:profile
(String)
— default:
"default"
—
Used when loading credentials from the shared credentials file at
HOME/.aws/credentials. When not specified, 'default' is used. -
:request_checksum_calculation
(String)
— default:
"when_supported"
—
Determines when a checksum will be calculated for request payloads. Values are:
when_supported- (default) When set, a checksum will be calculated for all request payloads of operations modeled with thehttpChecksumtrait whererequestChecksumRequiredistrueand/or arequestAlgorithmMemberis modeled.when_required- When set, a checksum will only be calculated for request payloads of operations modeled with thehttpChecksumtrait whererequestChecksumRequiredistrueor where arequestAlgorithmMemberis modeled and supplied.
-
:request_min_compression_size_bytes
(Integer)
— default:
10240
—
The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.
-
:response_checksum_validation
(String)
— default:
"when_supported"
—
Determines when checksum validation will be performed on response payloads. Values are:
when_supported- (default) When set, checksum validation is performed on all response payloads of operations modeled with thehttpChecksumtrait whereresponseAlgorithmsis modeled, except when no modeled checksum algorithms are supported.when_required- When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and therequestValidationModeMembermember is set toENABLED.
-
:retry_backoff
(Proc)
—
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the
legacyretry mode. -
:retry_base_delay
(Float)
— default:
0.3
—
The base delay in seconds used by the default backoff function. This option is only used in the
legacyretry mode. -
:retry_jitter
(Symbol)
— default:
:none
—
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the
legacyretry mode.@see https://www.awsarchitectureblog.com/2015/03/backoff.html
-
:retry_limit
(Integer)
— default:
3
—
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the
legacyretry mode. -
:retry_max_delay
(Integer)
— default:
0
—
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the
legacyretry mode. -
:retry_mode
(String)
— default:
"standard"
—
Specifies which retry algorithm to use. Values are:
legacy- The pre-existing retry behavior.standard- A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. This is the default value if no retry mode is provided.adaptive- A retry mode that includes all the functionality ofstandardmode along with automatic client side throttling.
-
:sdk_ua_app_id
(String)
—
A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
- :secret_access_key (String)
- :session_token (String)
-
:sigv4a_signing_region_set
(Array)
—
A list of regions that should be signed with SigV4a signing. When not passed, a default
:sigv4a_signing_region_setis searched for in the following locations:Aws.config[:sigv4a_signing_region_set]ENV['AWS_SIGV4A_SIGNING_REGION_SET']~/.aws/config
-
:stub_responses
(Boolean)
— default:
false
—
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.
Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
-
:telemetry_provider
(Aws::Telemetry::TelemetryProviderBase)
— default:
Aws::Telemetry::NoOpTelemetryProvider
—
Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses
NoOpTelemetryProviderwhich will not record or emit any telemetry data. The SDK supports the following telemetry providers:- OpenTelemetry (OTel) - To use the OTel provider, install and require the
opentelemetry-sdkgem and then, pass in an instance of aAws::Telemetry::OTelProviderfor telemetry provider.
- OpenTelemetry (OTel) - To use the OTel provider, install and require the
-
:token_provider
(Aws::TokenProvider)
—
Your Bearer token used for authentication. This can be any class that includes and implements
Aws::TokenProvider, or instance of any one of the following classes:Aws::StaticTokenProvider- Used for configuring static, non-refreshing tokens.Aws::SSOTokenProvider- Used for loading tokens from AWS SSO using an access token generated fromaws login.
When
:token_provideris not configured directly, theAws::TokenProviderChainwill be used to search for tokens configured for your profile in shared configuration files. -
:use_dualstack_endpoint
(Boolean)
—
When set to
true, dualstack enabled endpoints (with.awsTLD) will be used if available. -
:use_fips_endpoint
(Boolean)
—
When set to
true, fips compatible endpoints will be used if available. When afipsregion is used, the region is normalized and this config is set totrue. -
:validate_params
(Boolean)
— default:
true
—
When
true, request parameters are validated before sending the request. -
:endpoint_provider
(Aws::BedrockAgentCoreControl::EndpointProvider)
—
The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters)whereparametersis a Struct similar toAws::BedrockAgentCoreControl::EndpointParameters. -
:http_continue_timeout
(Float)
— default:
1
—
The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to
nilwhich disables this behaviour. This value can safely be set per request on the session. -
:http_idle_timeout
(Float)
— default:
5
—
The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
-
:http_open_timeout
(Float)
— default:
15
—
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
-
:http_proxy
(URI::HTTP, String)
—
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
-
:http_read_timeout
(Float)
— default:
60
—
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
-
:http_wire_trace
(Boolean)
— default:
false
—
When
true, HTTP debug output will be sent to the:logger. -
:on_chunk_received
(Proc)
—
When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a
content-length). -
:on_chunk_sent
(Proc)
—
When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.
-
:raise_response_errors
(Boolean)
— default:
true
—
When
true, response errors are raised. -
:ssl_ca_bundle
(String)
—
Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass
:ssl_ca_bundleor:ssl_ca_directorythe the system default will be used if available. -
:ssl_ca_directory
(String)
—
Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass
:ssl_ca_bundleor:ssl_ca_directorythe the system default will be used if available. -
:ssl_ca_store
(String)
—
Sets the X509::Store to verify peer certificate.
-
:ssl_cert
(OpenSSL::X509::Certificate)
—
Sets a client certificate when creating http connections.
-
:ssl_key
(OpenSSL::PKey)
—
Sets a client key when creating http connections.
-
:ssl_timeout
(Float)
—
Sets the SSL timeout in seconds
-
:ssl_verify_peer
(Boolean)
— default:
true
—
When
true, SSL peer certificates are verified when establishing a connection.
479 480 481 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#add_dataset_examples(params = {}) ⇒ Types::AddDatasetExamplesResponse
Adds examples to the dataset's DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.add_dataset_examples({
dataset_id: "DatasetId", # required
client_token: "ClientToken",
source: { # required
inline_examples: {
examples: [ # required
{
},
],
},
s3_source: {
s3_uri: "S3Uri", # required
},
},
})
Response structure
Response structure
resp.dataset_arn #=> String
resp.dataset_id #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.added_count #=> Integer
resp.updated_at #=> Time
resp.example_ids #=> Array
resp.example_ids[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:dataset_id
(required, String)
—
The unique identifier of the dataset to add examples to.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:source
(required, Types::DataSourceType)
—
Source of examples to add. Provide either inline examples or an S3 URI pointing to a JSONL file.
Returns:
-
(Types::AddDatasetExamplesResponse)
—
Returns a response object which responds to the following methods:
- #dataset_arn => String
- #dataset_id => String
- #status => String
- #added_count => Integer
- #updated_at => Time
- #example_ids => Array<String>
See Also:
552 553 554 555 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 552 def add_dataset_examples(params = {}, options = {}) req = build_request(:add_dataset_examples, params) req.send_request(options) end |
#batch_put_gateway_rate_limits(params = {}) ⇒ Types::BatchPutGatewayRateLimitsResponse
Atomically creates or updates multiple rate limits for a gateway. The operation updates existing limits with matching keys and creates new limits for new keys. If the operation fails, the service applies no changes. Retry the request after resolving the issue.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.batch_put_gateway_rate_limits({
gateway_identifier: "GatewayIdentifier", # required
client_token: "ClientToken",
rate_limits: [ # required
{
rate_limit_id: "GatewayRateLimitId",
description: "GatewayRateLimitDescription",
dimension_keys: ["DimensionKey"], # required
entries: [ # required
{
dimensions: { # required
"DimensionKey" => "DimensionValue",
},
requests: [
{
rate: 1.0, # required
period: "second", # required, accepts second, minute
},
],
tokens: [
{
rate: 1.0, # required
period: "second", # required, accepts second, minute
},
],
connections: [
{
rate: 1.0, # required
period: "second", # required, accepts second, minute
},
],
},
],
},
],
})
Response structure
Response structure
resp.rate_limits #=> Array
resp.rate_limits[0].rate_limit_id #=> String
resp.rate_limits[0].gateway_identifier #=> String
resp.rate_limits[0].description #=> String
resp.rate_limits[0].dimension_keys #=> Array
resp.rate_limits[0].dimension_keys[0] #=> String
resp.rate_limits[0].entries #=> Array
resp.rate_limits[0].entries[0].dimensions #=> Hash
resp.rate_limits[0].entries[0].dimensions["DimensionKey"] #=> String
resp.rate_limits[0].entries[0].requests #=> Array
resp.rate_limits[0].entries[0].requests[0].rate #=> Float
resp.rate_limits[0].entries[0].requests[0].period #=> String, one of "second", "minute"
resp.rate_limits[0].entries[0].tokens #=> Array
resp.rate_limits[0].entries[0].tokens[0].rate #=> Float
resp.rate_limits[0].entries[0].tokens[0].period #=> String, one of "second", "minute"
resp.rate_limits[0].entries[0].connections #=> Array
resp.rate_limits[0].entries[0].connections[0].rate #=> Float
resp.rate_limits[0].entries[0].connections[0].period #=> String, one of "second", "minute"
resp.rate_limits[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.rate_limits[0].created_at #=> Time
resp.rate_limits[0].updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The unique identifier of the gateway.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:rate_limits
(required, Array<Types::BatchPutLimitEntry>)
—
The complete set of rate limits for this gateway. This operation replaces all existing rate limits in a single request. If the operation fails, no rate limits are changed.
Returns:
-
(Types::BatchPutGatewayRateLimitsResponse)
—
Returns a response object which responds to the following methods:
- #rate_limits => Array<Types::GatewayRateLimitDetail>
See Also:
655 656 657 658 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 655 def batch_put_gateway_rate_limits(params = {}, options = {}) req = build_request(:batch_put_gateway_rate_limits, params) req.send_request(options) end |
#create_agent_runtime(params = {}) ⇒ Types::CreateAgentRuntimeResponse
Creates an Amazon Bedrock AgentCore Runtime.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_agent_runtime({
agent_runtime_name: "AgentRuntimeName", # required
agent_runtime_artifact: { # required
container_configuration: {
container_uri: "RuntimeContainerUri", # required
},
code_configuration: {
code: { # required
s3: {
bucket: "S3LocationBucketString", # required
prefix: "S3LocationPrefixString", # required
version_id: "S3LocationVersionIdString",
},
},
runtime: "PYTHON_3_10", # required, accepts PYTHON_3_10, PYTHON_3_11, PYTHON_3_12, PYTHON_3_13, PYTHON_3_14, NODE_22
entry_point: ["entryPoint"], # required
},
},
role_arn: "RoleArn", # required
network_configuration: {
network_mode: "PUBLIC", # required, accepts PUBLIC, VPC
network_mode_config: {
security_groups: ["SecurityGroupId"], # required
subnets: ["SubnetId"], # required
require_service_s3_endpoint: false,
},
},
client_token: "ClientToken",
description: "Description",
authorizer_configuration: {
custom_jwt_authorizer: {
discovery_url: "DiscoveryUrl", # required
allowed_audience: ["AllowedAudience"],
allowed_clients: ["AllowedClient"],
allowed_scopes: ["AllowedScopeType"],
advertised_scope_mapping: {
"AllowedScopeType" => "AllowedScopeType",
},
custom_claims: [
{
inbound_token_claim_name: "InboundTokenClaimNameType", # required
inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
authorizing_claim_match_value: { # required
claim_match_value: { # required
match_value_string: "MatchValueString",
match_value_string_list: ["MatchValueString"],
},
claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
},
},
],
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
allowed_workload_configuration: {
hosting_environments: [
{
arn: "BedrockAgentcoreResourceArn", # required
},
],
workload_identities: ["WorkloadIdentityNameType"],
},
},
},
request_header_configuration: {
request_header_allowlist: ["HeaderName"],
},
protocol_configuration: {
server_protocol: "MCP", # required, accepts MCP, HTTP, A2A, AGUI
port: 1,
path: "ServerPath",
},
lifecycle_configuration: {
idle_runtime_session_timeout: 1,
max_lifetime: 1,
},
hooks_configuration: {
build: {
warmup: {
action: { # required
http_post: {
path: "LifecycleHookPath", # required
port: 1,
},
},
},
},
},
environment_variables: {
"EnvironmentVariableKey" => "EnvironmentVariableValue",
},
filesystem_configurations: [
{
session_storage: {
mount_path: "MountPath", # required
},
s3_files_access_point: {
access_point_arn: "S3FilesAccessPointArn", # required
mount_path: "MountPath", # required
},
efs_access_point: {
access_point_arn: "EfsAccessPointArn", # required
mount_path: "MountPath", # required
},
capacity_provider_volume: {
volume_name: "CapacityProviderVolumeName", # required
mount_path: "MountPath", # required
},
},
],
capacity_provider_configuration: {
capacity_provider_arn: "CapacityProviderArn", # required
},
tags: {
"TagKey" => "TagValue",
},
platform_version: "PlatformVersion",
allowed_ports: [
{
port: 1,
port_range: {
from: 1, # required
to: 1, # required
},
},
],
resource_configurations: [
{
minimum_memory_in_mi_b: 1, # required
},
],
})
Response structure
Response structure
resp.agent_runtime_arn #=> String
resp.workload_identity_details.workload_identity_arn #=> String
resp.agent_runtime_id #=> String
resp.agent_runtime_version #=> String
resp.created_at #=> Time
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_runtime_name
(required, String)
—
The name of the AgentCore Runtime.
-
:agent_runtime_artifact
(required, Types::AgentRuntimeArtifact)
—
The artifact of the AgentCore Runtime.
-
:role_arn
(required, String)
—
The IAM role ARN that provides permissions for the AgentCore Runtime.
-
:network_configuration
(Types::NetworkConfiguration)
—
The network configuration for the AgentCore Runtime.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:description
(String)
—
The description of the AgentCore Runtime.
-
:authorizer_configuration
(Types::AuthorizerConfiguration)
—
The authorizer configuration for the AgentCore Runtime.
-
:request_header_configuration
(Types::RequestHeaderConfiguration)
—
Configuration for HTTP request headers that will be passed through to the runtime.
-
:protocol_configuration
(Types::ProtocolConfiguration)
—
The protocol configuration for the AgentCore Runtime, including the protocol, port, and path on which the agent server is available.
-
:lifecycle_configuration
(Types::LifecycleConfiguration)
—
The life cycle configuration for the AgentCore Runtime.
-
:hooks_configuration
(Types::RuntimeHooksConfiguration)
—
The lifecycle hooks configuration for the AgentCore Runtime. Use lifecycle hooks to run actions in the agent's container at fixed points in the runtime's lifecycle, such as warming up the agent before sessions are created.
-
:environment_variables
(Hash<String,String>)
—
Environment variables to set in the AgentCore Runtime environment.
-
:filesystem_configurations
(Array<Types::FilesystemConfiguration>)
—
The filesystem configurations to mount into the AgentCore Runtime. Use filesystem configurations to provide persistent storage to your AgentCore Runtime sessions.
-
:capacity_provider_configuration
(Types::CapacityProviderConfiguration)
—
The capacity provider configuration for the AgentCore Runtime. Use a capacity provider to run the AgentCore Runtime on the Instances compute type, which provisions Amazon Web Services managed compute in your account.
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the agent runtime. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
-
:platform_version
(String)
—
The version of the runtime platform to use for the AgentCore Runtime.
-
:allowed_ports
(Array<Types::AllowedPort>)
—
The additional ports on the AgentCore Runtime that are reachable through the runtime's session URL. Specify one to five non-overlapping entries, each containing either a single port or an inclusive port range. Ports must be between
8000and12000, excluding the reserved port8443. -
:resource_configurations
(Array<Types::ResourceConfiguration>)
—
The resource configurations for the AgentCore Runtime, such as the minimum amount of memory to allocate to the runtime. You can specify at most one resource configuration.
Returns:
-
(Types::CreateAgentRuntimeResponse)
—
Returns a response object which responds to the following methods:
- #agent_runtime_arn => String
- #workload_identity_details => Types::WorkloadIdentityDetails
- #agent_runtime_id => String
- #agent_runtime_version => String
- #created_at => Time
- #status => String
See Also:
938 939 940 941 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 938 def create_agent_runtime(params = {}, options = {}) req = build_request(:create_agent_runtime, params) req.send_request(options) end |
#create_agent_runtime_endpoint(params = {}) ⇒ Types::CreateAgentRuntimeEndpointResponse
Creates an AgentCore Runtime endpoint.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_agent_runtime_endpoint({
agent_runtime_id: "AgentRuntimeId", # required
name: "EndpointName", # required
agent_runtime_version: "AgentRuntimeVersion",
description: "AgentEndpointDescription",
client_token: "ClientToken",
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.target_version #=> String
resp.agent_runtime_endpoint_arn #=> String
resp.agent_runtime_arn #=> String
resp.agent_runtime_id #=> String
resp.endpoint_name #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.created_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_runtime_id
(required, String)
—
The unique identifier of the AgentCore Runtime to create an endpoint for.
-
:name
(required, String)
—
The name of the AgentCore Runtime endpoint.
-
:agent_runtime_version
(String)
—
The version of the AgentCore Runtime to use for the endpoint.
-
:description
(String)
—
The description of the AgentCore Runtime endpoint.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the agent runtime endpoint. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateAgentRuntimeEndpointResponse)
—
Returns a response object which responds to the following methods:
- #target_version => String
- #agent_runtime_endpoint_arn => String
- #agent_runtime_arn => String
- #agent_runtime_id => String
- #endpoint_name => String
- #status => String
- #created_at => Time
See Also:
1007 1008 1009 1010 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1007 def create_agent_runtime_endpoint(params = {}, options = {}) req = build_request(:create_agent_runtime_endpoint, params) req.send_request(options) end |
#create_api_key_credential_provider(params = {}) ⇒ Types::CreateApiKeyCredentialProviderResponse
Creates a new API key credential provider.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_api_key_credential_provider({
name: "CredentialProviderName", # required
api_key: "DefaultApiKeyType",
api_key_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
api_key_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.api_key_secret_arn.secret_arn #=> String
resp.api_key_secret_json_key #=> String
resp.api_key_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.name #=> String
resp.credential_provider_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the API key credential provider. The name must be unique within your account.
-
:api_key
(String)
—
The API key to use for authentication. This value is encrypted and stored securely.
-
:api_key_secret_config
(Types::SecretReference)
—
A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when
apiKeySecretSourceis set toEXTERNAL. -
:api_key_secret_source
(String)
—
The source type of the API key secret. Use
MANAGEDif the secret is managed by the service, orEXTERNALif you manage the secret yourself in Amazon Web Services Secrets Manager. -
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateApiKeyCredentialProviderResponse)
—
Returns a response object which responds to the following methods:
- #api_key_secret_arn => Types::Secret
- #api_key_secret_json_key => String
- #api_key_secret_source => String
- #name => String
- #credential_provider_arn => String
See Also:
1073 1074 1075 1076 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1073 def create_api_key_credential_provider(params = {}, options = {}) req = build_request(:create_api_key_credential_provider, params) req.send_request(options) end |
#create_browser(params = {}) ⇒ Types::CreateBrowserResponse
Creates a custom browser.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_browser({
name: "SandboxName", # required
description: "Description",
execution_role_arn: "RoleArn",
network_configuration: { # required
network_mode: "PUBLIC", # required, accepts PUBLIC, VPC
vpc_config: {
security_groups: ["SecurityGroupId"], # required
subnets: ["SubnetId"], # required
require_service_s3_endpoint: false,
},
},
recording: {
enabled: false,
s3_location: {
bucket: "S3LocationBucketString", # required
prefix: "S3LocationPrefixString", # required
version_id: "S3LocationVersionIdString",
},
},
browser_signing: {
enabled: false, # required
},
enterprise_policies: [
{
location: { # required
s3: {
bucket: "S3LocationBucketString", # required
prefix: "S3LocationPrefixString", # required
version_id: "S3LocationVersionIdString",
},
},
type: "MANAGED", # accepts MANAGED, RECOMMENDED
},
],
certificates: [
{
location: { # required
secrets_manager: {
secret_arn: "ToolSecretArn", # required
},
},
},
],
filesystem_configurations: [
{
s3_files_configuration: {
access_point_arn: "S3FilesAccessPointArn", # required
mount_path: "MountPath", # required
file_system_arn: "S3FilesFileSystemArn", # required
},
efs_configuration: {
access_point_arn: "EfsAccessPointArn", # required
mount_path: "MountPath", # required
file_system_arn: "EfsFileSystemArn", # required
},
},
],
client_token: "ClientToken",
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.browser_id #=> String
resp.browser_arn #=> String
resp.created_at #=> Time
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "READY", "DELETING", "DELETE_FAILED", "DELETED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the browser. The name must be unique within your account.
-
:description
(String)
—
The description of the browser.
-
:execution_role_arn
(String)
—
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the browser to access Amazon Web Services services.
-
:network_configuration
(required, Types::BrowserNetworkConfiguration)
—
The network configuration for the browser. This configuration specifies the network mode for the browser.
-
:recording
(Types::RecordingConfig)
—
The recording configuration for the browser. When enabled, browser sessions are recorded and stored in the specified Amazon S3 location.
-
:browser_signing
(Types::BrowserSigningConfigInput)
—
The browser signing configuration that enables cryptographic agent identification using HTTP message signatures for web bot authentication.
-
:enterprise_policies
(Array<Types::BrowserEnterprisePolicy>)
—
A list of enterprise policy files for the browser.
-
:certificates
(Array<Types::Certificate>)
—
A list of certificates to install in the browser.
-
:filesystem_configurations
(Array<Types::ToolsFileSystemConfiguration>)
—
The file system configurations to mount into the browser. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateBrowserResponse)
—
Returns a response object which responds to the following methods:
- #browser_id => String
- #browser_arn => String
- #created_at => Time
- #status => String
See Also:
1214 1215 1216 1217 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1214 def create_browser(params = {}, options = {}) req = build_request(:create_browser, params) req.send_request(options) end |
#create_browser_profile(params = {}) ⇒ Types::CreateBrowserProfileResponse
Creates a browser profile in Amazon Bedrock AgentCore. A browser profile stores persistent browser data such as cookies, local storage, session storage, and browsing history that can be saved from browser sessions and reused in subsequent sessions.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_browser_profile({
name: "BrowserProfileName", # required
description: "Description",
client_token: "ClientToken",
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.profile_id #=> String
resp.profile_arn #=> String
resp.created_at #=> Time
resp.status #=> String, one of "READY", "DELETING", "DELETED", "SAVING"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the browser profile. The name must be unique within your account and can contain alphanumeric characters and underscores.
-
:description
(String)
—
A description of the browser profile. Use this field to describe the purpose or contents of the profile.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the browser profile. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateBrowserProfileResponse)
—
Returns a response object which responds to the following methods:
- #profile_id => String
- #profile_arn => String
- #created_at => Time
- #status => String
See Also:
1275 1276 1277 1278 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1275 def create_browser_profile(params = {}, options = {}) req = build_request(:create_browser_profile, params) req.send_request(options) end |
#create_capacity_provider(params = {}) ⇒ Types::CreateCapacityProviderOutput
Creates a capacity provider. A capacity provider defines the Amazon EC2 infrastructure for AgentCore Runtime, including the operating system, allowed instance types, networking, and storage. It also specifies the IAM permissions that AgentCore uses to manage those instances.
The capacity provider name must be unique within your account. After
you create the capacity provider, it enters a CREATING state and
transitions to READY when it is available for use.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_capacity_provider({
name: "CapacityProviderName", # required
description: "Description",
permissions_configuration: { # required
capacity_provider_operator_role_arn: "RoleArn", # required
},
client_token: "ClientToken",
tags: {
"TagKey" => "TagValue",
},
compute_configuration: { # required
ec2_configuration: {
launch_template_source: { # required
launch_parameters: {
operating_system: "LINUX_X86_64", # required, accepts LINUX_X86_64, LINUX_ARM64
instance_requirements: { # required
allowed_instance_types: ["EC2InstanceType"], # required
},
ephemeral_volumes: [
{
device_name: "DeviceName",
virtual_name: "VirtualDeviceName",
ebs: {
volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
iops: 1,
throughput: 1,
encrypted: false,
kms_key_id: "KmsKeyId",
snapshot_id: "EbsSnapshotId",
volume_size: 1,
volume_initialization_rate: 1,
ebs_card_index: 1,
},
},
],
monitoring: "BASIC", # accepts BASIC, DETAILED
license_specifications: [
{
license_configuration_arn: "LicenseConfigurationArn", # required
},
],
capacity_reservation_specification: {
capacity_reservation_preference: "capacity-reservations-only", # accepts capacity-reservations-only, open, none
capacity_reservation_target: {
capacity_reservation_id: "CapacityReservationId",
capacity_reservation_resource_group_arn: "CapacityReservationResourceGroupArn",
},
},
ssh_key_name: "SSHKeyName",
instance_profile_arn: "InstanceProfileArn",
propagated_tags: {
"TagKey" => "TagValue",
},
},
},
vpc_configuration: { # required
subnets: ["SubnetId"], # required
security_groups: ["SecurityGroupId"], # required
},
volumes: [
{
ebs_configuration: {
name: "VolumeName", # required
size_gi_b: 1, # required
volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
iops: 1,
throughput: 1,
encrypted: false,
kms_key_id: "KmsKeyId",
snapshot_id: "EbsSnapshotId",
},
},
],
lifecycle_configuration: {
idle_instance_timeout: 1,
max_lifetime: 1,
},
root_volume: {
volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
iops: 1,
throughput: 1,
encrypted: false,
kms_key_id: "KmsKeyId",
free_space_gi_b: 1,
},
},
},
})
Response structure
Response structure
resp.capacity_provider_id #=> String
resp.capacity_provider_arn #=> String
resp.name #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the capacity provider. The name must be unique within your account.
-
:description
(String)
—
An optional description of the capacity provider. If you don't specify a description, the service creates the capacity provider without one.
-
:permissions_configuration
(required, Types::PermissionsConfiguration)
—
The permissions configuration for the capacity provider. This specifies the IAM role that AgentCore uses to manage the Amazon EC2 instances on your behalf.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to associate with the capacity provider. If you don't specify tags, the capacity provider is created with no tags.
-
:compute_configuration
(required, Types::ComputeConfiguration)
—
The compute configuration for the capacity provider. This defines the Amazon EC2 compute resources used to launch instances: the operating system, allowed instance types, networking, and storage.
Returns:
-
(Types::CreateCapacityProviderOutput)
—
Returns a response object which responds to the following methods:
- #capacity_provider_id => String
- #capacity_provider_arn => String
- #name => String
- #status => String
See Also:
1437 1438 1439 1440 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1437 def create_capacity_provider(params = {}, options = {}) req = build_request(:create_capacity_provider, params) req.send_request(options) end |
#create_code_interpreter(params = {}) ⇒ Types::CreateCodeInterpreterResponse
Creates a custom code interpreter.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_code_interpreter({
name: "SandboxName", # required
description: "Description",
execution_role_arn: "RoleArn",
network_configuration: { # required
network_mode: "PUBLIC", # required, accepts PUBLIC, SANDBOX, VPC
vpc_config: {
security_groups: ["SecurityGroupId"], # required
subnets: ["SubnetId"], # required
require_service_s3_endpoint: false,
},
},
certificates: [
{
location: { # required
secrets_manager: {
secret_arn: "ToolSecretArn", # required
},
},
},
],
filesystem_configurations: [
{
s3_files_configuration: {
access_point_arn: "S3FilesAccessPointArn", # required
mount_path: "MountPath", # required
file_system_arn: "S3FilesFileSystemArn", # required
},
efs_configuration: {
access_point_arn: "EfsAccessPointArn", # required
mount_path: "MountPath", # required
file_system_arn: "EfsFileSystemArn", # required
},
},
],
client_token: "ClientToken",
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.code_interpreter_id #=> String
resp.code_interpreter_arn #=> String
resp.created_at #=> Time
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "READY", "DELETING", "DELETE_FAILED", "DELETED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the code interpreter. The name must be unique within your account.
-
:description
(String)
—
The description of the code interpreter.
-
:execution_role_arn
(String)
—
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the code interpreter to access Amazon Web Services services.
-
:network_configuration
(required, Types::CodeInterpreterNetworkConfiguration)
—
The network configuration for the code interpreter. This configuration specifies the network mode for the code interpreter.
-
:certificates
(Array<Types::Certificate>)
—
A list of certificates to install in the code interpreter.
-
:filesystem_configurations
(Array<Types::ToolsFileSystemConfiguration>)
—
The file system configurations to mount into the code interpreter. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the code interpreter. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateCodeInterpreterResponse)
—
Returns a response object which responds to the following methods:
- #code_interpreter_id => String
- #code_interpreter_arn => String
- #created_at => Time
- #status => String
See Also:
1545 1546 1547 1548 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1545 def create_code_interpreter(params = {}, options = {}) req = build_request(:create_code_interpreter, params) req.send_request(options) end |
#create_configuration_bundle(params = {}) ⇒ Types::CreateConfigurationBundleResponse
Creates a new configuration bundle resource. A configuration bundle stores versioned component configurations for agent evaluation workflows.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_configuration_bundle({
client_token: "ClientToken",
bundle_name: "ConfigurationBundleName", # required
description: "ConfigurationBundleDescription",
components: { # required
"ComponentIdentifier" => {
configuration: { # required
},
},
},
branch_name: "BranchName",
commit_message: "CreateConfigurationBundleRequestCommitMessageString",
created_by: {
name: "String", # required
arn: "String",
},
kms_key_arn: "KmsKeyArn",
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.bundle_arn #=> String
resp.bundle_id #=> String
resp.version_id #=> String
resp.created_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:bundle_name
(required, String)
—
The name for the configuration bundle. Names must be unique within your account.
-
:description
(String)
—
The description for the configuration bundle.
-
:components
(required, Hash<String,Types::ComponentConfiguration>)
—
A map of component identifiers to their configurations. Each component represents a configurable element within the bundle.
-
:branch_name
(String)
—
The branch name for version tracking. Defaults to
mainlineif not specified. -
:commit_message
(String)
—
A commit message describing the initial version of the configuration bundle.
-
:created_by
(Types::VersionCreatedBySource)
—
The source that created this version, including the source name and optional ARN.
-
:kms_key_arn
(String)
—
Optional KMS key ARN for encrypting component configurations.
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the configuration bundle. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateConfigurationBundleResponse)
—
Returns a response object which responds to the following methods:
- #bundle_arn => String
- #bundle_id => String
- #version_id => String
- #created_at => Time
See Also:
1641 1642 1643 1644 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1641 def create_configuration_bundle(params = {}, options = {}) req = build_request(:create_configuration_bundle, params) req.send_request(options) end |
#create_consent_portal(params = {}) ⇒ Types::CreateConsentPortalResponse
Creates a new consent portal.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_consent_portal({
execution_role_arn: "ExecutionRoleArnType", # required
idp_config: { # required
credential_provider_arn: "OAuth2CredentialProviderArn", # required
scopes: ["AllowedScopeType"], # required
audience: "AllowedAudienceType",
},
name: "ConsentPortalNameType", # required
sources: [ # required
{
identifier: "ConsentPortalSourceIdentifierType", # required
type: "agentcore-gateway", # required, accepts agentcore-gateway
},
],
description: "ConsentPortalDescriptionType",
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.sources #=> Array
resp.sources[0].identifier #=> String
resp.sources[0].type #=> String, one of "agentcore-gateway"
resp.consent_portal_arn #=> String
resp.consent_portal_id #=> String
resp.created_at #=> Time
resp.description #=> String
resp.execution_role_arn #=> String
resp.idp_config.credential_provider_arn #=> String
resp.idp_config.scopes #=> Array
resp.idp_config.scopes[0] #=> String
resp.idp_config.audience #=> String
resp.name #=> String
resp.portal_url #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "FAILED"
resp.status_reason #=> String
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:execution_role_arn
(required, String)
—
The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.
-
:idp_config
(required, Types::ConsentPortalIdpConfig)
—
The identity provider configuration that the consent portal uses to authenticate end users.
-
:name
(required, String)
—
The name of the consent portal. The name must be unique within your account.
-
:sources
(required, Array<Types::ConsentPortalSource>)
—
The resources served by the consent portal. Currently, we only support type
agentcore-gateway. -
:description
(String)
—
The description of the consent portal.
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the consent portal. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateConsentPortalResponse)
—
Returns a response object which responds to the following methods:
- #sources => Array<Types::ConsentPortalSource>
- #consent_portal_arn => String
- #consent_portal_id => String
- #created_at => Time
- #description => String
- #execution_role_arn => String
- #idp_config => Types::ConsentPortalIdpConfig
- #name => String
- #portal_url => String
- #status => String
- #status_reason => String
- #updated_at => Time
See Also:
1733 1734 1735 1736 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1733 def create_consent_portal(params = {}, options = {}) req = build_request(:create_consent_portal, params) req.send_request(options) end |
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a new dataset resource asynchronously. Returns immediately
with status CREATING. Poll GetDataset until status transitions to
ACTIVE or CREATE_FAILED.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_dataset({
client_token: "ClientToken",
dataset_name: "DatasetName", # required
description: "CreateDatasetRequestDescriptionString",
source: {
inline_examples: {
examples: [ # required
{
},
],
},
s3_source: {
s3_uri: "S3Uri", # required
},
},
schema_type: "AGENTCORE_EVALUATION_PREDEFINED_V1", # accepts AGENTCORE_EVALUATION_PREDEFINED_V1, AGENTCORE_EVALUATION_SIMULATED_V1, THIRD_PARTY_EVALUATION_V1
kms_key_arn: "KmsKeyArn",
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.dataset_arn #=> String
resp.dataset_id #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.created_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:dataset_name
(required, String)
—
Human-readable name for the dataset. Must be unique within the account. Immutable after creation.
-
:description
(String)
—
A description of the dataset.
-
:source
(Types::DataSourceType)
—
Source of initial examples. Provide either inline examples or an S3 URI pointing to a JSONL file.
-
:schema_type
(String)
—
Versioned schema type governing the structure of examples. Immutable after creation.
-
:kms_key_arn
(String)
—
Optional KMS key ARN for server-side encryption on service Amazon S3 writes.
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the dataset.
Returns:
-
(Types::CreateDatasetResponse)
—
Returns a response object which responds to the following methods:
- #dataset_arn => String
- #dataset_id => String
- #status => String
- #created_at => Time
See Also:
1820 1821 1822 1823 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1820 def create_dataset(params = {}, options = {}) req = build_request(:create_dataset, params) req.send_request(options) end |
#create_dataset_version(params = {}) ⇒ Types::CreateDatasetVersionResponse
Publishes the current DRAFT as a new numbered version. The DRAFT is
preserved and remains editable after publishing. Returns immediately
with status UPDATING. Poll GetDataset until status transitions to
ACTIVE or UPDATE_FAILED.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_dataset_version({
dataset_id: "DatasetId", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.dataset_arn #=> String
resp.dataset_id #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.dataset_version #=> String
resp.created_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:dataset_id
(required, String)
—
The unique identifier of the dataset to publish a version for.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::CreateDatasetVersionResponse)
—
Returns a response object which responds to the following methods:
- #dataset_arn => String
- #dataset_id => String
- #status => String
- #dataset_version => String
- #created_at => Time
See Also:
1874 1875 1876 1877 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 1874 def create_dataset_version(params = {}, options = {}) req = build_request(:create_dataset_version, params) req.send_request(options) end |
#create_evaluator(params = {}) ⇒ Types::CreateEvaluatorResponse
Creates a custom evaluator for agent quality assessment. Custom evaluators can use either LLM-as-a-Judge configurations with user-defined prompts, rating scales, and model settings, or code-based configurations with customer-managed Lambda functions to evaluate agent performance at tool call, trace, or session levels.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_evaluator({
client_token: "ClientToken",
evaluator_name: "CustomEvaluatorName", # required
description: "EvaluatorDescription",
evaluator_config: { # required
llm_as_a_judge: {
instructions: "EvaluatorInstructions", # required
rating_scale: { # required
numerical: [
{
definition: "String", # required
value: 1.0, # required
label: "NumericalScaleDefinitionLabelString", # required
},
],
categorical: [
{
definition: "String", # required
label: "CategoricalScaleDefinitionLabelString", # required
},
],
multi_dimensional: [
{
dimension_name: "EvaluationDimensionName", # required
dimension_instruction: "EvaluationDimensionInstruction", # required
dimension_rating_scale: { # required
numerical: [
{
definition: "String", # required
value: 1.0, # required
label: "NumericalScaleDefinitionLabelString", # required
},
],
categorical: [
{
definition: "String", # required
label: "CategoricalScaleDefinitionLabelString", # required
},
],
},
},
],
},
model_config: { # required
bedrock_evaluator_model_config: {
model_id: "ModelId", # required
inference_config: {
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
stop_sequences: ["NonEmptyString"],
},
additional_model_request_fields: {
},
},
responses_evaluator_model_config: {
model_id: "ModelId", # required
max_output_tokens: 1,
temperature: 1.0,
top_p: 1.0,
reasoning: {
effort: "ReasoningConfigurationEffortString",
},
},
},
},
code_based: {
lambda_config: {
lambda_arn: "LambdaArn", # required
lambda_timeout_in_seconds: 1,
},
},
derived: {
base_evaluator_id: "EvaluatorId", # required
model_config: { # required
bedrock_evaluator_model_config: {
model_id: "ModelId", # required
inference_config: {
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
stop_sequences: ["NonEmptyString"],
},
additional_model_request_fields: {
},
},
responses_evaluator_model_config: {
model_id: "ModelId", # required
max_output_tokens: 1,
temperature: 1.0,
top_p: 1.0,
reasoning: {
effort: "ReasoningConfigurationEffortString",
},
},
},
},
},
level: "TOOL_CALL", # required, accepts TOOL_CALL, TRACE, SESSION
kms_key_arn: "KmsKeyArn",
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.evaluator_arn #=> String
resp.evaluator_id #=> String
resp.created_at #=> Time
resp.status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:evaluator_name
(required, String)
—
The name of the evaluator. Must be unique within your account.
-
:description
(String)
—
The description of the evaluator that explains its purpose and evaluation criteria.
-
:evaluator_config
(required, Types::EvaluatorConfig)
—
The configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.
-
:level
(required, String)
—
The evaluation level that determines the scope of evaluation. Valid values are
TOOL_CALLfor individual tool invocations,TRACEfor single request-response interactions, orSESSIONfor entire conversation sessions. -
:kms_key_arn
(String)
—
The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data, including instructions and rating scale. If you don't specify a KMS key, the evaluator data is encrypted with an Amazon Web Services owned key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to an AgentCore Evaluator. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateEvaluatorResponse)
—
Returns a response object which responds to the following methods:
- #evaluator_arn => String
- #evaluator_id => String
- #created_at => Time
- #status => String
See Also:
2059 2060 2061 2062 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2059 def create_evaluator(params = {}, options = {}) req = build_request(:create_evaluator, params) req.send_request(options) 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.
If you specify CUSTOM_JWT as the authorizerType, you must provide
an authorizerConfiguration.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_gateway({
name: "GatewayName", # required
description: "GatewayDescription",
client_token: "ClientToken",
role_arn: "RoleArn", # required
protocol_type: "MCP", # accepts MCP
protocol_configuration: {
mcp: {
supported_versions: ["McpVersion"],
instructions: "McpInstructions",
search_type: "SEMANTIC", # accepts SEMANTIC
session_configuration: {
session_timeout_in_seconds: 1,
},
streaming_configuration: {
enable_response_streaming: false,
},
disable_mcp_list_tools_pagination: false,
},
},
authorizer_type: "CUSTOM_JWT", # required, accepts CUSTOM_JWT, AWS_IAM, NONE, AUTHENTICATE_ONLY
authorizer_configuration: {
custom_jwt_authorizer: {
discovery_url: "DiscoveryUrl", # required
allowed_audience: ["AllowedAudience"],
allowed_clients: ["AllowedClient"],
allowed_scopes: ["AllowedScopeType"],
advertised_scope_mapping: {
"AllowedScopeType" => "AllowedScopeType",
},
custom_claims: [
{
inbound_token_claim_name: "InboundTokenClaimNameType", # required
inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
authorizing_claim_match_value: { # required
claim_match_value: { # required
match_value_string: "MatchValueString",
match_value_string_list: ["MatchValueString"],
},
claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
},
},
],
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
allowed_workload_configuration: {
hosting_environments: [
{
arn: "BedrockAgentcoreResourceArn", # required
},
],
workload_identities: ["WorkloadIdentityNameType"],
},
},
},
kms_key_arn: "KmsKeyArn",
interceptor_configurations: [
{
interceptor: { # required
lambda: {
arn: "LambdaFunctionArn", # required
},
},
interception_points: ["REQUEST"], # required, accepts REQUEST, RESPONSE
input_configuration: {
pass_request_headers: false, # required
payload_filter: {
exclude: [ # required
{
field: "RESPONSE_BODY", # accepts RESPONSE_BODY
},
],
},
},
},
],
policy_engine_configuration: {
arn: "GatewayPolicyEngineArn", # required
mode: "LOG_ONLY", # required, accepts LOG_ONLY, ENFORCE
},
exception_level: "DEBUG", # accepts DEBUG
tags: {
"TagKey" => "TagValue",
},
domain_override: {
default_domain: "PublicDomainName", # required
alternate_domains: ["PublicDomainName"],
},
})
Response structure
Response structure
resp.gateway_arn #=> String
resp.gateway_id #=> String
resp.gateway_url #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED"
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
resp.name #=> String
resp.description #=> String
resp.role_arn #=> String
resp.protocol_type #=> String, one of "MCP"
resp.protocol_configuration.mcp.supported_versions #=> Array
resp.protocol_configuration.mcp.supported_versions[0] #=> String
resp.protocol_configuration.mcp.instructions #=> String
resp.protocol_configuration.mcp.search_type #=> String, one of "SEMANTIC"
resp.protocol_configuration.mcp.session_configuration.session_timeout_in_seconds #=> Integer
resp.protocol_configuration.mcp.streaming_configuration.enable_response_streaming #=> Boolean
resp.protocol_configuration.mcp.disable_mcp_list_tools_pagination #=> Boolean
resp.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM", "NONE", "AUTHENTICATE_ONLY"
resp.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.kms_key_arn #=> String
resp.custom_transform_configuration.lambda.arn #=> String
resp.interceptor_configurations #=> Array
resp.interceptor_configurations[0].interceptor.lambda.arn #=> String
resp.interceptor_configurations[0].interception_points #=> Array
resp.interceptor_configurations[0].interception_points[0] #=> String, one of "REQUEST", "RESPONSE"
resp.interceptor_configurations[0].input_configuration.pass_request_headers #=> Boolean
resp.interceptor_configurations[0].input_configuration.payload_filter.exclude #=> Array
resp.interceptor_configurations[0].input_configuration.payload_filter.exclude[0].field #=> String, one of "RESPONSE_BODY"
resp.policy_engine_configuration.arn #=> String
resp.policy_engine_configuration.mode #=> String, one of "LOG_ONLY", "ENFORCE"
resp.workload_identity_details.workload_identity_arn #=> String
resp.exception_level #=> String, one of "DEBUG"
resp.web_acl_arn #=> String
resp.waf_configuration.failure_mode #=> String, one of "FAIL_CLOSE", "FAIL_OPEN"
resp.domain_override.default_domain #=> String
resp.domain_override.alternate_domains #=> Array
resp.domain_override.alternate_domains[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the gateway. The name must be unique within your account.
-
:description
(String)
—
The description of the gateway.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:role_arn
(required, String)
—
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.
-
:protocol_type
(String)
—
The protocol type for the gateway.
-
:protocol_configuration
(Types::GatewayProtocolConfiguration)
—
The configuration settings for the protocol specified in the
protocolTypeparameter. -
:authorizer_type
(required, String)
—
The type of authorizer to use for the gateway.
CUSTOM_JWT- Authorize with a bearer token.AWS_IAM- Authorize with your Amazon Web Services IAM credentials.NONE- No authorization
-
:authorizer_configuration
(Types::AuthorizerConfiguration)
—
The authorizer configuration for the gateway. Required if
authorizerTypeisCUSTOM_JWT. -
:kms_key_arn
(String)
—
The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
-
:interceptor_configurations
(Array<Types::GatewayInterceptorConfiguration>)
—
A list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations.
-
:policy_engine_configuration
(Types::GatewayPolicyEngineConfiguration)
—
The policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
-
:exception_level
(String)
—
The level of detail in error messages returned when invoking the gateway.
If the value is
DEBUG, granular exception messages are returned to help a user debug the gateway.If the value is omitted, a generic error message is returned to the end user.
-
:tags
(Hash<String,String>)
—
A map of key-value pairs to associate with the gateway as metadata tags.
-
:domain_override
(Types::DomainOverride)
—
The public domain names that the gateway advertises in its OAuth discovery URLs instead of the inbound Host header. Specify this when clients reach the gateway through your own proxy or custom domain.
Returns:
-
(Types::CreateGatewayResponse)
—
Returns a response object which responds to the following methods:
- #gateway_arn => String
- #gateway_id => String
- #gateway_url => String
- #created_at => Time
- #updated_at => Time
- #status => String
- #status_reasons => Array<String>
- #name => String
- #description => String
- #role_arn => String
- #protocol_type => String
- #protocol_configuration => Types::GatewayProtocolConfiguration
- #authorizer_type => String
- #authorizer_configuration => Types::AuthorizerConfiguration
- #kms_key_arn => String
- #custom_transform_configuration => Types::CustomTransformConfiguration
- #interceptor_configurations => Array<Types::GatewayInterceptorConfiguration>
- #policy_engine_configuration => Types::GatewayPolicyEngineConfiguration
- #workload_identity_details => Types::WorkloadIdentityDetails
- #exception_level => String
- #web_acl_arn => String
- #waf_configuration => Types::WafConfiguration
- #domain_override => Types::DomainOverride
See Also:
2402 2403 2404 2405 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2402 def create_gateway(params = {}, options = {}) req = build_request(:create_gateway, params) req.send_request(options) end |
#create_gateway_rate_limit(params = {}) ⇒ Types::CreateGatewayRateLimitResponse
Creates a rate limit for a gateway. Rate limits define throttling rules for each dimension that control request rates, token consumption rates, and concurrent connections through the gateway.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_gateway_rate_limit({
gateway_identifier: "GatewayIdentifier", # required
client_token: "ClientToken",
rate_limit_id: "GatewayRateLimitId",
description: "GatewayRateLimitDescription",
dimension_keys: ["DimensionKey"], # required
entries: [ # required
{
dimensions: { # required
"DimensionKey" => "DimensionValue",
},
requests: [
{
rate: 1.0, # required
period: "second", # required, accepts second, minute
},
],
tokens: [
{
rate: 1.0, # required
period: "second", # required, accepts second, minute
},
],
connections: [
{
rate: 1.0, # required
period: "second", # required, accepts second, minute
},
],
},
],
})
Response structure
Response structure
resp.rate_limit_id #=> String
resp.gateway_identifier #=> String
resp.description #=> String
resp.dimension_keys #=> Array
resp.dimension_keys[0] #=> String
resp.data.entries #=> Array
resp.data.entries[0].dimensions #=> Hash
resp.data.entries[0].dimensions["DimensionKey"] #=> String
resp.data.entries[0].requests #=> Array
resp.data.entries[0].requests[0].rate #=> Float
resp.data.entries[0].requests[0].period #=> String, one of "second", "minute"
resp.data.entries[0].tokens #=> Array
resp.data.entries[0].tokens[0].rate #=> Float
resp.data.entries[0].tokens[0].period #=> String, one of "second", "minute"
resp.data.entries[0].connections #=> Array
resp.data.entries[0].connections[0].rate #=> Float
resp.data.entries[0].connections[0].period #=> String, one of "second", "minute"
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.created_at #=> Time
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The unique identifier of the gateway to create the rate limit for.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:rate_limit_id
(String)
—
An optional customer-defined identifier for the rate limit. If not provided, the system generates one.
-
:description
(String)
—
An optional human-readable description for this rate limit. If not provided, the rate limit is created without a description.
-
:dimension_keys
(required, Array<String>)
—
The ordered list of dimension key names that define the scope of this rate limit. Must be unique per gateway—no two rate limits can share the same dimension keys.
-
:entries
(required, Array<Types::LimitEntry>)
—
The rule entries that map dimension values to rate configurations.
Returns:
-
(Types::CreateGatewayRateLimitResponse)
—
Returns a response object which responds to the following methods:
- #rate_limit_id => String
- #gateway_identifier => String
- #description => String
- #dimension_keys => Array<String>
- #data.entries => Array<Types::LimitEntry> (This method conflicts with a method on Response, call it through the data member)
- #status => String
- #created_at => Time
- #updated_at => Time
See Also:
2517 2518 2519 2520 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2517 def create_gateway_rate_limit(params = {}, options = {}) req = build_request(:create_gateway_rate_limit, params) req.send_request(options) end |
#create_gateway_rule(params = {}) ⇒ Types::CreateGatewayRuleResponse
Creates a rule for a gateway. Rules define conditions and actions that control how requests are routed and processed through the gateway, including principal-based access control and path-based routing.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_gateway_rule({
gateway_identifier: "GatewayIdentifier", # required
client_token: "ClientToken",
priority: 1, # required
conditions: [
{
match_principals: {
any_of: [ # required
{
iam_principal: {
arn: "IamPrincipalArn", # required
operator: "StringEquals", # accepts StringEquals, StringLike
},
},
],
},
match_paths: {
any_of: ["MatchPathPattern"], # required
},
match_models: {
any_of: [ # required
{
value: "ModelPattern", # required
operator: "StringEquals", # accepts StringEquals, StringLike
},
],
},
},
],
actions: [ # required
{
configuration_bundle: {
static_override: {
bundle_arn: "GatewayConfigurationBundleArn", # required
bundle_version: "StaticOverrideBundleVersionString", # required
},
weighted_override: {
traffic_split: [ # required
{
name: "TrafficSplitEntryNameString", # required
weight: 1, # required
configuration_bundle: { # required
bundle_arn: "GatewayConfigurationBundleArn", # required
bundle_version: "ConfigurationBundleReferenceBundleVersionString", # required
},
description: "TrafficSplitEntryDescriptionString",
metadata: {
"TrafficSplitMetadataKey" => "TrafficSplitMetadataValue",
},
},
],
},
},
route_to_target: {
static_route: {
target_name: "TargetName", # required
model: "ConcreteModelId",
fallback: {
trigger_on: {
status_codes: ["ErrorStatusCodePattern"],
errors: ["CONNECTION_ERROR"], # accepts CONNECTION_ERROR, FIRST_BYTE_TIMEOUT, UNROUTABLE
},
first_byte_timeout_milliseconds: 1,
circuit_breaker: {
mode: "ENABLED", # accepts ENABLED, DISABLED
},
target_fallback: [ # required
{
target_name: "TargetName", # required
model: "ConcreteModelId",
trigger_on: {
status_codes: ["ErrorStatusCodePattern"],
errors: ["CONNECTION_ERROR"], # accepts CONNECTION_ERROR, FIRST_BYTE_TIMEOUT, UNROUTABLE
},
first_byte_timeout_milliseconds: 1,
},
],
},
},
weighted_route: {
traffic_split: [ # required
{
target_name: "TargetName", # required
model: "ConcreteModelId",
fallback: {
trigger_on: {
status_codes: ["ErrorStatusCodePattern"],
errors: ["CONNECTION_ERROR"], # accepts CONNECTION_ERROR, FIRST_BYTE_TIMEOUT, UNROUTABLE
},
first_byte_timeout_milliseconds: 1,
circuit_breaker: {
mode: "ENABLED", # accepts ENABLED, DISABLED
},
target_fallback: [ # required
{
target_name: "TargetName", # required
model: "ConcreteModelId",
trigger_on: {
status_codes: ["ErrorStatusCodePattern"],
errors: ["CONNECTION_ERROR"], # accepts CONNECTION_ERROR, FIRST_BYTE_TIMEOUT, UNROUTABLE
},
first_byte_timeout_milliseconds: 1,
},
],
},
name: "TargetTrafficSplitEntryNameString", # required
weight: 1, # required
description: "TargetTrafficSplitEntryDescriptionString",
metadata: {
"TrafficSplitMetadataKey" => "TrafficSplitMetadataValue",
},
},
],
},
},
},
],
description: "GatewayRuleDescription",
})
Response structure
Response structure
resp.rule_id #=> String
resp.gateway_arn #=> String
resp.priority #=> Integer
resp.conditions #=> Array
resp.conditions[0].match_principals.any_of #=> Array
resp.conditions[0].match_principals.any_of[0].iam_principal.arn #=> String
resp.conditions[0].match_principals.any_of[0].iam_principal.operator #=> String, one of "StringEquals", "StringLike"
resp.conditions[0].match_paths.any_of #=> Array
resp.conditions[0].match_paths.any_of[0] #=> String
resp.conditions[0].match_models.any_of #=> Array
resp.conditions[0].match_models.any_of[0].value #=> String
resp.conditions[0].match_models.any_of[0].operator #=> String, one of "StringEquals", "StringLike"
resp.actions #=> Array
resp.actions[0].configuration_bundle.static_override.bundle_arn #=> String
resp.actions[0].configuration_bundle.static_override.bundle_version #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split #=> Array
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].name #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].weight #=> Integer
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].configuration_bundle.bundle_arn #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].configuration_bundle.bundle_version #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].description #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].metadata #=> Hash
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].metadata["TrafficSplitMetadataKey"] #=> String
resp.actions[0].route_to_target.static_route.target_name #=> String
resp.actions[0].route_to_target.static_route.model #=> String
resp.actions[0].route_to_target.static_route.fallback.trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.static_route.fallback.trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.static_route.fallback.trigger_on.errors #=> Array
resp.actions[0].route_to_target.static_route.fallback.trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.static_route.fallback.first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.static_route.fallback.circuit_breaker.mode #=> String, one of "ENABLED", "DISABLED"
resp.actions[0].route_to_target.static_route.fallback.target_fallback #=> Array
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].target_name #=> String
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].model #=> String
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.errors #=> Array
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].target_name #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].model #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.errors #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.circuit_breaker.mode #=> String, one of "ENABLED", "DISABLED"
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].target_name #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].model #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.errors #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split[0].name #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].weight #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split[0].description #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].metadata #=> Hash
resp.actions[0].route_to_target.weighted_route.traffic_split[0].metadata["TrafficSplitMetadataKey"] #=> String
resp.description #=> String
resp.created_at #=> Time
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.system.managed_by #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway to create a rule for.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:priority
(required, Integer)
—
The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first. Must be between 1 and 1,000,000.
-
:conditions
(Array<Types::Condition>)
—
The conditions that must be met for the rule to apply. Conditions can match on principals (IAM ARNs) or request paths.
-
:actions
(required, Array<Types::Action>)
—
The actions to take when the rule conditions are met. Actions can route to a specific target or apply a configuration bundle override.
-
:description
(String)
—
The description of the gateway rule.
Returns:
-
(Types::CreateGatewayRuleResponse)
—
Returns a response object which responds to the following methods:
- #rule_id => String
- #gateway_arn => String
- #priority => Integer
- #conditions => Array<Types::Condition>
- #actions => Array<Types::Action>
- #description => String
- #created_at => Time
- #status => String
- #system => Types::SystemManagedBlock
See Also:
2764 2765 2766 2767 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 2764 def create_gateway_rule(params = {}, options = {}) req = build_request(:create_gateway_rule, params) req.send_request(options) end |
#create_gateway_target(params = {}) ⇒ Types::CreateGatewayTargetResponse
Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_gateway_target({
gateway_identifier: "GatewayIdentifier", # required
name: "TargetName",
description: "TargetDescription",
client_token: "ClientToken",
target_configuration: { # required
mcp: {
open_api_schema: {
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: "InlinePayload",
},
smithy_model: {
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: "InlinePayload",
},
lambda: {
lambda_arn: "LambdaFunctionArn", # required
tool_schema: { # required
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: [
{
name: "String", # required
description: "String", # required
input_schema: { # required
type: "string", # required, accepts string, number, object, array, boolean, integer
properties: {
"String" => {
# recursive SchemaDefinition
},
},
required: ["String"],
items: {
# recursive SchemaDefinition
},
description: "String",
},
output_schema: {
type: "string", # required, accepts string, number, object, array, boolean, integer
properties: {
"String" => {
# recursive SchemaDefinition
},
},
required: ["String"],
items: {
# recursive SchemaDefinition
},
description: "String",
},
},
],
},
},
mcp_server: {
endpoint: "McpServerTargetConfigurationEndpointString", # required
mcp_tool_schema: {
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: "InlinePayload",
},
listing_mode: "DEFAULT", # accepts DEFAULT, DYNAMIC
resource_priority: 1,
},
api_gateway: {
rest_api_id: "String", # required
stage: "String", # required
api_gateway_tool_configuration: { # required
tool_overrides: [
{
name: "String", # required
description: "String",
path: "String", # required
method: "GET", # required, accepts GET, DELETE, HEAD, OPTIONS, PATCH, PUT, POST
},
],
tool_filters: [ # required
{
filter_path: "String", # required
methods: ["GET"], # required, accepts GET, DELETE, HEAD, OPTIONS, PATCH, PUT, POST
},
],
},
},
connector: {
source: { # required
connector_id: "ConnectorId", # required
version: "ConnectorVersion",
},
enabled: ["String"],
configurations: [
{
name: "ConnectorConfigurationNameString", # required
description: "ConnectorConfigurationDescriptionString",
parameter_values: {
},
parameter_overrides: [
{
path: "String", # required
description: "String",
visible: false,
},
],
},
],
},
},
http: {
agentcore_runtime: {
arn: "RuntimeArn", # required
qualifier: "RuntimeQualifier",
schema: {
source: { # required
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: "InlinePayload",
},
},
},
passthrough: {
endpoint: "PassthroughEndpoint", # required
protocol_type: "MCP", # required, accepts MCP, A2A, INFERENCE, CUSTOM
schema: {
source: { # required
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: "InlinePayload",
},
},
stickiness_configuration: {
identifier: "StickinessConfigurationIdentifierString", # required
timeout: 1,
composite_identifier: ["CompositeIdentifierEntry"],
},
static_query_parameters: {
"StaticQueryParameterName" => "StaticQueryParameterValue",
},
static_query_parameter_conflict_resolution: "CLIENT_OVERRIDE", # accepts CLIENT_OVERRIDE, STATIC_OVERRIDE
},
connector: {
source: { # required
connector_id: "ConnectorId", # required
},
parameters: {
"ConnectorParameterName" => "ConnectorParameterValue",
},
},
},
inference: {
connector: {
source: { # required
connector_id: "InferenceConnectorId", # required
},
},
provider: {
endpoint: "PassthroughEndpoint", # required
model_mapping: {
provider_prefix: {
strip: false,
separator: "ProviderPrefixSeparatorString",
},
},
operations: [
{
path: "InferenceOperationPath", # required
provider_path: "InferenceOperationPath",
models: [
{
model: "ModelPattern", # required
},
],
},
],
},
},
},
credential_provider_configurations: [
{
credential_provider_type: "GATEWAY_IAM_ROLE", # required, accepts GATEWAY_IAM_ROLE, OAUTH, API_KEY, CALLER_IAM_CREDENTIALS, JWT_PASSTHROUGH
credential_provider: {
oauth_credential_provider: {
provider_arn: "OAuthCredentialProviderArn", # required
scopes: ["OAuthScope"], # required
custom_parameters: {
"OAuthCustomParametersKey" => "OAuthCustomParametersValue",
},
grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE, TOKEN_EXCHANGE
default_return_url: "OAuthDefaultReturnUrl",
},
api_key_credential_provider: {
provider_arn: "ApiKeyCredentialProviderArn", # required
credential_parameter_name: "ApiKeyCredentialParameterName",
credential_prefix: "ApiKeyCredentialPrefix",
credential_location: "HEADER", # accepts HEADER, QUERY_PARAMETER
},
iam_credential_provider: {
service: "IamCredentialProviderServiceString", # required
region: "IamCredentialProviderRegionString",
},
},
},
],
metadata_configuration: {
allowed_request_headers: ["HttpHeaderName"],
allowed_query_parameters: ["HttpQueryParameterName"],
allowed_response_headers: ["HttpHeaderName"],
},
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
})
Response structure
Response structure
resp.gateway_arn #=> String
resp.target_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED", "SYNCHRONIZING", "SYNCHRONIZE_UNSUCCESSFUL", "CREATE_PENDING_AUTH", "UPDATE_PENDING_AUTH", "SYNCHRONIZE_PENDING_AUTH"
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
resp.name #=> String
resp.description #=> String
resp.target_configuration.mcp.open_api_schema.s3.uri #=> String
resp.target_configuration.mcp.open_api_schema.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.open_api_schema.inline_payload #=> String
resp.target_configuration.mcp.smithy_model.s3.uri #=> String
resp.target_configuration.mcp.smithy_model.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.smithy_model.inline_payload #=> String
resp.target_configuration.mcp.lambda.lambda_arn #=> String
resp.target_configuration.mcp.lambda.tool_schema.s3.uri #=> String
resp.target_configuration.mcp.lambda.tool_schema.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload #=> Array
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].name #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].description #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.type #=> String, one of "string", "number", "object", "array", "boolean", "integer"
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.properties #=> Hash
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.properties["String"] #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.required #=> Array
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.required[0] #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.items #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.description #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.type #=> String, one of "string", "number", "object", "array", "boolean", "integer"
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.properties #=> Hash
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.properties["String"] #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.required #=> Array
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.required[0] #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.items #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.description #=> String
resp.target_configuration.mcp.mcp_server.endpoint #=> String
resp.target_configuration.mcp.mcp_server.mcp_tool_schema.s3.uri #=> String
resp.target_configuration.mcp.mcp_server.mcp_tool_schema.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.mcp_server.mcp_tool_schema.inline_payload #=> String
resp.target_configuration.mcp.mcp_server.listing_mode #=> String, one of "DEFAULT", "DYNAMIC"
resp.target_configuration.mcp.mcp_server.resource_priority #=> Integer
resp.target_configuration.mcp.api_gateway.rest_api_id #=> String
resp.target_configuration.mcp.api_gateway.stage #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides #=> Array
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].name #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].description #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].path #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].method #=> String, one of "GET", "DELETE", "HEAD", "OPTIONS", "PATCH", "PUT", "POST"
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters #=> Array
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].filter_path #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].methods #=> Array
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].methods[0] #=> String, one of "GET", "DELETE", "HEAD", "OPTIONS", "PATCH", "PUT", "POST"
resp.target_configuration.mcp.connector.source.connector_id #=> String
resp.target_configuration.mcp.connector.source.version #=> String
resp.target_configuration.mcp.connector.enabled #=> Array
resp.target_configuration.mcp.connector.enabled[0] #=> String
resp.target_configuration.mcp.connector.configurations #=> Array
resp.target_configuration.mcp.connector.configurations[0].name #=> String
resp.target_configuration.mcp.connector.configurations[0].description #=> String
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides #=> Array
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides[0].path #=> String
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides[0].description #=> String
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides[0].visible #=> Boolean
resp.target_configuration.http.agentcore_runtime.arn #=> String
resp.target_configuration.http.agentcore_runtime.qualifier #=> String
resp.target_configuration.http.agentcore_runtime.schema.source.s3.uri #=> String
resp.target_configuration.http.agentcore_runtime.schema.source.s3.bucket_owner_account_id #=> String
resp.target_configuration.http.agentcore_runtime.schema.source.inline_payload #=> String
resp.target_configuration.http.passthrough.endpoint #=> String
resp.target_configuration.http.passthrough.protocol_type #=> String, one of "MCP", "A2A", "INFERENCE", "CUSTOM"
resp.target_configuration.http.passthrough.schema.source.s3.uri #=> String
resp.target_configuration.http.passthrough.schema.source.s3.bucket_owner_account_id #=> String
resp.target_configuration.http.passthrough.schema.source.inline_payload #=> String
resp.target_configuration.http.passthrough.stickiness_configuration.identifier #=> String
resp.target_configuration.http.passthrough.stickiness_configuration.timeout #=> Integer
resp.target_configuration.http.passthrough.stickiness_configuration.composite_identifier #=> Array
resp.target_configuration.http.passthrough.stickiness_configuration.composite_identifier[0] #=> String
resp.target_configuration.http.passthrough.static_query_parameters #=> Hash
resp.target_configuration.http.passthrough.static_query_parameters["StaticQueryParameterName"] #=> String
resp.target_configuration.http.passthrough.static_query_parameter_conflict_resolution #=> String, one of "CLIENT_OVERRIDE", "STATIC_OVERRIDE"
resp.target_configuration.http.connector.source.connector_id #=> String
resp.target_configuration.http.connector.parameters #=> Hash
resp.target_configuration.http.connector.parameters["ConnectorParameterName"] #=> String
resp.target_configuration.inference.connector.source.connector_id #=> String
resp.target_configuration.inference.provider.endpoint #=> String
resp.target_configuration.inference.provider.model_mapping.provider_prefix.strip #=> Boolean
resp.target_configuration.inference.provider.model_mapping.provider_prefix.separator #=> String
resp.target_configuration.inference.provider.operations #=> Array
resp.target_configuration.inference.provider.operations[0].path #=> String
resp.target_configuration.inference.provider.operations[0].provider_path #=> String
resp.target_configuration.inference.provider.operations[0].models #=> Array
resp.target_configuration.inference.provider.operations[0].models[0].model #=> String
resp.credential_provider_configurations #=> Array
resp.credential_provider_configurations[0].credential_provider_type #=> String, one of "GATEWAY_IAM_ROLE", "OAUTH", "API_KEY", "CALLER_IAM_CREDENTIALS", "JWT_PASSTHROUGH"
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["OAuthCustomParametersKey"] #=> String
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "TOKEN_EXCHANGE"
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.default_return_url #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.provider_arn #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_parameter_name #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_prefix #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_location #=> String, one of "HEADER", "QUERY_PARAMETER"
resp.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
resp.last_synchronized_at #=> Time
resp.metadata_configuration.allowed_request_headers #=> Array
resp.metadata_configuration.allowed_request_headers[0] #=> String
resp.metadata_configuration.allowed_query_parameters #=> Array
resp.metadata_configuration.allowed_query_parameters[0] #=> String
resp.metadata_configuration.allowed_response_headers #=> Array
resp.metadata_configuration.allowed_response_headers[0] #=> String
resp.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.private_endpoint_managed_resources #=> Array
resp.private_endpoint_managed_resources[0].domain #=> String
resp.private_endpoint_managed_resources[0].resource_gateway_arn #=> String
resp.private_endpoint_managed_resources[0].resource_association_arn #=> String
resp.authorization_data.oauth2.authorization_url #=> String
resp.authorization_data.oauth2.user_id #=> String
resp.protocol_type #=> String, one of "MCP", "HTTP"
resp.certificate_configurations #=> Array
resp.certificate_configurations[0].s3.uri #=> String
resp.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.certificate_configurations[0].secrets_manager.secret_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway to create a target for.
-
:name
(String)
—
The name of the gateway target. The name must be unique within the gateway.
-
:description
(String)
—
The description of the gateway target.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:target_configuration
(required, Types::TargetConfiguration)
—
The configuration settings for the target, including endpoint information and schema definitions.
-
:credential_provider_configurations
(Array<Types::CredentialProviderConfiguration>)
—
The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.
-
:metadata_configuration
(Types::MetadataConfiguration)
—
Optional configuration for HTTP header and query parameter propagation to and from the gateway target.
-
:private_endpoint
(Types::PrivateEndpoint)
—
The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.
-
:certificate_configurations
(Array<Types::CertificateConfiguration>)
—
The private certificate authority (CA) configurations for the gateway target. Use this to have the gateway trust a private CA when it establishes TLS connections to the target endpoint. Provide each certificate by reference to an Amazon S3 object or an Amazon Web Services Secrets Manager secret. You can specify only one certificate authority configuration in this list.
Returns:
-
(Types::CreateGatewayTargetResponse)
—
Returns a response object which responds to the following methods:
- #gateway_arn => String
- #target_id => String
- #created_at => Time
- #updated_at => Time
- #status => String
- #status_reasons => Array<String>
- #name => String
- #description => String
- #target_configuration => Types::TargetConfiguration
- #credential_provider_configurations => Array<Types::CredentialProviderConfiguration>
- #last_synchronized_at => Time
- #metadata_configuration => Types::MetadataConfiguration
- #private_endpoint => Types::PrivateEndpoint
- #private_endpoint_managed_resources => Array<Types::ManagedResourceDetails>
- #authorization_data => Types::AuthorizationData
- #protocol_type => String
- #certificate_configurations => Array<Types::CertificateConfiguration>
See Also:
3234 3235 3236 3237 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3234 def create_gateway_target(params = {}, options = {}) req = build_request(:create_gateway_target, params) req.send_request(options) end |
#create_harness(params = {}) ⇒ Types::CreateHarnessResponse
Operation to create a harness.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_harness({
harness_name: "HarnessName", # required
client_token: "ClientToken",
execution_role_arn: "RoleArn", # required
environment: {
agent_core_runtime_environment: {
lifecycle_configuration: {
idle_runtime_session_timeout: 1,
max_lifetime: 1,
},
network_configuration: {
network_mode: "PUBLIC", # required, accepts PUBLIC, VPC
network_mode_config: {
security_groups: ["SecurityGroupId"], # required
subnets: ["SubnetId"], # required
require_service_s3_endpoint: false,
},
},
filesystem_configurations: [
{
session_storage: {
mount_path: "MountPath", # required
},
s3_files_access_point: {
access_point_arn: "S3FilesAccessPointArn", # required
mount_path: "MountPath", # required
},
efs_access_point: {
access_point_arn: "EfsAccessPointArn", # required
mount_path: "MountPath", # required
},
capacity_provider_volume: {
volume_name: "CapacityProviderVolumeName", # required
mount_path: "MountPath", # required
},
},
],
},
},
environment_artifact: {
container_configuration: {
container_uri: "RuntimeContainerUri", # required
},
},
environment_variables: {
"EnvironmentVariableKey" => "EnvironmentVariableValue",
},
authorizer_configuration: {
custom_jwt_authorizer: {
discovery_url: "DiscoveryUrl", # required
allowed_audience: ["AllowedAudience"],
allowed_clients: ["AllowedClient"],
allowed_scopes: ["AllowedScopeType"],
advertised_scope_mapping: {
"AllowedScopeType" => "AllowedScopeType",
},
custom_claims: [
{
inbound_token_claim_name: "InboundTokenClaimNameType", # required
inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
authorizing_claim_match_value: { # required
claim_match_value: { # required
match_value_string: "MatchValueString",
match_value_string_list: ["MatchValueString"],
},
claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
},
},
],
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
allowed_workload_configuration: {
hosting_environments: [
{
arn: "BedrockAgentcoreResourceArn", # required
},
],
workload_identities: ["WorkloadIdentityNameType"],
},
},
},
model: {
bedrock_model_config: {
model_id: "ModelId", # required
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
api_format: "converse_stream", # accepts converse_stream, responses, chat_completions
additional_params: {
},
},
open_ai_model_config: {
model_id: "ModelId", # required
api_key_arn: "ApiKeyArn", # required
api_base: "HarnessOpenAiApiBase",
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
api_format: "chat_completions", # accepts chat_completions, responses
additional_params: {
},
},
gemini_model_config: {
model_id: "ModelId", # required
api_key_arn: "ApiKeyArn", # required
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
top_k: 1,
additional_params: {
},
},
lite_llm_model_config: {
model_id: "ModelId", # required
api_key_arn: "ApiKeyArn",
api_base: "HarnessLiteLlmApiBase",
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
additional_params: {
},
},
},
system_prompt: [
{
text: "SensitiveText",
},
],
tools: [
{
type: "remote_mcp", # required, accepts remote_mcp, agentcore_browser, agentcore_gateway, inline_function, agentcore_code_interpreter
name: "HarnessToolName",
config: {
remote_mcp: {
url: "HarnessRemoteMcpUrl", # required
headers: {
"HttpHeaderKey" => "HttpHeaderValue",
},
outbound_auth: {
aws_iam: {
service: "IamCredentialProviderServiceString", # required
region: "IamCredentialProviderRegionString",
},
none: {
},
},
},
agent_core_browser: {
browser_arn: "HarnessBrowserArn",
},
agent_core_gateway: {
gateway_arn: "GatewayArn", # required
outbound_auth: {
aws_iam: {
},
none: {
},
oauth: {
provider_arn: "OAuthCredentialProviderArn", # required
scopes: ["OAuthScope"], # required
custom_parameters: {
"OAuthCustomParametersKey" => "OAuthCustomParametersValue",
},
grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE, TOKEN_EXCHANGE
default_return_url: "OAuthDefaultReturnUrl",
},
},
},
inline_function: {
description: "HarnessInlineFunctionDescription", # required
input_schema: { # required
},
},
agent_core_code_interpreter: {
code_interpreter_arn: "HarnessCodeInterpreterArn",
},
},
},
],
skills: [
{
path: "HarnessSkillPath",
s3: {
uri: "HarnessSkillS3Uri", # required
},
git: {
url: "HarnessSkillGitUrl", # required
path: "String",
auth: {
credential_arn: "ApiKeyArn", # required
username: "String",
},
},
aws_skills: {
paths: ["HarnessAwsSkillPath"],
},
},
],
allowed_tools: ["HarnessAllowedTool"],
memory: {
agent_core_memory_configuration: {
arn: "MemoryArn", # required
actor_id: "String",
messages_count: 1,
retrieval_config: {
"String" => {
top_k: 1,
relevance_score: 1.0,
strategy_id: "String",
},
},
},
managed_memory_configuration: {
arn: "MemoryArn",
strategies: ["SEMANTIC"], # accepts SEMANTIC, SUMMARIZATION, USER_PREFERENCE, EPISODIC
event_expiry_duration: 1,
encryption_key_arn: "KmsKeyArn",
},
disabled: {
},
},
truncation: {
strategy: "sliding_window", # required, accepts sliding_window, summarization, none
config: {
sliding_window: {
messages_count: 1,
},
summarization: {
summary_ratio: 1.0,
preserve_recent_messages: 1,
summarization_system_prompt: "String",
},
},
},
hooks: [
{
before_invocation: {
name: "HarnessHookName", # required
target: { # required
lambda: {
arn: "HarnessLambdaFunctionArn", # required
timeout_seconds: 1,
failure_mode: "allow", # accepts allow, deny
},
sns: {
arn: "HarnessSnsTopicArn", # required
},
event_bridge: {
arn: "HarnessEventBridgeBusArn", # required
},
},
},
after_invocation: {
name: "HarnessHookName", # required
target: { # required
lambda: {
arn: "HarnessLambdaFunctionArn", # required
timeout_seconds: 1,
failure_mode: "allow", # accepts allow, deny
},
sns: {
arn: "HarnessSnsTopicArn", # required
},
event_bridge: {
arn: "HarnessEventBridgeBusArn", # required
},
},
},
before_tool_call: {
name: "HarnessHookName", # required
target: { # required
lambda: {
arn: "HarnessLambdaFunctionArn", # required
timeout_seconds: 1,
failure_mode: "allow", # accepts allow, deny
},
sns: {
arn: "HarnessSnsTopicArn", # required
},
event_bridge: {
arn: "HarnessEventBridgeBusArn", # required
},
},
},
after_tool_call: {
name: "HarnessHookName", # required
target: { # required
lambda: {
arn: "HarnessLambdaFunctionArn", # required
timeout_seconds: 1,
failure_mode: "allow", # accepts allow, deny
},
sns: {
arn: "HarnessSnsTopicArn", # required
},
event_bridge: {
arn: "HarnessEventBridgeBusArn", # required
},
},
},
},
],
max_iterations: 1,
max_tokens: 1,
timeout_seconds: 1,
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.harness.harness_id #=> String
resp.harness.harness_name #=> String
resp.harness.arn #=> String
resp.harness.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.harness.harness_version #=> String
resp.harness.execution_role_arn #=> String
resp.harness.created_at #=> Time
resp.harness.updated_at #=> Time
resp.harness.model.bedrock_model_config.model_id #=> String
resp.harness.model.bedrock_model_config.max_tokens #=> Integer
resp.harness.model.bedrock_model_config.temperature #=> Float
resp.harness.model.bedrock_model_config.top_p #=> Float
resp.harness.model.bedrock_model_config.api_format #=> String, one of "converse_stream", "responses", "chat_completions"
resp.harness.model.open_ai_model_config.model_id #=> String
resp.harness.model.open_ai_model_config.api_key_arn #=> String
resp.harness.model.open_ai_model_config.api_base #=> String
resp.harness.model.open_ai_model_config.max_tokens #=> Integer
resp.harness.model.open_ai_model_config.temperature #=> Float
resp.harness.model.open_ai_model_config.top_p #=> Float
resp.harness.model.open_ai_model_config.api_format #=> String, one of "chat_completions", "responses"
resp.harness.model.gemini_model_config.model_id #=> String
resp.harness.model.gemini_model_config.api_key_arn #=> String
resp.harness.model.gemini_model_config.max_tokens #=> Integer
resp.harness.model.gemini_model_config.temperature #=> Float
resp.harness.model.gemini_model_config.top_p #=> Float
resp.harness.model.gemini_model_config.top_k #=> Integer
resp.harness.model.lite_llm_model_config.model_id #=> String
resp.harness.model.lite_llm_model_config.api_key_arn #=> String
resp.harness.model.lite_llm_model_config.api_base #=> String
resp.harness.model.lite_llm_model_config.max_tokens #=> Integer
resp.harness.model.lite_llm_model_config.temperature #=> Float
resp.harness.model.lite_llm_model_config.top_p #=> Float
resp.harness.system_prompt #=> Array
resp.harness.system_prompt[0].text #=> String
resp.harness.tools #=> Array
resp.harness.tools[0].type #=> String, one of "remote_mcp", "agentcore_browser", "agentcore_gateway", "inline_function", "agentcore_code_interpreter"
resp.harness.tools[0].name #=> String
resp.harness.tools[0].config.remote_mcp.url #=> String
resp.harness.tools[0].config.remote_mcp.headers #=> Hash
resp.harness.tools[0].config.remote_mcp.headers["HttpHeaderKey"] #=> String
resp.harness.tools[0].config.remote_mcp.outbound_auth.aws_iam.service #=> String
resp.harness.tools[0].config.remote_mcp.outbound_auth.aws_iam.region #=> String
resp.harness.tools[0].config.agent_core_browser.browser_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.gateway_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.provider_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.scopes #=> Array
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.scopes[0] #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.custom_parameters #=> Hash
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.custom_parameters["OAuthCustomParametersKey"] #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.grant_type #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "TOKEN_EXCHANGE"
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.default_return_url #=> String
resp.harness.tools[0].config.inline_function.description #=> String
resp.harness.tools[0].config.agent_core_code_interpreter.code_interpreter_arn #=> String
resp.harness.skills #=> Array
resp.harness.skills[0].path #=> String
resp.harness.skills[0].s3.uri #=> String
resp.harness.skills[0].git.url #=> String
resp.harness.skills[0].git.path #=> String
resp.harness.skills[0].git.auth.credential_arn #=> String
resp.harness.skills[0].git.auth.username #=> String
resp.harness.skills[0].aws_skills.paths #=> Array
resp.harness.skills[0].aws_skills.paths[0] #=> String
resp.harness.allowed_tools #=> Array
resp.harness.allowed_tools[0] #=> String
resp.harness.truncation.strategy #=> String, one of "sliding_window", "summarization", "none"
resp.harness.truncation.config.sliding_window.messages_count #=> Integer
resp.harness.truncation.config.summarization.summary_ratio #=> Float
resp.harness.truncation.config.summarization.preserve_recent_messages #=> Integer
resp.harness.truncation.config.summarization.summarization_system_prompt #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_arn #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_name #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_id #=> String
resp.harness.environment.agent_core_runtime_environment.lifecycle_configuration.idle_runtime_session_timeout #=> Integer
resp.harness.environment.agent_core_runtime_environment.lifecycle_configuration.max_lifetime #=> Integer
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode #=> String, one of "PUBLIC", "VPC"
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.security_groups #=> Array
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.security_groups[0] #=> String
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.subnets #=> Array
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.subnets[0] #=> String
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.require_service_s3_endpoint #=> Boolean
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations #=> Array
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].session_storage.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].s3_files_access_point.access_point_arn #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].s3_files_access_point.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].efs_access_point.access_point_arn #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].efs_access_point.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].capacity_provider_volume.volume_name #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].capacity_provider_volume.mount_path #=> String
resp.harness.environment_artifact.container_configuration.container_uri #=> String
resp.harness.environment_variables #=> Hash
resp.harness.environment_variables["EnvironmentVariableKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.harness.memory.agent_core_memory_configuration.arn #=> String
resp.harness.memory.agent_core_memory_configuration.actor_id #=> String
resp.harness.memory.agent_core_memory_configuration.messages_count #=> Integer
resp.harness.memory.agent_core_memory_configuration.retrieval_config #=> Hash
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].top_k #=> Integer
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].relevance_score #=> Float
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].strategy_id #=> String
resp.harness.memory.managed_memory_configuration.arn #=> String
resp.harness.memory.managed_memory_configuration.strategies #=> Array
resp.harness.memory.managed_memory_configuration.strategies[0] #=> String, one of "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "EPISODIC"
resp.harness.memory.managed_memory_configuration.event_expiry_duration #=> Integer
resp.harness.memory.managed_memory_configuration.encryption_key_arn #=> String
resp.harness.hooks #=> Array
resp.harness.hooks[0].before_invocation.name #=> String
resp.harness.hooks[0].before_invocation.target.lambda.arn #=> String
resp.harness.hooks[0].before_invocation.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].before_invocation.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].before_invocation.target.sns.arn #=> String
resp.harness.hooks[0].before_invocation.target.event_bridge.arn #=> String
resp.harness.hooks[0].after_invocation.name #=> String
resp.harness.hooks[0].after_invocation.target.lambda.arn #=> String
resp.harness.hooks[0].after_invocation.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].after_invocation.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].after_invocation.target.sns.arn #=> String
resp.harness.hooks[0].after_invocation.target.event_bridge.arn #=> String
resp.harness.hooks[0].before_tool_call.name #=> String
resp.harness.hooks[0].before_tool_call.target.lambda.arn #=> String
resp.harness.hooks[0].before_tool_call.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].before_tool_call.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].before_tool_call.target.sns.arn #=> String
resp.harness.hooks[0].before_tool_call.target.event_bridge.arn #=> String
resp.harness.hooks[0].after_tool_call.name #=> String
resp.harness.hooks[0].after_tool_call.target.lambda.arn #=> String
resp.harness.hooks[0].after_tool_call.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].after_tool_call.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].after_tool_call.target.sns.arn #=> String
resp.harness.hooks[0].after_tool_call.target.event_bridge.arn #=> String
resp.harness.max_iterations #=> Integer
resp.harness.max_tokens #=> Integer
resp.harness.timeout_seconds #=> Integer
resp.harness.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:harness_name
(required, String)
—
The name of the harness. Must start with a letter and contain only alphanumeric characters and underscores.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:execution_role_arn
(required, String)
—
The ARN of the IAM role that the harness assumes when running. This role must have permissions for the services the agent needs to access, such as Amazon Bedrock for model invocation.
-
:environment
(Types::HarnessEnvironmentProviderRequest)
—
The compute environment configuration for the harness, including network and lifecycle settings.
-
:environment_artifact
(Types::HarnessEnvironmentArtifact)
—
The environment artifact for the harness, such as a custom container image containing additional dependencies.
-
:environment_variables
(Hash<String,String>)
—
Environment variables to set in the harness runtime environment.
-
:authorizer_configuration
(Types::AuthorizerConfiguration)
—
Represents inbound authorization configuration options used to authenticate incoming requests.
-
:model
(Types::HarnessModelConfiguration)
—
The model configuration for the harness. Supports Amazon Bedrock, OpenAI, and Google Gemini model providers.
-
:system_prompt
(Array<Types::HarnessSystemContentBlock>)
—
The system prompt that defines the agent's behavior and instructions.
-
:tools
(Array<Types::HarnessTool>)
—
The tools available to the agent, such as remote MCP servers, AgentCore Gateway, AgentCore Browser, Code Interpreter, or inline functions.
-
:skills
(Array<Types::HarnessSkill>)
—
The skills available to the agent. Skills are bundles of files that the agent can pull into its context on demand.
-
:allowed_tools
(Array<String>)
—
The tools that the agent is allowed to use. Supports glob patterns such as * for all tools, @builtin for all built-in tools, or @serverName/toolName for specific MCP server tools.
-
:memory
(Types::HarnessMemoryConfiguration)
—
The AgentCore Memory configuration for persisting conversation context across sessions.
-
:truncation
(Types::HarnessTruncationConfiguration)
—
The truncation configuration for managing conversation context when it exceeds model limits.
-
:hooks
(Array<Types::HarnessHook>)
—
The lifecycle hooks to run at defined points in the agent loop.
-
:max_iterations
(Integer)
—
The maximum number of iterations the agent loop can execute per invocation.
-
:max_tokens
(Integer)
—
The maximum total number of output tokens the agent can generate across all model calls within a single invocation.
-
:timeout_seconds
(Integer)
—
The maximum duration in seconds for the agent loop execution per invocation.
-
:tags
(Hash<String,String>)
—
Tags to apply to the harness resource.
Returns:
See Also:
3864 3865 3866 3867 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3864 def create_harness(params = {}, options = {}) req = build_request(:create_harness, params) req.send_request(options) end |
#create_harness_endpoint(params = {}) ⇒ Types::CreateHarnessEndpointResponse
Operation to create a harness endpoint.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_harness_endpoint({
harness_id: "HarnessId", # required
endpoint_name: "HarnessEndpointName", # required
target_version: "HarnessVersion",
description: "HarnessEndpointDescription",
client_token: "ClientToken",
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.endpoint.harness_id #=> String
resp.endpoint.harness_name #=> String
resp.endpoint.endpoint_name #=> String
resp.endpoint.arn #=> String
resp.endpoint.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.endpoint.created_at #=> Time
resp.endpoint.updated_at #=> Time
resp.endpoint.live_version #=> String
resp.endpoint.target_version #=> String
resp.endpoint.description #=> String
resp.endpoint.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:harness_id
(required, String)
—
The ID of the harness to create an endpoint for.
-
:endpoint_name
(required, String)
—
The name of the endpoint. Must start with a letter and contain only alphanumeric characters and underscores.
-
:target_version
(String)
—
The harness version that the endpoint points to and serves invocations from.
-
:description
(String)
—
A description of the endpoint.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:tags
(Hash<String,String>)
—
Tags to apply to the endpoint resource.
Returns:
See Also:
3930 3931 3932 3933 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 3930 def create_harness_endpoint(params = {}, options = {}) req = build_request(:create_harness_endpoint, params) req.send_request(options) end |
#create_memory(params = {}) ⇒ Types::CreateMemoryOutput
Creates a new Amazon Bedrock AgentCore Memory resource.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_memory({
client_token: "CreateMemoryInputClientTokenString",
name: "Name", # required
description: "Description",
encryption_key_arn: "Arn",
memory_execution_role_arn: "Arn",
event_expiry_duration: 1, # required
memory_strategies: [
{
semantic_memory_strategy: {
name: "Name", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
summary_memory_strategy: {
name: "Name", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
user_preference_memory_strategy: {
name: "Name", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
custom_memory_strategy: {
name: "Name", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
configuration: {
semantic_override: {
extraction: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
consolidation: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
},
summary_override: {
consolidation: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
},
user_preference_override: {
extraction: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
consolidation: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
},
episodic_override: {
extraction: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
consolidation: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
reflection: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
},
},
self_managed_configuration: {
trigger_conditions: [
{
message_based_trigger: {
message_count: 1,
},
token_based_trigger: {
token_count: 1,
},
time_based_trigger: {
idle_session_timeout: 1,
},
},
],
invocation_configuration: { # required
topic_arn: "Arn", # required
payload_delivery_bucket_name: "InvocationConfigurationInputPayloadDeliveryBucketNameString", # required
},
historical_context_window_size: 1,
},
},
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
episodic_memory_strategy: {
name: "Name", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
reflection_configuration: {
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
},
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
},
],
indexed_keys: [
{
key: "MetadataKey", # required
type: "STRING", # required, accepts STRING, STRINGLIST, NUMBER
},
],
namespace_keys: [
{
key: "NamespaceVariableKey", # required
validation: {
allowed_values: ["NamespaceAllowedValue"],
regex_pattern: "NamespaceRegexPattern",
},
},
],
stream_delivery_resources: {
resources: [ # required
{
kinesis: {
data_stream_arn: "Arn", # required
content_configurations: [ # required
{
type: "MEMORY_RECORDS", # required, accepts MEMORY_RECORDS
level: "METADATA_ONLY", # accepts METADATA_ONLY, FULL_CONTENT
},
],
},
},
],
},
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.memory.arn #=> String
resp.memory.id #=> String
resp.memory.name #=> String
resp.memory.description #=> String
resp.memory.encryption_key_arn #=> String
resp.memory.memory_execution_role_arn #=> String
resp.memory.event_expiry_duration #=> Integer
resp.memory.status #=> String, one of "CREATING", "ACTIVE", "FAILED", "DELETING", "UPDATING"
resp.memory.failure_reason #=> String
resp.memory.created_at #=> Time
resp.memory.updated_at #=> Time
resp.memory.strategies #=> Array
resp.memory.strategies[0].strategy_id #=> String
resp.memory.strategies[0].name #=> String
resp.memory.strategies[0].description #=> String
resp.memory.strategies[0].configuration.type #=> String, one of "SEMANTIC_OVERRIDE", "SUMMARY_OVERRIDE", "USER_PREFERENCE_OVERRIDE", "SELF_MANAGED", "EPISODIC_OVERRIDE"
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.semantic_extraction_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.semantic_extraction_override.model_id #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.user_preference_extraction_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.user_preference_extraction_override.model_id #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.episodic_extraction_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.episodic_extraction_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.semantic_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.semantic_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.summary_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.summary_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.user_preference_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.user_preference_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.episodic_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.episodic_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.model_id #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespaces #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespaces[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespace_templates #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespace_templates[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].key #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_type #=> String, one of "LLM_INFERRED", "STRICTLY_CONSISTENT"
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.llm_extraction_instruction #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.definition #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.max_items #=> Integer
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.min_value #=> Float
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.max_value #=> Float
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespaces #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespaces[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespace_templates #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespace_templates[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].key #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_type #=> String, one of "LLM_INFERRED", "STRICTLY_CONSISTENT"
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.llm_extraction_instruction #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.definition #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.max_items #=> Integer
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.min_value #=> Float
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.max_value #=> Float
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions #=> Array
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions[0].message_based_trigger.message_count #=> Integer
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions[0].token_based_trigger.token_count #=> Integer
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions[0].time_based_trigger.idle_session_timeout #=> Integer
resp.memory.strategies[0].configuration.self_managed_configuration.invocation_configuration.topic_arn #=> String
resp.memory.strategies[0].configuration.self_managed_configuration.invocation_configuration.payload_delivery_bucket_name #=> String
resp.memory.strategies[0].configuration.self_managed_configuration.historical_context_window_size #=> Integer
resp.memory.strategies[0].type #=> String, one of "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "CUSTOM", "EPISODIC"
resp.memory.strategies[0].namespaces #=> Array
resp.memory.strategies[0].namespaces[0] #=> String
resp.memory.strategies[0].namespace_templates #=> Array
resp.memory.strategies[0].namespace_templates[0] #=> String
resp.memory.strategies[0].created_at #=> Time
resp.memory.strategies[0].updated_at #=> Time
resp.memory.strategies[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.memory.strategies[0].memory_record_schema.metadata_schema #=> Array
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].key #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_type #=> String, one of "LLM_INFERRED", "STRICTLY_CONSISTENT"
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.llm_extraction_instruction #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.definition #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values #=> Array
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values[0] #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values #=> Array
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values[0] #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.max_items #=> Integer
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.min_value #=> Float
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.max_value #=> Float
resp.memory.strategies[0].record_expiry_duration_days #=> Integer
resp.memory.indexed_keys #=> Array
resp.memory.indexed_keys[0].key #=> String
resp.memory.indexed_keys[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.namespace_keys #=> Array
resp.memory.namespace_keys[0].key #=> String
resp.memory.namespace_keys[0].validation.allowed_values #=> Array
resp.memory.namespace_keys[0].validation.allowed_values[0] #=> String
resp.memory.namespace_keys[0].validation.regex_pattern #=> String
resp.memory.stream_delivery_resources.resources #=> Array
resp.memory.stream_delivery_resources.resources[0].kinesis.data_stream_arn #=> String
resp.memory.stream_delivery_resources.resources[0].kinesis.content_configurations #=> Array
resp.memory.stream_delivery_resources.resources[0].kinesis.content_configurations[0].type #=> String, one of "MEMORY_RECORDS"
resp.memory.stream_delivery_resources.resources[0].kinesis.content_configurations[0].level #=> String, one of "METADATA_ONLY", "FULL_CONTENT"
resp.memory.managed_by_resource_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:name
(required, String)
—
The name of the memory. The name must be unique within your account.
-
:description
(String)
—
The description of the memory.
-
:encryption_key_arn
(String)
—
The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.
-
:memory_execution_role_arn
(String)
—
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.
-
:event_expiry_duration
(required, Integer)
—
The number of days after which memory events expire, between 7 and 3650 days.
-
:memory_strategies
(Array<Types::MemoryStrategyInput>)
—
The memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.
-
:indexed_keys
(Array<Types::IndexedKey>)
—
Metadata keys to index for filtering. Once declared, indexed keys cannot be removed.
-
:namespace_keys
(Array<Types::NamespaceKeyEntry>)
—
The namespace variable key definitions with optional validation rules. Use these
namespaceKeysinnamespaceTemplatesto control namespace hierarchy. -
:stream_delivery_resources
(Types::StreamDeliveryResources)
—
Configuration for streaming memory record data to external resources.
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to an AgentCore Memory. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
See Also:
4467 4468 4469 4470 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 4467 def create_memory(params = {}, options = {}) req = build_request(:create_memory, params) req.send_request(options) end |
#create_oauth_2_credential_provider(params = {}) ⇒ Types::CreateOauth2CredentialProviderResponse
Creates a new OAuth2 credential provider.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_oauth_2_credential_provider({
name: "CredentialProviderName", # required
credential_provider_vendor: "GoogleOauth2", # required, accepts GoogleOauth2, GithubOauth2, SlackOauth2, SalesforceOauth2, MicrosoftOauth2, CustomOauth2, AtlassianOauth2, LinkedinOauth2, XOauth2, OktaOauth2, OneLoginOauth2, PingOneOauth2, FacebookOauth2, YandexOauth2, RedditOauth2, ZoomOauth2, TwitchOauth2, SpotifyOauth2, DropboxOauth2, NotionOauth2, HubspotOauth2, CyberArkOauth2, FusionAuthOauth2, Auth0Oauth2, CognitoOauth2
oauth2_provider_config_input: { # required
custom_oauth_2_provider_config: {
oauth_discovery: { # required
discovery_url: "DiscoveryUrlType",
authorization_server_metadata: {
issuer: "IssuerUrlType", # required
authorization_endpoint: "AuthorizationEndpointType", # required
token_endpoint: "TokenEndpointType", # required
response_types: ["ResponseType"],
token_endpoint_auth_methods: ["TokenAuthMethod"],
},
},
client_id: "DefaultClientIdType",
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
on_behalf_of_token_exchange_config: {
grant_type: "TOKEN_EXCHANGE", # required, accepts TOKEN_EXCHANGE, JWT_AUTHORIZATION_GRANT
token_exchange_grant_type_config: {
actor_token_content: "NONE", # required, accepts NONE, M2M, AWS_IAM_ID_TOKEN_JWT
actor_token_scopes: ["ScopeType"],
},
on_behalf_of_authentication_config: {
client_authentication_method: "NO_CLIENT", # required, accepts NO_CLIENT
},
},
client_authentication_method: "CLIENT_SECRET_BASIC", # accepts CLIENT_SECRET_BASIC, CLIENT_SECRET_POST, AWS_IAM_ID_TOKEN_JWT, PRIVATE_KEY_JWT
private_key_jwt_config: {
private_key_source: {
kms_key_source: {
kms_key_arn: "KmsKeyArn", # required
},
},
signing_algorithm: "RS256", # accepts RS256, PS256, ES256
additional_header_claims: {
"AdditionalClaimName" => "AdditionalClaimValue",
},
additional_payload_claims: {
"AdditionalClaimName" => "AdditionalClaimValue",
},
},
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
},
google_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
github_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
slack_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
salesforce_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
microsoft_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
tenant_id: "TenantIdType",
},
atlassian_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
linkedin_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
included_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
issuer: "IssuerUrlType",
authorization_endpoint: "AuthorizationEndpointType",
token_endpoint: "TokenEndpointType",
},
},
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.client_secret_arn.secret_arn #=> String
resp.client_secret_json_key #=> String
resp.client_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.name #=> String
resp.credential_provider_arn #=> String
resp.callback_url #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.grant_type #=> String, one of "TOKEN_EXCHANGE", "JWT_AUTHORIZATION_GRANT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.token_exchange_grant_type_config.actor_token_content #=> String, one of "NONE", "M2M", "AWS_IAM_ID_TOKEN_JWT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.token_exchange_grant_type_config.actor_token_scopes #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.token_exchange_grant_type_config.actor_token_scopes[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.on_behalf_of_authentication_config.client_authentication_method #=> String, one of "NO_CLIENT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.client_authentication_method #=> String, one of "CLIENT_SECRET_BASIC", "CLIENT_SECRET_POST", "AWS_IAM_ID_TOKEN_JWT", "PRIVATE_KEY_JWT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].domain #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations[0].s3.uri #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.private_key_source.kms_key_source.kms_key_arn #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.signing_algorithm #=> String, one of "RS256", "PS256", "ES256"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_header_claims #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_header_claims["AdditionalClaimName"] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_payload_claims #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_payload_claims["AdditionalClaimName"] #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.client_id #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the OAuth2 credential provider. The name must be unique within your account.
-
:credential_provider_vendor
(required, String)
—
The vendor of the OAuth2 credential provider. This specifies which OAuth2 implementation to use.
-
:oauth2_provider_config_input
(required, Types::Oauth2ProviderConfigInput)
—
The configuration settings for the OAuth2 provider, including client ID, client secret, and other vendor-specific settings.
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the OAuth2 credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateOauth2CredentialProviderResponse)
—
Returns a response object which responds to the following methods:
- #client_secret_arn => Types::Secret
- #client_secret_json_key => String
- #client_secret_source => String
- #name => String
- #credential_provider_arn => String
- #callback_url => String
- #oauth2_provider_config_output => Types::Oauth2ProviderConfigOutput
- #status => String
See Also:
4813 4814 4815 4816 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 4813 def create_oauth_2_credential_provider(params = {}, options = {}) req = build_request(:create_oauth_2_credential_provider, params) req.send_request(options) end |
#create_online_evaluation_config(params = {}) ⇒ Types::CreateOnlineEvaluationConfigResponse
Creates an online evaluation configuration for continuous monitoring of agent performance. Online evaluation automatically samples live traffic from CloudWatch logs at specified rates and applies evaluators to assess agent quality in production.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_online_evaluation_config({
client_token: "ClientToken",
online_evaluation_config_name: "EvaluationConfigName", # required
description: "EvaluationConfigDescription",
rule: { # required
sampling_config: { # required
sampling_percentage: 1.0, # required
},
filters: [
{
key: "FilterKeyString", # required
operator: "Equals", # required, accepts Equals, NotEquals, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Contains, NotContains
value: { # required
string_value: "FilterValueStringValueString",
double_value: 1.0,
boolean_value: false,
},
},
],
session_config: {
session_timeout_minutes: 1, # required
},
},
data_source_config: { # required
cloud_watch_logs: {
log_group_names: ["LogGroupName"],
log_group_name_prefixes: ["LogGroupNamePrefix"],
service_names: ["ServiceName"], # required
},
},
evaluators: [
{
evaluator_id: "EvaluatorId",
},
],
insights: [
{
insight_id: "InsightId", # required
},
],
clustering_config: {
frequencies: ["DAILY"], # required, accepts DAILY, WEEKLY, MONTHLY
},
output_config: {
cloud_watch_config: { # required
log_group_name: "OptionalLogGroupName",
metrics_namespace: "MetricsNamespace",
result_destination: "DEDICATED_LOG_GROUP", # accepts DEDICATED_LOG_GROUP, SOURCE_LOG_GROUP
},
},
evaluation_execution_role_arn: "RoleArn", # required
enable_on_create: false, # required
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.online_evaluation_config_arn #=> String
resp.online_evaluation_config_id #=> String
resp.created_at #=> Time
resp.output_config.cloud_watch_config.log_group_name #=> String
resp.output_config.cloud_watch_config.metrics_namespace #=> String
resp.output_config.cloud_watch_config.result_destination #=> String, one of "DEDICATED_LOG_GROUP", "SOURCE_LOG_GROUP"
resp.status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "ERROR"
resp.execution_status #=> String, one of "ENABLED", "DISABLED"
resp.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:online_evaluation_config_name
(required, String)
—
The name of the online evaluation configuration. Must be unique within your account.
-
:description
(String)
—
The description of the online evaluation configuration that explains its monitoring purpose and scope.
-
:rule
(required, Types::Rule)
—
The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.
-
:data_source_config
(required, Types::DataSourceConfig)
—
The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.
-
:evaluators
(Array<Types::EvaluatorReference>)
—
The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with
CreateEvaluator. -
:insights
(Array<Types::Insight>)
—
The list of insight types to run against agent sessions.
-
:clustering_config
(Types::ClusteringConfig)
—
Configuration for periodic batch evaluation clustering of insight results.
-
:output_config
(Types::OutputConfig)
—
The configuration that specifies where evaluation results should be written for monitoring and analysis.
-
:evaluation_execution_role_arn
(required, String)
—
The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation. If the configuration references evaluators encrypted with a customer managed KMS key, this role must also have
kms:Decryptpermission on the KMS key. The service validates this permission at configuration creation time. For more information, see Encryption at rest for AgentCore Evaluations. -
:enable_on_create
(required, Boolean)
—
Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to an AgentCore Online Evaluation Config. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateOnlineEvaluationConfigResponse)
—
Returns a response object which responds to the following methods:
- #online_evaluation_config_arn => String
- #online_evaluation_config_id => String
- #created_at => Time
- #output_config => Types::OutputConfig
- #status => String
- #execution_status => String
- #failure_reason => String
See Also:
4976 4977 4978 4979 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 4976 def create_online_evaluation_config(params = {}, options = {}) req = build_request(:create_online_evaluation_config, params) req.send_request(options) end |
#create_payment_connector(params = {}) ⇒ Types::CreatePaymentConnectorResponse
Creates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing capabilities.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_payment_connector({
payment_manager_id: "PaymentManagerId", # required
name: "PaymentConnectorName", # required
description: "PaymentsDescription",
type: "CoinbaseCDP", # required, accepts CoinbaseCDP, StripePrivy
credential_provider_configurations: [ # required
{
coinbase_cdp: {
credential_provider_arn: "PaymentCredentialProviderArn", # required
},
stripe_privy: {
credential_provider_arn: "PaymentCredentialProviderArn", # required
},
},
],
provision_mode: "MANUAL", # accepts MANUAL, QUICK_CREATE
client_token: "ClientToken",
})
Response structure
Response structure
resp.payment_connector_id #=> String
resp.payment_manager_id #=> String
resp.name #=> String
resp.type #=> String, one of "CoinbaseCDP", "StripePrivy"
resp.credential_provider_configurations #=> Array
resp.credential_provider_configurations[0].coinbase_cdp.credential_provider_arn #=> String
resp.credential_provider_configurations[0].stripe_privy.credential_provider_arn #=> String
resp.created_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED", "PENDING_AUTHENTICATION", "PROVISIONING", "AUTHENTICATION_EXPIRED", "AUTHENTICATION_FAILED"
resp.authorization_url #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:payment_manager_id
(required, String)
—
The unique identifier of the payment manager to create the connector for.
-
:name
(required, String)
—
The name of the payment connector.
-
:description
(String)
—
A description of the payment connector.
-
:type
(required, String)
—
The type of payment connector, which determines the payment provider integration.
-
:credential_provider_configurations
(required, Array<Types::CredentialsProviderConfiguration>)
—
The credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.
-
:provision_mode
(String)
—
The provision mode for creating the payment connector. If you don't specify a value, the default is
MANUAL.MANUAL- You provide the credential provider configurations directly.QUICK_CREATE- The service orchestrates OAuth consent and provisions the credential provider for you.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::CreatePaymentConnectorResponse)
—
Returns a response object which responds to the following methods:
- #payment_connector_id => String
- #payment_manager_id => String
- #name => String
- #type => String
- #credential_provider_configurations => Array<Types::CredentialsProviderConfiguration>
- #created_at => Time
- #status => String
- #authorization_url => String
See Also:
5077 5078 5079 5080 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 5077 def create_payment_connector(params = {}, options = {}) req = build_request(:create_payment_connector, params) req.send_request(options) end |
#create_payment_credential_provider(params = {}) ⇒ Types::CreatePaymentCredentialProviderResponse
Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_payment_credential_provider({
name: "CredentialProviderName", # required
credential_provider_vendor: "CoinbaseCDP", # required, accepts CoinbaseCDP, StripePrivy
provider_configuration_input: { # required
coinbase_cdp_configuration: {
api_key_id: "CoinbaseCdpApiKeyIdType", # required
api_key_secret: "DefaultCoinbaseCdpApiKeySecretType",
api_key_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
api_key_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
wallet_secret: "DefaultCoinbaseCdpWalletSecretType",
wallet_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
wallet_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
},
stripe_privy_configuration: {
app_id: "StripePrivyAppIdType", # required
app_secret: "DefaultStripePrivyAppSecretType",
app_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
app_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
authorization_private_key: "DefaultStripePrivyAuthorizationPrivateKeyType",
authorization_private_key_source: "MANAGED", # accepts MANAGED, EXTERNAL
authorization_private_key_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
authorization_id: "StripePrivyAuthorizationIdType", # required
},
},
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.name #=> String
resp.credential_provider_vendor #=> String, one of "CoinbaseCDP", "StripePrivy"
resp.credential_provider_arn #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_id #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_secret_arn.secret_arn #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_secret_json_key #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.coinbase_cdp_configuration.wallet_secret_arn.secret_arn #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.wallet_secret_json_key #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.wallet_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.stripe_privy_configuration.app_id #=> String
resp.provider_configuration_output.stripe_privy_configuration.app_secret_arn.secret_arn #=> String
resp.provider_configuration_output.stripe_privy_configuration.app_secret_json_key #=> String
resp.provider_configuration_output.stripe_privy_configuration.app_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.stripe_privy_configuration.authorization_private_key_arn.secret_arn #=> String
resp.provider_configuration_output.stripe_privy_configuration.authorization_private_key_json_key #=> String
resp.provider_configuration_output.stripe_privy_configuration.authorization_private_key_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.stripe_privy_configuration.authorization_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
Unique name for the payment credential provider.
-
:credential_provider_vendor
(required, String)
—
The vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).
-
:provider_configuration_input
(required, Types::PaymentProviderConfigurationInput)
—
Configuration specific to the vendor, including API credentials.
-
:tags
(Hash<String,String>)
—
Optional tags for resource organization.
Returns:
-
(Types::CreatePaymentCredentialProviderResponse)
—
Returns a response object which responds to the following methods:
- #name => String
- #credential_provider_vendor => String
- #credential_provider_arn => String
- #provider_configuration_output => Types::PaymentProviderConfigurationOutput
See Also:
5174 5175 5176 5177 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 5174 def create_payment_credential_provider(params = {}, options = {}) req = build_request(:create_payment_credential_provider, params) req.send_request(options) end |
#create_payment_manager(params = {}) ⇒ Types::CreatePaymentManagerResponse
Creates a new payment manager in your Amazon Web Services account. A payment manager serves as the top-level resource for managing payment processing capabilities, including payment connectors that integrate with supported payment providers.
If you specify CUSTOM_JWT as the authorizerType, you must provide
an authorizerConfiguration.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_payment_manager({
name: "PaymentManagerName", # required
description: "PaymentsDescription",
authorizer_type: "CUSTOM_JWT", # required, accepts CUSTOM_JWT, AWS_IAM
authorizer_configuration: {
custom_jwt_authorizer: {
discovery_url: "DiscoveryUrl", # required
allowed_audience: ["AllowedAudience"],
allowed_clients: ["AllowedClient"],
allowed_scopes: ["AllowedScopeType"],
advertised_scope_mapping: {
"AllowedScopeType" => "AllowedScopeType",
},
custom_claims: [
{
inbound_token_claim_name: "InboundTokenClaimNameType", # required
inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
authorizing_claim_match_value: { # required
claim_match_value: { # required
match_value_string: "MatchValueString",
match_value_string_list: ["MatchValueString"],
},
claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
},
},
],
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
allowed_workload_configuration: {
hosting_environments: [
{
arn: "BedrockAgentcoreResourceArn", # required
},
],
workload_identities: ["WorkloadIdentityNameType"],
},
},
},
role_arn: "RoleArn", # required
client_token: "ClientToken",
tags: {
"TagKey" => "TagValue",
},
kms_key_arn: "KmsKeyArn",
})
Response structure
Response structure
resp.payment_manager_arn #=> String
resp.payment_manager_id #=> String
resp.name #=> String
resp.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM"
resp.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.role_arn #=> String
resp.workload_identity_details.workload_identity_arn #=> String
resp.created_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.kms_key_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the payment manager.
-
:description
(String)
—
A description of the payment manager.
-
:authorizer_type
(required, String)
—
The type of authorizer to use for the payment manager.
CUSTOM_JWT- Authorize with a bearer token.AWS_IAM- Authorize with your Amazon Web Services IAM credentials.
-
:authorizer_configuration
(Types::AuthorizerConfiguration)
—
The authorizer configuration for the payment manager.
-
:role_arn
(required, String)
—
The Amazon Resource Name (ARN) of the IAM role that the payment manager assumes to access resources on your behalf.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the payment manager.
-
:kms_key_arn
(String)
—
The Amazon Resource Name (ARN) of the customer managed KMS key to use for encrypting sensitive payment manager data at rest. If you don't specify a key, the data is encrypted with an Amazon Web Services owned key.
Returns:
-
(Types::CreatePaymentManagerResponse)
—
Returns a response object which responds to the following methods:
- #payment_manager_arn => String
- #payment_manager_id => String
- #name => String
- #authorizer_type => String
- #authorizer_configuration => Types::AuthorizerConfiguration
- #role_arn => String
- #workload_identity_details => Types::WorkloadIdentityDetails
- #created_at => Time
- #status => String
- #tags => Hash<String,String>
- #kms_key_arn => String
See Also:
5400 5401 5402 5403 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 5400 def create_payment_manager(params = {}, options = {}) req = build_request(:create_payment_manager, params) req.send_request(options) end |
#create_policy(params = {}) ⇒ Types::CreatePolicyResponse
Creates a policy within the AgentCore Policy system. Policies provide
real-time, deterministic control over agentic interactions with
AgentCore Gateway. Using Cedar or Dogwood, you can define fine-grained
policies that specify which interactions with Gateway tools are
permitted based on input parameters and OAuth claims, ensuring agents
operate within defined boundaries and business rules. The policy is
validated during creation against the Cedar schema generated from the
Gateway's tools' input schemas, which defines the available tools,
their parameters, and expected data types. This is an asynchronous
operation. Use the GetPolicy operation to poll the status field
to track completion.
If the new policy is a temporal policy, creating it invalidates the
policy engine's active temporal sessions. For more information about
temporal policy sessions, see session-based temporal policies.
The policy engine returns an HTTP 409 ConflictException to in-flight
sessions. To resume, you must start a new session with a new session
ID.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_policy({
name: "PolicyName", # required
definition: { # required
cedar: {
statement: "Statement", # required
},
policy_generation: {
policy_generation_id: "ResourceId", # required
policy_generation_asset_id: "ResourceId", # required
},
policy: {
statement: "Statement", # required
},
},
description: "Description",
validation_mode: "FAIL_ON_ANY_FINDINGS", # accepts FAIL_ON_ANY_FINDINGS, IGNORE_ALL_FINDINGS
enforcement_mode: "ACTIVE", # accepts ACTIVE, LOG_ONLY
policy_engine_id: "ResourceId", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.policy_id #=> String
resp.name #=> String
resp.policy_engine_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.policy_arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.enforcement_mode #=> String, one of "ACTIVE", "LOG_ONLY"
resp.definition.cedar.statement #=> String
resp.definition.policy_generation.policy_generation_id #=> String
resp.definition.policy_generation.policy_generation_asset_id #=> String
resp.definition.policy.statement #=> String
resp.description #=> String
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The customer-assigned immutable name for the policy. Must be unique within the account. This name is used for policy identification and cannot be changed after creation.
-
:definition
(required, Types::PolicyDefinition)
—
The Cedar or Dogwood policy statement that defines the access control rules. This contains the actual policy logic written in Cedar or Dogwood, specifying effect (permit or forbid), principals, actions, resources, and conditions for agent behavior control.
-
:description
(String)
—
A human-readable description of the policy's purpose and functionality (1-4,096 characters). This helps policy administrators understand the policy's intent, business rules, and operational scope. Use this field to document why the policy exists, what business requirement it addresses, and any special considerations for maintenance. Clear descriptions are essential for policy governance, auditing, and troubleshooting.
-
:validation_mode
(String)
—
The validation mode for the policy creation. Determines how Cedar analyzer validation results are handled during policy creation. FAIL_ON_ANY_FINDINGS (default) runs the Cedar analyzer to validate the policy against the Cedar schema and tool context, failing creation if the analyzer detects any validation issues to ensure strict conformance. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows policy creation even if validation issues are detected, useful for testing or when the policy schema is evolving. Use FAIL_ON_ANY_FINDINGS for production policies to ensure correctness, and IGNORE_ALL_FINDINGS only when you understand and accept the analyzer findings.
-
:enforcement_mode
(String)
—
The enforcement mode for the policy. Run this policy in
LOG_ONLYmode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy toACTIVE. Defaults toACTIVE. -
:policy_engine_id
(required, String)
—
The identifier of the policy engine which contains this policy. Policy engines group related policies and provide the execution context for policy evaluation.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure the idempotency of the request. The Amazon Web Services SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::CreatePolicyResponse)
—
Returns a response object which responds to the following methods:
- #policy_id => String
- #name => String
- #policy_engine_id => String
- #created_at => Time
- #updated_at => Time
- #policy_arn => String
- #status => String
- #enforcement_mode => String
- #definition => Types::PolicyDefinition
- #description => String
- #status_reasons => Array<String>
See Also:
5542 5543 5544 5545 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 5542 def create_policy(params = {}, options = {}) req = build_request(:create_policy, params) req.send_request(options) end |
#create_policy_engine(params = {}) ⇒ Types::CreatePolicyEngineResponse
Creates a new policy engine within the AgentCore Policy system. A
policy engine is a collection of policies that evaluates and
authorizes agent tool calls. When associated with Gateways (each
Gateway can be associated with at most one policy engine, but multiple
Gateways can be associated with the same engine), the policy engine
intercepts all agent requests and determines whether to allow or deny
each action based on the defined policies. This is an asynchronous
operation. Use the GetPolicyEngine operation to poll the status
field to track completion.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_policy_engine({
name: "PolicyEngineName", # required
description: "Description",
client_token: "ClientToken",
encryption_key_arn: "KmsKeyArn",
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.policy_engine_id #=> String
resp.name #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.policy_engine_arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.encryption_key_arn #=> String
resp.description #=> String
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The customer-assigned immutable name for the policy engine. This name identifies the policy engine and cannot be changed after creation.
-
:description
(String)
—
A human-readable description of the policy engine's purpose and scope (1-4,096 characters). This helps administrators understand the policy engine's role in the overall governance strategy. Document which Gateway this engine will be associated with, what types of tools or workflows it governs, and the team or service responsible for maintaining it. Clear descriptions are essential when managing multiple policy engines across different services or environments.
-
:client_token
(String)
—
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy engine.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:encryption_key_arn
(String)
—
The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to an AgentCore Policy. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreatePolicyEngineResponse)
—
Returns a response object which responds to the following methods:
- #policy_engine_id => String
- #name => String
- #created_at => Time
- #updated_at => Time
- #policy_engine_arn => String
- #status => String
- #encryption_key_arn => String
- #description => String
- #status_reasons => Array<String>
See Also:
5633 5634 5635 5636 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 5633 def create_policy_engine(params = {}, options = {}) req = build_request(:create_policy_engine, params) req.send_request(options) end |
#create_registry(params = {}) ⇒ Types::CreateRegistryResponse
Creates a new registry in your Amazon Web Services account. A registry serves as a centralized catalog for organizing and managing registry records, including MCP servers, A2A agents, agent skills, and custom resource types.
If you specify CUSTOM_JWT as the authorizerType, you must provide
an authorizerConfiguration.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_registry({
name: "RegistryName", # required
description: "Description",
authorizer_type: "CUSTOM_JWT", # accepts CUSTOM_JWT, AWS_IAM
authorizer_configuration: {
custom_jwt_authorizer: {
discovery_url: "DiscoveryUrl", # required
allowed_audience: ["AllowedAudience"],
allowed_clients: ["AllowedClient"],
allowed_scopes: ["AllowedScopeType"],
advertised_scope_mapping: {
"AllowedScopeType" => "AllowedScopeType",
},
custom_claims: [
{
inbound_token_claim_name: "InboundTokenClaimNameType", # required
inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
authorizing_claim_match_value: { # required
claim_match_value: { # required
match_value_string: "MatchValueString",
match_value_string_list: ["MatchValueString"],
},
claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
},
},
],
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
allowed_workload_configuration: {
hosting_environments: [
{
arn: "BedrockAgentcoreResourceArn", # required
},
],
workload_identities: ["WorkloadIdentityNameType"],
},
},
},
client_token: "ClientToken",
approval_configuration: {
auto_approval: false,
},
})
Response structure
Response structure
resp.registry_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the registry. The name must be unique within your account and can contain alphanumeric characters and underscores.
-
:description
(String)
—
A description of the registry.
-
:authorizer_type
(String)
—
The type of authorizer to use for the registry. This controls the authorization method for the Search and Invoke APIs used by consumers, and does not affect the standard CRUDL APIs for registry and registry record management used by administrators.
CUSTOM_JWT- Authorize with a bearer token.AWS_IAM- Authorize with your Amazon Web Services IAM credentials.
-
:authorizer_configuration
(Types::AuthorizerConfiguration)
—
The authorizer configuration for the registry. Required if
authorizerTypeisCUSTOM_JWT. For details, see theAuthorizerConfigurationdata type. -
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:approval_configuration
(Types::ApprovalConfiguration)
—
The approval configuration for registry records. Controls whether records require explicit approval before becoming active. See the
ApprovalConfigurationdata type for supported configuration options.
Returns:
-
(Types::CreateRegistryResponse)
—
Returns a response object which responds to the following methods:
- #registry_arn => String
See Also:
5789 5790 5791 5792 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 5789 def create_registry(params = {}, options = {}) req = build_request(:create_registry, params) req.send_request(options) end |
#create_registry_record(params = {}) ⇒ Types::CreateRegistryRecordResponse
Creates a new registry record within the specified registry. A registry record represents an individual AI resource's metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema.
The record is processed asynchronously and returns HTTP 202 Accepted.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_registry_record({
registry_id: "RegistryIdentifier", # required
name: "RegistryRecordName", # required
description: "Description",
descriptor_type: "MCP", # required, accepts MCP, A2A, CUSTOM, AGENT_SKILLS
descriptors: {
mcp: {
server: {
schema_version: "SchemaVersion",
inline_content: "InlineContent",
},
tools: {
protocol_version: "SchemaVersion",
inline_content: "InlineContent",
},
},
a2a: {
agent_card: {
schema_version: "SchemaVersion",
inline_content: "InlineContent",
},
},
custom: {
inline_content: "InlineContent",
},
agent_skills: {
skill_md: {
inline_content: "InlineContent",
},
skill_definition: {
schema_version: "SchemaVersion",
inline_content: "InlineContent",
},
},
},
record_version: "RegistryRecordVersion",
synchronization_type: "URL", # accepts URL
synchronization_configuration: {
from_url: {
url: "McpServerUrl", # required
credential_provider_configurations: [
{
credential_provider_type: "OAUTH", # required, accepts OAUTH, IAM
credential_provider: { # required
oauth_credential_provider: {
provider_arn: "CredentialProviderArn", # required
grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS
scopes: ["String"],
custom_parameters: {
"String" => "String",
},
},
iam_credential_provider: {
role_arn: "IamRoleArn",
service: "IamSigningServiceName",
region: "IamSigningRegion",
},
},
},
],
},
},
client_token: "ClientToken",
})
Response structure
Response structure
resp.record_arn #=> String
resp.status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:registry_id
(required, String)
—
The identifier of the registry where the record will be created. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
-
:name
(required, String)
—
The name of the registry record.
-
:description
(String)
—
A description of the registry record.
-
:descriptor_type
(required, String)
—
The descriptor type of the registry record.
MCP- Model Context Protocol descriptor for MCP-compatible servers and tools.A2A- Agent-to-Agent protocol descriptor.CUSTOM- Custom descriptor type for resources such as APIs, Lambda functions, or servers not conforming to a standard protocol.AGENT_SKILLS- Agent skills descriptor for defining agent skill definitions.
-
:descriptors
(Types::Descriptors)
—
The descriptor-type-specific configuration containing the resource schema and metadata. The structure of this field depends on the
descriptorTypeyou specify. -
:record_version
(String)
—
The version of the registry record. Use this to track different versions of the record's content.
-
:synchronization_type
(String)
—
The type of synchronization to use for keeping the record metadata up to date from an external source. Possible values include
FROM_URLandNONE. -
:synchronization_configuration
(Types::SynchronizationConfiguration)
—
The configuration for synchronizing registry record metadata from an external source, such as a URL-based MCP server.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::CreateRegistryRecordResponse)
—
Returns a response object which responds to the following methods:
- #record_arn => String
- #status => String
See Also:
5939 5940 5941 5942 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 5939 def create_registry_record(params = {}, options = {}) req = build_request(:create_registry_record, params) req.send_request(options) end |
#create_workload_identity(params = {}) ⇒ Types::CreateWorkloadIdentityResponse
Creates a new workload identity.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_workload_identity({
name: "WorkloadIdentityNameType", # required
allowed_resource_oauth_2_return_urls: ["ResourceOauth2ReturnUrlType"],
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.name #=> String
resp.workload_identity_arn #=> String
resp.allowed_resource_oauth_2_return_urls #=> Array
resp.allowed_resource_oauth_2_return_urls[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the workload identity. The name must be unique within your account.
-
:allowed_resource_oauth_2_return_urls
(Array<String>)
—
The list of allowed OAuth2 return URLs for resources associated with this workload identity.
-
:tags
(Hash<String,String>)
—
A map of tag keys and values to assign to the workload identity. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Returns:
-
(Types::CreateWorkloadIdentityResponse)
—
Returns a response object which responds to the following methods:
- #name => String
- #workload_identity_arn => String
- #allowed_resource_oauth_2_return_urls => Array<String>
See Also:
5986 5987 5988 5989 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 5986 def create_workload_identity(params = {}, options = {}) req = build_request(:create_workload_identity, params) req.send_request(options) end |
#delete_agent_runtime(params = {}) ⇒ Types::DeleteAgentRuntimeResponse
Deletes an Amazon Bedrock AgentCore Runtime, or a single version of an AgentCore Runtime when you provide the version qualifier.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_agent_runtime({
agent_runtime_id: "AgentRuntimeId", # required
agent_runtime_version: "AgentRuntimeVersion",
client_token: "ClientToken",
})
Response structure
Response structure
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.agent_runtime_id #=> String
resp.agent_runtime_version #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_runtime_id
(required, String)
—
The unique identifier of the AgentCore Runtime to delete.
-
:agent_runtime_version
(String)
—
The version of the AgentCore Runtime to delete. When you provide this value, only that version is deleted. When you omit it, the entire AgentCore Runtime and all of its versions are deleted.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::DeleteAgentRuntimeResponse)
—
Returns a response object which responds to the following methods:
- #status => String
- #agent_runtime_id => String
- #agent_runtime_version => String
See Also:
6034 6035 6036 6037 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6034 def delete_agent_runtime(params = {}, options = {}) req = build_request(:delete_agent_runtime, params) req.send_request(options) end |
#delete_agent_runtime_endpoint(params = {}) ⇒ Types::DeleteAgentRuntimeEndpointResponse
Deletes an AgentCore Runtime endpoint.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_agent_runtime_endpoint({
agent_runtime_id: "AgentRuntimeId", # required
endpoint_name: "EndpointName", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.agent_runtime_id #=> String
resp.endpoint_name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_runtime_id
(required, String)
—
The unique identifier of the AgentCore Runtime associated with the endpoint.
-
:endpoint_name
(required, String)
—
The name of the AgentCore Runtime endpoint to delete.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::DeleteAgentRuntimeEndpointResponse)
—
Returns a response object which responds to the following methods:
- #status => String
- #agent_runtime_id => String
- #endpoint_name => String
See Also:
6079 6080 6081 6082 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6079 def delete_agent_runtime_endpoint(params = {}, options = {}) req = build_request(:delete_agent_runtime_endpoint, params) req.send_request(options) end |
#delete_api_key_credential_provider(params = {}) ⇒ Struct
Deletes an API key credential provider.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_api_key_credential_provider({
name: "CredentialProviderName", # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the API key credential provider to delete.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
6101 6102 6103 6104 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6101 def delete_api_key_credential_provider(params = {}, options = {}) req = build_request(:delete_api_key_credential_provider, params) req.send_request(options) end |
#delete_browser(params = {}) ⇒ Types::DeleteBrowserResponse
Deletes a custom browser.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_browser({
browser_id: "BrowserId", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.browser_id #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "READY", "DELETING", "DELETE_FAILED", "DELETED"
resp.last_updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:browser_id
(required, String)
—
The unique identifier of the browser to delete.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::DeleteBrowserResponse)
—
Returns a response object which responds to the following methods:
- #browser_id => String
- #status => String
- #last_updated_at => Time
See Also:
6141 6142 6143 6144 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6141 def delete_browser(params = {}, options = {}) req = build_request(:delete_browser, params) req.send_request(options) end |
#delete_browser_profile(params = {}) ⇒ Types::DeleteBrowserProfileResponse
Deletes a browser profile.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_browser_profile({
profile_id: "BrowserProfileId", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.profile_id #=> String
resp.profile_arn #=> String
resp.status #=> String, one of "READY", "DELETING", "DELETED", "SAVING"
resp.last_updated_at #=> Time
resp.last_saved_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:profile_id
(required, String)
—
The unique identifier of the browser profile to delete.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::DeleteBrowserProfileResponse)
—
Returns a response object which responds to the following methods:
- #profile_id => String
- #profile_arn => String
- #status => String
- #last_updated_at => Time
- #last_saved_at => Time
See Also:
6185 6186 6187 6188 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6185 def delete_browser_profile(params = {}, options = {}) req = build_request(:delete_browser_profile, params) req.send_request(options) end |
#delete_capacity_provider(params = {}) ⇒ Types::DeleteCapacityProviderOutput
Deletes a capacity provider. Before you delete a capacity provider, disassociate all agent runtimes and runtime versions that reference it. If any references remain, the operation fails.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_capacity_provider({
capacity_provider_id: "CapacityProviderId", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.capacity_provider_id #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:capacity_provider_id
(required, String)
—
The unique identifier of the capacity provider to delete.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::DeleteCapacityProviderOutput)
—
Returns a response object which responds to the following methods:
- #capacity_provider_id => String
- #status => String
See Also:
6232 6233 6234 6235 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6232 def delete_capacity_provider(params = {}, options = {}) req = build_request(:delete_capacity_provider, params) req.send_request(options) end |
#delete_code_interpreter(params = {}) ⇒ Types::DeleteCodeInterpreterResponse
Deletes a custom code interpreter.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_code_interpreter({
code_interpreter_id: "CodeInterpreterId", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.code_interpreter_id #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "READY", "DELETING", "DELETE_FAILED", "DELETED"
resp.last_updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:code_interpreter_id
(required, String)
—
The unique identifier of the code interpreter to delete.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::DeleteCodeInterpreterResponse)
—
Returns a response object which responds to the following methods:
- #code_interpreter_id => String
- #status => String
- #last_updated_at => Time
See Also:
6272 6273 6274 6275 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6272 def delete_code_interpreter(params = {}, options = {}) req = build_request(:delete_code_interpreter, params) req.send_request(options) end |
#delete_configuration_bundle(params = {}) ⇒ Types::DeleteConfigurationBundleResponse
Deletes a configuration bundle and all of its versions.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_configuration_bundle({
bundle_id: "ConfigurationBundleId", # required
})
Response structure
Response structure
resp.bundle_arn #=> String
resp.bundle_id #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:bundle_id
(required, String)
—
The unique identifier of the configuration bundle to delete.
Returns:
-
(Types::DeleteConfigurationBundleResponse)
—
Returns a response object which responds to the following methods:
- #bundle_arn => String
- #bundle_id => String
- #status => String
See Also:
6304 6305 6306 6307 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6304 def delete_configuration_bundle(params = {}, options = {}) req = build_request(:delete_configuration_bundle, params) req.send_request(options) end |
#delete_consent_portal(params = {}) ⇒ Struct
Deletes a consent portal.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_consent_portal({
consent_portal_identifier: "ConsentPortalIdentifier", # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:consent_portal_identifier
(required, String)
—
The identifier of the consent portal. You can specify either the consent portal ID or its Amazon Resource Name (ARN).
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
6327 6328 6329 6330 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6327 def delete_consent_portal(params = {}, options = {}) req = build_request(:delete_consent_portal, params) req.send_request(options) end |
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a dataset version or an entire dataset asynchronously. If
datasetVersion is absent, deletes all versions and the dataset
record itself. If provided, deletes only that specific version.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_dataset({
dataset_id: "DatasetId", # required
dataset_version: "DatasetVersion",
})
Response structure
Response structure
resp.dataset_arn #=> String
resp.dataset_id #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.dataset_version #=> String
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:dataset_id
(required, String)
—
The unique identifier of the dataset to delete.
-
:dataset_version
(String)
—
Optional version to delete. If absent, deletes the entire dataset. If provided, deletes only that specific version.
Returns:
-
(Types::DeleteDatasetResponse)
—
Returns a response object which responds to the following methods:
- #dataset_arn => String
- #dataset_id => String
- #status => String
- #dataset_version => String
- #updated_at => Time
See Also:
6370 6371 6372 6373 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6370 def delete_dataset(params = {}, options = {}) req = build_request(:delete_dataset, params) req.send_request(options) end |
#delete_dataset_examples(params = {}) ⇒ Types::DeleteDatasetExamplesResponse
Deletes specific examples by ID from DRAFT. All example IDs are validated before any deletes occur. If any ID does not exist in DRAFT, the entire batch is rejected (all-or-nothing semantics).
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_dataset_examples({
dataset_id: "DatasetId", # required
client_token: "ClientToken",
example_ids: ["ExampleId"], # required
})
Response structure
Response structure
resp.dataset_arn #=> String
resp.dataset_id #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.deleted_count #=> Integer
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:dataset_id
(required, String)
—
The unique identifier of the dataset.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:example_ids
(required, Array<String>)
—
The IDs of the examples to delete.
Returns:
-
(Types::DeleteDatasetExamplesResponse)
—
Returns a response object which responds to the following methods:
- #dataset_arn => String
- #dataset_id => String
- #status => String
- #deleted_count => Integer
- #updated_at => Time
See Also:
6427 6428 6429 6430 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6427 def delete_dataset_examples(params = {}, options = {}) req = build_request(:delete_dataset_examples, params) req.send_request(options) end |
#delete_evaluator(params = {}) ⇒ Types::DeleteEvaluatorResponse
Deletes a custom evaluator. Builtin evaluators cannot be deleted. The evaluator must not be referenced by any active online evaluation configurations.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_evaluator({
evaluator_id: "EvaluatorId", # required
})
Response structure
Response structure
resp.evaluator_arn #=> String
resp.evaluator_id #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:evaluator_id
(required, String)
—
The unique identifier of the evaluator to delete.
Returns:
-
(Types::DeleteEvaluatorResponse)
—
Returns a response object which responds to the following methods:
- #evaluator_arn => String
- #evaluator_id => String
- #status => String
See Also:
6461 6462 6463 6464 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6461 def delete_evaluator(params = {}, options = {}) req = build_request(:delete_evaluator, params) req.send_request(options) end |
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayResponse
Deletes a gateway.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_gateway({
gateway_identifier: "GatewayIdentifier", # required
})
Response structure
Response structure
resp.gateway_id #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED"
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway to delete.
Returns:
-
(Types::DeleteGatewayResponse)
—
Returns a response object which responds to the following methods:
- #gateway_id => String
- #status => String
- #status_reasons => Array<String>
See Also:
6494 6495 6496 6497 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6494 def delete_gateway(params = {}, options = {}) req = build_request(:delete_gateway, params) req.send_request(options) end |
#delete_gateway_rate_limit(params = {}) ⇒ Types::DeleteGatewayRateLimitResponse
Deletes a gateway rate limit.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_gateway_rate_limit({
gateway_identifier: "GatewayIdentifier", # required
rate_limit_id: "GatewayRateLimitId", # required
})
Response structure
Response structure
resp.rate_limit_id #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The unique identifier of the gateway.
-
:rate_limit_id
(required, String)
—
The unique identifier of the rate limit to delete.
Returns:
-
(Types::DeleteGatewayRateLimitResponse)
—
Returns a response object which responds to the following methods:
- #rate_limit_id => String
- #status => String
See Also:
6528 6529 6530 6531 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6528 def delete_gateway_rate_limit(params = {}, options = {}) req = build_request(:delete_gateway_rate_limit, params) req.send_request(options) end |
#delete_gateway_rule(params = {}) ⇒ Types::DeleteGatewayRuleResponse
Deletes a gateway rule.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_gateway_rule({
gateway_identifier: "GatewayIdentifier", # required
rule_id: "GatewayRuleId", # required
})
Response structure
Response structure
resp.rule_id #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway containing the rule.
-
:rule_id
(required, String)
—
The unique identifier of the rule to delete.
Returns:
See Also:
6562 6563 6564 6565 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6562 def delete_gateway_rule(params = {}, options = {}) req = build_request(:delete_gateway_rule, params) req.send_request(options) end |
#delete_gateway_target(params = {}) ⇒ Types::DeleteGatewayTargetResponse
Deletes a gateway target.
You cannot delete a target that is in a pending authorization state
(CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or
SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or
fail before deleting the target.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_gateway_target({
gateway_identifier: "GatewayIdentifier", # required
target_id: "TargetId", # required
})
Response structure
Response structure
resp.gateway_arn #=> String
resp.target_id #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED", "SYNCHRONIZING", "SYNCHRONIZE_UNSUCCESSFUL", "CREATE_PENDING_AUTH", "UPDATE_PENDING_AUTH", "SYNCHRONIZE_PENDING_AUTH"
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The unique identifier of the gateway associated with the target.
-
:target_id
(required, String)
—
The unique identifier of the gateway target to delete.
Returns:
-
(Types::DeleteGatewayTargetResponse)
—
Returns a response object which responds to the following methods:
- #gateway_arn => String
- #target_id => String
- #status => String
- #status_reasons => Array<String>
See Also:
6606 6607 6608 6609 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6606 def delete_gateway_target(params = {}, options = {}) req = build_request(:delete_gateway_target, params) req.send_request(options) end |
#delete_harness(params = {}) ⇒ Types::DeleteHarnessResponse
Operation to delete a Harness.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_harness({
harness_id: "HarnessId", # required
client_token: "ClientToken",
delete_managed_memory: false,
})
Response structure
Response structure
resp.harness.harness_id #=> String
resp.harness.harness_name #=> String
resp.harness.arn #=> String
resp.harness.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.harness.harness_version #=> String
resp.harness.execution_role_arn #=> String
resp.harness.created_at #=> Time
resp.harness.updated_at #=> Time
resp.harness.model.bedrock_model_config.model_id #=> String
resp.harness.model.bedrock_model_config.max_tokens #=> Integer
resp.harness.model.bedrock_model_config.temperature #=> Float
resp.harness.model.bedrock_model_config.top_p #=> Float
resp.harness.model.bedrock_model_config.api_format #=> String, one of "converse_stream", "responses", "chat_completions"
resp.harness.model.open_ai_model_config.model_id #=> String
resp.harness.model.open_ai_model_config.api_key_arn #=> String
resp.harness.model.open_ai_model_config.api_base #=> String
resp.harness.model.open_ai_model_config.max_tokens #=> Integer
resp.harness.model.open_ai_model_config.temperature #=> Float
resp.harness.model.open_ai_model_config.top_p #=> Float
resp.harness.model.open_ai_model_config.api_format #=> String, one of "chat_completions", "responses"
resp.harness.model.gemini_model_config.model_id #=> String
resp.harness.model.gemini_model_config.api_key_arn #=> String
resp.harness.model.gemini_model_config.max_tokens #=> Integer
resp.harness.model.gemini_model_config.temperature #=> Float
resp.harness.model.gemini_model_config.top_p #=> Float
resp.harness.model.gemini_model_config.top_k #=> Integer
resp.harness.model.lite_llm_model_config.model_id #=> String
resp.harness.model.lite_llm_model_config.api_key_arn #=> String
resp.harness.model.lite_llm_model_config.api_base #=> String
resp.harness.model.lite_llm_model_config.max_tokens #=> Integer
resp.harness.model.lite_llm_model_config.temperature #=> Float
resp.harness.model.lite_llm_model_config.top_p #=> Float
resp.harness.system_prompt #=> Array
resp.harness.system_prompt[0].text #=> String
resp.harness.tools #=> Array
resp.harness.tools[0].type #=> String, one of "remote_mcp", "agentcore_browser", "agentcore_gateway", "inline_function", "agentcore_code_interpreter"
resp.harness.tools[0].name #=> String
resp.harness.tools[0].config.remote_mcp.url #=> String
resp.harness.tools[0].config.remote_mcp.headers #=> Hash
resp.harness.tools[0].config.remote_mcp.headers["HttpHeaderKey"] #=> String
resp.harness.tools[0].config.remote_mcp.outbound_auth.aws_iam.service #=> String
resp.harness.tools[0].config.remote_mcp.outbound_auth.aws_iam.region #=> String
resp.harness.tools[0].config.agent_core_browser.browser_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.gateway_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.provider_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.scopes #=> Array
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.scopes[0] #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.custom_parameters #=> Hash
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.custom_parameters["OAuthCustomParametersKey"] #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.grant_type #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "TOKEN_EXCHANGE"
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.default_return_url #=> String
resp.harness.tools[0].config.inline_function.description #=> String
resp.harness.tools[0].config.agent_core_code_interpreter.code_interpreter_arn #=> String
resp.harness.skills #=> Array
resp.harness.skills[0].path #=> String
resp.harness.skills[0].s3.uri #=> String
resp.harness.skills[0].git.url #=> String
resp.harness.skills[0].git.path #=> String
resp.harness.skills[0].git.auth.credential_arn #=> String
resp.harness.skills[0].git.auth.username #=> String
resp.harness.skills[0].aws_skills.paths #=> Array
resp.harness.skills[0].aws_skills.paths[0] #=> String
resp.harness.allowed_tools #=> Array
resp.harness.allowed_tools[0] #=> String
resp.harness.truncation.strategy #=> String, one of "sliding_window", "summarization", "none"
resp.harness.truncation.config.sliding_window.messages_count #=> Integer
resp.harness.truncation.config.summarization.summary_ratio #=> Float
resp.harness.truncation.config.summarization.preserve_recent_messages #=> Integer
resp.harness.truncation.config.summarization.summarization_system_prompt #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_arn #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_name #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_id #=> String
resp.harness.environment.agent_core_runtime_environment.lifecycle_configuration.idle_runtime_session_timeout #=> Integer
resp.harness.environment.agent_core_runtime_environment.lifecycle_configuration.max_lifetime #=> Integer
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode #=> String, one of "PUBLIC", "VPC"
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.security_groups #=> Array
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.security_groups[0] #=> String
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.subnets #=> Array
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.subnets[0] #=> String
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.require_service_s3_endpoint #=> Boolean
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations #=> Array
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].session_storage.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].s3_files_access_point.access_point_arn #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].s3_files_access_point.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].efs_access_point.access_point_arn #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].efs_access_point.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].capacity_provider_volume.volume_name #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].capacity_provider_volume.mount_path #=> String
resp.harness.environment_artifact.container_configuration.container_uri #=> String
resp.harness.environment_variables #=> Hash
resp.harness.environment_variables["EnvironmentVariableKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.harness.memory.agent_core_memory_configuration.arn #=> String
resp.harness.memory.agent_core_memory_configuration.actor_id #=> String
resp.harness.memory.agent_core_memory_configuration.messages_count #=> Integer
resp.harness.memory.agent_core_memory_configuration.retrieval_config #=> Hash
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].top_k #=> Integer
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].relevance_score #=> Float
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].strategy_id #=> String
resp.harness.memory.managed_memory_configuration.arn #=> String
resp.harness.memory.managed_memory_configuration.strategies #=> Array
resp.harness.memory.managed_memory_configuration.strategies[0] #=> String, one of "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "EPISODIC"
resp.harness.memory.managed_memory_configuration.event_expiry_duration #=> Integer
resp.harness.memory.managed_memory_configuration.encryption_key_arn #=> String
resp.harness.hooks #=> Array
resp.harness.hooks[0].before_invocation.name #=> String
resp.harness.hooks[0].before_invocation.target.lambda.arn #=> String
resp.harness.hooks[0].before_invocation.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].before_invocation.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].before_invocation.target.sns.arn #=> String
resp.harness.hooks[0].before_invocation.target.event_bridge.arn #=> String
resp.harness.hooks[0].after_invocation.name #=> String
resp.harness.hooks[0].after_invocation.target.lambda.arn #=> String
resp.harness.hooks[0].after_invocation.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].after_invocation.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].after_invocation.target.sns.arn #=> String
resp.harness.hooks[0].after_invocation.target.event_bridge.arn #=> String
resp.harness.hooks[0].before_tool_call.name #=> String
resp.harness.hooks[0].before_tool_call.target.lambda.arn #=> String
resp.harness.hooks[0].before_tool_call.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].before_tool_call.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].before_tool_call.target.sns.arn #=> String
resp.harness.hooks[0].before_tool_call.target.event_bridge.arn #=> String
resp.harness.hooks[0].after_tool_call.name #=> String
resp.harness.hooks[0].after_tool_call.target.lambda.arn #=> String
resp.harness.hooks[0].after_tool_call.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].after_tool_call.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].after_tool_call.target.sns.arn #=> String
resp.harness.hooks[0].after_tool_call.target.event_bridge.arn #=> String
resp.harness.max_iterations #=> Integer
resp.harness.max_tokens #=> Integer
resp.harness.timeout_seconds #=> Integer
resp.harness.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:harness_id
(required, String)
—
The ID of the harness to delete.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:delete_managed_memory
(Boolean)
—
Whether to delete the managed memory on harness deletion. Default: true. If false, the memory is disassociated and becomes a regular customer-owned resource.
Returns:
See Also:
6825 6826 6827 6828 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6825 def delete_harness(params = {}, options = {}) req = build_request(:delete_harness, params) req.send_request(options) end |
#delete_harness_endpoint(params = {}) ⇒ Types::DeleteHarnessEndpointResponse
Operation to delete a harness endpoint.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_harness_endpoint({
harness_id: "HarnessId", # required
endpoint_name: "HarnessEndpointName", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.endpoint.harness_id #=> String
resp.endpoint.harness_name #=> String
resp.endpoint.endpoint_name #=> String
resp.endpoint.arn #=> String
resp.endpoint.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.endpoint.created_at #=> Time
resp.endpoint.updated_at #=> Time
resp.endpoint.live_version #=> String
resp.endpoint.target_version #=> String
resp.endpoint.description #=> String
resp.endpoint.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:harness_id
(required, String)
—
The ID of the harness that the endpoint belongs to.
-
:endpoint_name
(required, String)
—
The name of the endpoint to delete.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
See Also:
6875 6876 6877 6878 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6875 def delete_harness_endpoint(params = {}, options = {}) req = build_request(:delete_harness_endpoint, params) req.send_request(options) end |
#delete_memory(params = {}) ⇒ Types::DeleteMemoryOutput
Deletes an Amazon Bedrock AgentCore Memory resource. When you delete a memory resource, it is permanently removed.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_memory({
client_token: "DeleteMemoryInputClientTokenString",
memory_id: "MemoryId", # required
})
Response structure
Response structure
resp.memory_id #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "FAILED", "DELETING", "UPDATING"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique Amazon Web Services identifier.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:memory_id
(required, String)
—
The unique identifier of the memory to delete.
Returns:
-
(Types::DeleteMemoryOutput)
—
Returns a response object which responds to the following methods:
- #memory_id => String
- #status => String
See Also:
6915 6916 6917 6918 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6915 def delete_memory(params = {}, options = {}) req = build_request(:delete_memory, params) req.send_request(options) end |
#delete_oauth_2_credential_provider(params = {}) ⇒ Struct
Deletes an OAuth2 credential provider.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_oauth_2_credential_provider({
name: "CredentialProviderName", # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the OAuth2 credential provider to delete.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
6937 6938 6939 6940 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6937 def delete_oauth_2_credential_provider(params = {}, options = {}) req = build_request(:delete_oauth_2_credential_provider, params) req.send_request(options) end |
#delete_online_evaluation_config(params = {}) ⇒ Types::DeleteOnlineEvaluationConfigResponse
Deletes an online evaluation configuration and stops any ongoing evaluation processes associated with it.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_online_evaluation_config({
online_evaluation_config_id: "OnlineEvaluationConfigId", # required
})
Response structure
Response structure
resp.online_evaluation_config_arn #=> String
resp.online_evaluation_config_id #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "ERROR"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:online_evaluation_config_id
(required, String)
—
The unique identifier of the online evaluation configuration to delete.
Returns:
-
(Types::DeleteOnlineEvaluationConfigResponse)
—
Returns a response object which responds to the following methods:
- #online_evaluation_config_arn => String
- #online_evaluation_config_id => String
- #status => String
See Also:
6971 6972 6973 6974 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 6971 def delete_online_evaluation_config(params = {}, options = {}) req = build_request(:delete_online_evaluation_config, params) req.send_request(options) end |
#delete_payment_connector(params = {}) ⇒ Types::DeletePaymentConnectorResponse
Deletes a payment connector.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_payment_connector({
payment_manager_id: "PaymentManagerId", # required
payment_connector_id: "PaymentConnectorId", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED", "PENDING_AUTHENTICATION", "PROVISIONING", "AUTHENTICATION_EXPIRED", "AUTHENTICATION_FAILED"
resp.payment_connector_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:payment_manager_id
(required, String)
—
The unique identifier of the parent payment manager.
-
:payment_connector_id
(required, String)
—
The unique identifier of the payment connector to delete.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::DeletePaymentConnectorResponse)
—
Returns a response object which responds to the following methods:
- #status => String
- #payment_connector_id => String
See Also:
7020 7021 7022 7023 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7020 def delete_payment_connector(params = {}, options = {}) req = build_request(:delete_payment_connector, params) req.send_request(options) end |
#delete_payment_credential_provider(params = {}) ⇒ Struct
Deletes a payment credential provider and its associated stored credentials.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_payment_credential_provider({
name: "CredentialProviderName", # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the payment credential provider to delete.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
7043 7044 7045 7046 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7043 def delete_payment_credential_provider(params = {}, options = {}) req = build_request(:delete_payment_credential_provider, params) req.send_request(options) end |
#delete_payment_manager(params = {}) ⇒ Types::DeletePaymentManagerResponse
Deletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_payment_manager({
payment_manager_id: "PaymentManagerId", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.payment_manager_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:payment_manager_id
(required, String)
—
The unique identifier of the payment manager to delete.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::DeletePaymentManagerResponse)
—
Returns a response object which responds to the following methods:
- #status => String
- #payment_manager_id => String
See Also:
7090 7091 7092 7093 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7090 def delete_payment_manager(params = {}, options = {}) req = build_request(:delete_payment_manager, params) req.send_request(options) end |
#delete_policy(params = {}) ⇒ Types::DeletePolicyResponse
Deletes an existing policy from the AgentCore Policy system. Once
deleted, the policy can no longer be used for agent behavior control
and all references to it become invalid. This is an asynchronous
operation. Use the GetPolicy operation to poll the status field to
track completion.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_policy({
policy_engine_id: "ResourceId", # required
policy_id: "ResourceId", # required
})
Response structure
Response structure
resp.policy_id #=> String
resp.name #=> String
resp.policy_engine_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.policy_arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.enforcement_mode #=> String, one of "ACTIVE", "LOG_ONLY"
resp.definition.cedar.statement #=> String
resp.definition.policy_generation.policy_generation_id #=> String
resp.definition.policy_generation.policy_generation_asset_id #=> String
resp.definition.policy.statement #=> String
resp.description #=> String
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine that manages the policy to be deleted. This ensures the policy is deleted from the correct policy engine context.
-
:policy_id
(required, String)
—
The unique identifier of the policy to be deleted. This must be a valid policy ID that exists within the specified policy engine.
Returns:
-
(Types::DeletePolicyResponse)
—
Returns a response object which responds to the following methods:
- #policy_id => String
- #name => String
- #policy_engine_id => String
- #created_at => Time
- #updated_at => Time
- #policy_arn => String
- #status => String
- #enforcement_mode => String
- #definition => Types::PolicyDefinition
- #description => String
- #status_reasons => Array<String>
See Also:
7153 7154 7155 7156 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7153 def delete_policy(params = {}, options = {}) req = build_request(:delete_policy, params) req.send_request(options) end |
#delete_policy_engine(params = {}) ⇒ Types::DeletePolicyEngineResponse
Deletes an existing policy engine from the AgentCore Policy system.
The policy engine must not have any associated policies before
deletion. Once deleted, the policy engine and all its configurations
become unavailable for policy management and evaluation. This is an
asynchronous operation. Use the GetPolicyEngine operation to poll
the status field to track completion.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_policy_engine({
policy_engine_id: "ResourceId", # required
})
Response structure
Response structure
resp.policy_engine_id #=> String
resp.name #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.policy_engine_arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.encryption_key_arn #=> String
resp.description #=> String
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_engine_id
(required, String)
—
The unique identifier of the policy engine to be deleted. This must be a valid policy engine ID that exists within the account.
Returns:
-
(Types::DeletePolicyEngineResponse)
—
Returns a response object which responds to the following methods:
- #policy_engine_id => String
- #name => String
- #created_at => Time
- #updated_at => Time
- #policy_engine_arn => String
- #status => String
- #encryption_key_arn => String
- #description => String
- #status_reasons => Array<String>
See Also:
7204 7205 7206 7207 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7204 def delete_policy_engine(params = {}, options = {}) req = build_request(:delete_policy_engine, params) req.send_request(options) end |
#delete_registry(params = {}) ⇒ Types::DeleteRegistryResponse
Deletes a registry. The registry must contain zero records before it can be deleted. This operation initiates the deletion process asynchronously.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_registry({
registry_id: "RegistryIdentifier", # required
})
Response structure
Response structure
resp.status #=> String, one of "CREATING", "READY", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:registry_id
(required, String)
—
The identifier of the registry to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
Returns:
See Also:
7235 7236 7237 7238 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7235 def delete_registry(params = {}, options = {}) req = build_request(:delete_registry, params) req.send_request(options) end |
#delete_registry_record(params = {}) ⇒ Struct
Deletes a registry record. The record's status transitions to
DELETING and the record is removed asynchronously.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_registry_record({
registry_id: "RegistryIdentifier", # required
record_id: "RecordIdentifier", # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:registry_id
(required, String)
—
The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
-
:record_id
(required, String)
—
The identifier of the registry record to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
7264 7265 7266 7267 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7264 def delete_registry_record(params = {}, options = {}) req = build_request(:delete_registry_record, params) req.send_request(options) end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the resource-based policy for a specified resource.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_resource_policy({
resource_arn: "BedrockAgentcoreResourceArn", # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource for which to delete the resource policy.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
7292 7293 7294 7295 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7292 def delete_resource_policy(params = {}, options = {}) req = build_request(:delete_resource_policy, params) req.send_request(options) end |
#delete_workload_identity(params = {}) ⇒ Struct
Deletes a workload identity.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_workload_identity({
name: "WorkloadIdentityNameType", # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the workload identity to delete.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
7314 7315 7316 7317 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7314 def delete_workload_identity(params = {}, options = {}) req = build_request(:delete_workload_identity, params) req.send_request(options) end |
#get_agent_insight_store(params = {}) ⇒ Types::GetAgentInsightStoreResponse
Returns the account's service-defined default Agent Insight Store. The logical default exists for every enrolled account; its backing state may be initialized on first access.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_agent_insight_store({
agent_insight_store_id: "AgentInsightStoreId", # required
})
Response structure
Response structure
resp.agent_insight_store_arn #=> String
resp.agent_insight_store_id #=> String
resp.status #=> String, one of "ACTIVE", "UPDATING", "INACTIVE", "ERROR"
resp.enablement_status #=> String, one of "ENABLED", "DISABLED"
resp.encryption_configuration.mode #=> String, one of "AWS_OWNED_KMS_KEY", "CUSTOMER_MANAGED_KMS"
resp.encryption_configuration.kms_key_arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_insight_store_id
(required, String)
—
Specifies the unique identifier of the Agent Insight Store to retrieve.
Returns:
-
(Types::GetAgentInsightStoreResponse)
—
Returns a response object which responds to the following methods:
- #agent_insight_store_arn => String
- #agent_insight_store_id => String
- #status => String
- #enablement_status => String
- #encryption_configuration => Types::AgentInsightStoreEncryptionConfiguration
- #created_at => Time
- #updated_at => Time
- #failure_reason => String
See Also:
7360 7361 7362 7363 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7360 def get_agent_insight_store(params = {}, options = {}) req = build_request(:get_agent_insight_store, params) req.send_request(options) end |
#get_agent_runtime(params = {}) ⇒ Types::GetAgentRuntimeResponse
Gets an Amazon Bedrock AgentCore Runtime.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_agent_runtime({
agent_runtime_id: "AgentRuntimeId", # required
agent_runtime_version: "AgentRuntimeVersion",
})
Response structure
Response structure
resp.agent_runtime_arn #=> String
resp.agent_runtime_name #=> String
resp.agent_runtime_id #=> String
resp.agent_runtime_version #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.role_arn #=> String
resp.network_configuration.network_mode #=> String, one of "PUBLIC", "VPC"
resp.network_configuration.network_mode_config.security_groups #=> Array
resp.network_configuration.network_mode_config.security_groups[0] #=> String
resp.network_configuration.network_mode_config.subnets #=> Array
resp.network_configuration.network_mode_config.subnets[0] #=> String
resp.network_configuration.network_mode_config.require_service_s3_endpoint #=> Boolean
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.lifecycle_configuration.idle_runtime_session_timeout #=> Integer
resp.lifecycle_configuration.max_lifetime #=> Integer
resp.hooks_configuration.build.warmup.action.http_post.path #=> String
resp.hooks_configuration.build.warmup.action.http_post.port #=> Integer
resp.failure_reason #=> String
resp.description #=> String
resp.workload_identity_details.workload_identity_arn #=> String
resp.agent_runtime_artifact.container_configuration.container_uri #=> String
resp.agent_runtime_artifact.code_configuration.code.s3.bucket #=> String
resp.agent_runtime_artifact.code_configuration.code.s3.prefix #=> String
resp.agent_runtime_artifact.code_configuration.code.s3.version_id #=> String
resp.agent_runtime_artifact.code_configuration.runtime #=> String, one of "PYTHON_3_10", "PYTHON_3_11", "PYTHON_3_12", "PYTHON_3_13", "PYTHON_3_14", "NODE_22"
resp.agent_runtime_artifact.code_configuration.entry_point #=> Array
resp.agent_runtime_artifact.code_configuration.entry_point[0] #=> String
resp.protocol_configuration.server_protocol #=> String, one of "MCP", "HTTP", "A2A", "AGUI"
resp.protocol_configuration.port #=> Integer
resp.protocol_configuration.path #=> String
resp.environment_variables #=> Hash
resp.environment_variables["EnvironmentVariableKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.request_header_configuration.request_header_allowlist #=> Array
resp.request_header_configuration.request_header_allowlist[0] #=> String
resp.metadata_configuration.require_mmdsv2 #=> Boolean
resp.filesystem_configurations #=> Array
resp.filesystem_configurations[0].session_storage.mount_path #=> String
resp.filesystem_configurations[0].s3_files_access_point.access_point_arn #=> String
resp.filesystem_configurations[0].s3_files_access_point.mount_path #=> String
resp.filesystem_configurations[0].efs_access_point.access_point_arn #=> String
resp.filesystem_configurations[0].efs_access_point.mount_path #=> String
resp.filesystem_configurations[0].capacity_provider_volume.volume_name #=> String
resp.filesystem_configurations[0].capacity_provider_volume.mount_path #=> String
resp.capacity_provider_configuration.capacity_provider_arn #=> String
resp.platform_version #=> String
resp.allowed_ports #=> Array
resp.allowed_ports[0].port #=> Integer
resp.allowed_ports[0].port_range.from #=> Integer
resp.allowed_ports[0].port_range.to #=> Integer
resp.resource_configurations #=> Array
resp.resource_configurations[0].minimum_memory_in_mi_b #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_runtime_id
(required, String)
—
The unique identifier of the AgentCore Runtime to retrieve.
-
:agent_runtime_version
(String)
—
The version of the AgentCore Runtime to retrieve.
Returns:
-
(Types::GetAgentRuntimeResponse)
—
Returns a response object which responds to the following methods:
- #agent_runtime_arn => String
- #agent_runtime_name => String
- #agent_runtime_id => String
- #agent_runtime_version => String
- #created_at => Time
- #last_updated_at => Time
- #role_arn => String
- #network_configuration => Types::NetworkConfiguration
- #status => String
- #lifecycle_configuration => Types::LifecycleConfiguration
- #hooks_configuration => Types::RuntimeHooksConfiguration
- #failure_reason => String
- #description => String
- #workload_identity_details => Types::WorkloadIdentityDetails
- #agent_runtime_artifact => Types::AgentRuntimeArtifact
- #protocol_configuration => Types::ProtocolConfiguration
- #environment_variables => Hash<String,String>
- #authorizer_configuration => Types::AuthorizerConfiguration
- #request_header_configuration => Types::RequestHeaderConfiguration
- #metadata_configuration => Types::RuntimeMetadataConfiguration
- #filesystem_configurations => Array<Types::FilesystemConfiguration>
- #capacity_provider_configuration => Types::CapacityProviderConfiguration
- #platform_version => String
- #allowed_ports => Array<Types::AllowedPort>
- #resource_configurations => Array<Types::ResourceConfiguration>
See Also:
7513 7514 7515 7516 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7513 def get_agent_runtime(params = {}, options = {}) req = build_request(:get_agent_runtime, params) req.send_request(options) end |
#get_agent_runtime_endpoint(params = {}) ⇒ Types::GetAgentRuntimeEndpointResponse
Gets information about an Amazon Secure AgentEndpoint.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_agent_runtime_endpoint({
agent_runtime_id: "AgentRuntimeId", # required
endpoint_name: "EndpointName", # required
})
Response structure
Response structure
resp.live_version #=> String
resp.target_version #=> String
resp.agent_runtime_endpoint_arn #=> String
resp.agent_runtime_arn #=> String
resp.description #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.failure_reason #=> String
resp.name #=> String
resp.id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_runtime_id
(required, String)
—
The unique identifier of the AgentCore Runtime associated with the endpoint.
-
:endpoint_name
(required, String)
—
The name of the AgentCore Runtime endpoint to retrieve.
Returns:
-
(Types::GetAgentRuntimeEndpointResponse)
—
Returns a response object which responds to the following methods:
- #live_version => String
- #target_version => String
- #agent_runtime_endpoint_arn => String
- #agent_runtime_arn => String
- #description => String
- #status => String
- #created_at => Time
- #last_updated_at => Time
- #failure_reason => String
- #name => String
- #id => String
See Also:
7566 7567 7568 7569 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7566 def get_agent_runtime_endpoint(params = {}, options = {}) req = build_request(:get_agent_runtime_endpoint, params) req.send_request(options) end |
#get_api_key_credential_provider(params = {}) ⇒ Types::GetApiKeyCredentialProviderResponse
Retrieves information about an API key credential provider.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_api_key_credential_provider({
name: "CredentialProviderName", # required
})
Response structure
Response structure
resp.api_key_secret_arn.secret_arn #=> String
resp.api_key_secret_json_key #=> String
resp.api_key_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.name #=> String
resp.credential_provider_arn #=> String
resp.created_time #=> Time
resp.last_updated_time #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the API key credential provider to retrieve.
Returns:
-
(Types::GetApiKeyCredentialProviderResponse)
—
Returns a response object which responds to the following methods:
- #api_key_secret_arn => Types::Secret
- #api_key_secret_json_key => String
- #api_key_secret_source => String
- #name => String
- #credential_provider_arn => String
- #created_time => Time
- #last_updated_time => Time
See Also:
7606 7607 7608 7609 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7606 def get_api_key_credential_provider(params = {}, options = {}) req = build_request(:get_api_key_credential_provider, params) req.send_request(options) end |
#get_browser(params = {}) ⇒ Types::GetBrowserResponse
Gets information about a custom browser.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_browser({
browser_id: "BrowserId", # required
})
Response structure
Response structure
resp.browser_id #=> String
resp.browser_arn #=> String
resp.name #=> String
resp.description #=> String
resp.execution_role_arn #=> String
resp.network_configuration.network_mode #=> String, one of "PUBLIC", "VPC"
resp.network_configuration.vpc_config.security_groups #=> Array
resp.network_configuration.vpc_config.security_groups[0] #=> String
resp.network_configuration.vpc_config.subnets #=> Array
resp.network_configuration.vpc_config.subnets[0] #=> String
resp.network_configuration.vpc_config.require_service_s3_endpoint #=> Boolean
resp.recording.enabled #=> Boolean
resp.recording.s3_location.bucket #=> String
resp.recording.s3_location.prefix #=> String
resp.recording.s3_location.version_id #=> String
resp.browser_signing.enabled #=> Boolean
resp.enterprise_policies #=> Array
resp.enterprise_policies[0].location.s3.bucket #=> String
resp.enterprise_policies[0].location.s3.prefix #=> String
resp.enterprise_policies[0].location.s3.version_id #=> String
resp.enterprise_policies[0].type #=> String, one of "MANAGED", "RECOMMENDED"
resp.certificates #=> Array
resp.certificates[0].location.secrets_manager.secret_arn #=> String
resp.filesystem_configurations #=> Array
resp.filesystem_configurations[0].s3_files_configuration.access_point_arn #=> String
resp.filesystem_configurations[0].s3_files_configuration.mount_path #=> String
resp.filesystem_configurations[0].s3_files_configuration.file_system_arn #=> String
resp.filesystem_configurations[0].efs_configuration.access_point_arn #=> String
resp.filesystem_configurations[0].efs_configuration.mount_path #=> String
resp.filesystem_configurations[0].efs_configuration.file_system_arn #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "READY", "DELETING", "DELETE_FAILED", "DELETED"
resp.failure_reason #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:browser_id
(required, String)
—
The unique identifier of the browser to retrieve.
Returns:
-
(Types::GetBrowserResponse)
—
Returns a response object which responds to the following methods:
- #browser_id => String
- #browser_arn => String
- #name => String
- #description => String
- #execution_role_arn => String
- #network_configuration => Types::BrowserNetworkConfiguration
- #recording => Types::RecordingConfig
- #browser_signing => Types::BrowserSigningConfigOutput
- #enterprise_policies => Array<Types::BrowserEnterprisePolicy>
- #certificates => Array<Types::Certificate>
- #filesystem_configurations => Array<Types::ToolsFileSystemConfiguration>
- #status => String
- #failure_reason => String
- #created_at => Time
- #last_updated_at => Time
See Also:
7681 7682 7683 7684 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7681 def get_browser(params = {}, options = {}) req = build_request(:get_browser, params) req.send_request(options) end |
#get_browser_profile(params = {}) ⇒ Types::GetBrowserProfileResponse
Gets information about a browser profile.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_browser_profile({
profile_id: "BrowserProfileId", # required
})
Response structure
Response structure
resp.profile_id #=> String
resp.profile_arn #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "READY", "DELETING", "DELETED", "SAVING"
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.last_saved_at #=> Time
resp.last_saved_browser_session_id #=> String
resp.last_saved_browser_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:profile_id
(required, String)
—
The unique identifier of the browser profile to retrieve.
Returns:
-
(Types::GetBrowserProfileResponse)
—
Returns a response object which responds to the following methods:
- #profile_id => String
- #profile_arn => String
- #name => String
- #description => String
- #status => String
- #created_at => Time
- #last_updated_at => Time
- #last_saved_at => Time
- #last_saved_browser_session_id => String
- #last_saved_browser_id => String
See Also:
7727 7728 7729 7730 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7727 def get_browser_profile(params = {}, options = {}) req = build_request(:get_browser_profile, params) req.send_request(options) end |
#get_capacity_provider(params = {}) ⇒ Types::GetCapacityProviderOutput
Retrieves information about a capacity provider, including its status, permissions configuration, and compute configuration.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_capacity_provider({
capacity_provider_id: "CapacityProviderId", # required
})
Response structure
Response structure
resp.capacity_provider_id #=> String
resp.capacity_provider_arn #=> String
resp.name #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.description #=> String
resp.status_code #=> String, one of "VALIDATION_ERROR", "QUOTA_EXCEEDED", "THROTTLED", "INTERNAL_SERVER_EXCEPTION"
resp.status_reason #=> String
resp.permissions_configuration.capacity_provider_operator_role_arn #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.operating_system #=> String, one of "LINUX_X86_64", "LINUX_ARM64"
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.instance_requirements.allowed_instance_types #=> Array
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.instance_requirements.allowed_instance_types[0] #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes #=> Array
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].device_name #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].virtual_name #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].ebs.iops #=> Integer
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].ebs.throughput #=> Integer
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].ebs.encrypted #=> Boolean
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].ebs.kms_key_id #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].ebs.snapshot_id #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].ebs.volume_size #=> Integer
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].ebs.volume_initialization_rate #=> Integer
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ephemeral_volumes[0].ebs.ebs_card_index #=> Integer
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.monitoring #=> String, one of "BASIC", "DETAILED"
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.license_specifications #=> Array
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.license_specifications[0].license_configuration_arn #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.capacity_reservation_specification.capacity_reservation_preference #=> String, one of "capacity-reservations-only", "open", "none"
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_id #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_resource_group_arn #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.ssh_key_name #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.instance_profile_arn #=> String
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.propagated_tags #=> Hash
resp.compute_configuration.ec2_configuration.launch_template_source.launch_parameters.propagated_tags["TagKey"] #=> String
resp.compute_configuration.ec2_configuration.vpc_configuration.subnets #=> Array
resp.compute_configuration.ec2_configuration.vpc_configuration.subnets[0] #=> String
resp.compute_configuration.ec2_configuration.vpc_configuration.security_groups #=> Array
resp.compute_configuration.ec2_configuration.vpc_configuration.security_groups[0] #=> String
resp.compute_configuration.ec2_configuration.volumes #=> Array
resp.compute_configuration.ec2_configuration.volumes[0].ebs_configuration.name #=> String
resp.compute_configuration.ec2_configuration.volumes[0].ebs_configuration.size_gi_b #=> Integer
resp.compute_configuration.ec2_configuration.volumes[0].ebs_configuration.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.compute_configuration.ec2_configuration.volumes[0].ebs_configuration.iops #=> Integer
resp.compute_configuration.ec2_configuration.volumes[0].ebs_configuration.throughput #=> Integer
resp.compute_configuration.ec2_configuration.volumes[0].ebs_configuration.encrypted #=> Boolean
resp.compute_configuration.ec2_configuration.volumes[0].ebs_configuration.kms_key_id #=> String
resp.compute_configuration.ec2_configuration.volumes[0].ebs_configuration.snapshot_id #=> String
resp.compute_configuration.ec2_configuration.lifecycle_configuration.idle_instance_timeout #=> Integer
resp.compute_configuration.ec2_configuration.lifecycle_configuration.max_lifetime #=> Integer
resp.compute_configuration.ec2_configuration.root_volume.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.compute_configuration.ec2_configuration.root_volume.iops #=> Integer
resp.compute_configuration.ec2_configuration.root_volume.throughput #=> Integer
resp.compute_configuration.ec2_configuration.root_volume.encrypted #=> Boolean
resp.compute_configuration.ec2_configuration.root_volume.kms_key_id #=> String
resp.compute_configuration.ec2_configuration.root_volume.free_space_gi_b #=> Integer
resp.created_at #=> Time
resp.last_updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:capacity_provider_id
(required, String)
—
The unique identifier of the capacity provider.
Returns:
-
(Types::GetCapacityProviderOutput)
—
Returns a response object which responds to the following methods:
- #capacity_provider_id => String
- #capacity_provider_arn => String
- #name => String
- #status => String
- #description => String
- #status_code => String
- #status_reason => String
- #permissions_configuration => Types::PermissionsConfiguration
- #compute_configuration => Types::ComputeConfiguration
- #created_at => Time
- #last_updated_at => Time
See Also:
7821 7822 7823 7824 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7821 def get_capacity_provider(params = {}, options = {}) req = build_request(:get_capacity_provider, params) req.send_request(options) end |
#get_code_interpreter(params = {}) ⇒ Types::GetCodeInterpreterResponse
Gets information about a custom code interpreter.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_code_interpreter({
code_interpreter_id: "CodeInterpreterId", # required
})
Response structure
Response structure
resp.code_interpreter_id #=> String
resp.code_interpreter_arn #=> String
resp.name #=> String
resp.description #=> String
resp.execution_role_arn #=> String
resp.network_configuration.network_mode #=> String, one of "PUBLIC", "SANDBOX", "VPC"
resp.network_configuration.vpc_config.security_groups #=> Array
resp.network_configuration.vpc_config.security_groups[0] #=> String
resp.network_configuration.vpc_config.subnets #=> Array
resp.network_configuration.vpc_config.subnets[0] #=> String
resp.network_configuration.vpc_config.require_service_s3_endpoint #=> Boolean
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "READY", "DELETING", "DELETE_FAILED", "DELETED"
resp.certificates #=> Array
resp.certificates[0].location.secrets_manager.secret_arn #=> String
resp.filesystem_configurations #=> Array
resp.filesystem_configurations[0].s3_files_configuration.access_point_arn #=> String
resp.filesystem_configurations[0].s3_files_configuration.mount_path #=> String
resp.filesystem_configurations[0].s3_files_configuration.file_system_arn #=> String
resp.filesystem_configurations[0].efs_configuration.access_point_arn #=> String
resp.filesystem_configurations[0].efs_configuration.mount_path #=> String
resp.filesystem_configurations[0].efs_configuration.file_system_arn #=> String
resp.failure_reason #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:code_interpreter_id
(required, String)
—
The unique identifier of the code interpreter to retrieve.
Returns:
-
(Types::GetCodeInterpreterResponse)
—
Returns a response object which responds to the following methods:
- #code_interpreter_id => String
- #code_interpreter_arn => String
- #name => String
- #description => String
- #execution_role_arn => String
- #network_configuration => Types::CodeInterpreterNetworkConfiguration
- #status => String
- #certificates => Array<Types::Certificate>
- #filesystem_configurations => Array<Types::ToolsFileSystemConfiguration>
- #failure_reason => String
- #created_at => Time
- #last_updated_at => Time
See Also:
7883 7884 7885 7886 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7883 def get_code_interpreter(params = {}, options = {}) req = build_request(:get_code_interpreter, params) req.send_request(options) end |
#get_configuration_bundle(params = {}) ⇒ Types::GetConfigurationBundleResponse
Gets the latest version of a configuration bundle. By default, returns
the latest version on the mainline branch. Use
GetConfigurationBundleVersion to retrieve a specific historical
version.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_configuration_bundle({
bundle_id: "ConfigurationBundleId", # required
branch_name: "BranchName",
})
Response structure
Response structure
resp.bundle_arn #=> String
resp.bundle_id #=> String
resp.bundle_name #=> String
resp.description #=> String
resp.version_id #=> String
resp.components #=> Hash
resp.lineage_metadata.parent_version_ids #=> Array
resp.lineage_metadata.parent_version_ids[0] #=> String
resp.lineage_metadata.branch_name #=> String
resp.lineage_metadata.created_by.name #=> String
resp.lineage_metadata.created_by.arn #=> String
resp.lineage_metadata.commit_message #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.kms_key_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:bundle_id
(required, String)
—
The unique identifier of the configuration bundle to retrieve.
-
:branch_name
(String)
—
The branch name to get the latest version from. If not specified, returns the latest version on the mainline branch.
Returns:
-
(Types::GetConfigurationBundleResponse)
—
Returns a response object which responds to the following methods:
- #bundle_arn => String
- #bundle_id => String
- #bundle_name => String
- #description => String
- #version_id => String
- #components => Hash<String,Types::ComponentConfiguration>
- #lineage_metadata => Types::VersionLineageMetadata
- #created_at => Time
- #updated_at => Time
- #kms_key_arn => String
See Also:
7942 7943 7944 7945 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7942 def get_configuration_bundle(params = {}, options = {}) req = build_request(:get_configuration_bundle, params) req.send_request(options) end |
#get_configuration_bundle_version(params = {}) ⇒ Types::GetConfigurationBundleVersionResponse
Gets a specific version of a configuration bundle by its version identifier.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_configuration_bundle_version({
bundle_id: "ConfigurationBundleId", # required
version_id: "ConfigurationBundleVersion", # required
})
Response structure
Response structure
resp.bundle_arn #=> String
resp.bundle_id #=> String
resp.bundle_name #=> String
resp.description #=> String
resp.version_id #=> String
resp.components #=> Hash
resp.lineage_metadata.parent_version_ids #=> Array
resp.lineage_metadata.parent_version_ids[0] #=> String
resp.lineage_metadata.branch_name #=> String
resp.lineage_metadata.created_by.name #=> String
resp.lineage_metadata.created_by.arn #=> String
resp.lineage_metadata.commit_message #=> String
resp.created_at #=> Time
resp.version_created_at #=> Time
resp.kms_key_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:bundle_id
(required, String)
—
The unique identifier of the configuration bundle.
-
:version_id
(required, String)
—
The version identifier of the configuration bundle version to retrieve.
Returns:
-
(Types::GetConfigurationBundleVersionResponse)
—
Returns a response object which responds to the following methods:
- #bundle_arn => String
- #bundle_id => String
- #bundle_name => String
- #description => String
- #version_id => String
- #components => Hash<String,Types::ComponentConfiguration>
- #lineage_metadata => Types::VersionLineageMetadata
- #created_at => Time
- #version_created_at => Time
- #kms_key_arn => String
See Also:
7999 8000 8001 8002 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 7999 def get_configuration_bundle_version(params = {}, options = {}) req = build_request(:get_configuration_bundle_version, params) req.send_request(options) end |
#get_consent_portal(params = {}) ⇒ Types::GetConsentPortalResponse
Retrieves information about a consent portal.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_consent_portal({
consent_portal_identifier: "ConsentPortalIdentifier", # required
})
Response structure
Response structure
resp.sources #=> Array
resp.sources[0].identifier #=> String
resp.sources[0].type #=> String, one of "agentcore-gateway"
resp.consent_portal_arn #=> String
resp.consent_portal_id #=> String
resp.created_at #=> Time
resp.description #=> String
resp.execution_role_arn #=> String
resp.idp_config.credential_provider_arn #=> String
resp.idp_config.scopes #=> Array
resp.idp_config.scopes[0] #=> String
resp.idp_config.audience #=> String
resp.name #=> String
resp.portal_url #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "FAILED"
resp.status_reason #=> String
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:consent_portal_identifier
(required, String)
—
The identifier of the consent portal. You can specify either the consent portal ID or its Amazon Resource Name (ARN).
Returns:
-
(Types::GetConsentPortalResponse)
—
Returns a response object which responds to the following methods:
- #sources => Array<Types::ConsentPortalSource>
- #consent_portal_arn => String
- #consent_portal_id => String
- #created_at => Time
- #description => String
- #execution_role_arn => String
- #idp_config => Types::ConsentPortalIdpConfig
- #name => String
- #portal_url => String
- #status => String
- #status_reason => String
- #updated_at => Time
See Also:
8055 8056 8057 8058 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 8055 def get_consent_portal(params = {}, options = {}) req = build_request(:get_consent_portal, params) req.send_request(options) end |
#get_dataset(params = {}) ⇒ Types::GetDatasetResponse
Retrieves dataset metadata. Use the datasetVersion query parameter
to retrieve a specific version's metadata. If absent, defaults to
DRAFT. For paginated example content, use ListDatasetExamples.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_dataset({
dataset_id: "DatasetId", # required
dataset_version: "DatasetVersion",
})
Response structure
Response structure
resp.dataset_arn #=> String
resp.dataset_id #=> String
resp.dataset_version #=> String
resp.dataset_name #=> String
resp.description #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.draft_status #=> String, one of "MODIFIED", "UNMODIFIED"
resp.failure_reason #=> String
resp.schema_type #=> String, one of "AGENTCORE_EVALUATION_PREDEFINED_V1", "AGENTCORE_EVALUATION_SIMULATED_V1", "THIRD_PARTY_EVALUATION_V1"
resp.kms_key_arn #=> String
resp.example_count #=> Integer
resp.example_count_by_field.turns #=> Integer
resp.example_count_by_field.input #=> Integer
resp.example_count_by_field.actor_profile #=> Integer
resp.download_url #=> String
resp.download_url_expires_at #=> Time
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:dataset_id
(required, String)
—
The unique identifier of the dataset to retrieve.
-
:dataset_version
(String)
—
Version to retrieve: "DRAFT" or a version number. Defaults to DRAFT if absent.
Returns:
-
(Types::GetDatasetResponse)
—
Returns a response object which responds to the following methods:
- #dataset_arn => String
- #dataset_id => String
- #dataset_version => String
- #dataset_name => String
- #description => String
- #status => String
- #draft_status => String
- #failure_reason => String
- #schema_type => String
- #kms_key_arn => String
- #example_count => Integer
- #example_count_by_field => Types::ExampleCountByField
- #download_url => String
- #download_url_expires_at => Time
- #created_at => Time
- #updated_at => Time
- #tags => Hash<String,String>
See Also:
8125 8126 8127 8128 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 8125 def get_dataset(params = {}, options = {}) req = build_request(:get_dataset, params) req.send_request(options) end |
#get_evaluator(params = {}) ⇒ Types::GetEvaluatorResponse
Retrieves detailed information about an evaluator, including its configuration, status, and metadata. Works with both built-in and custom evaluators.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_evaluator({
evaluator_id: "EvaluatorId", # required
included_data: "ALL_DATA", # accepts ALL_DATA, METADATA_ONLY
})
Response structure
Response structure
resp.evaluator_arn #=> String
resp.evaluator_id #=> String
resp.evaluator_name #=> String
resp.description #=> String
resp.evaluator_config.llm_as_a_judge.instructions #=> String
resp.evaluator_config.llm_as_a_judge.rating_scale.numerical #=> Array
resp.evaluator_config.llm_as_a_judge.rating_scale.numerical[0].definition #=> String
resp.evaluator_config.llm_as_a_judge.rating_scale.numerical[0].value #=> Float
resp.evaluator_config.llm_as_a_judge.rating_scale.numerical[0].label #=> String
resp.evaluator_config.llm_as_a_judge.rating_scale.categorical #=> Array
resp.evaluator_config.llm_as_a_judge.rating_scale.categorical[0].definition #=> String
resp.evaluator_config.llm_as_a_judge.rating_scale.categorical[0].label #=> String
resp.evaluator_config.llm_as_a_judge.rating_scale.multi_dimensional #=> Array
resp.evaluator_config.llm_as_a_judge.rating_scale.multi_dimensional[0].dimension_name #=> String
resp.evaluator_config.llm_as_a_judge.rating_scale.multi_dimensional[0].dimension_instruction #=> String
resp.evaluator_config.llm_as_a_judge.rating_scale.multi_dimensional[0].dimension_rating_scale.numerical #=> Array
resp.evaluator_config.llm_as_a_judge.rating_scale.multi_dimensional[0].dimension_rating_scale.numerical[0].definition #=> String
resp.evaluator_config.llm_as_a_judge.rating_scale.multi_dimensional[0].dimension_rating_scale.numerical[0].value #=> Float
resp.evaluator_config.llm_as_a_judge.rating_scale.multi_dimensional[0].dimension_rating_scale.numerical[0].label #=> String
resp.evaluator_config.llm_as_a_judge.rating_scale.multi_dimensional[0].dimension_rating_scale.categorical #=> Array
resp.evaluator_config.llm_as_a_judge.rating_scale.multi_dimensional[0].dimension_rating_scale.categorical[0].definition #=> String
resp.evaluator_config.llm_as_a_judge.rating_scale.multi_dimensional[0].dimension_rating_scale.categorical[0].label #=> String
resp.evaluator_config.llm_as_a_judge.model_config.bedrock_evaluator_model_config.model_id #=> String
resp.evaluator_config.llm_as_a_judge.model_config.bedrock_evaluator_model_config.inference_config.max_tokens #=> Integer
resp.evaluator_config.llm_as_a_judge.model_config.bedrock_evaluator_model_config.inference_config.temperature #=> Float
resp.evaluator_config.llm_as_a_judge.model_config.bedrock_evaluator_model_config.inference_config.top_p #=> Float
resp.evaluator_config.llm_as_a_judge.model_config.bedrock_evaluator_model_config.inference_config.stop_sequences #=> Array
resp.evaluator_config.llm_as_a_judge.model_config.bedrock_evaluator_model_config.inference_config.stop_sequences[0] #=> String
resp.evaluator_config.llm_as_a_judge.model_config.responses_evaluator_model_config.model_id #=> String
resp.evaluator_config.llm_as_a_judge.model_config.responses_evaluator_model_config.max_output_tokens #=> Integer
resp.evaluator_config.llm_as_a_judge.model_config.responses_evaluator_model_config.temperature #=> Float
resp.evaluator_config.llm_as_a_judge.model_config.responses_evaluator_model_config.top_p #=> Float
resp.evaluator_config.llm_as_a_judge.model_config.responses_evaluator_model_config.reasoning.effort #=> String
resp.evaluator_config.code_based.lambda_config.lambda_arn #=> String
resp.evaluator_config.code_based.lambda_config.lambda_timeout_in_seconds #=> Integer
resp.evaluator_config.derived.base_evaluator_id #=> String
resp.evaluator_config.derived.model_config.bedrock_evaluator_model_config.model_id #=> String
resp.evaluator_config.derived.model_config.bedrock_evaluator_model_config.inference_config.max_tokens #=> Integer
resp.evaluator_config.derived.model_config.bedrock_evaluator_model_config.inference_config.temperature #=> Float
resp.evaluator_config.derived.model_config.bedrock_evaluator_model_config.inference_config.top_p #=> Float
resp.evaluator_config.derived.model_config.bedrock_evaluator_model_config.inference_config.stop_sequences #=> Array
resp.evaluator_config.derived.model_config.bedrock_evaluator_model_config.inference_config.stop_sequences[0] #=> String
resp.evaluator_config.derived.model_config.responses_evaluator_model_config.model_id #=> String
resp.evaluator_config.derived.model_config.responses_evaluator_model_config.max_output_tokens #=> Integer
resp.evaluator_config.derived.model_config.responses_evaluator_model_config.temperature #=> Float
resp.evaluator_config.derived.model_config.responses_evaluator_model_config.top_p #=> Float
resp.evaluator_config.derived.model_config.responses_evaluator_model_config.reasoning.effort #=> String
resp.evaluator_type #=> String, one of "Builtin", "ThirdParty", "Custom", "CustomCode", "CustomDerived"
resp.provider #=> String, one of "AWS", "DeepEval", "AutoEval", "Custom"
resp.level #=> String, one of "TOOL_CALL", "TRACE", "SESSION"
resp.status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.locked_for_modification #=> Boolean
resp.kms_key_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:evaluator_id
(required, String)
—
The unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.
-
:included_data
(String)
—
Controls which data is returned in the response.
ALL_DATA(default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requireskms:Decryptpermission on the key.METADATA_ONLYreturns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.
Returns:
-
(Types::GetEvaluatorResponse)
—
Returns a response object which responds to the following methods:
- #evaluator_arn => String
- #evaluator_id => String
- #evaluator_name => String
- #description => String
- #evaluator_config => Types::EvaluatorConfig
- #evaluator_type => String
- #provider => String
- #level => String
- #status => String
- #created_at => Time
- #updated_at => Time
- #locked_for_modification => Boolean
- #kms_key_arn => String
See Also:
8231 8232 8233 8234 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 8231 def get_evaluator(params = {}, options = {}) req = build_request(:get_evaluator, params) req.send_request(options) end |
#get_gateway(params = {}) ⇒ Types::GetGatewayResponse
Retrieves information about a specific Gateway.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_gateway({
gateway_identifier: "GatewayIdentifier", # required
})
Response structure
Response structure
resp.gateway_arn #=> String
resp.gateway_id #=> String
resp.gateway_url #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED"
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
resp.name #=> String
resp.description #=> String
resp.role_arn #=> String
resp.protocol_type #=> String, one of "MCP"
resp.protocol_configuration.mcp.supported_versions #=> Array
resp.protocol_configuration.mcp.supported_versions[0] #=> String
resp.protocol_configuration.mcp.instructions #=> String
resp.protocol_configuration.mcp.search_type #=> String, one of "SEMANTIC"
resp.protocol_configuration.mcp.session_configuration.session_timeout_in_seconds #=> Integer
resp.protocol_configuration.mcp.streaming_configuration.enable_response_streaming #=> Boolean
resp.protocol_configuration.mcp.disable_mcp_list_tools_pagination #=> Boolean
resp.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM", "NONE", "AUTHENTICATE_ONLY"
resp.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.kms_key_arn #=> String
resp.custom_transform_configuration.lambda.arn #=> String
resp.interceptor_configurations #=> Array
resp.interceptor_configurations[0].interceptor.lambda.arn #=> String
resp.interceptor_configurations[0].interception_points #=> Array
resp.interceptor_configurations[0].interception_points[0] #=> String, one of "REQUEST", "RESPONSE"
resp.interceptor_configurations[0].input_configuration.pass_request_headers #=> Boolean
resp.interceptor_configurations[0].input_configuration.payload_filter.exclude #=> Array
resp.interceptor_configurations[0].input_configuration.payload_filter.exclude[0].field #=> String, one of "RESPONSE_BODY"
resp.policy_engine_configuration.arn #=> String
resp.policy_engine_configuration.mode #=> String, one of "LOG_ONLY", "ENFORCE"
resp.workload_identity_details.workload_identity_arn #=> String
resp.exception_level #=> String, one of "DEBUG"
resp.web_acl_arn #=> String
resp.waf_configuration.failure_mode #=> String, one of "FAIL_CLOSE", "FAIL_OPEN"
resp.domain_override.default_domain #=> String
resp.domain_override.alternate_domains #=> Array
resp.domain_override.alternate_domains[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway to retrieve.
Returns:
-
(Types::GetGatewayResponse)
—
Returns a response object which responds to the following methods:
- #gateway_arn => String
- #gateway_id => String
- #gateway_url => String
- #created_at => Time
- #updated_at => Time
- #status => String
- #status_reasons => Array<String>
- #name => String
- #description => String
- #role_arn => String
- #protocol_type => String
- #protocol_configuration => Types::GatewayProtocolConfiguration
- #authorizer_type => String
- #authorizer_configuration => Types::AuthorizerConfiguration
- #kms_key_arn => String
- #custom_transform_configuration => Types::CustomTransformConfiguration
- #interceptor_configurations => Array<Types::GatewayInterceptorConfiguration>
- #policy_engine_configuration => Types::GatewayPolicyEngineConfiguration
- #workload_identity_details => Types::WorkloadIdentityDetails
- #exception_level => String
- #web_acl_arn => String
- #waf_configuration => Types::WafConfiguration
- #domain_override => Types::DomainOverride
See Also:
8364 8365 8366 8367 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 8364 def get_gateway(params = {}, options = {}) req = build_request(:get_gateway, params) req.send_request(options) end |
#get_gateway_rate_limit(params = {}) ⇒ Types::GetGatewayRateLimitResponse
Retrieves information about a gateway rate limit.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_gateway_rate_limit({
gateway_identifier: "GatewayIdentifier", # required
rate_limit_id: "GatewayRateLimitId", # required
})
Response structure
Response structure
resp.rate_limit_id #=> String
resp.gateway_identifier #=> String
resp.description #=> String
resp.dimension_keys #=> Array
resp.dimension_keys[0] #=> String
resp.data.entries #=> Array
resp.data.entries[0].dimensions #=> Hash
resp.data.entries[0].dimensions["DimensionKey"] #=> String
resp.data.entries[0].requests #=> Array
resp.data.entries[0].requests[0].rate #=> Float
resp.data.entries[0].requests[0].period #=> String, one of "second", "minute"
resp.data.entries[0].tokens #=> Array
resp.data.entries[0].tokens[0].rate #=> Float
resp.data.entries[0].tokens[0].period #=> String, one of "second", "minute"
resp.data.entries[0].connections #=> Array
resp.data.entries[0].connections[0].rate #=> Float
resp.data.entries[0].connections[0].period #=> String, one of "second", "minute"
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.created_at #=> Time
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The unique identifier of the gateway.
-
:rate_limit_id
(required, String)
—
The unique identifier of the rate limit to retrieve.
Returns:
-
(Types::GetGatewayRateLimitResponse)
—
Returns a response object which responds to the following methods:
- #rate_limit_id => String
- #gateway_identifier => String
- #description => String
- #dimension_keys => Array<String>
- #data.entries => Array<Types::LimitEntry> (This method conflicts with a method on Response, call it through the data member)
- #status => String
- #created_at => Time
- #updated_at => Time
See Also:
8422 8423 8424 8425 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 8422 def get_gateway_rate_limit(params = {}, options = {}) req = build_request(:get_gateway_rate_limit, params) req.send_request(options) end |
#get_gateway_rule(params = {}) ⇒ Types::GetGatewayRuleResponse
Retrieves detailed information about a specific gateway rule.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_gateway_rule({
gateway_identifier: "GatewayIdentifier", # required
rule_id: "GatewayRuleId", # required
})
Response structure
Response structure
resp.rule_id #=> String
resp.gateway_arn #=> String
resp.priority #=> Integer
resp.conditions #=> Array
resp.conditions[0].match_principals.any_of #=> Array
resp.conditions[0].match_principals.any_of[0].iam_principal.arn #=> String
resp.conditions[0].match_principals.any_of[0].iam_principal.operator #=> String, one of "StringEquals", "StringLike"
resp.conditions[0].match_paths.any_of #=> Array
resp.conditions[0].match_paths.any_of[0] #=> String
resp.conditions[0].match_models.any_of #=> Array
resp.conditions[0].match_models.any_of[0].value #=> String
resp.conditions[0].match_models.any_of[0].operator #=> String, one of "StringEquals", "StringLike"
resp.actions #=> Array
resp.actions[0].configuration_bundle.static_override.bundle_arn #=> String
resp.actions[0].configuration_bundle.static_override.bundle_version #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split #=> Array
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].name #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].weight #=> Integer
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].configuration_bundle.bundle_arn #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].configuration_bundle.bundle_version #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].description #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].metadata #=> Hash
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].metadata["TrafficSplitMetadataKey"] #=> String
resp.actions[0].route_to_target.static_route.target_name #=> String
resp.actions[0].route_to_target.static_route.model #=> String
resp.actions[0].route_to_target.static_route.fallback.trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.static_route.fallback.trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.static_route.fallback.trigger_on.errors #=> Array
resp.actions[0].route_to_target.static_route.fallback.trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.static_route.fallback.first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.static_route.fallback.circuit_breaker.mode #=> String, one of "ENABLED", "DISABLED"
resp.actions[0].route_to_target.static_route.fallback.target_fallback #=> Array
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].target_name #=> String
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].model #=> String
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.errors #=> Array
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].target_name #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].model #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.errors #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.circuit_breaker.mode #=> String, one of "ENABLED", "DISABLED"
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].target_name #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].model #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.errors #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split[0].name #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].weight #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split[0].description #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].metadata #=> Hash
resp.actions[0].route_to_target.weighted_route.traffic_split[0].metadata["TrafficSplitMetadataKey"] #=> String
resp.description #=> String
resp.created_at #=> Time
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.system.managed_by #=> String
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway containing the rule.
-
:rule_id
(required, String)
—
The unique identifier of the rule to retrieve.
Returns:
-
(Types::GetGatewayRuleResponse)
—
Returns a response object which responds to the following methods:
- #rule_id => String
- #gateway_arn => String
- #priority => Integer
- #conditions => Array<Types::Condition>
- #actions => Array<Types::Action>
- #description => String
- #created_at => Time
- #status => String
- #system => Types::SystemManagedBlock
- #updated_at => Time
See Also:
8528 8529 8530 8531 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 8528 def get_gateway_rule(params = {}, options = {}) req = build_request(:get_gateway_rule, params) req.send_request(options) end |
#get_gateway_target(params = {}) ⇒ Types::GetGatewayTargetResponse
Retrieves information about a specific gateway target.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_gateway_target({
gateway_identifier: "GatewayIdentifier", # required
target_id: "TargetId", # required
})
Response structure
Response structure
resp.gateway_arn #=> String
resp.target_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED", "SYNCHRONIZING", "SYNCHRONIZE_UNSUCCESSFUL", "CREATE_PENDING_AUTH", "UPDATE_PENDING_AUTH", "SYNCHRONIZE_PENDING_AUTH"
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
resp.name #=> String
resp.description #=> String
resp.target_configuration.mcp.open_api_schema.s3.uri #=> String
resp.target_configuration.mcp.open_api_schema.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.open_api_schema.inline_payload #=> String
resp.target_configuration.mcp.smithy_model.s3.uri #=> String
resp.target_configuration.mcp.smithy_model.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.smithy_model.inline_payload #=> String
resp.target_configuration.mcp.lambda.lambda_arn #=> String
resp.target_configuration.mcp.lambda.tool_schema.s3.uri #=> String
resp.target_configuration.mcp.lambda.tool_schema.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload #=> Array
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].name #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].description #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.type #=> String, one of "string", "number", "object", "array", "boolean", "integer"
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.properties #=> Hash
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.properties["String"] #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.required #=> Array
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.required[0] #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.items #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.description #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.type #=> String, one of "string", "number", "object", "array", "boolean", "integer"
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.properties #=> Hash
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.properties["String"] #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.required #=> Array
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.required[0] #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.items #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.description #=> String
resp.target_configuration.mcp.mcp_server.endpoint #=> String
resp.target_configuration.mcp.mcp_server.mcp_tool_schema.s3.uri #=> String
resp.target_configuration.mcp.mcp_server.mcp_tool_schema.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.mcp_server.mcp_tool_schema.inline_payload #=> String
resp.target_configuration.mcp.mcp_server.listing_mode #=> String, one of "DEFAULT", "DYNAMIC"
resp.target_configuration.mcp.mcp_server.resource_priority #=> Integer
resp.target_configuration.mcp.api_gateway.rest_api_id #=> String
resp.target_configuration.mcp.api_gateway.stage #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides #=> Array
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].name #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].description #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].path #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].method #=> String, one of "GET", "DELETE", "HEAD", "OPTIONS", "PATCH", "PUT", "POST"
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters #=> Array
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].filter_path #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].methods #=> Array
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].methods[0] #=> String, one of "GET", "DELETE", "HEAD", "OPTIONS", "PATCH", "PUT", "POST"
resp.target_configuration.mcp.connector.source.connector_id #=> String
resp.target_configuration.mcp.connector.source.version #=> String
resp.target_configuration.mcp.connector.enabled #=> Array
resp.target_configuration.mcp.connector.enabled[0] #=> String
resp.target_configuration.mcp.connector.configurations #=> Array
resp.target_configuration.mcp.connector.configurations[0].name #=> String
resp.target_configuration.mcp.connector.configurations[0].description #=> String
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides #=> Array
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides[0].path #=> String
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides[0].description #=> String
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides[0].visible #=> Boolean
resp.target_configuration.http.agentcore_runtime.arn #=> String
resp.target_configuration.http.agentcore_runtime.qualifier #=> String
resp.target_configuration.http.agentcore_runtime.schema.source.s3.uri #=> String
resp.target_configuration.http.agentcore_runtime.schema.source.s3.bucket_owner_account_id #=> String
resp.target_configuration.http.agentcore_runtime.schema.source.inline_payload #=> String
resp.target_configuration.http.passthrough.endpoint #=> String
resp.target_configuration.http.passthrough.protocol_type #=> String, one of "MCP", "A2A", "INFERENCE", "CUSTOM"
resp.target_configuration.http.passthrough.schema.source.s3.uri #=> String
resp.target_configuration.http.passthrough.schema.source.s3.bucket_owner_account_id #=> String
resp.target_configuration.http.passthrough.schema.source.inline_payload #=> String
resp.target_configuration.http.passthrough.stickiness_configuration.identifier #=> String
resp.target_configuration.http.passthrough.stickiness_configuration.timeout #=> Integer
resp.target_configuration.http.passthrough.stickiness_configuration.composite_identifier #=> Array
resp.target_configuration.http.passthrough.stickiness_configuration.composite_identifier[0] #=> String
resp.target_configuration.http.passthrough.static_query_parameters #=> Hash
resp.target_configuration.http.passthrough.static_query_parameters["StaticQueryParameterName"] #=> String
resp.target_configuration.http.passthrough.static_query_parameter_conflict_resolution #=> String, one of "CLIENT_OVERRIDE", "STATIC_OVERRIDE"
resp.target_configuration.http.connector.source.connector_id #=> String
resp.target_configuration.http.connector.parameters #=> Hash
resp.target_configuration.http.connector.parameters["ConnectorParameterName"] #=> String
resp.target_configuration.inference.connector.source.connector_id #=> String
resp.target_configuration.inference.provider.endpoint #=> String
resp.target_configuration.inference.provider.model_mapping.provider_prefix.strip #=> Boolean
resp.target_configuration.inference.provider.model_mapping.provider_prefix.separator #=> String
resp.target_configuration.inference.provider.operations #=> Array
resp.target_configuration.inference.provider.operations[0].path #=> String
resp.target_configuration.inference.provider.operations[0].provider_path #=> String
resp.target_configuration.inference.provider.operations[0].models #=> Array
resp.target_configuration.inference.provider.operations[0].models[0].model #=> String
resp.credential_provider_configurations #=> Array
resp.credential_provider_configurations[0].credential_provider_type #=> String, one of "GATEWAY_IAM_ROLE", "OAUTH", "API_KEY", "CALLER_IAM_CREDENTIALS", "JWT_PASSTHROUGH"
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["OAuthCustomParametersKey"] #=> String
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "TOKEN_EXCHANGE"
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.default_return_url #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.provider_arn #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_parameter_name #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_prefix #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_location #=> String, one of "HEADER", "QUERY_PARAMETER"
resp.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
resp.last_synchronized_at #=> Time
resp.metadata_configuration.allowed_request_headers #=> Array
resp.metadata_configuration.allowed_request_headers[0] #=> String
resp.metadata_configuration.allowed_query_parameters #=> Array
resp.metadata_configuration.allowed_query_parameters[0] #=> String
resp.metadata_configuration.allowed_response_headers #=> Array
resp.metadata_configuration.allowed_response_headers[0] #=> String
resp.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.private_endpoint_managed_resources #=> Array
resp.private_endpoint_managed_resources[0].domain #=> String
resp.private_endpoint_managed_resources[0].resource_gateway_arn #=> String
resp.private_endpoint_managed_resources[0].resource_association_arn #=> String
resp.authorization_data.oauth2.authorization_url #=> String
resp.authorization_data.oauth2.user_id #=> String
resp.protocol_type #=> String, one of "MCP", "HTTP"
resp.certificate_configurations #=> Array
resp.certificate_configurations[0].s3.uri #=> String
resp.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.certificate_configurations[0].secrets_manager.secret_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway that contains the target.
-
:target_id
(required, String)
—
The unique identifier of the target to retrieve.
Returns:
-
(Types::GetGatewayTargetResponse)
—
Returns a response object which responds to the following methods:
- #gateway_arn => String
- #target_id => String
- #created_at => Time
- #updated_at => Time
- #status => String
- #status_reasons => Array<String>
- #name => String
- #description => String
- #target_configuration => Types::TargetConfiguration
- #credential_provider_configurations => Array<Types::CredentialProviderConfiguration>
- #last_synchronized_at => Time
- #metadata_configuration => Types::MetadataConfiguration
- #private_endpoint => Types::PrivateEndpoint
- #private_endpoint_managed_resources => Array<Types::ManagedResourceDetails>
- #authorization_data => Types::AuthorizationData
- #protocol_type => String
- #certificate_configurations => Array<Types::CertificateConfiguration>
See Also:
8710 8711 8712 8713 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 8710 def get_gateway_target(params = {}, options = {}) req = build_request(:get_gateway_target, params) req.send_request(options) end |
#get_harness(params = {}) ⇒ Types::GetHarnessResponse
Operation to get a single harness.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_harness({
harness_id: "HarnessId", # required
harness_version: "HarnessVersion",
})
Response structure
Response structure
resp.harness.harness_id #=> String
resp.harness.harness_name #=> String
resp.harness.arn #=> String
resp.harness.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.harness.harness_version #=> String
resp.harness.execution_role_arn #=> String
resp.harness.created_at #=> Time
resp.harness.updated_at #=> Time
resp.harness.model.bedrock_model_config.model_id #=> String
resp.harness.model.bedrock_model_config.max_tokens #=> Integer
resp.harness.model.bedrock_model_config.temperature #=> Float
resp.harness.model.bedrock_model_config.top_p #=> Float
resp.harness.model.bedrock_model_config.api_format #=> String, one of "converse_stream", "responses", "chat_completions"
resp.harness.model.open_ai_model_config.model_id #=> String
resp.harness.model.open_ai_model_config.api_key_arn #=> String
resp.harness.model.open_ai_model_config.api_base #=> String
resp.harness.model.open_ai_model_config.max_tokens #=> Integer
resp.harness.model.open_ai_model_config.temperature #=> Float
resp.harness.model.open_ai_model_config.top_p #=> Float
resp.harness.model.open_ai_model_config.api_format #=> String, one of "chat_completions", "responses"
resp.harness.model.gemini_model_config.model_id #=> String
resp.harness.model.gemini_model_config.api_key_arn #=> String
resp.harness.model.gemini_model_config.max_tokens #=> Integer
resp.harness.model.gemini_model_config.temperature #=> Float
resp.harness.model.gemini_model_config.top_p #=> Float
resp.harness.model.gemini_model_config.top_k #=> Integer
resp.harness.model.lite_llm_model_config.model_id #=> String
resp.harness.model.lite_llm_model_config.api_key_arn #=> String
resp.harness.model.lite_llm_model_config.api_base #=> String
resp.harness.model.lite_llm_model_config.max_tokens #=> Integer
resp.harness.model.lite_llm_model_config.temperature #=> Float
resp.harness.model.lite_llm_model_config.top_p #=> Float
resp.harness.system_prompt #=> Array
resp.harness.system_prompt[0].text #=> String
resp.harness.tools #=> Array
resp.harness.tools[0].type #=> String, one of "remote_mcp", "agentcore_browser", "agentcore_gateway", "inline_function", "agentcore_code_interpreter"
resp.harness.tools[0].name #=> String
resp.harness.tools[0].config.remote_mcp.url #=> String
resp.harness.tools[0].config.remote_mcp.headers #=> Hash
resp.harness.tools[0].config.remote_mcp.headers["HttpHeaderKey"] #=> String
resp.harness.tools[0].config.remote_mcp.outbound_auth.aws_iam.service #=> String
resp.harness.tools[0].config.remote_mcp.outbound_auth.aws_iam.region #=> String
resp.harness.tools[0].config.agent_core_browser.browser_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.gateway_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.provider_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.scopes #=> Array
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.scopes[0] #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.custom_parameters #=> Hash
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.custom_parameters["OAuthCustomParametersKey"] #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.grant_type #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "TOKEN_EXCHANGE"
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.default_return_url #=> String
resp.harness.tools[0].config.inline_function.description #=> String
resp.harness.tools[0].config.agent_core_code_interpreter.code_interpreter_arn #=> String
resp.harness.skills #=> Array
resp.harness.skills[0].path #=> String
resp.harness.skills[0].s3.uri #=> String
resp.harness.skills[0].git.url #=> String
resp.harness.skills[0].git.path #=> String
resp.harness.skills[0].git.auth.credential_arn #=> String
resp.harness.skills[0].git.auth.username #=> String
resp.harness.skills[0].aws_skills.paths #=> Array
resp.harness.skills[0].aws_skills.paths[0] #=> String
resp.harness.allowed_tools #=> Array
resp.harness.allowed_tools[0] #=> String
resp.harness.truncation.strategy #=> String, one of "sliding_window", "summarization", "none"
resp.harness.truncation.config.sliding_window.messages_count #=> Integer
resp.harness.truncation.config.summarization.summary_ratio #=> Float
resp.harness.truncation.config.summarization.preserve_recent_messages #=> Integer
resp.harness.truncation.config.summarization.summarization_system_prompt #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_arn #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_name #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_id #=> String
resp.harness.environment.agent_core_runtime_environment.lifecycle_configuration.idle_runtime_session_timeout #=> Integer
resp.harness.environment.agent_core_runtime_environment.lifecycle_configuration.max_lifetime #=> Integer
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode #=> String, one of "PUBLIC", "VPC"
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.security_groups #=> Array
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.security_groups[0] #=> String
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.subnets #=> Array
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.subnets[0] #=> String
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.require_service_s3_endpoint #=> Boolean
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations #=> Array
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].session_storage.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].s3_files_access_point.access_point_arn #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].s3_files_access_point.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].efs_access_point.access_point_arn #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].efs_access_point.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].capacity_provider_volume.volume_name #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].capacity_provider_volume.mount_path #=> String
resp.harness.environment_artifact.container_configuration.container_uri #=> String
resp.harness.environment_variables #=> Hash
resp.harness.environment_variables["EnvironmentVariableKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.harness.memory.agent_core_memory_configuration.arn #=> String
resp.harness.memory.agent_core_memory_configuration.actor_id #=> String
resp.harness.memory.agent_core_memory_configuration.messages_count #=> Integer
resp.harness.memory.agent_core_memory_configuration.retrieval_config #=> Hash
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].top_k #=> Integer
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].relevance_score #=> Float
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].strategy_id #=> String
resp.harness.memory.managed_memory_configuration.arn #=> String
resp.harness.memory.managed_memory_configuration.strategies #=> Array
resp.harness.memory.managed_memory_configuration.strategies[0] #=> String, one of "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "EPISODIC"
resp.harness.memory.managed_memory_configuration.event_expiry_duration #=> Integer
resp.harness.memory.managed_memory_configuration.encryption_key_arn #=> String
resp.harness.hooks #=> Array
resp.harness.hooks[0].before_invocation.name #=> String
resp.harness.hooks[0].before_invocation.target.lambda.arn #=> String
resp.harness.hooks[0].before_invocation.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].before_invocation.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].before_invocation.target.sns.arn #=> String
resp.harness.hooks[0].before_invocation.target.event_bridge.arn #=> String
resp.harness.hooks[0].after_invocation.name #=> String
resp.harness.hooks[0].after_invocation.target.lambda.arn #=> String
resp.harness.hooks[0].after_invocation.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].after_invocation.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].after_invocation.target.sns.arn #=> String
resp.harness.hooks[0].after_invocation.target.event_bridge.arn #=> String
resp.harness.hooks[0].before_tool_call.name #=> String
resp.harness.hooks[0].before_tool_call.target.lambda.arn #=> String
resp.harness.hooks[0].before_tool_call.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].before_tool_call.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].before_tool_call.target.sns.arn #=> String
resp.harness.hooks[0].before_tool_call.target.event_bridge.arn #=> String
resp.harness.hooks[0].after_tool_call.name #=> String
resp.harness.hooks[0].after_tool_call.target.lambda.arn #=> String
resp.harness.hooks[0].after_tool_call.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].after_tool_call.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].after_tool_call.target.sns.arn #=> String
resp.harness.hooks[0].after_tool_call.target.event_bridge.arn #=> String
resp.harness.max_iterations #=> Integer
resp.harness.max_tokens #=> Integer
resp.harness.timeout_seconds #=> Integer
resp.harness.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:harness_id
(required, String)
—
The ID of the harness to retrieve.
-
:harness_version
(String)
—
Specific version of the harness to retrieve. If omitted, returns the current Harness configuration, including its status.
Returns:
See Also:
8920 8921 8922 8923 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 8920 def get_harness(params = {}, options = {}) req = build_request(:get_harness, params) req.send_request(options) end |
#get_harness_endpoint(params = {}) ⇒ Types::GetHarnessEndpointResponse
Operation to get a single harness endpoint.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_harness_endpoint({
harness_id: "HarnessId", # required
endpoint_name: "HarnessEndpointName", # required
})
Response structure
Response structure
resp.endpoint.harness_id #=> String
resp.endpoint.harness_name #=> String
resp.endpoint.endpoint_name #=> String
resp.endpoint.arn #=> String
resp.endpoint.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.endpoint.created_at #=> Time
resp.endpoint.updated_at #=> Time
resp.endpoint.live_version #=> String
resp.endpoint.target_version #=> String
resp.endpoint.description #=> String
resp.endpoint.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:harness_id
(required, String)
—
The ID of the harness that the endpoint belongs to.
-
:endpoint_name
(required, String)
—
The name of the endpoint to retrieve.
Returns:
See Also:
8962 8963 8964 8965 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 8962 def get_harness_endpoint(params = {}, options = {}) req = build_request(:get_harness_endpoint, params) req.send_request(options) end |
#get_memory(params = {}) ⇒ Types::GetMemoryOutput
Retrieve an existing Amazon Bedrock AgentCore Memory resource.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- memory_created
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_memory({
memory_id: "MemoryId", # required
view: "full", # accepts full, without_decryption
})
Response structure
Response structure
resp.memory.arn #=> String
resp.memory.id #=> String
resp.memory.name #=> String
resp.memory.description #=> String
resp.memory.encryption_key_arn #=> String
resp.memory.memory_execution_role_arn #=> String
resp.memory.event_expiry_duration #=> Integer
resp.memory.status #=> String, one of "CREATING", "ACTIVE", "FAILED", "DELETING", "UPDATING"
resp.memory.failure_reason #=> String
resp.memory.created_at #=> Time
resp.memory.updated_at #=> Time
resp.memory.strategies #=> Array
resp.memory.strategies[0].strategy_id #=> String
resp.memory.strategies[0].name #=> String
resp.memory.strategies[0].description #=> String
resp.memory.strategies[0].configuration.type #=> String, one of "SEMANTIC_OVERRIDE", "SUMMARY_OVERRIDE", "USER_PREFERENCE_OVERRIDE", "SELF_MANAGED", "EPISODIC_OVERRIDE"
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.semantic_extraction_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.semantic_extraction_override.model_id #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.user_preference_extraction_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.user_preference_extraction_override.model_id #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.episodic_extraction_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.episodic_extraction_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.semantic_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.semantic_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.summary_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.summary_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.user_preference_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.user_preference_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.episodic_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.episodic_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.model_id #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespaces #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespaces[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespace_templates #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespace_templates[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].key #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_type #=> String, one of "LLM_INFERRED", "STRICTLY_CONSISTENT"
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.llm_extraction_instruction #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.definition #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.max_items #=> Integer
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.min_value #=> Float
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.max_value #=> Float
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespaces #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespaces[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespace_templates #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespace_templates[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].key #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_type #=> String, one of "LLM_INFERRED", "STRICTLY_CONSISTENT"
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.llm_extraction_instruction #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.definition #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.max_items #=> Integer
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.min_value #=> Float
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.max_value #=> Float
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions #=> Array
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions[0].message_based_trigger.message_count #=> Integer
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions[0].token_based_trigger.token_count #=> Integer
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions[0].time_based_trigger.idle_session_timeout #=> Integer
resp.memory.strategies[0].configuration.self_managed_configuration.invocation_configuration.topic_arn #=> String
resp.memory.strategies[0].configuration.self_managed_configuration.invocation_configuration.payload_delivery_bucket_name #=> String
resp.memory.strategies[0].configuration.self_managed_configuration.historical_context_window_size #=> Integer
resp.memory.strategies[0].type #=> String, one of "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "CUSTOM", "EPISODIC"
resp.memory.strategies[0].namespaces #=> Array
resp.memory.strategies[0].namespaces[0] #=> String
resp.memory.strategies[0].namespace_templates #=> Array
resp.memory.strategies[0].namespace_templates[0] #=> String
resp.memory.strategies[0].created_at #=> Time
resp.memory.strategies[0].updated_at #=> Time
resp.memory.strategies[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.memory.strategies[0].memory_record_schema.metadata_schema #=> Array
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].key #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_type #=> String, one of "LLM_INFERRED", "STRICTLY_CONSISTENT"
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.llm_extraction_instruction #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.definition #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values #=> Array
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values[0] #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values #=> Array
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values[0] #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.max_items #=> Integer
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.min_value #=> Float
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.max_value #=> Float
resp.memory.strategies[0].record_expiry_duration_days #=> Integer
resp.memory.indexed_keys #=> Array
resp.memory.indexed_keys[0].key #=> String
resp.memory.indexed_keys[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.namespace_keys #=> Array
resp.memory.namespace_keys[0].key #=> String
resp.memory.namespace_keys[0].validation.allowed_values #=> Array
resp.memory.namespace_keys[0].validation.allowed_values[0] #=> String
resp.memory.namespace_keys[0].validation.regex_pattern #=> String
resp.memory.stream_delivery_resources.resources #=> Array
resp.memory.stream_delivery_resources.resources[0].kinesis.data_stream_arn #=> String
resp.memory.stream_delivery_resources.resources[0].kinesis.content_configurations #=> Array
resp.memory.stream_delivery_resources.resources[0].kinesis.content_configurations[0].type #=> String, one of "MEMORY_RECORDS"
resp.memory.stream_delivery_resources.resources[0].kinesis.content_configurations[0].level #=> String, one of "METADATA_ONLY", "FULL_CONTENT"
resp.memory.managed_by_resource_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:memory_id
(required, String)
—
The unique identifier of the memory to retrieve.
-
:view
(String)
—
The level of detail to return for the memory.
Returns:
See Also:
9107 9108 9109 9110 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9107 def get_memory(params = {}, options = {}) req = build_request(:get_memory, params) req.send_request(options) end |
#get_oauth_2_credential_provider(params = {}) ⇒ Types::GetOauth2CredentialProviderResponse
Retrieves information about an OAuth2 credential provider.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_oauth_2_credential_provider({
name: "CredentialProviderName", # required
})
Response structure
Response structure
resp.client_secret_arn.secret_arn #=> String
resp.client_secret_json_key #=> String
resp.client_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.name #=> String
resp.credential_provider_arn #=> String
resp.credential_provider_vendor #=> String, one of "GoogleOauth2", "GithubOauth2", "SlackOauth2", "SalesforceOauth2", "MicrosoftOauth2", "CustomOauth2", "AtlassianOauth2", "LinkedinOauth2", "XOauth2", "OktaOauth2", "OneLoginOauth2", "PingOneOauth2", "FacebookOauth2", "YandexOauth2", "RedditOauth2", "ZoomOauth2", "TwitchOauth2", "SpotifyOauth2", "DropboxOauth2", "NotionOauth2", "HubspotOauth2", "CyberArkOauth2", "FusionAuthOauth2", "Auth0Oauth2", "CognitoOauth2"
resp.callback_url #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.grant_type #=> String, one of "TOKEN_EXCHANGE", "JWT_AUTHORIZATION_GRANT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.token_exchange_grant_type_config.actor_token_content #=> String, one of "NONE", "M2M", "AWS_IAM_ID_TOKEN_JWT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.token_exchange_grant_type_config.actor_token_scopes #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.token_exchange_grant_type_config.actor_token_scopes[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.on_behalf_of_authentication_config.client_authentication_method #=> String, one of "NO_CLIENT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.client_authentication_method #=> String, one of "CLIENT_SECRET_BASIC", "CLIENT_SECRET_POST", "AWS_IAM_ID_TOKEN_JWT", "PRIVATE_KEY_JWT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].domain #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations[0].s3.uri #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.private_key_source.kms_key_source.kms_key_arn #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.signing_algorithm #=> String, one of "RS256", "PS256", "ES256"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_header_claims #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_header_claims["AdditionalClaimName"] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_payload_claims #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_payload_claims["AdditionalClaimName"] #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.client_id #=> String
resp.created_time #=> Time
resp.last_updated_time #=> Time
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the OAuth2 credential provider to retrieve.
Returns:
-
(Types::GetOauth2CredentialProviderResponse)
—
Returns a response object which responds to the following methods:
- #client_secret_arn => Types::Secret
- #client_secret_json_key => String
- #client_secret_source => String
- #name => String
- #credential_provider_arn => String
- #credential_provider_vendor => String
- #callback_url => String
- #oauth2_provider_config_output => Types::Oauth2ProviderConfigOutput
- #created_time => Time
- #last_updated_time => Time
- #status => String
- #failure_reason => String
See Also:
9275 9276 9277 9278 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9275 def get_oauth_2_credential_provider(params = {}, options = {}) req = build_request(:get_oauth_2_credential_provider, params) req.send_request(options) end |
#get_online_evaluation_config(params = {}) ⇒ Types::GetOnlineEvaluationConfigResponse
Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_online_evaluation_config({
online_evaluation_config_id: "OnlineEvaluationConfigId", # required
})
Response structure
Response structure
resp.online_evaluation_config_arn #=> String
resp.online_evaluation_config_id #=> String
resp.online_evaluation_config_name #=> String
resp.description #=> String
resp.rule.sampling_config.sampling_percentage #=> Float
resp.rule.filters #=> Array
resp.rule.filters[0].key #=> String
resp.rule.filters[0].operator #=> String, one of "Equals", "NotEquals", "GreaterThan", "LessThan", "GreaterThanOrEqual", "LessThanOrEqual", "Contains", "NotContains"
resp.rule.filters[0].value.string_value #=> String
resp.rule.filters[0].value.double_value #=> Float
resp.rule.filters[0].value.boolean_value #=> Boolean
resp.rule.session_config.session_timeout_minutes #=> Integer
resp.data_source_config.cloud_watch_logs.log_group_names #=> Array
resp.data_source_config.cloud_watch_logs.log_group_names[0] #=> String
resp.data_source_config.cloud_watch_logs.log_group_name_prefixes #=> Array
resp.data_source_config.cloud_watch_logs.log_group_name_prefixes[0] #=> String
resp.data_source_config.cloud_watch_logs.service_names #=> Array
resp.data_source_config.cloud_watch_logs.service_names[0] #=> String
resp.evaluators #=> Array
resp.evaluators[0].evaluator_id #=> String
resp.insights #=> Array
resp.insights[0].insight_id #=> String
resp.clustering_config.frequencies #=> Array
resp.clustering_config.frequencies[0] #=> String, one of "DAILY", "WEEKLY", "MONTHLY"
resp.output_config.cloud_watch_config.log_group_name #=> String
resp.output_config.cloud_watch_config.metrics_namespace #=> String
resp.output_config.cloud_watch_config.result_destination #=> String, one of "DEDICATED_LOG_GROUP", "SOURCE_LOG_GROUP"
resp.evaluation_execution_role_arn #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "ERROR"
resp.execution_status #=> String, one of "ENABLED", "DISABLED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:online_evaluation_config_id
(required, String)
—
The unique identifier of the online evaluation configuration to retrieve.
Returns:
-
(Types::GetOnlineEvaluationConfigResponse)
—
Returns a response object which responds to the following methods:
- #online_evaluation_config_arn => String
- #online_evaluation_config_id => String
- #online_evaluation_config_name => String
- #description => String
- #rule => Types::Rule
- #data_source_config => Types::DataSourceConfig
- #evaluators => Array<Types::EvaluatorReference>
- #insights => Array<Types::Insight>
- #clustering_config => Types::ClusteringConfig
- #output_config => Types::OutputConfig
- #evaluation_execution_role_arn => String
- #status => String
- #execution_status => String
- #created_at => Time
- #updated_at => Time
- #failure_reason => String
See Also:
9353 9354 9355 9356 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9353 def get_online_evaluation_config(params = {}, options = {}) req = build_request(:get_online_evaluation_config, params) req.send_request(options) end |
#get_payment_connector(params = {}) ⇒ Types::GetPaymentConnectorResponse
Retrieves information about a specific payment connector.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_payment_connector({
payment_manager_id: "PaymentManagerId", # required
payment_connector_id: "PaymentConnectorId", # required
})
Response structure
Response structure
resp.payment_connector_id #=> String
resp.name #=> String
resp.description #=> String
resp.type #=> String, one of "CoinbaseCDP", "StripePrivy"
resp.provision_mode #=> String, one of "MANUAL", "QUICK_CREATE"
resp.credential_provider_configurations #=> Array
resp.credential_provider_configurations[0].coinbase_cdp.credential_provider_arn #=> String
resp.credential_provider_configurations[0].stripe_privy.credential_provider_arn #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED", "PENDING_AUTHENTICATION", "PROVISIONING", "AUTHENTICATION_EXPIRED", "AUTHENTICATION_FAILED"
resp.authorization_url #=> String
resp.credentials_updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:payment_manager_id
(required, String)
—
The unique identifier of the parent payment manager.
-
:payment_connector_id
(required, String)
—
The unique identifier of the payment connector to retrieve.
Returns:
-
(Types::GetPaymentConnectorResponse)
—
Returns a response object which responds to the following methods:
- #payment_connector_id => String
- #name => String
- #description => String
- #type => String
- #provision_mode => String
- #credential_provider_configurations => Array<Types::CredentialsProviderConfiguration>
- #created_at => Time
- #last_updated_at => Time
- #status => String
- #authorization_url => String
- #credentials_updated_at => Time
See Also:
9407 9408 9409 9410 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9407 def get_payment_connector(params = {}, options = {}) req = build_request(:get_payment_connector, params) req.send_request(options) end |
#get_payment_credential_provider(params = {}) ⇒ Types::GetPaymentCredentialProviderResponse
Retrieves information about a specific payment credential provider.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_payment_credential_provider({
name: "CredentialProviderName", # required
})
Response structure
Response structure
resp.name #=> String
resp.credential_provider_arn #=> String
resp.credential_provider_vendor #=> String, one of "CoinbaseCDP", "StripePrivy"
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_id #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_secret_arn.secret_arn #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_secret_json_key #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.coinbase_cdp_configuration.wallet_secret_arn.secret_arn #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.wallet_secret_json_key #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.wallet_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.stripe_privy_configuration.app_id #=> String
resp.provider_configuration_output.stripe_privy_configuration.app_secret_arn.secret_arn #=> String
resp.provider_configuration_output.stripe_privy_configuration.app_secret_json_key #=> String
resp.provider_configuration_output.stripe_privy_configuration.app_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.stripe_privy_configuration.authorization_private_key_arn.secret_arn #=> String
resp.provider_configuration_output.stripe_privy_configuration.authorization_private_key_json_key #=> String
resp.provider_configuration_output.stripe_privy_configuration.authorization_private_key_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.stripe_privy_configuration.authorization_id #=> String
resp.created_time #=> Time
resp.last_updated_time #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the payment credential provider to retrieve.
Returns:
-
(Types::GetPaymentCredentialProviderResponse)
—
Returns a response object which responds to the following methods:
- #name => String
- #credential_provider_arn => String
- #credential_provider_vendor => String
- #provider_configuration_output => Types::PaymentProviderConfigurationOutput
- #created_time => Time
- #last_updated_time => Time
- #tags => Hash<String,String>
See Also:
9462 9463 9464 9465 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9462 def get_payment_credential_provider(params = {}, options = {}) req = build_request(:get_payment_credential_provider, params) req.send_request(options) end |
#get_payment_manager(params = {}) ⇒ Types::GetPaymentManagerResponse
Retrieves information about a specific payment manager.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_payment_manager({
payment_manager_id: "PaymentManagerId", # required
})
Response structure
Response structure
resp.payment_manager_arn #=> String
resp.payment_manager_id #=> String
resp.name #=> String
resp.description #=> String
resp.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM"
resp.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.role_arn #=> String
resp.workload_identity_details.workload_identity_arn #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.kms_key_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:payment_manager_id
(required, String)
—
The unique identifier of the payment manager to retrieve.
Returns:
-
(Types::GetPaymentManagerResponse)
—
Returns a response object which responds to the following methods:
- #payment_manager_arn => String
- #payment_manager_id => String
- #name => String
- #description => String
- #authorizer_type => String
- #authorizer_configuration => Types::AuthorizerConfiguration
- #role_arn => String
- #workload_identity_details => Types::WorkloadIdentityDetails
- #created_at => Time
- #last_updated_at => Time
- #status => String
- #tags => Hash<String,String>
- #kms_key_arn => String
See Also:
9560 9561 9562 9563 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9560 def get_payment_manager(params = {}, options = {}) req = build_request(:get_payment_manager, params) req.send_request(options) end |
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Retrieves detailed information about a specific policy within the AgentCore Policy system. This operation returns the complete policy definition, metadata, and current status, allowing administrators to review and manage policy configurations.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- policy_active
- policy_deleted
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_policy({
policy_engine_id: "ResourceId", # required
policy_id: "ResourceId", # required
})
Response structure
Response structure
resp.policy_id #=> String
resp.name #=> String
resp.policy_engine_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.policy_arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.enforcement_mode #=> String, one of "ACTIVE", "LOG_ONLY"
resp.definition.cedar.statement #=> String
resp.definition.policy_generation.policy_generation_id #=> String
resp.definition.policy_generation.policy_generation_asset_id #=> String
resp.definition.policy.statement #=> String
resp.description #=> String
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine that manages the policy to be retrieved.
-
:policy_id
(required, String)
—
The unique identifier of the policy to be retrieved. This must be a valid policy ID that exists within the specified policy engine.
Returns:
-
(Types::GetPolicyResponse)
—
Returns a response object which responds to the following methods:
- #policy_id => String
- #name => String
- #policy_engine_id => String
- #created_at => Time
- #updated_at => Time
- #policy_arn => String
- #status => String
- #enforcement_mode => String
- #definition => Types::PolicyDefinition
- #description => String
- #status_reasons => Array<String>
See Also:
9627 9628 9629 9630 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9627 def get_policy(params = {}, options = {}) req = build_request(:get_policy, params) req.send_request(options) end |
#get_policy_engine(params = {}) ⇒ Types::GetPolicyEngineResponse
Retrieves detailed information about a specific policy engine within the AgentCore Policy system. This operation returns the complete policy engine configuration, metadata, and current status, allowing administrators to review and manage policy engine settings.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- policy_engine_active
- policy_engine_deleted
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_policy_engine({
policy_engine_id: "ResourceId", # required
})
Response structure
Response structure
resp.policy_engine_id #=> String
resp.name #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.policy_engine_arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.encryption_key_arn #=> String
resp.description #=> String
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_engine_id
(required, String)
—
The unique identifier of the policy engine to be retrieved. This must be a valid policy engine ID that exists within the account.
Returns:
-
(Types::GetPolicyEngineResponse)
—
Returns a response object which responds to the following methods:
- #policy_engine_id => String
- #name => String
- #created_at => Time
- #updated_at => Time
- #policy_engine_arn => String
- #status => String
- #encryption_key_arn => String
- #description => String
- #status_reasons => Array<String>
See Also:
9682 9683 9684 9685 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9682 def get_policy_engine(params = {}, options = {}) req = build_request(:get_policy_engine, params) req.send_request(options) end |
#get_policy_engine_summary(params = {}) ⇒ Types::GetPolicyEngineSummaryResponse
Retrieves a metadata-only summary of a specific policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and the encryption key ARN, but does not include the description or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_policy_engine_summary({
policy_engine_id: "ResourceId", # required
})
Response structure
Response structure
resp.policy_engine_id #=> String
resp.name #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.policy_engine_arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.encryption_key_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_engine_id
(required, String)
—
The unique identifier of the policy engine to retrieve the summary for. This must be a valid policy engine ID that exists within the account.
Returns:
-
(Types::GetPolicyEngineSummaryResponse)
—
Returns a response object which responds to the following methods:
- #policy_engine_id => String
- #name => String
- #created_at => Time
- #updated_at => Time
- #policy_engine_arn => String
- #status => String
- #encryption_key_arn => String
See Also:
9730 9731 9732 9733 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9730 def get_policy_engine_summary(params = {}, options = {}) req = build_request(:get_policy_engine_summary, params) req.send_request(options) end |
#get_policy_generation(params = {}) ⇒ Types::GetPolicyGenerationResponse
Retrieves information about a policy generation request within the AgentCore Policy system. Policy generation converts natural language descriptions into Dogwood policy statements using AI-powered translation, enabling non-technical users to create policies.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- policy_generation_completed
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_policy_generation({
policy_generation_id: "ResourceId", # required
policy_engine_id: "ResourceId", # required
})
Response structure
Response structure
resp.policy_engine_id #=> String
resp.policy_generation_id #=> String
resp.name #=> String
resp.policy_generation_arn #=> String
resp.resource.arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status #=> String, one of "GENERATING", "GENERATED", "GENERATE_FAILED", "DELETE_FAILED"
resp.findings #=> String
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_generation_id
(required, String)
—
The unique identifier of the policy generation request to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call.
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and schema validation.
Returns:
-
(Types::GetPolicyGenerationResponse)
—
Returns a response object which responds to the following methods:
- #policy_engine_id => String
- #policy_generation_id => String
- #name => String
- #policy_generation_arn => String
- #resource => Types::Resource
- #created_at => Time
- #updated_at => Time
- #status => String
- #findings => String
- #status_reasons => Array<String>
See Also:
9797 9798 9799 9800 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9797 def get_policy_generation(params = {}, options = {}) req = build_request(:get_policy_generation, params) req.send_request(options) end |
#get_policy_generation_summary(params = {}) ⇒ Types::GetPolicyGenerationSummaryResponse
Retrieves a metadata-only summary of a specific policy generation request without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings, but does not include status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_policy_generation_summary({
policy_generation_id: "ResourceId", # required
policy_engine_id: "ResourceId", # required
})
Response structure
Response structure
resp.policy_engine_id #=> String
resp.policy_generation_id #=> String
resp.name #=> String
resp.policy_generation_arn #=> String
resp.resource.arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status #=> String, one of "GENERATING", "GENERATED", "GENERATE_FAILED", "DELETE_FAILED"
resp.findings #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_generation_id
(required, String)
—
The unique identifier of the policy generation request to retrieve the summary for.
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine associated with the policy generation request.
Returns:
-
(Types::GetPolicyGenerationSummaryResponse)
—
Returns a response object which responds to the following methods:
- #policy_engine_id => String
- #policy_generation_id => String
- #name => String
- #policy_generation_arn => String
- #resource => Types::Resource
- #created_at => Time
- #updated_at => Time
- #status => String
- #findings => String
See Also:
9853 9854 9855 9856 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9853 def get_policy_generation_summary(params = {}, options = {}) req = build_request(:get_policy_generation_summary, params) req.send_request(options) end |
#get_policy_summary(params = {}) ⇒ Types::GetPolicySummaryResponse
Retrieves a metadata-only summary of a specific policy without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps, but does not include the policy definition, description, or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_policy_summary({
policy_engine_id: "ResourceId", # required
policy_id: "ResourceId", # required
})
Response structure
Response structure
resp.policy_id #=> String
resp.name #=> String
resp.policy_engine_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.policy_arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.enforcement_mode #=> String, one of "ACTIVE", "LOG_ONLY"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine that manages the policy to retrieve the summary for.
-
:policy_id
(required, String)
—
The unique identifier of the policy to retrieve the summary for. This must be a valid policy ID that exists within the specified policy engine.
Returns:
-
(Types::GetPolicySummaryResponse)
—
Returns a response object which responds to the following methods:
- #policy_id => String
- #name => String
- #policy_engine_id => String
- #created_at => Time
- #updated_at => Time
- #policy_arn => String
- #status => String
- #enforcement_mode => String
See Also:
9908 9909 9910 9911 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 9908 def get_policy_summary(params = {}, options = {}) req = build_request(:get_policy_summary, params) req.send_request(options) end |
#get_registry(params = {}) ⇒ Types::GetRegistryResponse
Retrieves information about a specific registry.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_registry({
registry_id: "RegistryIdentifier", # required
})
Response structure
Response structure
resp.name #=> String
resp.description #=> String
resp.registry_id #=> String
resp.registry_arn #=> String
resp.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM"
resp.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.approval_configuration.auto_approval #=> Boolean
resp.status #=> String, one of "CREATING", "READY", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.status_reason #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:registry_id
(required, String)
—
The identifier of the registry to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
Returns:
-
(Types::GetRegistryResponse)
—
Returns a response object which responds to the following methods:
- #name => String
- #description => String
- #registry_id => String
- #registry_arn => String
- #authorizer_type => String
- #authorizer_configuration => Types::AuthorizerConfiguration
- #approval_configuration => Types::ApprovalConfiguration
- #status => String
- #status_reason => String
- #created_at => Time
- #updated_at => Time
See Also:
10002 10003 10004 10005 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10002 def get_registry(params = {}, options = {}) req = build_request(:get_registry, params) req.send_request(options) end |
#get_registry_record(params = {}) ⇒ Types::GetRegistryRecordResponse
Retrieves information about a specific registry record.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_registry_record({
registry_id: "RegistryIdentifier", # required
record_id: "RecordIdentifier", # required
})
Response structure
Response structure
resp.registry_arn #=> String
resp.record_arn #=> String
resp.record_id #=> String
resp.name #=> String
resp.description #=> String
resp.descriptor_type #=> String, one of "MCP", "A2A", "CUSTOM", "AGENT_SKILLS"
resp.descriptors.mcp.server.schema_version #=> String
resp.descriptors.mcp.server.inline_content #=> String
resp.descriptors.mcp.tools.protocol_version #=> String
resp.descriptors.mcp.tools.inline_content #=> String
resp.descriptors.a2a.agent_card.schema_version #=> String
resp.descriptors.a2a.agent_card.inline_content #=> String
resp.descriptors.custom.inline_content #=> String
resp.descriptors.agent_skills.skill_md.inline_content #=> String
resp.descriptors.agent_skills.skill_definition.schema_version #=> String
resp.descriptors.agent_skills.skill_definition.inline_content #=> String
resp.record_version #=> String
resp.status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status_reason #=> String
resp.synchronization_type #=> String, one of "URL"
resp.synchronization_configuration.from_url.url #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations #=> Array
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider_type #=> String, one of "OAUTH", "IAM"
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS"
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["String"] #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.role_arn #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:registry_id
(required, String)
—
The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
-
:record_id
(required, String)
—
The identifier of the registry record to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
Returns:
-
(Types::GetRegistryRecordResponse)
—
Returns a response object which responds to the following methods:
- #registry_arn => String
- #record_arn => String
- #record_id => String
- #name => String
- #description => String
- #descriptor_type => String
- #descriptors => Types::Descriptors
- #record_version => String
- #status => String
- #created_at => Time
- #updated_at => Time
- #status_reason => String
- #synchronization_type => String
- #synchronization_configuration => Types::SynchronizationConfiguration
See Also:
10082 10083 10084 10085 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10082 def get_registry_record(params = {}, options = {}) req = build_request(:get_registry_record, params) req.send_request(options) end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves the resource-based policy for a specified resource.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_resource_policy({
resource_arn: "BedrockAgentcoreResourceArn", # required
})
Response structure
Response structure
resp.policy #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource for which to retrieve the resource policy.
Returns:
See Also:
10116 10117 10118 10119 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10116 def get_resource_policy(params = {}, options = {}) req = build_request(:get_resource_policy, params) req.send_request(options) end |
#get_token_vault(params = {}) ⇒ Types::GetTokenVaultResponse
Retrieves information about a token vault.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_token_vault({
token_vault_id: "TokenVaultIdType",
})
Response structure
Response structure
resp.token_vault_id #=> String
resp.kms_configuration.key_type #=> String, one of "CustomerManagedKey", "ServiceManagedKey"
resp.kms_configuration.kms_key_arn #=> String
resp.last_modified_date #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:token_vault_id
(String)
—
The unique identifier of the token vault to retrieve.
Returns:
-
(Types::GetTokenVaultResponse)
—
Returns a response object which responds to the following methods:
- #token_vault_id => String
- #kms_configuration => Types::KmsConfiguration
- #last_modified_date => Time
See Also:
10149 10150 10151 10152 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10149 def get_token_vault(params = {}, options = {}) req = build_request(:get_token_vault, params) req.send_request(options) end |
#get_workload_identity(params = {}) ⇒ Types::GetWorkloadIdentityResponse
Retrieves information about a workload identity.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_workload_identity({
name: "WorkloadIdentityNameType", # required
})
Response structure
Response structure
resp.name #=> String
resp.workload_identity_arn #=> String
resp.allowed_resource_oauth_2_return_urls #=> Array
resp.allowed_resource_oauth_2_return_urls[0] #=> String
resp.created_time #=> Time
resp.last_updated_time #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the workload identity to retrieve.
Returns:
-
(Types::GetWorkloadIdentityResponse)
—
Returns a response object which responds to the following methods:
- #name => String
- #workload_identity_arn => String
- #allowed_resource_oauth_2_return_urls => Array<String>
- #created_time => Time
- #last_updated_time => Time
See Also:
10186 10187 10188 10189 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10186 def get_workload_identity(params = {}, options = {}) req = build_request(:get_workload_identity, params) req.send_request(options) end |
#list_agent_insight_stores(params = {}) ⇒ Types::ListAgentInsightStoresResponse
Lists the account's service-defined default Agent Insight Store. The singleton backing state may be initialized on first access.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_agent_insight_stores({
next_token: "ListAgentInsightStoresRequestNextTokenString",
max_results: 1,
})
Response structure
Response structure
resp.agent_insight_stores #=> Array
resp.agent_insight_stores[0].agent_insight_store_arn #=> String
resp.agent_insight_stores[0].agent_insight_store_id #=> String
resp.agent_insight_stores[0].status #=> String, one of "ACTIVE", "UPDATING", "INACTIVE", "ERROR"
resp.agent_insight_stores[0].enablement_status #=> String, one of "ENABLED", "DISABLED"
resp.agent_insight_stores[0].encryption_configuration.mode #=> String, one of "AWS_OWNED_KMS_KEY", "CUSTOMER_MANAGED_KMS"
resp.agent_insight_stores[0].encryption_configuration.kms_key_arn #=> String
resp.agent_insight_stores[0].created_at #=> Time
resp.agent_insight_stores[0].updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results. -
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.
Returns:
-
(Types::ListAgentInsightStoresResponse)
—
Returns a response object which responds to the following methods:
- #agent_insight_stores => Array<Types::AgentInsightStoreSummary>
- #next_token => String
See Also:
10237 10238 10239 10240 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10237 def list_agent_insight_stores(params = {}, options = {}) req = build_request(:list_agent_insight_stores, params) req.send_request(options) 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_agent_runtime_endpoints({
agent_runtime_id: "AgentRuntimeId", # required
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.runtime_endpoints #=> Array
resp.runtime_endpoints[0].name #=> String
resp.runtime_endpoints[0].live_version #=> String
resp.runtime_endpoints[0].target_version #=> String
resp.runtime_endpoints[0].agent_runtime_endpoint_arn #=> String
resp.runtime_endpoints[0].agent_runtime_arn #=> String
resp.runtime_endpoints[0].status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.runtime_endpoints[0].id #=> String
resp.runtime_endpoints[0].description #=> String
resp.runtime_endpoints[0].created_at #=> Time
resp.runtime_endpoints[0].last_updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_runtime_id
(required, String)
—
The unique identifier of the AgentCore Runtime to list endpoints for.
-
:max_results
(Integer)
—
The maximum number of results to return in the response.
-
:next_token
(String)
—
A token to retrieve the next page of results.
Returns:
-
(Types::ListAgentRuntimeEndpointsResponse)
—
Returns a response object which responds to the following methods:
- #runtime_endpoints => Array<Types::AgentRuntimeEndpoint>
- #next_token => String
See Also:
10287 10288 10289 10290 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10287 def list_agent_runtime_endpoints(params = {}, options = {}) req = build_request(:list_agent_runtime_endpoints, params) req.send_request(options) 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_agent_runtime_versions({
agent_runtime_id: "AgentRuntimeId", # required
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.agent_runtimes #=> Array
resp.agent_runtimes[0].agent_runtime_arn #=> String
resp.agent_runtimes[0].agent_runtime_id #=> String
resp.agent_runtimes[0].agent_runtime_version #=> String
resp.agent_runtimes[0].agent_runtime_name #=> String
resp.agent_runtimes[0].description #=> String
resp.agent_runtimes[0].last_updated_at #=> Time
resp.agent_runtimes[0].status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_runtime_id
(required, String)
—
The unique identifier of the AgentCore Runtime to list versions for.
-
:max_results
(Integer)
—
The maximum number of results to return in the response.
-
:next_token
(String)
—
A token to retrieve the next page of results.
Returns:
-
(Types::ListAgentRuntimeVersionsResponse)
—
Returns a response object which responds to the following methods:
- #agent_runtimes => Array<Types::AgentRuntime>
- #next_token => String
See Also:
10334 10335 10336 10337 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10334 def list_agent_runtime_versions(params = {}, options = {}) req = build_request(:list_agent_runtime_versions, params) req.send_request(options) end |
#list_agent_runtime_versions_by_capacity_provider(params = {}) ⇒ Types::ListAgentRuntimeVersionsByCapacityProviderOutput
Lists the agent runtime versions that are associated with a capacity
provider. Use this operation to identify the runtimes you must
disassociate before you can delete the capacity provider. Results are
paginated; use the nextToken parameter to retrieve additional
results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_agent_runtime_versions_by_capacity_provider({
capacity_provider_id: "CapacityProviderId", # required
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.agent_runtimes #=> Array
resp.agent_runtimes[0].agent_runtime_arn #=> String
resp.agent_runtimes[0].agent_runtime_version #=> String
resp.agent_runtimes[0].status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:capacity_provider_id
(required, String)
—
The unique identifier of the capacity provider.
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
Returns:
-
(Types::ListAgentRuntimeVersionsByCapacityProviderOutput)
—
Returns a response object which responds to the following methods:
- #agent_runtimes => Array<Types::AgentRuntimeVersionSummary>
- #next_token => String
See Also:
10387 10388 10389 10390 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10387 def list_agent_runtime_versions_by_capacity_provider(params = {}, options = {}) req = build_request(:list_agent_runtime_versions_by_capacity_provider, params) req.send_request(options) 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_agent_runtimes({
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.agent_runtimes #=> Array
resp.agent_runtimes[0].agent_runtime_arn #=> String
resp.agent_runtimes[0].agent_runtime_id #=> String
resp.agent_runtimes[0].agent_runtime_version #=> String
resp.agent_runtimes[0].agent_runtime_name #=> String
resp.agent_runtimes[0].description #=> String
resp.agent_runtimes[0].last_updated_at #=> Time
resp.agent_runtimes[0].status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in the response.
-
:next_token
(String)
—
A token to retrieve the next page of results.
Returns:
-
(Types::ListAgentRuntimesResponse)
—
Returns a response object which responds to the following methods:
- #agent_runtimes => Array<Types::AgentRuntime>
- #next_token => String
See Also:
10430 10431 10432 10433 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10430 def list_agent_runtimes(params = {}, options = {}) req = build_request(:list_agent_runtimes, params) req.send_request(options) 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_api_key_credential_providers({
next_token: "String",
max_results: 1,
})
Response structure
Response structure
resp.credential_providers #=> Array
resp.credential_providers[0].name #=> String
resp.credential_providers[0].credential_provider_arn #=> String
resp.credential_providers[0].created_time #=> Time
resp.credential_providers[0].last_updated_time #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
Pagination token.
-
:max_results
(Integer)
—
Maximum number of results to return.
Returns:
-
(Types::ListApiKeyCredentialProvidersResponse)
—
Returns a response object which responds to the following methods:
- #credential_providers => Array<Types::ApiKeyCredentialProviderItem>
- #next_token => String
See Also:
10470 10471 10472 10473 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10470 def list_api_key_credential_providers(params = {}, options = {}) req = build_request(:list_api_key_credential_providers, params) req.send_request(options) end |
#list_browser_profiles(params = {}) ⇒ Types::ListBrowserProfilesResponse
Lists all browser profiles in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_browser_profiles({
max_results: 1,
next_token: "NextToken",
name: "BrowserProfileName",
})
Response structure
Response structure
resp.profile_summaries #=> Array
resp.profile_summaries[0].profile_id #=> String
resp.profile_summaries[0].profile_arn #=> String
resp.profile_summaries[0].name #=> String
resp.profile_summaries[0].description #=> String
resp.profile_summaries[0].status #=> String, one of "READY", "DELETING", "DELETED", "SAVING"
resp.profile_summaries[0].created_at #=> Time
resp.profile_summaries[0].last_updated_at #=> Time
resp.profile_summaries[0].last_saved_at #=> Time
resp.profile_summaries[0].last_saved_browser_session_id #=> String
resp.profile_summaries[0].last_saved_browser_id #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in the response.
-
:next_token
(String)
—
A token to retrieve the next page of results.
-
:name
(String)
—
The name of the browser profile to filter results by.
Returns:
-
(Types::ListBrowserProfilesResponse)
—
Returns a response object which responds to the following methods:
- #profile_summaries => Array<Types::BrowserProfileSummary>
- #next_token => String
See Also:
10520 10521 10522 10523 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10520 def list_browser_profiles(params = {}, options = {}) req = build_request(:list_browser_profiles, params) req.send_request(options) 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_browsers({
max_results: 1,
next_token: "NextToken",
type: "SYSTEM", # accepts SYSTEM, CUSTOM
})
Response structure
Response structure
resp.browser_summaries #=> Array
resp.browser_summaries[0].browser_id #=> String
resp.browser_summaries[0].browser_arn #=> String
resp.browser_summaries[0].name #=> String
resp.browser_summaries[0].description #=> String
resp.browser_summaries[0].status #=> String, one of "CREATING", "CREATE_FAILED", "READY", "DELETING", "DELETE_FAILED", "DELETED"
resp.browser_summaries[0].created_at #=> Time
resp.browser_summaries[0].last_updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.
-
:next_token
(String)
—
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
-
:type
(String)
—
The type of browsers to list. If not specified, all browser types are returned.
Returns:
-
(Types::ListBrowsersResponse)
—
Returns a response object which responds to the following methods:
- #browser_summaries => Array<Types::BrowserSummary>
- #next_token => String
See Also:
10571 10572 10573 10574 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10571 def list_browsers(params = {}, options = {}) req = build_request(:list_browsers, params) req.send_request(options) end |
#list_capacity_providers(params = {}) ⇒ Types::ListCapacityProvidersOutput
Lists the capacity providers in your account and returns summary
information for each one. To retrieve the full configuration for a
specific capacity provider, use GetCapacityProvider. Results are
paginated; use the nextToken parameter to retrieve additional
results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_capacity_providers({
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.capacity_providers #=> Array
resp.capacity_providers[0].capacity_provider_id #=> String
resp.capacity_providers[0].capacity_provider_arn #=> String
resp.capacity_providers[0].name #=> String
resp.capacity_providers[0].status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.capacity_providers[0].last_updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
Returns:
-
(Types::ListCapacityProvidersOutput)
—
Returns a response object which responds to the following methods:
- #capacity_providers => Array<Types::CapacityProviderSummary>
- #next_token => String
See Also:
10622 10623 10624 10625 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10622 def list_capacity_providers(params = {}, options = {}) req = build_request(:list_capacity_providers, params) req.send_request(options) 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_code_interpreters({
max_results: 1,
next_token: "NextToken",
type: "SYSTEM", # accepts SYSTEM, CUSTOM
})
Response structure
Response structure
resp.code_interpreter_summaries #=> Array
resp.code_interpreter_summaries[0].code_interpreter_id #=> String
resp.code_interpreter_summaries[0].code_interpreter_arn #=> String
resp.code_interpreter_summaries[0].name #=> String
resp.code_interpreter_summaries[0].description #=> String
resp.code_interpreter_summaries[0].status #=> String, one of "CREATING", "CREATE_FAILED", "READY", "DELETING", "DELETE_FAILED", "DELETED"
resp.code_interpreter_summaries[0].created_at #=> Time
resp.code_interpreter_summaries[0].last_updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in the response.
-
:next_token
(String)
—
A token to retrieve the next page of results.
-
:type
(String)
—
The type of code interpreters to list.
Returns:
-
(Types::ListCodeInterpretersResponse)
—
Returns a response object which responds to the following methods:
- #code_interpreter_summaries => Array<Types::CodeInterpreterSummary>
- #next_token => String
See Also:
10669 10670 10671 10672 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10669 def list_code_interpreters(params = {}, options = {}) req = build_request(:list_code_interpreters, params) req.send_request(options) end |
#list_configuration_bundle_versions(params = {}) ⇒ Types::ListConfigurationBundleVersionsResponse
Lists all versions of a configuration bundle, with optional filtering by branch name or creation source.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_configuration_bundle_versions({
bundle_id: "ConfigurationBundleId", # required
next_token: "String",
max_results: 1,
filter: {
branch_name: "BranchName",
created_by_name: "String",
latest_per_branch: false,
},
})
Response structure
Response structure
resp.versions #=> Array
resp.versions[0].bundle_arn #=> String
resp.versions[0].bundle_id #=> String
resp.versions[0].version_id #=> String
resp.versions[0].lineage_metadata.parent_version_ids #=> Array
resp.versions[0].lineage_metadata.parent_version_ids[0] #=> String
resp.versions[0].lineage_metadata.branch_name #=> String
resp.versions[0].lineage_metadata.created_by.name #=> String
resp.versions[0].lineage_metadata.created_by.arn #=> String
resp.versions[0].lineage_metadata.commit_message #=> String
resp.versions[0].version_created_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:bundle_id
(required, String)
—
The unique identifier of the configuration bundle to list versions for.
-
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results. -
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:filter
(Types::VersionFilter)
—
An optional filter for listing versions, including branch name, creation source, and whether to return only the latest version per branch.
Returns:
-
(Types::ListConfigurationBundleVersionsResponse)
—
Returns a response object which responds to the following methods:
- #versions => Array<Types::ConfigurationBundleVersionSummary>
- #next_token => String
See Also:
10737 10738 10739 10740 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10737 def list_configuration_bundle_versions(params = {}, options = {}) req = build_request(:list_configuration_bundle_versions, params) req.send_request(options) end |
#list_configuration_bundles(params = {}) ⇒ Types::ListConfigurationBundlesResponse
Lists all configuration bundles in the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_configuration_bundles({
next_token: "String",
max_results: 1,
})
Response structure
Response structure
resp.bundles #=> Array
resp.bundles[0].bundle_arn #=> String
resp.bundles[0].bundle_id #=> String
resp.bundles[0].bundle_name #=> String
resp.bundles[0].description #=> String
resp.bundles[0].created_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results. -
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.
Returns:
-
(Types::ListConfigurationBundlesResponse)
—
Returns a response object which responds to the following methods:
- #bundles => Array<Types::ConfigurationBundleSummary>
- #next_token => String
See Also:
10784 10785 10786 10787 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10784 def list_configuration_bundles(params = {}, options = {}) req = build_request(:list_configuration_bundles, params) req.send_request(options) end |
#list_consent_portals(params = {}) ⇒ Types::ListConsentPortalsResponse
Lists all of the consent portals in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_consent_portals({
max_results: 1,
next_token: "String",
})
Response structure
Response structure
resp.consent_portals #=> Array
resp.consent_portals[0].sources #=> Array
resp.consent_portals[0].sources[0].identifier #=> String
resp.consent_portals[0].sources[0].type #=> String, one of "agentcore-gateway"
resp.consent_portals[0].consent_portal_arn #=> String
resp.consent_portals[0].consent_portal_id #=> String
resp.consent_portals[0].created_at #=> Time
resp.consent_portals[0].description #=> String
resp.consent_portals[0].name #=> String
resp.consent_portals[0].portal_url #=> String
resp.consent_portals[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "FAILED"
resp.consent_portals[0].updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of consent portals to return in a single call.
-
:next_token
(String)
—
A token to retrieve the next page of results. Use the value returned in a previous response to request the next page.
Returns:
-
(Types::ListConsentPortalsResponse)
—
Returns a response object which responds to the following methods:
- #consent_portals => Array<Types::ConsentPortalSummary>
- #next_token => String
See Also:
10832 10833 10834 10835 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10832 def list_consent_portals(params = {}, options = {}) req = build_request(:list_consent_portals, params) req.send_request(options) end |
#list_dataset_examples(params = {}) ⇒ Types::ListDatasetExamplesResponse
Returns paginated examples from the dataset. The server embeds the
resolved version in the pagination token. Once pagination begins, all
subsequent pages are pinned to that version regardless of concurrent
mutations. A request with a pagination token can omit
datasetVersion. If it sets a version that differs from the token's
version, the request fails with a ValidationException.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_dataset_examples({
dataset_id: "DatasetId", # required
dataset_version: "DatasetVersion",
filter: {
generation_ids: ["DatasetGenerationId"],
example_fields: [
{
any_of: ["TURNS"], # accepts TURNS, INPUT, ACTOR_PROFILE
},
],
},
max_results: 1,
next_token: "ListDatasetExamplesRequestNextTokenString",
})
Response structure
Response structure
resp.dataset_arn #=> String
resp.dataset_id #=> String
resp.dataset_version #=> String
resp.examples #=> Array
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:dataset_id
(required, String)
—
The unique identifier of the dataset.
-
:dataset_version
(String)
—
Version to paginate: "DRAFT" or a version number. Defaults to DRAFT if absent on the first request. With a pagination token, the version comes from the token: you can omit this member, and a value that differs from the token's version is rejected with a
ValidationException. -
:filter
(Types::ListDatasetExamplesFilter)
—
A filter to apply to the examples.
-
:max_results
(Integer)
—
Maximum number of examples to return per page.
-
:next_token
(String)
—
The token for the next page of results.
Returns:
-
(Types::ListDatasetExamplesResponse)
—
Returns a response object which responds to the following methods:
- #dataset_arn => String
- #dataset_id => String
- #dataset_version => String
- #examples => Array<Hash,Array,String,Numeric,Boolean>
- #next_token => String
See Also:
10902 10903 10904 10905 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10902 def list_dataset_examples(params = {}, options = {}) req = build_request(:list_dataset_examples, params) req.send_request(options) end |
#list_dataset_versions(params = {}) ⇒ Types::ListDatasetVersionsResponse
Lists all published versions of a dataset, sorted by version number descending (newest first). Does not include the DRAFT working copy.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_dataset_versions({
dataset_id: "DatasetId", # required
filter: {
example_count_by_field: [
{
any_of: ["TURNS"], # accepts TURNS, INPUT, ACTOR_PROFILE
min: 1,
max: 1,
},
],
},
next_token: "ListDatasetVersionsRequestNextTokenString",
max_results: 1,
})
Response structure
Response structure
resp.versions #=> Array
resp.versions[0].dataset_version #=> String
resp.versions[0].example_count #=> Integer
resp.versions[0].example_count_by_field.turns #=> Integer
resp.versions[0].example_count_by_field.input #=> Integer
resp.versions[0].example_count_by_field.actor_profile #=> Integer
resp.versions[0].created_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:dataset_id
(required, String)
—
The unique identifier of the dataset.
-
:filter
(Types::ListDatasetVersionsFilter)
—
A filter to apply to the dataset versions.
-
:next_token
(String)
—
The token for the next page of results.
-
:max_results
(Integer)
—
The maximum number of versions to return per page.
Returns:
-
(Types::ListDatasetVersionsResponse)
—
Returns a response object which responds to the following methods:
- #versions => Array<Types::DatasetVersionSummary>
- #next_token => String
See Also:
10961 10962 10963 10964 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 10961 def list_dataset_versions(params = {}, options = {}) req = build_request(:list_dataset_versions, params) req.send_request(options) end |
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Lists all datasets in the caller's account, paginated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_datasets({
filter: {
example_count_by_field: [
{
any_of: ["TURNS"], # accepts TURNS, INPUT, ACTOR_PROFILE
min: 1,
max: 1,
},
],
},
next_token: "ListDatasetsRequestNextTokenString",
max_results: 1,
})
Response structure
Response structure
resp.datasets #=> Array
resp.datasets[0].dataset_arn #=> String
resp.datasets[0].dataset_id #=> String
resp.datasets[0].dataset_name #=> String
resp.datasets[0].description #=> String
resp.datasets[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.datasets[0].draft_status #=> String, one of "MODIFIED", "UNMODIFIED"
resp.datasets[0].schema_type #=> String, one of "AGENTCORE_EVALUATION_PREDEFINED_V1", "AGENTCORE_EVALUATION_SIMULATED_V1", "THIRD_PARTY_EVALUATION_V1"
resp.datasets[0].example_count #=> Integer
resp.datasets[0].example_count_by_field.turns #=> Integer
resp.datasets[0].example_count_by_field.input #=> Integer
resp.datasets[0].example_count_by_field.actor_profile #=> Integer
resp.datasets[0].created_at #=> Time
resp.datasets[0].updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:filter
(Types::ListDatasetsFilter)
—
A filter to apply to the datasets.
-
:next_token
(String)
—
The token for the next page of results.
-
:max_results
(Integer)
—
The maximum number of datasets to return per page.
Returns:
-
(Types::ListDatasetsResponse)
—
Returns a response object which responds to the following methods:
- #datasets => Array<Types::DatasetSummary>
- #next_token => String
See Also:
11022 11023 11024 11025 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11022 def list_datasets(params = {}, options = {}) req = build_request(:list_datasets, params) req.send_request(options) end |
#list_evaluators(params = {}) ⇒ Types::ListEvaluatorsResponse
Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_evaluators({
next_token: "String",
max_results: 1,
})
Response structure
Response structure
resp.evaluators #=> Array
resp.evaluators[0].evaluator_arn #=> String
resp.evaluators[0].evaluator_id #=> String
resp.evaluators[0].evaluator_name #=> String
resp.evaluators[0].description #=> String
resp.evaluators[0].evaluator_type #=> String, one of "Builtin", "ThirdParty", "Custom", "CustomCode", "CustomDerived"
resp.evaluators[0].provider #=> String, one of "AWS", "DeepEval", "AutoEval", "Custom"
resp.evaluators[0].level #=> String, one of "TOOL_CALL", "TRACE", "SESSION"
resp.evaluators[0].status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING"
resp.evaluators[0].created_at #=> Time
resp.evaluators[0].updated_at #=> Time
resp.evaluators[0].locked_for_modification #=> Boolean
resp.evaluators[0].kms_key_arn #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
The pagination token from a previous request to retrieve the next page of results.
-
:max_results
(Integer)
—
The maximum number of evaluators to return in a single response.
Returns:
-
(Types::ListEvaluatorsResponse)
—
Returns a response object which responds to the following methods:
- #evaluators => Array<Types::EvaluatorSummary>
- #next_token => String
See Also:
11072 11073 11074 11075 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11072 def list_evaluators(params = {}, options = {}) req = build_request(:list_evaluators, params) req.send_request(options) end |
#list_gateway_rate_limits(params = {}) ⇒ Types::ListGatewayRateLimitsResponse
Lists all rate limits for a gateway. Results are paginated. Use the
nextToken parameter to retrieve additional results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_gateway_rate_limits({
gateway_identifier: "GatewayIdentifier", # required
max_results: 1,
next_token: "GatewayRateLimitNextToken",
})
Response structure
Response structure
resp.rate_limits #=> Array
resp.rate_limits[0].rate_limit_id #=> String
resp.rate_limits[0].gateway_identifier #=> String
resp.rate_limits[0].description #=> String
resp.rate_limits[0].dimension_keys #=> Array
resp.rate_limits[0].dimension_keys[0] #=> String
resp.rate_limits[0].entries #=> Array
resp.rate_limits[0].entries[0].dimensions #=> Hash
resp.rate_limits[0].entries[0].dimensions["DimensionKey"] #=> String
resp.rate_limits[0].entries[0].requests #=> Array
resp.rate_limits[0].entries[0].requests[0].rate #=> Float
resp.rate_limits[0].entries[0].requests[0].period #=> String, one of "second", "minute"
resp.rate_limits[0].entries[0].tokens #=> Array
resp.rate_limits[0].entries[0].tokens[0].rate #=> Float
resp.rate_limits[0].entries[0].tokens[0].period #=> String, one of "second", "minute"
resp.rate_limits[0].entries[0].connections #=> Array
resp.rate_limits[0].entries[0].connections[0].rate #=> Float
resp.rate_limits[0].entries[0].connections[0].period #=> String, one of "second", "minute"
resp.rate_limits[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.rate_limits[0].created_at #=> Time
resp.rate_limits[0].updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The unique identifier of the gateway.
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:next_token
(String)
—
The token to use to retrieve the next page of results. Use the value returned in a previous
ListGatewayRateLimitsresponse.
Returns:
-
(Types::ListGatewayRateLimitsResponse)
—
Returns a response object which responds to the following methods:
- #rate_limits => Array<Types::GatewayRateLimitDetail>
- #next_token => String
See Also:
11137 11138 11139 11140 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11137 def list_gateway_rate_limits(params = {}, options = {}) req = build_request(:list_gateway_rate_limits, params) req.send_request(options) end |
#list_gateway_rules(params = {}) ⇒ Types::ListGatewayRulesResponse
Lists all rules for a gateway.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_gateway_rules({
gateway_identifier: "GatewayIdentifier", # required
max_results: 1,
next_token: "GatewayRuleNextToken",
})
Response structure
Response structure
resp.gateway_rules #=> Array
resp.gateway_rules[0].rule_id #=> String
resp.gateway_rules[0].gateway_arn #=> String
resp.gateway_rules[0].priority #=> Integer
resp.gateway_rules[0].conditions #=> Array
resp.gateway_rules[0].conditions[0].match_principals.any_of #=> Array
resp.gateway_rules[0].conditions[0].match_principals.any_of[0].iam_principal.arn #=> String
resp.gateway_rules[0].conditions[0].match_principals.any_of[0].iam_principal.operator #=> String, one of "StringEquals", "StringLike"
resp.gateway_rules[0].conditions[0].match_paths.any_of #=> Array
resp.gateway_rules[0].conditions[0].match_paths.any_of[0] #=> String
resp.gateway_rules[0].conditions[0].match_models.any_of #=> Array
resp.gateway_rules[0].conditions[0].match_models.any_of[0].value #=> String
resp.gateway_rules[0].conditions[0].match_models.any_of[0].operator #=> String, one of "StringEquals", "StringLike"
resp.gateway_rules[0].actions #=> Array
resp.gateway_rules[0].actions[0].configuration_bundle.static_override.bundle_arn #=> String
resp.gateway_rules[0].actions[0].configuration_bundle.static_override.bundle_version #=> String
resp.gateway_rules[0].actions[0].configuration_bundle.weighted_override.traffic_split #=> Array
resp.gateway_rules[0].actions[0].configuration_bundle.weighted_override.traffic_split[0].name #=> String
resp.gateway_rules[0].actions[0].configuration_bundle.weighted_override.traffic_split[0].weight #=> Integer
resp.gateway_rules[0].actions[0].configuration_bundle.weighted_override.traffic_split[0].configuration_bundle.bundle_arn #=> String
resp.gateway_rules[0].actions[0].configuration_bundle.weighted_override.traffic_split[0].configuration_bundle.bundle_version #=> String
resp.gateway_rules[0].actions[0].configuration_bundle.weighted_override.traffic_split[0].description #=> String
resp.gateway_rules[0].actions[0].configuration_bundle.weighted_override.traffic_split[0].metadata #=> Hash
resp.gateway_rules[0].actions[0].configuration_bundle.weighted_override.traffic_split[0].metadata["TrafficSplitMetadataKey"] #=> String
resp.gateway_rules[0].actions[0].route_to_target.static_route.target_name #=> String
resp.gateway_rules[0].actions[0].route_to_target.static_route.model #=> String
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.trigger_on.status_codes #=> Array
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.trigger_on.status_codes[0] #=> String
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.trigger_on.errors #=> Array
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.first_byte_timeout_milliseconds #=> Integer
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.circuit_breaker.mode #=> String, one of "ENABLED", "DISABLED"
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.target_fallback #=> Array
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.target_fallback[0].target_name #=> String
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.target_fallback[0].model #=> String
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.status_codes #=> Array
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.status_codes[0] #=> String
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.errors #=> Array
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.gateway_rules[0].actions[0].route_to_target.static_route.fallback.target_fallback[0].first_byte_timeout_milliseconds #=> Integer
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split #=> Array
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].target_name #=> String
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].model #=> String
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.status_codes #=> Array
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.status_codes[0] #=> String
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.errors #=> Array
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.first_byte_timeout_milliseconds #=> Integer
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.circuit_breaker.mode #=> String, one of "ENABLED", "DISABLED"
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback #=> Array
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].target_name #=> String
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].model #=> String
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.status_codes #=> Array
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.status_codes[0] #=> String
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.errors #=> Array
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].first_byte_timeout_milliseconds #=> Integer
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].name #=> String
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].weight #=> Integer
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].description #=> String
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].metadata #=> Hash
resp.gateway_rules[0].actions[0].route_to_target.weighted_route.traffic_split[0].metadata["TrafficSplitMetadataKey"] #=> String
resp.gateway_rules[0].description #=> String
resp.gateway_rules[0].created_at #=> Time
resp.gateway_rules[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.gateway_rules[0].system.managed_by #=> String
resp.gateway_rules[0].updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway to list rules for.
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:next_token
(String)
—
The pagination token from a previous request.
Returns:
-
(Types::ListGatewayRulesResponse)
—
Returns a response object which responds to the following methods:
- #gateway_rules => Array<Types::GatewayRuleDetail>
- #next_token => String
See Also:
11246 11247 11248 11249 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11246 def list_gateway_rules(params = {}, options = {}) req = build_request(:list_gateway_rules, params) req.send_request(options) 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_gateway_targets({
gateway_identifier: "GatewayIdentifier", # required
max_results: 1,
next_token: "TargetNextToken",
})
Response structure
Response structure
resp.items #=> Array
resp.items[0].target_id #=> String
resp.items[0].name #=> String
resp.items[0].status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED", "SYNCHRONIZING", "SYNCHRONIZE_UNSUCCESSFUL", "CREATE_PENDING_AUTH", "UPDATE_PENDING_AUTH", "SYNCHRONIZE_PENDING_AUTH"
resp.items[0].description #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].resource_priority #=> Integer
resp.items[0].last_synchronized_at #=> Time
resp.items[0].authorization_data.oauth2.authorization_url #=> String
resp.items[0].authorization_data.oauth2.user_id #=> String
resp.items[0].target_type #=> String, one of "OPEN_API_SCHEMA", "SMITHY_MODEL", "MCP_SERVER", "LAMBDA", "API_GATEWAY", "CONNECTOR", "AGENTCORE_RUNTIME", "PASSTHROUGH", "PROVIDER", "HTTP_CONNECTOR"
resp.items[0].listing_mode #=> String, one of "DEFAULT", "DYNAMIC"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway to list targets for.
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
Returns:
-
(Types::ListGatewayTargetsResponse)
—
Returns a response object which responds to the following methods:
- #items => Array<Types::TargetSummary>
- #next_token => String
See Also:
11304 11305 11306 11307 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11304 def list_gateway_targets(params = {}, options = {}) req = build_request(:list_gateway_targets, params) req.send_request(options) 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_gateways({
max_results: 1,
next_token: "GatewayNextToken",
})
Response structure
Response structure
resp.items #=> Array
resp.items[0].gateway_id #=> String
resp.items[0].name #=> String
resp.items[0].status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED"
resp.items[0].description #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM", "NONE", "AUTHENTICATE_ONLY"
resp.items[0].protocol_type #=> String, one of "MCP"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
Returns:
-
(Types::ListGatewaysResponse)
—
Returns a response object which responds to the following methods:
- #items => Array<Types::GatewaySummary>
- #next_token => String
See Also:
11354 11355 11356 11357 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11354 def list_gateways(params = {}, options = {}) req = build_request(:list_gateways, params) req.send_request(options) end |
#list_harness_endpoints(params = {}) ⇒ Types::ListHarnessEndpointsResponse
Operation to list the endpoints of a harness.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_harness_endpoints({
harness_id: "HarnessId", # required
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.endpoints #=> Array
resp.endpoints[0].harness_id #=> String
resp.endpoints[0].harness_name #=> String
resp.endpoints[0].endpoint_name #=> String
resp.endpoints[0].arn #=> String
resp.endpoints[0].status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.endpoints[0].created_at #=> Time
resp.endpoints[0].updated_at #=> Time
resp.endpoints[0].live_version #=> String
resp.endpoints[0].target_version #=> String
resp.endpoints[0].description #=> String
resp.endpoints[0].failure_reason #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:harness_id
(required, String)
—
The ID of the harness whose endpoints are listed.
-
:max_results
(Integer)
—
The maximum number of results to return in a single call.
-
:next_token
(String)
—
The token for the next set of results.
Returns:
-
(Types::ListHarnessEndpointsResponse)
—
Returns a response object which responds to the following methods:
- #endpoints => Array<Types::HarnessEndpoint>
- #next_token => String
See Also:
11405 11406 11407 11408 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11405 def list_harness_endpoints(params = {}, options = {}) req = build_request(:list_harness_endpoints, params) req.send_request(options) end |
#list_harness_versions(params = {}) ⇒ Types::ListHarnessVersionsResponse
Operation to list the versions of a Harness.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_harness_versions({
harness_id: "HarnessId", # required
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.harness_versions #=> Array
resp.harness_versions[0].harness_id #=> String
resp.harness_versions[0].harness_name #=> String
resp.harness_versions[0].arn #=> String
resp.harness_versions[0].harness_version #=> String
resp.harness_versions[0].status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.harness_versions[0].created_at #=> Time
resp.harness_versions[0].updated_at #=> Time
resp.harness_versions[0].failure_reason #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:harness_id
(required, String)
—
The ID of the harness whose versions are listed.
-
:max_results
(Integer)
—
The maximum number of results to return in a single call.
-
:next_token
(String)
—
The token for the next set of results.
Returns:
-
(Types::ListHarnessVersionsResponse)
—
Returns a response object which responds to the following methods:
- #harness_versions => Array<Types::HarnessVersionSummary>
- #next_token => String
See Also:
11453 11454 11455 11456 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11453 def list_harness_versions(params = {}, options = {}) req = build_request(:list_harness_versions, params) req.send_request(options) end |
#list_harnesses(params = {}) ⇒ Types::ListHarnessesResponse
Operation to list harnesses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_harnesses({
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.harnesses #=> Array
resp.harnesses[0].harness_id #=> String
resp.harnesses[0].harness_name #=> String
resp.harnesses[0].arn #=> String
resp.harnesses[0].status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.harnesses[0].created_at #=> Time
resp.harnesses[0].updated_at #=> Time
resp.harnesses[0].harness_version #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in a single call.
-
:next_token
(String)
—
The token for the next set of results.
Returns:
-
(Types::ListHarnessesResponse)
—
Returns a response object which responds to the following methods:
- #harnesses => Array<Types::HarnessSummary>
- #next_token => String
See Also:
11496 11497 11498 11499 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11496 def list_harnesses(params = {}, options = {}) req = build_request(:list_harnesses, params) req.send_request(options) end |
#list_memories(params = {}) ⇒ Types::ListMemoriesOutput
Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_memories({
max_results: 1,
next_token: "String",
})
Response structure
Response structure
resp.memories #=> Array
resp.memories[0].arn #=> String
resp.memories[0].id #=> String
resp.memories[0].status #=> String, one of "CREATING", "ACTIVE", "FAILED", "DELETING", "UPDATING"
resp.memories[0].created_at #=> Time
resp.memories[0].updated_at #=> Time
resp.memories[0].managed_by_resource_arn #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.
-
:next_token
(String)
—
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Returns:
-
(Types::ListMemoriesOutput)
—
Returns a response object which responds to the following methods:
- #memories => Array<Types::MemorySummary>
- #next_token => String
See Also:
11542 11543 11544 11545 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11542 def list_memories(params = {}, options = {}) req = build_request(:list_memories, params) req.send_request(options) 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_oauth_2_credential_providers({
next_token: "String",
max_results: 1,
})
Response structure
Response structure
resp.credential_providers #=> Array
resp.credential_providers[0].name #=> String
resp.credential_providers[0].credential_provider_vendor #=> String, one of "GoogleOauth2", "GithubOauth2", "SlackOauth2", "SalesforceOauth2", "MicrosoftOauth2", "CustomOauth2", "AtlassianOauth2", "LinkedinOauth2", "XOauth2", "OktaOauth2", "OneLoginOauth2", "PingOneOauth2", "FacebookOauth2", "YandexOauth2", "RedditOauth2", "ZoomOauth2", "TwitchOauth2", "SpotifyOauth2", "DropboxOauth2", "NotionOauth2", "HubspotOauth2", "CyberArkOauth2", "FusionAuthOauth2", "Auth0Oauth2", "CognitoOauth2"
resp.credential_providers[0].credential_provider_arn #=> String
resp.credential_providers[0].created_time #=> Time
resp.credential_providers[0].last_updated_time #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
Pagination token.
-
:max_results
(Integer)
—
Maximum number of results to return.
Returns:
-
(Types::ListOauth2CredentialProvidersResponse)
—
Returns a response object which responds to the following methods:
- #credential_providers => Array<Types::Oauth2CredentialProviderItem>
- #next_token => String
See Also:
11583 11584 11585 11586 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11583 def list_oauth_2_credential_providers(params = {}, options = {}) req = build_request(:list_oauth_2_credential_providers, params) req.send_request(options) end |
#list_online_evaluation_configs(params = {}) ⇒ Types::ListOnlineEvaluationConfigsResponse
Lists all online evaluation configurations in the account, providing summary information about each configuration's status and settings.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_online_evaluation_configs({
next_token: "String",
max_results: 1,
})
Response structure
Response structure
resp.online_evaluation_configs #=> Array
resp.online_evaluation_configs[0].online_evaluation_config_arn #=> String
resp.online_evaluation_configs[0].online_evaluation_config_id #=> String
resp.online_evaluation_configs[0].online_evaluation_config_name #=> String
resp.online_evaluation_configs[0].description #=> String
resp.online_evaluation_configs[0].status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "ERROR"
resp.online_evaluation_configs[0].execution_status #=> String, one of "ENABLED", "DISABLED"
resp.online_evaluation_configs[0].created_at #=> Time
resp.online_evaluation_configs[0].updated_at #=> Time
resp.online_evaluation_configs[0].failure_reason #=> String
resp.online_evaluation_configs[0].insights #=> Array
resp.online_evaluation_configs[0].insights[0].insight_id #=> String
resp.online_evaluation_configs[0].clustering_config.frequencies #=> Array
resp.online_evaluation_configs[0].clustering_config.frequencies[0] #=> String, one of "DAILY", "WEEKLY", "MONTHLY"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
The pagination token from a previous request to retrieve the next page of results.
-
:max_results
(Integer)
—
The maximum number of online evaluation configurations to return in a single response.
Returns:
-
(Types::ListOnlineEvaluationConfigsResponse)
—
Returns a response object which responds to the following methods:
- #online_evaluation_configs => Array<Types::OnlineEvaluationConfigSummary>
- #next_token => String
See Also:
11635 11636 11637 11638 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11635 def list_online_evaluation_configs(params = {}, options = {}) req = build_request(:list_online_evaluation_configs, params) req.send_request(options) end |
#list_payment_connectors(params = {}) ⇒ Types::ListPaymentConnectorsResponse
Lists all payment connectors for a specified payment manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_payment_connectors({
payment_manager_id: "PaymentManagerId", # required
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.payment_connectors #=> Array
resp.payment_connectors[0].payment_connector_id #=> String
resp.payment_connectors[0].name #=> String
resp.payment_connectors[0].type #=> String, one of "CoinbaseCDP", "StripePrivy"
resp.payment_connectors[0].provision_mode #=> String, one of "MANUAL", "QUICK_CREATE"
resp.payment_connectors[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED", "PENDING_AUTHENTICATION", "PROVISIONING", "AUTHENTICATION_EXPIRED", "AUTHENTICATION_FAILED"
resp.payment_connectors[0].last_updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:payment_manager_id
(required, String)
—
The unique identifier of the payment manager whose connectors to list.
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
Returns:
-
(Types::ListPaymentConnectorsResponse)
—
Returns a response object which responds to the following methods:
- #payment_connectors => Array<Types::PaymentConnectorSummary>
- #next_token => String
See Also:
11687 11688 11689 11690 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11687 def list_payment_connectors(params = {}, options = {}) req = build_request(:list_payment_connectors, params) req.send_request(options) end |
#list_payment_credential_providers(params = {}) ⇒ Types::ListPaymentCredentialProvidersResponse
Lists all payment credential providers in the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_payment_credential_providers({
next_token: "String",
max_results: 1,
})
Response structure
Response structure
resp.credential_providers #=> Array
resp.credential_providers[0].name #=> String
resp.credential_providers[0].credential_provider_vendor #=> String, one of "CoinbaseCDP", "StripePrivy"
resp.credential_providers[0].credential_provider_arn #=> String
resp.credential_providers[0].created_time #=> Time
resp.credential_providers[0].last_updated_time #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
Pagination token.
-
:max_results
(Integer)
—
Maximum number of results to return.
Returns:
-
(Types::ListPaymentCredentialProvidersResponse)
—
Returns a response object which responds to the following methods:
- #credential_providers => Array<Types::PaymentCredentialProviderItem>
- #next_token => String
See Also:
11728 11729 11730 11731 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11728 def list_payment_credential_providers(params = {}, options = {}) req = build_request(:list_payment_credential_providers, params) req.send_request(options) end |
#list_payment_managers(params = {}) ⇒ Types::ListPaymentManagersResponse
Lists all payment managers in the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_payment_managers({
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.payment_managers #=> Array
resp.payment_managers[0].payment_manager_arn #=> String
resp.payment_managers[0].payment_manager_id #=> String
resp.payment_managers[0].name #=> String
resp.payment_managers[0].description #=> String
resp.payment_managers[0].authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM"
resp.payment_managers[0].role_arn #=> String
resp.payment_managers[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.payment_managers[0].created_at #=> Time
resp.payment_managers[0].last_updated_at #=> Time
resp.payment_managers[0].kms_key_arn #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
Returns:
-
(Types::ListPaymentManagersResponse)
—
Returns a response object which responds to the following methods:
- #payment_managers => Array<Types::PaymentManagerSummary>
- #next_token => String
See Also:
11780 11781 11782 11783 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11780 def list_payment_managers(params = {}, options = {}) req = build_request(:list_payment_managers, params) req.send_request(options) end |
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Retrieves a list of policies within the AgentCore Policy engine. This operation supports pagination and filtering to help administrators manage and discover policies across policy engines. Results can be filtered by policy engine or resource associations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_policies({
next_token: "NextToken",
max_results: 1,
policy_engine_id: "ResourceId", # required
target_resource_scope: "BedrockAgentcoreResourceArn",
})
Response structure
Response structure
resp.policies #=> Array
resp.policies[0].policy_id #=> String
resp.policies[0].name #=> String
resp.policies[0].policy_engine_id #=> String
resp.policies[0].created_at #=> Time
resp.policies[0].updated_at #=> Time
resp.policies[0].policy_arn #=> String
resp.policies[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.policies[0].enforcement_mode #=> String, one of "ACTIVE", "LOG_ONLY"
resp.policies[0].definition.cedar.statement #=> String
resp.policies[0].definition.policy_generation.policy_generation_id #=> String
resp.policies[0].definition.policy_generation.policy_generation_asset_id #=> String
resp.policies[0].definition.policy.statement #=> String
resp.policies[0].description #=> String
resp.policies[0].status_reasons #=> Array
resp.policies[0].status_reasons[0] #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
A pagination token returned from a previous ListPolicies call. Use this token to retrieve the next page of results when the response is paginated.
-
:max_results
(Integer)
—
The maximum number of policies to return in a single response. If not specified, the default is 10 policies per page, with a maximum of 100 per page.
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine whose policies to retrieve.
-
:target_resource_scope
(String)
—
Optional filter to list policies that apply to a specific resource scope or resource type. This helps narrow down policy results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.
Returns:
-
(Types::ListPoliciesResponse)
—
Returns a response object which responds to the following methods:
- #policies => Array<Types::Policy>
- #next_token => String
See Also:
11853 11854 11855 11856 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11853 def list_policies(params = {}, options = {}) req = build_request(:list_policies, params) req.send_request(options) end |
#list_policy_engine_summaries(params = {}) ⇒ Types::ListPolicyEngineSummariesResponse
Retrieves a paginated list of metadata-only policy engine summaries without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy engine, but does not include descriptions or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_policy_engine_summaries({
next_token: "NextToken",
max_results: 1,
})
Response structure
Response structure
resp.policy_engines #=> Array
resp.policy_engines[0].policy_engine_id #=> String
resp.policy_engines[0].name #=> String
resp.policy_engines[0].created_at #=> Time
resp.policy_engines[0].updated_at #=> Time
resp.policy_engines[0].policy_engine_arn #=> String
resp.policy_engines[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.policy_engines[0].encryption_key_arn #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
A pagination token returned from a previous ListPolicyEngineSummaries call. Use this token to retrieve the next page of results when the response is paginated.
-
:max_results
(Integer)
—
The maximum number of policy engine summaries to return in a single response.
Returns:
-
(Types::ListPolicyEngineSummariesResponse)
—
Returns a response object which responds to the following methods:
- #policy_engines => Array<Types::PolicyEngineSummary>
- #next_token => String
See Also:
11909 11910 11911 11912 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11909 def list_policy_engine_summaries(params = {}, options = {}) req = build_request(:list_policy_engine_summaries, params) req.send_request(options) end |
#list_policy_engines(params = {}) ⇒ Types::ListPolicyEnginesResponse
Retrieves a list of policy engines within the AgentCore Policy system. This operation supports pagination to help administrators discover and manage policy engines across their account. Each policy engine serves as a container for related policies.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_policy_engines({
next_token: "NextToken",
max_results: 1,
})
Response structure
Response structure
resp.policy_engines #=> Array
resp.policy_engines[0].policy_engine_id #=> String
resp.policy_engines[0].name #=> String
resp.policy_engines[0].created_at #=> Time
resp.policy_engines[0].updated_at #=> Time
resp.policy_engines[0].policy_engine_arn #=> String
resp.policy_engines[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.policy_engines[0].encryption_key_arn #=> String
resp.policy_engines[0].description #=> String
resp.policy_engines[0].status_reasons #=> Array
resp.policy_engines[0].status_reasons[0] #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
A pagination token returned from a previous ListPolicyEngines call. Use this token to retrieve the next page of results when the response is paginated.
-
:max_results
(Integer)
—
The maximum number of policy engines to return in a single response. If not specified, the default is 10 policy engines per page, with a maximum of 100 per page.
Returns:
-
(Types::ListPolicyEnginesResponse)
—
Returns a response object which responds to the following methods:
- #policy_engines => Array<Types::PolicyEngine>
- #next_token => String
See Also:
11966 11967 11968 11969 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 11966 def list_policy_engines(params = {}, options = {}) req = build_request(:list_policy_engines, params) req.send_request(options) end |
#list_policy_generation_assets(params = {}) ⇒ Types::ListPolicyGenerationAssetsResponse
Retrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system. This operation returns the actual Dogwood policies and related artifacts produced by the AI-powered policy generation process, allowing users to review and select from multiple generated policy options.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_policy_generation_assets({
policy_generation_id: "ResourceId", # required
policy_engine_id: "ResourceId", # required
next_token: "NextToken",
max_results: 1,
})
Response structure
Response structure
resp.policy_generation_assets #=> Array
resp.policy_generation_assets[0].policy_generation_asset_id #=> String
resp.policy_generation_assets[0].definition.cedar.statement #=> String
resp.policy_generation_assets[0].definition.policy_generation.policy_generation_id #=> String
resp.policy_generation_assets[0].definition.policy_generation.policy_generation_asset_id #=> String
resp.policy_generation_assets[0].definition.policy.statement #=> String
resp.policy_generation_assets[0].raw_text_fragment #=> String
resp.policy_generation_assets[0].findings #=> Array
resp.policy_generation_assets[0].findings[0].type #=> String, one of "VALID", "INVALID", "NOT_TRANSLATABLE", "ALLOW_ALL", "ALLOW_NONE", "DENY_ALL", "DENY_NONE"
resp.policy_generation_assets[0].findings[0].description #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_generation_id
(required, String)
—
The unique identifier of the policy generation request whose assets are to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call that has completed processing.
-
:policy_engine_id
(required, String)
—
The unique identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and ensures assets are retrieved from the correct policy engine.
-
:next_token
(String)
—
A pagination token returned from a previous ListPolicyGenerationAssets call. Use this token to retrieve the next page of assets when the response is paginated due to large numbers of generated policy options.
-
:max_results
(Integer)
—
The maximum number of policy generation assets to return in a single response. If not specified, the default is 10 assets per page, with a maximum of 100 per page. This helps control response size when dealing with policy generations that produce many alternative policy options.
Returns:
-
(Types::ListPolicyGenerationAssetsResponse)
—
Returns a response object which responds to the following methods:
- #policy_generation_assets => Array<Types::PolicyGenerationAsset>
- #next_token => String
See Also:
12043 12044 12045 12046 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12043 def list_policy_generation_assets(params = {}, options = {}) req = build_request(:list_policy_generation_assets, params) req.send_request(options) end |
#list_policy_generation_summaries(params = {}) ⇒ Types::ListPolicyGenerationSummariesResponse
Retrieves a paginated list of metadata-only policy generation summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings for each policy generation, but does not include status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_policy_generation_summaries({
next_token: "NextToken",
max_results: 1,
policy_engine_id: "ResourceId", # required
})
Response structure
Response structure
resp.policy_generations #=> Array
resp.policy_generations[0].policy_engine_id #=> String
resp.policy_generations[0].policy_generation_id #=> String
resp.policy_generations[0].name #=> String
resp.policy_generations[0].policy_generation_arn #=> String
resp.policy_generations[0].resource.arn #=> String
resp.policy_generations[0].created_at #=> Time
resp.policy_generations[0].updated_at #=> Time
resp.policy_generations[0].status #=> String, one of "GENERATING", "GENERATED", "GENERATE_FAILED", "DELETE_FAILED"
resp.policy_generations[0].findings #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
A pagination token returned from a previous ListPolicyGenerationSummaries call. Use this token to retrieve the next page of results when the response is paginated.
-
:max_results
(Integer)
—
The maximum number of policy generation summaries to return in a single response.
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine whose policy generation summaries to retrieve.
Returns:
-
(Types::ListPolicyGenerationSummariesResponse)
—
Returns a response object which responds to the following methods:
- #policy_generations => Array<Types::PolicyGenerationSummary>
- #next_token => String
See Also:
12106 12107 12108 12109 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12106 def list_policy_generation_summaries(params = {}, options = {}) req = build_request(:list_policy_generation_summaries, params) req.send_request(options) end |
#list_policy_generations(params = {}) ⇒ Types::ListPolicyGenerationsResponse
Retrieves a list of policy generation requests within the AgentCore Policy system. This operation supports pagination and filtering to help track and manage AI-powered policy generation operations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_policy_generations({
next_token: "NextToken",
max_results: 1,
policy_engine_id: "ResourceId", # required
})
Response structure
Response structure
resp.policy_generations #=> Array
resp.policy_generations[0].policy_engine_id #=> String
resp.policy_generations[0].policy_generation_id #=> String
resp.policy_generations[0].name #=> String
resp.policy_generations[0].policy_generation_arn #=> String
resp.policy_generations[0].resource.arn #=> String
resp.policy_generations[0].created_at #=> Time
resp.policy_generations[0].updated_at #=> Time
resp.policy_generations[0].status #=> String, one of "GENERATING", "GENERATED", "GENERATE_FAILED", "DELETE_FAILED"
resp.policy_generations[0].findings #=> String
resp.policy_generations[0].status_reasons #=> Array
resp.policy_generations[0].status_reasons[0] #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
A pagination token for retrieving additional policy generations when results are paginated.
-
:max_results
(Integer)
—
The maximum number of policy generations to return in a single response.
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine whose policy generations to retrieve.
Returns:
-
(Types::ListPolicyGenerationsResponse)
—
Returns a response object which responds to the following methods:
- #policy_generations => Array<Types::PolicyGeneration>
- #next_token => String
See Also:
12162 12163 12164 12165 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12162 def list_policy_generations(params = {}, options = {}) req = build_request(:list_policy_generations, params) req.send_request(options) end |
#list_policy_summaries(params = {}) ⇒ Types::ListPolicySummariesResponse
Retrieves a paginated list of metadata-only policy summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy, but does not include policy definitions, descriptions, or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_policy_summaries({
next_token: "NextToken",
max_results: 1,
policy_engine_id: "ResourceId", # required
target_resource_scope: "BedrockAgentcoreResourceArn",
})
Response structure
Response structure
resp.policies #=> Array
resp.policies[0].policy_id #=> String
resp.policies[0].name #=> String
resp.policies[0].policy_engine_id #=> String
resp.policies[0].created_at #=> Time
resp.policies[0].updated_at #=> Time
resp.policies[0].policy_arn #=> String
resp.policies[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.policies[0].enforcement_mode #=> String, one of "ACTIVE", "LOG_ONLY"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
A pagination token returned from a previous ListPolicySummaries call. Use this token to retrieve the next page of results when the response is paginated.
-
:max_results
(Integer)
—
The maximum number of policy summaries to return in a single response.
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine whose policy summaries to retrieve.
-
:target_resource_scope
(String)
—
Optional filter to list policy summaries that apply to a specific resource scope or resource type. This helps narrow down results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.
Returns:
-
(Types::ListPolicySummariesResponse)
—
Returns a response object which responds to the following methods:
- #policies => Array<Types::PolicySummary>
- #next_token => String
See Also:
12231 12232 12233 12234 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12231 def list_policy_summaries(params = {}, options = {}) req = build_request(:list_policy_summaries, params) req.send_request(options) end |
#list_registries(params = {}) ⇒ Types::ListRegistriesResponse
Lists all registries in the account. You can optionally filter results
by status using the status parameter, or by authorizer type using
the authorizerType parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_registries({
max_results: 1,
next_token: "NextToken",
status: "CREATING", # accepts CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, DELETE_FAILED
authorizer_type: "CUSTOM_JWT", # accepts CUSTOM_JWT, AWS_IAM
})
Response structure
Response structure
resp.registries #=> Array
resp.registries[0].name #=> String
resp.registries[0].description #=> String
resp.registries[0].registry_id #=> String
resp.registries[0].registry_arn #=> String
resp.registries[0].authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM"
resp.registries[0].status #=> String, one of "CREATING", "READY", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.registries[0].status_reason #=> String
resp.registries[0].created_at #=> Time
resp.registries[0].updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results. -
:status
(String)
—
Filter registries by their current status. Possible values include
CREATING,READY,UPDATING,CREATE_FAILED,UPDATE_FAILED,DELETING, andDELETE_FAILED. -
:authorizer_type
(String)
—
Filter registries by their authorizer type. Possible values are
CUSTOM_JWTandAWS_IAM. For more information about authorizer types, see theRegistryAuthorizerTypeenum.
Returns:
-
(Types::ListRegistriesResponse)
—
Returns a response object which responds to the following methods:
- #registries => Array<Types::RegistrySummary>
- #next_token => String
See Also:
12296 12297 12298 12299 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12296 def list_registries(params = {}, options = {}) req = build_request(:list_registries, params) req.send_request(options) end |
#list_registry_records(params = {}) ⇒ Types::ListRegistryRecordsResponse
Lists registry records within a registry. You can optionally filter
results using the name, status, and descriptorType parameters.
When multiple filters are specified, they are combined using AND
logic.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_registry_records({
registry_id: "RegistryIdentifier", # required
max_results: 1,
next_token: "NextToken",
name: "RegistryRecordName",
status: "DRAFT", # accepts DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, DEPRECATED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED
descriptor_type: "MCP", # accepts MCP, A2A, CUSTOM, AGENT_SKILLS
})
Response structure
Response structure
resp.registry_records #=> Array
resp.registry_records[0].registry_arn #=> String
resp.registry_records[0].record_arn #=> String
resp.registry_records[0].record_id #=> String
resp.registry_records[0].name #=> String
resp.registry_records[0].description #=> String
resp.registry_records[0].descriptor_type #=> String, one of "MCP", "A2A", "CUSTOM", "AGENT_SKILLS"
resp.registry_records[0].record_version #=> String
resp.registry_records[0].status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.registry_records[0].created_at #=> Time
resp.registry_records[0].updated_at #=> Time
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:registry_id
(required, String)
—
The identifier of the registry to list records from. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results. -
:name
(String)
—
Filter registry records by name.
-
:status
(String)
—
Filter registry records by their current status. Possible values include
CREATING,DRAFT,APPROVED,PENDING_APPROVAL,REJECTED,DEPRECATED,UPDATING,CREATE_FAILED, andUPDATE_FAILED. -
:descriptor_type
(String)
—
Filter registry records by their descriptor type. Possible values are
MCP,A2A,CUSTOM, andAGENT_SKILLS.
Returns:
-
(Types::ListRegistryRecordsResponse)
—
Returns a response object which responds to the following methods:
- #registry_records => Array<Types::RegistryRecordSummary>
- #next_token => String
See Also:
12372 12373 12374 12375 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12372 def list_registry_records(params = {}, options = {}) req = build_request(:list_registry_records, params) req.send_request(options) end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags associated with the specified resource.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_tags_for_resource({
resource_arn: "TaggableResourcesArn", # required
})
Response structure
Response structure
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
Returns:
See Also:
12407 12408 12409 12410 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12407 def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_workload_identities({
next_token: "String",
max_results: 1,
})
Response structure
Response structure
resp.workload_identities #=> Array
resp.workload_identities[0].name #=> String
resp.workload_identities[0].workload_identity_arn #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
Pagination token.
-
:max_results
(Integer)
—
Maximum number of results to return.
Returns:
-
(Types::ListWorkloadIdentitiesResponse)
—
Returns a response object which responds to the following methods:
- #workload_identities => Array<Types::WorkloadIdentityType>
- #next_token => String
See Also:
12445 12446 12447 12448 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12445 def list_workload_identities(params = {}, options = {}) req = build_request(:list_workload_identities, params) req.send_request(options) end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Creates or updates a resource-based policy for a resource with the specified resourceArn.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.put_resource_policy({
resource_arn: "BedrockAgentcoreResourceArn", # required
policy: "ResourcePolicyBody", # required
})
Response structure
Response structure
resp.policy #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource for which to create or update the resource policy.
-
:policy
(required, String)
—
The resource policy to create or update.
Returns:
See Also:
12484 12485 12486 12487 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12484 def put_resource_policy(params = {}, options = {}) req = build_request(:put_resource_policy, params) req.send_request(options) end |
#reset_token_vault_key_material(params = {}) ⇒ Types::ResetTokenVaultKeyMaterialResponse
Resets the key material for a token vault whose customer managed KMS key has been deleted, and re-encrypts the token vault with an Amazon Web Services managed key so that you can use the token vault again.
This operation can't be undone. The reset permanently deletes the OAuth2 access tokens and refresh tokens stored in the token vault, including tokens obtained through all supported flows. After the reset, your agents must complete these flows again to get new tokens, and for user-delegated flows your users must authorize access again. The reset doesn't delete your credential providers or their configuration.
You can reset a token vault only if its customer managed key has been
deleted. If the key still exists, including when it's disabled or
scheduled for deletion, this operation returns a
ValidationException. To use the token vault again, enable the key or
cancel its scheduled deletion in KMS. To switch to a different key,
use SetTokenVaultCMK.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.reset_token_vault_key_material({
token_vault_id: "TokenVaultIdType", # required
})
Response structure
Response structure
resp.token_vault_id #=> String
resp.kms_configuration.key_type #=> String, one of "CustomerManagedKey", "ServiceManagedKey"
resp.kms_configuration.kms_key_arn #=> String
resp.last_modified_date #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:token_vault_id
(required, String)
—
The unique identifier of the token vault to reset. To reset your account's default token vault, specify
default.
Returns:
-
(Types::ResetTokenVaultKeyMaterialResponse)
—
Returns a response object which responds to the following methods:
- #token_vault_id => String
- #kms_configuration => Types::KmsConfiguration
- #last_modified_date => Time
See Also:
12535 12536 12537 12538 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12535 def reset_token_vault_key_material(params = {}, options = {}) req = build_request(:reset_token_vault_key_material, params) req.send_request(options) end |
#rotate_payment_connector_credentials(params = {}) ⇒ Types::RotatePaymentConnectorCredentialsResponse
Replaces the service-managed credentials of a payment connector with newly issued credentials.
Use this operation only for payment connectors with a provisionMode
of QUICK_CREATE. For payment connectors with a provisionMode of
MANUAL, call UpdatePaymentCredentialProvider instead after
rotating credentials with the payment provider directly.
The rotation finishes before the response is returned, and only one
rotation runs at a time for a given payment connector. When it
succeeds, the new credential is in effect and the payment connector
stays in the READY state. When it fails, an error is returned, the
payment connector and its existing credential are left unchanged, and
you can retry the request.
Rotation replaces the credential on the connector's credential provider, so every payment connector that uses that provider is affected. Replace any copy of the previous credential that you use outside AgentCore.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.rotate_payment_connector_credentials({
payment_manager_id: "PaymentManagerId", # required
payment_connector_id: "PaymentConnectorId", # required
credentials_to_rotate: { # required
coinbase_cdp: {
secrets: ["API_KEY"], # required, accepts API_KEY, WALLET_SECRET
},
},
client_token: "ClientToken",
})
Response structure
Response structure
resp.payment_connector_id #=> String
resp.payment_manager_id #=> String
resp.last_updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED", "PENDING_AUTHENTICATION", "PROVISIONING", "AUTHENTICATION_EXPIRED", "AUTHENTICATION_FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:payment_manager_id
(required, String)
—
The unique identifier of the parent payment manager.
-
:payment_connector_id
(required, String)
—
The unique identifier of the payment connector whose credentials you want to rotate.
-
:credentials_to_rotate
(required, Types::CredentialRotationConfig)
—
The credentials to rotate. Specify the member that matches the payment connector's
type. Each credential that you select is rotated independently. -
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::RotatePaymentConnectorCredentialsResponse)
—
Returns a response object which responds to the following methods:
- #payment_connector_id => String
- #payment_manager_id => String
- #last_updated_at => Time
- #status => String
See Also:
12617 12618 12619 12620 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12617 def rotate_payment_connector_credentials(params = {}, options = {}) req = build_request(:rotate_payment_connector_credentials, params) req.send_request(options) end |
#set_token_vault_cmk(params = {}) ⇒ Types::SetTokenVaultCMKResponse
Sets the customer master key (CMK) for a token vault.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.set_token_vault_cmk({
token_vault_id: "TokenVaultIdType",
kms_configuration: { # required
key_type: "CustomerManagedKey", # required, accepts CustomerManagedKey, ServiceManagedKey
kms_key_arn: "KmsKeyArn",
},
})
Response structure
Response structure
resp.token_vault_id #=> String
resp.kms_configuration.key_type #=> String, one of "CustomerManagedKey", "ServiceManagedKey"
resp.kms_configuration.kms_key_arn #=> String
resp.last_modified_date #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:token_vault_id
(String)
—
The unique identifier of the token vault to update.
-
:kms_configuration
(required, Types::KmsConfiguration)
—
The KMS configuration for the token vault, including the key type and KMS key ARN.
Returns:
-
(Types::SetTokenVaultCMKResponse)
—
Returns a response object which responds to the following methods:
- #token_vault_id => String
- #kms_configuration => Types::KmsConfiguration
- #last_modified_date => Time
See Also:
12658 12659 12660 12661 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12658 def set_token_vault_cmk(params = {}, options = {}) req = build_request(:set_token_vault_cmk, params) req.send_request(options) end |
#start_policy_generation(params = {}) ⇒ Types::StartPolicyGenerationResponse
Initiates the AI-powered generation of Dogwood policies from natural language descriptions within the AgentCore Policy system. This feature enables both technical and non-technical users to create policies by describing their authorization requirements in plain English, which is then automatically translated into formal Dogwood policy statements. The generation process analyzes the natural language input along with the Gateway's tool context to produce validated policy options. Generated policy assets are automatically deleted after 7 days, so you should review and create policies from the generated assets within this timeframe. Once created, policies are permanent and not subject to this expiration. Generated policies should be reviewed and tested in log-only mode before deploying to production. Use this when you want to describe policy intent naturally rather than learning Dogwood syntax, though generated policies may require refinement for complex scenarios.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.start_policy_generation({
policy_engine_id: "ResourceId", # required
resource: { # required
arn: "BedrockAgentcoreResourceArn",
},
content: { # required
raw_text: "NaturalLanguage",
},
name: "PolicyGenerationName", # required
client_token: "ClientToken",
})
Response structure
Response structure
resp.policy_engine_id #=> String
resp.policy_generation_id #=> String
resp.name #=> String
resp.policy_generation_arn #=> String
resp.resource.arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status #=> String, one of "GENERATING", "GENERATED", "GENERATE_FAILED", "DELETE_FAILED"
resp.findings #=> String
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine that provides the context for policy generation. This engine's schema and tool context are used to ensure generated policies are valid and applicable.
-
:resource
(required, Types::Resource)
—
The resource information that provides context for policy generation. This helps the AI understand the target resources and generate appropriate access control rules.
-
:content
(required, Types::Content)
—
The natural language description of the desired policy behavior. This content is processed by AI to generate corresponding Dogwood policy statements that match the described intent.
-
:name
(required, String)
—
A customer-assigned name for the policy generation request. This helps track and identify generation operations, especially when running multiple generations simultaneously.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure the idempotency of the request. The Amazon Web Services SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without starting a duplicate generation.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::StartPolicyGenerationResponse)
—
Returns a response object which responds to the following methods:
- #policy_engine_id => String
- #policy_generation_id => String
- #name => String
- #policy_generation_arn => String
- #resource => Types::Resource
- #created_at => Time
- #updated_at => Time
- #status => String
- #findings => String
- #status_reasons => Array<String>
See Also:
12754 12755 12756 12757 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12754 def start_policy_generation(params = {}, options = {}) req = build_request(:start_policy_generation, params) req.send_request(options) end |
#submit_registry_record_for_approval(params = {}) ⇒ Types::SubmitRegistryRecordForApprovalResponse
Submits a registry record for approval. This transitions the record
from DRAFT status to PENDING_APPROVAL status. If the registry has
auto-approval enabled, the record is automatically approved.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.submit_registry_record_for_approval({
registry_id: "RegistryIdentifier", # required
record_id: "RecordIdentifier", # required
})
Response structure
Response structure
resp.registry_arn #=> String
resp.record_arn #=> String
resp.record_id #=> String
resp.status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:registry_id
(required, String)
—
The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
-
:record_id
(required, String)
—
The identifier of the registry record to submit for approval. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
Returns:
-
(Types::SubmitRegistryRecordForApprovalResponse)
—
Returns a response object which responds to the following methods:
- #registry_arn => String
- #record_arn => String
- #record_id => String
- #status => String
- #updated_at => Time
See Also:
12798 12799 12800 12801 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12798 def submit_registry_record_for_approval(params = {}, options = {}) req = build_request(:submit_registry_record_for_approval, params) req.send_request(options) end |
#synchronize_gateway_targets(params = {}) ⇒ Types::SynchronizeGatewayTargetsResponse
Synchronizes the gateway targets by fetching the latest tool definitions from the target endpoints.
You cannot synchronize a target that is in a pending authorization
state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or
SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or
fail before synchronizing.
You cannot synchronize a target that has a static tool schema
(mcpToolSchema) configured. Remove the static schema through an
UpdateGatewayTarget call to enable dynamic tool synchronization.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.synchronize_gateway_targets({
gateway_identifier: "GatewayIdentifier", # required
target_id_list: ["TargetId"], # required
})
Response structure
Response structure
resp.targets #=> Array
resp.targets[0].gateway_arn #=> String
resp.targets[0].target_id #=> String
resp.targets[0].created_at #=> Time
resp.targets[0].updated_at #=> Time
resp.targets[0].status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED", "SYNCHRONIZING", "SYNCHRONIZE_UNSUCCESSFUL", "CREATE_PENDING_AUTH", "UPDATE_PENDING_AUTH", "SYNCHRONIZE_PENDING_AUTH"
resp.targets[0].status_reasons #=> Array
resp.targets[0].status_reasons[0] #=> String
resp.targets[0].name #=> String
resp.targets[0].description #=> String
resp.targets[0].target_configuration.mcp.open_api_schema.s3.uri #=> String
resp.targets[0].target_configuration.mcp.open_api_schema.s3.bucket_owner_account_id #=> String
resp.targets[0].target_configuration.mcp.open_api_schema.inline_payload #=> String
resp.targets[0].target_configuration.mcp.smithy_model.s3.uri #=> String
resp.targets[0].target_configuration.mcp.smithy_model.s3.bucket_owner_account_id #=> String
resp.targets[0].target_configuration.mcp.smithy_model.inline_payload #=> String
resp.targets[0].target_configuration.mcp.lambda.lambda_arn #=> String
resp.targets[0].target_configuration.mcp.lambda.tool_schema.s3.uri #=> String
resp.targets[0].target_configuration.mcp.lambda.tool_schema.s3.bucket_owner_account_id #=> String
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload #=> Array
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].name #=> String
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].description #=> String
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.type #=> String, one of "string", "number", "object", "array", "boolean", "integer"
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.properties #=> Hash
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.properties["String"] #=> Types::SchemaDefinition
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.required #=> Array
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.required[0] #=> String
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.items #=> Types::SchemaDefinition
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.description #=> String
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.type #=> String, one of "string", "number", "object", "array", "boolean", "integer"
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.properties #=> Hash
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.properties["String"] #=> Types::SchemaDefinition
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.required #=> Array
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.required[0] #=> String
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.items #=> Types::SchemaDefinition
resp.targets[0].target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.description #=> String
resp.targets[0].target_configuration.mcp.mcp_server.endpoint #=> String
resp.targets[0].target_configuration.mcp.mcp_server.mcp_tool_schema.s3.uri #=> String
resp.targets[0].target_configuration.mcp.mcp_server.mcp_tool_schema.s3.bucket_owner_account_id #=> String
resp.targets[0].target_configuration.mcp.mcp_server.mcp_tool_schema.inline_payload #=> String
resp.targets[0].target_configuration.mcp.mcp_server.listing_mode #=> String, one of "DEFAULT", "DYNAMIC"
resp.targets[0].target_configuration.mcp.mcp_server.resource_priority #=> Integer
resp.targets[0].target_configuration.mcp.api_gateway.rest_api_id #=> String
resp.targets[0].target_configuration.mcp.api_gateway.stage #=> String
resp.targets[0].target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides #=> Array
resp.targets[0].target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].name #=> String
resp.targets[0].target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].description #=> String
resp.targets[0].target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].path #=> String
resp.targets[0].target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].method #=> String, one of "GET", "DELETE", "HEAD", "OPTIONS", "PATCH", "PUT", "POST"
resp.targets[0].target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters #=> Array
resp.targets[0].target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].filter_path #=> String
resp.targets[0].target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].methods #=> Array
resp.targets[0].target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].methods[0] #=> String, one of "GET", "DELETE", "HEAD", "OPTIONS", "PATCH", "PUT", "POST"
resp.targets[0].target_configuration.mcp.connector.source.connector_id #=> String
resp.targets[0].target_configuration.mcp.connector.source.version #=> String
resp.targets[0].target_configuration.mcp.connector.enabled #=> Array
resp.targets[0].target_configuration.mcp.connector.enabled[0] #=> String
resp.targets[0].target_configuration.mcp.connector.configurations #=> Array
resp.targets[0].target_configuration.mcp.connector.configurations[0].name #=> String
resp.targets[0].target_configuration.mcp.connector.configurations[0].description #=> String
resp.targets[0].target_configuration.mcp.connector.configurations[0].parameter_overrides #=> Array
resp.targets[0].target_configuration.mcp.connector.configurations[0].parameter_overrides[0].path #=> String
resp.targets[0].target_configuration.mcp.connector.configurations[0].parameter_overrides[0].description #=> String
resp.targets[0].target_configuration.mcp.connector.configurations[0].parameter_overrides[0].visible #=> Boolean
resp.targets[0].target_configuration.http.agentcore_runtime.arn #=> String
resp.targets[0].target_configuration.http.agentcore_runtime.qualifier #=> String
resp.targets[0].target_configuration.http.agentcore_runtime.schema.source.s3.uri #=> String
resp.targets[0].target_configuration.http.agentcore_runtime.schema.source.s3.bucket_owner_account_id #=> String
resp.targets[0].target_configuration.http.agentcore_runtime.schema.source.inline_payload #=> String
resp.targets[0].target_configuration.http.passthrough.endpoint #=> String
resp.targets[0].target_configuration.http.passthrough.protocol_type #=> String, one of "MCP", "A2A", "INFERENCE", "CUSTOM"
resp.targets[0].target_configuration.http.passthrough.schema.source.s3.uri #=> String
resp.targets[0].target_configuration.http.passthrough.schema.source.s3.bucket_owner_account_id #=> String
resp.targets[0].target_configuration.http.passthrough.schema.source.inline_payload #=> String
resp.targets[0].target_configuration.http.passthrough.stickiness_configuration.identifier #=> String
resp.targets[0].target_configuration.http.passthrough.stickiness_configuration.timeout #=> Integer
resp.targets[0].target_configuration.http.passthrough.stickiness_configuration.composite_identifier #=> Array
resp.targets[0].target_configuration.http.passthrough.stickiness_configuration.composite_identifier[0] #=> String
resp.targets[0].target_configuration.http.passthrough.static_query_parameters #=> Hash
resp.targets[0].target_configuration.http.passthrough.static_query_parameters["StaticQueryParameterName"] #=> String
resp.targets[0].target_configuration.http.passthrough.static_query_parameter_conflict_resolution #=> String, one of "CLIENT_OVERRIDE", "STATIC_OVERRIDE"
resp.targets[0].target_configuration.http.connector.source.connector_id #=> String
resp.targets[0].target_configuration.http.connector.parameters #=> Hash
resp.targets[0].target_configuration.http.connector.parameters["ConnectorParameterName"] #=> String
resp.targets[0].target_configuration.inference.connector.source.connector_id #=> String
resp.targets[0].target_configuration.inference.provider.endpoint #=> String
resp.targets[0].target_configuration.inference.provider.model_mapping.provider_prefix.strip #=> Boolean
resp.targets[0].target_configuration.inference.provider.model_mapping.provider_prefix.separator #=> String
resp.targets[0].target_configuration.inference.provider.operations #=> Array
resp.targets[0].target_configuration.inference.provider.operations[0].path #=> String
resp.targets[0].target_configuration.inference.provider.operations[0].provider_path #=> String
resp.targets[0].target_configuration.inference.provider.operations[0].models #=> Array
resp.targets[0].target_configuration.inference.provider.operations[0].models[0].model #=> String
resp.targets[0].credential_provider_configurations #=> Array
resp.targets[0].credential_provider_configurations[0].credential_provider_type #=> String, one of "GATEWAY_IAM_ROLE", "OAUTH", "API_KEY", "CALLER_IAM_CREDENTIALS", "JWT_PASSTHROUGH"
resp.targets[0].credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.targets[0].credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.targets[0].credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.targets[0].credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.targets[0].credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["OAuthCustomParametersKey"] #=> String
resp.targets[0].credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "TOKEN_EXCHANGE"
resp.targets[0].credential_provider_configurations[0].credential_provider.oauth_credential_provider.default_return_url #=> String
resp.targets[0].credential_provider_configurations[0].credential_provider.api_key_credential_provider.provider_arn #=> String
resp.targets[0].credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_parameter_name #=> String
resp.targets[0].credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_prefix #=> String
resp.targets[0].credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_location #=> String, one of "HEADER", "QUERY_PARAMETER"
resp.targets[0].credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.targets[0].credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
resp.targets[0].last_synchronized_at #=> Time
resp.targets[0].metadata_configuration.allowed_request_headers #=> Array
resp.targets[0].metadata_configuration.allowed_request_headers[0] #=> String
resp.targets[0].metadata_configuration.allowed_query_parameters #=> Array
resp.targets[0].metadata_configuration.allowed_query_parameters[0] #=> String
resp.targets[0].metadata_configuration.allowed_response_headers #=> Array
resp.targets[0].metadata_configuration.allowed_response_headers[0] #=> String
resp.targets[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.targets[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.targets[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.targets[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.targets[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.targets[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.targets[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.targets[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.targets[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.targets[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.targets[0].private_endpoint_managed_resources #=> Array
resp.targets[0].private_endpoint_managed_resources[0].domain #=> String
resp.targets[0].private_endpoint_managed_resources[0].resource_gateway_arn #=> String
resp.targets[0].private_endpoint_managed_resources[0].resource_association_arn #=> String
resp.targets[0].authorization_data.oauth2.authorization_url #=> String
resp.targets[0].authorization_data.oauth2.user_id #=> String
resp.targets[0].protocol_type #=> String, one of "MCP", "HTTP"
resp.targets[0].certificate_configurations #=> Array
resp.targets[0].certificate_configurations[0].s3.uri #=> String
resp.targets[0].certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.targets[0].certificate_configurations[0].secrets_manager.secret_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The gateway Identifier.
-
:target_id_list
(required, Array<String>)
—
The target ID list.
Returns:
See Also:
12975 12976 12977 12978 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 12975 def synchronize_gateway_targets(params = {}, options = {}) req = build_request(:synchronize_gateway_targets, params) req.send_request(options) end |
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.tag_resource({
resource_arn: "TaggableResourcesArn", # required
tags: { # required
"TagKey" => "TagValue",
},
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource that you want to tag.
-
:tags
(required, Hash<String,String>)
—
The tags to add to the resource. A tag is a key-value pair.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
13011 13012 13013 13014 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13011 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.untag_resource({
resource_arn: "TaggableResourcesArn", # required
tag_keys: ["TagKey"], # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource that you want to untag.
-
:tag_keys
(required, Array<String>)
—
The tag keys of the tags to remove from the resource.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
13042 13043 13044 13045 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13042 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end |
#update_agent_insight_store(params = {}) ⇒ Types::UpdateAgentInsightStoreResponse
Updates the enablement status or encryption configuration of an Agent Insight Store.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_agent_insight_store({
client_token: "ClientToken",
agent_insight_store_id: "AgentInsightStoreId", # required
enablement_status: "ENABLED", # accepts ENABLED, DISABLED
encryption_configuration: {
mode: "AWS_OWNED_KMS_KEY", # required, accepts AWS_OWNED_KMS_KEY, CUSTOMER_MANAGED_KMS
kms_key_arn: "KmsKeyArn",
},
})
Response structure
Response structure
resp.agent_insight_store_arn #=> String
resp.agent_insight_store_id #=> String
resp.status #=> String, one of "ACTIVE", "UPDATING", "INACTIVE", "ERROR"
resp.enablement_status #=> String, one of "ENABLED", "DISABLED"
resp.updated_at #=> Time
resp.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:agent_insight_store_id
(required, String)
—
Specifies the unique identifier of the Agent Insight Store to update.
-
:enablement_status
(String)
—
Specifies whether the Agent Insight Store accepts new Agent Insights. If you don't specify this parameter, the store's current enablement setting remains unchanged.
-
:encryption_configuration
(Types::AgentInsightStoreEncryptionConfiguration)
—
Specifies the encryption mode and key configuration to use for new Agent Insights. If you don't specify this parameter, the store's current encryption configuration remains unchanged.
Returns:
-
(Types::UpdateAgentInsightStoreResponse)
—
Returns a response object which responds to the following methods:
- #agent_insight_store_arn => String
- #agent_insight_store_id => String
- #status => String
- #enablement_status => String
- #updated_at => Time
- #failure_reason => String
See Also:
13111 13112 13113 13114 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13111 def update_agent_insight_store(params = {}, options = {}) req = build_request(:update_agent_insight_store, params) req.send_request(options) end |
#update_agent_runtime(params = {}) ⇒ Types::UpdateAgentRuntimeResponse
Updates an existing Amazon Secure Agent.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_agent_runtime({
agent_runtime_id: "AgentRuntimeId", # required
agent_runtime_artifact: { # required
container_configuration: {
container_uri: "RuntimeContainerUri", # required
},
code_configuration: {
code: { # required
s3: {
bucket: "S3LocationBucketString", # required
prefix: "S3LocationPrefixString", # required
version_id: "S3LocationVersionIdString",
},
},
runtime: "PYTHON_3_10", # required, accepts PYTHON_3_10, PYTHON_3_11, PYTHON_3_12, PYTHON_3_13, PYTHON_3_14, NODE_22
entry_point: ["entryPoint"], # required
},
},
role_arn: "RoleArn", # required
network_configuration: {
network_mode: "PUBLIC", # required, accepts PUBLIC, VPC
network_mode_config: {
security_groups: ["SecurityGroupId"], # required
subnets: ["SubnetId"], # required
require_service_s3_endpoint: false,
},
},
description: "Description",
authorizer_configuration: {
custom_jwt_authorizer: {
discovery_url: "DiscoveryUrl", # required
allowed_audience: ["AllowedAudience"],
allowed_clients: ["AllowedClient"],
allowed_scopes: ["AllowedScopeType"],
advertised_scope_mapping: {
"AllowedScopeType" => "AllowedScopeType",
},
custom_claims: [
{
inbound_token_claim_name: "InboundTokenClaimNameType", # required
inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
authorizing_claim_match_value: { # required
claim_match_value: { # required
match_value_string: "MatchValueString",
match_value_string_list: ["MatchValueString"],
},
claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
},
},
],
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
allowed_workload_configuration: {
hosting_environments: [
{
arn: "BedrockAgentcoreResourceArn", # required
},
],
workload_identities: ["WorkloadIdentityNameType"],
},
},
},
request_header_configuration: {
request_header_allowlist: ["HeaderName"],
},
protocol_configuration: {
server_protocol: "MCP", # required, accepts MCP, HTTP, A2A, AGUI
port: 1,
path: "ServerPath",
},
lifecycle_configuration: {
idle_runtime_session_timeout: 1,
max_lifetime: 1,
},
hooks_configuration: {
build: {
warmup: {
action: { # required
http_post: {
path: "LifecycleHookPath", # required
port: 1,
},
},
},
},
},
metadata_configuration: {
require_mmdsv2: false, # required
},
environment_variables: {
"EnvironmentVariableKey" => "EnvironmentVariableValue",
},
filesystem_configurations: [
{
session_storage: {
mount_path: "MountPath", # required
},
s3_files_access_point: {
access_point_arn: "S3FilesAccessPointArn", # required
mount_path: "MountPath", # required
},
efs_access_point: {
access_point_arn: "EfsAccessPointArn", # required
mount_path: "MountPath", # required
},
capacity_provider_volume: {
volume_name: "CapacityProviderVolumeName", # required
mount_path: "MountPath", # required
},
},
],
capacity_provider_configuration: {
capacity_provider_arn: "CapacityProviderArn", # required
},
platform_version: "PlatformVersion",
allowed_ports: [
{
port: 1,
port_range: {
from: 1, # required
to: 1, # required
},
},
],
resource_configurations: [
{
minimum_memory_in_mi_b: 1, # required
},
],
client_token: "ClientToken",
})
Response structure
Response structure
resp.agent_runtime_arn #=> String
resp.agent_runtime_id #=> String
resp.workload_identity_details.workload_identity_arn #=> String
resp.agent_runtime_version #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_runtime_id
(required, String)
—
The unique identifier of the AgentCore Runtime to update.
-
:agent_runtime_artifact
(required, Types::AgentRuntimeArtifact)
—
The updated artifact of the AgentCore Runtime.
-
:role_arn
(required, String)
—
The updated IAM role ARN that provides permissions for the AgentCore Runtime.
-
:network_configuration
(Types::NetworkConfiguration)
—
The updated network configuration for the AgentCore Runtime.
-
:description
(String)
—
The updated description of the AgentCore Runtime.
-
:authorizer_configuration
(Types::AuthorizerConfiguration)
—
The updated authorizer configuration for the AgentCore Runtime.
-
:request_header_configuration
(Types::RequestHeaderConfiguration)
—
The updated configuration for HTTP request headers that will be passed through to the runtime.
-
:protocol_configuration
(Types::ProtocolConfiguration)
—
The updated protocol configuration for the AgentCore Runtime, including the protocol, port, and path on which the agent server is available.
-
:lifecycle_configuration
(Types::LifecycleConfiguration)
—
The updated life cycle configuration for the AgentCore Runtime.
-
:hooks_configuration
(Types::RuntimeHooksConfiguration)
—
The updated lifecycle hooks configuration for the AgentCore Runtime.
-
:metadata_configuration
(Types::RuntimeMetadataConfiguration)
—
The updated configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.
-
:environment_variables
(Hash<String,String>)
—
Updated environment variables to set in the AgentCore Runtime environment.
-
:filesystem_configurations
(Array<Types::FilesystemConfiguration>)
—
The updated filesystem configurations to mount into the AgentCore Runtime.
-
:capacity_provider_configuration
(Types::CapacityProviderConfiguration)
—
The updated capacity provider configuration for the AgentCore Runtime.
-
:platform_version
(String)
—
The updated version of the runtime platform to use for the AgentCore Runtime.
-
:allowed_ports
(Array<Types::AllowedPort>)
—
The updated additional ports on the AgentCore Runtime that are reachable through the runtime's session URL. Specify one to five non-overlapping entries, each containing either a single port or an inclusive port range. Ports must be between
8000and12000, excluding the reserved port8443. -
:resource_configurations
(Array<Types::ResourceConfiguration>)
—
The updated resource configurations for the AgentCore Runtime. You can specify at most one resource configuration.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::UpdateAgentRuntimeResponse)
—
Returns a response object which responds to the following methods:
- #agent_runtime_arn => String
- #agent_runtime_id => String
- #workload_identity_details => Types::WorkloadIdentityDetails
- #agent_runtime_version => String
- #created_at => Time
- #last_updated_at => Time
- #status => String
See Also:
13391 13392 13393 13394 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13391 def update_agent_runtime(params = {}, options = {}) req = build_request(:update_agent_runtime, params) req.send_request(options) end |
#update_agent_runtime_endpoint(params = {}) ⇒ Types::UpdateAgentRuntimeEndpointResponse
Updates an existing Amazon Bedrock AgentCore Runtime endpoint.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_agent_runtime_endpoint({
agent_runtime_id: "AgentRuntimeId", # required
endpoint_name: "EndpointName", # required
agent_runtime_version: "AgentRuntimeVersion",
description: "AgentEndpointDescription",
client_token: "ClientToken",
})
Response structure
Response structure
resp.live_version #=> String
resp.target_version #=> String
resp.agent_runtime_endpoint_arn #=> String
resp.agent_runtime_arn #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.created_at #=> Time
resp.last_updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_runtime_id
(required, String)
—
The unique identifier of the AgentCore Runtime associated with the endpoint.
-
:endpoint_name
(required, String)
—
The name of the AgentCore Runtime endpoint to update.
-
:agent_runtime_version
(String)
—
The updated version of the AgentCore Runtime for the endpoint.
-
:description
(String)
—
The updated description of the AgentCore Runtime endpoint.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::UpdateAgentRuntimeEndpointResponse)
—
Returns a response object which responds to the following methods:
- #live_version => String
- #target_version => String
- #agent_runtime_endpoint_arn => String
- #agent_runtime_arn => String
- #status => String
- #created_at => Time
- #last_updated_at => Time
See Also:
13452 13453 13454 13455 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13452 def update_agent_runtime_endpoint(params = {}, options = {}) req = build_request(:update_agent_runtime_endpoint, params) req.send_request(options) end |
#update_api_key_credential_provider(params = {}) ⇒ Types::UpdateApiKeyCredentialProviderResponse
Updates an existing API key credential provider.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_api_key_credential_provider({
name: "CredentialProviderName", # required
api_key: "DefaultApiKeyType",
api_key_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
api_key_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
})
Response structure
Response structure
resp.api_key_secret_arn.secret_arn #=> String
resp.api_key_secret_json_key #=> String
resp.api_key_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.name #=> String
resp.credential_provider_arn #=> String
resp.created_time #=> Time
resp.last_updated_time #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the API key credential provider to update.
-
:api_key
(String)
—
The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.
-
:api_key_secret_config
(Types::SecretReference)
—
A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when
apiKeySecretSourceis set toEXTERNAL. -
:api_key_secret_source
(String)
—
The source type of the API key secret. Use
MANAGEDif the secret is managed by the service, orEXTERNALif you manage the secret yourself in Amazon Web Services Secrets Manager.
Returns:
-
(Types::UpdateApiKeyCredentialProviderResponse)
—
Returns a response object which responds to the following methods:
- #api_key_secret_arn => Types::Secret
- #api_key_secret_json_key => String
- #api_key_secret_source => String
- #name => String
- #credential_provider_arn => String
- #created_time => Time
- #last_updated_time => Time
See Also:
13513 13514 13515 13516 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13513 def update_api_key_credential_provider(params = {}, options = {}) req = build_request(:update_api_key_credential_provider, params) req.send_request(options) end |
#update_capacity_provider(params = {}) ⇒ Types::UpdateCapacityProviderOutput
Updates a capacity provider. Only the description can be changed. To change other configuration, such as instance types, networking, or storage, create a new capacity provider.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_capacity_provider({
capacity_provider_id: "CapacityProviderId", # required
description: {
optional_value: "Description",
},
client_token: "ClientToken",
})
Response structure
Response structure
resp.capacity_provider_id #=> String
resp.capacity_provider_arn #=> String
resp.name #=> String
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.created_at #=> Time
resp.last_updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:capacity_provider_id
(required, String)
—
The unique identifier of the capacity provider to update.
-
:description
(Types::UpdatedDescription)
—
The updated description of the capacity provider.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::UpdateCapacityProviderOutput)
—
Returns a response object which responds to the following methods:
- #capacity_provider_id => String
- #capacity_provider_arn => String
- #name => String
- #status => String
- #created_at => Time
- #last_updated_at => Time
See Also:
13574 13575 13576 13577 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13574 def update_capacity_provider(params = {}, options = {}) req = build_request(:update_capacity_provider, params) req.send_request(options) end |
#update_configuration_bundle(params = {}) ⇒ Types::UpdateConfigurationBundleResponse
Updates a configuration bundle by creating a new version with the specified changes. Each update creates a new version in the version history.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_configuration_bundle({
client_token: "ClientToken",
bundle_id: "ConfigurationBundleId", # required
bundle_name: "ConfigurationBundleName",
description: "ConfigurationBundleDescription",
components: {
"ComponentIdentifier" => {
configuration: { # required
},
},
},
parent_version_ids: ["ConfigurationBundleVersion"], # required
branch_name: "BranchName",
commit_message: "UpdateConfigurationBundleRequestCommitMessageString", # required
created_by: {
name: "String", # required
arn: "String",
},
kms_key_arn: "KmsKeyArn",
})
Response structure
Response structure
resp.bundle_arn #=> String
resp.bundle_id #=> String
resp.version_id #=> String
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:bundle_id
(required, String)
—
The unique identifier of the configuration bundle to update.
-
:bundle_name
(String)
—
The updated name for the configuration bundle.
-
:description
(String)
—
The updated description for the configuration bundle.
-
:components
(Hash<String,Types::ComponentConfiguration>)
—
The updated component configurations. Creates a new version of the bundle.
-
:parent_version_ids
(required, Array<String>)
—
A list of parent version identifiers for lineage tracking. Regular commits have a single parent. Merge commits have two parents: the target branch parent and the source branch parent. If the branch already exists, the first parent must be the latest version on that branch.
-
:branch_name
(String)
—
The branch name for this version. If not specified, inherits the parent's branch or defaults to
mainline. -
:commit_message
(required, String)
—
A commit message describing the changes in this version.
-
:created_by
(Types::VersionCreatedBySource)
—
The source that created this version, including the source name and optional ARN.
-
:kms_key_arn
(String)
—
Optional KMS key ARN for encrypting component configurations. If provided, components will be encrypted with this key. If the bundle already has a KMS key, this rotates to the new key.
Returns:
-
(Types::UpdateConfigurationBundleResponse)
—
Returns a response object which responds to the following methods:
- #bundle_arn => String
- #bundle_id => String
- #version_id => String
- #updated_at => Time
See Also:
13674 13675 13676 13677 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13674 def update_configuration_bundle(params = {}, options = {}) req = build_request(:update_configuration_bundle, params) req.send_request(options) end |
#update_consent_portal(params = {}) ⇒ Types::UpdateConsentPortalResponse
Updates an existing consent portal.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_consent_portal({
consent_portal_identifier: "ConsentPortalIdentifier", # required
execution_role_arn: "ExecutionRoleArnType",
idp_config: {
credential_provider_arn: "OAuth2CredentialProviderArn", # required
scopes: ["AllowedScopeType"], # required
audience: "AllowedAudienceType",
},
description: "ConsentPortalDescriptionType",
})
Response structure
Response structure
resp.sources #=> Array
resp.sources[0].identifier #=> String
resp.sources[0].type #=> String, one of "agentcore-gateway"
resp.consent_portal_arn #=> String
resp.consent_portal_id #=> String
resp.created_at #=> Time
resp.description #=> String
resp.execution_role_arn #=> String
resp.idp_config.credential_provider_arn #=> String
resp.idp_config.scopes #=> Array
resp.idp_config.scopes[0] #=> String
resp.idp_config.audience #=> String
resp.name #=> String
resp.portal_url #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "FAILED"
resp.status_reason #=> String
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:consent_portal_identifier
(required, String)
—
The identifier of the consent portal. You can specify either the consent portal ID or its Amazon Resource Name (ARN).
-
:execution_role_arn
(String)
—
The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.
-
:idp_config
(Types::ConsentPortalIdpConfig)
—
The identity provider configuration that the consent portal uses to authenticate end users.
-
:description
(String)
—
The description of the consent portal.
Returns:
-
(Types::UpdateConsentPortalResponse)
—
Returns a response object which responds to the following methods:
- #sources => Array<Types::ConsentPortalSource>
- #consent_portal_arn => String
- #consent_portal_id => String
- #created_at => Time
- #description => String
- #execution_role_arn => String
- #idp_config => Types::ConsentPortalIdpConfig
- #name => String
- #portal_url => String
- #status => String
- #status_reason => String
- #updated_at => Time
See Also:
13748 13749 13750 13751 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13748 def update_consent_portal(params = {}, options = {}) req = build_request(:update_consent_portal, params) req.send_request(options) end |
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Updates a dataset's metadata. Synchronous operation. Only provided
fields are updated; omitted fields remain unchanged. To modify dataset
content, use AddDatasetExamples, UpdateDatasetExamples, or
DeleteDatasetExamples.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_dataset({
dataset_id: "DatasetId", # required
client_token: "ClientToken",
description: "UpdateDatasetRequestDescriptionString",
})
Response structure
Response structure
resp.dataset_arn #=> String
resp.dataset_id #=> String
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:dataset_id
(required, String)
—
The unique identifier of the dataset to update.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:description
(String)
—
The updated description for the dataset.
Returns:
-
(Types::UpdateDatasetResponse)
—
Returns a response object which responds to the following methods:
- #dataset_arn => String
- #dataset_id => String
- #updated_at => Time
See Also:
13802 13803 13804 13805 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13802 def update_dataset(params = {}, options = {}) req = build_request(:update_dataset, params) req.send_request(options) end |
#update_dataset_examples(params = {}) ⇒ Types::UpdateDatasetExamplesResponse
Updates multiple existing examples in-place on DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_dataset_examples({
dataset_id: "DatasetId", # required
client_token: "ClientToken",
examples: [ # required
{
},
],
})
Response structure
Response structure
resp.dataset_arn #=> String
resp.dataset_id #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.updated_count #=> Integer
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:dataset_id
(required, String)
—
The unique identifier of the dataset.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:examples
(required, Array<Hash,Array,String,Numeric,Boolean>)
—
Examples to update. Each element is a JSON object containing a required
exampleIdfield identifying the existing example, plus the replacement fields. Maximum 1000 examples per call.
Returns:
-
(Types::UpdateDatasetExamplesResponse)
—
Returns a response object which responds to the following methods:
- #dataset_arn => String
- #dataset_id => String
- #status => String
- #updated_count => Integer
- #updated_at => Time
See Also:
13865 13866 13867 13868 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 13865 def update_dataset_examples(params = {}, options = {}) req = build_request(:update_dataset_examples, params) req.send_request(options) end |
#update_evaluator(params = {}) ⇒ Types::UpdateEvaluatorResponse
Updates a custom evaluator's configuration, description, or evaluation level. Built-in evaluators cannot be updated. The evaluator must not be locked for modification.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_evaluator({
client_token: "ClientToken",
evaluator_id: "EvaluatorId", # required
description: "EvaluatorDescription",
evaluator_config: {
llm_as_a_judge: {
instructions: "EvaluatorInstructions", # required
rating_scale: { # required
numerical: [
{
definition: "String", # required
value: 1.0, # required
label: "NumericalScaleDefinitionLabelString", # required
},
],
categorical: [
{
definition: "String", # required
label: "CategoricalScaleDefinitionLabelString", # required
},
],
multi_dimensional: [
{
dimension_name: "EvaluationDimensionName", # required
dimension_instruction: "EvaluationDimensionInstruction", # required
dimension_rating_scale: { # required
numerical: [
{
definition: "String", # required
value: 1.0, # required
label: "NumericalScaleDefinitionLabelString", # required
},
],
categorical: [
{
definition: "String", # required
label: "CategoricalScaleDefinitionLabelString", # required
},
],
},
},
],
},
model_config: { # required
bedrock_evaluator_model_config: {
model_id: "ModelId", # required
inference_config: {
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
stop_sequences: ["NonEmptyString"],
},
additional_model_request_fields: {
},
},
responses_evaluator_model_config: {
model_id: "ModelId", # required
max_output_tokens: 1,
temperature: 1.0,
top_p: 1.0,
reasoning: {
effort: "ReasoningConfigurationEffortString",
},
},
},
},
code_based: {
lambda_config: {
lambda_arn: "LambdaArn", # required
lambda_timeout_in_seconds: 1,
},
},
derived: {
base_evaluator_id: "EvaluatorId", # required
model_config: { # required
bedrock_evaluator_model_config: {
model_id: "ModelId", # required
inference_config: {
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
stop_sequences: ["NonEmptyString"],
},
additional_model_request_fields: {
},
},
responses_evaluator_model_config: {
model_id: "ModelId", # required
max_output_tokens: 1,
temperature: 1.0,
top_p: 1.0,
reasoning: {
effort: "ReasoningConfigurationEffortString",
},
},
},
},
},
level: "TOOL_CALL", # accepts TOOL_CALL, TRACE, SESSION
kms_key_arn: "KmsKeyArn",
})
Response structure
Response structure
resp.evaluator_arn #=> String
resp.evaluator_id #=> String
resp.updated_at #=> Time
resp.status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:evaluator_id
(required, String)
—
The unique identifier of the evaluator to update.
-
:description
(String)
—
The updated description of the evaluator.
-
:evaluator_config
(Types::EvaluatorConfig)
—
The updated configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.
-
:level
(String)
—
The updated evaluation level (
TOOL_CALL,TRACE, orSESSION) that determines the scope of evaluation. -
:kms_key_arn
(String)
—
The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data. Specify a new key ARN to rotate the encryption key, or specify a key ARN to add encryption to an evaluator that was previously created without one. When you rotate to a new key, the service decrypts the existing data with the old key and re-encrypts it with the new key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.
Returns:
-
(Types::UpdateEvaluatorResponse)
—
Returns a response object which responds to the following methods:
- #evaluator_arn => String
- #evaluator_id => String
- #updated_at => Time
- #status => String
See Also:
14040 14041 14042 14043 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 14040 def update_evaluator(params = {}, options = {}) req = build_request(:update_evaluator, params) req.send_request(options) end |
#update_gateway(params = {}) ⇒ Types::UpdateGatewayResponse
Updates an existing gateway.
Replaces the entire gateway configuration. Any optional field that you
omit, including fields in protocolConfiguration, is reset. For
information about retrieving the current configuration, see
GetGateway.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_gateway({
gateway_identifier: "GatewayIdentifier", # required
name: "GatewayName", # required
description: "GatewayDescription",
role_arn: "RoleArn", # required
protocol_type: "MCP", # accepts MCP
protocol_configuration: {
mcp: {
supported_versions: ["McpVersion"],
instructions: "McpInstructions",
search_type: "SEMANTIC", # accepts SEMANTIC
session_configuration: {
session_timeout_in_seconds: 1,
},
streaming_configuration: {
enable_response_streaming: false,
},
disable_mcp_list_tools_pagination: false,
},
},
authorizer_type: "CUSTOM_JWT", # required, accepts CUSTOM_JWT, AWS_IAM, NONE, AUTHENTICATE_ONLY
authorizer_configuration: {
custom_jwt_authorizer: {
discovery_url: "DiscoveryUrl", # required
allowed_audience: ["AllowedAudience"],
allowed_clients: ["AllowedClient"],
allowed_scopes: ["AllowedScopeType"],
advertised_scope_mapping: {
"AllowedScopeType" => "AllowedScopeType",
},
custom_claims: [
{
inbound_token_claim_name: "InboundTokenClaimNameType", # required
inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
authorizing_claim_match_value: { # required
claim_match_value: { # required
match_value_string: "MatchValueString",
match_value_string_list: ["MatchValueString"],
},
claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
},
},
],
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
allowed_workload_configuration: {
hosting_environments: [
{
arn: "BedrockAgentcoreResourceArn", # required
},
],
workload_identities: ["WorkloadIdentityNameType"],
},
},
},
kms_key_arn: "KmsKeyArn",
custom_transform_configuration: {
lambda: {
arn: "LambdaFunctionArn",
},
},
interceptor_configurations: [
{
interceptor: { # required
lambda: {
arn: "LambdaFunctionArn", # required
},
},
interception_points: ["REQUEST"], # required, accepts REQUEST, RESPONSE
input_configuration: {
pass_request_headers: false, # required
payload_filter: {
exclude: [ # required
{
field: "RESPONSE_BODY", # accepts RESPONSE_BODY
},
],
},
},
},
],
policy_engine_configuration: {
arn: "GatewayPolicyEngineArn", # required
mode: "LOG_ONLY", # required, accepts LOG_ONLY, ENFORCE
},
exception_level: "DEBUG", # accepts DEBUG
waf_configuration: {
failure_mode: "FAIL_CLOSE", # accepts FAIL_CLOSE, FAIL_OPEN
},
domain_override: {
default_domain: "PublicDomainName", # required
alternate_domains: ["PublicDomainName"],
},
})
Response structure
Response structure
resp.gateway_arn #=> String
resp.gateway_id #=> String
resp.gateway_url #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED"
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
resp.name #=> String
resp.description #=> String
resp.role_arn #=> String
resp.protocol_type #=> String, one of "MCP"
resp.protocol_configuration.mcp.supported_versions #=> Array
resp.protocol_configuration.mcp.supported_versions[0] #=> String
resp.protocol_configuration.mcp.instructions #=> String
resp.protocol_configuration.mcp.search_type #=> String, one of "SEMANTIC"
resp.protocol_configuration.mcp.session_configuration.session_timeout_in_seconds #=> Integer
resp.protocol_configuration.mcp.streaming_configuration.enable_response_streaming #=> Boolean
resp.protocol_configuration.mcp.disable_mcp_list_tools_pagination #=> Boolean
resp.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM", "NONE", "AUTHENTICATE_ONLY"
resp.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.kms_key_arn #=> String
resp.custom_transform_configuration.lambda.arn #=> String
resp.interceptor_configurations #=> Array
resp.interceptor_configurations[0].interceptor.lambda.arn #=> String
resp.interceptor_configurations[0].interception_points #=> Array
resp.interceptor_configurations[0].interception_points[0] #=> String, one of "REQUEST", "RESPONSE"
resp.interceptor_configurations[0].input_configuration.pass_request_headers #=> Boolean
resp.interceptor_configurations[0].input_configuration.payload_filter.exclude #=> Array
resp.interceptor_configurations[0].input_configuration.payload_filter.exclude[0].field #=> String, one of "RESPONSE_BODY"
resp.policy_engine_configuration.arn #=> String
resp.policy_engine_configuration.mode #=> String, one of "LOG_ONLY", "ENFORCE"
resp.workload_identity_details.workload_identity_arn #=> String
resp.exception_level #=> String, one of "DEBUG"
resp.web_acl_arn #=> String
resp.waf_configuration.failure_mode #=> String, one of "FAIL_CLOSE", "FAIL_OPEN"
resp.domain_override.default_domain #=> String
resp.domain_override.alternate_domains #=> Array
resp.domain_override.alternate_domains[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway to update.
-
:name
(required, String)
—
The name of the gateway. This name must be the same as the one when the gateway was created.
-
:description
(String)
—
The updated description for the gateway.
-
:role_arn
(required, String)
—
The updated IAM role ARN that provides permissions for the gateway.
-
:protocol_type
(String)
—
The updated protocol type for the gateway.
-
:protocol_configuration
(Types::GatewayProtocolConfiguration)
—
The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.
-
:authorizer_type
(required, String)
—
The updated authorizer type for the gateway.
-
:authorizer_configuration
(Types::AuthorizerConfiguration)
—
The updated authorizer configuration for the gateway.
-
:kms_key_arn
(String)
—
The updated ARN of the KMS key used to encrypt the gateway.
-
:custom_transform_configuration
(Types::CustomTransformConfiguration)
—
The updated custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.
-
:interceptor_configurations
(Array<Types::GatewayInterceptorConfiguration>)
—
The updated interceptor configurations for the gateway.
-
:policy_engine_configuration
(Types::GatewayPolicyEngineConfiguration)
—
The updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
-
:exception_level
(String)
—
The level of detail in error messages returned when invoking the gateway.
If the value is
DEBUG, granular exception messages are returned to help a user debug the gateway.If the value is omitted, a generic error message is returned to the end user.
-
:waf_configuration
(Types::WafConfiguration)
—
The updated Amazon Web Services WAF configuration for the gateway.
-
:domain_override
(Types::DomainOverride)
—
The updated public domain names that the gateway advertises in its OAuth discovery URLs instead of the inbound Host header. Specify this when clients reach the gateway through your own proxy or custom domain.
Returns:
-
(Types::UpdateGatewayResponse)
—
Returns a response object which responds to the following methods:
- #gateway_arn => String
- #gateway_id => String
- #gateway_url => String
- #created_at => Time
- #updated_at => Time
- #status => String
- #status_reasons => Array<String>
- #name => String
- #description => String
- #role_arn => String
- #protocol_type => String
- #protocol_configuration => Types::GatewayProtocolConfiguration
- #authorizer_type => String
- #authorizer_configuration => Types::AuthorizerConfiguration
- #kms_key_arn => String
- #custom_transform_configuration => Types::CustomTransformConfiguration
- #interceptor_configurations => Array<Types::GatewayInterceptorConfiguration>
- #policy_engine_configuration => Types::GatewayPolicyEngineConfiguration
- #workload_identity_details => Types::WorkloadIdentityDetails
- #exception_level => String
- #web_acl_arn => String
- #waf_configuration => Types::WafConfiguration
- #domain_override => Types::DomainOverride
See Also:
14377 14378 14379 14380 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 14377 def update_gateway(params = {}, options = {}) req = build_request(:update_gateway, params) req.send_request(options) end |
#update_gateway_rate_limit(params = {}) ⇒ Types::UpdateGatewayRateLimitResponse
Updates the entries of a gateway rate limit. The dimension keys are immutable after creation.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_gateway_rate_limit({
gateway_identifier: "GatewayIdentifier", # required
rate_limit_id: "GatewayRateLimitId", # required
description: "GatewayRateLimitDescription",
entries: [ # required
{
dimensions: { # required
"DimensionKey" => "DimensionValue",
},
requests: [
{
rate: 1.0, # required
period: "second", # required, accepts second, minute
},
],
tokens: [
{
rate: 1.0, # required
period: "second", # required, accepts second, minute
},
],
connections: [
{
rate: 1.0, # required
period: "second", # required, accepts second, minute
},
],
},
],
})
Response structure
Response structure
resp.rate_limit_id #=> String
resp.gateway_identifier #=> String
resp.description #=> String
resp.dimension_keys #=> Array
resp.dimension_keys[0] #=> String
resp.data.entries #=> Array
resp.data.entries[0].dimensions #=> Hash
resp.data.entries[0].dimensions["DimensionKey"] #=> String
resp.data.entries[0].requests #=> Array
resp.data.entries[0].requests[0].rate #=> Float
resp.data.entries[0].requests[0].period #=> String, one of "second", "minute"
resp.data.entries[0].tokens #=> Array
resp.data.entries[0].tokens[0].rate #=> Float
resp.data.entries[0].tokens[0].period #=> String, one of "second", "minute"
resp.data.entries[0].connections #=> Array
resp.data.entries[0].connections[0].rate #=> Float
resp.data.entries[0].connections[0].period #=> String, one of "second", "minute"
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.created_at #=> Time
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The unique identifier of the gateway.
-
:rate_limit_id
(required, String)
—
The unique identifier of the rate limit to update.
-
:description
(String)
—
The updated human-readable description for this rate limit.
-
:entries
(required, Array<Types::LimitEntry>)
—
The updated rule entries. The dimension keys are immutable after creation and cannot be changed.
Returns:
-
(Types::UpdateGatewayRateLimitResponse)
—
Returns a response object which responds to the following methods:
- #rate_limit_id => String
- #gateway_identifier => String
- #description => String
- #dimension_keys => Array<String>
- #data.entries => Array<Types::LimitEntry> (This method conflicts with a method on Response, call it through the data member)
- #status => String
- #created_at => Time
- #updated_at => Time
See Also:
14469 14470 14471 14472 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 14469 def update_gateway_rate_limit(params = {}, options = {}) req = build_request(:update_gateway_rate_limit, params) req.send_request(options) end |
#update_gateway_rule(params = {}) ⇒ Types::UpdateGatewayRuleResponse
Updates a gateway rule's priority, conditions, actions, or description.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_gateway_rule({
gateway_identifier: "GatewayIdentifier", # required
rule_id: "GatewayRuleId", # required
priority: 1,
conditions: [
{
match_principals: {
any_of: [ # required
{
iam_principal: {
arn: "IamPrincipalArn", # required
operator: "StringEquals", # accepts StringEquals, StringLike
},
},
],
},
match_paths: {
any_of: ["MatchPathPattern"], # required
},
match_models: {
any_of: [ # required
{
value: "ModelPattern", # required
operator: "StringEquals", # accepts StringEquals, StringLike
},
],
},
},
],
actions: [
{
configuration_bundle: {
static_override: {
bundle_arn: "GatewayConfigurationBundleArn", # required
bundle_version: "StaticOverrideBundleVersionString", # required
},
weighted_override: {
traffic_split: [ # required
{
name: "TrafficSplitEntryNameString", # required
weight: 1, # required
configuration_bundle: { # required
bundle_arn: "GatewayConfigurationBundleArn", # required
bundle_version: "ConfigurationBundleReferenceBundleVersionString", # required
},
description: "TrafficSplitEntryDescriptionString",
metadata: {
"TrafficSplitMetadataKey" => "TrafficSplitMetadataValue",
},
},
],
},
},
route_to_target: {
static_route: {
target_name: "TargetName", # required
model: "ConcreteModelId",
fallback: {
trigger_on: {
status_codes: ["ErrorStatusCodePattern"],
errors: ["CONNECTION_ERROR"], # accepts CONNECTION_ERROR, FIRST_BYTE_TIMEOUT, UNROUTABLE
},
first_byte_timeout_milliseconds: 1,
circuit_breaker: {
mode: "ENABLED", # accepts ENABLED, DISABLED
},
target_fallback: [ # required
{
target_name: "TargetName", # required
model: "ConcreteModelId",
trigger_on: {
status_codes: ["ErrorStatusCodePattern"],
errors: ["CONNECTION_ERROR"], # accepts CONNECTION_ERROR, FIRST_BYTE_TIMEOUT, UNROUTABLE
},
first_byte_timeout_milliseconds: 1,
},
],
},
},
weighted_route: {
traffic_split: [ # required
{
target_name: "TargetName", # required
model: "ConcreteModelId",
fallback: {
trigger_on: {
status_codes: ["ErrorStatusCodePattern"],
errors: ["CONNECTION_ERROR"], # accepts CONNECTION_ERROR, FIRST_BYTE_TIMEOUT, UNROUTABLE
},
first_byte_timeout_milliseconds: 1,
circuit_breaker: {
mode: "ENABLED", # accepts ENABLED, DISABLED
},
target_fallback: [ # required
{
target_name: "TargetName", # required
model: "ConcreteModelId",
trigger_on: {
status_codes: ["ErrorStatusCodePattern"],
errors: ["CONNECTION_ERROR"], # accepts CONNECTION_ERROR, FIRST_BYTE_TIMEOUT, UNROUTABLE
},
first_byte_timeout_milliseconds: 1,
},
],
},
name: "TargetTrafficSplitEntryNameString", # required
weight: 1, # required
description: "TargetTrafficSplitEntryDescriptionString",
metadata: {
"TrafficSplitMetadataKey" => "TrafficSplitMetadataValue",
},
},
],
},
},
},
],
description: "GatewayRuleDescription",
})
Response structure
Response structure
resp.rule_id #=> String
resp.gateway_arn #=> String
resp.priority #=> Integer
resp.conditions #=> Array
resp.conditions[0].match_principals.any_of #=> Array
resp.conditions[0].match_principals.any_of[0].iam_principal.arn #=> String
resp.conditions[0].match_principals.any_of[0].iam_principal.operator #=> String, one of "StringEquals", "StringLike"
resp.conditions[0].match_paths.any_of #=> Array
resp.conditions[0].match_paths.any_of[0] #=> String
resp.conditions[0].match_models.any_of #=> Array
resp.conditions[0].match_models.any_of[0].value #=> String
resp.conditions[0].match_models.any_of[0].operator #=> String, one of "StringEquals", "StringLike"
resp.actions #=> Array
resp.actions[0].configuration_bundle.static_override.bundle_arn #=> String
resp.actions[0].configuration_bundle.static_override.bundle_version #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split #=> Array
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].name #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].weight #=> Integer
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].configuration_bundle.bundle_arn #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].configuration_bundle.bundle_version #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].description #=> String
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].metadata #=> Hash
resp.actions[0].configuration_bundle.weighted_override.traffic_split[0].metadata["TrafficSplitMetadataKey"] #=> String
resp.actions[0].route_to_target.static_route.target_name #=> String
resp.actions[0].route_to_target.static_route.model #=> String
resp.actions[0].route_to_target.static_route.fallback.trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.static_route.fallback.trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.static_route.fallback.trigger_on.errors #=> Array
resp.actions[0].route_to_target.static_route.fallback.trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.static_route.fallback.first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.static_route.fallback.circuit_breaker.mode #=> String, one of "ENABLED", "DISABLED"
resp.actions[0].route_to_target.static_route.fallback.target_fallback #=> Array
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].target_name #=> String
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].model #=> String
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.errors #=> Array
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.static_route.fallback.target_fallback[0].first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].target_name #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].model #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.errors #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.circuit_breaker.mode #=> String, one of "ENABLED", "DISABLED"
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].target_name #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].model #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.status_codes #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.status_codes[0] #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.errors #=> Array
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].trigger_on.errors[0] #=> String, one of "CONNECTION_ERROR", "FIRST_BYTE_TIMEOUT", "UNROUTABLE"
resp.actions[0].route_to_target.weighted_route.traffic_split[0].fallback.target_fallback[0].first_byte_timeout_milliseconds #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split[0].name #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].weight #=> Integer
resp.actions[0].route_to_target.weighted_route.traffic_split[0].description #=> String
resp.actions[0].route_to_target.weighted_route.traffic_split[0].metadata #=> Hash
resp.actions[0].route_to_target.weighted_route.traffic_split[0].metadata["TrafficSplitMetadataKey"] #=> String
resp.description #=> String
resp.created_at #=> Time
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.system.managed_by #=> String
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The identifier of the gateway containing the rule.
-
:rule_id
(required, String)
—
The unique identifier of the rule to update.
-
:priority
(Integer)
—
The updated priority of the rule.
-
:conditions
(Array<Types::Condition>)
—
The updated conditions for the rule.
-
:actions
(Array<Types::Action>)
—
The updated actions for the rule.
-
:description
(String)
—
The updated description of the rule.
Returns:
-
(Types::UpdateGatewayRuleResponse)
—
Returns a response object which responds to the following methods:
- #rule_id => String
- #gateway_arn => String
- #priority => Integer
- #conditions => Array<Types::Condition>
- #actions => Array<Types::Action>
- #description => String
- #created_at => Time
- #status => String
- #system => Types::SystemManagedBlock
- #updated_at => Time
See Also:
14703 14704 14705 14706 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 14703 def update_gateway_rule(params = {}, options = {}) req = build_request(:update_gateway_rule, params) req.send_request(options) end |
#update_gateway_target(params = {}) ⇒ Types::UpdateGatewayTargetResponse
Updates an existing gateway target.
You cannot update a target that is in a pending authorization state
(CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or
SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or
fail before updating the target.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_gateway_target({
gateway_identifier: "GatewayIdentifier", # required
target_id: "TargetId", # required
name: "TargetName",
description: "TargetDescription",
target_configuration: { # required
mcp: {
open_api_schema: {
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: "InlinePayload",
},
smithy_model: {
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: "InlinePayload",
},
lambda: {
lambda_arn: "LambdaFunctionArn", # required
tool_schema: { # required
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: [
{
name: "String", # required
description: "String", # required
input_schema: { # required
type: "string", # required, accepts string, number, object, array, boolean, integer
properties: {
"String" => {
# recursive SchemaDefinition
},
},
required: ["String"],
items: {
# recursive SchemaDefinition
},
description: "String",
},
output_schema: {
type: "string", # required, accepts string, number, object, array, boolean, integer
properties: {
"String" => {
# recursive SchemaDefinition
},
},
required: ["String"],
items: {
# recursive SchemaDefinition
},
description: "String",
},
},
],
},
},
mcp_server: {
endpoint: "McpServerTargetConfigurationEndpointString", # required
mcp_tool_schema: {
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: "InlinePayload",
},
listing_mode: "DEFAULT", # accepts DEFAULT, DYNAMIC
resource_priority: 1,
},
api_gateway: {
rest_api_id: "String", # required
stage: "String", # required
api_gateway_tool_configuration: { # required
tool_overrides: [
{
name: "String", # required
description: "String",
path: "String", # required
method: "GET", # required, accepts GET, DELETE, HEAD, OPTIONS, PATCH, PUT, POST
},
],
tool_filters: [ # required
{
filter_path: "String", # required
methods: ["GET"], # required, accepts GET, DELETE, HEAD, OPTIONS, PATCH, PUT, POST
},
],
},
},
connector: {
source: { # required
connector_id: "ConnectorId", # required
version: "ConnectorVersion",
},
enabled: ["String"],
configurations: [
{
name: "ConnectorConfigurationNameString", # required
description: "ConnectorConfigurationDescriptionString",
parameter_values: {
},
parameter_overrides: [
{
path: "String", # required
description: "String",
visible: false,
},
],
},
],
},
},
http: {
agentcore_runtime: {
arn: "RuntimeArn", # required
qualifier: "RuntimeQualifier",
schema: {
source: { # required
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: "InlinePayload",
},
},
},
passthrough: {
endpoint: "PassthroughEndpoint", # required
protocol_type: "MCP", # required, accepts MCP, A2A, INFERENCE, CUSTOM
schema: {
source: { # required
s3: {
uri: "S3BucketUri",
bucket_owner_account_id: "AwsAccountId",
},
inline_payload: "InlinePayload",
},
},
stickiness_configuration: {
identifier: "StickinessConfigurationIdentifierString", # required
timeout: 1,
composite_identifier: ["CompositeIdentifierEntry"],
},
static_query_parameters: {
"StaticQueryParameterName" => "StaticQueryParameterValue",
},
static_query_parameter_conflict_resolution: "CLIENT_OVERRIDE", # accepts CLIENT_OVERRIDE, STATIC_OVERRIDE
},
connector: {
source: { # required
connector_id: "ConnectorId", # required
},
parameters: {
"ConnectorParameterName" => "ConnectorParameterValue",
},
},
},
inference: {
connector: {
source: { # required
connector_id: "InferenceConnectorId", # required
},
},
provider: {
endpoint: "PassthroughEndpoint", # required
model_mapping: {
provider_prefix: {
strip: false,
separator: "ProviderPrefixSeparatorString",
},
},
operations: [
{
path: "InferenceOperationPath", # required
provider_path: "InferenceOperationPath",
models: [
{
model: "ModelPattern", # required
},
],
},
],
},
},
},
credential_provider_configurations: [
{
credential_provider_type: "GATEWAY_IAM_ROLE", # required, accepts GATEWAY_IAM_ROLE, OAUTH, API_KEY, CALLER_IAM_CREDENTIALS, JWT_PASSTHROUGH
credential_provider: {
oauth_credential_provider: {
provider_arn: "OAuthCredentialProviderArn", # required
scopes: ["OAuthScope"], # required
custom_parameters: {
"OAuthCustomParametersKey" => "OAuthCustomParametersValue",
},
grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE, TOKEN_EXCHANGE
default_return_url: "OAuthDefaultReturnUrl",
},
api_key_credential_provider: {
provider_arn: "ApiKeyCredentialProviderArn", # required
credential_parameter_name: "ApiKeyCredentialParameterName",
credential_prefix: "ApiKeyCredentialPrefix",
credential_location: "HEADER", # accepts HEADER, QUERY_PARAMETER
},
iam_credential_provider: {
service: "IamCredentialProviderServiceString", # required
region: "IamCredentialProviderRegionString",
},
},
},
],
metadata_configuration: {
allowed_request_headers: ["HttpHeaderName"],
allowed_query_parameters: ["HttpQueryParameterName"],
allowed_response_headers: ["HttpHeaderName"],
},
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
})
Response structure
Response structure
resp.gateway_arn #=> String
resp.target_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "UPDATE_UNSUCCESSFUL", "DELETING", "READY", "FAILED", "SYNCHRONIZING", "SYNCHRONIZE_UNSUCCESSFUL", "CREATE_PENDING_AUTH", "UPDATE_PENDING_AUTH", "SYNCHRONIZE_PENDING_AUTH"
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
resp.name #=> String
resp.description #=> String
resp.target_configuration.mcp.open_api_schema.s3.uri #=> String
resp.target_configuration.mcp.open_api_schema.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.open_api_schema.inline_payload #=> String
resp.target_configuration.mcp.smithy_model.s3.uri #=> String
resp.target_configuration.mcp.smithy_model.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.smithy_model.inline_payload #=> String
resp.target_configuration.mcp.lambda.lambda_arn #=> String
resp.target_configuration.mcp.lambda.tool_schema.s3.uri #=> String
resp.target_configuration.mcp.lambda.tool_schema.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload #=> Array
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].name #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].description #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.type #=> String, one of "string", "number", "object", "array", "boolean", "integer"
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.properties #=> Hash
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.properties["String"] #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.required #=> Array
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.required[0] #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.items #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].input_schema.description #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.type #=> String, one of "string", "number", "object", "array", "boolean", "integer"
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.properties #=> Hash
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.properties["String"] #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.required #=> Array
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.required[0] #=> String
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.items #=> Types::SchemaDefinition
resp.target_configuration.mcp.lambda.tool_schema.inline_payload[0].output_schema.description #=> String
resp.target_configuration.mcp.mcp_server.endpoint #=> String
resp.target_configuration.mcp.mcp_server.mcp_tool_schema.s3.uri #=> String
resp.target_configuration.mcp.mcp_server.mcp_tool_schema.s3.bucket_owner_account_id #=> String
resp.target_configuration.mcp.mcp_server.mcp_tool_schema.inline_payload #=> String
resp.target_configuration.mcp.mcp_server.listing_mode #=> String, one of "DEFAULT", "DYNAMIC"
resp.target_configuration.mcp.mcp_server.resource_priority #=> Integer
resp.target_configuration.mcp.api_gateway.rest_api_id #=> String
resp.target_configuration.mcp.api_gateway.stage #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides #=> Array
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].name #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].description #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].path #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_overrides[0].method #=> String, one of "GET", "DELETE", "HEAD", "OPTIONS", "PATCH", "PUT", "POST"
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters #=> Array
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].filter_path #=> String
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].methods #=> Array
resp.target_configuration.mcp.api_gateway.api_gateway_tool_configuration.tool_filters[0].methods[0] #=> String, one of "GET", "DELETE", "HEAD", "OPTIONS", "PATCH", "PUT", "POST"
resp.target_configuration.mcp.connector.source.connector_id #=> String
resp.target_configuration.mcp.connector.source.version #=> String
resp.target_configuration.mcp.connector.enabled #=> Array
resp.target_configuration.mcp.connector.enabled[0] #=> String
resp.target_configuration.mcp.connector.configurations #=> Array
resp.target_configuration.mcp.connector.configurations[0].name #=> String
resp.target_configuration.mcp.connector.configurations[0].description #=> String
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides #=> Array
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides[0].path #=> String
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides[0].description #=> String
resp.target_configuration.mcp.connector.configurations[0].parameter_overrides[0].visible #=> Boolean
resp.target_configuration.http.agentcore_runtime.arn #=> String
resp.target_configuration.http.agentcore_runtime.qualifier #=> String
resp.target_configuration.http.agentcore_runtime.schema.source.s3.uri #=> String
resp.target_configuration.http.agentcore_runtime.schema.source.s3.bucket_owner_account_id #=> String
resp.target_configuration.http.agentcore_runtime.schema.source.inline_payload #=> String
resp.target_configuration.http.passthrough.endpoint #=> String
resp.target_configuration.http.passthrough.protocol_type #=> String, one of "MCP", "A2A", "INFERENCE", "CUSTOM"
resp.target_configuration.http.passthrough.schema.source.s3.uri #=> String
resp.target_configuration.http.passthrough.schema.source.s3.bucket_owner_account_id #=> String
resp.target_configuration.http.passthrough.schema.source.inline_payload #=> String
resp.target_configuration.http.passthrough.stickiness_configuration.identifier #=> String
resp.target_configuration.http.passthrough.stickiness_configuration.timeout #=> Integer
resp.target_configuration.http.passthrough.stickiness_configuration.composite_identifier #=> Array
resp.target_configuration.http.passthrough.stickiness_configuration.composite_identifier[0] #=> String
resp.target_configuration.http.passthrough.static_query_parameters #=> Hash
resp.target_configuration.http.passthrough.static_query_parameters["StaticQueryParameterName"] #=> String
resp.target_configuration.http.passthrough.static_query_parameter_conflict_resolution #=> String, one of "CLIENT_OVERRIDE", "STATIC_OVERRIDE"
resp.target_configuration.http.connector.source.connector_id #=> String
resp.target_configuration.http.connector.parameters #=> Hash
resp.target_configuration.http.connector.parameters["ConnectorParameterName"] #=> String
resp.target_configuration.inference.connector.source.connector_id #=> String
resp.target_configuration.inference.provider.endpoint #=> String
resp.target_configuration.inference.provider.model_mapping.provider_prefix.strip #=> Boolean
resp.target_configuration.inference.provider.model_mapping.provider_prefix.separator #=> String
resp.target_configuration.inference.provider.operations #=> Array
resp.target_configuration.inference.provider.operations[0].path #=> String
resp.target_configuration.inference.provider.operations[0].provider_path #=> String
resp.target_configuration.inference.provider.operations[0].models #=> Array
resp.target_configuration.inference.provider.operations[0].models[0].model #=> String
resp.credential_provider_configurations #=> Array
resp.credential_provider_configurations[0].credential_provider_type #=> String, one of "GATEWAY_IAM_ROLE", "OAUTH", "API_KEY", "CALLER_IAM_CREDENTIALS", "JWT_PASSTHROUGH"
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["OAuthCustomParametersKey"] #=> String
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "TOKEN_EXCHANGE"
resp.credential_provider_configurations[0].credential_provider.oauth_credential_provider.default_return_url #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.provider_arn #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_parameter_name #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_prefix #=> String
resp.credential_provider_configurations[0].credential_provider.api_key_credential_provider.credential_location #=> String, one of "HEADER", "QUERY_PARAMETER"
resp.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
resp.last_synchronized_at #=> Time
resp.metadata_configuration.allowed_request_headers #=> Array
resp.metadata_configuration.allowed_request_headers[0] #=> String
resp.metadata_configuration.allowed_query_parameters #=> Array
resp.metadata_configuration.allowed_query_parameters[0] #=> String
resp.metadata_configuration.allowed_response_headers #=> Array
resp.metadata_configuration.allowed_response_headers[0] #=> String
resp.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.private_endpoint_managed_resources #=> Array
resp.private_endpoint_managed_resources[0].domain #=> String
resp.private_endpoint_managed_resources[0].resource_gateway_arn #=> String
resp.private_endpoint_managed_resources[0].resource_association_arn #=> String
resp.authorization_data.oauth2.authorization_url #=> String
resp.authorization_data.oauth2.user_id #=> String
resp.protocol_type #=> String, one of "MCP", "HTTP"
resp.certificate_configurations #=> Array
resp.certificate_configurations[0].s3.uri #=> String
resp.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.certificate_configurations[0].secrets_manager.secret_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:gateway_identifier
(required, String)
—
The unique identifier of the gateway associated with the target.
-
:target_id
(required, String)
—
The unique identifier of the gateway target to update.
-
:name
(String)
—
The updated name for the gateway target.
-
:description
(String)
—
The updated description for the gateway target.
-
:target_configuration
(required, Types::TargetConfiguration)
—
The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
-
:credential_provider_configurations
(Array<Types::CredentialProviderConfiguration>)
—
The updated credential provider configurations for the gateway target.
-
:metadata_configuration
(Types::MetadataConfiguration)
—
Configuration for HTTP header and query parameter propagation to the gateway target.
-
:private_endpoint
(Types::PrivateEndpoint)
—
The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.
-
:certificate_configurations
(Array<Types::CertificateConfiguration>)
—
The private certificate authority (CA) configurations for the gateway target. Use this to have the gateway trust a private CA when it establishes TLS connections to the target endpoint. Provide each certificate by reference to an Amazon S3 object or an Amazon Web Services Secrets Manager secret. You can specify only one certificate authority configuration in this list. To remove a previously configured certificate authority, omit this field on update.
Returns:
-
(Types::UpdateGatewayTargetResponse)
—
Returns a response object which responds to the following methods:
- #gateway_arn => String
- #target_id => String
- #created_at => Time
- #updated_at => Time
- #status => String
- #status_reasons => Array<String>
- #name => String
- #description => String
- #target_configuration => Types::TargetConfiguration
- #credential_provider_configurations => Array<Types::CredentialProviderConfiguration>
- #last_synchronized_at => Time
- #metadata_configuration => Types::MetadataConfiguration
- #private_endpoint => Types::PrivateEndpoint
- #private_endpoint_managed_resources => Array<Types::ManagedResourceDetails>
- #authorization_data => Types::AuthorizationData
- #protocol_type => String
- #certificate_configurations => Array<Types::CertificateConfiguration>
See Also:
15164 15165 15166 15167 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 15164 def update_gateway_target(params = {}, options = {}) req = build_request(:update_gateway_target, params) req.send_request(options) end |
#update_harness(params = {}) ⇒ Types::UpdateHarnessResponse
Operation to update a harness.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_harness({
harness_id: "HarnessId", # required
client_token: "ClientToken",
execution_role_arn: "RoleArn",
environment: {
agent_core_runtime_environment: {
lifecycle_configuration: {
idle_runtime_session_timeout: 1,
max_lifetime: 1,
},
network_configuration: {
network_mode: "PUBLIC", # required, accepts PUBLIC, VPC
network_mode_config: {
security_groups: ["SecurityGroupId"], # required
subnets: ["SubnetId"], # required
require_service_s3_endpoint: false,
},
},
filesystem_configurations: [
{
session_storage: {
mount_path: "MountPath", # required
},
s3_files_access_point: {
access_point_arn: "S3FilesAccessPointArn", # required
mount_path: "MountPath", # required
},
efs_access_point: {
access_point_arn: "EfsAccessPointArn", # required
mount_path: "MountPath", # required
},
capacity_provider_volume: {
volume_name: "CapacityProviderVolumeName", # required
mount_path: "MountPath", # required
},
},
],
},
},
environment_artifact: {
optional_value: {
container_configuration: {
container_uri: "RuntimeContainerUri", # required
},
},
},
environment_variables: {
"EnvironmentVariableKey" => "EnvironmentVariableValue",
},
authorizer_configuration: {
optional_value: {
custom_jwt_authorizer: {
discovery_url: "DiscoveryUrl", # required
allowed_audience: ["AllowedAudience"],
allowed_clients: ["AllowedClient"],
allowed_scopes: ["AllowedScopeType"],
advertised_scope_mapping: {
"AllowedScopeType" => "AllowedScopeType",
},
custom_claims: [
{
inbound_token_claim_name: "InboundTokenClaimNameType", # required
inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
authorizing_claim_match_value: { # required
claim_match_value: { # required
match_value_string: "MatchValueString",
match_value_string_list: ["MatchValueString"],
},
claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
},
},
],
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
allowed_workload_configuration: {
hosting_environments: [
{
arn: "BedrockAgentcoreResourceArn", # required
},
],
workload_identities: ["WorkloadIdentityNameType"],
},
},
},
},
model: {
bedrock_model_config: {
model_id: "ModelId", # required
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
api_format: "converse_stream", # accepts converse_stream, responses, chat_completions
additional_params: {
},
},
open_ai_model_config: {
model_id: "ModelId", # required
api_key_arn: "ApiKeyArn", # required
api_base: "HarnessOpenAiApiBase",
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
api_format: "chat_completions", # accepts chat_completions, responses
additional_params: {
},
},
gemini_model_config: {
model_id: "ModelId", # required
api_key_arn: "ApiKeyArn", # required
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
top_k: 1,
additional_params: {
},
},
lite_llm_model_config: {
model_id: "ModelId", # required
api_key_arn: "ApiKeyArn",
api_base: "HarnessLiteLlmApiBase",
max_tokens: 1,
temperature: 1.0,
top_p: 1.0,
additional_params: {
},
},
},
system_prompt: [
{
text: "SensitiveText",
},
],
tools: [
{
type: "remote_mcp", # required, accepts remote_mcp, agentcore_browser, agentcore_gateway, inline_function, agentcore_code_interpreter
name: "HarnessToolName",
config: {
remote_mcp: {
url: "HarnessRemoteMcpUrl", # required
headers: {
"HttpHeaderKey" => "HttpHeaderValue",
},
outbound_auth: {
aws_iam: {
service: "IamCredentialProviderServiceString", # required
region: "IamCredentialProviderRegionString",
},
none: {
},
},
},
agent_core_browser: {
browser_arn: "HarnessBrowserArn",
},
agent_core_gateway: {
gateway_arn: "GatewayArn", # required
outbound_auth: {
aws_iam: {
},
none: {
},
oauth: {
provider_arn: "OAuthCredentialProviderArn", # required
scopes: ["OAuthScope"], # required
custom_parameters: {
"OAuthCustomParametersKey" => "OAuthCustomParametersValue",
},
grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE, TOKEN_EXCHANGE
default_return_url: "OAuthDefaultReturnUrl",
},
},
},
inline_function: {
description: "HarnessInlineFunctionDescription", # required
input_schema: { # required
},
},
agent_core_code_interpreter: {
code_interpreter_arn: "HarnessCodeInterpreterArn",
},
},
},
],
skills: [
{
path: "HarnessSkillPath",
s3: {
uri: "HarnessSkillS3Uri", # required
},
git: {
url: "HarnessSkillGitUrl", # required
path: "String",
auth: {
credential_arn: "ApiKeyArn", # required
username: "String",
},
},
aws_skills: {
paths: ["HarnessAwsSkillPath"],
},
},
],
allowed_tools: ["HarnessAllowedTool"],
memory: {
optional_value: {
agent_core_memory_configuration: {
arn: "MemoryArn", # required
actor_id: "String",
messages_count: 1,
retrieval_config: {
"String" => {
top_k: 1,
relevance_score: 1.0,
strategy_id: "String",
},
},
},
managed_memory_configuration: {
arn: "MemoryArn",
strategies: ["SEMANTIC"], # accepts SEMANTIC, SUMMARIZATION, USER_PREFERENCE, EPISODIC
event_expiry_duration: 1,
encryption_key_arn: "KmsKeyArn",
},
disabled: {
},
},
},
truncation: {
strategy: "sliding_window", # required, accepts sliding_window, summarization, none
config: {
sliding_window: {
messages_count: 1,
},
summarization: {
summary_ratio: 1.0,
preserve_recent_messages: 1,
summarization_system_prompt: "String",
},
},
},
hooks: [
{
before_invocation: {
name: "HarnessHookName", # required
target: { # required
lambda: {
arn: "HarnessLambdaFunctionArn", # required
timeout_seconds: 1,
failure_mode: "allow", # accepts allow, deny
},
sns: {
arn: "HarnessSnsTopicArn", # required
},
event_bridge: {
arn: "HarnessEventBridgeBusArn", # required
},
},
},
after_invocation: {
name: "HarnessHookName", # required
target: { # required
lambda: {
arn: "HarnessLambdaFunctionArn", # required
timeout_seconds: 1,
failure_mode: "allow", # accepts allow, deny
},
sns: {
arn: "HarnessSnsTopicArn", # required
},
event_bridge: {
arn: "HarnessEventBridgeBusArn", # required
},
},
},
before_tool_call: {
name: "HarnessHookName", # required
target: { # required
lambda: {
arn: "HarnessLambdaFunctionArn", # required
timeout_seconds: 1,
failure_mode: "allow", # accepts allow, deny
},
sns: {
arn: "HarnessSnsTopicArn", # required
},
event_bridge: {
arn: "HarnessEventBridgeBusArn", # required
},
},
},
after_tool_call: {
name: "HarnessHookName", # required
target: { # required
lambda: {
arn: "HarnessLambdaFunctionArn", # required
timeout_seconds: 1,
failure_mode: "allow", # accepts allow, deny
},
sns: {
arn: "HarnessSnsTopicArn", # required
},
event_bridge: {
arn: "HarnessEventBridgeBusArn", # required
},
},
},
},
],
max_iterations: 1,
max_tokens: 1,
timeout_seconds: 1,
})
Response structure
Response structure
resp.harness.harness_id #=> String
resp.harness.harness_name #=> String
resp.harness.arn #=> String
resp.harness.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.harness.harness_version #=> String
resp.harness.execution_role_arn #=> String
resp.harness.created_at #=> Time
resp.harness.updated_at #=> Time
resp.harness.model.bedrock_model_config.model_id #=> String
resp.harness.model.bedrock_model_config.max_tokens #=> Integer
resp.harness.model.bedrock_model_config.temperature #=> Float
resp.harness.model.bedrock_model_config.top_p #=> Float
resp.harness.model.bedrock_model_config.api_format #=> String, one of "converse_stream", "responses", "chat_completions"
resp.harness.model.open_ai_model_config.model_id #=> String
resp.harness.model.open_ai_model_config.api_key_arn #=> String
resp.harness.model.open_ai_model_config.api_base #=> String
resp.harness.model.open_ai_model_config.max_tokens #=> Integer
resp.harness.model.open_ai_model_config.temperature #=> Float
resp.harness.model.open_ai_model_config.top_p #=> Float
resp.harness.model.open_ai_model_config.api_format #=> String, one of "chat_completions", "responses"
resp.harness.model.gemini_model_config.model_id #=> String
resp.harness.model.gemini_model_config.api_key_arn #=> String
resp.harness.model.gemini_model_config.max_tokens #=> Integer
resp.harness.model.gemini_model_config.temperature #=> Float
resp.harness.model.gemini_model_config.top_p #=> Float
resp.harness.model.gemini_model_config.top_k #=> Integer
resp.harness.model.lite_llm_model_config.model_id #=> String
resp.harness.model.lite_llm_model_config.api_key_arn #=> String
resp.harness.model.lite_llm_model_config.api_base #=> String
resp.harness.model.lite_llm_model_config.max_tokens #=> Integer
resp.harness.model.lite_llm_model_config.temperature #=> Float
resp.harness.model.lite_llm_model_config.top_p #=> Float
resp.harness.system_prompt #=> Array
resp.harness.system_prompt[0].text #=> String
resp.harness.tools #=> Array
resp.harness.tools[0].type #=> String, one of "remote_mcp", "agentcore_browser", "agentcore_gateway", "inline_function", "agentcore_code_interpreter"
resp.harness.tools[0].name #=> String
resp.harness.tools[0].config.remote_mcp.url #=> String
resp.harness.tools[0].config.remote_mcp.headers #=> Hash
resp.harness.tools[0].config.remote_mcp.headers["HttpHeaderKey"] #=> String
resp.harness.tools[0].config.remote_mcp.outbound_auth.aws_iam.service #=> String
resp.harness.tools[0].config.remote_mcp.outbound_auth.aws_iam.region #=> String
resp.harness.tools[0].config.agent_core_browser.browser_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.gateway_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.provider_arn #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.scopes #=> Array
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.scopes[0] #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.custom_parameters #=> Hash
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.custom_parameters["OAuthCustomParametersKey"] #=> String
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.grant_type #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "TOKEN_EXCHANGE"
resp.harness.tools[0].config.agent_core_gateway.outbound_auth.oauth.default_return_url #=> String
resp.harness.tools[0].config.inline_function.description #=> String
resp.harness.tools[0].config.agent_core_code_interpreter.code_interpreter_arn #=> String
resp.harness.skills #=> Array
resp.harness.skills[0].path #=> String
resp.harness.skills[0].s3.uri #=> String
resp.harness.skills[0].git.url #=> String
resp.harness.skills[0].git.path #=> String
resp.harness.skills[0].git.auth.credential_arn #=> String
resp.harness.skills[0].git.auth.username #=> String
resp.harness.skills[0].aws_skills.paths #=> Array
resp.harness.skills[0].aws_skills.paths[0] #=> String
resp.harness.allowed_tools #=> Array
resp.harness.allowed_tools[0] #=> String
resp.harness.truncation.strategy #=> String, one of "sliding_window", "summarization", "none"
resp.harness.truncation.config.sliding_window.messages_count #=> Integer
resp.harness.truncation.config.summarization.summary_ratio #=> Float
resp.harness.truncation.config.summarization.preserve_recent_messages #=> Integer
resp.harness.truncation.config.summarization.summarization_system_prompt #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_arn #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_name #=> String
resp.harness.environment.agent_core_runtime_environment.agent_runtime_id #=> String
resp.harness.environment.agent_core_runtime_environment.lifecycle_configuration.idle_runtime_session_timeout #=> Integer
resp.harness.environment.agent_core_runtime_environment.lifecycle_configuration.max_lifetime #=> Integer
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode #=> String, one of "PUBLIC", "VPC"
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.security_groups #=> Array
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.security_groups[0] #=> String
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.subnets #=> Array
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.subnets[0] #=> String
resp.harness.environment.agent_core_runtime_environment.network_configuration.network_mode_config.require_service_s3_endpoint #=> Boolean
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations #=> Array
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].session_storage.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].s3_files_access_point.access_point_arn #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].s3_files_access_point.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].efs_access_point.access_point_arn #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].efs_access_point.mount_path #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].capacity_provider_volume.volume_name #=> String
resp.harness.environment.agent_core_runtime_environment.filesystem_configurations[0].capacity_provider_volume.mount_path #=> String
resp.harness.environment_artifact.container_configuration.container_uri #=> String
resp.harness.environment_variables #=> Hash
resp.harness.environment_variables["EnvironmentVariableKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.harness.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.harness.memory.agent_core_memory_configuration.arn #=> String
resp.harness.memory.agent_core_memory_configuration.actor_id #=> String
resp.harness.memory.agent_core_memory_configuration.messages_count #=> Integer
resp.harness.memory.agent_core_memory_configuration.retrieval_config #=> Hash
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].top_k #=> Integer
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].relevance_score #=> Float
resp.harness.memory.agent_core_memory_configuration.retrieval_config["String"].strategy_id #=> String
resp.harness.memory.managed_memory_configuration.arn #=> String
resp.harness.memory.managed_memory_configuration.strategies #=> Array
resp.harness.memory.managed_memory_configuration.strategies[0] #=> String, one of "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "EPISODIC"
resp.harness.memory.managed_memory_configuration.event_expiry_duration #=> Integer
resp.harness.memory.managed_memory_configuration.encryption_key_arn #=> String
resp.harness.hooks #=> Array
resp.harness.hooks[0].before_invocation.name #=> String
resp.harness.hooks[0].before_invocation.target.lambda.arn #=> String
resp.harness.hooks[0].before_invocation.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].before_invocation.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].before_invocation.target.sns.arn #=> String
resp.harness.hooks[0].before_invocation.target.event_bridge.arn #=> String
resp.harness.hooks[0].after_invocation.name #=> String
resp.harness.hooks[0].after_invocation.target.lambda.arn #=> String
resp.harness.hooks[0].after_invocation.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].after_invocation.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].after_invocation.target.sns.arn #=> String
resp.harness.hooks[0].after_invocation.target.event_bridge.arn #=> String
resp.harness.hooks[0].before_tool_call.name #=> String
resp.harness.hooks[0].before_tool_call.target.lambda.arn #=> String
resp.harness.hooks[0].before_tool_call.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].before_tool_call.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].before_tool_call.target.sns.arn #=> String
resp.harness.hooks[0].before_tool_call.target.event_bridge.arn #=> String
resp.harness.hooks[0].after_tool_call.name #=> String
resp.harness.hooks[0].after_tool_call.target.lambda.arn #=> String
resp.harness.hooks[0].after_tool_call.target.lambda.timeout_seconds #=> Integer
resp.harness.hooks[0].after_tool_call.target.lambda.failure_mode #=> String, one of "allow", "deny"
resp.harness.hooks[0].after_tool_call.target.sns.arn #=> String
resp.harness.hooks[0].after_tool_call.target.event_bridge.arn #=> String
resp.harness.max_iterations #=> Integer
resp.harness.max_tokens #=> Integer
resp.harness.timeout_seconds #=> Integer
resp.harness.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:harness_id
(required, String)
—
The ID of the harness to update.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:execution_role_arn
(String)
—
The ARN of the IAM role that the harness assumes when running. If not specified, the existing value is retained.
-
:environment
(Types::HarnessEnvironmentProviderRequest)
—
The compute environment configuration for the harness. If not specified, the existing value is retained.
-
:environment_artifact
(Types::UpdatedHarnessEnvironmentArtifact)
—
The environment artifact for the harness. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.
-
:environment_variables
(Hash<String,String>)
—
Environment variables to set in the harness runtime environment. If specified, this replaces all existing environment variables. If not specified, the existing value is retained.
-
:authorizer_configuration
(Types::UpdatedAuthorizerConfiguration)
—
Wrapper for updating an optional AuthorizerConfiguration field with PATCH semantics. When present in an update request, the authorizer configuration is replaced with optionalValue. When absent, the authorizer configuration is left unchanged. To unset, include the wrapper with optionalValue not specified.
-
:model
(Types::HarnessModelConfiguration)
—
The model configuration for the harness. If not specified, the existing value is retained.
-
:system_prompt
(Array<Types::HarnessSystemContentBlock>)
—
The system prompt that defines the agent's behavior. If not specified, the existing value is retained.
-
:tools
(Array<Types::HarnessTool>)
—
The tools available to the agent. If specified, this replaces all existing tools. If not specified, the existing value is retained.
-
:skills
(Array<Types::HarnessSkill>)
—
The skills available to the agent. If specified, this replaces all existing skills. If not specified, the existing value is retained.
-
:allowed_tools
(Array<String>)
—
The tools that the agent is allowed to use. If specified, this replaces all existing allowed tools. If not specified, the existing value is retained.
-
:memory
(Types::UpdatedHarnessMemoryConfiguration)
—
The AgentCore Memory configuration. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.
-
:truncation
(Types::HarnessTruncationConfiguration)
—
The truncation configuration for managing conversation context. If not specified, the existing value is retained.
-
:hooks
(Array<Types::HarnessHook>)
—
The lifecycle hooks to run at defined points in the agent loop. If specified, this replaces all existing hooks. If not specified, the existing hooks are retained.
-
:max_iterations
(Integer)
—
The maximum number of iterations the agent loop can execute per invocation. If not specified, the existing value is retained.
-
:max_tokens
(Integer)
—
The maximum total number of output tokens the agent can generate across all model calls within a single invocation. If not specified, the existing value is retained.
-
:timeout_seconds
(Integer)
—
The maximum duration in seconds for the agent loop execution per invocation. If not specified, the existing value is retained.
Returns:
See Also:
15802 15803 15804 15805 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 15802 def update_harness(params = {}, options = {}) req = build_request(:update_harness, params) req.send_request(options) end |
#update_harness_endpoint(params = {}) ⇒ Types::UpdateHarnessEndpointResponse
Operation to update a harness endpoint.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_harness_endpoint({
harness_id: "HarnessId", # required
endpoint_name: "HarnessEndpointName", # required
target_version: "HarnessVersion",
description: "HarnessEndpointDescription",
client_token: "ClientToken",
})
Response structure
Response structure
resp.endpoint.harness_id #=> String
resp.endpoint.harness_name #=> String
resp.endpoint.endpoint_name #=> String
resp.endpoint.arn #=> String
resp.endpoint.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
resp.endpoint.created_at #=> Time
resp.endpoint.updated_at #=> Time
resp.endpoint.live_version #=> String
resp.endpoint.target_version #=> String
resp.endpoint.description #=> String
resp.endpoint.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:harness_id
(required, String)
—
The ID of the harness that the endpoint belongs to.
-
:endpoint_name
(required, String)
—
The name of the endpoint to update.
-
:target_version
(String)
—
The harness version that the endpoint points to. If not specified, the existing value is retained.
-
:description
(String)
—
A description of the endpoint. If not specified, the existing value is retained.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
See Also:
15862 15863 15864 15865 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 15862 def update_harness_endpoint(params = {}, options = {}) req = build_request(:update_harness_endpoint, params) req.send_request(options) end |
#update_memory(params = {}) ⇒ Types::UpdateMemoryOutput
Update an Amazon Bedrock AgentCore Memory resource memory.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_memory({
client_token: "UpdateMemoryInputClientTokenString",
memory_id: "MemoryId", # required
description: "Description",
event_expiry_duration: 1,
memory_execution_role_arn: "Arn",
memory_strategies: {
add_memory_strategies: [
{
semantic_memory_strategy: {
name: "Name", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
summary_memory_strategy: {
name: "Name", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
user_preference_memory_strategy: {
name: "Name", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
custom_memory_strategy: {
name: "Name", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
configuration: {
semantic_override: {
extraction: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
consolidation: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
},
summary_override: {
consolidation: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
},
user_preference_override: {
extraction: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
consolidation: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
},
episodic_override: {
extraction: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
consolidation: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
reflection: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
},
},
self_managed_configuration: {
trigger_conditions: [
{
message_based_trigger: {
message_count: 1,
},
token_based_trigger: {
token_count: 1,
},
time_based_trigger: {
idle_session_timeout: 1,
},
},
],
invocation_configuration: { # required
topic_arn: "Arn", # required
payload_delivery_bucket_name: "InvocationConfigurationInputPayloadDeliveryBucketNameString", # required
},
historical_context_window_size: 1,
},
},
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
episodic_memory_strategy: {
name: "Name", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
reflection_configuration: {
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
},
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
},
],
modify_memory_strategies: [
{
memory_strategy_id: "String", # required
description: "Description",
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
configuration: {
extraction: {
custom_extraction_configuration: {
semantic_extraction_override: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
user_preference_extraction_override: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
episodic_extraction_override: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
},
},
consolidation: {
custom_consolidation_configuration: {
semantic_consolidation_override: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
summary_consolidation_override: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
user_preference_consolidation_override: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
episodic_consolidation_override: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
},
},
},
reflection: {
episodic_reflection_configuration: {
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
},
custom_reflection_configuration: {
episodic_reflection_override: {
append_to_prompt: "Prompt", # required
model_id: "String", # required
namespaces: ["Namespace"],
namespace_templates: ["Namespace"],
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
},
},
},
self_managed_configuration: {
trigger_conditions: [
{
message_based_trigger: {
message_count: 1,
},
token_based_trigger: {
token_count: 1,
},
time_based_trigger: {
idle_session_timeout: 1,
},
},
],
invocation_configuration: {
topic_arn: "Arn",
payload_delivery_bucket_name: "ModifyInvocationConfigurationInputPayloadDeliveryBucketNameString",
},
historical_context_window_size: 1,
},
},
memory_record_schema: {
metadata_schema: [
{
key: "MetadataKey", # required
type: "STRING", # accepts STRING, STRINGLIST, NUMBER
extraction_type: "LLM_INFERRED", # accepts LLM_INFERRED, STRICTLY_CONSISTENT
extraction_config: {
llm_extraction_config: {
llm_extraction_instruction: "LlmExtractionInstruction",
definition: "Definition", # required
validation: {
string_validation: {
allowed_values: ["AllowedStringValue"], # required
},
string_list_validation: {
allowed_values: ["AllowedStringListValue"],
max_items: 1,
},
number_validation: {
min_value: 1.0,
max_value: 1.0,
},
},
},
},
},
],
},
record_expiry_specification: {
record_expiry_duration_days: 1,
action: "REMOVE", # accepts REMOVE
},
},
],
delete_memory_strategies: [
{
memory_strategy_id: "String", # required
},
],
},
add_indexed_keys: [
{
key: "MetadataKey", # required
type: "STRING", # required, accepts STRING, STRINGLIST, NUMBER
},
],
namespace_keys: [
{
key: "NamespaceVariableKey", # required
validation: {
allowed_values: ["NamespaceAllowedValue"],
regex_pattern: "NamespaceRegexPattern",
},
},
],
stream_delivery_resources: {
resources: [ # required
{
kinesis: {
data_stream_arn: "Arn", # required
content_configurations: [ # required
{
type: "MEMORY_RECORDS", # required, accepts MEMORY_RECORDS
level: "METADATA_ONLY", # accepts METADATA_ONLY, FULL_CONTENT
},
],
},
},
],
},
})
Response structure
Response structure
resp.memory.arn #=> String
resp.memory.id #=> String
resp.memory.name #=> String
resp.memory.description #=> String
resp.memory.encryption_key_arn #=> String
resp.memory.memory_execution_role_arn #=> String
resp.memory.event_expiry_duration #=> Integer
resp.memory.status #=> String, one of "CREATING", "ACTIVE", "FAILED", "DELETING", "UPDATING"
resp.memory.failure_reason #=> String
resp.memory.created_at #=> Time
resp.memory.updated_at #=> Time
resp.memory.strategies #=> Array
resp.memory.strategies[0].strategy_id #=> String
resp.memory.strategies[0].name #=> String
resp.memory.strategies[0].description #=> String
resp.memory.strategies[0].configuration.type #=> String, one of "SEMANTIC_OVERRIDE", "SUMMARY_OVERRIDE", "USER_PREFERENCE_OVERRIDE", "SELF_MANAGED", "EPISODIC_OVERRIDE"
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.semantic_extraction_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.semantic_extraction_override.model_id #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.user_preference_extraction_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.user_preference_extraction_override.model_id #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.episodic_extraction_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.extraction.custom_extraction_configuration.episodic_extraction_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.semantic_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.semantic_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.summary_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.summary_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.user_preference_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.user_preference_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.episodic_consolidation_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.consolidation.custom_consolidation_configuration.episodic_consolidation_override.model_id #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.append_to_prompt #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.model_id #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespaces #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespaces[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespace_templates #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.namespace_templates[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].key #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_type #=> String, one of "LLM_INFERRED", "STRICTLY_CONSISTENT"
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.llm_extraction_instruction #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.definition #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.max_items #=> Integer
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.min_value #=> Float
resp.memory.strategies[0].configuration.reflection.custom_reflection_configuration.episodic_reflection_override.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.max_value #=> Float
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespaces #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespaces[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespace_templates #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.namespace_templates[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].key #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_type #=> String, one of "LLM_INFERRED", "STRICTLY_CONSISTENT"
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.llm_extraction_instruction #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.definition #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values #=> Array
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values[0] #=> String
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.max_items #=> Integer
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.min_value #=> Float
resp.memory.strategies[0].configuration.reflection.episodic_reflection_configuration.memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.max_value #=> Float
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions #=> Array
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions[0].message_based_trigger.message_count #=> Integer
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions[0].token_based_trigger.token_count #=> Integer
resp.memory.strategies[0].configuration.self_managed_configuration.trigger_conditions[0].time_based_trigger.idle_session_timeout #=> Integer
resp.memory.strategies[0].configuration.self_managed_configuration.invocation_configuration.topic_arn #=> String
resp.memory.strategies[0].configuration.self_managed_configuration.invocation_configuration.payload_delivery_bucket_name #=> String
resp.memory.strategies[0].configuration.self_managed_configuration.historical_context_window_size #=> Integer
resp.memory.strategies[0].type #=> String, one of "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "CUSTOM", "EPISODIC"
resp.memory.strategies[0].namespaces #=> Array
resp.memory.strategies[0].namespaces[0] #=> String
resp.memory.strategies[0].namespace_templates #=> Array
resp.memory.strategies[0].namespace_templates[0] #=> String
resp.memory.strategies[0].created_at #=> Time
resp.memory.strategies[0].updated_at #=> Time
resp.memory.strategies[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.memory.strategies[0].memory_record_schema.metadata_schema #=> Array
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].key #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_type #=> String, one of "LLM_INFERRED", "STRICTLY_CONSISTENT"
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.llm_extraction_instruction #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.definition #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values #=> Array
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_validation.allowed_values[0] #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values #=> Array
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.allowed_values[0] #=> String
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.string_list_validation.max_items #=> Integer
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.min_value #=> Float
resp.memory.strategies[0].memory_record_schema.metadata_schema[0].extraction_config.llm_extraction_config.validation.number_validation.max_value #=> Float
resp.memory.strategies[0].record_expiry_duration_days #=> Integer
resp.memory.indexed_keys #=> Array
resp.memory.indexed_keys[0].key #=> String
resp.memory.indexed_keys[0].type #=> String, one of "STRING", "STRINGLIST", "NUMBER"
resp.memory.namespace_keys #=> Array
resp.memory.namespace_keys[0].key #=> String
resp.memory.namespace_keys[0].validation.allowed_values #=> Array
resp.memory.namespace_keys[0].validation.allowed_values[0] #=> String
resp.memory.namespace_keys[0].validation.regex_pattern #=> String
resp.memory.stream_delivery_resources.resources #=> Array
resp.memory.stream_delivery_resources.resources[0].kinesis.data_stream_arn #=> String
resp.memory.stream_delivery_resources.resources[0].kinesis.content_configurations #=> Array
resp.memory.stream_delivery_resources.resources[0].kinesis.content_configurations[0].type #=> String, one of "MEMORY_RECORDS"
resp.memory.stream_delivery_resources.resources[0].kinesis.content_configurations[0].level #=> String, one of "METADATA_ONLY", "FULL_CONTENT"
resp.memory.managed_by_resource_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique Amazon Web Services identifier.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:memory_id
(required, String)
—
The unique identifier of the memory to update.
-
:description
(String)
—
The updated description of the AgentCore Memory resource.
-
:event_expiry_duration
(Integer)
—
The number of days after which memory events expire, between 7 and 3650 days.
-
:memory_execution_role_arn
(String)
—
The ARN of the IAM role that provides permissions for the AgentCore Memory resource.
-
:memory_strategies
(Types::ModifyMemoryStrategies)
—
The memory strategies to add, modify, or delete.
-
:add_indexed_keys
(Array<Types::IndexedKey>)
—
Additional metadata keys to index. Previously indexed keys cannot be removed.
-
:namespace_keys
(Array<Types::NamespaceKeyEntry>)
—
The namespace variable key definitions with validation rules for this memory. This value fully replaces the existing set — any key you omit is removed. Any referenced
namespaceKeyomission will throw ValidationException. -
:stream_delivery_resources
(Types::StreamDeliveryResources)
—
Configuration for streaming memory record data to external resources.
Returns:
See Also:
16560 16561 16562 16563 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 16560 def update_memory(params = {}, options = {}) req = build_request(:update_memory, params) req.send_request(options) end |
#update_oauth_2_credential_provider(params = {}) ⇒ Types::UpdateOauth2CredentialProviderResponse
Updates an existing OAuth2 credential provider.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_oauth_2_credential_provider({
name: "CredentialProviderName", # required
credential_provider_vendor: "GoogleOauth2", # required, accepts GoogleOauth2, GithubOauth2, SlackOauth2, SalesforceOauth2, MicrosoftOauth2, CustomOauth2, AtlassianOauth2, LinkedinOauth2, XOauth2, OktaOauth2, OneLoginOauth2, PingOneOauth2, FacebookOauth2, YandexOauth2, RedditOauth2, ZoomOauth2, TwitchOauth2, SpotifyOauth2, DropboxOauth2, NotionOauth2, HubspotOauth2, CyberArkOauth2, FusionAuthOauth2, Auth0Oauth2, CognitoOauth2
oauth2_provider_config_input: { # required
custom_oauth_2_provider_config: {
oauth_discovery: { # required
discovery_url: "DiscoveryUrlType",
authorization_server_metadata: {
issuer: "IssuerUrlType", # required
authorization_endpoint: "AuthorizationEndpointType", # required
token_endpoint: "TokenEndpointType", # required
response_types: ["ResponseType"],
token_endpoint_auth_methods: ["TokenAuthMethod"],
},
},
client_id: "DefaultClientIdType",
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
on_behalf_of_token_exchange_config: {
grant_type: "TOKEN_EXCHANGE", # required, accepts TOKEN_EXCHANGE, JWT_AUTHORIZATION_GRANT
token_exchange_grant_type_config: {
actor_token_content: "NONE", # required, accepts NONE, M2M, AWS_IAM_ID_TOKEN_JWT
actor_token_scopes: ["ScopeType"],
},
on_behalf_of_authentication_config: {
client_authentication_method: "NO_CLIENT", # required, accepts NO_CLIENT
},
},
client_authentication_method: "CLIENT_SECRET_BASIC", # accepts CLIENT_SECRET_BASIC, CLIENT_SECRET_POST, AWS_IAM_ID_TOKEN_JWT, PRIVATE_KEY_JWT
private_key_jwt_config: {
private_key_source: {
kms_key_source: {
kms_key_arn: "KmsKeyArn", # required
},
},
signing_algorithm: "RS256", # accepts RS256, PS256, ES256
additional_header_claims: {
"AdditionalClaimName" => "AdditionalClaimValue",
},
additional_payload_claims: {
"AdditionalClaimName" => "AdditionalClaimValue",
},
},
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
},
google_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
github_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
slack_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
salesforce_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
microsoft_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
tenant_id: "TenantIdType",
},
atlassian_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
linkedin_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
},
included_oauth_2_provider_config: {
client_id: "ClientIdType", # required
client_secret: "DefaultClientSecretType",
client_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
client_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
issuer: "IssuerUrlType",
authorization_endpoint: "AuthorizationEndpointType",
token_endpoint: "TokenEndpointType",
},
},
})
Response structure
Response structure
resp.client_secret_arn.secret_arn #=> String
resp.client_secret_json_key #=> String
resp.client_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.name #=> String
resp.credential_provider_vendor #=> String, one of "GoogleOauth2", "GithubOauth2", "SlackOauth2", "SalesforceOauth2", "MicrosoftOauth2", "CustomOauth2", "AtlassianOauth2", "LinkedinOauth2", "XOauth2", "OktaOauth2", "OneLoginOauth2", "PingOneOauth2", "FacebookOauth2", "YandexOauth2", "RedditOauth2", "ZoomOauth2", "TwitchOauth2", "SpotifyOauth2", "DropboxOauth2", "NotionOauth2", "HubspotOauth2", "CyberArkOauth2", "FusionAuthOauth2", "Auth0Oauth2", "CognitoOauth2"
resp.credential_provider_arn #=> String
resp.callback_url #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.grant_type #=> String, one of "TOKEN_EXCHANGE", "JWT_AUTHORIZATION_GRANT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.token_exchange_grant_type_config.actor_token_content #=> String, one of "NONE", "M2M", "AWS_IAM_ID_TOKEN_JWT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.token_exchange_grant_type_config.actor_token_scopes #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.token_exchange_grant_type_config.actor_token_scopes[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.on_behalf_of_token_exchange_config.on_behalf_of_authentication_config.client_authentication_method #=> String, one of "NO_CLIENT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.client_authentication_method #=> String, one of "CLIENT_SECRET_BASIC", "CLIENT_SECRET_POST", "AWS_IAM_ID_TOKEN_JWT", "PRIVATE_KEY_JWT"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].domain #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations #=> Array
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations[0].s3.uri #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.private_key_source.kms_key_source.kms_key_arn #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.signing_algorithm #=> String, one of "RS256", "PS256", "ES256"
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_header_claims #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_header_claims["AdditionalClaimName"] #=> String
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_payload_claims #=> Hash
resp.oauth2_provider_config_output.custom_oauth_2_provider_config.private_key_jwt_config.additional_payload_claims["AdditionalClaimName"] #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.google_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.google_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.github_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.github_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.slack_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.salesforce_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.microsoft_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.atlassian_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.linkedin_oauth_2_provider_config.client_id #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.discovery_url #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.issuer #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.authorization_endpoint #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types #=> Array
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.response_types[0] #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods #=> Array
resp.oauth2_provider_config_output.included_oauth_2_provider_config.oauth_discovery.authorization_server_metadata.token_endpoint_auth_methods[0] #=> String
resp.oauth2_provider_config_output.included_oauth_2_provider_config.client_id #=> String
resp.created_time #=> Time
resp.last_updated_time #=> Time
resp.status #=> String, one of "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "READY", "DELETING", "DELETE_FAILED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the OAuth2 credential provider to update.
-
:credential_provider_vendor
(required, String)
—
The vendor of the OAuth2 credential provider.
-
:oauth2_provider_config_input
(required, Types::Oauth2ProviderConfigInput)
—
The configuration input for the OAuth2 provider.
Returns:
-
(Types::UpdateOauth2CredentialProviderResponse)
—
Returns a response object which responds to the following methods:
- #client_secret_arn => Types::Secret
- #client_secret_json_key => String
- #client_secret_source => String
- #name => String
- #credential_provider_vendor => String
- #credential_provider_arn => String
- #callback_url => String
- #oauth2_provider_config_output => Types::Oauth2ProviderConfigOutput
- #created_time => Time
- #last_updated_time => Time
- #status => String
See Also:
16901 16902 16903 16904 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 16901 def update_oauth_2_credential_provider(params = {}, options = {}) req = build_request(:update_oauth_2_credential_provider, params) req.send_request(options) end |
#update_online_evaluation_config(params = {}) ⇒ Types::UpdateOnlineEvaluationConfigResponse
Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status. Changes take effect immediately for ongoing evaluations.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_online_evaluation_config({
client_token: "ClientToken",
online_evaluation_config_id: "OnlineEvaluationConfigId", # required
description: "EvaluationConfigDescription",
rule: {
sampling_config: { # required
sampling_percentage: 1.0, # required
},
filters: [
{
key: "FilterKeyString", # required
operator: "Equals", # required, accepts Equals, NotEquals, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Contains, NotContains
value: { # required
string_value: "FilterValueStringValueString",
double_value: 1.0,
boolean_value: false,
},
},
],
session_config: {
session_timeout_minutes: 1, # required
},
},
data_source_config: {
cloud_watch_logs: {
log_group_names: ["LogGroupName"],
log_group_name_prefixes: ["LogGroupNamePrefix"],
service_names: ["ServiceName"], # required
},
},
evaluators: [
{
evaluator_id: "EvaluatorId",
},
],
insights: [
{
insight_id: "InsightId", # required
},
],
clustering_config: {
frequencies: ["DAILY"], # required, accepts DAILY, WEEKLY, MONTHLY
},
output_config: {
cloud_watch_config: { # required
log_group_name: "OptionalLogGroupName",
metrics_namespace: "MetricsNamespace",
result_destination: "DEDICATED_LOG_GROUP", # accepts DEDICATED_LOG_GROUP, SOURCE_LOG_GROUP
},
},
evaluation_execution_role_arn: "RoleArn",
execution_status: "ENABLED", # accepts ENABLED, DISABLED
})
Response structure
Response structure
resp.online_evaluation_config_arn #=> String
resp.online_evaluation_config_id #=> String
resp.updated_at #=> Time
resp.status #=> String, one of "ACTIVE", "CREATING", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "ERROR"
resp.execution_status #=> String, one of "ENABLED", "DISABLED"
resp.failure_reason #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:online_evaluation_config_id
(required, String)
—
The unique identifier of the online evaluation configuration to update.
-
:description
(String)
—
The updated description of the online evaluation configuration.
-
:rule
(Types::Rule)
—
The updated evaluation rule containing sampling configuration, filters, and session settings.
-
:data_source_config
(Types::DataSourceConfig)
—
The updated data source configuration specifying CloudWatch log groups and service names to monitor.
-
:evaluators
(Array<Types::EvaluatorReference>)
—
The updated list of evaluators to apply during online evaluation.
-
:insights
(Array<Types::Insight>)
—
The updated list of insight types to run against agent sessions.
-
:clustering_config
(Types::ClusteringConfig)
—
The updated clustering configuration for periodic batch evaluation.
-
:output_config
(Types::OutputConfig)
—
The configuration that specifies where evaluation results should be written for monitoring and analysis.
-
:evaluation_execution_role_arn
(String)
—
The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
-
:execution_status
(String)
—
The updated execution status to enable or disable the online evaluation.
Returns:
-
(Types::UpdateOnlineEvaluationConfigResponse)
—
Returns a response object which responds to the following methods:
- #online_evaluation_config_arn => String
- #online_evaluation_config_id => String
- #updated_at => Time
- #status => String
- #execution_status => String
- #failure_reason => String
See Also:
17038 17039 17040 17041 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 17038 def update_online_evaluation_config(params = {}, options = {}) req = build_request(:update_online_evaluation_config, params) req.send_request(options) end |
#update_payment_connector(params = {}) ⇒ Types::UpdatePaymentConnectorResponse
Updates an existing payment connector. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_payment_connector({
payment_manager_id: "PaymentManagerId", # required
payment_connector_id: "PaymentConnectorId", # required
description: "PaymentsDescription",
type: "CoinbaseCDP", # accepts CoinbaseCDP, StripePrivy
credential_provider_configurations: [
{
coinbase_cdp: {
credential_provider_arn: "PaymentCredentialProviderArn", # required
},
stripe_privy: {
credential_provider_arn: "PaymentCredentialProviderArn", # required
},
},
],
client_token: "ClientToken",
})
Response structure
Response structure
resp.payment_connector_id #=> String
resp.payment_manager_id #=> String
resp.name #=> String
resp.type #=> String, one of "CoinbaseCDP", "StripePrivy"
resp.credential_provider_configurations #=> Array
resp.credential_provider_configurations[0].coinbase_cdp.credential_provider_arn #=> String
resp.credential_provider_configurations[0].stripe_privy.credential_provider_arn #=> String
resp.last_updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED", "PENDING_AUTHENTICATION", "PROVISIONING", "AUTHENTICATION_EXPIRED", "AUTHENTICATION_FAILED"
resp.authorization_url #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:payment_manager_id
(required, String)
—
The unique identifier of the parent payment manager.
-
:payment_connector_id
(required, String)
—
The unique identifier of the payment connector to update.
-
:description
(String)
—
The updated description of the payment connector.
-
:type
(String)
—
The updated type of the payment connector.
-
:credential_provider_configurations
(Array<Types::CredentialsProviderConfiguration>)
—
The updated credential provider configurations for the payment connector.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
Returns:
-
(Types::UpdatePaymentConnectorResponse)
—
Returns a response object which responds to the following methods:
- #payment_connector_id => String
- #payment_manager_id => String
- #name => String
- #type => String
- #credential_provider_configurations => Array<Types::CredentialsProviderConfiguration>
- #last_updated_at => Time
- #status => String
- #authorization_url => String
See Also:
17124 17125 17126 17127 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 17124 def update_payment_connector(params = {}, options = {}) req = build_request(:update_payment_connector, params) req.send_request(options) end |
#update_payment_credential_provider(params = {}) ⇒ Types::UpdatePaymentCredentialProviderResponse
Updates an existing payment credential provider with new authentication credentials.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_payment_credential_provider({
name: "CredentialProviderName", # required
credential_provider_vendor: "CoinbaseCDP", # required, accepts CoinbaseCDP, StripePrivy
provider_configuration_input: { # required
coinbase_cdp_configuration: {
api_key_id: "CoinbaseCdpApiKeyIdType", # required
api_key_secret: "DefaultCoinbaseCdpApiKeySecretType",
api_key_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
api_key_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
wallet_secret: "DefaultCoinbaseCdpWalletSecretType",
wallet_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
wallet_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
},
stripe_privy_configuration: {
app_id: "StripePrivyAppIdType", # required
app_secret: "DefaultStripePrivyAppSecretType",
app_secret_source: "MANAGED", # accepts MANAGED, EXTERNAL
app_secret_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
authorization_private_key: "DefaultStripePrivyAuthorizationPrivateKeyType",
authorization_private_key_source: "MANAGED", # accepts MANAGED, EXTERNAL
authorization_private_key_config: {
secret_id: "SecretIdType", # required
json_key: "SecretJsonKeyType", # required
},
authorization_id: "StripePrivyAuthorizationIdType", # required
},
},
})
Response structure
Response structure
resp.name #=> String
resp.credential_provider_vendor #=> String, one of "CoinbaseCDP", "StripePrivy"
resp.credential_provider_arn #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_id #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_secret_arn.secret_arn #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_secret_json_key #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.api_key_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.coinbase_cdp_configuration.wallet_secret_arn.secret_arn #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.wallet_secret_json_key #=> String
resp.provider_configuration_output.coinbase_cdp_configuration.wallet_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.stripe_privy_configuration.app_id #=> String
resp.provider_configuration_output.stripe_privy_configuration.app_secret_arn.secret_arn #=> String
resp.provider_configuration_output.stripe_privy_configuration.app_secret_json_key #=> String
resp.provider_configuration_output.stripe_privy_configuration.app_secret_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.stripe_privy_configuration.authorization_private_key_arn.secret_arn #=> String
resp.provider_configuration_output.stripe_privy_configuration.authorization_private_key_json_key #=> String
resp.provider_configuration_output.stripe_privy_configuration.authorization_private_key_source #=> String, one of "MANAGED", "EXTERNAL"
resp.provider_configuration_output.stripe_privy_configuration.authorization_id #=> String
resp.created_time #=> Time
resp.last_updated_time #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the payment credential provider to update.
-
:credential_provider_vendor
(required, String)
—
The vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).
-
:provider_configuration_input
(required, Types::PaymentProviderConfigurationInput)
—
Configuration specific to the vendor, including API credentials.
Returns:
-
(Types::UpdatePaymentCredentialProviderResponse)
—
Returns a response object which responds to the following methods:
- #name => String
- #credential_provider_vendor => String
- #credential_provider_arn => String
- #provider_configuration_output => Types::PaymentProviderConfigurationOutput
- #created_time => Time
- #last_updated_time => Time
See Also:
17218 17219 17220 17221 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 17218 def update_payment_credential_provider(params = {}, options = {}) req = build_request(:update_payment_credential_provider, params) req.send_request(options) end |
#update_payment_manager(params = {}) ⇒ Types::UpdatePaymentManagerResponse
Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_payment_manager({
payment_manager_id: "PaymentManagerId", # required
description: "PaymentsDescription",
authorizer_type: "CUSTOM_JWT", # accepts CUSTOM_JWT, AWS_IAM
authorizer_configuration: {
custom_jwt_authorizer: {
discovery_url: "DiscoveryUrl", # required
allowed_audience: ["AllowedAudience"],
allowed_clients: ["AllowedClient"],
allowed_scopes: ["AllowedScopeType"],
advertised_scope_mapping: {
"AllowedScopeType" => "AllowedScopeType",
},
custom_claims: [
{
inbound_token_claim_name: "InboundTokenClaimNameType", # required
inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
authorizing_claim_match_value: { # required
claim_match_value: { # required
match_value_string: "MatchValueString",
match_value_string_list: ["MatchValueString"],
},
claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
},
},
],
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
allowed_workload_configuration: {
hosting_environments: [
{
arn: "BedrockAgentcoreResourceArn", # required
},
],
workload_identities: ["WorkloadIdentityNameType"],
},
},
},
role_arn: "RoleArn",
client_token: "ClientToken",
kms_key_arn: "KmsKeyArn",
})
Response structure
Response structure
resp.payment_manager_arn #=> String
resp.payment_manager_id #=> String
resp.name #=> String
resp.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM"
resp.role_arn #=> String
resp.workload_identity_details.workload_identity_arn #=> String
resp.last_updated_at #=> Time
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "READY", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.kms_key_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:payment_manager_id
(required, String)
—
The unique identifier of the payment manager to update.
-
:description
(String)
—
The updated description of the payment manager.
-
:authorizer_type
(String)
—
The updated authorizer type for the payment manager.
-
:authorizer_configuration
(Types::AuthorizerConfiguration)
—
The updated authorizer configuration for the payment manager.
-
:role_arn
(String)
—
The updated Amazon Resource Name (ARN) of the IAM role for the payment manager.
-
:client_token
(String)
—
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.**
-
:kms_key_arn
(String)
—
The updated Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt sensitive payment manager data at rest.
Returns:
-
(Types::UpdatePaymentManagerResponse)
—
Returns a response object which responds to the following methods:
- #payment_manager_arn => String
- #payment_manager_id => String
- #name => String
- #authorizer_type => String
- #role_arn => String
- #workload_identity_details => Types::WorkloadIdentityDetails
- #last_updated_at => Time
- #status => String
- #kms_key_arn => String
See Also:
17377 17378 17379 17380 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 17377 def update_payment_manager(params = {}, options = {}) req = build_request(:update_payment_manager, params) req.send_request(options) end |
#update_policy(params = {}) ⇒ Types::UpdatePolicyResponse
Updates an existing policy within the AgentCore Policy system. This
operation allows modification of the policy description and definition
while maintaining the policy's identity. The updated policy is
validated against the Cedar schema before being applied. This is an
asynchronous operation. Use the GetPolicy operation to poll the
status field to track completion.
If the updated policy is a temporal policy, the policy engine
invalidates all active temporal sessions. If the update adds or
removes temporal operators, the policy engine also invalidates active
temporal sessions. For more information about temporal policy
sessions, see session-based temporal policies. The policy engine
returns an HTTP 409 ConflictException to in-flight sessions. To
resume, you must start a new session with a new session ID.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_policy({
policy_engine_id: "ResourceId", # required
policy_id: "ResourceId", # required
description: {
optional_value: "Description",
},
definition: {
cedar: {
statement: "Statement", # required
},
policy_generation: {
policy_generation_id: "ResourceId", # required
policy_generation_asset_id: "ResourceId", # required
},
policy: {
statement: "Statement", # required
},
},
validation_mode: "FAIL_ON_ANY_FINDINGS", # accepts FAIL_ON_ANY_FINDINGS, IGNORE_ALL_FINDINGS
enforcement_mode: "ACTIVE", # accepts ACTIVE, LOG_ONLY
})
Response structure
Response structure
resp.policy_id #=> String
resp.name #=> String
resp.policy_engine_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.policy_arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.enforcement_mode #=> String, one of "ACTIVE", "LOG_ONLY"
resp.definition.cedar.statement #=> String
resp.definition.policy_generation.policy_generation_id #=> String
resp.definition.policy_generation.policy_generation_asset_id #=> String
resp.definition.policy.statement #=> String
resp.description #=> String
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_engine_id
(required, String)
—
The identifier of the policy engine that manages the policy to be updated. This ensures the policy is updated within the correct policy engine context.
-
:policy_id
(required, String)
—
The unique identifier of the policy to be updated. This must be a valid policy ID that exists within the specified policy engine.
-
:description
(Types::UpdatedDescription)
—
The new human-readable description for the policy. This optional field allows updating the policy's documentation while keeping the same policy logic.
-
:definition
(Types::PolicyDefinition)
—
The new Cedar or Dogwood policy statement that defines the access control rules. This replaces the existing policy definition with new logic while maintaining the policy's identity.
-
:validation_mode
(String)
—
The validation mode for the policy update. Determines how Cedar analyzer validation results are handled during policy updates. FAIL_ON_ANY_FINDINGS runs the Cedar analyzer and fails the update if validation issues are detected, ensuring the policy conforms to the Cedar schema and tool context. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows updates despite validation warnings. Use FAIL_ON_ANY_FINDINGS to ensure policy correctness during updates, especially when modifying policy logic or conditions.
-
:enforcement_mode
(String)
—
The enforcement mode for the policy. Run this policy in
LOG_ONLYmode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy toACTIVE. If you omit this field, the policy's existing enforcement mode is unchanged.
Returns:
-
(Types::UpdatePolicyResponse)
—
Returns a response object which responds to the following methods:
- #policy_id => String
- #name => String
- #policy_engine_id => String
- #created_at => Time
- #updated_at => Time
- #policy_arn => String
- #status => String
- #enforcement_mode => String
- #definition => Types::PolicyDefinition
- #description => String
- #status_reasons => Array<String>
See Also:
17497 17498 17499 17500 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 17497 def update_policy(params = {}, options = {}) req = build_request(:update_policy, params) req.send_request(options) end |
#update_policy_engine(params = {}) ⇒ Types::UpdatePolicyEngineResponse
Updates an existing policy engine within the AgentCore Policy system.
This operation allows modification of the policy engine description
while maintaining its identity. This is an asynchronous operation. Use
the GetPolicyEngine operation to poll the status field to track
completion.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_policy_engine({
policy_engine_id: "ResourceId", # required
description: {
optional_value: "Description",
},
})
Response structure
Response structure
resp.policy_engine_id #=> String
resp.name #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.policy_engine_arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.encryption_key_arn #=> String
resp.description #=> String
resp.status_reasons #=> Array
resp.status_reasons[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:policy_engine_id
(required, String)
—
The unique identifier of the policy engine to be updated.
-
:description
(Types::UpdatedDescription)
—
The new description for the policy engine.
Returns:
-
(Types::UpdatePolicyEngineResponse)
—
Returns a response object which responds to the following methods:
- #policy_engine_id => String
- #name => String
- #created_at => Time
- #updated_at => Time
- #policy_engine_arn => String
- #status => String
- #encryption_key_arn => String
- #description => String
- #status_reasons => Array<String>
See Also:
17552 17553 17554 17555 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 17552 def update_policy_engine(params = {}, options = {}) req = build_request(:update_policy_engine, params) req.send_request(options) end |
#update_registry(params = {}) ⇒ Types::UpdateRegistryResponse
Updates an existing registry. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_registry({
registry_id: "RegistryIdentifier", # required
name: "RegistryName",
description: {
optional_value: "Description",
},
authorizer_configuration: {
optional_value: {
custom_jwt_authorizer: {
discovery_url: "DiscoveryUrl", # required
allowed_audience: ["AllowedAudience"],
allowed_clients: ["AllowedClient"],
allowed_scopes: ["AllowedScopeType"],
advertised_scope_mapping: {
"AllowedScopeType" => "AllowedScopeType",
},
custom_claims: [
{
inbound_token_claim_name: "InboundTokenClaimNameType", # required
inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
authorizing_claim_match_value: { # required
claim_match_value: { # required
match_value_string: "MatchValueString",
match_value_string_list: ["MatchValueString"],
},
claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
},
},
],
private_endpoint: {
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
private_endpoint_overrides: [
{
domain: "PrivateEndpointOverrideDomain", # required
private_endpoint: { # required
self_managed_lattice_resource: {
resource_configuration_identifier: "ResourceConfigurationIdentifier",
},
managed_vpc_resource: {
vpc_identifier: "VpcIdentifier", # required
subnet_ids: ["SubnetId"], # required
endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
security_group_ids: ["SecurityGroupIdentifier"],
tags: {
"TagKey" => "TagValue",
},
routing_domain: "RoutingDomain",
},
},
},
],
certificate_configurations: [
{
s3: {
uri: "CertificateS3Uri", # required
bucket_owner_account_id: "CertificateBucketOwnerAccountId",
},
secrets_manager: {
secret_arn: "CertificateSecretArn", # required
},
},
],
allowed_workload_configuration: {
hosting_environments: [
{
arn: "BedrockAgentcoreResourceArn", # required
},
],
workload_identities: ["WorkloadIdentityNameType"],
},
},
},
},
approval_configuration: {
optional_value: {
auto_approval: false,
},
},
})
Response structure
Response structure
resp.name #=> String
resp.description #=> String
resp.registry_id #=> String
resp.registry_arn #=> String
resp.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM"
resp.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.advertised_scope_mapping["AllowedScopeType"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.uri #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].s3.bucket_owner_account_id #=> String
resp.authorizer_configuration.custom_jwt_authorizer.certificate_configurations[0].secrets_manager.secret_arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.hosting_environments[0].arn #=> String
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities #=> Array
resp.authorizer_configuration.custom_jwt_authorizer.allowed_workload_configuration.workload_identities[0] #=> String
resp.approval_configuration.auto_approval #=> Boolean
resp.status #=> String, one of "CREATING", "READY", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.status_reason #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:registry_id
(required, String)
—
The identifier of the registry to update. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
-
:name
(String)
—
The updated name of the registry.
-
:description
(Types::UpdatedDescription)
—
The updated description of the registry. To clear the description, include the
UpdatedDescriptionwrapper withoptionalValuenot specified. -
:authorizer_configuration
(Types::UpdatedAuthorizerConfiguration)
—
The updated authorizer configuration for the registry. Changing the authorizer configuration can break existing consumers of the registry who are using the authorization type prior to the update.
-
:approval_configuration
(Types::UpdatedApprovalConfiguration)
—
The updated approval configuration for registry records. The updated configuration only affects new records that move to
PENDING_APPROVALstatus after the change. Existing records already inPENDING_APPROVALstatus are not affected.
Returns:
-
(Types::UpdateRegistryResponse)
—
Returns a response object which responds to the following methods:
- #name => String
- #description => String
- #registry_id => String
- #registry_arn => String
- #authorizer_type => String
- #authorizer_configuration => Types::AuthorizerConfiguration
- #approval_configuration => Types::ApprovalConfiguration
- #status => String
- #status_reason => String
- #created_at => Time
- #updated_at => Time
See Also:
17755 17756 17757 17758 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 17755 def update_registry(params = {}, options = {}) req = build_request(:update_registry, params) req.send_request(options) end |
#update_registry_record(params = {}) ⇒ Types::UpdateRegistryRecordResponse
Updates an existing registry record. This operation uses PATCH semantics, so you only need to specify the fields you want to change. The update is processed asynchronously and returns HTTP 202 Accepted.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_registry_record({
registry_id: "RegistryIdentifier", # required
record_id: "RecordIdentifier", # required
name: "RegistryRecordName",
description: {
optional_value: "Description",
},
descriptor_type: "MCP", # accepts MCP, A2A, CUSTOM, AGENT_SKILLS
descriptors: {
optional_value: {
mcp: {
optional_value: {
server: {
optional_value: {
schema_version: "SchemaVersion",
inline_content: "InlineContent",
},
},
tools: {
optional_value: {
protocol_version: "SchemaVersion",
inline_content: "InlineContent",
},
},
},
},
a2a: {
optional_value: {
agent_card: {
schema_version: "SchemaVersion",
inline_content: "InlineContent",
},
},
},
custom: {
optional_value: {
inline_content: "InlineContent",
},
},
agent_skills: {
optional_value: {
skill_md: {
optional_value: {
inline_content: "InlineContent",
},
},
skill_definition: {
optional_value: {
schema_version: "SchemaVersion",
inline_content: "InlineContent",
},
},
},
},
},
},
record_version: "RegistryRecordVersion",
synchronization_type: {
optional_value: "URL", # accepts URL
},
synchronization_configuration: {
optional_value: {
from_url: {
url: "McpServerUrl", # required
credential_provider_configurations: [
{
credential_provider_type: "OAUTH", # required, accepts OAUTH, IAM
credential_provider: { # required
oauth_credential_provider: {
provider_arn: "CredentialProviderArn", # required
grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS
scopes: ["String"],
custom_parameters: {
"String" => "String",
},
},
iam_credential_provider: {
role_arn: "IamRoleArn",
service: "IamSigningServiceName",
region: "IamSigningRegion",
},
},
},
],
},
},
},
trigger_synchronization: false,
})
Response structure
Response structure
resp.registry_arn #=> String
resp.record_arn #=> String
resp.record_id #=> String
resp.name #=> String
resp.description #=> String
resp.descriptor_type #=> String, one of "MCP", "A2A", "CUSTOM", "AGENT_SKILLS"
resp.descriptors.mcp.server.schema_version #=> String
resp.descriptors.mcp.server.inline_content #=> String
resp.descriptors.mcp.tools.protocol_version #=> String
resp.descriptors.mcp.tools.inline_content #=> String
resp.descriptors.a2a.agent_card.schema_version #=> String
resp.descriptors.a2a.agent_card.inline_content #=> String
resp.descriptors.custom.inline_content #=> String
resp.descriptors.agent_skills.skill_md.inline_content #=> String
resp.descriptors.agent_skills.skill_definition.schema_version #=> String
resp.descriptors.agent_skills.skill_definition.inline_content #=> String
resp.record_version #=> String
resp.status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status_reason #=> String
resp.synchronization_type #=> String, one of "URL"
resp.synchronization_configuration.from_url.url #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations #=> Array
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider_type #=> String, one of "OAUTH", "IAM"
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS"
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["String"] #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.role_arn #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.synchronization_configuration.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:registry_id
(required, String)
—
The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
-
:record_id
(required, String)
—
The identifier of the registry record to update. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
-
:name
(String)
—
The updated name for the registry record.
-
:description
(Types::UpdatedDescription)
—
The updated description for the registry record. To clear the description, include the
UpdatedDescriptionwrapper withoptionalValuenot specified. -
:descriptor_type
(String)
—
The updated descriptor type for the registry record. Changing the descriptor type may require updating the
descriptorsfield to match the new type's schema requirements. -
:descriptors
(Types::UpdatedDescriptors)
—
The updated descriptor-type-specific configuration containing the resource schema and metadata. Uses PATCH semantics where individual descriptor fields can be updated independently.
-
:record_version
(String)
—
The version of the registry record for optimistic locking. If provided, it must match the current version of the record. The service automatically increments the version after a successful update.
-
:synchronization_type
(Types::UpdatedSynchronizationType)
—
The updated synchronization type for the registry record.
-
:synchronization_configuration
(Types::UpdatedSynchronizationConfiguration)
—
The updated synchronization configuration for the registry record.
-
:trigger_synchronization
(Boolean)
—
Whether to trigger synchronization using the stored or provided configuration. When set to
true, the service will synchronize the record metadata from the configured external source.
Returns:
-
(Types::UpdateRegistryRecordResponse)
—
Returns a response object which responds to the following methods:
- #registry_arn => String
- #record_arn => String
- #record_id => String
- #name => String
- #description => String
- #descriptor_type => String
- #descriptors => Types::Descriptors
- #record_version => String
- #status => String
- #created_at => Time
- #updated_at => Time
- #status_reason => String
- #synchronization_type => String
- #synchronization_configuration => Types::SynchronizationConfiguration
See Also:
17956 17957 17958 17959 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 17956 def update_registry_record(params = {}, options = {}) req = build_request(:update_registry_record, params) req.send_request(options) end |
#update_registry_record_status(params = {}) ⇒ Types::UpdateRegistryRecordStatusResponse
Updates the status of a registry record. Use this operation to approve, reject, or deprecate a registry record.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_registry_record_status({
registry_id: "RegistryIdentifier", # required
record_id: "RecordIdentifier", # required
status: "DRAFT", # required, accepts DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, DEPRECATED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED
status_reason: "UpdateRegistryRecordStatusRequestStatusReasonString", # required
})
Response structure
Response structure
resp.registry_arn #=> String
resp.record_arn #=> String
resp.record_id #=> String
resp.status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.status_reason #=> String
resp.updated_at #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:registry_id
(required, String)
—
The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
-
:record_id
(required, String)
—
The identifier of the registry record to update the status for. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
-
:status
(required, String)
—
The target status for the registry record.
-
:status_reason
(required, String)
—
The reason for the status change, such as why the record was approved or rejected.
Returns:
-
(Types::UpdateRegistryRecordStatusResponse)
—
Returns a response object which responds to the following methods:
- #registry_arn => String
- #record_arn => String
- #record_id => String
- #status => String
- #status_reason => String
- #updated_at => Time
See Also:
18011 18012 18013 18014 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 18011 def update_registry_record_status(params = {}, options = {}) req = build_request(:update_registry_record_status, params) req.send_request(options) end |
#update_workload_identity(params = {}) ⇒ Types::UpdateWorkloadIdentityResponse
Updates an existing workload identity.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_workload_identity({
name: "WorkloadIdentityNameType", # required
allowed_resource_oauth_2_return_urls: ["ResourceOauth2ReturnUrlType"],
})
Response structure
Response structure
resp.name #=> String
resp.workload_identity_arn #=> String
resp.allowed_resource_oauth_2_return_urls #=> Array
resp.allowed_resource_oauth_2_return_urls[0] #=> String
resp.created_time #=> Time
resp.last_updated_time #=> Time
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:name
(required, String)
—
The name of the workload identity to update.
-
:allowed_resource_oauth_2_return_urls
(Array<String>)
—
The new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.
Returns:
-
(Types::UpdateWorkloadIdentityResponse)
—
Returns a response object which responds to the following methods:
- #name => String
- #workload_identity_arn => String
- #allowed_resource_oauth_2_return_urls => Array<String>
- #created_time => Time
- #last_updated_time => Time
See Also:
18053 18054 18055 18056 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 18053 def update_workload_identity(params = {}, options = {}) req = build_request(:update_workload_identity, params) req.send_request(options) 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 |
| policy_active | #get_policy | 5 | 24 |
| policy_deleted | #get_policy | 2 | 60 |
| policy_engine_active | #get_policy_engine | 5 | 24 |
| policy_engine_deleted | #get_policy_engine | 2 | 60 |
| policy_generation_completed | #get_policy_generation | 5 | 24 |
Parameters:
- waiter_name (Symbol)
-
params
(Hash)
(defaults to: {})
—
({})
-
options
(Hash)
(defaults to: {})
—
({})
Options Hash (options):
- :max_attempts (Integer)
- :delay (Integer)
- :before_attempt (Proc)
- :before_wait (Proc)
Yields:
- (w.waiter)
Returns:
-
(Boolean)
—
Returns
trueif the waiter was successful.
Raises:
-
(Errors::FailureStateError)
—
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
-
(Errors::TooManyAttemptsError)
—
Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
-
(Errors::UnexpectedError)
—
Raised when an error is encounted while polling for a resource that is not expected.
-
(Errors::NoSuchWaiterError)
—
Raised when you request to wait for an unknown state.
18173 18174 18175 18176 18177 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/client.rb', line 18173 def wait_until(waiter_name, params = {}, options = {}) w = waiter(waiter_name, options) yield(w.waiter) if block_given? # deprecated w.wait(params) end |