Agent Registry Control

2026/11/19 - Agent Registry Control - 6 updated api methods

Changes  BatchGetDiscoverableRegistryRecord returns a short-lived download URL and SHA-256 checksum for approved skill packages. SearchDiscoverableRegistryRecords adds searchType (KEYWORD, SEMANTIC, HYBRID) and pagination. Adds bearer token authentication for registries that use JWT authorization.

CreateRegistryRecord (updated) Link ¶
Changes (request, response)
Request
{'artifact': {'content': 'blob', 'sha256': 'string'},
 'descriptors': {'a2aAgentCard': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                 'returnUrl': 'string'}}}}}},
                 'agentSkillsDefinition': {'additionalData': {'repositoryProvider': 'GITHUB',
                                                              'skillMd': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                                                         'returnUrl': 'string'}}}}}},
                                                              'skillPackage': {'source': {'fromUrl': {'credentialProviderConfigurations': [{'credentialProvider': {'iamCredentialProvider': {'region': 'string',
                                                                                                                                                                                             'roleArn': 'string',
                                                                                                                                                                                             'service': 'string'},
                                                                                                                                                                   'oauthCredentialProvider': {'customParameters': {'string': 'string'},
                                                                                                                                                                                               'grantType': 'CLIENT_CREDENTIALS '
                                                                                                                                                                                                            '| '
                                                                                                                                                                                                            'AUTHORIZATION_CODE',
                                                                                                                                                                                               'providerArn': 'string',
                                                                                                                                                                                               'returnUrl': 'string',
                                                                                                                                                                                               'scopes': ['string']}},
                                                                                                                                            'credentialProviderType': 'OAUTH '
                                                                                                                                                                      '| '
                                                                                                                                                                      'IAM'}],
                                                                                                      'url': 'string'}}},
                                                              'sourceConfiguration': {'s3': {'bucketOwnerAccountId': 'string'}}}},
                 'agui': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                         'returnUrl': 'string'}}}}}},
                 'http': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                         'returnUrl': 'string'}}}}}},
                 'mcpServer': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                              'returnUrl': 'string'}}}}}}}}
Response
{'authorizationData': {'oauth2': {'authorizationAttemptId': 'string',
                                  'authorizationUrl': 'string',
                                  'expiresAt': 'timestamp',
                                  'userId': 'string'}},
 'status': {'UPDATE_PENDING_AUTH', 'CREATE_PENDING_AUTH'}}

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. For an agent skill, you can upload a skill package in artifact, or synchronize the skill from an Amazon S3 or GitHub source. Creation is asynchronous: the operation returns the record with the CREATING status while the registry processes it. If a GitHub user must first authorize access to the source, the operation returns the record with the CREATE_PENDING_AUTH status instead.

See also: AWS API Documentation

Request Syntax

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'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': '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'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': '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'|'AUTHORIZATION_CODE',
                                            'scopes': [
                                                'string',
                                            ],
                                            'customParameters': {
                                                'string': 'string'
                                            },
                                            'returnUrl': 'string'
                                        },
                                        'iamCredentialProvider': {
                                            'roleArn': 'string',
                                            'service': 'string',
                                            'region': 'string'
                                        }
                                    }
                                },
                            ]
                        }
                    }
                },
                'skillPackage': {
                    'source': {
                        'fromUrl': {
                            'url': 'string',
                            'credentialProviderConfigurations': [
                                {
                                    'credentialProviderType': 'OAUTH'|'IAM',
                                    'credentialProvider': {
                                        'oauthCredentialProvider': {
                                            'providerArn': 'string',
                                            'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                            'scopes': [
                                                'string',
                                            ],
                                            'customParameters': {
                                                'string': 'string'
                                            },
                                            'returnUrl': 'string'
                                        },
                                        'iamCredentialProvider': {
                                            'roleArn': 'string',
                                            'service': 'string',
                                            'region': 'string'
                                        }
                                    }
                                },
                            ]
                        }
                    }
                },
                'repositoryProvider': 'GITHUB',
                'sourceConfiguration': {
                    's3': {
                        'bucketOwnerAccountId': 'string'
                    }
                }
            }
        },
        'custom': {
            'data': 'string'
        },
        'http': {
            'source': {
                'fromUrl': {
                    'url': 'string',
                    'credentialProviderConfigurations': [
                        {
                            'credentialProviderType': 'OAUTH'|'IAM',
                            'credentialProvider': {
                                'oauthCredentialProvider': {
                                    'providerArn': 'string',
                                    'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': 'string'
                                },
                                'iamCredentialProvider': {
                                    'roleArn': 'string',
                                    'service': 'string',
                                    'region': 'string'
                                }
                            }
                        },
                    ]
                }
            }
        },
        'agui': {
            'source': {
                'fromUrl': {
                    'url': 'string',
                    'credentialProviderConfigurations': [
                        {
                            'credentialProviderType': 'OAUTH'|'IAM',
                            'credentialProvider': {
                                'oauthCredentialProvider': {
                                    'providerArn': 'string',
                                    'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': 'string'
                                },
                                'iamCredentialProvider': {
                                    'roleArn': 'string',
                                    'service': 'string',
                                    'region': 'string'
                                }
                            }
                        },
                    ]
                }
            }
        }
    },
    artifact={
        'content': b'bytes',
        'sha256': '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'
    }
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry in which to create the record (ARN or ID)

type name:

string

param name:

[REQUIRED]

The name of the registry record

type displayName:

string

param displayName:

The human-readable display name of the registry record

type description:

string

param description:

The description of the registry record

type recordType:

string

param recordType:

[REQUIRED]

The type of the registry record, which determines the descriptor format

type descriptors:

dict

param descriptors:

[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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

        • 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.

              • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                • returnUrl (string) --

                  The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

              • 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. For an Amazon S3 skill source, omit it or set it to s3.

                • 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. For an Amazon S3 skill source, omit it or set it 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

        • 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.

              • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                • returnUrl (string) --

                  The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

              • 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. For an Amazon S3 skill source, omit it or set it to s3.

                • 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. For an Amazon S3 skill source, omit it or set it 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 of the skill's SKILL.md only. The registry synchronizes the SKILL.md from this source into data. Specify an s3:// URL of a SKILL.md object, or a GitHub folder URL together with repositoryProvider set to GITHUB. The registry rejects a new https:// URL without repositoryProvider, and you can't set both this source and skillPackage.source.

          • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

            • 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.

                  • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                    • returnUrl (string) --

                      The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                  • 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. For an Amazon S3 skill source, omit it or set it to s3.

                    • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

      • skillPackage (dict) --

        The source that the registry synchronizes the full skill package from. The registry validates and stores the package, sets skillMd.data from its SKILL.md, and returns the package in the artifact member of GetRegistryRecord. You can't set both this source and skillMd.source.

        • source (dict) --

          The source of the skill package. Specify an s3:// URL of a ZIP object, or a GitHub folder URL together with repositoryProvider set to GITHUB. For a GitHub folder, the registry builds the package from every file in the folder.

          • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

            • 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.

                  • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                    • returnUrl (string) --

                      The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                  • 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. For an Amazon S3 skill source, omit it or set it to s3.

                    • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

      • repositoryProvider (string) --

        The repository provider of the record's skill source. Set it to GITHUB when skillMd.source or skillPackage.source is a GitHub folder URL. The registry treats an https:// source as a GitHub source only when this member is set. Don't set it for an Amazon S3 source.

      • sourceConfiguration (dict) --

        The provider-specific settings of the record's skill source. For an Amazon S3 source, s3.bucketOwnerAccountId specifies the account that owns the source bucket.

        • s3 (dict) --

          The settings of an Amazon S3 source.

          • bucketOwnerAccountId (string) --

            The ID of the Amazon Web Services account that owns the source bucket. The registry checks that the bucket belongs to this account each time it reads the source. If you omit it for a source that uses an IAM role, the registry expects the bucket to be in the role's account. If you omit it for a source that has no credential provider, which the registry reads as a public object, the request fails with a ValidationException.

  • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

        • 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.

              • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                • returnUrl (string) --

                  The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

              • 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. For an Amazon S3 skill source, omit it or set it to s3.

                • 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. For an Amazon S3 skill source, omit it or set it 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

        • 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.

              • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                • returnUrl (string) --

                  The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

              • 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. For an Amazon S3 skill source, omit it or set it to s3.

                • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

type artifact:

dict

param artifact:

The skill package to store with the record, for a record of type SKILL with an agentSkillsDefinition descriptor. The registry validates the package after the operation returns and sets skillMd.data from the package's SKILL.md. A request that uploads a package can't also set a skill source or send new skillMd.data.

  • content (bytes) -- [REQUIRED]

    The ZIP archive of the skill package, up to 5 MiB (5,242,880 bytes). In a JSON request, the content is base64-encoded. The Amazon Web Services SDKs encode it for you.

  • sha256 (string) --

    The optional SHA-256 checksum of the ZIP archive, as 64 lowercase hexadecimal characters, computed over the archive's bytes rather than its base64 text. If it doesn't match the content, the request fails with a ValidationException.

type recordVersion:

string

param recordVersion:

The version of the registry record

type clientToken:

string

param clientToken:

Client token for idempotency

This field is autopopulated if not provided.

type provenance:

list

param provenance:

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.

      • 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.

          • customJWTAuthorizer (dict) --

            Configuration for a custom JWT authorizer.

            • discoveryUrl (string) -- [REQUIRED]

              The OpenID Connect discovery or OAuth 2.0 authorization server metadata 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.

                    • 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.

              • selfManagedLatticeResource (dict) --

                A private endpoint backed by a self-managed VPC Lattice resource configuration.

                • 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.

                  • selfManagedLatticeResource (dict) --

                    A private endpoint backed by a self-managed VPC Lattice resource configuration.

                    • 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.

          • customJWTAuthorizer (dict) --

            Configuration for a custom JWT authorizer.

            • discoveryUrl (string) -- [REQUIRED]

              The OpenID Connect discovery or OAuth 2.0 authorization server metadata 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.

                    • 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.

              • selfManagedLatticeResource (dict) --

                A private endpoint backed by a self-managed VPC Lattice resource configuration.

                • 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.

                  • selfManagedLatticeResource (dict) --

                    A private endpoint backed by a self-managed VPC Lattice resource configuration.

                    • 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.

type customMetadata:

:ref:`document<document>`

param customMetadata:

The custom metadata for the record. Values are strings or JSON booleans.

type tags:

dict

param tags:

Tags to associate with the registry record

  • (string) --

    Key of a tag.

    • (string) --

      Value of a tag.

rtype:

dict

returns:

Response Syntax

{
    'recordArn': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'CREATE_PENDING_AUTH'|'UPDATE_PENDING_AUTH',
    'authorizationData': {
        'oauth2': {
            'authorizationUrl': 'string',
            'userId': 'string',
            'authorizationAttemptId': 'string',
            'expiresAt': datetime(2015, 1, 1)
        }
    }
}

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. CREATING means that the asynchronous workflow is in progress. CREATE_PENDING_AUTH means that the record waits for a GitHub user to authorize access before it synchronizes from its GitHub source. For the authorization link, see authorizationData.

    • authorizationData (dict) --

      The authorization that a GitHub user must complete before the record's synchronization starts. Present only in this response, and only while the status is CREATE_PENDING_AUTH. If the status is CREATE_PENDING_AUTH but this member is absent, call UpdateRegistryRecord with triggerSynchronization to get a new authorization link.

      • oauth2 (dict) --

        The OAuth 2.0 authorization that a GitHub user must approve.

        • authorizationUrl (string) --

          The URL that the user opens to approve access. The link is valid for up to 10 minutes. Treat it as sensitive and give it only to the user who approves access.

        • userId (string) --

          The AgentCore Identity user ID that the authorization is for. Store it with your signed-in user and pass it as userIdentifier.userId when your application calls CompleteResourceTokenAuth.

        • authorizationAttemptId (string) --

          The identifier of this authorization attempt.

        • expiresAt (datetime) --

          The timestamp when the authorization link expires, 10 minutes after the authorization started. A request that joins an authorization in progress gets less time, and the link might stop working shortly before this time.

GetRegistryRecord (updated) Link ¶
Changes (response)
{'artifact': {'downloadUrl': 'string', 'sha256': 'string'},
 'descriptors': {'a2aAgentCard': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                 'returnUrl': 'string'}}}}}},
                 'agentSkillsDefinition': {'additionalData': {'repositoryProvider': 'GITHUB',
                                                              'skillMd': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                                                         'returnUrl': 'string'}}}}}},
                                                              'skillPackage': {'source': {'fromUrl': {'credentialProviderConfigurations': [{'credentialProvider': {'iamCredentialProvider': {'region': 'string',
                                                                                                                                                                                             'roleArn': 'string',
                                                                                                                                                                                             'service': 'string'},
                                                                                                                                                                   'oauthCredentialProvider': {'customParameters': {'string': 'string'},
                                                                                                                                                                                               'grantType': 'CLIENT_CREDENTIALS '
                                                                                                                                                                                                            '| '
                                                                                                                                                                                                            'AUTHORIZATION_CODE',
                                                                                                                                                                                               'providerArn': 'string',
                                                                                                                                                                                               'returnUrl': 'string',
                                                                                                                                                                                               'scopes': ['string']}},
                                                                                                                                            'credentialProviderType': 'OAUTH '
                                                                                                                                                                      '| '
                                                                                                                                                                      'IAM'}],
                                                                                                      'url': 'string'}}},
                                                              'sourceConfiguration': {'s3': {'bucketOwnerAccountId': 'string'}}}},
                 'agui': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                         'returnUrl': 'string'}}}}}},
                 'http': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                         'returnUrl': 'string'}}}}}},
                 'mcpServer': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                              'returnUrl': 'string'}}}}}}},
 'status': {'UPDATE_PENDING_AUTH', 'CREATE_PENDING_AUTH'},
 'synchronizedSource': {'gitHub': {'commitId': 'string',
                                   'synchronizedAt': 'timestamp',
                                   'url': 'string'},
                        's3': {'eTag': 'string',
                               'synchronizedAt': 'timestamp',
                               'url': 'string',
                               'versionId': 'string'}}}

Retrieves the details of a registry record. The response describes the record's latest revision, including a revision that isn't approved yet. For a skill record, the operation also returns the skill package in artifact and the source that the registry last synchronized the skill from in synchronizedSource.

See also: AWS API Documentation

Request Syntax

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

string

param registryId:

[REQUIRED]

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

type recordId:

string

param recordId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'registryArn': 'string',
    'recordArn': 'string',
    'recordId': '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'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': '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'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': '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'|'AUTHORIZATION_CODE',
                                            'scopes': [
                                                'string',
                                            ],
                                            'customParameters': {
                                                'string': 'string'
                                            },
                                            'returnUrl': 'string'
                                        },
                                        'iamCredentialProvider': {
                                            'roleArn': 'string',
                                            'service': 'string',
                                            'region': 'string'
                                        }
                                    }
                                },
                            ]
                        }
                    }
                },
                'skillPackage': {
                    'source': {
                        'fromUrl': {
                            'url': 'string',
                            'credentialProviderConfigurations': [
                                {
                                    'credentialProviderType': 'OAUTH'|'IAM',
                                    'credentialProvider': {
                                        'oauthCredentialProvider': {
                                            'providerArn': 'string',
                                            'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                            'scopes': [
                                                'string',
                                            ],
                                            'customParameters': {
                                                'string': 'string'
                                            },
                                            'returnUrl': 'string'
                                        },
                                        'iamCredentialProvider': {
                                            'roleArn': 'string',
                                            'service': 'string',
                                            'region': 'string'
                                        }
                                    }
                                },
                            ]
                        }
                    }
                },
                'repositoryProvider': 'GITHUB',
                'sourceConfiguration': {
                    's3': {
                        'bucketOwnerAccountId': 'string'
                    }
                }
            }
        },
        'custom': {
            'data': 'string'
        },
        'http': {
            'source': {
                'fromUrl': {
                    'url': 'string',
                    'credentialProviderConfigurations': [
                        {
                            'credentialProviderType': 'OAUTH'|'IAM',
                            'credentialProvider': {
                                'oauthCredentialProvider': {
                                    'providerArn': 'string',
                                    'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': 'string'
                                },
                                'iamCredentialProvider': {
                                    'roleArn': 'string',
                                    'service': 'string',
                                    'region': 'string'
                                }
                            }
                        },
                    ]
                }
            }
        },
        'agui': {
            'source': {
                'fromUrl': {
                    'url': 'string',
                    'credentialProviderConfigurations': [
                        {
                            'credentialProviderType': 'OAUTH'|'IAM',
                            'credentialProvider': {
                                'oauthCredentialProvider': {
                                    'providerArn': 'string',
                                    'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': 'string'
                                },
                                'iamCredentialProvider': {
                                    'roleArn': 'string',
                                    'service': 'string',
                                    'region': 'string'
                                }
                            }
                        },
                    ]
                }
            }
        }
    },
    'recordVersion': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'CREATE_PENDING_AUTH'|'UPDATE_PENDING_AUTH',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'statusReason': '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'
                    }
                }
            }
        },
    ],
    'createdByAutoDetection': True|False,
    'createdBy': 'string',
    'customMetadata': {...}|[...]|123|123.4|'string'|True|None,
    'customMetadataSchemaComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT',
    'artifact': {
        'sha256': 'string',
        'downloadUrl': 'string'
    },
    'synchronizedSource': {
        's3': {
            'url': 'string',
            'synchronizedAt': datetime(2015, 1, 1),
            'versionId': 'string',
            'eTag': 'string'
        },
        'gitHub': {
            'url': 'string',
            'synchronizedAt': datetime(2015, 1, 1),
            'commitId': 'string'
        }
    }
}

Response Structure

  • (dict) --

    Response structure for retrieving a registry record

    • registryArn (string) --

      The Amazon Resource Name (ARN) of the parent registry that owns 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. 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. For a skill record with a skill package or a synchronized source, skillMd.data contains the SKILL.md that the registry took from the package or the source.

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

              The URL from which the descriptor content is retrieved. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

            • 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.

                  • oauthCredentialProvider (dict) --

                    The OAuth 2.0 credential provider details.

                    • providerArn (string) --

                      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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                    • returnUrl (string) --

                      The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                  • 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. For an Amazon S3 skill source, omit it or set it to s3.

                    • 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. For an Amazon S3 skill source, omit it or set it 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

            • 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.

                  • oauthCredentialProvider (dict) --

                    The OAuth 2.0 credential provider details.

                    • providerArn (string) --

                      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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                    • returnUrl (string) --

                      The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                  • 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. For an Amazon S3 skill source, omit it or set it to s3.

                    • 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. For an Amazon S3 skill source, omit it or set it 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 of the skill's SKILL.md only. The registry synchronizes the SKILL.md from this source into data. Specify an s3:// URL of a SKILL.md object, or a GitHub folder URL together with repositoryProvider set to GITHUB. The registry rejects a new https:// URL without repositoryProvider, and you can't set both this source and skillPackage.source.

              • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

                • 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.

                      • oauthCredentialProvider (dict) --

                        The OAuth 2.0 credential provider details.

                        • providerArn (string) --

                          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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                        • returnUrl (string) --

                          The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                      • 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. For an Amazon S3 skill source, omit it or set it to s3.

                        • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

          • skillPackage (dict) --

            The source that the registry synchronizes the full skill package from. The registry validates and stores the package, sets skillMd.data from its SKILL.md, and returns the package in the artifact member of GetRegistryRecord. You can't set both this source and skillMd.source.

            • source (dict) --

              The source of the skill package. Specify an s3:// URL of a ZIP object, or a GitHub folder URL together with repositoryProvider set to GITHUB. For a GitHub folder, the registry builds the package from every file in the folder.

              • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

                • 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.

                      • oauthCredentialProvider (dict) --

                        The OAuth 2.0 credential provider details.

                        • providerArn (string) --

                          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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                        • returnUrl (string) --

                          The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                      • 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. For an Amazon S3 skill source, omit it or set it to s3.

                        • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

          • repositoryProvider (string) --

            The repository provider of the record's skill source. Set it to GITHUB when skillMd.source or skillPackage.source is a GitHub folder URL. The registry treats an https:// source as a GitHub source only when this member is set. Don't set it for an Amazon S3 source.

          • sourceConfiguration (dict) --

            The provider-specific settings of the record's skill source. For an Amazon S3 source, s3.bucketOwnerAccountId specifies the account that owns the source bucket.

            • s3 (dict) --

              The settings of an Amazon S3 source.

              • bucketOwnerAccountId (string) --

                The ID of the Amazon Web Services account that owns the source bucket. The registry checks that the bucket belongs to this account each time it reads the source. If you omit it for a source that uses an IAM role, the registry expects the bucket to be in the role's account. If you omit it for a source that has no credential provider, which the registry reads as a public object, the request fails with a ValidationException.

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

              The URL from which the descriptor content is retrieved. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

            • 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.

                  • oauthCredentialProvider (dict) --

                    The OAuth 2.0 credential provider details.

                    • providerArn (string) --

                      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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                    • returnUrl (string) --

                      The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                  • 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. For an Amazon S3 skill source, omit it or set it to s3.

                    • 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. For an Amazon S3 skill source, omit it or set it 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) --

              The URL from which the descriptor content is retrieved. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

            • 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.

                  • oauthCredentialProvider (dict) --

                    The OAuth 2.0 credential provider details.

                    • providerArn (string) --

                      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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                    • returnUrl (string) --

                      The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                  • 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. For an Amazon S3 skill source, omit it or set it to s3.

                    • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

    • 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.

    • provenance (list) --

      The provenance lineage entries for the registry record. Populated for records created by auto-detection; each entry identifies the upstream source that the record was detected from.

      • (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) --

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

          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.

          • 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.

              • customJWTAuthorizer (dict) --

                Configuration for a custom JWT authorizer.

                • discoveryUrl (string) --

                  The OpenID Connect discovery or OAuth 2.0 authorization server metadata 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) --

                      The name of the claim in the inbound token to validate.

                    • inboundTokenClaimValueType (string) --

                      The value type of the claim in the inbound token, either a string or an array of strings.

                    • authorizingClaimMatchValue (dict) --

                      The value and match operator used to authorize the claim.

                      • claimMatchValue (dict) --

                        The expected value or values that the claim is compared against.

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

                        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.

                  • selfManagedLatticeResource (dict) --

                    A private endpoint backed by a self-managed VPC Lattice resource configuration.

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

                      The identifier of the VPC in which the private endpoint is provisioned.

                    • subnetIds (list) --

                      The identifiers of the subnets in which the private endpoint network interfaces are placed.

                      • (string) --

                        Subnet identifier

                    • endpointIpAddressType (string) --

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

                      The domain name to which this private endpoint override applies.

                    • privateEndpoint (dict) --

                      The private endpoint used to reach the specified domain.

                      • selfManagedLatticeResource (dict) --

                        A private endpoint backed by a self-managed VPC Lattice resource configuration.

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

                          The identifier of the VPC in which the private endpoint is provisioned.

                        • subnetIds (list) --

                          The identifiers of the subnets in which the private endpoint network interfaces are placed.

                          • (string) --

                            Subnet identifier

                        • endpointIpAddressType (string) --

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

                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.

              • customJWTAuthorizer (dict) --

                Configuration for a custom JWT authorizer.

                • discoveryUrl (string) --

                  The OpenID Connect discovery or OAuth 2.0 authorization server metadata 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) --

                      The name of the claim in the inbound token to validate.

                    • inboundTokenClaimValueType (string) --

                      The value type of the claim in the inbound token, either a string or an array of strings.

                    • authorizingClaimMatchValue (dict) --

                      The value and match operator used to authorize the claim.

                      • claimMatchValue (dict) --

                        The expected value or values that the claim is compared against.

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

                        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.

                  • selfManagedLatticeResource (dict) --

                    A private endpoint backed by a self-managed VPC Lattice resource configuration.

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

                      The identifier of the VPC in which the private endpoint is provisioned.

                    • subnetIds (list) --

                      The identifiers of the subnets in which the private endpoint network interfaces are placed.

                      • (string) --

                        Subnet identifier

                    • endpointIpAddressType (string) --

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

                      The domain name to which this private endpoint override applies.

                    • privateEndpoint (dict) --

                      The private endpoint used to reach the specified domain.

                      • selfManagedLatticeResource (dict) --

                        A private endpoint backed by a self-managed VPC Lattice resource configuration.

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

                          The identifier of the VPC in which the private endpoint is provisioned.

                        • subnetIds (list) --

                          The identifiers of the subnets in which the private endpoint network interfaces are placed.

                          • (string) --

                            Subnet identifier

                        • endpointIpAddressType (string) --

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

                The Amazon Resource Name (ARN) of the workload identity associated with the source resource.

    • createdByAutoDetection (boolean) --

      Specifies whether the registry record was created by auto-detection. true indicates the record was automatically created by the service based on the registry's auto-detection configuration; false indicates the record was created through a control-plane API call.

    • createdBy (string) --

      The ID of the Amazon Web Services account that created the registry record.

    • customMetadata (:ref:`document<document>`) --

      The custom metadata attached to this registry record. Values are strings (maximum 128 characters) or booleans.

    • customMetadataSchemaComplianceStatus (string) --

      Indicates whether this record's custom metadata conforms to the registry's current schema. This status is computed at read time against the latest schema.

    • artifact (dict) --

      The skill package of the record's latest revision, including a revision in DRAFT or PENDING_APPROVAL status, as a download URL and a SHA-256 checksum. While an update of the record is in progress or after it fails, this is the last package that passed validation, unless the update switches between an uploaded package and a synchronized one: then it is absent until the update succeeds. Absent while the record is being created or after its creation fails, and when the record has no package, for example when its content is inline or it synchronizes only SKILL.md.

      • sha256 (string) --

        The SHA-256 checksum of the package, as 64 lowercase hexadecimal characters. The download response carries no signature that you can check, so compare the checksum of the file that you download with this value before you use the package.

      • downloadUrl (string) --

        A presigned Amazon S3 URL that downloads the package. The URL is valid for up to 5 minutes, and the response doesn't include its expiry time. To get a new URL, call the operation again. Anyone who has the URL can download the package until it expires, so don't log, store, or share it.

    • synchronizedSource (dict) --

      The source that the registry last synchronized the record's skill content from, including when the registry read the source and which version it read. Absent until the first successful synchronization, and after an update replaces the synchronized content, for example with an uploaded package. A failed synchronization leaves this member unchanged. After you change the source, this member shows the previous source until the registry successfully synchronizes from the new source.

      • s3 (dict) --

        The Amazon S3 source that the registry read.

        • url (string) --

          The source URL that the registry read.

        • synchronizedAt (datetime) --

          The timestamp when the registry read the source.

        • versionId (string) --

          The version ID of the object that the registry read. Absent when the bucket isn't versioned.

        • eTag (string) --

          The entity tag (ETag) of the object that the registry read, without quotes, when the object has no version ID. Not recorded for a SKILL.md source on a registry that is encrypted with a customer managed key.

      • gitHub (dict) --

        The GitHub source that the registry read.

        • url (string) --

          The source URL that the registry read.

        • synchronizedAt (datetime) --

          The timestamp when the registry read the source.

        • commitId (string) --

          The commit that the source's branch or tag pointed to when the registry read it.

ListRegistryRecords (updated) Link ¶
Changes (response)
{'registryRecords': {'status': {'UPDATE_PENDING_AUTH', 'CREATE_PENDING_AUTH'}}}

Lists the registry records within a registry, with optional filtering by name, status, and record type

See also: AWS API Documentation

Request Syntax

client.list_registry_records(
    registryId='string',
    maxResults=123,
    nextToken='string',
    filters=[
        {
            'name': 'name'|'status'|'recordType',
            'values': [
                'string',
            ]
        },
    ]
)
type registryId:

string

param registryId:

[REQUIRED]

The identifier of the registry to list records from (ARN or ID)

type maxResults:

integer

param maxResults:

Maximum number of records to return

type nextToken:

string

param nextToken:

Token for pagination

type filters:

list

param filters:

Filters to apply to the registry record list

  • (dict) --

    A single filter applied to a ListRegistryRecords request.

    • name (string) -- [REQUIRED]

      The attribute to filter on

    • values (list) -- [REQUIRED]

      The values to match for the attribute

      • (string) --

        A single filter value. Constrained by length only; the accepted set of values is filter-specific and validated server-side so enum-style values such as READY or AWS_IAM are accepted.

rtype:

dict

returns:

Response Syntax

{
    'registryRecords': [
        {
            'registryArn': 'string',
            'recordArn': 'string',
            'recordId': 'string',
            'name': 'string',
            'displayName': 'string',
            'description': 'string',
            'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY',
            'recordVersion': 'string',
            'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'CREATE_PENDING_AUTH'|'UPDATE_PENDING_AUTH',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'createdByAutoDetection': True|False,
            'createdBy': 'string',
            'provenanceSummaryList': [
                {
                    'relation': 'DETECTED_FROM',
                    'sourceId': 'string',
                    'sourceType': 'AWS::BedrockAgentCore::Runtime'|'AWS::BedrockAgentCore::Gateway'
                },
            ],
            'customMetadataSchemaComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Response structure for listing registry records

    • registryRecords (list) --

      List of registry record summaries

      • (dict) --

        A summary of a registry record returned by list operations. Contains identifying and lifecycle fields but omits descriptor content.

        • registryArn (string) --

          The Amazon Resource Name (ARN) of the parent registry that owns 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. 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.

        • 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.

        • createdByAutoDetection (boolean) --

          Specifies whether the registry record was created by auto-detection. true indicates the record was automatically created by the service based on the registry's auto-detection configuration; false indicates the record was created through a control-plane API call.

        • createdBy (string) --

          The ID of the Amazon Web Services account that created the registry record.

        • provenanceSummaryList (list) --

          The condensed provenance lineage for the registry record. Each entry contains the source relation, source identifier, and source type of an auto-detection lineage entry. Populated for records created by auto-detection.

          • (dict) --

            A condensed provenance entry surfaced in list results. Contains the source identity of a lineage entry without the source details returned by GetRegistryRecord.

            • relation (string) --

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

              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.

        • customMetadataSchemaComplianceStatus (string) --

          Indicates whether this record's custom metadata conforms to the registry's current schema.

    • nextToken (string) --

      Token for next page of results

SubmitRegistryRecordForApproval (updated) Link ¶
Changes (response)
{'status': {'UPDATE_PENDING_AUTH', 'CREATE_PENDING_AUTH'}}

Submits a DRAFT registry record for approval, moving it into the registry's approval workflow. Depending on the registry's approval configuration, the record is either auto-approved or set to PENDING_APPROVAL for a curator to approve or reject.

See also: AWS API Documentation

Request Syntax

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

string

param registryId:

[REQUIRED]

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

type recordId:

string

param recordId:

[REQUIRED]

The identifier of the registry record to submit for approval (ARN or ID)

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    Response structure for submitting a registry record for approval

    • registryArn (string) --

      The ARN of the registry

    • recordArn (string) --

      The ARN of the registry record

    • recordId (string) --

      The ID of the registry record

    • status (string) --

      The resulting status of the registry record

    • updatedAt (datetime) --

      The timestamp when the record was last updated

UpdateRegistryRecord (updated) Link ¶
Changes (request, response)
Request
{'artifact': {'optionalValue': {'content': 'blob', 'sha256': 'string'}},
 'descriptors': {'optionalValue': {'a2aAgentCard': {'optionalValue': {'source': {'optionalValue': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                                                                       'returnUrl': 'string'}}}}}}}},
                                   'agentSkillsDefinition': {'optionalValue': {'additionalData': {'optionalValue': {'repositoryProvider': {'optionalValue': 'GITHUB'},
                                                                                                                    'skillMd': {'optionalValue': {'source': {'optionalValue': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                                                                                                                                                   'returnUrl': 'string'}}}}}}}},
                                                                                                                    'skillPackage': {'optionalValue': {'source': {'fromUrl': {'credentialProviderConfigurations': [{'credentialProvider': {'iamCredentialProvider': {'region': 'string',
                                                                                                                                                                                                                                                                     'roleArn': 'string',
                                                                                                                                                                                                                                                                     'service': 'string'},
                                                                                                                                                                                                                                           'oauthCredentialProvider': {'customParameters': {'string': 'string'},
                                                                                                                                                                                                                                                                       'grantType': 'CLIENT_CREDENTIALS '
                                                                                                                                                                                                                                                                                    '| '
                                                                                                                                                                                                                                                                                    'AUTHORIZATION_CODE',
                                                                                                                                                                                                                                                                       'providerArn': 'string',
                                                                                                                                                                                                                                                                       'returnUrl': 'string',
                                                                                                                                                                                                                                                                       'scopes': ['string']}},
                                                                                                                                                                                                                    'credentialProviderType': 'OAUTH '
                                                                                                                                                                                                                                              '| '
                                                                                                                                                                                                                                              'IAM'}],
                                                                                                                                                                              'url': 'string'}}}},
                                                                                                                    'sourceConfiguration': {'optionalValue': {'s3': {'bucketOwnerAccountId': 'string'}}}}}}},
                                   'agui': {'optionalValue': {'source': {'optionalValue': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                                                               'returnUrl': 'string'}}}}}}}},
                                   'http': {'optionalValue': {'source': {'optionalValue': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                                                               'returnUrl': 'string'}}}}}}}},
                                   'mcpServer': {'optionalValue': {'source': {'optionalValue': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                                                                    'returnUrl': 'string'}}}}}}}}}},
 'forceAuthentication': 'boolean'}
Response
{'authorizationData': {'oauth2': {'authorizationAttemptId': 'string',
                                  'authorizationUrl': 'string',
                                  'expiresAt': 'timestamp',
                                  'userId': 'string'}},
 'descriptors': {'a2aAgentCard': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                 'returnUrl': 'string'}}}}}},
                 'agentSkillsDefinition': {'additionalData': {'repositoryProvider': 'GITHUB',
                                                              'skillMd': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                                                                         'returnUrl': 'string'}}}}}},
                                                              'skillPackage': {'source': {'fromUrl': {'credentialProviderConfigurations': [{'credentialProvider': {'iamCredentialProvider': {'region': 'string',
                                                                                                                                                                                             'roleArn': 'string',
                                                                                                                                                                                             'service': 'string'},
                                                                                                                                                                   'oauthCredentialProvider': {'customParameters': {'string': 'string'},
                                                                                                                                                                                               'grantType': 'CLIENT_CREDENTIALS '
                                                                                                                                                                                                            '| '
                                                                                                                                                                                                            'AUTHORIZATION_CODE',
                                                                                                                                                                                               'providerArn': 'string',
                                                                                                                                                                                               'returnUrl': 'string',
                                                                                                                                                                                               'scopes': ['string']}},
                                                                                                                                            'credentialProviderType': 'OAUTH '
                                                                                                                                                                      '| '
                                                                                                                                                                      'IAM'}],
                                                                                                      'url': 'string'}}},
                                                              'sourceConfiguration': {'s3': {'bucketOwnerAccountId': 'string'}}}},
                 'agui': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                         'returnUrl': 'string'}}}}}},
                 'http': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                         'returnUrl': 'string'}}}}}},
                 'mcpServer': {'source': {'fromUrl': {'credentialProviderConfigurations': {'credentialProvider': {'oauthCredentialProvider': {'grantType': {'AUTHORIZATION_CODE'},
                                                                                                                                              'returnUrl': 'string'}}}}}}},
 'status': {'UPDATE_PENDING_AUTH', 'CREATE_PENDING_AUTH'}}

Updates a registry record. The update is asynchronous: the operation returns the record with the UPDATING status while the registry processes it. If a GitHub user must first authorize access to the record's skill source, the operation returns the record with the UPDATE_PENDING_AUTH status instead. Fields that use update wrappers follow PATCH semantics: omit the field to leave it unchanged.

See also: AWS API Documentation

Request Syntax

client.update_registry_record(
    registryId='string',
    recordId='string',
    name='string',
    displayName={
        'optionalValue': 'string'
    },
    description={
        'optionalValue': 'string'
    },
    recordType='MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY',
    descriptors={
        'optionalValue': {
            'mcpServer': {
                'optionalValue': {
                    'data': {
                        'optionalValue': 'string'
                    },
                    'dataSchemaVersion': {
                        'optionalValue': 'string'
                    },
                    'source': {
                        'optionalValue': {
                            'fromUrl': {
                                'url': 'string',
                                'credentialProviderConfigurations': [
                                    {
                                        'credentialProviderType': 'OAUTH'|'IAM',
                                        'credentialProvider': {
                                            'oauthCredentialProvider': {
                                                'providerArn': 'string',
                                                'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                                'scopes': [
                                                    'string',
                                                ],
                                                'customParameters': {
                                                    'string': 'string'
                                                },
                                                'returnUrl': 'string'
                                            },
                                            'iamCredentialProvider': {
                                                'roleArn': 'string',
                                                'service': 'string',
                                                'region': 'string'
                                            }
                                        }
                                    },
                                ]
                            }
                        }
                    },
                    'additionalData': {
                        'optionalValue': {
                            'tools': {
                                'optionalValue': {
                                    'data': {
                                        'optionalValue': 'string'
                                    },
                                    'dataSchemaVersion': {
                                        'optionalValue': 'string'
                                    }
                                }
                            }
                        }
                    }
                }
            },
            'a2aAgentCard': {
                'optionalValue': {
                    'data': {
                        'optionalValue': 'string'
                    },
                    'dataSchemaVersion': {
                        'optionalValue': 'string'
                    },
                    'source': {
                        'optionalValue': {
                            'fromUrl': {
                                'url': 'string',
                                'credentialProviderConfigurations': [
                                    {
                                        'credentialProviderType': 'OAUTH'|'IAM',
                                        'credentialProvider': {
                                            'oauthCredentialProvider': {
                                                'providerArn': 'string',
                                                'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                                'scopes': [
                                                    'string',
                                                ],
                                                'customParameters': {
                                                    'string': 'string'
                                                },
                                                'returnUrl': 'string'
                                            },
                                            'iamCredentialProvider': {
                                                'roleArn': 'string',
                                                'service': 'string',
                                                'region': 'string'
                                            }
                                        }
                                    },
                                ]
                            }
                        }
                    }
                }
            },
            'agentSkillsDefinition': {
                'optionalValue': {
                    'data': {
                        'optionalValue': 'string'
                    },
                    'dataSchemaVersion': {
                        'optionalValue': 'string'
                    },
                    'additionalData': {
                        'optionalValue': {
                            'skillMd': {
                                'optionalValue': {
                                    'data': {
                                        'optionalValue': 'string'
                                    },
                                    'dataSchemaVersion': {
                                        'optionalValue': 'string'
                                    },
                                    'source': {
                                        'optionalValue': {
                                            'fromUrl': {
                                                'url': 'string',
                                                'credentialProviderConfigurations': [
                                                    {
                                                        'credentialProviderType': 'OAUTH'|'IAM',
                                                        'credentialProvider': {
                                                            'oauthCredentialProvider': {
                                                                'providerArn': 'string',
                                                                'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                                                'scopes': [
                                                                    'string',
                                                                ],
                                                                'customParameters': {
                                                                    'string': 'string'
                                                                },
                                                                'returnUrl': 'string'
                                                            },
                                                            'iamCredentialProvider': {
                                                                'roleArn': 'string',
                                                                'service': 'string',
                                                                'region': 'string'
                                                            }
                                                        }
                                                    },
                                                ]
                                            }
                                        }
                                    }
                                }
                            },
                            'skillPackage': {
                                'optionalValue': {
                                    'source': {
                                        'fromUrl': {
                                            'url': 'string',
                                            'credentialProviderConfigurations': [
                                                {
                                                    'credentialProviderType': 'OAUTH'|'IAM',
                                                    'credentialProvider': {
                                                        'oauthCredentialProvider': {
                                                            'providerArn': 'string',
                                                            'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                                            'scopes': [
                                                                'string',
                                                            ],
                                                            'customParameters': {
                                                                'string': 'string'
                                                            },
                                                            'returnUrl': 'string'
                                                        },
                                                        'iamCredentialProvider': {
                                                            'roleArn': 'string',
                                                            'service': 'string',
                                                            'region': 'string'
                                                        }
                                                    }
                                                },
                                            ]
                                        }
                                    }
                                }
                            },
                            'repositoryProvider': {
                                'optionalValue': 'GITHUB'
                            },
                            'sourceConfiguration': {
                                'optionalValue': {
                                    's3': {
                                        'bucketOwnerAccountId': 'string'
                                    }
                                }
                            }
                        }
                    }
                }
            },
            'custom': {
                'optionalValue': {
                    'data': {
                        'optionalValue': 'string'
                    }
                }
            },
            'http': {
                'optionalValue': {
                    'source': {
                        'optionalValue': {
                            'fromUrl': {
                                'url': 'string',
                                'credentialProviderConfigurations': [
                                    {
                                        'credentialProviderType': 'OAUTH'|'IAM',
                                        'credentialProvider': {
                                            'oauthCredentialProvider': {
                                                'providerArn': 'string',
                                                'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                                'scopes': [
                                                    'string',
                                                ],
                                                'customParameters': {
                                                    'string': 'string'
                                                },
                                                'returnUrl': 'string'
                                            },
                                            'iamCredentialProvider': {
                                                'roleArn': 'string',
                                                'service': 'string',
                                                'region': 'string'
                                            }
                                        }
                                    },
                                ]
                            }
                        }
                    }
                }
            },
            'agui': {
                'optionalValue': {
                    'source': {
                        'optionalValue': {
                            'fromUrl': {
                                'url': 'string',
                                'credentialProviderConfigurations': [
                                    {
                                        'credentialProviderType': 'OAUTH'|'IAM',
                                        'credentialProvider': {
                                            'oauthCredentialProvider': {
                                                'providerArn': 'string',
                                                'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                                'scopes': [
                                                    'string',
                                                ],
                                                'customParameters': {
                                                    'string': 'string'
                                                },
                                                'returnUrl': 'string'
                                            },
                                            'iamCredentialProvider': {
                                                'roleArn': 'string',
                                                'service': 'string',
                                                'region': 'string'
                                            }
                                        }
                                    },
                                ]
                            }
                        }
                    }
                }
            }
        }
    },
    artifact={
        'optionalValue': {
            'content': b'bytes',
            'sha256': 'string'
        }
    },
    recordVersion='string',
    customMetadata={
        'optionalValue': {...}|[...]|123|123.4|'string'|True|None
    },
    triggerSynchronization=True|False,
    forceAuthentication=True|False,
    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'
                    }
                }
            }
        },
    ]
)
type registryId:

string

param registryId:

[REQUIRED]

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

type recordId:

string

param recordId:

[REQUIRED]

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

type name:

string

param name:

The updated name of the registry record. Omit to leave the name unchanged.

type displayName:

dict

param displayName:

The updated display name of the registry record. Omit to leave the display name unchanged; provide an empty wrapper to unset it.

  • optionalValue (string) --

    The value to set for this field. Omit the wrapper to leave the field unchanged.

type description:

dict

param description:

The updated description of the registry record. Omit to leave the description unchanged; provide an empty wrapper to unset it.

  • optionalValue (string) --

    The value to set for this field. Omit the wrapper to leave the field unchanged.

type recordType:

string

param recordType:

The updated type of the registry record. Omit to leave the record type unchanged.

type descriptors:

dict

param descriptors:

The updated typed descriptor content for the registry record. Omit to leave the descriptors unchanged.

  • optionalValue (dict) --

    The value to set for this field. Omit the wrapper to leave the field unchanged.

    • mcpServer (dict) --

      The patch for the MCP server descriptor.

      • optionalValue (dict) --

        The value to set for this field. Omit the wrapper to leave the field unchanged.

        • data (dict) --

          The patch for the descriptor's data field.

          • optionalValue (string) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

        • dataSchemaVersion (dict) --

          The patch for the descriptor's data schema version field.

          • optionalValue (string) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

        • source (dict) --

          The patch for the descriptor's source field.

          • optionalValue (dict) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

            • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

              • 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.

                    • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                      • returnUrl (string) --

                        The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                    • 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. For an Amazon S3 skill source, omit it or set it to s3.

                      • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

        • additionalData (dict) --

          The patch for the descriptor's additional data field.

          • optionalValue (dict) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

            • tools (dict) --

              The patch for the MCP tools descriptor field.

              • optionalValue (dict) --

                The value to set for this field. Omit the wrapper to leave the field unchanged.

                • data (dict) --

                  The patch for the descriptor's data field.

                  • optionalValue (string) --

                    The value to set for this field. Omit the wrapper to leave the field unchanged.

                • dataSchemaVersion (dict) --

                  The patch for the descriptor's data schema version field.

                  • optionalValue (string) --

                    The value to set for this field. Omit the wrapper to leave the field unchanged.

    • a2aAgentCard (dict) --

      The patch for the A2A agent card descriptor.

      • optionalValue (dict) --

        The value to set for this field. Omit the wrapper to leave the field unchanged.

        • data (dict) --

          The patch for the descriptor's data field.

          • optionalValue (string) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

        • dataSchemaVersion (dict) --

          The patch for the descriptor's data schema version field.

          • optionalValue (string) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

        • source (dict) --

          The patch for the descriptor's source field.

          • optionalValue (dict) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

            • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

              • 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.

                    • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                      • returnUrl (string) --

                        The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                    • 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. For an Amazon S3 skill source, omit it or set it to s3.

                      • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

    • agentSkillsDefinition (dict) --

      The patch for the agent skills definition descriptor.

      • optionalValue (dict) --

        The value to set for this field. Omit the wrapper to leave the field unchanged.

        • data (dict) --

          The patch for the descriptor's data field.

          • optionalValue (string) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

        • dataSchemaVersion (dict) --

          The patch for the descriptor's data schema version field.

          • optionalValue (string) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

        • additionalData (dict) --

          The patch for the descriptor's additional data field.

          • optionalValue (dict) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

            • skillMd (dict) --

              The patch for the agent skills markdown descriptor field.

              • optionalValue (dict) --

                The value to set for this field. Omit the wrapper to leave the field unchanged.

                • data (dict) --

                  The patch for the descriptor's data field.

                  • optionalValue (string) --

                    The value to set for this field. Omit the wrapper to leave the field unchanged.

                • dataSchemaVersion (dict) --

                  The patch for the descriptor's data schema version field.

                  • optionalValue (string) --

                    The value to set for this field. Omit the wrapper to leave the field unchanged.

                • source (dict) --

                  The patch for the descriptor's source field.

                  • optionalValue (dict) --

                    The value to set for this field. Omit the wrapper to leave the field unchanged.

                    • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

                      • 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.

                            • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                              • returnUrl (string) --

                                The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                            • 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. For an Amazon S3 skill source, omit it or set it to s3.

                              • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

            • skillPackage (dict) --

              The patch for the skill package source field.

              • optionalValue (dict) --

                The value to set for this field. Omit the wrapper to leave the field unchanged.

                • source (dict) --

                  The source of the skill package. Specify an s3:// URL of a ZIP object, or a GitHub folder URL together with repositoryProvider set to GITHUB. For a GitHub folder, the registry builds the package from every file in the folder.

                  • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

                    • 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.

                          • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                            • returnUrl (string) --

                              The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                          • 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. For an Amazon S3 skill source, omit it or set it to s3.

                            • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

            • repositoryProvider (dict) --

              The patch for the repository provider field.

              • optionalValue (string) --

                The value to set for this field. Omit the wrapper to leave the field unchanged.

            • sourceConfiguration (dict) --

              The patch for the source configuration field.

              • optionalValue (dict) --

                The value to set for this field. Omit the wrapper to leave the field unchanged.

                • s3 (dict) --

                  The settings of an Amazon S3 source.

                  • bucketOwnerAccountId (string) --

                    The ID of the Amazon Web Services account that owns the source bucket. The registry checks that the bucket belongs to this account each time it reads the source. If you omit it for a source that uses an IAM role, the registry expects the bucket to be in the role's account. If you omit it for a source that has no credential provider, which the registry reads as a public object, the request fails with a ValidationException.

    • custom (dict) --

      The patch for the custom descriptor.

      • optionalValue (dict) --

        The value to set for this field. Omit the wrapper to leave the field unchanged.

        • data (dict) --

          The patch for the descriptor's data field.

          • optionalValue (string) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

    • http (dict) --

      The patch for the HTTP descriptor.

      • optionalValue (dict) --

        The value to set for this field. Omit the wrapper to leave the field unchanged.

        • source (dict) --

          The patch for the descriptor's source field.

          • optionalValue (dict) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

            • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

              • 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.

                    • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                      • returnUrl (string) --

                        The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                    • 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. For an Amazon S3 skill source, omit it or set it to s3.

                      • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

    • agui (dict) --

      The patch for the AG-UI descriptor.

      • optionalValue (dict) --

        The value to set for this field. Omit the wrapper to leave the field unchanged.

        • source (dict) --

          The patch for the descriptor's source field.

          • optionalValue (dict) --

            The value to set for this field. Omit the wrapper to leave the field unchanged.

            • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

              • 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.

                    • 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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                      • returnUrl (string) --

                        The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                    • 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. For an Amazon S3 skill source, omit it or set it to s3.

                      • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

type artifact:

dict

param artifact:

The change to the record's uploaded skill package. Omit it to keep the current package, specify an empty object to remove an uploaded package, or specify optionalValue to upload a new package. An empty object doesn't remove a package that the record synchronizes from a source. To stop that synchronization, remove skillPackage. A request that changes skillMd.data replaces the record's package with that text, even if you omit this member.

  • optionalValue (dict) --

    The skill package to upload. It replaces the record's current package or its synchronized content.

    • content (bytes) -- [REQUIRED]

      The ZIP archive of the skill package, up to 5 MiB (5,242,880 bytes). In a JSON request, the content is base64-encoded. The Amazon Web Services SDKs encode it for you.

    • sha256 (string) --

      The optional SHA-256 checksum of the ZIP archive, as 64 lowercase hexadecimal characters, computed over the archive's bytes rather than its base64 text. If it doesn't match the content, the request fails with a ValidationException.

type recordVersion:

string

param recordVersion:

The updated version of the registry record. Omit to leave the version unchanged.

type customMetadata:

dict

param customMetadata:

The updated custom metadata for the registry record. Values can be strings (maximum 128 characters) or native JSON booleans ( true or false). Omit to leave the existing metadata unchanged. Supply the wrapper with a full replacement set to update, or with a null value to clear all metadata.

  • optionalValue (:ref:`document<document>`) --

    The value to set for this field. Omit the wrapper to leave the field unchanged.

type triggerSynchronization:

boolean

param triggerSynchronization:

Specifies whether to synchronize the record's descriptor content from its source. For a skill record, the registry reads the stored skillMd.source or skillPackage.source again, because it doesn't watch the source for changes. For a GitHub source, the operation also returns a new authorization link when one is needed. An update that sets a different skill source starts a synchronization even if you omit this member.

type forceAuthentication:

boolean

param forceAuthentication:

Specifies whether to ask a GitHub user to authorize access again, even when the current authorization still works, for example to use a different GitHub account. You can use it only together with triggerSynchronization, for a GitHub source whose credential provider uses the AUTHORIZATION_CODE grant. The new authorization also replaces the one that the same IAM principal's other records in the registry use for the same host, credential provider, scopes, and custom parameters.

type provenance:

list

param provenance:

The provenance lineage re-assertion 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. The source identity of an existing lineage is immutable; a re-assertion may only refresh the source details.

  • (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.

      • 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.

          • customJWTAuthorizer (dict) --

            Configuration for a custom JWT authorizer.

            • discoveryUrl (string) -- [REQUIRED]

              The OpenID Connect discovery or OAuth 2.0 authorization server metadata 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.

                    • 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.

              • selfManagedLatticeResource (dict) --

                A private endpoint backed by a self-managed VPC Lattice resource configuration.

                • 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.

                  • selfManagedLatticeResource (dict) --

                    A private endpoint backed by a self-managed VPC Lattice resource configuration.

                    • 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.

          • customJWTAuthorizer (dict) --

            Configuration for a custom JWT authorizer.

            • discoveryUrl (string) -- [REQUIRED]

              The OpenID Connect discovery or OAuth 2.0 authorization server metadata 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.

                    • 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.

              • selfManagedLatticeResource (dict) --

                A private endpoint backed by a self-managed VPC Lattice resource configuration.

                • 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.

                  • selfManagedLatticeResource (dict) --

                    A private endpoint backed by a self-managed VPC Lattice resource configuration.

                    • 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.

rtype:

dict

returns:

Response Syntax

{
    'registryArn': 'string',
    'recordArn': 'string',
    'recordId': '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'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': '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'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': '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'|'AUTHORIZATION_CODE',
                                            'scopes': [
                                                'string',
                                            ],
                                            'customParameters': {
                                                'string': 'string'
                                            },
                                            'returnUrl': 'string'
                                        },
                                        'iamCredentialProvider': {
                                            'roleArn': 'string',
                                            'service': 'string',
                                            'region': 'string'
                                        }
                                    }
                                },
                            ]
                        }
                    }
                },
                'skillPackage': {
                    'source': {
                        'fromUrl': {
                            'url': 'string',
                            'credentialProviderConfigurations': [
                                {
                                    'credentialProviderType': 'OAUTH'|'IAM',
                                    'credentialProvider': {
                                        'oauthCredentialProvider': {
                                            'providerArn': 'string',
                                            'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                            'scopes': [
                                                'string',
                                            ],
                                            'customParameters': {
                                                'string': 'string'
                                            },
                                            'returnUrl': 'string'
                                        },
                                        'iamCredentialProvider': {
                                            'roleArn': 'string',
                                            'service': 'string',
                                            'region': 'string'
                                        }
                                    }
                                },
                            ]
                        }
                    }
                },
                'repositoryProvider': 'GITHUB',
                'sourceConfiguration': {
                    's3': {
                        'bucketOwnerAccountId': 'string'
                    }
                }
            }
        },
        'custom': {
            'data': 'string'
        },
        'http': {
            'source': {
                'fromUrl': {
                    'url': 'string',
                    'credentialProviderConfigurations': [
                        {
                            'credentialProviderType': 'OAUTH'|'IAM',
                            'credentialProvider': {
                                'oauthCredentialProvider': {
                                    'providerArn': 'string',
                                    'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': 'string'
                                },
                                'iamCredentialProvider': {
                                    'roleArn': 'string',
                                    'service': 'string',
                                    'region': 'string'
                                }
                            }
                        },
                    ]
                }
            }
        },
        'agui': {
            'source': {
                'fromUrl': {
                    'url': 'string',
                    'credentialProviderConfigurations': [
                        {
                            'credentialProviderType': 'OAUTH'|'IAM',
                            'credentialProvider': {
                                'oauthCredentialProvider': {
                                    'providerArn': 'string',
                                    'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                    'scopes': [
                                        'string',
                                    ],
                                    'customParameters': {
                                        'string': 'string'
                                    },
                                    'returnUrl': 'string'
                                },
                                'iamCredentialProvider': {
                                    'roleArn': 'string',
                                    'service': 'string',
                                    'region': 'string'
                                }
                            }
                        },
                    ]
                }
            }
        }
    },
    'recordVersion': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'CREATE_PENDING_AUTH'|'UPDATE_PENDING_AUTH',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'statusReason': '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'
                    }
                }
            }
        },
    ],
    'createdByAutoDetection': True|False,
    'createdBy': 'string',
    'customMetadata': {...}|[...]|123|123.4|'string'|True|None,
    'customMetadataSchemaComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT',
    'authorizationData': {
        'oauth2': {
            'authorizationUrl': 'string',
            'userId': 'string',
            'authorizationAttemptId': 'string',
            'expiresAt': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    Response structure for updating a registry record

    • registryArn (string) --

      The Amazon Resource Name (ARN) of the parent registry that owns 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. 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) --

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

              The URL from which the descriptor content is retrieved. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

            • 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.

                  • oauthCredentialProvider (dict) --

                    The OAuth 2.0 credential provider details.

                    • providerArn (string) --

                      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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                    • returnUrl (string) --

                      The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                  • 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. For an Amazon S3 skill source, omit it or set it to s3.

                    • 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. For an Amazon S3 skill source, omit it or set it 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

            • 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.

                  • oauthCredentialProvider (dict) --

                    The OAuth 2.0 credential provider details.

                    • providerArn (string) --

                      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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                    • returnUrl (string) --

                      The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                  • 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. For an Amazon S3 skill source, omit it or set it to s3.

                    • 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. For an Amazon S3 skill source, omit it or set it 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 of the skill's SKILL.md only. The registry synchronizes the SKILL.md from this source into data. Specify an s3:// URL of a SKILL.md object, or a GitHub folder URL together with repositoryProvider set to GITHUB. The registry rejects a new https:// URL without repositoryProvider, and you can't set both this source and skillPackage.source.

              • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

                • 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.

                      • oauthCredentialProvider (dict) --

                        The OAuth 2.0 credential provider details.

                        • providerArn (string) --

                          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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                        • returnUrl (string) --

                          The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                      • 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. For an Amazon S3 skill source, omit it or set it to s3.

                        • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

          • skillPackage (dict) --

            The source that the registry synchronizes the full skill package from. The registry validates and stores the package, sets skillMd.data from its SKILL.md, and returns the package in the artifact member of GetRegistryRecord. You can't set both this source and skillMd.source.

            • source (dict) --

              The source of the skill package. Specify an s3:// URL of a ZIP object, or a GitHub folder URL together with repositoryProvider set to GITHUB. For a GitHub folder, the registry builds the package from every file in the folder.

              • 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. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

                • 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.

                      • oauthCredentialProvider (dict) --

                        The OAuth 2.0 credential provider details.

                        • providerArn (string) --

                          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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                        • returnUrl (string) --

                          The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                      • 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. For an Amazon S3 skill source, omit it or set it to s3.

                        • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

          • repositoryProvider (string) --

            The repository provider of the record's skill source. Set it to GITHUB when skillMd.source or skillPackage.source is a GitHub folder URL. The registry treats an https:// source as a GitHub source only when this member is set. Don't set it for an Amazon S3 source.

          • sourceConfiguration (dict) --

            The provider-specific settings of the record's skill source. For an Amazon S3 source, s3.bucketOwnerAccountId specifies the account that owns the source bucket.

            • s3 (dict) --

              The settings of an Amazon S3 source.

              • bucketOwnerAccountId (string) --

                The ID of the Amazon Web Services account that owns the source bucket. The registry checks that the bucket belongs to this account each time it reads the source. If you omit it for a source that uses an IAM role, the registry expects the bucket to be in the role's account. If you omit it for a source that has no credential provider, which the registry reads as a public object, the request fails with a ValidationException.

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

              The URL from which the descriptor content is retrieved. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

            • 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.

                  • oauthCredentialProvider (dict) --

                    The OAuth 2.0 credential provider details.

                    • providerArn (string) --

                      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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                    • returnUrl (string) --

                      The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                  • 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. For an Amazon S3 skill source, omit it or set it to s3.

                    • 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. For an Amazon S3 skill source, omit it or set it 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) --

              The URL from which the descriptor content is retrieved. For an agent skill source, specify an s3:// URL of an object in a bucket in the same Amazon Web Services Region as the registry. For a GitHub skill source, specify a GitHub folder URL in the form https://host/owner/repo/tree/branch-or-tag/path. Other descriptor sources use https:// URLs.

            • 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.

                  • oauthCredentialProvider (dict) --

                    The OAuth 2.0 credential provider details.

                    • providerArn (string) --

                      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. A GitHub skill source requires AUTHORIZATION_CODE. Other sources, such as MCP server and A2A agent card sources, use CLIENT_CREDENTIALS. A GitHub source takes exactly one OAuth credential provider, in the registry's Amazon Web Services account and Region. Only an IAM role or IAM user in the account that owns the registry can set, synchronize, or reauthorize it, and the caller needs bedrock-agentcore:GetWorkloadAccessTokenForUserId and bedrock-agentcore:GetResourceOauth2Token on the registry's workload identity, registry- followed by the registry ID.

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

                    • returnUrl (string) --

                      The URL that the user's browser returns to after the user approves access on GitHub, for the AUTHORIZATION_CODE grant. There, your application completes the authorization by calling the Amazon Bedrock AgentCore Identity CompleteResourceTokenAuth operation with the userId from authorizationData. If you omit it, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization when the user is signed in as the IAM principal that made the request. A request that joins an authorization already in progress uses the return URL of the request that started it.

                  • 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. For an Amazon S3 skill source, omit it or set it to s3.

                    • 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. For an Amazon S3 skill source, omit it or set it to the Region of the registry.

    • recordVersion (string) --

      The version identifier of the registry record.

    • status (string) --

      The lifecycle status of the registry record. UPDATE_PENDING_AUTH means that the update waits for a GitHub user to authorize access before the record synchronizes from its GitHub source. For the authorization link, see authorizationData.

    • 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.

    • provenance (list) --

      The provenance lineage entries for the registry record. Populated for records created by auto-detection; each entry identifies the upstream source that the record was detected from.

      • (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) --

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

          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.

          • 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.

              • customJWTAuthorizer (dict) --

                Configuration for a custom JWT authorizer.

                • discoveryUrl (string) --

                  The OpenID Connect discovery or OAuth 2.0 authorization server metadata 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) --

                      The name of the claim in the inbound token to validate.

                    • inboundTokenClaimValueType (string) --

                      The value type of the claim in the inbound token, either a string or an array of strings.

                    • authorizingClaimMatchValue (dict) --

                      The value and match operator used to authorize the claim.

                      • claimMatchValue (dict) --

                        The expected value or values that the claim is compared against.

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

                        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.

                  • selfManagedLatticeResource (dict) --

                    A private endpoint backed by a self-managed VPC Lattice resource configuration.

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

                      The identifier of the VPC in which the private endpoint is provisioned.

                    • subnetIds (list) --

                      The identifiers of the subnets in which the private endpoint network interfaces are placed.

                      • (string) --

                        Subnet identifier

                    • endpointIpAddressType (string) --

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

                      The domain name to which this private endpoint override applies.

                    • privateEndpoint (dict) --

                      The private endpoint used to reach the specified domain.

                      • selfManagedLatticeResource (dict) --

                        A private endpoint backed by a self-managed VPC Lattice resource configuration.

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

                          The identifier of the VPC in which the private endpoint is provisioned.

                        • subnetIds (list) --

                          The identifiers of the subnets in which the private endpoint network interfaces are placed.

                          • (string) --

                            Subnet identifier

                        • endpointIpAddressType (string) --

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

                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.

              • customJWTAuthorizer (dict) --

                Configuration for a custom JWT authorizer.

                • discoveryUrl (string) --

                  The OpenID Connect discovery or OAuth 2.0 authorization server metadata 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) --

                      The name of the claim in the inbound token to validate.

                    • inboundTokenClaimValueType (string) --

                      The value type of the claim in the inbound token, either a string or an array of strings.

                    • authorizingClaimMatchValue (dict) --

                      The value and match operator used to authorize the claim.

                      • claimMatchValue (dict) --

                        The expected value or values that the claim is compared against.

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

                        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.

                  • selfManagedLatticeResource (dict) --

                    A private endpoint backed by a self-managed VPC Lattice resource configuration.

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

                      The identifier of the VPC in which the private endpoint is provisioned.

                    • subnetIds (list) --

                      The identifiers of the subnets in which the private endpoint network interfaces are placed.

                      • (string) --

                        Subnet identifier

                    • endpointIpAddressType (string) --

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

                      The domain name to which this private endpoint override applies.

                    • privateEndpoint (dict) --

                      The private endpoint used to reach the specified domain.

                      • selfManagedLatticeResource (dict) --

                        A private endpoint backed by a self-managed VPC Lattice resource configuration.

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

                          The identifier of the VPC in which the private endpoint is provisioned.

                        • subnetIds (list) --

                          The identifiers of the subnets in which the private endpoint network interfaces are placed.

                          • (string) --

                            Subnet identifier

                        • endpointIpAddressType (string) --

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

                The Amazon Resource Name (ARN) of the workload identity associated with the source resource.

    • createdByAutoDetection (boolean) --

      Specifies whether the registry record was created by auto-detection. true indicates the record was automatically created by the service based on the registry's auto-detection configuration; false indicates the record was created through a control-plane API call.

    • createdBy (string) --

      The ID of the Amazon Web Services account that created the registry record.

    • customMetadata (:ref:`document<document>`) --

      The custom metadata attached to this registry record. Values are strings (maximum 128 characters) or booleans.

    • customMetadataSchemaComplianceStatus (string) --

      Indicates whether this record's custom metadata conforms to the registry's current schema. This status is computed at read time against the latest schema.

    • authorizationData (dict) --

      The authorization that a GitHub user must complete before the record's synchronization starts. Present only in this response, and only while the status is UPDATE_PENDING_AUTH. If the status is UPDATE_PENDING_AUTH but this member is absent, call UpdateRegistryRecord again with triggerSynchronization to get a new authorization link.

      • oauth2 (dict) --

        The OAuth 2.0 authorization that a GitHub user must approve.

        • authorizationUrl (string) --

          The URL that the user opens to approve access. The link is valid for up to 10 minutes. Treat it as sensitive and give it only to the user who approves access.

        • userId (string) --

          The AgentCore Identity user ID that the authorization is for. Store it with your signed-in user and pass it as userIdentifier.userId when your application calls CompleteResourceTokenAuth.

        • authorizationAttemptId (string) --

          The identifier of this authorization attempt.

        • expiresAt (datetime) --

          The timestamp when the authorization link expires, 10 minutes after the authorization started. A request that joins an authorization in progress gets less time, and the link might stop working shortly before this time.

UpdateRegistryRecordStatus (updated) Link ¶
Changes (both)
{'status': {'UPDATE_PENDING_AUTH', 'CREATE_PENDING_AUTH'}}

Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable

See also: AWS API Documentation

Request Syntax

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

string

param registryId:

[REQUIRED]

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

type recordId:

string

param recordId:

[REQUIRED]

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

type status:

string

param status:

[REQUIRED]

The target status for the registry record

type statusReason:

string

param statusReason:

[REQUIRED]

The reason for the status change, for example why the record was approved, rejected, or deprecated

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    Response structure for updating a registry record status

    • registryArn (string) --

      The ARN of the registry

    • recordArn (string) --

      The ARN of the registry record

    • recordId (string) --

      The ID of the registry record

    • status (string) --

      The resulting status of the registry record

    • statusReason (string) --

      The reason for the status change

    • updatedAt (datetime) --

      The timestamp when the record was last updated