@aws-sdk/client-quicksight 3.958.0 → 3.962.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 +28 -0
- package/dist-cjs/index.js +215 -10
- package/dist-es/QuickSight.js +8 -0
- package/dist-es/commands/DescribeSelfUpgradeConfigurationCommand.js +16 -0
- package/dist-es/commands/ListSelfUpgradesCommand.js +16 -0
- package/dist-es/commands/UpdateSelfUpgradeCommand.js +16 -0
- package/dist-es/commands/UpdateSelfUpgradeConfigurationCommand.js +16 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/enums.js +16 -0
- package/dist-es/models/errors.js +16 -0
- package/dist-es/schemas/schemas_0.js +109 -11
- package/dist-types/QuickSight.d.ts +28 -0
- package/dist-types/QuickSightClient.d.ts +6 -2
- package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeSelfUpgradeConfigurationCommand.d.ts +106 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/ListCustomPermissionsCommand.d.ts +1 -0
- package/dist-types/commands/ListSelfUpgradesCommand.d.ts +122 -0
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +2 -2
- package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +1 -0
- package/dist-types/commands/UpdateSelfUpgradeCommand.d.ts +119 -0
- package/dist-types/commands/UpdateSelfUpgradeConfigurationCommand.d.ts +104 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/enums.d.ts +40 -0
- package/dist-types/models/errors.d.ts +18 -0
- package/dist-types/models/models_2.d.ts +5 -0
- package/dist-types/models/models_3.d.ts +57 -129
- package/dist-types/models/models_4.d.ts +312 -3
- package/dist-types/schemas/schemas_0.d.ts +15 -0
- package/dist-types/ts3.4/QuickSight.d.ts +68 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/DescribeSelfUpgradeConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeTemplateDefinitionCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSelfUpgradesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateSelfUpgradeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateSelfUpgradeConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +22 -0
- package/dist-types/ts3.4/models/errors.d.ts +9 -0
- package/dist-types/ts3.4/models/models_2.d.ts +1 -0
- package/dist-types/ts3.4/models/models_3.d.ts +13 -21
- package/dist-types/ts3.4/models/models_4.d.ts +68 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +15 -0
- package/package.json +2 -2
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DescribeSelfUpgradeConfigurationRequest, DescribeSelfUpgradeConfigurationResponse } from "../models/models_3";
|
|
4
|
+
import type { 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 DescribeSelfUpgradeConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeSelfUpgradeConfigurationCommandInput extends DescribeSelfUpgradeConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeSelfUpgradeConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeSelfUpgradeConfigurationCommandOutput extends DescribeSelfUpgradeConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeSelfUpgradeConfigurationCommand_base: {
|
|
25
|
+
new (input: DescribeSelfUpgradeConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeSelfUpgradeConfigurationCommandInput, DescribeSelfUpgradeConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeSelfUpgradeConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeSelfUpgradeConfigurationCommandInput, DescribeSelfUpgradeConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Describes the self-upgrade configuration for a Quick Suite account.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QuickSightClient, DescribeSelfUpgradeConfigurationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
35
|
+
* // const { QuickSightClient, DescribeSelfUpgradeConfigurationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
36
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
37
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
38
|
+
* const client = new QuickSightClient(config);
|
|
39
|
+
* const input = { // DescribeSelfUpgradeConfigurationRequest
|
|
40
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
41
|
+
* Namespace: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DescribeSelfUpgradeConfigurationCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // DescribeSelfUpgradeConfigurationResponse
|
|
46
|
+
* // SelfUpgradeConfiguration: { // SelfUpgradeConfiguration
|
|
47
|
+
* // SelfUpgradeStatus: "AUTO_APPROVAL" || "ADMIN_APPROVAL",
|
|
48
|
+
* // },
|
|
49
|
+
* // RequestId: "STRING_VALUE",
|
|
50
|
+
* // Status: Number("int"),
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param DescribeSelfUpgradeConfigurationCommandInput - {@link DescribeSelfUpgradeConfigurationCommandInput}
|
|
56
|
+
* @returns {@link DescribeSelfUpgradeConfigurationCommandOutput}
|
|
57
|
+
* @see {@link DescribeSelfUpgradeConfigurationCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link DescribeSelfUpgradeConfigurationCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
63
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
64
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
65
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
68
|
+
* <p>An internal failure occurred.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
71
|
+
* <p>One or more parameter has a value that isn't valid.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
74
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
77
|
+
* <p>One or more preconditions aren't met.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
80
|
+
* <p>One or more resources can't be found.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ResourceUnavailableException} (server fault)
|
|
83
|
+
* <p>This resource is currently unavailable.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
86
|
+
* <p>Access is throttled.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link QuickSightServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
90
|
+
*
|
|
91
|
+
*
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
export declare class DescribeSelfUpgradeConfigurationCommand extends DescribeSelfUpgradeConfigurationCommand_base {
|
|
95
|
+
/** @internal type navigation helper, not in runtime. */
|
|
96
|
+
protected static __types: {
|
|
97
|
+
api: {
|
|
98
|
+
input: DescribeSelfUpgradeConfigurationRequest;
|
|
99
|
+
output: DescribeSelfUpgradeConfigurationResponse;
|
|
100
|
+
};
|
|
101
|
+
sdk: {
|
|
102
|
+
input: DescribeSelfUpgradeConfigurationCommandInput;
|
|
103
|
+
output: DescribeSelfUpgradeConfigurationCommandOutput;
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeTemplateDefinitionRequest
|
|
3
|
+
import type { DescribeTemplateDefinitionRequest } from "../models/models_3";
|
|
4
|
+
import type { DescribeTemplateDefinitionResponse } from "../models/models_4";
|
|
4
5
|
import type { 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 type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DescribeTemplatePermissionsRequest, DescribeTemplatePermissionsResponse } from "../models/
|
|
3
|
+
import type { DescribeTemplatePermissionsRequest, DescribeTemplatePermissionsResponse } from "../models/models_4";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListSelfUpgradesRequest, ListSelfUpgradesResponse } from "../models/models_4";
|
|
4
|
+
import type { 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 ListSelfUpgradesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListSelfUpgradesCommandInput extends ListSelfUpgradesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListSelfUpgradesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListSelfUpgradesCommandOutput extends ListSelfUpgradesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListSelfUpgradesCommand_base: {
|
|
25
|
+
new (input: ListSelfUpgradesCommandInput): import("@smithy/smithy-client").CommandImpl<ListSelfUpgradesCommandInput, ListSelfUpgradesCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListSelfUpgradesCommandInput): import("@smithy/smithy-client").CommandImpl<ListSelfUpgradesCommandInput, ListSelfUpgradesCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists all self-upgrade requests for a Quick Suite account.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QuickSightClient, ListSelfUpgradesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
35
|
+
* // const { QuickSightClient, ListSelfUpgradesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
36
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
37
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
38
|
+
* const client = new QuickSightClient(config);
|
|
39
|
+
* const input = { // ListSelfUpgradesRequest
|
|
40
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
41
|
+
* Namespace: "STRING_VALUE", // required
|
|
42
|
+
* NextToken: "STRING_VALUE",
|
|
43
|
+
* MaxResults: Number("int"),
|
|
44
|
+
* };
|
|
45
|
+
* const command = new ListSelfUpgradesCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // ListSelfUpgradesResponse
|
|
48
|
+
* // SelfUpgradeRequestDetails: [ // SelfUpgradeRequestDetailList
|
|
49
|
+
* // { // SelfUpgradeRequestDetail
|
|
50
|
+
* // UpgradeRequestId: "STRING_VALUE",
|
|
51
|
+
* // UserName: "STRING_VALUE",
|
|
52
|
+
* // OriginalRole: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
|
|
53
|
+
* // RequestedRole: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
|
|
54
|
+
* // RequestNote: "STRING_VALUE",
|
|
55
|
+
* // CreationTime: Number("long"),
|
|
56
|
+
* // RequestStatus: "PENDING" || "APPROVED" || "DENIED" || "UPDATE_FAILED" || "VERIFY_FAILED",
|
|
57
|
+
* // lastUpdateAttemptTime: Number("long"),
|
|
58
|
+
* // lastUpdateFailureReason: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // NextToken: "STRING_VALUE",
|
|
62
|
+
* // RequestId: "STRING_VALUE",
|
|
63
|
+
* // Status: Number("int"),
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param ListSelfUpgradesCommandInput - {@link ListSelfUpgradesCommandInput}
|
|
69
|
+
* @returns {@link ListSelfUpgradesCommandOutput}
|
|
70
|
+
* @see {@link ListSelfUpgradesCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link ListSelfUpgradesCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
76
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
77
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
78
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
81
|
+
* <p>An internal failure occurred.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InvalidNextTokenException} (client fault)
|
|
84
|
+
* <p>The <code>NextToken</code> value isn't valid.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
87
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
90
|
+
* <p>A limit is exceeded.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
93
|
+
* <p>One or more preconditions aren't met.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
96
|
+
* <p>One or more resources can't be found.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ResourceUnavailableException} (server fault)
|
|
99
|
+
* <p>This resource is currently unavailable.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
102
|
+
* <p>Access is throttled.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link QuickSightServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
106
|
+
*
|
|
107
|
+
*
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export declare class ListSelfUpgradesCommand extends ListSelfUpgradesCommand_base {
|
|
111
|
+
/** @internal type navigation helper, not in runtime. */
|
|
112
|
+
protected static __types: {
|
|
113
|
+
api: {
|
|
114
|
+
input: ListSelfUpgradesRequest;
|
|
115
|
+
output: ListSelfUpgradesResponse;
|
|
116
|
+
};
|
|
117
|
+
sdk: {
|
|
118
|
+
input: ListSelfUpgradesCommandInput;
|
|
119
|
+
output: ListSelfUpgradesCommandOutput;
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
}
|
|
@@ -94,14 +94,14 @@ declare const StartDashboardSnapshotJobCommand_base: {
|
|
|
94
94
|
* <p>To generate snapshots for registered Quick Sight users, you need to:</p>
|
|
95
95
|
* <ul>
|
|
96
96
|
* <li>
|
|
97
|
-
* <p>Obtain identity-enhanced IAM role session credentials from
|
|
97
|
+
* <p>Obtain identity-enhanced IAM role session credentials from Amazon Web Services Security Token Service (STS).</p>
|
|
98
98
|
* </li>
|
|
99
99
|
* <li>
|
|
100
100
|
* <p>Use these credentials to call the Snapshot Job APIs.</p>
|
|
101
101
|
* </li>
|
|
102
102
|
* </ul>
|
|
103
103
|
* <p>Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user).</p>
|
|
104
|
-
* <p>If your Quick Sight users are backed by <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">
|
|
104
|
+
* <p>If your Quick Sight users are backed by <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">Amazon Web Services Identity Center</a>, then you need to set up a <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/setuptrustedtokenissuer.html">trusted token issuer</a>. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following:</p>
|
|
105
105
|
* <ul>
|
|
106
106
|
* <li>
|
|
107
107
|
* <p>Authenticate user with your OIDC compliant Identity Provider. You should get auth tokens back.</p>
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { UpdateSelfUpgradeRequest, UpdateSelfUpgradeResponse } from "../models/models_4";
|
|
4
|
+
import type { 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 UpdateSelfUpgradeCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateSelfUpgradeCommandInput extends UpdateSelfUpgradeRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateSelfUpgradeCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateSelfUpgradeCommandOutput extends UpdateSelfUpgradeResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateSelfUpgradeCommand_base: {
|
|
25
|
+
new (input: UpdateSelfUpgradeCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSelfUpgradeCommandInput, UpdateSelfUpgradeCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateSelfUpgradeCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSelfUpgradeCommandInput, UpdateSelfUpgradeCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates a self-upgrade request for a Quick Suite user by approving, denying, or verifying the request.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QuickSightClient, UpdateSelfUpgradeCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
35
|
+
* // const { QuickSightClient, UpdateSelfUpgradeCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
36
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
37
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
38
|
+
* const client = new QuickSightClient(config);
|
|
39
|
+
* const input = { // UpdateSelfUpgradeRequest
|
|
40
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
41
|
+
* Namespace: "STRING_VALUE", // required
|
|
42
|
+
* UpgradeRequestId: "STRING_VALUE", // required
|
|
43
|
+
* Action: "APPROVE" || "DENY" || "VERIFY", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new UpdateSelfUpgradeCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // UpdateSelfUpgradeResponse
|
|
48
|
+
* // SelfUpgradeRequestDetail: { // SelfUpgradeRequestDetail
|
|
49
|
+
* // UpgradeRequestId: "STRING_VALUE",
|
|
50
|
+
* // UserName: "STRING_VALUE",
|
|
51
|
+
* // OriginalRole: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
|
|
52
|
+
* // RequestedRole: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
|
|
53
|
+
* // RequestNote: "STRING_VALUE",
|
|
54
|
+
* // CreationTime: Number("long"),
|
|
55
|
+
* // RequestStatus: "PENDING" || "APPROVED" || "DENIED" || "UPDATE_FAILED" || "VERIFY_FAILED",
|
|
56
|
+
* // lastUpdateAttemptTime: Number("long"),
|
|
57
|
+
* // lastUpdateFailureReason: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // RequestId: "STRING_VALUE",
|
|
60
|
+
* // Status: Number("int"),
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param UpdateSelfUpgradeCommandInput - {@link UpdateSelfUpgradeCommandInput}
|
|
66
|
+
* @returns {@link UpdateSelfUpgradeCommandOutput}
|
|
67
|
+
* @see {@link UpdateSelfUpgradeCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link UpdateSelfUpgradeCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
72
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
73
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
74
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
75
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
78
|
+
* <p>An internal failure occurred.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InvalidNextTokenException} (client fault)
|
|
81
|
+
* <p>The <code>NextToken</code> value isn't valid.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
84
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
87
|
+
* <p>A limit is exceeded.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
90
|
+
* <p>One or more preconditions aren't met.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
93
|
+
* <p>One or more resources can't be found.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ResourceUnavailableException} (server fault)
|
|
96
|
+
* <p>This resource is currently unavailable.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
99
|
+
* <p>Access is throttled.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link QuickSightServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
103
|
+
*
|
|
104
|
+
*
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export declare class UpdateSelfUpgradeCommand extends UpdateSelfUpgradeCommand_base {
|
|
108
|
+
/** @internal type navigation helper, not in runtime. */
|
|
109
|
+
protected static __types: {
|
|
110
|
+
api: {
|
|
111
|
+
input: UpdateSelfUpgradeRequest;
|
|
112
|
+
output: UpdateSelfUpgradeResponse;
|
|
113
|
+
};
|
|
114
|
+
sdk: {
|
|
115
|
+
input: UpdateSelfUpgradeCommandInput;
|
|
116
|
+
output: UpdateSelfUpgradeCommandOutput;
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { UpdateSelfUpgradeConfigurationRequest, UpdateSelfUpgradeConfigurationResponse } from "../models/models_4";
|
|
4
|
+
import type { 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 UpdateSelfUpgradeConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateSelfUpgradeConfigurationCommandInput extends UpdateSelfUpgradeConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateSelfUpgradeConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateSelfUpgradeConfigurationCommandOutput extends UpdateSelfUpgradeConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateSelfUpgradeConfigurationCommand_base: {
|
|
25
|
+
new (input: UpdateSelfUpgradeConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSelfUpgradeConfigurationCommandInput, UpdateSelfUpgradeConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateSelfUpgradeConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSelfUpgradeConfigurationCommandInput, UpdateSelfUpgradeConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the self-upgrade configuration for a Quick Suite account.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QuickSightClient, UpdateSelfUpgradeConfigurationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
35
|
+
* // const { QuickSightClient, UpdateSelfUpgradeConfigurationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
36
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
37
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
38
|
+
* const client = new QuickSightClient(config);
|
|
39
|
+
* const input = { // UpdateSelfUpgradeConfigurationRequest
|
|
40
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
41
|
+
* Namespace: "STRING_VALUE", // required
|
|
42
|
+
* SelfUpgradeStatus: "AUTO_APPROVAL" || "ADMIN_APPROVAL", // required
|
|
43
|
+
* };
|
|
44
|
+
* const command = new UpdateSelfUpgradeConfigurationCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // UpdateSelfUpgradeConfigurationResponse
|
|
47
|
+
* // RequestId: "STRING_VALUE",
|
|
48
|
+
* // Status: Number("int"),
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param UpdateSelfUpgradeConfigurationCommandInput - {@link UpdateSelfUpgradeConfigurationCommandInput}
|
|
54
|
+
* @returns {@link UpdateSelfUpgradeConfigurationCommandOutput}
|
|
55
|
+
* @see {@link UpdateSelfUpgradeConfigurationCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link UpdateSelfUpgradeConfigurationCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
61
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
62
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
63
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
66
|
+
* <p>An internal failure occurred.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
69
|
+
* <p>One or more parameter has a value that isn't valid.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
72
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
75
|
+
* <p>One or more preconditions aren't met.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
78
|
+
* <p>One or more resources can't be found.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ResourceUnavailableException} (server fault)
|
|
81
|
+
* <p>This resource is currently unavailable.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
84
|
+
* <p>Access is throttled.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link QuickSightServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class UpdateSelfUpgradeConfigurationCommand extends UpdateSelfUpgradeConfigurationCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: UpdateSelfUpgradeConfigurationRequest;
|
|
97
|
+
output: UpdateSelfUpgradeConfigurationResponse;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: UpdateSelfUpgradeConfigurationCommandInput;
|
|
101
|
+
output: UpdateSelfUpgradeConfigurationCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -100,6 +100,7 @@ export * from "./DescribeQPersonalizationConfigurationCommand";
|
|
|
100
100
|
export * from "./DescribeQuickSightQSearchConfigurationCommand";
|
|
101
101
|
export * from "./DescribeRefreshScheduleCommand";
|
|
102
102
|
export * from "./DescribeRoleCustomPermissionCommand";
|
|
103
|
+
export * from "./DescribeSelfUpgradeConfigurationCommand";
|
|
103
104
|
export * from "./DescribeTemplateAliasCommand";
|
|
104
105
|
export * from "./DescribeTemplateCommand";
|
|
105
106
|
export * from "./DescribeTemplateDefinitionCommand";
|
|
@@ -144,6 +145,7 @@ export * from "./ListIngestionsCommand";
|
|
|
144
145
|
export * from "./ListNamespacesCommand";
|
|
145
146
|
export * from "./ListRefreshSchedulesCommand";
|
|
146
147
|
export * from "./ListRoleMembershipsCommand";
|
|
148
|
+
export * from "./ListSelfUpgradesCommand";
|
|
147
149
|
export * from "./ListTagsForResourceCommand";
|
|
148
150
|
export * from "./ListTemplateAliasesCommand";
|
|
149
151
|
export * from "./ListTemplateVersionsCommand";
|
|
@@ -212,6 +214,8 @@ export * from "./UpdateQuickSightQSearchConfigurationCommand";
|
|
|
212
214
|
export * from "./UpdateRefreshScheduleCommand";
|
|
213
215
|
export * from "./UpdateRoleCustomPermissionCommand";
|
|
214
216
|
export * from "./UpdateSPICECapacityConfigurationCommand";
|
|
217
|
+
export * from "./UpdateSelfUpgradeCommand";
|
|
218
|
+
export * from "./UpdateSelfUpgradeConfigurationCommand";
|
|
215
219
|
export * from "./UpdateTemplateAliasCommand";
|
|
216
220
|
export * from "./UpdateTemplateCommand";
|
|
217
221
|
export * from "./UpdateTemplatePermissionsCommand";
|
|
@@ -3571,6 +3571,18 @@ export declare const QSearchStatus: {
|
|
|
3571
3571
|
* @public
|
|
3572
3572
|
*/
|
|
3573
3573
|
export type QSearchStatus = (typeof QSearchStatus)[keyof typeof QSearchStatus];
|
|
3574
|
+
/**
|
|
3575
|
+
* @public
|
|
3576
|
+
* @enum
|
|
3577
|
+
*/
|
|
3578
|
+
export declare const SelfUpgradeStatus: {
|
|
3579
|
+
readonly ADMIN_APPROVAL: "ADMIN_APPROVAL";
|
|
3580
|
+
readonly AUTO_APPROVAL: "AUTO_APPROVAL";
|
|
3581
|
+
};
|
|
3582
|
+
/**
|
|
3583
|
+
* @public
|
|
3584
|
+
*/
|
|
3585
|
+
export type SelfUpgradeStatus = (typeof SelfUpgradeStatus)[keyof typeof SelfUpgradeStatus];
|
|
3574
3586
|
/**
|
|
3575
3587
|
* @public
|
|
3576
3588
|
* @enum
|
|
@@ -3792,6 +3804,21 @@ export declare const IncludeQuickSightQIndex: {
|
|
|
3792
3804
|
* @public
|
|
3793
3805
|
*/
|
|
3794
3806
|
export type IncludeQuickSightQIndex = (typeof IncludeQuickSightQIndex)[keyof typeof IncludeQuickSightQIndex];
|
|
3807
|
+
/**
|
|
3808
|
+
* @public
|
|
3809
|
+
* @enum
|
|
3810
|
+
*/
|
|
3811
|
+
export declare const SelfUpgradeRequestStatus: {
|
|
3812
|
+
readonly APPROVED: "APPROVED";
|
|
3813
|
+
readonly DENIED: "DENIED";
|
|
3814
|
+
readonly PENDING: "PENDING";
|
|
3815
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
3816
|
+
readonly VERIFY_FAILED: "VERIFY_FAILED";
|
|
3817
|
+
};
|
|
3818
|
+
/**
|
|
3819
|
+
* @public
|
|
3820
|
+
*/
|
|
3821
|
+
export type SelfUpgradeRequestStatus = (typeof SelfUpgradeRequestStatus)[keyof typeof SelfUpgradeRequestStatus];
|
|
3795
3822
|
/**
|
|
3796
3823
|
* @public
|
|
3797
3824
|
* @enum
|
|
@@ -3858,3 +3885,16 @@ export declare const TopicFilterOperator: {
|
|
|
3858
3885
|
* @public
|
|
3859
3886
|
*/
|
|
3860
3887
|
export type TopicFilterOperator = (typeof TopicFilterOperator)[keyof typeof TopicFilterOperator];
|
|
3888
|
+
/**
|
|
3889
|
+
* @public
|
|
3890
|
+
* @enum
|
|
3891
|
+
*/
|
|
3892
|
+
export declare const SelfUpgradeAdminAction: {
|
|
3893
|
+
readonly APPROVE: "APPROVE";
|
|
3894
|
+
readonly DENY: "DENY";
|
|
3895
|
+
readonly VERIFY: "VERIFY";
|
|
3896
|
+
};
|
|
3897
|
+
/**
|
|
3898
|
+
* @public
|
|
3899
|
+
*/
|
|
3900
|
+
export type SelfUpgradeAdminAction = (typeof SelfUpgradeAdminAction)[keyof typeof SelfUpgradeAdminAction];
|
|
@@ -325,6 +325,24 @@ export declare class InvalidNextTokenException extends __BaseException {
|
|
|
325
325
|
*/
|
|
326
326
|
constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
|
|
327
327
|
}
|
|
328
|
+
/**
|
|
329
|
+
* <p>One or more parameter has a value that isn't valid.</p>
|
|
330
|
+
* @public
|
|
331
|
+
*/
|
|
332
|
+
export declare class InvalidParameterException extends __BaseException {
|
|
333
|
+
readonly name: "InvalidParameterException";
|
|
334
|
+
readonly $fault: "client";
|
|
335
|
+
Message?: string | undefined;
|
|
336
|
+
/**
|
|
337
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
338
|
+
* @public
|
|
339
|
+
*/
|
|
340
|
+
RequestId?: string | undefined;
|
|
341
|
+
/**
|
|
342
|
+
* @internal
|
|
343
|
+
*/
|
|
344
|
+
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
|
|
345
|
+
}
|
|
328
346
|
/**
|
|
329
347
|
* <p>The domain specified isn't on the allow list. All domains for embedded dashboards must be
|
|
330
348
|
* added to the approved list by an Amazon Quick Suite admin.</p>
|
|
@@ -6022,6 +6022,11 @@ export interface Capabilities {
|
|
|
6022
6022
|
* @public
|
|
6023
6023
|
*/
|
|
6024
6024
|
Research?: CapabilityState | undefined;
|
|
6025
|
+
/**
|
|
6026
|
+
* <p>The ability to enable users to upgrade their user role.</p>
|
|
6027
|
+
* @public
|
|
6028
|
+
*/
|
|
6029
|
+
SelfUpgradeUserRole?: CapabilityState | undefined;
|
|
6025
6030
|
}
|
|
6026
6031
|
/**
|
|
6027
6032
|
* <p>A transform operation that casts a column to a different type.</p>
|