Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . macie2 ]

get-bucket-statistics

Description

Retrieves (queries) aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-bucket-statistics
[--account-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The unique identifier for the AWS account.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

bucketCount -> (long)

The total number of buckets.

bucketCountByEffectivePermission -> (structure)

The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.

publiclyAccessible -> (long)

The total number of buckets that allow the general public to have read or write access to the bucket.

publiclyReadable -> (long)

The total number of buckets that allow the general public to have read access to the bucket.

publiclyWritable -> (long)

The total number of buckets that allow the general public to have write access to the bucket.

unknown -> (long)

The total number of buckets that Amazon Macie wasn't able to evaluate permissions settings for. Macie can't determine whether these buckets are publicly accessible.

bucketCountByEncryptionType -> (structure)

The total number of buckets, grouped by server-side encryption type. This object also reports the total number of buckets that don't encrypt objects by default.

kmsManaged -> (long)

The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt objects. These buckets use AWS KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.

s3Managed -> (long)

The total number of buckets that use an Amazon S3-managed key to encrypt objects. These buckets use Amazon S3-managed (SSE-S3) encryption.

unencrypted -> (long)

The total number of buckets that don't encrypt objects by default. Default encryption is disabled for these buckets.

bucketCountBySharedAccessType -> (structure)

The total number of buckets that are shared with another AWS account.

external -> (long)

The total number of buckets that are shared with an AWS account that isn't part of the same Amazon Macie organization.

internal -> (long)

The total number of buckets that are shared with an AWS account that's part of the same Amazon Macie organization.

notShared -> (long)

The total number of buckets that aren't shared with other AWS accounts.

unknown -> (long)

The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other AWS accounts.

classifiableObjectCount -> (long)

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.

classifiableSizeInBytes -> (long)

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.

lastUpdated -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the buckets from Amazon S3.

objectCount -> (long)

The total number of objects in the buckets.

sizeInBytes -> (long)

The total storage size, in bytes, of the buckets.

sizeInBytesCompressed -> (long)

The total compressed storage size, in bytes, of the buckets.

unclassifiableObjectCount -> (structure)

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.

fileType -> (long)

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.

storageClass -> (long)

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.

total -> (long)

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.

unclassifiableObjectSizeInBytes -> (structure)

The total storage size, in bytes, of all 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.

fileType -> (long)

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.

storageClass -> (long)

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.

total -> (long)

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.