Struct aws_sdk_macie2::model::BucketMetadata

source · [−]

#[non_exhaustive]
pub struct BucketMetadata {Show 24 fields
    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: i64,
    pub classifiable_size_in_bytes: i64,
    pub error_code: Option<BucketMetadataErrorCode>,
    pub error_message: Option<String>,
    pub job_details: Option<JobDetails>,
    pub last_updated: Option<DateTime>,
    pub object_count: i64,
    pub object_count_by_encryption_type: Option<ObjectCountByEncryptionType>,
    pub public_access: Option<BucketPublicAccess>,
    pub region: Option<String>,
    pub replication_details: Option<ReplicationDetails>,
    pub server_side_encryption: Option<BucketServerSideEncryption>,
    pub shared_access: Option<SharedAccess>,
    pub size_in_bytes: i64,
    pub size_in_bytes_compressed: i64,
    pub tags: Option<Vec<KeyValuePair>>,
    pub unclassifiable_object_count: Option<ObjectLevelStatistics>,
    pub unclassifiable_object_size_in_bytes: Option<ObjectLevelStatistics>,
    pub versioning: bool,
}

Expand description

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 the versioning property is false and the value for most other 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.

Fields (Non-exhaustive)

This struct is marked as 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 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.

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.

bucket_name: Option<String>

The name of the bucket.

classifiable_object_count: 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: 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>

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.

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_updated: Option<DateTime>

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.

object_count: i64

The total number of objects in the bucket.

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

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.

server_side_encryption: Option<BucketServerSideEncryption>

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

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

size_in_bytes: 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: 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: bool

Specifies whether versioning is enabled for the bucket.

Struct aws_sdk_macie2::model::BucketMetadata

Fields (Non-exhaustive)

Implementations

impl BucketMetadata

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

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

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

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

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

pub fn classifiable_object_count(&self) -> i64

pub fn classifiable_size_in_bytes(&self) -> i64

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

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

pub fn job_details(&self) -> Option<&JobDetails>

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

pub fn object_count(&self) -> i64

pub fn object_count_by_encryption_type( &self) -> Option<&ObjectCountByEncryptionType>

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

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

pub fn replication_details(&self) -> Option<&ReplicationDetails>

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

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

pub fn size_in_bytes(&self) -> i64

pub fn size_in_bytes_compressed(&self) -> i64

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

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

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

pub fn versioning(&self) -> bool

impl BucketMetadata

pub fn builder() -> Builder

Trait Implementations

impl Clone for BucketMetadata

fn clone(&self) -> BucketMetadata

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

impl Debug for BucketMetadata

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

impl PartialEq<BucketMetadata> for BucketMetadata

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

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

impl StructuralPartialEq for BucketMetadata

Auto Trait Implementations

impl RefUnwindSafe for BucketMetadata

impl Send for BucketMetadata

impl Sync for BucketMetadata

impl Unpin for BucketMetadata

impl UnwindSafe for BucketMetadata

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

pub fn object_count_by_encryption_type(
&self
) -> Option<&ObjectCountByEncryptionType>

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,