Class: AWS.IoTFleetHub

var params = {
  applicationId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
iotfleethub.deleteApplication(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: {}) —
  • applicationId — (String)

    The unique Id of the web application.

  • clientToken — (String)

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    If a token is not provided, the SDK will use a version 4 UUID.

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

    The unique Id of the web application.

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:

    • applicationId — (String)

      The unique Id of the web application.

    • applicationArn — (String)

      The ARN of the web application.

    • applicationName — (String)

      The name of the web application.

    • applicationDescription — (String)

      An optional description of the web application.

    • applicationUrl — (String)

      The URL of the web application.

    • applicationState — (String)

      The current state of the web application.

      Possible values include:
      • "CREATING"
      • "DELETING"
      • "ACTIVE"
      • "CREATE_FAILED"
      • "DELETE_FAILED"
    • applicationCreationDate — (Integer)

      The date (in Unix epoch time) when the application was created.

    • applicationLastUpdateDate — (Integer)

      The date (in Unix epoch time) when the application was last updated.

    • roleArn — (String)

      The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.

    • ssoClientId — (String)

      The Id of the single sign-on client that you use to authenticate and authorize users on the web application.

    • errorMessage — (String)

      A message that explains any failures included in the applicationState response field. This message explains failures in the CreateApplication and DeleteApplication actions.

    • tags — (map<String>)

      A set of key/value pairs that you can use to manage the web application resource.

Returns:

• (AWS.Request) —

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

var params = {
  nextToken: 'STRING_VALUE'
};
iotfleethub.listApplications(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: {}) —
  • nextToken — (String)

    A token used to get the next set of results.

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:

    • applicationSummaries — (Array<map>)

      An array of objects that provide summaries of information about the web applications in the list.

      • applicationId — required — (String)

        The unique Id of the web application.

      • applicationName — required — (String)

        The name of the web application.

      • applicationDescription — (String)

        An optional description of the web application.

      • applicationUrl — required — (String)

        The URL of the web application.

      • applicationCreationDate — (Integer)

        The date (in Unix epoch time) when the web application was created.

      • applicationLastUpdateDate — (Integer)

        The date (in Unix epoch time) when the web application was last updated.

      • applicationState — (String)

        The current state of the web application.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "ACTIVE"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
    • nextToken — (String)

      A token used to get the next set of results.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The ARN of the resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • tags — (map<String>)

      The list of tags assigned to the resource.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The ARN of the resource.

  • tags — (map<String>)

    The new or modified tags for the resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The ARN of the resource.

  • tagKeys — (Array<String>)

    A list of the keys of the tags to be removed from the resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  applicationDescription: 'STRING_VALUE',
  applicationName: 'STRING_VALUE',
  clientToken: 'STRING_VALUE'
};
iotfleethub.updateApplication(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: {}) —
  • applicationId — (String)

    The unique Id of the web application.

  • applicationName — (String)

    The name of the web application.

  • applicationDescription — (String)

    An optional description of the web application.

  • clientToken — (String)

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    If a token is not provided, the SDK will use a version 4 UUID.

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.