Class Insights

java.lang.Object
software.amazon.awssdk.services.auditmanager.model.Insights
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Insights.Builder,Insights>
@Generated("software.amazon.awssdk:codegen") public final class Insights extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Insights.Builder,Insights>

A summary of the latest analytics data for all your active assessments.

This summary is a snapshot of the data that your active assessments collected on the lastUpdated date. It’s important to understand that the following totals are daily counts based on this date — they aren’t a total sum to date.

The Insights data is eventually consistent. This means that, when you read data from Insights, the response might not instantly reflect the results of a recently completed write or update operation. If you repeat your read request after a few hours, the response should return the latest data.

If you delete an assessment or change its status to inactive, InsightsByAssessment includes data for that assessment as follows.

  • Inactive assessments - If Audit Manager collected evidence for your assessment before you changed it inactive, that evidence is included in the InsightsByAssessment counts for that day.

  • Deleted assessments - If Audit Manager collected evidence for your assessment before you deleted it, that evidence isn't included in the InsightsByAssessment counts for that day.

See Also:

  • Method Details

    • activeAssessmentsCount

      public final Integer activeAssessmentsCount()

      The number of active assessments in Audit Manager.

      Returns:
      The number of active assessments in Audit Manager.

    • noncompliantEvidenceCount

      public final Integer noncompliantEvidenceCount()

      The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

      Returns:
      The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

    • compliantEvidenceCount

      public final Integer compliantEvidenceCount()

      The number of compliance check evidence that Audit Manager classified as compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

      Returns:
      The number of compliance check evidence that Audit Manager classified as compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

    • inconclusiveEvidenceCount

      public final Integer inconclusiveEvidenceCount()

      The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example: manual evidence, API calls, or CloudTrail).

      If evidence has a compliance check status of not applicable, it's classed as inconclusive in Insights data.

      Returns:
      The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example: manual evidence, API calls, or CloudTrail).

      If evidence has a compliance check status of not applicable, it's classed as inconclusive in Insights data.

    • assessmentControlsCountByNoncompliantEvidence

      public final Integer assessmentControlsCountByNoncompliantEvidence()

      The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

      Returns:
      The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

    • totalAssessmentControlsCount

      public final Integer totalAssessmentControlsCount()

      The total number of controls across all active assessments.

      Returns:
      The total number of controls across all active assessments.

    • lastUpdated

      public final Instant lastUpdated()

      The time when the cross-assessment insights were last updated.

      Returns:
      The time when the cross-assessment insights were last updated.

    • toBuilder

      public Insights.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Insights.Builder,Insights>
      Returns:
      a builder for type T

    • builder

      public static Insights.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Insights.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.