@aws-sdk/client-quicksight 3.565.0 → 3.566.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.
- package/README.md +8 -0
- package/dist-cjs/index.js +76 -6
- package/dist-es/QuickSight.js +2 -0
- package/dist-es/commands/UpdateSPICECapacityConfigurationCommand.js +24 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_1.js +0 -4
- package/dist-es/models/models_2.js +7 -0
- package/dist-es/models/models_3.js +3 -0
- package/dist-es/models/models_4.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +36 -0
- package/dist-types/QuickSight.d.ts +7 -0
- package/dist-types/QuickSightClient.d.ts +3 -2
- package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +8 -1
- package/dist-types/commands/CreateAnalysisCommand.d.ts +4 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +4 -0
- package/dist-types/commands/CreateRoleMembershipCommand.d.ts +1 -1
- package/dist-types/commands/CreateTemplateCommand.d.ts +4 -0
- package/dist-types/commands/DeleteRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRoleMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +4 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +4 -0
- package/dist-types/commands/DescribeRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +4 -0
- package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +3 -0
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +3 -0
- package/dist-types/commands/ListFoldersCommand.d.ts +2 -1
- package/dist-types/commands/ListGroupMembershipsCommand.d.ts +1 -1
- package/dist-types/commands/ListRoleMembershipsCommand.d.ts +1 -1
- package/dist-types/commands/ListTopicsCommand.d.ts +1 -0
- package/dist-types/commands/ListUsersCommand.d.ts +1 -1
- package/dist-types/commands/RegisterUserCommand.d.ts +2 -2
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +4 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +4 -0
- package/dist-types/commands/UpdateRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSPICECapacityConfigurationCommand.d.ts +79 -0
- package/dist-types/commands/UpdateTemplateCommand.d.ts +4 -0
- package/dist-types/commands/UpdateUserCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_1.d.ts +21 -12
- package/dist-types/models/models_2.d.ts +55 -133
- package/dist-types/models/models_3.d.ts +170 -90
- package/dist-types/models/models_4.d.ts +154 -17
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/QuickSight.d.ts +17 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/ListFoldersCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListGroupMembershipsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSPICECapacityConfigurationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_1.d.ts +5 -6
- package/dist-types/ts3.4/models/models_2.d.ts +17 -26
- package/dist-types/ts3.4/models/models_3.d.ts +34 -20
- package/dist-types/ts3.4/models/models_4.d.ts +36 -1
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +1 -1
|
@@ -2904,6 +2904,10 @@ declare const DescribeTemplateDefinitionCommand_base: {
|
|
|
2904
2904
|
* // },
|
|
2905
2905
|
* // ],
|
|
2906
2906
|
* // },
|
|
2907
|
+
* // ColorConfiguration: { // GaugeChartColorConfiguration
|
|
2908
|
+
* // ForegroundColor: "STRING_VALUE",
|
|
2909
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
2910
|
+
* // },
|
|
2907
2911
|
* // Interactions: "<VisualInteractionOptions>",
|
|
2908
2912
|
* // },
|
|
2909
2913
|
* // ConditionalFormatting: { // GaugeChartConditionalFormatting
|
|
@@ -45,7 +45,7 @@ declare const DescribeUserCommand_base: {
|
|
|
45
45
|
* // Arn: "STRING_VALUE",
|
|
46
46
|
* // UserName: "STRING_VALUE",
|
|
47
47
|
* // Email: "STRING_VALUE",
|
|
48
|
-
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER",
|
|
48
|
+
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
|
|
49
49
|
* // IdentityType: "IAM" || "QUICKSIGHT" || "IAM_IDENTITY_CENTER",
|
|
50
50
|
* // Active: true || false,
|
|
51
51
|
* // PrincipalId: "STRING_VALUE",
|
|
@@ -77,6 +77,9 @@ declare const GenerateEmbedUrlForAnonymousUserCommand_base: {
|
|
|
77
77
|
* QSearchBar: { // AnonymousUserQSearchBarEmbeddingConfiguration
|
|
78
78
|
* InitialTopicId: "STRING_VALUE", // required
|
|
79
79
|
* },
|
|
80
|
+
* GenerativeQnA: { // AnonymousUserGenerativeQnAEmbeddingConfiguration
|
|
81
|
+
* InitialTopicId: "STRING_VALUE", // required
|
|
82
|
+
* },
|
|
80
83
|
* },
|
|
81
84
|
* AllowedDomains: [ // StringList
|
|
82
85
|
* "STRING_VALUE",
|
|
@@ -87,6 +87,9 @@ declare const GenerateEmbedUrlForRegisteredUserCommand_base: {
|
|
|
87
87
|
* VisualId: "STRING_VALUE", // required
|
|
88
88
|
* },
|
|
89
89
|
* },
|
|
90
|
+
* GenerativeQnA: { // RegisteredUserGenerativeQnAEmbeddingConfiguration
|
|
91
|
+
* InitialTopicId: "STRING_VALUE",
|
|
92
|
+
* },
|
|
90
93
|
* },
|
|
91
94
|
* AllowedDomains: [ // StringList
|
|
92
95
|
* "STRING_VALUE",
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { ListFoldersRequest
|
|
3
|
+
import { ListFoldersRequest } from "../models/models_3";
|
|
4
|
+
import { ListFoldersResponse } from "../models/models_4";
|
|
4
5
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { ListGroupMembershipsRequest, ListGroupMembershipsResponse } from "../models/
|
|
3
|
+
import { ListGroupMembershipsRequest, ListGroupMembershipsResponse } from "../models/models_4";
|
|
4
4
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -34,7 +34,7 @@ declare const ListRoleMembershipsCommand_base: {
|
|
|
34
34
|
* // const { QuickSightClient, ListRoleMembershipsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
35
35
|
* const client = new QuickSightClient(config);
|
|
36
36
|
* const input = { // ListRoleMembershipsRequest
|
|
37
|
-
* Role: "ADMIN" || "AUTHOR" || "READER", // required
|
|
37
|
+
* Role: "ADMIN" || "AUTHOR" || "READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
|
|
38
38
|
* NextToken: "STRING_VALUE",
|
|
39
39
|
* MaxResults: Number("int"),
|
|
40
40
|
* AwsAccountId: "STRING_VALUE", // required
|
|
@@ -47,7 +47,7 @@ declare const ListUsersCommand_base: {
|
|
|
47
47
|
* // Arn: "STRING_VALUE",
|
|
48
48
|
* // UserName: "STRING_VALUE",
|
|
49
49
|
* // Email: "STRING_VALUE",
|
|
50
|
-
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER",
|
|
50
|
+
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
|
|
51
51
|
* // IdentityType: "IAM" || "QUICKSIGHT" || "IAM_IDENTITY_CENTER",
|
|
52
52
|
* // Active: true || false,
|
|
53
53
|
* // PrincipalId: "STRING_VALUE",
|
|
@@ -36,7 +36,7 @@ declare const RegisterUserCommand_base: {
|
|
|
36
36
|
* const input = { // RegisterUserRequest
|
|
37
37
|
* IdentityType: "IAM" || "QUICKSIGHT" || "IAM_IDENTITY_CENTER", // required
|
|
38
38
|
* Email: "STRING_VALUE", // required
|
|
39
|
-
* UserRole: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER", // required
|
|
39
|
+
* UserRole: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
|
|
40
40
|
* IamArn: "STRING_VALUE",
|
|
41
41
|
* SessionName: "STRING_VALUE",
|
|
42
42
|
* AwsAccountId: "STRING_VALUE", // required
|
|
@@ -60,7 +60,7 @@ declare const RegisterUserCommand_base: {
|
|
|
60
60
|
* // Arn: "STRING_VALUE",
|
|
61
61
|
* // UserName: "STRING_VALUE",
|
|
62
62
|
* // Email: "STRING_VALUE",
|
|
63
|
-
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER",
|
|
63
|
+
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
|
|
64
64
|
* // IdentityType: "IAM" || "QUICKSIGHT" || "IAM_IDENTITY_CENTER",
|
|
65
65
|
* // Active: true || false,
|
|
66
66
|
* // PrincipalId: "STRING_VALUE",
|
|
@@ -2904,6 +2904,10 @@ declare const UpdateAnalysisCommand_base: {
|
|
|
2904
2904
|
* },
|
|
2905
2905
|
* ],
|
|
2906
2906
|
* },
|
|
2907
|
+
* ColorConfiguration: { // GaugeChartColorConfiguration
|
|
2908
|
+
* ForegroundColor: "STRING_VALUE",
|
|
2909
|
+
* BackgroundColor: "STRING_VALUE",
|
|
2910
|
+
* },
|
|
2907
2911
|
* Interactions: "<VisualInteractionOptions>",
|
|
2908
2912
|
* },
|
|
2909
2913
|
* ConditionalFormatting: { // GaugeChartConditionalFormatting
|
|
@@ -2947,6 +2947,10 @@ declare const UpdateDashboardCommand_base: {
|
|
|
2947
2947
|
* },
|
|
2948
2948
|
* ],
|
|
2949
2949
|
* },
|
|
2950
|
+
* ColorConfiguration: { // GaugeChartColorConfiguration
|
|
2951
|
+
* ForegroundColor: "STRING_VALUE",
|
|
2952
|
+
* BackgroundColor: "STRING_VALUE",
|
|
2953
|
+
* },
|
|
2950
2954
|
* Interactions: "<VisualInteractionOptions>",
|
|
2951
2955
|
* },
|
|
2952
2956
|
* ConditionalFormatting: { // GaugeChartConditionalFormatting
|
|
@@ -35,7 +35,7 @@ declare const UpdateRoleCustomPermissionCommand_base: {
|
|
|
35
35
|
* const client = new QuickSightClient(config);
|
|
36
36
|
* const input = { // UpdateRoleCustomPermissionRequest
|
|
37
37
|
* CustomPermissionsName: "STRING_VALUE", // required
|
|
38
|
-
* Role: "ADMIN" || "AUTHOR" || "READER", // required
|
|
38
|
+
* Role: "ADMIN" || "AUTHOR" || "READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
|
|
39
39
|
* AwsAccountId: "STRING_VALUE", // required
|
|
40
40
|
* Namespace: "STRING_VALUE", // required
|
|
41
41
|
* };
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { UpdateSPICECapacityConfigurationRequest, UpdateSPICECapacityConfigurationResponse } from "../models/models_4";
|
|
4
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link UpdateSPICECapacityConfigurationCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface UpdateSPICECapacityConfigurationCommandInput extends UpdateSPICECapacityConfigurationRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link UpdateSPICECapacityConfigurationCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface UpdateSPICECapacityConfigurationCommandOutput extends UpdateSPICECapacityConfigurationResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const UpdateSPICECapacityConfigurationCommand_base: {
|
|
24
|
+
new (input: UpdateSPICECapacityConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSPICECapacityConfigurationCommandInput, UpdateSPICECapacityConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: UpdateSPICECapacityConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSPICECapacityConfigurationCommandInput, UpdateSPICECapacityConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Updates the SPICE capacity configuration for a Amazon QuickSight account.</p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { QuickSightClient, UpdateSPICECapacityConfigurationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
34
|
+
* // const { QuickSightClient, UpdateSPICECapacityConfigurationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
35
|
+
* const client = new QuickSightClient(config);
|
|
36
|
+
* const input = { // UpdateSPICECapacityConfigurationRequest
|
|
37
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
38
|
+
* PurchaseMode: "MANUAL" || "AUTO_PURCHASE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new UpdateSPICECapacityConfigurationCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // UpdateSPICECapacityConfigurationResponse
|
|
43
|
+
* // RequestId: "STRING_VALUE",
|
|
44
|
+
* // Status: Number("int"),
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param UpdateSPICECapacityConfigurationCommandInput - {@link UpdateSPICECapacityConfigurationCommandInput}
|
|
50
|
+
* @returns {@link UpdateSPICECapacityConfigurationCommandOutput}
|
|
51
|
+
* @see {@link UpdateSPICECapacityConfigurationCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link UpdateSPICECapacityConfigurationCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
57
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
58
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
59
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
62
|
+
* <p>An internal failure occurred.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
65
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
|
+
* <p>One or more resources can't be found.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
+
* <p>Access is throttled.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link QuickSightServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
75
|
+
*
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
export declare class UpdateSPICECapacityConfigurationCommand extends UpdateSPICECapacityConfigurationCommand_base {
|
|
79
|
+
}
|
|
@@ -2891,6 +2891,10 @@ declare const UpdateTemplateCommand_base: {
|
|
|
2891
2891
|
* },
|
|
2892
2892
|
* ],
|
|
2893
2893
|
* },
|
|
2894
|
+
* ColorConfiguration: { // GaugeChartColorConfiguration
|
|
2895
|
+
* ForegroundColor: "STRING_VALUE",
|
|
2896
|
+
* BackgroundColor: "STRING_VALUE",
|
|
2897
|
+
* },
|
|
2894
2898
|
* Interactions: "<VisualInteractionOptions>",
|
|
2895
2899
|
* },
|
|
2896
2900
|
* ConditionalFormatting: { // GaugeChartConditionalFormatting
|
|
@@ -38,7 +38,7 @@ declare const UpdateUserCommand_base: {
|
|
|
38
38
|
* AwsAccountId: "STRING_VALUE", // required
|
|
39
39
|
* Namespace: "STRING_VALUE", // required
|
|
40
40
|
* Email: "STRING_VALUE", // required
|
|
41
|
-
* Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER", // required
|
|
41
|
+
* Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
|
|
42
42
|
* CustomPermissionsName: "STRING_VALUE",
|
|
43
43
|
* UnapplyCustomPermissions: true || false,
|
|
44
44
|
* ExternalLoginFederationProviderType: "STRING_VALUE",
|
|
@@ -52,7 +52,7 @@ declare const UpdateUserCommand_base: {
|
|
|
52
52
|
* // Arn: "STRING_VALUE",
|
|
53
53
|
* // UserName: "STRING_VALUE",
|
|
54
54
|
* // Email: "STRING_VALUE",
|
|
55
|
-
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER",
|
|
55
|
+
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
|
|
56
56
|
* // IdentityType: "IAM" || "QUICKSIGHT" || "IAM_IDENTITY_CENTER",
|
|
57
57
|
* // Active: true || false,
|
|
58
58
|
* // PrincipalId: "STRING_VALUE",
|
|
@@ -158,6 +158,7 @@ export * from "./UpdateIpRestrictionCommand";
|
|
|
158
158
|
export * from "./UpdatePublicSharingSettingsCommand";
|
|
159
159
|
export * from "./UpdateRefreshScheduleCommand";
|
|
160
160
|
export * from "./UpdateRoleCustomPermissionCommand";
|
|
161
|
+
export * from "./UpdateSPICECapacityConfigurationCommand";
|
|
161
162
|
export * from "./UpdateTemplateAliasCommand";
|
|
162
163
|
export * from "./UpdateTemplateCommand";
|
|
163
164
|
export * from "./UpdateTemplatePermissionsCommand";
|
|
@@ -1523,6 +1523,22 @@ export interface FunnelChartVisual {
|
|
|
1523
1523
|
*/
|
|
1524
1524
|
ColumnHierarchies?: ColumnHierarchy[];
|
|
1525
1525
|
}
|
|
1526
|
+
/**
|
|
1527
|
+
* <p>The color configuration of a <code>GaugeChartVisual</code>.</p>
|
|
1528
|
+
* @public
|
|
1529
|
+
*/
|
|
1530
|
+
export interface GaugeChartColorConfiguration {
|
|
1531
|
+
/**
|
|
1532
|
+
* <p>The foreground color configuration of a <code>GaugeChartVisual</code>.</p>
|
|
1533
|
+
* @public
|
|
1534
|
+
*/
|
|
1535
|
+
ForegroundColor?: string;
|
|
1536
|
+
/**
|
|
1537
|
+
* <p>The background color configuration of a <code>GaugeChartVisual</code>.</p>
|
|
1538
|
+
* @public
|
|
1539
|
+
*/
|
|
1540
|
+
BackgroundColor?: string;
|
|
1541
|
+
}
|
|
1526
1542
|
/**
|
|
1527
1543
|
* <p>The field well configuration of a <code>GaugeChartVisual</code>.</p>
|
|
1528
1544
|
* @public
|
|
@@ -1737,6 +1753,11 @@ export interface GaugeChartConfiguration {
|
|
|
1737
1753
|
* @public
|
|
1738
1754
|
*/
|
|
1739
1755
|
VisualPalette?: VisualPalette;
|
|
1756
|
+
/**
|
|
1757
|
+
* <p>The color configuration of a <code>GaugeChartVisual</code>.</p>
|
|
1758
|
+
* @public
|
|
1759
|
+
*/
|
|
1760
|
+
ColorConfiguration?: GaugeChartColorConfiguration;
|
|
1740
1761
|
/**
|
|
1741
1762
|
* <p>The general visual interactions setup for a visual.</p>
|
|
1742
1763
|
* @public
|
|
@@ -6756,18 +6777,6 @@ export declare const WordCloudWordCasing: {
|
|
|
6756
6777
|
* @public
|
|
6757
6778
|
*/
|
|
6758
6779
|
export type WordCloudWordCasing = (typeof WordCloudWordCasing)[keyof typeof WordCloudWordCasing];
|
|
6759
|
-
/**
|
|
6760
|
-
* @public
|
|
6761
|
-
* @enum
|
|
6762
|
-
*/
|
|
6763
|
-
export declare const WordCloudWordOrientation: {
|
|
6764
|
-
readonly HORIZONTAL: "HORIZONTAL";
|
|
6765
|
-
readonly HORIZONTAL_AND_VERTICAL: "HORIZONTAL_AND_VERTICAL";
|
|
6766
|
-
};
|
|
6767
|
-
/**
|
|
6768
|
-
* @public
|
|
6769
|
-
*/
|
|
6770
|
-
export type WordCloudWordOrientation = (typeof WordCloudWordOrientation)[keyof typeof WordCloudWordOrientation];
|
|
6771
6780
|
/**
|
|
6772
6781
|
* @internal
|
|
6773
6782
|
*/
|
|
@@ -1,7 +1,19 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { AccountCustomization, AdHocFilteringOption, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, DashboardBehavior, DataSetIdentifierDeclaration, Edition, FilterControl, FilterGroup, Layout, ParameterControl, ParameterDeclaration, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, TimeGranularity, VisualCustomAction, VisualInteractionOptions, VisualMenuOption } from "./models_0";
|
|
3
|
-
import { BarChartVisual, BoxPlotVisual, ColumnHierarchy, ComboChartVisual, CustomContentVisual, EmptyVisual, FilledMapVisual, FunnelChartVisual, GaugeChartVisual, GeospatialMapVisual, HeatMapVisual, HistogramVisual, InsightVisual, KPIVisual, LineChartVisual, PieChartVisual, PivotTableVisual, RadarChartVisual, SankeyDiagramVisual, ScatterPlotVisual, TableVisual, TreeMapVisual, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WaterfallVisual, WordCloudCloudLayout, WordCloudFieldWells, WordCloudSortConfiguration, WordCloudWordCasing
|
|
3
|
+
import { BarChartVisual, BoxPlotVisual, ColumnHierarchy, ComboChartVisual, CustomContentVisual, EmptyVisual, FilledMapVisual, FunnelChartVisual, GaugeChartVisual, GeospatialMapVisual, HeatMapVisual, HistogramVisual, InsightVisual, KPIVisual, LineChartVisual, PieChartVisual, PivotTableVisual, RadarChartVisual, SankeyDiagramVisual, ScatterPlotVisual, TableVisual, TreeMapVisual, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WaterfallVisual, WordCloudCloudLayout, WordCloudFieldWells, WordCloudSortConfiguration, WordCloudWordCasing } from "./models_1";
|
|
4
4
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
* @enum
|
|
8
|
+
*/
|
|
9
|
+
export declare const WordCloudWordOrientation: {
|
|
10
|
+
readonly HORIZONTAL: "HORIZONTAL";
|
|
11
|
+
readonly HORIZONTAL_AND_VERTICAL: "HORIZONTAL_AND_VERTICAL";
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
export type WordCloudWordOrientation = (typeof WordCloudWordOrientation)[keyof typeof WordCloudWordOrientation];
|
|
5
17
|
/**
|
|
6
18
|
* @public
|
|
7
19
|
* @enum
|
|
@@ -625,14 +637,26 @@ export interface AnonymousUserDashboardVisualEmbeddingConfiguration {
|
|
|
625
637
|
*/
|
|
626
638
|
InitialDashboardVisualId: DashboardVisualId | undefined;
|
|
627
639
|
}
|
|
640
|
+
/**
|
|
641
|
+
* <p>The settings that you want to use for the Generative Q&A experience.</p>
|
|
642
|
+
* @public
|
|
643
|
+
*/
|
|
644
|
+
export interface AnonymousUserGenerativeQnAEmbeddingConfiguration {
|
|
645
|
+
/**
|
|
646
|
+
* <p>The Amazon QuickSight Q topic ID of the new reader experience 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 Generative Q&A experience with this new reader experience topic pre selected.</p>
|
|
647
|
+
* <p>The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request fails with an <code>InvalidParameterValueException</code> error.</p>
|
|
648
|
+
* @public
|
|
649
|
+
*/
|
|
650
|
+
InitialTopicId: string | undefined;
|
|
651
|
+
}
|
|
628
652
|
/**
|
|
629
653
|
* <p>The settings that you want to use with the Q search bar.</p>
|
|
630
654
|
* @public
|
|
631
655
|
*/
|
|
632
656
|
export interface AnonymousUserQSearchBarEmbeddingConfiguration {
|
|
633
657
|
/**
|
|
634
|
-
* <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>
|
|
635
|
-
* <p>The Amazon Resource Name (ARN) of this Q topic must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request
|
|
658
|
+
* <p>The Amazon QuickSight Q topic ID of the legacy 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 legacy topic pre-selected.</p>
|
|
659
|
+
* <p>The Amazon Resource Name (ARN) of this Q legacy topic must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request fails with an <code>InvalidParameterValueException</code> error.</p>
|
|
636
660
|
* @public
|
|
637
661
|
*/
|
|
638
662
|
InitialTopicId: string | undefined;
|
|
@@ -657,6 +681,11 @@ export interface AnonymousUserEmbeddingExperienceConfiguration {
|
|
|
657
681
|
* @public
|
|
658
682
|
*/
|
|
659
683
|
QSearchBar?: AnonymousUserQSearchBarEmbeddingConfiguration;
|
|
684
|
+
/**
|
|
685
|
+
* <p>The Generative Q&A experience that you want to use for anonymous user embedding.</p>
|
|
686
|
+
* @public
|
|
687
|
+
*/
|
|
688
|
+
GenerativeQnA?: AnonymousUserGenerativeQnAEmbeddingConfiguration;
|
|
660
689
|
}
|
|
661
690
|
/**
|
|
662
691
|
* @public
|
|
@@ -4184,7 +4213,7 @@ export interface CreateAccountSubscriptionRequest {
|
|
|
4184
4213
|
* </ul>
|
|
4185
4214
|
* @public
|
|
4186
4215
|
*/
|
|
4187
|
-
Edition
|
|
4216
|
+
Edition?: Edition;
|
|
4188
4217
|
/**
|
|
4189
4218
|
* <p>The method that you want to use to authenticate your Amazon QuickSight account.</p>
|
|
4190
4219
|
* <p>If you choose <code>ACTIVE_DIRECTORY</code>, provide an <code>ActiveDirectoryName</code>
|
|
@@ -4226,7 +4255,7 @@ export interface CreateAccountSubscriptionRequest {
|
|
|
4226
4255
|
*/
|
|
4227
4256
|
DirectoryId?: string;
|
|
4228
4257
|
/**
|
|
4229
|
-
* <p>The admin group associated with your Active Directory or IAM Identity Center account.
|
|
4258
|
+
* <p>The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the <code>AdminProGroup</code> field is required if <code>ACTIVE_DIRECTORY</code> or <code>IAM_IDENTITY_CENTER</code> is the selected authentication method of the new Amazon QuickSight account.</p>
|
|
4230
4259
|
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
4231
4260
|
* @public
|
|
4232
4261
|
*/
|
|
@@ -4243,6 +4272,24 @@ export interface CreateAccountSubscriptionRequest {
|
|
|
4243
4272
|
* @public
|
|
4244
4273
|
*/
|
|
4245
4274
|
ReaderGroup?: string[];
|
|
4275
|
+
/**
|
|
4276
|
+
* <p>The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the <code>AdminGroup</code> field is required if <code>ACTIVE_DIRECTORY</code> or <code>IAM_IDENTITY_CENTER</code> is the selected authentication method of the new Amazon QuickSight account.</p>
|
|
4277
|
+
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
4278
|
+
* @public
|
|
4279
|
+
*/
|
|
4280
|
+
AdminProGroup?: string[];
|
|
4281
|
+
/**
|
|
4282
|
+
* <p>The author pro group associated with your Active Directory or IAM Identity Center account.</p>
|
|
4283
|
+
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
4284
|
+
* @public
|
|
4285
|
+
*/
|
|
4286
|
+
AuthorProGroup?: string[];
|
|
4287
|
+
/**
|
|
4288
|
+
* <p>The reader pro group associated with your Active Directory or IAM Identity Center account.</p>
|
|
4289
|
+
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
4290
|
+
* @public
|
|
4291
|
+
*/
|
|
4292
|
+
ReaderProGroup?: string[];
|
|
4246
4293
|
/**
|
|
4247
4294
|
* <p>The first name of the author of the Amazon QuickSight account to use for future
|
|
4248
4295
|
* communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected
|
|
@@ -7188,8 +7235,11 @@ export interface CreateRefreshScheduleResponse {
|
|
|
7188
7235
|
*/
|
|
7189
7236
|
export declare const Role: {
|
|
7190
7237
|
readonly ADMIN: "ADMIN";
|
|
7238
|
+
readonly ADMIN_PRO: "ADMIN_PRO";
|
|
7191
7239
|
readonly AUTHOR: "AUTHOR";
|
|
7240
|
+
readonly AUTHOR_PRO: "AUTHOR_PRO";
|
|
7192
7241
|
readonly READER: "READER";
|
|
7242
|
+
readonly READER_PRO: "READER_PRO";
|
|
7193
7243
|
};
|
|
7194
7244
|
/**
|
|
7195
7245
|
* @public
|
|
@@ -7649,134 +7699,6 @@ export interface Typography {
|
|
|
7649
7699
|
*/
|
|
7650
7700
|
FontFamilies?: Font[];
|
|
7651
7701
|
}
|
|
7652
|
-
/**
|
|
7653
|
-
* <p>The theme colors that apply to UI and to charts, excluding data colors. The colors
|
|
7654
|
-
* description is a hexadecimal color code that consists of six alphanumerical characters,
|
|
7655
|
-
* prefixed with <code>#</code>, for example #37BFF5. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html">Using Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User
|
|
7656
|
-
* Guide.</i>
|
|
7657
|
-
* </p>
|
|
7658
|
-
* @public
|
|
7659
|
-
*/
|
|
7660
|
-
export interface UIColorPalette {
|
|
7661
|
-
/**
|
|
7662
|
-
* <p>The color of text and other foreground elements that appear over the primary
|
|
7663
|
-
* background regions, such as grid lines, borders, table banding, icons, and so on.</p>
|
|
7664
|
-
* @public
|
|
7665
|
-
*/
|
|
7666
|
-
PrimaryForeground?: string;
|
|
7667
|
-
/**
|
|
7668
|
-
* <p>The background color that applies to visuals and other high emphasis UI.</p>
|
|
7669
|
-
* @public
|
|
7670
|
-
*/
|
|
7671
|
-
PrimaryBackground?: string;
|
|
7672
|
-
/**
|
|
7673
|
-
* <p>The foreground color that applies to any sheet title, sheet control text, or UI that
|
|
7674
|
-
* appears over the secondary background.</p>
|
|
7675
|
-
* @public
|
|
7676
|
-
*/
|
|
7677
|
-
SecondaryForeground?: string;
|
|
7678
|
-
/**
|
|
7679
|
-
* <p>The background color that applies to the sheet background and sheet controls.</p>
|
|
7680
|
-
* @public
|
|
7681
|
-
*/
|
|
7682
|
-
SecondaryBackground?: string;
|
|
7683
|
-
/**
|
|
7684
|
-
* <p>This color is that applies to selected states and buttons.</p>
|
|
7685
|
-
* @public
|
|
7686
|
-
*/
|
|
7687
|
-
Accent?: string;
|
|
7688
|
-
/**
|
|
7689
|
-
* <p>The foreground color that applies to any text or other elements that appear over the
|
|
7690
|
-
* accent color.</p>
|
|
7691
|
-
* @public
|
|
7692
|
-
*/
|
|
7693
|
-
AccentForeground?: string;
|
|
7694
|
-
/**
|
|
7695
|
-
* <p>The color that applies to error messages.</p>
|
|
7696
|
-
* @public
|
|
7697
|
-
*/
|
|
7698
|
-
Danger?: string;
|
|
7699
|
-
/**
|
|
7700
|
-
* <p>The foreground color that applies to any text or other elements that appear over the
|
|
7701
|
-
* error color.</p>
|
|
7702
|
-
* @public
|
|
7703
|
-
*/
|
|
7704
|
-
DangerForeground?: string;
|
|
7705
|
-
/**
|
|
7706
|
-
* <p>This color that applies to warning and informational messages.</p>
|
|
7707
|
-
* @public
|
|
7708
|
-
*/
|
|
7709
|
-
Warning?: string;
|
|
7710
|
-
/**
|
|
7711
|
-
* <p>The foreground color that applies to any text or other elements that appear over the
|
|
7712
|
-
* warning color.</p>
|
|
7713
|
-
* @public
|
|
7714
|
-
*/
|
|
7715
|
-
WarningForeground?: string;
|
|
7716
|
-
/**
|
|
7717
|
-
* <p>The color that applies to success messages, for example the check mark for a
|
|
7718
|
-
* successful download.</p>
|
|
7719
|
-
* @public
|
|
7720
|
-
*/
|
|
7721
|
-
Success?: string;
|
|
7722
|
-
/**
|
|
7723
|
-
* <p>The foreground color that applies to any text or other elements that appear over the
|
|
7724
|
-
* success color.</p>
|
|
7725
|
-
* @public
|
|
7726
|
-
*/
|
|
7727
|
-
SuccessForeground?: string;
|
|
7728
|
-
/**
|
|
7729
|
-
* <p>The color that applies to the names of fields that are identified as
|
|
7730
|
-
* dimensions.</p>
|
|
7731
|
-
* @public
|
|
7732
|
-
*/
|
|
7733
|
-
Dimension?: string;
|
|
7734
|
-
/**
|
|
7735
|
-
* <p>The foreground color that applies to any text or other elements that appear over the
|
|
7736
|
-
* dimension color.</p>
|
|
7737
|
-
* @public
|
|
7738
|
-
*/
|
|
7739
|
-
DimensionForeground?: string;
|
|
7740
|
-
/**
|
|
7741
|
-
* <p>The color that applies to the names of fields that are identified as measures.</p>
|
|
7742
|
-
* @public
|
|
7743
|
-
*/
|
|
7744
|
-
Measure?: string;
|
|
7745
|
-
/**
|
|
7746
|
-
* <p>The foreground color that applies to any text or other elements that appear over the
|
|
7747
|
-
* measure color.</p>
|
|
7748
|
-
* @public
|
|
7749
|
-
*/
|
|
7750
|
-
MeasureForeground?: string;
|
|
7751
|
-
}
|
|
7752
|
-
/**
|
|
7753
|
-
* <p>The theme configuration. This configuration contains all of the display properties for
|
|
7754
|
-
* a theme.</p>
|
|
7755
|
-
* @public
|
|
7756
|
-
*/
|
|
7757
|
-
export interface ThemeConfiguration {
|
|
7758
|
-
/**
|
|
7759
|
-
* <p>Color properties that apply to chart data colors.</p>
|
|
7760
|
-
* @public
|
|
7761
|
-
*/
|
|
7762
|
-
DataColorPalette?: DataColorPalette;
|
|
7763
|
-
/**
|
|
7764
|
-
* <p>Color properties that apply to the UI and to charts, excluding the colors that apply
|
|
7765
|
-
* to data. </p>
|
|
7766
|
-
* @public
|
|
7767
|
-
*/
|
|
7768
|
-
UIColorPalette?: UIColorPalette;
|
|
7769
|
-
/**
|
|
7770
|
-
* <p>Display options related to sheets.</p>
|
|
7771
|
-
* @public
|
|
7772
|
-
*/
|
|
7773
|
-
Sheet?: SheetStyle;
|
|
7774
|
-
/**
|
|
7775
|
-
* <p>Determines the typography options.</p>
|
|
7776
|
-
* @public
|
|
7777
|
-
*/
|
|
7778
|
-
Typography?: Typography;
|
|
7779
|
-
}
|
|
7780
7702
|
/**
|
|
7781
7703
|
* @internal
|
|
7782
7704
|
*/
|