Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

BucketMetadata

import type { BucketMetadata } from "https://aws-api.deno.dev/v0.4/services/macie2.ts?docs=full";

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 occurs when Macie attempts to retrieve and process metadata from Amazon S3 for the bucket or the bucket's objects, the value for the versioning property is false and the value for most other properties is null. Key exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of the error, refer to the errorCode and errorMessage values.

interface BucketMetadata {

accountId?: string | null;

allowsUnencryptedObjectUploads?: AllowsUnencryptedObjectUploads | null;

bucketArn?: string | null;

bucketCreatedAt?: Date | number | null;

bucketName?: string | null;

classifiableObjectCount?: number | null;

classifiableSizeInBytes?: number | null;

errorCode?: BucketMetadataErrorCode | null;

errorMessage?: string | null;

jobDetails?: JobDetails | null;

lastAutomatedDiscoveryTime?: Date | number | null;

lastUpdated?: Date | number | null;

objectCount?: number | null;

objectCountByEncryptionType?: ObjectCountByEncryptionType | null;

publicAccess?: BucketPublicAccess | null;

region?: string | null;

replicationDetails?: ReplicationDetails | null;

sensitivityScore?: number | null;

serverSideEncryption?: BucketServerSideEncryption | null;

sharedAccess?: SharedAccess | null;

sizeInBytes?: number | null;

sizeInBytesCompressed?: number | null;

tags?: KeyValuePair[] | null;

unclassifiableObjectCount?: ObjectLevelStatistics | null;

unclassifiableObjectSizeInBytes?: ObjectLevelStatistics | null;

versioning?: boolean | null;

}

§Properties

accountId?: string | null

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

allowsUnencryptedObjectUploads?: AllowsUnencryptedObjectUploads | null

Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:

FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.
TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.
UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

bucketArn?: string | null

The Amazon Resource Name (ARN) of the bucket.

bucketCreatedAt?: Date | number | null

The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket.

bucketName?: string | null

The name of the bucket.

classifiableObjectCount?: number | null

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.

classifiableSizeInBytes?: number | null

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.

errorCode?: BucketMetadataErrorCode | null

The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is 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. If this value is null, Macie was able to retrieve and process the information.

errorMessage?: string | null

A brief description of the error (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.

jobDetails?: JobDetails | null

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

lastAutomatedDiscoveryTime?: Date | number | null

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.

lastUpdated?: Date | number | null

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the bucket.

objectCount?: number | null

The total number of objects in the bucket.

objectCountByEncryptionType?: ObjectCountByEncryptionType | null

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.

publicAccess?: BucketPublicAccess | null

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.

region?: string | null

The Amazon Web Services Region that hosts the bucket.

replicationDetails?: ReplicationDetails | null

Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.

sensitivityScore?: number | null

The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.

serverSideEncryption?: BucketServerSideEncryption | null

Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.

sharedAccess?: SharedAccess | null

Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:

EXTERNAL - The bucket is shared with one or more of the following or any combination of the following: an Amazon Web Services account that isn't part of your Amazon Macie organization, a CloudFront OAI, or a CloudFront OAC.
INTERNAL - The bucket is shared with one or more Amazon Web Services accounts that are part of your Amazon Macie organization. It isn't shared with a CloudFront OAI or OAC.
NOT_SHARED - The bucket isn't shared with another Amazon Web Services account, a CloudFront OAI, or a CloudFront OAC.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

sizeInBytes?: number | null

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.

sizeInBytesCompressed?: number | null

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.

tags?: KeyValuePair[] | null

An array that specifies the tags (keys and values) that are associated with the bucket.

unclassifiableObjectCount?: ObjectLevelStatistics | null

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.

unclassifiableObjectSizeInBytes?: ObjectLevelStatistics | null

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.

versioning?: boolean | null

Specifies whether versioning is enabled for the bucket.