Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MacieV2.GetBucketStatistics

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data GetBucketStatistics Source #

See: newGetBucketStatistics smart constructor.

Constructors

GetBucketStatistics'
Fields accountId :: Maybe Text The unique identifier for the Amazon Web Services account.

Instances

Instances details

ToJSON GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods toJSON :: GetBucketStatistics -> Value # toEncoding :: GetBucketStatistics -> Encoding # toJSONList :: [GetBucketStatistics] -> Value # toEncodingList :: [GetBucketStatistics] -> Encoding #
ToHeaders GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods toHeaders :: GetBucketStatistics -> [Header] #
ToPath GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods toPath :: GetBucketStatistics -> ByteString #
ToQuery GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods toQuery :: GetBucketStatistics -> QueryString #
AWSRequest GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Associated Types type AWSResponse GetBucketStatistics # Methods request :: (Service -> Service) -> GetBucketStatistics -> Request GetBucketStatistics # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBucketStatistics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBucketStatistics))) #
Generic GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Associated Types type Rep GetBucketStatistics :: Type -> Type # Methods from :: GetBucketStatistics -> Rep GetBucketStatistics x # to :: Rep GetBucketStatistics x -> GetBucketStatistics #
Read GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods readsPrec :: Int -> ReadS GetBucketStatistics # readList :: ReadS [GetBucketStatistics] # readPrec :: ReadPrec GetBucketStatistics # readListPrec :: ReadPrec [GetBucketStatistics] #
Show GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods showsPrec :: Int -> GetBucketStatistics -> ShowS # show :: GetBucketStatistics -> String # showList :: [GetBucketStatistics] -> ShowS #
NFData GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods rnf :: GetBucketStatistics -> () #
Eq GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods (==) :: GetBucketStatistics -> GetBucketStatistics -> Bool # (/=) :: GetBucketStatistics -> GetBucketStatistics -> Bool #
Hashable GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods hashWithSalt :: Int -> GetBucketStatistics -> Int # hash :: GetBucketStatistics -> Int #
type AWSResponse GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics type AWSResponse GetBucketStatistics = GetBucketStatisticsResponse
type Rep GetBucketStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics type Rep GetBucketStatistics = D1 ('MetaData "GetBucketStatistics" "Amazonka.MacieV2.GetBucketStatistics" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "GetBucketStatistics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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:

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

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.
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.
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.
bucketCountBySharedAccessType :: Maybe BucketCountBySharedAccessType
The total number of buckets that are or aren't shared with another Amazon Web Services account.
bucketStatisticsBySensitivity :: Maybe BucketStatisticsBySensitivity
The aggregated sensitive data discovery statistics for the buckets. If automated sensitive data discovery is currently disabled for your account, the value for each statistic is 0.
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.
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, 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.
lastUpdated :: Maybe ISO8601
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.
objectCount :: Maybe Integer
The total number of objects in the buckets.
sizeInBytes :: Maybe Integer
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.
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, 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.
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.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetBucketStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Associated Types type Rep GetBucketStatisticsResponse :: Type -> Type # Methods from :: GetBucketStatisticsResponse -> Rep GetBucketStatisticsResponse x # to :: Rep GetBucketStatisticsResponse x -> GetBucketStatisticsResponse #
Read GetBucketStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods readsPrec :: Int -> ReadS GetBucketStatisticsResponse # readList :: ReadS [GetBucketStatisticsResponse] # readPrec :: ReadPrec GetBucketStatisticsResponse # readListPrec :: ReadPrec [GetBucketStatisticsResponse] #
Show GetBucketStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods showsPrec :: Int -> GetBucketStatisticsResponse -> ShowS # show :: GetBucketStatisticsResponse -> String # showList :: [GetBucketStatisticsResponse] -> ShowS #
NFData GetBucketStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods rnf :: GetBucketStatisticsResponse -> () #
Eq GetBucketStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics Methods (==) :: GetBucketStatisticsResponse -> GetBucketStatisticsResponse -> Bool # (/=) :: GetBucketStatisticsResponse -> GetBucketStatisticsResponse -> Bool #
type Rep GetBucketStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetBucketStatistics type Rep GetBucketStatisticsResponse = D1 ('MetaData "GetBucketStatisticsResponse" "Amazonka.MacieV2.GetBucketStatistics" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "GetBucketStatisticsResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bucketCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "bucketCountByEffectivePermission") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketCountByEffectivePermission)) :: S1 ('MetaSel ('Just "bucketCountByEncryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketCountByEncryptionType)))) :: ((S1 ('MetaSel ('Just "bucketCountByObjectEncryptionRequirement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketCountPolicyAllowsUnencryptedObjectUploads)) :: S1 ('MetaSel ('Just "bucketCountBySharedAccessType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketCountBySharedAccessType))) :: (S1 ('MetaSel ('Just "bucketStatisticsBySensitivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketStatisticsBySensitivity)) :: S1 ('MetaSel ('Just "classifiableObjectCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :: (((S1 ('MetaSel ('Just "classifiableSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "lastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "objectCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "sizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 ('MetaSel ('Just "sizeInBytesCompressed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "unclassifiableObjectCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectLevelStatistics))) :: (S1 ('MetaSel ('Just "unclassifiableObjectSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectLevelStatistics)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetBucketStatisticsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetBucketStatisticsResponse'`
-> GetBucketStatisticsResponse

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: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: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: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:bucketCountBySharedAccessType:GetBucketStatisticsResponse', getBucketStatisticsResponse_bucketCountBySharedAccessType - The total number of buckets that are or aren't shared with another Amazon Web Services account.

$sel:bucketStatisticsBySensitivity:GetBucketStatisticsResponse', getBucketStatisticsResponse_bucketStatisticsBySensitivity - The aggregated sensitive data discovery statistics for the buckets. If automated sensitive data discovery is currently disabled for your account, the value for each statistic is 0.

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.

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

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.

GetBucketStatisticsResponse, getBucketStatisticsResponse_objectCount - The total number of objects in the buckets.

GetBucketStatisticsResponse, getBucketStatisticsResponse_sizeInBytes - 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.

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

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.

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:httpStatus:GetBucketStatisticsResponse', getBucketStatisticsResponse_httpStatus - The response's http status code.

Response Lenses

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

The total number of buckets.

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

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_bucketCountBySharedAccessType :: Lens' GetBucketStatisticsResponse (Maybe BucketCountBySharedAccessType) Source #

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

getBucketStatisticsResponse_bucketStatisticsBySensitivity :: Lens' GetBucketStatisticsResponse (Maybe BucketStatisticsBySensitivity) Source #

The aggregated sensitive data discovery statistics for the buckets. If automated sensitive data discovery is currently disabled for your account, the value for each statistic is 0.

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_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, 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.

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_objectCount :: Lens' GetBucketStatisticsResponse (Maybe Integer) Source #

The total number of objects in 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, 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.

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

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_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_httpStatus :: Lens' GetBucketStatisticsResponse Int Source #

The response's http status code.