Amazon Bedrock AgentCore Control

2026/04/09 - Amazon Bedrock AgentCore Control - 12 new api methods

Changes  Introducing support for SearchRegistryRecords API on AgentCoreRegistry

UpdateRegistryRecordStatus (new) Link ¶

Updates the status of a registry record. Use this operation to approve, reject, or deprecate a registry record.

See also: AWS API Documentation

Request Syntax

client.update_registry_record_status(
    registryId='string',
    recordId='string',
    status='DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    statusReason='string'
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

type recordId:

string

param recordId:

[REQUIRED]

The identifier of the registry record to update the status for. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

type status:

string

param status:

[REQUIRED]

The target status for the registry record.

type statusReason:

string

param statusReason:

[REQUIRED]

The reason for the status change, such as why the record was approved or rejected.

rtype:

dict

returns:

Response Syntax

{
    'registryArn': 'string',
    'recordArn': 'string',
    'recordId': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    'statusReason': 'string',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • registryArn (string) --

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

    • recordArn (string) --

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

    • recordId (string) --

      The unique identifier of the registry record.

    • status (string) --

      The resulting status of the registry record.

    • statusReason (string) --

      The reason for the status change.

    • updatedAt (datetime) --

      The timestamp when the record was last updated.

ListRegistries (new) Link ¶

Lists all registries in the account. You can optionally filter results by status using the status parameter.

See also: AWS API Documentation

Request Syntax

client.list_registries(
    maxResults=123,
    nextToken='string',
    status='CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'
)
type maxResults:

integer

param maxResults:

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

type nextToken:

string

param nextToken:

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

type status:

string

param status:

Filter registries by their current status. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

rtype:

dict

returns:

Response Syntax

{
    'registries': [
        {
            'name': 'string',
            'description': 'string',
            'registryId': 'string',
            'registryArn': 'string',
            'authorizerType': 'CUSTOM_JWT'|'AWS_IAM',
            'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
            'statusReason': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • registries (list) --

      The list of registry summaries. For details about the fields in each summary, see the RegistrySummary data type.

      • (dict) --

        Contains summary information about a registry.

        • name (string) --

          The name of the registry.

        • description (string) --

          The description of the registry.

        • registryId (string) --

          The unique identifier of the registry.

        • registryArn (string) --

          The Amazon Resource Name (ARN) of the registry.

        • authorizerType (string) --

          The type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

          • CUSTOM_JWT - Authorize with a bearer token.

          • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

        • status (string) --

          The current status of the registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

        • statusReason (string) --

          The reason for the current status, typically set when the status is a failure state.

        • createdAt (datetime) --

          The timestamp when the registry was created.

        • updatedAt (datetime) --

          The timestamp when the registry was last updated.

    • nextToken (string) --

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

ListRegistryRecords (new) Link ¶

Lists registry records within a registry. You can optionally filter results using the name, status, and descriptorType parameters. When multiple filters are specified, they are combined using AND logic.

See also: AWS API Documentation

Request Syntax

client.list_registry_records(
    registryId='string',
    maxResults=123,
    nextToken='string',
    name='string',
    status='DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    descriptorType='MCP'|'A2A'|'CUSTOM'|'AGENT_SKILLS'
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry to list records from. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

type maxResults:

integer

param maxResults:

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

type nextToken:

string

param nextToken:

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

type name:

string

param name:

Filter registry records by name.

type status:

string

param status:

Filter registry records by their current status. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

type descriptorType:

string

param descriptorType:

Filter registry records by their descriptor type. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

rtype:

dict

returns:

Response Syntax

{
    'registryRecords': [
        {
            'registryArn': 'string',
            'recordArn': 'string',
            'recordId': 'string',
            'name': 'string',
            'description': 'string',
            'descriptorType': 'MCP'|'A2A'|'CUSTOM'|'AGENT_SKILLS',
            'recordVersion': 'string',
            'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • registryRecords (list) --

      The list of registry record summaries. For details about the fields in each summary, see the RegistryRecordSummary data type.

      • (dict) --

        Contains summary information about a registry record.

        • registryArn (string) --

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

        • recordArn (string) --

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

        • recordId (string) --

          The unique identifier of the registry record.

        • name (string) --

          The name of the registry record.

        • description (string) --

          The description of the registry record.

        • descriptorType (string) --

          The descriptor type of the registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

        • recordVersion (string) --

          The version of the registry record.

        • status (string) --

          The current status of the registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

        • createdAt (datetime) --

          The timestamp when the registry record was created.

        • updatedAt (datetime) --

          The timestamp when the registry record was last updated.

    • nextToken (string) --

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

UpdateRegistryRecord (new) Link ¶

Updates an existing registry record. This operation uses PATCH semantics, so you only need to specify the fields you want to change. The update is processed asynchronously and returns HTTP 202 Accepted.

See also: AWS API Documentation

Request Syntax

client.update_registry_record(
    registryId='string',
    recordId='string',
    name='string',
    description={
        'optionalValue': 'string'
    },
    descriptorType='MCP'|'A2A'|'CUSTOM'|'AGENT_SKILLS',
    descriptors={
        'optionalValue': {
            'mcp': {
                'optionalValue': {
                    'server': {
                        'optionalValue': {
                            'schemaVersion': 'string',
                            'inlineContent': 'string'
                        }
                    },
                    'tools': {
                        'optionalValue': {
                            'protocolVersion': 'string',
                            'inlineContent': 'string'
                        }
                    }
                }
            },
            'a2a': {
                'optionalValue': {
                    'agentCard': {
                        'schemaVersion': 'string',
                        'inlineContent': 'string'
                    }
                }
            },
            'custom': {
                'optionalValue': {
                    'inlineContent': 'string'
                }
            },
            'agentSkills': {
                'optionalValue': {
                    'skillMd': {
                        'optionalValue': {
                            'inlineContent': 'string'
                        }
                    },
                    'skillDefinition': {
                        'optionalValue': {
                            'schemaVersion': 'string',
                            'inlineContent': 'string'
                        }
                    }
                }
            }
        }
    },
    recordVersion='string',
    synchronizationType={
        'optionalValue': 'URL'
    },
    synchronizationConfiguration={
        'optionalValue': {
            'fromUrl': {
                'url': 'string',
                'credentialProviderConfigurations': [
                    {
                        'credentialProviderType': 'OAUTH'|'IAM',
                        'credentialProvider': {
                            'oauthCredentialProvider': {
                                'providerArn': 'string',
                                'grantType': 'CLIENT_CREDENTIALS',
                                'scopes': [
                                    'string',
                                ],
                                'customParameters': {
                                    'string': 'string'
                                }
                            },
                            'iamCredentialProvider': {
                                'roleArn': 'string',
                                'service': 'string',
                                'region': 'string'
                            }
                        }
                    },
                ]
            }
        }
    },
    triggerSynchronization=True|False
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

type recordId:

string

param recordId:

[REQUIRED]

The identifier of the registry record to update. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

type name:

string

param name:

The updated name for the registry record.

type description:

dict

param description:

The updated description for the registry record. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.

  • optionalValue (string) --

    Represents an optional value that is used to update the human-readable description of the resource. If not specified, it will clear the current description of the resource.

type descriptorType:

string

param descriptorType:

The updated descriptor type for the registry record. Changing the descriptor type may require updating the descriptors field to match the new type's schema requirements.

type descriptors:

dict

param descriptors:

The updated descriptor-type-specific configuration containing the resource schema and metadata. Uses PATCH semantics where individual descriptor fields can be updated independently.

  • optionalValue (dict) --

    The updated descriptors value. Contains per-descriptor-type wrappers that are each independently updatable.

    • mcp (dict) --

      The updated MCP descriptor.

      • optionalValue (dict) --

        The updated MCP descriptor fields.

        • server (dict) --

          The updated server definition for the MCP descriptor.

          • optionalValue (dict) --

            The updated server definition value.

            • schemaVersion (string) --

              The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

            • inlineContent (string) --

              The JSON content containing the MCP server definition, conforming to the MCP protocol specification.

        • tools (dict) --

          The updated tools definition for the MCP descriptor.

          • optionalValue (dict) --

            The updated tools definition value.

            • protocolVersion (string) --

              The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

            • inlineContent (string) --

              The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.

    • a2a (dict) --

      The updated A2A descriptor.

      • optionalValue (dict) --

        The updated A2A descriptor value.

        • agentCard (dict) --

          The agent card definition for the A2A agent, as defined by the A2A protocol specification.

          • schemaVersion (string) --

            The schema version of the agent card based on the A2A protocol specification.

          • inlineContent (string) --

            The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.

    • custom (dict) --

      The updated custom descriptor.

      • optionalValue (dict) --

        The updated custom descriptor value.

        • inlineContent (string) --

          The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.

    • agentSkills (dict) --

      The updated agent skills descriptor.

      • optionalValue (dict) --

        The updated agent skills descriptor fields.

        • skillMd (dict) --

          The updated skill markdown definition.

          • optionalValue (dict) --

            The updated skill markdown definition value.

            • inlineContent (string) --

              The markdown content describing the agent's skills in a human-readable format.

        • skillDefinition (dict) --

          The updated skill definition.

          • optionalValue (dict) --

            The updated skill definition value.

            • schemaVersion (string) --

              The version of the skill definition schema.

            • inlineContent (string) --

              The JSON content containing the structured skill definition.

type recordVersion:

string

param recordVersion:

The version of the registry record for optimistic locking. If provided, it must match the current version of the record. The service automatically increments the version after a successful update.

type synchronizationType:

dict

param synchronizationType:

The updated synchronization type for the registry record.

  • optionalValue (string) --

    The updated synchronization type value.

type synchronizationConfiguration:

dict

param synchronizationConfiguration:

The updated synchronization configuration for the registry record.

  • optionalValue (dict) --

    The updated synchronization configuration value.

    • fromUrl (dict) --

      Configuration for synchronizing from a URL-based source.

      • url (string) -- [REQUIRED]

        The HTTPS URL of the MCP server to synchronize from.

      • credentialProviderConfigurations (list) --

        Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified.

        • (dict) --

          A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.

          • credentialProviderType (string) -- [REQUIRED]

            The type of credential provider.

            • OAUTH - OAuth-based authentication.

            • IAM - Amazon Web Services IAM-based authentication using SigV4 signing.

          • credentialProvider (dict) -- [REQUIRED]

            The credential provider configuration details. The structure depends on the credentialProviderType.

            • oauthCredentialProvider (dict) --

              The OAuth credential provider configuration for authenticating with the external source.

              • providerArn (string) -- [REQUIRED]

                The Amazon Resource Name (ARN) of the OAuth credential provider resource.

              • grantType (string) --

                The OAuth grant type. Currently only CLIENT_CREDENTIALS is supported.

              • scopes (list) --

                The OAuth scopes to request during authentication.

                • (string) --

              • customParameters (dict) --

                Additional custom parameters for the OAuth flow.

                • (string) --

                  • (string) --

            • iamCredentialProvider (dict) --

              The IAM credential provider configuration for authenticating with the external source using SigV4 signing.

              • roleArn (string) --

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

              • service (string) --

                The SigV4 signing service name (for example, execute-api or bedrock-agentcore).

              • region (string) --

                The Amazon Web Services region for SigV4 signing (for example, us-west-2). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service's own region.

type triggerSynchronization:

boolean

param triggerSynchronization:

Whether to trigger synchronization using the stored or provided configuration. When set to true, the service will synchronize the record metadata from the configured external source.

rtype:

dict

returns:

Response Syntax

{
    'registryArn': 'string',
    'recordArn': 'string',
    'recordId': 'string',
    'name': 'string',
    'description': 'string',
    'descriptorType': 'MCP'|'A2A'|'CUSTOM'|'AGENT_SKILLS',
    'descriptors': {
        'mcp': {
            'server': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            },
            'tools': {
                'protocolVersion': 'string',
                'inlineContent': 'string'
            }
        },
        'a2a': {
            'agentCard': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            }
        },
        'custom': {
            'inlineContent': 'string'
        },
        'agentSkills': {
            'skillMd': {
                'inlineContent': 'string'
            },
            'skillDefinition': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            }
        }
    },
    'recordVersion': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'statusReason': 'string',
    'synchronizationType': 'URL',
    'synchronizationConfiguration': {
        'fromUrl': {
            'url': 'string',
            'credentialProviderConfigurations': [
                {
                    'credentialProviderType': 'OAUTH'|'IAM',
                    'credentialProvider': {
                        'oauthCredentialProvider': {
                            'providerArn': 'string',
                            'grantType': 'CLIENT_CREDENTIALS',
                            'scopes': [
                                'string',
                            ],
                            'customParameters': {
                                'string': 'string'
                            }
                        },
                        'iamCredentialProvider': {
                            'roleArn': 'string',
                            'service': 'string',
                            'region': 'string'
                        }
                    }
                },
            ]
        }
    }
}

Response Structure

  • (dict) --

    • registryArn (string) --

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

    • recordArn (string) --

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

    • recordId (string) --

      The unique identifier of the updated registry record.

    • name (string) --

      The name of the updated registry record.

    • description (string) --

      The description of the updated registry record.

    • descriptorType (string) --

      The descriptor type of the updated registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

    • descriptors (dict) --

      The descriptor-type-specific configuration of the updated registry record. For details, see the Descriptors data type.

      • mcp (dict) --

        The Model Context Protocol (MCP) descriptor configuration. Use this when the descriptorType is MCP.

        • server (dict) --

          The MCP server definition, containing the server configuration and schema as defined by the MCP protocol specification.

          • schemaVersion (string) --

            The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

          • inlineContent (string) --

            The JSON content containing the MCP server definition, conforming to the MCP protocol specification.

        • tools (dict) --

          The MCP tools definition, containing the tools available on the MCP server as defined by the MCP protocol specification.

          • protocolVersion (string) --

            The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

          • inlineContent (string) --

            The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.

      • a2a (dict) --

        The Agent-to-Agent (A2A) protocol descriptor configuration. Use this when the descriptorType is A2A.

        • agentCard (dict) --

          The agent card definition for the A2A agent, as defined by the A2A protocol specification.

          • schemaVersion (string) --

            The schema version of the agent card based on the A2A protocol specification.

          • inlineContent (string) --

            The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.

      • custom (dict) --

        The custom descriptor configuration. Use this when the descriptorType is CUSTOM.

        • inlineContent (string) --

          The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.

      • agentSkills (dict) --

        The agent skills descriptor configuration. Use this when the descriptorType is AGENT_SKILLS.

        • skillMd (dict) --

          The optional skill markdown definition describing the agent's skills in a human-readable format.

          • inlineContent (string) --

            The markdown content describing the agent's skills in a human-readable format.

        • skillDefinition (dict) --

          The structured skill definition with schema version and content.

          • schemaVersion (string) --

            The version of the skill definition schema.

          • inlineContent (string) --

            The JSON content containing the structured skill definition.

    • recordVersion (string) --

      The version of the updated registry record.

    • status (string) --

      The current status of the updated registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

    • createdAt (datetime) --

      The timestamp when the registry record was created.

    • updatedAt (datetime) --

      The timestamp when the registry record was last updated.

    • statusReason (string) --

      The reason for the current status of the updated registry record.

    • synchronizationType (string) --

      The synchronization type of the updated registry record.

    • synchronizationConfiguration (dict) --

      The synchronization configuration of the updated registry record.

      • fromUrl (dict) --

        Configuration for synchronizing from a URL-based source.

        • url (string) --

          The HTTPS URL of the MCP server to synchronize from.

        • credentialProviderConfigurations (list) --

          Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified.

          • (dict) --

            A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.

            • credentialProviderType (string) --

              The type of credential provider.

              • OAUTH - OAuth-based authentication.

              • IAM - Amazon Web Services IAM-based authentication using SigV4 signing.

            • credentialProvider (dict) --

              The credential provider configuration details. The structure depends on the credentialProviderType.

              • oauthCredentialProvider (dict) --

                The OAuth credential provider configuration for authenticating with the external source.

                • providerArn (string) --

                  The Amazon Resource Name (ARN) of the OAuth credential provider resource.

                • grantType (string) --

                  The OAuth grant type. Currently only CLIENT_CREDENTIALS is supported.

                • scopes (list) --

                  The OAuth scopes to request during authentication.

                  • (string) --

                • customParameters (dict) --

                  Additional custom parameters for the OAuth flow.

                  • (string) --

                    • (string) --

              • iamCredentialProvider (dict) --

                The IAM credential provider configuration for authenticating with the external source using SigV4 signing.

                • roleArn (string) --

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

                • service (string) --

                  The SigV4 signing service name (for example, execute-api or bedrock-agentcore).

                • region (string) --

                  The Amazon Web Services region for SigV4 signing (for example, us-west-2). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service's own region.

SubmitRegistryRecordForApproval (new) Link ¶

Submits a registry record for approval. This transitions the record from DRAFT status to PENDING_APPROVAL status. If the registry has auto-approval enabled, the record is automatically approved.

See also: AWS API Documentation

Request Syntax

client.submit_registry_record_for_approval(
    registryId='string',
    recordId='string'
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

type recordId:

string

param recordId:

[REQUIRED]

The identifier of the registry record to submit for approval. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

rtype:

dict

returns:

Response Syntax

{
    'registryArn': 'string',
    'recordArn': 'string',
    'recordId': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • registryArn (string) --

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

    • recordArn (string) --

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

    • recordId (string) --

      The unique identifier of the registry record.

    • status (string) --

      The resulting status of the registry record after submission.

    • updatedAt (datetime) --

      The timestamp when the record was last updated.

GetRegistryRecord (new) Link ¶

Retrieves information about a specific registry record.

See also: AWS API Documentation

Request Syntax

client.get_registry_record(
    registryId='string',
    recordId='string'
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

type recordId:

string

param recordId:

[REQUIRED]

The identifier of the registry record to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

rtype:

dict

returns:

Response Syntax

{
    'registryArn': 'string',
    'recordArn': 'string',
    'recordId': 'string',
    'name': 'string',
    'description': 'string',
    'descriptorType': 'MCP'|'A2A'|'CUSTOM'|'AGENT_SKILLS',
    'descriptors': {
        'mcp': {
            'server': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            },
            'tools': {
                'protocolVersion': 'string',
                'inlineContent': 'string'
            }
        },
        'a2a': {
            'agentCard': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            }
        },
        'custom': {
            'inlineContent': 'string'
        },
        'agentSkills': {
            'skillMd': {
                'inlineContent': 'string'
            },
            'skillDefinition': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            }
        }
    },
    'recordVersion': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'statusReason': 'string',
    'synchronizationType': 'URL',
    'synchronizationConfiguration': {
        'fromUrl': {
            'url': 'string',
            'credentialProviderConfigurations': [
                {
                    'credentialProviderType': 'OAUTH'|'IAM',
                    'credentialProvider': {
                        'oauthCredentialProvider': {
                            'providerArn': 'string',
                            'grantType': 'CLIENT_CREDENTIALS',
                            'scopes': [
                                'string',
                            ],
                            'customParameters': {
                                'string': 'string'
                            }
                        },
                        'iamCredentialProvider': {
                            'roleArn': 'string',
                            'service': 'string',
                            'region': 'string'
                        }
                    }
                },
            ]
        }
    }
}

Response Structure

  • (dict) --

    • registryArn (string) --

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

    • recordArn (string) --

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

    • recordId (string) --

      The unique identifier of the registry record.

    • name (string) --

      The name of the registry record.

    • description (string) --

      The description of the registry record.

    • descriptorType (string) --

      The descriptor type of the registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

    • descriptors (dict) --

      The descriptor-type-specific configuration containing the resource schema and metadata. For details, see the Descriptors data type.

      • mcp (dict) --

        The Model Context Protocol (MCP) descriptor configuration. Use this when the descriptorType is MCP.

        • server (dict) --

          The MCP server definition, containing the server configuration and schema as defined by the MCP protocol specification.

          • schemaVersion (string) --

            The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

          • inlineContent (string) --

            The JSON content containing the MCP server definition, conforming to the MCP protocol specification.

        • tools (dict) --

          The MCP tools definition, containing the tools available on the MCP server as defined by the MCP protocol specification.

          • protocolVersion (string) --

            The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

          • inlineContent (string) --

            The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.

      • a2a (dict) --

        The Agent-to-Agent (A2A) protocol descriptor configuration. Use this when the descriptorType is A2A.

        • agentCard (dict) --

          The agent card definition for the A2A agent, as defined by the A2A protocol specification.

          • schemaVersion (string) --

            The schema version of the agent card based on the A2A protocol specification.

          • inlineContent (string) --

            The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.

      • custom (dict) --

        The custom descriptor configuration. Use this when the descriptorType is CUSTOM.

        • inlineContent (string) --

          The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.

      • agentSkills (dict) --

        The agent skills descriptor configuration. Use this when the descriptorType is AGENT_SKILLS.

        • skillMd (dict) --

          The optional skill markdown definition describing the agent's skills in a human-readable format.

          • inlineContent (string) --

            The markdown content describing the agent's skills in a human-readable format.

        • skillDefinition (dict) --

          The structured skill definition with schema version and content.

          • schemaVersion (string) --

            The version of the skill definition schema.

          • inlineContent (string) --

            The JSON content containing the structured skill definition.

    • recordVersion (string) --

      The version of the registry record.

    • status (string) --

      The current status of the registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED. A record transitions from CREATING to DRAFT, then to PENDING_APPROVAL (via SubmitRegistryRecordForApproval), and finally to APPROVED upon approval.

    • createdAt (datetime) --

      The timestamp when the registry record was created.

    • updatedAt (datetime) --

      The timestamp when the registry record was last updated.

    • statusReason (string) --

      The reason for the current status, typically set when the status is a failure state.

    • synchronizationType (string) --

      The type of synchronization used for this record.

    • synchronizationConfiguration (dict) --

      The configuration for synchronizing registry record metadata from an external source.

      • fromUrl (dict) --

        Configuration for synchronizing from a URL-based source.

        • url (string) --

          The HTTPS URL of the MCP server to synchronize from.

        • credentialProviderConfigurations (list) --

          Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified.

          • (dict) --

            A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.

            • credentialProviderType (string) --

              The type of credential provider.

              • OAUTH - OAuth-based authentication.

              • IAM - Amazon Web Services IAM-based authentication using SigV4 signing.

            • credentialProvider (dict) --

              The credential provider configuration details. The structure depends on the credentialProviderType.

              • oauthCredentialProvider (dict) --

                The OAuth credential provider configuration for authenticating with the external source.

                • providerArn (string) --

                  The Amazon Resource Name (ARN) of the OAuth credential provider resource.

                • grantType (string) --

                  The OAuth grant type. Currently only CLIENT_CREDENTIALS is supported.

                • scopes (list) --

                  The OAuth scopes to request during authentication.

                  • (string) --

                • customParameters (dict) --

                  Additional custom parameters for the OAuth flow.

                  • (string) --

                    • (string) --

              • iamCredentialProvider (dict) --

                The IAM credential provider configuration for authenticating with the external source using SigV4 signing.

                • roleArn (string) --

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

                • service (string) --

                  The SigV4 signing service name (for example, execute-api or bedrock-agentcore).

                • region (string) --

                  The Amazon Web Services region for SigV4 signing (for example, us-west-2). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service's own region.

DeleteRegistry (new) Link ¶

Deletes a registry. The registry must contain zero records before it can be deleted. This operation initiates the deletion process asynchronously.

See also: AWS API Documentation

Request Syntax

client.delete_registry(
    registryId='string'
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

rtype:

dict

returns:

Response Syntax

{
    'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'
}

Response Structure

  • (dict) --

    • status (string) --

      The current status of the registry, set to DELETING when deletion is initiated. For a list of all possible registry statuses, see the RegistryStatus data type.

GetRegistry (new) Link ¶

Retrieves information about a specific registry.

See also: AWS API Documentation

Request Syntax

client.get_registry(
    registryId='string'
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

rtype:

dict

returns:

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'registryId': 'string',
    'registryArn': 'string',
    'authorizerType': 'CUSTOM_JWT'|'AWS_IAM',
    'authorizerConfiguration': {
        'customJWTAuthorizer': {
            'discoveryUrl': 'string',
            'allowedAudience': [
                'string',
            ],
            'allowedClients': [
                'string',
            ],
            'allowedScopes': [
                'string',
            ],
            'customClaims': [
                {
                    'inboundTokenClaimName': 'string',
                    'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                    'authorizingClaimMatchValue': {
                        'claimMatchValue': {
                            'matchValueString': 'string',
                            'matchValueStringList': [
                                'string',
                            ]
                        },
                        'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                    }
                },
            ]
        }
    },
    'approvalConfiguration': {
        'autoApproval': True|False
    },
    'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
    'statusReason': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the registry.

    • description (string) --

      The description of the registry.

    • registryId (string) --

      The unique identifier of the registry.

    • registryArn (string) --

      The Amazon Resource Name (ARN) of the registry.

    • authorizerType (string) --

      The type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

    • authorizerConfiguration (dict) --

      The authorizer configuration for the registry. For details, see the AuthorizerConfiguration data type.

      • customJWTAuthorizer (dict) --

        The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

        • discoveryUrl (string) --

          This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

        • allowedAudience (list) --

          Represents individual audience values that are validated in the incoming JWT token validation process.

          • (string) --

        • allowedClients (list) --

          Represents individual client IDs that are validated in the incoming JWT token validation process.

          • (string) --

        • allowedScopes (list) --

          An array of scopes that are allowed to access the token.

          • (string) --

        • customClaims (list) --

          An array of objects that define a custom claim validation name, value, and operation

          • (dict) --

            Defines the name of a custom claim field and rules for finding matches to authenticate its value.

            • inboundTokenClaimName (string) --

              The name of the custom claim field to check.

            • inboundTokenClaimValueType (string) --

              The data type of the claim value to check for.

              • Use STRING if you want to find an exact match to a string you define.

              • Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

            • authorizingClaimMatchValue (dict) --

              Defines the value or values to match for and the relationship of the match.

              • claimMatchValue (dict) --

                The value or values to match for.

                • matchValueString (string) --

                  The string value to match for.

                • matchValueStringList (list) --

                  An array of strings to check for a match.

                  • (string) --

              • claimMatchOperator (string) --

                Defines the relationship between the claim field value and the value or values you're matching for.

    • approvalConfiguration (dict) --

      The approval configuration for registry records. For details, see the ApprovalConfiguration data type.

      • autoApproval (boolean) --

        Whether registry records are auto-approved. When set to true, records are automatically approved upon creation. When set to false (the default), records require explicit approval for security purposes.

    • status (string) --

      The current status of the registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

    • statusReason (string) --

      The reason for the current status, typically set when the status is a failure state.

    • createdAt (datetime) --

      The timestamp when the registry was created.

    • updatedAt (datetime) --

      The timestamp when the registry was last updated.

UpdateRegistry (new) Link ¶

Updates an existing registry. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

See also: AWS API Documentation

Request Syntax

client.update_registry(
    registryId='string',
    name='string',
    description={
        'optionalValue': 'string'
    },
    authorizerConfiguration={
        'optionalValue': {
            'customJWTAuthorizer': {
                'discoveryUrl': 'string',
                'allowedAudience': [
                    'string',
                ],
                'allowedClients': [
                    'string',
                ],
                'allowedScopes': [
                    'string',
                ],
                'customClaims': [
                    {
                        'inboundTokenClaimName': 'string',
                        'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                        'authorizingClaimMatchValue': {
                            'claimMatchValue': {
                                'matchValueString': 'string',
                                'matchValueStringList': [
                                    'string',
                                ]
                            },
                            'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                        }
                    },
                ]
            }
        }
    },
    approvalConfiguration={
        'optionalValue': {
            'autoApproval': True|False
        }
    }
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry to update. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

type name:

string

param name:

The updated name of the registry.

type description:

dict

param description:

The updated description of the registry. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.

  • optionalValue (string) --

    Represents an optional value that is used to update the human-readable description of the resource. If not specified, it will clear the current description of the resource.

type authorizerConfiguration:

dict

param authorizerConfiguration:

The updated authorizer configuration for the registry. Changing the authorizer configuration can break existing consumers of the registry who are using the authorization type prior to the update.

  • optionalValue (dict) --

    The updated authorizer configuration value. If not specified, it will clear the current authorizer configuration of the resource.

    • customJWTAuthorizer (dict) --

      The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

      • discoveryUrl (string) -- [REQUIRED]

        This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

      • allowedAudience (list) --

        Represents individual audience values that are validated in the incoming JWT token validation process.

        • (string) --

      • allowedClients (list) --

        Represents individual client IDs that are validated in the incoming JWT token validation process.

        • (string) --

      • allowedScopes (list) --

        An array of scopes that are allowed to access the token.

        • (string) --

      • customClaims (list) --

        An array of objects that define a custom claim validation name, value, and operation

        • (dict) --

          Defines the name of a custom claim field and rules for finding matches to authenticate its value.

          • inboundTokenClaimName (string) -- [REQUIRED]

            The name of the custom claim field to check.

          • inboundTokenClaimValueType (string) -- [REQUIRED]

            The data type of the claim value to check for.

            • Use STRING if you want to find an exact match to a string you define.

            • Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

          • authorizingClaimMatchValue (dict) -- [REQUIRED]

            Defines the value or values to match for and the relationship of the match.

            • claimMatchValue (dict) -- [REQUIRED]

              The value or values to match for.

              • matchValueString (string) --

                The string value to match for.

              • matchValueStringList (list) --

                An array of strings to check for a match.

                • (string) --

            • claimMatchOperator (string) -- [REQUIRED]

              Defines the relationship between the claim field value and the value or values you're matching for.

type approvalConfiguration:

dict

param approvalConfiguration:

The updated approval configuration for registry records. The updated configuration only affects new records that move to PENDING_APPROVAL status after the change. Existing records already in PENDING_APPROVAL status are not affected.

  • optionalValue (dict) --

    The updated approval configuration value. Set to null to unset the approval configuration.

    • autoApproval (boolean) --

      Whether registry records are auto-approved. When set to true, records are automatically approved upon creation. When set to false (the default), records require explicit approval for security purposes.

rtype:

dict

returns:

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'registryId': 'string',
    'registryArn': 'string',
    'authorizerType': 'CUSTOM_JWT'|'AWS_IAM',
    'authorizerConfiguration': {
        'customJWTAuthorizer': {
            'discoveryUrl': 'string',
            'allowedAudience': [
                'string',
            ],
            'allowedClients': [
                'string',
            ],
            'allowedScopes': [
                'string',
            ],
            'customClaims': [
                {
                    'inboundTokenClaimName': 'string',
                    'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                    'authorizingClaimMatchValue': {
                        'claimMatchValue': {
                            'matchValueString': 'string',
                            'matchValueStringList': [
                                'string',
                            ]
                        },
                        'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                    }
                },
            ]
        }
    },
    'approvalConfiguration': {
        'autoApproval': True|False
    },
    'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
    'statusReason': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the updated registry.

    • description (string) --

      The description of the updated registry.

    • registryId (string) --

      The unique identifier of the updated registry.

    • registryArn (string) --

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

    • authorizerType (string) --

      The type of authorizer used by the updated registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

    • authorizerConfiguration (dict) --

      The authorizer configuration for the updated registry. For details, see the AuthorizerConfiguration data type.

      • customJWTAuthorizer (dict) --

        The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

        • discoveryUrl (string) --

          This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

        • allowedAudience (list) --

          Represents individual audience values that are validated in the incoming JWT token validation process.

          • (string) --

        • allowedClients (list) --

          Represents individual client IDs that are validated in the incoming JWT token validation process.

          • (string) --

        • allowedScopes (list) --

          An array of scopes that are allowed to access the token.

          • (string) --

        • customClaims (list) --

          An array of objects that define a custom claim validation name, value, and operation

          • (dict) --

            Defines the name of a custom claim field and rules for finding matches to authenticate its value.

            • inboundTokenClaimName (string) --

              The name of the custom claim field to check.

            • inboundTokenClaimValueType (string) --

              The data type of the claim value to check for.

              • Use STRING if you want to find an exact match to a string you define.

              • Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

            • authorizingClaimMatchValue (dict) --

              Defines the value or values to match for and the relationship of the match.

              • claimMatchValue (dict) --

                The value or values to match for.

                • matchValueString (string) --

                  The string value to match for.

                • matchValueStringList (list) --

                  An array of strings to check for a match.

                  • (string) --

              • claimMatchOperator (string) --

                Defines the relationship between the claim field value and the value or values you're matching for.

    • approvalConfiguration (dict) --

      The approval configuration for the updated registry. For details, see the ApprovalConfiguration data type.

      • autoApproval (boolean) --

        Whether registry records are auto-approved. When set to true, records are automatically approved upon creation. When set to false (the default), records require explicit approval for security purposes.

    • status (string) --

      The current status of the updated registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

    • statusReason (string) --

      The reason for the current status of the updated registry.

    • createdAt (datetime) --

      The timestamp when the registry was created.

    • updatedAt (datetime) --

      The timestamp when the registry was last updated.

CreateRegistry (new) Link ¶

Creates a new registry in your Amazon Web Services account. A registry serves as a centralized catalog for organizing and managing registry records, including MCP servers, A2A agents, agent skills, and custom resource types.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

See also: AWS API Documentation

Request Syntax

client.create_registry(
    name='string',
    description='string',
    authorizerType='CUSTOM_JWT'|'AWS_IAM',
    authorizerConfiguration={
        'customJWTAuthorizer': {
            'discoveryUrl': 'string',
            'allowedAudience': [
                'string',
            ],
            'allowedClients': [
                'string',
            ],
            'allowedScopes': [
                'string',
            ],
            'customClaims': [
                {
                    'inboundTokenClaimName': 'string',
                    'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                    'authorizingClaimMatchValue': {
                        'claimMatchValue': {
                            'matchValueString': 'string',
                            'matchValueStringList': [
                                'string',
                            ]
                        },
                        'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                    }
                },
            ]
        }
    },
    clientToken='string',
    approvalConfiguration={
        'autoApproval': True|False
    }
)
type name:

string

param name:

[REQUIRED]

The name of the registry. The name must be unique within your account and can contain alphanumeric characters and underscores.

type description:

string

param description:

A description of the registry.

type authorizerType:

string

param authorizerType:

The type of authorizer to use for the registry. This controls the authorization method for the Search and Invoke APIs used by consumers, and does not affect the standard CRUDL APIs for registry and registry record management used by administrators.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

type authorizerConfiguration:

dict

param authorizerConfiguration:

The authorizer configuration for the registry. Required if authorizerType is CUSTOM_JWT. For details, see the AuthorizerConfiguration data type.

  • customJWTAuthorizer (dict) --

    The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

    • discoveryUrl (string) -- [REQUIRED]

      This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

    • allowedAudience (list) --

      Represents individual audience values that are validated in the incoming JWT token validation process.

      • (string) --

    • allowedClients (list) --

      Represents individual client IDs that are validated in the incoming JWT token validation process.

      • (string) --

    • allowedScopes (list) --

      An array of scopes that are allowed to access the token.

      • (string) --

    • customClaims (list) --

      An array of objects that define a custom claim validation name, value, and operation

      • (dict) --

        Defines the name of a custom claim field and rules for finding matches to authenticate its value.

        • inboundTokenClaimName (string) -- [REQUIRED]

          The name of the custom claim field to check.

        • inboundTokenClaimValueType (string) -- [REQUIRED]

          The data type of the claim value to check for.

          • Use STRING if you want to find an exact match to a string you define.

          • Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

        • authorizingClaimMatchValue (dict) -- [REQUIRED]

          Defines the value or values to match for and the relationship of the match.

          • claimMatchValue (dict) -- [REQUIRED]

            The value or values to match for.

            • matchValueString (string) --

              The string value to match for.

            • matchValueStringList (list) --

              An array of strings to check for a match.

              • (string) --

          • claimMatchOperator (string) -- [REQUIRED]

            Defines the relationship between the claim field value and the value or values you're matching for.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

type approvalConfiguration:

dict

param approvalConfiguration:

The approval configuration for registry records. Controls whether records require explicit approval before becoming active. See the ApprovalConfiguration data type for supported configuration options.

  • autoApproval (boolean) --

    Whether registry records are auto-approved. When set to true, records are automatically approved upon creation. When set to false (the default), records require explicit approval for security purposes.

rtype:

dict

returns:

Response Syntax

{
    'registryArn': 'string'
}

Response Structure

  • (dict) --

    • registryArn (string) --

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

CreateRegistryRecord (new) Link ¶

Creates a new registry record within the specified registry. A registry record represents an individual AI resource's metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema.

The record is processed asynchronously and returns HTTP 202 Accepted.

See also: AWS API Documentation

Request Syntax

client.create_registry_record(
    registryId='string',
    name='string',
    description='string',
    descriptorType='MCP'|'A2A'|'CUSTOM'|'AGENT_SKILLS',
    descriptors={
        'mcp': {
            'server': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            },
            'tools': {
                'protocolVersion': 'string',
                'inlineContent': 'string'
            }
        },
        'a2a': {
            'agentCard': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            }
        },
        'custom': {
            'inlineContent': 'string'
        },
        'agentSkills': {
            'skillMd': {
                'inlineContent': 'string'
            },
            'skillDefinition': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            }
        }
    },
    recordVersion='string',
    synchronizationType='URL',
    synchronizationConfiguration={
        'fromUrl': {
            'url': 'string',
            'credentialProviderConfigurations': [
                {
                    'credentialProviderType': 'OAUTH'|'IAM',
                    'credentialProvider': {
                        'oauthCredentialProvider': {
                            'providerArn': 'string',
                            'grantType': 'CLIENT_CREDENTIALS',
                            'scopes': [
                                'string',
                            ],
                            'customParameters': {
                                'string': 'string'
                            }
                        },
                        'iamCredentialProvider': {
                            'roleArn': 'string',
                            'service': 'string',
                            'region': 'string'
                        }
                    }
                },
            ]
        }
    },
    clientToken='string'
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry where the record will be created. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

type name:

string

param name:

[REQUIRED]

The name of the registry record.

type description:

string

param description:

A description of the registry record.

type descriptorType:

string

param descriptorType:

[REQUIRED]

The descriptor type of the registry record.

  • MCP - Model Context Protocol descriptor for MCP-compatible servers and tools.

  • A2A - Agent-to-Agent protocol descriptor.

  • CUSTOM - Custom descriptor type for resources such as APIs, Lambda functions, or servers not conforming to a standard protocol.

  • AGENT_SKILLS - Agent skills descriptor for defining agent skill definitions.

type descriptors:

dict

param descriptors:

The descriptor-type-specific configuration containing the resource schema and metadata. The structure of this field depends on the descriptorType you specify.

  • mcp (dict) --

    The Model Context Protocol (MCP) descriptor configuration. Use this when the descriptorType is MCP.

    • server (dict) --

      The MCP server definition, containing the server configuration and schema as defined by the MCP protocol specification.

      • schemaVersion (string) --

        The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

      • inlineContent (string) --

        The JSON content containing the MCP server definition, conforming to the MCP protocol specification.

    • tools (dict) --

      The MCP tools definition, containing the tools available on the MCP server as defined by the MCP protocol specification.

      • protocolVersion (string) --

        The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

      • inlineContent (string) --

        The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.

  • a2a (dict) --

    The Agent-to-Agent (A2A) protocol descriptor configuration. Use this when the descriptorType is A2A.

    • agentCard (dict) --

      The agent card definition for the A2A agent, as defined by the A2A protocol specification.

      • schemaVersion (string) --

        The schema version of the agent card based on the A2A protocol specification.

      • inlineContent (string) --

        The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.

  • custom (dict) --

    The custom descriptor configuration. Use this when the descriptorType is CUSTOM.

    • inlineContent (string) --

      The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.

  • agentSkills (dict) --

    The agent skills descriptor configuration. Use this when the descriptorType is AGENT_SKILLS.

    • skillMd (dict) --

      The optional skill markdown definition describing the agent's skills in a human-readable format.

      • inlineContent (string) --

        The markdown content describing the agent's skills in a human-readable format.

    • skillDefinition (dict) --

      The structured skill definition with schema version and content.

      • schemaVersion (string) --

        The version of the skill definition schema.

      • inlineContent (string) --

        The JSON content containing the structured skill definition.

type recordVersion:

string

param recordVersion:

The version of the registry record. Use this to track different versions of the record's content.

type synchronizationType:

string

param synchronizationType:

The type of synchronization to use for keeping the record metadata up to date from an external source. Possible values include FROM_URL and NONE.

type synchronizationConfiguration:

dict

param synchronizationConfiguration:

The configuration for synchronizing registry record metadata from an external source, such as a URL-based MCP server.

  • fromUrl (dict) --

    Configuration for synchronizing from a URL-based source.

    • url (string) -- [REQUIRED]

      The HTTPS URL of the MCP server to synchronize from.

    • credentialProviderConfigurations (list) --

      Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified.

      • (dict) --

        A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.

        • credentialProviderType (string) -- [REQUIRED]

          The type of credential provider.

          • OAUTH - OAuth-based authentication.

          • IAM - Amazon Web Services IAM-based authentication using SigV4 signing.

        • credentialProvider (dict) -- [REQUIRED]

          The credential provider configuration details. The structure depends on the credentialProviderType.

          • oauthCredentialProvider (dict) --

            The OAuth credential provider configuration for authenticating with the external source.

            • providerArn (string) -- [REQUIRED]

              The Amazon Resource Name (ARN) of the OAuth credential provider resource.

            • grantType (string) --

              The OAuth grant type. Currently only CLIENT_CREDENTIALS is supported.

            • scopes (list) --

              The OAuth scopes to request during authentication.

              • (string) --

            • customParameters (dict) --

              Additional custom parameters for the OAuth flow.

              • (string) --

                • (string) --

          • iamCredentialProvider (dict) --

            The IAM credential provider configuration for authenticating with the external source using SigV4 signing.

            • roleArn (string) --

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

            • service (string) --

              The SigV4 signing service name (for example, execute-api or bedrock-agentcore).

            • region (string) --

              The Amazon Web Services region for SigV4 signing (for example, us-west-2). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service's own region.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'recordArn': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'
}

Response Structure

  • (dict) --

    • recordArn (string) --

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

    • status (string) --

      The status of the registry record. Set to CREATING while the asynchronous workflow is in progress.

DeleteRegistryRecord (new) Link ¶

Deletes a registry record. The record's status transitions to DELETING and the record is removed asynchronously.

See also: AWS API Documentation

Request Syntax

client.delete_registry_record(
    registryId='string',
    recordId='string'
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

type recordId:

string

param recordId:

[REQUIRED]

The identifier of the registry record to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --