Class: AWS.Schemas

var params = {
  RegistryName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
schemas.createRegistry(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Description — (String)

    A description of the registry to be created.

  • RegistryName — (String)

    The name of the registry.

  • Tags — (map<String>)

    Tags to associate with the registry.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Description — (String)

      The description of the registry.

    • RegistryArn — (String)

      The ARN of the registry.

    • RegistryName — (String)

      The name of the registry.

    • Tags — (map<String>)

      Tags associated with the registry.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Content: 'STRING_VALUE', /* required */
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  Type: OpenApi3 | JSONSchemaDraft4, /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
schemas.createSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Content — (String)

    The source of the schema definition.

  • Description — (String)

    A description of the schema.

  • RegistryName — (String)

    The name of the registry.

  • SchemaName — (String)

    The name of the schema.

  • Tags — (map<String>)

    Tags associated with the schema.

  • Type — (String)

    The type of schema.

    Possible values include:
    • "OpenApi3"
    • "JSONSchemaDraft4"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Description — (String)

      The description of the schema.

    • LastModified — (Date)

      The date and time that schema was modified.

    • SchemaArn — (String)

      The ARN of the schema.

    • SchemaName — (String)

      The name of the schema.

    • SchemaVersion — (String)

      The version number of the schema

    • Tags — (map<String>)

      Key-value pairs associated with a resource.

    • Type — (String)

      The type of the schema.

    • VersionCreatedDate — (Date)

      The date the schema version was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DiscovererId: 'STRING_VALUE' /* required */
};
schemas.deleteDiscoverer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DiscovererId — (String)

    The ID of the discoverer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE' /* required */
};
schemas.deleteRegistry(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RegistryName — (String)

    The name of the registry.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE'
};
schemas.deleteResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RegistryName — (String)

    The name of the registry.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE' /* required */
};
schemas.deleteSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RegistryName — (String)

    The name of the registry.

  • SchemaName — (String)

    The name of the schema.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  SchemaVersion: 'STRING_VALUE' /* required */
};
schemas.deleteSchemaVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RegistryName — (String)

    The name of the registry.

  • SchemaName — (String)

    The name of the schema.

  • SchemaVersion — (String) The version number of the schema

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Language: 'STRING_VALUE', /* required */
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  SchemaVersion: 'STRING_VALUE'
};
schemas.describeCodeBinding(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Language — (String)

    The language of the code binding.

  • RegistryName — (String)

    The name of the registry.

  • SchemaName — (String)

    The name of the schema.

  • SchemaVersion — (String)

    Specifying this limits the results to only this schema version.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CreationDate — (Date)

      The time and date that the code binding was created.

    • LastModified — (Date)

      The date and time that code bindings were modified.

    • SchemaVersion — (String)

      The version number of the schema.

    • Status — (String)

      The current status of code binding generation.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "CREATE_COMPLETE"
      • "CREATE_FAILED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• codeBindingExists

var params = {
  DiscovererId: 'STRING_VALUE' /* required */
};
schemas.describeDiscoverer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DiscovererId — (String)

    The ID of the discoverer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Description — (String)

      The description of the discoverer.

    • DiscovererArn — (String)

      The ARN of the discoverer.

    • DiscovererId — (String)

      The ID of the discoverer.

    • SourceArn — (String)

      The ARN of the event bus.

    • State — (String)

      The state of the discoverer.

      Possible values include:
      • "STARTED"
      • "STOPPED"
    • CrossAccount — (Boolean)

      The Status if the discoverer will discover schemas from events sent from another account.

    • Tags — (map<String>)

      Tags associated with the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE' /* required */
};
schemas.describeRegistry(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RegistryName — (String)

    The name of the registry.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Description — (String)

      The description of the registry.

    • RegistryArn — (String)

      The ARN of the registry.

    • RegistryName — (String)

      The name of the registry.

    • Tags — (map<String>)

      Tags associated with the registry.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  SchemaVersion: 'STRING_VALUE'
};
schemas.describeSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RegistryName — (String)

    The name of the registry.

  • SchemaName — (String)

    The name of the schema.

  • SchemaVersion — (String)

    Specifying this limits the results to only this schema version.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Content — (String)

      The source of the schema definition.

    • Description — (String)

      The description of the schema.

    • LastModified — (Date)

      The date and time that schema was modified.

    • SchemaArn — (String)

      The ARN of the schema.

    • SchemaName — (String)

      The name of the schema.

    • SchemaVersion — (String)

      The version number of the schema

    • Tags — (map<String>)

      Tags associated with the resource.

    • Type — (String)

      The type of the schema.

    • VersionCreatedDate — (Date)

      The date the schema version was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  Type: 'STRING_VALUE', /* required */
  SchemaVersion: 'STRING_VALUE'
};
schemas.exportSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RegistryName — (String)

    The name of the registry.

  • SchemaName — (String)

    The name of the schema.

  • SchemaVersion — (String)

    Specifying this limits the results to only this schema version.

  • Type — (String)

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Content — (String)
    • SchemaArn — (String)
    • SchemaName — (String)
    • SchemaVersion — (String)
    • Type — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Language: 'STRING_VALUE', /* required */
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  SchemaVersion: 'STRING_VALUE'
};
schemas.getCodeBindingSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Language — (String)

    The language of the code binding.

  • RegistryName — (String)

    The name of the registry.

  • SchemaName — (String)

    The name of the schema.

  • SchemaVersion — (String)

    Specifying this limits the results to only this schema version.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Body — (Buffer(Node.js), Typed Array(Browser))

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Events: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Type: OpenApi3 | JSONSchemaDraft4 /* required */
};
schemas.getDiscoveredSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Events — (Array<String>)

    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.

  • Type — (String)

    The type of event.

    Possible values include:
    • "OpenApi3"
    • "JSONSchemaDraft4"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Content — (String)

      The source of the schema definition.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE'
};
schemas.getResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RegistryName — (String)

    The name of the registry.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Policy — (String)

      The resource-based policy.

    • RevisionId — (String)

      The revision ID.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DiscovererIdPrefix: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SourceArnPrefix: 'STRING_VALUE'
};
schemas.listDiscoverers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DiscovererIdPrefix — (String)

    Specifying this limits the results to only those discoverer IDs that start with the specified prefix.

  • Limit — (Integer)
  • NextToken — (String)

    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.

  • SourceArnPrefix — (String)

    Specifying this limits the results to only those ARNs that start with the specified prefix.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Discoverers — (Array<map>)

      An array of DiscovererSummary information.

      • DiscovererArn — (String)

        The ARN of the discoverer.

      • DiscovererId — (String)

        The ID of the discoverer.

      • SourceArn — (String)

        The ARN of the event bus.

      • State — (String)

        The state of the discoverer.

        Possible values include:
        • "STARTED"
        • "STOPPED"
      • CrossAccount — (Boolean)

        The Status if the discoverer will discover schemas from events sent from another account.

      • Tags — (map<String>)

        Tags associated with the resource.

    • NextToken — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RegistryNamePrefix: 'STRING_VALUE',
  Scope: 'STRING_VALUE'
};
schemas.listRegistries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Limit — (Integer)
  • NextToken — (String)

    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.

  • RegistryNamePrefix — (String)

    Specifying this limits the results to only those registry names that start with the specified prefix.

  • Scope — (String)

    Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      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.

    • Registries — (Array<map>)

      An array of registry summaries.

      • RegistryArn — (String)

        The ARN of the registry.

      • RegistryName — (String)

        The name of the registry.

      • Tags — (map<String>)

        Tags associated with the registry.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SchemaNamePrefix: 'STRING_VALUE'
};
schemas.listSchemas(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Limit — (Integer)
  • NextToken — (String)

    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.

  • RegistryName — (String)

    The name of the registry.

  • SchemaNamePrefix — (String)

    Specifying this limits the results to only those schema names that start with the specified prefix.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      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.

    • Schemas — (Array<map>)

      An array of schema summaries.

      • LastModified — (Date)

        The date and time that schema was modified.

      • SchemaArn — (String)

        The ARN of the schema.

      • SchemaName — (String)

        The name of the schema.

      • Tags — (map<String>)

        Tags associated with the schema.

      • VersionCount — (Integer)

        The number of versions available for the schema.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
schemas.listSchemaVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Limit — (Integer)
  • NextToken — (String)

    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.

  • RegistryName — (String)

    The name of the registry.

  • SchemaName — (String)

    The name of the schema.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      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.

    • SchemaVersions — (Array<map>)

      An array of schema version summaries.

      • SchemaArn — (String)

        The ARN of the schema version.

      • SchemaName — (String)

        The name of the schema.

      • SchemaVersion — (String)

        The version number of the schema.

      • Type — (String)

        The type of schema.

        Possible values include:
        • "OpenApi3"
        • "JSONSchemaDraft4"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
schemas.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The ARN of the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (map<String>)

      Key-value pairs associated with a resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Language: 'STRING_VALUE', /* required */
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  SchemaVersion: 'STRING_VALUE'
};
schemas.putCodeBinding(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Language — (String)

    The language of the code binding.

  • RegistryName — (String)

    The name of the registry.

  • SchemaName — (String)

    The name of the schema.

  • SchemaVersion — (String)

    Specifying this limits the results to only this schema version.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CreationDate — (Date)

      The time and date that the code binding was created.

    • LastModified — (Date)

      The date and time that code bindings were modified.

    • SchemaVersion — (String)

      The version number of the schema.

    • Status — (String)

      The current status of code binding generation.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "CREATE_COMPLETE"
      • "CREATE_FAILED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Policy: any /* This value will be JSON encoded on your behalf with JSON.stringify() */, /* required */
  RegistryName: 'STRING_VALUE',
  RevisionId: 'STRING_VALUE'
};
schemas.putResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Policy — (String)

    The resource-based policy.

  • RegistryName — (String)

    The name of the registry.

  • RevisionId — (String)

    The revision ID of the policy.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Policy — (String)

      The resource-based policy.

    • RevisionId — (String)

      The revision ID of the policy.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Keywords: 'STRING_VALUE', /* required */
  RegistryName: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
schemas.searchSchemas(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Keywords — (String)

    Specifying this limits the results to only schemas that include the provided keywords.

  • Limit — (Integer)
  • NextToken — (String)

    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.

  • RegistryName — (String)

    The name of the registry.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      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.

    • Schemas — (Array<map>)

      An array of SearchSchemaSummary information.

      • RegistryName — (String)

        The name of the registry.

      • SchemaArn — (String)

        The ARN of the schema.

      • SchemaName — (String)

        The name of the schema.

      • SchemaVersions — (Array<map>)

        An array of schema version summaries.

        • CreatedDate — (Date)

          The date the schema version was created.

        • SchemaVersion — (String)

          The version number of the schema

        • Type — (String)

          The type of schema.

          Possible values include:
          • "OpenApi3"
          • "JSONSchemaDraft4"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DiscovererId: 'STRING_VALUE' /* required */
};
schemas.startDiscoverer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DiscovererId — (String)

    The ID of the discoverer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DiscovererId — (String)

      The ID of the discoverer.

    • State — (String)

      The state of the discoverer.

      Possible values include:
      • "STARTED"
      • "STOPPED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DiscovererId: 'STRING_VALUE' /* required */
};
schemas.stopDiscoverer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DiscovererId — (String)

    The ID of the discoverer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DiscovererId — (String)

      The ID of the discoverer.

    • State — (String)

      The state of the discoverer.

      Possible values include:
      • "STARTED"
      • "STOPPED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
schemas.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The ARN of the resource.

  • Tags — (map<String>)

    Tags associated with the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
schemas.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The ARN of the resource.

  • TagKeys — (Array<String>)

    Keys of key-value pairs.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DiscovererId: 'STRING_VALUE', /* required */
  CrossAccount: true || false,
  Description: 'STRING_VALUE'
};
schemas.updateDiscoverer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Description — (String)

    The description of the discoverer to update.

  • DiscovererId — (String)

    The ID of the discoverer.

  • CrossAccount — (Boolean)

    Support discovery of schemas in events sent to the bus from another account. (default: true)

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Description — (String)

      The description of the discoverer.

    • DiscovererArn — (String)

      The ARN of the discoverer.

    • DiscovererId — (String)

      The ID of the discoverer.

    • SourceArn — (String)

      The ARN of the event bus.

    • State — (String)

      The state of the discoverer.

      Possible values include:
      • "STARTED"
      • "STOPPED"
    • CrossAccount — (Boolean)

      The Status if the discoverer will discover schemas from events sent from another account.

    • Tags — (map<String>)

      Tags associated with the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
schemas.updateRegistry(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Description — (String)

    The description of the registry to update.

  • RegistryName — (String)

    The name of the registry.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Description — (String)

      The description of the registry.

    • RegistryArn — (String)

      The ARN of the registry.

    • RegistryName — (String)

      The name of the registry.

    • Tags — (map<String>)

      Tags associated with the registry.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  ClientTokenId: 'STRING_VALUE',
  Content: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Type: OpenApi3 | JSONSchemaDraft4
};
schemas.updateSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientTokenId — (String)

    The ID of the client token.

    If a token is not provided, the SDK will use a version 4 UUID.
  • Content — (String)

    The source of the schema definition.

  • Description — (String)

    The description of the schema.

  • RegistryName — (String)

    The name of the registry.

  • SchemaName — (String)

    The name of the schema.

  • Type — (String)

    The schema type for the events schema.

    Possible values include:
    • "OpenApi3"
    • "JSONSchemaDraft4"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Description — (String)

      The description of the schema.

    • LastModified — (Date)

      The date and time that schema was modified.

    • SchemaArn — (String)

      The ARN of the schema.

    • SchemaName — (String)

      The name of the schema.

    • SchemaVersion — (String)

      The version number of the schema

    • Tags — (map<String>)

      Key-value pairs associated with a resource.

    • Type — (String)

      The type of the schema.

    • VersionCreatedDate — (Date)

      The date the schema version was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Language: 'STRING_VALUE', /* required */
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
};
schemas.waitFor('codeBindingExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• codeBindingExists