@aws-sdk/client-quicksight 3.658.1 → 3.660.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 +16 -0
- package/dist-cjs/index.js +112 -11
- package/dist-es/QuickSight.js +4 -0
- package/dist-es/commands/DescribeQPersonalizationConfigurationCommand.js +22 -0
- package/dist-es/commands/UpdateQPersonalizationConfigurationCommand.js +22 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_3.js +4 -10
- package/dist-es/models/models_4.js +10 -0
- package/dist-es/protocols/Aws_restJson1.js +59 -0
- package/dist-types/QuickSight.d.ts +14 -0
- package/dist-types/QuickSightClient.d.ts +4 -2
- package/dist-types/commands/DescribeQPersonalizationConfigurationCommand.d.ts +94 -0
- package/dist-types/commands/DescribeUserCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQPersonalizationConfigurationCommand.d.ts +98 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_3.d.ts +42 -152
- package/dist-types/models/models_4.d.ts +188 -1
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/QuickSight.d.ts +46 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/DescribeQPersonalizationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateQPersonalizationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_3.d.ts +14 -29
- package/dist-types/ts3.4/models/models_4.d.ts +39 -2
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +1 -1
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DescribeQPersonalizationConfigurationRequest, DescribeQPersonalizationConfigurationResponse } from "../models/models_3";
|
|
4
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeQPersonalizationConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeQPersonalizationConfigurationCommandInput extends DescribeQPersonalizationConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeQPersonalizationConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeQPersonalizationConfigurationCommandOutput extends DescribeQPersonalizationConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeQPersonalizationConfigurationCommand_base: {
|
|
25
|
+
new (input: DescribeQPersonalizationConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeQPersonalizationConfigurationCommandInput, DescribeQPersonalizationConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DescribeQPersonalizationConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeQPersonalizationConfigurationCommandInput, DescribeQPersonalizationConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Describes a personalization configuration.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QuickSightClient, DescribeQPersonalizationConfigurationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
35
|
+
* // const { QuickSightClient, DescribeQPersonalizationConfigurationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
36
|
+
* const client = new QuickSightClient(config);
|
|
37
|
+
* const input = { // DescribeQPersonalizationConfigurationRequest
|
|
38
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeQPersonalizationConfigurationCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeQPersonalizationConfigurationResponse
|
|
43
|
+
* // PersonalizationMode: "ENABLED" || "DISABLED",
|
|
44
|
+
* // RequestId: "STRING_VALUE",
|
|
45
|
+
* // Status: Number("int"),
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param DescribeQPersonalizationConfigurationCommandInput - {@link DescribeQPersonalizationConfigurationCommandInput}
|
|
51
|
+
* @returns {@link DescribeQPersonalizationConfigurationCommandOutput}
|
|
52
|
+
* @see {@link DescribeQPersonalizationConfigurationCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link DescribeQPersonalizationConfigurationCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
58
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
59
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
60
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ConflictException} (client fault)
|
|
63
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
66
|
+
* <p>An internal failure occurred.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
69
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>One or more resources can't be found.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>Access is throttled.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link QuickSightServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
79
|
+
*
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
export declare class DescribeQPersonalizationConfigurationCommand extends DescribeQPersonalizationConfigurationCommand_base {
|
|
83
|
+
/** @internal type navigation helper, not in runtime. */
|
|
84
|
+
protected static __types: {
|
|
85
|
+
api: {
|
|
86
|
+
input: DescribeQPersonalizationConfigurationRequest;
|
|
87
|
+
output: DescribeQPersonalizationConfigurationResponse;
|
|
88
|
+
};
|
|
89
|
+
sdk: {
|
|
90
|
+
input: DescribeQPersonalizationConfigurationCommandInput;
|
|
91
|
+
output: DescribeQPersonalizationConfigurationCommandOutput;
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -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 { DescribeUserRequest
|
|
3
|
+
import { DescribeUserRequest } from "../models/models_3";
|
|
4
|
+
import { DescribeUserResponse } from "../models/models_4";
|
|
4
5
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { UpdateQPersonalizationConfigurationRequest, UpdateQPersonalizationConfigurationResponse } from "../models/models_4";
|
|
4
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateQPersonalizationConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateQPersonalizationConfigurationCommandInput extends UpdateQPersonalizationConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateQPersonalizationConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateQPersonalizationConfigurationCommandOutput extends UpdateQPersonalizationConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateQPersonalizationConfigurationCommand_base: {
|
|
25
|
+
new (input: UpdateQPersonalizationConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQPersonalizationConfigurationCommandInput, UpdateQPersonalizationConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateQPersonalizationConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQPersonalizationConfigurationCommandInput, UpdateQPersonalizationConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates a personalization configuration.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QuickSightClient, UpdateQPersonalizationConfigurationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
35
|
+
* // const { QuickSightClient, UpdateQPersonalizationConfigurationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
36
|
+
* const client = new QuickSightClient(config);
|
|
37
|
+
* const input = { // UpdateQPersonalizationConfigurationRequest
|
|
38
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
39
|
+
* PersonalizationMode: "ENABLED" || "DISABLED", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new UpdateQPersonalizationConfigurationCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // UpdateQPersonalizationConfigurationResponse
|
|
44
|
+
* // PersonalizationMode: "ENABLED" || "DISABLED",
|
|
45
|
+
* // RequestId: "STRING_VALUE",
|
|
46
|
+
* // Status: Number("int"),
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param UpdateQPersonalizationConfigurationCommandInput - {@link UpdateQPersonalizationConfigurationCommandInput}
|
|
52
|
+
* @returns {@link UpdateQPersonalizationConfigurationCommandOutput}
|
|
53
|
+
* @see {@link UpdateQPersonalizationConfigurationCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link UpdateQPersonalizationConfigurationCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
59
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
60
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
61
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ConflictException} (client fault)
|
|
64
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
67
|
+
* <p>An internal failure occurred.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
70
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
73
|
+
* <p>One or more resources can't be found.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ResourceUnavailableException} (server fault)
|
|
76
|
+
* <p>This resource is currently unavailable.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
79
|
+
* <p>Access is throttled.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link QuickSightServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
83
|
+
*
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export declare class UpdateQPersonalizationConfigurationCommand extends UpdateQPersonalizationConfigurationCommand_base {
|
|
87
|
+
/** @internal type navigation helper, not in runtime. */
|
|
88
|
+
protected static __types: {
|
|
89
|
+
api: {
|
|
90
|
+
input: UpdateQPersonalizationConfigurationRequest;
|
|
91
|
+
output: UpdateQPersonalizationConfigurationResponse;
|
|
92
|
+
};
|
|
93
|
+
sdk: {
|
|
94
|
+
input: UpdateQPersonalizationConfigurationCommandInput;
|
|
95
|
+
output: UpdateQPersonalizationConfigurationCommandOutput;
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
}
|
|
@@ -77,6 +77,7 @@ export * from "./DescribeIngestionCommand";
|
|
|
77
77
|
export * from "./DescribeIpRestrictionCommand";
|
|
78
78
|
export * from "./DescribeKeyRegistrationCommand";
|
|
79
79
|
export * from "./DescribeNamespaceCommand";
|
|
80
|
+
export * from "./DescribeQPersonalizationConfigurationCommand";
|
|
80
81
|
export * from "./DescribeRefreshScheduleCommand";
|
|
81
82
|
export * from "./DescribeRoleCustomPermissionCommand";
|
|
82
83
|
export * from "./DescribeTemplateAliasCommand";
|
|
@@ -162,6 +163,7 @@ export * from "./UpdateIdentityPropagationConfigCommand";
|
|
|
162
163
|
export * from "./UpdateIpRestrictionCommand";
|
|
163
164
|
export * from "./UpdateKeyRegistrationCommand";
|
|
164
165
|
export * from "./UpdatePublicSharingSettingsCommand";
|
|
166
|
+
export * from "./UpdateQPersonalizationConfigurationCommand";
|
|
165
167
|
export * from "./UpdateRefreshScheduleCommand";
|
|
166
168
|
export * from "./UpdateRoleCustomPermissionCommand";
|
|
167
169
|
export * from "./UpdateSPICECapacityConfigurationCommand";
|
|
@@ -6897,6 +6897,48 @@ export interface DescribeNamespaceResponse {
|
|
|
6897
6897
|
*/
|
|
6898
6898
|
Status?: number;
|
|
6899
6899
|
}
|
|
6900
|
+
/**
|
|
6901
|
+
* @public
|
|
6902
|
+
*/
|
|
6903
|
+
export interface DescribeQPersonalizationConfigurationRequest {
|
|
6904
|
+
/**
|
|
6905
|
+
* <p>The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.</p>
|
|
6906
|
+
* @public
|
|
6907
|
+
*/
|
|
6908
|
+
AwsAccountId: string | undefined;
|
|
6909
|
+
}
|
|
6910
|
+
/**
|
|
6911
|
+
* @public
|
|
6912
|
+
* @enum
|
|
6913
|
+
*/
|
|
6914
|
+
export declare const PersonalizationMode: {
|
|
6915
|
+
readonly DISABLED: "DISABLED";
|
|
6916
|
+
readonly ENABLED: "ENABLED";
|
|
6917
|
+
};
|
|
6918
|
+
/**
|
|
6919
|
+
* @public
|
|
6920
|
+
*/
|
|
6921
|
+
export type PersonalizationMode = (typeof PersonalizationMode)[keyof typeof PersonalizationMode];
|
|
6922
|
+
/**
|
|
6923
|
+
* @public
|
|
6924
|
+
*/
|
|
6925
|
+
export interface DescribeQPersonalizationConfigurationResponse {
|
|
6926
|
+
/**
|
|
6927
|
+
* <p>A value that indicates whether personalization is enabled or not.</p>
|
|
6928
|
+
* @public
|
|
6929
|
+
*/
|
|
6930
|
+
PersonalizationMode?: PersonalizationMode;
|
|
6931
|
+
/**
|
|
6932
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6933
|
+
* @public
|
|
6934
|
+
*/
|
|
6935
|
+
RequestId?: string;
|
|
6936
|
+
/**
|
|
6937
|
+
* <p>The HTTP status of the request.</p>
|
|
6938
|
+
* @public
|
|
6939
|
+
*/
|
|
6940
|
+
Status?: number;
|
|
6941
|
+
}
|
|
6900
6942
|
/**
|
|
6901
6943
|
* @public
|
|
6902
6944
|
*/
|
|
@@ -7924,158 +7966,6 @@ export declare const IdentityType: {
|
|
|
7924
7966
|
* @public
|
|
7925
7967
|
*/
|
|
7926
7968
|
export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
|
|
7927
|
-
/**
|
|
7928
|
-
* @public
|
|
7929
|
-
* @enum
|
|
7930
|
-
*/
|
|
7931
|
-
export declare const UserRole: {
|
|
7932
|
-
readonly ADMIN: "ADMIN";
|
|
7933
|
-
readonly ADMIN_PRO: "ADMIN_PRO";
|
|
7934
|
-
readonly AUTHOR: "AUTHOR";
|
|
7935
|
-
readonly AUTHOR_PRO: "AUTHOR_PRO";
|
|
7936
|
-
readonly READER: "READER";
|
|
7937
|
-
readonly READER_PRO: "READER_PRO";
|
|
7938
|
-
readonly RESTRICTED_AUTHOR: "RESTRICTED_AUTHOR";
|
|
7939
|
-
readonly RESTRICTED_READER: "RESTRICTED_READER";
|
|
7940
|
-
};
|
|
7941
|
-
/**
|
|
7942
|
-
* @public
|
|
7943
|
-
*/
|
|
7944
|
-
export type UserRole = (typeof UserRole)[keyof typeof UserRole];
|
|
7945
|
-
/**
|
|
7946
|
-
* <p>A registered user of Amazon QuickSight. </p>
|
|
7947
|
-
* @public
|
|
7948
|
-
*/
|
|
7949
|
-
export interface User {
|
|
7950
|
-
/**
|
|
7951
|
-
* <p>The Amazon Resource Name (ARN) for the user.</p>
|
|
7952
|
-
* @public
|
|
7953
|
-
*/
|
|
7954
|
-
Arn?: string;
|
|
7955
|
-
/**
|
|
7956
|
-
* <p>The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for <code>UserName</code> is
|
|
7957
|
-
* <code>N/A</code> when the value for <code>IdentityType</code> is <code>IAM</code>
|
|
7958
|
-
* and the corresponding IAM user is deleted.</p>
|
|
7959
|
-
* @public
|
|
7960
|
-
*/
|
|
7961
|
-
UserName?: string;
|
|
7962
|
-
/**
|
|
7963
|
-
* <p>The user's email address.</p>
|
|
7964
|
-
* @public
|
|
7965
|
-
*/
|
|
7966
|
-
Email?: string;
|
|
7967
|
-
/**
|
|
7968
|
-
* <p>The Amazon QuickSight role for the user. The user role can be one of the
|
|
7969
|
-
* following:.</p>
|
|
7970
|
-
* <ul>
|
|
7971
|
-
* <li>
|
|
7972
|
-
* <p>
|
|
7973
|
-
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
7974
|
-
* </li>
|
|
7975
|
-
* <li>
|
|
7976
|
-
* <p>
|
|
7977
|
-
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses,
|
|
7978
|
-
* and dashboards.</p>
|
|
7979
|
-
* </li>
|
|
7980
|
-
* <li>
|
|
7981
|
-
* <p>
|
|
7982
|
-
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon
|
|
7983
|
-
* Amazon QuickSight settings.</p>
|
|
7984
|
-
* </li>
|
|
7985
|
-
* <li>
|
|
7986
|
-
* <p>
|
|
7987
|
-
* <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p>
|
|
7988
|
-
* </li>
|
|
7989
|
-
* <li>
|
|
7990
|
-
* <p>
|
|
7991
|
-
* <code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p>
|
|
7992
|
-
* </li>
|
|
7993
|
-
* <li>
|
|
7994
|
-
* <p>
|
|
7995
|
-
* <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.</p>
|
|
7996
|
-
* </li>
|
|
7997
|
-
* <li>
|
|
7998
|
-
* <p>
|
|
7999
|
-
* <code>RESTRICTED_READER</code>: This role isn't currently available for
|
|
8000
|
-
* use.</p>
|
|
8001
|
-
* </li>
|
|
8002
|
-
* <li>
|
|
8003
|
-
* <p>
|
|
8004
|
-
* <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for
|
|
8005
|
-
* use.</p>
|
|
8006
|
-
* </li>
|
|
8007
|
-
* </ul>
|
|
8008
|
-
* @public
|
|
8009
|
-
*/
|
|
8010
|
-
Role?: UserRole;
|
|
8011
|
-
/**
|
|
8012
|
-
* <p>The type of identity authentication used by the user.</p>
|
|
8013
|
-
* @public
|
|
8014
|
-
*/
|
|
8015
|
-
IdentityType?: IdentityType;
|
|
8016
|
-
/**
|
|
8017
|
-
* <p>The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a
|
|
8018
|
-
* password.</p>
|
|
8019
|
-
* @public
|
|
8020
|
-
*/
|
|
8021
|
-
Active?: boolean;
|
|
8022
|
-
/**
|
|
8023
|
-
* <p>The principal ID of the user.</p>
|
|
8024
|
-
* @public
|
|
8025
|
-
*/
|
|
8026
|
-
PrincipalId?: string;
|
|
8027
|
-
/**
|
|
8028
|
-
* <p>The custom permissions profile associated with this user.</p>
|
|
8029
|
-
* @public
|
|
8030
|
-
*/
|
|
8031
|
-
CustomPermissionsName?: string;
|
|
8032
|
-
/**
|
|
8033
|
-
* <p>The type of supported external login provider that provides identity to let the user
|
|
8034
|
-
* federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.</p>
|
|
8035
|
-
* <ul>
|
|
8036
|
-
* <li>
|
|
8037
|
-
* <p>
|
|
8038
|
-
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.</p>
|
|
8039
|
-
* </li>
|
|
8040
|
-
* <li>
|
|
8041
|
-
* <p>
|
|
8042
|
-
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider.</p>
|
|
8043
|
-
* </li>
|
|
8044
|
-
* </ul>
|
|
8045
|
-
* @public
|
|
8046
|
-
*/
|
|
8047
|
-
ExternalLoginFederationProviderType?: string;
|
|
8048
|
-
/**
|
|
8049
|
-
* <p>The URL of the external login provider.</p>
|
|
8050
|
-
* @public
|
|
8051
|
-
*/
|
|
8052
|
-
ExternalLoginFederationProviderUrl?: string;
|
|
8053
|
-
/**
|
|
8054
|
-
* <p>The identity ID for the user in the external login provider.</p>
|
|
8055
|
-
* @public
|
|
8056
|
-
*/
|
|
8057
|
-
ExternalLoginId?: string;
|
|
8058
|
-
}
|
|
8059
|
-
/**
|
|
8060
|
-
* @public
|
|
8061
|
-
*/
|
|
8062
|
-
export interface DescribeUserResponse {
|
|
8063
|
-
/**
|
|
8064
|
-
* <p>The user name.</p>
|
|
8065
|
-
* @public
|
|
8066
|
-
*/
|
|
8067
|
-
User?: User;
|
|
8068
|
-
/**
|
|
8069
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8070
|
-
* @public
|
|
8071
|
-
*/
|
|
8072
|
-
RequestId?: string;
|
|
8073
|
-
/**
|
|
8074
|
-
* <p>The HTTP status of the request.</p>
|
|
8075
|
-
* @public
|
|
8076
|
-
*/
|
|
8077
|
-
Status?: number;
|
|
8078
|
-
}
|
|
8079
7969
|
/**
|
|
8080
7970
|
* @internal
|
|
8081
7971
|
*/
|
|
@@ -1,8 +1,160 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { AccountCustomization, ActiveIAMPolicyAssignment, ResourceStatus } from "./models_0";
|
|
3
3
|
import { _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobSummary, AssetBundleImportSource, AssignmentStatus, AuthorizedTargetsByService, BookmarksConfigurations, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DashboardVisualId, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceParameters, FieldFolder, FilterOperator, LinkSharingConfiguration, LogicalTable, PhysicalTable, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, ServiceType, SharedViewConfigurations, SslProperties, Tag, TopicIR, TopicTemplate, ValidationStrategy, VisualRole, VpcConnectionProperties } from "./models_2";
|
|
4
|
-
import { DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FolderType, Group, GroupMember, IdentityType, Ingestion, NamespaceInfoV2, RefreshSchedule, RegisteredCustomerManagedKey, Role, SharingModel, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, ThemeType, TopicDetails, TopicRefreshSchedule, TopicUserExperienceVersion,
|
|
4
|
+
import { DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FolderType, Group, GroupMember, IdentityType, Ingestion, NamespaceInfoV2, PersonalizationMode, RefreshSchedule, RegisteredCustomerManagedKey, Role, SharingModel, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, ThemeType, TopicDetails, TopicRefreshSchedule, TopicUserExperienceVersion, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
|
|
5
5
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
* @enum
|
|
9
|
+
*/
|
|
10
|
+
export declare const UserRole: {
|
|
11
|
+
readonly ADMIN: "ADMIN";
|
|
12
|
+
readonly ADMIN_PRO: "ADMIN_PRO";
|
|
13
|
+
readonly AUTHOR: "AUTHOR";
|
|
14
|
+
readonly AUTHOR_PRO: "AUTHOR_PRO";
|
|
15
|
+
readonly READER: "READER";
|
|
16
|
+
readonly READER_PRO: "READER_PRO";
|
|
17
|
+
readonly RESTRICTED_AUTHOR: "RESTRICTED_AUTHOR";
|
|
18
|
+
readonly RESTRICTED_READER: "RESTRICTED_READER";
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export type UserRole = (typeof UserRole)[keyof typeof UserRole];
|
|
24
|
+
/**
|
|
25
|
+
* <p>A registered user of Amazon QuickSight. </p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
export interface User {
|
|
29
|
+
/**
|
|
30
|
+
* <p>The Amazon Resource Name (ARN) for the user.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
Arn?: string;
|
|
34
|
+
/**
|
|
35
|
+
* <p>The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for <code>UserName</code> is
|
|
36
|
+
* <code>N/A</code> when the value for <code>IdentityType</code> is <code>IAM</code>
|
|
37
|
+
* and the corresponding IAM user is deleted.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
UserName?: string;
|
|
41
|
+
/**
|
|
42
|
+
* <p>The user's email address.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
Email?: string;
|
|
46
|
+
/**
|
|
47
|
+
* <p>The Amazon QuickSight role for the user. The user role can be one of the
|
|
48
|
+
* following:.</p>
|
|
49
|
+
* <ul>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>
|
|
52
|
+
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>
|
|
56
|
+
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses,
|
|
57
|
+
* and dashboards.</p>
|
|
58
|
+
* </li>
|
|
59
|
+
* <li>
|
|
60
|
+
* <p>
|
|
61
|
+
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon
|
|
62
|
+
* Amazon QuickSight settings.</p>
|
|
63
|
+
* </li>
|
|
64
|
+
* <li>
|
|
65
|
+
* <p>
|
|
66
|
+
* <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p>
|
|
67
|
+
* </li>
|
|
68
|
+
* <li>
|
|
69
|
+
* <p>
|
|
70
|
+
* <code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p>
|
|
71
|
+
* </li>
|
|
72
|
+
* <li>
|
|
73
|
+
* <p>
|
|
74
|
+
* <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.</p>
|
|
75
|
+
* </li>
|
|
76
|
+
* <li>
|
|
77
|
+
* <p>
|
|
78
|
+
* <code>RESTRICTED_READER</code>: This role isn't currently available for
|
|
79
|
+
* use.</p>
|
|
80
|
+
* </li>
|
|
81
|
+
* <li>
|
|
82
|
+
* <p>
|
|
83
|
+
* <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for
|
|
84
|
+
* use.</p>
|
|
85
|
+
* </li>
|
|
86
|
+
* </ul>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
Role?: UserRole;
|
|
90
|
+
/**
|
|
91
|
+
* <p>The type of identity authentication used by the user.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
IdentityType?: IdentityType;
|
|
95
|
+
/**
|
|
96
|
+
* <p>The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a
|
|
97
|
+
* password.</p>
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
Active?: boolean;
|
|
101
|
+
/**
|
|
102
|
+
* <p>The principal ID of the user.</p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
PrincipalId?: string;
|
|
106
|
+
/**
|
|
107
|
+
* <p>The custom permissions profile associated with this user.</p>
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
CustomPermissionsName?: string;
|
|
111
|
+
/**
|
|
112
|
+
* <p>The type of supported external login provider that provides identity to let the user
|
|
113
|
+
* federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.</p>
|
|
114
|
+
* <ul>
|
|
115
|
+
* <li>
|
|
116
|
+
* <p>
|
|
117
|
+
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.</p>
|
|
118
|
+
* </li>
|
|
119
|
+
* <li>
|
|
120
|
+
* <p>
|
|
121
|
+
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider.</p>
|
|
122
|
+
* </li>
|
|
123
|
+
* </ul>
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
ExternalLoginFederationProviderType?: string;
|
|
127
|
+
/**
|
|
128
|
+
* <p>The URL of the external login provider.</p>
|
|
129
|
+
* @public
|
|
130
|
+
*/
|
|
131
|
+
ExternalLoginFederationProviderUrl?: string;
|
|
132
|
+
/**
|
|
133
|
+
* <p>The identity ID for the user in the external login provider.</p>
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
ExternalLoginId?: string;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
141
|
+
export interface DescribeUserResponse {
|
|
142
|
+
/**
|
|
143
|
+
* <p>The user name.</p>
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
User?: User;
|
|
147
|
+
/**
|
|
148
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
RequestId?: string;
|
|
152
|
+
/**
|
|
153
|
+
* <p>The HTTP status of the request.</p>
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
Status?: number;
|
|
157
|
+
}
|
|
6
158
|
/**
|
|
7
159
|
* @public
|
|
8
160
|
*/
|
|
@@ -5034,6 +5186,41 @@ export interface UpdatePublicSharingSettingsResponse {
|
|
|
5034
5186
|
*/
|
|
5035
5187
|
Status?: number;
|
|
5036
5188
|
}
|
|
5189
|
+
/**
|
|
5190
|
+
* @public
|
|
5191
|
+
*/
|
|
5192
|
+
export interface UpdateQPersonalizationConfigurationRequest {
|
|
5193
|
+
/**
|
|
5194
|
+
* <p>The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.</p>
|
|
5195
|
+
* @public
|
|
5196
|
+
*/
|
|
5197
|
+
AwsAccountId: string | undefined;
|
|
5198
|
+
/**
|
|
5199
|
+
* <p>An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.</p>
|
|
5200
|
+
* @public
|
|
5201
|
+
*/
|
|
5202
|
+
PersonalizationMode: PersonalizationMode | undefined;
|
|
5203
|
+
}
|
|
5204
|
+
/**
|
|
5205
|
+
* @public
|
|
5206
|
+
*/
|
|
5207
|
+
export interface UpdateQPersonalizationConfigurationResponse {
|
|
5208
|
+
/**
|
|
5209
|
+
* <p>The personalization mode that is used for the personalization configuration.</p>
|
|
5210
|
+
* @public
|
|
5211
|
+
*/
|
|
5212
|
+
PersonalizationMode?: PersonalizationMode;
|
|
5213
|
+
/**
|
|
5214
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
5215
|
+
* @public
|
|
5216
|
+
*/
|
|
5217
|
+
RequestId?: string;
|
|
5218
|
+
/**
|
|
5219
|
+
* <p>The HTTP status of the request.</p>
|
|
5220
|
+
* @public
|
|
5221
|
+
*/
|
|
5222
|
+
Status?: number;
|
|
5223
|
+
}
|
|
5037
5224
|
/**
|
|
5038
5225
|
* @public
|
|
5039
5226
|
*/
|