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

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::AbortCriteria

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AbortCriteria as input to an Aws::Client method, you can use a vanilla Hash:

{
  failure_type: "FAILED", # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
  action: "CANCEL", # required, accepts CANCEL
  threshold_percentage: 1.0, # required
  min_number_of_executed_things: 1, # required
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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

Possible values:

  • CANCEL

Returns:

  • (String)

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

#failure_typeString

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

Possible values:

  • FAILED
  • REJECTED
  • TIMED_OUT
  • ALL

Returns:

  • (String)

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

#min_number_of_executed_thingsInteger

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

Returns:

  • (Integer)

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

#threshold_percentageFloat

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

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

Returns:

  • (Float)

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