List all folders that a resource is a member of.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListFoldersForResourceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListFoldersForResourceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // ListFoldersForResourceRequest + * AwsAccountId: "STRING_VALUE", // required + * ResourceArn: "STRING_VALUE", // required + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new ListFoldersForResourceCommand(input); + * const response = await client.send(command); + * // { // ListFoldersForResourceResponse + * // Status: Number("int"), + * // Folders: [ // FoldersForResourceArnList + * // "STRING_VALUE", + * // ], + * // NextToken: "STRING_VALUE", + * // RequestId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListFoldersForResourceCommandInput - {@link ListFoldersForResourceCommandInput} + * @returns {@link ListFoldersForResourceCommandOutput} + * @see {@link ListFoldersForResourceCommandInput} for command's `input` shape. + * @see {@link ListFoldersForResourceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *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.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal failure occurred.
+ * + * @throws {@link InvalidNextTokenException} (client fault) + *The NextToken value isn't valid.
One or more parameters has a value that isn't valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *One or more resources can't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *Access is throttled.
+ * + * @throws {@link UnsupportedUserEditionException} (client fault) + *This error indicates that you are calling an operation on an Amazon QuickSight + * subscription where the edition doesn't include support for that operation. Amazon + * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and + * capability is available in every edition.
+ * + * @throws {@link QuickSightServiceException} + *Base exception class for all service exceptions from QuickSight service.
+ * + * @public + */ +export class ListFoldersForResourceCommand extends $Command + .classBuilder< + ListFoldersForResourceCommandInput, + ListFoldersForResourceCommandOutput, + QuickSightClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: QuickSightClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSight_20180401", "ListFoldersForResource", {}) + .n("QuickSightClient", "ListFoldersForResourceCommand") + .f(void 0, void 0) + .ser(se_ListFoldersForResourceCommand) + .de(de_ListFoldersForResourceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListFoldersForResourceRequest; + output: ListFoldersForResourceResponse; + }; + sdk: { + input: ListFoldersForResourceCommandInput; + output: ListFoldersForResourceCommandOutput; + }; + }; +} diff --git a/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts b/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts index c78ef9bf6c93..aed3d910c236 100644 --- a/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts @@ -235,6 +235,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * ], * }, + * CommitMode: "AUTO" || "MANUAL", * }, * TextField: { // ParameterTextFieldControl * ParameterControlId: "STRING_VALUE", // required @@ -323,6 +324,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * DateIconVisibility: "HIDDEN" || "VISIBLE", * }, * Type: "SINGLE_VALUED" || "DATE_RANGE", + * CommitMode: "AUTO" || "MANUAL", * }, * List: { // FilterListControl * FilterControlId: "STRING_VALUE", // required @@ -381,6 +383,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * }, * ], * }, + * CommitMode: "AUTO" || "MANUAL", * }, * TextField: { // FilterTextFieldControl * FilterControlId: "STRING_VALUE", // required @@ -429,6 +432,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * DateTimeFormat: "STRING_VALUE", * InfoIconLabelOptions: "A control to display info icons for filters and parameters.
* @public @@ -2143,6 +2157,12 @@ export interface DefaultDateTimePickerControlOptions { * @public */ DisplayOptions?: DateTimePickerControlDisplayOptions; + + /** + *The visibility configuration of the Apply button on a DateTimePickerControl.
The visibility configuration of the Apply button on a FilterDropDownControl.
The visibility configuration of the Apply button on a RelativeDateTimeControl.
The visibility configurationof the Apply button on a DateTimePickerControl.
The visibility configuration of the Apply button on a FilterDropDownControl.
The visibility configuration of the Apply button on a FilterRelativeDateTimeControl.
The visibility configuration of the Apply button on a ParameterDropDownControl.
The limit configuration of the visual display for an axis.
* @public @@ -7750,72 +7763,6 @@ export interface TreeMapSortConfiguration { TreeMapGroupItemsLimitConfiguration?: ItemsLimitConfiguration; } -/** - *The configuration of a tree map.
- * @public - */ -export interface TreeMapConfiguration { - /** - *The field wells of the visual.
- * @public - */ - FieldWells?: TreeMapFieldWells; - - /** - *The sort configuration of a tree map.
- * @public - */ - SortConfiguration?: TreeMapSortConfiguration; - - /** - *The label options (label text, label visibility) of the groups that are displayed in a tree map.
- * @public - */ - GroupLabelOptions?: ChartAxisLabelOptions; - - /** - *The label options (label text, label visibility) of the sizes that are displayed in a tree map.
- * @public - */ - SizeLabelOptions?: ChartAxisLabelOptions; - - /** - *The label options (label text, label visibility) for the colors displayed in a tree map.
- * @public - */ - ColorLabelOptions?: ChartAxisLabelOptions; - - /** - *The color options (gradient color, point of divergence) of a tree map.
- * @public - */ - ColorScale?: ColorScale; - - /** - *The legend display setup of the visual.
- * @public - */ - Legend?: LegendOptions; - - /** - *The options that determine if visual data labels are displayed.
- * @public - */ - DataLabels?: DataLabelOptions; - - /** - *The tooltip display setup of the visual.
- * @public - */ - Tooltip?: TooltipOptions; - - /** - *The general visual interactions setup for a visual.
- * @public - */ - Interactions?: VisualInteractionOptions; -} - /** * @internal */ @@ -8973,11 +8920,3 @@ export const TreeMapAggregatedFieldWellsFilterSensitiveLog = (obj: TreeMapAggreg export const TreeMapFieldWellsFilterSensitiveLog = (obj: TreeMapFieldWells): any => ({ ...obj, }); - -/** - * @internal - */ -export const TreeMapConfigurationFilterSensitiveLog = (obj: TreeMapConfiguration): any => ({ - ...obj, - ...(obj.DataLabels && { DataLabels: DataLabelOptionsFilterSensitiveLog(obj.DataLabels) }), -}); diff --git a/clients/client-quicksight/src/models/models_2.ts b/clients/client-quicksight/src/models/models_2.ts index 900575950150..a7a0532d0cf2 100644 --- a/clients/client-quicksight/src/models/models_2.ts +++ b/clients/client-quicksight/src/models/models_2.ts @@ -48,6 +48,7 @@ import { import { BarChartVisual, BoxPlotVisual, + ColorScale, ColumnHierarchy, ComboChartVisual, CustomContentVisual, @@ -74,7 +75,9 @@ import { ScatterPlotVisual, ScatterPlotVisualFilterSensitiveLog, TableVisual, - TreeMapConfiguration, + TooltipOptions, + TreeMapFieldWells, + TreeMapSortConfiguration, VisualPalette, VisualPaletteFilterSensitiveLog, VisualSubtitleLabelOptions, @@ -83,6 +86,72 @@ import { import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; +/** + *The configuration of a tree map.
+ * @public + */ +export interface TreeMapConfiguration { + /** + *The field wells of the visual.
+ * @public + */ + FieldWells?: TreeMapFieldWells; + + /** + *The sort configuration of a tree map.
+ * @public + */ + SortConfiguration?: TreeMapSortConfiguration; + + /** + *The label options (label text, label visibility) of the groups that are displayed in a tree map.
+ * @public + */ + GroupLabelOptions?: ChartAxisLabelOptions; + + /** + *The label options (label text, label visibility) of the sizes that are displayed in a tree map.
+ * @public + */ + SizeLabelOptions?: ChartAxisLabelOptions; + + /** + *The label options (label text, label visibility) for the colors displayed in a tree map.
+ * @public + */ + ColorLabelOptions?: ChartAxisLabelOptions; + + /** + *The color options (gradient color, point of divergence) of a tree map.
+ * @public + */ + ColorScale?: ColorScale; + + /** + *The legend display setup of the visual.
+ * @public + */ + Legend?: LegendOptions; + + /** + *The options that determine if visual data labels are displayed.
+ * @public + */ + DataLabels?: DataLabelOptions; + + /** + *The tooltip display setup of the visual.
+ * @public + */ + Tooltip?: TooltipOptions; + + /** + *The general visual interactions setup for a visual.
+ * @public + */ + Interactions?: VisualInteractionOptions; +} + /** *A tree map.
*For more information, see Using tree maps in the Amazon QuickSight User Guide.
@@ -8697,35 +8766,12 @@ export interface CredentialPair { } /** - *Data source credentials. This is a variant type structure. For this structure to be - * valid, only one of the attributes can be non-null.
- * @public + * @internal */ -export interface DataSourceCredentials { - /** - *Credential pair. For more information, see
- *
- * CredentialPair
- * .
The Amazon Resource Name (ARN) of a data source that has the credential pair that you
- * want to use. When CopySourceArn is not null, the credential pair from the
- * data source in the ARN is used as the credentials for the
- * DataSourceCredentials structure.
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
- * @public - */ - SecretArn?: string; -} +export const TreeMapConfigurationFilterSensitiveLog = (obj: TreeMapConfiguration): any => ({ + ...obj, + ...(obj.DataLabels && { DataLabels: DataLabelOptionsFilterSensitiveLog(obj.DataLabels) }), +}); /** * @internal @@ -9127,11 +9173,3 @@ export const CreateDataSetRequestFilterSensitiveLog = (obj: CreateDataSetRequest ), }), }); - -/** - * @internal - */ -export const DataSourceCredentialsFilterSensitiveLog = (obj: DataSourceCredentials): any => ({ - ...obj, - ...(obj.CredentialPair && { CredentialPair: obj.CredentialPair }), -}); diff --git a/clients/client-quicksight/src/models/models_3.ts b/clients/client-quicksight/src/models/models_3.ts index 509f291f16cd..1f02b3417d51 100644 --- a/clients/client-quicksight/src/models/models_3.ts +++ b/clients/client-quicksight/src/models/models_3.ts @@ -60,13 +60,13 @@ import { ColumnSchema, ComparativeOrder, ConstantType, + CredentialPair, DashboardPublishOptions, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetReference, DataSetUsageConfiguration, - DataSourceCredentials, DataSourceParameters, DisplayFormat, DisplayFormatOptions, @@ -93,6 +93,37 @@ import { import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; +/** + *Data source credentials. This is a variant type structure. For this structure to be + * valid, only one of the attributes can be non-null.
+ * @public + */ +export interface DataSourceCredentials { + /** + *Credential pair. For more information, see
+ *
+ * CredentialPair
+ * .
The Amazon Resource Name (ARN) of a data source that has the credential pair that you
+ * want to use. When CopySourceArn is not null, the credential pair from the
+ * data source in the ARN is used as the credentials for the
+ * DataSourceCredentials structure.
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
+ * @public + */ + SecretArn?: string; +} + /** * @public * @enum @@ -9285,23 +9316,12 @@ export interface DescribeUserResponse { } /** - * @public + * @internal */ -export interface DescribeVPCConnectionRequest { - /** - *The Amazon Web Services account ID of the account that contains the VPC connection that - * you want described.
- * @public - */ - AwsAccountId: string | undefined; - - /** - *The ID of the VPC connection that - * you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
- * @public - */ - VPCConnectionId: string | undefined; -} +export const DataSourceCredentialsFilterSensitiveLog = (obj: DataSourceCredentials): any => ({ + ...obj, + ...(obj.CredentialPair && { CredentialPair: obj.CredentialPair }), +}); /** * @internal diff --git a/clients/client-quicksight/src/models/models_4.ts b/clients/client-quicksight/src/models/models_4.ts index 02fd84b8d32a..e3fa3e48c185 100644 --- a/clients/client-quicksight/src/models/models_4.ts +++ b/clients/client-quicksight/src/models/models_4.ts @@ -35,7 +35,6 @@ import { DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, - DataSourceCredentials, DataSourceParameters, FieldFolder, FilterOperator, @@ -67,6 +66,7 @@ import { DataSetSearchFilter, DataSetSummary, DataSource, + DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FolderType, @@ -97,6 +97,25 @@ import { import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; +/** + * @public + */ +export interface DescribeVPCConnectionRequest { + /** + *The Amazon Web Services account ID of the account that contains the VPC connection that + * you want described.
+ * @public + */ + AwsAccountId: string | undefined; + + /** + *The ID of the VPC connection that + * you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
+ * @public + */ + VPCConnectionId: string | undefined; +} + /** * @public * @enum @@ -1816,6 +1835,64 @@ export interface ListFoldersResponse { RequestId?: string; } +/** + * @public + */ +export interface ListFoldersForResourceRequest { + /** + *The ID for the Amazon Web Services account that contains the resource.
+ * @public + */ + AwsAccountId: string | undefined; + + /** + *The Amazon Resource Name (ARN) the resource whose folders you need to list.
+ * @public + */ + ResourceArn: string | undefined; + + /** + *The token for the next set of results, or null if there are no more results.
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to be returned per request.
+ * @public + */ + MaxResults?: number; +} + +/** + * @public + */ +export interface ListFoldersForResourceResponse { + /** + *The HTTP status of the request.
+ * @public + */ + Status?: number; + + /** + *A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of.
+ * @public + */ + Folders?: string[]; + + /** + *The token for the next set of results, or null if there are no more results.
+ * @public + */ + NextToken?: string; + + /** + *The Amazon Web Services request ID for this operation.
+ * @public + */ + RequestId?: string; +} + /** * @public */ diff --git a/clients/client-quicksight/src/pagination/ListFoldersForResourcePaginator.ts b/clients/client-quicksight/src/pagination/ListFoldersForResourcePaginator.ts new file mode 100644 index 000000000000..66f52365ada9 --- /dev/null +++ b/clients/client-quicksight/src/pagination/ListFoldersForResourcePaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListFoldersForResourceCommand, + ListFoldersForResourceCommandInput, + ListFoldersForResourceCommandOutput, +} from "../commands/ListFoldersForResourceCommand"; +import { QuickSightClient } from "../QuickSightClient"; +import { QuickSightPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListFoldersForResource: ( + config: QuickSightPaginationConfiguration, + input: ListFoldersForResourceCommandInput, + ...rest: any[] +) => PaginatorA combo chart.
\nThe ComboChartVisual includes stacked bar combo charts and clustered bar combo charts
For more information, see Using combo charts in the Amazon QuickSight User Guide.
" } }, + "com.amazonaws.quicksight#CommitMode": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, "com.amazonaws.quicksight#ComparativeOrder": { "type": "structure", "members": { @@ -14472,6 +14489,12 @@ "traits": { "smithy.api#documentation": "The display options of a control.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a DateTimePickerControl.
A list of selectable values that are used in a control.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a FilterDropDownControl.
The display options of a control.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a RelativeDateTimeControl.
The type of the FilterDropDownControl. Choose one of the following options:
\n MULTI_SELECT: The user can select multiple entries from a dropdown menu.
\n SINGLE_SELECT: The user can select a single entry from a dropdown menu.
The visibility configurationof the Apply button on a DateTimePickerControl.
The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a FilterDropDownControl.
The display options of a control.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a FilterRelativeDateTimeControl.
List all folders that a resource is a member of.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/resource/{ResourceArn}/folders", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Folders", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListFoldersForResourceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) the resource whose folders you need to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListFoldersForResourceResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "Folders": { + "target": "com.amazonaws.quicksight#FoldersForResourceArnList", + "traits": { + "smithy.api#documentation": "A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of.
" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#ListFoldersRequest": { "type": "structure", "members": { @@ -35799,6 +35982,12 @@ "traits": { "smithy.api#documentation": "The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
" } + }, + "CommitMode": { + "target": "com.amazonaws.quicksight#CommitMode", + "traits": { + "smithy.api#documentation": "The visibility configuration of the Apply button on a ParameterDropDownControl.