1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201 |
- import {Request} from '../lib/request';
- import {Response} from '../lib/response';
- import {AWSError} from '../lib/error';
- import {Service} from '../lib/service';
- import {WaiterConfiguration} from '../lib/service';
- import {ServiceConfigurationOptions} from '../lib/service';
- import {ConfigBase as Config} from '../lib/config-base';
- interface Blob {}
- declare class Schemas extends Service {
- /**
- * Constructs a service object. This object has one method for each API operation.
- */
- constructor(options?: Schemas.Types.ClientConfiguration)
- config: Config & Schemas.Types.ClientConfiguration;
- /**
- * Creates a discoverer.
- */
- createDiscoverer(params: Schemas.Types.CreateDiscovererRequest, callback?: (err: AWSError, data: Schemas.Types.CreateDiscovererResponse) => void): Request<Schemas.Types.CreateDiscovererResponse, AWSError>;
- /**
- * Creates a discoverer.
- */
- createDiscoverer(callback?: (err: AWSError, data: Schemas.Types.CreateDiscovererResponse) => void): Request<Schemas.Types.CreateDiscovererResponse, AWSError>;
- /**
- * Creates a registry.
- */
- createRegistry(params: Schemas.Types.CreateRegistryRequest, callback?: (err: AWSError, data: Schemas.Types.CreateRegistryResponse) => void): Request<Schemas.Types.CreateRegistryResponse, AWSError>;
- /**
- * Creates a registry.
- */
- createRegistry(callback?: (err: AWSError, data: Schemas.Types.CreateRegistryResponse) => void): Request<Schemas.Types.CreateRegistryResponse, AWSError>;
- /**
- * Creates a schema definition. Inactive schemas will be deleted after two years.
- */
- createSchema(params: Schemas.Types.CreateSchemaRequest, callback?: (err: AWSError, data: Schemas.Types.CreateSchemaResponse) => void): Request<Schemas.Types.CreateSchemaResponse, AWSError>;
- /**
- * Creates a schema definition. Inactive schemas will be deleted after two years.
- */
- createSchema(callback?: (err: AWSError, data: Schemas.Types.CreateSchemaResponse) => void): Request<Schemas.Types.CreateSchemaResponse, AWSError>;
- /**
- * Deletes a discoverer.
- */
- deleteDiscoverer(params: Schemas.Types.DeleteDiscovererRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Deletes a discoverer.
- */
- deleteDiscoverer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Deletes a Registry.
- */
- deleteRegistry(params: Schemas.Types.DeleteRegistryRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Deletes a Registry.
- */
- deleteRegistry(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Delete the resource-based policy attached to the specified registry.
- */
- deleteResourcePolicy(params: Schemas.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Delete the resource-based policy attached to the specified registry.
- */
- deleteResourcePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Delete a schema definition.
- */
- deleteSchema(params: Schemas.Types.DeleteSchemaRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Delete a schema definition.
- */
- deleteSchema(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Delete the schema version definition
- */
- deleteSchemaVersion(params: Schemas.Types.DeleteSchemaVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Delete the schema version definition
- */
- deleteSchemaVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Describe the code binding URI.
- */
- describeCodeBinding(params: Schemas.Types.DescribeCodeBindingRequest, callback?: (err: AWSError, data: Schemas.Types.DescribeCodeBindingResponse) => void): Request<Schemas.Types.DescribeCodeBindingResponse, AWSError>;
- /**
- * Describe the code binding URI.
- */
- describeCodeBinding(callback?: (err: AWSError, data: Schemas.Types.DescribeCodeBindingResponse) => void): Request<Schemas.Types.DescribeCodeBindingResponse, AWSError>;
- /**
- * Describes the discoverer.
- */
- describeDiscoverer(params: Schemas.Types.DescribeDiscovererRequest, callback?: (err: AWSError, data: Schemas.Types.DescribeDiscovererResponse) => void): Request<Schemas.Types.DescribeDiscovererResponse, AWSError>;
- /**
- * Describes the discoverer.
- */
- describeDiscoverer(callback?: (err: AWSError, data: Schemas.Types.DescribeDiscovererResponse) => void): Request<Schemas.Types.DescribeDiscovererResponse, AWSError>;
- /**
- * Describes the registry.
- */
- describeRegistry(params: Schemas.Types.DescribeRegistryRequest, callback?: (err: AWSError, data: Schemas.Types.DescribeRegistryResponse) => void): Request<Schemas.Types.DescribeRegistryResponse, AWSError>;
- /**
- * Describes the registry.
- */
- describeRegistry(callback?: (err: AWSError, data: Schemas.Types.DescribeRegistryResponse) => void): Request<Schemas.Types.DescribeRegistryResponse, AWSError>;
- /**
- * Retrieve the schema definition.
- */
- describeSchema(params: Schemas.Types.DescribeSchemaRequest, callback?: (err: AWSError, data: Schemas.Types.DescribeSchemaResponse) => void): Request<Schemas.Types.DescribeSchemaResponse, AWSError>;
- /**
- * Retrieve the schema definition.
- */
- describeSchema(callback?: (err: AWSError, data: Schemas.Types.DescribeSchemaResponse) => void): Request<Schemas.Types.DescribeSchemaResponse, AWSError>;
- /**
- *
- */
- exportSchema(params: Schemas.Types.ExportSchemaRequest, callback?: (err: AWSError, data: Schemas.Types.ExportSchemaResponse) => void): Request<Schemas.Types.ExportSchemaResponse, AWSError>;
- /**
- *
- */
- exportSchema(callback?: (err: AWSError, data: Schemas.Types.ExportSchemaResponse) => void): Request<Schemas.Types.ExportSchemaResponse, AWSError>;
- /**
- * Get the code binding source URI.
- */
- getCodeBindingSource(params: Schemas.Types.GetCodeBindingSourceRequest, callback?: (err: AWSError, data: Schemas.Types.GetCodeBindingSourceResponse) => void): Request<Schemas.Types.GetCodeBindingSourceResponse, AWSError>;
- /**
- * Get the code binding source URI.
- */
- getCodeBindingSource(callback?: (err: AWSError, data: Schemas.Types.GetCodeBindingSourceResponse) => void): Request<Schemas.Types.GetCodeBindingSourceResponse, AWSError>;
- /**
- * Get the discovered schema that was generated based on sampled events.
- */
- getDiscoveredSchema(params: Schemas.Types.GetDiscoveredSchemaRequest, callback?: (err: AWSError, data: Schemas.Types.GetDiscoveredSchemaResponse) => void): Request<Schemas.Types.GetDiscoveredSchemaResponse, AWSError>;
- /**
- * Get the discovered schema that was generated based on sampled events.
- */
- getDiscoveredSchema(callback?: (err: AWSError, data: Schemas.Types.GetDiscoveredSchemaResponse) => void): Request<Schemas.Types.GetDiscoveredSchemaResponse, AWSError>;
- /**
- * Retrieves the resource-based policy attached to a given registry.
- */
- getResourcePolicy(params: Schemas.Types.GetResourcePolicyRequest, callback?: (err: AWSError, data: Schemas.Types.GetResourcePolicyResponse) => void): Request<Schemas.Types.GetResourcePolicyResponse, AWSError>;
- /**
- * Retrieves the resource-based policy attached to a given registry.
- */
- getResourcePolicy(callback?: (err: AWSError, data: Schemas.Types.GetResourcePolicyResponse) => void): Request<Schemas.Types.GetResourcePolicyResponse, AWSError>;
- /**
- * List the discoverers.
- */
- listDiscoverers(params: Schemas.Types.ListDiscoverersRequest, callback?: (err: AWSError, data: Schemas.Types.ListDiscoverersResponse) => void): Request<Schemas.Types.ListDiscoverersResponse, AWSError>;
- /**
- * List the discoverers.
- */
- listDiscoverers(callback?: (err: AWSError, data: Schemas.Types.ListDiscoverersResponse) => void): Request<Schemas.Types.ListDiscoverersResponse, AWSError>;
- /**
- * List the registries.
- */
- listRegistries(params: Schemas.Types.ListRegistriesRequest, callback?: (err: AWSError, data: Schemas.Types.ListRegistriesResponse) => void): Request<Schemas.Types.ListRegistriesResponse, AWSError>;
- /**
- * List the registries.
- */
- listRegistries(callback?: (err: AWSError, data: Schemas.Types.ListRegistriesResponse) => void): Request<Schemas.Types.ListRegistriesResponse, AWSError>;
- /**
- * Provides a list of the schema versions and related information.
- */
- listSchemaVersions(params: Schemas.Types.ListSchemaVersionsRequest, callback?: (err: AWSError, data: Schemas.Types.ListSchemaVersionsResponse) => void): Request<Schemas.Types.ListSchemaVersionsResponse, AWSError>;
- /**
- * Provides a list of the schema versions and related information.
- */
- listSchemaVersions(callback?: (err: AWSError, data: Schemas.Types.ListSchemaVersionsResponse) => void): Request<Schemas.Types.ListSchemaVersionsResponse, AWSError>;
- /**
- * List the schemas.
- */
- listSchemas(params: Schemas.Types.ListSchemasRequest, callback?: (err: AWSError, data: Schemas.Types.ListSchemasResponse) => void): Request<Schemas.Types.ListSchemasResponse, AWSError>;
- /**
- * List the schemas.
- */
- listSchemas(callback?: (err: AWSError, data: Schemas.Types.ListSchemasResponse) => void): Request<Schemas.Types.ListSchemasResponse, AWSError>;
- /**
- * Get tags for resource.
- */
- listTagsForResource(params: Schemas.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Schemas.Types.ListTagsForResourceResponse) => void): Request<Schemas.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Get tags for resource.
- */
- listTagsForResource(callback?: (err: AWSError, data: Schemas.Types.ListTagsForResourceResponse) => void): Request<Schemas.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Put code binding URI
- */
- putCodeBinding(params: Schemas.Types.PutCodeBindingRequest, callback?: (err: AWSError, data: Schemas.Types.PutCodeBindingResponse) => void): Request<Schemas.Types.PutCodeBindingResponse, AWSError>;
- /**
- * Put code binding URI
- */
- putCodeBinding(callback?: (err: AWSError, data: Schemas.Types.PutCodeBindingResponse) => void): Request<Schemas.Types.PutCodeBindingResponse, AWSError>;
- /**
- * The name of the policy.
- */
- putResourcePolicy(params: Schemas.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: Schemas.Types.PutResourcePolicyResponse) => void): Request<Schemas.Types.PutResourcePolicyResponse, AWSError>;
- /**
- * The name of the policy.
- */
- putResourcePolicy(callback?: (err: AWSError, data: Schemas.Types.PutResourcePolicyResponse) => void): Request<Schemas.Types.PutResourcePolicyResponse, AWSError>;
- /**
- * Search the schemas
- */
- searchSchemas(params: Schemas.Types.SearchSchemasRequest, callback?: (err: AWSError, data: Schemas.Types.SearchSchemasResponse) => void): Request<Schemas.Types.SearchSchemasResponse, AWSError>;
- /**
- * Search the schemas
- */
- searchSchemas(callback?: (err: AWSError, data: Schemas.Types.SearchSchemasResponse) => void): Request<Schemas.Types.SearchSchemasResponse, AWSError>;
- /**
- * Starts the discoverer
- */
- startDiscoverer(params: Schemas.Types.StartDiscovererRequest, callback?: (err: AWSError, data: Schemas.Types.StartDiscovererResponse) => void): Request<Schemas.Types.StartDiscovererResponse, AWSError>;
- /**
- * Starts the discoverer
- */
- startDiscoverer(callback?: (err: AWSError, data: Schemas.Types.StartDiscovererResponse) => void): Request<Schemas.Types.StartDiscovererResponse, AWSError>;
- /**
- * Stops the discoverer
- */
- stopDiscoverer(params: Schemas.Types.StopDiscovererRequest, callback?: (err: AWSError, data: Schemas.Types.StopDiscovererResponse) => void): Request<Schemas.Types.StopDiscovererResponse, AWSError>;
- /**
- * Stops the discoverer
- */
- stopDiscoverer(callback?: (err: AWSError, data: Schemas.Types.StopDiscovererResponse) => void): Request<Schemas.Types.StopDiscovererResponse, AWSError>;
- /**
- * Add tags to a resource.
- */
- tagResource(params: Schemas.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Add tags to a resource.
- */
- tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Removes tags from a resource.
- */
- untagResource(params: Schemas.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Removes tags from a resource.
- */
- untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
- /**
- * Updates the discoverer
- */
- updateDiscoverer(params: Schemas.Types.UpdateDiscovererRequest, callback?: (err: AWSError, data: Schemas.Types.UpdateDiscovererResponse) => void): Request<Schemas.Types.UpdateDiscovererResponse, AWSError>;
- /**
- * Updates the discoverer
- */
- updateDiscoverer(callback?: (err: AWSError, data: Schemas.Types.UpdateDiscovererResponse) => void): Request<Schemas.Types.UpdateDiscovererResponse, AWSError>;
- /**
- * Updates a registry.
- */
- updateRegistry(params: Schemas.Types.UpdateRegistryRequest, callback?: (err: AWSError, data: Schemas.Types.UpdateRegistryResponse) => void): Request<Schemas.Types.UpdateRegistryResponse, AWSError>;
- /**
- * Updates a registry.
- */
- updateRegistry(callback?: (err: AWSError, data: Schemas.Types.UpdateRegistryResponse) => void): Request<Schemas.Types.UpdateRegistryResponse, AWSError>;
- /**
- * Updates the schema definition Inactive schemas will be deleted after two years.
- */
- updateSchema(params: Schemas.Types.UpdateSchemaRequest, callback?: (err: AWSError, data: Schemas.Types.UpdateSchemaResponse) => void): Request<Schemas.Types.UpdateSchemaResponse, AWSError>;
- /**
- * Updates the schema definition Inactive schemas will be deleted after two years.
- */
- updateSchema(callback?: (err: AWSError, data: Schemas.Types.UpdateSchemaResponse) => void): Request<Schemas.Types.UpdateSchemaResponse, AWSError>;
- /**
- * Waits for the codeBindingExists state by periodically calling the underlying Schemas.describeCodeBindingoperation every 2 seconds (at most 30 times). Wait until code binding is generated
- */
- waitFor(state: "codeBindingExists", params: Schemas.Types.DescribeCodeBindingRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Schemas.Types.DescribeCodeBindingResponse) => void): Request<Schemas.Types.DescribeCodeBindingResponse, AWSError>;
- /**
- * Waits for the codeBindingExists state by periodically calling the underlying Schemas.describeCodeBindingoperation every 2 seconds (at most 30 times). Wait until code binding is generated
- */
- waitFor(state: "codeBindingExists", callback?: (err: AWSError, data: Schemas.Types.DescribeCodeBindingResponse) => void): Request<Schemas.Types.DescribeCodeBindingResponse, AWSError>;
- }
- declare namespace Schemas {
- export type CodeGenerationStatus = "CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"CREATE_FAILED"|string;
- export interface CreateDiscovererRequest {
- /**
- * A description for the discoverer.
- */
- Description?: __stringMin0Max256;
- /**
- * The ARN of the event bus.
- */
- SourceArn: __stringMin20Max1600;
- /**
- * Support discovery of schemas in events sent to the bus from another account. (default: true).
- */
- CrossAccount?: __boolean;
- /**
- * Tags associated with the resource.
- */
- Tags?: Tags;
- }
- export interface CreateDiscovererResponse {
- /**
- * The description of the discoverer.
- */
- Description?: __string;
- /**
- * The ARN of the discoverer.
- */
- DiscovererArn?: __string;
- /**
- * The ID of the discoverer.
- */
- DiscovererId?: __string;
- /**
- * The ARN of the event bus.
- */
- SourceArn?: __string;
- /**
- * The state of the discoverer.
- */
- State?: DiscovererState;
- /**
- * The Status if the discoverer will discover schemas from events sent from another account.
- */
- CrossAccount?: __boolean;
- /**
- * Tags associated with the resource.
- */
- Tags?: Tags;
- }
- export interface CreateRegistryRequest {
- /**
- * A description of the registry to be created.
- */
- Description?: __stringMin0Max256;
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * Tags to associate with the registry.
- */
- Tags?: Tags;
- }
- export interface CreateRegistryResponse {
- /**
- * The description of the registry.
- */
- Description?: __string;
- /**
- * The ARN of the registry.
- */
- RegistryArn?: __string;
- /**
- * The name of the registry.
- */
- RegistryName?: __string;
- /**
- * Tags associated with the registry.
- */
- Tags?: Tags;
- }
- export interface CreateSchemaRequest {
- /**
- * The source of the schema definition.
- */
- Content: __stringMin1Max100000;
- /**
- * A description of the schema.
- */
- Description?: __stringMin0Max256;
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * The name of the schema.
- */
- SchemaName: __string;
- /**
- * Tags associated with the schema.
- */
- Tags?: Tags;
- /**
- * The type of schema.
- */
- Type: Type;
- }
- export interface CreateSchemaResponse {
- /**
- * The description of the schema.
- */
- Description?: __string;
- /**
- * The date and time that schema was modified.
- */
- LastModified?: __timestampIso8601;
- /**
- * The ARN of the schema.
- */
- SchemaArn?: __string;
- /**
- * The name of the schema.
- */
- SchemaName?: __string;
- /**
- * The version number of the schema
- */
- SchemaVersion?: __string;
- Tags?: Tags;
- /**
- * The type of the schema.
- */
- Type?: __string;
- /**
- * The date the schema version was created.
- */
- VersionCreatedDate?: __timestampIso8601;
- }
- export interface DeleteDiscovererRequest {
- /**
- * The ID of the discoverer.
- */
- DiscovererId: __string;
- }
- export interface DeleteRegistryRequest {
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- }
- export interface DeleteResourcePolicyRequest {
- /**
- * The name of the registry.
- */
- RegistryName?: __string;
- }
- export interface DeleteSchemaRequest {
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * The name of the schema.
- */
- SchemaName: __string;
- }
- export interface DeleteSchemaVersionRequest {
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * The name of the schema.
- */
- SchemaName: __string;
- /**
- * The version number of the schema
- */
- SchemaVersion: __string;
- }
- export interface DescribeCodeBindingRequest {
- /**
- * The language of the code binding.
- */
- Language: __string;
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * The name of the schema.
- */
- SchemaName: __string;
- /**
- * Specifying this limits the results to only this schema version.
- */
- SchemaVersion?: __string;
- }
- export interface DescribeCodeBindingResponse {
- /**
- * The time and date that the code binding was created.
- */
- CreationDate?: __timestampIso8601;
- /**
- * The date and time that code bindings were modified.
- */
- LastModified?: __timestampIso8601;
- /**
- * The version number of the schema.
- */
- SchemaVersion?: __string;
- /**
- * The current status of code binding generation.
- */
- Status?: CodeGenerationStatus;
- }
- export interface DescribeDiscovererRequest {
- /**
- * The ID of the discoverer.
- */
- DiscovererId: __string;
- }
- export interface DescribeDiscovererResponse {
- /**
- * The description of the discoverer.
- */
- Description?: __string;
- /**
- * The ARN of the discoverer.
- */
- DiscovererArn?: __string;
- /**
- * The ID of the discoverer.
- */
- DiscovererId?: __string;
- /**
- * The ARN of the event bus.
- */
- SourceArn?: __string;
- /**
- * The state of the discoverer.
- */
- State?: DiscovererState;
- /**
- * The Status if the discoverer will discover schemas from events sent from another account.
- */
- CrossAccount?: __boolean;
- /**
- * Tags associated with the resource.
- */
- Tags?: Tags;
- }
- export interface DescribeRegistryRequest {
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- }
- export interface DescribeRegistryResponse {
- /**
- * The description of the registry.
- */
- Description?: __string;
- /**
- * The ARN of the registry.
- */
- RegistryArn?: __string;
- /**
- * The name of the registry.
- */
- RegistryName?: __string;
- /**
- * Tags associated with the registry.
- */
- Tags?: Tags;
- }
- export interface DescribeSchemaRequest {
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * The name of the schema.
- */
- SchemaName: __string;
- /**
- * Specifying this limits the results to only this schema version.
- */
- SchemaVersion?: __string;
- }
- export interface DescribeSchemaResponse {
- /**
- * The source of the schema definition.
- */
- Content?: __string;
- /**
- * The description of the schema.
- */
- Description?: __string;
- /**
- * The date and time that schema was modified.
- */
- LastModified?: __timestampIso8601;
- /**
- * The ARN of the schema.
- */
- SchemaArn?: __string;
- /**
- * The name of the schema.
- */
- SchemaName?: __string;
- /**
- * The version number of the schema
- */
- SchemaVersion?: __string;
- /**
- * Tags associated with the resource.
- */
- Tags?: Tags;
- /**
- * The type of the schema.
- */
- Type?: __string;
- /**
- * The date the schema version was created.
- */
- VersionCreatedDate?: __timestampIso8601;
- }
- export type DiscovererState = "STARTED"|"STOPPED"|string;
- export interface DiscovererSummary {
- /**
- * The ARN of the discoverer.
- */
- DiscovererArn?: __string;
- /**
- * The ID of the discoverer.
- */
- DiscovererId?: __string;
- /**
- * The ARN of the event bus.
- */
- SourceArn?: __string;
- /**
- * The state of the discoverer.
- */
- State?: DiscovererState;
- /**
- * The Status if the discoverer will discover schemas from events sent from another account.
- */
- CrossAccount?: __boolean;
- /**
- * Tags associated with the resource.
- */
- Tags?: Tags;
- }
- export interface ExportSchemaRequest {
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * The name of the schema.
- */
- SchemaName: __string;
- /**
- * Specifying this limits the results to only this schema version.
- */
- SchemaVersion?: __string;
- Type: __string;
- }
- export interface ExportSchemaResponse {
- Content?: __string;
- SchemaArn?: __string;
- SchemaName?: __string;
- SchemaVersion?: __string;
- Type?: __string;
- }
- export interface GetCodeBindingSourceRequest {
- /**
- * The language of the code binding.
- */
- Language: __string;
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * The name of the schema.
- */
- SchemaName: __string;
- /**
- * Specifying this limits the results to only this schema version.
- */
- SchemaVersion?: __string;
- }
- export interface GetCodeBindingSourceResponse {
- Body?: Body;
- }
- export interface GetDiscoveredSchemaRequest {
- /**
- * An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.
- */
- Events: __listOfGetDiscoveredSchemaVersionItemInput;
- /**
- * The type of event.
- */
- Type: Type;
- }
- export interface GetDiscoveredSchemaResponse {
- /**
- * The source of the schema definition.
- */
- Content?: __string;
- }
- export type GetDiscoveredSchemaVersionItemInput = string;
- export interface GetResourcePolicyRequest {
- /**
- * The name of the registry.
- */
- RegistryName?: __string;
- }
- export interface GetResourcePolicyResponse {
- /**
- * The resource-based policy.
- */
- Policy?: __string;
- /**
- * The revision ID.
- */
- RevisionId?: __string;
- }
- export interface ListDiscoverersRequest {
- /**
- * Specifying this limits the results to only those discoverer IDs that start with the specified prefix.
- */
- DiscovererIdPrefix?: __string;
- Limit?: __integer;
- /**
- * The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- */
- NextToken?: __string;
- /**
- * Specifying this limits the results to only those ARNs that start with the specified prefix.
- */
- SourceArnPrefix?: __string;
- }
- export interface ListDiscoverersResponse {
- /**
- * An array of DiscovererSummary information.
- */
- Discoverers?: __listOfDiscovererSummary;
- /**
- * The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- */
- NextToken?: __string;
- }
- export interface ListRegistriesRequest {
- Limit?: __integer;
- /**
- * The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- */
- NextToken?: __string;
- /**
- * Specifying this limits the results to only those registry names that start with the specified prefix.
- */
- RegistryNamePrefix?: __string;
- /**
- * Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.
- */
- Scope?: __string;
- }
- export interface ListRegistriesResponse {
- /**
- * The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- */
- NextToken?: __string;
- /**
- * An array of registry summaries.
- */
- Registries?: __listOfRegistrySummary;
- }
- export interface ListSchemaVersionsRequest {
- Limit?: __integer;
- /**
- * The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- */
- NextToken?: __string;
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * The name of the schema.
- */
- SchemaName: __string;
- }
- export interface ListSchemaVersionsResponse {
- /**
- * The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- */
- NextToken?: __string;
- /**
- * An array of schema version summaries.
- */
- SchemaVersions?: __listOfSchemaVersionSummary;
- }
- export interface ListSchemasRequest {
- Limit?: __integer;
- /**
- * The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- */
- NextToken?: __string;
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * Specifying this limits the results to only those schema names that start with the specified prefix.
- */
- SchemaNamePrefix?: __string;
- }
- export interface ListSchemasResponse {
- /**
- * The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- */
- NextToken?: __string;
- /**
- * An array of schema summaries.
- */
- Schemas?: __listOfSchemaSummary;
- }
- export interface ListTagsForResourceRequest {
- /**
- * The ARN of the resource.
- */
- ResourceArn: __string;
- }
- export interface ListTagsForResourceResponse {
- Tags?: Tags;
- }
- export interface PutCodeBindingRequest {
- /**
- * The language of the code binding.
- */
- Language: __string;
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * The name of the schema.
- */
- SchemaName: __string;
- /**
- * Specifying this limits the results to only this schema version.
- */
- SchemaVersion?: __string;
- }
- export interface PutCodeBindingResponse {
- /**
- * The time and date that the code binding was created.
- */
- CreationDate?: __timestampIso8601;
- /**
- * The date and time that code bindings were modified.
- */
- LastModified?: __timestampIso8601;
- /**
- * The version number of the schema.
- */
- SchemaVersion?: __string;
- /**
- * The current status of code binding generation.
- */
- Status?: CodeGenerationStatus;
- }
- export interface PutResourcePolicyRequest {
- /**
- * The resource-based policy.
- */
- Policy: __string;
- /**
- * The name of the registry.
- */
- RegistryName?: __string;
- /**
- * The revision ID of the policy.
- */
- RevisionId?: __string;
- }
- export interface PutResourcePolicyResponse {
- /**
- * The resource-based policy.
- */
- Policy?: __string;
- /**
- * The revision ID of the policy.
- */
- RevisionId?: __string;
- }
- export interface RegistrySummary {
- /**
- * The ARN of the registry.
- */
- RegistryArn?: __string;
- /**
- * The name of the registry.
- */
- RegistryName?: __string;
- /**
- * Tags associated with the registry.
- */
- Tags?: Tags;
- }
- export interface SchemaSummary {
- /**
- * The date and time that schema was modified.
- */
- LastModified?: __timestampIso8601;
- /**
- * The ARN of the schema.
- */
- SchemaArn?: __string;
- /**
- * The name of the schema.
- */
- SchemaName?: __string;
- /**
- * Tags associated with the schema.
- */
- Tags?: Tags;
- /**
- * The number of versions available for the schema.
- */
- VersionCount?: __long;
- }
- export interface SchemaVersionSummary {
- /**
- * The ARN of the schema version.
- */
- SchemaArn?: __string;
- /**
- * The name of the schema.
- */
- SchemaName?: __string;
- /**
- * The version number of the schema.
- */
- SchemaVersion?: __string;
- /**
- * The type of schema.
- */
- Type?: Type;
- }
- export interface SearchSchemaSummary {
- /**
- * The name of the registry.
- */
- RegistryName?: __string;
- /**
- * The ARN of the schema.
- */
- SchemaArn?: __string;
- /**
- * The name of the schema.
- */
- SchemaName?: __string;
- /**
- * An array of schema version summaries.
- */
- SchemaVersions?: __listOfSearchSchemaVersionSummary;
- }
- export interface SearchSchemaVersionSummary {
- /**
- * The date the schema version was created.
- */
- CreatedDate?: __timestampIso8601;
- /**
- * The version number of the schema
- */
- SchemaVersion?: __string;
- /**
- * The type of schema.
- */
- Type?: Type;
- }
- export interface SearchSchemasRequest {
- /**
- * Specifying this limits the results to only schemas that include the provided keywords.
- */
- Keywords: __string;
- Limit?: __integer;
- /**
- * The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- */
- NextToken?: __string;
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- }
- export interface SearchSchemasResponse {
- /**
- * The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- */
- NextToken?: __string;
- /**
- * An array of SearchSchemaSummary information.
- */
- Schemas?: __listOfSearchSchemaSummary;
- }
- export interface StartDiscovererRequest {
- /**
- * The ID of the discoverer.
- */
- DiscovererId: __string;
- }
- export interface StartDiscovererResponse {
- /**
- * The ID of the discoverer.
- */
- DiscovererId?: __string;
- /**
- * The state of the discoverer.
- */
- State?: DiscovererState;
- }
- export interface StopDiscovererRequest {
- /**
- * The ID of the discoverer.
- */
- DiscovererId: __string;
- }
- export interface StopDiscovererResponse {
- /**
- * The ID of the discoverer.
- */
- DiscovererId?: __string;
- /**
- * The state of the discoverer.
- */
- State?: DiscovererState;
- }
- export interface TagResourceRequest {
- /**
- * The ARN of the resource.
- */
- ResourceArn: __string;
- /**
- * Tags associated with the resource.
- */
- Tags: Tags;
- }
- export type Tags = {[key: string]: __string};
- export type Type = "OpenApi3"|"JSONSchemaDraft4"|string;
- export interface UntagResourceRequest {
- /**
- * The ARN of the resource.
- */
- ResourceArn: __string;
- /**
- * Keys of key-value pairs.
- */
- TagKeys: __listOf__string;
- }
- export interface UpdateDiscovererRequest {
- /**
- * The description of the discoverer to update.
- */
- Description?: __stringMin0Max256;
- /**
- * The ID of the discoverer.
- */
- DiscovererId: __string;
- /**
- * Support discovery of schemas in events sent to the bus from another account. (default: true)
- */
- CrossAccount?: __boolean;
- }
- export interface UpdateDiscovererResponse {
- /**
- * The description of the discoverer.
- */
- Description?: __string;
- /**
- * The ARN of the discoverer.
- */
- DiscovererArn?: __string;
- /**
- * The ID of the discoverer.
- */
- DiscovererId?: __string;
- /**
- * The ARN of the event bus.
- */
- SourceArn?: __string;
- /**
- * The state of the discoverer.
- */
- State?: DiscovererState;
- /**
- * The Status if the discoverer will discover schemas from events sent from another account.
- */
- CrossAccount?: __boolean;
- /**
- * Tags associated with the resource.
- */
- Tags?: Tags;
- }
- export interface UpdateRegistryRequest {
- /**
- * The description of the registry to update.
- */
- Description?: __stringMin0Max256;
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- }
- export interface UpdateRegistryResponse {
- /**
- * The description of the registry.
- */
- Description?: __string;
- /**
- * The ARN of the registry.
- */
- RegistryArn?: __string;
- /**
- * The name of the registry.
- */
- RegistryName?: __string;
- /**
- * Tags associated with the registry.
- */
- Tags?: Tags;
- }
- export interface UpdateSchemaRequest {
- /**
- * The ID of the client token.
- */
- ClientTokenId?: __stringMin0Max36;
- /**
- * The source of the schema definition.
- */
- Content?: __stringMin1Max100000;
- /**
- * The description of the schema.
- */
- Description?: __stringMin0Max256;
- /**
- * The name of the registry.
- */
- RegistryName: __string;
- /**
- * The name of the schema.
- */
- SchemaName: __string;
- /**
- * The schema type for the events schema.
- */
- Type?: Type;
- }
- export interface UpdateSchemaResponse {
- /**
- * The description of the schema.
- */
- Description?: __string;
- /**
- * The date and time that schema was modified.
- */
- LastModified?: __timestampIso8601;
- /**
- * The ARN of the schema.
- */
- SchemaArn?: __string;
- /**
- * The name of the schema.
- */
- SchemaName?: __string;
- /**
- * The version number of the schema
- */
- SchemaVersion?: __string;
- Tags?: Tags;
- /**
- * The type of the schema.
- */
- Type?: __string;
- /**
- * The date the schema version was created.
- */
- VersionCreatedDate?: __timestampIso8601;
- }
- export type __boolean = boolean;
- export type __integer = number;
- export type __listOfDiscovererSummary = DiscovererSummary[];
- export type __listOfGetDiscoveredSchemaVersionItemInput = GetDiscoveredSchemaVersionItemInput[];
- export type __listOfRegistrySummary = RegistrySummary[];
- export type __listOfSchemaSummary = SchemaSummary[];
- export type __listOfSchemaVersionSummary = SchemaVersionSummary[];
- export type __listOfSearchSchemaSummary = SearchSchemaSummary[];
- export type __listOfSearchSchemaVersionSummary = SearchSchemaVersionSummary[];
- export type __listOf__string = __string[];
- export type __long = number;
- export type __string = string;
- export type __stringMin0Max256 = string;
- export type __stringMin0Max36 = string;
- export type __stringMin1Max100000 = string;
- export type __stringMin20Max1600 = string;
- export type __timestampIso8601 = Date;
- export type Body = Buffer|Uint8Array|Blob|string;
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- export type apiVersion = "2019-12-02"|"latest"|string;
- export interface ClientApiVersions {
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- apiVersion?: apiVersion;
- }
- export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
- /**
- * Contains interfaces for use with the Schemas client.
- */
- export import Types = Schemas;
- }
- export = Schemas;
|