AgentRegistryControl / Client / get_registry_record

get_registry_record

AgentRegistryControl.Client.get_registry_record(**kwargs)

Retrieves the details of a registry record

See also: AWS API Documentation

Request Syntax

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

  • registryId (string) –

    [REQUIRED]

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

  • recordId (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'registryArn': 'string',
    'recordArn': 'string',
    'recordId': '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',
    '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'
}

Response Structure

  • (dict) –

    Response structure for retrieving a registry record

    • registryArn (string) –

      The &ARN; of the parent registry that owns the record.

    • recordArn (string) –

      The &ARN; of the registry record.

    • recordId (string) –

      The unique identifier of the registry record.

    • name (string) –

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

    • displayName (string) –

      The human-readable display name of the registry record.

    • description (string) –

      A description of the registry record.

    • recordType (string) –

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

    • descriptors (dict) –

      The typed descriptors that define the content of 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) –

              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) –

                  The type of credential provider.

                • credentialProvider (dict) –

                  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 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 2.0 credential provider details.

                    • providerArn (string) –

                      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) –

              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) –

                  The type of credential provider.

                • credentialProvider (dict) –

                  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 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 2.0 credential provider details.

                    • providerArn (string) –

                      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) –

                  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) –

                      The type of credential provider.

                    • credentialProvider (dict) –

                      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 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 2.0 credential provider details.

                        • providerArn (string) –

                          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 identifier of the registry record.

    • status (string) –

      The lifecycle status of the registry record.

    • 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 populated when the status indicates a failure state.

Exceptions