Skip to content

Commit 5e19279

Browse files
author
awstools
committed
feat(client-quicksight): This release adds DescribeKeyRegistration and UpdateKeyRegistration APIs to manage QuickSight Customer Managed Keys (CMK).
1 parent f11ecac commit 5e19279

19 files changed

+996
-132
lines changed

‎clients/client-quicksight/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -807,6 +807,14 @@ DescribeIpRestriction
807807

808808
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeIpRestrictionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeIpRestrictionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeIpRestrictionCommandOutput/)
809809

810+
</details>
811+
<details>
812+
<summary>
813+
DescribeKeyRegistration
814+
</summary>
815+
816+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeKeyRegistrationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeKeyRegistrationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeKeyRegistrationCommandOutput/)
817+
810818
</details>
811819
<details>
812820
<summary>
@@ -1463,6 +1471,14 @@ UpdateIpRestriction
14631471

14641472
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateIpRestrictionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateIpRestrictionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateIpRestrictionCommandOutput/)
14651473

1474+
</details>
1475+
<details>
1476+
<summary>
1477+
UpdateKeyRegistration
1478+
</summary>
1479+
1480+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateKeyRegistrationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateKeyRegistrationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateKeyRegistrationCommandOutput/)
1481+
14661482
</details>
14671483
<details>
14681484
<summary>

‎clients/client-quicksight/src/QuickSight.ts

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,11 @@ import {
349349
DescribeIpRestrictionCommandInput,
350350
DescribeIpRestrictionCommandOutput,
351351
} from "./commands/DescribeIpRestrictionCommand";
352+
import {
353+
DescribeKeyRegistrationCommand,
354+
DescribeKeyRegistrationCommandInput,
355+
DescribeKeyRegistrationCommandOutput,
356+
} from "./commands/DescribeKeyRegistrationCommand";
352357
import {
353358
DescribeNamespaceCommand,
354359
DescribeNamespaceCommandInput,
@@ -731,6 +736,11 @@ import {
731736
UpdateIpRestrictionCommandInput,
732737
UpdateIpRestrictionCommandOutput,
733738
} from "./commands/UpdateIpRestrictionCommand";
739+
import {
740+
UpdateKeyRegistrationCommand,
741+
UpdateKeyRegistrationCommandInput,
742+
UpdateKeyRegistrationCommandOutput,
743+
} from "./commands/UpdateKeyRegistrationCommand";
734744
import {
735745
UpdatePublicSharingSettingsCommand,
736746
UpdatePublicSharingSettingsCommandInput,
@@ -872,6 +882,7 @@ const commands = {
872882
DescribeIAMPolicyAssignmentCommand,
873883
DescribeIngestionCommand,
874884
DescribeIpRestrictionCommand,
885+
DescribeKeyRegistrationCommand,
875886
DescribeNamespaceCommand,
876887
DescribeRefreshScheduleCommand,
877888
DescribeRoleCustomPermissionCommand,
@@ -954,6 +965,7 @@ const commands = {
954965
UpdateIAMPolicyAssignmentCommand,
955966
UpdateIdentityPropagationConfigCommand,
956967
UpdateIpRestrictionCommand,
968+
UpdateKeyRegistrationCommand,
957969
UpdatePublicSharingSettingsCommand,
958970
UpdateRefreshScheduleCommand,
959971
UpdateRoleCustomPermissionCommand,
@@ -2139,6 +2151,23 @@ export interface QuickSight {
21392151
cb: (err: any, data?: DescribeIpRestrictionCommandOutput) => void
21402152
): void;
21412153

2154+
/**
2155+
* @see {@link DescribeKeyRegistrationCommand}
2156+
*/
2157+
describeKeyRegistration(
2158+
args: DescribeKeyRegistrationCommandInput,
2159+
options?: __HttpHandlerOptions
2160+
): Promise<DescribeKeyRegistrationCommandOutput>;
2161+
describeKeyRegistration(
2162+
args: DescribeKeyRegistrationCommandInput,
2163+
cb: (err: any, data?: DescribeKeyRegistrationCommandOutput) => void
2164+
): void;
2165+
describeKeyRegistration(
2166+
args: DescribeKeyRegistrationCommandInput,
2167+
options: __HttpHandlerOptions,
2168+
cb: (err: any, data?: DescribeKeyRegistrationCommandOutput) => void
2169+
): void;
2170+
21422171
/**
21432172
* @see {@link DescribeNamespaceCommand}
21442173
*/
@@ -3389,6 +3418,23 @@ export interface QuickSight {
33893418
cb: (err: any, data?: UpdateIpRestrictionCommandOutput) => void
33903419
): void;
33913420

3421+
/**
3422+
* @see {@link UpdateKeyRegistrationCommand}
3423+
*/
3424+
updateKeyRegistration(
3425+
args: UpdateKeyRegistrationCommandInput,
3426+
options?: __HttpHandlerOptions
3427+
): Promise<UpdateKeyRegistrationCommandOutput>;
3428+
updateKeyRegistration(
3429+
args: UpdateKeyRegistrationCommandInput,
3430+
cb: (err: any, data?: UpdateKeyRegistrationCommandOutput) => void
3431+
): void;
3432+
updateKeyRegistration(
3433+
args: UpdateKeyRegistrationCommandInput,
3434+
options: __HttpHandlerOptions,
3435+
cb: (err: any, data?: UpdateKeyRegistrationCommandOutput) => void
3436+
): void;
3437+
33923438
/**
33933439
* @see {@link UpdatePublicSharingSettingsCommand}
33943440
*/

‎clients/client-quicksight/src/QuickSightClient.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,10 @@ import {
257257
DescribeIpRestrictionCommandInput,
258258
DescribeIpRestrictionCommandOutput,
259259
} from "./commands/DescribeIpRestrictionCommand";
260+
import {
261+
DescribeKeyRegistrationCommandInput,
262+
DescribeKeyRegistrationCommandOutput,
263+
} from "./commands/DescribeKeyRegistrationCommand";
260264
import { DescribeNamespaceCommandInput, DescribeNamespaceCommandOutput } from "./commands/DescribeNamespaceCommand";
261265
import {
262266
DescribeRefreshScheduleCommandInput,
@@ -465,6 +469,10 @@ import {
465469
UpdateIpRestrictionCommandInput,
466470
UpdateIpRestrictionCommandOutput,
467471
} from "./commands/UpdateIpRestrictionCommand";
472+
import {
473+
UpdateKeyRegistrationCommandInput,
474+
UpdateKeyRegistrationCommandOutput,
475+
} from "./commands/UpdateKeyRegistrationCommand";
468476
import {
469477
UpdatePublicSharingSettingsCommandInput,
470478
UpdatePublicSharingSettingsCommandOutput,
@@ -600,6 +608,7 @@ export type ServiceInputTypes =
600608
| DescribeIAMPolicyAssignmentCommandInput
601609
| DescribeIngestionCommandInput
602610
| DescribeIpRestrictionCommandInput
611+
| DescribeKeyRegistrationCommandInput
603612
| DescribeNamespaceCommandInput
604613
| DescribeRefreshScheduleCommandInput
605614
| DescribeRoleCustomPermissionCommandInput
@@ -682,6 +691,7 @@ export type ServiceInputTypes =
682691
| UpdateIAMPolicyAssignmentCommandInput
683692
| UpdateIdentityPropagationConfigCommandInput
684693
| UpdateIpRestrictionCommandInput
694+
| UpdateKeyRegistrationCommandInput
685695
| UpdatePublicSharingSettingsCommandInput
686696
| UpdateRefreshScheduleCommandInput
687697
| UpdateRoleCustomPermissionCommandInput
@@ -777,6 +787,7 @@ export type ServiceOutputTypes =
777787
| DescribeIAMPolicyAssignmentCommandOutput
778788
| DescribeIngestionCommandOutput
779789
| DescribeIpRestrictionCommandOutput
790+
| DescribeKeyRegistrationCommandOutput
780791
| DescribeNamespaceCommandOutput
781792
| DescribeRefreshScheduleCommandOutput
782793
| DescribeRoleCustomPermissionCommandOutput
@@ -859,6 +870,7 @@ export type ServiceOutputTypes =
859870
| UpdateIAMPolicyAssignmentCommandOutput
860871
| UpdateIdentityPropagationConfigCommandOutput
861872
| UpdateIpRestrictionCommandOutput
873+
| UpdateKeyRegistrationCommandOutput
862874
| UpdatePublicSharingSettingsCommandOutput
863875
| UpdateRefreshScheduleCommandOutput
864876
| UpdateRoleCustomPermissionCommandOutput

‎clients/client-quicksight/src/commands/CreateDataSourceCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
103103
* ClusterId: "STRING_VALUE",
104104
* IAMParameters: { // RedshiftIAMParameters
105105
* RoleArn: "STRING_VALUE", // required
106-
* DatabaseUser: "STRING_VALUE", // required
106+
* DatabaseUser: "STRING_VALUE",
107107
* DatabaseGroups: [ // DatabaseGroupList
108108
* "STRING_VALUE",
109109
* ],
@@ -239,7 +239,7 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
239239
* ClusterId: "STRING_VALUE",
240240
* IAMParameters: {
241241
* RoleArn: "STRING_VALUE", // required
242-
* DatabaseUser: "STRING_VALUE", // required
242+
* DatabaseUser: "STRING_VALUE",
243243
* DatabaseGroups: [
244244
* "STRING_VALUE",
245245
* ],

‎clients/client-quicksight/src/commands/DescribeAssetBundleImportJobCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ export interface DescribeAssetBundleImportJobCommandOutput
165165
* // ClusterId: "STRING_VALUE",
166166
* // IAMParameters: { // RedshiftIAMParameters
167167
* // RoleArn: "STRING_VALUE", // required
168-
* // DatabaseUser: "STRING_VALUE", // required
168+
* // DatabaseUser: "STRING_VALUE",
169169
* // DatabaseGroups: [ // DatabaseGroupList
170170
* // "STRING_VALUE",
171171
* // ],

‎clients/client-quicksight/src/commands/DescribeDataSourceCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
109109
* // ClusterId: "STRING_VALUE",
110110
* // IAMParameters: { // RedshiftIAMParameters
111111
* // RoleArn: "STRING_VALUE", // required
112-
* // DatabaseUser: "STRING_VALUE", // required
112+
* // DatabaseUser: "STRING_VALUE",
113113
* // DatabaseGroups: [ // DatabaseGroupList
114114
* // "STRING_VALUE",
115115
* // ],
@@ -241,7 +241,7 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
241241
* // ClusterId: "STRING_VALUE",
242242
* // IAMParameters: {
243243
* // RoleArn: "STRING_VALUE", // required
244-
* // DatabaseUser: "STRING_VALUE", // required
244+
* // DatabaseUser: "STRING_VALUE",
245245
* // DatabaseGroups: [
246246
* // "STRING_VALUE",
247247
* // ],

‎clients/client-quicksight/src/commands/DescribeKeyRegistrationCommand.ts

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
// smithy-typescript generated code
2+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
3+
import { getSerdePlugin } from "@smithy/middleware-serde";
4+
import { Command as $Command } from "@smithy/smithy-client";
5+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
6+
7+
import { commonParams } from "../endpoint/EndpointParameters";
8+
import { DescribeKeyRegistrationRequest, DescribeKeyRegistrationResponse } from "../models/models_3";
9+
import { de_DescribeKeyRegistrationCommand, se_DescribeKeyRegistrationCommand } from "../protocols/Aws_restJson1";
10+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
11+
12+
/**
13+
* @public
14+
*/
15+
export { __MetadataBearer, $Command };
16+
/**
17+
* @public
18+
*
19+
* The input for {@link DescribeKeyRegistrationCommand}.
20+
*/
21+
export interface DescribeKeyRegistrationCommandInput extends DescribeKeyRegistrationRequest {}
22+
/**
23+
* @public
24+
*
25+
* The output of {@link DescribeKeyRegistrationCommand}.
26+
*/
27+
export interface DescribeKeyRegistrationCommandOutput extends DescribeKeyRegistrationResponse, __MetadataBearer {}
28+
29+
/**
30+
* <p>Describes all customer managed key registrations in a Amazon QuickSight account.</p>
31+
* @example
32+
* Use a bare-bones client and the command you need to make an API call.
33+
* ```javascript
34+
* import { QuickSightClient, DescribeKeyRegistrationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
35+
* // const { QuickSightClient, DescribeKeyRegistrationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
36+
* const client = new QuickSightClient(config);
37+
* const input = { // DescribeKeyRegistrationRequest
38+
* AwsAccountId: "STRING_VALUE", // required
39+
* DefaultKeyOnly: true || false,
40+
* };
41+
* const command = new DescribeKeyRegistrationCommand(input);
42+
* const response = await client.send(command);
43+
* // { // DescribeKeyRegistrationResponse
44+
* // AwsAccountId: "STRING_VALUE",
45+
* // KeyRegistration: [ // KeyRegistration
46+
* // { // RegisteredCustomerManagedKey
47+
* // KeyArn: "STRING_VALUE",
48+
* // DefaultKey: true || false,
49+
* // },
50+
* // ],
51+
* // RequestId: "STRING_VALUE",
52+
* // Status: Number("int"),
53+
* // };
54+
*
55+
* ```
56+
*
57+
* @param DescribeKeyRegistrationCommandInput - {@link DescribeKeyRegistrationCommandInput}
58+
* @returns {@link DescribeKeyRegistrationCommandOutput}
59+
* @see {@link DescribeKeyRegistrationCommandInput} for command's `input` shape.
60+
* @see {@link DescribeKeyRegistrationCommandOutput} for command's `response` shape.
61+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
62+
*
63+
* @throws {@link AccessDeniedException} (client fault)
64+
* <p>You don't have access to this item. The provided credentials couldn't be
65+
* validated. You might not be authorized to carry out the request. Make sure that your
66+
* account is authorized to use the Amazon QuickSight service, that your policies have the
67+
* correct permissions, and that you are using the correct credentials.</p>
68+
*
69+
* @throws {@link InternalFailureException} (server fault)
70+
* <p>An internal failure occurred.</p>
71+
*
72+
* @throws {@link InvalidParameterValueException} (client fault)
73+
* <p>One or more parameters has a value that isn't valid.</p>
74+
*
75+
* @throws {@link ThrottlingException} (client fault)
76+
* <p>Access is throttled.</p>
77+
*
78+
* @throws {@link QuickSightServiceException}
79+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
80+
*
81+
* @public
82+
*/
83+
export class DescribeKeyRegistrationCommand extends $Command
84+
.classBuilder<
85+
DescribeKeyRegistrationCommandInput,
86+
DescribeKeyRegistrationCommandOutput,
87+
QuickSightClientResolvedConfig,
88+
ServiceInputTypes,
89+
ServiceOutputTypes
90+
>()
91+
.ep({
92+
...commonParams,
93+
})
94+
.m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) {
95+
return [
96+
getSerdePlugin(config, this.serialize, this.deserialize),
97+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
98+
];
99+
})
100+
.s("QuickSight_20180401", "DescribeKeyRegistration", {})
101+
.n("QuickSightClient", "DescribeKeyRegistrationCommand")
102+
.f(void 0, void 0)
103+
.ser(se_DescribeKeyRegistrationCommand)
104+
.de(de_DescribeKeyRegistrationCommand)
105+
.build() {}

‎clients/client-quicksight/src/commands/ListDataSourcesCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { ListDataSourcesRequest, ListDataSourcesResponse } from "../models/models_3";
8+
import { ListDataSourcesRequest } from "../models/models_3";
9+
import { ListDataSourcesResponse } from "../models/models_4";
910
import { de_ListDataSourcesCommand, se_ListDataSourcesCommand } from "../protocols/Aws_restJson1";
1011
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
1112

@@ -111,7 +112,7 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _
111112
* // ClusterId: "STRING_VALUE",
112113
* // IAMParameters: { // RedshiftIAMParameters
113114
* // RoleArn: "STRING_VALUE", // required
114-
* // DatabaseUser: "STRING_VALUE", // required
115+
* // DatabaseUser: "STRING_VALUE",
115116
* // DatabaseGroups: [ // DatabaseGroupList
116117
* // "STRING_VALUE",
117118
* // ],
@@ -243,7 +244,7 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _
243244
* // ClusterId: "STRING_VALUE",
244245
* // IAMParameters: {
245246
* // RoleArn: "STRING_VALUE", // required
246-
* // DatabaseUser: "STRING_VALUE", // required
247+
* // DatabaseUser: "STRING_VALUE",
247248
* // DatabaseGroups: [
248249
* // "STRING_VALUE",
249250
* // ],

‎clients/client-quicksight/src/commands/ListFolderMembersCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { ListFolderMembersRequest, ListFolderMembersResponse } from "../models/models_3";
8+
import { ListFolderMembersRequest, ListFolderMembersResponse } from "../models/models_4";
99
import { de_ListFolderMembersCommand, se_ListFolderMembersCommand } from "../protocols/Aws_restJson1";
1010
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
1111

‎clients/client-quicksight/src/commands/ListFoldersCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { ListFoldersRequest } from "../models/models_3";
9-
import { ListFoldersResponse } from "../models/models_4";
8+
import { ListFoldersRequest, ListFoldersResponse } from "../models/models_4";
109
import { de_ListFoldersCommand, se_ListFoldersCommand } from "../protocols/Aws_restJson1";
1110
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
1211

‎clients/client-quicksight/src/commands/StartAssetBundleImportJobCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ export interface StartAssetBundleImportJobCommandOutput extends StartAssetBundle
138138
* ClusterId: "STRING_VALUE",
139139
* IAMParameters: { // RedshiftIAMParameters
140140
* RoleArn: "STRING_VALUE", // required
141-
* DatabaseUser: "STRING_VALUE", // required
141+
* DatabaseUser: "STRING_VALUE",
142142
* DatabaseGroups: [ // DatabaseGroupList
143143
* "STRING_VALUE",
144144
* ],

‎clients/client-quicksight/src/commands/UpdateDataSourceCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse,
102102
* ClusterId: "STRING_VALUE",
103103
* IAMParameters: { // RedshiftIAMParameters
104104
* RoleArn: "STRING_VALUE", // required
105-
* DatabaseUser: "STRING_VALUE", // required
105+
* DatabaseUser: "STRING_VALUE",
106106
* DatabaseGroups: [ // DatabaseGroupList
107107
* "STRING_VALUE",
108108
* ],
@@ -238,7 +238,7 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse,
238238
* ClusterId: "STRING_VALUE",
239239
* IAMParameters: {
240240
* RoleArn: "STRING_VALUE", // required
241-
* DatabaseUser: "STRING_VALUE", // required
241+
* DatabaseUser: "STRING_VALUE",
242242
* DatabaseGroups: [
243243
* "STRING_VALUE",
244244
* ],

0 commit comments

Comments
 (0)