Struct aws_sdk_macie2::types::BucketMetadata

#[non_exhaustive]
pub struct BucketMetadata {

    pub account_id: Option<String>,
    pub allows_unencrypted_object_uploads: Option<AllowsUnencryptedObjectUploads>,
    pub bucket_arn: Option<String>,
    pub bucket_created_at: Option<DateTime>,
    pub bucket_name: Option<String>,
    pub classifiable_object_count: Option<i64>,
    pub classifiable_size_in_bytes: Option<i64>,
    pub error_code: Option<BucketMetadataErrorCode>,
    pub error_message: Option<String>,
    pub job_details: Option<JobDetails>,
    pub last_automated_discovery_time: Option<DateTime>,
    pub last_updated: Option<DateTime>,
    pub object_count: Option<i64>,
    pub object_count_by_encryption_type: Option<ObjectCountByEncryptionType>,
    pub public_access: Option<BucketPublicAccess>,
    pub region: Option<String>,
    pub replication_details: Option<ReplicationDetails>,
    pub sensitivity_score: Option<i32>,
    pub server_side_encryption: Option<BucketServerSideEncryption>,
    pub shared_access: Option<SharedAccess>,
    pub size_in_bytes: Option<i64>,
    pub size_in_bytes_compressed: Option<i64>,
    pub tags: Option<Vec<KeyValuePair>>,
    pub unclassifiable_object_count: Option<ObjectLevelStatistics>,
    pub unclassifiable_object_size_in_bytes: Option<ObjectLevelStatistics>,
    pub versioning: Option<bool>,
}

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 occurs when Macie attempts to retrieve and process metadata from Amazon S3 for the bucket or the bucket's objects, the value for the versioning property is false and the value for most other properties is null. Key exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of the error, refer to the errorCode and errorMessage values.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

account_id: Option<String>

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

allows_unencrypted_object_uploads: Option<AllowsUnencryptedObjectUploads>

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

• FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.

• 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 a valid server-side encryption header.

• UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

bucket_arn: Option<String>

The Amazon Resource Name (ARN) of the bucket.

bucket_created_at: Option<DateTime>

The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket.

bucket_name: Option<String>

The name of the bucket.

classifiable_object_count: Option<i64>

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.

classifiable_size_in_bytes: Option<i64>

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.

error_code: Option<BucketMetadataErrorCode>

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.

error_message: Option<String>

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.

job_details: Option<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.

last_automated_discovery_time: Option<DateTime>

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.

last_updated: Option<DateTime>

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

object_count: Option<i64>

The total number of objects in the bucket.

object_count_by_encryption_type: Option<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.

public_access: Option<BucketPublicAccess>

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.

region: Option<String>

The Amazon Web Services Region that hosts the bucket.

replication_details: Option<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.

sensitivity_score: Option<i32>

The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.

server_side_encryption: Option<BucketServerSideEncryption>

The default server-side encryption settings for the bucket.

shared_access: Option<SharedAccess>

Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:

• EXTERNAL - The bucket is shared with one or more of the following or any combination of the following: a CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn't part of your Amazon Macie organization.

• INTERNAL - The bucket is shared with one or more Amazon Web Services accounts that are part of your Amazon Macie organization. It isn't shared with a CloudFront OAI or OAC.

• NOT_SHARED - The bucket isn't shared with another Amazon Web Services account, a CloudFront OAI, or a CloudFront OAC.

• UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

size_in_bytes: Option<i64>

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.

size_in_bytes_compressed: Option<i64>

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.

tags: Option<Vec<KeyValuePair>>

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

unclassifiable_object_count: Option<ObjectLevelStatistics>

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.

unclassifiable_object_size_in_bytes: Option<ObjectLevelStatistics>

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.

versioning: Option<bool>

Specifies whether versioning is enabled for the bucket.

Implementations

impl BucketMetadata

pub fn account_id(&self) -> Option<&str>

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

pub fn allows_unencrypted_object_uploads( &self ) -> Option<&AllowsUnencryptedObjectUploads>

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

• FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.

• 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 a valid server-side encryption header.

• UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

pub fn bucket_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the bucket.

pub fn bucket_created_at(&self) -> Option<&DateTime>

The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket.

pub fn bucket_name(&self) -> Option<&str>

The name of the bucket.

pub fn classifiable_object_count(&self) -> Option<i64>

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.

pub fn classifiable_size_in_bytes(&self) -> Option<i64>

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.

pub fn error_code(&self) -> Option<&BucketMetadataErrorCode>

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.

pub fn error_message(&self) -> Option<&str>

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.

pub fn job_details(&self) -> Option<&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.

pub fn last_automated_discovery_time(&self) -> Option<&DateTime>

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.

pub fn last_updated(&self) -> Option<&DateTime>

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

pub fn object_count(&self) -> Option<i64>

The total number of objects in the bucket.

pub fn object_count_by_encryption_type( &self ) -> Option<&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.

pub fn public_access(&self) -> Option<&BucketPublicAccess>

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.

pub fn region(&self) -> Option<&str>

The Amazon Web Services Region that hosts the bucket.

pub fn replication_details(&self) -> Option<&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.

pub fn sensitivity_score(&self) -> Option<i32>

The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.

pub fn server_side_encryption(&self) -> Option<&BucketServerSideEncryption>

The default server-side encryption settings for the bucket.

pub fn shared_access(&self) -> Option<&SharedAccess>

Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:

• EXTERNAL - The bucket is shared with one or more of the following or any combination of the following: a CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn't part of your Amazon Macie organization.

• INTERNAL - The bucket is shared with one or more Amazon Web Services accounts that are part of your Amazon Macie organization. It isn't shared with a CloudFront OAI or OAC.

• NOT_SHARED - The bucket isn't shared with another Amazon Web Services account, a CloudFront OAI, or a CloudFront OAC.

• UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

pub fn size_in_bytes(&self) -> Option<i64>

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.

pub fn size_in_bytes_compressed(&self) -> Option<i64>

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.

pub fn tags(&self) -> &[KeyValuePair]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn unclassifiable_object_count(&self) -> Option<&ObjectLevelStatistics>

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.

pub fn unclassifiable_object_size_in_bytes( &self ) -> Option<&ObjectLevelStatistics>

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.

pub fn versioning(&self) -> Option<bool>

Specifies whether versioning is enabled for the bucket.

impl BucketMetadata

pub fn builder() -> BucketMetadataBuilder

Creates a new builder-style object to manufacture BucketMetadata.

Trait Implementations

impl Clone for BucketMetadata

fn clone(&self) -> BucketMetadata

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BucketMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BucketMetadata

fn eq(&self, other: &BucketMetadata) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BucketMetadata