@aws-sdk/client-quicksight 3.948.0 → 3.952.0

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

@@ -970,6 +970,14 @@ declare const DescribeTemplateDefinitionCommand_base: {
  * //                     },
  * //                   },
  * //                 ],
+ * //                 DashboardCustomizationVisualOptions: { // DashboardCustomizationVisualOptions
+ * //                   FieldsConfiguration: { // VisualCustomizationFieldsConfiguration
+ * //                     Status: "ENABLED" || "DISABLED",
+ * //                     AdditionalFields: [ // VisualCustomizationAdditionalFieldsList
+ * //                       "<ColumnIdentifier>",
+ * //                     ],
+ * //                   },
+ * //                 },
  * //                 Interactions: { // VisualInteractionOptions
  * //                   VisualMenuOption: { // VisualMenuOption
  * //                     AvailabilityStatus: "ENABLED" || "DISABLED",
@@ -1482,6 +1490,14 @@ declare const DescribeTemplateDefinitionCommand_base: {
  * //                   VerticalOverflowVisibility: "HIDDEN" || "VISIBLE",
  * //                   OverflowColumnHeaderVisibility: "HIDDEN" || "VISIBLE",
  * //                 },
+ * //                 DashboardCustomizationVisualOptions: {
+ * //                   FieldsConfiguration: {
+ * //                     Status: "ENABLED" || "DISABLED",
+ * //                     AdditionalFields: [
+ * //                       "<ColumnIdentifier>",
+ * //                     ],
+ * //                   },
+ * //                 },
  * //                 Interactions: {
  * //                   VisualMenuOption: {
  * //                     AvailabilityStatus: "ENABLED" || "DISABLED",
@@ -1959,6 +1975,59 @@ declare const DescribeTemplateDefinitionCommand_base: {
  * //                     },
  * //                   ],
  * //                 },
+ * //                 DefaultSeriesSettings: { // BarChartDefaultSeriesSettings
+ * //                   DecalSettings: { // DecalSettings
+ * //                     ElementValue: "STRING_VALUE",
+ * //                     DecalVisibility: "HIDDEN" || "VISIBLE",
+ * //                     DecalColor: "STRING_VALUE",
+ * //                     DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL",
+ * //                     DecalStyleType: "Manual" || "Auto",
+ * //                   },
+ * //                   BorderSettings: { // BorderSettings
+ * //                     BorderVisibility: "HIDDEN" || "VISIBLE",
+ * //                     BorderWidth: "STRING_VALUE",
+ * //                     BorderColor: "STRING_VALUE",
+ * //                   },
+ * //                 },
+ * //                 Series: [ // BarSeriesItemList
+ * //                   { // BarSeriesItem
+ * //                     FieldBarSeriesItem: { // FieldBarSeriesItem
+ * //                       FieldId: "STRING_VALUE", // required
+ * //                       Settings: { // BarChartSeriesSettings
+ * //                         DecalSettings: {
+ * //                           ElementValue: "STRING_VALUE",
+ * //                           DecalVisibility: "HIDDEN" || "VISIBLE",
+ * //                           DecalColor: "STRING_VALUE",
+ * //                           DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL",
+ * //                           DecalStyleType: "Manual" || "Auto",
+ * //                         },
+ * //                         BorderSettings: {
+ * //                           BorderVisibility: "HIDDEN" || "VISIBLE",
+ * //                           BorderWidth: "STRING_VALUE",
+ * //                           BorderColor: "STRING_VALUE",
+ * //                         },
+ * //                       },
+ * //                     },
+ * //                     DataFieldBarSeriesItem: { // DataFieldBarSeriesItem
+ * //                       FieldId: "STRING_VALUE", // required
+ * //                       FieldValue: "STRING_VALUE",
+ * //                       Settings: {
+ * //                         DecalSettings: {
+ * //                           ElementValue: "STRING_VALUE",
+ * //                           DecalVisibility: "HIDDEN" || "VISIBLE",
+ * //                           DecalColor: "STRING_VALUE",
+ * //                           DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL",
+ * //                           DecalStyleType: "Manual" || "Auto",
+ * //                         },
+ * //                         BorderSettings: {
+ * //                           BorderVisibility: "HIDDEN" || "VISIBLE",
+ * //                           BorderWidth: "STRING_VALUE",
+ * //                           BorderColor: "STRING_VALUE",
+ * //                         },
+ * //                       },
+ * //                     },
+ * //                   },
+ * //                 ],
  * //                 Legend: { // LegendOptions
  * //                   Visibility: "HIDDEN" || "VISIBLE",
  * //                   Title: "<LabelOptions>",
@@ -3195,6 +3264,13 @@ declare const DescribeTemplateDefinitionCommand_base: {
  * //                     MarkerSize: "STRING_VALUE",
  * //                     MarkerColor: "STRING_VALUE",
  * //                   },
+ * //                   DecalSettings: {
+ * //                     ElementValue: "STRING_VALUE",
+ * //                     DecalVisibility: "HIDDEN" || "VISIBLE",
+ * //                     DecalColor: "STRING_VALUE",
+ * //                     DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL",
+ * //                     DecalStyleType: "Manual" || "Auto",
+ * //                   },
  * //                 },
  * //                 Series: [ // SeriesItemList
  * //                   { // SeriesItem
@@ -3214,6 +3290,13 @@ declare const DescribeTemplateDefinitionCommand_base: {
  * //                           MarkerSize: "STRING_VALUE",
  * //                           MarkerColor: "STRING_VALUE",
  * //                         },
+ * //                         DecalSettings: {
+ * //                           ElementValue: "STRING_VALUE",
+ * //                           DecalVisibility: "HIDDEN" || "VISIBLE",
+ * //                           DecalColor: "STRING_VALUE",
+ * //                           DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL",
+ * //                           DecalStyleType: "Manual" || "Auto",
+ * //                         },
  * //                       },
  * //                     },
  * //                     DataFieldSeriesItem: { // DataFieldSeriesItem
@@ -3233,6 +3316,7 @@ declare const DescribeTemplateDefinitionCommand_base: {
  * //                           MarkerSize: "STRING_VALUE",
  * //                           MarkerColor: "STRING_VALUE",
  * //                         },
+ * //                         DecalSettings: "<DecalSettings>",
  * //                       },
  * //                     },
  * //                   },
@@ -3630,6 +3714,30 @@ declare const DescribeTemplateDefinitionCommand_base: {
  * //               ColumnHierarchies: "<ColumnHierarchyList>",
  * //               Actions: "<VisualCustomActionList>",
  * //               VisualContentAltText: "STRING_VALUE",
+ * //               GeocodingPreferences: [ // GeocodePreferenceList
+ * //                 { // GeocodePreference
+ * //                   RequestKey: { // GeocoderHierarchy
+ * //                     Country: "STRING_VALUE",
+ * //                     State: "STRING_VALUE",
+ * //                     County: "STRING_VALUE",
+ * //                     City: "STRING_VALUE",
+ * //                     PostCode: "STRING_VALUE",
+ * //                   },
+ * //                   Preference: { // GeocodePreferenceValue Union: only one key present
+ * //                     GeocoderHierarchy: {
+ * //                       Country: "STRING_VALUE",
+ * //                       State: "STRING_VALUE",
+ * //                       County: "STRING_VALUE",
+ * //                       City: "STRING_VALUE",
+ * //                       PostCode: "STRING_VALUE",
+ * //                     },
+ * //                     Coordinate: { // Coordinate
+ * //                       Latitude: Number("double"), // required
+ * //                       Longitude: Number("double"), // required
+ * //                     },
+ * //                   },
+ * //                 },
+ * //               ],
  * //             },
  * //             FilledMapVisual: { // FilledMapVisual
  * //               VisualId: "STRING_VALUE", // required
@@ -3680,6 +3788,30 @@ declare const DescribeTemplateDefinitionCommand_base: {
  * //               ColumnHierarchies: "<ColumnHierarchyList>",
  * //               Actions: "<VisualCustomActionList>",
  * //               VisualContentAltText: "STRING_VALUE",
+ * //               GeocodingPreferences: [
+ * //                 {
+ * //                   RequestKey: {
+ * //                     Country: "STRING_VALUE",
+ * //                     State: "STRING_VALUE",
+ * //                     County: "STRING_VALUE",
+ * //                     City: "STRING_VALUE",
+ * //                     PostCode: "STRING_VALUE",
+ * //                   },
+ * //                   Preference: {//  Union: only one key present
+ * //                     GeocoderHierarchy: {
+ * //                       Country: "STRING_VALUE",
+ * //                       State: "STRING_VALUE",
+ * //                       County: "STRING_VALUE",
+ * //                       City: "STRING_VALUE",
+ * //                       PostCode: "STRING_VALUE",
+ * //                     },
+ * //                     Coordinate: {
+ * //                       Latitude: Number("double"), // required
+ * //                       Longitude: Number("double"), // required
+ * //                     },
+ * //                   },
+ * //                 },
+ * //               ],
  * //             },
  * //             LayerMapVisual: { // LayerMapVisual
  * //               VisualId: "STRING_VALUE", // required
@@ -4066,6 +4198,63 @@ declare const DescribeTemplateDefinitionCommand_base: {
  * //                   },
  * //                 },
  * //                 ColorLabelOptions: "<ChartAxisLabelOptions>",
+ * //                 DefaultSeriesSettings: { // ComboChartDefaultSeriesSettings
+ * //                   LineStyleSettings: {
+ * //                     LineVisibility: "HIDDEN" || "VISIBLE",
+ * //                     LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED",
+ * //                     LineStyle: "SOLID" || "DOTTED" || "DASHED",
+ * //                     LineWidth: "STRING_VALUE",
+ * //                   },
+ * //                   MarkerStyleSettings: {
+ * //                     MarkerVisibility: "HIDDEN" || "VISIBLE",
+ * //                     MarkerShape: "CIRCLE" || "TRIANGLE" || "SQUARE" || "DIAMOND" || "ROUNDED_SQUARE",
+ * //                     MarkerSize: "STRING_VALUE",
+ * //                     MarkerColor: "STRING_VALUE",
+ * //                   },
+ * //                   DecalSettings: "<DecalSettings>",
+ * //                   BorderSettings: {
+ * //                     BorderVisibility: "HIDDEN" || "VISIBLE",
+ * //                     BorderWidth: "STRING_VALUE",
+ * //                     BorderColor: "STRING_VALUE",
+ * //                   },
+ * //                 },
+ * //                 Series: [ // ComboSeriesItemList
+ * //                   { // ComboSeriesItem
+ * //                     FieldComboSeriesItem: { // FieldComboSeriesItem
+ * //                       FieldId: "STRING_VALUE", // required
+ * //                       Settings: { // ComboChartSeriesSettings
+ * //                         LineStyleSettings: {
+ * //                           LineVisibility: "HIDDEN" || "VISIBLE",
+ * //                           LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED",
+ * //                           LineStyle: "SOLID" || "DOTTED" || "DASHED",
+ * //                           LineWidth: "STRING_VALUE",
+ * //                         },
+ * //                         MarkerStyleSettings: {
+ * //                           MarkerVisibility: "HIDDEN" || "VISIBLE",
+ * //                           MarkerShape: "CIRCLE" || "TRIANGLE" || "SQUARE" || "DIAMOND" || "ROUNDED_SQUARE",
+ * //                           MarkerSize: "STRING_VALUE",
+ * //                           MarkerColor: "STRING_VALUE",
+ * //                         },
+ * //                         DecalSettings: "<DecalSettings>",
+ * //                         BorderSettings: {
+ * //                           BorderVisibility: "HIDDEN" || "VISIBLE",
+ * //                           BorderWidth: "STRING_VALUE",
+ * //                           BorderColor: "STRING_VALUE",
+ * //                         },
+ * //                       },
+ * //                     },
+ * //                     DataFieldComboSeriesItem: { // DataFieldComboSeriesItem
+ * //                       FieldId: "STRING_VALUE", // required
+ * //                       FieldValue: "STRING_VALUE",
+ * //                       Settings: {
+ * //                         LineStyleSettings: "<LineChartLineStyleSettings>",
+ * //                         MarkerStyleSettings: "<LineChartMarkerStyleSettings>",
+ * //                         DecalSettings: "<DecalSettings>",
+ * //                         BorderSettings: "<BorderSettings>",
+ * //                       },
+ * //                     },
+ * //                   },
+ * //                 ],
  * //                 Legend: "<LegendOptions>",
  * //                 BarDataLabels: "<DataLabelOptions>",
  * //                 LineDataLabels: "<DataLabelOptions>",
@@ -5463,6 +5652,11 @@ declare const DescribeTemplateDefinitionCommand_base: {
  * //             },
  * //           ],
  * //         },
+ * //         DecalSettingsConfiguration: { // DecalSettingsConfiguration
+ * //           CustomDecalSettings: [ // DecalSettingsList
+ * //             "<DecalSettings>",
+ * //           ],
+ * //         },
  * //       },
  * //     ],
  * //     AnalysisDefaults: { // AnalysisDefaults

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,143 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetIdentityContextRequest, GetIdentityContextResponse } from "../models/models_4";
+import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetIdentityContextCommand}.
+ */
+export interface GetIdentityContextCommandInput extends GetIdentityContextRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetIdentityContextCommand}.
+ */
+export interface GetIdentityContextCommandOutput extends GetIdentityContextResponse, __MetadataBearer {
+}
+declare const GetIdentityContextCommand_base: {
+    new (input: GetIdentityContextCommandInput): import("@smithy/smithy-client").CommandImpl<GetIdentityContextCommandInput, GetIdentityContextCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetIdentityContextCommandInput): import("@smithy/smithy-client").CommandImpl<GetIdentityContextCommandInput, GetIdentityContextCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs.</p>
+ *          <p>Currently, you can call the following APIs with identity-enhanced Credentials</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_StartDashboardSnapshotJob.html">StartDashboardSnapshotJob</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboardSnapshotJob.html">DescribeDashboardSnapshotJob</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboardSnapshotJobResult.html">DescribeDashboardSnapshotJobResult</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Supported Authentication Methods</b>
+ *          </p>
+ *          <p>This API supports Quick Sight native users, IAM federated users, and Active Directory users. For Quick Sight users authenticated by Amazon Web Services Identity Center, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-identity-enhanced-iam-role-sessions.html">Identity Center documentation on identity-enhanced IAM role sessions</a>.</p>
+ *          <p>
+ *             <b>Getting Identity-Enhanced Credentials</b>
+ *          </p>
+ *          <p>To obtain identity-enhanced credentials, follow these steps:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Call the GetIdentityContext API to retrieve an identity token for the specified user.</p>
+ *             </li>
+ *             <li>
+ *                <p>Use the identity token with the <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">STS AssumeRole API</a> to obtain identity-enhanced IAM role session credentials.</p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Usage with STS AssumeRole</b>
+ *          </p>
+ *          <p>The identity token returned by this API should be used with the STS AssumeRole API to obtain credentials for an identity-enhanced IAM role session. When calling AssumeRole, include the identity token in the <code>ProvidedContexts</code> parameter with <code>ProviderArn</code> set to <code>arn:aws:iam::aws:contextProvider/QuickSight</code> and <code>ContextAssertion</code> set to the identity token received from this API.</p>
+ *          <p>The assumed role must allow the <code>sts:SetContext</code> action in addition to <code>sts:AssumeRole</code> in its trust relationship policy. The trust policy should include both actions for the principal that will be assuming the role.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QuickSightClient, GetIdentityContextCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
+ * // const { QuickSightClient, GetIdentityContextCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
+ * // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
+ * const config = {}; // type is QuickSightClientConfig
+ * const client = new QuickSightClient(config);
+ * const input = { // GetIdentityContextRequest
+ *   AwsAccountId: "STRING_VALUE", // required
+ *   UserIdentifier: { // UserIdentifier Union: only one key present
+ *     UserName: "STRING_VALUE",
+ *     Email: "STRING_VALUE",
+ *     UserArn: "STRING_VALUE",
+ *   },
+ *   Namespace: "STRING_VALUE",
+ *   SessionExpiresAt: new Date("TIMESTAMP"),
+ * };
+ * const command = new GetIdentityContextCommand(input);
+ * const response = await client.send(command);
+ * // { // GetIdentityContextResponse
+ * //   Status: Number("int"), // required
+ * //   RequestId: "STRING_VALUE", // required
+ * //   Context: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetIdentityContextCommandInput - {@link GetIdentityContextCommandInput}
+ * @returns {@link GetIdentityContextCommandOutput}
+ * @see {@link GetIdentityContextCommandInput} for command's `input` shape.
+ * @see {@link GetIdentityContextCommandOutput} 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 Quick Sight 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 PreconditionNotMetException} (client fault)
+ *  <p>One or more preconditions aren't met.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>One or more resources can't be found.</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 GetIdentityContextCommand extends GetIdentityContextCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetIdentityContextRequest;
+            output: GetIdentityContextResponse;
+        };
+        sdk: {
+            input: GetIdentityContextCommandInput;
+            output: GetIdentityContextCommandOutput;
+        };
+    };
+}

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

@@ -87,6 +87,61 @@ declare const StartDashboardSnapshotJobCommand_base: {
  *                <p>The size of the generated snapshots.</p>
  *             </li>
  *          </ul>
+ *          <p>
+ *             <b>Registered user support</b>
+ *          </p>
+ *          <p>You can generate snapshots for registered Quick Sight users by using the Snapshot Job APIs with <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-identity-enhanced-iam-role-sessions.html">identity-enhanced IAM role session credentials</a>. This approach allows you to create snapshots on behalf of specific Quick Sight users while respecting their row-level security (RLS), column-level security (CLS), dynamic default parameters and dashboard parameter/filter settings.</p>
+ *          <p>To generate snapshots for registered Quick Sight users, you need to:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Obtain identity-enhanced IAM role session credentials from AWS Security Token Service (STS).</p>
+ *             </li>
+ *             <li>
+ *                <p>Use these credentials to call the Snapshot Job APIs.</p>
+ *             </li>
+ *          </ul>
+ *          <p>Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user).</p>
+ *          <p>If your Quick Sight users are backed by <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">AWS Identity Center</a>, then you need to set up a <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/setuptrustedtokenissuer.html">trusted token issuer</a>. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Authenticate user with your OIDC compliant Identity Provider. You should get auth tokens back.</p>
+ *             </li>
+ *             <li>
+ *                <p>Use the OIDC API, <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateTokenWithIAM.html">CreateTokenWithIAM</a>, to exchange auth tokens to IAM tokens. One of the resulted tokens will be identity token.</p>
+ *             </li>
+ *             <li>
+ *                <p>Call STS AssumeRole API as you normally would, but provide an extra <code>ProvidedContexts</code> parameter in the API request. The list of contexts must have a single trusted context assertion. The <code>ProviderArn</code> should be <code>arn:aws:iam::aws:contextProvider/IdentityCenter</code> while <code>ContextAssertion</code> will be the identity token you received in response from CreateTokenWithIAM</p>
+ *             </li>
+ *          </ul>
+ *          <p>For more details, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-identity-enhanced-iam-role-sessions.html">IdC documentation on Identity-enhanced IAM role sessions</a>.</p>
+ *          <p>To obtain Identity-enhanced credentials for Quick Sight native users, IAM federated users, or Active Directory users, follow the steps below:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Call Quick Sight <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetIdentityContext.html">GetIdentityContext API</a> to get identity token.</p>
+ *             </li>
+ *             <li>
+ *                <p>Call STS AssumeRole API as you normally would, but provide extra <code>ProvidedContexts</code> parameter in the API request. The list of contexts must have a single trusted context assertion. The <code>ProviderArn</code> should be <code>arn:aws:iam::aws:contextProvider/QuickSight</code> while <code>ContextAssertion</code> will be the identity token you received in response from GetIdentityContext</p>
+ *             </li>
+ *          </ul>
+ *          <p>After obtaining the identity-enhanced IAM role session credentials, you can use them to start a job, describe the job and describe job result. You can use the same credentials as long as they haven't expired. All API requests made with these credentials are considered to be made by the impersonated Quick Sight user.</p>
+ *          <important>
+ *             <p>When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.</p>
+ *          </important>
+ *          <p>
+ *             <b>Possible error scenarios</b>
+ *          </p>
+ *          <p>The request fails with an Access Denied error in the following scenarios:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The credentials have expired.</p>
+ *             </li>
+ *             <li>
+ *                <p>The impersonated Quick Sight user doesn't have access to the specified dashboard.</p>
+ *             </li>
+ *             <li>
+ *                <p>The impersonated Quick Sight user is restricted from exporting data in the selected formats. For more information about export restrictions, see <a href="https://docs.aws.amazon.com/quicksuite/latest/userguide/create-custom-permisions-profile.html">Customizing access to Amazon Quick Sight capabilities</a>.</p>
+ *             </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript