@aws-sdk/client-quicksight 3.326.0 → 3.328.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 +144 -0
- package/dist-cjs/QuickSight.js +36 -0
- package/dist-cjs/commands/CreateTopicCommand.js +46 -0
- package/dist-cjs/commands/CreateTopicRefreshScheduleCommand.js +45 -0
- package/dist-cjs/commands/CreateVPCConnectionCommand.js +45 -0
- package/dist-cjs/commands/DeleteTopicCommand.js +45 -0
- package/dist-cjs/commands/DeleteTopicRefreshScheduleCommand.js +45 -0
- package/dist-cjs/commands/DeleteVPCConnectionCommand.js +45 -0
- package/dist-cjs/commands/DescribeDataSetCommand.js +2 -2
- package/dist-cjs/commands/DescribeTemplateDefinitionCommand.js +2 -2
- package/dist-cjs/commands/DescribeTopicCommand.js +46 -0
- package/dist-cjs/commands/DescribeTopicPermissionsCommand.js +45 -0
- package/dist-cjs/commands/DescribeTopicRefreshCommand.js +45 -0
- package/dist-cjs/commands/DescribeTopicRefreshScheduleCommand.js +45 -0
- package/dist-cjs/commands/DescribeVPCConnectionCommand.js +45 -0
- package/dist-cjs/commands/ListTopicRefreshSchedulesCommand.js +45 -0
- package/dist-cjs/commands/ListTopicsCommand.js +45 -0
- package/dist-cjs/commands/ListVPCConnectionsCommand.js +45 -0
- package/dist-cjs/commands/UpdateTopicCommand.js +46 -0
- package/dist-cjs/commands/UpdateTopicPermissionsCommand.js +45 -0
- package/dist-cjs/commands/UpdateTopicRefreshScheduleCommand.js +45 -0
- package/dist-cjs/commands/UpdateVPCConnectionCommand.js +45 -0
- package/dist-cjs/commands/index.js +18 -0
- package/dist-cjs/models/models_0.js +1 -11
- package/dist-cjs/models/models_1.js +46 -50
- package/dist-cjs/models/models_2.js +262 -141
- package/dist-cjs/models/models_3.js +167 -1
- package/dist-cjs/pagination/ListTopicsPaginator.js +29 -0
- package/dist-cjs/pagination/ListVPCConnectionsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +2076 -307
- package/dist-es/QuickSight.js +36 -0
- package/dist-es/commands/CreateTopicCommand.js +42 -0
- package/dist-es/commands/CreateTopicRefreshScheduleCommand.js +41 -0
- package/dist-es/commands/CreateVPCConnectionCommand.js +41 -0
- package/dist-es/commands/DeleteTopicCommand.js +41 -0
- package/dist-es/commands/DeleteTopicRefreshScheduleCommand.js +41 -0
- package/dist-es/commands/DeleteVPCConnectionCommand.js +41 -0
- package/dist-es/commands/DescribeDataSetCommand.js +1 -1
- package/dist-es/commands/DescribeTemplateDefinitionCommand.js +1 -1
- package/dist-es/commands/DescribeTopicCommand.js +42 -0
- package/dist-es/commands/DescribeTopicPermissionsCommand.js +41 -0
- package/dist-es/commands/DescribeTopicRefreshCommand.js +41 -0
- package/dist-es/commands/DescribeTopicRefreshScheduleCommand.js +41 -0
- package/dist-es/commands/DescribeVPCConnectionCommand.js +41 -0
- package/dist-es/commands/ListTopicRefreshSchedulesCommand.js +41 -0
- package/dist-es/commands/ListTopicsCommand.js +41 -0
- package/dist-es/commands/ListVPCConnectionsCommand.js +41 -0
- package/dist-es/commands/UpdateTopicCommand.js +42 -0
- package/dist-es/commands/UpdateTopicPermissionsCommand.js +41 -0
- package/dist-es/commands/UpdateTopicRefreshScheduleCommand.js +41 -0
- package/dist-es/commands/UpdateVPCConnectionCommand.js +41 -0
- package/dist-es/commands/index.js +18 -0
- package/dist-es/models/models_0.js +0 -9
- package/dist-es/models/models_1.js +41 -43
- package/dist-es/models/models_2.js +242 -135
- package/dist-es/models/models_3.js +161 -1
- package/dist-es/pagination/ListTopicsPaginator.js +25 -0
- package/dist-es/pagination/ListVPCConnectionsPaginator.js +25 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +2030 -298
- package/dist-types/QuickSight.d.ts +126 -0
- package/dist-types/QuickSightClient.d.ts +20 -2
- package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/CreateAnalysisCommand.d.ts +56 -4
- package/dist-types/commands/CreateDashboardCommand.d.ts +56 -4
- package/dist-types/commands/CreateDataSetCommand.d.ts +63 -0
- package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +5 -4
- package/dist-types/commands/CreateTemplateCommand.d.ts +56 -4
- package/dist-types/commands/CreateTopicCommand.d.ts +352 -0
- package/dist-types/commands/CreateTopicRefreshScheduleCommand.d.ts +111 -0
- package/dist-types/commands/CreateVPCConnectionCommand.d.ts +122 -0
- package/dist-types/commands/DeleteTopicCommand.d.ts +94 -0
- package/dist-types/commands/DeleteTopicRefreshScheduleCommand.d.ts +102 -0
- package/dist-types/commands/DeleteVPCConnectionCommand.d.ts +102 -0
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +56 -4
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +56 -4
- package/dist-types/commands/DescribeDataSetCommand.d.ts +64 -1
- package/dist-types/commands/DescribeDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +3 -2
- package/dist-types/commands/DescribeIngestionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeNamespaceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +57 -5
- package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicCommand.d.ts +336 -0
- package/dist-types/commands/DescribeTopicPermissionsCommand.d.ts +99 -0
- package/dist-types/commands/DescribeTopicRefreshCommand.d.ts +95 -0
- package/dist-types/commands/DescribeTopicRefreshScheduleCommand.d.ts +110 -0
- package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/commands/DescribeVPCConnectionCommand.d.ts +121 -0
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +3 -0
- package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +3 -1
- package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +7 -3
- package/dist-types/commands/ListTopicRefreshSchedulesCommand.d.ts +115 -0
- package/dist-types/commands/ListTopicsCommand.d.ts +98 -0
- package/dist-types/commands/ListVPCConnectionsCommand.d.ts +126 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +56 -4
- package/dist-types/commands/UpdateDashboardCommand.d.ts +56 -4
- package/dist-types/commands/UpdateDataSetCommand.d.ts +63 -0
- package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +3 -4
- package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +4 -1
- package/dist-types/commands/UpdateTemplateCommand.d.ts +56 -4
- package/dist-types/commands/UpdateTopicCommand.d.ts +346 -0
- package/dist-types/commands/UpdateTopicPermissionsCommand.d.ts +127 -0
- package/dist-types/commands/UpdateTopicRefreshScheduleCommand.d.ts +110 -0
- package/dist-types/commands/UpdateVPCConnectionCommand.d.ts +116 -0
- package/dist-types/commands/index.d.ts +18 -0
- package/dist-types/models/models_0.d.ts +43 -91
- package/dist-types/models/models_1.d.ts +210 -281
- package/dist-types/models/models_2.d.ts +2375 -2163
- package/dist-types/models/models_3.d.ts +2468 -54
- package/dist-types/pagination/ListTopicsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListVPCConnectionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +162 -0
- package/dist-types/ts3.4/QuickSight.d.ts +306 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +110 -2
- package/dist-types/ts3.4/commands/CreateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateTopicCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/CreateTopicRefreshScheduleCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/CreateVPCConnectionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteTopicCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/DeleteTopicRefreshScheduleCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DeleteVPCConnectionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeDataSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeFolderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeFolderResolvedPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeGroupMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIngestionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeNamespaceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplateDefinitionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DescribeTopicPermissionsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeTopicRefreshCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeTopicRefreshScheduleCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeVPCConnectionCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListTopicRefreshSchedulesCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListTopicsCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/ListVPCConnectionsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateTopicCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/UpdateTopicPermissionsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateTopicRefreshScheduleCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateVPCConnectionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +18 -0
- package/dist-types/ts3.4/models/models_0.d.ts +12 -22
- package/dist-types/ts3.4/models/models_1.d.ts +79 -75
- package/dist-types/ts3.4/models/models_2.d.ts +605 -500
- package/dist-types/ts3.4/models/models_3.d.ts +737 -9
- package/dist-types/ts3.4/pagination/ListTopicsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListVPCConnectionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +216 -0
- package/package.json +8 -8
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DescribeTopicPermissionsRequest, DescribeTopicPermissionsResponse } from "../models/models_3";
|
|
5
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link DescribeTopicPermissionsCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface DescribeTopicPermissionsCommandInput extends DescribeTopicPermissionsRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link DescribeTopicPermissionsCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface DescribeTopicPermissionsCommandOutput extends DescribeTopicPermissionsResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Describes the permissions of a topic.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { QuickSightClient, DescribeTopicPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
27
|
+
* // const { QuickSightClient, DescribeTopicPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
28
|
+
* const client = new QuickSightClient(config);
|
|
29
|
+
* const input = { // DescribeTopicPermissionsRequest
|
|
30
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
31
|
+
* TopicId: "STRING_VALUE", // required
|
|
32
|
+
* };
|
|
33
|
+
* const command = new DescribeTopicPermissionsCommand(input);
|
|
34
|
+
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeTopicPermissionsResponse
|
|
36
|
+
* // TopicId: "STRING_VALUE",
|
|
37
|
+
* // TopicArn: "STRING_VALUE",
|
|
38
|
+
* // Permissions: [ // ResourcePermissionList
|
|
39
|
+
* // { // ResourcePermission
|
|
40
|
+
* // Principal: "STRING_VALUE", // required
|
|
41
|
+
* // Actions: [ // ActionList // required
|
|
42
|
+
* // "STRING_VALUE",
|
|
43
|
+
* // ],
|
|
44
|
+
* // },
|
|
45
|
+
* // ],
|
|
46
|
+
* // Status: Number("int"),
|
|
47
|
+
* // RequestId: "STRING_VALUE",
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param DescribeTopicPermissionsCommandInput - {@link DescribeTopicPermissionsCommandInput}
|
|
53
|
+
* @returns {@link DescribeTopicPermissionsCommandOutput}
|
|
54
|
+
* @see {@link DescribeTopicPermissionsCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link DescribeTopicPermissionsCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
60
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
61
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
62
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
65
|
+
* <p>An internal failure occurred.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
68
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
71
|
+
* <p>One or more resources can't be found.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
74
|
+
* <p>Access is throttled.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link QuickSightServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
78
|
+
*
|
|
79
|
+
*/
|
|
80
|
+
export declare class DescribeTopicPermissionsCommand extends $Command<DescribeTopicPermissionsCommandInput, DescribeTopicPermissionsCommandOutput, QuickSightClientResolvedConfig> {
|
|
81
|
+
readonly input: DescribeTopicPermissionsCommandInput;
|
|
82
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
83
|
+
/**
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
constructor(input: DescribeTopicPermissionsCommandInput);
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeTopicPermissionsCommandInput, DescribeTopicPermissionsCommandOutput>;
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
*/
|
|
94
|
+
private serialize;
|
|
95
|
+
/**
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
private deserialize;
|
|
99
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DescribeTopicRefreshRequest, DescribeTopicRefreshResponse } from "../models/models_3";
|
|
5
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link DescribeTopicRefreshCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface DescribeTopicRefreshCommandInput extends DescribeTopicRefreshRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link DescribeTopicRefreshCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface DescribeTopicRefreshCommandOutput extends DescribeTopicRefreshResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Describes the status of a topic refresh.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { QuickSightClient, DescribeTopicRefreshCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
27
|
+
* // const { QuickSightClient, DescribeTopicRefreshCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
28
|
+
* const client = new QuickSightClient(config);
|
|
29
|
+
* const input = { // DescribeTopicRefreshRequest
|
|
30
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
31
|
+
* TopicId: "STRING_VALUE", // required
|
|
32
|
+
* RefreshId: "STRING_VALUE", // required
|
|
33
|
+
* };
|
|
34
|
+
* const command = new DescribeTopicRefreshCommand(input);
|
|
35
|
+
* const response = await client.send(command);
|
|
36
|
+
* // { // DescribeTopicRefreshResponse
|
|
37
|
+
* // RefreshDetails: { // TopicRefreshDetails
|
|
38
|
+
* // RefreshArn: "STRING_VALUE",
|
|
39
|
+
* // RefreshId: "STRING_VALUE",
|
|
40
|
+
* // RefreshStatus: "INITIALIZED" || "RUNNING" || "FAILED" || "COMPLETED" || "CANCELLED",
|
|
41
|
+
* // },
|
|
42
|
+
* // RequestId: "STRING_VALUE",
|
|
43
|
+
* // Status: Number("int"),
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DescribeTopicRefreshCommandInput - {@link DescribeTopicRefreshCommandInput}
|
|
49
|
+
* @returns {@link DescribeTopicRefreshCommandOutput}
|
|
50
|
+
* @see {@link DescribeTopicRefreshCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DescribeTopicRefreshCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
55
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
56
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
57
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
58
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
61
|
+
* <p>An internal failure occurred.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
64
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
+
* <p>One or more resources can't be found.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
+
* <p>Access is throttled.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link QuickSightServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
74
|
+
*
|
|
75
|
+
*/
|
|
76
|
+
export declare class DescribeTopicRefreshCommand extends $Command<DescribeTopicRefreshCommandInput, DescribeTopicRefreshCommandOutput, QuickSightClientResolvedConfig> {
|
|
77
|
+
readonly input: DescribeTopicRefreshCommandInput;
|
|
78
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
79
|
+
/**
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
constructor(input: DescribeTopicRefreshCommandInput);
|
|
83
|
+
/**
|
|
84
|
+
* @internal
|
|
85
|
+
*/
|
|
86
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeTopicRefreshCommandInput, DescribeTopicRefreshCommandOutput>;
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
private serialize;
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
*/
|
|
94
|
+
private deserialize;
|
|
95
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DescribeTopicRefreshScheduleRequest, DescribeTopicRefreshScheduleResponse } from "../models/models_3";
|
|
5
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link DescribeTopicRefreshScheduleCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface DescribeTopicRefreshScheduleCommandInput extends DescribeTopicRefreshScheduleRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link DescribeTopicRefreshScheduleCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface DescribeTopicRefreshScheduleCommandOutput extends DescribeTopicRefreshScheduleResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Deletes a topic refresh schedule.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { QuickSightClient, DescribeTopicRefreshScheduleCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
27
|
+
* // const { QuickSightClient, DescribeTopicRefreshScheduleCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
28
|
+
* const client = new QuickSightClient(config);
|
|
29
|
+
* const input = { // DescribeTopicRefreshScheduleRequest
|
|
30
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
31
|
+
* TopicId: "STRING_VALUE", // required
|
|
32
|
+
* DatasetId: "STRING_VALUE", // required
|
|
33
|
+
* };
|
|
34
|
+
* const command = new DescribeTopicRefreshScheduleCommand(input);
|
|
35
|
+
* const response = await client.send(command);
|
|
36
|
+
* // { // DescribeTopicRefreshScheduleResponse
|
|
37
|
+
* // TopicId: "STRING_VALUE",
|
|
38
|
+
* // TopicArn: "STRING_VALUE",
|
|
39
|
+
* // DatasetArn: "STRING_VALUE",
|
|
40
|
+
* // RefreshSchedule: { // TopicRefreshSchedule
|
|
41
|
+
* // IsEnabled: true || false, // required
|
|
42
|
+
* // BasedOnSpiceSchedule: true || false, // required
|
|
43
|
+
* // StartingAt: new Date("TIMESTAMP"),
|
|
44
|
+
* // Timezone: "STRING_VALUE",
|
|
45
|
+
* // RepeatAt: "STRING_VALUE",
|
|
46
|
+
* // TopicScheduleType: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY",
|
|
47
|
+
* // },
|
|
48
|
+
* // Status: Number("int"),
|
|
49
|
+
* // RequestId: "STRING_VALUE",
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param DescribeTopicRefreshScheduleCommandInput - {@link DescribeTopicRefreshScheduleCommandInput}
|
|
55
|
+
* @returns {@link DescribeTopicRefreshScheduleCommandOutput}
|
|
56
|
+
* @see {@link DescribeTopicRefreshScheduleCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link DescribeTopicRefreshScheduleCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
61
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
62
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
63
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
64
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ConflictException} (client fault)
|
|
67
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
70
|
+
* <p>An internal failure occurred.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
73
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
76
|
+
* <p>A limit is exceeded.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceExistsException} (client fault)
|
|
79
|
+
* <p>The resource specified already exists. </p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
82
|
+
* <p>One or more resources can't be found.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
85
|
+
* <p>Access is throttled.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link QuickSightServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
89
|
+
*
|
|
90
|
+
*/
|
|
91
|
+
export declare class DescribeTopicRefreshScheduleCommand extends $Command<DescribeTopicRefreshScheduleCommandInput, DescribeTopicRefreshScheduleCommandOutput, QuickSightClientResolvedConfig> {
|
|
92
|
+
readonly input: DescribeTopicRefreshScheduleCommandInput;
|
|
93
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
constructor(input: DescribeTopicRefreshScheduleCommandInput);
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeTopicRefreshScheduleCommandInput, DescribeTopicRefreshScheduleCommandOutput>;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
private serialize;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
private deserialize;
|
|
110
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
-
import { DescribeUserRequest, DescribeUserResponse } from "../models/
|
|
4
|
+
import { DescribeUserRequest, DescribeUserResponse } from "../models/models_3";
|
|
5
5
|
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
6
|
/**
|
|
7
7
|
* @public
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DescribeVPCConnectionRequest, DescribeVPCConnectionResponse } from "../models/models_3";
|
|
5
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link DescribeVPCConnectionCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface DescribeVPCConnectionCommandInput extends DescribeVPCConnectionRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link DescribeVPCConnectionCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface DescribeVPCConnectionCommandOutput extends DescribeVPCConnectionResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Describes a VPC connection.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { QuickSightClient, DescribeVPCConnectionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
27
|
+
* // const { QuickSightClient, DescribeVPCConnectionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
28
|
+
* const client = new QuickSightClient(config);
|
|
29
|
+
* const input = { // DescribeVPCConnectionRequest
|
|
30
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
31
|
+
* VPCConnectionId: "STRING_VALUE", // required
|
|
32
|
+
* };
|
|
33
|
+
* const command = new DescribeVPCConnectionCommand(input);
|
|
34
|
+
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeVPCConnectionResponse
|
|
36
|
+
* // VPCConnection: { // VPCConnection
|
|
37
|
+
* // VPCConnectionId: "STRING_VALUE",
|
|
38
|
+
* // Arn: "STRING_VALUE",
|
|
39
|
+
* // Name: "STRING_VALUE",
|
|
40
|
+
* // VPCId: "STRING_VALUE",
|
|
41
|
+
* // SecurityGroupIds: [ // SecurityGroupIdList
|
|
42
|
+
* // "STRING_VALUE",
|
|
43
|
+
* // ],
|
|
44
|
+
* // DnsResolvers: [ // StringList
|
|
45
|
+
* // "STRING_VALUE",
|
|
46
|
+
* // ],
|
|
47
|
+
* // Status: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETION_IN_PROGRESS" || "DELETION_FAILED" || "DELETED",
|
|
48
|
+
* // AvailabilityStatus: "AVAILABLE" || "UNAVAILABLE" || "PARTIALLY_AVAILABLE",
|
|
49
|
+
* // NetworkInterfaces: [ // NetworkInterfaceList
|
|
50
|
+
* // { // NetworkInterface
|
|
51
|
+
* // SubnetId: "STRING_VALUE",
|
|
52
|
+
* // AvailabilityZone: "STRING_VALUE",
|
|
53
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
54
|
+
* // Status: "CREATING" || "AVAILABLE" || "CREATION_FAILED" || "UPDATING" || "UPDATE_FAILED" || "DELETING" || "DELETED" || "DELETION_FAILED" || "DELETION_SCHEDULED" || "ATTACHMENT_FAILED_ROLLBACK_FAILED",
|
|
55
|
+
* // NetworkInterfaceId: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // RoleArn: "STRING_VALUE",
|
|
59
|
+
* // CreatedTime: new Date("TIMESTAMP"),
|
|
60
|
+
* // LastUpdatedTime: new Date("TIMESTAMP"),
|
|
61
|
+
* // },
|
|
62
|
+
* // RequestId: "STRING_VALUE",
|
|
63
|
+
* // Status: Number("int"),
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param DescribeVPCConnectionCommandInput - {@link DescribeVPCConnectionCommandInput}
|
|
69
|
+
* @returns {@link DescribeVPCConnectionCommandOutput}
|
|
70
|
+
* @see {@link DescribeVPCConnectionCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link DescribeVPCConnectionCommandOutput} 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 QuickSight 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 InvalidParameterValueException} (client fault)
|
|
84
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
87
|
+
* <p>One or more resources can't be found.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
90
|
+
* <p>Access is throttled.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
93
|
+
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
94
|
+
* subscription where the edition doesn't include support for that operation. Amazon
|
|
95
|
+
* Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
96
|
+
* capability is available in every edition.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link QuickSightServiceException}
|
|
99
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
100
|
+
*
|
|
101
|
+
*/
|
|
102
|
+
export declare class DescribeVPCConnectionCommand extends $Command<DescribeVPCConnectionCommandInput, DescribeVPCConnectionCommandOutput, QuickSightClientResolvedConfig> {
|
|
103
|
+
readonly input: DescribeVPCConnectionCommandInput;
|
|
104
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
105
|
+
/**
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
constructor(input: DescribeVPCConnectionCommandInput);
|
|
109
|
+
/**
|
|
110
|
+
* @internal
|
|
111
|
+
*/
|
|
112
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeVPCConnectionCommandInput, DescribeVPCConnectionCommandOutput>;
|
|
113
|
+
/**
|
|
114
|
+
* @internal
|
|
115
|
+
*/
|
|
116
|
+
private serialize;
|
|
117
|
+
/**
|
|
118
|
+
* @internal
|
|
119
|
+
*/
|
|
120
|
+
private deserialize;
|
|
121
|
+
}
|
|
@@ -57,6 +57,9 @@ export interface GenerateEmbedUrlForRegisteredUserCommandOutput extends Generate
|
|
|
57
57
|
* StatePersistence: { // StatePersistenceConfigurations
|
|
58
58
|
* Enabled: true || false, // required
|
|
59
59
|
* },
|
|
60
|
+
* Bookmarks: { // BookmarksConfigurations
|
|
61
|
+
* Enabled: true || false, // required
|
|
62
|
+
* },
|
|
60
63
|
* },
|
|
61
64
|
* },
|
|
62
65
|
* QuickSightConsole: { // RegisteredUserQuickSightConsoleEmbeddingConfiguration
|
|
@@ -19,7 +19,9 @@ export interface ListIAMPolicyAssignmentsCommandOutput extends ListIAMPolicyAssi
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Lists
|
|
22
|
+
* <p>Lists the
|
|
23
|
+
* IAM policy assignments in the current Amazon QuickSight
|
|
24
|
+
* account.</p>
|
|
23
25
|
* @example
|
|
24
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
27
|
* ```javascript
|
|
@@ -19,9 +19,13 @@ export interface ListIAMPolicyAssignmentsForUserCommandOutput extends ListIAMPol
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Lists all
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>Lists all of
|
|
23
|
+
* the IAM policy assignments, including the Amazon
|
|
24
|
+
* Resource Names
|
|
25
|
+
* (ARNs),
|
|
26
|
+
* for the IAM policies assigned to the specified user and
|
|
27
|
+
* group,
|
|
28
|
+
* or groups that the user belongs to.</p>
|
|
25
29
|
* @example
|
|
26
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
31
|
* ```javascript
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { ListTopicRefreshSchedulesRequest, ListTopicRefreshSchedulesResponse } from "../models/models_3";
|
|
5
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link ListTopicRefreshSchedulesCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface ListTopicRefreshSchedulesCommandInput extends ListTopicRefreshSchedulesRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link ListTopicRefreshSchedulesCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface ListTopicRefreshSchedulesCommandOutput extends ListTopicRefreshSchedulesResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Lists all of the refresh schedules for a topic.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { QuickSightClient, ListTopicRefreshSchedulesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
27
|
+
* // const { QuickSightClient, ListTopicRefreshSchedulesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
28
|
+
* const client = new QuickSightClient(config);
|
|
29
|
+
* const input = { // ListTopicRefreshSchedulesRequest
|
|
30
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
31
|
+
* TopicId: "STRING_VALUE", // required
|
|
32
|
+
* };
|
|
33
|
+
* const command = new ListTopicRefreshSchedulesCommand(input);
|
|
34
|
+
* const response = await client.send(command);
|
|
35
|
+
* // { // ListTopicRefreshSchedulesResponse
|
|
36
|
+
* // TopicId: "STRING_VALUE",
|
|
37
|
+
* // TopicArn: "STRING_VALUE",
|
|
38
|
+
* // RefreshSchedules: [ // TopicRefreshScheduleSummaries
|
|
39
|
+
* // { // TopicRefreshScheduleSummary
|
|
40
|
+
* // DatasetId: "STRING_VALUE",
|
|
41
|
+
* // DatasetArn: "STRING_VALUE",
|
|
42
|
+
* // DatasetName: "STRING_VALUE",
|
|
43
|
+
* // RefreshSchedule: { // TopicRefreshSchedule
|
|
44
|
+
* // IsEnabled: true || false, // required
|
|
45
|
+
* // BasedOnSpiceSchedule: true || false, // required
|
|
46
|
+
* // StartingAt: new Date("TIMESTAMP"),
|
|
47
|
+
* // Timezone: "STRING_VALUE",
|
|
48
|
+
* // RepeatAt: "STRING_VALUE",
|
|
49
|
+
* // TopicScheduleType: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY",
|
|
50
|
+
* // },
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // Status: Number("int"),
|
|
54
|
+
* // RequestId: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param ListTopicRefreshSchedulesCommandInput - {@link ListTopicRefreshSchedulesCommandInput}
|
|
60
|
+
* @returns {@link ListTopicRefreshSchedulesCommandOutput}
|
|
61
|
+
* @see {@link ListTopicRefreshSchedulesCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link ListTopicRefreshSchedulesCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
67
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
68
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
69
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ConflictException} (client fault)
|
|
72
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
75
|
+
* <p>An internal failure occurred.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
78
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
81
|
+
* <p>A limit is exceeded.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceExistsException} (client fault)
|
|
84
|
+
* <p>The resource specified already exists. </p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
87
|
+
* <p>One or more resources can't be found.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
90
|
+
* <p>Access is throttled.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link QuickSightServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
94
|
+
*
|
|
95
|
+
*/
|
|
96
|
+
export declare class ListTopicRefreshSchedulesCommand extends $Command<ListTopicRefreshSchedulesCommandInput, ListTopicRefreshSchedulesCommandOutput, QuickSightClientResolvedConfig> {
|
|
97
|
+
readonly input: ListTopicRefreshSchedulesCommandInput;
|
|
98
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
99
|
+
/**
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
constructor(input: ListTopicRefreshSchedulesCommandInput);
|
|
103
|
+
/**
|
|
104
|
+
* @internal
|
|
105
|
+
*/
|
|
106
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTopicRefreshSchedulesCommandInput, ListTopicRefreshSchedulesCommandOutput>;
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
private serialize;
|
|
111
|
+
/**
|
|
112
|
+
* @internal
|
|
113
|
+
*/
|
|
114
|
+
private deserialize;
|
|
115
|
+
}
|