Api-Agent-Registry-Control-2025-12-01

Client: Aws\AgentRegistryControl\AgentRegistryControlClient

Service ID: agent-registry-control

Version: 2025-12-01

This page describes the parameters and results for the operations of the Agent Registry Control (2025-12-01), and shows how to use the Aws\AgentRegistryControl\AgentRegistryControlClient object to call the described operations. This documentation is specific to the 2025-12-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateRegistry ( array $params = [] ): Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior.
CreateRegistryRecord ( array $params = [] ): Creates a registry record within a registry.
DeleteRegistry ( array $params = [] ): Deletes a registry.
DeleteRegistryRecord ( array $params = [] ): Deletes a registry record
GetRegistry ( array $params = [] ): Gets a registry by identifier (ARN or ID)
GetRegistryRecord ( array $params = [] ): Retrieves the details of a registry record
ListRegistries ( array $params = [] ): Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer type
ListRegistryRecords ( array $params = [] ): Lists the registry records within a registry, with optional filtering by name, status, and record type
ListTagsForResource ( array $params = [] ): Lists the tags associated with the specified Amazon Web Services Agent Registry resource.
SubmitRegistryRecordForApproval ( array $params = [] ): Submits a DRAFT registry record for approval, moving it into the registry's approval workflow.
TagResource ( array $params = [] ): Adds or overwrites one or more tags for the specified Amazon Web Services Agent Registry resource.
UntagResource ( array $params = [] ): Removes one or more tags from the specified Amazon Web Services Agent Registry resource.
UpdateRegistry ( array $params = [] ): Updates an existing registry.
UpdateRegistryRecord ( array $params = [] ): Updates a registry record.
UpdateRegistryRecordStatus ( array $params = [] ): 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

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListRegistries
ListRegistryRecords

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
RegistryReady	GetRegistry	30	5
RegistryRecordApproved	GetRegistryRecord	30	5

Operations

CreateRegistry

$result = $client->createRegistry([/* ... */]);
$promise = $client->createRegistryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createRegistry([
    'approvalConfiguration' => [
        'autoApprovalRules' => ['<string>', ...],
    ],
    'autoDetectionConfiguration' => [
        'enabled' => true || false, // REQUIRED
        'scope' => 'ORGANIZATION', // REQUIRED
    ],
    'clientToken' => '<string>',
    'description' => '<string>',
    'discoveryConfiguration' => [
        'authorizerConfiguration' => [
            'customJWTAuthorizer' => [
                'allowedAudience' => ['<string>', ...],
                'allowedClients' => ['<string>', ...],
                'allowedScopes' => ['<string>', ...],
                'customClaims' => [
                    [
                        'authorizingClaimMatchValue' => [ // REQUIRED
                            'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY', // REQUIRED
                            'claimMatchValue' => [ // REQUIRED
                                'matchValueString' => '<string>',
                                'matchValueStringList' => ['<string>', ...],
                            ],
                        ],
                        'inboundTokenClaimName' => '<string>', // REQUIRED
                        'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY', // REQUIRED
                    ],
                    // ...
                ],
                'discoveryUrl' => '<string>', // REQUIRED
                'privateEndpoint' => [
                    'managedVpcResource' => [
                        'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                        'routingDomain' => '<string>',
                        'securityGroupIds' => ['<string>', ...],
                        'subnetIds' => ['<string>', ...], // REQUIRED
                        'tags' => ['<string>', ...],
                        'vpcIdentifier' => '<string>', // REQUIRED
                    ],
                    'selfManagedLatticeResource' => [
                        'resourceConfigurationIdentifier' => '<string>',
                    ],
                ],
                'privateEndpointOverrides' => [
                    [
                        'domain' => '<string>', // REQUIRED
                        'privateEndpoint' => [ // REQUIRED
                            'managedVpcResource' => [
                                'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                                'routingDomain' => '<string>',
                                'securityGroupIds' => ['<string>', ...],
                                'subnetIds' => ['<string>', ...], // REQUIRED
                                'tags' => ['<string>', ...],
                                'vpcIdentifier' => '<string>', // REQUIRED
                            ],
                            'selfManagedLatticeResource' => [
                                'resourceConfigurationIdentifier' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'authorizerType' => 'CUSTOM_JWT|AWS_IAM',
    ],
    'encryptionConfiguration' => [
        'kmsKeyArn' => '<string>', // REQUIRED
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

approvalConfiguration

: Type: ApprovalConfiguration structure

Approval configuration for registry records

autoDetectionConfiguration

: Type: AutoDetectionConfiguration structure

The optional auto-detection configuration for the registry. When provided, the registry is automatically populated with resources discovered according to the configuration. Omit this field for registries whose records are managed exclusively through the Agent Registry Control API.

clientToken

: Type: 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.

description

: Type: string

The description of the registry

discoveryConfiguration

: Type: DiscoveryConfiguration structure

Discovery configuration for the registry

encryptionConfiguration

: Type: EncryptionConfiguration structure

The optional server-side encryption configuration for the registry. When you provide this field, the specified customer-managed Amazon Web Services KMS key encrypts the registry's content. Omit this field to use an Amazon Web Services-owned encryption key. You cannot change the encryption configuration after registry creation.

name

: Required: Yes
: Type: string

The name of the registry

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Tags to associate with the registry

Result Syntax

[
    'registryArn' => '<string>',
]

Result Details

Members

registryArn

: Required: Yes
: Type: string

The ARN of the created registry

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.
ServiceQuotaExceededException:: The request would exceed a service quota.
ConflictException:: The request conflicts with the current state of the resource.

CreateRegistryRecord

$result = $client->createRegistryRecord([/* ... */]);
$promise = $client->createRegistryRecordAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createRegistryRecord([
    'clientToken' => '<string>',
    'description' => '<string>',
    'descriptors' => [ // REQUIRED
        'a2aAgentCard' => [
            'data' => '<string>',
            'dataSchemaVersion' => '<string>',
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [ // REQUIRED
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>', // REQUIRED
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM', // REQUIRED
                        ],
                        // ...
                    ],
                    'url' => '<string>', // REQUIRED
                ],
            ],
        ],
        'agentSkillsDefinition' => [
            'additionalData' => [
                'skillMd' => [
                    'data' => '<string>',
                    'dataSchemaVersion' => '<string>',
                    'source' => [
                        'fromUrl' => [
                            'credentialProviderConfigurations' => [
                                [
                                    'credentialProvider' => [ // REQUIRED
                                        'iamCredentialProvider' => [
                                            'region' => '<string>',
                                            'roleArn' => '<string>',
                                            'service' => '<string>',
                                        ],
                                        'oauthCredentialProvider' => [
                                            'customParameters' => ['<string>', ...],
                                            'grantType' => 'CLIENT_CREDENTIALS',
                                            'providerArn' => '<string>', // REQUIRED
                                            'scopes' => ['<string>', ...],
                                        ],
                                    ],
                                    'credentialProviderType' => 'OAUTH|IAM', // REQUIRED
                                ],
                                // ...
                            ],
                            'url' => '<string>', // REQUIRED
                        ],
                    ],
                ],
            ],
            'data' => '<string>',
            'dataSchemaVersion' => '<string>',
        ],
        'agui' => [
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [ // REQUIRED
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>', // REQUIRED
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM', // REQUIRED
                        ],
                        // ...
                    ],
                    'url' => '<string>', // REQUIRED
                ],
            ],
        ],
        'custom' => [
            'data' => '<string>',
        ],
        'http' => [
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [ // REQUIRED
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>', // REQUIRED
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM', // REQUIRED
                        ],
                        // ...
                    ],
                    'url' => '<string>', // REQUIRED
                ],
            ],
        ],
        'mcpServer' => [
            'additionalData' => [
                'tools' => [
                    'data' => '<string>',
                    'dataSchemaVersion' => '<string>',
                ],
            ],
            'data' => '<string>',
            'dataSchemaVersion' => '<string>',
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [ // REQUIRED
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>', // REQUIRED
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM', // REQUIRED
                        ],
                        // ...
                    ],
                    'url' => '<string>', // REQUIRED
                ],
            ],
        ],
    ],
    'displayName' => '<string>',
    'name' => '<string>', // REQUIRED
    'provenance' => [
        [
            'relation' => 'DETECTED_FROM', // REQUIRED
            'sourceDetails' => [
                'agentcoreGateway' => [
                    'authorizerConfiguration' => [
                        'customJWTAuthorizer' => [
                            'allowedAudience' => ['<string>', ...],
                            'allowedClients' => ['<string>', ...],
                            'allowedScopes' => ['<string>', ...],
                            'customClaims' => [
                                [
                                    'authorizingClaimMatchValue' => [ // REQUIRED
                                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY', // REQUIRED
                                        'claimMatchValue' => [ // REQUIRED
                                            'matchValueString' => '<string>',
                                            'matchValueStringList' => ['<string>', ...],
                                        ],
                                    ],
                                    'inboundTokenClaimName' => '<string>', // REQUIRED
                                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY', // REQUIRED
                                ],
                                // ...
                            ],
                            'discoveryUrl' => '<string>', // REQUIRED
                            'privateEndpoint' => [
                                'managedVpcResource' => [
                                    'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                                    'routingDomain' => '<string>',
                                    'securityGroupIds' => ['<string>', ...],
                                    'subnetIds' => ['<string>', ...], // REQUIRED
                                    'tags' => ['<string>', ...],
                                    'vpcIdentifier' => '<string>', // REQUIRED
                                ],
                                'selfManagedLatticeResource' => [
                                    'resourceConfigurationIdentifier' => '<string>',
                                ],
                            ],
                            'privateEndpointOverrides' => [
                                [
                                    'domain' => '<string>', // REQUIRED
                                    'privateEndpoint' => [ // REQUIRED
                                        'managedVpcResource' => [
                                            'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                                            'routingDomain' => '<string>',
                                            'securityGroupIds' => ['<string>', ...],
                                            'subnetIds' => ['<string>', ...], // REQUIRED
                                            'tags' => ['<string>', ...],
                                            'vpcIdentifier' => '<string>', // REQUIRED
                                        ],
                                        'selfManagedLatticeResource' => [
                                            'resourceConfigurationIdentifier' => '<string>',
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'authorizerType' => '<string>',
                    'protocolType' => 'MCP',
                    'workloadIdentityDetails' => [
                        'workloadIdentityArn' => '<string>', // REQUIRED
                    ],
                ],
                'agentcoreRuntime' => [
                    'authorizerConfiguration' => [
                        'customJWTAuthorizer' => [
                            'allowedAudience' => ['<string>', ...],
                            'allowedClients' => ['<string>', ...],
                            'allowedScopes' => ['<string>', ...],
                            'customClaims' => [
                                [
                                    'authorizingClaimMatchValue' => [ // REQUIRED
                                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY', // REQUIRED
                                        'claimMatchValue' => [ // REQUIRED
                                            'matchValueString' => '<string>',
                                            'matchValueStringList' => ['<string>', ...],
                                        ],
                                    ],
                                    'inboundTokenClaimName' => '<string>', // REQUIRED
                                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY', // REQUIRED
                                ],
                                // ...
                            ],
                            'discoveryUrl' => '<string>', // REQUIRED
                            'privateEndpoint' => [
                                'managedVpcResource' => [
                                    'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                                    'routingDomain' => '<string>',
                                    'securityGroupIds' => ['<string>', ...],
                                    'subnetIds' => ['<string>', ...], // REQUIRED
                                    'tags' => ['<string>', ...],
                                    'vpcIdentifier' => '<string>', // REQUIRED
                                ],
                                'selfManagedLatticeResource' => [
                                    'resourceConfigurationIdentifier' => '<string>',
                                ],
                            ],
                            'privateEndpointOverrides' => [
                                [
                                    'domain' => '<string>', // REQUIRED
                                    'privateEndpoint' => [ // REQUIRED
                                        'managedVpcResource' => [
                                            'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                                            'routingDomain' => '<string>',
                                            'securityGroupIds' => ['<string>', ...],
                                            'subnetIds' => ['<string>', ...], // REQUIRED
                                            'tags' => ['<string>', ...],
                                            'vpcIdentifier' => '<string>', // REQUIRED
                                        ],
                                        'selfManagedLatticeResource' => [
                                            'resourceConfigurationIdentifier' => '<string>',
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'protocolConfiguration' => [
                        'serverProtocol' => 'HTTP|A2A|MCP|AGUI',
                    ],
                    'workloadIdentityDetails' => [
                        'workloadIdentityArn' => '<string>', // REQUIRED
                    ],
                ],
            ],
            'sourceId' => '<string>', // REQUIRED
            'sourceType' => 'AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Gateway',
        ],
        // ...
    ],
    'recordType' => 'MCP|AGENT|CUSTOM|SKILL|GATEWAY', // REQUIRED
    'recordVersion' => '<string>',
    'registryId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

clientToken

: Type: string

Client token for idempotency

description

: Type: string

The description of the registry record

descriptors

: Required: Yes
: Type: Descriptors structure

The typed descriptor content for the registry record

displayName

: Type: string

The human-readable display name of the registry record

name

: Required: Yes
: Type: string

The name of the registry record

provenance

: Type: Array of Provenance structures

List of provenance entries on a registry record. Capped at one entry today: a record carries a single DETECTED_FROM lineage. Modeled as a list so additional relations can be unlocked post-GA by raising this bound without a breaking shape change.

recordType

: Required: Yes
: Type: string

The type of the registry record, which determines the descriptor format

recordVersion

: Type: string

The version of the registry record

registryId

: Required: Yes
: Type: string

The identifier of the registry in which to create the record (ARN or ID)

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Tags to associate with the registry record

Result Syntax

[
    'recordArn' => '<string>',
    'status' => 'DRAFT|PENDING_APPROVAL|APPROVED|REJECTED|DEPRECATED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
]

Result Details

Members

recordArn

: Required: Yes
: Type: string

The ARN of the created registry record

status

: Required: Yes
: Type: string

The status of the registry record, set to CREATING while the asynchronous workflow is in progress

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ResourceNotFoundException:: The requested resource was not found.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.
ServiceQuotaExceededException:: The request would exceed a service quota.
ConflictException:: The request conflicts with the current state of the resource.

DeleteRegistry

$result = $client->deleteRegistry([/* ... */]);
$promise = $client->deleteRegistryAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteRegistry([
    'registryId' => '<string>', // REQUIRED
]);

Parameter Details

Members

registryId

: Required: Yes
: Type: string

The identifier of the registry to delete (ARN or ID)

Result Syntax

[
    'status' => 'CREATING|READY|UPDATING|CREATE_FAILED|UPDATE_FAILED|DELETING|DELETE_FAILED',
]

Result Details

Members

status

: Required: Yes
: Type: string

Current status of the registry, set to DELETING when deletion is initiated

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ResourceNotFoundException:: The requested resource was not found.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.
ConflictException:: The request conflicts with the current state of the resource.

DeleteRegistryRecord

$result = $client->deleteRegistryRecord([/* ... */]);
$promise = $client->deleteRegistryRecordAsync([/* ... */]);

Deletes a registry record

Parameter Syntax

$result = $client->deleteRegistryRecord([
    'recordId' => '<string>', // REQUIRED
    'registryId' => '<string>', // REQUIRED
]);

Parameter Details

Members

recordId

: Required: Yes
: Type: string

The identifier of the registry record to delete (ARN or ID)

registryId

: Required: Yes
: Type: string

The identifier of the registry containing the record (ARN or ID)

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ResourceNotFoundException:: The requested resource was not found.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.
ConflictException:: The request conflicts with the current state of the resource.

GetRegistry

$result = $client->getRegistry([/* ... */]);
$promise = $client->getRegistryAsync([/* ... */]);

Gets a registry by identifier (ARN or ID)

Parameter Syntax

$result = $client->getRegistry([
    'registryId' => '<string>', // REQUIRED
]);

Parameter Details

Members

registryId

: Required: Yes
: Type: string

The identifier of the registry to retrieve (ARN or ID)

Result Syntax

[
    'approvalConfiguration' => [
        'autoApprovalRules' => ['<string>', ...],
    ],
    'autoDetection' => [
        'configuration' => [
            'enabled' => true || false,
            'scope' => 'ORGANIZATION',
        ],
        'status' => 'ACTIVE|INACTIVE',
        'statusReason' => '<string>',
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'discoveryConfiguration' => [
        'authorizerConfiguration' => [
            'customJWTAuthorizer' => [
                'allowedAudience' => ['<string>', ...],
                'allowedClients' => ['<string>', ...],
                'allowedScopes' => ['<string>', ...],
                'customClaims' => [
                    [
                        'authorizingClaimMatchValue' => [
                            'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY',
                            'claimMatchValue' => [
                                'matchValueString' => '<string>',
                                'matchValueStringList' => ['<string>', ...],
                            ],
                        ],
                        'inboundTokenClaimName' => '<string>',
                        'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY',
                    ],
                    // ...
                ],
                'discoveryUrl' => '<string>',
                'privateEndpoint' => [
                    'managedVpcResource' => [
                        'endpointIpAddressType' => 'IPV4|IPV6',
                        'routingDomain' => '<string>',
                        'securityGroupIds' => ['<string>', ...],
                        'subnetIds' => ['<string>', ...],
                        'tags' => ['<string>', ...],
                        'vpcIdentifier' => '<string>',
                    ],
                    'selfManagedLatticeResource' => [
                        'resourceConfigurationIdentifier' => '<string>',
                    ],
                ],
                'privateEndpointOverrides' => [
                    [
                        'domain' => '<string>',
                        'privateEndpoint' => [
                            'managedVpcResource' => [
                                'endpointIpAddressType' => 'IPV4|IPV6',
                                'routingDomain' => '<string>',
                                'securityGroupIds' => ['<string>', ...],
                                'subnetIds' => ['<string>', ...],
                                'tags' => ['<string>', ...],
                                'vpcIdentifier' => '<string>',
                            ],
                            'selfManagedLatticeResource' => [
                                'resourceConfigurationIdentifier' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'authorizerType' => 'CUSTOM_JWT|AWS_IAM',
    ],
    'encryptionConfiguration' => [
        'kmsKeyArn' => '<string>',
    ],
    'name' => '<string>',
    'registryArn' => '<string>',
    'registryId' => '<string>',
    'status' => 'CREATING|READY|UPDATING|CREATE_FAILED|UPDATE_FAILED|DELETING|DELETE_FAILED',
    'statusReason' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Members

approvalConfiguration

: Type: ApprovalConfiguration structure

Approval configuration for registry records

autoDetection

: Type: AutoDetection structure

The registry's auto-detection properties, including the requested configuration and the current detection status. Present only when auto-detection was configured for the registry.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry was created

description

: Type: string

The description of the registry

discoveryConfiguration

: Type: DiscoveryConfiguration structure

Discovery configuration for the registry

encryptionConfiguration

: Type: EncryptionConfiguration structure

The server-side encryption configuration for the registry. Appears only when a customer-managed Amazon Web Services KMS key encrypts the registry.

name

: Required: Yes
: Type: string

The name of the registry

registryArn

: Required: Yes
: Type: string

The ARN of the registry

registryId

: Required: Yes
: Type: string

The unique identifier of the registry

status

: Required: Yes
: Type: string

Current status of the registry

statusReason

: Type: string

The reason for the current status. Typically populated when the status indicates a failure state.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry was last updated

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ResourceNotFoundException:: The requested resource was not found.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.

GetRegistryRecord

$result = $client->getRegistryRecord([/* ... */]);
$promise = $client->getRegistryRecordAsync([/* ... */]);

Retrieves the details of a registry record

Parameter Syntax

$result = $client->getRegistryRecord([
    'recordId' => '<string>', // REQUIRED
    'registryId' => '<string>', // REQUIRED
]);

Parameter Details

Members

recordId

: Required: Yes
: Type: string

The identifier of the registry record to retrieve (ARN or ID)

registryId

: Required: Yes
: Type: string

The identifier of the registry containing the record (ARN or ID)

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'createdByAutoDetection' => true || false,
    'description' => '<string>',
    'descriptors' => [
        'a2aAgentCard' => [
            'data' => '<string>',
            'dataSchemaVersion' => '<string>',
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>',
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM',
                        ],
                        // ...
                    ],
                    'url' => '<string>',
                ],
            ],
        ],
        'agentSkillsDefinition' => [
            'additionalData' => [
                'skillMd' => [
                    'data' => '<string>',
                    'dataSchemaVersion' => '<string>',
                    'source' => [
                        'fromUrl' => [
                            'credentialProviderConfigurations' => [
                                [
                                    'credentialProvider' => [
                                        'iamCredentialProvider' => [
                                            'region' => '<string>',
                                            'roleArn' => '<string>',
                                            'service' => '<string>',
                                        ],
                                        'oauthCredentialProvider' => [
                                            'customParameters' => ['<string>', ...],
                                            'grantType' => 'CLIENT_CREDENTIALS',
                                            'providerArn' => '<string>',
                                            'scopes' => ['<string>', ...],
                                        ],
                                    ],
                                    'credentialProviderType' => 'OAUTH|IAM',
                                ],
                                // ...
                            ],
                            'url' => '<string>',
                        ],
                    ],
                ],
            ],
            'data' => '<string>',
            'dataSchemaVersion' => '<string>',
        ],
        'agui' => [
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>',
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM',
                        ],
                        // ...
                    ],
                    'url' => '<string>',
                ],
            ],
        ],
        'custom' => [
            'data' => '<string>',
        ],
        'http' => [
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>',
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM',
                        ],
                        // ...
                    ],
                    'url' => '<string>',
                ],
            ],
        ],
        'mcpServer' => [
            'additionalData' => [
                'tools' => [
                    'data' => '<string>',
                    'dataSchemaVersion' => '<string>',
                ],
            ],
            'data' => '<string>',
            'dataSchemaVersion' => '<string>',
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>',
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM',
                        ],
                        // ...
                    ],
                    'url' => '<string>',
                ],
            ],
        ],
    ],
    'displayName' => '<string>',
    'name' => '<string>',
    'provenance' => [
        [
            'relation' => 'DETECTED_FROM',
            'sourceDetails' => [
                'agentcoreGateway' => [
                    'authorizerConfiguration' => [
                        'customJWTAuthorizer' => [
                            'allowedAudience' => ['<string>', ...],
                            'allowedClients' => ['<string>', ...],
                            'allowedScopes' => ['<string>', ...],
                            'customClaims' => [
                                [
                                    'authorizingClaimMatchValue' => [
                                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY',
                                        'claimMatchValue' => [
                                            'matchValueString' => '<string>',
                                            'matchValueStringList' => ['<string>', ...],
                                        ],
                                    ],
                                    'inboundTokenClaimName' => '<string>',
                                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY',
                                ],
                                // ...
                            ],
                            'discoveryUrl' => '<string>',
                            'privateEndpoint' => [
                                'managedVpcResource' => [
                                    'endpointIpAddressType' => 'IPV4|IPV6',
                                    'routingDomain' => '<string>',
                                    'securityGroupIds' => ['<string>', ...],
                                    'subnetIds' => ['<string>', ...],
                                    'tags' => ['<string>', ...],
                                    'vpcIdentifier' => '<string>',
                                ],
                                'selfManagedLatticeResource' => [
                                    'resourceConfigurationIdentifier' => '<string>',
                                ],
                            ],
                            'privateEndpointOverrides' => [
                                [
                                    'domain' => '<string>',
                                    'privateEndpoint' => [
                                        'managedVpcResource' => [
                                            'endpointIpAddressType' => 'IPV4|IPV6',
                                            'routingDomain' => '<string>',
                                            'securityGroupIds' => ['<string>', ...],
                                            'subnetIds' => ['<string>', ...],
                                            'tags' => ['<string>', ...],
                                            'vpcIdentifier' => '<string>',
                                        ],
                                        'selfManagedLatticeResource' => [
                                            'resourceConfigurationIdentifier' => '<string>',
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'authorizerType' => '<string>',
                    'protocolType' => 'MCP',
                    'workloadIdentityDetails' => [
                        'workloadIdentityArn' => '<string>',
                    ],
                ],
                'agentcoreRuntime' => [
                    'authorizerConfiguration' => [
                        'customJWTAuthorizer' => [
                            'allowedAudience' => ['<string>', ...],
                            'allowedClients' => ['<string>', ...],
                            'allowedScopes' => ['<string>', ...],
                            'customClaims' => [
                                [
                                    'authorizingClaimMatchValue' => [
                                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY',
                                        'claimMatchValue' => [
                                            'matchValueString' => '<string>',
                                            'matchValueStringList' => ['<string>', ...],
                                        ],
                                    ],
                                    'inboundTokenClaimName' => '<string>',
                                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY',
                                ],
                                // ...
                            ],
                            'discoveryUrl' => '<string>',
                            'privateEndpoint' => [
                                'managedVpcResource' => [
                                    'endpointIpAddressType' => 'IPV4|IPV6',
                                    'routingDomain' => '<string>',
                                    'securityGroupIds' => ['<string>', ...],
                                    'subnetIds' => ['<string>', ...],
                                    'tags' => ['<string>', ...],
                                    'vpcIdentifier' => '<string>',
                                ],
                                'selfManagedLatticeResource' => [
                                    'resourceConfigurationIdentifier' => '<string>',
                                ],
                            ],
                            'privateEndpointOverrides' => [
                                [
                                    'domain' => '<string>',
                                    'privateEndpoint' => [
                                        'managedVpcResource' => [
                                            'endpointIpAddressType' => 'IPV4|IPV6',
                                            'routingDomain' => '<string>',
                                            'securityGroupIds' => ['<string>', ...],
                                            'subnetIds' => ['<string>', ...],
                                            'tags' => ['<string>', ...],
                                            'vpcIdentifier' => '<string>',
                                        ],
                                        'selfManagedLatticeResource' => [
                                            'resourceConfigurationIdentifier' => '<string>',
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'protocolConfiguration' => [
                        'serverProtocol' => 'HTTP|A2A|MCP|AGUI',
                    ],
                    'workloadIdentityDetails' => [
                        'workloadIdentityArn' => '<string>',
                    ],
                ],
            ],
            'sourceId' => '<string>',
            'sourceType' => 'AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Gateway',
        ],
        // ...
    ],
    'recordArn' => '<string>',
    'recordId' => '<string>',
    'recordType' => 'MCP|AGENT|CUSTOM|SKILL|GATEWAY',
    'recordVersion' => '<string>',
    'registryArn' => '<string>',
    'status' => 'DRAFT|PENDING_APPROVAL|APPROVED|REJECTED|DEPRECATED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
    'statusReason' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry record was created.

createdBy

: Type: string

The ID of the Amazon Web Services account that created the registry record.

createdByAutoDetection

: Type: boolean

Specifies whether the registry record was created by auto-detection. true indicates the record was automatically created by the service based on the registry's auto-detection configuration; false indicates the record was created through a control-plane API call.

description

: Type: string

A description of the registry record.

descriptors

: Type: Descriptors structure

The typed descriptors that define the content of the registry record.

displayName

: Type: string

The human-readable display name of the registry record.

name

: Required: Yes
: Type: string

The name of the registry record. Names are unique within a registry.

provenance

: Type: Array of Provenance structures

recordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the registry record.

recordId

: Required: Yes
: Type: string

The unique identifier of the registry record.

recordType

: Required: Yes
: Type: string

The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM.

recordVersion

: Type: string

The version identifier of the registry record.

registryArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the parent registry that owns the record.

status

: Required: Yes
: Type: string

The lifecycle status of the registry record.

statusReason

: Type: string

The reason for the current status. Typically populated when the status indicates a failure state.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry record was last updated.

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ResourceNotFoundException:: The requested resource was not found.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.
ConflictException:: The request conflicts with the current state of the resource.

ListRegistries

$result = $client->listRegistries([/* ... */]);
$promise = $client->listRegistriesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listRegistries([
    'filters' => [
        [
            'name' => 'status|discoveryConfiguration.authorizerType', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

: Type: Array of RegistryFilter structures

Filters to apply to the registry list

maxResults

: Type: int

Maximum number of results to return

nextToken

: Type: string

Token for pagination

Result Syntax

[
    'nextToken' => '<string>',
    'registries' => [
        [
            'autoDetection' => [
                'configuration' => [
                    'enabled' => true || false,
                    'scope' => 'ORGANIZATION',
                ],
                'status' => 'ACTIVE|INACTIVE',
                'statusReason' => '<string>',
            ],
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'discoveryConfiguration' => [
                'authorizerConfiguration' => [
                    'customJWTAuthorizer' => [
                        'allowedAudience' => ['<string>', ...],
                        'allowedClients' => ['<string>', ...],
                        'allowedScopes' => ['<string>', ...],
                        'customClaims' => [
                            [
                                'authorizingClaimMatchValue' => [
                                    'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY',
                                    'claimMatchValue' => [
                                        'matchValueString' => '<string>',
                                        'matchValueStringList' => ['<string>', ...],
                                    ],
                                ],
                                'inboundTokenClaimName' => '<string>',
                                'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY',
                            ],
                            // ...
                        ],
                        'discoveryUrl' => '<string>',
                        'privateEndpoint' => [
                            'managedVpcResource' => [
                                'endpointIpAddressType' => 'IPV4|IPV6',
                                'routingDomain' => '<string>',
                                'securityGroupIds' => ['<string>', ...],
                                'subnetIds' => ['<string>', ...],
                                'tags' => ['<string>', ...],
                                'vpcIdentifier' => '<string>',
                            ],
                            'selfManagedLatticeResource' => [
                                'resourceConfigurationIdentifier' => '<string>',
                            ],
                        ],
                        'privateEndpointOverrides' => [
                            [
                                'domain' => '<string>',
                                'privateEndpoint' => [
                                    'managedVpcResource' => [
                                        'endpointIpAddressType' => 'IPV4|IPV6',
                                        'routingDomain' => '<string>',
                                        'securityGroupIds' => ['<string>', ...],
                                        'subnetIds' => ['<string>', ...],
                                        'tags' => ['<string>', ...],
                                        'vpcIdentifier' => '<string>',
                                    ],
                                    'selfManagedLatticeResource' => [
                                        'resourceConfigurationIdentifier' => '<string>',
                                    ],
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                'authorizerType' => 'CUSTOM_JWT|AWS_IAM',
            ],
            'name' => '<string>',
            'registryArn' => '<string>',
            'registryId' => '<string>',
            'status' => 'CREATING|READY|UPDATING|CREATE_FAILED|UPDATE_FAILED|DELETING|DELETE_FAILED',
            'statusReason' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

Token for next page of results

registries

: Required: Yes
: Type: Array of RegistrySummary structures

List of registry summaries

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.

ListRegistryRecords

$result = $client->listRegistryRecords([/* ... */]);
$promise = $client->listRegistryRecordsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listRegistryRecords([
    'filters' => [
        [
            'name' => 'name|status|recordType', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'registryId' => '<string>', // REQUIRED
]);

Parameter Details

Members

filters

: Type: Array of RegistryRecordFilter structures

Filters to apply to the registry record list

maxResults

: Type: int

Maximum number of records to return

nextToken

: Type: string

Token for pagination

registryId

: Required: Yes
: Type: string

The identifier of the registry to list records from (ARN or ID)

Result Syntax

[
    'nextToken' => '<string>',
    'registryRecords' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'createdByAutoDetection' => true || false,
            'description' => '<string>',
            'displayName' => '<string>',
            'name' => '<string>',
            'provenanceSummaryList' => [
                [
                    'relation' => 'DETECTED_FROM',
                    'sourceId' => '<string>',
                    'sourceType' => 'AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Gateway',
                ],
                // ...
            ],
            'recordArn' => '<string>',
            'recordId' => '<string>',
            'recordType' => 'MCP|AGENT|CUSTOM|SKILL|GATEWAY',
            'recordVersion' => '<string>',
            'registryArn' => '<string>',
            'status' => 'DRAFT|PENDING_APPROVAL|APPROVED|REJECTED|DEPRECATED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

Token for next page of results

registryRecords

: Required: Yes
: Type: Array of RegistryRecordSummary structures

List of registry record summaries

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ResourceNotFoundException:: The requested resource was not found.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.
ConflictException:: The request conflicts with the current state of the resource.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags associated with the specified Amazon Web Services Agent Registry resource. Returns the current tag key-value pairs on the resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource to list tags for. Supported resources include registries and registry records.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags currently associated with the resource, as a map of tag keys to tag values.

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ResourceNotFoundException:: The requested resource was not found.
ValidationException:: The request failed validation of one or more input fields.

SubmitRegistryRecordForApproval

$result = $client->submitRegistryRecordForApproval([/* ... */]);
$promise = $client->submitRegistryRecordForApprovalAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->submitRegistryRecordForApproval([
    'recordId' => '<string>', // REQUIRED
    'registryId' => '<string>', // REQUIRED
]);

Parameter Details

Members

recordId

: Required: Yes
: Type: string

The identifier of the registry record to submit for approval (ARN or ID)

registryId

: Required: Yes
: Type: string

The identifier of the registry containing the record (ARN or ID)

Result Syntax

[
    'recordArn' => '<string>',
    'recordId' => '<string>',
    'registryArn' => '<string>',
    'status' => 'DRAFT|PENDING_APPROVAL|APPROVED|REJECTED|DEPRECATED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
    'updatedAt' => <DateTime>,
]

Result Details

Members

recordArn

: Required: Yes
: Type: string

The ARN of the registry record

recordId

: Required: Yes
: Type: string

The ID of the registry record

registryArn

: Required: Yes
: Type: string

The ARN of the registry

status

: Required: Yes
: Type: string

The resulting status of the registry record

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the record was last updated

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ResourceNotFoundException:: The requested resource was not found.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.
ConflictException:: The request conflicts with the current state of the resource.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or overwrites one or more tags for the specified Amazon Web Services Agent Registry resource. Tags are key-value pairs that you can use to categorize and manage Amazon Web Services resources. If a tag with the same key already exists on the resource, the service replaces its value with the value you specify.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource to tag. Supported resources include registries and registry records.

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

The tags to apply to the resource, as a map of tag keys to tag values. Tag keys must be unique within the request.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ResourceNotFoundException:: The requested resource was not found.
ValidationException:: The request failed validation of one or more input fields.
ServiceQuotaExceededException:: The request would exceed a service quota.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified Amazon Web Services Agent Registry resource. The operation removes only the tags whose keys you supply; other tags on the resource remain unchanged.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource to remove tags from. Supported resources include registries and registry records.

tagKeys

: Required: Yes
: Type: Array of strings

The keys of the tags to remove from the resource. Tags with keys not included in this list remain on the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ResourceNotFoundException:: The requested resource was not found.
ValidationException:: The request failed validation of one or more input fields.

UpdateRegistry

$result = $client->updateRegistry([/* ... */]);
$promise = $client->updateRegistryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateRegistry([
    'approvalConfiguration' => [
        'optionalValue' => [
            'autoApprovalRules' => ['<string>', ...],
        ],
    ],
    'autoDetectionConfiguration' => [
        'optionalValue' => [
            'enabled' => true || false, // REQUIRED
            'scope' => 'ORGANIZATION', // REQUIRED
        ],
    ],
    'description' => [
        'optionalValue' => '<string>',
    ],
    'discoveryConfiguration' => [
        'authorizerConfiguration' => [
            'optionalValue' => [
                'customJWTAuthorizer' => [
                    'allowedAudience' => ['<string>', ...],
                    'allowedClients' => ['<string>', ...],
                    'allowedScopes' => ['<string>', ...],
                    'customClaims' => [
                        [
                            'authorizingClaimMatchValue' => [ // REQUIRED
                                'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY', // REQUIRED
                                'claimMatchValue' => [ // REQUIRED
                                    'matchValueString' => '<string>',
                                    'matchValueStringList' => ['<string>', ...],
                                ],
                            ],
                            'inboundTokenClaimName' => '<string>', // REQUIRED
                            'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY', // REQUIRED
                        ],
                        // ...
                    ],
                    'discoveryUrl' => '<string>', // REQUIRED
                    'privateEndpoint' => [
                        'managedVpcResource' => [
                            'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                            'routingDomain' => '<string>',
                            'securityGroupIds' => ['<string>', ...],
                            'subnetIds' => ['<string>', ...], // REQUIRED
                            'tags' => ['<string>', ...],
                            'vpcIdentifier' => '<string>', // REQUIRED
                        ],
                        'selfManagedLatticeResource' => [
                            'resourceConfigurationIdentifier' => '<string>',
                        ],
                    ],
                    'privateEndpointOverrides' => [
                        [
                            'domain' => '<string>', // REQUIRED
                            'privateEndpoint' => [ // REQUIRED
                                'managedVpcResource' => [
                                    'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                                    'routingDomain' => '<string>',
                                    'securityGroupIds' => ['<string>', ...],
                                    'subnetIds' => ['<string>', ...], // REQUIRED
                                    'tags' => ['<string>', ...],
                                    'vpcIdentifier' => '<string>', // REQUIRED
                                ],
                                'selfManagedLatticeResource' => [
                                    'resourceConfigurationIdentifier' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
        ],
    ],
    'name' => '<string>',
    'registryId' => '<string>', // REQUIRED
]);

Parameter Details

Members

approvalConfiguration

: Type: UpdatedApprovalConfiguration structure

The updated approval configuration. The change applies only to records that move to PENDING_APPROVAL after the update; records already in PENDING_APPROVAL are unaffected.

autoDetectionConfiguration

: Type: UpdatedAutoDetectionConfiguration structure

The updated auto-detection configuration for the registry, with PATCH semantics. Omit this field to leave the current configuration unchanged. Supply an empty wrapper to unset it. Supply optionalValue to replace it.

description

: Type: UpdatedDescription structure

The updated description of the registry

discoveryConfiguration

: Type: UpdatedDiscoveryConfiguration structure

The updated discovery configuration. Changing the discovery authorization can break existing consumers that rely on the previous authorization type.

name

: Type: string

The updated name of the registry

registryId

: Required: Yes
: Type: string

The identifier of the registry to update (ARN or ID)

Result Syntax

[
    'approvalConfiguration' => [
        'autoApprovalRules' => ['<string>', ...],
    ],
    'autoDetection' => [
        'configuration' => [
            'enabled' => true || false,
            'scope' => 'ORGANIZATION',
        ],
        'status' => 'ACTIVE|INACTIVE',
        'statusReason' => '<string>',
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'discoveryConfiguration' => [
        'authorizerConfiguration' => [
            'customJWTAuthorizer' => [
                'allowedAudience' => ['<string>', ...],
                'allowedClients' => ['<string>', ...],
                'allowedScopes' => ['<string>', ...],
                'customClaims' => [
                    [
                        'authorizingClaimMatchValue' => [
                            'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY',
                            'claimMatchValue' => [
                                'matchValueString' => '<string>',
                                'matchValueStringList' => ['<string>', ...],
                            ],
                        ],
                        'inboundTokenClaimName' => '<string>',
                        'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY',
                    ],
                    // ...
                ],
                'discoveryUrl' => '<string>',
                'privateEndpoint' => [
                    'managedVpcResource' => [
                        'endpointIpAddressType' => 'IPV4|IPV6',
                        'routingDomain' => '<string>',
                        'securityGroupIds' => ['<string>', ...],
                        'subnetIds' => ['<string>', ...],
                        'tags' => ['<string>', ...],
                        'vpcIdentifier' => '<string>',
                    ],
                    'selfManagedLatticeResource' => [
                        'resourceConfigurationIdentifier' => '<string>',
                    ],
                ],
                'privateEndpointOverrides' => [
                    [
                        'domain' => '<string>',
                        'privateEndpoint' => [
                            'managedVpcResource' => [
                                'endpointIpAddressType' => 'IPV4|IPV6',
                                'routingDomain' => '<string>',
                                'securityGroupIds' => ['<string>', ...],
                                'subnetIds' => ['<string>', ...],
                                'tags' => ['<string>', ...],
                                'vpcIdentifier' => '<string>',
                            ],
                            'selfManagedLatticeResource' => [
                                'resourceConfigurationIdentifier' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'authorizerType' => 'CUSTOM_JWT|AWS_IAM',
    ],
    'encryptionConfiguration' => [
        'kmsKeyArn' => '<string>',
    ],
    'name' => '<string>',
    'registryArn' => '<string>',
    'registryId' => '<string>',
    'status' => 'CREATING|READY|UPDATING|CREATE_FAILED|UPDATE_FAILED|DELETING|DELETE_FAILED',
    'statusReason' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Members

approvalConfiguration

: Type: ApprovalConfiguration structure

Approval configuration for registry records

autoDetection

: Type: AutoDetection structure

The registry's auto-detection properties, including the requested configuration and the current detection status. Present only when auto-detection was configured for the registry.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry was created

description

: Type: string

The description of the registry

discoveryConfiguration

: Type: DiscoveryConfiguration structure

Discovery configuration for the registry

encryptionConfiguration

: Type: EncryptionConfiguration structure

The server-side encryption configuration for the registry. Appears only when a customer-managed Amazon Web Services KMS key encrypts the registry.

name

: Required: Yes
: Type: string

The name of the registry

registryArn

: Required: Yes
: Type: string

The ARN of the registry

registryId

: Required: Yes
: Type: string

The unique identifier of the registry

status

: Required: Yes
: Type: string

Current status of the registry

statusReason

: Type: string

The reason for the current status. Typically populated when the status indicates a failure state.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry was last updated

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ResourceNotFoundException:: The requested resource was not found.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.
ServiceQuotaExceededException:: The request would exceed a service quota.
ConflictException:: The request conflicts with the current state of the resource.

UpdateRegistryRecord

$result = $client->updateRegistryRecord([/* ... */]);
$promise = $client->updateRegistryRecordAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateRegistryRecord([
    'description' => [
        'optionalValue' => '<string>',
    ],
    'descriptors' => [
        'optionalValue' => [
            'a2aAgentCard' => [
                'optionalValue' => [
                    'data' => [
                        'optionalValue' => '<string>',
                    ],
                    'dataSchemaVersion' => [
                        'optionalValue' => '<string>',
                    ],
                    'source' => [
                        'optionalValue' => [
                            'fromUrl' => [
                                'credentialProviderConfigurations' => [
                                    [
                                        'credentialProvider' => [ // REQUIRED
                                            'iamCredentialProvider' => [
                                                'region' => '<string>',
                                                'roleArn' => '<string>',
                                                'service' => '<string>',
                                            ],
                                            'oauthCredentialProvider' => [
                                                'customParameters' => ['<string>', ...],
                                                'grantType' => 'CLIENT_CREDENTIALS',
                                                'providerArn' => '<string>', // REQUIRED
                                                'scopes' => ['<string>', ...],
                                            ],
                                        ],
                                        'credentialProviderType' => 'OAUTH|IAM', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'url' => '<string>', // REQUIRED
                            ],
                        ],
                    ],
                ],
            ],
            'agentSkillsDefinition' => [
                'optionalValue' => [
                    'additionalData' => [
                        'optionalValue' => [
                            'skillMd' => [
                                'optionalValue' => [
                                    'data' => [
                                        'optionalValue' => '<string>',
                                    ],
                                    'dataSchemaVersion' => [
                                        'optionalValue' => '<string>',
                                    ],
                                    'source' => [
                                        'optionalValue' => [
                                            'fromUrl' => [
                                                'credentialProviderConfigurations' => [
                                                    [
                                                        'credentialProvider' => [ // REQUIRED
                                                            'iamCredentialProvider' => [
                                                                'region' => '<string>',
                                                                'roleArn' => '<string>',
                                                                'service' => '<string>',
                                                            ],
                                                            'oauthCredentialProvider' => [
                                                                'customParameters' => ['<string>', ...],
                                                                'grantType' => 'CLIENT_CREDENTIALS',
                                                                'providerArn' => '<string>', // REQUIRED
                                                                'scopes' => ['<string>', ...],
                                                            ],
                                                        ],
                                                        'credentialProviderType' => 'OAUTH|IAM', // REQUIRED
                                                    ],
                                                    // ...
                                                ],
                                                'url' => '<string>', // REQUIRED
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                    'data' => [
                        'optionalValue' => '<string>',
                    ],
                    'dataSchemaVersion' => [
                        'optionalValue' => '<string>',
                    ],
                ],
            ],
            'agui' => [
                'optionalValue' => [
                    'source' => [
                        'optionalValue' => [
                            'fromUrl' => [
                                'credentialProviderConfigurations' => [
                                    [
                                        'credentialProvider' => [ // REQUIRED
                                            'iamCredentialProvider' => [
                                                'region' => '<string>',
                                                'roleArn' => '<string>',
                                                'service' => '<string>',
                                            ],
                                            'oauthCredentialProvider' => [
                                                'customParameters' => ['<string>', ...],
                                                'grantType' => 'CLIENT_CREDENTIALS',
                                                'providerArn' => '<string>', // REQUIRED
                                                'scopes' => ['<string>', ...],
                                            ],
                                        ],
                                        'credentialProviderType' => 'OAUTH|IAM', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'url' => '<string>', // REQUIRED
                            ],
                        ],
                    ],
                ],
            ],
            'custom' => [
                'optionalValue' => [
                    'data' => [
                        'optionalValue' => '<string>',
                    ],
                ],
            ],
            'http' => [
                'optionalValue' => [
                    'source' => [
                        'optionalValue' => [
                            'fromUrl' => [
                                'credentialProviderConfigurations' => [
                                    [
                                        'credentialProvider' => [ // REQUIRED
                                            'iamCredentialProvider' => [
                                                'region' => '<string>',
                                                'roleArn' => '<string>',
                                                'service' => '<string>',
                                            ],
                                            'oauthCredentialProvider' => [
                                                'customParameters' => ['<string>', ...],
                                                'grantType' => 'CLIENT_CREDENTIALS',
                                                'providerArn' => '<string>', // REQUIRED
                                                'scopes' => ['<string>', ...],
                                            ],
                                        ],
                                        'credentialProviderType' => 'OAUTH|IAM', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'url' => '<string>', // REQUIRED
                            ],
                        ],
                    ],
                ],
            ],
            'mcpServer' => [
                'optionalValue' => [
                    'additionalData' => [
                        'optionalValue' => [
                            'tools' => [
                                'optionalValue' => [
                                    'data' => [
                                        'optionalValue' => '<string>',
                                    ],
                                    'dataSchemaVersion' => [
                                        'optionalValue' => '<string>',
                                    ],
                                ],
                            ],
                        ],
                    ],
                    'data' => [
                        'optionalValue' => '<string>',
                    ],
                    'dataSchemaVersion' => [
                        'optionalValue' => '<string>',
                    ],
                    'source' => [
                        'optionalValue' => [
                            'fromUrl' => [
                                'credentialProviderConfigurations' => [
                                    [
                                        'credentialProvider' => [ // REQUIRED
                                            'iamCredentialProvider' => [
                                                'region' => '<string>',
                                                'roleArn' => '<string>',
                                                'service' => '<string>',
                                            ],
                                            'oauthCredentialProvider' => [
                                                'customParameters' => ['<string>', ...],
                                                'grantType' => 'CLIENT_CREDENTIALS',
                                                'providerArn' => '<string>', // REQUIRED
                                                'scopes' => ['<string>', ...],
                                            ],
                                        ],
                                        'credentialProviderType' => 'OAUTH|IAM', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'url' => '<string>', // REQUIRED
                            ],
                        ],
                    ],
                ],
            ],
        ],
    ],
    'displayName' => [
        'optionalValue' => '<string>',
    ],
    'name' => '<string>',
    'provenance' => [
        [
            'relation' => 'DETECTED_FROM', // REQUIRED
            'sourceDetails' => [
                'agentcoreGateway' => [
                    'authorizerConfiguration' => [
                        'customJWTAuthorizer' => [
                            'allowedAudience' => ['<string>', ...],
                            'allowedClients' => ['<string>', ...],
                            'allowedScopes' => ['<string>', ...],
                            'customClaims' => [
                                [
                                    'authorizingClaimMatchValue' => [ // REQUIRED
                                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY', // REQUIRED
                                        'claimMatchValue' => [ // REQUIRED
                                            'matchValueString' => '<string>',
                                            'matchValueStringList' => ['<string>', ...],
                                        ],
                                    ],
                                    'inboundTokenClaimName' => '<string>', // REQUIRED
                                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY', // REQUIRED
                                ],
                                // ...
                            ],
                            'discoveryUrl' => '<string>', // REQUIRED
                            'privateEndpoint' => [
                                'managedVpcResource' => [
                                    'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                                    'routingDomain' => '<string>',
                                    'securityGroupIds' => ['<string>', ...],
                                    'subnetIds' => ['<string>', ...], // REQUIRED
                                    'tags' => ['<string>', ...],
                                    'vpcIdentifier' => '<string>', // REQUIRED
                                ],
                                'selfManagedLatticeResource' => [
                                    'resourceConfigurationIdentifier' => '<string>',
                                ],
                            ],
                            'privateEndpointOverrides' => [
                                [
                                    'domain' => '<string>', // REQUIRED
                                    'privateEndpoint' => [ // REQUIRED
                                        'managedVpcResource' => [
                                            'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                                            'routingDomain' => '<string>',
                                            'securityGroupIds' => ['<string>', ...],
                                            'subnetIds' => ['<string>', ...], // REQUIRED
                                            'tags' => ['<string>', ...],
                                            'vpcIdentifier' => '<string>', // REQUIRED
                                        ],
                                        'selfManagedLatticeResource' => [
                                            'resourceConfigurationIdentifier' => '<string>',
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'authorizerType' => '<string>',
                    'protocolType' => 'MCP',
                    'workloadIdentityDetails' => [
                        'workloadIdentityArn' => '<string>', // REQUIRED
                    ],
                ],
                'agentcoreRuntime' => [
                    'authorizerConfiguration' => [
                        'customJWTAuthorizer' => [
                            'allowedAudience' => ['<string>', ...],
                            'allowedClients' => ['<string>', ...],
                            'allowedScopes' => ['<string>', ...],
                            'customClaims' => [
                                [
                                    'authorizingClaimMatchValue' => [ // REQUIRED
                                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY', // REQUIRED
                                        'claimMatchValue' => [ // REQUIRED
                                            'matchValueString' => '<string>',
                                            'matchValueStringList' => ['<string>', ...],
                                        ],
                                    ],
                                    'inboundTokenClaimName' => '<string>', // REQUIRED
                                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY', // REQUIRED
                                ],
                                // ...
                            ],
                            'discoveryUrl' => '<string>', // REQUIRED
                            'privateEndpoint' => [
                                'managedVpcResource' => [
                                    'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                                    'routingDomain' => '<string>',
                                    'securityGroupIds' => ['<string>', ...],
                                    'subnetIds' => ['<string>', ...], // REQUIRED
                                    'tags' => ['<string>', ...],
                                    'vpcIdentifier' => '<string>', // REQUIRED
                                ],
                                'selfManagedLatticeResource' => [
                                    'resourceConfigurationIdentifier' => '<string>',
                                ],
                            ],
                            'privateEndpointOverrides' => [
                                [
                                    'domain' => '<string>', // REQUIRED
                                    'privateEndpoint' => [ // REQUIRED
                                        'managedVpcResource' => [
                                            'endpointIpAddressType' => 'IPV4|IPV6', // REQUIRED
                                            'routingDomain' => '<string>',
                                            'securityGroupIds' => ['<string>', ...],
                                            'subnetIds' => ['<string>', ...], // REQUIRED
                                            'tags' => ['<string>', ...],
                                            'vpcIdentifier' => '<string>', // REQUIRED
                                        ],
                                        'selfManagedLatticeResource' => [
                                            'resourceConfigurationIdentifier' => '<string>',
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'protocolConfiguration' => [
                        'serverProtocol' => 'HTTP|A2A|MCP|AGUI',
                    ],
                    'workloadIdentityDetails' => [
                        'workloadIdentityArn' => '<string>', // REQUIRED
                    ],
                ],
            ],
            'sourceId' => '<string>', // REQUIRED
            'sourceType' => 'AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Gateway',
        ],
        // ...
    ],
    'recordId' => '<string>', // REQUIRED
    'recordType' => 'MCP|AGENT|CUSTOM|SKILL|GATEWAY',
    'recordVersion' => '<string>',
    'registryId' => '<string>', // REQUIRED
    'triggerSynchronization' => true || false,
]);

Parameter Details

Members

description

: Type: UpdatedDescription structure

The updated description of the registry record. Omit to leave the description unchanged; provide an empty wrapper to unset it.

descriptors

: Type: UpdatedDescriptors structure

The updated typed descriptor content for the registry record. Omit to leave the descriptors unchanged.

displayName

: Type: UpdatedDisplayName structure

The updated display name of the registry record. Omit to leave the display name unchanged; provide an empty wrapper to unset it.

name

: Type: string

The updated name of the registry record. Omit to leave the name unchanged.

provenance

: Type: Array of Provenance structures

recordId

: Required: Yes
: Type: string

The identifier of the registry record to update (ARN or ID)

recordType

: Type: string

The updated type of the registry record. Omit to leave the record type unchanged.

recordVersion

: Type: string

The updated version of the registry record. Omit to leave the version unchanged.

registryId

: Required: Yes
: Type: string

The identifier of the registry containing the record (ARN or ID)

triggerSynchronization

: Type: boolean

Whether to trigger synchronization of the record's descriptor content from its source

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'createdByAutoDetection' => true || false,
    'description' => '<string>',
    'descriptors' => [
        'a2aAgentCard' => [
            'data' => '<string>',
            'dataSchemaVersion' => '<string>',
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>',
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM',
                        ],
                        // ...
                    ],
                    'url' => '<string>',
                ],
            ],
        ],
        'agentSkillsDefinition' => [
            'additionalData' => [
                'skillMd' => [
                    'data' => '<string>',
                    'dataSchemaVersion' => '<string>',
                    'source' => [
                        'fromUrl' => [
                            'credentialProviderConfigurations' => [
                                [
                                    'credentialProvider' => [
                                        'iamCredentialProvider' => [
                                            'region' => '<string>',
                                            'roleArn' => '<string>',
                                            'service' => '<string>',
                                        ],
                                        'oauthCredentialProvider' => [
                                            'customParameters' => ['<string>', ...],
                                            'grantType' => 'CLIENT_CREDENTIALS',
                                            'providerArn' => '<string>',
                                            'scopes' => ['<string>', ...],
                                        ],
                                    ],
                                    'credentialProviderType' => 'OAUTH|IAM',
                                ],
                                // ...
                            ],
                            'url' => '<string>',
                        ],
                    ],
                ],
            ],
            'data' => '<string>',
            'dataSchemaVersion' => '<string>',
        ],
        'agui' => [
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>',
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM',
                        ],
                        // ...
                    ],
                    'url' => '<string>',
                ],
            ],
        ],
        'custom' => [
            'data' => '<string>',
        ],
        'http' => [
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>',
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM',
                        ],
                        // ...
                    ],
                    'url' => '<string>',
                ],
            ],
        ],
        'mcpServer' => [
            'additionalData' => [
                'tools' => [
                    'data' => '<string>',
                    'dataSchemaVersion' => '<string>',
                ],
            ],
            'data' => '<string>',
            'dataSchemaVersion' => '<string>',
            'source' => [
                'fromUrl' => [
                    'credentialProviderConfigurations' => [
                        [
                            'credentialProvider' => [
                                'iamCredentialProvider' => [
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'service' => '<string>',
                                ],
                                'oauthCredentialProvider' => [
                                    'customParameters' => ['<string>', ...],
                                    'grantType' => 'CLIENT_CREDENTIALS',
                                    'providerArn' => '<string>',
                                    'scopes' => ['<string>', ...],
                                ],
                            ],
                            'credentialProviderType' => 'OAUTH|IAM',
                        ],
                        // ...
                    ],
                    'url' => '<string>',
                ],
            ],
        ],
    ],
    'displayName' => '<string>',
    'name' => '<string>',
    'provenance' => [
        [
            'relation' => 'DETECTED_FROM',
            'sourceDetails' => [
                'agentcoreGateway' => [
                    'authorizerConfiguration' => [
                        'customJWTAuthorizer' => [
                            'allowedAudience' => ['<string>', ...],
                            'allowedClients' => ['<string>', ...],
                            'allowedScopes' => ['<string>', ...],
                            'customClaims' => [
                                [
                                    'authorizingClaimMatchValue' => [
                                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY',
                                        'claimMatchValue' => [
                                            'matchValueString' => '<string>',
                                            'matchValueStringList' => ['<string>', ...],
                                        ],
                                    ],
                                    'inboundTokenClaimName' => '<string>',
                                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY',
                                ],
                                // ...
                            ],
                            'discoveryUrl' => '<string>',
                            'privateEndpoint' => [
                                'managedVpcResource' => [
                                    'endpointIpAddressType' => 'IPV4|IPV6',
                                    'routingDomain' => '<string>',
                                    'securityGroupIds' => ['<string>', ...],
                                    'subnetIds' => ['<string>', ...],
                                    'tags' => ['<string>', ...],
                                    'vpcIdentifier' => '<string>',
                                ],
                                'selfManagedLatticeResource' => [
                                    'resourceConfigurationIdentifier' => '<string>',
                                ],
                            ],
                            'privateEndpointOverrides' => [
                                [
                                    'domain' => '<string>',
                                    'privateEndpoint' => [
                                        'managedVpcResource' => [
                                            'endpointIpAddressType' => 'IPV4|IPV6',
                                            'routingDomain' => '<string>',
                                            'securityGroupIds' => ['<string>', ...],
                                            'subnetIds' => ['<string>', ...],
                                            'tags' => ['<string>', ...],
                                            'vpcIdentifier' => '<string>',
                                        ],
                                        'selfManagedLatticeResource' => [
                                            'resourceConfigurationIdentifier' => '<string>',
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'authorizerType' => '<string>',
                    'protocolType' => 'MCP',
                    'workloadIdentityDetails' => [
                        'workloadIdentityArn' => '<string>',
                    ],
                ],
                'agentcoreRuntime' => [
                    'authorizerConfiguration' => [
                        'customJWTAuthorizer' => [
                            'allowedAudience' => ['<string>', ...],
                            'allowedClients' => ['<string>', ...],
                            'allowedScopes' => ['<string>', ...],
                            'customClaims' => [
                                [
                                    'authorizingClaimMatchValue' => [
                                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY',
                                        'claimMatchValue' => [
                                            'matchValueString' => '<string>',
                                            'matchValueStringList' => ['<string>', ...],
                                        ],
                                    ],
                                    'inboundTokenClaimName' => '<string>',
                                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY',
                                ],
                                // ...
                            ],
                            'discoveryUrl' => '<string>',
                            'privateEndpoint' => [
                                'managedVpcResource' => [
                                    'endpointIpAddressType' => 'IPV4|IPV6',
                                    'routingDomain' => '<string>',
                                    'securityGroupIds' => ['<string>', ...],
                                    'subnetIds' => ['<string>', ...],
                                    'tags' => ['<string>', ...],
                                    'vpcIdentifier' => '<string>',
                                ],
                                'selfManagedLatticeResource' => [
                                    'resourceConfigurationIdentifier' => '<string>',
                                ],
                            ],
                            'privateEndpointOverrides' => [
                                [
                                    'domain' => '<string>',
                                    'privateEndpoint' => [
                                        'managedVpcResource' => [
                                            'endpointIpAddressType' => 'IPV4|IPV6',
                                            'routingDomain' => '<string>',
                                            'securityGroupIds' => ['<string>', ...],
                                            'subnetIds' => ['<string>', ...],
                                            'tags' => ['<string>', ...],
                                            'vpcIdentifier' => '<string>',
                                        ],
                                        'selfManagedLatticeResource' => [
                                            'resourceConfigurationIdentifier' => '<string>',
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'protocolConfiguration' => [
                        'serverProtocol' => 'HTTP|A2A|MCP|AGUI',
                    ],
                    'workloadIdentityDetails' => [
                        'workloadIdentityArn' => '<string>',
                    ],
                ],
            ],
            'sourceId' => '<string>',
            'sourceType' => 'AWS::BedrockAgentCore::Runtime|AWS::BedrockAgentCore::Gateway',
        ],
        // ...
    ],
    'recordArn' => '<string>',
    'recordId' => '<string>',
    'recordType' => 'MCP|AGENT|CUSTOM|SKILL|GATEWAY',
    'recordVersion' => '<string>',
    'registryArn' => '<string>',
    'status' => 'DRAFT|PENDING_APPROVAL|APPROVED|REJECTED|DEPRECATED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
    'statusReason' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry record was created.

createdBy

: Type: string

The ID of the Amazon Web Services account that created the registry record.

createdByAutoDetection

: Type: boolean

description

: Type: string

A description of the registry record.

descriptors

: Type: Descriptors structure

The typed descriptors that define the content of the registry record.

displayName

: Type: string

The human-readable display name of the registry record.

name

: Required: Yes
: Type: string

The name of the registry record. Names are unique within a registry.

provenance

: Type: Array of Provenance structures

recordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the registry record.

recordId

: Required: Yes
: Type: string

The unique identifier of the registry record.

recordType

: Required: Yes
: Type: string

The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM.

recordVersion

: Type: string

The version identifier of the registry record.

registryArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the parent registry that owns the record.

status

: Required: Yes
: Type: string

The lifecycle status of the registry record.

statusReason

: Type: string

The reason for the current status. Typically populated when the status indicates a failure state.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry record was last updated.

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ResourceNotFoundException:: The requested resource was not found.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.
ConflictException:: The request conflicts with the current state of the resource.

UpdateRegistryRecordStatus

$result = $client->updateRegistryRecordStatus([/* ... */]);
$promise = $client->updateRegistryRecordStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateRegistryRecordStatus([
    'recordId' => '<string>', // REQUIRED
    'registryId' => '<string>', // REQUIRED
    'status' => 'DRAFT|PENDING_APPROVAL|APPROVED|REJECTED|DEPRECATED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED', // REQUIRED
    'statusReason' => '<string>', // REQUIRED
]);

Parameter Details

Members

recordId

: Required: Yes
: Type: string

The identifier of the registry record to update the status of (ARN or ID)

registryId

: Required: Yes
: Type: string

The identifier of the registry containing the record (ARN or ID)

status

: Required: Yes
: Type: string

The target status for the registry record

statusReason

: Required: Yes
: Type: string

The reason for the status change, for example why the record was approved, rejected, or deprecated

Result Syntax

[
    'recordArn' => '<string>',
    'recordId' => '<string>',
    'registryArn' => '<string>',
    'status' => 'DRAFT|PENDING_APPROVAL|APPROVED|REJECTED|DEPRECATED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
    'statusReason' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Members

recordArn

: Required: Yes
: Type: string

The ARN of the registry record

recordId

: Required: Yes
: Type: string

The ID of the registry record

registryArn

: Required: Yes
: Type: string

The ARN of the registry

status

: Required: Yes
: Type: string

The resulting status of the registry record

statusReason

: Required: Yes
: Type: string

The reason for the status change

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the record was last updated

Errors

InternalServerException:: The request failed due to an unexpected internal error; the caller may retry.
AccessDeniedException:: The caller is not authorized to perform the requested action.
ResourceNotFoundException:: The requested resource was not found.
ThrottlingException:: The request was denied due to request throttling; the caller may retry after a delay.
ValidationException:: The request failed validation of one or more input fields.
ConflictException:: The request conflicts with the current state of the resource.

Shapes

A2aAgentCardDescriptor

Description

Descriptor that defines the content of an A2A (Agent-to-Agent) agent card registry record. The content is validated against the A2A protocol schema.

Members

data

: Type: string

The A2A agent card content, serialized as descriptor payload data.

dataSchemaVersion

: Type: string

The schema version of the descriptor payload.

source

: Type: DescriptorSource structure

The optional source configuration used to synchronize the A2A agent card descriptor content.

AccessDeniedException

Description

The caller is not authorized to perform the requested action.

Members

message

: Type: string

AgUiDescriptor

Description

A registry record descriptor for the AG-UI (Agent-User Interaction) protocol.

Members

source

: Type: DescriptorSource structure

The source configuration that defines where descriptor content is retrieved from.

AgentCoreGatewaySourceDetails

Description

Source details for a record auto-detected from an AgentCore Gateway resource.

Members

authorizerConfiguration

: Type: AuthorizerConfiguration structure

The authorizer configuration for a registry. Exactly one member is set.

authorizerType

: Type: string

The type of authorizer configured on the AgentCore Gateway resource that the registry record was detected from.

protocolType

: Type: string

The protocol type of an AgentCore Gateway.

workloadIdentityDetails

: Type: WorkloadIdentityDetails structure

Workload identity details associated with a source resource.

AgentCoreRuntimeProtocolConfiguration

Description

Protocol configuration for an AgentCore Runtime.

Members

serverProtocol

: Type: string

The server protocol used by an AgentCore Runtime.

AgentCoreRuntimeSourceDetails

Description

Source details for a record auto-detected from an AgentCore Runtime resource.

Members

authorizerConfiguration

: Type: AuthorizerConfiguration structure

The authorizer configuration for a registry. Exactly one member is set.

protocolConfiguration

: Type: AgentCoreRuntimeProtocolConfiguration structure

Protocol configuration for an AgentCore Runtime.

workloadIdentityDetails

: Type: WorkloadIdentityDetails structure

Workload identity details associated with a source resource.

AgentSkillsAdditionalData

Description

Additional data associated with an agent skills definition descriptor.

Members

skillMd

: Type: AgentSkillsMdDescriptor structure

The markdown skill content associated with an agent skills definition.

AgentSkillsDefinitionDescriptor

Description

Descriptor that defines an agent skills registry record and its associated content.

Members

additionalData

: Type: AgentSkillsAdditionalData structure

Additional data associated with the agent skills definition descriptor.

data

: Type: string

The agent skills definition content, serialized as descriptor payload data.

dataSchemaVersion

: Type: string

The schema version of the descriptor payload.

AgentSkillsMdDescriptor

Description

Markdown-format descriptor containing an agent skills document.

Members

data

: Type: string

The agent skills markdown content, serialized as descriptor payload data.

dataSchemaVersion

: Type: string

The schema version of the descriptor payload.

source

: Type: DescriptorSource structure

The optional source configuration used to synchronize the agent skills markdown content.

ApprovalConfiguration

Description

Configuration for the registry's record approval workflow. Controls whether records submitted for approval require manual review before they become approved and discoverable, or are auto-approved. When no auto-approval rules are configured, submitted records require manual review.

Members

autoApprovalRules

: Type: Array of strings

The rules that determine which registry records are automatically approved on submission. When omitted or empty, submitted records require manual review.

AuthorizerConfiguration

Description

The authorizer configuration for a registry. Exactly one member is set.

Members

customJWTAuthorizer

: Type: CustomJWTAuthorizerConfiguration structure

Configuration for a custom JWT authorizer.

AuthorizingClaimMatchValueType

Description

The value and match operator used to authorize a claim during JWT validation.

Members

claimMatchOperator

: Required: Yes
: Type: string

The operator used to compare the claim value against the expected value.

claimMatchValue

: Required: Yes
: Type: ClaimMatchValueType structure

The expected value or values that the claim is compared against.

AutoDetection

Description

The auto-detection properties for a registry, including the requested configuration and the current detection status. When auto-detection is enabled and the scope preconditions are met, the registry is automatically populated with discovered resources.

Members

configuration

: Required: Yes
: Type: AutoDetectionConfiguration structure

The auto-detection settings that control how resources are discovered for the registry.

status

: Required: Yes
: Type: string

The current auto-detection status. ACTIVE indicates that the registry is actively being populated with detected resources. INACTIVE indicates that the preconditions required at the configured scope are not currently met.

statusReason

: Type: string

A human-readable explanation of the current auto-detection status. Typically populated when the status requires additional context.

AutoDetectionConfiguration

Description

The customer-defined auto-detection settings for a registry.

Members

enabled

: Required: Yes
: Type: boolean

Specifies whether auto-detection is requested for the registry. Setting this to true is necessary but not sufficient for auto-detection to become active; the preconditions of the configured scope must also be met.

scope

: Required: Yes
: Type: string

The source from which resources are detected. For example, ORGANIZATION sources resources from all member accounts of an Amazon Web Services organization.

ClaimMatchValueType

Description

The expected value used to match a claim. Exactly one member is set.

Members

matchValueString

: Type: string

A single string value to match the claim against.

matchValueStringList

: Type: Array of strings

A list of string values to match the claim against.

ConflictException

Description

The request conflicts with the current state of the resource.

Members

message

: Type: string

CustomClaimValidationType

Description

A validation rule applied to a single claim of an inbound JWT.

Members

authorizingClaimMatchValue

: Required: Yes
: Type: AuthorizingClaimMatchValueType structure

The value and match operator used to authorize the claim.

inboundTokenClaimName

: Required: Yes
: Type: string

The name of the claim in the inbound token to validate.

inboundTokenClaimValueType

: Required: Yes
: Type: string

The value type of the claim in the inbound token, either a string or an array of strings.

CustomDescriptor

Description

Custom descriptor for user-defined content

Members

data

: Type: string

The custom descriptor content, serialized as descriptor payload data.

CustomJWTAuthorizerConfiguration

Description

Configuration for a custom JWT authorizer that validates inbound bearer tokens against an OpenID Connect identity provider.

Members

allowedAudience

: Type: Array of strings

The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.

allowedClients

: Type: Array of strings

The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.

allowedScopes

: Type: Array of strings

The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.

customClaims

: Type: Array of CustomClaimValidationType structures

Additional custom claim validations applied to the inbound JWT.

discoveryUrl

: Required: Yes
: Type: string

The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.

privateEndpoint

: Type: PrivateEndpoint structure

The private endpoint used to reach the identity provider's discovery URL over a private network path.

privateEndpointOverrides

: Type: Array of PrivateEndpointOverride structures

Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.

DescriptorSource

Description

The source configuration that defines where descriptor content is retrieved from.

Members

fromUrl

: Type: DescriptorSourceFromUrl structure

URL-based descriptor source, populated when descriptor content is synchronized from a URL.

DescriptorSourceFromUrl

Description

URL-based descriptor source configuration, with credential provider configurations for authenticated URL retrieval.

Members

credentialProviderConfigurations

: Type: Array of RegistryRecordCredentialProviderConfiguration structures

The credential providers used to authenticate when fetching descriptor content from the source URL.

url

: Required: Yes
: Type: string

The URL from which the descriptor content is retrieved.

Descriptors

Description

The typed set of descriptors for a registry record. Exactly one descriptor field is populated based on the record type.

Members

a2aAgentCard

: Type: A2aAgentCardDescriptor structure

The A2A agent card descriptor, populated when the record type is AGENT.

agentSkillsDefinition

: Type: AgentSkillsDefinitionDescriptor structure

The agent skills definition descriptor, populated when the record type is SKILL.

agui

: Type: AgUiDescriptor structure

The AG-UI descriptor, populated for records detected from an AG-UI protocol source.

custom

: Type: CustomDescriptor structure

The custom descriptor, populated when the record type is CUSTOM.

http

: Type: HttpDescriptor structure

The HTTP descriptor, populated for records detected from an HTTP protocol source.

mcpServer

: Type: McpServerDescriptor structure

The MCP server descriptor, populated when the record type is MCP.

DiscoveryConfiguration

Description

Discovery configuration for the registry. Controls how consumers are authorized to search the registry and invoke its MCP endpoint.

Members

authorizerConfiguration

: Type: AuthorizerConfiguration structure

The authorizer configuration for the registry. Required when authorizerType is CUSTOM_JWT.

authorizerType

: Type: string

The type of authorizer that controls how consumers access the registry's search and MCP invoke operations.

EncryptionConfiguration

Description

The server-side encryption configuration for a registry. Specifies a customer-managed Amazon Web Services KMS key used to encrypt the registry's content.

Members

kmsKeyArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the customer-managed Amazon Web Services KMS key used to encrypt the registry's content. The key must be a symmetric encryption key in the same Amazon Web Services account and Region as the registry.

HttpDescriptor

Description

A registry record descriptor for the HTTP protocol. This descriptor is source-only: its content is synchronized from the configured source URL rather than supplied inline.

Members

source

: Type: DescriptorSource structure

The source configuration that defines where descriptor content is retrieved from.

InternalServerException

Description

The request failed due to an unexpected internal error; the caller may retry.

Members

message

: Type: string

ManagedVpcResource

Description

A service-managed private endpoint provisioned within a customer VPC.

Members

endpointIpAddressType

: Required: Yes
: Type: string

The IP address type used by the private endpoint, either IPV4 or IPV6.

routingDomain

: Type: string

The routing domain used to resolve traffic through the private endpoint.

securityGroupIds

: Type: Array of strings

The identifiers of the security groups associated with the private endpoint network interfaces.

subnetIds

: Required: Yes
: Type: Array of strings

The identifiers of the subnets in which the private endpoint network interfaces are placed.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags applied to the service-managed VPC resource.

vpcIdentifier

: Required: Yes
: Type: string

The identifier of the VPC in which the private endpoint is provisioned.

McpServerAdditionalData

Description

Additional data for an MCP server descriptor

Members

tools

: Type: McpToolsDescriptor structure

The MCP tools descriptor that defines the tools exposed by the MCP server.

McpServerDescriptor

Description

Descriptor that defines the content of an MCP (Model Context Protocol) server registry record, including the server definition and its tool definitions. The content is validated against the MCP protocol schema.

Members

additionalData

: Type: McpServerAdditionalData structure

Additional data associated with the MCP server descriptor, such as tool definitions.

data

: Type: string

The MCP server descriptor content, serialized as descriptor payload data.

dataSchemaVersion

: Type: string

The schema version of the descriptor payload.

source

: Type: DescriptorSource structure

The optional source configuration used to synchronize the MCP server descriptor content.

McpToolsDescriptor

Description

MCP tools descriptor containing tool definitions

Members

data

: Type: string

The MCP tools descriptor content, serialized as descriptor payload data.

dataSchemaVersion

: Type: string

The schema version of the descriptor payload.

PrivateEndpoint

Description

A private network endpoint used to reach a resource over a private path. Exactly one member is set.

Members

managedVpcResource

: Type: ManagedVpcResource structure

A private endpoint backed by a service-managed VPC resource.

selfManagedLatticeResource

: Type: SelfManagedLatticeResource structure

A private endpoint backed by a self-managed VPC Lattice resource configuration.

PrivateEndpointOverride

Description

A mapping of a domain to the private endpoint used to reach it.

Members

domain

: Required: Yes
: Type: string

The domain name to which this private endpoint override applies.

privateEndpoint

: Required: Yes
: Type: PrivateEndpoint structure

The private endpoint used to reach the specified domain.

Provenance

Description

One provenance entry describing the lineage of a registry record.

Members

relation

: Required: Yes
: Type: string

The relationship between the registry record and its provenance source.

sourceDetails

: Type: SourceDetails structure

Additional details about the upstream source that the registry record was detected from, such as the AgentCore Gateway or Runtime configuration. The populated member corresponds to the source type.

sourceId

: Required: Yes
: Type: string

The identifier of the upstream source that the registry record was detected from.

sourceType

: Type: string

The type of the upstream source that the registry record was detected from.

ProvenanceSummary

Description

Condensed provenance entry for list results — the key triple only (no sourceDetails union). Enough to display and client-side-filter lineage without the full-read config payload.

Members

relation

: Required: Yes
: Type: string

The relationship between the registry record and its provenance source.

sourceId

: Required: Yes
: Type: string

The identifier of the upstream source that the registry record was detected from.

sourceType

: Type: string

The type of the upstream source that the registry record was detected from.

RegistryFilter

Description

A single filter applied to a ListRegistries request.

Members

name

: Required: Yes
: Type: string

The attribute to filter on

values

: Required: Yes
: Type: Array of strings

The values to match for the attribute

RegistryRecordCredentialProviderConfiguration

Description

A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.

Members

credentialProvider

: Required: Yes
: Type: RegistryRecordCredentialProviderUnion structure

The credential provider details corresponding to the specified credential provider type.

credentialProviderType

: Required: Yes
: Type: string

The type of credential provider.

RegistryRecordCredentialProviderUnion

Description

The credential provider details for a registry record. Exactly one member is populated, matching the configured credential provider type.

Members

iamCredentialProvider

: Type: RegistryRecordIamCredentialProvider structure

The IAM role credential provider details.

oauthCredentialProvider

: Type: RegistryRecordOAuthCredentialProvider structure

The OAuth 2.0 credential provider details.

RegistryRecordFilter

Description

A single filter applied to a ListRegistryRecords request.

Members

name

: Required: Yes
: Type: string

The attribute to filter on

values

: Required: Yes
: Type: Array of strings

The values to match for the attribute

RegistryRecordIamCredentialProvider

Description

The configuration for an IAM role credential provider that signs requests to a registry record's source with Amazon Web Services Signature Version 4 (SigV4).

Members

region

: Type: string

The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role to assume for request signing.

service

: Type: string

The service name to use for request signing, such as execute-api.

RegistryRecordOAuthCredentialProvider

Description

The configuration for an OAuth 2.0 credential provider that authenticates requests to a registry record's source.

Members

customParameters

: Type: Associative array of custom strings keys (String) to strings

Additional parameters to include in the OAuth 2.0 token request.

grantType

: Type: string

The OAuth 2.0 grant type used to obtain access tokens.

providerArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.

scopes

: Type: Array of strings

The OAuth 2.0 scopes to request when obtaining access tokens.

RegistryRecordSummary

Description

A summary of a registry record returned by list operations. Contains identifying and lifecycle fields but omits descriptor content.

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry record was created.

createdBy

: Type: string

The ID of the Amazon Web Services account that created the registry record.

createdByAutoDetection

: Type: boolean

description

: Type: string

A description of the registry record.

displayName

: Type: string

The human-readable display name of the registry record.

name

: Required: Yes
: Type: string

The name of the registry record. Names are unique within a registry.

provenanceSummaryList

: Type: Array of ProvenanceSummary structures

List of condensed provenance entries surfaced on RegistryRecordSummary. Mirrors ProvenanceList's cardinality (one entry today); modeled as a list for forward-compatibility.

recordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the registry record.

recordId

: Required: Yes
: Type: string

The unique identifier of the registry record.

recordType

: Required: Yes
: Type: string

The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM.

recordVersion

: Required: Yes
: Type: string

The version identifier of the registry record.

registryArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the parent registry that owns the record.

status

: Required: Yes
: Type: string

The lifecycle status of the registry record.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry record was last updated.

RegistrySummary

Description

Registry summary for list operations

Members

autoDetection

: Type: AutoDetection structure

The registry's auto-detection properties, including the requested configuration and the current detection status. Present only when auto-detection was configured for the registry.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry was created

description

: Type: string

Registry description

discoveryConfiguration

: Type: DiscoveryConfiguration structure

Discovery configuration for the registry

name

: Required: Yes
: Type: string

Registry name

registryArn

: Required: Yes
: Type: string

Registry Amazon Resource Name

registryId

: Required: Yes
: Type: string

Unique registry identifier

status

: Required: Yes
: Type: string

Current status of the registry

statusReason

: Type: string

The reason for the current status. Typically populated when the status indicates a failure state.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the registry was last updated

ResourceNotFoundException

Description

The requested resource was not found.

Members

message

: Type: string

SelfManagedLatticeResource

Description

A self-managed private endpoint backed by a VPC Lattice resource configuration. Exactly one member is set.

Members

resourceConfigurationIdentifier

: Type: string

The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.

ServiceQuotaExceededException

Description

The request would exceed a service quota.

Members

message

: Type: string

SourceDetails

Description

The details about the upstream source from which a registry record was detected. Exactly one member is populated, corresponding to the source type.

Members

agentcoreGateway

: Type: AgentCoreGatewaySourceDetails structure

Source details for a record auto-detected from an AgentCore Gateway resource.

agentcoreRuntime

: Type: AgentCoreRuntimeSourceDetails structure

Source details for a record auto-detected from an AgentCore Runtime resource.

ThrottlingException

Description

The request was denied due to request throttling; the caller may retry after a delay.

Members

message

: Type: string

UpdatedA2aAgentCardDescriptor

Description

The A2A agent card descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields.

Members

optionalValue

: Type: UpdatedA2aAgentCardDescriptorFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedA2aAgentCardDescriptorFields

Description

The set of A2A agent card descriptor fields that can be individually updated.

Members

data

: Type: UpdatedDescriptorData structure

The patch for the descriptor's data field.

dataSchemaVersion

: Type: UpdatedDataSchemaVersion structure

The patch for the descriptor's data schema version field.

source

: Type: UpdatedDescriptorSource structure

The patch for the descriptor's source field.

UpdatedAgUiDescriptor

Description

The AG-UI descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields.

Members

optionalValue

: Type: UpdatedAgUiDescriptorFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedAgUiDescriptorFields

Description

The set of AG-UI descriptor fields that can be individually updated.

Members

source

: Type: UpdatedDescriptorSource structure

The patch for the descriptor's source field.

UpdatedAgentSkillsAdditionalData

Description

The agent skills additional-data patch wrapper. Omit to leave the additional data unchanged; supply an empty object to remove it; supply optionalValue to patch its fields.

Members

optionalValue

: Type: UpdatedAgentSkillsAdditionalDataFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedAgentSkillsAdditionalDataFields

Description

The set of agent skills additional-data fields that can be individually updated.

Members

skillMd

: Type: UpdatedAgentSkillsMdDescriptor structure

The patch for the agent skills markdown descriptor field.

UpdatedAgentSkillsDefinitionDescriptor

Description

The agent skills definition descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields.

Members

optionalValue

: Type: UpdatedAgentSkillsDefinitionDescriptorFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedAgentSkillsDefinitionDescriptorFields

Description

The set of agent skills definition descriptor fields that can be individually updated.

Members

additionalData

: Type: UpdatedAgentSkillsAdditionalData structure

The patch for the descriptor's additional data field.

data

: Type: UpdatedDescriptorData structure

The patch for the descriptor's data field.

dataSchemaVersion

: Type: UpdatedDataSchemaVersion structure

The patch for the descriptor's data schema version field.

UpdatedAgentSkillsMdDescriptor

Description

The agent skills markdown descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields.

Members

optionalValue

: Type: UpdatedAgentSkillsMdDescriptorFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedAgentSkillsMdDescriptorFields

Description

The set of agent skills markdown descriptor fields that can be individually updated.

Members

data

: Type: UpdatedDescriptorData structure

The patch for the descriptor's data field.

dataSchemaVersion

: Type: UpdatedDataSchemaVersion structure

The patch for the descriptor's data schema version field.

source

: Type: UpdatedDescriptorSource structure

The patch for the descriptor's source field.

UpdatedApprovalConfiguration

Description

A wrapper for updating the approval configuration of a registry. Include this wrapper to replace the approval configuration with the specified value; omit it to leave the approval configuration unchanged.

Members

optionalValue

: Type: ApprovalConfiguration structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedAuthorizerConfiguration

Description

Wrapper for updating an optional authorizer configuration with PATCH semantics.

Members

optionalValue

: Type: AuthorizerConfiguration structure

The new authorizer configuration to set. Omit to leave the existing configuration unchanged.

UpdatedAutoDetectionConfiguration

Description

A wrapper for updating the auto-detection configuration of a registry with PATCH semantics. Include this wrapper to replace the auto-detection configuration with the specified value. Omit it to leave the auto-detection configuration unchanged. To clear the configuration, include the wrapper with a null optionalValue.

Members

optionalValue

: Type: AutoDetectionConfiguration structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedCustomDescriptor

Description

The custom descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields.

Members

optionalValue

: Type: UpdatedCustomDescriptorFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedCustomDescriptorFields

Description

The set of custom descriptor fields that can be individually updated.

Members

data

: Type: UpdatedDescriptorData structure

The patch for the descriptor's data field.

UpdatedDataSchemaVersion

Description

Leaf patch wrapper for a descriptor's data schema version. Omit to leave unchanged; supply an empty object to unset; supply optionalValue to set.

Members

optionalValue

: Type: string

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedDescription

Description

Wrapper for updating an optional Description field with PATCH semantics

Members

optionalValue

: Type: string

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedDescriptorData

Description

Leaf patch wrapper for descriptor data. Omit to leave unchanged; supply an empty object to unset; supply optionalValue to set.

Members

optionalValue

: Type: string

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedDescriptorSource

Description

Leaf patch wrapper for a descriptor's source configuration. Omit to leave unchanged; supply an empty object to unset; supply optionalValue to set.

Members

optionalValue

: Type: DescriptorSource structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedDescriptors

Description

The top-level descriptors patch wrapper used in UpdateRegistryRecord. Omit to leave the current descriptors unchanged; supply an empty object to clear them; supply optionalValue to apply a per-field patch.

Members

optionalValue

: Type: UpdatedDescriptorsFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedDescriptorsFields

Description

The patchable descriptor fields applied during an UpdateRegistryRecord call. Each field is independently patchable.

Members

a2aAgentCard

: Type: UpdatedA2aAgentCardDescriptor structure

The patch for the A2A agent card descriptor.

agentSkillsDefinition

: Type: UpdatedAgentSkillsDefinitionDescriptor structure

The patch for the agent skills definition descriptor.

agui

: Type: UpdatedAgUiDescriptor structure

The patch for the AG-UI descriptor.

custom

: Type: UpdatedCustomDescriptor structure

The patch for the custom descriptor.

http

: Type: UpdatedHttpDescriptor structure

The patch for the HTTP descriptor.

mcpServer

: Type: UpdatedMcpServerDescriptor structure

The patch for the MCP server descriptor.

UpdatedDiscoveryConfiguration

Description

The discovery configuration fields to update on a registry. Omit this structure to leave the discovery configuration unchanged.

Members

authorizerConfiguration

: Type: UpdatedAuthorizerConfiguration structure

Authorization configuration for the registry, with PATCH semantics

UpdatedDisplayName

Description

Leaf patch wrapper for a registry record's display name. Omit to leave unchanged; supply an empty object to unset; supply optionalValue to set.

Members

optionalValue

: Type: string

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedHttpDescriptor

Description

The HTTP descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields.

Members

optionalValue

: Type: UpdatedHttpDescriptorFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedHttpDescriptorFields

Description

The set of HTTP descriptor fields that can be individually updated.

Members

source

: Type: UpdatedDescriptorSource structure

The patch for the descriptor's source field.

UpdatedMcpServerAdditionalData

Description

The MCP server additional-data patch wrapper. Omit to leave the additional data unchanged; supply an empty object to remove it; supply optionalValue to patch its fields.

Members

optionalValue

: Type: UpdatedMcpServerAdditionalDataFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedMcpServerAdditionalDataFields

Description

The set of MCP server additional-data fields that can be individually updated.

Members

tools

: Type: UpdatedMcpToolsDescriptor structure

The patch for the MCP tools descriptor field.

UpdatedMcpServerDescriptor

Description

The MCP server descriptor patch wrapper. Omit to leave the descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields.

Members

optionalValue

: Type: UpdatedMcpServerDescriptorFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedMcpServerDescriptorFields

Description

The set of MCP server descriptor fields that can be individually updated.

Members

additionalData

: Type: UpdatedMcpServerAdditionalData structure

The patch for the descriptor's additional data field.

data

: Type: UpdatedDescriptorData structure

The patch for the descriptor's data field.

dataSchemaVersion

: Type: UpdatedDataSchemaVersion structure

The patch for the descriptor's data schema version field.

source

: Type: UpdatedDescriptorSource structure

The patch for the descriptor's source field.

UpdatedMcpToolsDescriptor

Description

The MCP tools descriptor patch wrapper. Omit to leave the tools descriptor unchanged; supply an empty object to remove it; supply optionalValue to patch its fields.

Members

optionalValue

: Type: UpdatedMcpToolsDescriptorFields structure

The value to set for this field. Omit the wrapper to leave the field unchanged.

UpdatedMcpToolsDescriptorFields

Description

The set of MCP tools descriptor fields that can be individually updated.

Members

data

: Type: UpdatedDescriptorData structure

The patch for the descriptor's data field.

dataSchemaVersion

: Type: UpdatedDataSchemaVersion structure

The patch for the descriptor's data schema version field.

ValidationException

Description

The request failed validation of one or more input fields.

Members

fieldList

: Type: Array of ValidationExceptionField structures

The list of input fields that failed validation.

message

: Required: Yes
: Type: string

reason

: Required: Yes
: Type: string

The reason the request failed validation.

ValidationExceptionField

Description

Describes a single input field that failed validation.

Members

message

: Required: Yes
: Type: string

A description of why the field failed validation.

name

: Required: Yes
: Type: string

The name of the field that failed validation.

WorkloadIdentityDetails

Description

Workload identity details associated with a source resource.

Members

workloadIdentityArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workload identity associated with the source resource.

Agent Registry Control 2025-12-01

Operation Summary

Paginators

Waiters

Operations

CreateRegistry

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateRegistryRecord

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteRegistry

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteRegistryRecord

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetRegistry

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetRegistryRecord

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListRegistries

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListRegistryRecords

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

SubmitRegistryRecordForApproval

Parameter Syntax

Parameter Details

Members