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

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

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

Overview

Note:

When passing ListAuditTasksRequest as input to an Aws::Client method, you can use a vanilla 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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

The end of the time period.

Returns:

  • (Time) —

    The end of the time period.

#max_results ⇒ Integer

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

Returns:

  • (Integer) —

    The maximum number of results to return at one time.

#next_token ⇒ String

The token for the next set of results.

Returns:

  • (String) —

    The token for the next set of results.

#start_time ⇒ Time

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) —

    The beginning of the time period.

#task_status ⇒ String

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

Possible values:

  • IN_PROGRESS
  • COMPLETED
  • FAILED
  • CANCELED

Returns:

  • (String) —

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

#task_type ⇒ String

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

Possible values:

  • ON_DEMAND_AUDIT_TASK
  • SCHEDULED_AUDIT_TASK

Returns:

  • (String) —

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