Semantic Conventions for AWS S3

Status: Experimental

The Semantic Conventions for AWS S3 extend the general AWS SDK Semantic Conventions that describe common AWS SDK attributes in addition to the Semantic Conventions described on this page.

AttributeTypeDescriptionExamplesRequirement Level
aws.s3.bucketstringThe S3 bucket name the request refers to. Corresponds to the --bucket parameter of the S3 API operations. [1]some-bucket-nameRecommended
aws.s3.keystringThe S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations. [2]someFile.ymlRecommended
aws.s3.copy_sourcestringThe source object (in the form bucket/key) for the copy operation. [3]someFile.ymlRecommended
aws.s3.upload_idstringUpload ID that identifies the multipart upload. [4]dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJRecommended
aws.s3.deletestringThe delete request container that specifies the objects to be deleted. [5]Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=booleanRecommended
aws.s3.part_numberintThe part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000. [6]3456Recommended

[1]: The bucket attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter. This applies to almost all S3 operations except list-buckets.

[2]: The key attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter. This applies in particular to the following operations:

[3]: The copy_source attribute applies to S3 copy operations and corresponds to the --copy-source parameter of the copy-object operation within the S3 API. This applies in particular to the following operations:

[4]: The upload_id attribute applies to S3 multipart-upload operations and corresponds to the --upload-id parameter of the S3 API multipart operations. This applies in particular to the following operations:

[5]: The delete attribute is only applicable to the delete-object operation. The delete attribute corresponds to the --delete parameter of the delete-objects operation within the S3 API.

[6]: The part_number attribute is only applicable to the upload-part and upload-part-copy operations. The part_number attribute corresponds to the --part-number parameter of the upload-part operation within the S3 API.