AWS amazondynamodb documentation change
Summary
Updated documentation to use plural forms ('keys') consistently when referring to partition keys and sort keys. Changed phrases like 'partition key' to 'partition keys' and 'has a sort key' to 'has sort keys' throughout the document for grammatical accuracy.
Security assessment
The changes are grammatical improvements and terminology consistency updates (pluralization of 'key' to 'keys'). There is no evidence of security vulnerability fixes, security incident references, or new security features being documented. The updates clarify billing mechanics and monitoring behavior but don't impact security controls or address security weaknesses.
Diff
diff --git a/amazondynamodb/latest/developerguide/contributorinsights_HowItWorks.md b/amazondynamodb/latest/developerguide/contributorinsights_HowItWorks.md index f7d72f4bd..281cf6710 100644 --- a//amazondynamodb/latest/developerguide/contributorinsights_HowItWorks.md +++ b//amazondynamodb/latest/developerguide/contributorinsights_HowItWorks.md @@ -83 +83 @@ You can switch between modes at any time using the DynamoDB console, AWS CLI, or - * Throttled key CloudWatch rules remain intact, maintaining your continuous historical data for throttling metrics: + * Throttled keys CloudWatch rules remain intact, maintaining your continuous historical data for throttling metrics: @@ -106 +106 @@ In _accessed and throttled keys_ mode, DynamoDB creates the following rules: - * **Most accessed items (partition key)** — Identifies the partition keys of the most accessed items in your table or global secondary index. + * **Most accessed items (partition keys)** — Identifies the partition keys of the most accessed items in your table or global secondary index. @@ -110 +110 @@ CloudWatch rule name format: `DynamoDBContributorInsights-PKC-[resource_name]-[c - * **Most throttled keys (partition key)** — Identifies the partition keys of the most throttled items in your table or global secondary index. + * **Most throttled keys (partition keys)** — Identifies the partition keys of the most throttled items in your table or global secondary index. @@ -117 +117 @@ CloudWatch rule name format: `DynamoDBContributorInsights-PKT-[resource_name]-[c -If your table or global secondary index has a sort key, DynamoDB also creates the following rules specific to sort keys: +If your table or global secondary index has sort keys, DynamoDB also creates the following rules specific to sort keys: @@ -141 +141 @@ CloudWatch rule name format: `DynamoDBContributorInsights-PKT-[resource_name]-[c -If your table or global secondary index has a sort key, DynamoDB also creates: +If your table or global secondary index has sort keys, DynamoDB also creates: @@ -199 +199 @@ If you see several closely clustered lines without any obvious outliers, it indi -If your table or global secondary index has a sort key, DynamoDB creates two graphs: one for the most accessed partition keys and one for the most accessed partition + sort key pairs. You can see traffic at the partition key level in the partition key–only graph. You can see traffic at the item level in the partition + sort key graphs. +If your table or global secondary index has sort keys, DynamoDB creates two graphs: one for the most accessed partition keys and one for the most accessed partition + sort keys pairs. You can see traffic at the partition keys level in the partition key–only graph. You can see traffic at the item level in the partition + sort keys graphs. @@ -213 +213 @@ If you see no data in this graph, it indicates that your requests are not being -If your table or global secondary index has a sort key, DynamoDB creates two graphs: one for most throttled partition keys and one for most throttled partition + sort key pairs. You can see throttle count at the partition key level in the partition key-only graph, and throttle count at the item-level in the partition + sort key graphs. +If your table or global secondary index has sort keys, DynamoDB creates two graphs: one for most throttled partition keys and one for most throttled partition + sort keys pairs. You can see throttle count at the partition keys level in the partition keys-only graph, and throttle count at the item-level in the partition + sort keys graphs. @@ -221 +221 @@ In _throttled keys_ mode, this is the only type of graph you'll see. The absence -The following example shows the reports generated for a table with both a partition key and sort key in _accessed and throttled keys_ modes. In _throttled keys_ mode, you see only the throttling-related portion of this report. +The following example shows the reports generated for a table with both a partition keys and sort keys in _accessed and throttled keys_ modes. In _throttled keys_ mode, you see only the throttling-related portion of this report. @@ -269 +269 @@ The two Contributor Insights modes have different billing characteristics. - * **Accessed and throttled keys mode billing** \- In this mode, each item that is written or read via a [data plane](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.API.html#HowItWorks.API.DataPlane) operation represents one event, regardless of whether the request succeeds or is throttled. If a table or global secondary index includes a sort key, each item that is read or written represents two events. This is because DynamoDB is identifying top contributors from separate time series: one for partitions keys only, and one for partition and sort key pairs. + * **Accessed and throttled keys mode billing** \- In this mode, each item that is written or read via a [data plane](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.API.html#HowItWorks.API.DataPlane) operation represents one event, regardless of whether the request succeeds or is throttled. If a table or global secondary index includes sort keys, each item that is read or written represents two events. This is because DynamoDB is identifying top contributors from separate time series: one for partitions keys only, and one for partition and sort keys pairs. @@ -271 +271 @@ The two Contributor Insights modes have different billing characteristics. - * **Throttled keys mode billing** \- In this mode, only throttled requests generate billable events. Events are only generated when requests result in `ProvisionedThroughputExceededException`, `ThrottlingException`, or `RequestLimitExceeded` errors. If a table or global secondary index includes a sort key, each throttled item represents two events (partition key tracking and partition + sort key tracking). + * **Throttled keys mode billing** \- In this mode, only throttled requests generate billable events. Events are only generated when requests result in `ProvisionedThroughputExceededException`, `ThrottlingException`, or `RequestLimitExceeded` errors. If a table or global secondary index includes sort keys, each throttled item represents two events (partition keys tracking and partition + sort keys tracking). @@ -282 +282 @@ For example, assume that your application performs the following DynamoDB operat - * If your table or global secondary index has only a partition key, it results in 7 events (1 for the `GetItem`, 1 for the `PutItem`, and 5 for the `BatchWriteItem`). + * If your table or global secondary index has only a partition keys, it results in 7 events (1 for the `GetItem`, 1 for the `PutItem`, and 5 for the `BatchWriteItem`). @@ -284 +284 @@ For example, assume that your application performs the following DynamoDB operat - * If your table or global secondary index has a partition key and sort key, it results in 14 events (2 for the `GetItem`, 2 for the `PutItem`, and 10 for the `BatchWriteItem`). + * If your table or global secondary index has a partition keys and sort keys, it results in 14 events (2 for the `GetItem`, 2 for the `PutItem`, and 10 for the `BatchWriteItem`). @@ -288 +288 @@ For example, assume that your application performs the following DynamoDB operat - * If your table or global secondary index has only a partition key, it results in 1 event (only for the throttled `PutItem`). + * If your table or global secondary index has only a partition keys, it results in 1 event (only for the throttled `PutItem`). @@ -290 +290 @@ For example, assume that your application performs the following DynamoDB operat - * If your table or global secondary index has a partition key and sort key, it results in 2 events (2 for the throttled `PutItem`). + * If your table or global secondary index has a partition keys and sort keys, it results in 2 events (2 for the throttled `PutItem`).