Class: Aws::IoT::Types::ListAuditTasksRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass ListAuditTasksRequest data as a hash:

{
  start_time: Time.now, # required
  end_time: Time.now, # required
  task_type: "ON_DEMAND_AUDIT_TASK", # accepts ON_DEMAND_AUDIT_TASK, SCHEDULED_AUDIT_TASK
  task_status: "IN_PROGRESS", # accepts IN_PROGRESS, COMPLETED, FAILED, CANCELED
  next_token: "NextToken",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

The end of the time period.

Returns:

  • (Time)


11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11179

class ListAuditTasksRequest < Struct.new(
  :start_time,
  :end_time,
  :task_type,
  :task_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return at one time. The default is 25.

Returns:

  • (Integer)


11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11179

class ListAuditTasksRequest < Struct.new(
  :start_time,
  :end_time,
  :task_type,
  :task_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next set of results.

Returns:

  • (String)


11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11179

class ListAuditTasksRequest < Struct.new(
  :start_time,
  :end_time,
  :task_type,
  :task_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".

Returns:

  • (Time)


11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11179

class ListAuditTasksRequest < Struct.new(
  :start_time,
  :end_time,
  :task_type,
  :task_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#task_statusString

A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

Returns:

  • (String)


11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11179

class ListAuditTasksRequest < Struct.new(
  :start_time,
  :end_time,
  :task_type,
  :task_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#task_typeString

A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".

Returns:

  • (String)


11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 11179

class ListAuditTasksRequest < Struct.new(
  :start_time,
  :end_time,
  :task_type,
  :task_status,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end