@aws-sdk/client-quicksight 3.473.0 → 3.474.0

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

@@ -0,0 +1,103 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { UpdateDashboardLinksRequest, UpdateDashboardLinksResponse } from "../models/models_4";
+import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateDashboardLinksCommand}.
+ */
+export interface UpdateDashboardLinksCommandInput extends UpdateDashboardLinksRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateDashboardLinksCommand}.
+ */
+export interface UpdateDashboardLinksCommandOutput extends UpdateDashboardLinksResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates the linked analyses on a dashboard.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QuickSightClient, UpdateDashboardLinksCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
+ * // const { QuickSightClient, UpdateDashboardLinksCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
+ * const client = new QuickSightClient(config);
+ * const input = { // UpdateDashboardLinksRequest
+ *   AwsAccountId: "STRING_VALUE", // required
+ *   DashboardId: "STRING_VALUE", // required
+ *   LinkEntities: [ // LinkEntityArnList // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UpdateDashboardLinksCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateDashboardLinksResponse
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * //   DashboardArn: "STRING_VALUE",
+ * //   LinkEntities: [ // LinkEntityArnList
+ * //     "STRING_VALUE",
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateDashboardLinksCommandInput - {@link UpdateDashboardLinksCommandInput}
+ * @returns {@link UpdateDashboardLinksCommandOutput}
+ * @see {@link UpdateDashboardLinksCommandInput} for command's `input` shape.
+ * @see {@link UpdateDashboardLinksCommandOutput} 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 ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</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 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>
+ *
+ */
+export declare class UpdateDashboardLinksCommand extends $Command<UpdateDashboardLinksCommandInput, UpdateDashboardLinksCommandOutput, QuickSightClientResolvedConfig> {
+    readonly input: UpdateDashboardLinksCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateDashboardLinksCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDashboardLinksCommandInput, UpdateDashboardLinksCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -3056,6 +3056,11 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
  *                   ],
  *                 },
  *                 SecondaryYAxisLabelOptions: "<ChartAxisLabelOptions>",
+ *                 SingleAxisOptions: { // SingleAxisOptions
+ *                   YAxisOptions: { // YAxisOptions
+ *                     YAxis: "PRIMARY_Y_AXIS", // required
+ *                   },
+ *                 },
  *                 DefaultSeriesSettings: { // LineChartDefaultSeriesSettings
  *                   AxisBinding: "PRIMARY_YAXIS" || "SECONDARY_YAXIS",
  *                   LineStyleSettings: { // LineChartLineStyleSettings
@@ -3594,6 +3599,9 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
  *                     Label: "<DimensionFieldList>",
  *                   },
  *                 },
+ *                 SortConfiguration: { // ScatterPlotSortConfiguration
+ *                   ScatterPlotLimitConfiguration: "<ItemsLimitConfiguration>",
+ *                 },
  *                 XAxisLabelOptions: "<ChartAxisLabelOptions>",
  *                 XAxisDisplayOptions: "<AxisDisplayOptions>",
  *                 YAxisLabelOptions: "<ChartAxisLabelOptions>",
@@ -3632,6 +3640,11 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
  *                 PrimaryYAxisLabelOptions: "<ChartAxisLabelOptions>",
  *                 SecondaryYAxisDisplayOptions: "<AxisDisplayOptions>",
  *                 SecondaryYAxisLabelOptions: "<ChartAxisLabelOptions>",
+ *                 SingleAxisOptions: {
+ *                   YAxisOptions: {
+ *                     YAxis: "PRIMARY_Y_AXIS", // required
+ *                   },
+ *                 },
  *                 ColorLabelOptions: "<ChartAxisLabelOptions>",
  *                 Legend: "<LegendOptions>",
  *                 BarDataLabels: "<DataLabelOptions>",

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

@@ -142,6 +142,7 @@ export * from "./UpdateAccountSettingsCommand";
 export * from "./UpdateAnalysisCommand";
 export * from "./UpdateAnalysisPermissionsCommand";
 export * from "./UpdateDashboardCommand";
+export * from "./UpdateDashboardLinksCommand";
 export * from "./UpdateDashboardPermissionsCommand";
 export * from "./UpdateDashboardPublishedVersionCommand";
 export * from "./UpdateDataSetCommand";

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

@@ -330,6 +330,40 @@ export interface ComboChartFieldWells {
      */
     ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const SingleYAxisOption: {
+    readonly PRIMARY_Y_AXIS: "PRIMARY_Y_AXIS";
+};
+/**
+ * @public
+ */
+export type SingleYAxisOption = (typeof SingleYAxisOption)[keyof typeof SingleYAxisOption];
+/**
+ * @public
+ * <p>The options that are available for a single Y axis in a chart.</p>
+ */
+export interface YAxisOptions {
+    /**
+     * @public
+     * <p>The Y axis type to be used in the chart.</p>
+     *          <p>If you choose <code>PRIMARY_Y_AXIS</code>, the primary Y Axis is located on the leftmost vertical axis of the chart.</p>
+     */
+    YAxis: SingleYAxisOption | undefined;
+}
+/**
+ * @public
+ * <p>The settings of a chart's single axis configuration.</p>
+ */
+export interface SingleAxisOptions {
+    /**
+     * @public
+     * <p>The Y axis options of a single axis configuration.</p>
+     */
+    YAxisOptions?: YAxisOptions;
+}
 /**
  * @public
  * <p>The sort configuration of a <code>ComboChartVisual</code>.</p>
@@ -420,6 +454,11 @@ export interface ComboChartConfiguration {
      * <p>The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.</p>
      */
     SecondaryYAxisLabelOptions?: ChartAxisLabelOptions;
+    /**
+     * @public
+     * <p>The settings of a chart's single axis configuration.</p>
+     */
+    SingleAxisOptions?: SingleAxisOptions;
     /**
      * @public
      * <p>The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.</p>
@@ -3584,6 +3623,11 @@ export interface LineChartConfiguration {
      * <p>The options that determine the presentation of the secondary y-axis label.</p>
      */
     SecondaryYAxisLabelOptions?: ChartAxisLabelOptions;
+    /**
+     * @public
+     * <p>The settings of a chart's single axis configuration.</p>
+     */
+    SingleAxisOptions?: SingleAxisOptions;
     /**
      * @public
      * <p>The options that determine the default presentation of all line series in <code>LineChartVisual</code>.</p>
@@ -5238,6 +5282,17 @@ export interface ScatterPlotFieldWells {
      */
     ScatterPlotUnaggregatedFieldWells?: ScatterPlotUnaggregatedFieldWells;
 }
+/**
+ * @public
+ * <p>The sort configuration of a scatter plot.</p>
+ */
+export interface ScatterPlotSortConfiguration {
+    /**
+     * @public
+     * <p>The limit configuration of the visual display for an axis.</p>
+     */
+    ScatterPlotLimitConfiguration?: ItemsLimitConfiguration;
+}
 /**
  * @public
  * <p>The configuration of a scatter plot.</p>
@@ -5248,6 +5303,11 @@ export interface ScatterPlotConfiguration {
      * <p>The field wells of the visual.</p>
      */
     FieldWells?: ScatterPlotFieldWells;
+    /**
+     * @public
+     * <p>The sort configuration of a scatter plot.</p>
+     */
+    SortConfiguration?: ScatterPlotSortConfiguration;
     /**
      * @public
      * <p>The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.</p>
@@ -6792,84 +6852,6 @@ export interface AnonymousUserDashboardEmbeddingConfiguration {
      */
     InitialDashboardId: string | undefined;
 }
-/**
- * @public
- * <p>A structure that contains the following elements:</p>
- *          <ul>
- *             <li>
- *                <p>The <code>DashboardId</code> of the dashboard that has the visual that you want to embed.</p>
- *             </li>
- *             <li>
- *                <p>The <code>SheetId</code> of the sheet that has the visual that you want to embed.</p>
- *             </li>
- *             <li>
- *                <p>The <code>VisualId</code> of the visual that you want to embed.</p>
- *             </li>
- *          </ul>
- *          <p>The <code>DashboardId</code>, <code>SheetId</code>, and <code>VisualId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the <code>DashboardId</code> with a <code>ListDashboards</code> API operation.</p>
- */
-export interface DashboardVisualId {
-    /**
-     * @public
-     * <p>The ID of the dashboard that has the visual that you want to embed. The <code>DashboardId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the <code>DashboardId</code> with a <code>ListDashboards</code> API operation.</p>
-     */
-    DashboardId: string | undefined;
-    /**
-     * @public
-     * <p>The ID of the sheet that the has visual that you want to embed. The <code>SheetId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console.</p>
-     */
-    SheetId: string | undefined;
-    /**
-     * @public
-     * <p>The ID of the visual that you want to embed. The <code>VisualID</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console.</p>
-     */
-    VisualId: string | undefined;
-}
-/**
- * @public
- * <p>The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.</p>
- */
-export interface AnonymousUserDashboardVisualEmbeddingConfiguration {
-    /**
-     * @public
-     * <p>The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.</p>
-     *          <p>The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>
-     */
-    InitialDashboardVisualId: DashboardVisualId | undefined;
-}
-/**
- * @public
- * <p>The settings that you want to use with the Q search bar.</p>
- */
-export interface AnonymousUserQSearchBarEmbeddingConfiguration {
-    /**
-     * @public
-     * <p>The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.</p>
-     *          <p>The Amazon Resource Name (ARN) of this Q topic must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>
-     */
-    InitialTopicId: string | undefined;
-}
-/**
- * @public
- * <p>The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.</p>
- */
-export interface AnonymousUserEmbeddingExperienceConfiguration {
-    /**
-     * @public
-     * <p>The type of embedding experience. In this case, Amazon QuickSight dashboards.</p>
-     */
-    Dashboard?: AnonymousUserDashboardEmbeddingConfiguration;
-    /**
-     * @public
-     * <p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>
-     */
-    DashboardVisual?: AnonymousUserDashboardVisualEmbeddingConfiguration;
-    /**
-     * @public
-     * <p>The Q search bar that you want to use for anonymous user embedding.</p>
-     */
-    QSearchBar?: AnonymousUserQSearchBarEmbeddingConfiguration;
-}
 /**
  * @internal
  */

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

@@ -1,7 +1,85 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { AccountCustomization, AdHocFilteringOption, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, CalculatedField, ColumnConfiguration, DashboardBehavior, DataSetIdentifierDeclaration, Edition, FilterGroup, NumberScale, ParameterDeclaration, ResourceStatus, TimeGranularity } from "./models_0";
-import { AnalysisDefinition, AnalysisSourceEntity, DataSetReference, SheetDefinition } from "./models_1";
+import { AnalysisDefinition, AnalysisSourceEntity, AnonymousUserDashboardEmbeddingConfiguration, DataSetReference, SheetDefinition } from "./models_1";
 import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
+/**
+ * @public
+ * <p>A structure that contains the following elements:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The <code>DashboardId</code> of the dashboard that has the visual that you want to embed.</p>
+ *             </li>
+ *             <li>
+ *                <p>The <code>SheetId</code> of the sheet that has the visual that you want to embed.</p>
+ *             </li>
+ *             <li>
+ *                <p>The <code>VisualId</code> of the visual that you want to embed.</p>
+ *             </li>
+ *          </ul>
+ *          <p>The <code>DashboardId</code>, <code>SheetId</code>, and <code>VisualId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the <code>DashboardId</code> with a <code>ListDashboards</code> API operation.</p>
+ */
+export interface DashboardVisualId {
+    /**
+     * @public
+     * <p>The ID of the dashboard that has the visual that you want to embed. The <code>DashboardId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the <code>DashboardId</code> with a <code>ListDashboards</code> API operation.</p>
+     */
+    DashboardId: string | undefined;
+    /**
+     * @public
+     * <p>The ID of the sheet that the has visual that you want to embed. The <code>SheetId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console.</p>
+     */
+    SheetId: string | undefined;
+    /**
+     * @public
+     * <p>The ID of the visual that you want to embed. The <code>VisualID</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console.</p>
+     */
+    VisualId: string | undefined;
+}
+/**
+ * @public
+ * <p>The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.</p>
+ */
+export interface AnonymousUserDashboardVisualEmbeddingConfiguration {
+    /**
+     * @public
+     * <p>The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.</p>
+     *          <p>The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>
+     */
+    InitialDashboardVisualId: DashboardVisualId | undefined;
+}
+/**
+ * @public
+ * <p>The settings that you want to use with the Q search bar.</p>
+ */
+export interface AnonymousUserQSearchBarEmbeddingConfiguration {
+    /**
+     * @public
+     * <p>The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.</p>
+     *          <p>The Amazon Resource Name (ARN) of this Q topic must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>
+     */
+    InitialTopicId: string | undefined;
+}
+/**
+ * @public
+ * <p>The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.</p>
+ */
+export interface AnonymousUserEmbeddingExperienceConfiguration {
+    /**
+     * @public
+     * <p>The type of embedding experience. In this case, Amazon QuickSight dashboards.</p>
+     */
+    Dashboard?: AnonymousUserDashboardEmbeddingConfiguration;
+    /**
+     * @public
+     * <p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>
+     */
+    DashboardVisual?: AnonymousUserDashboardVisualEmbeddingConfiguration;
+    /**
+     * @public
+     * <p>The Q search bar that you want to use for anonymous user embedding.</p>
+     */
+    QSearchBar?: AnonymousUserQSearchBarEmbeddingConfiguration;
+}
 /**
  * @public
  * @enum
@@ -122,7 +200,7 @@ export interface SnapshotS3DestinationConfiguration {
      * @public
      * <p>A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.</p>
      */
-    BucketConfiguration?: S3BucketConfiguration;
+    BucketConfiguration: S3BucketConfiguration | undefined;
 }
 /**
  * @public
@@ -4379,6 +4457,11 @@ export interface CreateDashboardRequest {
      * <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
      */
     LinkSharingConfiguration?: LinkSharingConfiguration;
+    /**
+     * @public
+     * <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
+     */
+    LinkEntities?: string[];
 }
 /**
  * @public
@@ -7698,85 +7781,6 @@ export interface DataAggregation {
      */
     DefaultDateColumnName?: string;
 }
-/**
- * @public
- * <p>A constant used in a category filter.</p>
- */
-export interface TopicCategoryFilterConstant {
-    /**
-     * @public
-     * <p>The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are <code>SINGULAR</code> and <code>COLLECTIVE</code>.</p>
-     */
-    ConstantType?: ConstantType;
-    /**
-     * @public
-     * <p>A singular constant used in a category filter. This element is used to specify a single value for the constant.</p>
-     */
-    SingularConstant?: string;
-    /**
-     * @public
-     * <p>A collective constant used in a category filter. This element is used to specify a list of values for the constant.</p>
-     */
-    CollectiveConstant?: CollectiveConstant;
-}
-/**
- * @public
- * <p>A structure that represents a category filter.</p>
- */
-export interface TopicCategoryFilter {
-    /**
-     * @public
-     * <p>The category filter function. Valid values for this structure are <code>EXACT</code> and <code>CONTAINS</code>.</p>
-     */
-    CategoryFilterFunction?: CategoryFilterFunction;
-    /**
-     * @public
-     * <p>The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.</p>
-     */
-    CategoryFilterType?: CategoryFilterType;
-    /**
-     * @public
-     * <p>The constant used in a category filter.</p>
-     */
-    Constant?: TopicCategoryFilterConstant;
-    /**
-     * @public
-     * <p>A Boolean value that indicates if the filter is inverse.</p>
-     */
-    Inverse?: boolean;
-}
-/**
- * @public
- * <p>A structure that represents a range constant.</p>
- */
-export interface RangeConstant {
-    /**
-     * @public
-     * <p>The minimum value for a range constant.</p>
-     */
-    Minimum?: string;
-    /**
-     * @public
-     * <p>The maximum value for a range constant.</p>
-     */
-    Maximum?: string;
-}
-/**
- * @public
- * <p>A constant value that is used in a range filter to specify the endpoints of the range.</p>
- */
-export interface TopicRangeFilterConstant {
-    /**
-     * @public
-     * <p>The data type of the constant value that is used in a range filter. Valid values for this structure are <code>RANGE</code>.</p>
-     */
-    ConstantType?: ConstantType;
-    /**
-     * @public
-     * <p>The value of the constant that is used to specify the endpoints of a range filter.</p>
-     */
-    RangeConstant?: RangeConstant;
-}
 /**
  * @internal
  */
@@ -7905,15 +7909,3 @@ export declare const TopicCalculatedFieldFilterSensitiveLog: (obj: TopicCalculat
  * @internal
  */
 export declare const TopicColumnFilterSensitiveLog: (obj: TopicColumn) => any;
-/**
- * @internal
- */
-export declare const TopicCategoryFilterConstantFilterSensitiveLog: (obj: TopicCategoryFilterConstant) => any;
-/**
- * @internal
- */
-export declare const TopicCategoryFilterFilterSensitiveLog: (obj: TopicCategoryFilter) => any;
-/**
- * @internal
- */
-export declare const TopicRangeFilterConstantFilterSensitiveLog: (obj: TopicRangeFilterConstant) => any;