Module Values.MatchingBucketSource

Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see How Macie monitors Amazon S3 data security in the Amazon Macie User Guide. If an error or issue prevents Macie from retrieving and processing information about the bucket or the bucket's objects, the value for many of these properties is null. Key exceptions are accountId and bucketName. To identify the cause, refer to the errorCode and errorMessage values.

Sourcetype nonrec t = {
  1. accountId : string option;
    (*

    The unique identifier for the Amazon Web Services account that owns the bucket.

    *)
  2. automatedDiscoveryMonitoringStatus : AutomatedDiscoveryMonitoringStatus.t option;
    (*

    Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.

    *)
  3. bucketName : string option;
    (*

    The name of the bucket.

    *)
  4. classifiableObjectCount : Awso.Import.Int64.t option;
    (*

    The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

    *)
  5. classifiableSizeInBytes : Awso.Import.Int64.t option;
    (*

    The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. 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 the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

    *)
  6. errorCode : BucketMetadataErrorCode.t option;
    (*

    The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. Possible values are: ACCESS_DENIED - Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. BUCKET_COUNT_EXCEEDS_QUOTA - Retrieving and processing the information would exceed the quota for the number of buckets that Macie monitors for an account (10,000). If this value is null, Macie was able to retrieve and process the information.

    *)
  7. errorMessage : string option;
    (*

    A brief description of the error or issue (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.

    *)
  8. jobDetails : JobDetails.t option;
    (*

    Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.

    *)
  9. lastAutomatedDiscoveryTime : string option;
    (*

    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed objects in the bucket while performing automated sensitive data discovery. This value is null if this analysis hasn't occurred.

    *)
  10. objectCount : Awso.Import.Int64.t option;
    (*

    The total number of objects in the bucket.

    *)
  11. objectCountByEncryptionType : ObjectCountByEncryptionType.t option;
    (*

    The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

    *)
  12. sensitivityScore : int option;
    (*

    The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive).If automated sensitive data discovery has never been enabled for your account or it's been disabled for your organization or standalone account for more than 30 days, possible values are: 1, the bucket is empty; or, 50, the bucket stores objects but it's been excluded from recent analyses.

    *)
  13. sizeInBytes : Awso.Import.Int64.t option;
    (*

    The total storage size, in bytes, of the bucket. If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.

    *)
  14. sizeInBytesCompressed : Awso.Import.Int64.t option;
    (*

    The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket. If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

    *)
  15. unclassifiableObjectCount : ObjectLevelStatistics.t option;
    (*

    The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

    *)
  16. unclassifiableObjectSizeInBytes : ObjectLevelStatistics.t option;
    (*

    The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

    *)
}
Sourceval make : ?accountId:??? -> ?automatedDiscoveryMonitoringStatus:??? -> ?bucketName:??? -> ?classifiableObjectCount:??? -> ?classifiableSizeInBytes:??? -> ?errorCode:??? -> ?errorMessage:??? -> ?jobDetails:??? -> ?lastAutomatedDiscoveryTime:??? -> ?objectCount:??? -> ?objectCountByEncryptionType:??? -> ?sensitivityScore:??? -> ?sizeInBytes:??? -> ?sizeInBytesCompressed:??? -> ?unclassifiableObjectCount:??? -> ?unclassifiableObjectSizeInBytes:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of int | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Enum of string | `Long of Awso.Import.Int64.t | `String of string | `Timestamp of string ]) list | `Timestamp of string ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t