@aws-sdk/client-quicksight 3.325.0 → 3.326.0

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

@@ -32,6 +32,13 @@ export interface DeleteFolderCommandOutput extends DeleteFolderResponse, __Metad
  * };
  * const command = new DeleteFolderCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteFolderResponse
+ * //   Status: Number("int"),
+ * //   Arn: "STRING_VALUE",
+ * //   FolderId: "STRING_VALUE",
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DeleteFolderCommandInput - {@link DeleteFolderCommandInput}
@@ -70,6 +77,8 @@ export interface DeleteFolderCommandOutput extends DeleteFolderResponse, __Metad
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DeleteFolderCommand extends $Command<DeleteFolderCommandInput, DeleteFolderCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -34,6 +34,11 @@ export interface DeleteFolderMembershipCommandOutput extends DeleteFolderMembers
  * };
  * const command = new DeleteFolderMembershipCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteFolderMembershipResponse
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DeleteFolderMembershipCommandInput - {@link DeleteFolderMembershipCommandInput}
@@ -66,6 +71,8 @@ export interface DeleteFolderMembershipCommandOutput extends DeleteFolderMembers
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DeleteFolderMembershipCommand extends $Command<DeleteFolderMembershipCommandInput, DeleteFolderMembershipCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -33,6 +33,11 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
  * };
  * const command = new DeleteGroupCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteGroupResponse
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DeleteGroupCommandInput - {@link DeleteGroupCommandInput}
@@ -65,6 +70,8 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
  * @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>
  *
  */
 export declare class DeleteGroupCommand extends $Command<DeleteGroupCommandInput, DeleteGroupCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -34,6 +34,11 @@ export interface DeleteGroupMembershipCommandOutput extends DeleteGroupMembershi
  * };
  * const command = new DeleteGroupMembershipCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteGroupMembershipResponse
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DeleteGroupMembershipCommandInput - {@link DeleteGroupMembershipCommandInput}
@@ -66,6 +71,8 @@ export interface DeleteGroupMembershipCommandOutput extends DeleteGroupMembershi
  * @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>
  *
  */
 export declare class DeleteGroupMembershipCommand extends $Command<DeleteGroupMembershipCommandInput, DeleteGroupMembershipCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -33,6 +33,12 @@ export interface DeleteIAMPolicyAssignmentCommandOutput extends DeleteIAMPolicyA
  * };
  * const command = new DeleteIAMPolicyAssignmentCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteIAMPolicyAssignmentResponse
+ * //   AssignmentName: "STRING_VALUE",
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DeleteIAMPolicyAssignmentCommandInput - {@link DeleteIAMPolicyAssignmentCommandInput}
@@ -66,6 +72,8 @@ export interface DeleteIAMPolicyAssignmentCommandOutput extends DeleteIAMPolicyA
  * @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>
  *
  */
 export declare class DeleteIAMPolicyAssignmentCommand extends $Command<DeleteIAMPolicyAssignmentCommandInput, DeleteIAMPolicyAssignmentCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -34,6 +34,11 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _
  * };
  * const command = new DeleteNamespaceCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteNamespaceResponse
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DeleteNamespaceCommandInput - {@link DeleteNamespaceCommandInput}
@@ -66,6 +71,8 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _
  * @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>
  *
  */
 export declare class DeleteNamespaceCommand extends $Command<DeleteNamespaceCommandInput, DeleteNamespaceCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -33,6 +33,13 @@ export interface DeleteRefreshScheduleCommandOutput extends DeleteRefreshSchedul
  * };
  * const command = new DeleteRefreshScheduleCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteRefreshScheduleResponse
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * //   ScheduleId: "STRING_VALUE",
+ * //   Arn: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DeleteRefreshScheduleCommandInput - {@link DeleteRefreshScheduleCommandInput}
@@ -62,6 +69,8 @@ export interface DeleteRefreshScheduleCommandOutput extends DeleteRefreshSchedul
  * @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>
  *
  */
 export declare class DeleteRefreshScheduleCommand extends $Command<DeleteRefreshScheduleCommandInput, DeleteRefreshScheduleCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -34,6 +34,14 @@ export interface DeleteTemplateAliasCommandOutput extends DeleteTemplateAliasRes
  * };
  * const command = new DeleteTemplateAliasCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteTemplateAliasResponse
+ * //   Status: Number("int"),
+ * //   TemplateId: "STRING_VALUE",
+ * //   AliasName: "STRING_VALUE",
+ * //   Arn: "STRING_VALUE",
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DeleteTemplateAliasCommandInput - {@link DeleteTemplateAliasCommandInput}
@@ -60,6 +68,8 @@ export interface DeleteTemplateAliasCommandOutput extends DeleteTemplateAliasRes
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DeleteTemplateAliasCommand extends $Command<DeleteTemplateAliasCommandInput, DeleteTemplateAliasCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -33,6 +33,13 @@ export interface DeleteTemplateCommandOutput extends DeleteTemplateResponse, __M
  * };
  * const command = new DeleteTemplateCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteTemplateResponse
+ * //   RequestId: "STRING_VALUE",
+ * //   Arn: "STRING_VALUE",
+ * //   TemplateId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DeleteTemplateCommandInput - {@link DeleteTemplateCommandInput}
@@ -65,6 +72,8 @@ export interface DeleteTemplateCommandOutput extends DeleteTemplateResponse, __M
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DeleteTemplateCommand extends $Command<DeleteTemplateCommandInput, DeleteTemplateCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -35,6 +35,14 @@ export interface DeleteThemeAliasCommandOutput extends DeleteThemeAliasResponse,
  * };
  * const command = new DeleteThemeAliasCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteThemeAliasResponse
+ * //   AliasName: "STRING_VALUE",
+ * //   Arn: "STRING_VALUE",
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * //   ThemeId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DeleteThemeAliasCommandInput - {@link DeleteThemeAliasCommandInput}
@@ -64,6 +72,8 @@ export interface DeleteThemeAliasCommandOutput extends DeleteThemeAliasResponse,
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DeleteThemeAliasCommand extends $Command<DeleteThemeAliasCommandInput, DeleteThemeAliasCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -33,6 +33,13 @@ export interface DeleteThemeCommandOutput extends DeleteThemeResponse, __Metadat
  * };
  * const command = new DeleteThemeCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteThemeResponse
+ * //   Arn: "STRING_VALUE",
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * //   ThemeId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DeleteThemeCommandInput - {@link DeleteThemeCommandInput}
@@ -68,6 +75,8 @@ export interface DeleteThemeCommandOutput extends DeleteThemeResponse, __Metadat
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DeleteThemeCommand extends $Command<DeleteThemeCommandInput, DeleteThemeCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -33,6 +33,11 @@ export interface DeleteUserByPrincipalIdCommandOutput extends DeleteUserByPrinci
  * };
  * const command = new DeleteUserByPrincipalIdCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteUserByPrincipalIdResponse
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DeleteUserByPrincipalIdCommandInput - {@link DeleteUserByPrincipalIdCommandInput}
@@ -65,6 +70,8 @@ export interface DeleteUserByPrincipalIdCommandOutput extends DeleteUserByPrinci
  * @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>
  *
  */
 export declare class DeleteUserByPrincipalIdCommand extends $Command<DeleteUserByPrincipalIdCommandInput, DeleteUserByPrincipalIdCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -35,6 +35,11 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
  * };
  * const command = new DeleteUserCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteUserResponse
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DeleteUserCommandInput - {@link DeleteUserCommandInput}
@@ -67,6 +72,8 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
  * @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>
  *
  */
 export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -89,6 +89,18 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
  * };
  * const command = new DescribeAccountCustomizationCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAccountCustomizationResponse
+ * //   Arn: "STRING_VALUE",
+ * //   AwsAccountId: "STRING_VALUE",
+ * //   Namespace: "STRING_VALUE",
+ * //   AccountCustomization: { // AccountCustomization
+ * //     DefaultTheme: "STRING_VALUE",
+ * //     DefaultEmailCustomizationTemplate: "STRING_VALUE",
+ * //   },
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeAccountCustomizationCommandInput - {@link DescribeAccountCustomizationCommandInput}
@@ -118,6 +130,8 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
  * @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>
  *
  */
 export declare class DescribeAccountCustomizationCommand extends $Command<DescribeAccountCustomizationCommandInput, DescribeAccountCustomizationCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -32,6 +32,19 @@ export interface DescribeAccountSettingsCommandOutput extends DescribeAccountSet
  * };
  * const command = new DescribeAccountSettingsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAccountSettingsResponse
+ * //   AccountSettings: { // AccountSettings
+ * //     AccountName: "STRING_VALUE",
+ * //     Edition: "STANDARD" || "ENTERPRISE" || "ENTERPRISE_AND_Q",
+ * //     DefaultNamespace: "STRING_VALUE",
+ * //     NotificationEmail: "STRING_VALUE",
+ * //     PublicSharingEnabled: true || false,
+ * //     TerminationProtectionEnabled: true || false,
+ * //   },
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeAccountSettingsCommandInput - {@link DescribeAccountSettingsCommandInput}
@@ -61,6 +74,8 @@ export interface DescribeAccountSettingsCommandOutput extends DescribeAccountSet
  * @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>
  *
  */
 export declare class DescribeAccountSettingsCommand extends $Command<DescribeAccountSettingsCommandInput, DescribeAccountSettingsCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -31,6 +31,18 @@ export interface DescribeAccountSubscriptionCommandOutput extends DescribeAccoun
  * };
  * const command = new DescribeAccountSubscriptionCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAccountSubscriptionResponse
+ * //   AccountInfo: { // AccountInfo
+ * //     AccountName: "STRING_VALUE",
+ * //     Edition: "STANDARD" || "ENTERPRISE" || "ENTERPRISE_AND_Q",
+ * //     NotificationEmail: "STRING_VALUE",
+ * //     AuthenticationType: "STRING_VALUE",
+ * //     AccountSubscriptionStatus: "STRING_VALUE",
+ * //   },
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeAccountSubscriptionCommandInput - {@link DescribeAccountSubscriptionCommandInput}
@@ -60,6 +72,8 @@ export interface DescribeAccountSubscriptionCommandOutput extends DescribeAccoun
  * @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>
  *
  */
 export declare class DescribeAccountSubscriptionCommand extends $Command<DescribeAccountSubscriptionCommandInput, DescribeAccountSubscriptionCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -32,6 +32,40 @@ export interface DescribeAnalysisCommandOutput extends DescribeAnalysisResponse,
  * };
  * const command = new DescribeAnalysisCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAnalysisResponse
+ * //   Analysis: { // Analysis
+ * //     AnalysisId: "STRING_VALUE",
+ * //     Arn: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     Status: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
+ * //     Errors: [ // AnalysisErrorList
+ * //       { // AnalysisError
+ * //         Type: "ACCESS_DENIED" || "SOURCE_NOT_FOUND" || "DATA_SET_NOT_FOUND" || "INTERNAL_FAILURE" || "PARAMETER_VALUE_INCOMPATIBLE" || "PARAMETER_TYPE_INVALID" || "PARAMETER_NOT_FOUND" || "COLUMN_TYPE_MISMATCH" || "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" || "COLUMN_REPLACEMENT_MISSING",
+ * //         Message: "STRING_VALUE",
+ * //         ViolatedEntities: [ // EntityList
+ * //           { // Entity
+ * //             Path: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     DataSetArns: [ // DataSetArnsList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     ThemeArn: "STRING_VALUE",
+ * //     CreatedTime: new Date("TIMESTAMP"),
+ * //     LastUpdatedTime: new Date("TIMESTAMP"),
+ * //     Sheets: [ // SheetList
+ * //       { // Sheet
+ * //         SheetId: "STRING_VALUE",
+ * //         Name: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //   },
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeAnalysisCommandInput - {@link DescribeAnalysisCommandInput}
@@ -64,6 +98,8 @@ export interface DescribeAnalysisCommandOutput extends DescribeAnalysisResponse,
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeAnalysisCommand extends $Command<DescribeAnalysisCommandInput, DescribeAnalysisCommandOutput, QuickSightClientResolvedConfig> {