Skip to content

Commit f640491

Browse files
author
awstools
committed
docs(client-dynamodb): Doc only update for GSI descriptions.
1 parent d20379b commit f640491

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

clients/client-dynamodb/src/endpoint/ruleset.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,5 +57,5 @@ O=[s],
5757
P=[w,{[U]:g,[V]:[{[W]:"AccountIdEndpointMode"},"required"]}],
5858
Q=[A],
5959
R=[{[W]:"ResourceArn"}];
60-
const _data={version:"1.0",parameters:{Region:n,UseDualStack:o,UseFIPS:o,Endpoint:n,AccountId:n,AccountIdEndpointMode:n,ResourceArn:n,ResourceArnList:{[S]:a,[T]:"stringArray"}},rules:[{conditions:[{[U]:b,[V]:[{[W]:"Endpoint"}]}],rules:[{conditions:M,error:"Invalid Configuration: FIPS and custom endpoint are not supported",[T]:c},{conditions:N,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",[T]:c},{endpoint:{url:"{Endpoint}",[X]:r,[Y]:r},[T]:d}],[T]:e},{conditions:[{[U]:b,[V]:O}],rules:[{conditions:[{[U]:"aws.partition",[V]:O,assign:f}],rules:[{conditions:[{[U]:g,[V]:[s,"local"]}],rules:[{conditions:M,error:"Invalid Configuration: FIPS and local endpoint are not supported",[T]:c},{conditions:N,error:"Invalid Configuration: Dualstack and local endpoint are not supported",[T]:c},{endpoint:{url:"http://localhost:8000",[X]:{authSchemes:[{signingRegion:"us-east-1",signingName:h,name:"sigv4"}]},[Y]:r},[T]:d}],[T]:e},{conditions:[p,q],rules:[{conditions:[t,u],rules:[v,{endpoint:{url:"https://dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",[X]:r,[Y]:r},[T]:d}],[T]:e},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",[T]:c}],[T]:e},{conditions:M,rules:[{conditions:[t],rules:[{conditions:[{[U]:g,[V]:[y,"aws-us-gov"]}],rules:[v,z],[T]:e},v,{endpoint:{url:"https://dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}",[X]:r,[Y]:r},[T]:d}],[T]:e},{error:"FIPS is enabled but this partition does not support FIPS",[T]:c}],[T]:e},{conditions:N,rules:[{conditions:[u],rules:[{conditions:P,rules:[{conditions:Q,rules:[B],[T]:e},x],[T]:e},{endpoint:{url:"https://dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}",[X]:r,[Y]:r},[T]:d}],[T]:e},{error:"DualStack is enabled but this partition does not support DualStack",[T]:c}],[T]:e},{conditions:[w,C,D,A,E,{[U]:b,[V]:R},{[U]:j,[V]:R,assign:k},F,G,H,I],endpoint:J,[T]:d},{conditions:[w,C,D,A,E,{[U]:b,[V]:[K]},{[U]:i,[V]:[K,"[0]"],assign:m},{[U]:j,[V]:[{[W]:m}],assign:k},F,G,H,I],endpoint:J,[T]:d},{conditions:[w,C,D,A,E,{[U]:b,[V]:[L]}],rules:[{conditions:[{[U]:l,[V]:[L,a]}],rules:[{endpoint:{url:"https://{AccountId}.ddb.{Region}.{PartitionResult#dnsSuffix}",[X]:r,[Y]:r},[T]:d}],[T]:e},{error:"Credentials-sourced account ID parameter is invalid",[T]:c}],[T]:e},{conditions:P,rules:[{conditions:Q,rules:[{conditions:[E],rules:[{conditions:[D],rules:[{error:"AccountIdEndpointMode is required but no AccountID was provided or able to be loaded",[T]:c}],[T]:e},{error:"Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition",[T]:c}],[T]:e},B],[T]:e},x],[T]:e},z],[T]:e}],[T]:e},{error:"Invalid Configuration: Missing Region",[T]:c}]};
60+
const _data={version:"1.0",parameters:{Region:n,UseDualStack:o,UseFIPS:o,Endpoint:n,AccountId:n,AccountIdEndpointMode:n,ResourceArn:n,ResourceArnList:{[S]:a,[T]:"stringArray"}},rules:[{conditions:[{[U]:b,[V]:[{[W]:"Endpoint"}]}],rules:[{conditions:M,error:"Invalid Configuration: FIPS and custom endpoint are not supported",[T]:c},{conditions:N,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",[T]:c},{endpoint:{url:"{Endpoint}",[X]:r,[Y]:r},[T]:d}],[T]:e},{conditions:[{[U]:b,[V]:O}],rules:[{conditions:[{[U]:"aws.partition",[V]:O,assign:f}],rules:[{conditions:[{[U]:g,[V]:[s,"local"]}],rules:[{conditions:M,error:"Invalid Configuration: FIPS and local endpoint are not supported",[T]:c},{conditions:N,error:"Invalid Configuration: Dualstack and local endpoint are not supported",[T]:c},{endpoint:{url:"http://localhost:8000",[X]:{authSchemes:[{signingRegion:"us-east-1",name:"sigv4",signingName:h}]},[Y]:r},[T]:d}],[T]:e},{conditions:[p,q],rules:[{conditions:[t,u],rules:[v,{endpoint:{url:"https://dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",[X]:r,[Y]:r},[T]:d}],[T]:e},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",[T]:c}],[T]:e},{conditions:M,rules:[{conditions:[t],rules:[{conditions:[{[U]:g,[V]:[y,"aws-us-gov"]}],rules:[v,z],[T]:e},v,{endpoint:{url:"https://dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}",[X]:r,[Y]:r},[T]:d}],[T]:e},{error:"FIPS is enabled but this partition does not support FIPS",[T]:c}],[T]:e},{conditions:N,rules:[{conditions:[u],rules:[{conditions:P,rules:[{conditions:Q,rules:[B],[T]:e},x],[T]:e},{endpoint:{url:"https://dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}",[X]:r,[Y]:r},[T]:d}],[T]:e},{error:"DualStack is enabled but this partition does not support DualStack",[T]:c}],[T]:e},{conditions:[w,C,D,A,E,{[U]:b,[V]:R},{[U]:j,[V]:R,assign:k},F,G,H,I],endpoint:J,[T]:d},{conditions:[w,C,D,A,E,{[U]:b,[V]:[K]},{[U]:i,[V]:[K,"[0]"],assign:m},{[U]:j,[V]:[{[W]:m}],assign:k},F,G,H,I],endpoint:J,[T]:d},{conditions:[w,C,D,A,E,{[U]:b,[V]:[L]}],rules:[{conditions:[{[U]:l,[V]:[L,a]}],rules:[{endpoint:{url:"https://{AccountId}.ddb.{Region}.{PartitionResult#dnsSuffix}",[X]:r,[Y]:r},[T]:d}],[T]:e},{error:"Credentials-sourced account ID parameter is invalid",[T]:c}],[T]:e},{conditions:P,rules:[{conditions:Q,rules:[{conditions:[E],rules:[{conditions:[D],rules:[{error:"AccountIdEndpointMode is required but no AccountID was provided or able to be loaded",[T]:c}],[T]:e},{error:"Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition",[T]:c}],[T]:e},B],[T]:e},x],[T]:e},z],[T]:e}],[T]:e},{error:"Invalid Configuration: Missing Region",[T]:c}]};
6161
export const ruleSet: RuleSetObject = _data;

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2479,7 +2479,9 @@ export interface GlobalSecondaryIndex {
24792479

24802480
/**
24812481
* <p>Represents the provisioned throughput settings for the specified global secondary
2482-
* index.</p>
2482+
* index. You must use either
2483+
* <code>OnDemandThroughput</code> or <code>ProvisionedThroughput</code> based
2484+
* on your table's capacity mode.</p>
24832485
* <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
24842486
* Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer
24852487
* Guide</i>.</p>
@@ -2490,7 +2492,9 @@ export interface GlobalSecondaryIndex {
24902492
/**
24912493
* <p>The maximum number of read and write units for the specified global secondary index.
24922494
* If you use this parameter, you must specify <code>MaxReadRequestUnits</code>,
2493-
* <code>MaxWriteRequestUnits</code>, or both.</p>
2495+
* <code>MaxWriteRequestUnits</code>, or both. You must use either
2496+
* <code>OnDemandThroughput</code> or <code>ProvisionedThroughput</code> based
2497+
* on your table's capacity mode.</p>
24942498
* @public
24952499
*/
24962500
OnDemandThroughput?: OnDemandThroughput | undefined;

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4116,8 +4116,8 @@
41164116
"authSchemes": [
41174117
{
41184118
"signingRegion": "us-east-1",
4119-
"signingName": "dynamodb",
4120-
"name": "sigv4"
4119+
"name": "sigv4",
4120+
"signingName": "dynamodb"
41214121
}
41224122
]
41234123
},
@@ -14370,13 +14370,13 @@
1437014370
"ProvisionedThroughput": {
1437114371
"target": "com.amazonaws.dynamodb#ProvisionedThroughput",
1437214372
"traits": {
14373-
"smithy.api#documentation": "<p>Represents the provisioned throughput settings for the specified global secondary\n index.</p>\n <p>For current minimum and maximum provisioned throughput values, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\">Service,\n Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer\n Guide</i>.</p>"
14373+
"smithy.api#documentation": "<p>Represents the provisioned throughput settings for the specified global secondary\n index. You must use either\n <code>OnDemandThroughput</code> or <code>ProvisionedThroughput</code> based\n on your table's capacity mode.</p>\n <p>For current minimum and maximum provisioned throughput values, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\">Service,\n Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer\n Guide</i>.</p>"
1437414374
}
1437514375
},
1437614376
"OnDemandThroughput": {
1437714377
"target": "com.amazonaws.dynamodb#OnDemandThroughput",
1437814378
"traits": {
14379-
"smithy.api#documentation": "<p>The maximum number of read and write units for the specified global secondary index.\n If you use this parameter, you must specify <code>MaxReadRequestUnits</code>,\n <code>MaxWriteRequestUnits</code>, or both.</p>"
14379+
"smithy.api#documentation": "<p>The maximum number of read and write units for the specified global secondary index.\n If you use this parameter, you must specify <code>MaxReadRequestUnits</code>,\n <code>MaxWriteRequestUnits</code>, or both. You must use either\n <code>OnDemandThroughput</code> or <code>ProvisionedThroughput</code> based\n on your table's capacity mode.</p>"
1438014380
}
1438114381
},
1438214382
"WarmThroughput": {

0 commit comments

Comments
 (0)