docs(client-grafana): Doc-only update. Updated information on attache…

…d role policies for customer provided roles
aws · Feb 23, 2023 · 61554a4 · 61554a4
1 parent 594acf0
commit 61554a4
Show file tree

Hide file tree

Showing 16 changed files with 503 additions and 451 deletions.
diff --git a/clients/client-grafana/README.md b/clients/client-grafana/README.md
@@ -9,13 +9,15 @@
 
 AWS SDK for JavaScript Grafana Client for Node.js, Browser and React Native.
 
-<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>
+<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>
 
 ## Installing
 

diff --git a/clients/client-grafana/src/Grafana.ts b/clients/client-grafana/src/Grafana.ts
@@ -90,19 +90,21 @@ import {
 import { GrafanaClient } from "./GrafanaClient";
 
 /**
- * <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>
+ * <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>
  */
 export class Grafana extends GrafanaClient {
   /**
    * <p>Assigns a Grafana Enterprise license to a workspace. 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>
+   *             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>
    */
   public associateLicense(
     args: AssociateLicenseCommandInput,
@@ -135,10 +137,10 @@ export class Grafana extends GrafanaClient {
 
   /**
    * <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>
+   *             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>
    */
   public createWorkspace(
     args: CreateWorkspaceCommandInput,
@@ -170,9 +172,8 @@ export class Grafana extends GrafanaClient {
   }
 
   /**
-   * <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>
+   * <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>
    */
   public createWorkspaceApiKey(
@@ -301,7 +302,8 @@ export class Grafana extends GrafanaClient {
   }
 
   /**
-   * <p>Displays information about the authentication methods used in one Amazon Managed Grafana workspace.</p>
+   * <p>Displays information about the authentication methods used in one Amazon Managed Grafana
+   *             workspace.</p>
    */
   public describeWorkspaceAuthentication(
     args: DescribeWorkspaceAuthenticationCommandInput,
@@ -398,12 +400,11 @@ export class Grafana extends GrafanaClient {
 
   /**
    * <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>
+   *                 <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>
    */
   public listPermissions(
     args: ListPermissionsCommandInput,
@@ -435,9 +436,10 @@ export class Grafana extends GrafanaClient {
   }
 
   /**
-   * <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>
+   * <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>
    */
   public listTagsForResource(
     args: ListTagsForResourceCommandInput,
@@ -502,11 +504,12 @@ export class Grafana extends GrafanaClient {
   }
 
   /**
-   * <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>
+   * <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>
    */
   public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
   public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
@@ -532,8 +535,8 @@ export class Grafana extends GrafanaClient {
   }
 
   /**
-   * <p>The <code>UntagResource</code> operation removes the association of the tag with the Amazon Managed Grafana resource.
-   *         </p>
+   * <p>The <code>UntagResource</code> operation removes the association of the tag with the
+   *             Amazon Managed Grafana resource. </p>
    */
   public untagResource(
     args: UntagResourceCommandInput,
@@ -565,7 +568,8 @@ export class Grafana extends GrafanaClient {
   }
 
   /**
-   * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or <code>Editor</code> roles.</p>
+   * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or
+   *                 <code>Editor</code> roles.</p>
    */
   public updatePermissions(
     args: UpdatePermissionsCommandInput,
@@ -597,12 +601,12 @@ export class Grafana extends GrafanaClient {
   }
 
   /**
-   * <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>
+   * <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>
    */
   public updateWorkspace(
     args: UpdateWorkspaceCommandInput,
@@ -636,8 +640,12 @@ export class Grafana extends GrafanaClient {
   /**
    * <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>
+   *             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>
    */
   public updateWorkspaceAuthentication(
     args: UpdateWorkspaceAuthenticationCommandInput,

diff --git a/clients/client-grafana/src/GrafanaClient.ts b/clients/client-grafana/src/GrafanaClient.ts
@@ -289,13 +289,15 @@ type GrafanaClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandl
 export interface GrafanaClientResolvedConfig extends GrafanaClientResolvedConfigType {}
 
 /**
- * <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>
+ * <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>
  */
 export class GrafanaClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-grafana/src/commands/AssociateLicenseCommand.ts b/clients/client-grafana/src/commands/AssociateLicenseCommand.ts
@@ -30,8 +30,8 @@ export interface AssociateLicenseCommandOutput extends AssociateLicenseResponse,
 
 /**
  * <p>Assigns a Grafana Enterprise license to a workspace. 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>
+ *             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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-grafana/src/commands/CreateWorkspaceApiKeyCommand.ts b/clients/client-grafana/src/commands/CreateWorkspaceApiKeyCommand.ts
@@ -29,9 +29,8 @@ export interface CreateWorkspaceApiKeyCommandInput extends CreateWorkspaceApiKey
 export interface CreateWorkspaceApiKeyCommandOutput extends CreateWorkspaceApiKeyResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-grafana/src/commands/CreateWorkspaceCommand.ts b/clients/client-grafana/src/commands/CreateWorkspaceCommand.ts
@@ -30,10 +30,10 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
 
 /**
  * <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>
+ *             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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-grafana/src/commands/DescribeWorkspaceAuthenticationCommand.ts b/clients/client-grafana/src/commands/DescribeWorkspaceAuthenticationCommand.ts
@@ -31,7 +31,8 @@ export interface DescribeWorkspaceAuthenticationCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Displays information about the authentication methods used in one Amazon Managed Grafana workspace.</p>
+ * <p>Displays information about the authentication methods used in one Amazon Managed Grafana
+ *             workspace.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-grafana/src/commands/ListPermissionsCommand.ts b/clients/client-grafana/src/commands/ListPermissionsCommand.ts
@@ -30,12 +30,11 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
 
 /**
  * <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>
+ *                 <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript