Skip to content

Commit

Permalink
feat(client-quicksight): This release adds DescribeKeyRegistration an…
Browse files Browse the repository at this point in the history
…d UpdateKeyRegistration APIs to manage QuickSight Customer Managed Keys (CMK).
  • Loading branch information
awstools committed May 16, 2024
1 parent f11ecac commit 5e19279
Show file tree
Hide file tree
Showing 19 changed files with 996 additions and 132 deletions.
16 changes: 16 additions & 0 deletions clients/client-quicksight/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -807,6 +807,14 @@ DescribeIpRestriction

[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/)

</details>
<details>
<summary>
DescribeKeyRegistration
</summary>

[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/)

</details>
<details>
<summary>
Expand Down Expand Up @@ -1463,6 +1471,14 @@ UpdateIpRestriction

[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/)

</details>
<details>
<summary>
UpdateKeyRegistration
</summary>

[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/)

</details>
<details>
<summary>
Expand Down
46 changes: 46 additions & 0 deletions clients/client-quicksight/src/QuickSight.ts
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,11 @@ import {
DescribeIpRestrictionCommandInput,
DescribeIpRestrictionCommandOutput,
} from "./commands/DescribeIpRestrictionCommand";
import {
DescribeKeyRegistrationCommand,
DescribeKeyRegistrationCommandInput,
DescribeKeyRegistrationCommandOutput,
} from "./commands/DescribeKeyRegistrationCommand";
import {
DescribeNamespaceCommand,
DescribeNamespaceCommandInput,
Expand Down Expand Up @@ -731,6 +736,11 @@ import {
UpdateIpRestrictionCommandInput,
UpdateIpRestrictionCommandOutput,
} from "./commands/UpdateIpRestrictionCommand";
import {
UpdateKeyRegistrationCommand,
UpdateKeyRegistrationCommandInput,
UpdateKeyRegistrationCommandOutput,
} from "./commands/UpdateKeyRegistrationCommand";
import {
UpdatePublicSharingSettingsCommand,
UpdatePublicSharingSettingsCommandInput,
Expand Down Expand Up @@ -872,6 +882,7 @@ const commands = {
DescribeIAMPolicyAssignmentCommand,
DescribeIngestionCommand,
DescribeIpRestrictionCommand,
DescribeKeyRegistrationCommand,
DescribeNamespaceCommand,
DescribeRefreshScheduleCommand,
DescribeRoleCustomPermissionCommand,
Expand Down Expand Up @@ -954,6 +965,7 @@ const commands = {
UpdateIAMPolicyAssignmentCommand,
UpdateIdentityPropagationConfigCommand,
UpdateIpRestrictionCommand,
UpdateKeyRegistrationCommand,
UpdatePublicSharingSettingsCommand,
UpdateRefreshScheduleCommand,
UpdateRoleCustomPermissionCommand,
Expand Down Expand Up @@ -2139,6 +2151,23 @@ export interface QuickSight {
cb: (err: any, data?: DescribeIpRestrictionCommandOutput) => void
): void;

/**
* @see {@link DescribeKeyRegistrationCommand}
*/
describeKeyRegistration(
args: DescribeKeyRegistrationCommandInput,
options?: __HttpHandlerOptions
): Promise<DescribeKeyRegistrationCommandOutput>;
describeKeyRegistration(
args: DescribeKeyRegistrationCommandInput,
cb: (err: any, data?: DescribeKeyRegistrationCommandOutput) => void
): void;
describeKeyRegistration(
args: DescribeKeyRegistrationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DescribeKeyRegistrationCommandOutput) => void
): void;

/**
* @see {@link DescribeNamespaceCommand}
*/
Expand Down Expand Up @@ -3389,6 +3418,23 @@ export interface QuickSight {
cb: (err: any, data?: UpdateIpRestrictionCommandOutput) => void
): void;

/**
* @see {@link UpdateKeyRegistrationCommand}
*/
updateKeyRegistration(
args: UpdateKeyRegistrationCommandInput,
options?: __HttpHandlerOptions
): Promise<UpdateKeyRegistrationCommandOutput>;
updateKeyRegistration(
args: UpdateKeyRegistrationCommandInput,
cb: (err: any, data?: UpdateKeyRegistrationCommandOutput) => void
): void;
updateKeyRegistration(
args: UpdateKeyRegistrationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: UpdateKeyRegistrationCommandOutput) => void
): void;

/**
* @see {@link UpdatePublicSharingSettingsCommand}
*/
Expand Down
12 changes: 12 additions & 0 deletions clients/client-quicksight/src/QuickSightClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,10 @@ import {
DescribeIpRestrictionCommandInput,
DescribeIpRestrictionCommandOutput,
} from "./commands/DescribeIpRestrictionCommand";
import {
DescribeKeyRegistrationCommandInput,
DescribeKeyRegistrationCommandOutput,
} from "./commands/DescribeKeyRegistrationCommand";
import { DescribeNamespaceCommandInput, DescribeNamespaceCommandOutput } from "./commands/DescribeNamespaceCommand";
import {
DescribeRefreshScheduleCommandInput,
Expand Down Expand Up @@ -465,6 +469,10 @@ import {
UpdateIpRestrictionCommandInput,
UpdateIpRestrictionCommandOutput,
} from "./commands/UpdateIpRestrictionCommand";
import {
UpdateKeyRegistrationCommandInput,
UpdateKeyRegistrationCommandOutput,
} from "./commands/UpdateKeyRegistrationCommand";
import {
UpdatePublicSharingSettingsCommandInput,
UpdatePublicSharingSettingsCommandOutput,
Expand Down Expand Up @@ -600,6 +608,7 @@ export type ServiceInputTypes =
| DescribeIAMPolicyAssignmentCommandInput
| DescribeIngestionCommandInput
| DescribeIpRestrictionCommandInput
| DescribeKeyRegistrationCommandInput
| DescribeNamespaceCommandInput
| DescribeRefreshScheduleCommandInput
| DescribeRoleCustomPermissionCommandInput
Expand Down Expand Up @@ -682,6 +691,7 @@ export type ServiceInputTypes =
| UpdateIAMPolicyAssignmentCommandInput
| UpdateIdentityPropagationConfigCommandInput
| UpdateIpRestrictionCommandInput
| UpdateKeyRegistrationCommandInput
| UpdatePublicSharingSettingsCommandInput
| UpdateRefreshScheduleCommandInput
| UpdateRoleCustomPermissionCommandInput
Expand Down Expand Up @@ -777,6 +787,7 @@ export type ServiceOutputTypes =
| DescribeIAMPolicyAssignmentCommandOutput
| DescribeIngestionCommandOutput
| DescribeIpRestrictionCommandOutput
| DescribeKeyRegistrationCommandOutput
| DescribeNamespaceCommandOutput
| DescribeRefreshScheduleCommandOutput
| DescribeRoleCustomPermissionCommandOutput
Expand Down Expand Up @@ -859,6 +870,7 @@ export type ServiceOutputTypes =
| UpdateIAMPolicyAssignmentCommandOutput
| UpdateIdentityPropagationConfigCommandOutput
| UpdateIpRestrictionCommandOutput
| UpdateKeyRegistrationCommandOutput
| UpdatePublicSharingSettingsCommandOutput
| UpdateRefreshScheduleCommandOutput
| UpdateRoleCustomPermissionCommandOutput
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
* ClusterId: "STRING_VALUE",
* IAMParameters: { // RedshiftIAMParameters
* RoleArn: "STRING_VALUE", // required
* DatabaseUser: "STRING_VALUE", // required
* DatabaseUser: "STRING_VALUE",
* DatabaseGroups: [ // DatabaseGroupList
* "STRING_VALUE",
* ],
Expand Down Expand Up @@ -239,7 +239,7 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
* ClusterId: "STRING_VALUE",
* IAMParameters: {
* RoleArn: "STRING_VALUE", // required
* DatabaseUser: "STRING_VALUE", // required
* DatabaseUser: "STRING_VALUE",
* DatabaseGroups: [
* "STRING_VALUE",
* ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ export interface DescribeAssetBundleImportJobCommandOutput
* // ClusterId: "STRING_VALUE",
* // IAMParameters: { // RedshiftIAMParameters
* // RoleArn: "STRING_VALUE", // required
* // DatabaseUser: "STRING_VALUE", // required
* // DatabaseUser: "STRING_VALUE",
* // DatabaseGroups: [ // DatabaseGroupList
* // "STRING_VALUE",
* // ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
* // ClusterId: "STRING_VALUE",
* // IAMParameters: { // RedshiftIAMParameters
* // RoleArn: "STRING_VALUE", // required
* // DatabaseUser: "STRING_VALUE", // required
* // DatabaseUser: "STRING_VALUE",
* // DatabaseGroups: [ // DatabaseGroupList
* // "STRING_VALUE",
* // ],
Expand Down Expand Up @@ -241,7 +241,7 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo
* // ClusterId: "STRING_VALUE",
* // IAMParameters: {
* // RoleArn: "STRING_VALUE", // required
* // DatabaseUser: "STRING_VALUE", // required
* // DatabaseUser: "STRING_VALUE",
* // DatabaseGroups: [
* // "STRING_VALUE",
* // ],
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
// smithy-typescript generated code
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
import { getSerdePlugin } from "@smithy/middleware-serde";
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { commonParams } from "../endpoint/EndpointParameters";
import { DescribeKeyRegistrationRequest, DescribeKeyRegistrationResponse } from "../models/models_3";
import { de_DescribeKeyRegistrationCommand, se_DescribeKeyRegistrationCommand } from "../protocols/Aws_restJson1";
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";

/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link DescribeKeyRegistrationCommand}.
*/
export interface DescribeKeyRegistrationCommandInput extends DescribeKeyRegistrationRequest {}
/**
* @public
*
* The output of {@link DescribeKeyRegistrationCommand}.
*/
export interface DescribeKeyRegistrationCommandOutput extends DescribeKeyRegistrationResponse, __MetadataBearer {}

/**
* <p>Describes all customer managed key registrations in a Amazon QuickSight account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { QuickSightClient, DescribeKeyRegistrationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
* // const { QuickSightClient, DescribeKeyRegistrationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
* const client = new QuickSightClient(config);
* const input = { // DescribeKeyRegistrationRequest
* AwsAccountId: "STRING_VALUE", // required
* DefaultKeyOnly: true || false,
* };
* const command = new DescribeKeyRegistrationCommand(input);
* const response = await client.send(command);
* // { // DescribeKeyRegistrationResponse
* // AwsAccountId: "STRING_VALUE",
* // KeyRegistration: [ // KeyRegistration
* // { // RegisteredCustomerManagedKey
* // KeyArn: "STRING_VALUE",
* // DefaultKey: true || false,
* // },
* // ],
* // RequestId: "STRING_VALUE",
* // Status: Number("int"),
* // };
*
* ```
*
* @param DescribeKeyRegistrationCommandInput - {@link DescribeKeyRegistrationCommandInput}
* @returns {@link DescribeKeyRegistrationCommandOutput}
* @see {@link DescribeKeyRegistrationCommandInput} for command's `input` shape.
* @see {@link DescribeKeyRegistrationCommandOutput} for command's `response` shape.
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
*
* @throws {@link AccessDeniedException} (client fault)
* <p>You don't have access to this item. The provided credentials couldn't be
* validated. You might not be authorized to carry out the request. Make sure that your
* account is authorized to use the Amazon QuickSight service, that your policies have the
* correct permissions, and that you are using the correct credentials.</p>
*
* @throws {@link InternalFailureException} (server fault)
* <p>An internal failure occurred.</p>
*
* @throws {@link InvalidParameterValueException} (client fault)
* <p>One or more parameters has a value that isn't valid.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>Access is throttled.</p>
*
* @throws {@link QuickSightServiceException}
* <p>Base exception class for all service exceptions from QuickSight service.</p>
*
* @public
*/
export class DescribeKeyRegistrationCommand extends $Command
.classBuilder<
DescribeKeyRegistrationCommandInput,
DescribeKeyRegistrationCommandOutput,
QuickSightClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes
>()
.ep({
...commonParams,
})
.m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) {
return [
getSerdePlugin(config, this.serialize, this.deserialize),
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
];
})
.s("QuickSight_20180401", "DescribeKeyRegistration", {})
.n("QuickSightClient", "DescribeKeyRegistrationCommand")
.f(void 0, void 0)
.ser(se_DescribeKeyRegistrationCommand)
.de(de_DescribeKeyRegistrationCommand)
.build() {}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { commonParams } from "../endpoint/EndpointParameters";
import { ListDataSourcesRequest, ListDataSourcesResponse } from "../models/models_3";
import { ListDataSourcesRequest } from "../models/models_3";
import { ListDataSourcesResponse } from "../models/models_4";
import { de_ListDataSourcesCommand, se_ListDataSourcesCommand } from "../protocols/Aws_restJson1";
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";

Expand Down Expand Up @@ -111,7 +112,7 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _
* // ClusterId: "STRING_VALUE",
* // IAMParameters: { // RedshiftIAMParameters
* // RoleArn: "STRING_VALUE", // required
* // DatabaseUser: "STRING_VALUE", // required
* // DatabaseUser: "STRING_VALUE",
* // DatabaseGroups: [ // DatabaseGroupList
* // "STRING_VALUE",
* // ],
Expand Down Expand Up @@ -243,7 +244,7 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _
* // ClusterId: "STRING_VALUE",
* // IAMParameters: {
* // RoleArn: "STRING_VALUE", // required
* // DatabaseUser: "STRING_VALUE", // required
* // DatabaseUser: "STRING_VALUE",
* // DatabaseGroups: [
* // "STRING_VALUE",
* // ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { commonParams } from "../endpoint/EndpointParameters";
import { ListFolderMembersRequest, ListFolderMembersResponse } from "../models/models_3";
import { ListFolderMembersRequest, ListFolderMembersResponse } from "../models/models_4";
import { de_ListFolderMembersCommand, se_ListFolderMembersCommand } from "../protocols/Aws_restJson1";
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";

Expand Down
3 changes: 1 addition & 2 deletions clients/client-quicksight/src/commands/ListFoldersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { commonParams } from "../endpoint/EndpointParameters";
import { ListFoldersRequest } from "../models/models_3";
import { ListFoldersResponse } from "../models/models_4";
import { ListFoldersRequest, ListFoldersResponse } from "../models/models_4";
import { de_ListFoldersCommand, se_ListFoldersCommand } from "../protocols/Aws_restJson1";
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ export interface StartAssetBundleImportJobCommandOutput extends StartAssetBundle
* ClusterId: "STRING_VALUE",
* IAMParameters: { // RedshiftIAMParameters
* RoleArn: "STRING_VALUE", // required
* DatabaseUser: "STRING_VALUE", // required
* DatabaseUser: "STRING_VALUE",
* DatabaseGroups: [ // DatabaseGroupList
* "STRING_VALUE",
* ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse,
* ClusterId: "STRING_VALUE",
* IAMParameters: { // RedshiftIAMParameters
* RoleArn: "STRING_VALUE", // required
* DatabaseUser: "STRING_VALUE", // required
* DatabaseUser: "STRING_VALUE",
* DatabaseGroups: [ // DatabaseGroupList
* "STRING_VALUE",
* ],
Expand Down Expand Up @@ -238,7 +238,7 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse,
* ClusterId: "STRING_VALUE",
* IAMParameters: {
* RoleArn: "STRING_VALUE", // required
* DatabaseUser: "STRING_VALUE", // required
* DatabaseUser: "STRING_VALUE",
* DatabaseGroups: [
* "STRING_VALUE",
* ],
Expand Down
Loading

0 comments on commit 5e19279

Please sign in to comment.