[ 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--account-id (string)

The unique identifier for the AWS account.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

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.

bucketCountByEncryptionType -> (structure)

The total number of buckets, grouped by server-side encryption type. This object also reports the total number of buckets that aren’t encrypted.

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 any other AWS accounts.

classifiableObjectCount -> (long)

The total number of objects that Amazon Macie can analyze in all the buckets. These objects use a file format, file extension, or content type that Amazon Macie supports.

lastUpdated -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last analyzed the buckets.

objectCount -> (long)

The total number of objects in all the buckets.

sizeInBytes -> (long)

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

sizeInBytesCompressed -> (long)

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