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 |
Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.
Synopsis
- data GetBucketStatistics = GetBucketStatistics' {}
- newGetBucketStatistics :: GetBucketStatistics
- getBucketStatistics_accountId :: Lens' GetBucketStatistics (Maybe Text)
- data GetBucketStatisticsResponse = GetBucketStatisticsResponse' {
- bucketCount :: Maybe Integer
- bucketCountByEffectivePermission :: Maybe BucketCountByEffectivePermission
- bucketCountByEncryptionType :: Maybe BucketCountByEncryptionType
- bucketCountByObjectEncryptionRequirement :: Maybe BucketCountPolicyAllowsUnencryptedObjectUploads
- bucketCountBySharedAccessType :: Maybe BucketCountBySharedAccessType
- bucketStatisticsBySensitivity :: Maybe BucketStatisticsBySensitivity
- classifiableObjectCount :: Maybe Integer
- classifiableSizeInBytes :: Maybe Integer
- lastUpdated :: Maybe ISO8601
- objectCount :: Maybe Integer
- sizeInBytes :: Maybe Integer
- sizeInBytesCompressed :: Maybe Integer
- unclassifiableObjectCount :: Maybe ObjectLevelStatistics
- unclassifiableObjectSizeInBytes :: Maybe ObjectLevelStatistics
- httpStatus :: Int
- newGetBucketStatisticsResponse :: Int -> GetBucketStatisticsResponse
- getBucketStatisticsResponse_bucketCount :: Lens' GetBucketStatisticsResponse (Maybe Integer)
- getBucketStatisticsResponse_bucketCountByEffectivePermission :: Lens' GetBucketStatisticsResponse (Maybe BucketCountByEffectivePermission)
- getBucketStatisticsResponse_bucketCountByEncryptionType :: Lens' GetBucketStatisticsResponse (Maybe BucketCountByEncryptionType)
- getBucketStatisticsResponse_bucketCountByObjectEncryptionRequirement :: Lens' GetBucketStatisticsResponse (Maybe BucketCountPolicyAllowsUnencryptedObjectUploads)
- getBucketStatisticsResponse_bucketCountBySharedAccessType :: Lens' GetBucketStatisticsResponse (Maybe BucketCountBySharedAccessType)
- getBucketStatisticsResponse_bucketStatisticsBySensitivity :: Lens' GetBucketStatisticsResponse (Maybe BucketStatisticsBySensitivity)
- getBucketStatisticsResponse_classifiableObjectCount :: Lens' GetBucketStatisticsResponse (Maybe Integer)
- getBucketStatisticsResponse_classifiableSizeInBytes :: Lens' GetBucketStatisticsResponse (Maybe Integer)
- getBucketStatisticsResponse_lastUpdated :: Lens' GetBucketStatisticsResponse (Maybe UTCTime)
- getBucketStatisticsResponse_objectCount :: Lens' GetBucketStatisticsResponse (Maybe Integer)
- getBucketStatisticsResponse_sizeInBytes :: Lens' GetBucketStatisticsResponse (Maybe Integer)
- getBucketStatisticsResponse_sizeInBytesCompressed :: Lens' GetBucketStatisticsResponse (Maybe Integer)
- getBucketStatisticsResponse_unclassifiableObjectCount :: Lens' GetBucketStatisticsResponse (Maybe ObjectLevelStatistics)
- getBucketStatisticsResponse_unclassifiableObjectSizeInBytes :: Lens' GetBucketStatisticsResponse (Maybe ObjectLevelStatistics)
- getBucketStatisticsResponse_httpStatus :: Lens' GetBucketStatisticsResponse Int
Creating a Request
data GetBucketStatistics Source #
See: newGetBucketStatistics
smart constructor.
Instances
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.
GetBucketStatisticsResponse' | |
|
Instances
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: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.