java.lang.Object
- software.amazon.awssdk.services.macie2.model.MatchingBucket

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MatchingBucket.Builder,MatchingBucket>
```
@Generated("software.amazon.awssdk:codegen")
public final class MatchingBucket
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MatchingBucket.Builder,MatchingBucket>
```
Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see How Macie monitors Amazon S3 data security in the Amazon Macie User Guide.

If an error or issue prevents Macie from retrieving and processing information about the bucket or the bucket's objects, the value for many of these properties is null. Key exceptions are accountId and bucketName. To identify the cause, refer to the errorCode and errorMessage values.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface MatchingBucket.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accountId()`	The unique identifier for the Amazon Web Services account that owns the bucket.
`AutomatedDiscoveryMonitoringStatus`	`automatedDiscoveryMonitoringStatus()`	Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket.
`String`	`automatedDiscoveryMonitoringStatusAsString()`	Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket.
`String`	`bucketName()`	The name of the bucket.
`static MatchingBucket.Builder`	`builder()`
`Long`	`classifiableObjectCount()`	The total number of objects that Amazon Macie can analyze in the bucket.
`Long`	`classifiableSizeInBytes()`	The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`BucketMetadataErrorCode`	`errorCode()`	The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects.
`String`	`errorCodeAsString()`	The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects.
`String`	`errorMessage()`	A brief description of the error or issue (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`JobDetails`	`jobDetails()`	Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.
`Instant`	`lastAutomatedDiscoveryTime()`	The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed objects in the bucket while performing automated sensitive data discovery.
`Long`	`objectCount()`	The total number of objects in the bucket.
`ObjectCountByEncryptionType`	`objectCountByEncryptionType()`	The total number of objects in the bucket, grouped by server-side encryption type.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`Integer`	`sensitivityScore()`	The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive).
`static Class<? extends MatchingBucket.Builder>`	`serializableBuilderClass()`
`Long`	`sizeInBytes()`	The total storage size, in bytes, of the bucket.
`Long`	`sizeInBytesCompressed()`	The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
`MatchingBucket.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`ObjectLevelStatistics`	`unclassifiableObjectCount()`	The total number of objects that Amazon Macie can't analyze in the bucket.
`ObjectLevelStatistics`	`unclassifiableObjectSizeInBytes()`	The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket.

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
  - accountId
```
public final String accountId()
```
    The unique identifier for the Amazon Web Services account that owns the bucket.
    
    Returns:
    
    The unique identifier for the Amazon Web Services account that owns the bucket.
  - automatedDiscoveryMonitoringStatus
```
public final AutomatedDiscoveryMonitoringStatus automatedDiscoveryMonitoringStatus()
```
    Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.
    
    If the service returns an enum value that is not available in the current SDK version, automatedDiscoveryMonitoringStatus will return AutomatedDiscoveryMonitoringStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automatedDiscoveryMonitoringStatusAsString().
    
    Returns:
    
    Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.
    
    See Also:
    
    AutomatedDiscoveryMonitoringStatus
  - automatedDiscoveryMonitoringStatusAsString
```
public final String automatedDiscoveryMonitoringStatusAsString()
```
    Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.
    
    If the service returns an enum value that is not available in the current SDK version, automatedDiscoveryMonitoringStatus will return AutomatedDiscoveryMonitoringStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automatedDiscoveryMonitoringStatusAsString().
    
    Returns:
    
    Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.
    
    See Also:
    
    AutomatedDiscoveryMonitoringStatus
  - bucketName
```
public final String bucketName()
```
    The name of the bucket.
    
    Returns:
    
    The name of the bucket.
  - classifiableObjectCount
```
public final Long classifiableObjectCount()
```
    The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
    
    Returns:
    
    The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
  - classifiableSizeInBytes
```
public final Long classifiableSizeInBytes()
```
    The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
    
    If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
    
    Returns:
    
    The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
    
    If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
  - errorCode
```
public final BucketMetadataErrorCode errorCode()
```
    The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. Possible values are:
    
    ACCESS_DENIED - Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request.
    
    BUCKET_COUNT_EXCEEDS_QUOTA - Retrieving and processing the information would exceed the quota for the number of buckets that Macie monitors for an account (10,000).
    
    If this value is null, Macie was able to retrieve and process the information.
    
    If the service returns an enum value that is not available in the current SDK version, errorCode will return BucketMetadataErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().
    Returns:
    
    The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. Possible values are:
    
    ACCESS_DENIED - Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request.
    
    BUCKET_COUNT_EXCEEDS_QUOTA - Retrieving and processing the information would exceed the quota for the number of buckets that Macie monitors for an account (10,000).
    
    If this value is null, Macie was able to retrieve and process the information.
    
    See Also:
    
    BucketMetadataErrorCode
  - errorCodeAsString
```
public final String errorCodeAsString()
```
    The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. Possible values are:
    
    ACCESS_DENIED - Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request.
    
    BUCKET_COUNT_EXCEEDS_QUOTA - Retrieving and processing the information would exceed the quota for the number of buckets that Macie monitors for an account (10,000).
    
    If this value is null, Macie was able to retrieve and process the information.
    
    If the service returns an enum value that is not available in the current SDK version, errorCode will return BucketMetadataErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().
    Returns:
    
    The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. Possible values are:
    
    ACCESS_DENIED - Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request.
    
    BUCKET_COUNT_EXCEEDS_QUOTA - Retrieving and processing the information would exceed the quota for the number of buckets that Macie monitors for an account (10,000).
    
    If this value is null, Macie was able to retrieve and process the information.
    
    See Also:
    
    BucketMetadataErrorCode
  - errorMessage
```
public final String errorMessage()
```
    A brief description of the error or issue (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.
    
    Returns:
    
    A brief description of the error or issue (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.
  - jobDetails
```
public final JobDetails jobDetails()
```
    Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.
    
    Returns:
    
    Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.
  - lastAutomatedDiscoveryTime
```
public final Instant lastAutomatedDiscoveryTime()
```
    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed objects in the bucket while performing automated sensitive data discovery. This value is null if this analysis hasn't occurred.
    
    Returns:
    
    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed objects in the bucket while performing automated sensitive data discovery. This value is null if this analysis hasn't occurred.
  - objectCount
```
public final Long objectCount()
```
    The total number of objects in the bucket.
    
    Returns:
    
    The total number of objects in the bucket.
  - objectCountByEncryptionType
```
public final ObjectCountByEncryptionType objectCountByEncryptionType()
```
    The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.
    
    Returns:
    
    The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.
  - sensitivityScore
```
public final Integer sensitivityScore()
```
    The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive).
    
    If automated sensitive data discovery has never been enabled for your account or it's been disabled for your organization or standalone account for more than 30 days, possible values are: 1, the bucket is empty; or, 50, the bucket stores objects but it's been excluded from recent analyses.
    
    Returns:
    
    The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive).
    
    If automated sensitive data discovery has never been enabled for your account or it's been disabled for your organization or standalone account for more than 30 days, possible values are: 1, the bucket is empty; or, 50, the bucket stores objects but it's been excluded from recent analyses.
  - sizeInBytes
```
public final Long sizeInBytes()
```
    The total storage size, in bytes, of the bucket.
    
    If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.
    
    Returns:
    
    The total storage size, in bytes, of the bucket.
    
    If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.
  - sizeInBytesCompressed
```
public final Long sizeInBytesCompressed()
```
    The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
    
    If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
    
    Returns:
    
    The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
    
    If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
  - unclassifiableObjectCount
```
public final ObjectLevelStatistics unclassifiableObjectCount()
```
    The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
    
    Returns:
    
    The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
  - unclassifiableObjectSizeInBytes
```
public final ObjectLevelStatistics unclassifiableObjectSizeInBytes()
```
    The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
    
    Returns:
    
    The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
  - toBuilder
```
public MatchingBucket.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MatchingBucket.Builder,MatchingBucket>
  - builder
```
public static MatchingBucket.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MatchingBucket.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class MatchingBucket

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

accountId

automatedDiscoveryMonitoringStatus

automatedDiscoveryMonitoringStatusAsString

bucketName

classifiableObjectCount

classifiableSizeInBytes

errorCode

errorCodeAsString

errorMessage

jobDetails

lastAutomatedDiscoveryTime

objectCount

objectCountByEncryptionType

sensitivityScore

sizeInBytes

sizeInBytesCompressed

unclassifiableObjectCount

unclassifiableObjectSizeInBytes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField