@aws-sdk/client-quicksight 3.693.0 → 3.699.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 +24 -0
- package/dist-cjs/index.js +1697 -691
- package/dist-es/QuickSight.js +6 -0
- package/dist-es/commands/BatchCreateTopicReviewedAnswerCommand.js +1 -1
- package/dist-es/commands/CreateAnalysisCommand.js +1 -1
- package/dist-es/commands/CreateDashboardCommand.js +1 -1
- package/dist-es/commands/DescribeAnalysisCommand.js +2 -1
- package/dist-es/commands/DescribeAssetBundleExportJobCommand.js +1 -1
- package/dist-es/commands/DescribeAssetBundleImportJobCommand.js +1 -1
- package/dist-es/commands/DescribeDashboardCommand.js +2 -1
- package/dist-es/commands/DescribeDashboardDefinitionCommand.js +1 -1
- package/dist-es/commands/DescribeDashboardSnapshotJobCommand.js +1 -1
- package/dist-es/commands/DescribeDashboardSnapshotJobResultCommand.js +1 -1
- package/dist-es/commands/DescribeDashboardsQAConfigurationCommand.js +22 -0
- package/dist-es/commands/DescribeDataSetCommand.js +1 -1
- package/dist-es/commands/DescribeTemplateCommand.js +2 -1
- package/dist-es/commands/ListTopicReviewedAnswersCommand.js +1 -1
- package/dist-es/commands/SearchTopicsCommand.js +22 -0
- package/dist-es/commands/UpdateDashboardsQAConfigurationCommand.js +22 -0
- package/dist-es/commands/UpdateDataSourceCommand.js +1 -1
- package/dist-es/commands/UpdateTemplateCommand.js +1 -1
- package/dist-es/commands/UpdateTopicCommand.js +1 -1
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +72 -82
- package/dist-es/models/models_1.js +102 -132
- package/dist-es/models/models_2.js +136 -193
- package/dist-es/models/models_3.js +205 -112
- package/dist-es/models/models_4.js +139 -33
- package/dist-es/models/models_5.js +33 -0
- package/dist-es/pagination/SearchTopicsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +787 -6
- package/dist-types/QuickSight.d.ts +21 -0
- package/dist-types/QuickSightClient.d.ts +5 -2
- package/dist-types/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
- 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 +434 -5
- package/dist-types/commands/CreateBrandCommand.d.ts +1 -1
- package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/CreateDashboardCommand.d.ts +434 -5
- package/dist-types/commands/CreateTemplateCommand.d.ts +433 -4
- package/dist-types/commands/CreateTopicCommand.d.ts +3 -0
- package/dist-types/commands/DescribeAnalysisCommand.d.ts +79 -0
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +433 -4
- package/dist-types/commands/DescribeAssetBundleExportJobCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBrandCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBrandPublishedVersionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardCommand.d.ts +80 -1
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +434 -5
- package/dist-types/commands/DescribeDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardsQAConfigurationCommand.d.ts +94 -0
- package/dist-types/commands/DescribeDataSetCommand.d.ts +1 -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 +1 -1
- package/dist-types/commands/DescribeIngestionCommand.d.ts +1 -2
- package/dist-types/commands/DescribeNamespaceCommand.d.ts +2 -0
- package/dist-types/commands/DescribeTemplateCommand.d.ts +79 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +433 -4
- package/dist-types/commands/ListNamespacesCommand.d.ts +2 -0
- package/dist-types/commands/ListTopicReviewedAnswersCommand.d.ts +2 -1
- package/dist-types/commands/SearchTopicsCommand.d.ts +111 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +433 -4
- package/dist-types/commands/UpdateDashboardCommand.d.ts +433 -4
- package/dist-types/commands/UpdateDashboardsQAConfigurationCommand.d.ts +95 -0
- package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIdentityPropagationConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateKeyRegistrationCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQPersonalizationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSPICECapacityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplateCommand.d.ts +434 -5
- package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemeCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTopicCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +487 -546
- package/dist-types/models/models_1.d.ts +1748 -1766
- package/dist-types/models/models_2.d.ts +4412 -4505
- package/dist-types/models/models_3.d.ts +4167 -4334
- package/dist-types/models/models_4.d.ts +3983 -3777
- package/dist-types/models/models_5.d.ts +1726 -0
- package/dist-types/pagination/SearchTopicsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/QuickSight.d.ts +57 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
- 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/CreateAnalysisCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateBrandCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAssetBundleExportJobCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeAssetBundleImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeBrandCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeBrandPublishedVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardDefinitionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDashboardsQAConfigurationCommand.d.ts +51 -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 +4 -2
- package/dist-types/ts3.4/commands/ListTopicReviewedAnswersCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchTopicsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateDashboardsQAConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateDataSetPermissionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFolderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIdentityPropagationConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateKeyRegistrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQPersonalizationConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSPICECapacityConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTemplateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateThemeAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateThemePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTopicCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserCustomPermissionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +142 -156
- package/dist-types/ts3.4/models/models_1.d.ts +324 -356
- package/dist-types/ts3.4/models/models_2.d.ts +427 -418
- package/dist-types/ts3.4/models/models_3.d.ts +435 -488
- package/dist-types/ts3.4/models/models_4.d.ts +1184 -1046
- package/dist-types/ts3.4/models/models_5.d.ts +422 -0
- package/dist-types/ts3.4/pagination/SearchTopicsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +35 -35
|
@@ -0,0 +1,1726 @@
|
|
|
1
|
+
import { ResourceStatus } from "./models_0";
|
|
2
|
+
import { AssignmentStatus, DataSourceParameters, ServiceType, SslProperties, TopicIR, TopicTemplate, VisualRole, VpcConnectionProperties } from "./models_2";
|
|
3
|
+
import { DataSourceCredentials, Group, RefreshSchedule, ResourcePermission, Role, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, ValidationStrategy, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
|
|
4
|
+
import { FailedKeyRegistrationEntry, PersonalizationMode, PurchaseMode, RegisteredCustomerManagedKey, User, UserRole } from "./models_4";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface UpdateDataSetPermissionsResponse {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
DataSetArn?: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The ID for the dataset whose permissions you want to update. This ID is unique per
|
|
16
|
+
* Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
DataSetId?: string | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
RequestId?: string | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* <p>The HTTP status of the request.</p>
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
Status?: number | undefined;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
export interface UpdateDataSourceRequest {
|
|
35
|
+
/**
|
|
36
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
AwsAccountId: string | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
DataSourceId: string | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* <p>A display name for the data source.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
Name: string | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>The parameters that Amazon QuickSight uses to connect to your underlying source.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
DataSourceParameters?: DataSourceParameters | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* <p>The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,
|
|
57
|
+
* only credentials based on user name and password are supported.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
Credentials?: DataSourceCredentials | undefined;
|
|
61
|
+
/**
|
|
62
|
+
* <p>Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to
|
|
63
|
+
* your underlying source.</p>
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
VpcConnectionProperties?: VpcConnectionProperties | undefined;
|
|
67
|
+
/**
|
|
68
|
+
* <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying
|
|
69
|
+
* source.</p>
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
SslProperties?: SslProperties | undefined;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
export interface UpdateDataSourceResponse {
|
|
78
|
+
/**
|
|
79
|
+
* <p>The Amazon Resource Name (ARN) of the data source.</p>
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
Arn?: string | undefined;
|
|
83
|
+
/**
|
|
84
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
DataSourceId?: string | undefined;
|
|
88
|
+
/**
|
|
89
|
+
* <p>The update status of the data source's last update.</p>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
UpdateStatus?: ResourceStatus | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
RequestId?: string | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* <p>The HTTP status of the request.</p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
Status?: number | undefined;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export interface UpdateDataSourcePermissionsRequest {
|
|
108
|
+
/**
|
|
109
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
AwsAccountId: string | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
DataSourceId: string | undefined;
|
|
118
|
+
/**
|
|
119
|
+
* <p>A list of resource permissions that you want to grant on the data source.</p>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
GrantPermissions?: ResourcePermission[] | undefined;
|
|
123
|
+
/**
|
|
124
|
+
* <p>A list of resource permissions that you want to revoke on the data source.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
RevokePermissions?: ResourcePermission[] | undefined;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export interface UpdateDataSourcePermissionsResponse {
|
|
133
|
+
/**
|
|
134
|
+
* <p>The Amazon Resource Name (ARN) of the data source.</p>
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
DataSourceArn?: string | undefined;
|
|
138
|
+
/**
|
|
139
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
DataSourceId?: string | undefined;
|
|
143
|
+
/**
|
|
144
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
RequestId?: string | undefined;
|
|
148
|
+
/**
|
|
149
|
+
* <p>The HTTP status of the request.</p>
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
Status?: number | undefined;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
export interface UpdateFolderRequest {
|
|
158
|
+
/**
|
|
159
|
+
* <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
|
|
160
|
+
* @public
|
|
161
|
+
*/
|
|
162
|
+
AwsAccountId: string | undefined;
|
|
163
|
+
/**
|
|
164
|
+
* <p>The ID of the folder.</p>
|
|
165
|
+
* @public
|
|
166
|
+
*/
|
|
167
|
+
FolderId: string | undefined;
|
|
168
|
+
/**
|
|
169
|
+
* <p>The name of the folder.</p>
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
Name: string | undefined;
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
export interface UpdateFolderResponse {
|
|
178
|
+
/**
|
|
179
|
+
* <p>The HTTP status of the request.</p>
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
Status?: number | undefined;
|
|
183
|
+
/**
|
|
184
|
+
* <p>The Amazon Resource Name (ARN) of the folder.</p>
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
Arn?: string | undefined;
|
|
188
|
+
/**
|
|
189
|
+
* <p>The ID of the folder.</p>
|
|
190
|
+
* @public
|
|
191
|
+
*/
|
|
192
|
+
FolderId?: string | undefined;
|
|
193
|
+
/**
|
|
194
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
RequestId?: string | undefined;
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
export interface UpdateFolderPermissionsRequest {
|
|
203
|
+
/**
|
|
204
|
+
* <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
AwsAccountId: string | undefined;
|
|
208
|
+
/**
|
|
209
|
+
* <p>The ID of the folder.</p>
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
FolderId: string | undefined;
|
|
213
|
+
/**
|
|
214
|
+
* <p>The permissions that you want to grant on a resource. Namespace ARNs are not supported <code>Principal</code> values for folder permissions.</p>
|
|
215
|
+
* @public
|
|
216
|
+
*/
|
|
217
|
+
GrantPermissions?: ResourcePermission[] | undefined;
|
|
218
|
+
/**
|
|
219
|
+
* <p>The permissions that you want to revoke from a resource. Namespace ARNs are not supported <code>Principal</code> values for folder permissions.</p>
|
|
220
|
+
* @public
|
|
221
|
+
*/
|
|
222
|
+
RevokePermissions?: ResourcePermission[] | undefined;
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
export interface UpdateFolderPermissionsResponse {
|
|
228
|
+
/**
|
|
229
|
+
* <p>The HTTP status of the request.</p>
|
|
230
|
+
* @public
|
|
231
|
+
*/
|
|
232
|
+
Status?: number | undefined;
|
|
233
|
+
/**
|
|
234
|
+
* <p>The Amazon Resource Name (ARN) of the folder.</p>
|
|
235
|
+
* @public
|
|
236
|
+
*/
|
|
237
|
+
Arn?: string | undefined;
|
|
238
|
+
/**
|
|
239
|
+
* <p>The ID of the folder.</p>
|
|
240
|
+
* @public
|
|
241
|
+
*/
|
|
242
|
+
FolderId?: string | undefined;
|
|
243
|
+
/**
|
|
244
|
+
* <p>Information about the permissions for the folder.</p>
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
248
|
+
/**
|
|
249
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
RequestId?: string | undefined;
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
export interface UpdateGroupRequest {
|
|
258
|
+
/**
|
|
259
|
+
* <p>The name of the group that you want to update.</p>
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
262
|
+
GroupName: string | undefined;
|
|
263
|
+
/**
|
|
264
|
+
* <p>The description for the group that you want to update.</p>
|
|
265
|
+
* @public
|
|
266
|
+
*/
|
|
267
|
+
Description?: string | undefined;
|
|
268
|
+
/**
|
|
269
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
270
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
AwsAccountId: string | undefined;
|
|
274
|
+
/**
|
|
275
|
+
* <p>The namespace of the group that you want to update.</p>
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
Namespace: string | undefined;
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
export interface UpdateGroupResponse {
|
|
284
|
+
/**
|
|
285
|
+
* <p>The name of the group.</p>
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
Group?: Group | undefined;
|
|
289
|
+
/**
|
|
290
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
RequestId?: string | undefined;
|
|
294
|
+
/**
|
|
295
|
+
* <p>The HTTP status of the request.</p>
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
Status?: number | undefined;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* @public
|
|
302
|
+
*/
|
|
303
|
+
export interface UpdateIAMPolicyAssignmentRequest {
|
|
304
|
+
/**
|
|
305
|
+
* <p>The ID of the Amazon Web Services account that contains the IAM policy
|
|
306
|
+
* assignment. </p>
|
|
307
|
+
* @public
|
|
308
|
+
*/
|
|
309
|
+
AwsAccountId: string | undefined;
|
|
310
|
+
/**
|
|
311
|
+
* <p>The name of the assignment, also called a rule.
|
|
312
|
+
* The
|
|
313
|
+
* name must be unique within the
|
|
314
|
+
* Amazon Web Services account.</p>
|
|
315
|
+
* @public
|
|
316
|
+
*/
|
|
317
|
+
AssignmentName: string | undefined;
|
|
318
|
+
/**
|
|
319
|
+
* <p>The namespace of the assignment.</p>
|
|
320
|
+
* @public
|
|
321
|
+
*/
|
|
322
|
+
Namespace: string | undefined;
|
|
323
|
+
/**
|
|
324
|
+
* <p>The status of the assignment. Possible values are as follows:</p>
|
|
325
|
+
* <ul>
|
|
326
|
+
* <li>
|
|
327
|
+
* <p>
|
|
328
|
+
* <code>ENABLED</code> - Anything specified in this assignment is used when
|
|
329
|
+
* creating the data source.</p>
|
|
330
|
+
* </li>
|
|
331
|
+
* <li>
|
|
332
|
+
* <p>
|
|
333
|
+
* <code>DISABLED</code> - This assignment isn't used when creating the data
|
|
334
|
+
* source.</p>
|
|
335
|
+
* </li>
|
|
336
|
+
* <li>
|
|
337
|
+
* <p>
|
|
338
|
+
* <code>DRAFT</code> - This assignment is an unfinished draft and isn't used
|
|
339
|
+
* when creating the data source.</p>
|
|
340
|
+
* </li>
|
|
341
|
+
* </ul>
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
AssignmentStatus?: AssignmentStatus | undefined;
|
|
345
|
+
/**
|
|
346
|
+
* <p>The ARN for the IAM policy to apply to the Amazon QuickSight users and
|
|
347
|
+
* groups specified in this assignment.</p>
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
PolicyArn?: string | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* <p>The Amazon QuickSight users, groups, or both that you want to assign the policy
|
|
353
|
+
* to.</p>
|
|
354
|
+
* @public
|
|
355
|
+
*/
|
|
356
|
+
Identities?: Record<string, string[]> | undefined;
|
|
357
|
+
}
|
|
358
|
+
/**
|
|
359
|
+
* @public
|
|
360
|
+
*/
|
|
361
|
+
export interface UpdateIAMPolicyAssignmentResponse {
|
|
362
|
+
/**
|
|
363
|
+
* <p>The name of the assignment or rule.</p>
|
|
364
|
+
* @public
|
|
365
|
+
*/
|
|
366
|
+
AssignmentName?: string | undefined;
|
|
367
|
+
/**
|
|
368
|
+
* <p>The ID of the assignment.</p>
|
|
369
|
+
* @public
|
|
370
|
+
*/
|
|
371
|
+
AssignmentId?: string | undefined;
|
|
372
|
+
/**
|
|
373
|
+
* <p>The ARN for the IAM policy applied to the Amazon QuickSight users and
|
|
374
|
+
* groups specified in this assignment.</p>
|
|
375
|
+
* @public
|
|
376
|
+
*/
|
|
377
|
+
PolicyArn?: string | undefined;
|
|
378
|
+
/**
|
|
379
|
+
* <p>The Amazon QuickSight users, groups, or both that the IAM policy is
|
|
380
|
+
* assigned to.</p>
|
|
381
|
+
* @public
|
|
382
|
+
*/
|
|
383
|
+
Identities?: Record<string, string[]> | undefined;
|
|
384
|
+
/**
|
|
385
|
+
* <p>The status of the assignment. Possible values are as follows:</p>
|
|
386
|
+
* <ul>
|
|
387
|
+
* <li>
|
|
388
|
+
* <p>
|
|
389
|
+
* <code>ENABLED</code> - Anything specified in this assignment is used when
|
|
390
|
+
* creating the data source.</p>
|
|
391
|
+
* </li>
|
|
392
|
+
* <li>
|
|
393
|
+
* <p>
|
|
394
|
+
* <code>DISABLED</code> - This assignment isn't used when creating the data
|
|
395
|
+
* source.</p>
|
|
396
|
+
* </li>
|
|
397
|
+
* <li>
|
|
398
|
+
* <p>
|
|
399
|
+
* <code>DRAFT</code> - This assignment is an unfinished draft and isn't used
|
|
400
|
+
* when creating the data source.</p>
|
|
401
|
+
* </li>
|
|
402
|
+
* </ul>
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
405
|
+
AssignmentStatus?: AssignmentStatus | undefined;
|
|
406
|
+
/**
|
|
407
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
RequestId?: string | undefined;
|
|
411
|
+
/**
|
|
412
|
+
* <p>The HTTP status of the request.</p>
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
Status?: number | undefined;
|
|
416
|
+
}
|
|
417
|
+
/**
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
export interface UpdateIdentityPropagationConfigRequest {
|
|
421
|
+
/**
|
|
422
|
+
* <p>The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.</p>
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
AwsAccountId: string | undefined;
|
|
426
|
+
/**
|
|
427
|
+
* <p>The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.</p>
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
Service: ServiceType | undefined;
|
|
431
|
+
/**
|
|
432
|
+
* <p>Specifies a list of application ARNs that represent the authorized targets for a service.</p>
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
AuthorizedTargets?: string[] | undefined;
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
export interface UpdateIdentityPropagationConfigResponse {
|
|
441
|
+
/**
|
|
442
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
RequestId?: string | undefined;
|
|
446
|
+
/**
|
|
447
|
+
* <p>The HTTP status of the request.</p>
|
|
448
|
+
* @public
|
|
449
|
+
*/
|
|
450
|
+
Status?: number | undefined;
|
|
451
|
+
}
|
|
452
|
+
/**
|
|
453
|
+
* @public
|
|
454
|
+
*/
|
|
455
|
+
export interface UpdateIpRestrictionRequest {
|
|
456
|
+
/**
|
|
457
|
+
* <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
|
|
458
|
+
* @public
|
|
459
|
+
*/
|
|
460
|
+
AwsAccountId: string | undefined;
|
|
461
|
+
/**
|
|
462
|
+
* <p>A map that describes the updated IP rules with CIDR ranges and descriptions.</p>
|
|
463
|
+
* @public
|
|
464
|
+
*/
|
|
465
|
+
IpRestrictionRuleMap?: Record<string, string> | undefined;
|
|
466
|
+
/**
|
|
467
|
+
* <p>A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.</p>
|
|
468
|
+
* @public
|
|
469
|
+
*/
|
|
470
|
+
VpcIdRestrictionRuleMap?: Record<string, string> | undefined;
|
|
471
|
+
/**
|
|
472
|
+
* <p>A map of allowed VPC endpoint IDs and their corresponding rule descriptions.</p>
|
|
473
|
+
* @public
|
|
474
|
+
*/
|
|
475
|
+
VpcEndpointIdRestrictionRuleMap?: Record<string, string> | undefined;
|
|
476
|
+
/**
|
|
477
|
+
* <p>A value that specifies whether IP rules are turned on.</p>
|
|
478
|
+
* @public
|
|
479
|
+
*/
|
|
480
|
+
Enabled?: boolean | undefined;
|
|
481
|
+
}
|
|
482
|
+
/**
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
export interface UpdateIpRestrictionResponse {
|
|
486
|
+
/**
|
|
487
|
+
* <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
|
|
488
|
+
* @public
|
|
489
|
+
*/
|
|
490
|
+
AwsAccountId?: string | undefined;
|
|
491
|
+
/**
|
|
492
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
493
|
+
* @public
|
|
494
|
+
*/
|
|
495
|
+
RequestId?: string | undefined;
|
|
496
|
+
/**
|
|
497
|
+
* <p>The HTTP status of the request. </p>
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
Status?: number | undefined;
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
export interface UpdateKeyRegistrationRequest {
|
|
506
|
+
/**
|
|
507
|
+
* <p>The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.</p>
|
|
508
|
+
* @public
|
|
509
|
+
*/
|
|
510
|
+
AwsAccountId: string | undefined;
|
|
511
|
+
/**
|
|
512
|
+
* <p>A list of <code>RegisteredCustomerManagedKey</code> objects to be updated to the Amazon QuickSight account.</p>
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
KeyRegistration: RegisteredCustomerManagedKey[] | undefined;
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* <p>A success entry that occurs when a <code>KeyRegistration</code> job is successfully applied to the Amazon QuickSight account.</p>
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
export interface SuccessfulKeyRegistrationEntry {
|
|
522
|
+
/**
|
|
523
|
+
* <p>The ARN of the KMS key that is associated with the <code>SuccessfulKeyRegistrationEntry</code> entry.</p>
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
526
|
+
KeyArn: string | undefined;
|
|
527
|
+
/**
|
|
528
|
+
* <p>The HTTP status of a <code>SuccessfulKeyRegistrationEntry</code> entry.</p>
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
StatusCode: number | undefined;
|
|
532
|
+
}
|
|
533
|
+
/**
|
|
534
|
+
* @public
|
|
535
|
+
*/
|
|
536
|
+
export interface UpdateKeyRegistrationResponse {
|
|
537
|
+
/**
|
|
538
|
+
* <p>A list of all customer managed key registrations that failed to update.</p>
|
|
539
|
+
* @public
|
|
540
|
+
*/
|
|
541
|
+
FailedKeyRegistration?: FailedKeyRegistrationEntry[] | undefined;
|
|
542
|
+
/**
|
|
543
|
+
* <p>A list of all customer managed key registrations that were successfully updated.</p>
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
546
|
+
SuccessfulKeyRegistration?: SuccessfulKeyRegistrationEntry[] | undefined;
|
|
547
|
+
/**
|
|
548
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
RequestId?: string | undefined;
|
|
552
|
+
}
|
|
553
|
+
/**
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
export interface UpdatePublicSharingSettingsRequest {
|
|
557
|
+
/**
|
|
558
|
+
* <p>The Amazon Web Services account ID associated with your Amazon QuickSight subscription.</p>
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
AwsAccountId: string | undefined;
|
|
562
|
+
/**
|
|
563
|
+
* <p>A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.</p>
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
PublicSharingEnabled?: boolean | undefined;
|
|
567
|
+
}
|
|
568
|
+
/**
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
export interface UpdatePublicSharingSettingsResponse {
|
|
572
|
+
/**
|
|
573
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
RequestId?: string | undefined;
|
|
577
|
+
/**
|
|
578
|
+
* <p>The HTTP status of the request.</p>
|
|
579
|
+
* @public
|
|
580
|
+
*/
|
|
581
|
+
Status?: number | undefined;
|
|
582
|
+
}
|
|
583
|
+
/**
|
|
584
|
+
* @public
|
|
585
|
+
*/
|
|
586
|
+
export interface UpdateQPersonalizationConfigurationRequest {
|
|
587
|
+
/**
|
|
588
|
+
* <p>The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.</p>
|
|
589
|
+
* @public
|
|
590
|
+
*/
|
|
591
|
+
AwsAccountId: string | undefined;
|
|
592
|
+
/**
|
|
593
|
+
* <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>
|
|
594
|
+
* @public
|
|
595
|
+
*/
|
|
596
|
+
PersonalizationMode: PersonalizationMode | undefined;
|
|
597
|
+
}
|
|
598
|
+
/**
|
|
599
|
+
* @public
|
|
600
|
+
*/
|
|
601
|
+
export interface UpdateQPersonalizationConfigurationResponse {
|
|
602
|
+
/**
|
|
603
|
+
* <p>The personalization mode that is used for the personalization configuration.</p>
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
PersonalizationMode?: PersonalizationMode | undefined;
|
|
607
|
+
/**
|
|
608
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
609
|
+
* @public
|
|
610
|
+
*/
|
|
611
|
+
RequestId?: string | undefined;
|
|
612
|
+
/**
|
|
613
|
+
* <p>The HTTP status of the request.</p>
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
Status?: number | undefined;
|
|
617
|
+
}
|
|
618
|
+
/**
|
|
619
|
+
* @public
|
|
620
|
+
*/
|
|
621
|
+
export interface UpdateRefreshScheduleRequest {
|
|
622
|
+
/**
|
|
623
|
+
* <p>The ID of the dataset.</p>
|
|
624
|
+
* @public
|
|
625
|
+
*/
|
|
626
|
+
DataSetId: string | undefined;
|
|
627
|
+
/**
|
|
628
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
629
|
+
* @public
|
|
630
|
+
*/
|
|
631
|
+
AwsAccountId: string | undefined;
|
|
632
|
+
/**
|
|
633
|
+
* <p>The refresh schedule.</p>
|
|
634
|
+
* @public
|
|
635
|
+
*/
|
|
636
|
+
Schedule: RefreshSchedule | undefined;
|
|
637
|
+
}
|
|
638
|
+
/**
|
|
639
|
+
* @public
|
|
640
|
+
*/
|
|
641
|
+
export interface UpdateRefreshScheduleResponse {
|
|
642
|
+
/**
|
|
643
|
+
* <p>The HTTP status of the request.</p>
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
Status?: number | undefined;
|
|
647
|
+
/**
|
|
648
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
649
|
+
* @public
|
|
650
|
+
*/
|
|
651
|
+
RequestId?: string | undefined;
|
|
652
|
+
/**
|
|
653
|
+
* <p>The ID of the refresh schedule.</p>
|
|
654
|
+
* @public
|
|
655
|
+
*/
|
|
656
|
+
ScheduleId?: string | undefined;
|
|
657
|
+
/**
|
|
658
|
+
* <p>The Amazon Resource Name (ARN) for the refresh schedule.</p>
|
|
659
|
+
* @public
|
|
660
|
+
*/
|
|
661
|
+
Arn?: string | undefined;
|
|
662
|
+
}
|
|
663
|
+
/**
|
|
664
|
+
* @public
|
|
665
|
+
*/
|
|
666
|
+
export interface UpdateRoleCustomPermissionRequest {
|
|
667
|
+
/**
|
|
668
|
+
* <p>The name of the custom permission that you want to update the role with.</p>
|
|
669
|
+
* @public
|
|
670
|
+
*/
|
|
671
|
+
CustomPermissionsName: string | undefined;
|
|
672
|
+
/**
|
|
673
|
+
* <p>The name of role tht you want to update.</p>
|
|
674
|
+
* @public
|
|
675
|
+
*/
|
|
676
|
+
Role: Role | undefined;
|
|
677
|
+
/**
|
|
678
|
+
* <p>The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
679
|
+
* @public
|
|
680
|
+
*/
|
|
681
|
+
AwsAccountId: string | undefined;
|
|
682
|
+
/**
|
|
683
|
+
* <p>The namespace that contains the role that you want to update.</p>
|
|
684
|
+
* @public
|
|
685
|
+
*/
|
|
686
|
+
Namespace: string | undefined;
|
|
687
|
+
}
|
|
688
|
+
/**
|
|
689
|
+
* @public
|
|
690
|
+
*/
|
|
691
|
+
export interface UpdateRoleCustomPermissionResponse {
|
|
692
|
+
/**
|
|
693
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
694
|
+
* @public
|
|
695
|
+
*/
|
|
696
|
+
RequestId?: string | undefined;
|
|
697
|
+
/**
|
|
698
|
+
* <p>The HTTP status of the request.</p>
|
|
699
|
+
* @public
|
|
700
|
+
*/
|
|
701
|
+
Status?: number | undefined;
|
|
702
|
+
}
|
|
703
|
+
/**
|
|
704
|
+
* @public
|
|
705
|
+
*/
|
|
706
|
+
export interface UpdateSPICECapacityConfigurationRequest {
|
|
707
|
+
/**
|
|
708
|
+
* <p>The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.</p>
|
|
709
|
+
* @public
|
|
710
|
+
*/
|
|
711
|
+
AwsAccountId: string | undefined;
|
|
712
|
+
/**
|
|
713
|
+
* <p>Determines how SPICE capacity can be purchased. The following options are available. </p>
|
|
714
|
+
* <ul>
|
|
715
|
+
* <li>
|
|
716
|
+
* <p>
|
|
717
|
+
* <code>MANUAL</code>: SPICE capacity can only be purchased manually.</p>
|
|
718
|
+
* </li>
|
|
719
|
+
* <li>
|
|
720
|
+
* <p>
|
|
721
|
+
* <code>AUTO_PURCHASE</code>: Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.</p>
|
|
722
|
+
* </li>
|
|
723
|
+
* </ul>
|
|
724
|
+
* @public
|
|
725
|
+
*/
|
|
726
|
+
PurchaseMode: PurchaseMode | undefined;
|
|
727
|
+
}
|
|
728
|
+
/**
|
|
729
|
+
* @public
|
|
730
|
+
*/
|
|
731
|
+
export interface UpdateSPICECapacityConfigurationResponse {
|
|
732
|
+
/**
|
|
733
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
RequestId?: string | undefined;
|
|
737
|
+
/**
|
|
738
|
+
* <p>The HTTP status of the request.</p>
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
Status?: number | undefined;
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
* @public
|
|
745
|
+
*/
|
|
746
|
+
export interface UpdateTemplateRequest {
|
|
747
|
+
/**
|
|
748
|
+
* <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
|
|
749
|
+
* @public
|
|
750
|
+
*/
|
|
751
|
+
AwsAccountId: string | undefined;
|
|
752
|
+
/**
|
|
753
|
+
* <p>The ID for the template.</p>
|
|
754
|
+
* @public
|
|
755
|
+
*/
|
|
756
|
+
TemplateId: string | undefined;
|
|
757
|
+
/**
|
|
758
|
+
* <p>The entity that you are using as a source when you update the template. In
|
|
759
|
+
* <code>SourceEntity</code>, you specify the type of object you're using as source:
|
|
760
|
+
* <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an
|
|
761
|
+
* analysis. Both of these require an Amazon Resource Name (ARN). For
|
|
762
|
+
* <code>SourceTemplate</code>, specify the ARN of the source template. For
|
|
763
|
+
* <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>
|
|
764
|
+
* ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
|
|
765
|
+
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or
|
|
766
|
+
* <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed
|
|
767
|
+
* in the original. The schema in each dataset must match its placeholder. </p>
|
|
768
|
+
* @public
|
|
769
|
+
*/
|
|
770
|
+
SourceEntity?: TemplateSourceEntity | undefined;
|
|
771
|
+
/**
|
|
772
|
+
* <p>A description of the current template version that is being updated. Every time you call
|
|
773
|
+
* <code>UpdateTemplate</code>, you create a new version of the template. Each version
|
|
774
|
+
* of the template maintains a description of the version in the
|
|
775
|
+
* <code>VersionDescription</code> field.</p>
|
|
776
|
+
* @public
|
|
777
|
+
*/
|
|
778
|
+
VersionDescription?: string | undefined;
|
|
779
|
+
/**
|
|
780
|
+
* <p>The name for the template.</p>
|
|
781
|
+
* @public
|
|
782
|
+
*/
|
|
783
|
+
Name?: string | undefined;
|
|
784
|
+
/**
|
|
785
|
+
* <p>The definition of a template.</p>
|
|
786
|
+
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
Definition?: TemplateVersionDefinition | undefined;
|
|
790
|
+
/**
|
|
791
|
+
* <p>The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.</p>
|
|
792
|
+
* @public
|
|
793
|
+
*/
|
|
794
|
+
ValidationStrategy?: ValidationStrategy | undefined;
|
|
795
|
+
}
|
|
796
|
+
/**
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
export interface UpdateTemplateResponse {
|
|
800
|
+
/**
|
|
801
|
+
* <p>The ID for the template.</p>
|
|
802
|
+
* @public
|
|
803
|
+
*/
|
|
804
|
+
TemplateId?: string | undefined;
|
|
805
|
+
/**
|
|
806
|
+
* <p>The Amazon Resource Name (ARN) for the template.</p>
|
|
807
|
+
* @public
|
|
808
|
+
*/
|
|
809
|
+
Arn?: string | undefined;
|
|
810
|
+
/**
|
|
811
|
+
* <p>The ARN for the template, including the version information of the first version.</p>
|
|
812
|
+
* @public
|
|
813
|
+
*/
|
|
814
|
+
VersionArn?: string | undefined;
|
|
815
|
+
/**
|
|
816
|
+
* <p>The creation status of the template.</p>
|
|
817
|
+
* @public
|
|
818
|
+
*/
|
|
819
|
+
CreationStatus?: ResourceStatus | undefined;
|
|
820
|
+
/**
|
|
821
|
+
* <p>The HTTP status of the request.</p>
|
|
822
|
+
* @public
|
|
823
|
+
*/
|
|
824
|
+
Status?: number | undefined;
|
|
825
|
+
/**
|
|
826
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
827
|
+
* @public
|
|
828
|
+
*/
|
|
829
|
+
RequestId?: string | undefined;
|
|
830
|
+
}
|
|
831
|
+
/**
|
|
832
|
+
* @public
|
|
833
|
+
*/
|
|
834
|
+
export interface UpdateTemplateAliasRequest {
|
|
835
|
+
/**
|
|
836
|
+
* <p>The ID of the Amazon Web Services account that contains the template alias that you're updating.</p>
|
|
837
|
+
* @public
|
|
838
|
+
*/
|
|
839
|
+
AwsAccountId: string | undefined;
|
|
840
|
+
/**
|
|
841
|
+
* <p>The ID for the template.</p>
|
|
842
|
+
* @public
|
|
843
|
+
*/
|
|
844
|
+
TemplateId: string | undefined;
|
|
845
|
+
/**
|
|
846
|
+
* <p>The alias of the template that you want to update. If you name a specific alias, you update
|
|
847
|
+
* the version that the alias points to. You can specify the latest version of the template
|
|
848
|
+
* by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter.
|
|
849
|
+
* The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
|
|
850
|
+
* @public
|
|
851
|
+
*/
|
|
852
|
+
AliasName: string | undefined;
|
|
853
|
+
/**
|
|
854
|
+
* <p>The version number of the template.</p>
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
TemplateVersionNumber: number | undefined;
|
|
858
|
+
}
|
|
859
|
+
/**
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
export interface UpdateTemplateAliasResponse {
|
|
863
|
+
/**
|
|
864
|
+
* <p>The template alias.</p>
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
TemplateAlias?: TemplateAlias | undefined;
|
|
868
|
+
/**
|
|
869
|
+
* <p>The HTTP status of the request.</p>
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
Status?: number | undefined;
|
|
873
|
+
/**
|
|
874
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
RequestId?: string | undefined;
|
|
878
|
+
}
|
|
879
|
+
/**
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
export interface UpdateTemplatePermissionsRequest {
|
|
883
|
+
/**
|
|
884
|
+
* <p>The ID of the Amazon Web Services account that contains the template.</p>
|
|
885
|
+
* @public
|
|
886
|
+
*/
|
|
887
|
+
AwsAccountId: string | undefined;
|
|
888
|
+
/**
|
|
889
|
+
* <p>The ID for the template.</p>
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
892
|
+
TemplateId: string | undefined;
|
|
893
|
+
/**
|
|
894
|
+
* <p>A list of resource permissions to be granted on the template. </p>
|
|
895
|
+
* @public
|
|
896
|
+
*/
|
|
897
|
+
GrantPermissions?: ResourcePermission[] | undefined;
|
|
898
|
+
/**
|
|
899
|
+
* <p>A list of resource permissions to be revoked from the template. </p>
|
|
900
|
+
* @public
|
|
901
|
+
*/
|
|
902
|
+
RevokePermissions?: ResourcePermission[] | undefined;
|
|
903
|
+
}
|
|
904
|
+
/**
|
|
905
|
+
* @public
|
|
906
|
+
*/
|
|
907
|
+
export interface UpdateTemplatePermissionsResponse {
|
|
908
|
+
/**
|
|
909
|
+
* <p>The ID for the template.</p>
|
|
910
|
+
* @public
|
|
911
|
+
*/
|
|
912
|
+
TemplateId?: string | undefined;
|
|
913
|
+
/**
|
|
914
|
+
* <p>The Amazon Resource Name (ARN) of the template.</p>
|
|
915
|
+
* @public
|
|
916
|
+
*/
|
|
917
|
+
TemplateArn?: string | undefined;
|
|
918
|
+
/**
|
|
919
|
+
* <p>A list of resource permissions to be set on the template.</p>
|
|
920
|
+
* @public
|
|
921
|
+
*/
|
|
922
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
923
|
+
/**
|
|
924
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
925
|
+
* @public
|
|
926
|
+
*/
|
|
927
|
+
RequestId?: string | undefined;
|
|
928
|
+
/**
|
|
929
|
+
* <p>The HTTP status of the request.</p>
|
|
930
|
+
* @public
|
|
931
|
+
*/
|
|
932
|
+
Status?: number | undefined;
|
|
933
|
+
}
|
|
934
|
+
/**
|
|
935
|
+
* @public
|
|
936
|
+
*/
|
|
937
|
+
export interface UpdateThemeRequest {
|
|
938
|
+
/**
|
|
939
|
+
* <p>The ID of the Amazon Web Services account that contains the theme that you're updating.</p>
|
|
940
|
+
* @public
|
|
941
|
+
*/
|
|
942
|
+
AwsAccountId: string | undefined;
|
|
943
|
+
/**
|
|
944
|
+
* <p>The ID for the theme.</p>
|
|
945
|
+
* @public
|
|
946
|
+
*/
|
|
947
|
+
ThemeId: string | undefined;
|
|
948
|
+
/**
|
|
949
|
+
* <p>The name for the theme.</p>
|
|
950
|
+
* @public
|
|
951
|
+
*/
|
|
952
|
+
Name?: string | undefined;
|
|
953
|
+
/**
|
|
954
|
+
* <p>The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.
|
|
955
|
+
* All themes initially inherit from a default Amazon QuickSight theme.</p>
|
|
956
|
+
* @public
|
|
957
|
+
*/
|
|
958
|
+
BaseThemeId: string | undefined;
|
|
959
|
+
/**
|
|
960
|
+
* <p>A description of the theme version that you're updating Every time that you call
|
|
961
|
+
* <code>UpdateTheme</code>, you create a new version of the theme. Each version of the
|
|
962
|
+
* theme maintains a description of the version in <code>VersionDescription</code>.</p>
|
|
963
|
+
* @public
|
|
964
|
+
*/
|
|
965
|
+
VersionDescription?: string | undefined;
|
|
966
|
+
/**
|
|
967
|
+
* <p>The theme configuration, which contains the theme display properties.</p>
|
|
968
|
+
* @public
|
|
969
|
+
*/
|
|
970
|
+
Configuration?: ThemeConfiguration | undefined;
|
|
971
|
+
}
|
|
972
|
+
/**
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
export interface UpdateThemeResponse {
|
|
976
|
+
/**
|
|
977
|
+
* <p>The ID for the theme.</p>
|
|
978
|
+
* @public
|
|
979
|
+
*/
|
|
980
|
+
ThemeId?: string | undefined;
|
|
981
|
+
/**
|
|
982
|
+
* <p>The Amazon Resource Name (ARN) for the theme.</p>
|
|
983
|
+
* @public
|
|
984
|
+
*/
|
|
985
|
+
Arn?: string | undefined;
|
|
986
|
+
/**
|
|
987
|
+
* <p>The Amazon Resource Name (ARN) for the new version of the theme.</p>
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
990
|
+
VersionArn?: string | undefined;
|
|
991
|
+
/**
|
|
992
|
+
* <p>The creation status of the theme.</p>
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
CreationStatus?: ResourceStatus | undefined;
|
|
996
|
+
/**
|
|
997
|
+
* <p>The HTTP status of the request.</p>
|
|
998
|
+
* @public
|
|
999
|
+
*/
|
|
1000
|
+
Status?: number | undefined;
|
|
1001
|
+
/**
|
|
1002
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1003
|
+
* @public
|
|
1004
|
+
*/
|
|
1005
|
+
RequestId?: string | undefined;
|
|
1006
|
+
}
|
|
1007
|
+
/**
|
|
1008
|
+
* @public
|
|
1009
|
+
*/
|
|
1010
|
+
export interface UpdateThemeAliasRequest {
|
|
1011
|
+
/**
|
|
1012
|
+
* <p>The ID of the Amazon Web Services account that contains the theme alias that you're updating.</p>
|
|
1013
|
+
* @public
|
|
1014
|
+
*/
|
|
1015
|
+
AwsAccountId: string | undefined;
|
|
1016
|
+
/**
|
|
1017
|
+
* <p>The ID for the theme.</p>
|
|
1018
|
+
* @public
|
|
1019
|
+
*/
|
|
1020
|
+
ThemeId: string | undefined;
|
|
1021
|
+
/**
|
|
1022
|
+
* <p>The name of the theme alias that you want to update.</p>
|
|
1023
|
+
* @public
|
|
1024
|
+
*/
|
|
1025
|
+
AliasName: string | undefined;
|
|
1026
|
+
/**
|
|
1027
|
+
* <p>The version number of the theme that the alias should reference.</p>
|
|
1028
|
+
* @public
|
|
1029
|
+
*/
|
|
1030
|
+
ThemeVersionNumber: number | undefined;
|
|
1031
|
+
}
|
|
1032
|
+
/**
|
|
1033
|
+
* @public
|
|
1034
|
+
*/
|
|
1035
|
+
export interface UpdateThemeAliasResponse {
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>Information about the theme alias.</p>
|
|
1038
|
+
* @public
|
|
1039
|
+
*/
|
|
1040
|
+
ThemeAlias?: ThemeAlias | undefined;
|
|
1041
|
+
/**
|
|
1042
|
+
* <p>The HTTP status of the request.</p>
|
|
1043
|
+
* @public
|
|
1044
|
+
*/
|
|
1045
|
+
Status?: number | undefined;
|
|
1046
|
+
/**
|
|
1047
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
RequestId?: string | undefined;
|
|
1051
|
+
}
|
|
1052
|
+
/**
|
|
1053
|
+
* @public
|
|
1054
|
+
*/
|
|
1055
|
+
export interface UpdateThemePermissionsRequest {
|
|
1056
|
+
/**
|
|
1057
|
+
* <p>The ID of the Amazon Web Services account that contains the theme.</p>
|
|
1058
|
+
* @public
|
|
1059
|
+
*/
|
|
1060
|
+
AwsAccountId: string | undefined;
|
|
1061
|
+
/**
|
|
1062
|
+
* <p>The ID for the theme.</p>
|
|
1063
|
+
* @public
|
|
1064
|
+
*/
|
|
1065
|
+
ThemeId: string | undefined;
|
|
1066
|
+
/**
|
|
1067
|
+
* <p>A list of resource permissions to be granted for the theme.</p>
|
|
1068
|
+
* @public
|
|
1069
|
+
*/
|
|
1070
|
+
GrantPermissions?: ResourcePermission[] | undefined;
|
|
1071
|
+
/**
|
|
1072
|
+
* <p>A list of resource permissions to be revoked from the theme.</p>
|
|
1073
|
+
* @public
|
|
1074
|
+
*/
|
|
1075
|
+
RevokePermissions?: ResourcePermission[] | undefined;
|
|
1076
|
+
}
|
|
1077
|
+
/**
|
|
1078
|
+
* @public
|
|
1079
|
+
*/
|
|
1080
|
+
export interface UpdateThemePermissionsResponse {
|
|
1081
|
+
/**
|
|
1082
|
+
* <p>The ID for the theme.</p>
|
|
1083
|
+
* @public
|
|
1084
|
+
*/
|
|
1085
|
+
ThemeId?: string | undefined;
|
|
1086
|
+
/**
|
|
1087
|
+
* <p>The Amazon Resource Name (ARN) of the theme.</p>
|
|
1088
|
+
* @public
|
|
1089
|
+
*/
|
|
1090
|
+
ThemeArn?: string | undefined;
|
|
1091
|
+
/**
|
|
1092
|
+
* <p>The resulting list of resource permissions for the theme.</p>
|
|
1093
|
+
* @public
|
|
1094
|
+
*/
|
|
1095
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
1096
|
+
/**
|
|
1097
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1098
|
+
* @public
|
|
1099
|
+
*/
|
|
1100
|
+
RequestId?: string | undefined;
|
|
1101
|
+
/**
|
|
1102
|
+
* <p>The HTTP status of the request.</p>
|
|
1103
|
+
* @public
|
|
1104
|
+
*/
|
|
1105
|
+
Status?: number | undefined;
|
|
1106
|
+
}
|
|
1107
|
+
/**
|
|
1108
|
+
* @public
|
|
1109
|
+
*/
|
|
1110
|
+
export interface UpdateTopicRequest {
|
|
1111
|
+
/**
|
|
1112
|
+
* <p>The ID of the Amazon Web Services account that contains the topic that you want to
|
|
1113
|
+
* update.</p>
|
|
1114
|
+
* @public
|
|
1115
|
+
*/
|
|
1116
|
+
AwsAccountId: string | undefined;
|
|
1117
|
+
/**
|
|
1118
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1119
|
+
* @public
|
|
1120
|
+
*/
|
|
1121
|
+
TopicId: string | undefined;
|
|
1122
|
+
/**
|
|
1123
|
+
* <p>The definition of the topic that you want to update.</p>
|
|
1124
|
+
* @public
|
|
1125
|
+
*/
|
|
1126
|
+
Topic: TopicDetails | undefined;
|
|
1127
|
+
}
|
|
1128
|
+
/**
|
|
1129
|
+
* @public
|
|
1130
|
+
*/
|
|
1131
|
+
export interface UpdateTopicResponse {
|
|
1132
|
+
/**
|
|
1133
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1134
|
+
* @public
|
|
1135
|
+
*/
|
|
1136
|
+
TopicId?: string | undefined;
|
|
1137
|
+
/**
|
|
1138
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
1139
|
+
* @public
|
|
1140
|
+
*/
|
|
1141
|
+
Arn?: string | undefined;
|
|
1142
|
+
/**
|
|
1143
|
+
* <p>The Amazon Resource Name (ARN) of the topic refresh.</p>
|
|
1144
|
+
* @public
|
|
1145
|
+
*/
|
|
1146
|
+
RefreshArn?: string | undefined;
|
|
1147
|
+
/**
|
|
1148
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1149
|
+
* @public
|
|
1150
|
+
*/
|
|
1151
|
+
RequestId?: string | undefined;
|
|
1152
|
+
/**
|
|
1153
|
+
* <p>The HTTP status of the request.</p>
|
|
1154
|
+
* @public
|
|
1155
|
+
*/
|
|
1156
|
+
Status?: number | undefined;
|
|
1157
|
+
}
|
|
1158
|
+
/**
|
|
1159
|
+
* @public
|
|
1160
|
+
*/
|
|
1161
|
+
export interface UpdateTopicPermissionsRequest {
|
|
1162
|
+
/**
|
|
1163
|
+
* <p>The ID of the Amazon Web Services account that contains the topic that you want to update
|
|
1164
|
+
* the permissions for.</p>
|
|
1165
|
+
* @public
|
|
1166
|
+
*/
|
|
1167
|
+
AwsAccountId: string | undefined;
|
|
1168
|
+
/**
|
|
1169
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1170
|
+
* @public
|
|
1171
|
+
*/
|
|
1172
|
+
TopicId: string | undefined;
|
|
1173
|
+
/**
|
|
1174
|
+
* <p>The resource permissions that you want to grant to the topic.</p>
|
|
1175
|
+
* @public
|
|
1176
|
+
*/
|
|
1177
|
+
GrantPermissions?: ResourcePermission[] | undefined;
|
|
1178
|
+
/**
|
|
1179
|
+
* <p>The resource permissions that you want to revoke from the topic.</p>
|
|
1180
|
+
* @public
|
|
1181
|
+
*/
|
|
1182
|
+
RevokePermissions?: ResourcePermission[] | undefined;
|
|
1183
|
+
}
|
|
1184
|
+
/**
|
|
1185
|
+
* @public
|
|
1186
|
+
*/
|
|
1187
|
+
export interface UpdateTopicPermissionsResponse {
|
|
1188
|
+
/**
|
|
1189
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1190
|
+
* @public
|
|
1191
|
+
*/
|
|
1192
|
+
TopicId?: string | undefined;
|
|
1193
|
+
/**
|
|
1194
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
1195
|
+
* @public
|
|
1196
|
+
*/
|
|
1197
|
+
TopicArn?: string | undefined;
|
|
1198
|
+
/**
|
|
1199
|
+
* <p>A list of resource permissions on the topic.</p>
|
|
1200
|
+
* @public
|
|
1201
|
+
*/
|
|
1202
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
1203
|
+
/**
|
|
1204
|
+
* <p>The HTTP status of the request.</p>
|
|
1205
|
+
* @public
|
|
1206
|
+
*/
|
|
1207
|
+
Status?: number | undefined;
|
|
1208
|
+
/**
|
|
1209
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1210
|
+
* @public
|
|
1211
|
+
*/
|
|
1212
|
+
RequestId?: string | undefined;
|
|
1213
|
+
}
|
|
1214
|
+
/**
|
|
1215
|
+
* @public
|
|
1216
|
+
*/
|
|
1217
|
+
export interface UpdateTopicRefreshScheduleRequest {
|
|
1218
|
+
/**
|
|
1219
|
+
* <p>The ID of the Amazon Web Services account that contains the topic whose refresh schedule
|
|
1220
|
+
* you want to update.</p>
|
|
1221
|
+
* @public
|
|
1222
|
+
*/
|
|
1223
|
+
AwsAccountId: string | undefined;
|
|
1224
|
+
/**
|
|
1225
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1226
|
+
* @public
|
|
1227
|
+
*/
|
|
1228
|
+
TopicId: string | undefined;
|
|
1229
|
+
/**
|
|
1230
|
+
* <p>The ID of the dataset.</p>
|
|
1231
|
+
* @public
|
|
1232
|
+
*/
|
|
1233
|
+
DatasetId: string | undefined;
|
|
1234
|
+
/**
|
|
1235
|
+
* <p>The definition of a refresh schedule.</p>
|
|
1236
|
+
* @public
|
|
1237
|
+
*/
|
|
1238
|
+
RefreshSchedule: TopicRefreshSchedule | undefined;
|
|
1239
|
+
}
|
|
1240
|
+
/**
|
|
1241
|
+
* @public
|
|
1242
|
+
*/
|
|
1243
|
+
export interface UpdateTopicRefreshScheduleResponse {
|
|
1244
|
+
/**
|
|
1245
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1246
|
+
* @public
|
|
1247
|
+
*/
|
|
1248
|
+
TopicId?: string | undefined;
|
|
1249
|
+
/**
|
|
1250
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
1251
|
+
* @public
|
|
1252
|
+
*/
|
|
1253
|
+
TopicArn?: string | undefined;
|
|
1254
|
+
/**
|
|
1255
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
1256
|
+
* @public
|
|
1257
|
+
*/
|
|
1258
|
+
DatasetArn?: string | undefined;
|
|
1259
|
+
/**
|
|
1260
|
+
* <p>The HTTP status of the request.</p>
|
|
1261
|
+
* @public
|
|
1262
|
+
*/
|
|
1263
|
+
Status?: number | undefined;
|
|
1264
|
+
/**
|
|
1265
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
RequestId?: string | undefined;
|
|
1269
|
+
}
|
|
1270
|
+
/**
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
export interface UpdateUserRequest {
|
|
1274
|
+
/**
|
|
1275
|
+
* <p>The Amazon QuickSight user name that you want to update.</p>
|
|
1276
|
+
* @public
|
|
1277
|
+
*/
|
|
1278
|
+
UserName: string | undefined;
|
|
1279
|
+
/**
|
|
1280
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
1281
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
1282
|
+
* @public
|
|
1283
|
+
*/
|
|
1284
|
+
AwsAccountId: string | undefined;
|
|
1285
|
+
/**
|
|
1286
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
1287
|
+
* @public
|
|
1288
|
+
*/
|
|
1289
|
+
Namespace: string | undefined;
|
|
1290
|
+
/**
|
|
1291
|
+
* <p>The email address of the user that you want to update.</p>
|
|
1292
|
+
* @public
|
|
1293
|
+
*/
|
|
1294
|
+
Email: string | undefined;
|
|
1295
|
+
/**
|
|
1296
|
+
* <p>The Amazon QuickSight role of the user. The role can be one of the
|
|
1297
|
+
* following default security cohorts:</p>
|
|
1298
|
+
* <ul>
|
|
1299
|
+
* <li>
|
|
1300
|
+
* <p>
|
|
1301
|
+
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
1302
|
+
* </li>
|
|
1303
|
+
* <li>
|
|
1304
|
+
* <p>
|
|
1305
|
+
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and
|
|
1306
|
+
* dashboards.</p>
|
|
1307
|
+
* </li>
|
|
1308
|
+
* <li>
|
|
1309
|
+
* <p>
|
|
1310
|
+
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight
|
|
1311
|
+
* settings.</p>
|
|
1312
|
+
* </li>
|
|
1313
|
+
* <li>
|
|
1314
|
+
* <p>
|
|
1315
|
+
* <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>
|
|
1316
|
+
* </li>
|
|
1317
|
+
* <li>
|
|
1318
|
+
* <p>
|
|
1319
|
+
* <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>
|
|
1320
|
+
* </li>
|
|
1321
|
+
* <li>
|
|
1322
|
+
* <p>
|
|
1323
|
+
* <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>
|
|
1324
|
+
* </li>
|
|
1325
|
+
* </ul>
|
|
1326
|
+
* <p>The name of the Amazon QuickSight role is invisible to the user except for the console
|
|
1327
|
+
* screens dealing with permissions.</p>
|
|
1328
|
+
* @public
|
|
1329
|
+
*/
|
|
1330
|
+
Role: UserRole | undefined;
|
|
1331
|
+
/**
|
|
1332
|
+
* <p>(Enterprise edition only) The name of the custom permissions profile that you want to
|
|
1333
|
+
* assign to this user. Customized permissions allows you to control a user's access by
|
|
1334
|
+
* restricting access the following operations:</p>
|
|
1335
|
+
* <ul>
|
|
1336
|
+
* <li>
|
|
1337
|
+
* <p>Create and update data sources</p>
|
|
1338
|
+
* </li>
|
|
1339
|
+
* <li>
|
|
1340
|
+
* <p>Create and update datasets</p>
|
|
1341
|
+
* </li>
|
|
1342
|
+
* <li>
|
|
1343
|
+
* <p>Create and update email reports</p>
|
|
1344
|
+
* </li>
|
|
1345
|
+
* <li>
|
|
1346
|
+
* <p>Subscribe to email reports</p>
|
|
1347
|
+
* </li>
|
|
1348
|
+
* </ul>
|
|
1349
|
+
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
1350
|
+
* you need to create the profile names for custom permission sets by using the Amazon QuickSight
|
|
1351
|
+
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
1352
|
+
* permissions to a Amazon QuickSight user. </p>
|
|
1353
|
+
* <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they
|
|
1354
|
+
* override the permissions typically granted by assigning Amazon QuickSight users to one of the
|
|
1355
|
+
* default security cohorts in Amazon QuickSight (admin, author, reader).</p>
|
|
1356
|
+
* <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
|
|
1357
|
+
* @public
|
|
1358
|
+
*/
|
|
1359
|
+
CustomPermissionsName?: string | undefined;
|
|
1360
|
+
/**
|
|
1361
|
+
* <p>A flag that you use to indicate that you want to remove all custom permissions
|
|
1362
|
+
* from this user. Using this parameter resets the user to the state
|
|
1363
|
+
* it was in before a custom permissions profile was applied. This parameter defaults to
|
|
1364
|
+
* NULL and it doesn't accept any other value.</p>
|
|
1365
|
+
* @public
|
|
1366
|
+
*/
|
|
1367
|
+
UnapplyCustomPermissions?: boolean | undefined;
|
|
1368
|
+
/**
|
|
1369
|
+
* <p>The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
|
|
1370
|
+
* <ul>
|
|
1371
|
+
* <li>
|
|
1372
|
+
* <p>
|
|
1373
|
+
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p>
|
|
1374
|
+
* </li>
|
|
1375
|
+
* <li>
|
|
1376
|
+
* <p>
|
|
1377
|
+
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p>
|
|
1378
|
+
* </li>
|
|
1379
|
+
* <li>
|
|
1380
|
+
* <p>
|
|
1381
|
+
* <code>NONE</code>: This clears all the previously saved external login information for a user. Use the
|
|
1382
|
+
* <code>
|
|
1383
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html">DescribeUser</a>
|
|
1384
|
+
* </code>
|
|
1385
|
+
* API operation to check the external login information.</p>
|
|
1386
|
+
* </li>
|
|
1387
|
+
* </ul>
|
|
1388
|
+
* @public
|
|
1389
|
+
*/
|
|
1390
|
+
ExternalLoginFederationProviderType?: string | undefined;
|
|
1391
|
+
/**
|
|
1392
|
+
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
1393
|
+
* into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
1394
|
+
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
1395
|
+
* @public
|
|
1396
|
+
*/
|
|
1397
|
+
CustomFederationProviderUrl?: string | undefined;
|
|
1398
|
+
/**
|
|
1399
|
+
* <p>The identity ID for a user in the external login provider.</p>
|
|
1400
|
+
* @public
|
|
1401
|
+
*/
|
|
1402
|
+
ExternalLoginId?: string | undefined;
|
|
1403
|
+
}
|
|
1404
|
+
/**
|
|
1405
|
+
* @public
|
|
1406
|
+
*/
|
|
1407
|
+
export interface UpdateUserResponse {
|
|
1408
|
+
/**
|
|
1409
|
+
* <p>The Amazon QuickSight user.</p>
|
|
1410
|
+
* @public
|
|
1411
|
+
*/
|
|
1412
|
+
User?: User | undefined;
|
|
1413
|
+
/**
|
|
1414
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
RequestId?: string | undefined;
|
|
1418
|
+
/**
|
|
1419
|
+
* <p>The HTTP status of the request.</p>
|
|
1420
|
+
* @public
|
|
1421
|
+
*/
|
|
1422
|
+
Status?: number | undefined;
|
|
1423
|
+
}
|
|
1424
|
+
/**
|
|
1425
|
+
* @public
|
|
1426
|
+
*/
|
|
1427
|
+
export interface UpdateUserCustomPermissionRequest {
|
|
1428
|
+
/**
|
|
1429
|
+
* <p>The username of the user that you want to update custom permissions for.</p>
|
|
1430
|
+
* @public
|
|
1431
|
+
*/
|
|
1432
|
+
UserName: string | undefined;
|
|
1433
|
+
/**
|
|
1434
|
+
* <p>The ID of the Amazon Web Services account that contains the custom permission configuration that you want to update.</p>
|
|
1435
|
+
* @public
|
|
1436
|
+
*/
|
|
1437
|
+
AwsAccountId: string | undefined;
|
|
1438
|
+
/**
|
|
1439
|
+
* <p>The namespace that the user belongs to.</p>
|
|
1440
|
+
* @public
|
|
1441
|
+
*/
|
|
1442
|
+
Namespace: string | undefined;
|
|
1443
|
+
/**
|
|
1444
|
+
* <p>The name of the custom permissions that you want to update.</p>
|
|
1445
|
+
* @public
|
|
1446
|
+
*/
|
|
1447
|
+
CustomPermissionsName: string | undefined;
|
|
1448
|
+
}
|
|
1449
|
+
/**
|
|
1450
|
+
* @public
|
|
1451
|
+
*/
|
|
1452
|
+
export interface UpdateUserCustomPermissionResponse {
|
|
1453
|
+
/**
|
|
1454
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1455
|
+
* @public
|
|
1456
|
+
*/
|
|
1457
|
+
RequestId?: string | undefined;
|
|
1458
|
+
/**
|
|
1459
|
+
* <p>The HTTP status of the request.</p>
|
|
1460
|
+
* @public
|
|
1461
|
+
*/
|
|
1462
|
+
Status?: number | undefined;
|
|
1463
|
+
}
|
|
1464
|
+
/**
|
|
1465
|
+
* @public
|
|
1466
|
+
*/
|
|
1467
|
+
export interface UpdateVPCConnectionRequest {
|
|
1468
|
+
/**
|
|
1469
|
+
* <p>The Amazon Web Services account ID of the account that contains the VPC connection that
|
|
1470
|
+
* you want to update.</p>
|
|
1471
|
+
* @public
|
|
1472
|
+
*/
|
|
1473
|
+
AwsAccountId: string | undefined;
|
|
1474
|
+
/**
|
|
1475
|
+
* <p>The ID of the VPC connection that
|
|
1476
|
+
* you're updating. This ID is a unique identifier for each Amazon Web Services Region in an
|
|
1477
|
+
* Amazon Web Services account.</p>
|
|
1478
|
+
* @public
|
|
1479
|
+
*/
|
|
1480
|
+
VPCConnectionId: string | undefined;
|
|
1481
|
+
/**
|
|
1482
|
+
* <p>The display name for the VPC connection.</p>
|
|
1483
|
+
* @public
|
|
1484
|
+
*/
|
|
1485
|
+
Name: string | undefined;
|
|
1486
|
+
/**
|
|
1487
|
+
* <p>A list of subnet IDs for the VPC connection.</p>
|
|
1488
|
+
* @public
|
|
1489
|
+
*/
|
|
1490
|
+
SubnetIds: string[] | undefined;
|
|
1491
|
+
/**
|
|
1492
|
+
* <p>A list of security group IDs for the VPC connection.</p>
|
|
1493
|
+
* @public
|
|
1494
|
+
*/
|
|
1495
|
+
SecurityGroupIds: string[] | undefined;
|
|
1496
|
+
/**
|
|
1497
|
+
* <p>A list of IP addresses of DNS resolver endpoints for the VPC connection.</p>
|
|
1498
|
+
* @public
|
|
1499
|
+
*/
|
|
1500
|
+
DnsResolvers?: string[] | undefined;
|
|
1501
|
+
/**
|
|
1502
|
+
* <p>An IAM role associated with the VPC connection.</p>
|
|
1503
|
+
* @public
|
|
1504
|
+
*/
|
|
1505
|
+
RoleArn: string | undefined;
|
|
1506
|
+
}
|
|
1507
|
+
/**
|
|
1508
|
+
* @public
|
|
1509
|
+
*/
|
|
1510
|
+
export interface UpdateVPCConnectionResponse {
|
|
1511
|
+
/**
|
|
1512
|
+
* <p>The Amazon Resource Name (ARN) of the VPC connection.</p>
|
|
1513
|
+
* @public
|
|
1514
|
+
*/
|
|
1515
|
+
Arn?: string | undefined;
|
|
1516
|
+
/**
|
|
1517
|
+
* <p>The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.</p>
|
|
1518
|
+
* @public
|
|
1519
|
+
*/
|
|
1520
|
+
VPCConnectionId?: string | undefined;
|
|
1521
|
+
/**
|
|
1522
|
+
* <p>The update status of the VPC connection's last update.</p>
|
|
1523
|
+
* @public
|
|
1524
|
+
*/
|
|
1525
|
+
UpdateStatus?: VPCConnectionResourceStatus | undefined;
|
|
1526
|
+
/**
|
|
1527
|
+
* <p>The availability status of the VPC connection.</p>
|
|
1528
|
+
* @public
|
|
1529
|
+
*/
|
|
1530
|
+
AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined;
|
|
1531
|
+
/**
|
|
1532
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1533
|
+
* @public
|
|
1534
|
+
*/
|
|
1535
|
+
RequestId?: string | undefined;
|
|
1536
|
+
/**
|
|
1537
|
+
* <p>The HTTP status of the request.</p>
|
|
1538
|
+
* @public
|
|
1539
|
+
*/
|
|
1540
|
+
Status?: number | undefined;
|
|
1541
|
+
}
|
|
1542
|
+
/**
|
|
1543
|
+
* <p>The definition for a <code>TopicVisual</code>.</p>
|
|
1544
|
+
* @public
|
|
1545
|
+
*/
|
|
1546
|
+
export interface TopicVisual {
|
|
1547
|
+
/**
|
|
1548
|
+
* <p>The visual ID for the <code>TopicVisual</code>.</p>
|
|
1549
|
+
* @public
|
|
1550
|
+
*/
|
|
1551
|
+
VisualId?: string | undefined;
|
|
1552
|
+
/**
|
|
1553
|
+
* <p>The role for the <code>TopicVisual</code>.</p>
|
|
1554
|
+
* @public
|
|
1555
|
+
*/
|
|
1556
|
+
Role?: VisualRole | undefined;
|
|
1557
|
+
/**
|
|
1558
|
+
* <p>The ir for the <code>TopicVisual</code>.</p>
|
|
1559
|
+
* @public
|
|
1560
|
+
*/
|
|
1561
|
+
Ir?: TopicIR | undefined;
|
|
1562
|
+
/**
|
|
1563
|
+
* <p>The supporting visuals for the <code>TopicVisual</code>.</p>
|
|
1564
|
+
* @public
|
|
1565
|
+
*/
|
|
1566
|
+
SupportingVisuals?: TopicVisual[] | undefined;
|
|
1567
|
+
}
|
|
1568
|
+
/**
|
|
1569
|
+
* <p>The definition for a <code>CreateTopicReviewedAnswer</code>.</p>
|
|
1570
|
+
* @public
|
|
1571
|
+
*/
|
|
1572
|
+
export interface CreateTopicReviewedAnswer {
|
|
1573
|
+
/**
|
|
1574
|
+
* <p>The answer ID for the <code>CreateTopicReviewedAnswer</code>.</p>
|
|
1575
|
+
* @public
|
|
1576
|
+
*/
|
|
1577
|
+
AnswerId: string | undefined;
|
|
1578
|
+
/**
|
|
1579
|
+
* <p>The Dataset arn for the <code>CreateTopicReviewedAnswer</code>.</p>
|
|
1580
|
+
* @public
|
|
1581
|
+
*/
|
|
1582
|
+
DatasetArn: string | undefined;
|
|
1583
|
+
/**
|
|
1584
|
+
* <p>The Question to be created.</p>
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
Question: string | undefined;
|
|
1588
|
+
/**
|
|
1589
|
+
* <p>The Mir for the <code>CreateTopicReviewedAnswer</code>.</p>
|
|
1590
|
+
* @public
|
|
1591
|
+
*/
|
|
1592
|
+
Mir?: TopicIR | undefined;
|
|
1593
|
+
/**
|
|
1594
|
+
* <p>The <code>PrimaryVisual</code> for the <code>CreateTopicReviewedAnswer</code>.</p>
|
|
1595
|
+
* @public
|
|
1596
|
+
*/
|
|
1597
|
+
PrimaryVisual?: TopicVisual | undefined;
|
|
1598
|
+
/**
|
|
1599
|
+
* <p>The template for the <code>CreateTopicReviewedAnswer</code>.</p>
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
Template?: TopicTemplate | undefined;
|
|
1603
|
+
}
|
|
1604
|
+
/**
|
|
1605
|
+
* <p>The deinition for a <code>TopicReviewedAnswer</code>.</p>
|
|
1606
|
+
* @public
|
|
1607
|
+
*/
|
|
1608
|
+
export interface TopicReviewedAnswer {
|
|
1609
|
+
/**
|
|
1610
|
+
* <p>The Amazon Resource Name (ARN) of the reviewed answer.</p>
|
|
1611
|
+
* @public
|
|
1612
|
+
*/
|
|
1613
|
+
Arn?: string | undefined;
|
|
1614
|
+
/**
|
|
1615
|
+
* <p>The answer ID of the reviewed answer.</p>
|
|
1616
|
+
* @public
|
|
1617
|
+
*/
|
|
1618
|
+
AnswerId: string | undefined;
|
|
1619
|
+
/**
|
|
1620
|
+
* <p>The Dataset ARN for the <code>TopicReviewedAnswer</code>.</p>
|
|
1621
|
+
* @public
|
|
1622
|
+
*/
|
|
1623
|
+
DatasetArn: string | undefined;
|
|
1624
|
+
/**
|
|
1625
|
+
* <p>The question for the <code>TopicReviewedAnswer</code>.</p>
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
Question: string | undefined;
|
|
1629
|
+
/**
|
|
1630
|
+
* <p>The mir for the <code>TopicReviewedAnswer</code>.</p>
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1633
|
+
Mir?: TopicIR | undefined;
|
|
1634
|
+
/**
|
|
1635
|
+
* <p>The primary visual for the <code>TopicReviewedAnswer</code>.</p>
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
PrimaryVisual?: TopicVisual | undefined;
|
|
1639
|
+
/**
|
|
1640
|
+
* <p>The template for the <code>TopicReviewedAnswer</code>.</p>
|
|
1641
|
+
* @public
|
|
1642
|
+
*/
|
|
1643
|
+
Template?: TopicTemplate | undefined;
|
|
1644
|
+
}
|
|
1645
|
+
/**
|
|
1646
|
+
* @public
|
|
1647
|
+
*/
|
|
1648
|
+
export interface BatchCreateTopicReviewedAnswerRequest {
|
|
1649
|
+
/**
|
|
1650
|
+
* <p>The ID of the Amazon Web Services account that you want to create a reviewed answer in.</p>
|
|
1651
|
+
* @public
|
|
1652
|
+
*/
|
|
1653
|
+
AwsAccountId: string | undefined;
|
|
1654
|
+
/**
|
|
1655
|
+
* <p>The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1656
|
+
* @public
|
|
1657
|
+
*/
|
|
1658
|
+
TopicId: string | undefined;
|
|
1659
|
+
/**
|
|
1660
|
+
* <p>The definition of the Answers to be created.</p>
|
|
1661
|
+
* @public
|
|
1662
|
+
*/
|
|
1663
|
+
Answers: CreateTopicReviewedAnswer[] | undefined;
|
|
1664
|
+
}
|
|
1665
|
+
/**
|
|
1666
|
+
* @public
|
|
1667
|
+
*/
|
|
1668
|
+
export interface ListTopicReviewedAnswersResponse {
|
|
1669
|
+
/**
|
|
1670
|
+
* <p>The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1671
|
+
* @public
|
|
1672
|
+
*/
|
|
1673
|
+
TopicId?: string | undefined;
|
|
1674
|
+
/**
|
|
1675
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
1676
|
+
* @public
|
|
1677
|
+
*/
|
|
1678
|
+
TopicArn?: string | undefined;
|
|
1679
|
+
/**
|
|
1680
|
+
* <p>The definition of all Answers in the topic.</p>
|
|
1681
|
+
* @public
|
|
1682
|
+
*/
|
|
1683
|
+
Answers?: TopicReviewedAnswer[] | undefined;
|
|
1684
|
+
/**
|
|
1685
|
+
* <p>The HTTP status of the request.</p>
|
|
1686
|
+
* @public
|
|
1687
|
+
*/
|
|
1688
|
+
Status?: number | undefined;
|
|
1689
|
+
/**
|
|
1690
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1691
|
+
* @public
|
|
1692
|
+
*/
|
|
1693
|
+
RequestId?: string | undefined;
|
|
1694
|
+
}
|
|
1695
|
+
/**
|
|
1696
|
+
* @internal
|
|
1697
|
+
*/
|
|
1698
|
+
export declare const UpdateDataSourceRequestFilterSensitiveLog: (obj: UpdateDataSourceRequest) => any;
|
|
1699
|
+
/**
|
|
1700
|
+
* @internal
|
|
1701
|
+
*/
|
|
1702
|
+
export declare const UpdateTemplateRequestFilterSensitiveLog: (obj: UpdateTemplateRequest) => any;
|
|
1703
|
+
/**
|
|
1704
|
+
* @internal
|
|
1705
|
+
*/
|
|
1706
|
+
export declare const UpdateTopicRequestFilterSensitiveLog: (obj: UpdateTopicRequest) => any;
|
|
1707
|
+
/**
|
|
1708
|
+
* @internal
|
|
1709
|
+
*/
|
|
1710
|
+
export declare const TopicVisualFilterSensitiveLog: (obj: TopicVisual) => any;
|
|
1711
|
+
/**
|
|
1712
|
+
* @internal
|
|
1713
|
+
*/
|
|
1714
|
+
export declare const CreateTopicReviewedAnswerFilterSensitiveLog: (obj: CreateTopicReviewedAnswer) => any;
|
|
1715
|
+
/**
|
|
1716
|
+
* @internal
|
|
1717
|
+
*/
|
|
1718
|
+
export declare const TopicReviewedAnswerFilterSensitiveLog: (obj: TopicReviewedAnswer) => any;
|
|
1719
|
+
/**
|
|
1720
|
+
* @internal
|
|
1721
|
+
*/
|
|
1722
|
+
export declare const BatchCreateTopicReviewedAnswerRequestFilterSensitiveLog: (obj: BatchCreateTopicReviewedAnswerRequest) => any;
|
|
1723
|
+
/**
|
|
1724
|
+
* @internal
|
|
1725
|
+
*/
|
|
1726
|
+
export declare const ListTopicReviewedAnswersResponseFilterSensitiveLog: (obj: ListTopicReviewedAnswersResponse) => any;
|