@aws-sdk/client-grafana 3.295.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 +29 -29
@@ -19,6 +19,7 @@ import { UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput } from "./com
19
19
  import { UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput } from "./commands/UpdateWorkspaceConfigurationCommand";
20
20
  import { GrafanaClient } from "./GrafanaClient";
21
21
  /**
22
+ * @public
22
23
  * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that
23
24
  * you can use to instantly query, correlate, and visualize operational metrics, logs, and
24
25
  * traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and
@@ -31,6 +32,7 @@ import { GrafanaClient } from "./GrafanaClient";
31
32
  */
32
33
  export declare class Grafana extends GrafanaClient {
33
34
  /**
35
+ * @public
34
36
  * <p>Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise
35
37
  * 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
38
  * workspace to Grafana Enterprise</a>.</p>
@@ -39,6 +41,7 @@ export declare class Grafana extends GrafanaClient {
39
41
  associateLicense(args: AssociateLicenseCommandInput, cb: (err: any, data?: AssociateLicenseCommandOutput) => void): void;
40
42
  associateLicense(args: AssociateLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateLicenseCommandOutput) => void): void;
41
43
  /**
44
+ * @public
42
45
  * <p>Creates a <i>workspace</i>. In a workspace, you can create Grafana
43
46
  * dashboards and visualizations to analyze your metrics, logs, and traces. You don't have
44
47
  * to build, package, or deploy any hardware to run the Grafana server.</p>
@@ -49,6 +52,7 @@ export declare class Grafana extends GrafanaClient {
49
52
  createWorkspace(args: CreateWorkspaceCommandInput, cb: (err: any, data?: CreateWorkspaceCommandOutput) => void): void;
50
53
  createWorkspace(args: CreateWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceCommandOutput) => void): void;
51
54
  /**
55
+ * @public
52
56
  * <p>Creates a Grafana API key for the workspace. This key can be used to authenticate
53
57
  * 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>
54
58
  * for available APIs and example requests.</p>
@@ -57,24 +61,28 @@ export declare class Grafana extends GrafanaClient {
57
61
  createWorkspaceApiKey(args: CreateWorkspaceApiKeyCommandInput, cb: (err: any, data?: CreateWorkspaceApiKeyCommandOutput) => void): void;
58
62
  createWorkspaceApiKey(args: CreateWorkspaceApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceApiKeyCommandOutput) => void): void;
59
63
  /**
64
+ * @public
60
65
  * <p>Deletes an Amazon Managed Grafana workspace.</p>
61
66
  */
62
67
  deleteWorkspace(args: DeleteWorkspaceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWorkspaceCommandOutput>;
63
68
  deleteWorkspace(args: DeleteWorkspaceCommandInput, cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void): void;
64
69
  deleteWorkspace(args: DeleteWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void): void;
65
70
  /**
71
+ * @public
66
72
  * <p>Deletes a Grafana API key for the workspace.</p>
67
73
  */
68
74
  deleteWorkspaceApiKey(args: DeleteWorkspaceApiKeyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWorkspaceApiKeyCommandOutput>;
69
75
  deleteWorkspaceApiKey(args: DeleteWorkspaceApiKeyCommandInput, cb: (err: any, data?: DeleteWorkspaceApiKeyCommandOutput) => void): void;
70
76
  deleteWorkspaceApiKey(args: DeleteWorkspaceApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceApiKeyCommandOutput) => void): void;
71
77
  /**
78
+ * @public
72
79
  * <p>Displays information about one Amazon Managed Grafana workspace.</p>
73
80
  */
74
81
  describeWorkspace(args: DescribeWorkspaceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspaceCommandOutput>;
75
82
  describeWorkspace(args: DescribeWorkspaceCommandInput, cb: (err: any, data?: DescribeWorkspaceCommandOutput) => void): void;
76
83
  describeWorkspace(args: DescribeWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceCommandOutput) => void): void;
77
84
  /**
85
+ * @public
78
86
  * <p>Displays information about the authentication methods used in one Amazon Managed Grafana
79
87
  * workspace.</p>
80
88
  */
@@ -82,18 +90,21 @@ export declare class Grafana extends GrafanaClient {
82
90
  describeWorkspaceAuthentication(args: DescribeWorkspaceAuthenticationCommandInput, cb: (err: any, data?: DescribeWorkspaceAuthenticationCommandOutput) => void): void;
83
91
  describeWorkspaceAuthentication(args: DescribeWorkspaceAuthenticationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceAuthenticationCommandOutput) => void): void;
84
92
  /**
93
+ * @public
85
94
  * <p>Gets the current configuration string for the given workspace.</p>
86
95
  */
87
96
  describeWorkspaceConfiguration(args: DescribeWorkspaceConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspaceConfigurationCommandOutput>;
88
97
  describeWorkspaceConfiguration(args: DescribeWorkspaceConfigurationCommandInput, cb: (err: any, data?: DescribeWorkspaceConfigurationCommandOutput) => void): void;
89
98
  describeWorkspaceConfiguration(args: DescribeWorkspaceConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceConfigurationCommandOutput) => void): void;
90
99
  /**
100
+ * @public
91
101
  * <p>Removes the Grafana Enterprise license from a workspace.</p>
92
102
  */
93
103
  disassociateLicense(args: DisassociateLicenseCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateLicenseCommandOutput>;
94
104
  disassociateLicense(args: DisassociateLicenseCommandInput, cb: (err: any, data?: DisassociateLicenseCommandOutput) => void): void;
95
105
  disassociateLicense(args: DisassociateLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateLicenseCommandOutput) => void): void;
96
106
  /**
107
+ * @public
97
108
  * <p>Lists the users and groups who have the Grafana <code>Admin</code> and
98
109
  * <code>Editor</code> roles in this workspace. If you use this operation without
99
110
  * specifying <code>userId</code> or <code>groupId</code>, the operation returns the roles
@@ -105,6 +116,7 @@ export declare class Grafana extends GrafanaClient {
105
116
  listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
106
117
  listPermissions(args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
107
118
  /**
119
+ * @public
108
120
  * <p>The <code>ListTagsForResource</code> operation returns the tags that are associated
109
121
  * with the Amazon Managed Service for Grafana resource specified by the
110
122
  * <code>resourceArn</code>. Currently, the only resource that can be tagged is a
@@ -114,6 +126,7 @@ export declare class Grafana extends GrafanaClient {
114
126
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
115
127
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
116
128
  /**
129
+ * @public
117
130
  * <p>Returns a list of Amazon Managed Grafana workspaces in the account, with some information
118
131
  * 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>
119
132
  */
@@ -121,6 +134,7 @@ export declare class Grafana extends GrafanaClient {
121
134
  listWorkspaces(args: ListWorkspacesCommandInput, cb: (err: any, data?: ListWorkspacesCommandOutput) => void): void;
122
135
  listWorkspaces(args: ListWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkspacesCommandOutput) => void): void;
123
136
  /**
137
+ * @public
124
138
  * <p>The <code>TagResource</code> operation associates tags with an Amazon Managed Grafana
125
139
  * resource. Currently, the only resource that can be tagged is workspaces. </p>
126
140
  * <p>If you specify a new tag key for the resource, this tag is appended to the list of
@@ -132,6 +146,7 @@ export declare class Grafana extends GrafanaClient {
132
146
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
133
147
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
134
148
  /**
149
+ * @public
135
150
  * <p>The <code>UntagResource</code> operation removes the association of the tag with the
136
151
  * Amazon Managed Grafana resource. </p>
137
152
  */
@@ -139,6 +154,7 @@ export declare class Grafana extends GrafanaClient {
139
154
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
140
155
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
141
156
  /**
157
+ * @public
142
158
  * <p>Updates which users in a workspace have the Grafana <code>Admin</code> or
143
159
  * <code>Editor</code> roles.</p>
144
160
  */
@@ -146,6 +162,7 @@ export declare class Grafana extends GrafanaClient {
146
162
  updatePermissions(args: UpdatePermissionsCommandInput, cb: (err: any, data?: UpdatePermissionsCommandOutput) => void): void;
147
163
  updatePermissions(args: UpdatePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePermissionsCommandOutput) => void): void;
148
164
  /**
165
+ * @public
149
166
  * <p>Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit
150
167
  * any optional parameters, the existing values of those parameters are not changed.</p>
151
168
  * <p>To modify the user authentication methods that the workspace uses, such as SAML or
@@ -157,6 +174,7 @@ export declare class Grafana extends GrafanaClient {
157
174
  updateWorkspace(args: UpdateWorkspaceCommandInput, cb: (err: any, data?: UpdateWorkspaceCommandOutput) => void): void;
158
175
  updateWorkspace(args: UpdateWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceCommandOutput) => void): void;
159
176
  /**
177
+ * @public
160
178
  * <p>Use this operation to define the identity provider (IdP) that this workspace
161
179
  * authenticates users from, using SAML. You can also map SAML assertion attributes to
162
180
  * workspace user information and define which groups in the assertion attribute are to
@@ -170,6 +188,7 @@ export declare class Grafana extends GrafanaClient {
170
188
  updateWorkspaceAuthentication(args: UpdateWorkspaceAuthenticationCommandInput, cb: (err: any, data?: UpdateWorkspaceAuthenticationCommandOutput) => void): void;
171
189
  updateWorkspaceAuthentication(args: UpdateWorkspaceAuthenticationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceAuthenticationCommandOutput) => void): void;
172
190
  /**
191
+ * @public
173
192
  * <p>Updates the configuration string for the given workspace</p>
174
193
  */
175
194
  updateWorkspaceConfiguration(args: UpdateWorkspaceConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWorkspaceConfigurationCommandOutput>;
@@ -26,15 +26,24 @@ import { UpdateWorkspaceAuthenticationCommandInput, UpdateWorkspaceAuthenticatio
26
26
  import { UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput } from "./commands/UpdateWorkspaceCommand";
27
27
  import { UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput } from "./commands/UpdateWorkspaceConfigurationCommand";
28
28
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
29
+ /**
30
+ * @public
31
+ */
29
32
  export type ServiceInputTypes = AssociateLicenseCommandInput | CreateWorkspaceApiKeyCommandInput | CreateWorkspaceCommandInput | DeleteWorkspaceApiKeyCommandInput | DeleteWorkspaceCommandInput | DescribeWorkspaceAuthenticationCommandInput | DescribeWorkspaceCommandInput | DescribeWorkspaceConfigurationCommandInput | DisassociateLicenseCommandInput | ListPermissionsCommandInput | ListTagsForResourceCommandInput | ListWorkspacesCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdatePermissionsCommandInput | UpdateWorkspaceAuthenticationCommandInput | UpdateWorkspaceCommandInput | UpdateWorkspaceConfigurationCommandInput;
33
+ /**
34
+ * @public
35
+ */
30
36
  export type ServiceOutputTypes = AssociateLicenseCommandOutput | CreateWorkspaceApiKeyCommandOutput | CreateWorkspaceCommandOutput | DeleteWorkspaceApiKeyCommandOutput | DeleteWorkspaceCommandOutput | DescribeWorkspaceAuthenticationCommandOutput | DescribeWorkspaceCommandOutput | DescribeWorkspaceConfigurationCommandOutput | DisassociateLicenseCommandOutput | ListPermissionsCommandOutput | ListTagsForResourceCommandOutput | ListWorkspacesCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdatePermissionsCommandOutput | UpdateWorkspaceAuthenticationCommandOutput | UpdateWorkspaceCommandOutput | UpdateWorkspaceConfigurationCommandOutput;
37
+ /**
38
+ * @public
39
+ */
31
40
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
32
41
  /**
33
42
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
34
43
  */
35
44
  requestHandler?: __HttpHandler;
36
45
  /**
37
- * A constructor for a class implementing the {@link __Checksum} interface
46
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
38
47
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
39
48
  * @internal
40
49
  */
@@ -124,23 +133,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
124
133
  */
125
134
  logger?: __Logger;
126
135
  /**
127
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
136
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
128
137
  */
129
138
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
130
139
  }
140
+ /**
141
+ * @public
142
+ */
131
143
  type GrafanaClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
132
144
  /**
133
- * The configuration interface of GrafanaClient class constructor that set the region, credentials and other options.
145
+ * @public
146
+ *
147
+ * The configuration interface of GrafanaClient class constructor that set the region, credentials and other options.
134
148
  */
135
149
  export interface GrafanaClientConfig extends GrafanaClientConfigType {
136
150
  }
151
+ /**
152
+ * @public
153
+ */
137
154
  type GrafanaClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
138
155
  /**
139
- * The resolved configuration interface of GrafanaClient class. This is resolved and normalized from the {@link GrafanaClientConfig | constructor configuration interface}.
156
+ * @public
157
+ *
158
+ * The resolved configuration interface of GrafanaClient class. This is resolved and normalized from the {@link GrafanaClientConfig | constructor configuration interface}.
140
159
  */
141
160
  export interface GrafanaClientResolvedConfig extends GrafanaClientResolvedConfigType {
142
161
  }
143
162
  /**
163
+ * @public
144
164
  * <p>Amazon Managed Grafana is a fully managed and secure data visualization service that
145
165
  * you can use to instantly query, correlate, and visualize operational metrics, logs, and
146
166
  * traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { AssociateLicenseRequest, AssociateLicenseResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateLicenseCommand}.
8
10
  */
9
11
  export interface AssociateLicenseCommandInput extends AssociateLicenseRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateLicenseCommand}.
13
17
  */
14
18
  export interface AssociateLicenseCommandOutput extends AssociateLicenseResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise
18
23
  * incurs additional fees. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html">Upgrade a
19
24
  * workspace to Grafana Enterprise</a>.</p>
@@ -27,6 +32,8 @@ export interface AssociateLicenseCommandOutput extends AssociateLicenseResponse,
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param AssociateLicenseCommandInput - {@link AssociateLicenseCommandInput}
36
+ * @returns {@link AssociateLicenseCommandOutput}
30
37
  * @see {@link AssociateLicenseCommandInput} for command's `input` shape.
31
38
  * @see {@link AssociateLicenseCommandOutput} for command's `response` shape.
32
39
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -51,11 +58,20 @@ export interface AssociateLicenseCommandOutput extends AssociateLicenseResponse,
51
58
  export declare class AssociateLicenseCommand extends $Command<AssociateLicenseCommandInput, AssociateLicenseCommandOutput, GrafanaClientResolvedConfig> {
52
59
  readonly input: AssociateLicenseCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: AssociateLicenseCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateLicenseCommandInput, AssociateLicenseCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { CreateWorkspaceApiKeyRequest, CreateWorkspaceApiKeyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateWorkspaceApiKeyCommand}.
8
10
  */
9
11
  export interface CreateWorkspaceApiKeyCommandInput extends CreateWorkspaceApiKeyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateWorkspaceApiKeyCommand}.
13
17
  */
14
18
  export interface CreateWorkspaceApiKeyCommandOutput extends CreateWorkspaceApiKeyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a Grafana API key for the workspace. This key can be used to authenticate
18
23
  * 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>
19
24
  * for available APIs and example requests.</p>
@@ -27,6 +32,8 @@ export interface CreateWorkspaceApiKeyCommandOutput extends CreateWorkspaceApiKe
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateWorkspaceApiKeyCommandInput - {@link CreateWorkspaceApiKeyCommandInput}
36
+ * @returns {@link CreateWorkspaceApiKeyCommandOutput}
30
37
  * @see {@link CreateWorkspaceApiKeyCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateWorkspaceApiKeyCommandOutput} for command's `response` shape.
32
39
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CreateWorkspaceApiKeyCommandOutput extends CreateWorkspaceApiKe
57
64
  export declare class CreateWorkspaceApiKeyCommand extends $Command<CreateWorkspaceApiKeyCommandInput, CreateWorkspaceApiKeyCommandOutput, GrafanaClientResolvedConfig> {
58
65
  readonly input: CreateWorkspaceApiKeyCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CreateWorkspaceApiKeyCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateWorkspaceApiKeyCommandInput, CreateWorkspaceApiKeyCommandOutput>;
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 { CreateWorkspaceRequest, CreateWorkspaceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateWorkspaceCommand}.
8
10
  */
9
11
  export interface CreateWorkspaceCommandInput extends CreateWorkspaceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateWorkspaceCommand}.
13
17
  */
14
18
  export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a <i>workspace</i>. In a workspace, you can create Grafana
18
23
  * dashboards and visualizations to analyze your metrics, logs, and traces. You don't have
19
24
  * to build, package, or deploy any hardware to run the Grafana server.</p>
@@ -29,6 +34,8 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateWorkspaceCommandInput - {@link CreateWorkspaceCommandInput}
38
+ * @returns {@link CreateWorkspaceCommandOutput}
32
39
  * @see {@link CreateWorkspaceCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateWorkspaceCommandOutput} for command's `response` shape.
34
41
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
56
63
  export declare class CreateWorkspaceCommand extends $Command<CreateWorkspaceCommandInput, CreateWorkspaceCommandOutput, GrafanaClientResolvedConfig> {
57
64
  readonly input: CreateWorkspaceCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CreateWorkspaceCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateWorkspaceCommandInput, CreateWorkspaceCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
5
5
  import { DeleteWorkspaceApiKeyRequest, DeleteWorkspaceApiKeyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteWorkspaceApiKeyCommand}.
8
10
  */
9
11
  export interface DeleteWorkspaceApiKeyCommandInput extends DeleteWorkspaceApiKeyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteWorkspaceApiKeyCommand}.
13
17
  */
14
18
  export interface DeleteWorkspaceApiKeyCommandOutput extends DeleteWorkspaceApiKeyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a Grafana API key for the 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 DeleteWorkspaceApiKeyCommandOutput extends DeleteWorkspaceApiKe
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteWorkspaceApiKeyCommandInput - {@link DeleteWorkspaceApiKeyCommandInput}
34
+ * @returns {@link DeleteWorkspaceApiKeyCommandOutput}
28
35
  * @see {@link DeleteWorkspaceApiKeyCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteWorkspaceApiKeyCommandOutput} for command's `response` shape.
30
37
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteWorkspaceApiKeyCommandOutput extends DeleteWorkspaceApiKe
52
59
  export declare class DeleteWorkspaceApiKeyCommand extends $Command<DeleteWorkspaceApiKeyCommandInput, DeleteWorkspaceApiKeyCommandOutput, GrafanaClientResolvedConfig> {
53
60
  readonly input: DeleteWorkspaceApiKeyCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteWorkspaceApiKeyCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWorkspaceApiKeyCommandInput, DeleteWorkspaceApiKeyCommandOutput>;
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 { DeleteWorkspaceRequest, DeleteWorkspaceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteWorkspaceCommand}.
8
10
  */
9
11
  export interface DeleteWorkspaceCommandInput extends DeleteWorkspaceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteWorkspaceCommand}.
13
17
  */
14
18
  export interface DeleteWorkspaceCommandOutput extends DeleteWorkspaceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an Amazon Managed Grafana 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 DeleteWorkspaceCommandOutput extends DeleteWorkspaceResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteWorkspaceCommandInput - {@link DeleteWorkspaceCommandInput}
34
+ * @returns {@link DeleteWorkspaceCommandOutput}
28
35
  * @see {@link DeleteWorkspaceCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteWorkspaceCommandOutput} for command's `response` shape.
30
37
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteWorkspaceCommandOutput extends DeleteWorkspaceResponse, _
52
59
  export declare class DeleteWorkspaceCommand extends $Command<DeleteWorkspaceCommandInput, DeleteWorkspaceCommandOutput, GrafanaClientResolvedConfig> {
53
60
  readonly input: DeleteWorkspaceCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteWorkspaceCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWorkspaceCommandInput, DeleteWorkspaceCommandOutput>;
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 { DescribeWorkspaceAuthenticationRequest, DescribeWorkspaceAuthenticationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeWorkspaceAuthenticationCommand}.
8
10
  */
9
11
  export interface DescribeWorkspaceAuthenticationCommandInput extends DescribeWorkspaceAuthenticationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeWorkspaceAuthenticationCommand}.
13
17
  */
14
18
  export interface DescribeWorkspaceAuthenticationCommandOutput extends DescribeWorkspaceAuthenticationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Displays information about the authentication methods used in one Amazon Managed Grafana
18
23
  * workspace.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeWorkspaceAuthenticationCommandOutput extends DescribeWo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeWorkspaceAuthenticationCommandInput - {@link DescribeWorkspaceAuthenticationCommandInput}
35
+ * @returns {@link DescribeWorkspaceAuthenticationCommandOutput}
29
36
  * @see {@link DescribeWorkspaceAuthenticationCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeWorkspaceAuthenticationCommandOutput} for command's `response` shape.
31
38
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeWorkspaceAuthenticationCommandOutput extends DescribeWo
50
57
  export declare class DescribeWorkspaceAuthenticationCommand extends $Command<DescribeWorkspaceAuthenticationCommandInput, DescribeWorkspaceAuthenticationCommandOutput, GrafanaClientResolvedConfig> {
51
58
  readonly input: DescribeWorkspaceAuthenticationCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeWorkspaceAuthenticationCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWorkspaceAuthenticationCommandInput, DescribeWorkspaceAuthenticationCommandOutput>;
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 { DescribeWorkspaceRequest, DescribeWorkspaceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeWorkspaceCommand}.
8
10
  */
9
11
  export interface DescribeWorkspaceCommandInput extends DescribeWorkspaceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeWorkspaceCommand}.
13
17
  */
14
18
  export interface DescribeWorkspaceCommandOutput extends DescribeWorkspaceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Displays information about one Amazon Managed Grafana 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 DescribeWorkspaceCommandOutput extends DescribeWorkspaceRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeWorkspaceCommandInput - {@link DescribeWorkspaceCommandInput}
34
+ * @returns {@link DescribeWorkspaceCommandOutput}
28
35
  * @see {@link DescribeWorkspaceCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeWorkspaceCommandOutput} for command's `response` shape.
30
37
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DescribeWorkspaceCommandOutput extends DescribeWorkspaceRespons
49
56
  export declare class DescribeWorkspaceCommand extends $Command<DescribeWorkspaceCommandInput, DescribeWorkspaceCommandOutput, GrafanaClientResolvedConfig> {
50
57
  readonly input: DescribeWorkspaceCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DescribeWorkspaceCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWorkspaceCommandInput, DescribeWorkspaceCommandOutput>;
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 { DescribeWorkspaceConfigurationRequest, DescribeWorkspaceConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeWorkspaceConfigurationCommand}.
8
10
  */
9
11
  export interface DescribeWorkspaceConfigurationCommandInput extends DescribeWorkspaceConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeWorkspaceConfigurationCommand}.
13
17
  */
14
18
  export interface DescribeWorkspaceConfigurationCommandOutput extends DescribeWorkspaceConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the current 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 DescribeWorkspaceConfigurationCommandOutput extends DescribeWor
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeWorkspaceConfigurationCommandInput - {@link DescribeWorkspaceConfigurationCommandInput}
34
+ * @returns {@link DescribeWorkspaceConfigurationCommandOutput}
28
35
  * @see {@link DescribeWorkspaceConfigurationCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeWorkspaceConfigurationCommandOutput} for command's `response` shape.
30
37
  * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DescribeWorkspaceConfigurationCommandOutput extends DescribeWor
46
53
  export declare class DescribeWorkspaceConfigurationCommand extends $Command<DescribeWorkspaceConfigurationCommandInput, DescribeWorkspaceConfigurationCommandOutput, GrafanaClientResolvedConfig> {
47
54
  readonly input: DescribeWorkspaceConfigurationCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DescribeWorkspaceConfigurationCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWorkspaceConfigurationCommandInput, DescribeWorkspaceConfigurationCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }