AgentRegistryControl class

AWS Agent Registry is a managed catalog for publishing and discovering resources such as MCP servers, agents, and agent skills. Agent Registry Control is its control-plane API: use it to create and manage registries and the records they contain, configure discovery and authorization, govern record approval and curation workflows, and manage automatic detection of resources. Data-plane search and MCP invocation operations are provided by the companion Agent Registry API.

Constructors

AgentRegistryControl({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createRegistry({required String name, ApprovalConfiguration? approvalConfiguration, String? clientToken, String? description, DiscoveryConfiguration? discoveryConfiguration, Map<String, String>? tags}) → Future<CreateRegistryResponse>

Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior. Creation is asynchronous: the registry begins in the CREATING status and becomes usable once it reaches READY.

createRegistryRecord({required Descriptors descriptors, required String name, required RecordType recordType, required String registryId, String? clientToken, String? description, String? displayName, String? recordVersion, Map<String, String>? tags}) → Future<CreateRegistryRecordResponse>

Creates a registry record within a registry. A registry record describes a discoverable resource, such as an MCP server, an agent, an agent skill, or a custom resource. Creation is asynchronous: the record is returned with the CREATING status while it is processed.

deleteRegistry({required String registryId}) → Future<DeleteRegistryResponse>

Deletes a registry. Deletion is asynchronous: the registry transitions to the DELETING status and is removed along with its registry records.

deleteRegistryRecord({required String recordId, required String registryId}) → Future<void>

Deletes a registry record

getRegistry({required String registryId}) → Future<GetRegistryResponse>

Gets a registry by identifier (ARN or ID)

getRegistryRecord({required String recordId, required String registryId}) → Future<GetRegistryRecordResponse>

Retrieves the details of a registry record

listRegistries({List<RegistryFilter>? filters, int? maxResults, String? nextToken}) → Future<ListRegistriesResponse>

Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer type

listRegistryRecords({required String registryId, List<RegistryRecordFilter>? filters, int? maxResults, String? nextToken}) → Future<ListRegistryRecordsResponse>

Lists the registry records within a registry, with optional filtering by name, status, and record type

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>

List the tags on a resource

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

submitRegistryRecordForApproval({required String recordId, required String registryId}) → Future<SubmitRegistryRecordForApprovalResponse>

Submits a DRAFT registry record for approval, moving it into the registry's approval workflow. Depending on the registry's approval configuration, the record is either auto-approved or set to PENDING_APPROVAL for a curator to approve or reject.

tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>

Tag a resource with key-value pairs

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Remove tags from a resource by key

updateRegistry({required String registryId, UpdatedApprovalConfiguration? approvalConfiguration, UpdatedDescription? description, UpdatedDiscoveryConfiguration? discoveryConfiguration, String? name}) → Future<UpdateRegistryResponse>

Updates an existing registry. This operation uses PATCH semantics: specify only the fields you want to change, and omit the rest to leave them unchanged. Updates are applied asynchronously and the registry transitions to the UPDATING status while they are processed.

updateRegistryRecord({required String recordId, required String registryId, UpdatedDescription? description, UpdatedDescriptors? descriptors, UpdatedDisplayName? displayName, String? name, RecordType? recordType, String? recordVersion, bool? triggerSynchronization}) → Future<UpdateRegistryRecordResponse>

Updates a registry record. The update is asynchronous: the record is returned with the UPDATING status while it is processed. Fields that use update wrappers follow PATCH semantics: omit the field to leave it unchanged.

updateRegistryRecordStatus({required String recordId, required String registryId, required RegistryRecordStatus status, required String statusReason}) → Future<UpdateRegistryRecordStatusResponse>

Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable

Operators

operator ==(Object other) → bool

The equality operator.

inherited