@aws-sdk/client-quicksight 3.262.0 → 3.264.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/dist-cjs/commands/CreateAnalysisCommand.js +1 -2
  2. package/dist-cjs/commands/GetSessionEmbedUrlCommand.js +2 -1
  3. package/dist-cjs/commands/ListAnalysesCommand.js +3 -3
  4. package/dist-cjs/commands/ListDashboardVersionsCommand.js +3 -3
  5. package/dist-cjs/commands/ListDashboardsCommand.js +3 -3
  6. package/dist-cjs/commands/ListDataSetsCommand.js +3 -3
  7. package/dist-cjs/commands/ListDataSourcesCommand.js +1 -2
  8. package/dist-cjs/endpoint/ruleset.js +1 -1
  9. package/dist-cjs/models/models_1.js +39 -64
  10. package/dist-cjs/models/models_2.js +96 -80
  11. package/dist-cjs/models/models_3.js +78 -6
  12. package/dist-cjs/protocols/Aws_restJson1.js +399 -2
  13. package/dist-es/commands/CreateAnalysisCommand.js +1 -2
  14. package/dist-es/commands/GetSessionEmbedUrlCommand.js +2 -1
  15. package/dist-es/commands/ListAnalysesCommand.js +1 -1
  16. package/dist-es/commands/ListDashboardVersionsCommand.js +1 -1
  17. package/dist-es/commands/ListDashboardsCommand.js +1 -1
  18. package/dist-es/commands/ListDataSetsCommand.js +1 -1
  19. package/dist-es/commands/ListDataSourcesCommand.js +1 -2
  20. package/dist-es/endpoint/ruleset.js +1 -1
  21. package/dist-es/models/models_1.js +28 -52
  22. package/dist-es/models/models_2.js +74 -60
  23. package/dist-es/models/models_3.js +61 -2
  24. package/dist-es/protocols/Aws_restJson1.js +399 -2
  25. package/dist-types/QuickSight.d.ts +4 -4
  26. package/dist-types/commands/CreateAnalysisCommand.d.ts +2 -3
  27. package/dist-types/commands/CreateDashboardCommand.d.ts +1 -1
  28. package/dist-types/commands/CreateTemplateCommand.d.ts +2 -2
  29. package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +2 -1
  30. package/dist-types/commands/ListAnalysesCommand.d.ts +1 -1
  31. package/dist-types/commands/ListDashboardVersionsCommand.d.ts +1 -1
  32. package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
  33. package/dist-types/commands/ListDataSetsCommand.d.ts +1 -1
  34. package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -2
  35. package/dist-types/models/models_0.d.ts +1 -1
  36. package/dist-types/models/models_1.d.ts +192 -193
  37. package/dist-types/models/models_2.d.ts +354 -271
  38. package/dist-types/models/models_3.d.ts +274 -2
  39. package/dist-types/ts3.4/commands/CreateAnalysisCommand.d.ts +4 -2
  40. package/dist-types/ts3.4/commands/GetSessionEmbedUrlCommand.d.ts +2 -4
  41. package/dist-types/ts3.4/commands/ListAnalysesCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/ListDashboardVersionsCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/ListDataSetsCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +4 -2
  46. package/dist-types/ts3.4/models/models_0.d.ts +1 -1
  47. package/dist-types/ts3.4/models/models_1.d.ts +70 -65
  48. package/dist-types/ts3.4/models/models_2.d.ts +116 -118
  49. package/dist-types/ts3.4/models/models_3.d.ts +120 -4
  50. package/package.json +4 -4
@@ -1,7 +1,7 @@
1
1
  import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
- import { ListDataSetsRequest, ListDataSetsResponse } from "../models/models_2";
4
+ import { ListDataSetsRequest, ListDataSetsResponse } from "../models/models_3";
5
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
6
  export interface ListDataSetsCommandInput extends ListDataSetsRequest {
7
7
  }
@@ -1,8 +1,7 @@
1
1
  import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
- import { ListDataSourcesRequest } from "../models/models_2";
5
- import { ListDataSourcesResponse } from "../models/models_3";
4
+ import { ListDataSourcesRequest, ListDataSourcesResponse } from "../models/models_3";
6
5
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
7
6
  export interface ListDataSourcesCommandInput extends ListDataSourcesRequest {
8
7
  }
@@ -1125,7 +1125,7 @@ export interface CategoryFilter {
1125
1125
  /**
1126
1126
  * <p>The configuration for a <code>CategoryFilter</code>.</p>
1127
1127
  */
1128
- Configuration?: CategoryFilterConfiguration;
1128
+ Configuration: CategoryFilterConfiguration | undefined;
1129
1129
  }
1130
1130
  export declare enum NumericEqualityMatchOperator {
1131
1131
  DOES_NOT_EQUAL = "DOES_NOT_EQUAL",
@@ -3098,6 +3098,165 @@ export interface PivotTableVisual {
3098
3098
  */
3099
3099
  Actions?: VisualCustomAction[];
3100
3100
  }
3101
+ /**
3102
+ * <p>The configured style settings of a radar chart.</p>
3103
+ */
3104
+ export interface RadarChartAreaStyleSettings {
3105
+ /**
3106
+ * <p>The visibility settings of a radar chart.</p>
3107
+ */
3108
+ Visibility?: Visibility | string;
3109
+ }
3110
+ /**
3111
+ * <p>The series settings of a radar chart.</p>
3112
+ */
3113
+ export interface RadarChartSeriesSettings {
3114
+ /**
3115
+ * <p>The area style settings of a radar chart.</p>
3116
+ */
3117
+ AreaStyleSettings?: RadarChartAreaStyleSettings;
3118
+ }
3119
+ /**
3120
+ * <p>The aggregated field well configuration of a <code>RadarChartVisual</code>.</p>
3121
+ */
3122
+ export interface RadarChartAggregatedFieldWells {
3123
+ /**
3124
+ * <p>The aggregated field well categories of a radar chart.</p>
3125
+ */
3126
+ Category?: DimensionField[];
3127
+ /**
3128
+ * <p>The color that are assigned to the aggregated field wells of a radar chart.</p>
3129
+ */
3130
+ Color?: DimensionField[];
3131
+ /**
3132
+ * <p>The values that are assigned to the aggregated field wells of a radar chart.</p>
3133
+ */
3134
+ Values?: MeasureField[];
3135
+ }
3136
+ /**
3137
+ * <p>The field wells of a radar chart visual.</p>
3138
+ */
3139
+ export interface RadarChartFieldWells {
3140
+ /**
3141
+ * <p>The aggregated field wells of a radar chart visual.</p>
3142
+ */
3143
+ RadarChartAggregatedFieldWells?: RadarChartAggregatedFieldWells;
3144
+ }
3145
+ export declare enum RadarChartShape {
3146
+ CIRCLE = "CIRCLE",
3147
+ POLYGON = "POLYGON"
3148
+ }
3149
+ /**
3150
+ * <p>The sort configuration of a <code>RadarChartVisual</code>.</p>
3151
+ */
3152
+ export interface RadarChartSortConfiguration {
3153
+ /**
3154
+ * <p>The category sort options of a radar chart.</p>
3155
+ */
3156
+ CategorySort?: FieldSortOptions[];
3157
+ /**
3158
+ * <p>The category items limit for a radar chart.</p>
3159
+ */
3160
+ CategoryItemsLimit?: ItemsLimitConfiguration;
3161
+ /**
3162
+ * <p>The color sort configuration of a radar chart.</p>
3163
+ */
3164
+ ColorSort?: FieldSortOptions[];
3165
+ /**
3166
+ * <p>The color items limit of a radar chart.</p>
3167
+ */
3168
+ ColorItemsLimit?: ItemsLimitConfiguration;
3169
+ }
3170
+ /**
3171
+ * <p>The configuration of a <code>RadarChartVisual</code>.</p>
3172
+ */
3173
+ export interface RadarChartConfiguration {
3174
+ /**
3175
+ * <p>The field well configuration of a <code>RadarChartVisual</code>.</p>
3176
+ */
3177
+ FieldWells?: RadarChartFieldWells;
3178
+ /**
3179
+ * <p>The sort configuration of a <code>RadarChartVisual</code>.</p>
3180
+ */
3181
+ SortConfiguration?: RadarChartSortConfiguration;
3182
+ /**
3183
+ * <p>The shape of the radar chart.</p>
3184
+ */
3185
+ Shape?: RadarChartShape | string;
3186
+ /**
3187
+ * <p>The base sreies settings of a radar chart.</p>
3188
+ */
3189
+ BaseSeriesSettings?: RadarChartSeriesSettings;
3190
+ /**
3191
+ * <p>The start angle of a radar chart's axis.</p>
3192
+ */
3193
+ StartAngle?: number;
3194
+ /**
3195
+ * <p>The palette (chart color) display setup of the visual.</p>
3196
+ */
3197
+ VisualPalette?: VisualPalette;
3198
+ /**
3199
+ * <p>Determines the visibility of the colors of alternatign bands in a radar chart.</p>
3200
+ */
3201
+ AlternateBandColorsVisibility?: Visibility | string;
3202
+ /**
3203
+ * <p>The color of the even-numbered alternate bands of a radar chart.</p>
3204
+ */
3205
+ AlternateBandEvenColor?: string;
3206
+ /**
3207
+ * <p>The color of the odd-numbered alternate bands of a radar chart.</p>
3208
+ */
3209
+ AlternateBandOddColor?: string;
3210
+ /**
3211
+ * <p>The category axis of a radar chart.</p>
3212
+ */
3213
+ CategoryAxis?: AxisDisplayOptions;
3214
+ /**
3215
+ * <p>The category label options of a radar chart.</p>
3216
+ */
3217
+ CategoryLabelOptions?: ChartAxisLabelOptions;
3218
+ /**
3219
+ * <p>The color axis of a radar chart.</p>
3220
+ */
3221
+ ColorAxis?: AxisDisplayOptions;
3222
+ /**
3223
+ * <p>The color label options of a radar chart.</p>
3224
+ */
3225
+ ColorLabelOptions?: ChartAxisLabelOptions;
3226
+ /**
3227
+ * <p>The legend display setup of the visual.</p>
3228
+ */
3229
+ Legend?: LegendOptions;
3230
+ }
3231
+ /**
3232
+ * <p>A radar chart visual.</p>
3233
+ */
3234
+ export interface RadarChartVisual {
3235
+ /**
3236
+ * <p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>
3237
+ */
3238
+ VisualId: string | undefined;
3239
+ /**
3240
+ * <p>The title that is displayed on the visual.</p>
3241
+ */
3242
+ Title?: VisualTitleLabelOptions;
3243
+ /**
3244
+ * <p>The subtitle that is displayed on the visual.</p>
3245
+ */
3246
+ Subtitle?: VisualSubtitleLabelOptions;
3247
+ /**
3248
+ * <p>The configuration settings of the visual.</p>
3249
+ */
3250
+ ChartConfiguration?: RadarChartConfiguration;
3251
+ /**
3252
+ * <p>The list of custom actions that are configured for a visual.</p>
3253
+ */
3254
+ Actions?: VisualCustomAction[];
3255
+ /**
3256
+ * <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
3257
+ */
3258
+ ColumnHierarchies?: ColumnHierarchy[];
3259
+ }
3101
3260
  /**
3102
3261
  * <p>The field well configuration of a sankey diagram.</p>
3103
3262
  */
@@ -4190,6 +4349,11 @@ export interface Visual {
4190
4349
  * <p>An empty visual.</p>
4191
4350
  */
4192
4351
  EmptyVisual?: EmptyVisual;
4352
+ /**
4353
+ * <p>A radar chart visual.</p>
4354
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html">Using radar charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>
4355
+ */
4356
+ RadarChartVisual?: RadarChartVisual;
4193
4357
  }
4194
4358
  /**
4195
4359
  * <p>A sheet is an object that contains a set of visuals that
@@ -5139,171 +5303,6 @@ export interface CreateAccountSubscriptionResponse {
5139
5303
  */
5140
5304
  RequestId?: string;
5141
5305
  }
5142
- /**
5143
- * <p>One or more preconditions aren't met.</p>
5144
- */
5145
- export declare class PreconditionNotMetException extends __BaseException {
5146
- readonly name: "PreconditionNotMetException";
5147
- readonly $fault: "client";
5148
- Message?: string;
5149
- /**
5150
- * <p>The Amazon Web Services request ID for this request.</p>
5151
- */
5152
- RequestId?: string;
5153
- /**
5154
- * @internal
5155
- */
5156
- constructor(opts: __ExceptionOptionType<PreconditionNotMetException, __BaseException>);
5157
- }
5158
- /**
5159
- * <p>A date-time parameter.</p>
5160
- */
5161
- export interface DateTimeParameter {
5162
- /**
5163
- * <p>A display name for the date-time parameter.</p>
5164
- */
5165
- Name: string | undefined;
5166
- /**
5167
- * <p>The values for the date-time parameter.</p>
5168
- */
5169
- Values: Date[] | undefined;
5170
- }
5171
- /**
5172
- * <p>A decimal parameter.</p>
5173
- */
5174
- export interface DecimalParameter {
5175
- /**
5176
- * <p>A display name for the decimal parameter.</p>
5177
- */
5178
- Name: string | undefined;
5179
- /**
5180
- * <p>The values for the decimal parameter.</p>
5181
- */
5182
- Values: number[] | undefined;
5183
- }
5184
- /**
5185
- * <p>An integer parameter.</p>
5186
- */
5187
- export interface IntegerParameter {
5188
- /**
5189
- * <p>The name of the integer parameter.</p>
5190
- */
5191
- Name: string | undefined;
5192
- /**
5193
- * <p>The values for the integer parameter.</p>
5194
- */
5195
- Values: number[] | undefined;
5196
- }
5197
- /**
5198
- * <p>A string parameter.</p>
5199
- */
5200
- export interface StringParameter {
5201
- /**
5202
- * <p>A display name for a string parameter.</p>
5203
- */
5204
- Name: string | undefined;
5205
- /**
5206
- * <p>The values of a string parameter.</p>
5207
- */
5208
- Values: string[] | undefined;
5209
- }
5210
- /**
5211
- * <p>A list of Amazon QuickSight parameters and the list's override values.</p>
5212
- */
5213
- export interface _Parameters {
5214
- /**
5215
- * <p>The parameters that have a data type of string.</p>
5216
- */
5217
- StringParameters?: StringParameter[];
5218
- /**
5219
- * <p>The parameters that have a data type of integer.</p>
5220
- */
5221
- IntegerParameters?: IntegerParameter[];
5222
- /**
5223
- * <p>The parameters that have a data type of decimal.</p>
5224
- */
5225
- DecimalParameters?: DecimalParameter[];
5226
- /**
5227
- * <p>The parameters that have a data type of date-time.</p>
5228
- */
5229
- DateTimeParameters?: DateTimeParameter[];
5230
- }
5231
- /**
5232
- * <p>Permission for the resource.</p>
5233
- */
5234
- export interface ResourcePermission {
5235
- /**
5236
- * <p>The Amazon Resource Name (ARN) of the principal. This can be one of the
5237
- * following:</p>
5238
- * <ul>
5239
- * <li>
5240
- * <p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p>
5241
- * </li>
5242
- * <li>
5243
- * <p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p>
5244
- * </li>
5245
- * <li>
5246
- * <p>The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight
5247
- * ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.
5248
- * (This is less common.) </p>
5249
- * </li>
5250
- * </ul>
5251
- */
5252
- Principal: string | undefined;
5253
- /**
5254
- * <p>The IAM action to grant or revoke permissions on.</p>
5255
- */
5256
- Actions: string[] | undefined;
5257
- }
5258
- export interface CreateAnalysisRequest {
5259
- /**
5260
- * <p>The ID of the Amazon Web Services account where you are creating an analysis.</p>
5261
- */
5262
- AwsAccountId: string | undefined;
5263
- /**
5264
- * <p>The ID for the analysis that you're creating. This ID displays in the URL of the
5265
- * analysis.</p>
5266
- */
5267
- AnalysisId: string | undefined;
5268
- /**
5269
- * <p>A descriptive name for the analysis that you're creating. This name displays for the
5270
- * analysis in the Amazon QuickSight console. </p>
5271
- */
5272
- Name: string | undefined;
5273
- /**
5274
- * <p>The parameter names and override values that you want to use. An analysis can have
5275
- * any parameter type, and some parameters might accept multiple values. </p>
5276
- */
5277
- Parameters?: _Parameters;
5278
- /**
5279
- * <p>A structure that describes the principals and the resource-level permissions on an
5280
- * analysis. You can use the <code>Permissions</code> structure to grant permissions by
5281
- * providing a list of Identity and Access Management (IAM) action information for each
5282
- * principal listed by Amazon Resource Name (ARN). </p>
5283
- * <p>To specify no permissions, omit <code>Permissions</code>.</p>
5284
- */
5285
- Permissions?: ResourcePermission[];
5286
- /**
5287
- * <p>A source entity to use for the analysis that you're creating. This metadata structure
5288
- * contains details that describe a source template and one or more datasets.</p>
5289
- */
5290
- SourceEntity?: AnalysisSourceEntity;
5291
- /**
5292
- * <p>The ARN for the theme to apply to the analysis that you're creating. To see the theme
5293
- * in the Amazon QuickSight console, make sure that you have access to it.</p>
5294
- */
5295
- ThemeArn?: string;
5296
- /**
5297
- * <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
5298
- * analysis.</p>
5299
- */
5300
- Tags?: Tag[];
5301
- /**
5302
- * <p>The definition of an analysis.</p>
5303
- * <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
5304
- */
5305
- Definition?: AnalysisDefinition;
5306
- }
5307
5306
  /**
5308
5307
  * @internal
5309
5308
  */
@@ -5892,6 +5891,34 @@ export declare const PivotTableConditionalFormattingFilterSensitiveLog: (obj: Pi
5892
5891
  * @internal
5893
5892
  */
5894
5893
  export declare const PivotTableVisualFilterSensitiveLog: (obj: PivotTableVisual) => any;
5894
+ /**
5895
+ * @internal
5896
+ */
5897
+ export declare const RadarChartAreaStyleSettingsFilterSensitiveLog: (obj: RadarChartAreaStyleSettings) => any;
5898
+ /**
5899
+ * @internal
5900
+ */
5901
+ export declare const RadarChartSeriesSettingsFilterSensitiveLog: (obj: RadarChartSeriesSettings) => any;
5902
+ /**
5903
+ * @internal
5904
+ */
5905
+ export declare const RadarChartAggregatedFieldWellsFilterSensitiveLog: (obj: RadarChartAggregatedFieldWells) => any;
5906
+ /**
5907
+ * @internal
5908
+ */
5909
+ export declare const RadarChartFieldWellsFilterSensitiveLog: (obj: RadarChartFieldWells) => any;
5910
+ /**
5911
+ * @internal
5912
+ */
5913
+ export declare const RadarChartSortConfigurationFilterSensitiveLog: (obj: RadarChartSortConfiguration) => any;
5914
+ /**
5915
+ * @internal
5916
+ */
5917
+ export declare const RadarChartConfigurationFilterSensitiveLog: (obj: RadarChartConfiguration) => any;
5918
+ /**
5919
+ * @internal
5920
+ */
5921
+ export declare const RadarChartVisualFilterSensitiveLog: (obj: RadarChartVisual) => any;
5895
5922
  /**
5896
5923
  * @internal
5897
5924
  */
@@ -6244,31 +6271,3 @@ export declare const SignupResponseFilterSensitiveLog: (obj: SignupResponse) =>
6244
6271
  * @internal
6245
6272
  */
6246
6273
  export declare const CreateAccountSubscriptionResponseFilterSensitiveLog: (obj: CreateAccountSubscriptionResponse) => any;
6247
- /**
6248
- * @internal
6249
- */
6250
- export declare const DateTimeParameterFilterSensitiveLog: (obj: DateTimeParameter) => any;
6251
- /**
6252
- * @internal
6253
- */
6254
- export declare const DecimalParameterFilterSensitiveLog: (obj: DecimalParameter) => any;
6255
- /**
6256
- * @internal
6257
- */
6258
- export declare const IntegerParameterFilterSensitiveLog: (obj: IntegerParameter) => any;
6259
- /**
6260
- * @internal
6261
- */
6262
- export declare const StringParameterFilterSensitiveLog: (obj: StringParameter) => any;
6263
- /**
6264
- * @internal
6265
- */
6266
- export declare const _ParametersFilterSensitiveLog: (obj: _Parameters) => any;
6267
- /**
6268
- * @internal
6269
- */
6270
- export declare const ResourcePermissionFilterSensitiveLog: (obj: ResourcePermission) => any;
6271
- /**
6272
- * @internal
6273
- */
6274
- export declare const CreateAnalysisRequestFilterSensitiveLog: (obj: CreateAnalysisRequest) => any;