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'|'GATEWAY',
    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'
        },
        'http': {
            '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'
                                }
                            }
                        },
                    ]
                }
            }
        },
        'agui': {
            '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'
                                }
                            }
                        },
                    ]
                }
            }
        }
    },
    recordVersion='string',
    clientToken='string',
    provenance=[
        {
            'relation': 'DETECTED_FROM',
            'sourceId': 'string',
            'sourceType': 'AWS::BedrockAgentCore::Runtime'|'AWS::BedrockAgentCore::Gateway',
            'sourceDetails': {
                'agentcoreRuntime': {
                    'protocolConfiguration': {
                        'serverProtocol': 'HTTP'|'A2A'|'MCP'|'AGUI'
                    },
                    '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'
                                    }
                                },
                            ],
                            'privateEndpoint': {
                                'selfManagedLatticeResource': {
                                    'resourceConfigurationIdentifier': 'string'
                                },
                                'managedVpcResource': {
                                    'vpcIdentifier': 'string',
                                    'subnetIds': [
                                        'string',
                                    ],
                                    'endpointIpAddressType': 'IPV4'|'IPV6',
                                    'securityGroupIds': [
                                        'string',
                                    ],
                                    'tags': {
                                        'string': 'string'
                                    },
                                    'routingDomain': 'string'
                                }
                            },
                            'privateEndpointOverrides': [
                                {
                                    'domain': 'string',
                                    'privateEndpoint': {
                                        'selfManagedLatticeResource': {
                                            'resourceConfigurationIdentifier': 'string'
                                        },
                                        'managedVpcResource': {
                                            'vpcIdentifier': 'string',
                                            'subnetIds': [
                                                'string',
                                            ],
                                            'endpointIpAddressType': 'IPV4'|'IPV6',
                                            'securityGroupIds': [
                                                'string',
                                            ],
                                            'tags': {
                                                'string': 'string'
                                            },
                                            'routingDomain': 'string'
                                        }
                                    }
                                },
                            ]
                        }
                    },
                    'workloadIdentityDetails': {
                        'workloadIdentityArn': 'string'
                    }
                },
                'agentcoreGateway': {
                    'protocolType': 'MCP',
                    'authorizerType': 'string',
                    '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'
                                    }
                                },
                            ],
                            'privateEndpoint': {
                                'selfManagedLatticeResource': {
                                    'resourceConfigurationIdentifier': 'string'
                                },
                                'managedVpcResource': {
                                    'vpcIdentifier': 'string',
                                    'subnetIds': [
                                        'string',
                                    ],
                                    'endpointIpAddressType': 'IPV4'|'IPV6',
                                    'securityGroupIds': [
                                        'string',
                                    ],
                                    'tags': {
                                        'string': 'string'
                                    },
                                    'routingDomain': 'string'
                                }
                            },
                            'privateEndpointOverrides': [
                                {
                                    'domain': 'string',
                                    'privateEndpoint': {
                                        'selfManagedLatticeResource': {
                                            'resourceConfigurationIdentifier': 'string'
                                        },
                                        'managedVpcResource': {
                                            'vpcIdentifier': 'string',
                                            'subnetIds': [
                                                'string',
                                            ],
                                            'endpointIpAddressType': 'IPV4'|'IPV6',
                                            'securityGroupIds': [
                                                'string',
                                            ],
                                            'tags': {
                                                'string': 'string'
                                            },
                                            'routingDomain': 'string'
                                        }
                                    }
                                },
                            ]
                        }
                    },
                    'workloadIdentityDetails': {
                        'workloadIdentityArn': 'string'
                    }
                }
            }
        },
    ],
    customMetadata={...}|[...]|123|123.4|'string'|True|None,
    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) –
      
      The MCP tools descriptor that defines the tools exposed by the MCP server.
      - data (string) –
        
        The MCP tools descriptor 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 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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
- 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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
- 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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
- custom (dict) –
  
  The custom descriptor, populated when the record type is CUSTOM.
  - data (string) –
    
    The custom descriptor content, serialized as descriptor payload data.
- http (dict) –
  
  The HTTP descriptor, populated for records detected from an HTTP protocol source.
  - source (dict) –
    
    The source configuration that defines where descriptor content is retrieved from.
    - 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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
- agui (dict) –
  
  The AG-UI descriptor, populated for records detected from an AG-UI protocol source.
  - source (dict) –
    
    The source configuration that defines where descriptor content is retrieved from.
    - 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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
recordVersion (string) – The version of the registry record
clientToken (string) –
Client token for idempotency

This field is autopopulated if not provided.
provenance (list) –
The provenance lineage entries for the registry record. This field is reserved for the Amazon Web Services Agent Registry auto-detection service principal. Requests that include this field from other callers are rejected.
- (dict) –
  
  A provenance entry that describes the lineage of a registry record. Records that were auto-detected by Amazon Web Services Agent Registry carry a provenance entry that links the record back to its upstream source.
  - relation (string) – [REQUIRED]
    
    The relationship between the registry record and its upstream source. DETECTED_FROM indicates that the record was auto-detected from the source resource.
  - sourceId (string) – [REQUIRED]
    
    The identifier of the upstream source that the registry record was detected from.
  - sourceType (string) –
    
    The type of the upstream source that the registry record was detected from.
  - sourceDetails (dict) –
    
    Additional details about the upstream source that the registry record was detected from, such as the AgentCore Gateway or Runtime configuration. The populated member corresponds to the source type.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: agentcoreRuntime, agentcoreGateway.
    - agentcoreRuntime (dict) –
      
      The source details for a registry record that was auto-detected from an Amazon Bedrock AgentCore Runtime resource. Populated when the source type is AWS::BedrockAgentCore::Runtime.
      - protocolConfiguration (dict) –
        
        The protocol configuration of the AgentCore Runtime resource that the registry record was detected from.
        
        serverProtocol (string) –
        
        The server protocol used by the AgentCore Runtime, such as MCP, HTTP, A2A, or AGUI.
      - authorizerConfiguration (dict) –
        
        The authorizer configuration for a registry. Exactly one member is set.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: customJWTAuthorizer.
        
        customJWTAuthorizer (dict) –
        
        Configuration for a custom JWT authorizer.
        
        discoveryUrl (string) – [REQUIRED]
        
        The OpenID Connect discovery URL used to retrieve the identity provider’s metadata and signing keys.
        
        allowedAudience (list) –
        
        The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
        
        (string) –
        
        An audience value that an inbound JWT must contain to be authorized.
        
        allowedClients (list) –
        
        The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
        
        (string) –
        
        A client identifier that an inbound JWT must be issued to in order to be authorized.
        
        allowedScopes (list) –
        
        The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
        
        (string) –
        
        A scope value that an inbound JWT must carry to be authorized.
        
        customClaims (list) –
        
        Additional custom claim validations applied to the inbound JWT.
        
        (dict) –
        
        A validation rule applied to a single claim of an inbound JWT.
        
        inboundTokenClaimName (string) – [REQUIRED]
        
        The name of the claim in the inbound token to validate.
        
        inboundTokenClaimValueType (string) – [REQUIRED]
        
        The value type of the claim in the inbound token, either a string or an array of strings.
        
        authorizingClaimMatchValue (dict) – [REQUIRED]
        
        The value and match operator used to authorize the claim.
        
        claimMatchValue (dict) – [REQUIRED]
        
        The expected value or values that the claim is compared against.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: matchValueString, matchValueStringList.
        
        matchValueString (string) –
        
        A single string value to match the claim against.
        
        matchValueStringList (list) –
        
        A list of string values to match the claim against.
        
        (string) –
        
        A single value used to match a claim during JWT validation.
        
        claimMatchOperator (string) – [REQUIRED]
        
        The operator used to compare the claim value against the expected value.
        
        privateEndpoint (dict) –
        
        The private endpoint used to reach the identity provider’s discovery URL over a private network path.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: selfManagedLatticeResource, managedVpcResource.
        
        selfManagedLatticeResource (dict) –
        
        A private endpoint backed by a self-managed VPC Lattice resource configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: resourceConfigurationIdentifier.
        
        resourceConfigurationIdentifier (string) –
        
        The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
        
        managedVpcResource (dict) –
        
        A private endpoint backed by a service-managed VPC resource.
        
        vpcIdentifier (string) – [REQUIRED]
        
        The identifier of the VPC in which the private endpoint is provisioned.
        
        subnetIds (list) – [REQUIRED]
        
        The identifiers of the subnets in which the private endpoint network interfaces are placed.
        
        (string) –
        
        Subnet identifier
        
        endpointIpAddressType (string) – [REQUIRED]
        
        The IP address type used by the private endpoint, either IPV4 or IPV6.
        
        securityGroupIds (list) –
        
        The identifiers of the security groups associated with the private endpoint network interfaces.
        
        (string) –
        
        The identifier of a security group.
        
        tags (dict) –
        
        The tags applied to the service-managed VPC resource.
        
        (string) –
        
        Key of a tag.
        
        (string) –
        
        Value of a tag.
        
        routingDomain (string) –
        
        The routing domain used to resolve traffic through the private endpoint.
        
        privateEndpointOverrides (list) –
        
        Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
        
        (dict) –
        
        A mapping of a domain to the private endpoint used to reach it.
        
        domain (string) – [REQUIRED]
        
        The domain name to which this private endpoint override applies.
        
        privateEndpoint (dict) – [REQUIRED]
        
        The private endpoint used to reach the specified domain.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: selfManagedLatticeResource, managedVpcResource.
        
        selfManagedLatticeResource (dict) –
        
        A private endpoint backed by a self-managed VPC Lattice resource configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: resourceConfigurationIdentifier.
        
        resourceConfigurationIdentifier (string) –
        
        The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
        
        managedVpcResource (dict) –
        
        A private endpoint backed by a service-managed VPC resource.
        
        vpcIdentifier (string) – [REQUIRED]
        
        The identifier of the VPC in which the private endpoint is provisioned.
        
        subnetIds (list) – [REQUIRED]
        
        The identifiers of the subnets in which the private endpoint network interfaces are placed.
        
        (string) –
        
        Subnet identifier
        
        endpointIpAddressType (string) – [REQUIRED]
        
        The IP address type used by the private endpoint, either IPV4 or IPV6.
        
        securityGroupIds (list) –
        
        The identifiers of the security groups associated with the private endpoint network interfaces.
        
        (string) –
        
        The identifier of a security group.
        
        tags (dict) –
        
        The tags applied to the service-managed VPC resource.
        
        (string) –
        
        Key of a tag.
        
        (string) –
        
        Value of a tag.
        
        routingDomain (string) –
        
        The routing domain used to resolve traffic through the private endpoint.
      - workloadIdentityDetails (dict) –
        
        The workload identity details for the AgentCore Runtime resource. Present when the runtime has a workload identity configured.
        
        workloadIdentityArn (string) – [REQUIRED]
        
        The Amazon Resource Name (ARN) of the workload identity associated with the source resource.
    - agentcoreGateway (dict) –
      
      The source details for a registry record that was auto-detected from an Amazon Bedrock AgentCore Gateway resource. Populated when the source type is AWS::BedrockAgentCore::Gateway.
      - protocolType (string) –
        
        The protocol type of the AgentCore Gateway resource that the registry record was detected from, for example MCP.
      - authorizerType (string) –
        
        The type of authorizer configured on the AgentCore Gateway resource that the registry record was detected from.
      - authorizerConfiguration (dict) –
        
        The authorizer configuration for a registry. Exactly one member is set.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: customJWTAuthorizer.
        
        customJWTAuthorizer (dict) –
        
        Configuration for a custom JWT authorizer.
        
        discoveryUrl (string) – [REQUIRED]
        
        The OpenID Connect discovery URL used to retrieve the identity provider’s metadata and signing keys.
        
        allowedAudience (list) –
        
        The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
        
        (string) –
        
        An audience value that an inbound JWT must contain to be authorized.
        
        allowedClients (list) –
        
        The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
        
        (string) –
        
        A client identifier that an inbound JWT must be issued to in order to be authorized.
        
        allowedScopes (list) –
        
        The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
        
        (string) –
        
        A scope value that an inbound JWT must carry to be authorized.
        
        customClaims (list) –
        
        Additional custom claim validations applied to the inbound JWT.
        
        (dict) –
        
        A validation rule applied to a single claim of an inbound JWT.
        
        inboundTokenClaimName (string) – [REQUIRED]
        
        The name of the claim in the inbound token to validate.
        
        inboundTokenClaimValueType (string) – [REQUIRED]
        
        The value type of the claim in the inbound token, either a string or an array of strings.
        
        authorizingClaimMatchValue (dict) – [REQUIRED]
        
        The value and match operator used to authorize the claim.
        
        claimMatchValue (dict) – [REQUIRED]
        
        The expected value or values that the claim is compared against.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: matchValueString, matchValueStringList.
        
        matchValueString (string) –
        
        A single string value to match the claim against.
        
        matchValueStringList (list) –
        
        A list of string values to match the claim against.
        
        (string) –
        
        A single value used to match a claim during JWT validation.
        
        claimMatchOperator (string) – [REQUIRED]
        
        The operator used to compare the claim value against the expected value.
        
        privateEndpoint (dict) –
        
        The private endpoint used to reach the identity provider’s discovery URL over a private network path.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: selfManagedLatticeResource, managedVpcResource.
        
        selfManagedLatticeResource (dict) –
        
        A private endpoint backed by a self-managed VPC Lattice resource configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: resourceConfigurationIdentifier.
        
        resourceConfigurationIdentifier (string) –
        
        The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
        
        managedVpcResource (dict) –
        
        A private endpoint backed by a service-managed VPC resource.
        
        vpcIdentifier (string) – [REQUIRED]
        
        The identifier of the VPC in which the private endpoint is provisioned.
        
        subnetIds (list) – [REQUIRED]
        
        The identifiers of the subnets in which the private endpoint network interfaces are placed.
        
        (string) –
        
        Subnet identifier
        
        endpointIpAddressType (string) – [REQUIRED]
        
        The IP address type used by the private endpoint, either IPV4 or IPV6.
        
        securityGroupIds (list) –
        
        The identifiers of the security groups associated with the private endpoint network interfaces.
        
        (string) –
        
        The identifier of a security group.
        
        tags (dict) –
        
        The tags applied to the service-managed VPC resource.
        
        (string) –
        
        Key of a tag.
        
        (string) –
        
        Value of a tag.
        
        routingDomain (string) –
        
        The routing domain used to resolve traffic through the private endpoint.
        
        privateEndpointOverrides (list) –
        
        Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
        
        (dict) –
        
        A mapping of a domain to the private endpoint used to reach it.
        
        domain (string) – [REQUIRED]
        
        The domain name to which this private endpoint override applies.
        
        privateEndpoint (dict) – [REQUIRED]
        
        The private endpoint used to reach the specified domain.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: selfManagedLatticeResource, managedVpcResource.
        
        selfManagedLatticeResource (dict) –
        
        A private endpoint backed by a self-managed VPC Lattice resource configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: resourceConfigurationIdentifier.
        
        resourceConfigurationIdentifier (string) –
        
        The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
        
        managedVpcResource (dict) –
        
        A private endpoint backed by a service-managed VPC resource.
        
        vpcIdentifier (string) – [REQUIRED]
        
        The identifier of the VPC in which the private endpoint is provisioned.
        
        subnetIds (list) – [REQUIRED]
        
        The identifiers of the subnets in which the private endpoint network interfaces are placed.
        
        (string) –
        
        Subnet identifier
        
        endpointIpAddressType (string) – [REQUIRED]
        
        The IP address type used by the private endpoint, either IPV4 or IPV6.
        
        securityGroupIds (list) –
        
        The identifiers of the security groups associated with the private endpoint network interfaces.
        
        (string) –
        
        The identifier of a security group.
        
        tags (dict) –
        
        The tags applied to the service-managed VPC resource.
        
        (string) –
        
        Key of a tag.
        
        (string) –
        
        Value of a tag.
        
        routingDomain (string) –
        
        The routing domain used to resolve traffic through the private endpoint.
      - workloadIdentityDetails (dict) –
        
        The workload identity details for the AgentCore Gateway resource. Present when the gateway has a workload identity configured.
        
        workloadIdentityArn (string) – [REQUIRED]
        
        The Amazon Resource Name (ARN) of the workload identity associated with the source resource.
customMetadata (document) – The custom metadata to attach to the registry record. Each key must match a property defined in the registry’s custom metadata schema. Values can be strings (maximum 128 characters) or native JSON booleans ( true or false). Values are validated against the schema at creation time.
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

Exceptions

AgentRegistryControl.Client.exceptions.InternalServerException
AgentRegistryControl.Client.exceptions.AccessDeniedException
AgentRegistryControl.Client.exceptions.ResourceNotFoundException
AgentRegistryControl.Client.exceptions.ThrottlingException
AgentRegistryControl.Client.exceptions.ValidationException
AgentRegistryControl.Client.exceptions.ServiceQuotaExceededException
AgentRegistryControl.Client.exceptions.ConflictException