software.amazon.awssdk.services.macie2.model

Class ResourceStatistics

java.lang.Object

software.amazon.awssdk.services.macie2.model.ResourceStatistics

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class ResourceStatistics
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ResourceStatistics.Builder,ResourceStatistics>

Provides statistical data for sensitive data discovery metrics that apply to an S3 bucket that Amazon Macie monitors and analyzes for your account. The statistics capture the results of automated sensitive data discovery activities that Macie has performed for the bucket. The data is available only if automated sensitive data discovery is currently enabled for your account.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResourceStatistics.Builder

Method Summary

Modifier and Type	Method and Description
static ResourceStatistics.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceStatistics.Builder>	serializableBuilderClass()
ResourceStatistics.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Long	totalBytesClassified() The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.
Long	totalDetections() The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects.
Long	totalDetectionsSuppressed() The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring settings for the bucket.
Long	totalItemsClassified() The total number of objects that Amazon Macie has analyzed in the bucket.
Long	totalItemsSensitive() The total number of the bucket's objects that Amazon Macie has found sensitive data in.
Long	totalItemsSkipped() The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue or error.
Long	totalItemsSkippedInvalidEncryption() The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with a key that Macie can't access.
Long	totalItemsSkippedInvalidKms() The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.
Long	totalItemsSkippedPermissionDenied() The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions settings for the objects or the permissions settings for the keys that were used to encrypt the objects.

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

totalBytesClassified

public final Long totalBytesClassified()

The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.

Returns:

The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.

totalDetections

public final Long totalDetections()

The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects. This includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket (totalDetectionsSuppressed).

Returns:

The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects. This includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket (totalDetectionsSuppressed).

totalDetectionsSuppressed

public final Long totalDetectionsSuppressed()

The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the bucket's objects, but the occurrences were manually suppressed. By default, suppressed occurrences are excluded from the bucket's sensitivity score.

Returns:

The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the bucket's objects, but the occurrences were manually suppressed. By default, suppressed occurrences are excluded from the bucket's sensitivity score.

totalItemsClassified

public final Long totalItemsClassified()

The total number of objects that Amazon Macie has analyzed in the bucket.

Returns:

The total number of objects that Amazon Macie has analyzed in the bucket.

totalItemsSensitive

public final Long totalItemsSensitive()

The total number of the bucket's objects that Amazon Macie has found sensitive data in.

Returns:

The total number of the bucket's objects that Amazon Macie has found sensitive data in.

totalItemsSkipped

public final Long totalItemsSkipped()

The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue or error. For example, the object is a malformed file. This value includes objects that Macie wasn't able to analyze for reasons reported by other statistics in the ResourceStatistics object.

Returns:

The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue or error. For example, the object is a malformed file. This value includes objects that Macie wasn't able to analyze for reasons reported by other statistics in the ResourceStatistics object.

totalItemsSkippedInvalidEncryption

public final Long totalItemsSkippedInvalidEncryption()

The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with a key that Macie can't access. The objects use server-side encryption with customer-provided keys (SSE-C).

Returns:

The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with a key that Macie can't access. The objects use server-side encryption with customer-provided keys (SSE-C).

totalItemsSkippedInvalidKms

public final Long totalItemsSkippedInvalidKms()

The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.

Returns:

The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.

totalItemsSkippedPermissionDenied

public final Long totalItemsSkippedPermissionDenied()

The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions settings for the objects or the permissions settings for the keys that were used to encrypt the objects.

Returns:

The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions settings for the objects or the permissions settings for the keys that were used to encrypt the objects.

toBuilder

public ResourceStatistics.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceStatistics.Builder,ResourceStatistics>

builder

public static ResourceStatistics.Builder builder()

serializableBuilderClass

public static Class<? extends ResourceStatistics.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