Class: Aws::IoT::Types::AuditCheckDetails

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

Overview

Information about the audit check.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#check_compliant ⇒ Boolean

True if the check is complete and found all resources compliant.

Returns:

  • (Boolean) 


787
788
789
790
791
792
793
794
795
796
797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 787

class AuditCheckDetails < Struct.new(
  :check_run_status,
  :check_compliant,
  :total_resources_count,
  :non_compliant_resources_count,
  :suppressed_non_compliant_resources_count,
  :error_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#check_run_status ⇒ String

The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".

Returns:

  • (String) 


787
788
789
790
791
792
793
794
795
796
797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 787

class AuditCheckDetails < Struct.new(
  :check_run_status,
  :check_compliant,
  :total_resources_count,
  :non_compliant_resources_count,
  :suppressed_non_compliant_resources_count,
  :error_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#error_code ⇒ String

The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".

Returns:

  • (String) 


787
788
789
790
791
792
793
794
795
796
797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 787

class AuditCheckDetails < Struct.new(
  :check_run_status,
  :check_compliant,
  :total_resources_count,
  :non_compliant_resources_count,
  :suppressed_non_compliant_resources_count,
  :error_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

The message associated with any error encountered when this check is performed during this audit.

Returns:

  • (String) 


787
788
789
790
791
792
793
794
795
796
797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 787

class AuditCheckDetails < Struct.new(
  :check_run_status,
  :check_compliant,
  :total_resources_count,
  :non_compliant_resources_count,
  :suppressed_non_compliant_resources_count,
  :error_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#non_compliant_resources_count ⇒ Integer

The number of resources that were found noncompliant during the check.

Returns:

  • (Integer) 


787
788
789
790
791
792
793
794
795
796
797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 787

class AuditCheckDetails < Struct.new(
  :check_run_status,
  :check_compliant,
  :total_resources_count,
  :non_compliant_resources_count,
  :suppressed_non_compliant_resources_count,
  :error_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#suppressed_non_compliant_resources_count ⇒ Integer

Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.

Returns:

  • (Integer) 


787
788
789
790
791
792
793
794
795
796
797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 787

class AuditCheckDetails < Struct.new(
  :check_run_status,
  :check_compliant,
  :total_resources_count,
  :non_compliant_resources_count,
  :suppressed_non_compliant_resources_count,
  :error_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#total_resources_count ⇒ Integer

The number of resources on which the check was performed.

Returns:

  • (Integer) 


787
788
789
790
791
792
793
794
795
796
797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 787

class AuditCheckDetails < Struct.new(
  :check_run_status,
  :check_compliant,
  :total_resources_count,
  :non_compliant_resources_count,
  :suppressed_non_compliant_resources_count,
  :error_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end