@aws-sdk/client-grafana 3.276.0 → 3.278.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 (16) hide show
  1. package/README.md +9 -7
  2. package/dist-types/Grafana.d.ts +50 -42
  3. package/dist-types/GrafanaClient.d.ts +9 -7
  4. package/dist-types/commands/AssociateLicenseCommand.d.ts +2 -2
  5. package/dist-types/commands/CreateWorkspaceApiKeyCommand.d.ts +2 -3
  6. package/dist-types/commands/CreateWorkspaceCommand.d.ts +4 -4
  7. package/dist-types/commands/DescribeWorkspaceAuthenticationCommand.d.ts +2 -1
  8. package/dist-types/commands/ListPermissionsCommand.d.ts +5 -6
  9. package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -3
  10. package/dist-types/commands/TagResourceCommand.d.ts +6 -5
  11. package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
  12. package/dist-types/commands/UpdatePermissionsCommand.d.ts +2 -1
  13. package/dist-types/commands/UpdateWorkspaceAuthenticationCommand.d.ts +6 -2
  14. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +6 -6
  15. package/dist-types/models/models_0.d.ts +242 -208
  16. package/package.json +4 -4
package/README.md CHANGED
@@ -9,13 +9,15 @@
9
9
 
10
10
  AWS SDK for JavaScript Grafana Client for Node.js, Browser and React Native.
11
11
 
12
- <p>Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to
13
- instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources.
14
- Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool
15
- that is popular for its extensible data support.</p>
16
- <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called <i>workspaces</i>. In
17
- a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to
18
- build, package, or deploy any hardware to run Grafana servers. </p>
12
+ <p>Amazon Managed Grafana is a fully managed and secure data visualization service that
13
+ you can use to instantly query, correlate, and visualize operational metrics, logs, and
14
+ traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and
15
+ scale Grafana, a widely deployed data visualization tool that is popular for its
16
+ extensible data support.</p>
17
+ <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called
18
+ <i>workspaces</i>. In a workspace, you can create Grafana dashboards
19
+ and visualizations to analyze your metrics, logs, and traces without having to build,
20
+ package, or deploy any hardware to run Grafana servers. </p>
19
21
 
20
22
  ## Installing
21
23
 
package/dist-types/Grafana.d.ts CHANGED
@@ -19,37 +19,38 @@ import { UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput } from "./com
19
19
  import { UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput } from "./commands/UpdateWorkspaceConfigurationCommand";
20
20
  import { GrafanaClient } from "./GrafanaClient";
21
21
  /**
22
- * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to
23
- * instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources.
24
- * Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool
25
- * that is popular for its extensible data support.</p>
26
- * <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called <i>workspaces</i>. In
27
- * a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to
28
- * build, package, or deploy any hardware to run Grafana servers. </p>
22
+ * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that
23
+ * you can use to instantly query, correlate, and visualize operational metrics, logs, and
24
+ * traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and
25
+ * scale Grafana, a widely deployed data visualization tool that is popular for its
26
+ * extensible data support.</p>
27
+ * <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called
28
+ * <i>workspaces</i>. In a workspace, you can create Grafana dashboards
29
+ * and visualizations to analyze your metrics, logs, and traces without having to build,
30
+ * package, or deploy any hardware to run Grafana servers. </p>
29
31
  */
30
32
  export declare class Grafana extends GrafanaClient {
31
33
  /**
32
34
  * <p>Assigns a Grafana Enterprise license to a workspace. 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 workspace to
34
- * Grafana Enterprise</a>.</p>
35
+ * incurs additional fees. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html">Upgrade a
36
+ * workspace to Grafana Enterprise</a>.</p>
35
37
  */
36
38
  associateLicense(args: AssociateLicenseCommandInput, options?: __HttpHandlerOptions): Promise<AssociateLicenseCommandOutput>;
37
39
  associateLicense(args: AssociateLicenseCommandInput, cb: (err: any, data?: AssociateLicenseCommandOutput) => void): void;
38
40
  associateLicense(args: AssociateLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateLicenseCommandOutput) => void): void;
39
41
  /**
40
42
  * <p>Creates a <i>workspace</i>. In a workspace, you can create Grafana
41
- * dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to
42
- * build, package, or deploy any hardware to run the Grafana server.</p>
43
- * <p>Don't use <code>CreateWorkspace</code> to modify an existing workspace. Instead,
44
- * use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html">UpdateWorkspace</a>.</p>
43
+ * dashboards and visualizations to analyze your metrics, logs, and traces. You don't have
44
+ * to build, package, or deploy any hardware to run the Grafana server.</p>
45
+ * <p>Don't use <code>CreateWorkspace</code> to modify an existing workspace. Instead, use
46
+ * <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html">UpdateWorkspace</a>.</p>
45
47
  */
46
48
  createWorkspace(args: CreateWorkspaceCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkspaceCommandOutput>;
47
49
  createWorkspace(args: CreateWorkspaceCommandInput, cb: (err: any, data?: CreateWorkspaceCommandOutput) => void): void;
48
50
  createWorkspace(args: CreateWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceCommandOutput) => void): void;
49
51
  /**
50
- * <p>Creates a Grafana API key for the workspace. This key can be used to
51
- * authenticate requests sent to the workspace's HTTP API.
52
- * 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>
52
+ * <p>Creates a Grafana API key for the workspace. This key can be used to authenticate
53
+ * 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>
53
54
  * for available APIs and example requests.</p>
54
55
  */
55
56
  createWorkspaceApiKey(args: CreateWorkspaceApiKeyCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkspaceApiKeyCommandOutput>;
@@ -74,7 +75,8 @@ export declare class Grafana extends GrafanaClient {
74
75
  describeWorkspace(args: DescribeWorkspaceCommandInput, cb: (err: any, data?: DescribeWorkspaceCommandOutput) => void): void;
75
76
  describeWorkspace(args: DescribeWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceCommandOutput) => void): void;
76
77
  /**
77
- * <p>Displays information about the authentication methods used in one Amazon Managed Grafana workspace.</p>
78
+ * <p>Displays information about the authentication methods used in one Amazon Managed Grafana
79
+ * workspace.</p>
78
80
  */
79
81
  describeWorkspaceAuthentication(args: DescribeWorkspaceAuthenticationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspaceAuthenticationCommandOutput>;
80
82
  describeWorkspaceAuthentication(args: DescribeWorkspaceAuthenticationCommandInput, cb: (err: any, data?: DescribeWorkspaceAuthenticationCommandOutput) => void): void;
@@ -93,20 +95,20 @@ export declare class Grafana extends GrafanaClient {
93
95
  disassociateLicense(args: DisassociateLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateLicenseCommandOutput) => void): void;
94
96
  /**
95
97
  * <p>Lists the users and groups who have the Grafana <code>Admin</code> and
96
- * <code>Editor</code> roles in this workspace. If you use this
97
- * operation without specifying <code>userId</code> or <code>groupId</code>, the operation returns
98
- * the roles of all users
99
- * and groups. If you specify a <code>userId</code> or a <code>groupId</code>, only the roles
100
- * for that user or group are returned. If you do this, you can specify only one <code>userId</code> or
101
- * one <code>groupId</code>.</p>
98
+ * <code>Editor</code> roles in this workspace. If you use this operation without
99
+ * specifying <code>userId</code> or <code>groupId</code>, the operation returns the roles
100
+ * of all users and groups. If you specify a <code>userId</code> or a <code>groupId</code>,
101
+ * only the roles for that user or group are returned. If you do this, you can specify only
102
+ * one <code>userId</code> or one <code>groupId</code>.</p>
102
103
  */
103
104
  listPermissions(args: ListPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<ListPermissionsCommandOutput>;
104
105
  listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
105
106
  listPermissions(args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
106
107
  /**
107
- * <p>The <code>ListTagsForResource</code> operation returns the tags that
108
- * are associated with the Amazon Managed Service for Grafana resource specified by the <code>resourceArn</code>.
109
- * Currently, the only resource that can be tagged is a workspace. </p>
108
+ * <p>The <code>ListTagsForResource</code> operation returns the tags that are associated
109
+ * with the Amazon Managed Service for Grafana resource specified by the
110
+ * <code>resourceArn</code>. Currently, the only resource that can be tagged is a
111
+ * workspace. </p>
110
112
  */
111
113
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
112
114
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
@@ -119,35 +121,37 @@ export declare class Grafana extends GrafanaClient {
119
121
  listWorkspaces(args: ListWorkspacesCommandInput, cb: (err: any, data?: ListWorkspacesCommandOutput) => void): void;
120
122
  listWorkspaces(args: ListWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkspacesCommandOutput) => void): void;
121
123
  /**
122
- * <p>The <code>TagResource</code> operation associates tags with an Amazon Managed Grafana resource.
123
- * Currently, the only resource that can be tagged is workspaces. </p>
124
- * <p>If you specify a new tag key for the resource, this tag is appended to the list of tags associated
125
- * with the resource. If you specify a tag key that is already associated with the resource, the new tag
126
- * value that you specify replaces the previous value for that tag.</p>
124
+ * <p>The <code>TagResource</code> operation associates tags with an Amazon Managed Grafana
125
+ * resource. Currently, the only resource that can be tagged is workspaces. </p>
126
+ * <p>If you specify a new tag key for the resource, this tag is appended to the list of
127
+ * tags associated with the resource. If you specify a tag key that is already associated
128
+ * with the resource, the new tag value that you specify replaces the previous value for
129
+ * that tag.</p>
127
130
  */
128
131
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
129
132
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
130
133
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
131
134
  /**
132
- * <p>The <code>UntagResource</code> operation removes the association of the tag with the Amazon Managed Grafana resource.
133
- * </p>
135
+ * <p>The <code>UntagResource</code> operation removes the association of the tag with the
136
+ * Amazon Managed Grafana resource. </p>
134
137
  */
135
138
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
136
139
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
137
140
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
138
141
  /**
139
- * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or <code>Editor</code> roles.</p>
142
+ * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or
143
+ * <code>Editor</code> roles.</p>
140
144
  */
141
145
  updatePermissions(args: UpdatePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePermissionsCommandOutput>;
142
146
  updatePermissions(args: UpdatePermissionsCommandInput, cb: (err: any, data?: UpdatePermissionsCommandOutput) => void): void;
143
147
  updatePermissions(args: UpdatePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePermissionsCommandOutput) => void): void;
144
148
  /**
145
- * <p>Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any
146
- * optional parameters, the existing values of those parameters are not changed.</p>
147
- * <p>To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center,
148
- * use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html">UpdateWorkspaceAuthentication</a>.</p>
149
- * <p>To modify which users in the workspace have the <code>Admin</code> and <code>Editor</code> Grafana roles,
150
- * use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a>.</p>
149
+ * <p>Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit
150
+ * any optional parameters, the existing values of those parameters are not changed.</p>
151
+ * <p>To modify the user authentication methods that the workspace uses, such as SAML or
152
+ * IAM Identity Center, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html">UpdateWorkspaceAuthentication</a>.</p>
153
+ * <p>To modify which users in the workspace have the <code>Admin</code> and
154
+ * <code>Editor</code> Grafana roles, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a>.</p>
151
155
  */
152
156
  updateWorkspace(args: UpdateWorkspaceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWorkspaceCommandOutput>;
153
157
  updateWorkspace(args: UpdateWorkspaceCommandInput, cb: (err: any, data?: UpdateWorkspaceCommandOutput) => void): void;
@@ -155,8 +159,12 @@ export declare class Grafana extends GrafanaClient {
155
159
  /**
156
160
  * <p>Use this operation to define the identity provider (IdP) that this workspace
157
161
  * authenticates users from, using SAML. You can also map SAML assertion attributes to
158
- * workspace user information and define which groups in the assertion attribute are to have
159
- * the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
162
+ * workspace user information and define which groups in the assertion attribute are to
163
+ * have the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
164
+ * <note>
165
+ * <p>Changes to the authentication method for a workspace may take a few minutes to
166
+ * take effect.</p>
167
+ * </note>
160
168
  */
161
169
  updateWorkspaceAuthentication(args: UpdateWorkspaceAuthenticationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWorkspaceAuthenticationCommandOutput>;
162
170
  updateWorkspaceAuthentication(args: UpdateWorkspaceAuthenticationCommandInput, cb: (err: any, data?: UpdateWorkspaceAuthenticationCommandOutput) => void): void;
package/dist-types/GrafanaClient.d.ts CHANGED
@@ -141,13 +141,15 @@ declare type GrafanaClientResolvedConfigType = __SmithyResolvedConfiguration<__H
141
141
  export interface GrafanaClientResolvedConfig extends GrafanaClientResolvedConfigType {
142
142
  }
143
143
  /**
144
- * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to
145
- * instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources.
146
- * Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool
147
- * that is popular for its extensible data support.</p>
148
- * <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called <i>workspaces</i>. In
149
- * a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to
150
- * build, package, or deploy any hardware to run Grafana servers. </p>
144
+ * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that
145
+ * you can use to instantly query, correlate, and visualize operational metrics, logs, and
146
+ * traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and
147
+ * scale Grafana, a widely deployed data visualization tool that is popular for its
148
+ * extensible data support.</p>
149
+ * <p>With Amazon Managed Grafana, you create logically isolated Grafana servers called
150
+ * <i>workspaces</i>. In a workspace, you can create Grafana dashboards
151
+ * and visualizations to analyze your metrics, logs, and traces without having to build,
152
+ * package, or deploy any hardware to run Grafana servers. </p>
151
153
  */
152
154
  export declare class GrafanaClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, GrafanaClientResolvedConfig> {
153
155
  /**
package/dist-types/commands/AssociateLicenseCommand.d.ts CHANGED
@@ -9,8 +9,8 @@ export interface AssociateLicenseCommandOutput extends AssociateLicenseResponse,
9
9
  }
10
10
  /**
11
11
  * <p>Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise
12
- * 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
13
- * Grafana Enterprise</a>.</p>
12
+ * incurs additional fees. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html">Upgrade a
13
+ * workspace to Grafana Enterprise</a>.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
package/dist-types/commands/CreateWorkspaceApiKeyCommand.d.ts CHANGED
@@ -8,9 +8,8 @@ export interface CreateWorkspaceApiKeyCommandInput extends CreateWorkspaceApiKey
8
8
  export interface CreateWorkspaceApiKeyCommandOutput extends CreateWorkspaceApiKeyResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Creates a Grafana API key for the workspace. This key can be used to
12
- * authenticate requests sent to the workspace's HTTP API.
13
- * 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>
11
+ * <p>Creates a Grafana API key for the workspace. This key can be used to authenticate
12
+ * 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>
14
13
  * for available APIs and example requests.</p>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.
package/dist-types/commands/CreateWorkspaceCommand.d.ts CHANGED
@@ -9,10 +9,10 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
9
9
  }
10
10
  /**
11
11
  * <p>Creates a <i>workspace</i>. In a workspace, you can create Grafana
12
- * dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to
13
- * build, package, or deploy any hardware to run the Grafana server.</p>
14
- * <p>Don't use <code>CreateWorkspace</code> to modify an existing workspace. Instead,
15
- * use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html">UpdateWorkspace</a>.</p>
12
+ * dashboards and visualizations to analyze your metrics, logs, and traces. You don't have
13
+ * to build, package, or deploy any hardware to run the Grafana server.</p>
14
+ * <p>Don't use <code>CreateWorkspace</code> to modify an existing workspace. Instead, use
15
+ * <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html">UpdateWorkspace</a>.</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
18
18
  * ```javascript
package/dist-types/commands/DescribeWorkspaceAuthenticationCommand.d.ts CHANGED
@@ -8,7 +8,8 @@ export interface DescribeWorkspaceAuthenticationCommandInput extends DescribeWor
8
8
  export interface DescribeWorkspaceAuthenticationCommandOutput extends DescribeWorkspaceAuthenticationResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Displays information about the authentication methods used in one Amazon Managed Grafana workspace.</p>
11
+ * <p>Displays information about the authentication methods used in one Amazon Managed Grafana
12
+ * workspace.</p>
12
13
  * @example
13
14
  * Use a bare-bones client and the command you need to make an API call.
14
15
  * ```javascript
package/dist-types/commands/ListPermissionsCommand.d.ts CHANGED
@@ -9,12 +9,11 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
9
9
  }
10
10
  /**
11
11
  * <p>Lists the users and groups who have the Grafana <code>Admin</code> and
12
- * <code>Editor</code> roles in this workspace. If you use this
13
- * operation without specifying <code>userId</code> or <code>groupId</code>, the operation returns
14
- * the roles of all users
15
- * and groups. If you specify a <code>userId</code> or a <code>groupId</code>, only the roles
16
- * for that user or group are returned. If you do this, you can specify only one <code>userId</code> or
17
- * one <code>groupId</code>.</p>
12
+ * <code>Editor</code> roles in this workspace. If you use this operation without
13
+ * specifying <code>userId</code> or <code>groupId</code>, the operation returns the roles
14
+ * of all users and groups. If you specify a <code>userId</code> or a <code>groupId</code>,
15
+ * only the roles for that user or group are returned. If you do this, you can specify only
16
+ * one <code>userId</code> or one <code>groupId</code>.</p>
18
17
  * @example
19
18
  * Use a bare-bones client and the command you need to make an API call.
20
19
  * ```javascript
package/dist-types/commands/ListTagsForResourceCommand.d.ts CHANGED
@@ -8,9 +8,10 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
8
8
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>The <code>ListTagsForResource</code> operation returns the tags that
12
- * are associated with the Amazon Managed Service for Grafana resource specified by the <code>resourceArn</code>.
13
- * Currently, the only resource that can be tagged is a workspace. </p>
11
+ * <p>The <code>ListTagsForResource</code> operation returns the tags that are associated
12
+ * with the Amazon Managed Service for Grafana resource specified by the
13
+ * <code>resourceArn</code>. Currently, the only resource that can be tagged is a
14
+ * workspace. </p>
14
15
  * @example
15
16
  * Use a bare-bones client and the command you need to make an API call.
16
17
  * ```javascript
package/dist-types/commands/TagResourceCommand.d.ts CHANGED
@@ -8,11 +8,12 @@ export interface TagResourceCommandInput extends TagResourceRequest {
8
8
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>The <code>TagResource</code> operation associates tags with an Amazon Managed Grafana resource.
12
- * Currently, the only resource that can be tagged is workspaces. </p>
13
- * <p>If you specify a new tag key for the resource, this tag is appended to the list of tags associated
14
- * with the resource. If you specify a tag key that is already associated with the resource, the new tag
15
- * value that you specify replaces the previous value for that tag.</p>
11
+ * <p>The <code>TagResource</code> operation associates tags with an Amazon Managed Grafana
12
+ * resource. Currently, the only resource that can be tagged is workspaces. </p>
13
+ * <p>If you specify a new tag key for the resource, this tag is appended to the list of
14
+ * tags associated with the resource. If you specify a tag key that is already associated
15
+ * with the resource, the new tag value that you specify replaces the previous value for
16
+ * that tag.</p>
16
17
  * @example
17
18
  * Use a bare-bones client and the command you need to make an API call.
18
19
  * ```javascript
package/dist-types/commands/UntagResourceCommand.d.ts CHANGED
@@ -8,8 +8,8 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
8
8
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>The <code>UntagResource</code> operation removes the association of the tag with the Amazon Managed Grafana resource.
12
- * </p>
11
+ * <p>The <code>UntagResource</code> operation removes the association of the tag with the
12
+ * Amazon Managed Grafana resource. </p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
package/dist-types/commands/UpdatePermissionsCommand.d.ts CHANGED
@@ -8,7 +8,8 @@ export interface UpdatePermissionsCommandInput extends UpdatePermissionsRequest
8
8
  export interface UpdatePermissionsCommandOutput extends UpdatePermissionsResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or <code>Editor</code> roles.</p>
11
+ * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or
12
+ * <code>Editor</code> roles.</p>
12
13
  * @example
13
14
  * Use a bare-bones client and the command you need to make an API call.
14
15
  * ```javascript
package/dist-types/commands/UpdateWorkspaceAuthenticationCommand.d.ts CHANGED
@@ -10,8 +10,12 @@ export interface UpdateWorkspaceAuthenticationCommandOutput extends UpdateWorksp
10
10
  /**
11
11
  * <p>Use this operation to define the identity provider (IdP) that this workspace
12
12
  * authenticates users from, using SAML. You can also map SAML assertion attributes to
13
- * workspace user information and define which groups in the assertion attribute are to have
14
- * the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
13
+ * workspace user information and define which groups in the assertion attribute are to
14
+ * have the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
15
+ * <note>
16
+ * <p>Changes to the authentication method for a workspace may take a few minutes to
17
+ * take effect.</p>
18
+ * </note>
15
19
  * @example
16
20
  * Use a bare-bones client and the command you need to make an API call.
17
21
  * ```javascript
package/dist-types/commands/UpdateWorkspaceCommand.d.ts CHANGED
@@ -8,12 +8,12 @@ export interface UpdateWorkspaceCommandInput extends UpdateWorkspaceRequest {
8
8
  export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any
12
- * optional parameters, the existing values of those parameters are not changed.</p>
13
- * <p>To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center,
14
- * use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html">UpdateWorkspaceAuthentication</a>.</p>
15
- * <p>To modify which users in the workspace have the <code>Admin</code> and <code>Editor</code> Grafana roles,
16
- * use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a>.</p>
11
+ * <p>Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit
12
+ * any optional parameters, the existing values of those parameters are not changed.</p>
13
+ * <p>To modify the user authentication methods that the workspace uses, such as SAML or
14
+ * IAM Identity Center, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html">UpdateWorkspaceAuthentication</a>.</p>
15
+ * <p>To modify which users in the workspace have the <code>Admin</code> and
16
+ * <code>Editor</code> Grafana roles, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a>.</p>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
19
19
  * ```javascript