{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-schemas","description":"Schemas","version":"2019-12-02","base_url":"","endpoints":31,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Schemas\n@version 2019-12-02\n@auth AWS SigV4\n@endpoints 31\n@hint download_for_search\n@toc discoverers(7), registries(17), policy(3), discover(1), tags(3)\n\n@group discoverers\n@endpoint POST /v1/discoverers\n@desc Creates a discoverer.\n@required {SourceArn: str}\n@optional {Description: str, CrossAccount: bool, Tags: map<str,str>}\n@returns(200) {Description: str?, DiscovererArn: str?, DiscovererId: str?, SourceArn: str?, State: str?, CrossAccount: bool?, Tags: map<str,str>?}\n\n@endgroup\n\n@group registries\n@endpoint POST /v1/registries/name/{registryName}\n@desc Creates a registry.\n@required {RegistryName: str}\n@optional {Description: str, Tags: map<str,str>}\n@returns(200) {Description: str?, RegistryArn: str?, RegistryName: str?, Tags: map<str,str>?}\n\n@endpoint POST /v1/registries/name/{registryName}/schemas/name/{schemaName}\n@desc Creates a schema definition. Inactive schemas will be deleted after two years.\n@required {RegistryName: str, SchemaName: str, Content: str, Type: str}\n@optional {Description: str, Tags: map<str,str>}\n@returns(200) {Description: str?, LastModified: str(timestamp)?, SchemaArn: str?, SchemaName: str?, SchemaVersion: str?, Tags: map<str,str>?, Type: str?, VersionCreatedDate: str(timestamp)?}\n\n@endgroup\n\n@group discoverers\n@endpoint DELETE /v1/discoverers/id/{discovererId}\n@desc Deletes a discoverer.\n@required {DiscovererId: str}\n\n@endgroup\n\n@group registries\n@endpoint DELETE /v1/registries/name/{registryName}\n@desc Deletes a Registry.\n@required {RegistryName: str}\n\n@endgroup\n\n@group policy\n@endpoint DELETE /v1/policy\n@desc Delete the resource-based policy attached to the specified registry.\n@optional {registryName: str}\n\n@endgroup\n\n@group registries\n@endpoint DELETE /v1/registries/name/{registryName}/schemas/name/{schemaName}\n@desc Delete a schema definition.\n@required {RegistryName: str, SchemaName: str}\n\n@endpoint DELETE /v1/registries/name/{registryName}/schemas/name/{schemaName}/version/{schemaVersion}\n@desc Delete the schema version definition\n@required {RegistryName: str, SchemaName: str, SchemaVersion: str}\n\n@endpoint GET /v1/registries/name/{registryName}/schemas/name/{schemaName}/language/{language}\n@desc Describe the code binding URI.\n@required {Language: str, RegistryName: str, SchemaName: str}\n@optional {schemaVersion: str}\n@returns(200) {CreationDate: str(timestamp)?, LastModified: str(timestamp)?, SchemaVersion: str?, Status: str?}\n\n@endgroup\n\n@group discoverers\n@endpoint GET /v1/discoverers/id/{discovererId}\n@desc Describes the discoverer.\n@required {DiscovererId: str}\n@returns(200) {Description: str?, DiscovererArn: str?, DiscovererId: str?, SourceArn: str?, State: str?, CrossAccount: bool?, Tags: map<str,str>?}\n\n@endgroup\n\n@group registries\n@endpoint GET /v1/registries/name/{registryName}\n@desc Describes the registry.\n@required {RegistryName: str}\n@returns(200) {Description: str?, RegistryArn: str?, RegistryName: str?, Tags: map<str,str>?}\n\n@endpoint GET /v1/registries/name/{registryName}/schemas/name/{schemaName}\n@desc Retrieve the schema definition.\n@required {RegistryName: str, SchemaName: str}\n@optional {schemaVersion: str}\n@returns(200) {Content: str?, Description: str?, LastModified: str(timestamp)?, SchemaArn: str?, SchemaName: str?, SchemaVersion: str?, Tags: map<str,str>?, Type: str?, VersionCreatedDate: str(timestamp)?}\n\n@endpoint GET /v1/registries/name/{registryName}/schemas/name/{schemaName}/export\n@required {RegistryName: str, SchemaName: str, type: str}\n@optional {schemaVersion: str}\n@returns(200) {Content: str?, SchemaArn: str?, SchemaName: str?, SchemaVersion: str?, Type: str?}\n\n@endpoint GET /v1/registries/name/{registryName}/schemas/name/{schemaName}/language/{language}/source\n@desc Get the code binding source URI.\n@required {Language: str, RegistryName: str, SchemaName: str}\n@optional {schemaVersion: str}\n@returns(200) {Body: bytes?}\n\n@endgroup\n\n@group discover\n@endpoint POST /v1/discover\n@desc Get the discovered schema that was generated based on sampled events.\n@required {Events: [str], Type: str}\n@returns(200) {Content: str?}\n\n@endgroup\n\n@group policy\n@endpoint GET /v1/policy\n@desc Retrieves the resource-based policy attached to a given registry.\n@optional {registryName: str}\n@returns(200) {Policy: str?, RevisionId: str?}\n\n@endgroup\n\n@group discoverers\n@endpoint GET /v1/discoverers\n@desc List the discoverers.\n@optional {discovererIdPrefix: str, limit: int, nextToken: str, sourceArnPrefix: str}\n@returns(200) {Discoverers: [DiscovererSummary]?, NextToken: str?}\n\n@endgroup\n\n@group registries\n@endpoint GET /v1/registries\n@desc List the registries.\n@optional {limit: int, nextToken: str, registryNamePrefix: str, scope: str}\n@returns(200) {NextToken: str?, Registries: [RegistrySummary]?}\n\n@endpoint GET /v1/registries/name/{registryName}/schemas/name/{schemaName}/versions\n@desc Provides a list of the schema versions and related information.\n@required {RegistryName: str, SchemaName: str}\n@optional {limit: int, nextToken: str}\n@returns(200) {NextToken: str?, SchemaVersions: [SchemaVersionSummary]?}\n\n@endpoint GET /v1/registries/name/{registryName}/schemas\n@desc List the schemas.\n@required {RegistryName: str}\n@optional {limit: int, nextToken: str, schemaNamePrefix: str}\n@returns(200) {NextToken: str?, Schemas: [SchemaSummary]?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{resource-arn}\n@desc Get tags for resource.\n@required {ResourceArn: str}\n@returns(200) {Tags: map<str,str>?}\n\n@endgroup\n\n@group registries\n@endpoint POST /v1/registries/name/{registryName}/schemas/name/{schemaName}/language/{language}\n@desc Put code binding URI\n@required {Language: str, RegistryName: str, SchemaName: str}\n@optional {schemaVersion: str}\n@returns(200) {CreationDate: str(timestamp)?, LastModified: str(timestamp)?, SchemaVersion: str?, Status: str?}\n\n@endgroup\n\n@group policy\n@endpoint PUT /v1/policy\n@desc The name of the policy.\n@required {Policy: str}\n@optional {registryName: str, RevisionId: str}\n@returns(200) {Policy: str?, RevisionId: str?}\n\n@endgroup\n\n@group registries\n@endpoint GET /v1/registries/name/{registryName}/schemas/search\n@desc Search the schemas\n@required {keywords: str, RegistryName: str}\n@optional {limit: int, nextToken: str}\n@returns(200) {NextToken: str?, Schemas: [SearchSchemaSummary]?}\n\n@endgroup\n\n@group discoverers\n@endpoint POST /v1/discoverers/id/{discovererId}/start\n@desc Starts the discoverer\n@required {DiscovererId: str}\n@returns(200) {DiscovererId: str?, State: str?}\n\n@endpoint POST /v1/discoverers/id/{discovererId}/stop\n@desc Stops the discoverer\n@required {DiscovererId: str}\n@returns(200) {DiscovererId: str?, State: str?}\n\n@endgroup\n\n@group tags\n@endpoint POST /tags/{resource-arn}\n@desc Add tags to a resource.\n@required {ResourceArn: str, Tags: map<str,str>}\n\n@endpoint DELETE /tags/{resource-arn}\n@desc Removes tags from a resource.\n@required {ResourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group discoverers\n@endpoint PUT /v1/discoverers/id/{discovererId}\n@desc Updates the discoverer\n@required {DiscovererId: str}\n@optional {Description: str, CrossAccount: bool}\n@returns(200) {Description: str?, DiscovererArn: str?, DiscovererId: str?, SourceArn: str?, State: str?, CrossAccount: bool?, Tags: map<str,str>?}\n\n@endgroup\n\n@group registries\n@endpoint PUT /v1/registries/name/{registryName}\n@desc Updates a registry.\n@required {RegistryName: str}\n@optional {Description: str}\n@returns(200) {Description: str?, RegistryArn: str?, RegistryName: str?, Tags: map<str,str>?}\n\n@endpoint PUT /v1/registries/name/{registryName}/schemas/name/{schemaName}\n@desc Updates the schema definition Inactive schemas will be deleted after two years.\n@required {RegistryName: str, SchemaName: str}\n@optional {ClientTokenId: str, Content: str, Description: str, Type: str}\n@returns(200) {Description: str?, LastModified: str(timestamp)?, SchemaArn: str?, SchemaName: str?, SchemaVersion: str?, Tags: map<str,str>?, Type: str?, VersionCreatedDate: str(timestamp)?}\n\n@endgroup\n\n@end\n"}