Skip to content

Commit b84ace0

Browse files
author
awstools
committed
docs(client-keyspaces): Documentation updates for Amazon Keyspaces
1 parent f77c77f commit b84ace0

File tree

3 files changed

+27
-9
lines changed

3 files changed

+27
-9
lines changed

clients/client-keyspaces/src/commands/GetTableAutoScalingSettingsCommand.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,24 @@ export interface GetTableAutoScalingSettingsCommandOutput
3535
* <p>Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing
3636
* your table's read and write capacity automatically in response to application traffic. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
3737
* Guide</i>.</p>
38+
* <important>
39+
* <p>
40+
* <code>GetTableAutoScalingSettings</code> can't be used as an action in an IAM policy.</p>
41+
* </important>
42+
* <p>To define permissions for <code>GetTableAutoScalingSettings</code>, you must allow the following two actions in the IAM policy statement's
43+
* <code>Action</code> element:</p>
44+
* <ul>
45+
* <li>
46+
* <p>
47+
* <code>application-autoscaling:DescribeScalableTargets</code>
48+
* </p>
49+
* </li>
50+
* <li>
51+
* <p>
52+
* <code>application-autoscaling:DescribeScalingPolicies</code>
53+
* </p>
54+
* </li>
55+
* </ul>
3856
* @example
3957
* Use a bare-bones client and the command you need to make an API call.
4058
* ```javascript

clients/client-keyspaces/src/models/models_0.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ export interface AutoScalingPolicy {
8282
* <p>The optional auto scaling settings for a table with provisioned throughput capacity.</p>
8383
* <p>To turn on auto scaling for a table in <code>throughputMode:PROVISIONED</code>,
8484
* you must specify the following parameters. </p>
85-
* <p>Configure the minimum and maximum units for write and read capacity. The auto scaling policy ensures that capacity never goes below the
86-
* minimum or above the maximum range.</p>
85+
* <p>Configure the minimum and maximum capacity units. The auto scaling policy ensures that
86+
* capacity never goes below the minimum or above the maximum range.</p>
8787
* <ul>
8888
* <li>
8989
* <p>
@@ -99,7 +99,7 @@ export interface AutoScalingPolicy {
9999
* <li>
100100
* <p>
101101
* <code>scalingPolicy</code>: Amazon Keyspaces supports the <code>target tracking</code> scaling policy.
102-
* The auto scaling target is the provisioned read and write capacity of the table.
102+
* The auto scaling target is the provisioned capacity of the table.
103103
* </p>
104104
* <ul>
105105
* <li>
@@ -171,7 +171,7 @@ export interface AutoScalingSettings {
171171

172172
/**
173173
* @public
174-
* <p>The optional auto scaling settings for read and write capacity of a table in provisioned capacity mode.</p>
174+
* <p>The optional auto scaling capacity settings for a table in provisioned capacity mode.</p>
175175
*/
176176
export interface AutoScalingSpecification {
177177
/**
@@ -1046,7 +1046,7 @@ export interface CreateTableRequest {
10461046
* automatically on your behalf.</p>
10471047
* <p>Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing
10481048
* your table's read and write capacity automatically in response to application traffic. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
1049-
* Guide</i>.</p>
1049+
* Guide</i>.</p>
10501050
* <p>By default, auto scaling is disabled for a table. </p>
10511051
*/
10521052
autoScalingSpecification?: AutoScalingSpecification;

codegen/sdk-codegen/aws-models/keyspaces.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
}
7676
},
7777
"traits": {
78-
"smithy.api#documentation": "<p>The optional auto scaling settings for a table with provisioned throughput capacity.</p>\n <p>To turn on auto scaling for a table in <code>throughputMode:PROVISIONED</code>, \n you must specify the following parameters. </p>\n <p>Configure the minimum and maximum units for write and read capacity. The auto scaling policy ensures that capacity never goes below the \n minimum or above the maximum range.</p>\n <ul>\n <li>\n <p>\n <code>minimumUnits</code>: The minimum level of throughput the table should always be ready to support. The value must be between 1 \n and the max throughput per second quota for your account (40,000 by default).</p>\n </li>\n <li>\n <p>\n <code>maximumUnits</code>: The maximum level of throughput the table should always be ready to\n support. The value must be between 1 and the max throughput per second quota for your\n account (40,000 by default).</p>\n </li>\n <li>\n <p>\n <code>scalingPolicy</code>: Amazon Keyspaces supports the <code>target tracking</code> scaling policy. \n The auto scaling target is the provisioned read and write capacity of the table. \n </p>\n <ul>\n <li>\n <p>\n <code>targetTrackingScalingPolicyConfiguration</code>: To define the target tracking policy, you must define the target value.\n </p>\n <ul>\n <li>\n <p>\n <code>targetValue</code>: The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of\n consumed capacity to provisioned capacity stays at or near this value. You\n define <code>targetValue</code> as a percentage. A <code>double</code> between 20 and 90. (Required)</p>\n </li>\n <li>\n <p>\n <code>disableScaleIn</code>: A <code>boolean</code> that specifies if <code>scale-in</code> is\n disabled or enabled for the table. This parameter is disabled by default.\n To turn on <code>scale-in</code>, set the <code>boolean</code> value to\n <code>FALSE</code>. This means that capacity for a table can be\n automatically scaled down on your behalf. (Optional) </p>\n </li>\n <li>\n <p>\n <code>scaleInCooldown</code>: A cooldown period in seconds between scaling activities that lets the table stabilize \n before another scale in activity starts. If no value is provided, the default is 0. (Optional) </p>\n </li>\n <li>\n <p>\n <code>scaleOutCooldown</code>: A cooldown period in seconds between scaling activities that lets the table stabilize \n before another scale out activity starts. If no value is provided, the default is 0. (Optional) </p>\n </li>\n </ul>\n </li>\n </ul>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html\">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer\n Guide</i>.</p>"
78+
"smithy.api#documentation": "<p>The optional auto scaling settings for a table with provisioned throughput capacity.</p>\n <p>To turn on auto scaling for a table in <code>throughputMode:PROVISIONED</code>, \n you must specify the following parameters. </p>\n <p>Configure the minimum and maximum capacity units. The auto scaling policy ensures that\n capacity never goes below the minimum or above the maximum range.</p>\n <ul>\n <li>\n <p>\n <code>minimumUnits</code>: The minimum level of throughput the table should always be ready to support. The value must be between 1 \n and the max throughput per second quota for your account (40,000 by default).</p>\n </li>\n <li>\n <p>\n <code>maximumUnits</code>: The maximum level of throughput the table should always be ready to\n support. The value must be between 1 and the max throughput per second quota for your\n account (40,000 by default).</p>\n </li>\n <li>\n <p>\n <code>scalingPolicy</code>: Amazon Keyspaces supports the <code>target tracking</code> scaling policy. \n The auto scaling target is the provisioned capacity of the table. \n </p>\n <ul>\n <li>\n <p>\n <code>targetTrackingScalingPolicyConfiguration</code>: To define the target tracking policy, you must define the target value.\n </p>\n <ul>\n <li>\n <p>\n <code>targetValue</code>: The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of\n consumed capacity to provisioned capacity stays at or near this value. You\n define <code>targetValue</code> as a percentage. A <code>double</code> between 20 and 90. (Required)</p>\n </li>\n <li>\n <p>\n <code>disableScaleIn</code>: A <code>boolean</code> that specifies if <code>scale-in</code> is\n disabled or enabled for the table. This parameter is disabled by default.\n To turn on <code>scale-in</code>, set the <code>boolean</code> value to\n <code>FALSE</code>. This means that capacity for a table can be\n automatically scaled down on your behalf. (Optional) </p>\n </li>\n <li>\n <p>\n <code>scaleInCooldown</code>: A cooldown period in seconds between scaling activities that lets the table stabilize \n before another scale in activity starts. If no value is provided, the default is 0. (Optional) </p>\n </li>\n <li>\n <p>\n <code>scaleOutCooldown</code>: A cooldown period in seconds between scaling activities that lets the table stabilize \n before another scale out activity starts. If no value is provided, the default is 0. (Optional) </p>\n </li>\n </ul>\n </li>\n </ul>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html\">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer\n Guide</i>.</p>"
7979
}
8080
},
8181
"com.amazonaws.keyspaces#AutoScalingSpecification": {
@@ -95,7 +95,7 @@
9595
}
9696
},
9797
"traits": {
98-
"smithy.api#documentation": "<p>The optional auto scaling settings for read and write capacity of a table in provisioned capacity mode.</p>"
98+
"smithy.api#documentation": "<p>The optional auto scaling capacity settings for a table in provisioned capacity mode.</p>"
9999
}
100100
},
101101
"com.amazonaws.keyspaces#BooleanObject": {
@@ -466,7 +466,7 @@
466466
"autoScalingSpecification": {
467467
"target": "com.amazonaws.keyspaces#AutoScalingSpecification",
468468
"traits": {
469-
"smithy.api#documentation": "<p>The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity \n automatically on your behalf.</p>\n <p>Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing \n your table's read and write capacity automatically in response to application traffic. For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html\">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer\n Guide</i>.</p>\n <p>By default, auto scaling is disabled for a table. </p>"
469+
"smithy.api#documentation": "<p>The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity \n automatically on your behalf.</p>\n <p>Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing \n your table's read and write capacity automatically in response to application traffic. For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html\">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer\n Guide</i>.</p>\n <p>By default, auto scaling is disabled for a table. </p>"
470470
}
471471
},
472472
"replicaSpecifications": {
@@ -774,7 +774,7 @@
774774
}
775775
],
776776
"traits": {
777-
"smithy.api#documentation": "<p>Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the \n Amazon Web Services Region specific auto scaling settings of the table are included.</p>\n <p>Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing \n your table's read and write capacity automatically in response to application traffic. For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html\">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer\n Guide</i>.</p>"
777+
"smithy.api#documentation": "<p>Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the \n Amazon Web Services Region specific auto scaling settings of the table are included.</p>\n <p>Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing \n your table's read and write capacity automatically in response to application traffic. For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html\">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer\n Guide</i>.</p>\n <important>\n <p>\n <code>GetTableAutoScalingSettings</code> can't be used as an action in an IAM policy.</p>\n </important>\n <p>To define permissions for <code>GetTableAutoScalingSettings</code>, you must allow the following two actions in the IAM policy statement's \n <code>Action</code> element:</p>\n <ul>\n <li>\n <p>\n <code>application-autoscaling:DescribeScalableTargets</code>\n </p>\n </li>\n <li>\n <p>\n <code>application-autoscaling:DescribeScalingPolicies</code>\n </p>\n </li>\n </ul>"
778778
}
779779
},
780780
"com.amazonaws.keyspaces#GetTableAutoScalingSettingsRequest": {

0 commit comments

Comments
 (0)