@aws-sdk/client-grafana 3.991.0 → 3.992.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 (32) hide show
  1. package/README.md +1 -9
  2. package/dist-cjs/schemas/schemas_0.js +5 -4
  3. package/dist-es/schemas/schemas_0.js +5 -4
  4. package/dist-types/Grafana.d.ts +1 -9
  5. package/dist-types/GrafanaClient.d.ts +1 -9
  6. package/dist-types/commands/AssociateLicenseCommand.d.ts +2 -5
  7. package/dist-types/commands/CreateWorkspaceApiKeyCommand.d.ts +1 -7
  8. package/dist-types/commands/CreateWorkspaceCommand.d.ts +3 -5
  9. package/dist-types/commands/CreateWorkspaceServiceAccountCommand.d.ts +1 -13
  10. package/dist-types/commands/CreateWorkspaceServiceAccountTokenCommand.d.ts +1 -13
  11. package/dist-types/commands/DeleteWorkspaceApiKeyCommand.d.ts +1 -5
  12. package/dist-types/commands/DeleteWorkspaceCommand.d.ts +1 -0
  13. package/dist-types/commands/DeleteWorkspaceServiceAccountCommand.d.ts +1 -6
  14. package/dist-types/commands/DeleteWorkspaceServiceAccountTokenCommand.d.ts +1 -6
  15. package/dist-types/commands/DescribeWorkspaceAuthenticationCommand.d.ts +1 -2
  16. package/dist-types/commands/DescribeWorkspaceCommand.d.ts +1 -0
  17. package/dist-types/commands/DisassociateLicenseCommand.d.ts +1 -0
  18. package/dist-types/commands/ListPermissionsCommand.d.ts +1 -6
  19. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -4
  20. package/dist-types/commands/ListVersionsCommand.d.ts +1 -3
  21. package/dist-types/commands/ListWorkspaceServiceAccountTokensCommand.d.ts +1 -7
  22. package/dist-types/commands/ListWorkspaceServiceAccountsCommand.d.ts +1 -3
  23. package/dist-types/commands/ListWorkspacesCommand.d.ts +1 -2
  24. package/dist-types/commands/TagResourceCommand.d.ts +1 -6
  25. package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
  26. package/dist-types/commands/UpdatePermissionsCommand.d.ts +1 -2
  27. package/dist-types/commands/UpdateWorkspaceAuthenticationCommand.d.ts +1 -8
  28. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +2 -6
  29. package/dist-types/index.d.ts +1 -9
  30. package/dist-types/models/models_0.d.ts +119 -400
  31. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  32. package/package.json +2 -2
package/dist-types/models/models_0.d.ts CHANGED
@@ -10,15 +10,12 @@ export interface CreateWorkspaceApiKeyRequest {
10
10
  */
11
11
  keyName: string | undefined;
12
12
  /**
13
- * <p>Specifies the permission level of the key.</p>
14
- * <p> Valid values: <code>ADMIN</code>|<code>EDITOR</code>|<code>VIEWER</code>
15
- * </p>
13
+ * <p>Specifies the permission level of the key.</p> <p> Valid values: <code>ADMIN</code>|<code>EDITOR</code>|<code>VIEWER</code> </p>
16
14
  * @public
17
15
  */
18
16
  keyRole: string | undefined;
19
17
  /**
20
- * <p>Specifies the time in seconds until the key expires. Keys can be valid for up to 30
21
- * days.</p>
18
+ * <p>Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.</p>
22
19
  * @public
23
20
  */
24
21
  secondsToLive: number | undefined;
@@ -38,8 +35,7 @@ export interface CreateWorkspaceApiKeyResponse {
38
35
  */
39
36
  keyName: string | undefined;
40
37
  /**
41
- * <p>The key token. Use this value as a bearer token to authenticate HTTP requests to the
42
- * workspace.</p>
38
+ * <p>The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.</p>
43
39
  * @public
44
40
  */
45
41
  key: string | undefined;
@@ -50,8 +46,7 @@ export interface CreateWorkspaceApiKeyResponse {
50
46
  workspaceId: string | undefined;
51
47
  }
52
48
  /**
53
- * <p>A structure that contains information about a request parameter that caused an
54
- * error.</p>
49
+ * <p>A structure that contains information about a request parameter that caused an error.</p>
55
50
  * @public
56
51
  */
57
52
  export interface ValidationExceptionField {
@@ -97,32 +92,27 @@ export interface DeleteWorkspaceApiKeyResponse {
97
92
  workspaceId: string | undefined;
98
93
  }
99
94
  /**
100
- * <p>A structure that defines which attributes in the IdP assertion are to be used to
101
- * define information about the users authenticated by the IdP to use the workspace.</p>
95
+ * <p>A structure that defines which attributes in the IdP assertion are to be used to define information about the users authenticated by the IdP to use the workspace.</p>
102
96
  * @public
103
97
  */
104
98
  export interface AssertionAttributes {
105
99
  /**
106
- * <p>The name of the attribute within the SAML assertion to use as the user full "friendly"
107
- * names for SAML users.</p>
100
+ * <p>The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.</p>
108
101
  * @public
109
102
  */
110
103
  name?: string | undefined;
111
104
  /**
112
- * <p>The name of the attribute within the SAML assertion to use as the login names for SAML
113
- * users.</p>
105
+ * <p>The name of the attribute within the SAML assertion to use as the login names for SAML users.</p>
114
106
  * @public
115
107
  */
116
108
  login?: string | undefined;
117
109
  /**
118
- * <p>The name of the attribute within the SAML assertion to use as the email names for SAML
119
- * users.</p>
110
+ * <p>The name of the attribute within the SAML assertion to use as the email names for SAML users.</p>
120
111
  * @public
121
112
  */
122
113
  email?: string | undefined;
123
114
  /**
124
- * <p>The name of the attribute within the SAML assertion to use as the user full "friendly"
125
- * names for user groups.</p>
115
+ * <p>The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.</p>
126
116
  * @public
127
117
  */
128
118
  groups?: string | undefined;
@@ -132,8 +122,7 @@ export interface AssertionAttributes {
132
122
  */
133
123
  role?: string | undefined;
134
124
  /**
135
- * <p>The name of the attribute within the SAML assertion to use as the user full "friendly"
136
- * names for the users' organizations.</p>
125
+ * <p>The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.</p>
137
126
  * @public
138
127
  */
139
128
  org?: string | undefined;
@@ -148,132 +137,71 @@ export interface AssociateLicenseRequest {
148
137
  */
149
138
  workspaceId: string | undefined;
150
139
  /**
151
- * <p>The type of license to associate with the workspace.</p>
152
- * <note>
153
- * <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p>
154
- * </note>
140
+ * <p>The type of license to associate with the workspace.</p> <note> <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p> </note>
155
141
  * @public
156
142
  */
157
143
  licenseType: LicenseType | undefined;
158
144
  /**
159
- * <p>A token from Grafana Labs that ties your Amazon Web Services account with a Grafana
160
- * Labs account. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Link your account with Grafana Labs</a>.</p>
145
+ * <p>A token from Grafana Labs that ties your Amazon Web Services account with a Grafana Labs account. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Link your account with Grafana Labs</a>.</p>
161
146
  * @public
162
147
  */
163
148
  grafanaToken?: string | undefined;
164
149
  }
165
150
  /**
166
- * <p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or
167
- * both methods for user authentication, and whether that authentication is fully
168
- * configured.</p>
151
+ * <p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication, and whether that authentication is fully configured.</p>
169
152
  * @public
170
153
  */
171
154
  export interface AuthenticationSummary {
172
155
  /**
173
- * <p>Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for
174
- * user authentication.</p>
156
+ * <p>Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.</p>
175
157
  * @public
176
158
  */
177
159
  providers: AuthenticationProviderTypes[] | undefined;
178
160
  /**
179
- * <p>Specifies whether the workplace's user authentication method is fully
180
- * configured.</p>
161
+ * <p>Specifies whether the workplace's user authentication method is fully configured.</p>
181
162
  * @public
182
163
  */
183
164
  samlConfigurationStatus?: SamlConfigurationStatus | undefined;
184
165
  }
185
166
  /**
186
- * <p>The configuration settings for in-bound network access to your workspace.</p>
187
- * <p>When this is configured, only listed IP addresses and VPC endpoints will be able to
188
- * access your workspace. Standard Grafana authentication and authorization are still
189
- * required.</p>
190
- * <p>Access is granted to a caller that is in either the IP address list or the VPC
191
- * endpoint list - they do not need to be in both.</p>
192
- * <p>If this is not configured, or is removed, then all IP addresses and VPC endpoints are
193
- * allowed. Standard Grafana authentication and authorization are still
194
- * required.</p>
195
- * <note>
196
- * <p>While both <code>prefixListIds</code> and <code>vpceIds</code> are required, you
197
- * can pass in an empty array of strings for either parameter if you do not want to allow any
198
- * of that type.</p>
199
- * <p>If both are passed as empty arrays, no traffic is allowed to the workspace,
200
- * because only <i>explicitly</i> allowed connections are accepted.</p>
201
- * </note>
167
+ * <p>The configuration settings for in-bound network access to your workspace.</p> <p>When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization are still required.</p> <p>Access is granted to a caller that is in either the IP address list or the VPC endpoint list - they do not need to be in both.</p> <p>If this is not configured, or is removed, then all IP addresses and VPC endpoints are allowed. Standard Grafana authentication and authorization are still required.</p> <note> <p>While both <code>prefixListIds</code> and <code>vpceIds</code> are required, you can pass in an empty array of strings for either parameter if you do not want to allow any of that type.</p> <p>If both are passed as empty arrays, no traffic is allowed to the workspace, because only <i>explicitly</i> allowed connections are accepted.</p> </note>
202
168
  * @public
203
169
  */
204
170
  export interface NetworkAccessConfiguration {
205
171
  /**
206
- * <p>An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses.
207
- * The IP addresses specified are allowed to access your workspace. If the list is not
208
- * included in the configuration (passed an empty array) then no IP addresses are
209
- * allowed to access the workspace. You create a prefix list using the Amazon VPC
210
- * console.</p>
211
- * <p>Prefix list IDs have the format <code>pl-<i>1a2b3c4d</i>
212
- * </code>.</p>
213
- * <p>For more information about prefix lists, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html">Group CIDR blocks using managed
214
- * prefix lists</a>in the <i>Amazon Virtual Private Cloud User
215
- * Guide</i>.</p>
172
+ * <p>An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.</p> <p>Prefix list IDs have the format <code>pl-<i>1a2b3c4d</i> </code>.</p> <p>For more information about prefix lists, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html">Group CIDR blocks using managed prefix lists</a>in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
216
173
  * @public
217
174
  */
218
175
  prefixListIds: string[] | undefined;
219
176
  /**
220
- * <p>An array of Amazon VPC endpoint IDs for the workspace. You can create VPC
221
- * endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a
222
- * <code>NetworkAccessConfiguration</code> is specified then only VPC endpoints
223
- * specified here are allowed to access the workspace. If you pass in an empty array
224
- * of strings, then no VPCs are allowed to access the workspace.</p>
225
- * <p>VPC endpoint IDs have the format
226
- * <code>vpce-<i>1a2b3c4d</i>
227
- * </code>.</p>
228
- * <p>For more information about creating an interface VPC endpoint, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints">Interface VPC
229
- * endpoints</a> in the <i>Amazon Managed Grafana User
230
- * Guide</i>.</p>
231
- * <note>
232
- * <p>The only VPC endpoints that can be specified here are interface VPC endpoints for
233
- * Grafana workspaces (using the <code>com.amazonaws.[region].grafana-workspace</code>
234
- * service endpoint). Other VPC endpoints are ignored.</p>
235
- * </note>
177
+ * <p>An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a <code>NetworkAccessConfiguration</code> is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.</p> <p>VPC endpoint IDs have the format <code>vpce-<i>1a2b3c4d</i> </code>.</p> <p>For more information about creating an interface VPC endpoint, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints">Interface VPC endpoints</a> in the <i>Amazon Managed Grafana User Guide</i>.</p> <note> <p>The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the <code>com.amazonaws.[region].grafana-workspace</code> service endpoint). Other VPC endpoints are ignored.</p> </note>
236
178
  * @public
237
179
  */
238
180
  vpceIds: string[] | undefined;
239
181
  }
240
182
  /**
241
- * <p>The configuration settings for an Amazon VPC that contains data sources for
242
- * your Grafana workspace to connect to.</p>
243
- * <note>
244
- * <p>Provided <code>securityGroupIds</code> and <code>subnetIds</code> must be part of
245
- * the same VPC.</p>
246
- * <p>Connecting to a private VPC is not yet available in the Asia Pacific (Seoul)
247
- * Region (ap-northeast-2).</p>
248
- * </note>
183
+ * <p>The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.</p> <note> <p>Provided <code>securityGroupIds</code> and <code>subnetIds</code> must be part of the same VPC.</p> <p>Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).</p> </note>
249
184
  * @public
250
185
  */
251
186
  export interface VpcConfiguration {
252
187
  /**
253
- * <p>The list of Amazon EC2 security group IDs attached to the Amazon VPC
254
- * for your Grafana workspace to connect. Duplicates not allowed.</p>
188
+ * <p>The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.</p>
255
189
  * @public
256
190
  */
257
191
  securityGroupIds: string[] | undefined;
258
192
  /**
259
- * <p>The list of Amazon EC2 subnet IDs created in the Amazon VPC for your
260
- * Grafana workspace to connect. Duplicates not allowed.</p>
193
+ * <p>The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.</p>
261
194
  * @public
262
195
  */
263
196
  subnetIds: string[] | undefined;
264
197
  }
265
198
  /**
266
- * <p>A structure containing information about an Amazon Managed Grafana workspace in your
267
- * account.</p>
199
+ * <p>A structure containing information about an Amazon Managed Grafana workspace in your account.</p>
268
200
  * @public
269
201
  */
270
202
  export interface WorkspaceDescription {
271
203
  /**
272
- * <p>Specifies whether the workspace can access Amazon Web Services resources in this
273
- * Amazon Web Services account only, or whether it can also access Amazon Web Services
274
- * resources in other accounts in the same organization. If this is
275
- * <code>ORGANIZATION</code>, the <code>workspaceOrganizationalUnits</code> parameter
276
- * specifies which organizational units the workspace can access.</p>
204
+ * <p>Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is <code>ORGANIZATION</code>, the <code>workspaceOrganizationalUnits</code> parameter specifies which organizational units the workspace can access.</p>
277
205
  * @public
278
206
  */
279
207
  accountAccessType?: AccountAccessType | undefined;
@@ -283,11 +211,7 @@ export interface WorkspaceDescription {
283
211
  */
284
212
  created: Date | undefined;
285
213
  /**
286
- * <p>Specifies the Amazon Web Services data sources that have been configured to have
287
- * IAM roles and permissions created to allow Amazon Managed Grafana to read
288
- * data from these sources.</p>
289
- * <p>This list is only used when the workspace was created through the Amazon Web Services
290
- * console, and the <code>permissionType</code> is <code>SERVICE_MANAGED</code>.</p>
214
+ * <p>Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.</p> <p>This list is only used when the workspace was created through the Amazon Web Services console, and the <code>permissionType</code> is <code>SERVICE_MANAGED</code>.</p>
291
215
  * @public
292
216
  */
293
217
  dataSources: DataSourceType[] | undefined;
@@ -322,42 +246,22 @@ export interface WorkspaceDescription {
322
246
  */
323
247
  name?: string | undefined;
324
248
  /**
325
- * <p>The name of the IAM role that is used to access resources through
326
- * Organizations.</p>
249
+ * <p>The name of the IAM role that is used to access resources through Organizations.</p>
327
250
  * @public
328
251
  */
329
252
  organizationRoleName?: string | undefined;
330
253
  /**
331
- * <p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically
332
- * create IAM roles and permissions for, to allow Amazon Managed Grafana to use
333
- * these channels.</p>
254
+ * <p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.</p>
334
255
  * @public
335
256
  */
336
257
  notificationDestinations?: NotificationDestinationType[] | undefined;
337
258
  /**
338
- * <p>Specifies the organizational units that this workspace is allowed to use data sources
339
- * from, if this workspace is in an account that is part of an organization.</p>
259
+ * <p>Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.</p>
340
260
  * @public
341
261
  */
342
262
  organizationalUnits?: string[] | undefined;
343
263
  /**
344
- * <p>If this is <code>SERVICE_MANAGED</code>, and the workplace was created through the
345
- * Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the
346
- * IAM roles and provisions the permissions that the workspace needs to
347
- * use Amazon Web Services data sources and notification channels.</p>
348
- * <p>If this is <code>CUSTOMER_MANAGED</code>, you must manage those roles and permissions
349
- * yourself.</p>
350
- * <p>If you are working with a workspace in a member account of an organization and
351
- * that account is not a delegated administrator account, and you want the workspace to
352
- * access data sources in other Amazon Web Services accounts in the organization, this
353
- * parameter must be set to <code>CUSTOMER_MANAGED</code>.</p>
354
- * <p>For more information about converting between customer and service managed, see
355
- * <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html">Managing permissions for data sources and notification channels</a>. For more
356
- * information about the roles and permissions that must be managed for customer managed
357
- * workspaces, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana
358
- * permissions and policies for Amazon Web Services data sources and notification
359
- * channels</a>
360
- * </p>
264
+ * <p>If this is <code>SERVICE_MANAGED</code>, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.</p> <p>If this is <code>CUSTOMER_MANAGED</code>, you must manage those roles and permissions yourself.</p> <p>If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to <code>CUSTOMER_MANAGED</code>.</p> <p>For more information about converting between customer and service managed, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html">Managing permissions for data sources and notification channels</a>. For more information about the roles and permissions that must be managed for customer managed workspaces, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels</a> </p>
361
265
  * @public
362
266
  */
363
267
  permissionType?: PermissionType | undefined;
@@ -372,49 +276,32 @@ export interface WorkspaceDescription {
372
276
  */
373
277
  status: WorkspaceStatus | undefined;
374
278
  /**
375
- * <p>The IAM role that grants permissions to the Amazon Web Services
376
- * resources that the workspace will view data from. This role must already exist.</p>
279
+ * <p>The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.</p>
377
280
  * @public
378
281
  */
379
282
  workspaceRoleArn?: string | undefined;
380
283
  /**
381
- * <p>Specifies whether this workspace has a full Grafana Enterprise license.</p>
382
- * <note>
383
- * <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p>
384
- * </note>
284
+ * <p>Specifies whether this workspace has a full Grafana Enterprise license.</p> <note> <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p> </note>
385
285
  * @public
386
286
  */
387
287
  licenseType?: LicenseType | undefined;
388
288
  /**
389
- * <p>Specifies whether this workspace has already fully used its free trial for Grafana
390
- * Enterprise.</p>
391
- * <note>
392
- * <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p>
393
- * </note>
289
+ * <p>Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.</p> <note> <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p> </note>
394
290
  * @public
395
291
  */
396
292
  freeTrialConsumed?: boolean | undefined;
397
293
  /**
398
- * <p>If this workspace has a full Grafana Enterprise license purchased through
399
- * Amazon Web Services Marketplace, this specifies when the
400
- * license ends and will need to be renewed. Purchasing the Enterprise plugins option
401
- * through Amazon Managed Grafana does not have an expiration. It is valid until the
402
- * license is removed.</p>
294
+ * <p>If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.</p>
403
295
  * @public
404
296
  */
405
297
  licenseExpiration?: Date | undefined;
406
298
  /**
407
- * <p>If this workspace is currently in the free trial period for Grafana Enterprise, this
408
- * value specifies when that free trial ends.</p>
409
- * <note>
410
- * <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p>
411
- * </note>
299
+ * <p>If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.</p> <note> <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p> </note>
412
300
  * @public
413
301
  */
414
302
  freeTrialExpiration?: Date | undefined;
415
303
  /**
416
- * <p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or
417
- * both methods for user authentication.</p>
304
+ * <p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.</p>
418
305
  * @public
419
306
  */
420
307
  authentication: AuthenticationSummary | undefined;
@@ -434,11 +321,15 @@ export interface WorkspaceDescription {
434
321
  */
435
322
  networkAccessControl?: NetworkAccessConfiguration | undefined;
436
323
  /**
437
- * <p>The token that ties this workspace to a Grafana Labs account. For more information,
438
- * see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Link your account with Grafana Labs</a>.</p>
324
+ * <p>The token that ties this workspace to a Grafana Labs account. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Link your account with Grafana Labs</a>.</p>
439
325
  * @public
440
326
  */
441
327
  grafanaToken?: string | undefined;
328
+ /**
329
+ * <p>The ID or ARN of the Key Management Service key used for encrypting workspace data.</p>
330
+ * @public
331
+ */
332
+ kmsKeyId?: string | undefined;
442
333
  }
443
334
  /**
444
335
  * @public
@@ -472,11 +363,7 @@ export interface AwsSsoAuthentication {
472
363
  ssoClientId?: string | undefined;
473
364
  }
474
365
  /**
475
- * <p>A structure containing the identity provider (IdP) metadata used to integrate the
476
- * identity provider with this workspace. You can specify the metadata either by providing
477
- * a URL to its location in the <code>url</code> parameter, or by specifying the full
478
- * metadata in XML format in the <code>xml</code> parameter. Specifying both will cause an
479
- * error.</p>
366
+ * <p>A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. You can specify the metadata either by providing a URL to its location in the <code>url</code> parameter, or by specifying the full metadata in XML format in the <code>xml</code> parameter. Specifying both will cause an error.</p>
480
367
  * @public
481
368
  */
482
369
  export type IdpMetadata = IdpMetadata.UrlMember | IdpMetadata.XmlMember | IdpMetadata.$UnknownMember;
@@ -521,22 +408,17 @@ export declare namespace IdpMetadata {
521
408
  }
522
409
  }
523
410
  /**
524
- * <p>This structure defines which groups defined in the SAML assertion attribute are to be
525
- * mapped to the Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.
526
- * SAML authenticated users not part of <code>Admin</code> or <code>Editor</code> role
527
- * groups have <code>Viewer</code> permission over the workspace.</p>
411
+ * <p>This structure defines which groups defined in the SAML assertion attribute are to be mapped to the Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace. SAML authenticated users not part of <code>Admin</code> or <code>Editor</code> role groups have <code>Viewer</code> permission over the workspace.</p>
528
412
  * @public
529
413
  */
530
414
  export interface RoleValues {
531
415
  /**
532
- * <p>A list of groups from the SAML assertion attribute to grant the Grafana
533
- * <code>Editor</code> role to.</p>
416
+ * <p>A list of groups from the SAML assertion attribute to grant the Grafana <code>Editor</code> role to.</p>
534
417
  * @public
535
418
  */
536
419
  editor?: string[] | undefined;
537
420
  /**
538
- * <p>A list of groups from the SAML assertion attribute to grant the Grafana
539
- * <code>Admin</code> role to.</p>
421
+ * <p>A list of groups from the SAML assertion attribute to grant the Grafana <code>Admin</code> role to.</p>
540
422
  * @public
541
423
  */
542
424
  admin?: string[] | undefined;
@@ -547,33 +429,27 @@ export interface RoleValues {
547
429
  */
548
430
  export interface SamlConfiguration {
549
431
  /**
550
- * <p>A structure containing the identity provider (IdP) metadata used to integrate the
551
- * identity provider with this workspace.</p>
432
+ * <p>A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.</p>
552
433
  * @public
553
434
  */
554
435
  idpMetadata: IdpMetadata | undefined;
555
436
  /**
556
- * <p>A structure that defines which attributes in the SAML assertion are to be used to
557
- * define information about the users authenticated by that IdP to use the
558
- * workspace.</p>
437
+ * <p>A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.</p>
559
438
  * @public
560
439
  */
561
440
  assertionAttributes?: AssertionAttributes | undefined;
562
441
  /**
563
- * <p>A structure containing arrays that map group names in the SAML assertion to the
564
- * Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
442
+ * <p>A structure containing arrays that map group names in the SAML assertion to the Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
565
443
  * @public
566
444
  */
567
445
  roleValues?: RoleValues | undefined;
568
446
  /**
569
- * <p>Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute
570
- * have access.</p>
447
+ * <p>Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.</p>
571
448
  * @public
572
449
  */
573
450
  allowedOrganizations?: string[] | undefined;
574
451
  /**
575
- * <p>How long a sign-on session by a SAML user is valid, before the user has to sign on
576
- * again.</p>
452
+ * <p>How long a sign-on session by a SAML user is valid, before the user has to sign on again.</p>
577
453
  * @public
578
454
  */
579
455
  loginValidityDuration?: number | undefined;
@@ -595,22 +471,17 @@ export interface SamlAuthentication {
595
471
  configuration?: SamlConfiguration | undefined;
596
472
  }
597
473
  /**
598
- * <p>A structure containing information about the user authentication methods used by the
599
- * workspace.</p>
474
+ * <p>A structure containing information about the user authentication methods used by the workspace.</p>
600
475
  * @public
601
476
  */
602
477
  export interface AuthenticationDescription {
603
478
  /**
604
- * <p>Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to
605
- * authenticate users to use the Grafana console in the Amazon Managed Grafana
606
- * workspace.</p>
479
+ * <p>Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.</p>
607
480
  * @public
608
481
  */
609
482
  providers: AuthenticationProviderTypes[] | undefined;
610
483
  /**
611
- * <p>A structure containing information about how this workspace works with SAML, including
612
- * what attributes within the assertion are to be mapped to user information in the
613
- * workspace. </p>
484
+ * <p>A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace. </p>
614
485
  * @public
615
486
  */
616
487
  saml?: SamlAuthentication | undefined;
@@ -625,8 +496,7 @@ export interface AuthenticationDescription {
625
496
  */
626
497
  export interface DescribeWorkspaceAuthenticationResponse {
627
498
  /**
628
- * <p>A structure containing information about the authentication methods used in the
629
- * workspace.</p>
499
+ * <p>A structure containing information about the authentication methods used in the workspace.</p>
630
500
  * @public
631
501
  */
632
502
  authentication: AuthenticationDescription | undefined;
@@ -641,17 +511,12 @@ export interface UpdateWorkspaceAuthenticationRequest {
641
511
  */
642
512
  workspaceId: string | undefined;
643
513
  /**
644
- * <p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to
645
- * authenticate users for using the Grafana console within a workspace. For more
646
- * information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in
647
- * Amazon Managed Grafana</a>.</p>
514
+ * <p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in Amazon Managed Grafana</a>.</p>
648
515
  * @public
649
516
  */
650
517
  authenticationProviders: AuthenticationProviderTypes[] | undefined;
651
518
  /**
652
- * <p>If the workspace uses SAML, use this structure to map SAML assertion attributes to
653
- * workspace user information and define which groups in the assertion attribute are to
654
- * have the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
519
+ * <p>If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
655
520
  * @public
656
521
  */
657
522
  samlConfiguration?: SamlConfiguration | undefined;
@@ -661,8 +526,7 @@ export interface UpdateWorkspaceAuthenticationRequest {
661
526
  */
662
527
  export interface UpdateWorkspaceAuthenticationResponse {
663
528
  /**
664
- * <p>A structure that describes the user authentication for this workspace after the update
665
- * is made.</p>
529
+ * <p>A structure that describes the user authentication for this workspace after the update is made.</p>
666
530
  * @public
667
531
  */
668
532
  authentication: AuthenticationDescription | undefined;
@@ -682,9 +546,7 @@ export interface DescribeWorkspaceConfigurationRequest {
682
546
  */
683
547
  export interface DescribeWorkspaceConfigurationResponse {
684
548
  /**
685
- * <p>The configuration string for the workspace that you requested. For more information
686
- * about the format and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana
687
- * workspace</a>.</p>
549
+ * <p>The configuration string for the workspace that you requested. For more information about the format and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana workspace</a>.</p>
688
550
  * @public
689
551
  */
690
552
  configuration: __AutomaticJsonStringConversion | string | undefined;
@@ -699,9 +561,7 @@ export interface DescribeWorkspaceConfigurationResponse {
699
561
  */
700
562
  export interface UpdateWorkspaceConfigurationRequest {
701
563
  /**
702
- * <p>The new configuration string for the workspace. For more information about the format
703
- * and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana
704
- * workspace</a>.</p>
564
+ * <p>The new configuration string for the workspace. For more information about the format and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana workspace</a>.</p>
705
565
  * @public
706
566
  */
707
567
  configuration: __AutomaticJsonStringConversion | string | undefined;
@@ -711,12 +571,7 @@ export interface UpdateWorkspaceConfigurationRequest {
711
571
  */
712
572
  workspaceId: string | undefined;
713
573
  /**
714
- * <p>Specifies the version of Grafana to support in the workspace. If not specified,
715
- * keeps the current version of the workspace.</p>
716
- * <p>Can only be used to upgrade (for example, from 8.4 to 9.4), not
717
- * downgrade (for example, from 9.4 to 8.4).</p>
718
- * <p>To know what versions are available to upgrade to for a specific workspace, see
719
- * the <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html">ListVersions</a> operation.</p>
574
+ * <p>Specifies the version of Grafana to support in the workspace. If not specified, keeps the current version of the workspace.</p> <p>Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).</p> <p>To know what versions are available to upgrade to for a specific workspace, see the <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html">ListVersions</a> operation.</p>
720
575
  * @public
721
576
  */
722
577
  grafanaVersion?: string | undefined;
@@ -781,15 +636,12 @@ export interface ListVersionsRequest {
781
636
  */
782
637
  maxResults?: number | undefined;
783
638
  /**
784
- * <p>The token to use when requesting the next set of results. You receive this token from
785
- * a previous <code>ListVersions</code> operation.</p>
639
+ * <p>The token to use when requesting the next set of results. You receive this token from a previous <code>ListVersions</code> operation.</p>
786
640
  * @public
787
641
  */
788
642
  nextToken?: string | undefined;
789
643
  /**
790
- * <p>The ID of the workspace to list the available upgrade versions. If not included,
791
- * lists all versions of Grafana that are supported for
792
- * <code>CreateWorkspace</code>.</p>
644
+ * <p>The ID of the workspace to list the available upgrade versions. If not included, lists all versions of Grafana that are supported for <code>CreateWorkspace</code>.</p>
793
645
  * @public
794
646
  */
795
647
  workspaceId?: string | undefined;
@@ -799,14 +651,12 @@ export interface ListVersionsRequest {
799
651
  */
800
652
  export interface ListVersionsResponse {
801
653
  /**
802
- * <p>The token to use in a subsequent <code>ListVersions</code> operation to return the
803
- * next set of results.</p>
654
+ * <p>The token to use in a subsequent <code>ListVersions</code> operation to return the next set of results.</p>
804
655
  * @public
805
656
  */
806
657
  nextToken?: string | undefined;
807
658
  /**
808
- * <p>The Grafana versions available to create. If a workspace ID is included in the
809
- * request, the Grafana versions to which this workspace can be upgraded.</p>
659
+ * <p>The Grafana versions available to create. If a workspace ID is included in the request, the Grafana versions to which this workspace can be upgraded.</p>
810
660
  * @public
811
661
  */
812
662
  grafanaVersions?: string[] | undefined;
@@ -821,14 +671,12 @@ export interface ListPermissionsRequest {
821
671
  */
822
672
  maxResults?: number | undefined;
823
673
  /**
824
- * <p>The token to use when requesting the next set of results. You received this token from
825
- * a previous <code>ListPermissions</code> operation.</p>
674
+ * <p>The token to use when requesting the next set of results. You received this token from a previous <code>ListPermissions</code> operation.</p>
826
675
  * @public
827
676
  */
828
677
  nextToken?: string | undefined;
829
678
  /**
830
- * <p>(Optional) If you specify <code>SSO_USER</code>, then only the permissions of IAM Identity Center users are returned. If you specify <code>SSO_GROUP</code>, only the
831
- * permissions of IAM Identity Center groups are returned.</p>
679
+ * <p>(Optional) If you specify <code>SSO_USER</code>, then only the permissions of IAM Identity Center users are returned. If you specify <code>SSO_GROUP</code>, only the permissions of IAM Identity Center groups are returned.</p>
832
680
  * @public
833
681
  */
834
682
  userType?: UserType | undefined;
@@ -854,10 +702,7 @@ export interface ListPermissionsRequest {
854
702
  */
855
703
  export interface User {
856
704
  /**
857
- * <p>The ID of the user or group.</p>
858
- * <p>Pattern:
859
- * <code>^([0-9a-fA-F]\{10\}-|)[A-Fa-f0-9]\{8\}-[A-Fa-f0-9]\{4\}-[A-Fa-f0-9]\{4\}-[A-Fa-f0-9]\{4\}-[A-Fa-f0-9]\{12\}$</code>
860
- * </p>
705
+ * <p>The ID of the user or group.</p> <p>Pattern: <code>^([0-9a-fA-F]\{10\}-|)[A-Fa-f0-9]\{8\}-[A-Fa-f0-9]\{4\}-[A-Fa-f0-9]\{4\}-[A-Fa-f0-9]\{4\}-[A-Fa-f0-9]\{12\}$</code> </p>
861
706
  * @public
862
707
  */
863
708
  id: string | undefined;
@@ -868,8 +713,7 @@ export interface User {
868
713
  type: UserType | undefined;
869
714
  }
870
715
  /**
871
- * <p>A structure containing the identity of one user or group and the <code>Admin</code>,
872
- * <code>Editor</code>, or <code>Viewer</code> role that they have.</p>
716
+ * <p>A structure containing the identity of one user or group and the <code>Admin</code>, <code>Editor</code>, or <code>Viewer</code> role that they have.</p>
873
717
  * @public
874
718
  */
875
719
  export interface PermissionEntry {
@@ -879,8 +723,7 @@ export interface PermissionEntry {
879
723
  */
880
724
  user: User | undefined;
881
725
  /**
882
- * <p>Specifies whether the user or group has the <code>Admin</code>, <code>Editor</code>,
883
- * or <code>Viewer</code> role.</p>
726
+ * <p>Specifies whether the user or group has the <code>Admin</code>, <code>Editor</code>, or <code>Viewer</code> role.</p>
884
727
  * @public
885
728
  */
886
729
  role: Role | undefined;
@@ -890,8 +733,7 @@ export interface PermissionEntry {
890
733
  */
891
734
  export interface ListPermissionsResponse {
892
735
  /**
893
- * <p>The token to use in a subsequent <code>ListPermissions</code> operation to return the
894
- * next set of results.</p>
736
+ * <p>The token to use in a subsequent <code>ListPermissions</code> operation to return the next set of results.</p>
895
737
  * @public
896
738
  */
897
739
  nextToken?: string | undefined;
@@ -912,8 +754,7 @@ export interface UpdateInstruction {
912
754
  */
913
755
  action: UpdateAction | undefined;
914
756
  /**
915
- * <p>The role to add or revoke for the user or the group specified in
916
- * <code>users</code>.</p>
757
+ * <p>The role to add or revoke for the user or the group specified in <code>users</code>.</p>
917
758
  * @public
918
759
  */
919
760
  role: Role | undefined;
@@ -939,8 +780,7 @@ export interface UpdatePermissionsRequest {
939
780
  workspaceId: string | undefined;
940
781
  }
941
782
  /**
942
- * <p>A structure containing information about one error encountered while performing an
943
- * <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a> operation.</p>
783
+ * <p>A structure containing information about one error encountered while performing an <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a> operation.</p>
944
784
  * @public
945
785
  */
946
786
  export interface UpdateError {
@@ -975,17 +815,12 @@ export interface UpdatePermissionsResponse {
975
815
  */
976
816
  export interface CreateWorkspaceServiceAccountRequest {
977
817
  /**
978
- * <p>A name for the service account. The name must be unique within the workspace, as it
979
- * determines the ID associated with the service account.</p>
818
+ * <p>A name for the service account. The name must be unique within the workspace, as it determines the ID associated with the service account.</p>
980
819
  * @public
981
820
  */
982
821
  name: string | undefined;
983
822
  /**
984
- * <p>The permission level to use for this service account.</p>
985
- * <note>
986
- * <p>For more information about the roles and the permissions each has, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/Grafana-user-roles.html">User
987
- * roles</a> in the <i>Amazon Managed Grafana User Guide</i>.</p>
988
- * </note>
823
+ * <p>The permission level to use for this service account.</p> <note> <p>For more information about the roles and the permissions each has, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/Grafana-user-roles.html">User roles</a> in the <i>Amazon Managed Grafana User Guide</i>.</p> </note>
989
824
  * @public
990
825
  */
991
826
  grafanaRole: Role | undefined;
@@ -1060,8 +895,7 @@ export interface ListWorkspaceServiceAccountsRequest {
1060
895
  */
1061
896
  maxResults?: number | undefined;
1062
897
  /**
1063
- * <p>The token for the next set of service accounts to return. (You receive this token
1064
- * from a previous <code>ListWorkspaceServiceAccounts</code> operation.)</p>
898
+ * <p>The token for the next set of service accounts to return. (You receive this token from a previous <code>ListWorkspaceServiceAccounts</code> operation.)</p>
1065
899
  * @public
1066
900
  */
1067
901
  nextToken?: string | undefined;
@@ -1087,14 +921,12 @@ export interface ServiceAccountSummary {
1087
921
  */
1088
922
  name: string | undefined;
1089
923
  /**
1090
- * <p>Returns true if the service account is disabled. Service accounts can be disabled and
1091
- * enabled in the Amazon Managed Grafana console.</p>
924
+ * <p>Returns true if the service account is disabled. Service accounts can be disabled and enabled in the Amazon Managed Grafana console.</p>
1092
925
  * @public
1093
926
  */
1094
927
  isDisabled: string | undefined;
1095
928
  /**
1096
- * <p>The role of the service account, which sets the permission level used when calling
1097
- * Grafana APIs.</p>
929
+ * <p>The role of the service account, which sets the permission level used when calling Grafana APIs.</p>
1098
930
  * @public
1099
931
  */
1100
932
  grafanaRole: Role | undefined;
@@ -1129,8 +961,7 @@ export interface CreateWorkspaceServiceAccountTokenRequest {
1129
961
  */
1130
962
  name: string | undefined;
1131
963
  /**
1132
- * <p>Sets how long the token will be valid, in seconds. You can set the time up to 30
1133
- * days in the future.</p>
964
+ * <p>Sets how long the token will be valid, in seconds. You can set the time up to 30 days in the future.</p>
1134
965
  * @public
1135
966
  */
1136
967
  secondsToLive: number | undefined;
@@ -1146,11 +977,7 @@ export interface CreateWorkspaceServiceAccountTokenRequest {
1146
977
  workspaceId: string | undefined;
1147
978
  }
1148
979
  /**
1149
- * <p>A structure that contains the information about a service account token.</p>
1150
- * <p>This structure is returned when creating the token. It is important to store the
1151
- * <code>key</code> that is returned, as it is not retrievable at a later time.</p>
1152
- * <p>If you lose the key, you can delete and recreate the token, which will create a
1153
- * new key.</p>
980
+ * <p>A structure that contains the information about a service account token.</p> <p>This structure is returned when creating the token. It is important to store the <code>key</code> that is returned, as it is not retrievable at a later time.</p> <p>If you lose the key, you can delete and recreate the token, which will create a new key.</p>
1154
981
  * @public
1155
982
  */
1156
983
  export interface ServiceAccountTokenSummaryWithKey {
@@ -1165,8 +992,7 @@ export interface ServiceAccountTokenSummaryWithKey {
1165
992
  */
1166
993
  name: string | undefined;
1167
994
  /**
1168
- * <p>The key for the service account token. Used when making calls to the Grafana HTTP
1169
- * APIs to authenticate and authorize the requests.</p>
995
+ * <p>The key for the service account token. Used when making calls to the Grafana HTTP APIs to authenticate and authorize the requests.</p>
1170
996
  * @public
1171
997
  */
1172
998
  key: string | undefined;
@@ -1176,8 +1002,7 @@ export interface ServiceAccountTokenSummaryWithKey {
1176
1002
  */
1177
1003
  export interface CreateWorkspaceServiceAccountTokenResponse {
1178
1004
  /**
1179
- * <p>Information about the created token, including the key. Be sure to store the key
1180
- * securely.</p>
1005
+ * <p>Information about the created token, including the key. Be sure to store the key securely.</p>
1181
1006
  * @public
1182
1007
  */
1183
1008
  serviceAccountToken: ServiceAccountTokenSummaryWithKey | undefined;
@@ -1242,8 +1067,7 @@ export interface ListWorkspaceServiceAccountTokensRequest {
1242
1067
  */
1243
1068
  maxResults?: number | undefined;
1244
1069
  /**
1245
- * <p>The token for the next set of service accounts to return. (You receive this token
1246
- * from a previous <code>ListWorkspaceServiceAccountTokens</code> operation.)</p>
1070
+ * <p>The token for the next set of service accounts to return. (You receive this token from a previous <code>ListWorkspaceServiceAccountTokens</code> operation.)</p>
1247
1071
  * @public
1248
1072
  */
1249
1073
  nextToken?: string | undefined;
@@ -1324,8 +1148,7 @@ export interface TagResourceRequest {
1324
1148
  */
1325
1149
  resourceArn: string | undefined;
1326
1150
  /**
1327
- * <p>The list of tag keys and values to associate with the resource. You can associate tag
1328
- * keys only, tags (key and values) only or a combination of tag keys and tags.</p>
1151
+ * <p>The list of tag keys and values to associate with the resource. You can associate tag keys only, tags (key and values) only or a combination of tag keys and tags.</p>
1329
1152
  * @public
1330
1153
  */
1331
1154
  tags: Record<string, string> | undefined;
@@ -1360,49 +1183,27 @@ export interface UntagResourceResponse {
1360
1183
  */
1361
1184
  export interface CreateWorkspaceRequest {
1362
1185
  /**
1363
- * <p>Specifies whether the workspace can access Amazon Web Services resources in this
1364
- * Amazon Web Services account only, or whether it can also access Amazon Web Services
1365
- * resources in other accounts in the same organization. If you specify
1366
- * <code>ORGANIZATION</code>, you must specify which organizational units the workspace
1367
- * can access in the <code>workspaceOrganizationalUnits</code> parameter.</p>
1186
+ * <p>Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify <code>ORGANIZATION</code>, you must specify which organizational units the workspace can access in the <code>workspaceOrganizationalUnits</code> parameter.</p>
1368
1187
  * @public
1369
1188
  */
1370
1189
  accountAccessType: AccountAccessType | undefined;
1371
1190
  /**
1372
- * <p>A unique, case-sensitive, user-provided identifier to ensure the idempotency of the
1373
- * request.</p>
1191
+ * <p>A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>
1374
1192
  * @public
1375
1193
  */
1376
1194
  clientToken?: string | undefined;
1377
1195
  /**
1378
- * <p>The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts
1379
- * in an organization.</p>
1196
+ * <p>The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.</p>
1380
1197
  * @public
1381
1198
  */
1382
1199
  organizationRoleName?: string | undefined;
1383
1200
  /**
1384
- * <p>When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the
1385
- * permissions that the workspace needs to use Amazon Web Services data sources and
1386
- * notification channels.</p>
1387
- * <p>You must also specify a <code>workspaceRoleArn</code> for a role that you will
1388
- * manage for the workspace to use when accessing those datasources and notification
1389
- * channels.</p>
1390
- * <p>The ability for Amazon Managed Grafana to create and update IAM roles on
1391
- * behalf of the user is supported only in the Amazon Managed Grafana console, where this value
1392
- * may be set to <code>SERVICE_MANAGED</code>.</p>
1393
- * <note>
1394
- * <p>Use only the <code>CUSTOMER_MANAGED</code> permission type when creating a
1395
- * workspace with the API, CLI or Amazon Web Services CloudFormation. </p>
1396
- * </note>
1397
- * <p>For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana
1398
- * permissions and policies for Amazon Web Services data sources and notification
1399
- * channels</a>.</p>
1201
+ * <p>When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.</p> <p>You must also specify a <code>workspaceRoleArn</code> for a role that you will manage for the workspace to use when accessing those datasources and notification channels.</p> <p>The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to <code>SERVICE_MANAGED</code>.</p> <note> <p>Use only the <code>CUSTOMER_MANAGED</code> permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation. </p> </note> <p>For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels</a>.</p>
1400
1202
  * @public
1401
1203
  */
1402
1204
  permissionType: PermissionType | undefined;
1403
1205
  /**
1404
- * <p>The name of the CloudFormation stack set to use to generate IAM
1405
- * roles to be used for this workspace.</p>
1206
+ * <p>The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.</p>
1406
1207
  * @public
1407
1208
  */
1408
1209
  stackSetName?: string | undefined;
@@ -1412,10 +1213,7 @@ export interface CreateWorkspaceRequest {
1412
1213
  */
1413
1214
  workspaceDataSources?: DataSourceType[] | undefined;
1414
1215
  /**
1415
- * <p>A description for the workspace. This is used only to help you identify this
1416
- * workspace.</p>
1417
- * <p>Pattern: <code>^[\\p\{L\}\\p\{Z\}\\p\{N\}\\p\{P\}]\{0,2048\}$</code>
1418
- * </p>
1216
+ * <p>A description for the workspace. This is used only to help you identify this workspace.</p> <p>Pattern: <code>^[\\p\{L\}\\p\{Z\}\\p\{N\}\\p\{P\}]\{0,2048\}$</code> </p>
1419
1217
  * @public
1420
1218
  */
1421
1219
  workspaceDescription?: string | undefined;
@@ -1425,31 +1223,22 @@ export interface CreateWorkspaceRequest {
1425
1223
  */
1426
1224
  workspaceName?: string | undefined;
1427
1225
  /**
1428
- * <p>Specify the Amazon Web Services notification channels that you plan to use in this
1429
- * workspace. Specifying these data sources here enables Amazon Managed Grafana to create
1430
- * IAM roles and permissions that allow Amazon Managed Grafana to use these
1431
- * channels.</p>
1226
+ * <p>Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.</p>
1432
1227
  * @public
1433
1228
  */
1434
1229
  workspaceNotificationDestinations?: NotificationDestinationType[] | undefined;
1435
1230
  /**
1436
- * <p>Specifies the organizational units that this workspace is allowed to use data sources
1437
- * from, if this workspace is in an account that is part of an organization.</p>
1231
+ * <p>Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.</p>
1438
1232
  * @public
1439
1233
  */
1440
1234
  workspaceOrganizationalUnits?: string[] | undefined;
1441
1235
  /**
1442
- * <p>Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data
1443
- * sources and notification channels. You are responsible for managing the permissions
1444
- * for this role as new data sources or notification channels are added. </p>
1236
+ * <p>Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added. </p>
1445
1237
  * @public
1446
1238
  */
1447
1239
  workspaceRoleArn?: string | undefined;
1448
1240
  /**
1449
- * <p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to
1450
- * authenticate users for using the Grafana console within a workspace. For more
1451
- * information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in
1452
- * Amazon Managed Grafana</a>.</p>
1241
+ * <p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in Amazon Managed Grafana</a>.</p>
1453
1242
  * @public
1454
1243
  */
1455
1244
  authenticationProviders: AuthenticationProviderTypes[] | undefined;
@@ -1459,41 +1248,30 @@ export interface CreateWorkspaceRequest {
1459
1248
  */
1460
1249
  tags?: Record<string, string> | undefined;
1461
1250
  /**
1462
- * <p>The configuration settings for an Amazon VPC that contains data sources for
1463
- * your Grafana workspace to connect to.</p>
1464
- * <note>
1465
- * <p>Connecting to a private VPC is not yet available in the Asia Pacific (Seoul)
1466
- * Region (ap-northeast-2).</p>
1467
- * </note>
1251
+ * <p>The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.</p> <note> <p>Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).</p> </note>
1468
1252
  * @public
1469
1253
  */
1470
1254
  vpcConfiguration?: VpcConfiguration | undefined;
1471
1255
  /**
1472
- * <p>The configuration string for the workspace that you create. For more information about
1473
- * the format and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana
1474
- * workspace</a>.</p>
1256
+ * <p>The configuration string for the workspace that you create. For more information about the format and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana workspace</a>.</p>
1475
1257
  * @public
1476
1258
  */
1477
1259
  configuration?: __AutomaticJsonStringConversion | string | undefined;
1478
1260
  /**
1479
- * <p>Configuration for network access to your workspace.</p>
1480
- * <p>When this is configured, only listed IP addresses and VPC endpoints will be able to
1481
- * access your workspace. Standard Grafana authentication and authorization will still be
1482
- * required.</p>
1483
- * <p>If this is not configured, or is removed, then all IP addresses and VPC endpoints will
1484
- * be allowed. Standard Grafana authentication and authorization will still be
1485
- * required.</p>
1261
+ * <p>Configuration for network access to your workspace.</p> <p>When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.</p> <p>If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.</p>
1486
1262
  * @public
1487
1263
  */
1488
1264
  networkAccessControl?: NetworkAccessConfiguration | undefined;
1489
1265
  /**
1490
- * <p>Specifies the version of Grafana to support in the new workspace. If not specified,
1491
- * defaults to the latest version (for example, 10.4).</p>
1492
- * <p>To get a list of supported versions, use the <code>ListVersions</code>
1493
- * operation.</p>
1266
+ * <p>Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).</p> <p>To get a list of supported versions, use the <code>ListVersions</code> operation.</p>
1494
1267
  * @public
1495
1268
  */
1496
1269
  grafanaVersion?: string | undefined;
1270
+ /**
1271
+ * <p>The ID or ARN of the Key Management Service key to use for encrypting workspace data.</p>
1272
+ * @public
1273
+ */
1274
+ kmsKeyId?: string | undefined;
1497
1275
  }
1498
1276
  /**
1499
1277
  * @public
@@ -1555,8 +1333,7 @@ export interface ListWorkspacesRequest {
1555
1333
  */
1556
1334
  maxResults?: number | undefined;
1557
1335
  /**
1558
- * <p>The token for the next set of workspaces to return. (You receive this token from a
1559
- * previous <code>ListWorkspaces</code> operation.)</p>
1336
+ * <p>The token for the next set of workspaces to return. (You receive this token from a previous <code>ListWorkspaces</code> operation.)</p>
1560
1337
  * @public
1561
1338
  */
1562
1339
  nextToken?: string | undefined;
@@ -1602,9 +1379,7 @@ export interface WorkspaceSummary {
1602
1379
  */
1603
1380
  name?: string | undefined;
1604
1381
  /**
1605
- * <p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically
1606
- * create IAM roles and permissions for, which allows Amazon Managed Grafana to
1607
- * use these channels.</p>
1382
+ * <p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.</p>
1608
1383
  * @public
1609
1384
  */
1610
1385
  notificationDestinations?: NotificationDestinationType[] | undefined;
@@ -1614,8 +1389,7 @@ export interface WorkspaceSummary {
1614
1389
  */
1615
1390
  status: WorkspaceStatus | undefined;
1616
1391
  /**
1617
- * <p>A structure containing information about the authentication methods used in the
1618
- * workspace.</p>
1392
+ * <p>A structure containing information about the authentication methods used in the workspace.</p>
1619
1393
  * @public
1620
1394
  */
1621
1395
  authentication: AuthenticationSummary | undefined;
@@ -1625,16 +1399,12 @@ export interface WorkspaceSummary {
1625
1399
  */
1626
1400
  tags?: Record<string, string> | undefined;
1627
1401
  /**
1628
- * <p>Specifies whether this workspace has a full Grafana Enterprise license.</p>
1629
- * <note>
1630
- * <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p>
1631
- * </note>
1402
+ * <p>Specifies whether this workspace has a full Grafana Enterprise license.</p> <note> <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p> </note>
1632
1403
  * @public
1633
1404
  */
1634
1405
  licenseType?: LicenseType | undefined;
1635
1406
  /**
1636
- * <p>The token that ties this workspace to a Grafana Labs account. For more information,
1637
- * see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Link your account with Grafana Labs</a>.</p>
1407
+ * <p>The token that ties this workspace to a Grafana Labs account. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Link your account with Grafana Labs</a>.</p>
1638
1408
  * @public
1639
1409
  */
1640
1410
  grafanaToken?: string | undefined;
@@ -1644,8 +1414,7 @@ export interface WorkspaceSummary {
1644
1414
  */
1645
1415
  export interface ListWorkspacesResponse {
1646
1416
  /**
1647
- * <p>An array of structures that contain some information about the workspaces in the
1648
- * account.</p>
1417
+ * <p>An array of structures that contain some information about the workspaces in the account.</p>
1649
1418
  * @public
1650
1419
  */
1651
1420
  workspaces: WorkspaceSummary[] | undefined;
@@ -1660,49 +1429,22 @@ export interface ListWorkspacesResponse {
1660
1429
  */
1661
1430
  export interface UpdateWorkspaceRequest {
1662
1431
  /**
1663
- * <p>Specifies whether the workspace can access Amazon Web Services resources in this
1664
- * Amazon Web Services account only, or whether it can also access Amazon Web Services
1665
- * resources in other accounts in the same organization. If you specify
1666
- * <code>ORGANIZATION</code>, you must specify which organizational units the workspace
1667
- * can access in the <code>workspaceOrganizationalUnits</code> parameter.</p>
1432
+ * <p>Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify <code>ORGANIZATION</code>, you must specify which organizational units the workspace can access in the <code>workspaceOrganizationalUnits</code> parameter.</p>
1668
1433
  * @public
1669
1434
  */
1670
1435
  accountAccessType?: AccountAccessType | undefined;
1671
1436
  /**
1672
- * <p>The name of an IAM role that already exists to use to access resources
1673
- * through Organizations. This can only be used with a workspace that has the
1674
- * <code>permissionType</code> set to <code>CUSTOMER_MANAGED</code>.</p>
1437
+ * <p>The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the <code>permissionType</code> set to <code>CUSTOMER_MANAGED</code>.</p>
1675
1438
  * @public
1676
1439
  */
1677
1440
  organizationRoleName?: string | undefined;
1678
1441
  /**
1679
- * <p>Use this parameter if you want to change a workspace from <code>SERVICE_MANAGED</code>
1680
- * to <code>CUSTOMER_MANAGED</code>. This allows you to manage the permissions that the
1681
- * workspace uses to access datasources and notification channels. If the workspace is
1682
- * in a member Amazon Web Services account of an organization, and that account is not
1683
- * a delegated administrator account, and you want the workspace to access data sources in
1684
- * other Amazon Web Services accounts in the organization, you must choose
1685
- * <code>CUSTOMER_MANAGED</code>.</p>
1686
- * <p>If you specify this as <code>CUSTOMER_MANAGED</code>, you must also specify a
1687
- * <code>workspaceRoleArn</code> that the workspace will use for accessing Amazon Web Services
1688
- * resources.</p>
1689
- * <p>For more information on the role and permissions needed, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for Amazon Web Services data sources
1690
- * and notification channels</a>
1691
- * </p>
1692
- * <note>
1693
- * <p>Do not use this to convert a <code>CUSTOMER_MANAGED</code> workspace to
1694
- * <code>SERVICE_MANAGED</code>. Do not include this
1695
- * parameter if you want to leave the workspace as <code>SERVICE_MANAGED</code>.</p>
1696
- * <p>You can convert a <code>CUSTOMER_MANAGED</code> workspace to
1697
- * <code>SERVICE_MANAGED</code> using the Amazon Managed Grafana console. For more
1698
- * information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html">Managing permissions for data sources and notification channels</a>.</p>
1699
- * </note>
1442
+ * <p>Use this parameter if you want to change a workspace from <code>SERVICE_MANAGED</code> to <code>CUSTOMER_MANAGED</code>. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose <code>CUSTOMER_MANAGED</code>.</p> <p>If you specify this as <code>CUSTOMER_MANAGED</code>, you must also specify a <code>workspaceRoleArn</code> that the workspace will use for accessing Amazon Web Services resources.</p> <p>For more information on the role and permissions needed, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels</a> </p> <note> <p>Do not use this to convert a <code>CUSTOMER_MANAGED</code> workspace to <code>SERVICE_MANAGED</code>. Do not include this parameter if you want to leave the workspace as <code>SERVICE_MANAGED</code>.</p> <p>You can convert a <code>CUSTOMER_MANAGED</code> workspace to <code>SERVICE_MANAGED</code> using the Amazon Managed Grafana console. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html">Managing permissions for data sources and notification channels</a>.</p> </note>
1700
1443
  * @public
1701
1444
  */
1702
1445
  permissionType?: PermissionType | undefined;
1703
1446
  /**
1704
- * <p>The name of the CloudFormation stack set to use to generate IAM
1705
- * roles to be used for this workspace.</p>
1447
+ * <p>The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.</p>
1706
1448
  * @public
1707
1449
  */
1708
1450
  stackSetName?: string | undefined;
@@ -1712,8 +1454,7 @@ export interface UpdateWorkspaceRequest {
1712
1454
  */
1713
1455
  workspaceDataSources?: DataSourceType[] | undefined;
1714
1456
  /**
1715
- * <p>A description for the workspace. This is used only to help you identify this
1716
- * workspace.</p>
1457
+ * <p>A description for the workspace. This is used only to help you identify this workspace.</p>
1717
1458
  * @public
1718
1459
  */
1719
1460
  workspaceDescription?: string | undefined;
@@ -1728,59 +1469,37 @@ export interface UpdateWorkspaceRequest {
1728
1469
  */
1729
1470
  workspaceName?: string | undefined;
1730
1471
  /**
1731
- * <p>Specify the Amazon Web Services notification channels that you plan to use in this
1732
- * workspace. Specifying these data sources here enables Amazon Managed Grafana to create
1733
- * IAM roles and permissions that allow Amazon Managed Grafana to use these
1734
- * channels.</p>
1472
+ * <p>Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.</p>
1735
1473
  * @public
1736
1474
  */
1737
1475
  workspaceNotificationDestinations?: NotificationDestinationType[] | undefined;
1738
1476
  /**
1739
- * <p>Specifies the organizational units that this workspace is allowed to use data sources
1740
- * from, if this workspace is in an account that is part of an organization.</p>
1477
+ * <p>Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.</p>
1741
1478
  * @public
1742
1479
  */
1743
1480
  workspaceOrganizationalUnits?: string[] | undefined;
1744
1481
  /**
1745
- * <p>Specifies an IAM role that grants permissions to Amazon Web Services
1746
- * resources that the workspace accesses, such as data sources and notification channels.
1747
- * If this workspace has <code>permissionType</code>
1748
- * <code>CUSTOMER_MANAGED</code>,
1749
- * then this role is required.</p>
1482
+ * <p>Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has <code>permissionType</code> <code>CUSTOMER_MANAGED</code>, then this role is required.</p>
1750
1483
  * @public
1751
1484
  */
1752
1485
  workspaceRoleArn?: string | undefined;
1753
1486
  /**
1754
- * <p>The configuration settings for an Amazon VPC that contains data sources for
1755
- * your Grafana workspace to connect to.</p>
1487
+ * <p>The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.</p>
1756
1488
  * @public
1757
1489
  */
1758
1490
  vpcConfiguration?: VpcConfiguration | undefined;
1759
1491
  /**
1760
- * <p>Whether to remove the VPC configuration from the workspace.</p>
1761
- * <p>Setting this to <code>true</code> and providing a <code>vpcConfiguration</code> to set
1762
- * will return an error.</p>
1492
+ * <p>Whether to remove the VPC configuration from the workspace.</p> <p>Setting this to <code>true</code> and providing a <code>vpcConfiguration</code> to set will return an error.</p>
1763
1493
  * @public
1764
1494
  */
1765
1495
  removeVpcConfiguration?: boolean | undefined;
1766
1496
  /**
1767
- * <p>The configuration settings for network access to your workspace.</p>
1768
- * <p>When this is configured, only listed IP addresses and VPC endpoints will be able to
1769
- * access your workspace. Standard Grafana authentication and authorization will still be
1770
- * required.</p>
1771
- * <p>If this is not configured, or is removed, then all IP addresses and VPC endpoints will
1772
- * be allowed. Standard Grafana authentication and authorization will still be
1773
- * required.</p>
1497
+ * <p>The configuration settings for network access to your workspace.</p> <p>When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.</p> <p>If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.</p>
1774
1498
  * @public
1775
1499
  */
1776
1500
  networkAccessControl?: NetworkAccessConfiguration | undefined;
1777
1501
  /**
1778
- * <p>Whether to remove the network access configuration from the workspace.</p>
1779
- * <p>Setting this to <code>true</code> and providing a <code>networkAccessControl</code> to
1780
- * set will return an error.</p>
1781
- * <p>If you remove this configuration by setting this to <code>true</code>, then all IP
1782
- * addresses and VPC endpoints will be allowed. Standard Grafana authentication and
1783
- * authorization will still be required.</p>
1502
+ * <p>Whether to remove the network access configuration from the workspace.</p> <p>Setting this to <code>true</code> and providing a <code>networkAccessControl</code> to set will return an error.</p> <p>If you remove this configuration by setting this to <code>true</code>, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.</p>
1784
1503
  * @public
1785
1504
  */
1786
1505
  removeNetworkAccessConfiguration?: boolean | undefined;