@aws-sdk/client-quicksight 3.577.0 → 3.582.0

package/dist-types/commands/DescribeKeyRegistrationCommand.d.ts

@@ -0,0 +1,83 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DescribeKeyRegistrationRequest, DescribeKeyRegistrationResponse } from "../models/models_3";
+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 {
+}
+declare const DescribeKeyRegistrationCommand_base: {
+    new (input: DescribeKeyRegistrationCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeKeyRegistrationCommandInput, DescribeKeyRegistrationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DescribeKeyRegistrationCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeKeyRegistrationCommandInput, DescribeKeyRegistrationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <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 declare class DescribeKeyRegistrationCommand extends DescribeKeyRegistrationCommand_base {
+}

package/dist-types/commands/ListDataSourcesCommand.d.ts

@@ -1,6 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListDataSourcesRequest, ListDataSourcesResponse } from "../models/models_3";
+import { ListDataSourcesRequest } from "../models/models_3";
+import { ListDataSourcesResponse } from "../models/models_4";
 import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
 /**
  * @public
@@ -110,7 +111,7 @@ declare const ListDataSourcesCommand_base: {
  * //           ClusterId: "STRING_VALUE",
  * //           IAMParameters: { // RedshiftIAMParameters
  * //             RoleArn: "STRING_VALUE", // required
- * //             DatabaseUser: "STRING_VALUE", // required
+ * //             DatabaseUser: "STRING_VALUE",
  * //             DatabaseGroups: [ // DatabaseGroupList
  * //               "STRING_VALUE",
  * //             ],
@@ -242,7 +243,7 @@ declare const ListDataSourcesCommand_base: {
  * //             ClusterId: "STRING_VALUE",
  * //             IAMParameters: {
  * //               RoleArn: "STRING_VALUE", // required
- * //               DatabaseUser: "STRING_VALUE", // required
+ * //               DatabaseUser: "STRING_VALUE",
  * //               DatabaseGroups: [
  * //                 "STRING_VALUE",
  * //               ],

package/dist-types/commands/ListFolderMembersCommand.d.ts

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListFolderMembersRequest, ListFolderMembersResponse } from "../models/models_3";
+import { ListFolderMembersRequest, ListFolderMembersResponse } from "../models/models_4";
 import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
 /**
  * @public

package/dist-types/commands/ListFoldersCommand.d.ts

@@ -1,7 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListFoldersRequest } from "../models/models_3";
-import { ListFoldersResponse } from "../models/models_4";
+import { ListFoldersRequest, ListFoldersResponse } from "../models/models_4";
 import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
 /**
  * @public

package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts

@@ -133,7 +133,7 @@ declare const StartAssetBundleImportJobCommand_base: {
  *             ClusterId: "STRING_VALUE",
  *             IAMParameters: { // RedshiftIAMParameters
  *               RoleArn: "STRING_VALUE", // required
- *               DatabaseUser: "STRING_VALUE", // required
+ *               DatabaseUser: "STRING_VALUE",
  *               DatabaseGroups: [ // DatabaseGroupList
  *                 "STRING_VALUE",
  *               ],

package/dist-types/commands/UpdateDataSourceCommand.d.ts

@@ -97,7 +97,7 @@ declare const UpdateDataSourceCommand_base: {
  *       ClusterId: "STRING_VALUE",
  *       IAMParameters: { // RedshiftIAMParameters
  *         RoleArn: "STRING_VALUE", // required
- *         DatabaseUser: "STRING_VALUE", // required
+ *         DatabaseUser: "STRING_VALUE",
  *         DatabaseGroups: [ // DatabaseGroupList
  *           "STRING_VALUE",
  *         ],
@@ -233,7 +233,7 @@ declare const UpdateDataSourceCommand_base: {
  *             ClusterId: "STRING_VALUE",
  *             IAMParameters: {
  *               RoleArn: "STRING_VALUE", // required
- *               DatabaseUser: "STRING_VALUE", // required
+ *               DatabaseUser: "STRING_VALUE",
  *               DatabaseGroups: [
  *                 "STRING_VALUE",
  *               ],

package/dist-types/commands/UpdateKeyRegistrationCommand.d.ts

@@ -0,0 +1,94 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateKeyRegistrationRequest, UpdateKeyRegistrationResponse } from "../models/models_4";
+import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateKeyRegistrationCommand}.
+ */
+export interface UpdateKeyRegistrationCommandInput extends UpdateKeyRegistrationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateKeyRegistrationCommand}.
+ */
+export interface UpdateKeyRegistrationCommandOutput extends UpdateKeyRegistrationResponse, __MetadataBearer {
+}
+declare const UpdateKeyRegistrationCommand_base: {
+    new (input: UpdateKeyRegistrationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateKeyRegistrationCommandInput, UpdateKeyRegistrationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateKeyRegistrationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateKeyRegistrationCommandInput, UpdateKeyRegistrationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates a customer managed key 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, UpdateKeyRegistrationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
+ * // const { QuickSightClient, UpdateKeyRegistrationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
+ * const client = new QuickSightClient(config);
+ * const input = { // UpdateKeyRegistrationRequest
+ *   AwsAccountId: "STRING_VALUE", // required
+ *   KeyRegistration: [ // KeyRegistration // required
+ *     { // RegisteredCustomerManagedKey
+ *       KeyArn: "STRING_VALUE",
+ *       DefaultKey: true || false,
+ *     },
+ *   ],
+ * };
+ * const command = new UpdateKeyRegistrationCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateKeyRegistrationResponse
+ * //   FailedKeyRegistration: [ // FailedKeyRegistrationEntries
+ * //     { // FailedKeyRegistrationEntry
+ * //       KeyArn: "STRING_VALUE",
+ * //       Message: "STRING_VALUE", // required
+ * //       StatusCode: Number("int"), // required
+ * //       SenderFault: true || false, // required
+ * //     },
+ * //   ],
+ * //   SuccessfulKeyRegistration: [ // SuccessfulKeyRegistrationEntries
+ * //     { // SuccessfulKeyRegistrationEntry
+ * //       KeyArn: "STRING_VALUE", // required
+ * //       StatusCode: Number("int"), // required
+ * //     },
+ * //   ],
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateKeyRegistrationCommandInput - {@link UpdateKeyRegistrationCommandInput}
+ * @returns {@link UpdateKeyRegistrationCommandOutput}
+ * @see {@link UpdateKeyRegistrationCommandInput} for command's `input` shape.
+ * @see {@link UpdateKeyRegistrationCommandOutput} 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 declare class UpdateKeyRegistrationCommand extends UpdateKeyRegistrationCommand_base {
+}

package/dist-types/commands/index.d.ts

@@ -73,6 +73,7 @@ export * from "./DescribeGroupMembershipCommand";
 export * from "./DescribeIAMPolicyAssignmentCommand";
 export * from "./DescribeIngestionCommand";
 export * from "./DescribeIpRestrictionCommand";
+export * from "./DescribeKeyRegistrationCommand";
 export * from "./DescribeNamespaceCommand";
 export * from "./DescribeRefreshScheduleCommand";
 export * from "./DescribeRoleCustomPermissionCommand";
@@ -155,6 +156,7 @@ export * from "./UpdateGroupCommand";
 export * from "./UpdateIAMPolicyAssignmentCommand";
 export * from "./UpdateIdentityPropagationConfigCommand";
 export * from "./UpdateIpRestrictionCommand";
+export * from "./UpdateKeyRegistrationCommand";
 export * from "./UpdatePublicSharingSettingsCommand";
 export * from "./UpdateRefreshScheduleCommand";
 export * from "./UpdateRoleCustomPermissionCommand";

package/dist-types/models/models_2.d.ts

@@ -1751,7 +1751,7 @@ export interface RedshiftIAMParameters {
      * <p>The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of <code>AutoCreateDatabaseUser</code> to <code>True</code> to create a new user with PUBLIC permissions.</p>
      * @public
      */
-    DatabaseUser: string | undefined;
+    DatabaseUser?: string;
     /**
      * <p>A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the <code>DatabaseUser</code>. If you choose to include this parameter, the <code>RoleArn</code> must grant access to <code>redshift:JoinGroup</code>.</p>
      * @public

package/dist-types/models/models_3.d.ts

@@ -5420,6 +5420,72 @@ export interface DescribeIpRestrictionResponse {
      */
     Status?: number;
 }
+/**
+ * @public
+ */
+export interface DescribeKeyRegistrationRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>Determines whether the request returns the default key only.</p>
+     * @public
+     */
+    DefaultKeyOnly?: boolean;
+}
+/**
+ * <p>A customer managed key structure that contains the information listed below: </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>KeyArn</code> - The ARN of a KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>DefaultKey</code> - Indicates whether the current key is set as the default key for encryption and decryption use.</p>
+ *             </li>
+ *          </ul>
+ * @public
+ */
+export interface RegisteredCustomerManagedKey {
+    /**
+     * <p>The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.</p>
+     * @public
+     */
+    KeyArn?: string;
+    /**
+     * <p>Indicates whether a <code>RegisteredCustomerManagedKey</code> is set as the default key for encryption and decryption use.</p>
+     * @public
+     */
+    DefaultKey?: boolean;
+}
+/**
+ * @public
+ */
+export interface DescribeKeyRegistrationResponse {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.</p>
+     * @public
+     */
+    AwsAccountId?: string;
+    /**
+     * <p>A list of <code>RegisteredCustomerManagedKey</code> objects in a Amazon QuickSight account.</p>
+     * @public
+     */
+    KeyRegistration?: RegisteredCustomerManagedKey[];
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number;
+}
 /**
  * @public
  */
@@ -6609,7 +6675,7 @@ export interface User {
      *             </li>
      *             <li>
      *                <p>
-     *                   <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p>
+     *                   <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p>
      *             </li>
      *             <li>
      *                <p>
@@ -6890,6 +6956,33 @@ export declare const EmbeddingIdentityType: {
  * @public
  */
 export type EmbeddingIdentityType = (typeof EmbeddingIdentityType)[keyof typeof EmbeddingIdentityType];
+/**
+ * <p>An entry that appears when a <code>KeyRegistration</code> update to Amazon QuickSight fails.</p>
+ * @public
+ */
+export interface FailedKeyRegistrationEntry {
+    /**
+     * <p>The ARN of the KMS key that failed to update.</p>
+     * @public
+     */
+    KeyArn?: string;
+    /**
+     * <p>A message that provides information about why a <code>FailedKeyRegistrationEntry</code> error occurred.</p>
+     * @public
+     */
+    Message: string | undefined;
+    /**
+     * <p>The HTTP status of a <code>FailedKeyRegistrationEntry</code> error.</p>
+     * @public
+     */
+    StatusCode: number | undefined;
+    /**
+     * <p>A boolean that indicates whether a <code>FailedKeyRegistrationEntry</code> resulted from user error. If the value of this property is <code>True</code>, the error was caused by user error. If the value of this property is <code>False</code>, the error occurred on the backend. If your job continues fail and with a <code>False</code>
+     *             <code>SenderFault</code> value, contact Amazon Web Services Support.</p>
+     * @public
+     */
+    SenderFault: boolean | undefined;
+}
 /**
  * @public
  * @enum
@@ -8045,101 +8138,6 @@ export interface ListDataSourcesRequest {
      */
     MaxResults?: number;
 }
-/**
- * @public
- */
-export interface ListDataSourcesResponse {
-    /**
-     * <p>A list of data sources.</p>
-     * @public
-     */
-    DataSources?: DataSource[];
-    /**
-     * <p>The token for the next set of results, or null if there are no more results.</p>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     * @public
-     */
-    RequestId?: string;
-    /**
-     * <p>The HTTP status of the request.</p>
-     * @public
-     */
-    Status?: number;
-}
-/**
- * @public
- */
-export interface ListFolderMembersRequest {
-    /**
-     * <p>The ID for the Amazon Web Services account that contains the folder.</p>
-     * @public
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>The ID of the folder.</p>
-     * @public
-     */
-    FolderId: string | undefined;
-    /**
-     * <p>The token for the next set of results, or null if there are no more results.</p>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of results to be returned per request.</p>
-     * @public
-     */
-    MaxResults?: number;
-}
-/**
- * @public
- */
-export interface ListFolderMembersResponse {
-    /**
-     * <p>The HTTP status of the request.</p>
-     * @public
-     */
-    Status?: number;
-    /**
-     * <p>A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.</p>
-     * @public
-     */
-    FolderMemberList?: MemberIdArnPair[];
-    /**
-     * <p>The token for the next set of results, or null if there are no more results.</p>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     * @public
-     */
-    RequestId?: string;
-}
-/**
- * @public
- */
-export interface ListFoldersRequest {
-    /**
-     * <p>The ID for the Amazon Web Services account that contains the folder.</p>
-     * @public
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>The token for the next set of results, or null if there are no more results.</p>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of results to be returned per request.</p>
-     * @public
-     */
-    MaxResults?: number;
-}
 /**
  * @internal
  */