@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/README.md CHANGED
@@ -6,15 +6,7 @@
6
6
 
7
7
  AWS SDK for JavaScript Grafana Client for Node.js, Browser and React Native.
8
8
 
9
- <p>Amazon Managed Grafana is a fully managed and secure data visualization service that
10
- you can use to instantly query, correlate, and visualize operational metrics, logs, and
11
- traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and
12
- scale Grafana, a widely deployed data visualization tool that is popular for its
13
- extensible data support.</p>
14
- <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called
15
- <i>workspaces</i>. In a workspace, you can create Grafana dashboards
16
- and visualizations to analyze your metrics, logs, and traces without having to build,
17
- package, or deploy any hardware to run Grafana servers. </p>
9
+ <p>Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.</p> <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called <i>workspaces</i>. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers. </p>
18
10
 
19
11
  ## Installing
20
12
  To install this package, simply type add or install @aws-sdk/client-grafana
@@ -165,6 +165,7 @@ const _i = "id";
165
165
  const _iD = "isDisabled";
166
166
  const _iM = "idpMetadata";
167
167
  const _k = "key";
168
+ const _kKI = "kmsKeyId";
168
169
  const _kN = "keyName";
169
170
  const _kR = "keyRole";
170
171
  const _l = "login";
@@ -339,8 +340,8 @@ exports.CreateWorkspaceApiKeyResponse$ = [3, n0, _CWAKRr,
339
340
  ];
340
341
  exports.CreateWorkspaceRequest$ = [3, n0, _CWR,
341
342
  0,
342
- [_aAT, _pT, _aP, _cT, _oRN, _sSN, _wDS, _wD, _wN, _wND, _wOU, _wRA, _t, _vC, _co, _nAC, _gV],
343
- [0, 0, 64 | 0, [0, 4], [() => OrganizationRoleName, 0], 0, 64 | 0, [() => Description, 0], [() => WorkspaceName, 0], 64 | 0, [() => OrganizationalUnitList, 0], [() => IamRoleArn, 0], 128 | 0, () => exports.VpcConfiguration$, [() => OverridableConfigurationJson, 0], () => exports.NetworkAccessConfiguration$, 0], 3
343
+ [_aAT, _pT, _aP, _cT, _oRN, _sSN, _wDS, _wD, _wN, _wND, _wOU, _wRA, _t, _vC, _co, _nAC, _gV, _kKI],
344
+ [0, 0, 64 | 0, [0, 4], [() => OrganizationRoleName, 0], 0, 64 | 0, [() => Description, 0], [() => WorkspaceName, 0], 64 | 0, [() => OrganizationalUnitList, 0], [() => IamRoleArn, 0], 128 | 0, () => exports.VpcConfiguration$, [() => OverridableConfigurationJson, 0], () => exports.NetworkAccessConfiguration$, 0, 0], 3
344
345
  ];
345
346
  exports.CreateWorkspaceResponse$ = [3, n0, _CWRr,
346
347
  0,
@@ -634,8 +635,8 @@ exports.VpcConfiguration$ = [3, n0, _VC,
634
635
  ];
635
636
  exports.WorkspaceDescription$ = [3, n0, _WD,
636
637
  0,
637
- [_cr, _dS, _en, _gV, _i, _mo, _st, _au, _aAT, _d, _n, _oRN, _nD, _oU, _pT, _sSN, _wRA, _lT, _fTC, _lE, _fTE, _t, _vC, _nAC, _gT],
638
- [4, 64 | 0, 0, 0, 0, 4, 0, () => exports.AuthenticationSummary$, 0, [() => Description, 0], [() => WorkspaceName, 0], [() => OrganizationRoleName, 0], 64 | 0, [() => OrganizationalUnitList, 0], 0, 0, [() => IamRoleArn, 0], 0, 2, 4, 4, 128 | 0, () => exports.VpcConfiguration$, () => exports.NetworkAccessConfiguration$, 0], 8
638
+ [_cr, _dS, _en, _gV, _i, _mo, _st, _au, _aAT, _d, _n, _oRN, _nD, _oU, _pT, _sSN, _wRA, _lT, _fTC, _lE, _fTE, _t, _vC, _nAC, _gT, _kKI],
639
+ [4, 64 | 0, 0, 0, 0, 4, 0, () => exports.AuthenticationSummary$, 0, [() => Description, 0], [() => WorkspaceName, 0], [() => OrganizationRoleName, 0], 64 | 0, [() => OrganizationalUnitList, 0], 0, 0, [() => IamRoleArn, 0], 0, 2, 4, 4, 128 | 0, () => exports.VpcConfiguration$, () => exports.NetworkAccessConfiguration$, 0, 0], 8
639
640
  ];
640
641
  exports.WorkspaceSummary$ = [3, n0, _WS,
641
642
  0,
@@ -160,6 +160,7 @@ const _i = "id";
160
160
  const _iD = "isDisabled";
161
161
  const _iM = "idpMetadata";
162
162
  const _k = "key";
163
+ const _kKI = "kmsKeyId";
163
164
  const _kN = "keyName";
164
165
  const _kR = "keyRole";
165
166
  const _l = "login";
@@ -334,8 +335,8 @@ export var CreateWorkspaceApiKeyResponse$ = [3, n0, _CWAKRr,
334
335
  ];
335
336
  export var CreateWorkspaceRequest$ = [3, n0, _CWR,
336
337
  0,
337
- [_aAT, _pT, _aP, _cT, _oRN, _sSN, _wDS, _wD, _wN, _wND, _wOU, _wRA, _t, _vC, _co, _nAC, _gV],
338
- [0, 0, 64 | 0, [0, 4], [() => OrganizationRoleName, 0], 0, 64 | 0, [() => Description, 0], [() => WorkspaceName, 0], 64 | 0, [() => OrganizationalUnitList, 0], [() => IamRoleArn, 0], 128 | 0, () => VpcConfiguration$, [() => OverridableConfigurationJson, 0], () => NetworkAccessConfiguration$, 0], 3
338
+ [_aAT, _pT, _aP, _cT, _oRN, _sSN, _wDS, _wD, _wN, _wND, _wOU, _wRA, _t, _vC, _co, _nAC, _gV, _kKI],
339
+ [0, 0, 64 | 0, [0, 4], [() => OrganizationRoleName, 0], 0, 64 | 0, [() => Description, 0], [() => WorkspaceName, 0], 64 | 0, [() => OrganizationalUnitList, 0], [() => IamRoleArn, 0], 128 | 0, () => VpcConfiguration$, [() => OverridableConfigurationJson, 0], () => NetworkAccessConfiguration$, 0, 0], 3
339
340
  ];
340
341
  export var CreateWorkspaceResponse$ = [3, n0, _CWRr,
341
342
  0,
@@ -629,8 +630,8 @@ export var VpcConfiguration$ = [3, n0, _VC,
629
630
  ];
630
631
  export var WorkspaceDescription$ = [3, n0, _WD,
631
632
  0,
632
- [_cr, _dS, _en, _gV, _i, _mo, _st, _au, _aAT, _d, _n, _oRN, _nD, _oU, _pT, _sSN, _wRA, _lT, _fTC, _lE, _fTE, _t, _vC, _nAC, _gT],
633
- [4, 64 | 0, 0, 0, 0, 4, 0, () => AuthenticationSummary$, 0, [() => Description, 0], [() => WorkspaceName, 0], [() => OrganizationRoleName, 0], 64 | 0, [() => OrganizationalUnitList, 0], 0, 0, [() => IamRoleArn, 0], 0, 2, 4, 4, 128 | 0, () => VpcConfiguration$, () => NetworkAccessConfiguration$, 0], 8
633
+ [_cr, _dS, _en, _gV, _i, _mo, _st, _au, _aAT, _d, _n, _oRN, _nD, _oU, _pT, _sSN, _wRA, _lT, _fTC, _lE, _fTE, _t, _vC, _nAC, _gT, _kKI],
634
+ [4, 64 | 0, 0, 0, 0, 4, 0, () => AuthenticationSummary$, 0, [() => Description, 0], [() => WorkspaceName, 0], [() => OrganizationRoleName, 0], 64 | 0, [() => OrganizationalUnitList, 0], 0, 0, [() => IamRoleArn, 0], 0, 2, 4, 4, 128 | 0, () => VpcConfiguration$, () => NetworkAccessConfiguration$, 0, 0], 8
634
635
  ];
635
636
  export var WorkspaceSummary$ = [3, n0, _WS,
636
637
  0,
@@ -215,15 +215,7 @@ export interface Grafana {
215
215
  paginateListWorkspaceServiceAccountTokens(args: ListWorkspaceServiceAccountTokensCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListWorkspaceServiceAccountTokensCommandOutput>;
216
216
  }
217
217
  /**
218
- * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that
219
- * you can use to instantly query, correlate, and visualize operational metrics, logs, and
220
- * traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and
221
- * scale Grafana, a widely deployed data visualization tool that is popular for its
222
- * extensible data support.</p>
223
- * <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called
224
- * <i>workspaces</i>. In a workspace, you can create Grafana dashboards
225
- * and visualizations to analyze your metrics, logs, and traces without having to build,
226
- * package, or deploy any hardware to run Grafana servers. </p>
218
+ * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.</p> <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called <i>workspaces</i>. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers. </p>
227
219
  * @public
228
220
  */
229
221
  export declare class Grafana extends GrafanaClient implements Grafana {
@@ -194,15 +194,7 @@ export type GrafanaClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
194
194
  export interface GrafanaClientResolvedConfig extends GrafanaClientResolvedConfigType {
195
195
  }
196
196
  /**
197
- * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that
198
- * you can use to instantly query, correlate, and visualize operational metrics, logs, and
199
- * traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and
200
- * scale Grafana, a widely deployed data visualization tool that is popular for its
201
- * extensible data support.</p>
202
- * <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called
203
- * <i>workspaces</i>. In a workspace, you can create Grafana dashboards
204
- * and visualizations to analyze your metrics, logs, and traces without having to build,
205
- * package, or deploy any hardware to run Grafana servers. </p>
197
+ * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.</p> <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called <i>workspaces</i>. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers. </p>
206
198
  * @public
207
199
  */
208
200
  export declare class GrafanaClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, GrafanaClientResolvedConfig> {
@@ -27,11 +27,7 @@ declare const AssociateLicenseCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use
31
- * <code>ENTERPRISE</code> for the <code>licenseType</code>, and pass in a valid
32
- * Grafana Labs token for the <code>grafanaToken</code>. Upgrading to Grafana Enterprise
33
- * incurs additional fees. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html">Upgrade a
34
- * workspace to Grafana Enterprise</a>.</p>
30
+ * <p>Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use <code>ENTERPRISE</code> for the <code>licenseType</code>, and pass in a valid Grafana Labs token for the <code>grafanaToken</code>. Upgrading to Grafana Enterprise incurs additional fees. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html">Upgrade a workspace to Grafana Enterprise</a>.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -101,6 +97,7 @@ declare const AssociateLicenseCommand_base: {
101
97
  * // ],
102
98
  * // },
103
99
  * // grafanaToken: "STRING_VALUE",
100
+ * // kmsKeyId: "STRING_VALUE",
104
101
  * // },
105
102
  * // };
106
103
  *
@@ -27,13 +27,7 @@ declare const CreateWorkspaceApiKeyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a Grafana API key for the workspace. This key can be used to authenticate
31
- * requests sent to the workspace's HTTP API. See <a href="https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html">https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html</a>
32
- * for available APIs and example requests.</p>
33
- * <note>
34
- * <p>In workspaces compatible with Grafana version 9 or above, use workspace service
35
- * accounts instead of API keys. API keys will be removed in a future release.</p>
36
- * </note>
30
+ * <p>Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See <a href="https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html">https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html</a> for available APIs and example requests.</p> <note> <p>In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.</p> </note>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -27,11 +27,7 @@ declare const CreateWorkspaceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a <i>workspace</i>. In a workspace, you can create Grafana
31
- * dashboards and visualizations to analyze your metrics, logs, and traces. You don't have
32
- * to build, package, or deploy any hardware to run the Grafana server.</p>
33
- * <p>Don't use <code>CreateWorkspace</code> to modify an existing workspace. Instead, use
34
- * <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html">UpdateWorkspace</a>.</p>
30
+ * <p>Creates a <i>workspace</i>. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.</p> <p>Don't use <code>CreateWorkspace</code> to modify an existing workspace. Instead, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html">UpdateWorkspace</a>.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -82,6 +78,7 @@ declare const CreateWorkspaceCommand_base: {
82
78
  * ],
83
79
  * },
84
80
  * grafanaVersion: "STRING_VALUE",
81
+ * kmsKeyId: "STRING_VALUE",
85
82
  * };
86
83
  * const command = new CreateWorkspaceCommand(input);
87
84
  * const response = await client.send(command);
@@ -139,6 +136,7 @@ declare const CreateWorkspaceCommand_base: {
139
136
  * // ],
140
137
  * // },
141
138
  * // grafanaToken: "STRING_VALUE",
139
+ * // kmsKeyId: "STRING_VALUE",
142
140
  * // },
143
141
  * // };
144
142
  *
@@ -27,19 +27,7 @@ declare const CreateWorkspaceServiceAccountCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a service account for the workspace. A service account can be used to call
31
- * Grafana HTTP APIs, and run automated workloads. After creating the service account with
32
- * the correct <code>GrafanaRole</code> for your use case, use
33
- * <code>CreateWorkspaceServiceAccountToken</code> to create a token that can be used to
34
- * authenticate and authorize Grafana HTTP API calls.</p>
35
- * <p>You can only create service accounts for workspaces that are compatible with Grafana
36
- * version 9 and above.</p>
37
- * <note>
38
- * <p>For more information about service accounts, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html">Service accounts</a> in
39
- * the <i>Amazon Managed Grafana User Guide</i>.</p>
40
- * <p>For more information about the Grafana HTTP APIs, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html">Using Grafana HTTP
41
- * APIs</a> in the <i>Amazon Managed Grafana User Guide</i>.</p>
42
- * </note>
30
+ * <p>Creates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct <code>GrafanaRole</code> for your use case, use <code>CreateWorkspaceServiceAccountToken</code> to create a token that can be used to authenticate and authorize Grafana HTTP API calls.</p> <p>You can only create service accounts for workspaces that are compatible with Grafana version 9 and above.</p> <note> <p>For more information about service accounts, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html">Service accounts</a> in the <i>Amazon Managed Grafana User Guide</i>.</p> <p>For more information about the Grafana HTTP APIs, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html">Using Grafana HTTP APIs</a> in the <i>Amazon Managed Grafana User Guide</i>.</p> </note>
43
31
  * @example
44
32
  * Use a bare-bones client and the command you need to make an API call.
45
33
  * ```javascript
@@ -27,19 +27,7 @@ declare const CreateWorkspaceServiceAccountTokenCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a token that can be used to authenticate and authorize Grafana HTTP API
31
- * operations for the given <a href="https://docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html">workspace service
32
- * account</a>. The service account acts as a user for the API operations, and
33
- * defines the permissions that are used by the API.</p>
34
- * <important>
35
- * <p>When you create the service account token, you will receive a key that is used
36
- * when calling Grafana APIs. Do not lose this key, as it will not be retrievable
37
- * again.</p>
38
- * <p>If you do lose the key, you can delete the token and recreate it to receive a
39
- * new key. This will disable the initial key.</p>
40
- * </important>
41
- * <p>Service accounts are only available for workspaces that are compatible with Grafana
42
- * version 9 and above.</p>
30
+ * <p>Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given <a href="https://docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html">workspace service account</a>. The service account acts as a user for the API operations, and defines the permissions that are used by the API.</p> <important> <p>When you create the service account token, you will receive a key that is used when calling Grafana APIs. Do not lose this key, as it will not be retrievable again.</p> <p>If you do lose the key, you can delete the token and recreate it to receive a new key. This will disable the initial key.</p> </important> <p>Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.</p>
43
31
  * @example
44
32
  * Use a bare-bones client and the command you need to make an API call.
45
33
  * ```javascript
@@ -27,11 +27,7 @@ declare const DeleteWorkspaceApiKeyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a Grafana API key for the workspace.</p>
31
- * <note>
32
- * <p>In workspaces compatible with Grafana version 9 or above, use workspace service
33
- * accounts instead of API keys. API keys will be removed in a future release.</p>
34
- * </note>
30
+ * <p>Deletes a Grafana API key for the workspace.</p> <note> <p>In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.</p> </note>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -95,6 +95,7 @@ declare const DeleteWorkspaceCommand_base: {
95
95
  * // ],
96
96
  * // },
97
97
  * // grafanaToken: "STRING_VALUE",
98
+ * // kmsKeyId: "STRING_VALUE",
98
99
  * // },
99
100
  * // };
100
101
  *
@@ -27,12 +27,7 @@ declare const DeleteWorkspaceServiceAccountCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a workspace service account from the workspace.</p>
31
- * <p>This will delete any tokens created for the service account, as well. If the tokens
32
- * are currently in use, the will fail to authenticate / authorize after they are
33
- * deleted.</p>
34
- * <p>Service accounts are only available for workspaces that are compatible with Grafana
35
- * version 9 and above.</p>
30
+ * <p>Deletes a workspace service account from the workspace.</p> <p>This will delete any tokens created for the service account, as well. If the tokens are currently in use, the will fail to authenticate / authorize after they are deleted.</p> <p>Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -27,12 +27,7 @@ declare const DeleteWorkspaceServiceAccountTokenCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a token for the workspace service account.</p>
31
- * <p>This will disable the key associated with the token. If any automation is currently
32
- * using the key, it will no longer be authenticated or authorized to perform actions with
33
- * the Grafana HTTP APIs.</p>
34
- * <p>Service accounts are only available for workspaces that are compatible with Grafana
35
- * version 9 and above.</p>
30
+ * <p>Deletes a token for the workspace service account.</p> <p>This will disable the key associated with the token. If any automation is currently using the key, it will no longer be authenticated or authorized to perform actions with the Grafana HTTP APIs.</p> <p>Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const DescribeWorkspaceAuthenticationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Displays information about the authentication methods used in one Amazon Managed Grafana
31
- * workspace.</p>
30
+ * <p>Displays information about the authentication methods used in one Amazon Managed Grafana workspace.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -95,6 +95,7 @@ declare const DescribeWorkspaceCommand_base: {
95
95
  * // ],
96
96
  * // },
97
97
  * // grafanaToken: "STRING_VALUE",
98
+ * // kmsKeyId: "STRING_VALUE",
98
99
  * // },
99
100
  * // };
100
101
  *
@@ -96,6 +96,7 @@ declare const DisassociateLicenseCommand_base: {
96
96
  * // ],
97
97
  * // },
98
98
  * // grafanaToken: "STRING_VALUE",
99
+ * // kmsKeyId: "STRING_VALUE",
99
100
  * // },
100
101
  * // };
101
102
  *
@@ -27,12 +27,7 @@ declare const ListPermissionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists the users and groups who have the Grafana <code>Admin</code> and
31
- * <code>Editor</code> roles in this workspace. If you use this operation without
32
- * specifying <code>userId</code> or <code>groupId</code>, the operation returns the roles
33
- * of all users and groups. If you specify a <code>userId</code> or a <code>groupId</code>,
34
- * only the roles for that user or group are returned. If you do this, you can specify only
35
- * one <code>userId</code> or one <code>groupId</code>.</p>
30
+ * <p>Lists the users and groups who have the Grafana <code>Admin</code> and <code>Editor</code> roles in this workspace. If you use this operation without specifying <code>userId</code> or <code>groupId</code>, the operation returns the roles of all users and groups. If you specify a <code>userId</code> or a <code>groupId</code>, only the roles for that user or group are returned. If you do this, you can specify only one <code>userId</code> or one <code>groupId</code>.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -27,10 +27,7 @@ declare const ListTagsForResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>The <code>ListTagsForResource</code> operation returns the tags that are associated
31
- * with the Amazon Managed Service for Grafana resource specified by the
32
- * <code>resourceArn</code>. Currently, the only resource that can be tagged is a
33
- * workspace. </p>
30
+ * <p>The <code>ListTagsForResource</code> operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the <code>resourceArn</code>. Currently, the only resource that can be tagged is a workspace. </p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -27,9 +27,7 @@ declare const ListVersionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists available versions of Grafana. These are available when calling
31
- * <code>CreateWorkspace</code>. Optionally, include a workspace to list the versions
32
- * to which it can be upgraded.</p>
30
+ * <p>Lists available versions of Grafana. These are available when calling <code>CreateWorkspace</code>. Optionally, include a workspace to list the versions to which it can be upgraded.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -27,13 +27,7 @@ declare const ListWorkspaceServiceAccountTokensCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of tokens for a workspace service account.</p>
31
- * <note>
32
- * <p>This does not return the key for each token. You cannot access keys after they
33
- * are created. To create a new key, delete the token and recreate it.</p>
34
- * </note>
35
- * <p>Service accounts are only available for workspaces that are compatible with Grafana
36
- * version 9 and above.</p>
30
+ * <p>Returns a list of tokens for a workspace service account.</p> <note> <p>This does not return the key for each token. You cannot access keys after they are created. To create a new key, delete the token and recreate it.</p> </note> <p>Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.</p>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -27,9 +27,7 @@ declare const ListWorkspaceServiceAccountsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of service accounts for a workspace.</p>
31
- * <p>Service accounts are only available for workspaces that are compatible with Grafana
32
- * version 9 and above.</p>
30
+ * <p>Returns a list of service accounts for a workspace.</p> <p>Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const ListWorkspacesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of Amazon Managed Grafana workspaces in the account, with some information
31
- * about each workspace. For more complete information about one workspace, use <a href="https://docs.aws.amazon.com/AAMG/latest/APIReference/API_DescribeWorkspace.html">DescribeWorkspace</a>.</p>
30
+ * <p>Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_DescribeWorkspace.html">DescribeWorkspace</a>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,12 +27,7 @@ declare const TagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>The <code>TagResource</code> operation associates tags with an Amazon Managed Grafana
31
- * resource. Currently, the only resource that can be tagged is workspaces. </p>
32
- * <p>If you specify a new tag key for the resource, this tag is appended to the list of
33
- * tags associated with the resource. If you specify a tag key that is already associated
34
- * with the resource, the new tag value that you specify replaces the previous value for
35
- * that tag.</p>
30
+ * <p>The <code>TagResource</code> operation associates tags with an Amazon Managed Grafana resource. Currently, the only resource that can be tagged is workspaces. </p> <p>If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const UntagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>The <code>UntagResource</code> operation removes the association of the tag with the
31
- * Amazon Managed Grafana resource. </p>
30
+ * <p>The <code>UntagResource</code> operation removes the association of the tag with the Amazon Managed Grafana resource. </p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const UpdatePermissionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or
31
- * <code>Editor</code> roles.</p>
30
+ * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or <code>Editor</code> roles.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,14 +27,7 @@ declare const UpdateWorkspaceAuthenticationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Use this operation to define the identity provider (IdP) that this workspace
31
- * authenticates users from, using SAML. You can also map SAML assertion attributes to
32
- * workspace user information and define which groups in the assertion attribute are to
33
- * have the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
34
- * <note>
35
- * <p>Changes to the authentication method for a workspace may take a few minutes to
36
- * take effect.</p>
37
- * </note>
30
+ * <p>Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also 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> <note> <p>Changes to the authentication method for a workspace may take a few minutes to take effect.</p> </note>
38
31
  * @example
39
32
  * Use a bare-bones client and the command you need to make an API call.
40
33
  * ```javascript
@@ -27,12 +27,7 @@ declare const UpdateWorkspaceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit
31
- * any optional parameters, the existing values of those parameters are not changed.</p>
32
- * <p>To modify the user authentication methods that the workspace uses, such as SAML or
33
- * IAM Identity Center, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html">UpdateWorkspaceAuthentication</a>.</p>
34
- * <p>To modify which users in the workspace have the <code>Admin</code> and
35
- * <code>Editor</code> Grafana roles, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a>.</p>
30
+ * <p>Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.</p> <p>To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html">UpdateWorkspaceAuthentication</a>.</p> <p>To modify which users in the workspace have the <code>Admin</code> and <code>Editor</code> Grafana roles, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a>.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -134,6 +129,7 @@ declare const UpdateWorkspaceCommand_base: {
134
129
  * // ],
135
130
  * // },
136
131
  * // grafanaToken: "STRING_VALUE",
132
+ * // kmsKeyId: "STRING_VALUE",
137
133
  * // },
138
134
  * // };
139
135
  *
@@ -1,13 +1,5 @@
1
1
  /**
2
- * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that
3
- * you can use to instantly query, correlate, and visualize operational metrics, logs, and
4
- * traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and
5
- * scale Grafana, a widely deployed data visualization tool that is popular for its
6
- * extensible data support.</p>
7
- * <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called
8
- * <i>workspaces</i>. In a workspace, you can create Grafana dashboards
9
- * and visualizations to analyze your metrics, logs, and traces without having to build,
10
- * package, or deploy any hardware to run Grafana servers. </p>
2
+ * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.</p> <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called <i>workspaces</i>. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers. </p>
11
3
  *
12
4
  * @packageDocumentation
13
5
  */