Skip to content

MatchingBucket

Source code in docs_src/capo_macie2/types/matching_bucket.py
class MatchingBucket(TypedDict, closed=True):
    account_id: NotRequired["capo_macie2.types.__string.__string"]
    """<p>The unique identifier for the Amazon Web Services account that owns the bucket.</p>"""
    automated_discovery_monitoring_status: NotRequired[
        "capo_macie2.types.automated_discovery_monitoring_status.AutomatedDiscoveryMonitoringStatus"
    ]
    """<p>Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.</p>"""
    bucket_name: NotRequired["capo_macie2.types.__string.__string"]
    """<p>The name of the bucket.</p>"""
    classifiable_object_count: NotRequired["capo_macie2.types.__long.__long"]
    """<p>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.</p>"""
    classifiable_size_in_bytes: NotRequired["capo_macie2.types.__long.__long"]
    """<p>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.</p> <p>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.</p>"""
    error_code: NotRequired[
        "capo_macie2.types.bucket_metadata_error_code.BucketMetadataErrorCode"
    ]
    """<p>The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. Possible values are:</p> <ul><li><p>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.</p></li> <li><p>BUCKET_COUNT_EXCEEDS_QUOTA - Retrieving and processing the information would exceed the quota for the number of buckets that Macie monitors for an account (10,000).</p></li></ul> <p>If this value is null, Macie was able to retrieve and process the information.</p>"""
    error_message: NotRequired["capo_macie2.types.__string.__string"]
    """<p>A brief description of the error or issue (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.</p>"""
    job_details: NotRequired["capo_macie2.types.job_details.JobDetails"]
    """<p>Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.</p>"""
    last_automated_discovery_time: NotRequired[
        "capo_macie2.types.__timestamp_iso8601.__timestampIso8601"
    ]
    """<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed objects in the bucket while performing automated sensitive data discovery. This value is null if this analysis hasn't occurred.</p>"""
    object_count: NotRequired["capo_macie2.types.__long.__long"]
    """<p>The total number of objects in the bucket.</p>"""
    object_count_by_encryption_type: NotRequired[
        "capo_macie2.types.object_count_by_encryption_type.ObjectCountByEncryptionType"
    ]
    """<p>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.</p>"""
    sensitivity_score: NotRequired["capo_macie2.types.__integer.__integer"]
    """<p>The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive).</p><p>If automated sensitive data discovery has never been enabled for your account or it's been disabled for your organization or standalone account for more than 30 days, possible values are: 1, the bucket is empty; or, 50, the bucket stores objects but it's been excluded from recent analyses.</p>"""
    size_in_bytes: NotRequired["capo_macie2.types.__long.__long"]
    """<p>The total storage size, in bytes, of the bucket.</p> <p>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.</p>"""
    size_in_bytes_compressed: NotRequired["capo_macie2.types.__long.__long"]
    """<p>The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.</p> <p>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.</p>"""
    unclassifiable_object_count: NotRequired[
        "capo_macie2.types.object_level_statistics.ObjectLevelStatistics"
    ]
    """<p>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.</p>"""
    unclassifiable_object_size_in_bytes: NotRequired[
        "capo_macie2.types.object_level_statistics.ObjectLevelStatistics"
    ]
    """<p>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.</p>"""

account_id instance-attribute

account_id: NotRequired[__string]

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

automated_discovery_monitoring_status instance-attribute

automated_discovery_monitoring_status: NotRequired[AutomatedDiscoveryMonitoringStatus]

Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.

bucket_name instance-attribute

bucket_name: NotRequired[__string]

The name of the bucket.

classifiable_object_count instance-attribute

classifiable_object_count: NotRequired[__long]

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 instance-attribute

classifiable_size_in_bytes: NotRequired[__long]

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 instance-attribute

error_code: NotRequired[BucketMetadataErrorCode]

The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. Possible values are:

  • ACCESS_DENIED - Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request.

  • BUCKET_COUNT_EXCEEDS_QUOTA - Retrieving and processing the information would exceed the quota for the number of buckets that Macie monitors for an account (10,000).

If this value is null, Macie was able to retrieve and process the information.

error_message instance-attribute

error_message: NotRequired[__string]

A brief description of the error or issue (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.

job_details instance-attribute

job_details: NotRequired[JobDetails]

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

last_automated_discovery_time instance-attribute

last_automated_discovery_time: NotRequired[__timestampIso8601]

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed objects in the bucket while performing automated sensitive data discovery. This value is null if this analysis hasn't occurred.

object_count instance-attribute

object_count: NotRequired[__long]

The total number of objects in the bucket.

object_count_by_encryption_type instance-attribute

object_count_by_encryption_type: NotRequired[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.

sensitivity_score instance-attribute

sensitivity_score: NotRequired[__integer]

The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive).

If automated sensitive data discovery has never been enabled for your account or it's been disabled for your organization or standalone account for more than 30 days, possible values are: 1, the bucket is empty; or, 50, the bucket stores objects but it's been excluded from recent analyses.

size_in_bytes instance-attribute

size_in_bytes: NotRequired[__long]

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 instance-attribute

size_in_bytes_compressed: NotRequired[__long]

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.

unclassifiable_object_count instance-attribute

unclassifiable_object_count: NotRequired[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 instance-attribute

unclassifiable_object_size_in_bytes: NotRequired[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.