Class: AWS.Iot

var params = {
  billingGroupArn: 'STRING_VALUE',
  billingGroupName: 'STRING_VALUE',
  thingArn: 'STRING_VALUE',
  thingName: 'STRING_VALUE'
};
iot.addThingToBillingGroup(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: {}) —
  • billingGroupName — (String)

    The name of the billing group.

    Note: This call is asynchronous. It might take several seconds for the detachment to propagate.
  • billingGroupArn — (String)

    The ARN of the billing group.

  • thingName — (String)

    The name of the thing to be added to the billing group.

  • thingArn — (String)

    The ARN of the thing to be added to the billing group.

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 = {
  overrideDynamicGroups: true || false,
  thingArn: 'STRING_VALUE',
  thingGroupArn: 'STRING_VALUE',
  thingGroupName: 'STRING_VALUE',
  thingName: 'STRING_VALUE'
};
iot.addThingToThingGroup(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: {}) —
  • thingGroupName — (String)

    The name of the group to which you are adding a thing.

  • thingGroupArn — (String)

    The ARN of the group to which you are adding a thing.

  • thingName — (String)

    The name of the thing to add to a group.

  • thingArn — (String)

    The ARN of the thing to add to a group.

  • overrideDynamicGroups — (Boolean)

    Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.

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 = {
  jobId: 'STRING_VALUE', /* required */
  targets: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  comment: 'STRING_VALUE',
  namespaceId: 'STRING_VALUE'
};
iot.associateTargetsWithJob(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: {}) —
  • targets — (Array<String>)

    A list of thing group ARNs that define the targets of the job.

  • jobId — (String)

    The unique identifier you assigned to this job when it was created.

  • comment — (String)

    An optional comment string describing why the job was associated with the targets.

  • namespaceId — (String)

    The namespace used to indicate that a job is a customer-managed job.

    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

    Note: The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

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:

    • jobArn — (String)

      An ARN identifying the job.

    • jobId — (String)

      The unique identifier you assigned to this job when it was created.

    • description — (String)

      A short text description of the job.

Returns:

• (AWS.Request) —

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

var params = {
  policyName: 'STRING_VALUE', /* required */
  target: 'STRING_VALUE' /* required */
};
iot.attachPolicy(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: {}) —
  • policyName — (String)

    The name of the policy to attach.

  • target — (String)

    The identity to which the policy is attached. For example, a thing group or a certificate.

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 = {
  policyName: 'STRING_VALUE', /* required */
  principal: 'STRING_VALUE' /* required */
};
iot.attachPrincipalPolicy(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: {}) —
  • policyName — (String)

    The policy name.

  • principal — (String)

    The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

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 = {
  securityProfileName: 'STRING_VALUE', /* required */
  securityProfileTargetArn: 'STRING_VALUE' /* required */
};
iot.attachSecurityProfile(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: {}) —
  • securityProfileName — (String)

    The security profile that is attached.

  • securityProfileTargetArn — (String)

    The ARN of the target (thing group) to which the security profile is attached.

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 = {
  principal: 'STRING_VALUE', /* required */
  thingName: 'STRING_VALUE' /* required */
};
iot.attachThingPrincipal(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: {}) —
  • thingName — (String)

    The name of the thing.

  • principal — (String)

    The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

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

    The unique identifier for the task that you want to cancel.

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

    The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".

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

    The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

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

    The unique identifier of the task.

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 = {
  jobId: 'STRING_VALUE', /* required */
  comment: 'STRING_VALUE',
  force: true || false,
  reasonCode: 'STRING_VALUE'
};
iot.cancelJob(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: {}) —
  • jobId — (String)

    The unique identifier you assigned to this job when it was created.

  • reasonCode — (String)

    (Optional)A reason code string that explains why the job was canceled.

  • comment — (String)

    An optional comment string describing why the job was canceled.

  • force — (Boolean)

    (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

    Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

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:

    • jobArn — (String)

      The job ARN.

    • jobId — (String)

      The unique identifier you assigned to this job when it was created.

    • description — (String)

      A short text description of the job.

Returns:

• (AWS.Request) —

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

var params = {
  jobId: 'STRING_VALUE', /* required */
  thingName: 'STRING_VALUE', /* required */
  expectedVersion: 'NUMBER_VALUE',
  force: true || false,
  statusDetails: {
    '<DetailsKey>': 'STRING_VALUE',
    /* '<DetailsKey>': ... */
  }
};
iot.cancelJobExecution(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: {}) —
  • jobId — (String)

    The ID of the job to be canceled.

  • thingName — (String)

    The name of the thing whose execution of the job will be canceled.

  • force — (Boolean)

    (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

    Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

  • expectedVersion — (Integer)

    (Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

  • statusDetails — (map<String>)

    A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
};
iot.clearDefaultAuthorizer(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: {})

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

    The token used to confirm ownership or access to the topic rule confirmation URL.

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 = {
  checkName: 'STRING_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE', /* required */
  resourceIdentifier: { /* required */
    account: 'STRING_VALUE',
    caCertificateId: 'STRING_VALUE',
    clientId: 'STRING_VALUE',
    cognitoIdentityPoolId: 'STRING_VALUE',
    deviceCertificateArn: 'STRING_VALUE',
    deviceCertificateId: 'STRING_VALUE',
    iamRoleArn: 'STRING_VALUE',
    issuerCertificateIdentifier: {
      issuerCertificateSerialNumber: 'STRING_VALUE',
      issuerCertificateSubject: 'STRING_VALUE',
      issuerId: 'STRING_VALUE'
    },
    policyVersionIdentifier: {
      policyName: 'STRING_VALUE',
      policyVersionId: 'STRING_VALUE'
    },
    roleAliasArn: 'STRING_VALUE'
  },
  description: 'STRING_VALUE',
  expirationDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  suppressIndefinitely: true || false
};
iot.createAuditSuppression(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: {}) —
  • checkName — (String)

    An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

  • resourceIdentifier — (map)

    Information that identifies the noncompliant resource.

    • deviceCertificateId — (String)

      The ID of the certificate attached to the resource.

    • caCertificateId — (String)

      The ID of the CA certificate used to authorize the certificate.

    • cognitoIdentityPoolId — (String)

      The ID of the Amazon Cognito identity pool.

    • clientId — (String)

      The client ID.

    • policyVersionIdentifier — (map)

      The version of the policy associated with the resource.

      • policyName — (String)

        The name of the policy.

      • policyVersionId — (String)

        The ID of the version of the policy associated with the resource.

    • account — (String)

      The account with which the resource is associated.

    • iamRoleArn — (String)

      The ARN of the IAM role that has overly permissive actions.

    • roleAliasArn — (String)

      The ARN of the role alias that has overly permissive actions.

    • issuerCertificateIdentifier — (map)

      The issuer certificate identifier.

      • issuerCertificateSubject — (String)

        The subject of the issuer certificate.

      • issuerId — (String)

        The issuer ID.

      • issuerCertificateSerialNumber — (String)

        The issuer certificate serial number.

    • deviceCertificateArn — (String)

      The ARN of the identified device certificate.

  • expirationDate — (Date)

    The epoch timestamp in seconds at which this suppression expires.

  • suppressIndefinitely — (Boolean)

    Indicates whether a suppression should exist indefinitely or not.

  • description — (String)

    The description of the audit suppression.

  • clientRequestToken — (String)

    Each audit supression must have a unique client request token. If you try to create a new audit suppression with the same token as one that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

    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 = {
  authorizerFunctionArn: 'STRING_VALUE', /* required */
  authorizerName: 'STRING_VALUE', /* required */
  enableCachingForHttp: true || false,
  signingDisabled: true || false,
  status: ACTIVE | INACTIVE,
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  tokenKeyName: 'STRING_VALUE',
  tokenSigningPublicKeys: {
    '<KeyName>': 'STRING_VALUE',
    /* '<KeyName>': ... */
  }
};
iot.createAuthorizer(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: {}) —
  • authorizerName — (String)

    The authorizer name.

  • authorizerFunctionArn — (String)

    The ARN of the authorizer's Lambda function.

  • tokenKeyName — (String)

    The name of the token key used to extract the token from the HTTP headers.

  • tokenSigningPublicKeys — (map<String>)

    The public keys used to verify the digital signature returned by your custom authentication service.

  • status — (String)

    The status of the create authorizer request.

    Possible values include:
    • "ACTIVE"
    • "INACTIVE"
  • tags — (Array<map>)

    Metadata which can be used to manage the custom authorizer.

    Note: For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

  • signingDisabled — (Boolean)

    Specifies whether IoT validates the token signature in an authorization request.

  • enableCachingForHttp — (Boolean)

    When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

    The default value is false.

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:

    • authorizerName — (String)

      The authorizer's name.

    • authorizerArn — (String)

      The authorizer ARN.

Returns:

• (AWS.Request) —

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

var params = {
  billingGroupName: 'STRING_VALUE', /* required */
  billingGroupProperties: {
    billingGroupDescription: 'STRING_VALUE'
  },
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
iot.createBillingGroup(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: {}) —
  • billingGroupName — (String)

    The name you wish to give to the billing group.

  • billingGroupProperties — (map)

    The properties of the billing group.

    • billingGroupDescription — (String)

      The description of the billing group.

  • tags — (Array<map>)

    Metadata which can be used to manage the billing group.

    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

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:

    • billingGroupName — (String)

      The name you gave to the billing group.

    • billingGroupArn — (String)

      The ARN of the billing group.

    • billingGroupId — (String)

      The ID of the billing group.

Returns:

• (AWS.Request) —

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

var params = {
  certificateSigningRequest: 'STRING_VALUE', /* required */
  setAsActive: true || false
};
iot.createCertificateFromCsr(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: {}) —
  • certificateSigningRequest — (String)

    The certificate signing request (CSR).

  • setAsActive — (Boolean)

    Specifies whether the certificate is active.

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:

    • certificateArn — (String)

      The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.

    • certificateId — (String)

      The ID of the certificate. Certificate management operations only take a certificateId.

    • certificatePem — (String)

      The certificate data, in PEM format.

Returns:

• (AWS.Request) —

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

var params = {
  accountDefaultForOperations: [ /* required */
    CreateCertificateFromCsr,
    /* more items */
  ],
  certificateProviderName: 'STRING_VALUE', /* required */
  lambdaFunctionArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
iot.createCertificateProvider(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: {}) —
  • certificateProviderName — (String)

    The name of the certificate provider.

  • lambdaFunctionArn — (String)

    The ARN of the Lambda function that defines the authentication logic.

  • accountDefaultForOperations — (Array<String>)

    A list of the operations that the certificate provider will use to generate certificates. Valid value: CreateCertificateFromCsr.

  • clientToken — (String)

    A string that you can optionally pass in the CreateCertificateProvider request to make sure the request is idempotent.

    If a token is not provided, the SDK will use a version 4 UUID.
  • tags — (Array<map>)

    Metadata which can be used to manage the certificate provider.

    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

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:

    • certificateProviderName — (String)

      The name of the certificate provider.

    • certificateProviderArn — (String)

      The ARN of the certificate provider.

Returns:

• (AWS.Request) —

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

var params = {
  clientRequestToken: 'STRING_VALUE', /* required */
  metricName: 'STRING_VALUE', /* required */
  metricType: string-list | ip-address-list | number-list | number, /* required */
  displayName: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
iot.createCustomMetric(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: {}) —
  • metricName — (String)

    The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.

  • displayName — (String)

    The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

  • metricType — (String)

    The type of the custom metric.

    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

    Possible values include:
    • "string-list"
    • "ip-address-list"
    • "number-list"
    • "number"
  • tags — (Array<map>)

    Metadata that can be used to manage the custom metric.

    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

  • clientRequestToken — (String)

    Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

    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. The data object has the following properties:

    • metricName — (String)

      The name of the custom metric to be used in the metric report.

    • metricArn — (String)

      The Amazon Resource Number (ARN) of the custom metric. For example, arn:aws-partition:iot:region:accountId:custommetric/metricName

Returns:

• (AWS.Request) —

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

var params = {
  clientRequestToken: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  stringValues: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  type: TOPIC_FILTER, /* required */
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
iot.createDimension(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: {}) —
  • name — (String)

    A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

  • type — (String)

    Specifies the type of dimension. Supported types: TOPIC_FILTER.

    Possible values include:
    • "TOPIC_FILTER"
  • stringValues — (Array<String>)

    Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

  • tags — (Array<map>)

    Metadata that can be used to manage the dimension.

    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

  • clientRequestToken — (String)

    Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

    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. The data object has the following properties:

    • name — (String)

      A unique identifier for the dimension.

    • arn — (String)

      The Amazon Resource Name (ARN) of the created dimension.

Returns:

• (AWS.Request) —

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

var params = {
  domainConfigurationName: 'STRING_VALUE', /* required */
  authorizerConfig: {
    allowAuthorizerOverride: true || false,
    defaultAuthorizerName: 'STRING_VALUE'
  },
  domainName: 'STRING_VALUE',
  serverCertificateArns: [
    'STRING_VALUE',
    /* more items */
  ],
  serverCertificateConfig: {
    enableOCSPCheck: true || false
  },
  serviceType: DATA | CREDENTIAL_PROVIDER | JOBS,
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  tlsConfig: {
    securityPolicy: 'STRING_VALUE'
  },
  validationCertificateArn: 'STRING_VALUE'
};
iot.createDomainConfiguration(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: {}) —
  • domainConfigurationName — (String)

    The name of the domain configuration. This value must be unique to a region.

  • domainName — (String)

    The name of the domain.

  • serverCertificateArns — (Array<String>)

    The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.

  • validationCertificateArn — (String)

    The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.

  • authorizerConfig — (map)

    An object that specifies the authorization service for a domain.

    • defaultAuthorizerName — (String)

      The name of the authorization service for a domain configuration.

    • allowAuthorizerOverride — (Boolean)

      A Boolean that specifies whether the domain configuration's authorization service can be overridden.

  • serviceType — (String)

    The type of service delivered by the endpoint.

    Note: Amazon Web Services IoT Core currently supports only the DATA service type.
    Possible values include:
    • "DATA"
    • "CREDENTIAL_PROVIDER"
    • "JOBS"
  • tags — (Array<map>)

    Metadata which can be used to manage the domain configuration.

    Note: For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

  • tlsConfig — (map)

    An object that specifies the TLS configuration for a domain.

    • securityPolicy — (String)

      The security policy for a domain configuration. For more information, see Security policies in the Amazon Web Services IoT Core developer guide.

  • serverCertificateConfig — (map)

    The server certificate configuration.

    • enableOCSPCheck — (Boolean)

      A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server certificate check is enabled or not.

      For more information, see Configuring OCSP server-certificate stapling in domain configuration from Amazon Web Services IoT Core Developer Guide.

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:

    • domainConfigurationName — (String)

      The name of the domain configuration.

    • domainConfigurationArn — (String)

      The ARN of the domain configuration.

Returns:

• (AWS.Request) —

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

var params = {
  queryString: 'STRING_VALUE', /* required */
  thingGroupName: 'STRING_VALUE', /* required */
  indexName: 'STRING_VALUE',
  queryVersion: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  thingGroupProperties: {
    attributePayload: {
      attributes: {
        '<AttributeName>': 'STRING_VALUE',
        /* '<AttributeName>': ... */
      },
      merge: true || false
    },
    thingGroupDescription: 'STRING_VALUE'
  }
};
iot.createDynamicThingGroup(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: {}) —
  • thingGroupName — (String)

    The dynamic thing group name to create.

  • thingGroupProperties — (map)

    The dynamic thing group properties.

    • thingGroupDescription — (String)

      The thing group description.

    • attributePayload — (map)

      The thing group attributes in JSON format.

      • attributes — (map<String>)

        A JSON string containing up to three key-value pair in JSON format. For example:

        {\"attributes\":{\"string1\":\"string2\"}}

      • merge — (Boolean)

        Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

        To remove an attribute, call UpdateThing with an empty attribute value.

        Note: The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.
  • indexName — (String)

    The dynamic thing group index name.

    Note: Currently one index is supported: AWS_Things.
  • queryString — (String)

    The dynamic thing group search query string.

    See Query Syntax for information about query string syntax.

  • queryVersion — (String)

    The dynamic thing group query version.

    Note: Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
  • tags — (Array<map>)

    Metadata which can be used to manage the dynamic thing group.

    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

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:

    • thingGroupName — (String)

      The dynamic thing group name.

    • thingGroupArn — (String)

      The dynamic thing group ARN.

    • thingGroupId — (String)

      The dynamic thing group ID.

    • indexName — (String)

      The dynamic thing group index name.

    • queryString — (String)

      The dynamic thing group search query string.

    • queryVersion — (String)

      The dynamic thing group query version.

Returns:

• (AWS.Request) —

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

var params = {
  aggregationField: 'STRING_VALUE', /* required */
  aggregationType: { /* required */
    name: Statistics | Percentiles | Cardinality, /* required */
    values: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  metricName: 'STRING_VALUE', /* required */
  period: 'NUMBER_VALUE', /* required */
  queryString: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  indexName: 'STRING_VALUE',
  queryVersion: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  unit: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
};
iot.createFleetMetric(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: {}) —
  • metricName — (String)

    The name of the fleet metric to create.

  • queryString — (String)

    The search query string.

  • aggregationType — (map)

    The type of the aggregation query.

    • name — required — (String)

      The name of the aggregation type.

      Possible values include:
      • "Statistics"
      • "Percentiles"
      • "Cardinality"
    • values — (Array<String>)

      A list of the values of aggregation types.

  • period — (Integer)

    The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

  • aggregationField — (String)

    The field to aggregate.

  • description — (String)

    The fleet metric description.

  • queryVersion — (String)

    The query version.

  • indexName — (String)

    The name of the index to search.

  • unit — (String)

    Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.

    Possible values include:
    • "Seconds"
    • "Microseconds"
    • "Milliseconds"
    • "Bytes"
    • "Kilobytes"
    • "Megabytes"
    • "Gigabytes"
    • "Terabytes"
    • "Bits"
    • "Kilobits"
    • "Megabits"
    • "Gigabits"
    • "Terabits"
    • "Percent"
    • "Count"
    • "Bytes/Second"
    • "Kilobytes/Second"
    • "Megabytes/Second"
    • "Gigabytes/Second"
    • "Terabytes/Second"
    • "Bits/Second"
    • "Kilobits/Second"
    • "Megabits/Second"
    • "Gigabits/Second"
    • "Terabits/Second"
    • "Count/Second"
    • "None"
  • tags — (Array<map>)

    Metadata, which can be used to manage the fleet metric.

    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

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:

    • metricName — (String)

      The name of the fleet metric to create.

    • metricArn — (String)

      The Amazon Resource Name (ARN) of the new fleet metric.

Returns:

• (AWS.Request) —

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

var params = {
  jobId: 'STRING_VALUE', /* required */
  targets: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  abortConfig: {
    criteriaList: [ /* required */
      {
        action: CANCEL, /* required */
        failureType: FAILED | REJECTED | TIMED_OUT | ALL, /* required */
        minNumberOfExecutedThings: 'NUMBER_VALUE', /* required */
        thresholdPercentage: 'NUMBER_VALUE' /* required */
      },
      /* more items */
    ]
  },
  description: 'STRING_VALUE',
  destinationPackageVersions: [
    'STRING_VALUE',
    /* more items */
  ],
  document: 'STRING_VALUE',
  documentParameters: {
    '<ParameterKey>': 'STRING_VALUE',
    /* '<ParameterKey>': ... */
  },
  documentSource: 'STRING_VALUE',
  jobExecutionsRetryConfig: {
    criteriaList: [ /* required */
      {
        failureType: FAILED | TIMED_OUT | ALL, /* required */
        numberOfRetries: 'NUMBER_VALUE' /* required */
      },
      /* more items */
    ]
  },
  jobExecutionsRolloutConfig: {
    exponentialRate: {
      baseRatePerMinute: 'NUMBER_VALUE', /* required */
      incrementFactor: 'NUMBER_VALUE', /* required */
      rateIncreaseCriteria: { /* required */
        numberOfNotifiedThings: 'NUMBER_VALUE',
        numberOfSucceededThings: 'NUMBER_VALUE'
      }
    },
    maximumPerMinute: 'NUMBER_VALUE'
  },
  jobTemplateArn: 'STRING_VALUE',
  namespaceId: 'STRING_VALUE',
  presignedUrlConfig: {
    expiresInSec: 'NUMBER_VALUE',
    roleArn: 'STRING_VALUE'
  },
  schedulingConfig: {
    endBehavior: STOP_ROLLOUT | CANCEL | FORCE_CANCEL,
    endTime: 'STRING_VALUE',
    maintenanceWindows: [
      {
        durationInMinutes: 'NUMBER_VALUE', /* required */
        startTime: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    startTime: 'STRING_VALUE'
  },
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  targetSelection: CONTINUOUS | SNAPSHOT,
  timeoutConfig: {
    inProgressTimeoutInMinutes: 'NUMBER_VALUE'
  }
};
iot.createJob(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: {}) —
  • jobId — (String)

    A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

  • targets — (Array<String>)

    A list of things and thing groups to which the job should be sent.

  • documentSource — (String)

    An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

    For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

    For more information, see Methods for accessing a bucket.

  • document — (String)

    The job document. Required if you don't specify a value for documentSource.

  • description — (String)

    A short text description of the job.

  • presignedUrlConfig — (map)

    Configuration information for pre-signed S3 URLs.

    • roleArn — (String)

      The ARN of an IAM role that grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.

      For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.

    • expiresInSec — (Integer)

      How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.

  • targetSelection — (String)

    Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

    Note: We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
    Possible values include:
    • "CONTINUOUS"
    • "SNAPSHOT"
  • jobExecutionsRolloutConfig — (map)

    Allows you to create a staged rollout of the job.

    • maximumPerMinute — (Integer)

      The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

    • exponentialRate — (map)

      The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.

      • baseRatePerMinute — required — (Integer)

        The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

      • incrementFactor — required — (Float)

        The exponential factor to increase the rate of rollout for a job.

        Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

      • rateIncreaseCriteria — required — (map)

        The criteria to initiate the increase in rate of rollout for a job.

        • numberOfNotifiedThings — (Integer)

          The threshold for number of notified things that will initiate the increase in rate of rollout.

        • numberOfSucceededThings — (Integer)

          The threshold for number of succeeded things that will initiate the increase in rate of rollout.

  • abortConfig — (map)

    Allows you to create the criteria to abort a job.

    • criteriaList — required — (Array<map>)

      The list of criteria that determine when and how to abort the job.

      • failureType — required — (String)

        The type of job execution failures that can initiate a job abort.

        Possible values include:
        • "FAILED"
        • "REJECTED"
        • "TIMED_OUT"
        • "ALL"
      • action — required — (String)

        The type of job action to take to initiate the job abort.

        Possible values include:
        • "CANCEL"
      • thresholdPercentage — required — (Float)

        The minimum percentage of job execution failures that must occur to initiate the job abort.

        Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

      • minNumberOfExecutedThings — required — (Integer)

        The minimum number of things which must receive job execution notifications before the job can be aborted.

  • timeoutConfig — (map)

    Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

    • inProgressTimeoutInMinutes — (Integer)

      Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

  • tags — (Array<map>)

    Metadata which can be used to manage the job.

    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

  • namespaceId — (String)

    The namespace used to indicate that a job is a customer-managed job.

    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

    Note: The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
  • jobTemplateArn — (String)

    The ARN of the job template used to create the job.

  • jobExecutionsRetryConfig — (map)

    Allows you to create the criteria to retry a job.

    • criteriaList — required — (Array<map>)

      The list of criteria that determines how many retries are allowed for each failure type for a job.

      • failureType — required — (String)

        The type of job execution failures that can initiate a job retry.

        Possible values include:
        • "FAILED"
        • "TIMED_OUT"
        • "ALL"
      • numberOfRetries — required — (Integer)

        The number of retries allowed for a failure type for the job.

  • documentParameters — (map<String>)

    Parameters of an Amazon Web Services managed template that you can specify to create the job document.

    Note: documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.
  • schedulingConfig — (map)

    The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.

    • startTime — (String)

      The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for the time.

      For more information on the syntax for startTime when using an API command or the Command Line Interface, see Timestamp.

    • endTime — (String)

      The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the time.

      For more information on the syntax for endTime when using an API command or the Command Line Interface, see Timestamp.

    • endBehavior — (String)

      Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.

      Possible values include:
      • "STOP_ROLLOUT"
      • "CANCEL"
      • "FORCE_CANCEL"
    • maintenanceWindows — (Array<map>)

      An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.

      • startTime — required — (String)

        Displays the start time of the next maintenance window.

      • durationInMinutes — required — (Integer)

        Displays the duration of the next maintenance window.

  • destinationPackageVersions — (Array<String>)

    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

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:

    • jobArn — (String)

      The job ARN.

    • jobId — (String)

      The unique identifier you assigned to this job.

    • description — (String)

      The job description.

Returns:

• (AWS.Request) —

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

var params = {
  description: 'STRING_VALUE', /* required */
  jobTemplateId: 'STRING_VALUE', /* required */
  abortConfig: {
    criteriaList: [ /* required */
      {
        action: CANCEL, /* required */
        failureType: FAILED | REJECTED | TIMED_OUT | ALL, /* required */
        minNumberOfExecutedThings: 'NUMBER_VALUE', /* required */
        thresholdPercentage: 'NUMBER_VALUE' /* required */
      },
      /* more items */
    ]
  },
  destinationPackageVersions: [
    'STRING_VALUE',
    /* more items */
  ],
  document: 'STRING_VALUE',
  documentSource: 'STRING_VALUE',
  jobArn: 'STRING_VALUE',
  jobExecutionsRetryConfig: {
    criteriaList: [ /* required */
      {
        failureType: FAILED | TIMED_OUT | ALL, /* required */
        numberOfRetries: 'NUMBER_VALUE' /* required */
      },
      /* more items */
    ]
  },
  jobExecutionsRolloutConfig: {
    exponentialRate: {
      baseRatePerMinute: 'NUMBER_VALUE', /* required */
      incrementFactor: 'NUMBER_VALUE', /* required */
      rateIncreaseCriteria: { /* required */
        numberOfNotifiedThings: 'NUMBER_VALUE',
        numberOfSucceededThings: 'NUMBER_VALUE'
      }
    },
    maximumPerMinute: 'NUMBER_VALUE'
  },
  maintenanceWindows: [
    {
      durationInMinutes: 'NUMBER_VALUE', /* required */
      startTime: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  presignedUrlConfig: {
    expiresInSec: 'NUMBER_VALUE',
    roleArn: 'STRING_VALUE'
  },
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  timeoutConfig: {
    inProgressTimeoutInMinutes: 'NUMBER_VALUE'
  }
};
iot.createJobTemplate(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: {}) —
  • jobTemplateId — (String)

    A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

  • jobArn — (String)

    The ARN of the job to use as the basis for the job template.

  • documentSource — (String)

    An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

    For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

    For more information, see Methods for accessing a bucket.

  • document — (String)

    The job document. Required if you don't specify a value for documentSource.

  • description — (String)

    A description of the job document.

  • presignedUrlConfig — (map)

    Configuration for pre-signed S3 URLs.

    • roleArn — (String)

      The ARN of an IAM role that grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.

      For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.

    • expiresInSec — (Integer)

      How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.

  • jobExecutionsRolloutConfig — (map)

    Allows you to create a staged rollout of a job.

    • maximumPerMinute — (Integer)

      The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

    • exponentialRate — (map)

      The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.

      • baseRatePerMinute — required — (Integer)

        The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

      • incrementFactor — required — (Float)

        The exponential factor to increase the rate of rollout for a job.

        Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

      • rateIncreaseCriteria — required — (map)

        The criteria to initiate the increase in rate of rollout for a job.

        • numberOfNotifiedThings — (Integer)

          The threshold for number of notified things that will initiate the increase in rate of rollout.

        • numberOfSucceededThings — (Integer)

          The threshold for number of succeeded things that will initiate the increase in rate of rollout.

  • abortConfig — (map)

    The criteria that determine when and how a job abort takes place.

    • criteriaList — required — (Array<map>)

      The list of criteria that determine when and how to abort the job.

      • failureType — required — (String)

        The type of job execution failures that can initiate a job abort.

        Possible values include:
        • "FAILED"
        • "REJECTED"
        • "TIMED_OUT"
        • "ALL"
      • action — required — (String)

        The type of job action to take to initiate the job abort.

        Possible values include:
        • "CANCEL"
      • thresholdPercentage — required — (Float)

        The minimum percentage of job execution failures that must occur to initiate the job abort.

        Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

      • minNumberOfExecutedThings — required — (Integer)

        The minimum number of things which must receive job execution notifications before the job can be aborted.

  • timeoutConfig — (map)

    Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

    • inProgressTimeoutInMinutes — (Integer)

      Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

  • tags — (Array<map>)

    Metadata that can be used to manage the job template.

    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

  • jobExecutionsRetryConfig — (map)

    Allows you to create the criteria to retry a job.

    • criteriaList — required — (Array<map>)

      The list of criteria that determines how many retries are allowed for each failure type for a job.

      • failureType — required — (String)

        The type of job execution failures that can initiate a job retry.

        Possible values include:
        • "FAILED"
        • "TIMED_OUT"
        • "ALL"
      • numberOfRetries — required — (Integer)

        The number of retries allowed for a failure type for the job.

  • maintenanceWindows — (Array<map>)

    Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

    • startTime — required — (String)

      Displays the start time of the next maintenance window.

    • durationInMinutes — required — (Integer)

      Displays the duration of the next maintenance window.

  • destinationPackageVersions — (Array<String>)

    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

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:

    • jobTemplateArn — (String)

      The ARN of the job template.

    • jobTemplateId — (String)

      The unique identifier of the job template.

Returns:

• (AWS.Request) —

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

var params = {
  setAsActive: true || false
};
iot.createKeysAndCertificate(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: {}) —
  • setAsActive — (Boolean)

    Specifies whether the certificate is active.

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:

    • certificateArn — (String)

      The ARN of the certificate.

    • certificateId — (String)

      The ID of the certificate. IoT issues a default subject name for the certificate (for example, IoT Certificate).

    • certificatePem — (String)

      The certificate data, in PEM format.

    • keyPair — (map)

      The generated key pair.

      • PublicKey — (String)

        The public key.

      • PrivateKey — (String)

        The private key.

Returns:

• (AWS.Request) —

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

var params = {
  actionName: 'STRING_VALUE', /* required */
  actionParams: { /* required */
    addThingsToThingGroupParams: {
      thingGroupNames: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      overrideDynamicGroups: true || false
    },
    enableIoTLoggingParams: {
      logLevel: DEBUG | INFO | ERROR | WARN | DISABLED, /* required */
      roleArnForLogging: 'STRING_VALUE' /* required */
    },
    publishFindingToSnsParams: {
      topicArn: 'STRING_VALUE' /* required */
    },
    replaceDefaultPolicyVersionParams: {
      templateName: BLANK_POLICY /* required */
    },
    updateCACertificateParams: {
      action: DEACTIVATE /* required */
    },
    updateDeviceCertificateParams: {
      action: DEACTIVATE /* required */
    }
  },
  roleArn: 'STRING_VALUE', /* required */
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
iot.createMitigationAction(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: {}) —
  • actionName — (String)

    A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

  • roleArn — (String)

    The ARN of the IAM role that is used to apply the mitigation action.

  • actionParams — (map)

    Defines the type of action and the parameters for that action.

    • updateDeviceCertificateParams — (map)

      Parameters to define a mitigation action that changes the state of the device certificate to inactive.

      • action — required — (String)

        The action that you want to apply to the device certificate. The only supported value is DEACTIVATE.

        Possible values include:
        • "DEACTIVATE"
    • updateCACertificateParams — (map)

      Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

      • action — required — (String)

        The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE.

        Possible values include:
        • "DEACTIVATE"
    • addThingsToThingGroupParams — (map)

      Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

      • thingGroupNames — required — (Array<String>)

        The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can't add a thing to more than one group in the same hierarchy.

      • overrideDynamicGroups — (Boolean)

        Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.

    • replaceDefaultPolicyVersionParams — (map)

      Parameters to define a mitigation action that adds a blank policy to restrict permissions.

      • templateName — required — (String)

        The name of the template to be applied. The only supported value is BLANK_POLICY.

        Possible values include:
        • "BLANK_POLICY"
    • enableIoTLoggingParams — (map)

      Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.

      • roleArnForLogging — required — (String)

        The Amazon Resource Name (ARN) of the IAM role used for logging.

      • logLevel — required — (String)

        Specifies the type of information to be logged.

        Possible values include:
        • "DEBUG"
        • "INFO"
        • "ERROR"
        • "WARN"
        • "DISABLED"
    • publishFindingToSnsParams — (map)

      Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

      • topicArn — required — (String)

        The ARN of the topic to which you want to publish the findings.

  • tags — (Array<map>)

    Metadata that can be used to manage the mitigation action.

    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

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:

    • actionArn — (String)

      The ARN for the new mitigation action.

    • actionId — (String)

      A unique identifier for the new mitigation action.

Returns:

• (AWS.Request) —

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

var params = {
  files: [ /* required */
    {
      attributes: {
        '<AttributeKey>': 'STRING_VALUE',
        /* '<AttributeKey>': ... */
      },
      codeSigning: {
        awsSignerJobId: 'STRING_VALUE',
        customCodeSigning: {
          certificateChain: {
            certificateName: 'STRING_VALUE',
            inlineDocument: 'STRING_VALUE'
          },
          hashAlgorithm: 'STRING_VALUE',
          signature: {
            inlineDocument: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
          },
          signatureAlgorithm: 'STRING_VALUE'
        },
        startSigningJobParameter: {
          destination: {
            s3Destination: {
              bucket: 'STRING_VALUE',
              prefix: 'STRING_VALUE'
            }
          },
          signingProfileName: 'STRING_VALUE',
          signingProfileParameter: {
            certificateArn: 'STRING_VALUE',
            certificatePathOnDevice: 'STRING_VALUE',
            platform: 'STRING_VALUE'
          }
        }
      },
      fileLocation: {
        s3Location: {
          bucket: 'STRING_VALUE',
          key: 'STRING_VALUE',
          version: 'STRING_VALUE'
        },
        stream: {
          fileId: 'NUMBER_VALUE',
          streamId: 'STRING_VALUE'
        }
      },
      fileName: 'STRING_VALUE',
      fileType: 'NUMBER_VALUE',
      fileVersion: 'STRING_VALUE'
    },
    /* more items */
  ],
  otaUpdateId: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  targets: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  additionalParameters: {
    '<AttributeKey>': 'STRING_VALUE',
    /* '<AttributeKey>': ... */
  },
  awsJobAbortConfig: {
    abortCriteriaList: [ /* required */
      {
        action: CANCEL, /* required */
        failureType: FAILED | REJECTED | TIMED_OUT | ALL, /* required */
        minNumberOfExecutedThings: 'NUMBER_VALUE', /* required */
        thresholdPercentage: 'NUMBER_VALUE' /* required */
      },
      /* more items */
    ]
  },
  awsJobExecutionsRolloutConfig: {
    exponentialRate: {
      baseRatePerMinute: 'NUMBER_VALUE', /* required */
      incrementFactor: 'NUMBER_VALUE', /* required */
      rateIncreaseCriteria: { /* required */
        numberOfNotifiedThings: 'NUMBER_VALUE',
        numberOfSucceededThings: 'NUMBER_VALUE'
      }
    },
    maximumPerMinute: 'NUMBER_VALUE'
  },
  awsJobPresignedUrlConfig: {
    expiresInSec: 'NUMBER_VALUE'
  },
  awsJobTimeoutConfig: {
    inProgressTimeoutInMinutes: 'NUMBER_VALUE'
  },
  description: 'STRING_VALUE',
  protocols: [
    MQTT | HTTP,
    /* more items */
  ],
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  targetSelection: CONTINUOUS | SNAPSHOT
};
iot.createOTAUpdate(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: {}) —
  • otaUpdateId — (String)

    The ID of the OTA update to be created.

  • description — (String)

    The description of the OTA update.

  • targets — (Array<String>)

    The devices targeted to receive OTA updates.

  • protocols — (Array<String>)

    The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

  • targetSelection — (String)

    Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

    Possible values include:
    • "CONTINUOUS"
    • "SNAPSHOT"
  • awsJobExecutionsRolloutConfig — (map)

    Configuration for the rollout of OTA updates.

    • maximumPerMinute — (Integer)

      The maximum number of OTA update job executions started per minute.

    • exponentialRate — (map)

      The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

      • baseRatePerMinute — required — (Integer)

        The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout. This is the initial rate of the rollout.

      • incrementFactor — required — (Float)

        The rate of increase for a job rollout. The number of things notified is multiplied by this factor.

      • rateIncreaseCriteria — required — (map)

        The criteria to initiate the increase in rate of rollout for a job.

        Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

        • numberOfNotifiedThings — (Integer)

          When this number of things have been notified, it will initiate an increase in the rollout rate.

        • numberOfSucceededThings — (Integer)

          When this number of things have succeeded in their job execution, it will initiate an increase in the rollout rate.

  • awsJobPresignedUrlConfig — (map)

    Configuration information for pre-signed URLs.

    • expiresInSec — (Integer)

      How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.

  • awsJobAbortConfig — (map)

    The criteria that determine when and how a job abort takes place.

    • abortCriteriaList — required — (Array<map>)

      The list of criteria that determine when and how to abort the job.

      • failureType — required — (String)

        The type of job execution failures that can initiate a job abort.

        Possible values include:
        • "FAILED"
        • "REJECTED"
        • "TIMED_OUT"
        • "ALL"
      • action — required — (String)

        The type of job action to take to initiate the job abort.

        Possible values include:
        • "CANCEL"
      • thresholdPercentage — required — (Float)

        The minimum percentage of job execution failures that must occur to initiate the job abort.

        Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

      • minNumberOfExecutedThings — required — (Integer)

        The minimum number of things which must receive job execution notifications before the job can be aborted.

  • awsJobTimeoutConfig — (map)

    Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

    • inProgressTimeoutInMinutes — (Integer)

      Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

  • files — (Array<map>)

    The files to be streamed by the OTA update.

    • fileName — (String)

      The name of the file.

    • fileType — (Integer)

      An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.

    • fileVersion — (String)

      The file version.

    • fileLocation — (map)

      The location of the updated firmware.

      • stream — (map)

        The stream that contains the OTA update.

        • streamId — (String)

          The stream ID.

        • fileId — (Integer)

          The ID of a file associated with a stream.

      • s3Location — (map)

        The location of the updated firmware in S3.

        • bucket — (String)

          The S3 bucket.

        • key — (String)

          The S3 key.

        • version — (String)

          The S3 bucket version.

    • codeSigning — (map)

      The code signing method of the file.

      • awsSignerJobId — (String)

        The ID of the AWSSignerJob which was created to sign the file.

      • startSigningJobParameter — (map)

        Describes the code-signing job.

        • signingProfileParameter — (map)

          Describes the code-signing profile.

          • certificateArn — (String)

            Certificate ARN.

          • platform — (String)

            The hardware platform of your device.

          • certificatePathOnDevice — (String)

            The location of the code-signing certificate on your device.

        • signingProfileName — (String)

          The code-signing profile name.

        • destination — (map)

          The location to write the code-signed file.

          • s3Destination — (map)

            Describes the location in S3 of the updated firmware.

            • bucket — (String)

              The S3 bucket that contains the updated firmware.

            • prefix — (String)

              The S3 prefix.

      • customCodeSigning — (map)

        A custom method for code signing a file.

        • signature — (map)

          The signature for the file.

          • inlineDocument — (Buffer, Typed Array, Blob, String)

            A base64 encoded binary representation of the code signing signature.

        • certificateChain — (map)

          The certificate chain.

          • certificateName — (String)

            The name of the certificate.

          • inlineDocument — (String)

            A base64 encoded binary representation of the code signing certificate chain.

        • hashAlgorithm — (String)

          The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses SHA256 or SHA1, so you can pass either of them based on which was used for generating the signature.

        • signatureAlgorithm — (String)

          The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses ECDSA or RSA, so you can pass either of them based on which was used for generating the signature.

    • attributes — (map<String>)

      A list of name-attribute pairs. They won't be sent to devices as a part of the Job document.

  • roleArn — (String)

    The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

  • additionalParameters — (map<String>)

    A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.

  • tags — (Array<map>)

    Metadata which can be used to manage updates.

    • Key — required — (String)

      The tag's key.

    • Value — (String)

      The tag's value.

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:

    • otaUpdateId — (String)

      The OTA update ID.

    • awsIotJobId — (String)

      The IoT job ID associated with the OTA update.

    • otaUpdateArn — (String)

      The OTA update ARN.

    • awsIotJobArn — (String)

      The IoT job ARN associated with the OTA update.

    • otaUpdateStatus — (String)

      The OTA update status.

      Possible values include:
      • "CREATE_PENDING"
      • "CREATE_IN_PROGRESS"
      • "CREATE_COMPLETE"
      • "CREATE_FAILED"
      • "DELETE_IN_PROGRESS"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  packageName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iot.createPackage(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: {}) —
  • packageName — (String)

    The name of the new software package.

  • description — (String)

    A summary of the package being created. This can be used to outline the package's contents or purpose.

  • tags — (map<String>)

    Metadata that can be used to manage the package.

  • 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. The data object has the following properties:

    • packageName — (String)

      The name of the software package.

    • packageArn — (String)

      The Amazon Resource Name (ARN) for the package.

    • description — (String)

      The package description.

Returns:

• (AWS.Request) —

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

var params = {
  packageName: 'STRING_VALUE', /* required */
  versionName: 'STRING_VALUE', /* required */
  attributes: {
    '<ResourceAttributeKey>': 'STRING_VALUE',
    /* '<ResourceAttributeKey>': ... */
  },
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iot.createPackageVersion(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: {}) —
  • packageName — (String)

    The name of the associated software package.

  • versionName — (String)

    The name of the new package version.

  • description — (String)

    A summary of the package version being created. This can be used to outline the package's contents or purpose.

  • attributes — (map<String>)

    Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.

    The combined size of all the attributes on a package version is limited to 3KB.

  • tags — (map<String>)

    Metadata that can be used to manage the package version.

  • 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. The data object has the following properties:

    • packageVersionArn — (String)

      The Amazon Resource Name (ARN) for the package.

    • packageName — (String)

      The name of the associated software package.

    • versionName — (String)

      The name of the new package version.

    • description — (String)

      The package version description.

    • attributes — (map<String>)

      Metadata that were added to the package version that can be used to define a package version’s configuration.

    • status — (String)

      The status of the package version. For more information, see Package version lifecycle.

      Possible values include:
      • "DRAFT"
      • "PUBLISHED"
      • "DEPRECATED"
    • errorReason — (String)

      Error reason for a package version failure during creation or update.