Skip to content

Commit 1e68ae3

Browse files
author
awstools
committed
docs(client-redshift-serverless): Added query monitoring rules as possible parameters for create and update workgroup operations.
1 parent 8973fbd commit 1e68ae3

File tree

8 files changed

+235
-441
lines changed

8 files changed

+235
-441
lines changed

clients/client-redshift-serverless/src/RedshiftServerless.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,7 +1239,8 @@ export class RedshiftServerless extends RedshiftServerlessClient {
12391239
}
12401240

12411241
/**
1242-
* <p>Restores a table from a snapshot to your Amazon Redshift Serverless instance.</p>
1242+
* <p>Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to
1243+
* restore tables with <a href="https://docs.aws.amazon.com/redshift/latest/dg/t_Sorting_data.html#t_Sorting_data-interleaved">interleaved sort keys</a>.</p>
12431244
*/
12441245
public restoreTableFromSnapshot(
12451246
args: RestoreTableFromSnapshotCommandInput,
@@ -1361,7 +1362,9 @@ export class RedshiftServerless extends RedshiftServerlessClient {
13611362
}
13621363

13631364
/**
1364-
* <p>Updates a namespace with the specified settings.</p>
1365+
* <p>Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example,
1366+
* you must specify both <code>adminUsername</code> and <code>adminUserPassword</code> to update either field, but you can't update both <code>kmsKeyId</code>
1367+
* and <code>logExports</code> in a single request.</p>
13651368
*/
13661369
public updateNamespace(
13671370
args: UpdateNamespaceCommandInput,
@@ -1457,7 +1460,8 @@ export class RedshiftServerless extends RedshiftServerlessClient {
14571460
}
14581461

14591462
/**
1460-
* <p>Updates a workgroup with the specified configuration settings.</p>
1463+
* <p>Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example,
1464+
* you can update <code>baseCapacity</code> or <code>port</code> in a single request, but you can't update both in the same request.</p>
14611465
*/
14621466
public updateWorkgroup(
14631467
args: UpdateWorkgroupCommandInput,

clients/client-redshift-serverless/src/commands/RestoreTableFromSnapshotCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ export interface RestoreTableFromSnapshotCommandInput extends RestoreTableFromSn
3333
export interface RestoreTableFromSnapshotCommandOutput extends RestoreTableFromSnapshotResponse, __MetadataBearer {}
3434

3535
/**
36-
* <p>Restores a table from a snapshot to your Amazon Redshift Serverless instance.</p>
36+
* <p>Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to
37+
* restore tables with <a href="https://docs.aws.amazon.com/redshift/latest/dg/t_Sorting_data.html#t_Sorting_data-interleaved">interleaved sort keys</a>.</p>
3738
* @example
3839
* Use a bare-bones client and the command you need to make an API call.
3940
* ```javascript

clients/client-redshift-serverless/src/commands/UpdateNamespaceCommand.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ export interface UpdateNamespaceCommandInput extends UpdateNamespaceRequest {}
3333
export interface UpdateNamespaceCommandOutput extends UpdateNamespaceResponse, __MetadataBearer {}
3434

3535
/**
36-
* <p>Updates a namespace with the specified settings.</p>
36+
* <p>Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example,
37+
* you must specify both <code>adminUsername</code> and <code>adminUserPassword</code> to update either field, but you can't update both <code>kmsKeyId</code>
38+
* and <code>logExports</code> in a single request.</p>
3739
* @example
3840
* Use a bare-bones client and the command you need to make an API call.
3941
* ```javascript

clients/client-redshift-serverless/src/commands/UpdateWorkgroupCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ export interface UpdateWorkgroupCommandInput extends UpdateWorkgroupRequest {}
3333
export interface UpdateWorkgroupCommandOutput extends UpdateWorkgroupResponse, __MetadataBearer {}
3434

3535
/**
36-
* <p>Updates a workgroup with the specified configuration settings.</p>
36+
* <p>Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example,
37+
* you can update <code>baseCapacity</code> or <code>port</code> in a single request, but you can't update both in the same request.</p>
3738
* @example
3839
* Use a bare-bones client and the command you need to make an API call.
3940
* ```javascript

clients/client-redshift-serverless/src/endpoint/EndpointParameters.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
2424
};
2525

2626
export interface EndpointParameters extends __EndpointParameters {
27-
Region?: string;
27+
Region: string;
2828
UseDualStack?: boolean;
2929
UseFIPS?: boolean;
3030
Endpoint?: string;

clients/client-redshift-serverless/src/endpoint/ruleset.ts

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,24 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints";
66
or see "smithy.rules#endpointRuleSet"
77
in codegen/sdk-codegen/aws-models/redshift-serverless.json */
88

9-
const p="required",
10-
q="fn",
9+
const q="fn",
1110
r="argv",
1211
s="ref";
13-
const a="PartitionResult",
14-
b="tree",
15-
c="error",
16-
d="endpoint",
17-
e={[p]:false,"type":"String"},
18-
f={[p]:true,"default":false,"type":"Boolean"},
19-
g={[s]:"Endpoint"},
20-
h={[q]:"booleanEquals",[r]:[{[s]:"UseFIPS"},true]},
21-
i={[q]:"booleanEquals",[r]:[{[s]:"UseDualStack"},true]},
22-
j={},
23-
k={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:a},"supportsFIPS"]}]},
24-
l={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:a},"supportsDualStack"]}]},
25-
m=[g],
26-
n=[h],
27-
o=[i];
28-
const _data={version:"1.0",parameters:{Region:e,UseDualStack:f,UseFIPS:f,Endpoint:e},rules:[{conditions:[{[q]:"aws.partition",[r]:[{[s]:"Region"}],assign:a}],type:b,rules:[{conditions:[{[q]:"isSet",[r]:m},{[q]:"parseURL",[r]:m,assign:"url"}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:g,properties:j,headers:j},type:d}]}]},{conditions:[h,i],type:b,rules:[{conditions:[k,l],type:b,rules:[{endpoint:{url:"https://redshift-serverless-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:j,headers:j},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[k],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://redshift-serverless-fips.{Region}.{PartitionResult#dnsSuffix}",properties:j,headers:j},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[l],type:b,rules:[{endpoint:{url:"https://redshift-serverless.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:j,headers:j},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://redshift-serverless.{Region}.{PartitionResult#dnsSuffix}",properties:j,headers:j},type:d}]}]};
12+
const a=true,
13+
b=false,
14+
c="String",
15+
d="PartitionResult",
16+
e="tree",
17+
f="error",
18+
g="endpoint",
19+
h={"required":true,"default":false,"type":"Boolean"},
20+
i={[s]:"Endpoint"},
21+
j={[q]:"booleanEquals",[r]:[{[s]:"UseFIPS"},true]},
22+
k={[q]:"booleanEquals",[r]:[{[s]:"UseDualStack"},true]},
23+
l={},
24+
m={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:d},"supportsFIPS"]}]},
25+
n={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:d},"supportsDualStack"]}]},
26+
o=[j],
27+
p=[k];
28+
const _data={version:"1.0",parameters:{Region:{required:a,type:c},UseDualStack:h,UseFIPS:h,Endpoint:{required:b,type:c}},rules:[{conditions:[{[q]:"aws.partition",[r]:[{[s]:"Region"}],assign:d}],type:e,rules:[{conditions:[{[q]:"isSet",[r]:[i]}],type:e,rules:[{conditions:o,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:f},{type:e,rules:[{conditions:p,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:f},{endpoint:{url:i,properties:l,headers:l},type:g}]}]},{conditions:[j,k],type:e,rules:[{conditions:[m,n],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://redshift-serverless-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:g}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:f}]},{conditions:o,type:e,rules:[{conditions:[m],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://redshift-serverless-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:g}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:f}]},{conditions:p,type:e,rules:[{conditions:[n],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://redshift-serverless.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:g}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:f}]},{type:e,rules:[{endpoint:{url:"https://redshift-serverless.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:g}]}]}]};
2929
export const ruleSet: RuleSetObject = _data;

clients/client-redshift-serverless/src/models/models_0.ts

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,10 @@ export class AccessDeniedException extends __BaseException {
3030
export interface ConfigParameter {
3131
/**
3232
* <p>The key of the parameter. The
33-
* options are <code>datestyle</code>, <code>enable_user_activity_logging</code>,
34-
* <code>query_group</code>, <code>search_path</code>, and <code>max_query_execution_time</code>.</p>
33+
* options are <code>auto_mv</code>, <code>datestyle</code>, <code>enable_case_sensitivity_identifier</code>, <code>enable_user_activity_logging</code>,
34+
* <code>query_group</code>, <code>search_path</code>, and query monitoring metrics that let
35+
* you define performance boundaries. For more information about query monitoring rules and available metrics, see
36+
* <a href="https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless">Query monitoring metrics for Amazon Redshift Serverless</a>.</p>
3537
*/
3638
parameterKey?: string;
3739

@@ -753,9 +755,11 @@ export interface CreateWorkgroupRequest {
753755
enhancedVpcRouting?: boolean;
754756

755757
/**
756-
* <p>An array of parameters to set for more control over a serverless database. The
757-
* options are <code>datestyle</code>, <code>enable_user_activity_logging</code>,
758-
* <code>query_group</code>, <code>search_path</code>, and <code>max_query_execution_time</code>.</p>
758+
* <p>An array of parameters to set for advanced control over a database. The
759+
* options are <code>auto_mv</code>, <code>datestyle</code>, <code>enable_case_sensitivity_identifier</code>, <code>enable_user_activity_logging</code>,
760+
* <code>query_group</code>, <code>search_path</code>, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see
761+
* <a href="https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless">
762+
* Query monitoring metrics for Amazon Redshift Serverless</a>.</p>
759763
*/
760764
configParameters?: ConfigParameter[];
761765

@@ -848,9 +852,10 @@ export interface Workgroup {
848852
enhancedVpcRouting?: boolean;
849853

850854
/**
851-
* <p>An array of parameters to set for finer control over a database. The
852-
* options are <code>datestyle</code>, <code>enable_user_activity_logging</code>,
853-
* <code>query_group</code>, <code>search_path</code>, and <code>max_query_execution_time</code>.</p>
855+
* <p>An array of parameters to set for advanced control over a database. The
856+
* options are <code>auto_mv</code>, <code>datestyle</code>, <code>enable_case_sensitivity_identifier</code>, <code>enable_user_activity_logging</code>,
857+
* <code>query_group</code>, , <code>search_path</code>, and query monitoring metrics that let you define performance boundaries.
858+
* For more information about query monitoring rules and available metrics, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless"> Query monitoring metrics for Amazon Redshift Serverless</a>.</p>
854859
*/
855860
configParameters?: ConfigParameter[];
856861

@@ -1685,17 +1690,19 @@ export interface ListWorkgroupsResponse {
16851690

16861691
export interface UpdateNamespaceRequest {
16871692
/**
1688-
* <p>The name of the namespace.</p>
1693+
* <p>The name of the namespace to update. You can't update the name of a namespace once it is created.</p>
16891694
*/
16901695
namespaceName: string | undefined;
16911696

16921697
/**
1693-
* <p>The password of the administrator for the first database created in the namespace.</p>
1698+
* <p>The password of the administrator for the first database created in the namespace. This parameter must be updated together
1699+
* with <code>adminUsername</code>.</p>
16941700
*/
16951701
adminUserPassword?: string;
16961702

16971703
/**
1698-
* <p>The username of the administrator for the first database created in the namespace.</p>
1704+
* <p>The username of the administrator for the first database created in the namespace. This parameter must be updated
1705+
* together with <code>adminUserPassword</code>.</p>
16991706
*/
17001707
adminUsername?: string;
17011708

@@ -1705,12 +1712,13 @@ export interface UpdateNamespaceRequest {
17051712
kmsKeyId?: string;
17061713

17071714
/**
1708-
* <p>The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.</p>
1715+
* <p>The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together
1716+
* with <code>iamRoles</code>.</p>
17091717
*/
17101718
defaultIamRoleArn?: string;
17111719

17121720
/**
1713-
* <p>A list of IAM roles to associate with the namespace.</p>
1721+
* <p>A list of IAM roles to associate with the namespace. This parameter must be updated together with <code>defaultIamRoleArn</code>.</p>
17141722
*/
17151723
iamRoles?: string[];
17161724

@@ -1963,7 +1971,7 @@ export interface UpdateUsageLimitResponse {
19631971

19641972
export interface UpdateWorkgroupRequest {
19651973
/**
1966-
* <p>The name of the workgroup to update.</p>
1974+
* <p>The name of the workgroup to update. You can't update the name of a workgroup once it is created.</p>
19671975
*/
19681976
workgroupName: string | undefined;
19691977

@@ -1980,8 +1988,11 @@ export interface UpdateWorkgroupRequest {
19801988

19811989
/**
19821990
* <p>An array of parameters to set for advanced control over a database. The
1983-
* options are <code>datestyle</code>, <code>enable_user_activity_logging</code>,
1984-
* <code>query_group</code>, <code>search_path</code>, and <code>max_query_execution_time</code>.</p>
1991+
* options are <code>auto_mv</code>, <code>datestyle</code>, <code>enable_case_sensitivity_identifier</code>, <code>enable_user_activity_logging</code>,
1992+
* <code>query_group</code>, <code>search_path</code>, and query monitoring metrics that let you
1993+
* define performance boundaries. For more information about query monitoring rules and available metrics, see
1994+
* <a href="https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless">
1995+
* Query monitoring metrics for Amazon Redshift Serverless</a>.</p>
19851996
*/
19861997
configParameters?: ConfigParameter[];
19871998

0 commit comments

Comments
 (0)