software.amazon.awssdk.services.auditmanager.model

Class Insights

java.lang.Object

software.amazon.awssdk.services.auditmanager.model.Insights

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Insights.Builder,Insights>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Insights.Builder

Method Summary

Modifier and Type	Method and Description
Integer	activeAssessmentsCount() The number of active assessments in Audit Manager.
Integer	assessmentControlsCountByNoncompliantEvidence() The number of assessment controls that collected non-compliant evidence on the lastUpdated date.
static Insights.Builder	builder()
Integer	compliantEvidenceCount() The number of compliance check evidence that Audit Manager classified as compliant on the lastUpdated date.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	inconclusiveEvidenceCount() The number of evidence without a compliance check ruling.
Instant	lastUpdated() The time when the cross-assessment insights were last updated.
Integer	noncompliantEvidenceCount() The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date.
List<SdkField<?>>	sdkFields()
static Class<? extends Insights.Builder>	serializableBuilderClass()
Insights.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	totalAssessmentControlsCount() The total number of controls across all active assessments.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<Insights.Builder,Insights>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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