Amazon Web Services, Inc.

Amazon Bedrock AgentCore Control

Welcome to the Amazon Bedrock AgentCore Control plane API reference. Control plane actions configure, create, modify, and monitor Amazon Web Services resources.

AI & machine learning#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Welcome to the Amazon Bedrock AgentCore Control plane API reference. Control plane actions configure, create, modify, and monitor Amazon Web Services resources.

Endpoints 172

Dataset

  • POSTAdd dataset examples/datasets/:datasetId/examples/addAdds 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,…
  • GETList datasets/datasets?nextToken=string&maxResults=0Lists all datasets in the caller's account, paginated.
  • POSTCreate dataset/datasetsCreates a new dataset resource asynchronously. Returns immediately with status CREATING. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED.
  • GETList dataset versions/datasets/:datasetId/versions?nextToken=string&maxResults=0Lists all published versions of a dataset, sorted by version number descending (newest first). Does not include the DRAFT working copy.
  • POSTCreate dataset version/datasets/:datasetId/versionsPublishes the current DRAFT as a new numbered version. The DRAFT is preserved and remains editable after publishing. Returns immediately with status UPDATING.…
  • GETGet dataset/datasets/:datasetId?datasetVersion=stringRetrieves dataset metadata. Use the datasetVersion query parameter to retrieve a specific version's metadata. If absent, defaults to DRAFT. For paginated…
  • PUTUpdate dataset/datasets/:datasetIdUpdates a dataset's metadata. Synchronous operation. Only provided fields are updated; omitted fields remain unchanged. To modify dataset content, use…
  • DELETEDelete dataset/datasets/:datasetId?datasetVersion=stringDeletes a dataset version or an entire dataset asynchronously. If datasetVersion is absent, deletes all versions and the dataset record itself. If provided,…
  • POSTDelete dataset examples/datasets/:datasetId/examples/deleteDeletes 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…
  • GETList dataset examples/datasets/:datasetId/examples?datasetVersion=string&maxResults=0&nextToken=stringReturns paginated examples from the dataset. The server embeds the resolved version in the pagination token. Once pagination begins, all subsequent pages are…
  • POSTUpdate dataset examples/datasets/:datasetId/examples/updateUpdates multiple existing examples in-place on DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example…

Gateway rate limit

  • PUTBatch put gateway rate limits/gateways/:gatewayIdentifier/rate-limits/batchAtomically creates or updates multiple rate limits for a gateway. The operation updates existing limits with matching keys and creates new limits for new…
  • GETList gateway rate limits/gateways/:gatewayIdentifier/rate-limits?maxResults=0&nextToken=stringLists all rate limits for a gateway. Results are paginated. Use the nextToken parameter to retrieve additional results.
  • POSTCreate gateway rate limit/gateways/:gatewayIdentifier/rate-limitsCreates a rate limit for a gateway. Rate limits define throttling rules for each dimension that control request rates, token consumption rates, and concurrent…
  • GETGet gateway rate limit/gateways/:gatewayIdentifier/rate-limits/:rateLimitIdRetrieves information about a gateway rate limit.
  • DELETEDelete gateway rate limit/gateways/:gatewayIdentifier/rate-limits/:rateLimitIdDeletes a gateway rate limit.
  • PATCHUpdate gateway rate limit/gateways/:gatewayIdentifier/rate-limits/:rateLimitIdUpdates the entries of a gateway rate limit. The dimension keys are immutable after creation.

Agent

  • PUTCreate agent runtime/runtimes/Creates an Amazon Bedrock AgentCore Runtime.
  • POSTList agent runtimes/runtimes/?maxResults=0&nextToken=stringLists all Amazon Secure Agents in your account.
  • GETGet agent runtime/runtimes/:agentRuntimeId/?version=stringGets an Amazon Bedrock AgentCore Runtime.
  • PUTUpdate agent runtime/runtimes/:agentRuntimeId/Updates an existing Amazon Secure Agent.
  • DELETEDelete agent runtime/runtimes/:agentRuntimeId/?version=string&clientToken=stringDeletes an Amazon Bedrock AgentCore Runtime, or a single version of an AgentCore Runtime when you provide the version qualifier.
  • POSTList agent runtime versions/runtimes/:agentRuntimeId/versions/?maxResults=0&nextToken=stringLists all versions of a specific Amazon Secure Agent.

Agent endpoint

  • PUTCreate agent runtime endpoint/runtimes/:agentRuntimeId/runtime-endpoints/Creates an AgentCore Runtime endpoint.
  • POSTList agent runtime endpoints/runtimes/:agentRuntimeId/runtime-endpoints/?maxResults=0&nextToken=stringLists all endpoints for a specific Amazon Secure Agent.
  • GETGet agent runtime endpoint/runtimes/:agentRuntimeId/runtime-endpoints/:endpointName/Gets information about an Amazon Secure AgentEndpoint.
  • PUTUpdate agent runtime endpoint/runtimes/:agentRuntimeId/runtime-endpoints/:endpointName/Updates an existing Amazon Bedrock AgentCore Runtime endpoint.
  • DELETEDelete agent runtime endpoint/runtimes/:agentRuntimeId/runtime-endpoints/:endpointName/?clientToken=stringDeletes an AgentCore Runtime endpoint.

Api key credential provider

  • POSTCreate api key credential provider/identities/CreateApiKeyCredentialProviderCreates a new API key credential provider.
  • POSTDelete api key credential provider/identities/DeleteApiKeyCredentialProviderDeletes an API key credential provider.
  • POSTGet api key credential provider/identities/GetApiKeyCredentialProviderRetrieves information about an API key credential provider.
  • POSTList api key credential providers/identities/ListApiKeyCredentialProvidersLists all API key credential providers in your account.
  • POSTUpdate api key credential provider/identities/UpdateApiKeyCredentialProviderUpdates an existing API key credential provider.

Browser

  • PUTCreate browser/browsersCreates a custom browser.
  • POSTList browsers/browsers?maxResults=0&nextToken=string&type=stringLists all custom browsers in your account.
  • GETGet browser/browsers/:browserIdGets information about a custom browser.
  • DELETEDelete browser/browsers/:browserId?clientToken=stringDeletes a custom browser.

Browser profile

  • PUTCreate browser profile/browser-profilesCreates a browser profile in Amazon Bedrock AgentCore. A browser profile stores persistent browser data such as cookies, local storage, session storage, and…
  • POSTList browser profiles/browser-profiles?maxResults=0&nextToken=stringLists all browser profiles in your account.
  • GETGet browser profile/browser-profiles/:profileIdGets information about a browser profile.
  • DELETEDelete browser profile/browser-profiles/:profileId?clientToken=stringDeletes a browser profile.

Capacity provider

  • PUTCreate capacity provider/capacity-providersCreates a capacity provider. A capacity provider defines the Amazon EC2 infrastructure for AgentCore Runtime, including the operating system, allowed instance…
  • POSTList capacity providers/capacity-providers?maxResults=0&nextToken=stringLists the capacity providers in your account and returns summary information for each one. To retrieve the full configuration for a specific capacity…
  • GETGet capacity provider/capacity-providers/:capacityProviderIdRetrieves information about a capacity provider, including its status, permissions configuration, and compute configuration.
  • PUTUpdate capacity provider/capacity-providers/:capacityProviderIdUpdates a capacity provider. Only the description can be changed. To change other configuration, such as instance types, networking, or storage, create a new…
  • DELETEDelete capacity provider/capacity-providers/:capacityProviderId?clientToken=stringDeletes a capacity provider. Before you delete a capacity provider, disassociate all agent runtimes and runtime versions that reference it. If any references…
  • POSTList agent runtime versions by capacity provider/capacity-providers/:capacityProviderId/runtime-versions?maxResults=0&nextToken=stringLists the agent runtime versions that are associated with a capacity provider. Use this operation to identify the runtimes you must disassociate before you…

Code interpreter

  • PUTCreate code interpreter/code-interpretersCreates a custom code interpreter.
  • POSTList code interpreters/code-interpreters?maxResults=0&nextToken=string&type=stringLists all custom code interpreters in your account.
  • GETGet code interpreter/code-interpreters/:codeInterpreterIdGets information about a custom code interpreter.
  • DELETEDelete code interpreter/code-interpreters/:codeInterpreterId?clientToken=stringDeletes a custom code interpreter.

Configuration bundle

  • POSTCreate configuration bundle/configuration-bundles/createCreates a new configuration bundle resource. A configuration bundle stores versioned component configurations for agent evaluation workflows.
  • GETGet configuration bundle/configuration-bundles/:bundleId?branchName=stringGets the latest version of a configuration bundle. By default, returns the latest version on the mainline branch. Use GetConfigurationBundleVersion to…
  • PUTUpdate configuration bundle/configuration-bundles/:bundleIdUpdates a configuration bundle by creating a new version with the specified changes. Each update creates a new version in the version history.
  • DELETEDelete configuration bundle/configuration-bundles/:bundleIdDeletes a configuration bundle and all of its versions.
  • GETGet configuration bundle version/configuration-bundles/:bundleId/versions/:versionIdGets a specific version of a configuration bundle by its version identifier.
  • POSTList configuration bundle versions/configuration-bundles/:bundleId/versions?nextToken=string&maxResults=0Lists all versions of a configuration bundle, with optional filtering by branch name or creation source.
  • POSTList configuration bundles/configuration-bundles?nextToken=string&maxResults=0Lists all configuration bundles in the account.

Consent portal

  • POSTCreate consent portal/identities/CreateConsentPortalCreates a new consent portal.
  • POSTDelete consent portal/identities/DeleteConsentPortalDeletes a consent portal.
  • POSTGet consent portal/identities/GetConsentPortalRetrieves information about a consent portal.
  • POSTList consent portals/identities/ListConsentPortalsLists all of the consent portals in your account.
  • POSTUpdate consent portal/identities/UpdateConsentPortalUpdates an existing consent portal.

Evaluator

  • POSTCreate evaluator/evaluators/createCreates a custom evaluator for agent quality assessment. Custom evaluators can use either LLM-as-a-Judge configurations with user-defined prompts, rating…
  • GETGet evaluator/evaluators/:evaluatorId?includedData=stringRetrieves detailed information about an evaluator, including its configuration, status, and metadata. Works with both built-in and custom evaluators.
  • PUTUpdate evaluator/evaluators/:evaluatorIdUpdates a custom evaluator's configuration, description, or evaluation level. Built-in evaluators cannot be updated. The evaluator must not be locked for…
  • DELETEDelete evaluator/evaluators/:evaluatorIdDeletes a custom evaluator. Builtin evaluators cannot be deleted. The evaluator must not be referenced by any active online evaluation configurations.
  • POSTList evaluators/evaluators?nextToken=string&maxResults=0Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.

Gateway

  • GETList gateways/gateways/?maxResults=0&nextToken=stringLists all gateways in the account.
  • POSTCreate gateway/gateways/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…
  • GETGet gateway/gateways/:gatewayIdentifier/Retrieves information about a specific Gateway.
  • PUTUpdate gateway/gateways/:gatewayIdentifier/Updates an existing gateway. Replaces the entire gateway configuration. Any optional field that you omit, including fields in protocolConfiguration , is…
  • DELETEDelete gateway/gateways/:gatewayIdentifier/Deletes a gateway.

Gateway rule

  • GETList gateway rules/gateways/:gatewayIdentifier/rules?maxResults=0&nextToken=stringLists all rules for a gateway.
  • POSTCreate gateway rule/gateways/:gatewayIdentifier/rulesCreates a rule for a gateway. Rules define conditions and actions that control how requests are routed and processed through the gateway, including…
  • GETGet gateway rule/gateways/:gatewayIdentifier/rules/:ruleIdRetrieves detailed information about a specific gateway rule.
  • DELETEDelete gateway rule/gateways/:gatewayIdentifier/rules/:ruleIdDeletes a gateway rule.
  • PATCHUpdate gateway rule/gateways/:gatewayIdentifier/rules/:ruleIdUpdates a gateway rule's priority, conditions, actions, or description.

Gateway target

  • GETList gateway targets/gateways/:gatewayIdentifier/targets/?maxResults=0&nextToken=stringLists all targets for a specific gateway.
  • POSTCreate gateway target/gateways/:gatewayIdentifier/targets/Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.
  • GETGet gateway target/gateways/:gatewayIdentifier/targets/:targetId/Retrieves information about a specific gateway target.
  • PUTUpdate gateway target/gateways/:gatewayIdentifier/targets/:targetId/Updates an existing gateway target. You cannot update a target that is in a pending authorization state ( CREATE_PENDING_AUTH , UPDATE_PENDING_AUTH , or…
  • DELETEDelete gateway target/gateways/:gatewayIdentifier/targets/:targetId/Deletes a gateway target. You cannot delete a target that is in a pending authorization state ( CREATE_PENDING_AUTH , UPDATE_PENDING_AUTH , or…
  • PUTSynchronize gateway targets/gateways/:gatewayIdentifier/synchronizeTargetsSynchronizes the gateway targets by fetching the latest tool definitions from the target endpoints. You cannot synchronize a target that is in a pending…

Harness

  • GETList harnesses/harnesses?maxResults=0&nextToken=stringOperation to list harnesses.
  • POSTCreate harness/harnessesOperation to create a harness.
  • GETGet harness/harnesses/:harnessId?harnessVersion=stringOperation to get a single harness.
  • DELETEDelete harness/harnesses/:harnessId?clientToken=string&deleteManagedMemory=trueOperation to delete a Harness.
  • PATCHUpdate harness/harnesses/:harnessIdOperation to update a harness.
  • GETList harness versions/harnesses/:harnessId/versions?maxResults=0&nextToken=stringOperation to list the versions of a Harness.

Harness endpoint

  • GETList harness endpoints/harnesses/:harnessId/endpoints?maxResults=0&nextToken=stringOperation to list the endpoints of a harness.
  • POSTCreate harness endpoint/harnesses/:harnessId/endpointsOperation to create a harness endpoint.
  • GETGet harness endpoint/harnesses/:harnessId/endpoints/:endpointNameOperation to get a single harness endpoint.
  • DELETEDelete harness endpoint/harnesses/:harnessId/endpoints/:endpointName?clientToken=stringOperation to delete a harness endpoint.
  • PATCHUpdate harness endpoint/harnesses/:harnessId/endpoints/:endpointNameOperation to update a harness endpoint.

Memory

  • POSTCreate memory/memories/createCreates a new Amazon Bedrock AgentCore Memory resource.
  • DELETEDelete memory/memories/:memoryId/delete?clientToken=stringDeletes an Amazon Bedrock AgentCore Memory resource. When you delete a memory resource, it is permanently removed.
  • GETGet memory/memories/:memoryId/details?view=stringRetrieve an existing Amazon Bedrock AgentCore Memory resource.
  • POSTList memories/memories/Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.
  • PUTUpdate memory/memories/:memoryId/updateUpdate an Amazon Bedrock AgentCore Memory resource memory.

Oauth2 credential provider

  • POSTCreate oauth2 credential provider/identities/CreateOauth2CredentialProviderCreates a new OAuth2 credential provider.
  • POSTDelete oauth2 credential provider/identities/DeleteOauth2CredentialProviderDeletes an OAuth2 credential provider.
  • POSTGet oauth2 credential provider/identities/GetOauth2CredentialProviderRetrieves information about an OAuth2 credential provider.
  • POSTList oauth2 credential providers/identities/ListOauth2CredentialProvidersLists all OAuth2 credential providers in your account.
  • POSTUpdate oauth2 credential provider/identities/UpdateOauth2CredentialProviderUpdates an existing OAuth2 credential provider.

Online evaluation config

  • POSTCreate online evaluation config/online-evaluation-configs/createCreates an online evaluation configuration for continuous monitoring of agent performance. Online evaluation automatically samples live traffic from…
  • GETGet online evaluation config/online-evaluation-configs/:onlineEvaluationConfigIdRetrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.
  • PUTUpdate online evaluation config/online-evaluation-configs/:onlineEvaluationConfigIdUpdates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status. Changes take effect immediately for…
  • DELETEDelete online evaluation config/online-evaluation-configs/:onlineEvaluationConfigIdDeletes an online evaluation configuration and stops any ongoing evaluation processes associated with it.
  • POSTList online evaluation configs/online-evaluation-configs?nextToken=string&maxResults=0Lists all online evaluation configurations in the account, providing summary information about each configuration's status and settings.

Payment connector

  • POSTCreate payment connector/payments/managers/:paymentManagerId/connectorsCreates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing…
  • GETGet payment connector/payments/managers/:paymentManagerId/connectors/:paymentConnectorIdRetrieves information about a specific payment connector.
  • DELETEDelete payment connector/payments/managers/:paymentManagerId/connectors/:paymentConnectorId?clientToken=stringDeletes a payment connector.
  • PATCHUpdate payment connector/payments/managers/:paymentManagerId/connectors/:paymentConnectorIdUpdates an existing payment connector. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
  • POSTList payment connectors/payments/managers/:paymentManagerId/connectors-list?maxResults=0&nextToken=stringLists all payment connectors for a specified payment manager.
  • POSTRotate payment connector credentials/payments/managers/:paymentManagerId/connectors/:paymentConnectorId/rotate-credentialsReplaces the service-managed credentials of a payment connector with newly issued credentials. Use this operation only for payment connectors with a…

Payment credential provider

  • POSTCreate payment credential provider/identities/CreatePaymentCredentialProviderCreates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.
  • POSTDelete payment credential provider/identities/DeletePaymentCredentialProviderDeletes a payment credential provider and its associated stored credentials.
  • POSTGet payment credential provider/identities/GetPaymentCredentialProviderRetrieves information about a specific payment credential provider.
  • POSTList payment credential providers/identities/ListPaymentCredentialProvidersLists all payment credential providers in the account.
  • POSTUpdate payment credential provider/identities/UpdatePaymentCredentialProviderUpdates an existing payment credential provider with new authentication credentials.

Payment manager

  • POSTCreate payment manager/payments/managersCreates a new payment manager in your Amazon Web Services account. A payment manager serves as the top-level resource for managing payment processing…
  • GETGet payment manager/payments/managers/:paymentManagerIdRetrieves information about a specific payment manager.
  • DELETEDelete payment manager/payments/managers/:paymentManagerId?clientToken=stringDeletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This…
  • PATCHUpdate payment manager/payments/managers/:paymentManagerIdUpdates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
  • POSTList payment managers/payments/managers-list?maxResults=0&nextToken=stringLists all payment managers in the account.

Policy

  • GETList policies/policy-engines/:policyEngineId/policies?nextToken=string&maxResults=0&targetResourceScope=stringRetrieves a list of policies within the AgentCore Policy engine. This operation supports pagination and filtering to help administrators manage and discover…
  • POSTCreate policy/policy-engines/:policyEngineId/policiesCreates a policy within the AgentCore Policy system. Policies provide real-time, deterministic control over agentic interactions with AgentCore Gateway. Using…
  • GETGet policy/policy-engines/:policyEngineId/policies/:policyIdRetrieves detailed information about a specific policy within the AgentCore Policy system. This operation returns the complete policy definition, metadata,…
  • DELETEDelete policy/policy-engines/:policyEngineId/policies/:policyIdDeletes 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…
  • PATCHUpdate policy/policy-engines/:policyEngineId/policies/:policyIdUpdates an existing policy within the AgentCore Policy system. This operation allows modification of the policy description and definition while maintaining…
  • GETGet policy summary/policy-engines/:policyEngineId/policy-summaries/:policyIdRetrieves a metadata-only summary of a specific policy without decrypting customer content. This lightweight read operation returns resource identifiers,…
  • GETList policy summaries/policy-engines/:policyEngineId/policy-summaries?nextToken=string&maxResults=0&targetResourceScope=stringRetrieves a paginated list of metadata-only policy summaries within a policy engine without decrypting customer content. This lightweight read operation…

Policy engine

  • GETList policy engines/policy-engines?nextToken=string&maxResults=0Retrieves a list of policy engines within the AgentCore Policy system. This operation supports pagination to help administrators discover and manage policy…
  • POSTCreate policy engine/policy-enginesCreates a new policy engine within the AgentCore Policy system. A policy engine is a collection of policies that evaluates and authorizes agent tool calls.…
  • GETGet policy engine/policy-engines/:policyEngineIdRetrieves detailed information about a specific policy engine within the AgentCore Policy system. This operation returns the complete policy engine…
  • DELETEDelete policy engine/policy-engines/:policyEngineIdDeletes an existing policy engine from the AgentCore Policy system. The policy engine must not have any associated policies before deletion. Once deleted, the…
  • PATCHUpdate policy engine/policy-engines/:policyEngineIdUpdates an existing policy engine within the AgentCore Policy system. This operation allows modification of the policy engine description while maintaining…
  • GETGet policy engine summary/policy-engine-summaries/:policyEngineIdRetrieves a metadata-only summary of a specific policy engine without decrypting customer content. This lightweight read operation returns resource…
  • GETList policy engine summaries/policy-engine-summaries?nextToken=string&maxResults=0Retrieves a paginated list of metadata-only policy engine summaries without decrypting customer content. This lightweight read operation returns resource…

Registry

  • GETList registries/registries?maxResults=0&nextToken=string&status=string&authorizerType=stringLists all registries in the account. You can optionally filter results by status using the status parameter, or by authorizer type using the authorizerType…
  • POSTCreate registry/registriesCreates a new registry in your Amazon Web Services account. A registry serves as a centralized catalog for organizing and managing registry records, including…
  • GETGet registry/registries/:registryIdRetrieves information about a specific registry.
  • DELETEDelete registry/registries/:registryIdDeletes a registry. The registry must contain zero records before it can be deleted. This operation initiates the deletion process asynchronously.
  • PATCHUpdate registry/registries/:registryIdUpdates an existing registry. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

Registry record

  • GETList registry records/registries/:registryId/records?maxResults=0&nextToken=string&name=string&status=string&descriptorType=stringLists registry records within a registry. You can optionally filter results using the name , status , and descriptorType parameters. When multiple filters are…
  • POSTCreate registry record/registries/:registryId/recordsCreates a new registry record within the specified registry. A registry record represents an individual AI resource's metadata in the registry. This could be…
  • GETGet registry record/registries/:registryId/records/:recordIdRetrieves information about a specific registry record.
  • DELETEDelete registry record/registries/:registryId/records/:recordIdDeletes a registry record. The record's status transitions to DELETING and the record is removed asynchronously.
  • PATCHUpdate registry record/registries/:registryId/records/:recordIdUpdates 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…
  • POSTSubmit registry record for approval/registries/:registryId/records/:recordId/submit-for-approvalSubmits a registry record for approval. This transitions the record from DRAFT status to PENDING_APPROVAL status. If the registry has auto-approval enabled,…
  • PATCHUpdate registry record status/registries/:registryId/records/:recordId/statusUpdates the status of a registry record. Use this operation to approve, reject, or deprecate a registry record.

Workload identity

  • POSTCreate workload identity/identities/CreateWorkloadIdentityCreates a new workload identity.
  • POSTDelete workload identity/identities/DeleteWorkloadIdentityDeletes a workload identity.
  • POSTGet workload identity/identities/GetWorkloadIdentityRetrieves information about a workload identity.
  • POSTList workload identities/identities/ListWorkloadIdentitiesLists all workload identities in your account.
  • POSTUpdate workload identity/identities/UpdateWorkloadIdentityUpdates an existing workload identity.

Policy generation

  • GETGet policy generation/policy-engines/:policyEngineId/policy-generations/:policyGenerationIdRetrieves information about a policy generation request within the AgentCore Policy system. Policy generation converts natural language descriptions into…
  • GETGet policy generation summary/policy-engines/:policyEngineId/policy-generation-summaries/:policyGenerationIdRetrieves a metadata-only summary of a specific policy generation request without decrypting customer content. This lightweight read operation returns…
  • GETList policy generation assets/policy-engines/:policyEngineId/policy-generations/:policyGenerationId/assets?nextToken=string&maxResults=0Retrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system. This operation returns the actual Dogwood…
  • GETList policy generation summaries/policy-engines/:policyEngineId/policy-generation-summaries?nextToken=string&maxResults=0Retrieves a paginated list of metadata-only policy generation summaries within a policy engine without decrypting customer content. This lightweight read…
  • GETList policy generations/policy-engines/:policyEngineId/policy-generations?nextToken=string&maxResults=0Retrieves a list of policy generation requests within the AgentCore Policy system. This operation supports pagination and filtering to help track and manage…
  • POSTStart policy generation/policy-engines/:policyEngineId/policy-generationsInitiates the AI-powered generation of Dogwood policies from natural language descriptions within the AgentCore Policy system. This feature enables both…
  • GETGet resource policy/resourcepolicy/:resourceArnRetrieves the resource-based policy for a specified resource. This feature is currently available only for AgentCore Runtime and Gateway.
  • PUTPut resource policy/resourcepolicy/:resourceArnCreates or updates a resource-based policy for a resource with the specified resourceArn. This feature is currently available only for AgentCore Runtime and…
  • DELETEDelete resource policy/resourcepolicy/:resourceArnDeletes the resource-based policy for a specified resource. This feature is currently available only for AgentCore Runtime and Gateway.
  • POSTGet token vault/identities/get-token-vaultRetrieves information about a token vault.
  • GETList tags for resource/tags/:resourceArnLists the tags associated with the specified resource. This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code…
  • POSTTag resource/tags/:resourceArnAssociates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they…
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes the specified tags from the specified resource. This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code…
  • POSTReset token vault key material/identities/reset-token-vault-key-materialResets 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…
  • POSTSet token vault cMK/identities/set-token-vault-cmkSets the customer master key (CMK) for a token vault.

API details

Base URL
https://bedrock-agentcore-control.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
172 operations on 108 pathsPOST 68GET 49DELETE 25PUT 19PATCH 11
Main resources
Dataset 11Configuration bundle 7Policy 7Policy engine 7Registry record 7Agent 6Capacity provider 6Gateway rate limit 6Gateway target 6Harness 6
Description format
AWS Smithy model, API version 2023-06-05

How to test the Amazon Bedrock AgentCore Control in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Bedrock AgentCore Control collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Add dataset examples” (POST /datasets/:datasetId/examples/add), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Bedrock AgentCore Control?

Welcome to the Amazon Bedrock AgentCore Control plane API reference. Control plane actions configure, create, modify, and monitor Amazon Web Services resources. It is listed under AI & machine learning and has 172 endpoints.

Who publishes the Amazon Bedrock AgentCore Control?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Bedrock AgentCore Control?

Requests go to https://bedrock-agentcore-control.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Bedrock AgentCore Control?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Bedrock AgentCore Control have?

172 operations on 108 paths (68 POST, 49 GET, 25 DELETE, 19 PUT, 11 PATCH). The largest groups are Dataset, Configuration bundle, Policy, Policy engine.

Is forking the Amazon Bedrock AgentCore Control free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.