AWS AmazonS3 documentation change
Summary
Clarified documentation for DELETE record types, added note about permanent delete column values, and standardized boolean values to uppercase (TRUE/FALSE)
Security assessment
Changes improve documentation clarity about delete markers and data schema behavior but do not address security vulnerabilities or introduce security features. The note about permanent delete NULL values helps users understand data representation but doesn't indicate a security fix.
Diff
diff --git a/AmazonS3/latest/userguide/metadata-tables-schema.md b/AmazonS3/latest/userguide/metadata-tables-schema.md index dd857944e..b706ab616 100644 --- a//AmazonS3/latest/userguide/metadata-tables-schema.md +++ b//AmazonS3/latest/userguide/metadata-tables-schema.md @@ -41 +41,5 @@ Column name | Required? | Data type | -`record_type` | Yes | String | The type of this record, one of `CREATE`, `UPDATE_METADATA`, or `DELETE`. `CREATE` records indicate that a new object (or a new version of the object) was written to the bucket. `UPDATE_METADATA` records capture changes to mutable metadata for an existing object, such as the storage class or tags. `DELETE` records indicate that this object (or this version of the object) has been deleted. When versioning is enabled, `DELETE` records represent either a delete marker or a permanent delete. Delete markers have a `record_type` value of `DELETE` and an `is_delete_marker` value of `True`. Permanent delete records have null values in all other columns except `bucket`, `key`, `sequence_number`, `record_type`, `record_timestamp`, and `version_id`. For more information, see [Deleting object versions from a versioning-enabled bucket](./DeletingObjectVersions.html). +`record_type` | Yes | String | The type of this record, one of `CREATE`, `UPDATE_METADATA`, or `DELETE`. `CREATE` records indicate that a new object (or a new version of the object) was written to the bucket. `UPDATE_METADATA` records capture changes to mutable metadata for an existing object, such as the storage class or tags. `DELETE` records indicate that this object (or this version of the object) has been deleted. When versioning is enabled, `DELETE` records represent either a delete marker or a permanent delete. They are further disambiguated by consulting the optional `is_delete_marker` column. For more information, see [Deleting object versions from a versioning-enabled bucket](./DeletingObjectVersions.html). + +###### Note + +A permanent delete carries `NULL`s in all columns, _except_ `bucket`, `key`, `sequence_number`, `record_type`, `record_timestamp`, and `version_id` (i.e. those columns marked as Required). @@ -44 +48 @@ Column name | Required? | Data type | -`is_delete_marker` | No | Boolean | The object's delete marker status. If the object is a delete marker, this value is `True`. Otherwise, it's `False`. For more information, see [Working with delete markers](./DeleteMarker.html). +`is_delete_marker` | No | Boolean | The object's delete marker status. For DELETE records that are delete markers, this value is `TRUE`. For permanent deletions, this value is omitted (`NULL`). Other record types (CREATE and UPDATE_METADATA) have value `FALSE`. For more information, see [Working with delete markers](./DeleteMarker.html). @@ -49 +53 @@ Rows that are added for delete markers have a `record_type` value of `DELETE`, n -`size` | No | Long | The object size in bytes, not including the size of incomplete multipart uploads or object metadata. If `is_delete_marker` is `True`, the size is `0`. For more information, see [System-defined object metadata](./UsingMetadata.html#SysMetadata). +`size` | No | Long | The object size in bytes, not including the size of incomplete multipart uploads or object metadata. If `is_delete_marker` is `TRUE`, the size is `0`. For more information, see [System-defined object metadata](./UsingMetadata.html#SysMetadata). @@ -53 +57 @@ Rows that are added for delete markers have a `record_type` value of `DELETE`, n -`is_multipart` | No | Boolean | The object's upload type. If the object was uploaded as a multipart upload, this value is `True`. Otherwise, it's `False`. For more information, see [Uploading and copying objects using multipart upload in Amazon S3](./mpuoverview.html). +`is_multipart` | No | Boolean | The object's upload type. If the object was uploaded as a multipart upload, this value is `TRUE`. Otherwise, it's `FALSE`. For more information, see [Uploading and copying objects using multipart upload in Amazon S3](./mpuoverview.html). @@ -55 +59 @@ Rows that are added for delete markers have a `record_type` value of `DELETE`, n -`is_bucket_key_enabled` | No | Boolean | The object's S3 Bucket Key enablement status. If the object uses an S3 Bucket Key for SSE-KMS, this value is `True`. Otherwise, it's `False`. For more information, see [Configuring an S3 Bucket Key at the object level](./configuring-bucket-key-object.html). +`is_bucket_key_enabled` | No | Boolean | The object's S3 Bucket Key enablement status. If the object uses an S3 Bucket Key for SSE-KMS, this value is `TRUE`. Otherwise, it's `FALSE`. For more information, see [Configuring an S3 Bucket Key at the object level](./configuring-bucket-key-object.html).