Documentation

Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. If an error occurs when Macie attempts to retrieve and process information about the bucket or the bucket's objects, the value for most of these properties is null. Exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of the error, refer to the errorCode and errorMessage values.

See: newBucketMetadata smart constructor.

Create a value of BucketMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sizeInBytesCompressed:BucketMetadata', bucketMetadata_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.

$sel:lastUpdated:BucketMetadata', bucketMetadata_lastUpdated - The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.

$sel:objectCountByEncryptionType:BucketMetadata', bucketMetadata_objectCountByEncryptionType - The total number of objects that are 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.

$sel:sharedAccess:BucketMetadata', bucketMetadata_sharedAccess - Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:

• EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
• INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
• NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
• UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

$sel:sizeInBytes:BucketMetadata', bucketMetadata_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.

$sel:bucketName:BucketMetadata', bucketMetadata_bucketName - The name of the bucket.

$sel:classifiableObjectCount:BucketMetadata', bucketMetadata_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.

$sel:accountId:BucketMetadata', bucketMetadata_accountId - The unique identifier for the Amazon Web Services account that owns the bucket.

$sel:unclassifiableObjectSizeInBytes:BucketMetadata', bucketMetadata_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.

$sel:unclassifiableObjectCount:BucketMetadata', bucketMetadata_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.

$sel:versioning:BucketMetadata', bucketMetadata_versioning - Specifies whether versioning is enabled for the bucket.

$sel:allowsUnencryptedObjectUploads:BucketMetadata', bucketMetadata_allowsUnencryptedObjectUploads - Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:

• FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
• TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
• UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

$sel:publicAccess:BucketMetadata', bucketMetadata_publicAccess - Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.

$sel:errorCode:BucketMetadata', bucketMetadata_errorCode - Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is 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. If this value is null, Macie was able to retrieve and process the information.

$sel:jobDetails:BucketMetadata', bucketMetadata_jobDetails - Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.

$sel:region:BucketMetadata', bucketMetadata_region - The Amazon Web Services Region that hosts the bucket.

$sel:bucketCreatedAt:BucketMetadata', bucketMetadata_bucketCreatedAt - The date and time, in UTC and extended ISO 8601 format, when the bucket was created.

$sel:errorMessage:BucketMetadata', bucketMetadata_errorMessage - A brief description of the error (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.

$sel:bucketArn:BucketMetadata', bucketMetadata_bucketArn - The Amazon Resource Name (ARN) of the bucket.

$sel:objectCount:BucketMetadata', bucketMetadata_objectCount - The total number of objects in the bucket.

$sel:replicationDetails:BucketMetadata', bucketMetadata_replicationDetails - Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.

$sel:serverSideEncryption:BucketMetadata', bucketMetadata_serverSideEncryption - Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.

$sel:tags:BucketMetadata', bucketMetadata_tags - An array that specifies the tags (keys and values) that are associated with the bucket.

$sel:classifiableSizeInBytes:BucketMetadata', bucketMetadata_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.

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.

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.

The total number of objects that are 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.

Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:

• EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
• INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
• NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
• UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

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.

The name of the bucket.

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.

The unique identifier for the Amazon Web Services account that owns the bucket.

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.

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.

Specifies whether versioning is enabled for the bucket.

Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:

• FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
• TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
• UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.

Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is 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. If this value is null, Macie was able to retrieve and process the information.

Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.

The Amazon Web Services Region that hosts the bucket.

The date and time, in UTC and extended ISO 8601 format, when the bucket was created.

A brief description of the error (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.

The Amazon Resource Name (ARN) of the bucket.

The total number of objects in the bucket.

Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.

Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.

An array that specifies the tags (keys and values) that are associated with the bucket.

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.