bucket_statistics
Creates, updates, deletes, gets or lists a bucket_statistics resource.
Overview
| Name | bucket_statistics |
| Type | Resource |
| Id | aws.macie2.bucket_statistics |
Fields
The following fields are returned by SELECT queries:
- get_bucket_statistics
| Name | Datatype | Description |
|---|---|---|
bucket_count | integer (int64) | The total number of buckets. |
bucket_count_by_effective_permission | object | The total number of buckets that are publicly accessible due to a combination of permissions settings for each bucket. |
bucket_count_by_encryption_type | object | The total number of buckets whose settings do or don't specify default server-side encryption behavior for objects that are added to the buckets. |
bucket_count_by_object_encryption_requirement | object | The total number of buckets whose bucket policies do or don't require server-side encryption of objects when objects are added to the buckets. |
bucket_count_by_shared_access_type | object | The total number of buckets that are or aren't shared with other Amazon Web Services accounts, Amazon CloudFront origin access identities (OAIs), or CloudFront origin access controls (OACs). |
bucket_statistics_by_sensitivity | object | The aggregated sensitive data discovery statistics for the buckets. If automated sensitive data discovery is currently disabled for your account, the value for most statistics is 0. |
classifiable_object_count | integer (int64) | The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format. |
classifiable_size_in_bytes | integer (int64) | The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. 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 any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets. |
last_updated | string (date-time) | 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 buckets. |
object_count | integer (int64) | The total number of objects in the buckets. |
size_in_bytes | integer (int64) | The total storage size, in bytes, of the buckets. If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets. |
size_in_bytes_compressed | integer (int64) | The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the buckets. If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of the applicable objects in the buckets. |
unclassifiable_object_count | object | The total number of objects that Amazon Macie can't analyze in the buckets. 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 | object | The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_bucket_statistics | select | region | Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_bucket_statistics
Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.
SELECT
bucket_count,
bucket_count_by_effective_permission,
bucket_count_by_encryption_type,
bucket_count_by_object_encryption_requirement,
bucket_count_by_shared_access_type,
bucket_statistics_by_sensitivity,
classifiable_object_count,
classifiable_size_in_bytes,
last_updated,
object_count,
size_in_bytes,
size_in_bytes_compressed,
unclassifiable_object_count,
unclassifiable_object_size_in_bytes
FROM aws.macie2.bucket_statistics
WHERE region = '{{ region }}' -- required
;