@aws-sdk/client-grafana 3.296.0 → 3.297.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 (26) hide show
  1. package/dist-types/Grafana.d.ts +19 -0
  2. package/dist-types/GrafanaClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateLicenseCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateWorkspaceApiKeyCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateWorkspaceCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteWorkspaceApiKeyCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteWorkspaceCommand.d.ts +16 -0
  8. package/dist-types/commands/DescribeWorkspaceAuthenticationCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeWorkspaceCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeWorkspaceConfigurationCommand.d.ts +16 -0
  11. package/dist-types/commands/DisassociateLicenseCommand.d.ts +16 -0
  12. package/dist-types/commands/ListPermissionsCommand.d.ts +16 -0
  13. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  14. package/dist-types/commands/ListWorkspacesCommand.d.ts +16 -0
  15. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  16. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  17. package/dist-types/commands/UpdatePermissionsCommand.d.ts +16 -0
  18. package/dist-types/commands/UpdateWorkspaceAuthenticationCommand.d.ts +16 -0
  19. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +16 -0
  20. package/dist-types/commands/UpdateWorkspaceConfigurationCommand.d.ts +16 -0
  21. package/dist-types/models/GrafanaServiceException.d.ts +2 -0
  22. package/dist-types/models/models_0.d.ts +173 -2
  23. package/dist-types/pagination/Interfaces.d.ts +3 -0
  24. package/dist-types/pagination/ListPermissionsPaginator.d.ts +3 -0
  25. package/dist-types/pagination/ListWorkspacesPaginator.d.ts +3 -0
  26. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { DisassociateLicenseRequest, DisassociateLicenseResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateLicenseCommand}.
8
10
  */
9
11
  export interface DisassociateLicenseCommandInput extends DisassociateLicenseRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateLicenseCommand}.
13
17
  */
14
18
  export interface DisassociateLicenseCommandOutput extends DisassociateLicenseResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the Grafana Enterprise license from a workspace.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DisassociateLicenseCommandOutput extends DisassociateLicenseRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DisassociateLicenseCommandInput - {@link DisassociateLicenseCommandInput}
34
+ * @returns {@link DisassociateLicenseCommandOutput}
28
35
  * @see {@link DisassociateLicenseCommandInput} for command's `input` shape.
29
36
  * @see {@link DisassociateLicenseCommandOutput} for command's `response` shape.
30
37
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DisassociateLicenseCommandOutput extends DisassociateLicenseRes
49
56
  export declare class DisassociateLicenseCommand extends $Command<DisassociateLicenseCommandInput, DisassociateLicenseCommandOutput, GrafanaClientResolvedConfig> {
50
57
  readonly input: DisassociateLicenseCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DisassociateLicenseCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateLicenseCommandInput, DisassociateLicenseCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { ListPermissionsRequest, ListPermissionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPermissionsCommand}.
8
10
  */
9
11
  export interface ListPermissionsCommandInput extends ListPermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPermissionsCommand}.
13
17
  */
14
18
  export interface ListPermissionsCommandOutput extends ListPermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the users and groups who have the Grafana <code>Admin</code> and
18
23
  * <code>Editor</code> roles in this workspace. If you use this operation without
19
24
  * specifying <code>userId</code> or <code>groupId</code>, the operation returns the roles
@@ -30,6 +35,8 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param ListPermissionsCommandInput - {@link ListPermissionsCommandInput}
39
+ * @returns {@link ListPermissionsCommandOutput}
33
40
  * @see {@link ListPermissionsCommandInput} for command's `input` shape.
34
41
  * @see {@link ListPermissionsCommandOutput} for command's `response` shape.
35
42
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -54,11 +61,20 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
54
61
  export declare class ListPermissionsCommand extends $Command<ListPermissionsCommandInput, ListPermissionsCommandOutput, GrafanaClientResolvedConfig> {
55
62
  readonly input: ListPermissionsCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: ListPermissionsCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPermissionsCommandInput, ListPermissionsCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>The <code>ListTagsForResource</code> operation returns the tags that are associated
18
23
  * with the Amazon Managed Service for Grafana resource specified by the
19
24
  * <code>resourceArn</code>. Currently, the only resource that can be tagged is a
@@ -28,6 +33,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
37
+ * @returns {@link ListTagsForResourceCommandOutput}
31
38
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
32
39
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
33
40
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
52
59
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, GrafanaClientResolvedConfig> {
53
60
  readonly input: ListTagsForResourceCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListTagsForResourceCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { ListWorkspacesRequest, ListWorkspacesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListWorkspacesCommand}.
8
10
  */
9
11
  export interface ListWorkspacesCommandInput extends ListWorkspacesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListWorkspacesCommand}.
13
17
  */
14
18
  export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of Amazon Managed Grafana workspaces in the account, with some information
18
23
  * 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>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListWorkspacesCommandInput - {@link ListWorkspacesCommandInput}
35
+ * @returns {@link ListWorkspacesCommandOutput}
29
36
  * @see {@link ListWorkspacesCommandInput} for command's `input` shape.
30
37
  * @see {@link ListWorkspacesCommandOutput} for command's `response` shape.
31
38
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M
44
51
  export declare class ListWorkspacesCommand extends $Command<ListWorkspacesCommandInput, ListWorkspacesCommandOutput, GrafanaClientResolvedConfig> {
45
52
  readonly input: ListWorkspacesCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListWorkspacesCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWorkspacesCommandInput, ListWorkspacesCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>The <code>TagResource</code> operation associates tags with an Amazon Managed Grafana
18
23
  * resource. Currently, the only resource that can be tagged is workspaces. </p>
19
24
  * <p>If you specify a new tag key for the resource, this tag is appended to the list of
@@ -30,6 +35,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
39
+ * @returns {@link TagResourceCommandOutput}
33
40
  * @see {@link TagResourceCommandInput} for command's `input` shape.
34
41
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
35
42
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -54,11 +61,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
54
61
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, GrafanaClientResolvedConfig> {
55
62
  readonly input: TagResourceCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: TagResourceCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>The <code>UntagResource</code> operation removes the association of the tag with the
18
23
  * Amazon Managed Grafana resource. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
35
+ * @returns {@link UntagResourceCommandOutput}
29
36
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -50,11 +57,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
50
57
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, GrafanaClientResolvedConfig> {
51
58
  readonly input: UntagResourceCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: UntagResourceCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { UpdatePermissionsRequest, UpdatePermissionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdatePermissionsCommand}.
8
10
  */
9
11
  export interface UpdatePermissionsCommandInput extends UpdatePermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdatePermissionsCommand}.
13
17
  */
14
18
  export interface UpdatePermissionsCommandOutput extends UpdatePermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or
18
23
  * <code>Editor</code> roles.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdatePermissionsCommandOutput extends UpdatePermissionsRespons
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdatePermissionsCommandInput - {@link UpdatePermissionsCommandInput}
35
+ * @returns {@link UpdatePermissionsCommandOutput}
29
36
  * @see {@link UpdatePermissionsCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdatePermissionsCommandOutput} for command's `response` shape.
31
38
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -50,11 +57,20 @@ export interface UpdatePermissionsCommandOutput extends UpdatePermissionsRespons
50
57
  export declare class UpdatePermissionsCommand extends $Command<UpdatePermissionsCommandInput, UpdatePermissionsCommandOutput, GrafanaClientResolvedConfig> {
51
58
  readonly input: UpdatePermissionsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: UpdatePermissionsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePermissionsCommandInput, UpdatePermissionsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { UpdateWorkspaceAuthenticationRequest, UpdateWorkspaceAuthenticationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateWorkspaceAuthenticationCommand}.
8
10
  */
9
11
  export interface UpdateWorkspaceAuthenticationCommandInput extends UpdateWorkspaceAuthenticationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateWorkspaceAuthenticationCommand}.
13
17
  */
14
18
  export interface UpdateWorkspaceAuthenticationCommandOutput extends UpdateWorkspaceAuthenticationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Use this operation to define the identity provider (IdP) that this workspace
18
23
  * authenticates users from, using SAML. You can also map SAML assertion attributes to
19
24
  * workspace user information and define which groups in the assertion attribute are to
@@ -32,6 +37,8 @@ export interface UpdateWorkspaceAuthenticationCommandOutput extends UpdateWorksp
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param UpdateWorkspaceAuthenticationCommandInput - {@link UpdateWorkspaceAuthenticationCommandInput}
41
+ * @returns {@link UpdateWorkspaceAuthenticationCommandOutput}
35
42
  * @see {@link UpdateWorkspaceAuthenticationCommandInput} for command's `input` shape.
36
43
  * @see {@link UpdateWorkspaceAuthenticationCommandOutput} for command's `response` shape.
37
44
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -59,11 +66,20 @@ export interface UpdateWorkspaceAuthenticationCommandOutput extends UpdateWorksp
59
66
  export declare class UpdateWorkspaceAuthenticationCommand extends $Command<UpdateWorkspaceAuthenticationCommandInput, UpdateWorkspaceAuthenticationCommandOutput, GrafanaClientResolvedConfig> {
60
67
  readonly input: UpdateWorkspaceAuthenticationCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: UpdateWorkspaceAuthenticationCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWorkspaceAuthenticationCommandInput, UpdateWorkspaceAuthenticationCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { UpdateWorkspaceRequest, UpdateWorkspaceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateWorkspaceCommand}.
8
10
  */
9
11
  export interface UpdateWorkspaceCommandInput extends UpdateWorkspaceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateWorkspaceCommand}.
13
17
  */
14
18
  export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit
18
23
  * any optional parameters, the existing values of those parameters are not changed.</p>
19
24
  * <p>To modify the user authentication methods that the workspace uses, such as SAML or
@@ -30,6 +35,8 @@ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, _
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param UpdateWorkspaceCommandInput - {@link UpdateWorkspaceCommandInput}
39
+ * @returns {@link UpdateWorkspaceCommandOutput}
33
40
  * @see {@link UpdateWorkspaceCommandInput} for command's `input` shape.
34
41
  * @see {@link UpdateWorkspaceCommandOutput} for command's `response` shape.
35
42
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -57,11 +64,20 @@ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, _
57
64
  export declare class UpdateWorkspaceCommand extends $Command<UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput, GrafanaClientResolvedConfig> {
58
65
  readonly input: UpdateWorkspaceCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: UpdateWorkspaceCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { UpdateWorkspaceConfigurationRequest, UpdateWorkspaceConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateWorkspaceConfigurationCommand}.
8
10
  */
9
11
  export interface UpdateWorkspaceConfigurationCommandInput extends UpdateWorkspaceConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateWorkspaceConfigurationCommand}.
13
17
  */
14
18
  export interface UpdateWorkspaceConfigurationCommandOutput extends UpdateWorkspaceConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the configuration string for the given workspace</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateWorkspaceConfigurationCommandOutput extends UpdateWorkspa
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateWorkspaceConfigurationCommandInput - {@link UpdateWorkspaceConfigurationCommandInput}
34
+ * @returns {@link UpdateWorkspaceConfigurationCommandOutput}
28
35
  * @see {@link UpdateWorkspaceConfigurationCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateWorkspaceConfigurationCommandOutput} for command's `response` shape.
30
37
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateWorkspaceConfigurationCommandOutput extends UpdateWorkspa
52
59
  export declare class UpdateWorkspaceConfigurationCommand extends $Command<UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput, GrafanaClientResolvedConfig> {
53
60
  readonly input: UpdateWorkspaceConfigurationCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: UpdateWorkspaceConfigurationCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from Grafana service.
4
6
  */
5
7
  export declare class GrafanaServiceException extends __ServiceException {