AWS.Schemas — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Schemas

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon EventBridge Schema Registry

Sending a Request Using Schemas

var schemas = new AWS.Schemas();
schemas.createDiscoverer(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Schemas object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var schemas = new AWS.Schemas({apiVersion: '2019-12-02'});

You can also set the API version globally in AWS.config.apiVersions using the schemas service identifier:

AWS.config.apiVersions = {
  schemas: '2019-12-02',
  // other service API versions
};

var schemas = new AWS.Schemas();

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

codeBindingExists

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.Schemas(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createDiscoverer(params = {}, callback) ⇒ AWS.Request

createRegistry(params = {}, callback) ⇒ AWS.Request

createSchema(params = {}, callback) ⇒ AWS.Request

Creates a schema definition.

Note: Inactive schemas will be deleted after two years.

deleteDiscoverer(params = {}, callback) ⇒ AWS.Request

deleteRegistry(params = {}, callback) ⇒ AWS.Request

deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request

Delete the resource-based policy attached to the specified registry.

deleteSchema(params = {}, callback) ⇒ AWS.Request

Delete a schema definition.

deleteSchemaVersion(params = {}, callback) ⇒ AWS.Request

Delete the schema version definition

describeCodeBinding(params = {}, callback) ⇒ AWS.Request

Describe the code binding URI.

describeDiscoverer(params = {}, callback) ⇒ AWS.Request

Describes the discoverer.

describeRegistry(params = {}, callback) ⇒ AWS.Request

describeSchema(params = {}, callback) ⇒ AWS.Request

Retrieve the schema definition.

exportSchema(params = {}, callback) ⇒ AWS.Request

Calls the ExportSchema API operation.

getCodeBindingSource(params = {}, callback) ⇒ AWS.Request

Get the code binding source URI.

getDiscoveredSchema(params = {}, callback) ⇒ AWS.Request

Get the discovered schema that was generated based on sampled events.

getResourcePolicy(params = {}, callback) ⇒ AWS.Request

Retrieves the resource-based policy attached to a given registry.

listDiscoverers(params = {}, callback) ⇒ AWS.Request

listRegistries(params = {}, callback) ⇒ AWS.Request

listSchemaVersions(params = {}, callback) ⇒ AWS.Request

Provides a list of the schema versions and related information.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

putCodeBinding(params = {}, callback) ⇒ AWS.Request

putResourcePolicy(params = {}, callback) ⇒ AWS.Request

searchSchemas(params = {}, callback) ⇒ AWS.Request

startDiscoverer(params = {}, callback) ⇒ AWS.Request

stopDiscoverer(params = {}, callback) ⇒ AWS.Request

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a resource.

updateDiscoverer(params = {}, callback) ⇒ AWS.Request

updateRegistry(params = {}, callback) ⇒ AWS.Request

updateSchema(params = {}, callback) ⇒ AWS.Request

Updates the schema definition

Note: Inactive schemas will be deleted after two years.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Schemas resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Waiter Resource Details

schemas.waitFor('codeBindingExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the codeBindingExists state by periodically calling the underlyingSchemas.describeCodeBinding() operation every 2 seconds (at most 30 times).