Class: AWS.IoTRoboRunner

var params = {
  countryCode: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
iotroborunner.createSite(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: {}) —
  • clientToken — (String)

    Token used for detecting replayed requests. Replayed requests will not be performed multiple times.

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

    Human friendly name of the resource.

  • countryCode — (String)

    A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.

  • description — (String)

    A high-level description of the site.

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:

    • arn — (String)

      Site ARN.

    • id — (String)

      Filters access by the site's identifier

    • createdAt — (Date)

      Timestamp at which the resource was created.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  fleet: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  additionalFixedProperties: 'STRING_VALUE',
  additionalTransientProperties: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  orientation: {
    degrees: 'NUMBER_VALUE'
  },
  position: {
    cartesianCoordinates: {
      x: 'NUMBER_VALUE', /* required */
      y: 'NUMBER_VALUE', /* required */
      z: 'NUMBER_VALUE'
    }
  },
  vendorProperties: {
    vendorWorkerId: 'STRING_VALUE', /* required */
    vendorAdditionalFixedProperties: 'STRING_VALUE',
    vendorAdditionalTransientProperties: 'STRING_VALUE',
    vendorWorkerIpAddress: 'STRING_VALUE'
  }
};
iotroborunner.createWorker(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: {}) —
  • clientToken — (String)

    Token used for detecting replayed requests. Replayed requests will not be performed multiple times.

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

    Human friendly name of the resource.

  • fleet — (String)

    Full ARN of the worker fleet.

  • additionalTransientProperties — (String)

    JSON blob containing unstructured worker properties that are transient and may change during regular operation.

  • additionalFixedProperties — (String)

    JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.

  • vendorProperties — (map)

    Properties of the worker that are provided by the vendor FMS.

    • vendorWorkerId — required — (String)

      The worker ID defined by the vendor FMS.

    • vendorWorkerIpAddress — (String)

      The worker IP address defined by the vendor FMS.

    • vendorAdditionalTransientProperties — (String)

      JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

    • vendorAdditionalFixedProperties — (String)

      JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

  • position — (map)

    Supported coordinates for worker position.

    • cartesianCoordinates — (map)

      Cartesian coordinates.

      • x — required — (Float)

        X coordinate.

      • y — required — (Float)

        Y coordinate.

      • z — (Float)

        Z coordinate.

  • orientation — (map)

    Worker orientation measured in units clockwise from north.

    • degrees — (Float)

      Degrees, limited on [0, 360)

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:

    • arn — (String)

      Full ARN of the worker.

    • id — (String)

      Filters access by the workers identifier

    • createdAt — (Date)

      Timestamp at which the resource was created.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

    • site — (String)

      Site ARN.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  site: 'STRING_VALUE', /* required */
  additionalFixedProperties: 'STRING_VALUE',
  clientToken: 'STRING_VALUE'
};
iotroborunner.createWorkerFleet(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: {}) —
  • clientToken — (String)

    Token used for detecting replayed requests. Replayed requests will not be performed multiple times.

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

    Human friendly name of the resource.

  • site — (String)

    Site ARN.

  • additionalFixedProperties — (String)

    JSON blob containing additional fixed properties regarding the worker fleet

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:

    • arn — (String)

      Full ARN of the worker fleet.

    • id — (String)

      Filters access by the worker fleet's identifier

    • createdAt — (Date)

      Timestamp at which the resource was created.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE' /* required */
};
iotroborunner.deleteDestination(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: {}) —
  • id — (String)

    Destination ARN.

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 = {
  id: 'STRING_VALUE' /* required */
};
iotroborunner.deleteSite(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: {}) —
  • id — (String)

    Site ARN.

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 = {
  id: 'STRING_VALUE' /* required */
};
iotroborunner.deleteWorker(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: {}) —
  • id — (String)

    Full ARN of the worker.

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 = {
  id: 'STRING_VALUE' /* required */
};
iotroborunner.deleteWorkerFleet(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: {}) —
  • id — (String)

    Full ARN of the worker fleet.

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 = {
  id: 'STRING_VALUE' /* required */
};
iotroborunner.getDestination(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: {}) —
  • id — (String)

    Destination ARN.

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:

    • arn — (String)

      Destination ARN.

    • id — (String)

      Filters access by the destination's identifier

    • name — (String)

      Human friendly name of the resource.

    • site — (String)

      Site ARN.

    • createdAt — (Date)

      Timestamp at which the resource was created.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

    • state — (String)

      State of the destination.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
      • "DECOMMISSIONED"
    • additionalFixedProperties — (String)

      JSON document containing additional fixed properties regarding the destination

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE' /* required */
};
iotroborunner.getSite(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: {}) —
  • id — (String)

    Site ARN.

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:

    • arn — (String)

      Site ARN.

    • id — (String)

      Filters access by the site's identifier

    • name — (String)

      Human friendly name of the resource.

    • countryCode — (String)

      A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.

    • description — (String)

      A high-level description of the site.

    • createdAt — (Date)

      Timestamp at which the resource was created.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE' /* required */
};
iotroborunner.getWorker(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: {}) —
  • id — (String)

    Full ARN of the worker.

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:

    • arn — (String)

      Full ARN of the worker.

    • id — (String)

      Filters access by the workers identifier

    • fleet — (String)

      Full ARN of the worker fleet.

    • site — (String)

      Site ARN.

    • createdAt — (Date)

      Timestamp at which the resource was created.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

    • name — (String)

      Human friendly name of the resource.

    • additionalTransientProperties — (String)

      JSON blob containing unstructured worker properties that are transient and may change during regular operation.

    • additionalFixedProperties — (String)

      JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.

    • vendorProperties — (map)

      Properties of the worker that are provided by the vendor FMS.

      • vendorWorkerId — required — (String)

        The worker ID defined by the vendor FMS.

      • vendorWorkerIpAddress — (String)

        The worker IP address defined by the vendor FMS.

      • vendorAdditionalTransientProperties — (String)

        JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

      • vendorAdditionalFixedProperties — (String)

        JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

    • position — (map)

      Supported coordinates for worker position.

      • cartesianCoordinates — (map)

        Cartesian coordinates.

        • x — required — (Float)

          X coordinate.

        • y — required — (Float)

          Y coordinate.

        • z — (Float)

          Z coordinate.

    • orientation — (map)

      Worker orientation measured in units clockwise from north.

      • degrees — (Float)

        Degrees, limited on [0, 360)

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE' /* required */
};
iotroborunner.getWorkerFleet(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: {}) —
  • id — (String)

    Full ARN of the worker fleet.

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:

    • id — (String)

      Filters access by the worker fleet's identifier

    • arn — (String)

      Full ARN of the worker fleet.

    • name — (String)

      Human friendly name of the resource.

    • site — (String)

      Site ARN.

    • createdAt — (Date)

      Timestamp at which the resource was created.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

    • additionalFixedProperties — (String)

      JSON blob containing additional fixed properties regarding the worker fleet

Returns:

• (AWS.Request) —

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

var params = {
  site: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  state: ENABLED | DISABLED | DECOMMISSIONED
};
iotroborunner.listDestinations(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: {}) —
  • site — (String)

    Site ARN.

  • maxResults — (Integer)

    Maximum number of results to retrieve in a single call.

  • nextToken — (String)

    Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

  • state — (String)

    State of the destination.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
    • "DECOMMISSIONED"

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)

      Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

    • destinations — (Array<map>)

      List of destinations.

      • arn — required — (String)

        Destination ARN.

      • id — required — (String)

        Filters access by the destination's identifier

      • name — required — (String)

        Human friendly name of the resource.

      • site — required — (String)

        Site ARN.

      • createdAt — required — (Date)

        Timestamp at which the resource was created.

      • updatedAt — required — (Date)

        Timestamp at which the resource was last updated.

      • state — required — (String)

        State of the destination.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
        • "DECOMMISSIONED"
      • additionalFixedProperties — (String)

        JSON document containing additional fixed properties regarding the destination

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotroborunner.listSites(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: {}) —
  • maxResults — (Integer)

    Maximum number of results to retrieve in a single ListSites call.

  • nextToken — (String)

    Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

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)

      Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

    • sites — (Array<map>)

      List of facilities.

      • arn — required — (String)

        Site ARN.

      • name — required — (String)

        The name of the site. Mutable after creation and unique within a given account.

      • countryCode — required — (String)

        A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.

      • createdAt — required — (Date)

        Timestamp at which the resource was created.

Returns:

• (AWS.Request) —

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

var params = {
  site: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotroborunner.listWorkerFleets(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: {}) —
  • site — (String)

    Site ARN.

  • maxResults — (Integer)

    Maximum number of results to retrieve in a single ListWorkerFleets call.

  • nextToken — (String)

    Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

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)

      Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

    • workerFleets — (Array<map>)

      List of worker fleets.

      • arn — required — (String)

        Full ARN of the worker fleet.

      • id — required — (String)

        Filters access by the worker fleet's identifier

      • name — required — (String)

        Human friendly name of the resource.

      • site — required — (String)

        Site ARN.

      • createdAt — required — (Date)

        Timestamp at which the resource was created.

      • updatedAt — required — (Date)

        Timestamp at which the resource was last updated.

      • additionalFixedProperties — (String)

        JSON blob containing additional fixed properties regarding the worker fleet

Returns:

• (AWS.Request) —

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

var params = {
  site: 'STRING_VALUE', /* required */
  fleet: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotroborunner.listWorkers(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: {}) —
  • site — (String)

    Site ARN.

  • maxResults — (Integer)

    Maximum number of results to retrieve in a single ListWorkers call.

  • nextToken — (String)

    Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

  • fleet — (String)

    Full ARN of the worker fleet.

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)

      Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

    • workers — (Array<map>)

      List of workers.

      • arn — required — (String)

        Full ARN of the worker.

      • id — required — (String)

        Filters access by the workers identifier

      • fleet — required — (String)

        Full ARN of the worker fleet.

      • createdAt — required — (Date)

        Timestamp at which the resource was created.

      • updatedAt — required — (Date)

        Timestamp at which the resource was last updated.

      • name — required — (String)

        Human friendly name of the resource.

      • site — required — (String)

        Site ARN.

      • additionalTransientProperties — (String)

        JSON blob containing unstructured worker properties that are transient and may change during regular operation.

      • additionalFixedProperties — (String)

        JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.

      • vendorProperties — (map)

        Properties of the worker that are provided by the vendor FMS.

        • vendorWorkerId — required — (String)

          The worker ID defined by the vendor FMS.

        • vendorWorkerIpAddress — (String)

          The worker IP address defined by the vendor FMS.

        • vendorAdditionalTransientProperties — (String)

          JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

        • vendorAdditionalFixedProperties — (String)

          JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

      • position — (map)

        Supported coordinates for worker position.

        • cartesianCoordinates — (map)

          Cartesian coordinates.

          • x — required — (Float)

            X coordinate.

          • y — required — (Float)

            Y coordinate.

          • z — (Float)

            Z coordinate.

      • orientation — (map)

        Worker orientation measured in units clockwise from north.

        • degrees — (Float)

          Degrees, limited on [0, 360)

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE', /* required */
  additionalFixedProperties: 'STRING_VALUE',
  name: 'STRING_VALUE',
  state: ENABLED | DISABLED | DECOMMISSIONED
};
iotroborunner.updateDestination(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: {}) —
  • id — (String)

    Destination ARN.

  • name — (String)

    Human friendly name of the resource.

  • state — (String)

    State of the destination.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
    • "DECOMMISSIONED"
  • additionalFixedProperties — (String)

    JSON document containing additional fixed properties regarding the destination

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:

    • arn — (String)

      Destination ARN.

    • id — (String)

      Filters access by the destination's identifier

    • name — (String)

      Human friendly name of the resource.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

    • state — (String)

      State of the destination.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
      • "DECOMMISSIONED"
    • additionalFixedProperties — (String)

      JSON document containing additional fixed properties regarding the destination

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE', /* required */
  countryCode: 'STRING_VALUE',
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
iotroborunner.updateSite(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: {}) —
  • id — (String)

    Site ARN.

  • name — (String)

    Human friendly name of the resource.

  • countryCode — (String)

    A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.

  • description — (String)

    A high-level description of the site.

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:

    • arn — (String)

      Site ARN.

    • id — (String)

      Filters access by the site's identifier

    • name — (String)

      Human friendly name of the resource.

    • countryCode — (String)

      A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.

    • description — (String)

      A high-level description of the site.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE', /* required */
  additionalFixedProperties: 'STRING_VALUE',
  additionalTransientProperties: 'STRING_VALUE',
  name: 'STRING_VALUE',
  orientation: {
    degrees: 'NUMBER_VALUE'
  },
  position: {
    cartesianCoordinates: {
      x: 'NUMBER_VALUE', /* required */
      y: 'NUMBER_VALUE', /* required */
      z: 'NUMBER_VALUE'
    }
  },
  vendorProperties: {
    vendorWorkerId: 'STRING_VALUE', /* required */
    vendorAdditionalFixedProperties: 'STRING_VALUE',
    vendorAdditionalTransientProperties: 'STRING_VALUE',
    vendorWorkerIpAddress: 'STRING_VALUE'
  }
};
iotroborunner.updateWorker(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: {}) —
  • id — (String)

    Full ARN of the worker.

  • name — (String)

    Human friendly name of the resource.

  • additionalTransientProperties — (String)

    JSON blob containing unstructured worker properties that are transient and may change during regular operation.

  • additionalFixedProperties — (String)

    JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.

  • vendorProperties — (map)

    Properties of the worker that are provided by the vendor FMS.

    • vendorWorkerId — required — (String)

      The worker ID defined by the vendor FMS.

    • vendorWorkerIpAddress — (String)

      The worker IP address defined by the vendor FMS.

    • vendorAdditionalTransientProperties — (String)

      JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

    • vendorAdditionalFixedProperties — (String)

      JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

  • position — (map)

    Supported coordinates for worker position.

    • cartesianCoordinates — (map)

      Cartesian coordinates.

      • x — required — (Float)

        X coordinate.

      • y — required — (Float)

        Y coordinate.

      • z — (Float)

        Z coordinate.

  • orientation — (map)

    Worker orientation measured in units clockwise from north.

    • degrees — (Float)

      Degrees, limited on [0, 360)

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:

    • arn — (String)

      Full ARN of the worker.

    • id — (String)

      Filters access by the workers identifier

    • fleet — (String)

      Full ARN of the worker fleet.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

    • name — (String)

      Human friendly name of the resource.

    • additionalTransientProperties — (String)

      JSON blob containing unstructured worker properties that are transient and may change during regular operation.

    • additionalFixedProperties — (String)

      JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.

    • orientation — (map)

      Worker orientation measured in units clockwise from north.

      • degrees — (Float)

        Degrees, limited on [0, 360)

    • vendorProperties — (map)

      Properties of the worker that are provided by the vendor FMS.

      • vendorWorkerId — required — (String)

        The worker ID defined by the vendor FMS.

      • vendorWorkerIpAddress — (String)

        The worker IP address defined by the vendor FMS.

      • vendorAdditionalTransientProperties — (String)

        JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

      • vendorAdditionalFixedProperties — (String)

        JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

    • position — (map)

      Supported coordinates for worker position.

      • cartesianCoordinates — (map)

        Cartesian coordinates.

        • x — required — (Float)

          X coordinate.

        • y — required — (Float)

          Y coordinate.

        • z — (Float)

          Z coordinate.

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE', /* required */
  additionalFixedProperties: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
iotroborunner.updateWorkerFleet(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: {}) —
  • id — (String)

    Full ARN of the worker fleet.

  • name — (String)

    Human friendly name of the resource.

  • additionalFixedProperties — (String)

    JSON blob containing additional fixed properties regarding the worker fleet

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:

    • arn — (String)

      Full ARN of the worker fleet.

    • id — (String)

      Filters access by the worker fleet's identifier

    • name — (String)

      Human friendly name of the resource.

    • updatedAt — (Date)

      Timestamp at which the resource was last updated.

    • additionalFixedProperties — (String)

      JSON blob containing additional fixed properties regarding the worker fleet

Returns:

• (AWS.Request) —

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