BedrockAgentCoreControl / Client / get_registry_record

get_registry_record¶

BedrockAgentCoreControl.Client.get_registry_record(**kwargs)¶

Retrieves information about a specific registry record.

Request Syntax

response = client.get_registry_record(
    registryId='string',
    recordId='string'
)

Parameters:

registryId (string) –
[REQUIRED]

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
recordId (string) –
[REQUIRED]

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

Return type:

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.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: oauthCredentialProvider, iamCredentialProvider. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.

Exceptions

BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ConflictException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException