AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.Schemas

Inherits:
AWS.Service show all
Identifier:
schemas
API Version:
2019-12-02
Defined in:
(unknown)

Overview

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

Service Description

AWS EventBridge Schemas

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

Version:

  • 2019-12-02

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 Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a Schemas object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Schemas.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Schemas.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Schemas.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates a discoverer.

Service Reference:

Examples:

Calling the createDiscoverer operation

var params = {
  SourceArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
schemas.createDiscoverer(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 for the discoverer.

    • SourceArn — (String)

      The ARN of the event bus.

    • 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. 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"
      • Tags — (map<String>)

        Tags associated with the resource.

Returns:

  • (AWS.Request)

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

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

Creates a registry.

Service Reference:

Examples:

Calling the createRegistry operation

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

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

Creates a schema definition.

Service Reference:

Examples:

Calling the createSchema operation

var params = {
  Content: 'STRING_VALUE', /* required */
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  Type: OpenApi3, /* 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)
    • Description — (String)

      A description of the schema.

    • RegistryName — (String)
    • SchemaName — (String)
    • Tags — (map<String>)

      Tags associated with the schema.

    • Type — (String) Possible values include:
      • "OpenApi3"

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.

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

Deletes a discoverer.

Service Reference:

Examples:

Calling the deleteDiscoverer operation

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)

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.

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

Deletes a Registry.

Service Reference:

Examples:

Calling the deleteRegistry operation

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)

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.

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

Delete a schema definition.

Service Reference:

Examples:

Calling the deleteSchema operation

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)
    • SchemaName — (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.

Returns:

  • (AWS.Request)

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

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

Delete the schema version definition

Service Reference:

Examples:

Calling the deleteSchemaVersion operation

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)
    • SchemaName — (String)
    • SchemaVersion — (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.

Returns:

  • (AWS.Request)

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

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

Describe the code binding URI.

Service Reference:

Examples:

Calling the describeCodeBinding operation

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)
    • RegistryName — (String)
    • SchemaName — (String)
    • SchemaVersion — (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:

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

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

Describes the discoverer.

Service Reference:

Examples:

Calling the describeDiscoverer operation

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)

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"
      • Tags — (map<String>)

        Tags associated with the resource.

Returns:

  • (AWS.Request)

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

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

Describes the registry.

Service Reference:

Examples:

Calling the describeRegistry operation

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)

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.

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

Retrieve the schema definition.

Service Reference:

Examples:

Calling the describeSchema operation

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)
    • SchemaName — (String)
    • SchemaVersion — (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)
      • 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.

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

Get the code binding source URI.

Service Reference:

Examples:

Calling the getCodeBindingSource operation

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)
    • RegistryName — (String)
    • SchemaName — (String)
    • SchemaVersion — (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:

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

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the getDiscoveredSchema operation

var params = {
  Events: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Type: OpenApi3 /* 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 that

    • Type — (String)

      The type of event.

      Possible values include:
      • "OpenApi3"

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)

Returns:

  • (AWS.Request)

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

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

List the discoverers.

Service Reference:

Examples:

Calling the listDiscoverers operation

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)
    • Limit — (Integer)
    • NextToken — (String)
    • SourceArnPrefix — (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:

      • 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) Possible values include:
          • "STARTED"
          • "STOPPED"
        • 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.

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

List the registries.

Service Reference:

Examples:

Calling the listRegistries operation

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)
    • RegistryNamePrefix — (String)
    • Scope — (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:

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

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

List the schemas.

Service Reference:

Examples:

Calling the listSchemas operation

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)
    • RegistryName — (String)
    • SchemaNamePrefix — (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:

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

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

Provides a list of the schema versions and related information.

Service Reference:

Examples:

Calling the listSchemaVersions operation

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)
    • RegistryName — (String)
    • SchemaName — (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:

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

Returns:

  • (AWS.Request)

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

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

Get tags for resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

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)

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.

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

Calls the LockServiceLinkedRole API operation.

Service Reference:

Examples:

Calling the lockServiceLinkedRole operation

var params = {
  RoleArn: 'STRING_VALUE', /* required */
  Timeout: 'NUMBER_VALUE' /* required */
};
schemas.lockServiceLinkedRole(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: {})
    • RoleArn — (String)
    • Timeout — (Integer)

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:

      • CanBeDeleted — (Boolean)
      • ReasonOfFailure — (String)
      • RelatedResources — (Array<map>)
        • DiscovererArn — (String)

          The ARN of the discoverer.

        • DiscovererId — (String)

          The ID of the discoverer.

        • SourceArn — (String)

          The ARN of the event bus.

        • State — (String) Possible values include:
          • "STARTED"
          • "STOPPED"
        • Tags — (map<String>)

          Tags associated with the resource.

Returns:

  • (AWS.Request)

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

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

Put code binding URI

Service Reference:

Examples:

Calling the putCodeBinding operation

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)
    • RegistryName — (String)
    • SchemaName — (String)
    • SchemaVersion — (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:

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

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

Search the schemas

Service Reference:

Examples:

Calling the searchSchemas operation

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)
    • Limit — (Integer)
    • NextToken — (String)
    • RegistryName — (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:

      • 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)
          • SchemaVersion — (String)

            The version number of the schema

Returns:

  • (AWS.Request)

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

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

Starts the discoverer

Service Reference:

Examples:

Calling the startDiscoverer operation

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)

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.

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

Stops the discoverer

Service Reference:

Examples:

Calling the stopDiscoverer operation

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)

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.

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

Add tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

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)
    • Tags — (map<String>)

      Key-value pairs associated with a 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.

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

Calls the UnlockServiceLinkedRole API operation.

Service Reference:

Examples:

Calling the unlockServiceLinkedRole operation

var params = {
  RoleArn: 'STRING_VALUE' /* required */
};
schemas.unlockServiceLinkedRole(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: {})
    • RoleArn — (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.

Returns:

  • (AWS.Request)

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

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

Removes tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

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)
    • TagKeys — (Array<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.

Returns:

  • (AWS.Request)

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

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

Updates the discoverer

Service Reference:

Examples:

Calling the updateDiscoverer operation

var params = {
  DiscovererId: 'STRING_VALUE', /* required */
  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)

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"
      • Tags — (map<String>)

        Tags associated with the resource.

Returns:

  • (AWS.Request)

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

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

Updates a registry.

Service Reference:

Examples:

Calling the updateRegistry operation

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)

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.

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

Updates the schema definition

Service Reference:

Examples:

Calling the updateSchema operation

var params = {
  RegistryName: 'STRING_VALUE', /* required */
  SchemaName: 'STRING_VALUE', /* required */
  ClientTokenId: 'STRING_VALUE',
  Content: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Type: OpenApi3
};
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)
    • SchemaName — (String)
    • Type — (String)

      The schema type for the events schema.

      Possible values include:
      • "OpenApi3"

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.

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.

Examples:

Waiting for the codeBindingExists state

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:

Waiter Resource Details

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

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

Examples:

Waiting for the codeBindingExists state

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:

  • params (Object)
    • Language — (String)
    • RegistryName — (String)
    • SchemaName — (String)
    • SchemaVersion — (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:

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

See Also: