AgentRegistryControl / Client / create_registry_record

create_registry_record¶

AgentRegistryControl.Client.create_registry_record(**kwargs)¶

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.

Request Syntax

response = client.create_registry_record(
    registryId='string',
    name='string',
    displayName='string',
    description='string',
    recordType='MCP'|'AGENT'|'CUSTOM'|'SKILL',
    descriptors={
        'mcpServer': {
            'data': 'string',
            'dataSchemaVersion': 'string',
            'additionalData': {
                'tools': {
                    'data': 'string',
                    'dataSchemaVersion': 'string'
                }
            },
            'source': {
                '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'
                                }
                            }
                        },
                    ]
                }
            }
        },
        'a2aAgentCard': {
            'data': 'string',
            'dataSchemaVersion': 'string',
            'source': {
                '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'
                                }
                            }
                        },
                    ]
                }
            }
        },
        'agentSkillsDefinition': {
            'data': 'string',
            'dataSchemaVersion': 'string',
            'additionalData': {
                'skillMd': {
                    'data': 'string',
                    'dataSchemaVersion': 'string',
                    'source': {
                        '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'
                                        }
                                    }
                                },
                            ]
                        }
                    }
                }
            }
        },
        'custom': {
            'data': 'string'
        }
    },
    recordVersion='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)

Parameters:

registryId (string) –
[REQUIRED]

The identifier of the registry in which to create the record (ARN or ID)
name (string) –
[REQUIRED]

The name of the registry record
displayName (string) – The human-readable display name of the registry record
description (string) – The description of the registry record
recordType (string) –
[REQUIRED]

The type of the registry record, which determines the descriptor format
descriptors (dict) –
[REQUIRED]

The typed descriptor content for the registry record
- mcpServer (dict) –
  
  The MCP server descriptor, populated when the record type is MCP.
  - data (string) –
    
    The MCP server descriptor content, serialized as descriptor payload data.
  - dataSchemaVersion (string) –
    
    The schema version of the descriptor payload.
  - additionalData (dict) –
    
    Additional data associated with the MCP server descriptor, such as tool definitions.
    - tools (dict) –
      
      MCP tools descriptor containing tool definitions
      - data (string) –
        
        Descriptor payload data
      - dataSchemaVersion (string) –
        
        Version of the descriptor type schema
  - source (dict) –
    
    The optional source configuration used to synchronize the MCP server descriptor content.
    - fromUrl (dict) –
      
      URL-based descriptor source, populated when descriptor content is synchronized from a URL.
      - url (string) – [REQUIRED]
        
        The URL from which the descriptor content is retrieved.
      - credentialProviderConfigurations (list) –
        
        The credential providers used to authenticate when fetching descriptor content from the source URL.
        
        (dict) –
        
        A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record’s source URL.
        
        credentialProviderType (string) – [REQUIRED]
        
        The type of credential provider.
        
        credentialProvider (dict) – [REQUIRED]
        
        The credential provider details corresponding to the specified credential provider type.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: oauthCredentialProvider, iamCredentialProvider.
        
        oauthCredentialProvider (dict) –
        
        The OAuth 2.0 credential provider details.
        
        providerArn (string) – [REQUIRED]
        
        The &ARN; of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
        
        grantType (string) –
        
        The OAuth 2.0 grant type used to obtain access tokens.
        
        scopes (list) –
        
        The OAuth 2.0 scopes to request when obtaining access tokens.
        
        (string) –
        
        customParameters (dict) –
        
        Additional parameters to include in the OAuth 2.0 token request.
        
        (string) –
        
        (string) –
        
        iamCredentialProvider (dict) –
        
        The IAM role credential provider details.
        
        roleArn (string) –
        
        The &ARN; of the IAM role to assume for request signing.
        
        service (string) –
        
        The service name to use for request signing, such as execute-api.
        
        region (string) –
        
        The AWS 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.
- a2aAgentCard (dict) –
  
  The A2A agent card descriptor, populated when the record type is AGENT.
  - data (string) –
    
    The A2A agent card content, serialized as descriptor payload data.
  - dataSchemaVersion (string) –
    
    The schema version of the descriptor payload.
  - source (dict) –
    
    The optional source configuration used to synchronize the A2A agent card descriptor content.
    - fromUrl (dict) –
      
      URL-based descriptor source, populated when descriptor content is synchronized from a URL.
      - url (string) – [REQUIRED]
        
        The URL from which the descriptor content is retrieved.
      - credentialProviderConfigurations (list) –
        
        The credential providers used to authenticate when fetching descriptor content from the source URL.
        
        (dict) –
        
        A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record’s source URL.
        
        credentialProviderType (string) – [REQUIRED]
        
        The type of credential provider.
        
        credentialProvider (dict) – [REQUIRED]
        
        The credential provider details corresponding to the specified credential provider type.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: oauthCredentialProvider, iamCredentialProvider.
        
        oauthCredentialProvider (dict) –
        
        The OAuth 2.0 credential provider details.
        
        providerArn (string) – [REQUIRED]
        
        The &ARN; of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
        
        grantType (string) –
        
        The OAuth 2.0 grant type used to obtain access tokens.
        
        scopes (list) –
        
        The OAuth 2.0 scopes to request when obtaining access tokens.
        
        (string) –
        
        customParameters (dict) –
        
        Additional parameters to include in the OAuth 2.0 token request.
        
        (string) –
        
        (string) –
        
        iamCredentialProvider (dict) –
        
        The IAM role credential provider details.
        
        roleArn (string) –
        
        The &ARN; of the IAM role to assume for request signing.
        
        service (string) –
        
        The service name to use for request signing, such as execute-api.
        
        region (string) –
        
        The AWS 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.
- agentSkillsDefinition (dict) –
  
  The agent skills definition descriptor, populated when the record type is SKILL.
  - data (string) –
    
    The agent skills definition content, serialized as descriptor payload data.
  - dataSchemaVersion (string) –
    
    The schema version of the descriptor payload.
  - additionalData (dict) –
    
    Additional data associated with the agent skills definition descriptor.
    - skillMd (dict) –
      
      The markdown skill content associated with an agent skills definition.
      - data (string) –
        
        The agent skills markdown content, serialized as descriptor payload data.
      - dataSchemaVersion (string) –
        
        The schema version of the descriptor payload.
      - source (dict) –
        
        The optional source configuration used to synchronize the agent skills markdown content.
        
        fromUrl (dict) –
        
        URL-based descriptor source, populated when descriptor content is synchronized from a URL.
        
        url (string) – [REQUIRED]
        
        The URL from which the descriptor content is retrieved.
        
        credentialProviderConfigurations (list) –
        
        The credential providers used to authenticate when fetching descriptor content from the source URL.
        
        (dict) –
        
        A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record’s source URL.
        
        credentialProviderType (string) – [REQUIRED]
        
        The type of credential provider.
        
        credentialProvider (dict) – [REQUIRED]
        
        The credential provider details corresponding to the specified credential provider type.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: oauthCredentialProvider, iamCredentialProvider.
        
        oauthCredentialProvider (dict) –
        
        The OAuth 2.0 credential provider details.
        
        providerArn (string) – [REQUIRED]
        
        The &ARN; of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
        
        grantType (string) –
        
        The OAuth 2.0 grant type used to obtain access tokens.
        
        scopes (list) –
        
        The OAuth 2.0 scopes to request when obtaining access tokens.
        
        (string) –
        
        customParameters (dict) –
        
        Additional parameters to include in the OAuth 2.0 token request.
        
        (string) –
        
        (string) –
        
        iamCredentialProvider (dict) –
        
        The IAM role credential provider details.
        
        roleArn (string) –
        
        The &ARN; of the IAM role to assume for request signing.
        
        service (string) –
        
        The service name to use for request signing, such as execute-api.
        
        region (string) –
        
        The AWS 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.
- custom (dict) –
  
  The custom descriptor, populated when the record type is CUSTOM.
  - data (string) –
    
    Descriptor payload data
recordVersion (string) – The version of the registry record
clientToken (string) –
Client token for idempotency

This field is autopopulated if not provided.
tags (dict) –
Tags to associate with the registry record
- (string) –
  
  Key of a tag.
  - (string) –
    
    Value of a tag.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

Response structure for creating a registry record
- recordArn (string) –
  
  The ARN of the created registry record
- status (string) –
  
  The status of the registry record, set to CREATING while the asynchronous workflow is in progress

create_registry_record¶

Request Syntax

Note

Note

Note

Response Syntax

Response Structure

Exceptions