Semantic conventions for AWS DynamoDB client operations

Status: Development

The Semantic Conventions for AWS DynamoDB extend and override the general AWS SDK Semantic Conventions and Database Semantic Conventions.

Spans

Spans representing calls to AWS DynamoDB adhere to the general Semantic Conventions for Database Client Spans.

DynamoDB.BatchGetItem

Status:

This span represents a DynamoDB.BatchGetItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.consumed_capacity	string[]	The JSON-serialized value of each item in the ConsumedCapacity response field.	["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]	Recommended
aws.dynamodb.table_names	string[]	The keys in the RequestItems object field.	["Users", "Cats"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.BatchWriteItem

Status:

This span represents a DynamoDB.BatchWriteItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.consumed_capacity	string[]	The JSON-serialized value of each item in the ConsumedCapacity response field.	["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]	Recommended
aws.dynamodb.item_collection_metrics	string	The JSON-serialized value of the ItemCollectionMetrics response field.	{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }	Recommended
aws.dynamodb.table_names	string[]	The keys in the RequestItems object field.	["Users", "Cats"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.CreateTable

Status:

This span represents a DynamoDB.CreateTable call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.consumed_capacity	string[]	The JSON-serialized value of each item in the ConsumedCapacity response field.	["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]	Recommended
aws.dynamodb.global_secondary_indexes	string[]	The JSON-serialized value of each item of the GlobalSecondaryIndexes request field	["{ \"IndexName\": \"string\", \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" }, \"ProvisionedThroughput\": { \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }"]	Recommended
aws.dynamodb.item_collection_metrics	string	The JSON-serialized value of the ItemCollectionMetrics response field.	{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }	Recommended
aws.dynamodb.local_secondary_indexes	string[]	The JSON-serialized value of each item of the LocalSecondaryIndexes request field.	["{ \"IndexArn\": \"string\", \"IndexName\": \"string\", \"IndexSizeBytes\": number, \"ItemCount\": number, \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" } }"]	Recommended
aws.dynamodb.provisioned_read_capacity	double	The value of the ProvisionedThroughput.ReadCapacityUnits request parameter.	1.0; 2.0	Recommended
aws.dynamodb.provisioned_write_capacity	double	The value of the ProvisionedThroughput.WriteCapacityUnits request parameter.	1.0; 2.0	Recommended
aws.dynamodb.table_names	string[]	A single-element array with the value of the TableName request parameter.	["Users"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.DeleteItem

Status:

This span represents a DynamoDB.DeleteItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.consumed_capacity	string[]	The JSON-serialized value of each item in the ConsumedCapacity response field.	["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]	Recommended
aws.dynamodb.item_collection_metrics	string	The JSON-serialized value of the ItemCollectionMetrics response field.	{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }	Recommended
aws.dynamodb.table_names	string[]	A single-element array with the value of the TableName request parameter.	["Users"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.DeleteTable

Status:

This span represents a DynamoDB.DeleteTable call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.table_names	string[]	A single-element array with the value of the TableName request parameter.	["Users"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.DescribeTable

Status:

This span represents a DynamoDB.DescribeTable call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.table_names	string[]	A single-element array with the value of the TableName request parameter.	["Users"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.GetItem

Status:

This span represents a DynamoDB.GetItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.consistent_read	boolean	The value of the ConsistentRead request parameter.		Recommended
aws.dynamodb.consumed_capacity	string[]	The JSON-serialized value of each item in the ConsumedCapacity response field.	["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]	Recommended
aws.dynamodb.projection	string	The value of the ProjectionExpression request parameter.	Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews	Recommended
aws.dynamodb.table_names	string[]	A single-element array with the value of the TableName request parameter.	["Users"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.ListTables

Status:

This span represents a DynamoDB.ListTables call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.exclusive_start_table	string	The value of the ExclusiveStartTableName request parameter.	Users; CatsTable	Recommended
aws.dynamodb.limit	int	The value of the Limit request parameter.	10	Recommended
aws.dynamodb.table_count	int	The number of items in the TableNames response parameter.	20	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.PutItem

Status:

This span represents a DynamoDB.PutItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.consumed_capacity	string[]	The JSON-serialized value of each item in the ConsumedCapacity response field.	["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]	Recommended
aws.dynamodb.item_collection_metrics	string	The JSON-serialized value of the ItemCollectionMetrics response field.	{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }	Recommended
aws.dynamodb.table_names	string[]	The keys in the RequestItems object field.	["Users", "Cats"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.Query

Status:

This span represents a DynamoDB.Query call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.attributes_to_get	string[]	The value of the AttributesToGet request parameter.	["lives", "id"]	Recommended
aws.dynamodb.consistent_read	boolean	The value of the ConsistentRead request parameter.		Recommended
aws.dynamodb.consumed_capacity	string[]	The JSON-serialized value of each item in the ConsumedCapacity response field.	["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]	Recommended
aws.dynamodb.index_name	string	The value of the IndexName request parameter.	name_to_group	Recommended
aws.dynamodb.limit	int	The value of the Limit request parameter.	10	Recommended
aws.dynamodb.projection	string	The value of the ProjectionExpression request parameter.	Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews	Recommended
aws.dynamodb.scan_forward	boolean	The value of the ScanIndexForward request parameter.		Recommended
aws.dynamodb.select	string	The value of the Select request parameter.	ALL_ATTRIBUTES; COUNT	Recommended
aws.dynamodb.table_names	string[]	A single-element array with the value of the TableName request parameter.	["Users"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.Scan

Status:

This span represents a DynamoDB.Scan call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.attributes_to_get	string[]	The value of the AttributesToGet request parameter.	["lives", "id"]	Recommended
aws.dynamodb.consistent_read	boolean	The value of the ConsistentRead request parameter.		Recommended
aws.dynamodb.consumed_capacity	string[]	The JSON-serialized value of each item in the ConsumedCapacity response field.	["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]	Recommended
aws.dynamodb.count	int	The value of the Count response parameter.	10	Recommended
aws.dynamodb.index_name	string	The value of the IndexName request parameter.	name_to_group	Recommended
aws.dynamodb.limit	int	The value of the Limit request parameter.	10	Recommended
aws.dynamodb.projection	string	The value of the ProjectionExpression request parameter.	Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews	Recommended
aws.dynamodb.scanned_count	int	The value of the ScannedCount response parameter.	50	Recommended
aws.dynamodb.segment	int	The value of the Segment request parameter.	10	Recommended
aws.dynamodb.select	string	The value of the Select request parameter.	ALL_ATTRIBUTES; COUNT	Recommended
aws.dynamodb.table_names	string[]	A single-element array with the value of the TableName request parameter.	["Users"]	Recommended
aws.dynamodb.total_segments	int	The value of the TotalSegments request parameter.	100	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.UpdateItem

Status:

This span represents a DynamoDB.UpdateItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.consumed_capacity	string[]	The JSON-serialized value of each item in the ConsumedCapacity response field.	["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]	Recommended
aws.dynamodb.item_collection_metrics	string	The JSON-serialized value of the ItemCollectionMetrics response field.	{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }	Recommended
aws.dynamodb.table_names	string[]	A single-element array with the value of the TableName request parameter.	["Users"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

DynamoDB.UpdateTable

Status:

This span represents a DynamoDB.UpdateTable call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
rpc.system	string	The value aws-api.	aws-api	Required
aws.extended_request_id	string	The AWS extended request ID as returned in the response header x-amz-id-2.	wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=	Conditionally Required If available.
aws.dynamodb.attribute_definitions	string[]	The JSON-serialized value of each item in the AttributeDefinitions request field.	["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"]	Recommended
aws.dynamodb.consumed_capacity	string[]	The JSON-serialized value of each item in the ConsumedCapacity response field.	["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]	Recommended
aws.dynamodb.global_secondary_index_updates	string[]	The JSON-serialized value of each item in the GlobalSecondaryIndexUpdates request field.	["{ \"Create\": { \"IndexName\": \"string\", \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" }, \"ProvisionedThroughput\": { \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }"]	Recommended
aws.dynamodb.provisioned_read_capacity	double	The value of the ProvisionedThroughput.ReadCapacityUnits request parameter.	1.0; 2.0	Recommended
aws.dynamodb.provisioned_write_capacity	double	The value of the ProvisionedThroughput.WriteCapacityUnits request parameter.	1.0; 2.0	Recommended
aws.dynamodb.table_names	string[]	A single-element array with the value of the TableName request parameter.	["Users"]	Recommended
aws.request_id	string	The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.	79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ	Recommended
cloud.region	string	The AWS Region where the requested service is being accessed. [1]	us-east-1; us-west-2	Recommended
rpc.method	string	The name of the operation corresponding to the request, as returned by the AWS SDK [2]	GetItem; PutItem	Recommended
rpc.service	string	The name of the service to which a request is made, as returned by the AWS SDK. [3]	DynamoDB; S3	Recommended

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
apache_dubbo	Apache Dubbo
connect_rpc	Connect RPC
dotnet_wcf	.NET WCF
grpc	gRPC
java_rmi	Java RMI

Metrics

AWS DynamoDB client instrumentations SHOULD collect metrics according to the general Semantic Conventions for Database Client Metrics.

db.system.name MUST be set to "aws.dynamodb".