Class: Aws::IoT::Types::ListAuditFindingsRequest

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 ListAuditFindingsRequest data as a hash:

{
  task_id: "AuditTaskId",
  check_name: "AuditCheckName",
  resource_identifier: {
    device_certificate_id: "CertificateId",
    ca_certificate_id: "CertificateId",
    cognito_identity_pool_id: "CognitoIdentityPoolId",
    client_id: "ClientId",
    policy_version_identifier: {
      policy_name: "PolicyName",
      policy_version_id: "PolicyVersionId",
    },
    account: "AwsAccountId",
    iam_role_arn: "RoleArn",
    role_alias_arn: "RoleAliasArn",
  },
  max_results: 1,
  next_token: "NextToken",
  start_time: Time.now,
  end_time: Time.now,
  list_suppressed_findings: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#check_nameString

A filter to limit results to the findings for the specified audit check.

Returns:

  • (String)


10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 10895

class ListAuditFindingsRequest < Struct.new(
  :task_id,
  :check_name,
  :resource_identifier,
  :max_results,
  :next_token,
  :start_time,
  :end_time,
  :list_suppressed_findings)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeTime

A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.

Returns:

  • (Time)


10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 10895

class ListAuditFindingsRequest < Struct.new(
  :task_id,
  :check_name,
  :resource_identifier,
  :max_results,
  :next_token,
  :start_time,
  :end_time,
  :list_suppressed_findings)
  SENSITIVE = []
  include Aws::Structure
end

#list_suppressed_findingsBoolean

Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn't provided, the response will list both suppressed and unsuppressed findings.

Returns:

  • (Boolean)


10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 10895

class ListAuditFindingsRequest < Struct.new(
  :task_id,
  :check_name,
  :resource_identifier,
  :max_results,
  :next_token,
  :start_time,
  :end_time,
  :list_suppressed_findings)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 10895

class ListAuditFindingsRequest < Struct.new(
  :task_id,
  :check_name,
  :resource_identifier,
  :max_results,
  :next_token,
  :start_time,
  :end_time,
  :list_suppressed_findings)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next set of results.

Returns:

  • (String)


10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 10895

class ListAuditFindingsRequest < Struct.new(
  :task_id,
  :check_name,
  :resource_identifier,
  :max_results,
  :next_token,
  :start_time,
  :end_time,
  :list_suppressed_findings)
  SENSITIVE = []
  include Aws::Structure
end

#resource_identifierTypes::ResourceIdentifier

Information identifying the noncompliant resource.



10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 10895

class ListAuditFindingsRequest < Struct.new(
  :task_id,
  :check_name,
  :resource_identifier,
  :max_results,
  :next_token,
  :start_time,
  :end_time,
  :list_suppressed_findings)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

Returns:

  • (Time)


10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 10895

class ListAuditFindingsRequest < Struct.new(
  :task_id,
  :check_name,
  :resource_identifier,
  :max_results,
  :next_token,
  :start_time,
  :end_time,
  :list_suppressed_findings)
  SENSITIVE = []
  include Aws::Structure
end

#task_idString

A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.

Returns:

  • (String)


10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 10895

class ListAuditFindingsRequest < Struct.new(
  :task_id,
  :check_name,
  :resource_identifier,
  :max_results,
  :next_token,
  :start_time,
  :end_time,
  :list_suppressed_findings)
  SENSITIVE = []
  include Aws::Structure
end