AWS SDK for C++  1.9.175
AWS SDK for C++
Public Member Functions | List of all members
Aws::Macie2::Model::BucketMetadata Class Reference

#include <BucketMetadata.h>

Public Member Functions

 BucketMetadata ()
 
 BucketMetadata (Aws::Utils::Json::JsonView jsonValue)
 
BucketMetadataoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetAccountId () const
 
bool AccountIdHasBeenSet () const
 
void SetAccountId (const Aws::String &value)
 
void SetAccountId (Aws::String &&value)
 
void SetAccountId (const char *value)
 
BucketMetadataWithAccountId (const Aws::String &value)
 
BucketMetadataWithAccountId (Aws::String &&value)
 
BucketMetadataWithAccountId (const char *value)
 
const AllowsUnencryptedObjectUploadsGetAllowsUnencryptedObjectUploads () const
 
bool AllowsUnencryptedObjectUploadsHasBeenSet () const
 
void SetAllowsUnencryptedObjectUploads (const AllowsUnencryptedObjectUploads &value)
 
void SetAllowsUnencryptedObjectUploads (AllowsUnencryptedObjectUploads &&value)
 
BucketMetadataWithAllowsUnencryptedObjectUploads (const AllowsUnencryptedObjectUploads &value)
 
BucketMetadataWithAllowsUnencryptedObjectUploads (AllowsUnencryptedObjectUploads &&value)
 
const Aws::StringGetBucketArn () const
 
bool BucketArnHasBeenSet () const
 
void SetBucketArn (const Aws::String &value)
 
void SetBucketArn (Aws::String &&value)
 
void SetBucketArn (const char *value)
 
BucketMetadataWithBucketArn (const Aws::String &value)
 
BucketMetadataWithBucketArn (Aws::String &&value)
 
BucketMetadataWithBucketArn (const char *value)
 
const Aws::Utils::DateTimeGetBucketCreatedAt () const
 
bool BucketCreatedAtHasBeenSet () const
 
void SetBucketCreatedAt (const Aws::Utils::DateTime &value)
 
void SetBucketCreatedAt (Aws::Utils::DateTime &&value)
 
BucketMetadataWithBucketCreatedAt (const Aws::Utils::DateTime &value)
 
BucketMetadataWithBucketCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::StringGetBucketName () const
 
bool BucketNameHasBeenSet () const
 
void SetBucketName (const Aws::String &value)
 
void SetBucketName (Aws::String &&value)
 
void SetBucketName (const char *value)
 
BucketMetadataWithBucketName (const Aws::String &value)
 
BucketMetadataWithBucketName (Aws::String &&value)
 
BucketMetadataWithBucketName (const char *value)
 
long long GetClassifiableObjectCount () const
 
bool ClassifiableObjectCountHasBeenSet () const
 
void SetClassifiableObjectCount (long long value)
 
BucketMetadataWithClassifiableObjectCount (long long value)
 
long long GetClassifiableSizeInBytes () const
 
bool ClassifiableSizeInBytesHasBeenSet () const
 
void SetClassifiableSizeInBytes (long long value)
 
BucketMetadataWithClassifiableSizeInBytes (long long value)
 
const BucketMetadataErrorCodeGetErrorCode () const
 
bool ErrorCodeHasBeenSet () const
 
void SetErrorCode (const BucketMetadataErrorCode &value)
 
void SetErrorCode (BucketMetadataErrorCode &&value)
 
BucketMetadataWithErrorCode (const BucketMetadataErrorCode &value)
 
BucketMetadataWithErrorCode (BucketMetadataErrorCode &&value)
 
const Aws::StringGetErrorMessage () const
 
bool ErrorMessageHasBeenSet () const
 
void SetErrorMessage (const Aws::String &value)
 
void SetErrorMessage (Aws::String &&value)
 
void SetErrorMessage (const char *value)
 
BucketMetadataWithErrorMessage (const Aws::String &value)
 
BucketMetadataWithErrorMessage (Aws::String &&value)
 
BucketMetadataWithErrorMessage (const char *value)
 
const JobDetailsGetJobDetails () const
 
bool JobDetailsHasBeenSet () const
 
void SetJobDetails (const JobDetails &value)
 
void SetJobDetails (JobDetails &&value)
 
BucketMetadataWithJobDetails (const JobDetails &value)
 
BucketMetadataWithJobDetails (JobDetails &&value)
 
const Aws::Utils::DateTimeGetLastUpdated () const
 
bool LastUpdatedHasBeenSet () const
 
void SetLastUpdated (const Aws::Utils::DateTime &value)
 
void SetLastUpdated (Aws::Utils::DateTime &&value)
 
BucketMetadataWithLastUpdated (const Aws::Utils::DateTime &value)
 
BucketMetadataWithLastUpdated (Aws::Utils::DateTime &&value)
 
long long GetObjectCount () const
 
bool ObjectCountHasBeenSet () const
 
void SetObjectCount (long long value)
 
BucketMetadataWithObjectCount (long long value)
 
const ObjectCountByEncryptionTypeGetObjectCountByEncryptionType () const
 
bool ObjectCountByEncryptionTypeHasBeenSet () const
 
void SetObjectCountByEncryptionType (const ObjectCountByEncryptionType &value)
 
void SetObjectCountByEncryptionType (ObjectCountByEncryptionType &&value)
 
BucketMetadataWithObjectCountByEncryptionType (const ObjectCountByEncryptionType &value)
 
BucketMetadataWithObjectCountByEncryptionType (ObjectCountByEncryptionType &&value)
 
const BucketPublicAccessGetPublicAccess () const
 
bool PublicAccessHasBeenSet () const
 
void SetPublicAccess (const BucketPublicAccess &value)
 
void SetPublicAccess (BucketPublicAccess &&value)
 
BucketMetadataWithPublicAccess (const BucketPublicAccess &value)
 
BucketMetadataWithPublicAccess (BucketPublicAccess &&value)
 
const Aws::StringGetRegion () const
 
bool RegionHasBeenSet () const
 
void SetRegion (const Aws::String &value)
 
void SetRegion (Aws::String &&value)
 
void SetRegion (const char *value)
 
BucketMetadataWithRegion (const Aws::String &value)
 
BucketMetadataWithRegion (Aws::String &&value)
 
BucketMetadataWithRegion (const char *value)
 
const ReplicationDetailsGetReplicationDetails () const
 
bool ReplicationDetailsHasBeenSet () const
 
void SetReplicationDetails (const ReplicationDetails &value)
 
void SetReplicationDetails (ReplicationDetails &&value)
 
BucketMetadataWithReplicationDetails (const ReplicationDetails &value)
 
BucketMetadataWithReplicationDetails (ReplicationDetails &&value)
 
const BucketServerSideEncryptionGetServerSideEncryption () const
 
bool ServerSideEncryptionHasBeenSet () const
 
void SetServerSideEncryption (const BucketServerSideEncryption &value)
 
void SetServerSideEncryption (BucketServerSideEncryption &&value)
 
BucketMetadataWithServerSideEncryption (const BucketServerSideEncryption &value)
 
BucketMetadataWithServerSideEncryption (BucketServerSideEncryption &&value)
 
const SharedAccessGetSharedAccess () const
 
bool SharedAccessHasBeenSet () const
 
void SetSharedAccess (const SharedAccess &value)
 
void SetSharedAccess (SharedAccess &&value)
 
BucketMetadataWithSharedAccess (const SharedAccess &value)
 
BucketMetadataWithSharedAccess (SharedAccess &&value)
 
long long GetSizeInBytes () const
 
bool SizeInBytesHasBeenSet () const
 
void SetSizeInBytes (long long value)
 
BucketMetadataWithSizeInBytes (long long value)
 
long long GetSizeInBytesCompressed () const
 
bool SizeInBytesCompressedHasBeenSet () const
 
void SetSizeInBytesCompressed (long long value)
 
BucketMetadataWithSizeInBytesCompressed (long long value)
 
const Aws::Vector< KeyValuePair > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< KeyValuePair > &value)
 
void SetTags (Aws::Vector< KeyValuePair > &&value)
 
BucketMetadataWithTags (const Aws::Vector< KeyValuePair > &value)
 
BucketMetadataWithTags (Aws::Vector< KeyValuePair > &&value)
 
BucketMetadataAddTags (const KeyValuePair &value)
 
BucketMetadataAddTags (KeyValuePair &&value)
 
const ObjectLevelStatisticsGetUnclassifiableObjectCount () const
 
bool UnclassifiableObjectCountHasBeenSet () const
 
void SetUnclassifiableObjectCount (const ObjectLevelStatistics &value)
 
void SetUnclassifiableObjectCount (ObjectLevelStatistics &&value)
 
BucketMetadataWithUnclassifiableObjectCount (const ObjectLevelStatistics &value)
 
BucketMetadataWithUnclassifiableObjectCount (ObjectLevelStatistics &&value)
 
const ObjectLevelStatisticsGetUnclassifiableObjectSizeInBytes () const
 
bool UnclassifiableObjectSizeInBytesHasBeenSet () const
 
void SetUnclassifiableObjectSizeInBytes (const ObjectLevelStatistics &value)
 
void SetUnclassifiableObjectSizeInBytes (ObjectLevelStatistics &&value)
 
BucketMetadataWithUnclassifiableObjectSizeInBytes (const ObjectLevelStatistics &value)
 
BucketMetadataWithUnclassifiableObjectSizeInBytes (ObjectLevelStatistics &&value)
 
bool GetVersioning () const
 
bool VersioningHasBeenSet () const
 
void SetVersioning (bool value)
 
BucketMetadataWithVersioning (bool value)
 

Detailed 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.

See Also:

AWS API Reference

Definition at line 50 of file BucketMetadata.h.

Constructor & Destructor Documentation

◆ BucketMetadata() [1/2]

Aws::Macie2::Model::BucketMetadata::BucketMetadata ( )

◆ BucketMetadata() [2/2]

Aws::Macie2::Model::BucketMetadata::BucketMetadata ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AccountIdHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::AccountIdHasBeenSet ( ) const
inline

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

Definition at line 69 of file BucketMetadata.h.

◆ AddTags() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::AddTags ( const KeyValuePair value)
inline

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

Definition at line 1021 of file BucketMetadata.h.

◆ AddTags() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::AddTags ( KeyValuePair &&  value)
inline

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

Definition at line 1027 of file BucketMetadata.h.

◆ AllowsUnencryptedObjectUploadsHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::AllowsUnencryptedObjectUploadsHasBeenSet ( ) const
inline

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.

Definition at line 138 of file BucketMetadata.h.

◆ BucketArnHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::BucketArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the bucket.

Definition at line 213 of file BucketMetadata.h.

◆ BucketCreatedAtHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::BucketCreatedAtHasBeenSet ( ) const
inline

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

Definition at line 256 of file BucketMetadata.h.

◆ BucketNameHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::BucketNameHasBeenSet ( ) const
inline

The name of the bucket.

Definition at line 291 of file BucketMetadata.h.

◆ ClassifiableObjectCountHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::ClassifiableObjectCountHasBeenSet ( ) const
inline

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.

Definition at line 336 of file BucketMetadata.h.

◆ ClassifiableSizeInBytesHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::ClassifiableSizeInBytesHasBeenSet ( ) const
inline

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.

Definition at line 373 of file BucketMetadata.h.

◆ ErrorCodeHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::ErrorCodeHasBeenSet ( ) const
inline

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.

Definition at line 416 of file BucketMetadata.h.

◆ ErrorMessageHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::ErrorMessageHasBeenSet ( ) const
inline

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.

Definition at line 473 of file BucketMetadata.h.

◆ GetAccountId()

const Aws::String& Aws::Macie2::Model::BucketMetadata::GetAccountId ( ) const
inline

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

Definition at line 63 of file BucketMetadata.h.

◆ GetAllowsUnencryptedObjectUploads()

const AllowsUnencryptedObjectUploads& Aws::Macie2::Model::BucketMetadata::GetAllowsUnencryptedObjectUploads ( ) const
inline

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.

Definition at line 122 of file BucketMetadata.h.

◆ GetBucketArn()

const Aws::String& Aws::Macie2::Model::BucketMetadata::GetBucketArn ( ) const
inline

The Amazon Resource Name (ARN) of the bucket.

Definition at line 208 of file BucketMetadata.h.

◆ GetBucketCreatedAt()

const Aws::Utils::DateTime& Aws::Macie2::Model::BucketMetadata::GetBucketCreatedAt ( ) const
inline

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

Definition at line 250 of file BucketMetadata.h.

◆ GetBucketName()

const Aws::String& Aws::Macie2::Model::BucketMetadata::GetBucketName ( ) const
inline

The name of the bucket.

Definition at line 286 of file BucketMetadata.h.

◆ GetClassifiableObjectCount()

long long Aws::Macie2::Model::BucketMetadata::GetClassifiableObjectCount ( ) const
inline

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.

Definition at line 329 of file BucketMetadata.h.

◆ GetClassifiableSizeInBytes()

long long Aws::Macie2::Model::BucketMetadata::GetClassifiableSizeInBytes ( ) const
inline

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.

Definition at line 362 of file BucketMetadata.h.

◆ GetErrorCode()

const BucketMetadataErrorCode& Aws::Macie2::Model::BucketMetadata::GetErrorCode ( ) const
inline

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.

Definition at line 406 of file BucketMetadata.h.

◆ GetErrorMessage()

const Aws::String& Aws::Macie2::Model::BucketMetadata::GetErrorMessage ( ) const
inline

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.

Definition at line 465 of file BucketMetadata.h.

◆ GetJobDetails()

const JobDetails& Aws::Macie2::Model::BucketMetadata::GetJobDetails ( ) const
inline

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.

Definition at line 529 of file BucketMetadata.h.

◆ GetLastUpdated()

const Aws::Utils::DateTime& Aws::Macie2::Model::BucketMetadata::GetLastUpdated ( ) const
inline

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.

Definition at line 572 of file BucketMetadata.h.

◆ GetObjectCount()

long long Aws::Macie2::Model::BucketMetadata::GetObjectCount ( ) const
inline

The total number of objects in the bucket.

Definition at line 613 of file BucketMetadata.h.

◆ GetObjectCountByEncryptionType()

const ObjectCountByEncryptionType& Aws::Macie2::Model::BucketMetadata::GetObjectCountByEncryptionType ( ) const
inline

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.

Definition at line 636 of file BucketMetadata.h.

◆ GetPublicAccess()

const BucketPublicAccess& Aws::Macie2::Model::BucketMetadata::GetPublicAccess ( ) const
inline

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.

Definition at line 679 of file BucketMetadata.h.

◆ GetRegion()

const Aws::String& Aws::Macie2::Model::BucketMetadata::GetRegion ( ) const
inline

The Amazon Web Services Region that hosts the bucket.

Definition at line 720 of file BucketMetadata.h.

◆ GetReplicationDetails()

const ReplicationDetails& Aws::Macie2::Model::BucketMetadata::GetReplicationDetails ( ) const
inline

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.

Definition at line 763 of file BucketMetadata.h.

◆ GetServerSideEncryption()

const BucketServerSideEncryption& Aws::Macie2::Model::BucketMetadata::GetServerSideEncryption ( ) const
inline

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

Definition at line 805 of file BucketMetadata.h.

◆ GetSharedAccess()

const SharedAccess& Aws::Macie2::Model::BucketMetadata::GetSharedAccess ( ) const
inline

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.

Definition at line 848 of file BucketMetadata.h.

◆ GetSizeInBytes()

long long Aws::Macie2::Model::BucketMetadata::GetSizeInBytes ( ) const
inline

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.

Definition at line 917 of file BucketMetadata.h.

◆ GetSizeInBytesCompressed()

long long Aws::Macie2::Model::BucketMetadata::GetSizeInBytesCompressed ( ) const
inline

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.

Definition at line 951 of file BucketMetadata.h.

◆ GetTags()

const Aws::Vector<KeyValuePair>& Aws::Macie2::Model::BucketMetadata::GetTags ( ) const
inline

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

Definition at line 985 of file BucketMetadata.h.

◆ GetUnclassifiableObjectCount()

const ObjectLevelStatistics& Aws::Macie2::Model::BucketMetadata::GetUnclassifiableObjectCount ( ) const
inline

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.

Definition at line 1035 of file BucketMetadata.h.

◆ GetUnclassifiableObjectSizeInBytes()

const ObjectLevelStatistics& Aws::Macie2::Model::BucketMetadata::GetUnclassifiableObjectSizeInBytes ( ) const
inline

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.

Definition at line 1078 of file BucketMetadata.h.

◆ GetVersioning()

bool Aws::Macie2::Model::BucketMetadata::GetVersioning ( ) const
inline

Specifies whether versioning is enabled for the bucket.

Definition at line 1119 of file BucketMetadata.h.

◆ JobDetailsHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::JobDetailsHasBeenSet ( ) const
inline

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.

Definition at line 536 of file BucketMetadata.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Macie2::Model::BucketMetadata::Jsonize ( ) const

◆ LastUpdatedHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::LastUpdatedHasBeenSet ( ) const
inline

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.

Definition at line 579 of file BucketMetadata.h.

◆ ObjectCountByEncryptionTypeHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::ObjectCountByEncryptionTypeHasBeenSet ( ) const
inline

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.

Definition at line 643 of file BucketMetadata.h.

◆ ObjectCountHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::ObjectCountHasBeenSet ( ) const
inline

The total number of objects in the bucket.

Definition at line 618 of file BucketMetadata.h.

◆ operator=()

BucketMetadata& Aws::Macie2::Model::BucketMetadata::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PublicAccessHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::PublicAccessHasBeenSet ( ) const
inline

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.

Definition at line 686 of file BucketMetadata.h.

◆ RegionHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::RegionHasBeenSet ( ) const
inline

The Amazon Web Services Region that hosts the bucket.

Definition at line 725 of file BucketMetadata.h.

◆ ReplicationDetailsHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::ReplicationDetailsHasBeenSet ( ) const
inline

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.

Definition at line 770 of file BucketMetadata.h.

◆ ServerSideEncryptionHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::ServerSideEncryptionHasBeenSet ( ) const
inline

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

Definition at line 811 of file BucketMetadata.h.

◆ SetAccountId() [1/3]

void Aws::Macie2::Model::BucketMetadata::SetAccountId ( Aws::String &&  value)
inline

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

Definition at line 81 of file BucketMetadata.h.

◆ SetAccountId() [2/3]

void Aws::Macie2::Model::BucketMetadata::SetAccountId ( const Aws::String value)
inline

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

Definition at line 75 of file BucketMetadata.h.

◆ SetAccountId() [3/3]

void Aws::Macie2::Model::BucketMetadata::SetAccountId ( const char *  value)
inline

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

Definition at line 87 of file BucketMetadata.h.

◆ SetAllowsUnencryptedObjectUploads() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetAllowsUnencryptedObjectUploads ( AllowsUnencryptedObjectUploads &&  value)
inline

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.

Definition at line 170 of file BucketMetadata.h.

◆ SetAllowsUnencryptedObjectUploads() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetAllowsUnencryptedObjectUploads ( const AllowsUnencryptedObjectUploads value)
inline

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.

Definition at line 154 of file BucketMetadata.h.

◆ SetBucketArn() [1/3]

void Aws::Macie2::Model::BucketMetadata::SetBucketArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the bucket.

Definition at line 223 of file BucketMetadata.h.

◆ SetBucketArn() [2/3]

void Aws::Macie2::Model::BucketMetadata::SetBucketArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the bucket.

Definition at line 218 of file BucketMetadata.h.

◆ SetBucketArn() [3/3]

void Aws::Macie2::Model::BucketMetadata::SetBucketArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the bucket.

Definition at line 228 of file BucketMetadata.h.

◆ SetBucketCreatedAt() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetBucketCreatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 268 of file BucketMetadata.h.

◆ SetBucketCreatedAt() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetBucketCreatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 262 of file BucketMetadata.h.

◆ SetBucketName() [1/3]

void Aws::Macie2::Model::BucketMetadata::SetBucketName ( Aws::String &&  value)
inline

The name of the bucket.

Definition at line 301 of file BucketMetadata.h.

◆ SetBucketName() [2/3]

void Aws::Macie2::Model::BucketMetadata::SetBucketName ( const Aws::String value)
inline

The name of the bucket.

Definition at line 296 of file BucketMetadata.h.

◆ SetBucketName() [3/3]

void Aws::Macie2::Model::BucketMetadata::SetBucketName ( const char *  value)
inline

The name of the bucket.

Definition at line 306 of file BucketMetadata.h.

◆ SetClassifiableObjectCount()

void Aws::Macie2::Model::BucketMetadata::SetClassifiableObjectCount ( long long  value)
inline

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.

Definition at line 343 of file BucketMetadata.h.

◆ SetClassifiableSizeInBytes()

void Aws::Macie2::Model::BucketMetadata::SetClassifiableSizeInBytes ( long long  value)
inline

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.

Definition at line 384 of file BucketMetadata.h.

◆ SetErrorCode() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetErrorCode ( BucketMetadataErrorCode &&  value)
inline

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.

Definition at line 436 of file BucketMetadata.h.

◆ SetErrorCode() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetErrorCode ( const BucketMetadataErrorCode value)
inline

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.

Definition at line 426 of file BucketMetadata.h.

◆ SetErrorMessage() [1/3]

void Aws::Macie2::Model::BucketMetadata::SetErrorMessage ( Aws::String &&  value)
inline

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.

Definition at line 489 of file BucketMetadata.h.

◆ SetErrorMessage() [2/3]

void Aws::Macie2::Model::BucketMetadata::SetErrorMessage ( const Aws::String value)
inline

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.

Definition at line 481 of file BucketMetadata.h.

◆ SetErrorMessage() [3/3]

void Aws::Macie2::Model::BucketMetadata::SetErrorMessage ( const char *  value)
inline

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.

Definition at line 497 of file BucketMetadata.h.

◆ SetJobDetails() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetJobDetails ( const JobDetails value)
inline

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.

Definition at line 543 of file BucketMetadata.h.

◆ SetJobDetails() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetJobDetails ( JobDetails &&  value)
inline

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.

Definition at line 550 of file BucketMetadata.h.

◆ SetLastUpdated() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetLastUpdated ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 593 of file BucketMetadata.h.

◆ SetLastUpdated() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetLastUpdated ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 586 of file BucketMetadata.h.

◆ SetObjectCount()

void Aws::Macie2::Model::BucketMetadata::SetObjectCount ( long long  value)
inline

The total number of objects in the bucket.

Definition at line 623 of file BucketMetadata.h.

◆ SetObjectCountByEncryptionType() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetObjectCountByEncryptionType ( const ObjectCountByEncryptionType value)
inline

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.

Definition at line 650 of file BucketMetadata.h.

◆ SetObjectCountByEncryptionType() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetObjectCountByEncryptionType ( ObjectCountByEncryptionType &&  value)
inline

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.

Definition at line 657 of file BucketMetadata.h.

◆ SetPublicAccess() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetPublicAccess ( BucketPublicAccess &&  value)
inline

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.

Definition at line 700 of file BucketMetadata.h.

◆ SetPublicAccess() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetPublicAccess ( const BucketPublicAccess value)
inline

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.

Definition at line 693 of file BucketMetadata.h.

◆ SetRegion() [1/3]

void Aws::Macie2::Model::BucketMetadata::SetRegion ( Aws::String &&  value)
inline

The Amazon Web Services Region that hosts the bucket.

Definition at line 735 of file BucketMetadata.h.

◆ SetRegion() [2/3]

void Aws::Macie2::Model::BucketMetadata::SetRegion ( const Aws::String value)
inline

The Amazon Web Services Region that hosts the bucket.

Definition at line 730 of file BucketMetadata.h.

◆ SetRegion() [3/3]

void Aws::Macie2::Model::BucketMetadata::SetRegion ( const char *  value)
inline

The Amazon Web Services Region that hosts the bucket.

Definition at line 740 of file BucketMetadata.h.

◆ SetReplicationDetails() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetReplicationDetails ( const ReplicationDetails value)
inline

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.

Definition at line 777 of file BucketMetadata.h.

◆ SetReplicationDetails() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetReplicationDetails ( ReplicationDetails &&  value)
inline

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.

Definition at line 784 of file BucketMetadata.h.

◆ SetServerSideEncryption() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetServerSideEncryption ( BucketServerSideEncryption &&  value)
inline

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

Definition at line 823 of file BucketMetadata.h.

◆ SetServerSideEncryption() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetServerSideEncryption ( const BucketServerSideEncryption value)
inline

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

Definition at line 817 of file BucketMetadata.h.

◆ SetSharedAccess() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetSharedAccess ( const SharedAccess value)
inline

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.

Definition at line 872 of file BucketMetadata.h.

◆ SetSharedAccess() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetSharedAccess ( SharedAccess &&  value)
inline

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.

Definition at line 884 of file BucketMetadata.h.

◆ SetSizeInBytes()

void Aws::Macie2::Model::BucketMetadata::SetSizeInBytes ( long long  value)
inline

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.

Definition at line 933 of file BucketMetadata.h.

◆ SetSizeInBytesCompressed()

void Aws::Macie2::Model::BucketMetadata::SetSizeInBytesCompressed ( long long  value)
inline

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.

Definition at line 969 of file BucketMetadata.h.

◆ SetTags() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetTags ( Aws::Vector< KeyValuePair > &&  value)
inline

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

Definition at line 1003 of file BucketMetadata.h.

◆ SetTags() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetTags ( const Aws::Vector< KeyValuePair > &  value)
inline

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

Definition at line 997 of file BucketMetadata.h.

◆ SetUnclassifiableObjectCount() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetUnclassifiableObjectCount ( const ObjectLevelStatistics value)
inline

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.

Definition at line 1049 of file BucketMetadata.h.

◆ SetUnclassifiableObjectCount() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetUnclassifiableObjectCount ( ObjectLevelStatistics &&  value)
inline

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.

Definition at line 1056 of file BucketMetadata.h.

◆ SetUnclassifiableObjectSizeInBytes() [1/2]

void Aws::Macie2::Model::BucketMetadata::SetUnclassifiableObjectSizeInBytes ( const ObjectLevelStatistics value)
inline

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.

Definition at line 1092 of file BucketMetadata.h.

◆ SetUnclassifiableObjectSizeInBytes() [2/2]

void Aws::Macie2::Model::BucketMetadata::SetUnclassifiableObjectSizeInBytes ( ObjectLevelStatistics &&  value)
inline

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.

Definition at line 1099 of file BucketMetadata.h.

◆ SetVersioning()

void Aws::Macie2::Model::BucketMetadata::SetVersioning ( bool  value)
inline

Specifies whether versioning is enabled for the bucket.

Definition at line 1129 of file BucketMetadata.h.

◆ SharedAccessHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::SharedAccessHasBeenSet ( ) const
inline

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.

Definition at line 860 of file BucketMetadata.h.

◆ SizeInBytesCompressedHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::SizeInBytesCompressedHasBeenSet ( ) const
inline

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.

Definition at line 960 of file BucketMetadata.h.

◆ SizeInBytesHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::SizeInBytesHasBeenSet ( ) const
inline

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.

Definition at line 925 of file BucketMetadata.h.

◆ TagsHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::TagsHasBeenSet ( ) const
inline

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

Definition at line 991 of file BucketMetadata.h.

◆ UnclassifiableObjectCountHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::UnclassifiableObjectCountHasBeenSet ( ) const
inline

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.

Definition at line 1042 of file BucketMetadata.h.

◆ UnclassifiableObjectSizeInBytesHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::UnclassifiableObjectSizeInBytesHasBeenSet ( ) const
inline

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.

Definition at line 1085 of file BucketMetadata.h.

◆ VersioningHasBeenSet()

bool Aws::Macie2::Model::BucketMetadata::VersioningHasBeenSet ( ) const
inline

Specifies whether versioning is enabled for the bucket.

Definition at line 1124 of file BucketMetadata.h.

◆ WithAccountId() [1/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithAccountId ( Aws::String &&  value)
inline

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

Definition at line 99 of file BucketMetadata.h.

◆ WithAccountId() [2/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithAccountId ( const Aws::String value)
inline

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

Definition at line 93 of file BucketMetadata.h.

◆ WithAccountId() [3/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithAccountId ( const char *  value)
inline

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

Definition at line 105 of file BucketMetadata.h.

◆ WithAllowsUnencryptedObjectUploads() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithAllowsUnencryptedObjectUploads ( AllowsUnencryptedObjectUploads &&  value)
inline

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.

Definition at line 202 of file BucketMetadata.h.

◆ WithAllowsUnencryptedObjectUploads() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithAllowsUnencryptedObjectUploads ( const AllowsUnencryptedObjectUploads value)
inline

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.

Definition at line 186 of file BucketMetadata.h.

◆ WithBucketArn() [1/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithBucketArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the bucket.

Definition at line 238 of file BucketMetadata.h.

◆ WithBucketArn() [2/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithBucketArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the bucket.

Definition at line 233 of file BucketMetadata.h.

◆ WithBucketArn() [3/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithBucketArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the bucket.

Definition at line 243 of file BucketMetadata.h.

◆ WithBucketCreatedAt() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithBucketCreatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 280 of file BucketMetadata.h.

◆ WithBucketCreatedAt() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithBucketCreatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 274 of file BucketMetadata.h.

◆ WithBucketName() [1/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithBucketName ( Aws::String &&  value)
inline

The name of the bucket.

Definition at line 316 of file BucketMetadata.h.

◆ WithBucketName() [2/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithBucketName ( const Aws::String value)
inline

The name of the bucket.

Definition at line 311 of file BucketMetadata.h.

◆ WithBucketName() [3/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithBucketName ( const char *  value)
inline

The name of the bucket.

Definition at line 321 of file BucketMetadata.h.

◆ WithClassifiableObjectCount()

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithClassifiableObjectCount ( long long  value)
inline

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.

Definition at line 350 of file BucketMetadata.h.

◆ WithClassifiableSizeInBytes()

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithClassifiableSizeInBytes ( long long  value)
inline

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.

Definition at line 395 of file BucketMetadata.h.

◆ WithErrorCode() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithErrorCode ( BucketMetadataErrorCode &&  value)
inline

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.

Definition at line 456 of file BucketMetadata.h.

◆ WithErrorCode() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithErrorCode ( const BucketMetadataErrorCode value)
inline

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.

Definition at line 446 of file BucketMetadata.h.

◆ WithErrorMessage() [1/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithErrorMessage ( Aws::String &&  value)
inline

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.

Definition at line 513 of file BucketMetadata.h.

◆ WithErrorMessage() [2/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithErrorMessage ( const Aws::String value)
inline

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.

Definition at line 505 of file BucketMetadata.h.

◆ WithErrorMessage() [3/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithErrorMessage ( const char *  value)
inline

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.

Definition at line 521 of file BucketMetadata.h.

◆ WithJobDetails() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithJobDetails ( const JobDetails value)
inline

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.

Definition at line 557 of file BucketMetadata.h.

◆ WithJobDetails() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithJobDetails ( JobDetails &&  value)
inline

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.

Definition at line 564 of file BucketMetadata.h.

◆ WithLastUpdated() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithLastUpdated ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 607 of file BucketMetadata.h.

◆ WithLastUpdated() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithLastUpdated ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 600 of file BucketMetadata.h.

◆ WithObjectCount()

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithObjectCount ( long long  value)
inline

The total number of objects in the bucket.

Definition at line 628 of file BucketMetadata.h.

◆ WithObjectCountByEncryptionType() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithObjectCountByEncryptionType ( const ObjectCountByEncryptionType value)
inline

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.

Definition at line 664 of file BucketMetadata.h.

◆ WithObjectCountByEncryptionType() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithObjectCountByEncryptionType ( ObjectCountByEncryptionType &&  value)
inline

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.

Definition at line 671 of file BucketMetadata.h.

◆ WithPublicAccess() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithPublicAccess ( BucketPublicAccess &&  value)
inline

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.

Definition at line 714 of file BucketMetadata.h.

◆ WithPublicAccess() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithPublicAccess ( const BucketPublicAccess value)
inline

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.

Definition at line 707 of file BucketMetadata.h.

◆ WithRegion() [1/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithRegion ( Aws::String &&  value)
inline

The Amazon Web Services Region that hosts the bucket.

Definition at line 750 of file BucketMetadata.h.

◆ WithRegion() [2/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithRegion ( const Aws::String value)
inline

The Amazon Web Services Region that hosts the bucket.

Definition at line 745 of file BucketMetadata.h.

◆ WithRegion() [3/3]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithRegion ( const char *  value)
inline

The Amazon Web Services Region that hosts the bucket.

Definition at line 755 of file BucketMetadata.h.

◆ WithReplicationDetails() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithReplicationDetails ( const ReplicationDetails value)
inline

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.

Definition at line 791 of file BucketMetadata.h.

◆ WithReplicationDetails() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithReplicationDetails ( ReplicationDetails &&  value)
inline

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.

Definition at line 798 of file BucketMetadata.h.

◆ WithServerSideEncryption() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithServerSideEncryption ( BucketServerSideEncryption &&  value)
inline

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

Definition at line 835 of file BucketMetadata.h.

◆ WithServerSideEncryption() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithServerSideEncryption ( const BucketServerSideEncryption value)
inline

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

Definition at line 829 of file BucketMetadata.h.

◆ WithSharedAccess() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithSharedAccess ( const SharedAccess value)
inline

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.

Definition at line 896 of file BucketMetadata.h.

◆ WithSharedAccess() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithSharedAccess ( SharedAccess &&  value)
inline

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.

Definition at line 908 of file BucketMetadata.h.

◆ WithSizeInBytes()

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithSizeInBytes ( long long  value)
inline

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.

Definition at line 941 of file BucketMetadata.h.

◆ WithSizeInBytesCompressed()

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithSizeInBytesCompressed ( long long  value)
inline

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.

Definition at line 978 of file BucketMetadata.h.

◆ WithTags() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithTags ( Aws::Vector< KeyValuePair > &&  value)
inline

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

Definition at line 1015 of file BucketMetadata.h.

◆ WithTags() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithTags ( const Aws::Vector< KeyValuePair > &  value)
inline

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

Definition at line 1009 of file BucketMetadata.h.

◆ WithUnclassifiableObjectCount() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithUnclassifiableObjectCount ( const ObjectLevelStatistics value)
inline

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.

Definition at line 1063 of file BucketMetadata.h.

◆ WithUnclassifiableObjectCount() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithUnclassifiableObjectCount ( ObjectLevelStatistics &&  value)
inline

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.

Definition at line 1070 of file BucketMetadata.h.

◆ WithUnclassifiableObjectSizeInBytes() [1/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithUnclassifiableObjectSizeInBytes ( const ObjectLevelStatistics value)
inline

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.

Definition at line 1106 of file BucketMetadata.h.

◆ WithUnclassifiableObjectSizeInBytes() [2/2]

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithUnclassifiableObjectSizeInBytes ( ObjectLevelStatistics &&  value)
inline

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.

Definition at line 1113 of file BucketMetadata.h.

◆ WithVersioning()

BucketMetadata& Aws::Macie2::Model::BucketMetadata::WithVersioning ( bool  value)
inline

Specifies whether versioning is enabled for the bucket.

Definition at line 1134 of file BucketMetadata.h.


The documentation for this class was generated from the following file: