@aws-sdk/client-grafana 3.296.0 → 3.298.0

package/dist-types/commands/UpdatePermissionsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
 import { UpdatePermissionsRequest, UpdatePermissionsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdatePermissionsCommand}.
  */
 export interface UpdatePermissionsCommandInput extends UpdatePermissionsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdatePermissionsCommand}.
  */
 export interface UpdatePermissionsCommandOutput extends UpdatePermissionsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or
  *                 <code>Editor</code> roles.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdatePermissionsCommandOutput extends UpdatePermissionsRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdatePermissionsCommandInput - {@link UpdatePermissionsCommandInput}
+ * @returns {@link UpdatePermissionsCommandOutput}
  * @see {@link UpdatePermissionsCommandInput} for command's `input` shape.
  * @see {@link UpdatePermissionsCommandOutput} for command's `response` shape.
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -50,11 +57,20 @@ export interface UpdatePermissionsCommandOutput extends UpdatePermissionsRespons
 export declare class UpdatePermissionsCommand extends $Command<UpdatePermissionsCommandInput, UpdatePermissionsCommandOutput, GrafanaClientResolvedConfig> {
     readonly input: UpdatePermissionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdatePermissionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePermissionsCommandInput, UpdatePermissionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateWorkspaceAuthenticationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
 import { UpdateWorkspaceAuthenticationRequest, UpdateWorkspaceAuthenticationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateWorkspaceAuthenticationCommand}.
  */
 export interface UpdateWorkspaceAuthenticationCommandInput extends UpdateWorkspaceAuthenticationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateWorkspaceAuthenticationCommand}.
  */
 export interface UpdateWorkspaceAuthenticationCommandOutput extends UpdateWorkspaceAuthenticationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
@@ -32,6 +37,8 @@ export interface UpdateWorkspaceAuthenticationCommandOutput extends UpdateWorksp
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateWorkspaceAuthenticationCommandInput - {@link UpdateWorkspaceAuthenticationCommandInput}
+ * @returns {@link UpdateWorkspaceAuthenticationCommandOutput}
  * @see {@link UpdateWorkspaceAuthenticationCommandInput} for command's `input` shape.
  * @see {@link UpdateWorkspaceAuthenticationCommandOutput} for command's `response` shape.
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -59,11 +66,20 @@ export interface UpdateWorkspaceAuthenticationCommandOutput extends UpdateWorksp
 export declare class UpdateWorkspaceAuthenticationCommand extends $Command<UpdateWorkspaceAuthenticationCommandInput, UpdateWorkspaceAuthenticationCommandOutput, GrafanaClientResolvedConfig> {
     readonly input: UpdateWorkspaceAuthenticationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateWorkspaceAuthenticationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWorkspaceAuthenticationCommandInput, UpdateWorkspaceAuthenticationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateWorkspaceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
 import { UpdateWorkspaceRequest, UpdateWorkspaceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateWorkspaceCommand}.
  */
 export interface UpdateWorkspaceCommandInput extends UpdateWorkspaceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateWorkspaceCommand}.
  */
 export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
@@ -30,6 +35,8 @@ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateWorkspaceCommandInput - {@link UpdateWorkspaceCommandInput}
+ * @returns {@link UpdateWorkspaceCommandOutput}
  * @see {@link UpdateWorkspaceCommandInput} for command's `input` shape.
  * @see {@link UpdateWorkspaceCommandOutput} for command's `response` shape.
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -57,11 +64,20 @@ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, _
 export declare class UpdateWorkspaceCommand extends $Command<UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput, GrafanaClientResolvedConfig> {
     readonly input: UpdateWorkspaceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateWorkspaceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateWorkspaceConfigurationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
 import { UpdateWorkspaceConfigurationRequest, UpdateWorkspaceConfigurationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateWorkspaceConfigurationCommand}.
  */
 export interface UpdateWorkspaceConfigurationCommandInput extends UpdateWorkspaceConfigurationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateWorkspaceConfigurationCommand}.
  */
 export interface UpdateWorkspaceConfigurationCommandOutput extends UpdateWorkspaceConfigurationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the configuration string for the given workspace</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateWorkspaceConfigurationCommandOutput extends UpdateWorkspa
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateWorkspaceConfigurationCommandInput - {@link UpdateWorkspaceConfigurationCommandInput}
+ * @returns {@link UpdateWorkspaceConfigurationCommandOutput}
  * @see {@link UpdateWorkspaceConfigurationCommandInput} for command's `input` shape.
  * @see {@link UpdateWorkspaceConfigurationCommandOutput} for command's `response` shape.
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateWorkspaceConfigurationCommandOutput extends UpdateWorkspa
 export declare class UpdateWorkspaceConfigurationCommand extends $Command<UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput, GrafanaClientResolvedConfig> {
     readonly input: UpdateWorkspaceConfigurationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateWorkspaceConfigurationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/GrafanaServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from Grafana service.
  */
 export declare class GrafanaServiceException extends __ServiceException {