libZSservicesZSamazonka-maciev2ZSamazonka-maciev2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MacieV2.GetBucketStatistics

Description

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

Synopsis

Creating a Request

data GetBucketStatistics Source #

See: newGetBucketStatistics smart constructor.

Constructors

GetBucketStatistics' 

Fields

Instances

Instances details
Eq GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

Read GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

Show GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

Generic GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

Associated Types

type Rep GetBucketStatistics :: Type -> Type #

NFData GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

Methods

rnf :: GetBucketStatistics -> () #

Hashable GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

ToJSON GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

AWSRequest GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

Associated Types

type AWSResponse GetBucketStatistics #

ToHeaders GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

ToPath GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

ToQuery GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

type Rep GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

type Rep GetBucketStatistics = D1 ('MetaData "GetBucketStatistics" "Amazonka.MacieV2.GetBucketStatistics" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "GetBucketStatistics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse GetBucketStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

newGetBucketStatistics :: GetBucketStatistics Source #

Create a value of GetBucketStatistics with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountId:GetBucketStatistics', getBucketStatistics_accountId - The unique identifier for the Amazon Web Services account.

Request Lenses

getBucketStatistics_accountId :: Lens' GetBucketStatistics (Maybe Text) Source #

The unique identifier for the Amazon Web Services account.

Destructuring the Response

data GetBucketStatisticsResponse Source #

See: newGetBucketStatisticsResponse smart constructor.

Constructors

GetBucketStatisticsResponse' 

Fields

  • sizeInBytesCompressed :: Maybe Integer

    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, Amazon Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of the applicable objects in the buckets.

  • lastUpdated :: Maybe POSIX

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

  • sizeInBytes :: Maybe Integer

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

    If versioning is enabled for any of the buckets, Amazon Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.

  • bucketCountBySharedAccessType :: Maybe BucketCountBySharedAccessType

    The total number of buckets that are or aren't shared with another Amazon Web Services account.

  • classifiableObjectCount :: Maybe Integer

    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.

  • unclassifiableObjectSizeInBytes :: Maybe ObjectLevelStatistics

    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.

  • unclassifiableObjectCount :: Maybe ObjectLevelStatistics

    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.

  • bucketCount :: Maybe Integer

    The total number of buckets.

  • bucketCountByEffectivePermission :: Maybe BucketCountByEffectivePermission

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

  • bucketCountByObjectEncryptionRequirement :: Maybe BucketCountPolicyAllowsUnencryptedObjectUploads

    The total number of buckets whose bucket policies do or don't require server-side encryption of objects when objects are uploaded to the buckets.

  • objectCount :: Maybe Integer

    The total number of objects in the buckets.

  • classifiableSizeInBytes :: Maybe Integer

    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, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.

  • bucketCountByEncryptionType :: Maybe BucketCountByEncryptionType

    The total number of buckets that use certain types of server-side encryption to encrypt new objects by default. This object also reports the total number of buckets that don't encrypt new objects by default.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetBucketStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

Read GetBucketStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

Show GetBucketStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

Generic GetBucketStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

Associated Types

type Rep GetBucketStatisticsResponse :: Type -> Type #

NFData GetBucketStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

type Rep GetBucketStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetBucketStatistics

type Rep GetBucketStatisticsResponse = D1 ('MetaData "GetBucketStatisticsResponse" "Amazonka.MacieV2.GetBucketStatistics" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "GetBucketStatisticsResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sizeInBytesCompressed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "lastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "sizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: ((S1 ('MetaSel ('Just "bucketCountBySharedAccessType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketCountBySharedAccessType)) :*: S1 ('MetaSel ('Just "classifiableObjectCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "unclassifiableObjectSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectLevelStatistics)) :*: S1 ('MetaSel ('Just "unclassifiableObjectCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectLevelStatistics))))) :*: ((S1 ('MetaSel ('Just "bucketCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "bucketCountByEffectivePermission") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketCountByEffectivePermission)) :*: S1 ('MetaSel ('Just "bucketCountByObjectEncryptionRequirement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketCountPolicyAllowsUnencryptedObjectUploads)))) :*: ((S1 ('MetaSel ('Just "objectCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "classifiableSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "bucketCountByEncryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketCountByEncryptionType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetBucketStatisticsResponse Source #

Create a value of GetBucketStatisticsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sizeInBytesCompressed:GetBucketStatisticsResponse', getBucketStatisticsResponse_sizeInBytesCompressed - 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, Amazon Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of the applicable objects in the buckets.

$sel:lastUpdated:GetBucketStatisticsResponse', getBucketStatisticsResponse_lastUpdated - 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 buckets.

$sel:sizeInBytes:GetBucketStatisticsResponse', getBucketStatisticsResponse_sizeInBytes - The total storage size, in bytes, of the buckets.

If versioning is enabled for any of the buckets, Amazon Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.

$sel:bucketCountBySharedAccessType:GetBucketStatisticsResponse', getBucketStatisticsResponse_bucketCountBySharedAccessType - The total number of buckets that are or aren't shared with another Amazon Web Services account.

$sel:classifiableObjectCount:GetBucketStatisticsResponse', getBucketStatisticsResponse_classifiableObjectCount - 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.

$sel:unclassifiableObjectSizeInBytes:GetBucketStatisticsResponse', getBucketStatisticsResponse_unclassifiableObjectSizeInBytes - 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.

$sel:unclassifiableObjectCount:GetBucketStatisticsResponse', getBucketStatisticsResponse_unclassifiableObjectCount - 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.

$sel:bucketCount:GetBucketStatisticsResponse', getBucketStatisticsResponse_bucketCount - The total number of buckets.

$sel:bucketCountByEffectivePermission:GetBucketStatisticsResponse', getBucketStatisticsResponse_bucketCountByEffectivePermission - The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.

$sel:bucketCountByObjectEncryptionRequirement:GetBucketStatisticsResponse', getBucketStatisticsResponse_bucketCountByObjectEncryptionRequirement - The total number of buckets whose bucket policies do or don't require server-side encryption of objects when objects are uploaded to the buckets.

$sel:objectCount:GetBucketStatisticsResponse', getBucketStatisticsResponse_objectCount - The total number of objects in the buckets.

$sel:classifiableSizeInBytes:GetBucketStatisticsResponse', getBucketStatisticsResponse_classifiableSizeInBytes - 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, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.

$sel:bucketCountByEncryptionType:GetBucketStatisticsResponse', getBucketStatisticsResponse_bucketCountByEncryptionType - The total number of buckets that use certain types of server-side encryption to encrypt new objects by default. This object also reports the total number of buckets that don't encrypt new objects by default.

$sel:httpStatus:GetBucketStatisticsResponse', getBucketStatisticsResponse_httpStatus - The response's http status code.

Response Lenses

getBucketStatisticsResponse_sizeInBytesCompressed :: Lens' GetBucketStatisticsResponse (Maybe Integer) Source #

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, Amazon Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of the applicable objects in the buckets.

getBucketStatisticsResponse_lastUpdated :: Lens' GetBucketStatisticsResponse (Maybe UTCTime) Source #

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

getBucketStatisticsResponse_sizeInBytes :: Lens' GetBucketStatisticsResponse (Maybe Integer) Source #

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

If versioning is enabled for any of the buckets, Amazon Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.

getBucketStatisticsResponse_bucketCountBySharedAccessType :: Lens' GetBucketStatisticsResponse (Maybe BucketCountBySharedAccessType) Source #

The total number of buckets that are or aren't shared with another Amazon Web Services account.

getBucketStatisticsResponse_classifiableObjectCount :: Lens' GetBucketStatisticsResponse (Maybe Integer) Source #

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.

getBucketStatisticsResponse_unclassifiableObjectSizeInBytes :: Lens' GetBucketStatisticsResponse (Maybe ObjectLevelStatistics) Source #

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.

getBucketStatisticsResponse_unclassifiableObjectCount :: Lens' GetBucketStatisticsResponse (Maybe ObjectLevelStatistics) Source #

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.

getBucketStatisticsResponse_bucketCountByEffectivePermission :: Lens' GetBucketStatisticsResponse (Maybe BucketCountByEffectivePermission) Source #

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

getBucketStatisticsResponse_bucketCountByObjectEncryptionRequirement :: Lens' GetBucketStatisticsResponse (Maybe BucketCountPolicyAllowsUnencryptedObjectUploads) Source #

The total number of buckets whose bucket policies do or don't require server-side encryption of objects when objects are uploaded to the buckets.

getBucketStatisticsResponse_classifiableSizeInBytes :: Lens' GetBucketStatisticsResponse (Maybe Integer) Source #

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, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.

getBucketStatisticsResponse_bucketCountByEncryptionType :: Lens' GetBucketStatisticsResponse (Maybe BucketCountByEncryptionType) Source #

The total number of buckets that use certain types of server-side encryption to encrypt new objects by default. This object also reports the total number of buckets that don't encrypt new objects by default.