@aws-sdk/client-quicksight 3.1056.0 → 3.1057.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.
Files changed (63) hide show
  1. package/README.md +35 -0
  2. package/dist-cjs/index.js +78 -0
  3. package/dist-cjs/schemas/schemas_0.js +140 -35
  4. package/dist-es/QuickSight.js +12 -0
  5. package/dist-es/commands/CreateOAuthClientApplicationCommand.js +16 -0
  6. package/dist-es/commands/DeleteOAuthClientApplicationCommand.js +16 -0
  7. package/dist-es/commands/DescribeOAuthClientApplicationCommand.js +16 -0
  8. package/dist-es/commands/ListOAuthClientApplicationsCommand.js +16 -0
  9. package/dist-es/commands/UpdateOAuthClientApplicationCommand.js +16 -0
  10. package/dist-es/commands/index.js +5 -0
  11. package/dist-es/models/enums.js +3 -0
  12. package/dist-es/pagination/ListOAuthClientApplicationsPaginator.js +4 -0
  13. package/dist-es/pagination/index.js +1 -0
  14. package/dist-es/schemas/schemas_0.js +109 -4
  15. package/dist-types/QuickSight.d.ts +42 -0
  16. package/dist-types/QuickSightClient.d.ts +7 -2
  17. package/dist-types/commands/CreateOAuthClientApplicationCommand.d.ts +125 -0
  18. package/dist-types/commands/DeleteOAuthClientApplicationCommand.d.ts +101 -0
  19. package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +2 -1
  20. package/dist-types/commands/DescribeKeyRegistrationCommand.d.ts +1 -2
  21. package/dist-types/commands/DescribeOAuthClientApplicationCommand.d.ts +111 -0
  22. package/dist-types/commands/ListOAuthClientApplicationsCommand.d.ts +115 -0
  23. package/dist-types/commands/UpdateOAuthClientApplicationCommand.d.ts +115 -0
  24. package/dist-types/commands/UpdateRoleCustomPermissionCommand.d.ts +2 -1
  25. package/dist-types/commands/UpdateSPICECapacityConfigurationCommand.d.ts +1 -1
  26. package/dist-types/commands/UpdateSelfUpgradeCommand.d.ts +1 -1
  27. package/dist-types/commands/UpdateSelfUpgradeConfigurationCommand.d.ts +1 -1
  28. package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +1 -1
  29. package/dist-types/commands/UpdateTemplateCommand.d.ts +1 -1
  30. package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +1 -2
  31. package/dist-types/commands/index.d.ts +5 -0
  32. package/dist-types/models/enums.d.ts +11 -0
  33. package/dist-types/models/models_3.d.ts +136 -99
  34. package/dist-types/models/models_4.d.ts +356 -282
  35. package/dist-types/models/models_5.d.ts +300 -4
  36. package/dist-types/pagination/ListOAuthClientApplicationsPaginator.d.ts +7 -0
  37. package/dist-types/pagination/index.d.ts +1 -0
  38. package/dist-types/schemas/schemas_0.d.ts +17 -0
  39. package/dist-types/ts3.4/QuickSight.d.ts +92 -0
  40. package/dist-types/ts3.4/QuickSightClient.d.ts +30 -0
  41. package/dist-types/ts3.4/commands/CreateOAuthClientApplicationCommand.d.ts +53 -0
  42. package/dist-types/ts3.4/commands/DeleteOAuthClientApplicationCommand.d.ts +53 -0
  43. package/dist-types/ts3.4/commands/DescribeIpRestrictionCommand.d.ts +2 -4
  44. package/dist-types/ts3.4/commands/DescribeKeyRegistrationCommand.d.ts +4 -2
  45. package/dist-types/ts3.4/commands/DescribeOAuthClientApplicationCommand.d.ts +53 -0
  46. package/dist-types/ts3.4/commands/ListOAuthClientApplicationsCommand.d.ts +53 -0
  47. package/dist-types/ts3.4/commands/UpdateOAuthClientApplicationCommand.d.ts +53 -0
  48. package/dist-types/ts3.4/commands/UpdateRoleCustomPermissionCommand.d.ts +2 -4
  49. package/dist-types/ts3.4/commands/UpdateSPICECapacityConfigurationCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/UpdateSelfUpgradeCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/UpdateSelfUpgradeConfigurationCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/UpdateTemplateAliasCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/UpdateTemplatePermissionsCommand.d.ts +4 -2
  55. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  56. package/dist-types/ts3.4/models/enums.d.ts +5 -0
  57. package/dist-types/ts3.4/models/models_3.d.ts +32 -22
  58. package/dist-types/ts3.4/models/models_4.d.ts +86 -71
  59. package/dist-types/ts3.4/models/models_5.d.ts +79 -2
  60. package/dist-types/ts3.4/pagination/ListOAuthClientApplicationsPaginator.d.ts +11 -0
  61. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  62. package/dist-types/ts3.4/schemas/schemas_0.d.ts +17 -0
  63. package/package.json +2 -2
@@ -1,7 +1,105 @@
1
- import type { AssetBundleExportFormat, AssetBundleImportFailureAction, AssignmentStatus, DashboardsQAStatus, DataSetImportMode, EmbeddingIdentityType, FieldName, FilterOperator, FlowPublishState, FolderFilterAttribute, FolderType, GeneratedAnswerStatus, GroupFilterAttribute, GroupFilterOperator, IdentityStore, IdentityType, IncludeFolderMembers, IncludeGeneratedAnswer, IncludeQuickSightQIndex, NamespaceErrorType, NamespaceStatus, NetworkInterfaceStatus, PersonalizationMode, PurchaseMode, QAResultType, QSearchStatus, ResourceStatus, Role, SearchFilterOperator, SelfUpgradeAdminAction, SelfUpgradeRequestStatus, SelfUpgradeStatus, ServiceType, SharingModel, TemplateErrorType, ThemeErrorType, ThemeType, TopicFilterAttribute, TopicFilterOperator, TopicRefreshStatus, TopicUserExperienceVersion, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
1
+ import type { AssetBundleExportFormat, AssetBundleImportFailureAction, AssignmentStatus, DashboardsQAStatus, DataSetImportMode, DataSourceType, EmbeddingIdentityType, FieldName, FilterOperator, FlowPublishState, FolderFilterAttribute, FolderType, GeneratedAnswerStatus, GroupFilterAttribute, GroupFilterOperator, IdentityStore, IdentityType, IncludeFolderMembers, IncludeGeneratedAnswer, IncludeQuickSightQIndex, NamespaceErrorType, NamespaceStatus, NetworkInterfaceStatus, OAuthClientAuthenticationType, PersonalizationMode, QAResultType, QDataKeyType, QSearchStatus, ResourceStatus, Role, SearchFilterOperator, SelfUpgradeRequestStatus, SelfUpgradeStatus, ServiceType, SharingModel, TemplateErrorType, ThemeErrorType, ThemeType, TopicFilterAttribute, TopicFilterOperator, TopicRefreshStatus, TopicUserExperienceVersion, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
2
2
  import type { AccountCustomization, ActionConnectorSearchFilter, ActionConnectorSummary, ActiveIAMPolicyAssignment, AmazonQInQuickSightConsoleConfigurations, AmazonQInQuickSightDashboardConfigurations, Entity, Sheet } from "./models_0";
3
3
  import type { _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobSummary, AssetBundleImportSource, AuthConfig, AuthorizedTargetsByService, BookmarksConfigurations, BrandDefinition, BrandDetail, BrandSummary, Capabilities, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DashboardVisualId, DataPrepConfiguration, DataSetRefreshProperties, DataSourceParameters, LinkSharingConfiguration, ResourcePermission, SharedViewConfigurations, SslProperties, Tag, ValidationStrategy, VpcConnectionProperties } from "./models_2";
4
- import type { CustomInstructions, CustomPermissions, DashboardCustomizationSummaryConfigurations, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DashboardVisualResult, DataSetConfiguration, DatasetParameter, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FieldFolder, Group, GroupMember, Ingestion, LogicalTable, PerformanceConfiguration, PhysicalTable, QDataKey, RefreshSchedule, RegisteredCustomerManagedKey, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticModelConfiguration, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule } from "./models_3";
4
+ import type { CustomInstructions, CustomPermissions, DashboardCustomizationSummaryConfigurations, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DashboardVisualResult, DataSetConfiguration, DatasetParameter, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FieldFolder, Group, GroupMember, Ingestion, LogicalTable, PerformanceConfiguration, PhysicalTable, RefreshSchedule, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticModelConfiguration, SnapshotConfiguration, TemplateAlias, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule } from "./models_3";
5
+ /**
6
+ * @public
7
+ */
8
+ export interface DescribeIpRestrictionResponse {
9
+ /**
10
+ * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
11
+ * @public
12
+ */
13
+ AwsAccountId?: string | undefined;
14
+ /**
15
+ * <p>A map that describes the IP rules with CIDR range and description.</p>
16
+ * @public
17
+ */
18
+ IpRestrictionRuleMap?: Record<string, string> | undefined;
19
+ /**
20
+ * <p>A map of allowed VPC IDs and their rule descriptions.</p>
21
+ * @public
22
+ */
23
+ VpcIdRestrictionRuleMap?: Record<string, string> | undefined;
24
+ /**
25
+ * <p>A map of allowed VPC endpoint IDs and their rule descriptions.</p>
26
+ * @public
27
+ */
28
+ VpcEndpointIdRestrictionRuleMap?: Record<string, string> | undefined;
29
+ /**
30
+ * <p>A value that specifies whether IP rules are turned on.</p>
31
+ * @public
32
+ */
33
+ Enabled?: boolean | undefined;
34
+ /**
35
+ * <p>The Amazon Web Services request ID for this operation.</p>
36
+ * @public
37
+ */
38
+ RequestId?: string | undefined;
39
+ /**
40
+ * <p>The HTTP status of the request.
41
+ * </p>
42
+ * @public
43
+ */
44
+ Status?: number | undefined;
45
+ }
46
+ /**
47
+ * @public
48
+ */
49
+ export interface DescribeKeyRegistrationRequest {
50
+ /**
51
+ * <p>The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.</p>
52
+ * @public
53
+ */
54
+ AwsAccountId: string | undefined;
55
+ /**
56
+ * <p>Determines whether the request returns the default key only.</p>
57
+ * @public
58
+ */
59
+ DefaultKeyOnly?: boolean | undefined;
60
+ }
61
+ /**
62
+ * <p>A customer managed key structure that contains the information listed below: </p>
63
+ * <ul>
64
+ * <li>
65
+ * <p>
66
+ * <code>KeyArn</code> - The ARN of a KMS key that is registered to a Quick Sight account for encryption and decryption use.</p>
67
+ * </li>
68
+ * <li>
69
+ * <p>
70
+ * <code>DefaultKey</code> - Indicates whether the current key is set as the default key for encryption and decryption use.</p>
71
+ * </li>
72
+ * </ul>
73
+ * @public
74
+ */
75
+ export interface RegisteredCustomerManagedKey {
76
+ /**
77
+ * <p>The ARN of the KMS key that is registered to a Quick Sight account for encryption and decryption use.</p>
78
+ * @public
79
+ */
80
+ KeyArn?: string | undefined;
81
+ /**
82
+ * <p>Indicates whether a <code>RegisteredCustomerManagedKey</code> is set as the default key for encryption and decryption use.</p>
83
+ * @public
84
+ */
85
+ DefaultKey?: boolean | undefined;
86
+ }
87
+ /**
88
+ * <p>A structure that contains information about the <code>QDataKey</code>.</p>
89
+ * @public
90
+ */
91
+ export interface QDataKey {
92
+ /**
93
+ * <p>The ARN of the KMS key that is registered to a Quick Sight account for encryption and decryption use as a <code>QDataKey</code>.</p>
94
+ * @public
95
+ */
96
+ QDataKeyArn?: string | undefined;
97
+ /**
98
+ * <p>The type of <code>QDataKey</code>.</p>
99
+ * @public
100
+ */
101
+ QDataKeyType?: QDataKeyType | undefined;
102
+ }
5
103
  /**
6
104
  * @public
7
105
  */
@@ -132,6 +230,102 @@ export interface DescribeNamespaceResponse {
132
230
  */
133
231
  Status?: number | undefined;
134
232
  }
233
+ /**
234
+ * @public
235
+ */
236
+ export interface DescribeOAuthClientApplicationRequest {
237
+ /**
238
+ * <p>The Amazon Web Services account ID.</p>
239
+ * @public
240
+ */
241
+ AwsAccountId: string | undefined;
242
+ /**
243
+ * <p>The ID of the OAuthClientApplication that you want to describe.</p>
244
+ * @public
245
+ */
246
+ OAuthClientApplicationId: string | undefined;
247
+ }
248
+ /**
249
+ * <p>An OAuth client application that is used to authenticate connections to a data source through an OAuth identity provider.</p>
250
+ * @public
251
+ */
252
+ export interface OAuthClientApplication {
253
+ /**
254
+ * <p>The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
255
+ * @public
256
+ */
257
+ OAuthClientApplicationId?: string | undefined;
258
+ /**
259
+ * <p>The display name of the OAuthClientApplication.</p>
260
+ * @public
261
+ */
262
+ Name?: string | undefined;
263
+ /**
264
+ * <p>The OAuth client authentication type used by the OAuthClientApplication. Valid values are <code>TOKEN</code>.</p>
265
+ * @public
266
+ */
267
+ OAuthClientAuthenticationType?: OAuthClientAuthenticationType | undefined;
268
+ /**
269
+ * <p>The token endpoint URL of the identity provider that is used to obtain access tokens.</p>
270
+ * @public
271
+ */
272
+ OAuthTokenEndpointUrl?: string | undefined;
273
+ /**
274
+ * <p>The authorization endpoint URL of the identity provider that is used to obtain authorization codes.</p>
275
+ * @public
276
+ */
277
+ OAuthAuthorizationEndpointUrl?: string | undefined;
278
+ /**
279
+ * <p>The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.</p>
280
+ * @public
281
+ */
282
+ OAuthScopes?: string | undefined;
283
+ /**
284
+ * <p>The type of data source that the OAuthClientApplication is used with. Valid values are <code>SNOWFLAKE</code>.</p>
285
+ * @public
286
+ */
287
+ DataSourceType?: DataSourceType | undefined;
288
+ /**
289
+ * <p>VPC connection properties.</p>
290
+ * @public
291
+ */
292
+ IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined;
293
+ /**
294
+ * <p>The time that the OAuthClientApplication was created.</p>
295
+ * @public
296
+ */
297
+ CreatedTime?: Date | undefined;
298
+ /**
299
+ * <p>The time that the OAuthClientApplication was last updated.</p>
300
+ * @public
301
+ */
302
+ LastUpdatedTime?: Date | undefined;
303
+ /**
304
+ * <p>The Amazon Resource Name (ARN) of the OAuthClientApplication.</p>
305
+ * @public
306
+ */
307
+ Arn?: string | undefined;
308
+ }
309
+ /**
310
+ * @public
311
+ */
312
+ export interface DescribeOAuthClientApplicationResponse {
313
+ /**
314
+ * <p>The information about the OAuthClientApplication.</p>
315
+ * @public
316
+ */
317
+ OAuthClientApplication?: OAuthClientApplication | undefined;
318
+ /**
319
+ * <p>The Amazon Web Services request ID for this operation.</p>
320
+ * @public
321
+ */
322
+ RequestId?: string | undefined;
323
+ /**
324
+ * <p>The HTTP status of the request.</p>
325
+ * @public
326
+ */
327
+ Status?: number | undefined;
328
+ }
135
329
  /**
136
330
  * @public
137
331
  */
@@ -3895,6 +4089,97 @@ export interface ListNamespacesResponse {
3895
4089
  */
3896
4090
  Status?: number | undefined;
3897
4091
  }
4092
+ /**
4093
+ * @public
4094
+ */
4095
+ export interface ListOAuthClientApplicationsRequest {
4096
+ /**
4097
+ * <p>The Amazon Web Services account ID.</p>
4098
+ * @public
4099
+ */
4100
+ AwsAccountId: string | undefined;
4101
+ /**
4102
+ * <p>A pagination token that can be used in a subsequent request.</p>
4103
+ * @public
4104
+ */
4105
+ NextToken?: string | undefined;
4106
+ /**
4107
+ * <p>The maximum number of results to return.</p>
4108
+ * @public
4109
+ */
4110
+ MaxResults?: number | undefined;
4111
+ }
4112
+ /**
4113
+ * <p>A summary of an OAuthClientApplication.</p>
4114
+ * @public
4115
+ */
4116
+ export interface OAuthClientApplicationSummary {
4117
+ /**
4118
+ * <p>The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
4119
+ * @public
4120
+ */
4121
+ OAuthClientApplicationId?: string | undefined;
4122
+ /**
4123
+ * <p>The display name of the OAuthClientApplication.</p>
4124
+ * @public
4125
+ */
4126
+ Name?: string | undefined;
4127
+ /**
4128
+ * <p>The OAuth client authentication type used by the OAuthClientApplication. Valid values are <code>TOKEN</code>.</p>
4129
+ * @public
4130
+ */
4131
+ OAuthClientAuthenticationType?: OAuthClientAuthenticationType | undefined;
4132
+ /**
4133
+ * <p>The type of data source that the OAuthClientApplication is used with. Valid values are <code>SNOWFLAKE</code>.</p>
4134
+ * @public
4135
+ */
4136
+ DataSourceType?: DataSourceType | undefined;
4137
+ /**
4138
+ * <p>VPC connection properties.</p>
4139
+ * @public
4140
+ */
4141
+ IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined;
4142
+ /**
4143
+ * <p>The time that the OAuthClientApplication was created.</p>
4144
+ * @public
4145
+ */
4146
+ CreatedTime?: Date | undefined;
4147
+ /**
4148
+ * <p>The time that the OAuthClientApplication was last updated.</p>
4149
+ * @public
4150
+ */
4151
+ LastUpdatedTime?: Date | undefined;
4152
+ /**
4153
+ * <p>The Amazon Resource Name (ARN) of the OAuthClientApplication.</p>
4154
+ * @public
4155
+ */
4156
+ Arn?: string | undefined;
4157
+ }
4158
+ /**
4159
+ * @public
4160
+ */
4161
+ export interface ListOAuthClientApplicationsResponse {
4162
+ /**
4163
+ * <p>A list of OAuthClientApplication summaries.</p>
4164
+ * @public
4165
+ */
4166
+ OAuthClientApplications?: OAuthClientApplicationSummary[] | undefined;
4167
+ /**
4168
+ * <p>A pagination token that can be used in a subsequent request.</p>
4169
+ * @public
4170
+ */
4171
+ NextToken?: string | undefined;
4172
+ /**
4173
+ * <p>The Amazon Web Services request ID for this operation.</p>
4174
+ * @public
4175
+ */
4176
+ RequestId?: string | undefined;
4177
+ /**
4178
+ * <p>The HTTP status of the request.</p>
4179
+ * @public
4180
+ */
4181
+ Status?: number | undefined;
4182
+ }
3898
4183
  /**
3899
4184
  * @public
3900
4185
  */
@@ -8024,178 +8309,108 @@ export interface UpdateKeyRegistrationResponse {
8024
8309
  /**
8025
8310
  * @public
8026
8311
  */
8027
- export interface UpdatePublicSharingSettingsRequest {
8028
- /**
8029
- * <p>The Amazon Web Services account ID associated with your Amazon Quick Sight
8030
- * subscription.</p>
8031
- * @public
8032
- */
8033
- AwsAccountId: string | undefined;
8312
+ export interface UpdateOAuthClientApplicationRequest {
8034
8313
  /**
8035
- * <p>A Boolean value that indicates whether public sharing is turned on for an Quick account.</p>
8036
- * @public
8037
- */
8038
- PublicSharingEnabled?: boolean | undefined;
8039
- }
8040
- /**
8041
- * @public
8042
- */
8043
- export interface UpdatePublicSharingSettingsResponse {
8044
- /**
8045
- * <p>The Amazon Web Services request ID for this operation.</p>
8046
- * @public
8047
- */
8048
- RequestId?: string | undefined;
8049
- /**
8050
- * <p>The HTTP status of the request.</p>
8051
- * @public
8052
- */
8053
- Status?: number | undefined;
8054
- }
8055
- /**
8056
- * @public
8057
- */
8058
- export interface UpdateQPersonalizationConfigurationRequest {
8059
- /**
8060
- * <p>The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.</p>
8314
+ * <p>The Amazon Web Services account ID.</p>
8061
8315
  * @public
8062
8316
  */
8063
8317
  AwsAccountId: string | undefined;
8064
8318
  /**
8065
- * <p>An option to allow Amazon Quick Sight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.</p>
8319
+ * <p>The ID of the OAuthClientApplication that you want to update.</p>
8066
8320
  * @public
8067
8321
  */
8068
- PersonalizationMode: PersonalizationMode | undefined;
8069
- }
8070
- /**
8071
- * @public
8072
- */
8073
- export interface UpdateQPersonalizationConfigurationResponse {
8322
+ OAuthClientApplicationId: string | undefined;
8074
8323
  /**
8075
- * <p>The personalization mode that is used for the personalization configuration.</p>
8324
+ * <p>The display name for the OAuthClientApplication.</p>
8076
8325
  * @public
8077
8326
  */
8078
- PersonalizationMode?: PersonalizationMode | undefined;
8327
+ Name: string | undefined;
8079
8328
  /**
8080
- * <p>The Amazon Web Services request ID for this operation.</p>
8329
+ * <p>The client ID of the OAuth application that is registered with the identity provider.</p>
8081
8330
  * @public
8082
8331
  */
8083
- RequestId?: string | undefined;
8332
+ ClientId?: string | undefined;
8084
8333
  /**
8085
- * <p>The HTTP status of the request.</p>
8334
+ * <p>The client secret of the OAuth application that is registered with the identity provider.</p>
8086
8335
  * @public
8087
8336
  */
8088
- Status?: number | undefined;
8089
- }
8090
- /**
8091
- * @public
8092
- */
8093
- export interface UpdateQuickSightQSearchConfigurationRequest {
8337
+ ClientSecret?: string | undefined;
8094
8338
  /**
8095
- * <p>The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that you want to update.</p>
8339
+ * <p>The token endpoint URL of the identity provider that is used to obtain access tokens.</p>
8096
8340
  * @public
8097
8341
  */
8098
- AwsAccountId: string | undefined;
8342
+ OAuthTokenEndpointUrl?: string | undefined;
8099
8343
  /**
8100
- * <p>The status of the Quick Sight Q Search configuration that the user wants to update.</p>
8344
+ * <p>The authorization endpoint URL of the identity provider that is used to obtain authorization codes.</p>
8101
8345
  * @public
8102
8346
  */
8103
- QSearchStatus: QSearchStatus | undefined;
8104
- }
8105
- /**
8106
- * @public
8107
- */
8108
- export interface UpdateQuickSightQSearchConfigurationResponse {
8347
+ OAuthAuthorizationEndpointUrl?: string | undefined;
8109
8348
  /**
8110
- * <p>The status of the Quick Sight Q Search configuration.</p>
8349
+ * <p>The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.</p>
8111
8350
  * @public
8112
8351
  */
8113
- QSearchStatus?: QSearchStatus | undefined;
8352
+ OAuthScopes?: string | undefined;
8114
8353
  /**
8115
- * <p>The Amazon Web Services request ID for this operation.</p>
8354
+ * <p>The type of data source that the OAuthClientApplication is used with. Valid values are <code>SNOWFLAKE</code>.</p>
8116
8355
  * @public
8117
8356
  */
8118
- RequestId?: string | undefined;
8357
+ DataSourceType?: DataSourceType | undefined;
8119
8358
  /**
8120
- * <p>The HTTP status of the request.</p>
8359
+ * <p>VPC connection properties.</p>
8121
8360
  * @public
8122
8361
  */
8123
- Status?: number | undefined;
8362
+ IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined;
8124
8363
  }
8125
8364
  /**
8126
8365
  * @public
8127
8366
  */
8128
- export interface UpdateRefreshScheduleRequest {
8129
- /**
8130
- * <p>The ID of the dataset.</p>
8131
- * @public
8132
- */
8133
- DataSetId: string | undefined;
8367
+ export interface UpdateOAuthClientApplicationResponse {
8134
8368
  /**
8135
- * <p>The Amazon Web Services account ID.</p>
8369
+ * <p>The Amazon Resource Name (ARN) of the OAuthClientApplication.</p>
8136
8370
  * @public
8137
8371
  */
8138
- AwsAccountId: string | undefined;
8372
+ Arn?: string | undefined;
8139
8373
  /**
8140
- * <p>The refresh schedule.</p>
8374
+ * <p>The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
8141
8375
  * @public
8142
8376
  */
8143
- Schedule: RefreshSchedule | undefined;
8144
- }
8145
- /**
8146
- * @public
8147
- */
8148
- export interface UpdateRefreshScheduleResponse {
8377
+ OAuthClientApplicationId?: string | undefined;
8149
8378
  /**
8150
- * <p>The HTTP status of the request.</p>
8379
+ * <p>The status of updating the OAuthClientApplication.</p>
8151
8380
  * @public
8152
8381
  */
8153
- Status?: number | undefined;
8382
+ UpdateStatus?: ResourceStatus | undefined;
8154
8383
  /**
8155
8384
  * <p>The Amazon Web Services request ID for this operation.</p>
8156
8385
  * @public
8157
8386
  */
8158
8387
  RequestId?: string | undefined;
8159
8388
  /**
8160
- * <p>The ID of the refresh schedule.</p>
8161
- * @public
8162
- */
8163
- ScheduleId?: string | undefined;
8164
- /**
8165
- * <p>The Amazon Resource Name (ARN) for the refresh schedule.</p>
8389
+ * <p>The HTTP status of the request.</p>
8166
8390
  * @public
8167
8391
  */
8168
- Arn?: string | undefined;
8392
+ Status?: number | undefined;
8169
8393
  }
8170
8394
  /**
8171
8395
  * @public
8172
8396
  */
8173
- export interface UpdateRoleCustomPermissionRequest {
8174
- /**
8175
- * <p>The name of the custom permission that you want to update the role with.</p>
8176
- * @public
8177
- */
8178
- CustomPermissionsName: string | undefined;
8179
- /**
8180
- * <p>The name of role tht you want to update.</p>
8181
- * @public
8182
- */
8183
- Role: Role | undefined;
8397
+ export interface UpdatePublicSharingSettingsRequest {
8184
8398
  /**
8185
- * <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 Quick Sight account.</p>
8399
+ * <p>The Amazon Web Services account ID associated with your Amazon Quick Sight
8400
+ * subscription.</p>
8186
8401
  * @public
8187
8402
  */
8188
8403
  AwsAccountId: string | undefined;
8189
8404
  /**
8190
- * <p>The namespace that contains the role that you want to update.</p>
8405
+ * <p>A Boolean value that indicates whether public sharing is turned on for an Quick account.</p>
8191
8406
  * @public
8192
8407
  */
8193
- Namespace: string | undefined;
8408
+ PublicSharingEnabled?: boolean | undefined;
8194
8409
  }
8195
8410
  /**
8196
8411
  * @public
8197
8412
  */
8198
- export interface UpdateRoleCustomPermissionResponse {
8413
+ export interface UpdatePublicSharingSettingsResponse {
8199
8414
  /**
8200
8415
  * <p>The Amazon Web Services request ID for this operation.</p>
8201
8416
  * @public
@@ -8210,37 +8425,27 @@ export interface UpdateRoleCustomPermissionResponse {
8210
8425
  /**
8211
8426
  * @public
8212
8427
  */
8213
- export interface UpdateSelfUpgradeRequest {
8428
+ export interface UpdateQPersonalizationConfigurationRequest {
8214
8429
  /**
8215
- * <p>The ID of the Amazon Web Services account that contains the self-upgrade request.</p>
8430
+ * <p>The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.</p>
8216
8431
  * @public
8217
8432
  */
8218
8433
  AwsAccountId: string | undefined;
8219
8434
  /**
8220
- * <p>The Quick namespace for the self-upgrade request.</p>
8221
- * @public
8222
- */
8223
- Namespace: string | undefined;
8224
- /**
8225
- * <p>The ID of the self-upgrade request to update.</p>
8226
- * @public
8227
- */
8228
- UpgradeRequestId: string | undefined;
8229
- /**
8230
- * <p>The action to perform on the self-upgrade request. Valid values are <code>APPROVE</code>, <code>DENY</code>, or <code>VERIFY</code>.</p>
8435
+ * <p>An option to allow Amazon Quick Sight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.</p>
8231
8436
  * @public
8232
8437
  */
8233
- Action: SelfUpgradeAdminAction | undefined;
8438
+ PersonalizationMode: PersonalizationMode | undefined;
8234
8439
  }
8235
8440
  /**
8236
8441
  * @public
8237
8442
  */
8238
- export interface UpdateSelfUpgradeResponse {
8443
+ export interface UpdateQPersonalizationConfigurationResponse {
8239
8444
  /**
8240
- * <p>Details of the updated self-upgrade request.</p>
8445
+ * <p>The personalization mode that is used for the personalization configuration.</p>
8241
8446
  * @public
8242
8447
  */
8243
- SelfUpgradeRequestDetail?: SelfUpgradeRequestDetail | undefined;
8448
+ PersonalizationMode?: PersonalizationMode | undefined;
8244
8449
  /**
8245
8450
  * <p>The Amazon Web Services request ID for this operation.</p>
8246
8451
  * @public
@@ -8255,67 +8460,27 @@ export interface UpdateSelfUpgradeResponse {
8255
8460
  /**
8256
8461
  * @public
8257
8462
  */
8258
- export interface UpdateSelfUpgradeConfigurationRequest {
8463
+ export interface UpdateQuickSightQSearchConfigurationRequest {
8259
8464
  /**
8260
- * <p>The ID of the Amazon Web Services account that contains the Quick self-upgrade configuration that you want to update.</p>
8465
+ * <p>The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that you want to update.</p>
8261
8466
  * @public
8262
8467
  */
8263
8468
  AwsAccountId: string | undefined;
8264
8469
  /**
8265
- * <p>The Quick namespace that you want to update the Quick self-upgrade configuration for.</p>
8266
- * @public
8267
- */
8268
- Namespace: string | undefined;
8269
- /**
8270
- * <p>The self-upgrade status that you want to set for the Quick account.</p>
8271
- * @public
8272
- */
8273
- SelfUpgradeStatus: SelfUpgradeStatus | undefined;
8274
- }
8275
- /**
8276
- * @public
8277
- */
8278
- export interface UpdateSelfUpgradeConfigurationResponse {
8279
- /**
8280
- * <p>The Amazon Web Services request ID for this operation.</p>
8281
- * @public
8282
- */
8283
- RequestId?: string | undefined;
8284
- /**
8285
- * <p>The HTTP status of the request.</p>
8470
+ * <p>The status of the Quick Sight Q Search configuration that the user wants to update.</p>
8286
8471
  * @public
8287
8472
  */
8288
- Status?: number | undefined;
8473
+ QSearchStatus: QSearchStatus | undefined;
8289
8474
  }
8290
8475
  /**
8291
8476
  * @public
8292
8477
  */
8293
- export interface UpdateSPICECapacityConfigurationRequest {
8294
- /**
8295
- * <p>The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.</p>
8296
- * @public
8297
- */
8298
- AwsAccountId: string | undefined;
8478
+ export interface UpdateQuickSightQSearchConfigurationResponse {
8299
8479
  /**
8300
- * <p>Determines how SPICE capacity can be purchased. The following options are available. </p>
8301
- * <ul>
8302
- * <li>
8303
- * <p>
8304
- * <code>MANUAL</code>: SPICE capacity can only be purchased manually.</p>
8305
- * </li>
8306
- * <li>
8307
- * <p>
8308
- * <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>
8309
- * </li>
8310
- * </ul>
8480
+ * <p>The status of the Quick Sight Q Search configuration.</p>
8311
8481
  * @public
8312
8482
  */
8313
- PurchaseMode: PurchaseMode | undefined;
8314
- }
8315
- /**
8316
- * @public
8317
- */
8318
- export interface UpdateSPICECapacityConfigurationResponse {
8483
+ QSearchStatus?: QSearchStatus | undefined;
8319
8484
  /**
8320
8485
  * <p>The Amazon Web Services request ID for this operation.</p>
8321
8486
  * @public
@@ -8330,80 +8495,27 @@ export interface UpdateSPICECapacityConfigurationResponse {
8330
8495
  /**
8331
8496
  * @public
8332
8497
  */
8333
- export interface UpdateTemplateRequest {
8334
- /**
8335
- * <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
8336
- * @public
8337
- */
8338
- AwsAccountId: string | undefined;
8339
- /**
8340
- * <p>The ID for the template.</p>
8341
- * @public
8342
- */
8343
- TemplateId: string | undefined;
8344
- /**
8345
- * <p>The entity that you are using as a source when you update the template. In
8346
- * <code>SourceEntity</code>, you specify the type of object you're using as source:
8347
- * <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an
8348
- * analysis. Both of these require an Amazon Resource Name (ARN). For
8349
- * <code>SourceTemplate</code>, specify the ARN of the source template. For
8350
- * <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>
8351
- * ARN can contain any Amazon Web Services account and any Quick Sight-supported Amazon Web Services Region;. </p>
8352
- * <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or
8353
- * <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed
8354
- * in the original. The schema in each dataset must match its placeholder. </p>
8355
- * @public
8356
- */
8357
- SourceEntity?: TemplateSourceEntity | undefined;
8358
- /**
8359
- * <p>A description of the current template version that is being updated. Every time you call
8360
- * <code>UpdateTemplate</code>, you create a new version of the template. Each version
8361
- * of the template maintains a description of the version in the
8362
- * <code>VersionDescription</code> field.</p>
8363
- * @public
8364
- */
8365
- VersionDescription?: string | undefined;
8498
+ export interface UpdateRefreshScheduleRequest {
8366
8499
  /**
8367
- * <p>The name for the template.</p>
8500
+ * <p>The ID of the dataset.</p>
8368
8501
  * @public
8369
8502
  */
8370
- Name?: string | undefined;
8503
+ DataSetId: string | undefined;
8371
8504
  /**
8372
- * <p>The definition of a template.</p>
8373
- * <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
8505
+ * <p>The Amazon Web Services account ID.</p>
8374
8506
  * @public
8375
8507
  */
8376
- Definition?: TemplateVersionDefinition | undefined;
8508
+ AwsAccountId: string | undefined;
8377
8509
  /**
8378
- * <p>The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.</p>
8510
+ * <p>The refresh schedule.</p>
8379
8511
  * @public
8380
8512
  */
8381
- ValidationStrategy?: ValidationStrategy | undefined;
8513
+ Schedule: RefreshSchedule | undefined;
8382
8514
  }
8383
8515
  /**
8384
8516
  * @public
8385
8517
  */
8386
- export interface UpdateTemplateResponse {
8387
- /**
8388
- * <p>The ID for the template.</p>
8389
- * @public
8390
- */
8391
- TemplateId?: string | undefined;
8392
- /**
8393
- * <p>The Amazon Resource Name (ARN) for the template.</p>
8394
- * @public
8395
- */
8396
- Arn?: string | undefined;
8397
- /**
8398
- * <p>The ARN for the template, including the version information of the first version.</p>
8399
- * @public
8400
- */
8401
- VersionArn?: string | undefined;
8402
- /**
8403
- * <p>The creation status of the template.</p>
8404
- * @public
8405
- */
8406
- CreationStatus?: ResourceStatus | undefined;
8518
+ export interface UpdateRefreshScheduleResponse {
8407
8519
  /**
8408
8520
  * <p>The HTTP status of the request.</p>
8409
8521
  * @public
@@ -8414,77 +8526,39 @@ export interface UpdateTemplateResponse {
8414
8526
  * @public
8415
8527
  */
8416
8528
  RequestId?: string | undefined;
8417
- }
8418
- /**
8419
- * @public
8420
- */
8421
- export interface UpdateTemplateAliasRequest {
8422
- /**
8423
- * <p>The ID of the Amazon Web Services account that contains the template alias that you're updating.</p>
8424
- * @public
8425
- */
8426
- AwsAccountId: string | undefined;
8427
- /**
8428
- * <p>The ID for the template.</p>
8429
- * @public
8430
- */
8431
- TemplateId: string | undefined;
8432
8529
  /**
8433
- * <p>The alias of the template that you want to update. If you name a specific alias, you update
8434
- * the version that the alias points to. You can specify the latest version of the template
8435
- * by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter.
8436
- * The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
8530
+ * <p>The ID of the refresh schedule.</p>
8437
8531
  * @public
8438
8532
  */
8439
- AliasName: string | undefined;
8533
+ ScheduleId?: string | undefined;
8440
8534
  /**
8441
- * <p>The version number of the template.</p>
8535
+ * <p>The Amazon Resource Name (ARN) for the refresh schedule.</p>
8442
8536
  * @public
8443
8537
  */
8444
- TemplateVersionNumber: number | undefined;
8538
+ Arn?: string | undefined;
8445
8539
  }
8446
8540
  /**
8447
8541
  * @public
8448
8542
  */
8449
- export interface UpdateTemplateAliasResponse {
8450
- /**
8451
- * <p>The template alias.</p>
8452
- * @public
8453
- */
8454
- TemplateAlias?: TemplateAlias | undefined;
8543
+ export interface UpdateRoleCustomPermissionRequest {
8455
8544
  /**
8456
- * <p>The HTTP status of the request.</p>
8545
+ * <p>The name of the custom permission that you want to update the role with.</p>
8457
8546
  * @public
8458
8547
  */
8459
- Status?: number | undefined;
8548
+ CustomPermissionsName: string | undefined;
8460
8549
  /**
8461
- * <p>The Amazon Web Services request ID for this operation.</p>
8550
+ * <p>The name of role tht you want to update.</p>
8462
8551
  * @public
8463
8552
  */
8464
- RequestId?: string | undefined;
8465
- }
8466
- /**
8467
- * @public
8468
- */
8469
- export interface UpdateTemplatePermissionsRequest {
8553
+ Role: Role | undefined;
8470
8554
  /**
8471
- * <p>The ID of the Amazon Web Services account that contains the template.</p>
8555
+ * <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 Quick Sight account.</p>
8472
8556
  * @public
8473
8557
  */
8474
8558
  AwsAccountId: string | undefined;
8475
8559
  /**
8476
- * <p>The ID for the template.</p>
8477
- * @public
8478
- */
8479
- TemplateId: string | undefined;
8480
- /**
8481
- * <p>A list of resource permissions to be granted on the template. </p>
8482
- * @public
8483
- */
8484
- GrantPermissions?: ResourcePermission[] | undefined;
8485
- /**
8486
- * <p>A list of resource permissions to be revoked from the template. </p>
8560
+ * <p>The namespace that contains the role that you want to update.</p>
8487
8561
  * @public
8488
8562
  */
8489
- RevokePermissions?: ResourcePermission[] | undefined;
8563
+ Namespace: string | undefined;
8490
8564
  }