@aws-sdk/client-grafana 3.216.0 → 3.217.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.
- package/dist-cjs/Grafana.js +30 -0
- package/dist-cjs/commands/DescribeWorkspaceConfigurationCommand.js +46 -0
- package/dist-cjs/commands/UpdateWorkspaceConfigurationCommand.js +46 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +23 -2
- package/dist-cjs/protocols/Aws_restJson1.js +192 -1
- package/dist-es/Grafana.js +30 -0
- package/dist-es/commands/DescribeWorkspaceConfigurationCommand.js +42 -0
- package/dist-es/commands/UpdateWorkspaceConfigurationCommand.js +42 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +17 -1
- package/dist-es/protocols/Aws_restJson1.js +188 -1
- package/dist-types/Grafana.d.ts +47 -33
- package/dist-types/GrafanaClient.d.ts +4 -2
- package/dist-types/commands/AssociateLicenseCommand.d.ts +2 -2
- package/dist-types/commands/CreateWorkspaceApiKeyCommand.d.ts +4 -4
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +4 -4
- package/dist-types/commands/DeleteWorkspaceApiKeyCommand.d.ts +1 -1
- package/dist-types/commands/DescribeWorkspaceConfigurationCommand.d.ts +37 -0
- package/dist-types/commands/ListPermissionsCommand.d.ts +6 -6
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/ListWorkspacesCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +4 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateWorkspaceAuthenticationCommand.d.ts +3 -3
- package/dist-types/commands/UpdateWorkspaceCommand.d.ts +5 -5
- package/dist-types/commands/UpdateWorkspaceConfigurationCommand.d.ts +37 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +227 -127
- package/dist-types/protocols/Aws_restJson1.d.ts +6 -0
- package/dist-types/ts3.4/Grafana.d.ts +34 -0
- package/dist-types/ts3.4/GrafanaClient.d.ts +14 -2
- package/dist-types/ts3.4/commands/DescribeWorkspaceConfigurationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateWorkspaceConfigurationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +40 -1
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +1 -1
|
@@ -9,12 +9,12 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists the users and groups who have the Grafana <code>Admin</code> and
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
12
|
+
* <code>Editor</code> roles in this workspace. If you use this
|
|
13
|
+
* operation without specifying <code>userId</code> or <code>groupId</code>, the operation returns
|
|
14
|
+
* the roles of all users
|
|
15
|
+
* and groups. If you specify a <code>userId</code> or a <code>groupId</code>, only the roles
|
|
16
|
+
* for that user or group are returned. If you do this, you can specify only one <code>userId</code> or
|
|
17
|
+
* one <code>groupId</code>.</p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
20
|
* ```javascript
|
|
@@ -9,8 +9,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>The <code>ListTagsForResource</code> operation returns the tags that
|
|
12
|
-
*
|
|
13
|
-
*
|
|
12
|
+
* are associated with the Amazon Managed Service for Grafana resource specified by the <code>resourceArn</code>.
|
|
13
|
+
* Currently, the only resource that can be tagged is a workspace. </p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns a list of Amazon Managed Grafana workspaces in the account, with some information
|
|
12
|
-
*
|
|
12
|
+
* 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>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,10 +9,10 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>The <code>TagResource</code> operation associates tags with an Amazon Managed Grafana resource.
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
12
|
+
* Currently, the only resource that can be tagged is workspaces. </p>
|
|
13
|
+
* <p>If you specify a new tag key for the resource, this tag is appended to the list of tags associated
|
|
14
|
+
* with the resource. If you specify a tag key that is already associated with the resource, the new tag
|
|
15
|
+
* value that you specify replaces the previous value for that tag.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>The <code>UntagResource</code> operation removes the association of the tag with the Amazon Managed Grafana resource.
|
|
12
|
-
*
|
|
12
|
+
* </p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,9 +9,9 @@ export interface UpdateWorkspaceAuthenticationCommandOutput extends UpdateWorksp
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Use this operation to define the identity provider (IdP) that this workspace
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
12
|
+
* authenticates users from, using SAML. You can also map SAML assertion attributes to
|
|
13
|
+
* workspace user information and define which groups in the assertion attribute are to have
|
|
14
|
+
* the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -9,11 +9,11 @@ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
12
|
+
* optional parameters, the existing values of those parameters are not changed.</p>
|
|
13
|
+
* <p>To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center,
|
|
14
|
+
* use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html">UpdateWorkspaceAuthentication</a>.</p>
|
|
15
|
+
* <p>To modify which users in the workspace have the <code>Admin</code> and <code>Editor</code> Grafana roles,
|
|
16
|
+
* use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html">UpdatePermissions</a>.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
19
|
* ```javascript
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
|
|
5
|
+
import { UpdateWorkspaceConfigurationRequest, UpdateWorkspaceConfigurationResponse } from "../models/models_0";
|
|
6
|
+
export interface UpdateWorkspaceConfigurationCommandInput extends UpdateWorkspaceConfigurationRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface UpdateWorkspaceConfigurationCommandOutput extends UpdateWorkspaceConfigurationResponse, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Updates the configuration string for the given workspace</p>
|
|
12
|
+
* @example
|
|
13
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
+
* ```javascript
|
|
15
|
+
* import { GrafanaClient, UpdateWorkspaceConfigurationCommand } from "@aws-sdk/client-grafana"; // ES Modules import
|
|
16
|
+
* // const { GrafanaClient, UpdateWorkspaceConfigurationCommand } = require("@aws-sdk/client-grafana"); // CommonJS import
|
|
17
|
+
* const client = new GrafanaClient(config);
|
|
18
|
+
* const command = new UpdateWorkspaceConfigurationCommand(input);
|
|
19
|
+
* const response = await client.send(command);
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @see {@link UpdateWorkspaceConfigurationCommandInput} for command's `input` shape.
|
|
23
|
+
* @see {@link UpdateWorkspaceConfigurationCommandOutput} for command's `response` shape.
|
|
24
|
+
* @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
export declare class UpdateWorkspaceConfigurationCommand extends $Command<UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput, GrafanaClientResolvedConfig> {
|
|
28
|
+
readonly input: UpdateWorkspaceConfigurationCommandInput;
|
|
29
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
30
|
+
constructor(input: UpdateWorkspaceConfigurationCommandInput);
|
|
31
|
+
/**
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GrafanaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput>;
|
|
35
|
+
private serialize;
|
|
36
|
+
private deserialize;
|
|
37
|
+
}
|
|
@@ -5,6 +5,7 @@ export * from "./DeleteWorkspaceApiKeyCommand";
|
|
|
5
5
|
export * from "./DeleteWorkspaceCommand";
|
|
6
6
|
export * from "./DescribeWorkspaceAuthenticationCommand";
|
|
7
7
|
export * from "./DescribeWorkspaceCommand";
|
|
8
|
+
export * from "./DescribeWorkspaceConfigurationCommand";
|
|
8
9
|
export * from "./DisassociateLicenseCommand";
|
|
9
10
|
export * from "./ListPermissionsCommand";
|
|
10
11
|
export * from "./ListTagsForResourceCommand";
|
|
@@ -14,3 +15,4 @@ export * from "./UntagResourceCommand";
|
|
|
14
15
|
export * from "./UpdatePermissionsCommand";
|
|
15
16
|
export * from "./UpdateWorkspaceAuthenticationCommand";
|
|
16
17
|
export * from "./UpdateWorkspaceCommand";
|
|
18
|
+
export * from "./UpdateWorkspaceConfigurationCommand";
|