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

Class: Aws::SecurityHub::Types::Compliance

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

Overview

Note:

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

{
  status: "PASSED", # accepts PASSED, WARNING, FAILED, NOT_AVAILABLE
  related_requirements: ["NonEmptyString"],
  status_reasons: [
    {
      reason_code: "NonEmptyString", # required
      description: "NonEmptyString",
    },
  ],
}

Contains finding details that are specific to control-based findings. Only returned for findings generated from controls.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.

Returns:

  • (Array<String>) —

    For a control, the industry or regulatory framework requirements that are related to the control.

#status ⇒ String

The result of a standards check.

The valid values for Status are as follows.

    • PASSED - Standards check passed for all evaluated resources.

    • WARNING - Some information is missing or this check is not supported for your configuration.

    • FAILED - Standards check failed for at least one evaluated resource.

    • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the AWS Config evaluation was NOT_APPLICABLE. If the AWS Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.

      Possible values:

      • PASSED
      • WARNING
      • FAILED
      • NOT_AVAILABLE

Returns:

  • (String) —

    The result of a standards check.

#status_reasons ⇒ Array<Types::StatusReason>

For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the AWS Security Hub User Guide.

Returns:

  • (Array<Types::StatusReason>) —

    For findings generated from controls, a list of reasons behind the value of Status.