From 7f8fe2832d87c1587c1efdbabea289b4521969fc Mon Sep 17 00:00:00 2001 From: Anuraag Agrawal Date: Thu, 15 Oct 2020 17:53:25 +0900 Subject: [PATCH 1/4] Add semantic conventions for the AWS SDK. --- .../instrumentation/aws-sdk.md | 772 ++++++++++++++++++ 1 file changed, 772 insertions(+) create mode 100644 specification/trace/semantic_conventions/instrumentation/aws-sdk.md diff --git a/specification/trace/semantic_conventions/instrumentation/aws-sdk.md b/specification/trace/semantic_conventions/instrumentation/aws-sdk.md new file mode 100644 index 00000000000..a0053d48521 --- /dev/null +++ b/specification/trace/semantic_conventions/instrumentation/aws-sdk.md @@ -0,0 +1,772 @@ +# AWS SDK Semantic Conventions + +These conventions apply to operations using the AWS SDK. They map request or response parameters +in AWS SDK API calls to attributes on a Span. The conventions have been collected over time based +on feedback from AWS users of tracing and will continue to increase as new interesting conventions +are found. + +Some descriptions are also provided for populating OpenTelemetry semantic conventions. + +## General +| Attribute | Type | Description | Examples | +|---|---|---|---| +|awssdk.service | string | The service name of the request, as returned by the AWS SDK | `DynamoDB`, `S3` | +|awssdk.operation | string | The operation name of the request, as returned by the AWS SDK | `GetItem`, `PutObject` | + + +The following attributes are all copied from parameters in the request or response of the SDK call. + +## DynamoDB + +### BatchGetItem +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.table_names` | string array | Extract the keys of the `RequestItems` object field in the request | +| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | + +### BatchWriteItem + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.table_names` | string array | Extract the keys of the `RequestItems` object field in the request | +| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | +| `awssdk.item_collection_metrics` | string | JSON-serialize the `ItemCollectionMetrics` response object field | + +### CreateTable + +| Attribute | Type | Description | +| --- | --- | --- | +| `db.name` | string | Copy the `TableName` request parameter | +| `awssdk.global_secondary_indexes` | string | JSON-serialize the `GlobalSecondaryIndexes` request list field | +| `awssdk.local_secondary_indexes` | string | JSON-serialize the `LocalSecondaryIndexes` request list field | +| `awssdk.provisioned_throughput. | int | d_capacity_units` - Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter | +| `awssdk.provisioned_throughput. | int | te_capacity_units` - Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter | + + +### DeleteItem + +| Attribute | Type | Description | +| --- | --- | --- | +| `db.name` | string | Copy the `TableName` request parameter | +| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | +| `awssdk.item_collection_metrics` | string | JSON-serialize the `ItemCollectionMetrics` response object field | + +### DeleteTable + +| Attribute | Type | Description | +| --- | --- | --- | +| `db.name` | string | Copy the `TableName` request parameter | + +### DescribeTable + +| Attribute | Type | Description | +| --- | --- | --- | +| `db.name` | string | Copy the `TableName` request parameter | + +### GetItem + +| Attribute | Type | Description | +| --- | --- | --- | +| `db.name` | string | Copy the `TableName` request parameter | +| `awssdk.consistent_read` | bool | Copy the `ConsistentRead` request parameter | +| `awssdk.projection_expression` | string | Copy the `ProjectionExpression` request parameter | +| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | + +### ListTables + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.exclusive_start_table_name` | string | Copy the `ExclusiveStartTableName` request parameter | +| `awssdk.limit` | int | Copy the `Limit` request parameter | +| `awssdk.table_count` | int | Fill in the number of elements in the `TableNames` response list parameter | + +### PutItem + +| Attribute | Type | Description | +| --- | --- | --- | +| `db.name` | string | Copy the `TableName` request parameter | +| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | +| `awssdk.item_collection_metrics` | string | JSON-serialize the `ItemCollectionMetrics` response object field | + +### Query + +| Attribute | Type | Description | +| --- | --- | --- | +| `db.name` | string | Copy the `TableName` request parameter | +| `awssdk.attributes_to_get` | string array | Copy the `AttributesToGet` list request parameter | +| `awssdk.consistent_read` | bool | Copy the `ConsistentRead` request parameter | +| `awssdk.index_name` | string | Copy the `IndexName` request parameter | +| `awssdk.limit` | int | Copy the `Limit` request parameter | +| `awssdk.projection_expression` | string | Copy the `ProjectionExpression` request parameter | +| `awssdk.scan_index_forward` | bool | Copy the `ScanIndexForward` request parameter | +| `awssdk.select` | string | Copy the `Select` request parameter | +| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | + +### Scan + +| Attribute | Type | Description | +| --- | --- | --- | +| `db.name` | string | Copy the `TableName` request parameter | +| `awssdk.attributes_to_get` | string array | Copy the `AttributesToGet` list request parameter | +| `awssdk.consistent_read` | bool | Copy the `ConsistentRead` request parameter | +| `awssdk.index_name` | string | Copy the `IndexName` request parameter | +| `awssdk.limit` | int | Copy the `Limit` request parameter | +| `awssdk.projection_expression` | string | Copy the `ProjectionExpression` request parameter | +| `awssdk.segment` | int | Copy the `Segment` request parameter | +| `awssdk.select` | string | Copy the `Select` request parameter | +| `awssdk.total_segments` | int | Copy the `TotalSegments` request parameter | +| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | +| `awssdk.count` | int | Copy the `Count` response parameter | +| `awssdk.scanned_count` | int | Copy the `ScannedCount` response parameter | + +### UpdateItem + +| Attribute | Type | Description | +| --- | --- | --- | +| `db.name` | string | Copy the `TableName` request parameter | +| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | +| `awssdk.item_collection_metrics` | string | JSON-serialize the `ItemCollectionMetrics` response object field | + +### UpdateTable + +| Attribute | Type | Description | +| --- | --- | --- | +| `db.name` | string | Copy the `TableName` request parameter | +| `awssdk.attribute_definitions` | string | JSON-serialize the `AttributeDefinitions` request list field | +| `awssdk.global_secondary_index_updates` | string | JSON-serialize the `GlobalSecondaryIndexUpdates` request list field | +| `awssdk.provisioned_throughput. | int | d_capacity_units` - Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter | +| `awssdk.provisioned_throughput. | int | te_capacity_units` - Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter | + +## SQS + +### AddPermission + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | +| `awssdk.label` | string | Copy the `Label` request field | + +### ChangeMessageVisibility + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | +| `awssdk.visibility_timeout` | int | Copy the `VisibilityTimeout` request field | + +### ChangeMessageVisibilityBatch + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | + +### CreateQueue + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.attributes` | string | JSON serialize the `Attributes` request field. If `Attributes` is a list of key/value pairs, pack them into an object before serializing. | +| `awssdk.queue_name` | string | Copy the `QueueName` request field | + +### DeleteMessage + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | + +### DeleteMessageBatch + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | + +### DeleteQueue + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | + +### GetQueueAttributes + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | +| `awssdk.attributes` | string | JSON serialize the `Attributes` response field. If `Attributes` is a list of key/value pairs, pack them into an object before serializing. | + +### GetQueueUrl + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` response field | +| `awssdk.queue_name` | string | Copy the `QueueName` request field | +| `awssdk.queue_owner_aws_account_id` | string | Copy the `QueueOwnerAWSAccountId` request field | + +### ListDeadLetterSourceQueues + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | +| `awssdk.queue_urls` | string array | Copy the `QueueUrls` response field | + +### ListQueues + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.queue_name_prefix` | string | Copy the `QueueNamePrefix` request field | +| `awssdk.queue_count` | int | Fill in the number of elements in the `QueueUrls` response list field | + +### PurgeQueue + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | + +### ReceiveMessage + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | +| `messaging.operation` | string | Fill in `receive` | +| `awssdk.attribute_names` | string array | Copy the `AttributeNames` request field | +| `awssdk.max_number_of_messages` | int | Copy the `MaxNumberOfMessages` request field | +| `awssdk.message_attribute_names` | string array | Copy the `MessageAttributeNames` request field | +| `awssdk.visibility_timeout` | int | Copy the `VisibilityTimeout` request field | +| `awssdk.wait_time_seconds` | int | py the `WaitTimeSeconds` request field | +| `awssdk.message_count` | int | Fill in the number of elements in the `Messages` response list field | + +### RemovePermission + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | + +### SendMessage + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | +| `messaging.message_id` | string | Copy the `MessageId` field | +| `messaging.operation` | string | Fill in `send` | +| `awssdk.delay_seconds` | int | Copy the `DelaySeconds` request field | +| `awssdk.message_attributes` | string array | Copy the keys of the `MessageAttributes` request object field | + +### SendMessageBatch + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | +| `messaging.operation` | string | Fill in `send` | +| `awssdk.message_count` | int | Fill in the number of elements in the `Messages` request list field | + +### SetQueueAttributes + +| Attribute | Type | Description | +| --- | --- | --- | +| `messaging.url` | string | Copy the `QueueUrl` request field | +| `awssdk.attribute_names` | string array | Copy the keys of the `Attributes` request object field | + +## Lambda + +Refer to the [FaaS] common attributes + +[FaaS]: ../faas.md + +### Invoke + +| Attribute | Type | Description | +| --- | --- | --- | +| `faas.invoked_name` | string | Copy the `FunctionName` request field. | +| `faas.invoked_provider` | string | Fill in `aws` | +| `faas.invoked_region` | string | Fill in the value of the region from the API endpoint (SDKs should provide this separate from the request) | +| `awssdk.invocation_type` | string | Copy the `InvocationType` request field | +| `awssdk.log_type` | string | Copy the `LogType` request field | +| `awssdk.qualifier` | string | Copy the `Qualifier` request field | +| `awssdk.function_error` | string | Copy the `X-Amz-Function-Error` response header. SDKs may present this as a `FunctionError` field | + +### InvokeAsync + +| Attribute | Type | Description | +| --- | --- | --- | +| `faas.invoked_name` | string | Copy the `FunctionName` request field. | +| `faas.invoked_provider` | string | Fill in `aws` | +| `faas.invoked_region` | string | Fill in the value of the region from the API endpoint (SDKs should provide this separate from the request) | + +## S3 + +### CopyObject + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.source_bucket_name` | string | Copy the `SourceBucketName` request field | +| `awssdk.source_key` | string | Copy the `SourceKey` request field | +| `awssdk.destination_bucket_name` | string | Copy the `DestinationBucketName` request field | +| `awssdk.destination_key` | string | Copy the `DestinationKey` request field | + +### CopyPart + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.source_bucket_name` | string | Copy the `SourceBucketName` request field | +| `awssdk.source_key` | string | Copy the `SourceKey` request field | +| `awssdk.destination_bucket_name` | string | Copy the `DestinationBucketName` request field | +| `awssdk.destination_key` | string | Copy the `DestinationKey` request field | + +### GetObject + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### PutObject + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | + +### GetObjectAcl + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### CreateBucket + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### ListObjectsV2 + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.prefix` | string | Copy the `Prefix` request field | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### ListObjects + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.prefix` | string | Copy the `Prefix` request field | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetObjectTagging + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### SetObjectTagging + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### ListVersions + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.prefix` | string | Copy the `Prefix` request field | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetObjectAcl + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### GetBucketAcl + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketAcl + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + + +### HeadBucket + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### UploadPart + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | + +### DeleteObject + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | + +### DeleteBucket + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteObjects + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteVersion + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### GetBucketPolicy + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketPolicy + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### ListParts + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | + +### RestoreObject + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### RestoreObjectV2 + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### SetBucketNotificationConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteBucketLifecycleConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketNotificationConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteBucketCrossOriginConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketCrossOriginConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketCrossOriginConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### ListBucketInventoryConfigurations + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketReplicationConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketReplicationConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteBucketReplicationConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteBucketAnalyticsConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteBucketInventoryConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### ListBucketAnalyticsConfigurations + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteObjectTagging + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### SetBucketVersioningConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketVersioningConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketWebsiteConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketLifecycleConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketLifecycleConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketTaggingConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketTaggingConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetObjectMetadata + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### GetBucketLocation + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketLoggingConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### ListMultipartUploads + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.prefix` | string | Copy the `Prefix` request field | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteBucketPolicy + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteBucketEncryption + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketAccelerateConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketWebsiteConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### CompleteMultipartUpload + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | + +### InitiateMultipartUpload + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | + +### SetBucketEncryption + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketLoggingConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteBucketWebsiteConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketEncryption + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### AbortMultipartUpload + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | + +### GeneratePresignedUrl + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | +| `awssdk.key` | string | Copy the `Key` request field | +| `awssdk.version_id` | string | Copy the `VersionId` request field | + +### DeleteBucketTaggingConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketAccelerateConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketMetricsConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### ListBucketMetricsConfigurations + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketInventoryConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketMetricsConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### SetBucketAnalyticsConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### DeleteBucketMetricsConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketAnalyticsConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +### GetBucketInventoryConfiguration + +| Attribute | Type | Description | +| --- | --- | --- | +| `awssdk.bucket_name` | string | Copy the `BucketName` request field | + +## SageMakerRuntime + +### InvokeEndpoint + +| Attribute | Type | Description | +| --- | --- | --- | +`awssdk.endpoint_name` | string | Copy the `EndpointName` request field | From b124776daf7b3602e4149219015127c3294f1cf2 Mon Sep 17 00:00:00 2001 From: Anuraag Agrawal Date: Thu, 15 Oct 2020 18:17:32 +0900 Subject: [PATCH 2/4] Lint --- .../trace/semantic_conventions/instrumentation/aws-sdk.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/specification/trace/semantic_conventions/instrumentation/aws-sdk.md b/specification/trace/semantic_conventions/instrumentation/aws-sdk.md index a0053d48521..e81b5545b20 100644 --- a/specification/trace/semantic_conventions/instrumentation/aws-sdk.md +++ b/specification/trace/semantic_conventions/instrumentation/aws-sdk.md @@ -8,17 +8,18 @@ are found. Some descriptions are also provided for populating OpenTelemetry semantic conventions. ## General + | Attribute | Type | Description | Examples | |---|---|---|---| |awssdk.service | string | The service name of the request, as returned by the AWS SDK | `DynamoDB`, `S3` | |awssdk.operation | string | The operation name of the request, as returned by the AWS SDK | `GetItem`, `PutObject` | - The following attributes are all copied from parameters in the request or response of the SDK call. ## DynamoDB ### BatchGetItem + | Attribute | Type | Description | | --- | --- | --- | | `awssdk.table_names` | string array | Extract the keys of the `RequestItems` object field in the request | @@ -42,7 +43,6 @@ The following attributes are all copied from parameters in the request or respon | `awssdk.provisioned_throughput. | int | d_capacity_units` - Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter | | `awssdk.provisioned_throughput. | int | te_capacity_units` - Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter | - ### DeleteItem | Attribute | Type | Description | @@ -261,7 +261,7 @@ The following attributes are all copied from parameters in the request or respon | Attribute | Type | Description | | --- | --- | --- | | `messaging.url` | string | Copy the `QueueUrl` request field | -| `awssdk.attribute_names` | string array | Copy the keys of the `Attributes` request object field | +| `awssdk.attribute_names` | string array | Copy the keys of the `Attributes` request object field | ## Lambda @@ -395,7 +395,6 @@ Refer to the [FaaS] common attributes | --- | --- | --- | | `awssdk.bucket_name` | string | Copy the `BucketName` request field | - ### HeadBucket | Attribute | Type | Description | From 1410a31ff37ebcd5661d44f1e7e90d7e69039e35 Mon Sep 17 00:00:00 2001 From: Anuraag Agrawal Date: Mon, 26 Oct 2020 18:16:24 +0900 Subject: [PATCH 3/4] Initial MD -> YML --- .../trace/instrumentation/aws-sdk.yml | 1089 +++++++++++++++++ .../instrumentation/aws-sdk.md | 771 ------------ 2 files changed, 1089 insertions(+), 771 deletions(-) create mode 100644 semantic_conventions/trace/instrumentation/aws-sdk.yml delete mode 100644 specification/trace/semantic_conventions/instrumentation/aws-sdk.md diff --git a/semantic_conventions/trace/instrumentation/aws-sdk.yml b/semantic_conventions/trace/instrumentation/aws-sdk.yml new file mode 100644 index 00000000000..db9fc9f7eb4 --- /dev/null +++ b/semantic_conventions/trace/instrumentation/aws-sdk.yml @@ -0,0 +1,1089 @@ +groups: + - id: awssdk + prefix: awssdk + brief: > + These conventions apply to operations using the AWS SDK. They map request or response parameters + in AWS SDK API calls to attributes on a Span. The conventions have been collected over time based + on feedback from AWS users of tracing and will continue to increase as new interesting conventions + are found. + + Some descriptions are also provided for populating OpenTelemetry semantic conventions. + attributes: + - id: service + type: string + brief: The service name of the request, as returned by the AWS SDK + examples: + - DynamoDB + - S3 + - id: operation + type: string + brief: The operation name of the request, as returned by the AWS SDK + examples: + - GetItem + - PutItem + - id: DynamoDB.BatchGetItem + extends: awssdk + attributes: + - id: table_names + type: string + brief: ray | Extract the keys of the `RequestItems` object field in the request + - id: consumed_capacity + type: string + brief: JSON-serialize the `ConsumedCapacity` response list field + + - id: DynamoDB.BatchWriteItem + extends: awssdk + attributes: + - id: table_names + type: string + brief: ray | Extract the keys of the `RequestItems` object field in the request + - id: consumed_capacity + type: string + brief: JSON-serialize the `ConsumedCapacity` response list field + - id: item_collection_metrics + type: string + brief: JSON-serialize the `ItemCollectionMetrics` response object field + + - id: DynamoDB.CreateTable + extends: awssdk + attributes: + - id: db.name + type: string + brief: Copy the `TableName` request parameter + - id: global_secondary_indexes + type: string + brief: JSON-serialize the `GlobalSecondaryIndexes` request list field + - id: local_secondary_indexes + type: string + brief: JSON-serialize the `LocalSecondaryIndexes` request list field + - id: provisioned_throughput.read_capacity_units + type: number + brief: Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter + - id: provisioned_throughput.write_capacity_units + type: number + brief: Copy the `ProvisionedThroughput.WriteCapacityUnits` request parameter + + - id: DynamoDB.DeleteItem + extends: awssdk + attributes: + - id: db.name + type: string + brief: Copy the `TableName` request parameter + - id: consumed_capacity + type: string + brief: JSON-serialize the `ConsumedCapacity` response list field + - id: item_collection_metrics + type: string + brief: JSON-serialize the `ItemCollectionMetrics` response object field + + - id: DynamoDB.DeleteTable + extends: awssdk + attributes: + - id: db.name + type: string + brief: Copy the `TableName` request parameter + + - id: DynamoDB.DescribeTable + extends: awssdk + attributes: + - id: db.name + type: string + brief: Copy the `TableName` request parameter + + - id: DynamoDB.GetItem + extends: awssdk + attributes: + - id: db.name + type: string + brief: Copy the `TableName` request parameter + - id: consistent_read + type: bool + brief: Copy the `ConsistentRead` request parameter + - id: projection_expression + type: string + brief: Copy the `ProjectionExpression` request parameter + - id: consumed_capacity + type: string + brief: JSON-serialize the `ConsumedCapacity` response list field + + - id: DynamoDB.ListTables + extends: awssdk + attributes: + - id: exclusive_start_table_name + type: string + brief: Copy the `ExclusiveStartTableName` request parameter + - id: limit + type: number + brief: Copy the `Limit` request parameter + - id: table_count + type: number + brief: Fill in the number of elements in the `TableNames` response list parameter + + - id: DynamoDB.PutItem + extends: awssdk + attributes: + - id: db.name + type: string + brief: Copy the `TableName` request parameter + - id: consumed_capacity + type: string + brief: JSON-serialize the `ConsumedCapacity` response list field + - id: item_collection_metrics + type: string + brief: JSON-serialize the `ItemCollectionMetrics` response object field + + - id: DynamoDB.Query + extends: awssdk + attributes: + - id: db.name + type: string + brief: Copy the `TableName` request parameter + - id: attributes_to_get + type: string + brief: ray | Copy the `AttributesToGet` list request parameter + - id: consistent_read + type: bool + brief: Copy the `ConsistentRead` request parameter + - id: index_name + type: string + brief: Copy the `IndexName` request parameter + - id: limit + type: number + brief: Copy the `Limit` request parameter + - id: projection_expression + type: string + brief: Copy the `ProjectionExpression` request parameter + - id: scan_index_forward + type: bool + brief: Copy the `ScanIndexForward` request parameter + - id: select + type: string + brief: Copy the `Select` request parameter + - id: consumed_capacity + type: string + brief: JSON-serialize the `ConsumedCapacity` response list field + + - id: DynamoDB.Scan + extends: awssdk + attributes: + - id: db.name + type: string + brief: Copy the `TableName` request parameter + - id: attributes_to_get + type: string + brief: ray | Copy the `AttributesToGet` list request parameter + - id: consistent_read + type: bool + brief: Copy the `ConsistentRead` request parameter + - id: index_name + type: string + brief: Copy the `IndexName` request parameter + - id: limit + type: number + brief: Copy the `Limit` request parameter + - id: projection_expression + type: string + brief: Copy the `ProjectionExpression` request parameter + - id: segment + type: number + brief: Copy the `Segment` request parameter + - id: select + type: string + brief: Copy the `Select` request parameter + - id: total_segments + type: number + brief: Copy the `TotalSegments` request parameter + - id: consumed_capacity + type: string + brief: JSON-serialize the `ConsumedCapacity` response list field + - id: count + type: number + brief: Copy the `Count` response parameter + - id: scanned_count + type: number + brief: Copy the `ScannedCount` response parameter + + - id: DynamoDB.UpdateItem + extends: awssdk + attributes: + - id: db.name + type: string + brief: Copy the `TableName` request parameter + - id: consumed_capacity + type: string + brief: JSON-serialize the `ConsumedCapacity` response list field + - id: item_collection_metrics + type: string + brief: JSON-serialize the `ItemCollectionMetrics` response object field + + - id: DynamoDB.UpdateTable + extends: awssdk + attributes: + - id: db.name + type: string + brief: Copy the `TableName` request parameter + - id: attribute_definitions + type: string + brief: JSON-serialize the `AttributeDefinitions` request list field + - id: global_secondary_index_updates + type: string + brief: JSON-serialize the `GlobalSecondaryIndexUpdates` request list field + - id: provisioned_throughput.read_capacity_units + type: number + brief: Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter + - id: provisioned_throughput.write_capacity_units + type: number + brief: Copy the `ProvisionedThroughput.WriteCapacityUnits` request parameter + + - id: SQS.AddPermission + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + - id: label + type: string + brief: Copy the `Label` request field + + - id: SQS.ChangeMessageVisibility + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + - id: visibility_timeout + type: number + brief: Copy the `VisibilityTimeout` request field + + - id: SQS.ChangeMessageVisibilityBatch + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + + - id: SQS.CreateQueue + extends: awssdk + attributes: + - id: attributes + type: string + brief: JSON serialize the `Attributes` request field. If `Attributes` is a list of key/value pairs, pack them into an object before serializing. + - id: queue_name + type: string + brief: Copy the `QueueName` request field + + - id: SQS.DeleteMessage + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + + - id: SQS.DeleteMessageBatch + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + + - id: SQS.DeleteQueue + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + + - id: SQS.GetQueueAttributes + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + - id: attributes + type: string + brief: JSON serialize the `Attributes` response field. If `Attributes` is a list of key/value pairs, pack them into an object before serializing. + + - id: SQS.GetQueueUrl + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` response field + - id: queue_name + type: string + brief: Copy the `QueueName` request field + - id: queue_owner_aws_account_id + type: string + brief: Copy the `QueueOwnerAWSAccountId` request field + + - id: SQS.ListDeadLetterSourceQueues + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + - id: queue_urls + type: string + brief: ray | Copy the `QueueUrls` response field + + - id: SQS.ListQueues + extends: awssdk + attributes: + - id: queue_name_prefix + type: string + brief: Copy the `QueueNamePrefix` request field + - id: queue_count + type: number + brief: Fill in the number of elements in the `QueueUrls` response list field + + - id: SQS.PurgeQueue + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + + - id: SQS.ReceiveMessage + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + - id: messaging.operation + type: string + brief: Fill in `receive` + - id: attribute_names + type: string + brief: ray | Copy the `AttributeNames` request field + - id: max_number_of_messages + type: number + brief: Copy the `MaxNumberOfMessages` request field + - id: message_attribute_names + type: string + brief: ray | Copy the `MessageAttributeNames` request field + - id: visibility_timeout + type: number + brief: Copy the `VisibilityTimeout` request field + - id: wait_time_seconds + type: number + brief: py the `WaitTimeSeconds` request field + - id: message_count + type: number + brief: Fill in the number of elements in the `Messages` response list field + + - id: SQS.RemovePermission + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + + - id: SQS.SendMessage + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + - id: messaging.message_id + type: string + brief: Copy the `MessageId` field + - id: messaging.operation + type: string + brief: Fill in `send` + - id: delay_seconds + type: number + brief: Copy the `DelaySeconds` request field + - id: message_attributes + type: string + brief: ray | Copy the keys of the `MessageAttributes` request object field + + - id: SQS.SendMessageBatch + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + - id: messaging.operation + type: string + brief: Fill in `send` + - id: message_count + type: number + brief: Fill in the number of elements in the `Messages` request list field + + - id: SQS.SetQueueAttributes + extends: awssdk + attributes: + - id: messaging.url + type: string + brief: Copy the `QueueUrl` request field + - id: attribute_names + type: string + brief: ray | Copy the keys of the `Attributes` request object field + + + - id: Lambda.Invoke + extends: awssdk + attributes: + - id: faas.invoked_name + type: string + brief: Copy the `FunctionName` request field. + - id: faas.invoked_provider + type: string + brief: Fill in `aws` + - id: faas.invoked_region + type: string + brief: Fill in the value of the region from the API endpoint (SDKs should provide this separate from the request) + - id: invocation_type + type: string + brief: Copy the `InvocationType` request field + - id: log_type + type: string + brief: Copy the `LogType` request field + - id: qualifier + type: string + brief: Copy the `Qualifier` request field + - id: function_error + type: string + brief: Copy the `X-Amz-Function-Error` response header. SDKs may present this as a `FunctionError` field + + - id: Lambda.InvokeAsync + extends: awssdk + attributes: + - id: faas.invoked_name + type: string + brief: Copy the `FunctionName` request field. + - id: faas.invoked_provider + type: string + brief: Fill in `aws` + - id: faas.invoked_region + type: string + brief: Fill in the value of the region from the API endpoint (SDKs should provide this separate from the request) + + - id: S3.CopyObject + extends: awssdk + attributes: + - id: source_bucket_name + type: string + brief: Copy the `SourceBucketName` request field + - id: source_key + type: string + brief: Copy the `SourceKey` request field + - id: destination_bucket_name + type: string + brief: Copy the `DestinationBucketName` request field + - id: destination_key + type: string + brief: Copy the `DestinationKey` request field + + - id: S3.CopyPart + extends: awssdk + attributes: + - id: source_bucket_name + type: string + brief: Copy the `SourceBucketName` request field + - id: source_key + type: string + brief: Copy the `SourceKey` request field + - id: destination_bucket_name + type: string + brief: Copy the `DestinationBucketName` request field + - id: destination_key + type: string + brief: Copy the `DestinationKey` request field + + - id: S3.GetObject + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.PutObject + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + + - id: S3.GetObjectAcl + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.CreateBucket + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.ListObjectsV2 + extends: awssdk + attributes: + - id: prefix + type: string + brief: Copy the `Prefix` request field + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.ListObjects + extends: awssdk + attributes: + - id: prefix + type: string + brief: Copy the `Prefix` request field + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetObjectTagging + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.SetObjectTagging + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.ListVersions + extends: awssdk + attributes: + - id: prefix + type: string + brief: Copy the `Prefix` request field + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetObjectAcl + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.GetBucketAcl + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketAcl + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.HeadBucket + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.UploadPart + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + + - id: S3.DeleteObject + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + + - id: S3.DeleteBucket + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteObjects + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteVersion + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.GetBucketPolicy + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketPolicy + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.ListParts + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + + - id: S3.RestoreObject + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.RestoreObjectV2 + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.SetBucketNotificationConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteBucketLifecycleConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketNotificationConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteBucketCrossOriginConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketCrossOriginConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketCrossOriginConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.ListBucketInventoryConfigurations + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketReplicationConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketReplicationConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteBucketReplicationConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteBucketAnalyticsConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteBucketInventoryConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.ListBucketAnalyticsConfigurations + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteObjectTagging + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.SetBucketVersioningConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketVersioningConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketWebsiteConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketLifecycleConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketLifecycleConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketTaggingConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketTaggingConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetObjectMetadata + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.GetBucketLocation + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketLoggingConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.ListMultipartUploads + extends: awssdk + attributes: + - id: prefix + type: string + brief: Copy the `Prefix` request field + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteBucketPolicy + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteBucketEncryption + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketAccelerateConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketWebsiteConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.CompleteMultipartUpload + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + + - id: S3.InitiateMultipartUpload + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + + - id: S3.SetBucketEncryption + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketLoggingConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteBucketWebsiteConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketEncryption + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.AbortMultipartUpload + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + + - id: S3.GeneratePresignedUrl + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + - id: key + type: string + brief: Copy the `Key` request field + - id: version_id + type: string + brief: Copy the `VersionId` request field + + - id: S3.DeleteBucketTaggingConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3GetBucketAccelerateConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketMetricsConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.ListBucketMetricsConfigurations + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketInventoryConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketMetricsConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.SetBucketAnalyticsConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.DeleteBucketMetricsConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketAnalyticsConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + - id: S3.GetBucketInventoryConfiguration + extends: awssdk + attributes: + - id: bucket_name + type: string + brief: Copy the `BucketName` request field + + + - id: SageMakerRuntime.InvokeEndpoint + extends: awssdk + attributes: + - id: endpoint_name + type: string + brief: Copy the `EndpointName` request field diff --git a/specification/trace/semantic_conventions/instrumentation/aws-sdk.md b/specification/trace/semantic_conventions/instrumentation/aws-sdk.md deleted file mode 100644 index e81b5545b20..00000000000 --- a/specification/trace/semantic_conventions/instrumentation/aws-sdk.md +++ /dev/null @@ -1,771 +0,0 @@ -# AWS SDK Semantic Conventions - -These conventions apply to operations using the AWS SDK. They map request or response parameters -in AWS SDK API calls to attributes on a Span. The conventions have been collected over time based -on feedback from AWS users of tracing and will continue to increase as new interesting conventions -are found. - -Some descriptions are also provided for populating OpenTelemetry semantic conventions. - -## General - -| Attribute | Type | Description | Examples | -|---|---|---|---| -|awssdk.service | string | The service name of the request, as returned by the AWS SDK | `DynamoDB`, `S3` | -|awssdk.operation | string | The operation name of the request, as returned by the AWS SDK | `GetItem`, `PutObject` | - -The following attributes are all copied from parameters in the request or response of the SDK call. - -## DynamoDB - -### BatchGetItem - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.table_names` | string array | Extract the keys of the `RequestItems` object field in the request | -| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | - -### BatchWriteItem - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.table_names` | string array | Extract the keys of the `RequestItems` object field in the request | -| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | -| `awssdk.item_collection_metrics` | string | JSON-serialize the `ItemCollectionMetrics` response object field | - -### CreateTable - -| Attribute | Type | Description | -| --- | --- | --- | -| `db.name` | string | Copy the `TableName` request parameter | -| `awssdk.global_secondary_indexes` | string | JSON-serialize the `GlobalSecondaryIndexes` request list field | -| `awssdk.local_secondary_indexes` | string | JSON-serialize the `LocalSecondaryIndexes` request list field | -| `awssdk.provisioned_throughput. | int | d_capacity_units` - Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter | -| `awssdk.provisioned_throughput. | int | te_capacity_units` - Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter | - -### DeleteItem - -| Attribute | Type | Description | -| --- | --- | --- | -| `db.name` | string | Copy the `TableName` request parameter | -| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | -| `awssdk.item_collection_metrics` | string | JSON-serialize the `ItemCollectionMetrics` response object field | - -### DeleteTable - -| Attribute | Type | Description | -| --- | --- | --- | -| `db.name` | string | Copy the `TableName` request parameter | - -### DescribeTable - -| Attribute | Type | Description | -| --- | --- | --- | -| `db.name` | string | Copy the `TableName` request parameter | - -### GetItem - -| Attribute | Type | Description | -| --- | --- | --- | -| `db.name` | string | Copy the `TableName` request parameter | -| `awssdk.consistent_read` | bool | Copy the `ConsistentRead` request parameter | -| `awssdk.projection_expression` | string | Copy the `ProjectionExpression` request parameter | -| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | - -### ListTables - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.exclusive_start_table_name` | string | Copy the `ExclusiveStartTableName` request parameter | -| `awssdk.limit` | int | Copy the `Limit` request parameter | -| `awssdk.table_count` | int | Fill in the number of elements in the `TableNames` response list parameter | - -### PutItem - -| Attribute | Type | Description | -| --- | --- | --- | -| `db.name` | string | Copy the `TableName` request parameter | -| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | -| `awssdk.item_collection_metrics` | string | JSON-serialize the `ItemCollectionMetrics` response object field | - -### Query - -| Attribute | Type | Description | -| --- | --- | --- | -| `db.name` | string | Copy the `TableName` request parameter | -| `awssdk.attributes_to_get` | string array | Copy the `AttributesToGet` list request parameter | -| `awssdk.consistent_read` | bool | Copy the `ConsistentRead` request parameter | -| `awssdk.index_name` | string | Copy the `IndexName` request parameter | -| `awssdk.limit` | int | Copy the `Limit` request parameter | -| `awssdk.projection_expression` | string | Copy the `ProjectionExpression` request parameter | -| `awssdk.scan_index_forward` | bool | Copy the `ScanIndexForward` request parameter | -| `awssdk.select` | string | Copy the `Select` request parameter | -| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | - -### Scan - -| Attribute | Type | Description | -| --- | --- | --- | -| `db.name` | string | Copy the `TableName` request parameter | -| `awssdk.attributes_to_get` | string array | Copy the `AttributesToGet` list request parameter | -| `awssdk.consistent_read` | bool | Copy the `ConsistentRead` request parameter | -| `awssdk.index_name` | string | Copy the `IndexName` request parameter | -| `awssdk.limit` | int | Copy the `Limit` request parameter | -| `awssdk.projection_expression` | string | Copy the `ProjectionExpression` request parameter | -| `awssdk.segment` | int | Copy the `Segment` request parameter | -| `awssdk.select` | string | Copy the `Select` request parameter | -| `awssdk.total_segments` | int | Copy the `TotalSegments` request parameter | -| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | -| `awssdk.count` | int | Copy the `Count` response parameter | -| `awssdk.scanned_count` | int | Copy the `ScannedCount` response parameter | - -### UpdateItem - -| Attribute | Type | Description | -| --- | --- | --- | -| `db.name` | string | Copy the `TableName` request parameter | -| `awssdk.consumed_capacity` | string | JSON-serialize the `ConsumedCapacity` response list field | -| `awssdk.item_collection_metrics` | string | JSON-serialize the `ItemCollectionMetrics` response object field | - -### UpdateTable - -| Attribute | Type | Description | -| --- | --- | --- | -| `db.name` | string | Copy the `TableName` request parameter | -| `awssdk.attribute_definitions` | string | JSON-serialize the `AttributeDefinitions` request list field | -| `awssdk.global_secondary_index_updates` | string | JSON-serialize the `GlobalSecondaryIndexUpdates` request list field | -| `awssdk.provisioned_throughput. | int | d_capacity_units` - Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter | -| `awssdk.provisioned_throughput. | int | te_capacity_units` - Copy the `ProvisionedThroughput.ReadCapacityUnits` request parameter | - -## SQS - -### AddPermission - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | -| `awssdk.label` | string | Copy the `Label` request field | - -### ChangeMessageVisibility - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | -| `awssdk.visibility_timeout` | int | Copy the `VisibilityTimeout` request field | - -### ChangeMessageVisibilityBatch - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | - -### CreateQueue - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.attributes` | string | JSON serialize the `Attributes` request field. If `Attributes` is a list of key/value pairs, pack them into an object before serializing. | -| `awssdk.queue_name` | string | Copy the `QueueName` request field | - -### DeleteMessage - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | - -### DeleteMessageBatch - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | - -### DeleteQueue - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | - -### GetQueueAttributes - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | -| `awssdk.attributes` | string | JSON serialize the `Attributes` response field. If `Attributes` is a list of key/value pairs, pack them into an object before serializing. | - -### GetQueueUrl - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` response field | -| `awssdk.queue_name` | string | Copy the `QueueName` request field | -| `awssdk.queue_owner_aws_account_id` | string | Copy the `QueueOwnerAWSAccountId` request field | - -### ListDeadLetterSourceQueues - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | -| `awssdk.queue_urls` | string array | Copy the `QueueUrls` response field | - -### ListQueues - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.queue_name_prefix` | string | Copy the `QueueNamePrefix` request field | -| `awssdk.queue_count` | int | Fill in the number of elements in the `QueueUrls` response list field | - -### PurgeQueue - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | - -### ReceiveMessage - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | -| `messaging.operation` | string | Fill in `receive` | -| `awssdk.attribute_names` | string array | Copy the `AttributeNames` request field | -| `awssdk.max_number_of_messages` | int | Copy the `MaxNumberOfMessages` request field | -| `awssdk.message_attribute_names` | string array | Copy the `MessageAttributeNames` request field | -| `awssdk.visibility_timeout` | int | Copy the `VisibilityTimeout` request field | -| `awssdk.wait_time_seconds` | int | py the `WaitTimeSeconds` request field | -| `awssdk.message_count` | int | Fill in the number of elements in the `Messages` response list field | - -### RemovePermission - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | - -### SendMessage - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | -| `messaging.message_id` | string | Copy the `MessageId` field | -| `messaging.operation` | string | Fill in `send` | -| `awssdk.delay_seconds` | int | Copy the `DelaySeconds` request field | -| `awssdk.message_attributes` | string array | Copy the keys of the `MessageAttributes` request object field | - -### SendMessageBatch - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | -| `messaging.operation` | string | Fill in `send` | -| `awssdk.message_count` | int | Fill in the number of elements in the `Messages` request list field | - -### SetQueueAttributes - -| Attribute | Type | Description | -| --- | --- | --- | -| `messaging.url` | string | Copy the `QueueUrl` request field | -| `awssdk.attribute_names` | string array | Copy the keys of the `Attributes` request object field | - -## Lambda - -Refer to the [FaaS] common attributes - -[FaaS]: ../faas.md - -### Invoke - -| Attribute | Type | Description | -| --- | --- | --- | -| `faas.invoked_name` | string | Copy the `FunctionName` request field. | -| `faas.invoked_provider` | string | Fill in `aws` | -| `faas.invoked_region` | string | Fill in the value of the region from the API endpoint (SDKs should provide this separate from the request) | -| `awssdk.invocation_type` | string | Copy the `InvocationType` request field | -| `awssdk.log_type` | string | Copy the `LogType` request field | -| `awssdk.qualifier` | string | Copy the `Qualifier` request field | -| `awssdk.function_error` | string | Copy the `X-Amz-Function-Error` response header. SDKs may present this as a `FunctionError` field | - -### InvokeAsync - -| Attribute | Type | Description | -| --- | --- | --- | -| `faas.invoked_name` | string | Copy the `FunctionName` request field. | -| `faas.invoked_provider` | string | Fill in `aws` | -| `faas.invoked_region` | string | Fill in the value of the region from the API endpoint (SDKs should provide this separate from the request) | - -## S3 - -### CopyObject - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.source_bucket_name` | string | Copy the `SourceBucketName` request field | -| `awssdk.source_key` | string | Copy the `SourceKey` request field | -| `awssdk.destination_bucket_name` | string | Copy the `DestinationBucketName` request field | -| `awssdk.destination_key` | string | Copy the `DestinationKey` request field | - -### CopyPart - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.source_bucket_name` | string | Copy the `SourceBucketName` request field | -| `awssdk.source_key` | string | Copy the `SourceKey` request field | -| `awssdk.destination_bucket_name` | string | Copy the `DestinationBucketName` request field | -| `awssdk.destination_key` | string | Copy the `DestinationKey` request field | - -### GetObject - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### PutObject - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | - -### GetObjectAcl - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### CreateBucket - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### ListObjectsV2 - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.prefix` | string | Copy the `Prefix` request field | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### ListObjects - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.prefix` | string | Copy the `Prefix` request field | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetObjectTagging - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### SetObjectTagging - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### ListVersions - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.prefix` | string | Copy the `Prefix` request field | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetObjectAcl - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### GetBucketAcl - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketAcl - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### HeadBucket - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### UploadPart - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | - -### DeleteObject - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | - -### DeleteBucket - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteObjects - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteVersion - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### GetBucketPolicy - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketPolicy - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### ListParts - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | - -### RestoreObject - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### RestoreObjectV2 - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### SetBucketNotificationConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteBucketLifecycleConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketNotificationConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteBucketCrossOriginConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketCrossOriginConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketCrossOriginConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### ListBucketInventoryConfigurations - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketReplicationConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketReplicationConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteBucketReplicationConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteBucketAnalyticsConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteBucketInventoryConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### ListBucketAnalyticsConfigurations - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteObjectTagging - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### SetBucketVersioningConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketVersioningConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketWebsiteConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketLifecycleConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketLifecycleConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketTaggingConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketTaggingConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetObjectMetadata - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### GetBucketLocation - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketLoggingConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### ListMultipartUploads - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.prefix` | string | Copy the `Prefix` request field | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteBucketPolicy - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteBucketEncryption - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketAccelerateConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketWebsiteConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### CompleteMultipartUpload - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | - -### InitiateMultipartUpload - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | - -### SetBucketEncryption - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketLoggingConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteBucketWebsiteConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketEncryption - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### AbortMultipartUpload - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | - -### GeneratePresignedUrl - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | -| `awssdk.key` | string | Copy the `Key` request field | -| `awssdk.version_id` | string | Copy the `VersionId` request field | - -### DeleteBucketTaggingConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketAccelerateConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketMetricsConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### ListBucketMetricsConfigurations - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketInventoryConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketMetricsConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### SetBucketAnalyticsConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### DeleteBucketMetricsConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketAnalyticsConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -### GetBucketInventoryConfiguration - -| Attribute | Type | Description | -| --- | --- | --- | -| `awssdk.bucket_name` | string | Copy the `BucketName` request field | - -## SageMakerRuntime - -### InvokeEndpoint - -| Attribute | Type | Description | -| --- | --- | --- | -`awssdk.endpoint_name` | string | Copy the `EndpointName` request field | From aa3b3b329ac56beb025db4c11027b971e103c2a5 Mon Sep 17 00:00:00 2001 From: Anuraag Agrawal Date: Mon, 26 Oct 2020 18:17:57 +0900 Subject: [PATCH 4/4] Fix --- semantic_conventions/README.md | 2 +- .../trace/instrumentation/aws-sdk.yml | 322 ++++++++++++------ 2 files changed, 215 insertions(+), 109 deletions(-) diff --git a/semantic_conventions/README.md b/semantic_conventions/README.md index f5425c421ae..8b963ab91ae 100644 --- a/semantic_conventions/README.md +++ b/semantic_conventions/README.md @@ -7,7 +7,7 @@ generation of semantics-related code. ## Generation These YAML files are used by the make target `table-generation` to generate consistently -formattted Markdown tables for all semantic conventions in the specification. Run it from the root of this repository using the command +formatted Markdown tables for all semantic conventions in the specification. Run it from the root of this repository using the command ``` make table-generation diff --git a/semantic_conventions/trace/instrumentation/aws-sdk.yml b/semantic_conventions/trace/instrumentation/aws-sdk.yml index db9fc9f7eb4..c0deefb51f3 100644 --- a/semantic_conventions/trace/instrumentation/aws-sdk.yml +++ b/semantic_conventions/trace/instrumentation/aws-sdk.yml @@ -21,17 +21,20 @@ groups: examples: - GetItem - PutItem - - id: DynamoDB.BatchGetItem + + - id: dynamodb.batchgetitem + brief: DynamoDB.BatchGetItem extends: awssdk attributes: - id: table_names type: string - brief: ray | Extract the keys of the `RequestItems` object field in the request + brief: Extract the keys of the `RequestItems` object field in the request - id: consumed_capacity type: string brief: JSON-serialize the `ConsumedCapacity` response list field - - id: DynamoDB.BatchWriteItem + - id: dynamodb.batchwriteitem + brief: DynamoDB.BatchWriteItem extends: awssdk attributes: - id: table_names @@ -44,7 +47,8 @@ groups: type: string brief: JSON-serialize the `ItemCollectionMetrics` response object field - - id: DynamoDB.CreateTable + - id: dynamodb.createtable + brief: DynamoDB.CreateTable extends: awssdk attributes: - id: db.name @@ -63,7 +67,8 @@ groups: type: number brief: Copy the `ProvisionedThroughput.WriteCapacityUnits` request parameter - - id: DynamoDB.DeleteItem + - id: dynamodb.deleteitem + brief: DynamoDB.DeleteItem extends: awssdk attributes: - id: db.name @@ -76,21 +81,24 @@ groups: type: string brief: JSON-serialize the `ItemCollectionMetrics` response object field - - id: DynamoDB.DeleteTable + - id: dynamodb.deletetable + brief: DynamoDB.DeleteTable extends: awssdk attributes: - id: db.name type: string brief: Copy the `TableName` request parameter - - id: DynamoDB.DescribeTable - extends: awssdk - attributes: + - id: dynamodb.describetable + brief: DynamoDB.DescribeTable + extends: awssdk + attributes: - id: db.name type: string brief: Copy the `TableName` request parameter - - id: DynamoDB.GetItem + - id: dynamodb.getitem + brief: DynamoDB.GetItem extends: awssdk attributes: - id: db.name @@ -106,7 +114,8 @@ groups: type: string brief: JSON-serialize the `ConsumedCapacity` response list field - - id: DynamoDB.ListTables + - id: dynamodb.listtables + brief: DynamoDB.ListTables extends: awssdk attributes: - id: exclusive_start_table_name @@ -119,7 +128,8 @@ groups: type: number brief: Fill in the number of elements in the `TableNames` response list parameter - - id: DynamoDB.PutItem + - id: dynamodb.putitem + brief: DynamoDB.PutItem extends: awssdk attributes: - id: db.name @@ -132,7 +142,8 @@ groups: type: string brief: JSON-serialize the `ItemCollectionMetrics` response object field - - id: DynamoDB.Query + - id: dynamodb.query + brief: DynamoDB.Query extends: awssdk attributes: - id: db.name @@ -163,7 +174,8 @@ groups: type: string brief: JSON-serialize the `ConsumedCapacity` response list field - - id: DynamoDB.Scan + - id: dynamodb.scan + brief: DynamoDB.Scan extends: awssdk attributes: - id: db.name @@ -203,7 +215,8 @@ groups: type: number brief: Copy the `ScannedCount` response parameter - - id: DynamoDB.UpdateItem + - id: dynamodb.updateitem + brief: DynamoDB.UpdateItem extends: awssdk attributes: - id: db.name @@ -216,7 +229,8 @@ groups: type: string brief: JSON-serialize the `ItemCollectionMetrics` response object field - - id: DynamoDB.UpdateTable + - id: dynamodb.updatetable + brief: DynamoDB.UpdateTable extends: awssdk attributes: - id: db.name @@ -235,7 +249,8 @@ groups: type: number brief: Copy the `ProvisionedThroughput.WriteCapacityUnits` request parameter - - id: SQS.AddPermission + - id: sqs.addpermission + brief: SQS.AddPermission extends: awssdk attributes: - id: messaging.url @@ -245,7 +260,8 @@ groups: type: string brief: Copy the `Label` request field - - id: SQS.ChangeMessageVisibility + - id: sqs.changemessagevisibility + brief: SQS.ChangeMessageVisibility extends: awssdk attributes: - id: messaging.url @@ -255,14 +271,16 @@ groups: type: number brief: Copy the `VisibilityTimeout` request field - - id: SQS.ChangeMessageVisibilityBatch + - id: sqs.changemessagevisibilitybatch + brief: SQS.ChangeMessageVisibilityBatch extends: awssdk attributes: - id: messaging.url type: string brief: Copy the `QueueUrl` request field - - id: SQS.CreateQueue + - id: sqs.createqueue + brief: SQS.CreateQueue extends: awssdk attributes: - id: attributes @@ -272,28 +290,32 @@ groups: type: string brief: Copy the `QueueName` request field - - id: SQS.DeleteMessage + - id: sqs.deletemessage + brief: SQS.DeleteMessage extends: awssdk attributes: - id: messaging.url type: string brief: Copy the `QueueUrl` request field - - id: SQS.DeleteMessageBatch + - id: sqs.deletemessagebatch + brief: SQS.DeleteMessageBatch extends: awssdk attributes: - id: messaging.url type: string brief: Copy the `QueueUrl` request field - - id: SQS.DeleteQueue + - id: sqs.deletequeue + brief: SQS.DeleteQueue extends: awssdk attributes: - id: messaging.url type: string brief: Copy the `QueueUrl` request field - - id: SQS.GetQueueAttributes + - id: sqs.getqueueattributes + brief: SQS.GetQueueAttributes extends: awssdk attributes: - id: messaging.url @@ -303,7 +325,8 @@ groups: type: string brief: JSON serialize the `Attributes` response field. If `Attributes` is a list of key/value pairs, pack them into an object before serializing. - - id: SQS.GetQueueUrl + - id: sqs.getqueueurl + brief: SQS.GetQueueUrl extends: awssdk attributes: - id: messaging.url @@ -316,7 +339,8 @@ groups: type: string brief: Copy the `QueueOwnerAWSAccountId` request field - - id: SQS.ListDeadLetterSourceQueues + - id: sqs.listdeadlettersourcequeues + brief: SQS.ListDeadLetterSourceQueues extends: awssdk attributes: - id: messaging.url @@ -326,7 +350,8 @@ groups: type: string brief: ray | Copy the `QueueUrls` response field - - id: SQS.ListQueues + - id: sqs.listqueues + brief: SQS.ListQueues extends: awssdk attributes: - id: queue_name_prefix @@ -336,14 +361,16 @@ groups: type: number brief: Fill in the number of elements in the `QueueUrls` response list field - - id: SQS.PurgeQueue + - id: sqs.purgequeue + brief: SQS.PurgeQueue extends: awssdk attributes: - id: messaging.url type: string brief: Copy the `QueueUrl` request field - - id: SQS.ReceiveMessage + - id: sqs.receivemessage + brief: SQS.ReceiveMessage extends: awssdk attributes: - id: messaging.url @@ -371,14 +398,16 @@ groups: type: number brief: Fill in the number of elements in the `Messages` response list field - - id: SQS.RemovePermission + - id: sqs.removepermission + brief: SQS.RemovePermission extends: awssdk attributes: - id: messaging.url type: string brief: Copy the `QueueUrl` request field - - id: SQS.SendMessage + - id: sqs.sendmessage + brief: SQS.SendMessage extends: awssdk attributes: - id: messaging.url @@ -397,7 +426,8 @@ groups: type: string brief: ray | Copy the keys of the `MessageAttributes` request object field - - id: SQS.SendMessageBatch + - id: sqs.sendmessagebatch + brief: SQS.SendMessageBatch extends: awssdk attributes: - id: messaging.url @@ -410,7 +440,8 @@ groups: type: number brief: Fill in the number of elements in the `Messages` request list field - - id: SQS.SetQueueAttributes + - id: sqs.setqueueattributes + brief: SQS.SetQueueAttributes extends: awssdk attributes: - id: messaging.url @@ -421,7 +452,8 @@ groups: brief: ray | Copy the keys of the `Attributes` request object field - - id: Lambda.Invoke + - id: lambda.invoke + brief: Lambda.Invoke extends: awssdk attributes: - id: faas.invoked_name @@ -446,7 +478,8 @@ groups: type: string brief: Copy the `X-Amz-Function-Error` response header. SDKs may present this as a `FunctionError` field - - id: Lambda.InvokeAsync + - id: lambda.invokeasync + brief: Lambda.InvokeAsync extends: awssdk attributes: - id: faas.invoked_name @@ -459,7 +492,8 @@ groups: type: string brief: Fill in the value of the region from the API endpoint (SDKs should provide this separate from the request) - - id: S3.CopyObject + - id: s3.copyobject + brief: S3.CopyObject extends: awssdk attributes: - id: source_bucket_name @@ -475,7 +509,8 @@ groups: type: string brief: Copy the `DestinationKey` request field - - id: S3.CopyPart + - id: s3.copypart + brief: S3.CopyPart extends: awssdk attributes: - id: source_bucket_name @@ -491,7 +526,8 @@ groups: type: string brief: Copy the `DestinationKey` request field - - id: S3.GetObject + - id: s3.getobject + brief: S3.GetObject extends: awssdk attributes: - id: bucket_name @@ -504,7 +540,8 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.PutObject + - id: s3.putobject + brief: S3.PutObject extends: awssdk attributes: - id: bucket_name @@ -514,7 +551,8 @@ groups: type: string brief: Copy the `Key` request field - - id: S3.GetObjectAcl + - id: s3.getobjectacl + brief: S3.GetObjectAcl extends: awssdk attributes: - id: bucket_name @@ -527,14 +565,16 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.CreateBucket + - id: s3.createbucket + brief: S3.CreateBucket extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.ListObjectsV2 + - id: s3.listobjectsv2 + brief: S3.ListObjectsV2 extends: awssdk attributes: - id: prefix @@ -544,7 +584,8 @@ groups: type: string brief: Copy the `BucketName` request field - - id: S3.ListObjects + - id: s3.listobjects + brief: S3.ListObjects extends: awssdk attributes: - id: prefix @@ -554,7 +595,8 @@ groups: type: string brief: Copy the `BucketName` request field - - id: S3.GetObjectTagging + - id: s3.getobjecttagging + brief: S3.GetObjectTagging extends: awssdk attributes: - id: bucket_name @@ -567,7 +609,8 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.SetObjectTagging + - id: s3.setobjecttagging + brief: S3.SetObjectTagging extends: awssdk attributes: - id: bucket_name @@ -580,7 +623,8 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.ListVersions + - id: s3.listversions + brief: S3.ListVersions extends: awssdk attributes: - id: prefix @@ -590,7 +634,8 @@ groups: type: string brief: Copy the `BucketName` request field - - id: S3.SetObjectAcl + - id: s3.setobjectacl + brief: S3.SetObjectAcl extends: awssdk attributes: - id: bucket_name @@ -603,28 +648,32 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.GetBucketAcl + - id: s3.getbucketacl + brief: S3.GetBucketAcl extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketAcl + - id: s3.setbucketacl + brief: S3.SetBucketAcl extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.HeadBucket + - id: s3.headbucket + brief: S3.HeadBucket extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.UploadPart + - id: s3.uploadpart + brief: S3.UploadPart extends: awssdk attributes: - id: bucket_name @@ -634,7 +683,8 @@ groups: type: string brief: Copy the `Key` request field - - id: S3.DeleteObject + - id: s3.deleteobject + brief: S3.DeleteObject extends: awssdk attributes: - id: bucket_name @@ -644,21 +694,24 @@ groups: type: string brief: Copy the `Key` request field - - id: S3.DeleteBucket + - id: s3.deletebucket + brief: S3.DeleteBucket extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteObjects + - id: s3.deleteobjects + brief: S3.DeleteObjects extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteVersion + - id: s3.deleteversion + brief: S3.DeleteVersion extends: awssdk attributes: - id: bucket_name @@ -671,21 +724,24 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.GetBucketPolicy + - id: s3.getbucketpolicy + brief: S3.GetBucketPolicy extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketPolicy + - id: s3.setbucketpolicy + brief: S3.SetBucketPolicy extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.ListParts + - id: s3.listparts + brief: S3.ListParts extends: awssdk attributes: - id: bucket_name @@ -695,7 +751,8 @@ groups: type: string brief: Copy the `Key` request field - - id: S3.RestoreObject + - id: s3.restoreobject + brief: S3.RestoreObject extends: awssdk attributes: - id: bucket_name @@ -708,7 +765,8 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.RestoreObjectV2 + - id: s3.restoreobjectv2 + brief: S3.RestoreObjectV2 extends: awssdk attributes: - id: bucket_name @@ -721,98 +779,112 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.SetBucketNotificationConfiguration + - id: s3.setbucketnotificationconfiguration + brief: S3.SetBucketNotificationConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteBucketLifecycleConfiguration + - id: s3.deletebucketlifecycleconfiguration + brief: S3.DeleteBucketLifecycleConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketNotificationConfiguration + - id: s3.getbucketnotificationconfiguration + brief: S3.GetBucketNotificationConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteBucketCrossOriginConfiguration + - id: s3.deletebucketcrossoriginconfiguration + brief: S3.DeleteBucketCrossOriginConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketCrossOriginConfiguration + - id: s3.setbucketcrossoriginconfiguration + brief: S3.SetBucketCrossOriginConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketCrossOriginConfiguration + - id: s3.getbucketcrossoriginconfiguration + brief: S3.GetBucketCrossOriginConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.ListBucketInventoryConfigurations + - id: s3.listbucketinventoryconfigurations + brief: S3.ListBucketInventoryConfigurations extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketReplicationConfiguration + - id: s3.getbucketreplicationconfiguration + brief: S3.GetBucketReplicationConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketReplicationConfiguration + - id: s3.setbucketreplicationconfiguration + brief: S3.SetBucketReplicationConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteBucketReplicationConfiguration + - id: s3.deletebucketreplicationconfiguration + brief: S3.DeleteBucketReplicationConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteBucketAnalyticsConfiguration + - id: s3.deletebucketanalyticsconfiguration + brief: S3.DeleteBucketAnalyticsConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteBucketInventoryConfiguration + - id: s3.deletebucketinventoryconfiguration + brief: S3.DeleteBucketInventoryConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.ListBucketAnalyticsConfigurations + - id: s3.listbucketanalyticsconfigurations + brief: S3.ListBucketAnalyticsConfigurations extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteObjectTagging + - id: s3.deleteobjecttagging + brief: S3.DeleteObjectTagging extends: awssdk attributes: - id: bucket_name @@ -825,56 +897,64 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.SetBucketVersioningConfiguration + - id: s3.setbucketversioningconfiguration + brief: S3.SetBucketVersioningConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketVersioningConfiguration + - id: s3.getbucketversioningconfiguration + brief: S3.GetBucketVersioningConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketWebsiteConfiguration + - id: s3.getbucketwebsiteconfiguration + brief: S3.GetBucketWebsiteConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketLifecycleConfiguration + - id: s3.getbucketlifecycleconfiguration + brief: S3.GetBucketLifecycleConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketLifecycleConfiguration + - id: s3.setbucketlifecycleconfiguration + brief: S3.SetBucketLifecycleConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketTaggingConfiguration + - id: s3.getbuckettaggingconfiguration + brief: S3.GetBucketTaggingConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketTaggingConfiguration + - id: s3.setbuckettaggingconfiguration + brief: S3.SetBucketTaggingConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetObjectMetadata + - id: s3.getobjectmetadata + brief: S3.GetObjectMetadata extends: awssdk attributes: - id: bucket_name @@ -887,21 +967,24 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.GetBucketLocation + - id: s3.getbucketlocation + brief: S3.GetBucketLocation extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketLoggingConfiguration + - id: s3.getbucketloggingconfiguration + brief: S3.GetBucketLoggingConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.ListMultipartUploads + - id: s3.listmultipartuploads + brief: S3.ListMultipartUploads extends: awssdk attributes: - id: prefix @@ -911,35 +994,40 @@ groups: type: string brief: Copy the `BucketName` request field - - id: S3.DeleteBucketPolicy + - id: s3.deletebucketpolicy + brief: S3.DeleteBucketPolicy extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteBucketEncryption + - id: s3.deletebucketencryption + brief: S3.DeleteBucketEncryption extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketAccelerateConfiguration + - id: s3.setbucketaccelerateconfiguration + brief: S3.SetBucketAccelerateConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketWebsiteConfiguration + - id: s3.setbucketwebsiteconfiguration + brief: S3.SetBucketWebsiteConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.CompleteMultipartUpload + - id: s3.completemultipartupload + brief: S3.CompleteMultipartUpload extends: awssdk attributes: - id: bucket_name @@ -949,7 +1037,8 @@ groups: type: string brief: Copy the `Key` request field - - id: S3.InitiateMultipartUpload + - id: s3.initiatemultipartupload + brief: S3.InitiateMultipartUpload extends: awssdk attributes: - id: bucket_name @@ -959,35 +1048,40 @@ groups: type: string brief: Copy the `Key` request field - - id: S3.SetBucketEncryption + - id: s3.setbucketencryption + brief: S3.SetBucketEncryption extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketLoggingConfiguration + - id: s3.setbucketloggingconfiguration + brief: S3.SetBucketLoggingConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteBucketWebsiteConfiguration + - id: s3.deletebucketwebsiteconfiguration + brief: S3.DeleteBucketWebsiteConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketEncryption + - id: s3.getbucketencryption + brief: S3.GetBucketEncryption extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.AbortMultipartUpload + - id: s3.abortmultipartupload + brief: S3.AbortMultipartUpload extends: awssdk attributes: - id: bucket_name @@ -997,7 +1091,8 @@ groups: type: string brief: Copy the `Key` request field - - id: S3.GeneratePresignedUrl + - id: s3.generatepresignedurl + brief: S3.GeneratePresignedUrl extends: awssdk attributes: - id: bucket_name @@ -1010,70 +1105,80 @@ groups: type: string brief: Copy the `VersionId` request field - - id: S3.DeleteBucketTaggingConfiguration + - id: s3.deletebuckettaggingconfiguration + brief: S3.DeleteBucketTaggingConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3GetBucketAccelerateConfiguration + - id: s3getbucketaccelerateconfiguration + brief: S3GetBucketAccelerateConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketMetricsConfiguration + - id: s3.getbucketmetricsconfiguration + brief: S3.GetBucketMetricsConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.ListBucketMetricsConfigurations + - id: s3.listbucketmetricsconfigurations + brief: S3.ListBucketMetricsConfigurations extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketInventoryConfiguration + - id: s3.setbucketinventoryconfiguration + brief: S3.SetBucketInventoryConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketMetricsConfiguration + - id: s3.setbucketmetricsconfiguration + brief: S3.SetBucketMetricsConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.SetBucketAnalyticsConfiguration + - id: s3.setbucketanalyticsconfiguration + brief: S3.SetBucketAnalyticsConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.DeleteBucketMetricsConfiguration + - id: s3.deletebucketmetricsconfiguration + brief: S3.DeleteBucketMetricsConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketAnalyticsConfiguration + - id: s3.getbucketanalyticsconfiguration + brief: S3.GetBucketAnalyticsConfiguration extends: awssdk attributes: - id: bucket_name type: string brief: Copy the `BucketName` request field - - id: S3.GetBucketInventoryConfiguration + - id: s3.getbucketinventoryconfiguration + brief: S3.GetBucketInventoryConfiguration extends: awssdk attributes: - id: bucket_name @@ -1081,7 +1186,8 @@ groups: brief: Copy the `BucketName` request field - - id: SageMakerRuntime.InvokeEndpoint + - id: sagemakerruntime.invokeendpoint + brief: SageMakerRuntime.InvokeEndpoint extends: awssdk attributes: - id: endpoint_name