@aws-sdk/client-grafana 3.533.0 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/Grafana.d.ts +3 -1
- package/dist-types/GrafanaClient.d.ts +1 -1
- package/dist-types/commands/AssociateLicenseCommand.d.ts +2 -1
- package/dist-types/commands/CreateWorkspaceApiKeyCommand.d.ts +2 -1
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteWorkspaceApiKeyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteWorkspaceCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspaceAuthenticationCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspaceCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspaceConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateLicenseCommand.d.ts +2 -1
- package/dist-types/commands/ListPermissionsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ListWorkspacesCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePermissionsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateWorkspaceAuthenticationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateWorkspaceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateWorkspaceConfigurationCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +209 -209
- package/dist-types/ts3.4/Grafana.d.ts +2 -0
- package/dist-types/ts3.4/commands/AssociateLicenseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateWorkspaceApiKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateWorkspaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteWorkspaceApiKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteWorkspaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspaceAuthenticationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspaceConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateLicenseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPermissionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListWorkspacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdatePermissionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateWorkspaceAuthenticationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateWorkspaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateWorkspaceConfigurationCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
|
|
2
2
|
import { GrafanaServiceException as __BaseException } from "./GrafanaServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You do not have sufficient permissions to perform this action. </p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -31,20 +31,20 @@ export declare const AccountAccessType: {
|
|
|
31
31
|
*/
|
|
32
32
|
export type AccountAccessType = (typeof AccountAccessType)[keyof typeof AccountAccessType];
|
|
33
33
|
/**
|
|
34
|
-
* @public
|
|
35
34
|
* <p>A resource was in an inconsistent state during an update or a deletion.</p>
|
|
35
|
+
* @public
|
|
36
36
|
*/
|
|
37
37
|
export declare class ConflictException extends __BaseException {
|
|
38
38
|
readonly name: "ConflictException";
|
|
39
39
|
readonly $fault: "client";
|
|
40
40
|
/**
|
|
41
|
-
* @public
|
|
42
41
|
* <p>The ID of the resource that is associated with the error.</p>
|
|
42
|
+
* @public
|
|
43
43
|
*/
|
|
44
44
|
resourceId: string | undefined;
|
|
45
45
|
/**
|
|
46
|
-
* @public
|
|
47
46
|
* <p>The type of the resource that is associated with the error.</p>
|
|
47
|
+
* @public
|
|
48
48
|
*/
|
|
49
49
|
resourceType: string | undefined;
|
|
50
50
|
/**
|
|
@@ -57,26 +57,26 @@ export declare class ConflictException extends __BaseException {
|
|
|
57
57
|
*/
|
|
58
58
|
export interface CreateWorkspaceApiKeyRequest {
|
|
59
59
|
/**
|
|
60
|
-
* @public
|
|
61
60
|
* <p>Specifies the name of the key. Keynames must be unique to the workspace.</p>
|
|
61
|
+
* @public
|
|
62
62
|
*/
|
|
63
63
|
keyName: string | undefined;
|
|
64
64
|
/**
|
|
65
|
-
* @public
|
|
66
65
|
* <p>Specifies the permission level of the key.</p>
|
|
67
66
|
* <p> Valid values: <code>VIEWER</code>|<code>EDITOR</code>|<code>ADMIN</code>
|
|
68
67
|
* </p>
|
|
68
|
+
* @public
|
|
69
69
|
*/
|
|
70
70
|
keyRole: string | undefined;
|
|
71
71
|
/**
|
|
72
|
-
* @public
|
|
73
72
|
* <p>Specifies the time in seconds until the key expires. Keys can be valid for up to 30
|
|
74
73
|
* days.</p>
|
|
74
|
+
* @public
|
|
75
75
|
*/
|
|
76
76
|
secondsToLive: number | undefined;
|
|
77
77
|
/**
|
|
78
|
-
* @public
|
|
79
78
|
* <p>The ID of the workspace to create an API key.</p>
|
|
79
|
+
* @public
|
|
80
80
|
*/
|
|
81
81
|
workspaceId: string | undefined;
|
|
82
82
|
}
|
|
@@ -85,33 +85,33 @@ export interface CreateWorkspaceApiKeyRequest {
|
|
|
85
85
|
*/
|
|
86
86
|
export interface CreateWorkspaceApiKeyResponse {
|
|
87
87
|
/**
|
|
88
|
-
* @public
|
|
89
88
|
* <p>The name of the key that was created.</p>
|
|
89
|
+
* @public
|
|
90
90
|
*/
|
|
91
91
|
keyName: string | undefined;
|
|
92
92
|
/**
|
|
93
|
-
* @public
|
|
94
93
|
* <p>The key token. Use this value as a bearer token to authenticate HTTP requests to the
|
|
95
94
|
* workspace.</p>
|
|
95
|
+
* @public
|
|
96
96
|
*/
|
|
97
97
|
key: string | undefined;
|
|
98
98
|
/**
|
|
99
|
-
* @public
|
|
100
99
|
* <p>The ID of the workspace that the key is valid for.</p>
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
workspaceId: string | undefined;
|
|
103
103
|
}
|
|
104
104
|
/**
|
|
105
|
-
* @public
|
|
106
105
|
* <p>Unexpected error while processing the request. Retry the request.</p>
|
|
106
|
+
* @public
|
|
107
107
|
*/
|
|
108
108
|
export declare class InternalServerException extends __BaseException {
|
|
109
109
|
readonly name: "InternalServerException";
|
|
110
110
|
readonly $fault: "server";
|
|
111
111
|
$retryable: {};
|
|
112
112
|
/**
|
|
113
|
-
* @public
|
|
114
113
|
* <p>How long to wait before you retry this operation.</p>
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
retryAfterSeconds?: number;
|
|
117
117
|
/**
|
|
@@ -120,20 +120,20 @@ export declare class InternalServerException extends __BaseException {
|
|
|
120
120
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
123
|
-
* @public
|
|
124
123
|
* <p>The request references a resource that does not exist.</p>
|
|
124
|
+
* @public
|
|
125
125
|
*/
|
|
126
126
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
127
127
|
readonly name: "ResourceNotFoundException";
|
|
128
128
|
readonly $fault: "client";
|
|
129
129
|
/**
|
|
130
|
-
* @public
|
|
131
130
|
* <p>The ID of the resource that is associated with the error.</p>
|
|
131
|
+
* @public
|
|
132
132
|
*/
|
|
133
133
|
resourceId: string | undefined;
|
|
134
134
|
/**
|
|
135
|
-
* @public
|
|
136
135
|
* <p>The type of the resource that is associated with the error.</p>
|
|
136
|
+
* @public
|
|
137
137
|
*/
|
|
138
138
|
resourceType: string | undefined;
|
|
139
139
|
/**
|
|
@@ -142,30 +142,30 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
142
142
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
143
143
|
}
|
|
144
144
|
/**
|
|
145
|
-
* @public
|
|
146
145
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
146
|
+
* @public
|
|
147
147
|
*/
|
|
148
148
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
149
149
|
readonly name: "ServiceQuotaExceededException";
|
|
150
150
|
readonly $fault: "client";
|
|
151
151
|
/**
|
|
152
|
-
* @public
|
|
153
152
|
* <p>The ID of the resource that is associated with the error.</p>
|
|
153
|
+
* @public
|
|
154
154
|
*/
|
|
155
155
|
resourceId: string | undefined;
|
|
156
156
|
/**
|
|
157
|
-
* @public
|
|
158
157
|
* <p>The type of the resource that is associated with the error.</p>
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
resourceType: string | undefined;
|
|
161
161
|
/**
|
|
162
|
-
* @public
|
|
163
162
|
* <p>The value of a parameter in the request caused an error.</p>
|
|
163
|
+
* @public
|
|
164
164
|
*/
|
|
165
165
|
serviceCode: string | undefined;
|
|
166
166
|
/**
|
|
167
|
-
* @public
|
|
168
167
|
* <p>The ID of the service quota that was exceeded.</p>
|
|
168
|
+
* @public
|
|
169
169
|
*/
|
|
170
170
|
quotaCode: string | undefined;
|
|
171
171
|
/**
|
|
@@ -174,26 +174,26 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
174
174
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
175
175
|
}
|
|
176
176
|
/**
|
|
177
|
-
* @public
|
|
178
177
|
* <p>The request was denied because of request throttling. Retry the request.</p>
|
|
178
|
+
* @public
|
|
179
179
|
*/
|
|
180
180
|
export declare class ThrottlingException extends __BaseException {
|
|
181
181
|
readonly name: "ThrottlingException";
|
|
182
182
|
readonly $fault: "client";
|
|
183
183
|
$retryable: {};
|
|
184
184
|
/**
|
|
185
|
-
* @public
|
|
186
185
|
* <p>The ID of the service that is associated with the error.</p>
|
|
186
|
+
* @public
|
|
187
187
|
*/
|
|
188
188
|
serviceCode?: string;
|
|
189
189
|
/**
|
|
190
|
-
* @public
|
|
191
190
|
* <p>The ID of the service quota that was exceeded.</p>
|
|
191
|
+
* @public
|
|
192
192
|
*/
|
|
193
193
|
quotaCode?: string;
|
|
194
194
|
/**
|
|
195
|
-
* @public
|
|
196
195
|
* <p>The value of a parameter in the request caused an error.</p>
|
|
196
|
+
* @public
|
|
197
197
|
*/
|
|
198
198
|
retryAfterSeconds?: number;
|
|
199
199
|
/**
|
|
@@ -202,19 +202,19 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
202
202
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
203
203
|
}
|
|
204
204
|
/**
|
|
205
|
-
* @public
|
|
206
205
|
* <p>A structure that contains information about a request parameter that caused an
|
|
207
206
|
* error.</p>
|
|
207
|
+
* @public
|
|
208
208
|
*/
|
|
209
209
|
export interface ValidationExceptionField {
|
|
210
210
|
/**
|
|
211
|
-
* @public
|
|
212
211
|
* <p>The name of the field that caused the validation error.</p>
|
|
212
|
+
* @public
|
|
213
213
|
*/
|
|
214
214
|
name: string | undefined;
|
|
215
215
|
/**
|
|
216
|
-
* @public
|
|
217
216
|
* <p>A message describing why this field couldn't be validated.</p>
|
|
217
|
+
* @public
|
|
218
218
|
*/
|
|
219
219
|
message: string | undefined;
|
|
220
220
|
}
|
|
@@ -233,20 +233,20 @@ export declare const ValidationExceptionReason: {
|
|
|
233
233
|
*/
|
|
234
234
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
235
235
|
/**
|
|
236
|
-
* @public
|
|
237
236
|
* <p>The value of a parameter in the request caused an error.</p>
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
export declare class ValidationException extends __BaseException {
|
|
240
240
|
readonly name: "ValidationException";
|
|
241
241
|
readonly $fault: "client";
|
|
242
242
|
/**
|
|
243
|
-
* @public
|
|
244
243
|
* <p>The reason that the operation failed.</p>
|
|
244
|
+
* @public
|
|
245
245
|
*/
|
|
246
246
|
reason: ValidationExceptionReason | undefined;
|
|
247
247
|
/**
|
|
248
|
-
* @public
|
|
249
248
|
* <p>A list of fields that might be associated with the error.</p>
|
|
249
|
+
* @public
|
|
250
250
|
*/
|
|
251
251
|
fieldList?: ValidationExceptionField[];
|
|
252
252
|
/**
|
|
@@ -259,13 +259,13 @@ export declare class ValidationException extends __BaseException {
|
|
|
259
259
|
*/
|
|
260
260
|
export interface DeleteWorkspaceApiKeyRequest {
|
|
261
261
|
/**
|
|
262
|
-
* @public
|
|
263
262
|
* <p>The name of the API key to delete.</p>
|
|
263
|
+
* @public
|
|
264
264
|
*/
|
|
265
265
|
keyName: string | undefined;
|
|
266
266
|
/**
|
|
267
|
-
* @public
|
|
268
267
|
* <p>The ID of the workspace to delete.</p>
|
|
268
|
+
* @public
|
|
269
269
|
*/
|
|
270
270
|
workspaceId: string | undefined;
|
|
271
271
|
}
|
|
@@ -274,55 +274,55 @@ export interface DeleteWorkspaceApiKeyRequest {
|
|
|
274
274
|
*/
|
|
275
275
|
export interface DeleteWorkspaceApiKeyResponse {
|
|
276
276
|
/**
|
|
277
|
-
* @public
|
|
278
277
|
* <p>The name of the key that was deleted.</p>
|
|
278
|
+
* @public
|
|
279
279
|
*/
|
|
280
280
|
keyName: string | undefined;
|
|
281
281
|
/**
|
|
282
|
-
* @public
|
|
283
282
|
* <p>The ID of the workspace where the key was deleted.</p>
|
|
283
|
+
* @public
|
|
284
284
|
*/
|
|
285
285
|
workspaceId: string | undefined;
|
|
286
286
|
}
|
|
287
287
|
/**
|
|
288
|
-
* @public
|
|
289
288
|
* <p>A structure that defines which attributes in the IdP assertion are to be used to
|
|
290
289
|
* define information about the users authenticated by the IdP to use the workspace.</p>
|
|
290
|
+
* @public
|
|
291
291
|
*/
|
|
292
292
|
export interface AssertionAttributes {
|
|
293
293
|
/**
|
|
294
|
-
* @public
|
|
295
294
|
* <p>The name of the attribute within the SAML assertion to use as the user full "friendly"
|
|
296
295
|
* names for SAML users.</p>
|
|
296
|
+
* @public
|
|
297
297
|
*/
|
|
298
298
|
name?: string;
|
|
299
299
|
/**
|
|
300
|
-
* @public
|
|
301
300
|
* <p>The name of the attribute within the SAML assertion to use as the login names for SAML
|
|
302
301
|
* users.</p>
|
|
302
|
+
* @public
|
|
303
303
|
*/
|
|
304
304
|
login?: string;
|
|
305
305
|
/**
|
|
306
|
-
* @public
|
|
307
306
|
* <p>The name of the attribute within the SAML assertion to use as the email names for SAML
|
|
308
307
|
* users.</p>
|
|
308
|
+
* @public
|
|
309
309
|
*/
|
|
310
310
|
email?: string;
|
|
311
311
|
/**
|
|
312
|
-
* @public
|
|
313
312
|
* <p>The name of the attribute within the SAML assertion to use as the user full "friendly"
|
|
314
313
|
* names for user groups.</p>
|
|
314
|
+
* @public
|
|
315
315
|
*/
|
|
316
316
|
groups?: string;
|
|
317
317
|
/**
|
|
318
|
-
* @public
|
|
319
318
|
* <p>The name of the attribute within the SAML assertion to use as the user roles.</p>
|
|
319
|
+
* @public
|
|
320
320
|
*/
|
|
321
321
|
role?: string;
|
|
322
322
|
/**
|
|
323
|
-
* @public
|
|
324
323
|
* <p>The name of the attribute within the SAML assertion to use as the user full "friendly"
|
|
325
324
|
* names for the users' organizations.</p>
|
|
325
|
+
* @public
|
|
326
326
|
*/
|
|
327
327
|
org?: string;
|
|
328
328
|
}
|
|
@@ -349,22 +349,22 @@ export type LicenseType = (typeof LicenseType)[keyof typeof LicenseType];
|
|
|
349
349
|
*/
|
|
350
350
|
export interface AssociateLicenseRequest {
|
|
351
351
|
/**
|
|
352
|
-
* @public
|
|
353
352
|
* <p>The ID of the workspace to associate the license with.</p>
|
|
353
|
+
* @public
|
|
354
354
|
*/
|
|
355
355
|
workspaceId: string | undefined;
|
|
356
356
|
/**
|
|
357
|
-
* @public
|
|
358
357
|
* <p>The type of license to associate with the workspace.</p>
|
|
359
358
|
* <note>
|
|
360
359
|
* <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p>
|
|
361
360
|
* </note>
|
|
361
|
+
* @public
|
|
362
362
|
*/
|
|
363
363
|
licenseType: LicenseType | undefined;
|
|
364
364
|
/**
|
|
365
|
-
* @public
|
|
366
365
|
* <p>A token from Grafana Labs that ties your Amazon Web Services account with a Grafana
|
|
367
366
|
* 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">Register with Grafana Labs</a>.</p>
|
|
367
|
+
* @public
|
|
368
368
|
*/
|
|
369
369
|
grafanaToken?: string;
|
|
370
370
|
}
|
|
@@ -405,22 +405,22 @@ export declare const SamlConfigurationStatus: {
|
|
|
405
405
|
*/
|
|
406
406
|
export type SamlConfigurationStatus = (typeof SamlConfigurationStatus)[keyof typeof SamlConfigurationStatus];
|
|
407
407
|
/**
|
|
408
|
-
* @public
|
|
409
408
|
* <p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or
|
|
410
409
|
* both methods for user authentication, and whether that authentication is fully
|
|
411
410
|
* configured.</p>
|
|
411
|
+
* @public
|
|
412
412
|
*/
|
|
413
413
|
export interface AuthenticationSummary {
|
|
414
414
|
/**
|
|
415
|
-
* @public
|
|
416
415
|
* <p>Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for
|
|
417
416
|
* user authentication.</p>
|
|
417
|
+
* @public
|
|
418
418
|
*/
|
|
419
419
|
providers: AuthenticationProviderTypes[] | undefined;
|
|
420
420
|
/**
|
|
421
|
-
* @public
|
|
422
421
|
* <p>Specifies whether the workplace's user authentication method is fully
|
|
423
422
|
* configured.</p>
|
|
423
|
+
* @public
|
|
424
424
|
*/
|
|
425
425
|
samlConfigurationStatus?: SamlConfigurationStatus;
|
|
426
426
|
}
|
|
@@ -471,7 +471,6 @@ export declare const DataSourceType: {
|
|
|
471
471
|
*/
|
|
472
472
|
export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType];
|
|
473
473
|
/**
|
|
474
|
-
* @public
|
|
475
474
|
* <p>The configuration settings for in-bound network access to your workspace.</p>
|
|
476
475
|
* <p>When this is configured, only listed IP addresses and VPC endpoints will be able to
|
|
477
476
|
* access your workspace. Standard Grafana authentication and authorization are still
|
|
@@ -488,10 +487,10 @@ export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType
|
|
|
488
487
|
* <p>If both are passed as empty arrays, no traffic is allowed to the workspace,
|
|
489
488
|
* because only <i>explicitly</i> allowed connections are accepted.</p>
|
|
490
489
|
* </note>
|
|
490
|
+
* @public
|
|
491
491
|
*/
|
|
492
492
|
export interface NetworkAccessConfiguration {
|
|
493
493
|
/**
|
|
494
|
-
* @public
|
|
495
494
|
* <p>An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses.
|
|
496
495
|
* The IP addresses specified are allowed to access your workspace. If the list is not
|
|
497
496
|
* included in the configuration (passed an empty array) then no IP addresses are
|
|
@@ -502,10 +501,10 @@ export interface NetworkAccessConfiguration {
|
|
|
502
501
|
* <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
|
|
503
502
|
* prefix lists</a>in the <i>Amazon Virtual Private Cloud User
|
|
504
503
|
* Guide</i>.</p>
|
|
504
|
+
* @public
|
|
505
505
|
*/
|
|
506
506
|
prefixListIds: string[] | undefined;
|
|
507
507
|
/**
|
|
508
|
-
* @public
|
|
509
508
|
* <p>An array of Amazon VPC endpoint IDs for the workspace. You can create VPC
|
|
510
509
|
* endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a
|
|
511
510
|
* <code>NetworkAccessConfiguration</code> is specified then only VPC endpoints
|
|
@@ -522,6 +521,7 @@ export interface NetworkAccessConfiguration {
|
|
|
522
521
|
* Grafana workspaces (using the <code>com.amazonaws.[region].grafana-workspace</code>
|
|
523
522
|
* service endpoint). Other VPC endpoints are ignored.</p>
|
|
524
523
|
* </note>
|
|
524
|
+
* @public
|
|
525
525
|
*/
|
|
526
526
|
vpceIds: string[] | undefined;
|
|
527
527
|
}
|
|
@@ -620,7 +620,6 @@ export declare const WorkspaceStatus: {
|
|
|
620
620
|
*/
|
|
621
621
|
export type WorkspaceStatus = (typeof WorkspaceStatus)[keyof typeof WorkspaceStatus];
|
|
622
622
|
/**
|
|
623
|
-
* @public
|
|
624
623
|
* <p>The configuration settings for an Amazon VPC that contains data sources for
|
|
625
624
|
* your Grafana workspace to connect to.</p>
|
|
626
625
|
* <note>
|
|
@@ -629,101 +628,101 @@ export type WorkspaceStatus = (typeof WorkspaceStatus)[keyof typeof WorkspaceSta
|
|
|
629
628
|
* <p>Connecting to a private VPC is not yet available in the Asia Pacific (Seoul)
|
|
630
629
|
* Region (ap-northeast-2).</p>
|
|
631
630
|
* </note>
|
|
631
|
+
* @public
|
|
632
632
|
*/
|
|
633
633
|
export interface VpcConfiguration {
|
|
634
634
|
/**
|
|
635
|
-
* @public
|
|
636
635
|
* <p>The list of Amazon EC2 security group IDs attached to the Amazon VPC
|
|
637
636
|
* for your Grafana workspace to connect. Duplicates not allowed.</p>
|
|
637
|
+
* @public
|
|
638
638
|
*/
|
|
639
639
|
securityGroupIds: string[] | undefined;
|
|
640
640
|
/**
|
|
641
|
-
* @public
|
|
642
641
|
* <p>The list of Amazon EC2 subnet IDs created in the Amazon VPC for your
|
|
643
642
|
* Grafana workspace to connect. Duplicates not allowed.</p>
|
|
643
|
+
* @public
|
|
644
644
|
*/
|
|
645
645
|
subnetIds: string[] | undefined;
|
|
646
646
|
}
|
|
647
647
|
/**
|
|
648
|
-
* @public
|
|
649
648
|
* <p>A structure containing information about an Amazon Managed Grafana workspace in your
|
|
650
649
|
* account.</p>
|
|
650
|
+
* @public
|
|
651
651
|
*/
|
|
652
652
|
export interface WorkspaceDescription {
|
|
653
653
|
/**
|
|
654
|
-
* @public
|
|
655
654
|
* <p>Specifies whether the workspace can access Amazon Web Services resources in this
|
|
656
655
|
* Amazon Web Services account only, or whether it can also access Amazon Web Services
|
|
657
656
|
* resources in other accounts in the same organization. If this is
|
|
658
657
|
* <code>ORGANIZATION</code>, the <code>workspaceOrganizationalUnits</code> parameter
|
|
659
658
|
* specifies which organizational units the workspace can access.</p>
|
|
659
|
+
* @public
|
|
660
660
|
*/
|
|
661
661
|
accountAccessType?: AccountAccessType;
|
|
662
662
|
/**
|
|
663
|
-
* @public
|
|
664
663
|
* <p>The date that the workspace was created.</p>
|
|
664
|
+
* @public
|
|
665
665
|
*/
|
|
666
666
|
created: Date | undefined;
|
|
667
667
|
/**
|
|
668
|
-
* @public
|
|
669
668
|
* <p>Specifies the Amazon Web Services data sources that have been configured to have
|
|
670
669
|
* IAM roles and permissions created to allow Amazon Managed Grafana to read
|
|
671
670
|
* data from these sources.</p>
|
|
672
671
|
* <p>This list is only used when the workspace was created through the Amazon Web Services
|
|
673
672
|
* console, and the <code>permissionType</code> is <code>SERVICE_MANAGED</code>.</p>
|
|
673
|
+
* @public
|
|
674
674
|
*/
|
|
675
675
|
dataSources: DataSourceType[] | undefined;
|
|
676
676
|
/**
|
|
677
|
-
* @public
|
|
678
677
|
* <p>The user-defined description of the workspace.</p>
|
|
678
|
+
* @public
|
|
679
679
|
*/
|
|
680
680
|
description?: string;
|
|
681
681
|
/**
|
|
682
|
-
* @public
|
|
683
682
|
* <p>The URL that users can use to access the Grafana console in the workspace.</p>
|
|
683
|
+
* @public
|
|
684
684
|
*/
|
|
685
685
|
endpoint: string | undefined;
|
|
686
686
|
/**
|
|
687
|
-
* @public
|
|
688
687
|
* <p>The version of Grafana supported in this workspace.</p>
|
|
688
|
+
* @public
|
|
689
689
|
*/
|
|
690
690
|
grafanaVersion: string | undefined;
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>The unique ID of this workspace.</p>
|
|
693
|
+
* @public
|
|
694
694
|
*/
|
|
695
695
|
id: string | undefined;
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>The most recent date that the workspace was modified.</p>
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
modified: Date | undefined;
|
|
701
701
|
/**
|
|
702
|
-
* @public
|
|
703
702
|
* <p>The name of the workspace.</p>
|
|
703
|
+
* @public
|
|
704
704
|
*/
|
|
705
705
|
name?: string;
|
|
706
706
|
/**
|
|
707
|
-
* @public
|
|
708
707
|
* <p>The name of the IAM role that is used to access resources through
|
|
709
708
|
* Organizations.</p>
|
|
709
|
+
* @public
|
|
710
710
|
*/
|
|
711
711
|
organizationRoleName?: string;
|
|
712
712
|
/**
|
|
713
|
-
* @public
|
|
714
713
|
* <p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically
|
|
715
714
|
* create IAM roles and permissions for, to allow Amazon Managed Grafana to use
|
|
716
715
|
* these channels.</p>
|
|
716
|
+
* @public
|
|
717
717
|
*/
|
|
718
718
|
notificationDestinations?: NotificationDestinationType[];
|
|
719
719
|
/**
|
|
720
|
-
* @public
|
|
721
720
|
* <p>Specifies the organizational units that this workspace is allowed to use data sources
|
|
722
721
|
* from, if this workspace is in an account that is part of an organization.</p>
|
|
722
|
+
* @public
|
|
723
723
|
*/
|
|
724
724
|
organizationalUnits?: string[];
|
|
725
725
|
/**
|
|
726
|
-
* @public
|
|
727
726
|
* <p>If this is <code>SERVICE_MANAGED</code>, and the workplace was created through the
|
|
728
727
|
* Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the
|
|
729
728
|
* IAM roles and provisions the permissions that the workspace needs to
|
|
@@ -741,84 +740,85 @@ export interface WorkspaceDescription {
|
|
|
741
740
|
* permissions and policies for Amazon Web Services data sources and notification
|
|
742
741
|
* channels</a>
|
|
743
742
|
* </p>
|
|
743
|
+
* @public
|
|
744
744
|
*/
|
|
745
745
|
permissionType?: PermissionType;
|
|
746
746
|
/**
|
|
747
|
-
* @public
|
|
748
747
|
* <p>The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.</p>
|
|
748
|
+
* @public
|
|
749
749
|
*/
|
|
750
750
|
stackSetName?: string;
|
|
751
751
|
/**
|
|
752
|
-
* @public
|
|
753
752
|
* <p>The current status of the workspace.</p>
|
|
753
|
+
* @public
|
|
754
754
|
*/
|
|
755
755
|
status: WorkspaceStatus | undefined;
|
|
756
756
|
/**
|
|
757
|
-
* @public
|
|
758
757
|
* <p>The IAM role that grants permissions to the Amazon Web Services
|
|
759
758
|
* resources that the workspace will view data from. This role must already exist.</p>
|
|
759
|
+
* @public
|
|
760
760
|
*/
|
|
761
761
|
workspaceRoleArn?: string;
|
|
762
762
|
/**
|
|
763
|
-
* @public
|
|
764
763
|
* <p>Specifies whether this workspace has a full Grafana Enterprise license.</p>
|
|
765
764
|
* <note>
|
|
766
765
|
* <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p>
|
|
767
766
|
* </note>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
licenseType?: LicenseType;
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>Specifies whether this workspace has already fully used its free trial for Grafana
|
|
773
772
|
* Enterprise.</p>
|
|
774
773
|
* <note>
|
|
775
774
|
* <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p>
|
|
776
775
|
* </note>
|
|
776
|
+
* @public
|
|
777
777
|
*/
|
|
778
778
|
freeTrialConsumed?: boolean;
|
|
779
779
|
/**
|
|
780
|
-
* @public
|
|
781
780
|
* <p>If this workspace has a full Grafana Enterprise license purchased through
|
|
782
781
|
* Amazon Web Services Marketplace, this specifies when the
|
|
783
782
|
* license ends and will need to be renewed. Purchasing the Enterprise plugins option
|
|
784
783
|
* through Amazon Managed Grafana does not have an expiration. It is valid until the
|
|
785
784
|
* license is removed.</p>
|
|
785
|
+
* @public
|
|
786
786
|
*/
|
|
787
787
|
licenseExpiration?: Date;
|
|
788
788
|
/**
|
|
789
|
-
* @public
|
|
790
789
|
* <p>If this workspace is currently in the free trial period for Grafana Enterprise, this
|
|
791
790
|
* value specifies when that free trial ends.</p>
|
|
792
791
|
* <note>
|
|
793
792
|
* <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p>
|
|
794
793
|
* </note>
|
|
794
|
+
* @public
|
|
795
795
|
*/
|
|
796
796
|
freeTrialExpiration?: Date;
|
|
797
797
|
/**
|
|
798
|
-
* @public
|
|
799
798
|
* <p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or
|
|
800
799
|
* both methods for user authentication.</p>
|
|
800
|
+
* @public
|
|
801
801
|
*/
|
|
802
802
|
authentication: AuthenticationSummary | undefined;
|
|
803
803
|
/**
|
|
804
|
-
* @public
|
|
805
804
|
* <p>The list of tags associated with the workspace.</p>
|
|
805
|
+
* @public
|
|
806
806
|
*/
|
|
807
807
|
tags?: Record<string, string>;
|
|
808
808
|
/**
|
|
809
|
-
* @public
|
|
810
809
|
* <p>The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).</p>
|
|
810
|
+
* @public
|
|
811
811
|
*/
|
|
812
812
|
vpcConfiguration?: VpcConfiguration;
|
|
813
813
|
/**
|
|
814
|
-
* @public
|
|
815
814
|
* <p>The configuration settings for network access to your workspace.</p>
|
|
815
|
+
* @public
|
|
816
816
|
*/
|
|
817
817
|
networkAccessControl?: NetworkAccessConfiguration;
|
|
818
818
|
/**
|
|
819
|
-
* @public
|
|
820
819
|
* <p>The token that ties this workspace to a Grafana Labs account. For more information,
|
|
821
820
|
* see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Register with Grafana Labs</a>.</p>
|
|
821
|
+
* @public
|
|
822
822
|
*/
|
|
823
823
|
grafanaToken?: string;
|
|
824
824
|
}
|
|
@@ -827,8 +827,8 @@ export interface WorkspaceDescription {
|
|
|
827
827
|
*/
|
|
828
828
|
export interface AssociateLicenseResponse {
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>A structure containing data about the workspace.</p>
|
|
831
|
+
* @public
|
|
832
832
|
*/
|
|
833
833
|
workspace: WorkspaceDescription | undefined;
|
|
834
834
|
}
|
|
@@ -837,29 +837,29 @@ export interface AssociateLicenseResponse {
|
|
|
837
837
|
*/
|
|
838
838
|
export interface DescribeWorkspaceAuthenticationRequest {
|
|
839
839
|
/**
|
|
840
|
-
* @public
|
|
841
840
|
* <p>The ID of the workspace to return authentication information about.</p>
|
|
841
|
+
* @public
|
|
842
842
|
*/
|
|
843
843
|
workspaceId: string | undefined;
|
|
844
844
|
}
|
|
845
845
|
/**
|
|
846
|
-
* @public
|
|
847
846
|
* <p>A structure containing information about how this workspace works with IAM Identity Center. </p>
|
|
847
|
+
* @public
|
|
848
848
|
*/
|
|
849
849
|
export interface AwsSsoAuthentication {
|
|
850
850
|
/**
|
|
851
|
-
* @public
|
|
852
851
|
* <p>The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.</p>
|
|
852
|
+
* @public
|
|
853
853
|
*/
|
|
854
854
|
ssoClientId?: string;
|
|
855
855
|
}
|
|
856
856
|
/**
|
|
857
|
-
* @public
|
|
858
857
|
* <p>A structure containing the identity provider (IdP) metadata used to integrate the
|
|
859
858
|
* identity provider with this workspace. You can specify the metadata either by providing
|
|
860
859
|
* a URL to its location in the <code>url</code> parameter, or by specifying the full
|
|
861
860
|
* metadata in XML format in the <code>xml</code> parameter. Specifying both will cause an
|
|
862
861
|
* error.</p>
|
|
862
|
+
* @public
|
|
863
863
|
*/
|
|
864
864
|
export type IdpMetadata = IdpMetadata.UrlMember | IdpMetadata.XmlMember | IdpMetadata.$UnknownMember;
|
|
865
865
|
/**
|
|
@@ -867,8 +867,8 @@ export type IdpMetadata = IdpMetadata.UrlMember | IdpMetadata.XmlMember | IdpMet
|
|
|
867
867
|
*/
|
|
868
868
|
export declare namespace IdpMetadata {
|
|
869
869
|
/**
|
|
870
|
-
* @public
|
|
871
870
|
* <p>The URL of the location containing the IdP metadata.</p>
|
|
871
|
+
* @public
|
|
872
872
|
*/
|
|
873
873
|
interface UrlMember {
|
|
874
874
|
url: string;
|
|
@@ -876,8 +876,8 @@ export declare namespace IdpMetadata {
|
|
|
876
876
|
$unknown?: never;
|
|
877
877
|
}
|
|
878
878
|
/**
|
|
879
|
-
* @public
|
|
880
879
|
* <p>The full IdP metadata, in XML format.</p>
|
|
880
|
+
* @public
|
|
881
881
|
*/
|
|
882
882
|
interface XmlMember {
|
|
883
883
|
url?: never;
|
|
@@ -900,102 +900,102 @@ export declare namespace IdpMetadata {
|
|
|
900
900
|
const visit: <T>(value: IdpMetadata, visitor: Visitor<T>) => T;
|
|
901
901
|
}
|
|
902
902
|
/**
|
|
903
|
-
* @public
|
|
904
903
|
* <p>This structure defines which groups defined in the SAML assertion attribute are to be
|
|
905
904
|
* mapped to the Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.
|
|
906
905
|
* SAML authenticated users not part of <code>Admin</code> or <code>Editor</code> role
|
|
907
906
|
* groups have <code>Viewer</code> permission over the workspace.</p>
|
|
907
|
+
* @public
|
|
908
908
|
*/
|
|
909
909
|
export interface RoleValues {
|
|
910
910
|
/**
|
|
911
|
-
* @public
|
|
912
911
|
* <p>A list of groups from the SAML assertion attribute to grant the Grafana
|
|
913
912
|
* <code>Editor</code> role to.</p>
|
|
913
|
+
* @public
|
|
914
914
|
*/
|
|
915
915
|
editor?: string[];
|
|
916
916
|
/**
|
|
917
|
-
* @public
|
|
918
917
|
* <p>A list of groups from the SAML assertion attribute to grant the Grafana
|
|
919
918
|
* <code>Admin</code> role to.</p>
|
|
919
|
+
* @public
|
|
920
920
|
*/
|
|
921
921
|
admin?: string[];
|
|
922
922
|
}
|
|
923
923
|
/**
|
|
924
|
-
* @public
|
|
925
924
|
* <p>A structure containing information about how this workspace works with SAML. </p>
|
|
925
|
+
* @public
|
|
926
926
|
*/
|
|
927
927
|
export interface SamlConfiguration {
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>A structure containing the identity provider (IdP) metadata used to integrate the
|
|
931
930
|
* identity provider with this workspace.</p>
|
|
931
|
+
* @public
|
|
932
932
|
*/
|
|
933
933
|
idpMetadata: IdpMetadata | undefined;
|
|
934
934
|
/**
|
|
935
|
-
* @public
|
|
936
935
|
* <p>A structure that defines which attributes in the SAML assertion are to be used to
|
|
937
936
|
* define information about the users authenticated by that IdP to use the
|
|
938
937
|
* workspace.</p>
|
|
938
|
+
* @public
|
|
939
939
|
*/
|
|
940
940
|
assertionAttributes?: AssertionAttributes;
|
|
941
941
|
/**
|
|
942
|
-
* @public
|
|
943
942
|
* <p>A structure containing arrays that map group names in the SAML assertion to the
|
|
944
943
|
* Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
|
|
944
|
+
* @public
|
|
945
945
|
*/
|
|
946
946
|
roleValues?: RoleValues;
|
|
947
947
|
/**
|
|
948
|
-
* @public
|
|
949
948
|
* <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
|
|
950
949
|
* have access.</p>
|
|
950
|
+
* @public
|
|
951
951
|
*/
|
|
952
952
|
allowedOrganizations?: string[];
|
|
953
953
|
/**
|
|
954
|
-
* @public
|
|
955
954
|
* <p>How long a sign-on session by a SAML user is valid, before the user has to sign on
|
|
956
955
|
* again.</p>
|
|
956
|
+
* @public
|
|
957
957
|
*/
|
|
958
958
|
loginValidityDuration?: number;
|
|
959
959
|
}
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p>A structure containing information about how this workspace works with SAML. </p>
|
|
962
|
+
* @public
|
|
963
963
|
*/
|
|
964
964
|
export interface SamlAuthentication {
|
|
965
965
|
/**
|
|
966
|
-
* @public
|
|
967
966
|
* <p>Specifies whether the workspace's SAML configuration is complete.</p>
|
|
967
|
+
* @public
|
|
968
968
|
*/
|
|
969
969
|
status: SamlConfigurationStatus | undefined;
|
|
970
970
|
/**
|
|
971
|
-
* @public
|
|
972
971
|
* <p>A structure containing details about how this workspace works with SAML. </p>
|
|
972
|
+
* @public
|
|
973
973
|
*/
|
|
974
974
|
configuration?: SamlConfiguration;
|
|
975
975
|
}
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>A structure containing information about the user authentication methods used by the
|
|
979
978
|
* workspace.</p>
|
|
979
|
+
* @public
|
|
980
980
|
*/
|
|
981
981
|
export interface AuthenticationDescription {
|
|
982
982
|
/**
|
|
983
|
-
* @public
|
|
984
983
|
* <p>Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to
|
|
985
984
|
* authenticate users to use the Grafana console in the Amazon Managed Grafana
|
|
986
985
|
* workspace.</p>
|
|
986
|
+
* @public
|
|
987
987
|
*/
|
|
988
988
|
providers: AuthenticationProviderTypes[] | undefined;
|
|
989
989
|
/**
|
|
990
|
-
* @public
|
|
991
990
|
* <p>A structure containing information about how this workspace works with SAML, including
|
|
992
991
|
* what attributes within the assertion are to be mapped to user information in the
|
|
993
992
|
* workspace. </p>
|
|
993
|
+
* @public
|
|
994
994
|
*/
|
|
995
995
|
saml?: SamlAuthentication;
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <p>A structure containing information about how this workspace works with IAM Identity Center. </p>
|
|
998
|
+
* @public
|
|
999
999
|
*/
|
|
1000
1000
|
awsSso?: AwsSsoAuthentication;
|
|
1001
1001
|
}
|
|
@@ -1004,9 +1004,9 @@ export interface AuthenticationDescription {
|
|
|
1004
1004
|
*/
|
|
1005
1005
|
export interface DescribeWorkspaceAuthenticationResponse {
|
|
1006
1006
|
/**
|
|
1007
|
-
* @public
|
|
1008
1007
|
* <p>A structure containing information about the authentication methods used in the
|
|
1009
1008
|
* workspace.</p>
|
|
1009
|
+
* @public
|
|
1010
1010
|
*/
|
|
1011
1011
|
authentication: AuthenticationDescription | undefined;
|
|
1012
1012
|
}
|
|
@@ -1015,23 +1015,23 @@ export interface DescribeWorkspaceAuthenticationResponse {
|
|
|
1015
1015
|
*/
|
|
1016
1016
|
export interface UpdateWorkspaceAuthenticationRequest {
|
|
1017
1017
|
/**
|
|
1018
|
-
* @public
|
|
1019
1018
|
* <p>The ID of the workspace to update the authentication for.</p>
|
|
1019
|
+
* @public
|
|
1020
1020
|
*/
|
|
1021
1021
|
workspaceId: string | undefined;
|
|
1022
1022
|
/**
|
|
1023
|
-
* @public
|
|
1024
1023
|
* <p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to
|
|
1025
1024
|
* authenticate users for using the Grafana console within a workspace. For more
|
|
1026
1025
|
* information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in
|
|
1027
1026
|
* Amazon Managed Grafana</a>.</p>
|
|
1027
|
+
* @public
|
|
1028
1028
|
*/
|
|
1029
1029
|
authenticationProviders: AuthenticationProviderTypes[] | undefined;
|
|
1030
1030
|
/**
|
|
1031
|
-
* @public
|
|
1032
1031
|
* <p>If the workspace uses SAML, use this structure to map SAML assertion attributes to
|
|
1033
1032
|
* workspace user information and define which groups in the assertion attribute are to
|
|
1034
1033
|
* have the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
|
|
1034
|
+
* @public
|
|
1035
1035
|
*/
|
|
1036
1036
|
samlConfiguration?: SamlConfiguration;
|
|
1037
1037
|
}
|
|
@@ -1040,9 +1040,9 @@ export interface UpdateWorkspaceAuthenticationRequest {
|
|
|
1040
1040
|
*/
|
|
1041
1041
|
export interface UpdateWorkspaceAuthenticationResponse {
|
|
1042
1042
|
/**
|
|
1043
|
-
* @public
|
|
1044
1043
|
* <p>A structure that describes the user authentication for this workspace after the update
|
|
1045
1044
|
* is made.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
authentication: AuthenticationDescription | undefined;
|
|
1048
1048
|
}
|
|
@@ -1051,8 +1051,8 @@ export interface UpdateWorkspaceAuthenticationResponse {
|
|
|
1051
1051
|
*/
|
|
1052
1052
|
export interface DescribeWorkspaceConfigurationRequest {
|
|
1053
1053
|
/**
|
|
1054
|
-
* @public
|
|
1055
1054
|
* <p>The ID of the workspace to get configuration information for.</p>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
workspaceId: string | undefined;
|
|
1058
1058
|
}
|
|
@@ -1061,15 +1061,15 @@ export interface DescribeWorkspaceConfigurationRequest {
|
|
|
1061
1061
|
*/
|
|
1062
1062
|
export interface DescribeWorkspaceConfigurationResponse {
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>The configuration string for the workspace that you requested. For more information
|
|
1066
1065
|
* 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
|
|
1067
1066
|
* workspace</a>.</p>
|
|
1067
|
+
* @public
|
|
1068
1068
|
*/
|
|
1069
1069
|
configuration: __LazyJsonString | string | undefined;
|
|
1070
1070
|
/**
|
|
1071
|
-
* @public
|
|
1072
1071
|
* <p>The supported Grafana version for the workspace.</p>
|
|
1072
|
+
* @public
|
|
1073
1073
|
*/
|
|
1074
1074
|
grafanaVersion?: string;
|
|
1075
1075
|
}
|
|
@@ -1078,25 +1078,25 @@ export interface DescribeWorkspaceConfigurationResponse {
|
|
|
1078
1078
|
*/
|
|
1079
1079
|
export interface UpdateWorkspaceConfigurationRequest {
|
|
1080
1080
|
/**
|
|
1081
|
-
* @public
|
|
1082
1081
|
* <p>The new configuration string for the workspace. For more information about the format
|
|
1083
1082
|
* and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana
|
|
1084
1083
|
* workspace</a>.</p>
|
|
1084
|
+
* @public
|
|
1085
1085
|
*/
|
|
1086
1086
|
configuration: __LazyJsonString | string | undefined;
|
|
1087
1087
|
/**
|
|
1088
|
-
* @public
|
|
1089
1088
|
* <p>The ID of the workspace to update.</p>
|
|
1089
|
+
* @public
|
|
1090
1090
|
*/
|
|
1091
1091
|
workspaceId: string | undefined;
|
|
1092
1092
|
/**
|
|
1093
|
-
* @public
|
|
1094
1093
|
* <p>Specifies the version of Grafana to support in the workspace. If not specified,
|
|
1095
1094
|
* keeps the current version of the workspace.</p>
|
|
1096
1095
|
* <p>Can only be used to upgrade (for example, from 8.4 to 9.4), not
|
|
1097
1096
|
* downgrade (for example, from 9.4 to 8.4).</p>
|
|
1098
1097
|
* <p>To know what versions are available to upgrade to for a specific workspace, see
|
|
1099
1098
|
* the <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html">ListVersions</a> operation.</p>
|
|
1099
|
+
* @public
|
|
1100
1100
|
*/
|
|
1101
1101
|
grafanaVersion?: string;
|
|
1102
1102
|
}
|
|
@@ -1110,13 +1110,13 @@ export interface UpdateWorkspaceConfigurationResponse {
|
|
|
1110
1110
|
*/
|
|
1111
1111
|
export interface DisassociateLicenseRequest {
|
|
1112
1112
|
/**
|
|
1113
|
-
* @public
|
|
1114
1113
|
* <p>The ID of the workspace to remove the Grafana Enterprise license from.</p>
|
|
1114
|
+
* @public
|
|
1115
1115
|
*/
|
|
1116
1116
|
workspaceId: string | undefined;
|
|
1117
1117
|
/**
|
|
1118
|
-
* @public
|
|
1119
1118
|
* <p>The type of license to remove from the workspace.</p>
|
|
1119
|
+
* @public
|
|
1120
1120
|
*/
|
|
1121
1121
|
licenseType: LicenseType | undefined;
|
|
1122
1122
|
}
|
|
@@ -1125,8 +1125,8 @@ export interface DisassociateLicenseRequest {
|
|
|
1125
1125
|
*/
|
|
1126
1126
|
export interface DisassociateLicenseResponse {
|
|
1127
1127
|
/**
|
|
1128
|
-
* @public
|
|
1129
1128
|
* <p>A structure containing information about the workspace.</p>
|
|
1129
|
+
* @public
|
|
1130
1130
|
*/
|
|
1131
1131
|
workspace: WorkspaceDescription | undefined;
|
|
1132
1132
|
}
|
|
@@ -1135,8 +1135,8 @@ export interface DisassociateLicenseResponse {
|
|
|
1135
1135
|
*/
|
|
1136
1136
|
export interface ListTagsForResourceRequest {
|
|
1137
1137
|
/**
|
|
1138
|
-
* @public
|
|
1139
1138
|
* <p>The ARN of the resource the list of tags are associated with.</p>
|
|
1139
|
+
* @public
|
|
1140
1140
|
*/
|
|
1141
1141
|
resourceArn: string | undefined;
|
|
1142
1142
|
}
|
|
@@ -1145,8 +1145,8 @@ export interface ListTagsForResourceRequest {
|
|
|
1145
1145
|
*/
|
|
1146
1146
|
export interface ListTagsForResourceResponse {
|
|
1147
1147
|
/**
|
|
1148
|
-
* @public
|
|
1149
1148
|
* <p>The list of tags that are associated with the resource.</p>
|
|
1149
|
+
* @public
|
|
1150
1150
|
*/
|
|
1151
1151
|
tags?: Record<string, string>;
|
|
1152
1152
|
}
|
|
@@ -1155,21 +1155,21 @@ export interface ListTagsForResourceResponse {
|
|
|
1155
1155
|
*/
|
|
1156
1156
|
export interface ListVersionsRequest {
|
|
1157
1157
|
/**
|
|
1158
|
-
* @public
|
|
1159
1158
|
* <p>The maximum number of results to include in the response.</p>
|
|
1159
|
+
* @public
|
|
1160
1160
|
*/
|
|
1161
1161
|
maxResults?: number;
|
|
1162
1162
|
/**
|
|
1163
|
-
* @public
|
|
1164
1163
|
* <p>The token to use when requesting the next set of results. You receive this token from
|
|
1165
1164
|
* a previous <code>ListVersions</code> operation.</p>
|
|
1165
|
+
* @public
|
|
1166
1166
|
*/
|
|
1167
1167
|
nextToken?: string;
|
|
1168
1168
|
/**
|
|
1169
|
-
* @public
|
|
1170
1169
|
* <p>The ID of the workspace to list the available upgrade versions. If not included,
|
|
1171
1170
|
* lists all versions of Grafana that are supported for
|
|
1172
1171
|
* <code>CreateWorkspace</code>.</p>
|
|
1172
|
+
* @public
|
|
1173
1173
|
*/
|
|
1174
1174
|
workspaceId?: string;
|
|
1175
1175
|
}
|
|
@@ -1178,15 +1178,15 @@ export interface ListVersionsRequest {
|
|
|
1178
1178
|
*/
|
|
1179
1179
|
export interface ListVersionsResponse {
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>The token to use in a subsequent <code>ListVersions</code> operation to return the
|
|
1183
1182
|
* next set of results.</p>
|
|
1183
|
+
* @public
|
|
1184
1184
|
*/
|
|
1185
1185
|
nextToken?: string;
|
|
1186
1186
|
/**
|
|
1187
|
-
* @public
|
|
1188
1187
|
* <p>The Grafana versions available to create. If a workspace ID is included in the
|
|
1189
1188
|
* request, the Grafana versions to which this workspace can be upgraded.</p>
|
|
1189
|
+
* @public
|
|
1190
1190
|
*/
|
|
1191
1191
|
grafanaVersions?: string[];
|
|
1192
1192
|
}
|
|
@@ -1213,35 +1213,35 @@ export type UserType = (typeof UserType)[keyof typeof UserType];
|
|
|
1213
1213
|
*/
|
|
1214
1214
|
export interface ListPermissionsRequest {
|
|
1215
1215
|
/**
|
|
1216
|
-
* @public
|
|
1217
1216
|
* <p>The maximum number of results to include in the response.</p>
|
|
1217
|
+
* @public
|
|
1218
1218
|
*/
|
|
1219
1219
|
maxResults?: number;
|
|
1220
1220
|
/**
|
|
1221
|
-
* @public
|
|
1222
1221
|
* <p>The token to use when requesting the next set of results. You received this token from
|
|
1223
1222
|
* a previous <code>ListPermissions</code> operation.</p>
|
|
1223
|
+
* @public
|
|
1224
1224
|
*/
|
|
1225
1225
|
nextToken?: string;
|
|
1226
1226
|
/**
|
|
1227
|
-
* @public
|
|
1228
1227
|
* <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
|
|
1229
1228
|
* permissions of IAM Identity Center groups are returned.</p>
|
|
1229
|
+
* @public
|
|
1230
1230
|
*/
|
|
1231
1231
|
userType?: UserType;
|
|
1232
1232
|
/**
|
|
1233
|
-
* @public
|
|
1234
1233
|
* <p>(Optional) Limits the results to only the user that matches this ID.</p>
|
|
1234
|
+
* @public
|
|
1235
1235
|
*/
|
|
1236
1236
|
userId?: string;
|
|
1237
1237
|
/**
|
|
1238
|
-
* @public
|
|
1239
1238
|
* <p>(Optional) Limits the results to only the group that matches this ID.</p>
|
|
1239
|
+
* @public
|
|
1240
1240
|
*/
|
|
1241
1241
|
groupId?: string;
|
|
1242
1242
|
/**
|
|
1243
|
-
* @public
|
|
1244
1243
|
* <p>The ID of the workspace to list permissions for. This parameter is required.</p>
|
|
1244
|
+
* @public
|
|
1245
1245
|
*/
|
|
1246
1246
|
workspaceId: string | undefined;
|
|
1247
1247
|
}
|
|
@@ -1268,39 +1268,39 @@ export declare const Role: {
|
|
|
1268
1268
|
*/
|
|
1269
1269
|
export type Role = (typeof Role)[keyof typeof Role];
|
|
1270
1270
|
/**
|
|
1271
|
-
* @public
|
|
1272
1271
|
* <p>A structure that specifies one user or group in the workspace.</p>
|
|
1272
|
+
* @public
|
|
1273
1273
|
*/
|
|
1274
1274
|
export interface User {
|
|
1275
1275
|
/**
|
|
1276
|
-
* @public
|
|
1277
1276
|
* <p>The ID of the user or group.</p>
|
|
1278
1277
|
* <p>Pattern:
|
|
1279
1278
|
* <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>
|
|
1280
1279
|
* </p>
|
|
1280
|
+
* @public
|
|
1281
1281
|
*/
|
|
1282
1282
|
id: string | undefined;
|
|
1283
1283
|
/**
|
|
1284
|
-
* @public
|
|
1285
1284
|
* <p>Specifies whether this is a single user or a group.</p>
|
|
1285
|
+
* @public
|
|
1286
1286
|
*/
|
|
1287
1287
|
type: UserType | undefined;
|
|
1288
1288
|
}
|
|
1289
1289
|
/**
|
|
1290
|
-
* @public
|
|
1291
1290
|
* <p>A structure containing the identity of one user or group and the <code>Admin</code>,
|
|
1292
1291
|
* <code>Editor</code>, or <code>Viewer</code> role that they have.</p>
|
|
1292
|
+
* @public
|
|
1293
1293
|
*/
|
|
1294
1294
|
export interface PermissionEntry {
|
|
1295
1295
|
/**
|
|
1296
|
-
* @public
|
|
1297
1296
|
* <p>A structure with the ID of the user or group with this role.</p>
|
|
1297
|
+
* @public
|
|
1298
1298
|
*/
|
|
1299
1299
|
user: User | undefined;
|
|
1300
1300
|
/**
|
|
1301
|
-
* @public
|
|
1302
1301
|
* <p>Specifies whether the user or group has the <code>Admin</code>, <code>Editor</code>,
|
|
1303
1302
|
* or <code>Viewer</code> role.</p>
|
|
1303
|
+
* @public
|
|
1304
1304
|
*/
|
|
1305
1305
|
role: Role | undefined;
|
|
1306
1306
|
}
|
|
@@ -1309,14 +1309,14 @@ export interface PermissionEntry {
|
|
|
1309
1309
|
*/
|
|
1310
1310
|
export interface ListPermissionsResponse {
|
|
1311
1311
|
/**
|
|
1312
|
-
* @public
|
|
1313
1312
|
* <p>The token to use in a subsequent <code>ListPermissions</code> operation to return the
|
|
1314
1313
|
* next set of results.</p>
|
|
1314
|
+
* @public
|
|
1315
1315
|
*/
|
|
1316
1316
|
nextToken?: string;
|
|
1317
1317
|
/**
|
|
1318
|
-
* @public
|
|
1319
1318
|
* <p>The permissions returned by the operation.</p>
|
|
1319
|
+
* @public
|
|
1320
1320
|
*/
|
|
1321
1321
|
permissions: PermissionEntry[] | undefined;
|
|
1322
1322
|
}
|
|
@@ -1339,24 +1339,24 @@ export declare const UpdateAction: {
|
|
|
1339
1339
|
*/
|
|
1340
1340
|
export type UpdateAction = (typeof UpdateAction)[keyof typeof UpdateAction];
|
|
1341
1341
|
/**
|
|
1342
|
-
* @public
|
|
1343
1342
|
* <p>Contains the instructions for one Grafana role permission update in a <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a> operation.</p>
|
|
1343
|
+
* @public
|
|
1344
1344
|
*/
|
|
1345
1345
|
export interface UpdateInstruction {
|
|
1346
1346
|
/**
|
|
1347
|
-
* @public
|
|
1348
1347
|
* <p>Specifies whether this update is to add or revoke role permissions.</p>
|
|
1348
|
+
* @public
|
|
1349
1349
|
*/
|
|
1350
1350
|
action: UpdateAction | undefined;
|
|
1351
1351
|
/**
|
|
1352
|
-
* @public
|
|
1353
1352
|
* <p>The role to add or revoke for the user or the group specified in
|
|
1354
1353
|
* <code>users</code>.</p>
|
|
1354
|
+
* @public
|
|
1355
1355
|
*/
|
|
1356
1356
|
role: Role | undefined;
|
|
1357
1357
|
/**
|
|
1358
|
-
* @public
|
|
1359
1358
|
* <p>A structure that specifies the user or group to add or revoke the role for.</p>
|
|
1359
|
+
* @public
|
|
1360
1360
|
*/
|
|
1361
1361
|
users: User[] | undefined;
|
|
1362
1362
|
}
|
|
@@ -1365,35 +1365,35 @@ export interface UpdateInstruction {
|
|
|
1365
1365
|
*/
|
|
1366
1366
|
export interface UpdatePermissionsRequest {
|
|
1367
1367
|
/**
|
|
1368
|
-
* @public
|
|
1369
1368
|
* <p>An array of structures that contain the permission updates to make.</p>
|
|
1369
|
+
* @public
|
|
1370
1370
|
*/
|
|
1371
1371
|
updateInstructionBatch: UpdateInstruction[] | undefined;
|
|
1372
1372
|
/**
|
|
1373
|
-
* @public
|
|
1374
1373
|
* <p>The ID of the workspace to update.</p>
|
|
1374
|
+
* @public
|
|
1375
1375
|
*/
|
|
1376
1376
|
workspaceId: string | undefined;
|
|
1377
1377
|
}
|
|
1378
1378
|
/**
|
|
1379
|
-
* @public
|
|
1380
1379
|
* <p>A structure containing information about one error encountered while performing an
|
|
1381
1380
|
* <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a> operation.</p>
|
|
1381
|
+
* @public
|
|
1382
1382
|
*/
|
|
1383
1383
|
export interface UpdateError {
|
|
1384
1384
|
/**
|
|
1385
|
-
* @public
|
|
1386
1385
|
* <p>The error code.</p>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
code: number | undefined;
|
|
1389
1389
|
/**
|
|
1390
|
-
* @public
|
|
1391
1390
|
* <p>The message for this error.</p>
|
|
1391
|
+
* @public
|
|
1392
1392
|
*/
|
|
1393
1393
|
message: string | undefined;
|
|
1394
1394
|
/**
|
|
1395
|
-
* @public
|
|
1396
1395
|
* <p>Specifies which permission update caused the error.</p>
|
|
1396
|
+
* @public
|
|
1397
1397
|
*/
|
|
1398
1398
|
causedBy: UpdateInstruction | undefined;
|
|
1399
1399
|
}
|
|
@@ -1402,8 +1402,8 @@ export interface UpdateError {
|
|
|
1402
1402
|
*/
|
|
1403
1403
|
export interface UpdatePermissionsResponse {
|
|
1404
1404
|
/**
|
|
1405
|
-
* @public
|
|
1406
1405
|
* <p>An array of structures that contain the errors from the operation, if any.</p>
|
|
1406
|
+
* @public
|
|
1407
1407
|
*/
|
|
1408
1408
|
errors: UpdateError[] | undefined;
|
|
1409
1409
|
}
|
|
@@ -1412,14 +1412,14 @@ export interface UpdatePermissionsResponse {
|
|
|
1412
1412
|
*/
|
|
1413
1413
|
export interface TagResourceRequest {
|
|
1414
1414
|
/**
|
|
1415
|
-
* @public
|
|
1416
1415
|
* <p>The ARN of the resource the tag is associated with.</p>
|
|
1416
|
+
* @public
|
|
1417
1417
|
*/
|
|
1418
1418
|
resourceArn: string | undefined;
|
|
1419
1419
|
/**
|
|
1420
|
-
* @public
|
|
1421
1420
|
* <p>The list of tag keys and values to associate with the resource. You can associate tag
|
|
1422
1421
|
* keys only, tags (key and values) only or a combination of tag keys and tags.</p>
|
|
1422
|
+
* @public
|
|
1423
1423
|
*/
|
|
1424
1424
|
tags: Record<string, string> | undefined;
|
|
1425
1425
|
}
|
|
@@ -1433,13 +1433,13 @@ export interface TagResourceResponse {
|
|
|
1433
1433
|
*/
|
|
1434
1434
|
export interface UntagResourceRequest {
|
|
1435
1435
|
/**
|
|
1436
|
-
* @public
|
|
1437
1436
|
* <p>The ARN of the resource the tag association is removed from. </p>
|
|
1437
|
+
* @public
|
|
1438
1438
|
*/
|
|
1439
1439
|
resourceArn: string | undefined;
|
|
1440
1440
|
/**
|
|
1441
|
-
* @public
|
|
1442
1441
|
* <p>The key values of the tag to be removed from the resource.</p>
|
|
1442
|
+
* @public
|
|
1443
1443
|
*/
|
|
1444
1444
|
tagKeys: string[] | undefined;
|
|
1445
1445
|
}
|
|
@@ -1453,28 +1453,27 @@ export interface UntagResourceResponse {
|
|
|
1453
1453
|
*/
|
|
1454
1454
|
export interface CreateWorkspaceRequest {
|
|
1455
1455
|
/**
|
|
1456
|
-
* @public
|
|
1457
1456
|
* <p>Specifies whether the workspace can access Amazon Web Services resources in this
|
|
1458
1457
|
* Amazon Web Services account only, or whether it can also access Amazon Web Services
|
|
1459
1458
|
* resources in other accounts in the same organization. If you specify
|
|
1460
1459
|
* <code>ORGANIZATION</code>, you must specify which organizational units the workspace
|
|
1461
1460
|
* can access in the <code>workspaceOrganizationalUnits</code> parameter.</p>
|
|
1461
|
+
* @public
|
|
1462
1462
|
*/
|
|
1463
1463
|
accountAccessType: AccountAccessType | undefined;
|
|
1464
1464
|
/**
|
|
1465
|
-
* @public
|
|
1466
1465
|
* <p>A unique, case-sensitive, user-provided identifier to ensure the idempotency of the
|
|
1467
1466
|
* request.</p>
|
|
1467
|
+
* @public
|
|
1468
1468
|
*/
|
|
1469
1469
|
clientToken?: string;
|
|
1470
1470
|
/**
|
|
1471
|
-
* @public
|
|
1472
1471
|
* <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
|
|
1473
1472
|
* in an organization.</p>
|
|
1473
|
+
* @public
|
|
1474
1474
|
*/
|
|
1475
1475
|
organizationRoleName?: string;
|
|
1476
1476
|
/**
|
|
1477
|
-
* @public
|
|
1478
1477
|
* <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
|
|
1479
1478
|
* permissions that the workspace needs to use Amazon Web Services data sources and
|
|
1480
1479
|
* notification channels.</p>
|
|
@@ -1491,85 +1490,85 @@ export interface CreateWorkspaceRequest {
|
|
|
1491
1490
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana
|
|
1492
1491
|
* permissions and policies for Amazon Web Services data sources and notification
|
|
1493
1492
|
* channels</a>.</p>
|
|
1493
|
+
* @public
|
|
1494
1494
|
*/
|
|
1495
1495
|
permissionType: PermissionType | undefined;
|
|
1496
1496
|
/**
|
|
1497
|
-
* @public
|
|
1498
1497
|
* <p>The name of the CloudFormation stack set to use to generate IAM
|
|
1499
1498
|
* roles to be used for this workspace.</p>
|
|
1499
|
+
* @public
|
|
1500
1500
|
*/
|
|
1501
1501
|
stackSetName?: string;
|
|
1502
1502
|
/**
|
|
1503
|
-
* @public
|
|
1504
1503
|
* <p>This parameter is for internal use only, and should not be used.</p>
|
|
1504
|
+
* @public
|
|
1505
1505
|
*/
|
|
1506
1506
|
workspaceDataSources?: DataSourceType[];
|
|
1507
1507
|
/**
|
|
1508
|
-
* @public
|
|
1509
1508
|
* <p>A description for the workspace. This is used only to help you identify this
|
|
1510
1509
|
* workspace.</p>
|
|
1511
1510
|
* <p>Pattern: <code>^[\\p\{L\}\\p\{Z\}\\p\{N\}\\p\{P\}]\{0,2048\}$</code>
|
|
1512
1511
|
* </p>
|
|
1512
|
+
* @public
|
|
1513
1513
|
*/
|
|
1514
1514
|
workspaceDescription?: string;
|
|
1515
1515
|
/**
|
|
1516
|
-
* @public
|
|
1517
1516
|
* <p>The name for the workspace. It does not have to be unique.</p>
|
|
1517
|
+
* @public
|
|
1518
1518
|
*/
|
|
1519
1519
|
workspaceName?: string;
|
|
1520
1520
|
/**
|
|
1521
|
-
* @public
|
|
1522
1521
|
* <p>Specify the Amazon Web Services notification channels that you plan to use in this
|
|
1523
1522
|
* workspace. Specifying these data sources here enables Amazon Managed Grafana to create
|
|
1524
1523
|
* IAM roles and permissions that allow Amazon Managed Grafana to use these
|
|
1525
1524
|
* channels.</p>
|
|
1525
|
+
* @public
|
|
1526
1526
|
*/
|
|
1527
1527
|
workspaceNotificationDestinations?: NotificationDestinationType[];
|
|
1528
1528
|
/**
|
|
1529
|
-
* @public
|
|
1530
1529
|
* <p>Specifies the organizational units that this workspace is allowed to use data sources
|
|
1531
1530
|
* from, if this workspace is in an account that is part of an organization.</p>
|
|
1531
|
+
* @public
|
|
1532
1532
|
*/
|
|
1533
1533
|
workspaceOrganizationalUnits?: string[];
|
|
1534
1534
|
/**
|
|
1535
|
-
* @public
|
|
1536
1535
|
* <p>Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data
|
|
1537
1536
|
* sources and notification channels. You are responsible for managing the permissions
|
|
1538
1537
|
* for this role as new data sources or notification channels are added. </p>
|
|
1538
|
+
* @public
|
|
1539
1539
|
*/
|
|
1540
1540
|
workspaceRoleArn?: string;
|
|
1541
1541
|
/**
|
|
1542
|
-
* @public
|
|
1543
1542
|
* <p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to
|
|
1544
1543
|
* authenticate users for using the Grafana console within a workspace. For more
|
|
1545
1544
|
* information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in
|
|
1546
1545
|
* Amazon Managed Grafana</a>.</p>
|
|
1546
|
+
* @public
|
|
1547
1547
|
*/
|
|
1548
1548
|
authenticationProviders: AuthenticationProviderTypes[] | undefined;
|
|
1549
1549
|
/**
|
|
1550
|
-
* @public
|
|
1551
1550
|
* <p>The list of tags associated with the workspace.</p>
|
|
1551
|
+
* @public
|
|
1552
1552
|
*/
|
|
1553
1553
|
tags?: Record<string, string>;
|
|
1554
1554
|
/**
|
|
1555
|
-
* @public
|
|
1556
1555
|
* <p>The configuration settings for an Amazon VPC that contains data sources for
|
|
1557
1556
|
* your Grafana workspace to connect to.</p>
|
|
1558
1557
|
* <note>
|
|
1559
1558
|
* <p>Connecting to a private VPC is not yet available in the Asia Pacific (Seoul)
|
|
1560
1559
|
* Region (ap-northeast-2).</p>
|
|
1561
1560
|
* </note>
|
|
1561
|
+
* @public
|
|
1562
1562
|
*/
|
|
1563
1563
|
vpcConfiguration?: VpcConfiguration;
|
|
1564
1564
|
/**
|
|
1565
|
-
* @public
|
|
1566
1565
|
* <p>The configuration string for the workspace that you create. For more information about
|
|
1567
1566
|
* 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
|
|
1568
1567
|
* workspace</a>.</p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
configuration?: __LazyJsonString | string;
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>Configuration for network access to your workspace.</p>
|
|
1574
1573
|
* <p>When this is configured, only listed IP addresses and VPC endpoints will be able to
|
|
1575
1574
|
* access your workspace. Standard Grafana authentication and authorization will still be
|
|
@@ -1577,14 +1576,15 @@ export interface CreateWorkspaceRequest {
|
|
|
1577
1576
|
* <p>If this is not configured, or is removed, then all IP addresses and VPC endpoints will
|
|
1578
1577
|
* be allowed. Standard Grafana authentication and authorization will still be
|
|
1579
1578
|
* required.</p>
|
|
1579
|
+
* @public
|
|
1580
1580
|
*/
|
|
1581
1581
|
networkAccessControl?: NetworkAccessConfiguration;
|
|
1582
1582
|
/**
|
|
1583
|
-
* @public
|
|
1584
1583
|
* <p>Specifies the version of Grafana to support in the new workspace. If not specified,
|
|
1585
1584
|
* defaults to the latest version (for example, 9.4).</p>
|
|
1586
1585
|
* <p>To get a list of supported versions, use the <code>ListVersions</code>
|
|
1587
1586
|
* operation.</p>
|
|
1587
|
+
* @public
|
|
1588
1588
|
*/
|
|
1589
1589
|
grafanaVersion?: string;
|
|
1590
1590
|
}
|
|
@@ -1593,8 +1593,8 @@ export interface CreateWorkspaceRequest {
|
|
|
1593
1593
|
*/
|
|
1594
1594
|
export interface CreateWorkspaceResponse {
|
|
1595
1595
|
/**
|
|
1596
|
-
* @public
|
|
1597
1596
|
* <p>A structure containing data about the workspace that was created.</p>
|
|
1597
|
+
* @public
|
|
1598
1598
|
*/
|
|
1599
1599
|
workspace: WorkspaceDescription | undefined;
|
|
1600
1600
|
}
|
|
@@ -1603,8 +1603,8 @@ export interface CreateWorkspaceResponse {
|
|
|
1603
1603
|
*/
|
|
1604
1604
|
export interface DeleteWorkspaceRequest {
|
|
1605
1605
|
/**
|
|
1606
|
-
* @public
|
|
1607
1606
|
* <p>The ID of the workspace to delete.</p>
|
|
1607
|
+
* @public
|
|
1608
1608
|
*/
|
|
1609
1609
|
workspaceId: string | undefined;
|
|
1610
1610
|
}
|
|
@@ -1613,8 +1613,8 @@ export interface DeleteWorkspaceRequest {
|
|
|
1613
1613
|
*/
|
|
1614
1614
|
export interface DeleteWorkspaceResponse {
|
|
1615
1615
|
/**
|
|
1616
|
-
* @public
|
|
1617
1616
|
* <p>A structure containing information about the workspace that was deleted.</p>
|
|
1617
|
+
* @public
|
|
1618
1618
|
*/
|
|
1619
1619
|
workspace: WorkspaceDescription | undefined;
|
|
1620
1620
|
}
|
|
@@ -1623,8 +1623,8 @@ export interface DeleteWorkspaceResponse {
|
|
|
1623
1623
|
*/
|
|
1624
1624
|
export interface DescribeWorkspaceRequest {
|
|
1625
1625
|
/**
|
|
1626
|
-
* @public
|
|
1627
1626
|
* <p>The ID of the workspace to display information about.</p>
|
|
1627
|
+
* @public
|
|
1628
1628
|
*/
|
|
1629
1629
|
workspaceId: string | undefined;
|
|
1630
1630
|
}
|
|
@@ -1633,8 +1633,8 @@ export interface DescribeWorkspaceRequest {
|
|
|
1633
1633
|
*/
|
|
1634
1634
|
export interface DescribeWorkspaceResponse {
|
|
1635
1635
|
/**
|
|
1636
|
-
* @public
|
|
1637
1636
|
* <p>A structure containing information about the workspace.</p>
|
|
1637
|
+
* @public
|
|
1638
1638
|
*/
|
|
1639
1639
|
workspace: WorkspaceDescription | undefined;
|
|
1640
1640
|
}
|
|
@@ -1643,92 +1643,92 @@ export interface DescribeWorkspaceResponse {
|
|
|
1643
1643
|
*/
|
|
1644
1644
|
export interface ListWorkspacesRequest {
|
|
1645
1645
|
/**
|
|
1646
|
-
* @public
|
|
1647
1646
|
* <p>The maximum number of workspaces to include in the results.</p>
|
|
1647
|
+
* @public
|
|
1648
1648
|
*/
|
|
1649
1649
|
maxResults?: number;
|
|
1650
1650
|
/**
|
|
1651
|
-
* @public
|
|
1652
1651
|
* <p>The token for the next set of workspaces to return. (You receive this token from a
|
|
1653
1652
|
* previous <code>ListWorkspaces</code> operation.)</p>
|
|
1653
|
+
* @public
|
|
1654
1654
|
*/
|
|
1655
1655
|
nextToken?: string;
|
|
1656
1656
|
}
|
|
1657
1657
|
/**
|
|
1658
|
-
* @public
|
|
1659
1658
|
* <p>A structure that contains some information about one workspace in the account.</p>
|
|
1659
|
+
* @public
|
|
1660
1660
|
*/
|
|
1661
1661
|
export interface WorkspaceSummary {
|
|
1662
1662
|
/**
|
|
1663
|
-
* @public
|
|
1664
1663
|
* <p>The date that the workspace was created.</p>
|
|
1664
|
+
* @public
|
|
1665
1665
|
*/
|
|
1666
1666
|
created: Date | undefined;
|
|
1667
1667
|
/**
|
|
1668
|
-
* @public
|
|
1669
1668
|
* <p>The customer-entered description of the workspace.</p>
|
|
1669
|
+
* @public
|
|
1670
1670
|
*/
|
|
1671
1671
|
description?: string;
|
|
1672
1672
|
/**
|
|
1673
|
-
* @public
|
|
1674
1673
|
* <p>The URL endpoint to use to access the Grafana console in the workspace.</p>
|
|
1674
|
+
* @public
|
|
1675
1675
|
*/
|
|
1676
1676
|
endpoint: string | undefined;
|
|
1677
1677
|
/**
|
|
1678
|
-
* @public
|
|
1679
1678
|
* <p>The Grafana version that the workspace is running.</p>
|
|
1679
|
+
* @public
|
|
1680
1680
|
*/
|
|
1681
1681
|
grafanaVersion: string | undefined;
|
|
1682
1682
|
/**
|
|
1683
|
-
* @public
|
|
1684
1683
|
* <p>The unique ID of the workspace.</p>
|
|
1684
|
+
* @public
|
|
1685
1685
|
*/
|
|
1686
1686
|
id: string | undefined;
|
|
1687
1687
|
/**
|
|
1688
|
-
* @public
|
|
1689
1688
|
* <p>The most recent date that the workspace was modified.</p>
|
|
1689
|
+
* @public
|
|
1690
1690
|
*/
|
|
1691
1691
|
modified: Date | undefined;
|
|
1692
1692
|
/**
|
|
1693
|
-
* @public
|
|
1694
1693
|
* <p>The name of the workspace.</p>
|
|
1694
|
+
* @public
|
|
1695
1695
|
*/
|
|
1696
1696
|
name?: string;
|
|
1697
1697
|
/**
|
|
1698
|
-
* @public
|
|
1699
1698
|
* <p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically
|
|
1700
1699
|
* create IAM roles and permissions for, which allows Amazon Managed Grafana to
|
|
1701
1700
|
* use these channels.</p>
|
|
1701
|
+
* @public
|
|
1702
1702
|
*/
|
|
1703
1703
|
notificationDestinations?: NotificationDestinationType[];
|
|
1704
1704
|
/**
|
|
1705
|
-
* @public
|
|
1706
1705
|
* <p>The current status of the workspace.</p>
|
|
1706
|
+
* @public
|
|
1707
1707
|
*/
|
|
1708
1708
|
status: WorkspaceStatus | undefined;
|
|
1709
1709
|
/**
|
|
1710
|
-
* @public
|
|
1711
1710
|
* <p>A structure containing information about the authentication methods used in the
|
|
1712
1711
|
* workspace.</p>
|
|
1712
|
+
* @public
|
|
1713
1713
|
*/
|
|
1714
1714
|
authentication: AuthenticationSummary | undefined;
|
|
1715
1715
|
/**
|
|
1716
|
-
* @public
|
|
1717
1716
|
* <p>The list of tags associated with the workspace.</p>
|
|
1717
|
+
* @public
|
|
1718
1718
|
*/
|
|
1719
1719
|
tags?: Record<string, string>;
|
|
1720
1720
|
/**
|
|
1721
|
-
* @public
|
|
1722
1721
|
* <p>Specifies whether this workspace has a full Grafana Enterprise license.</p>
|
|
1723
1722
|
* <note>
|
|
1724
1723
|
* <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p>
|
|
1725
1724
|
* </note>
|
|
1725
|
+
* @public
|
|
1726
1726
|
*/
|
|
1727
1727
|
licenseType?: LicenseType;
|
|
1728
1728
|
/**
|
|
1729
|
-
* @public
|
|
1730
1729
|
* <p>The token that ties this workspace to a Grafana Labs account. For more information,
|
|
1731
1730
|
* see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Register with Grafana Labs</a>.</p>
|
|
1731
|
+
* @public
|
|
1732
1732
|
*/
|
|
1733
1733
|
grafanaToken?: string;
|
|
1734
1734
|
}
|
|
@@ -1737,14 +1737,14 @@ export interface WorkspaceSummary {
|
|
|
1737
1737
|
*/
|
|
1738
1738
|
export interface ListWorkspacesResponse {
|
|
1739
1739
|
/**
|
|
1740
|
-
* @public
|
|
1741
1740
|
* <p>An array of structures that contain some information about the workspaces in the
|
|
1742
1741
|
* account.</p>
|
|
1742
|
+
* @public
|
|
1743
1743
|
*/
|
|
1744
1744
|
workspaces: WorkspaceSummary[] | undefined;
|
|
1745
1745
|
/**
|
|
1746
|
-
* @public
|
|
1747
1746
|
* <p>The token to use when requesting the next set of workspaces.</p>
|
|
1747
|
+
* @public
|
|
1748
1748
|
*/
|
|
1749
1749
|
nextToken?: string;
|
|
1750
1750
|
}
|
|
@@ -1753,23 +1753,22 @@ export interface ListWorkspacesResponse {
|
|
|
1753
1753
|
*/
|
|
1754
1754
|
export interface UpdateWorkspaceRequest {
|
|
1755
1755
|
/**
|
|
1756
|
-
* @public
|
|
1757
1756
|
* <p>Specifies whether the workspace can access Amazon Web Services resources in this
|
|
1758
1757
|
* Amazon Web Services account only, or whether it can also access Amazon Web Services
|
|
1759
1758
|
* resources in other accounts in the same organization. If you specify
|
|
1760
1759
|
* <code>ORGANIZATION</code>, you must specify which organizational units the workspace
|
|
1761
1760
|
* can access in the <code>workspaceOrganizationalUnits</code> parameter.</p>
|
|
1761
|
+
* @public
|
|
1762
1762
|
*/
|
|
1763
1763
|
accountAccessType?: AccountAccessType;
|
|
1764
1764
|
/**
|
|
1765
|
-
* @public
|
|
1766
1765
|
* <p>The name of an IAM role that already exists to use to access resources
|
|
1767
1766
|
* through Organizations. This can only be used with a workspace that has the
|
|
1768
1767
|
* <code>permissionType</code> set to <code>CUSTOMER_MANAGED</code>.</p>
|
|
1768
|
+
* @public
|
|
1769
1769
|
*/
|
|
1770
1770
|
organizationRoleName?: string;
|
|
1771
1771
|
/**
|
|
1772
|
-
* @public
|
|
1773
1772
|
* <p>Use this parameter if you want to change a workspace from <code>SERVICE_MANAGED</code>
|
|
1774
1773
|
* to <code>CUSTOMER_MANAGED</code>. This allows you to manage the permissions that the
|
|
1775
1774
|
* workspace uses to access datasources and notification channels. If the workspace is
|
|
@@ -1791,73 +1790,73 @@ export interface UpdateWorkspaceRequest {
|
|
|
1791
1790
|
* <code>SERVICE_MANAGED</code> using the Amazon Managed Grafana console. For more
|
|
1792
1791
|
* 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>
|
|
1793
1792
|
* </note>
|
|
1793
|
+
* @public
|
|
1794
1794
|
*/
|
|
1795
1795
|
permissionType?: PermissionType;
|
|
1796
1796
|
/**
|
|
1797
|
-
* @public
|
|
1798
1797
|
* <p>The name of the CloudFormation stack set to use to generate IAM
|
|
1799
1798
|
* roles to be used for this workspace.</p>
|
|
1799
|
+
* @public
|
|
1800
1800
|
*/
|
|
1801
1801
|
stackSetName?: string;
|
|
1802
1802
|
/**
|
|
1803
|
-
* @public
|
|
1804
1803
|
* <p>This parameter is for internal use only, and should not be used.</p>
|
|
1804
|
+
* @public
|
|
1805
1805
|
*/
|
|
1806
1806
|
workspaceDataSources?: DataSourceType[];
|
|
1807
1807
|
/**
|
|
1808
|
-
* @public
|
|
1809
1808
|
* <p>A description for the workspace. This is used only to help you identify this
|
|
1810
1809
|
* workspace.</p>
|
|
1810
|
+
* @public
|
|
1811
1811
|
*/
|
|
1812
1812
|
workspaceDescription?: string;
|
|
1813
1813
|
/**
|
|
1814
|
-
* @public
|
|
1815
1814
|
* <p>The ID of the workspace to update.</p>
|
|
1815
|
+
* @public
|
|
1816
1816
|
*/
|
|
1817
1817
|
workspaceId: string | undefined;
|
|
1818
1818
|
/**
|
|
1819
|
-
* @public
|
|
1820
1819
|
* <p>A new name for the workspace to update.</p>
|
|
1820
|
+
* @public
|
|
1821
1821
|
*/
|
|
1822
1822
|
workspaceName?: string;
|
|
1823
1823
|
/**
|
|
1824
|
-
* @public
|
|
1825
1824
|
* <p>Specify the Amazon Web Services notification channels that you plan to use in this
|
|
1826
1825
|
* workspace. Specifying these data sources here enables Amazon Managed Grafana to create
|
|
1827
1826
|
* IAM roles and permissions that allow Amazon Managed Grafana to use these
|
|
1828
1827
|
* channels.</p>
|
|
1828
|
+
* @public
|
|
1829
1829
|
*/
|
|
1830
1830
|
workspaceNotificationDestinations?: NotificationDestinationType[];
|
|
1831
1831
|
/**
|
|
1832
|
-
* @public
|
|
1833
1832
|
* <p>Specifies the organizational units that this workspace is allowed to use data sources
|
|
1834
1833
|
* from, if this workspace is in an account that is part of an organization.</p>
|
|
1834
|
+
* @public
|
|
1835
1835
|
*/
|
|
1836
1836
|
workspaceOrganizationalUnits?: string[];
|
|
1837
1837
|
/**
|
|
1838
|
-
* @public
|
|
1839
1838
|
* <p>Specifies an IAM role that grants permissions to Amazon Web Services
|
|
1840
1839
|
* resources that the workspace accesses, such as data sources and notification channels.
|
|
1841
1840
|
* If this workspace has <code>permissionType</code>
|
|
1842
1841
|
* <code>CUSTOMER_MANAGED</code>,
|
|
1843
1842
|
* then this role is required.</p>
|
|
1843
|
+
* @public
|
|
1844
1844
|
*/
|
|
1845
1845
|
workspaceRoleArn?: string;
|
|
1846
1846
|
/**
|
|
1847
|
-
* @public
|
|
1848
1847
|
* <p>The configuration settings for an Amazon VPC that contains data sources for
|
|
1849
1848
|
* your Grafana workspace to connect to.</p>
|
|
1849
|
+
* @public
|
|
1850
1850
|
*/
|
|
1851
1851
|
vpcConfiguration?: VpcConfiguration;
|
|
1852
1852
|
/**
|
|
1853
|
-
* @public
|
|
1854
1853
|
* <p>Whether to remove the VPC configuration from the workspace.</p>
|
|
1855
1854
|
* <p>Setting this to <code>true</code> and providing a <code>vpcConfiguration</code> to set
|
|
1856
1855
|
* will return an error.</p>
|
|
1856
|
+
* @public
|
|
1857
1857
|
*/
|
|
1858
1858
|
removeVpcConfiguration?: boolean;
|
|
1859
1859
|
/**
|
|
1860
|
-
* @public
|
|
1861
1860
|
* <p>The configuration settings for network access to your workspace.</p>
|
|
1862
1861
|
* <p>When this is configured, only listed IP addresses and VPC endpoints will be able to
|
|
1863
1862
|
* access your workspace. Standard Grafana authentication and authorization will still be
|
|
@@ -1865,16 +1864,17 @@ export interface UpdateWorkspaceRequest {
|
|
|
1865
1864
|
* <p>If this is not configured, or is removed, then all IP addresses and VPC endpoints will
|
|
1866
1865
|
* be allowed. Standard Grafana authentication and authorization will still be
|
|
1867
1866
|
* required.</p>
|
|
1867
|
+
* @public
|
|
1868
1868
|
*/
|
|
1869
1869
|
networkAccessControl?: NetworkAccessConfiguration;
|
|
1870
1870
|
/**
|
|
1871
|
-
* @public
|
|
1872
1871
|
* <p>Whether to remove the network access configuration from the workspace.</p>
|
|
1873
1872
|
* <p>Setting this to <code>true</code> and providing a <code>networkAccessControl</code> to
|
|
1874
1873
|
* set will return an error.</p>
|
|
1875
1874
|
* <p>If you remove this configuration by setting this to <code>true</code>, then all IP
|
|
1876
1875
|
* addresses and VPC endpoints will be allowed. Standard Grafana authentication and
|
|
1877
1876
|
* authorization will still be required.</p>
|
|
1877
|
+
* @public
|
|
1878
1878
|
*/
|
|
1879
1879
|
removeNetworkAccessConfiguration?: boolean;
|
|
1880
1880
|
}
|
|
@@ -1883,8 +1883,8 @@ export interface UpdateWorkspaceRequest {
|
|
|
1883
1883
|
*/
|
|
1884
1884
|
export interface UpdateWorkspaceResponse {
|
|
1885
1885
|
/**
|
|
1886
|
-
* @public
|
|
1887
1886
|
* <p>A structure containing data about the workspace that was created.</p>
|
|
1887
|
+
* @public
|
|
1888
1888
|
*/
|
|
1889
1889
|
workspace: WorkspaceDescription | undefined;
|
|
1890
1890
|
}
|