@aws-sdk/client-quicksight 3.321.1 → 3.326.0

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

@@ -32,6 +32,21 @@ export interface DescribeTemplatePermissionsCommandOutput extends DescribeTempla
  * };
  * const command = new DescribeTemplatePermissionsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeTemplatePermissionsResponse
+ * //   TemplateId: "STRING_VALUE",
+ * //   TemplateArn: "STRING_VALUE",
+ * //   Permissions: [ // ResourcePermissionList
+ * //     { // ResourcePermission
+ * //       Principal: "STRING_VALUE", // required
+ * //       Actions: [ // ActionList // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   ],
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeTemplatePermissionsCommandInput - {@link DescribeTemplatePermissionsCommandInput}
@@ -61,6 +76,8 @@ export interface DescribeTemplatePermissionsCommandOutput extends DescribeTempla
  * 			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 DescribeTemplatePermissionsCommand extends $Command<DescribeTemplatePermissionsCommandInput, DescribeTemplatePermissionsCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -33,6 +33,16 @@ export interface DescribeThemeAliasCommandOutput extends DescribeThemeAliasRespo
  * };
  * const command = new DescribeThemeAliasCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeThemeAliasResponse
+ * //   ThemeAlias: { // ThemeAlias
+ * //     Arn: "STRING_VALUE",
+ * //     AliasName: "STRING_VALUE",
+ * //     ThemeVersionNumber: Number("long"),
+ * //   },
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeThemeAliasCommandInput - {@link DescribeThemeAliasCommandInput}
@@ -62,6 +72,8 @@ export interface DescribeThemeAliasCommandOutput extends DescribeThemeAliasRespo
  * 			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 DescribeThemeAliasCommand extends $Command<DescribeThemeAliasCommandInput, DescribeThemeAliasCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -34,6 +34,84 @@ export interface DescribeThemeCommandOutput extends DescribeThemeResponse, __Met
  * };
  * const command = new DescribeThemeCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeThemeResponse
+ * //   Theme: { // Theme
+ * //     Arn: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     ThemeId: "STRING_VALUE",
+ * //     Version: { // ThemeVersion
+ * //       VersionNumber: Number("long"),
+ * //       Arn: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //       BaseThemeId: "STRING_VALUE",
+ * //       CreatedTime: new Date("TIMESTAMP"),
+ * //       Configuration: { // ThemeConfiguration
+ * //         DataColorPalette: { // DataColorPalette
+ * //           Colors: [ // ColorList
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           MinMaxGradient: [
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           EmptyFillColor: "STRING_VALUE",
+ * //         },
+ * //         UIColorPalette: { // UIColorPalette
+ * //           PrimaryForeground: "STRING_VALUE",
+ * //           PrimaryBackground: "STRING_VALUE",
+ * //           SecondaryForeground: "STRING_VALUE",
+ * //           SecondaryBackground: "STRING_VALUE",
+ * //           Accent: "STRING_VALUE",
+ * //           AccentForeground: "STRING_VALUE",
+ * //           Danger: "STRING_VALUE",
+ * //           DangerForeground: "STRING_VALUE",
+ * //           Warning: "STRING_VALUE",
+ * //           WarningForeground: "STRING_VALUE",
+ * //           Success: "STRING_VALUE",
+ * //           SuccessForeground: "STRING_VALUE",
+ * //           Dimension: "STRING_VALUE",
+ * //           DimensionForeground: "STRING_VALUE",
+ * //           Measure: "STRING_VALUE",
+ * //           MeasureForeground: "STRING_VALUE",
+ * //         },
+ * //         Sheet: { // SheetStyle
+ * //           Tile: { // TileStyle
+ * //             Border: { // BorderStyle
+ * //               Show: true || false,
+ * //             },
+ * //           },
+ * //           TileLayout: { // TileLayoutStyle
+ * //             Gutter: { // GutterStyle
+ * //               Show: true || false,
+ * //             },
+ * //             Margin: { // MarginStyle
+ * //               Show: true || false,
+ * //             },
+ * //           },
+ * //         },
+ * //         Typography: { // Typography
+ * //           FontFamilies: [ // FontList
+ * //             { // Font
+ * //               FontFamily: "STRING_VALUE",
+ * //             },
+ * //           ],
+ * //         },
+ * //       },
+ * //       Errors: [ // ThemeErrorList
+ * //         { // ThemeError
+ * //           Type: "INTERNAL_FAILURE",
+ * //           Message: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       Status: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
+ * //     },
+ * //     CreatedTime: new Date("TIMESTAMP"),
+ * //     LastUpdatedTime: new Date("TIMESTAMP"),
+ * //     Type: "QUICKSIGHT" || "CUSTOM" || "ALL",
+ * //   },
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeThemeCommandInput - {@link DescribeThemeCommandInput}
@@ -69,6 +147,8 @@ export interface DescribeThemeCommandOutput extends DescribeThemeResponse, __Met
  * 			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 DescribeThemeCommand extends $Command<DescribeThemeCommandInput, DescribeThemeCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -32,6 +32,21 @@ export interface DescribeThemePermissionsCommandOutput extends DescribeThemePerm
  * };
  * const command = new DescribeThemePermissionsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeThemePermissionsResponse
+ * //   ThemeId: "STRING_VALUE",
+ * //   ThemeArn: "STRING_VALUE",
+ * //   Permissions: [ // ResourcePermissionList
+ * //     { // ResourcePermission
+ * //       Principal: "STRING_VALUE", // required
+ * //       Actions: [ // ActionList // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   ],
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeThemePermissionsCommandInput - {@link DescribeThemePermissionsCommandInput}
@@ -64,6 +79,8 @@ export interface DescribeThemePermissionsCommandOutput extends DescribeThemePerm
  * 			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 DescribeThemePermissionsCommand extends $Command<DescribeThemePermissionsCommandInput, DescribeThemePermissionsCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -33,6 +33,24 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
  * };
  * const command = new DescribeUserCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeUserResponse
+ * //   User: { // User
+ * //     Arn: "STRING_VALUE",
+ * //     UserName: "STRING_VALUE",
+ * //     Email: "STRING_VALUE",
+ * //     Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER",
+ * //     IdentityType: "IAM" || "QUICKSIGHT",
+ * //     Active: true || false,
+ * //     PrincipalId: "STRING_VALUE",
+ * //     CustomPermissionsName: "STRING_VALUE",
+ * //     ExternalLoginFederationProviderType: "STRING_VALUE",
+ * //     ExternalLoginFederationProviderUrl: "STRING_VALUE",
+ * //     ExternalLoginId: "STRING_VALUE",
+ * //   },
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeUserCommandInput - {@link DescribeUserCommandInput}
@@ -65,6 +83,8 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
  * @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 DescribeUserCommand extends $Command<DescribeUserCommandInput, DescribeUserCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -77,6 +77,13 @@ export interface GenerateEmbedUrlForAnonymousUserCommandOutput extends GenerateE
  * };
  * const command = new GenerateEmbedUrlForAnonymousUserCommand(input);
  * const response = await client.send(command);
+ * // { // GenerateEmbedUrlForAnonymousUserResponse
+ * //   EmbedUrl: "STRING_VALUE", // required
+ * //   Status: Number("int"), // required
+ * //   RequestId: "STRING_VALUE", // required
+ * //   AnonymousUserArn: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param GenerateEmbedUrlForAnonymousUserCommandInput - {@link GenerateEmbedUrlForAnonymousUserCommandInput}
@@ -124,6 +131,8 @@ export interface GenerateEmbedUrlForAnonymousUserCommandOutput extends GenerateE
  * 			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 GenerateEmbedUrlForAnonymousUserCommand extends $Command<GenerateEmbedUrlForAnonymousUserCommandInput, GenerateEmbedUrlForAnonymousUserCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -84,6 +84,12 @@ export interface GenerateEmbedUrlForRegisteredUserCommandOutput extends Generate
  * };
  * const command = new GenerateEmbedUrlForRegisteredUserCommand(input);
  * const response = await client.send(command);
+ * // { // GenerateEmbedUrlForRegisteredUserResponse
+ * //   EmbedUrl: "STRING_VALUE", // required
+ * //   Status: Number("int"), // required
+ * //   RequestId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param GenerateEmbedUrlForRegisteredUserCommandInput - {@link GenerateEmbedUrlForRegisteredUserCommandInput}
@@ -136,6 +142,8 @@ export interface GenerateEmbedUrlForRegisteredUserCommandOutput extends Generate
  * 			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 GenerateEmbedUrlForRegisteredUserCommand extends $Command<GenerateEmbedUrlForRegisteredUserCommandInput, GenerateEmbedUrlForRegisteredUserCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -63,6 +63,12 @@ export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlR
  * };
  * const command = new GetDashboardEmbedUrlCommand(input);
  * const response = await client.send(command);
+ * // { // GetDashboardEmbedUrlResponse
+ * //   EmbedUrl: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param GetDashboardEmbedUrlCommandInput - {@link GetDashboardEmbedUrlCommandInput}
@@ -126,6 +132,8 @@ export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlR
  * 			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 GetDashboardEmbedUrlCommand extends $Command<GetDashboardEmbedUrlCommandInput, GetDashboardEmbedUrlCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -59,6 +59,12 @@ export interface GetSessionEmbedUrlCommandOutput extends GetSessionEmbedUrlRespo
  * };
  * const command = new GetSessionEmbedUrlCommand(input);
  * const response = await client.send(command);
+ * // { // GetSessionEmbedUrlResponse
+ * //   EmbedUrl: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param GetSessionEmbedUrlCommandInput - {@link GetSessionEmbedUrlCommandInput}
@@ -103,6 +109,8 @@ export interface GetSessionEmbedUrlCommandOutput extends GetSessionEmbedUrlRespo
  * 			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 GetSessionEmbedUrlCommand extends $Command<GetSessionEmbedUrlCommandInput, GetSessionEmbedUrlCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -33,6 +33,22 @@ export interface ListAnalysesCommandOutput extends ListAnalysesResponse, __Metad
  * };
  * const command = new ListAnalysesCommand(input);
  * const response = await client.send(command);
+ * // { // ListAnalysesResponse
+ * //   AnalysisSummaryList: [ // AnalysisSummaryList
+ * //     { // AnalysisSummary
+ * //       Arn: "STRING_VALUE",
+ * //       AnalysisId: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       Status: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
+ * //       CreatedTime: new Date("TIMESTAMP"),
+ * //       LastUpdatedTime: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListAnalysesCommandInput - {@link ListAnalysesCommandInput}
@@ -56,6 +72,8 @@ export interface ListAnalysesCommandOutput extends ListAnalysesResponse, __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 ListAnalysesCommand extends $Command<ListAnalysesCommandInput, ListAnalysesCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -34,6 +34,22 @@ export interface ListDashboardVersionsCommandOutput extends ListDashboardVersion
  * };
  * const command = new ListDashboardVersionsCommand(input);
  * const response = await client.send(command);
+ * // { // ListDashboardVersionsResponse
+ * //   DashboardVersionSummaryList: [ // DashboardVersionSummaryList
+ * //     { // DashboardVersionSummary
+ * //       Arn: "STRING_VALUE",
+ * //       CreatedTime: new Date("TIMESTAMP"),
+ * //       VersionNumber: Number("long"),
+ * //       Status: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
+ * //       SourceEntityArn: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListDashboardVersionsCommandInput - {@link ListDashboardVersionsCommandInput}
@@ -63,6 +79,8 @@ export interface ListDashboardVersionsCommandOutput extends ListDashboardVersion
  * 			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 ListDashboardVersionsCommand extends $Command<ListDashboardVersionsCommandInput, ListDashboardVersionsCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -33,6 +33,23 @@ export interface ListDashboardsCommandOutput extends ListDashboardsResponse, __M
  * };
  * const command = new ListDashboardsCommand(input);
  * const response = await client.send(command);
+ * // { // ListDashboardsResponse
+ * //   DashboardSummaryList: [ // DashboardSummaryList
+ * //     { // DashboardSummary
+ * //       Arn: "STRING_VALUE",
+ * //       DashboardId: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       CreatedTime: new Date("TIMESTAMP"),
+ * //       LastUpdatedTime: new Date("TIMESTAMP"),
+ * //       PublishedVersionNumber: Number("long"),
+ * //       LastPublishedTime: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListDashboardsCommandInput - {@link ListDashboardsCommandInput}
@@ -56,6 +73,8 @@ export interface ListDashboardsCommandOutput extends ListDashboardsResponse, __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 ListDashboardsCommand extends $Command<ListDashboardsCommandInput, ListDashboardsCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -34,6 +34,31 @@ export interface ListDataSetsCommandOutput extends ListDataSetsResponse, __Metad
  * };
  * const command = new ListDataSetsCommand(input);
  * const response = await client.send(command);
+ * // { // ListDataSetsResponse
+ * //   DataSetSummaries: [ // DataSetSummaryList
+ * //     { // DataSetSummary
+ * //       Arn: "STRING_VALUE",
+ * //       DataSetId: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       CreatedTime: new Date("TIMESTAMP"),
+ * //       LastUpdatedTime: new Date("TIMESTAMP"),
+ * //       ImportMode: "SPICE" || "DIRECT_QUERY",
+ * //       RowLevelPermissionDataSet: { // RowLevelPermissionDataSet
+ * //         Namespace: "STRING_VALUE",
+ * //         Arn: "STRING_VALUE", // required
+ * //         PermissionPolicy: "GRANT_ACCESS" || "DENY_ACCESS", // required
+ * //         FormatVersion: "VERSION_1" || "VERSION_2",
+ * //         Status: "ENABLED" || "DISABLED",
+ * //       },
+ * //       RowLevelPermissionTagConfigurationApplied: true || false,
+ * //       ColumnLevelPermissionRulesApplied: true || false,
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param ListDataSetsCommandInput - {@link ListDataSetsCommandInput}
@@ -60,6 +85,8 @@ export interface ListDataSetsCommandOutput extends ListDataSetsResponse, __Metad
  * @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 ListDataSetsCommand extends $Command<ListDataSetsCommandInput, ListDataSetsCommandOutput, QuickSightClientResolvedConfig> {