@aws-sdk/client-grafana 3.575.0 → 3.577.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/README.md +48 -0
- package/dist-cjs/index.js +341 -0
- package/dist-es/Grafana.js +12 -0
- package/dist-es/commands/CreateWorkspaceServiceAccountCommand.js +24 -0
- package/dist-es/commands/CreateWorkspaceServiceAccountTokenCommand.js +25 -0
- package/dist-es/commands/DeleteWorkspaceServiceAccountCommand.js +24 -0
- package/dist-es/commands/DeleteWorkspaceServiceAccountTokenCommand.js +24 -0
- package/dist-es/commands/ListWorkspaceServiceAccountTokensCommand.js +24 -0
- package/dist-es/commands/ListWorkspaceServiceAccountsCommand.js +24 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/models_0.js +10 -0
- package/dist-es/pagination/ListWorkspaceServiceAccountTokensPaginator.js +4 -0
- package/dist-es/pagination/ListWorkspaceServiceAccountsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +193 -0
- package/dist-types/Grafana.d.ts +42 -0
- package/dist-types/GrafanaClient.d.ts +8 -2
- package/dist-types/commands/AssociateLicenseCommand.d.ts +3 -1
- package/dist-types/commands/CreateWorkspaceApiKeyCommand.d.ts +4 -0
- package/dist-types/commands/CreateWorkspaceServiceAccountCommand.d.ts +97 -0
- package/dist-types/commands/CreateWorkspaceServiceAccountTokenCommand.d.ts +101 -0
- package/dist-types/commands/DeleteWorkspaceApiKeyCommand.d.ts +4 -0
- package/dist-types/commands/DeleteWorkspaceServiceAccountCommand.d.ts +84 -0
- package/dist-types/commands/DeleteWorkspaceServiceAccountTokenCommand.d.ts +86 -0
- package/dist-types/commands/DescribeWorkspaceAuthenticationCommand.d.ts +3 -0
- package/dist-types/commands/ListWorkspaceServiceAccountTokensCommand.d.ts +97 -0
- package/dist-types/commands/ListWorkspaceServiceAccountsCommand.d.ts +90 -0
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +357 -5
- package/dist-types/pagination/ListWorkspaceServiceAccountTokensPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkspaceServiceAccountsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +54 -0
- package/dist-types/ts3.4/Grafana.d.ts +120 -0
- package/dist-types/ts3.4/GrafanaClient.d.ts +36 -0
- package/dist-types/ts3.4/commands/CreateWorkspaceServiceAccountCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateWorkspaceServiceAccountTokenCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteWorkspaceServiceAccountCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteWorkspaceServiceAccountTokenCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListWorkspaceServiceAccountTokensCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListWorkspaceServiceAccountsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +86 -0
- package/dist-types/ts3.4/pagination/ListWorkspaceServiceAccountTokensPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWorkspaceServiceAccountsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
- package/package.json +14 -14
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
|
|
4
|
+
import { CreateWorkspaceServiceAccountTokenRequest, CreateWorkspaceServiceAccountTokenResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link CreateWorkspaceServiceAccountTokenCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface CreateWorkspaceServiceAccountTokenCommandInput extends CreateWorkspaceServiceAccountTokenRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link CreateWorkspaceServiceAccountTokenCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateWorkspaceServiceAccountTokenCommandOutput extends CreateWorkspaceServiceAccountTokenResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const CreateWorkspaceServiceAccountTokenCommand_base: {
|
|
24
|
+
new (input: CreateWorkspaceServiceAccountTokenCommandInput): import("@smithy/smithy-client").CommandImpl<CreateWorkspaceServiceAccountTokenCommandInput, CreateWorkspaceServiceAccountTokenCommandOutput, GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CreateWorkspaceServiceAccountTokenCommandInput): import("@smithy/smithy-client").CommandImpl<CreateWorkspaceServiceAccountTokenCommandInput, CreateWorkspaceServiceAccountTokenCommandOutput, GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Creates a token that can be used to authenticate and authorize Grafana HTTP API
|
|
30
|
+
* operations for the given <a href="https://docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html">workspace service
|
|
31
|
+
* account</a>. The service account acts as a user for the API operations, and
|
|
32
|
+
* defines the permissions that are used by the API.</p>
|
|
33
|
+
* <important>
|
|
34
|
+
* <p>When you create the service account token, you will receive a key that is used
|
|
35
|
+
* when calling Grafana APIs. Do not lose this key, as it will not be retrievable
|
|
36
|
+
* again.</p>
|
|
37
|
+
* <p>If you do lose the key, you can delete the token and recreate it to receive a
|
|
38
|
+
* new key. This will disable the initial key.</p>
|
|
39
|
+
* </important>
|
|
40
|
+
* <p>Service accounts are only available for workspaces that are compatible with Grafana
|
|
41
|
+
* version 9 and above.</p>
|
|
42
|
+
* @example
|
|
43
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
44
|
+
* ```javascript
|
|
45
|
+
* import { GrafanaClient, CreateWorkspaceServiceAccountTokenCommand } from "@aws-sdk/client-grafana"; // ES Modules import
|
|
46
|
+
* // const { GrafanaClient, CreateWorkspaceServiceAccountTokenCommand } = require("@aws-sdk/client-grafana"); // CommonJS import
|
|
47
|
+
* const client = new GrafanaClient(config);
|
|
48
|
+
* const input = { // CreateWorkspaceServiceAccountTokenRequest
|
|
49
|
+
* name: "STRING_VALUE", // required
|
|
50
|
+
* secondsToLive: Number("int"), // required
|
|
51
|
+
* serviceAccountId: "STRING_VALUE", // required
|
|
52
|
+
* workspaceId: "STRING_VALUE", // required
|
|
53
|
+
* };
|
|
54
|
+
* const command = new CreateWorkspaceServiceAccountTokenCommand(input);
|
|
55
|
+
* const response = await client.send(command);
|
|
56
|
+
* // { // CreateWorkspaceServiceAccountTokenResponse
|
|
57
|
+
* // serviceAccountToken: { // ServiceAccountTokenSummaryWithKey
|
|
58
|
+
* // id: "STRING_VALUE", // required
|
|
59
|
+
* // name: "STRING_VALUE", // required
|
|
60
|
+
* // key: "STRING_VALUE", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // serviceAccountId: "STRING_VALUE", // required
|
|
63
|
+
* // workspaceId: "STRING_VALUE", // required
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param CreateWorkspaceServiceAccountTokenCommandInput - {@link CreateWorkspaceServiceAccountTokenCommandInput}
|
|
69
|
+
* @returns {@link CreateWorkspaceServiceAccountTokenCommandOutput}
|
|
70
|
+
* @see {@link CreateWorkspaceServiceAccountTokenCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link CreateWorkspaceServiceAccountTokenCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>You do not have sufficient permissions to perform this action. </p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ConflictException} (client fault)
|
|
78
|
+
* <p>A resource was in an inconsistent state during an update or a deletion.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerException} (server fault)
|
|
81
|
+
* <p>Unexpected error while processing the request. Retry the request.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>The request references a resource that does not exist.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
87
|
+
* <p>The request would cause a service quota to be exceeded.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
90
|
+
* <p>The request was denied because of request throttling. Retry the request.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ValidationException} (client fault)
|
|
93
|
+
* <p>The value of a parameter in the request caused an error.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link GrafanaServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from Grafana service.</p>
|
|
97
|
+
*
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export declare class CreateWorkspaceServiceAccountTokenCommand extends CreateWorkspaceServiceAccountTokenCommand_base {
|
|
101
|
+
}
|
|
@@ -27,6 +27,10 @@ declare const DeleteWorkspaceApiKeyCommand_base: {
|
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
29
|
* <p>Deletes a Grafana API key for the workspace.</p>
|
|
30
|
+
* <note>
|
|
31
|
+
* <p>In workspaces compatible with Grafana version 9 or above, use workspace service
|
|
32
|
+
* accounts instead of API keys. API keys will be removed in a future release.</p>
|
|
33
|
+
* </note>
|
|
30
34
|
* @example
|
|
31
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
36
|
* ```javascript
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
|
|
4
|
+
import { DeleteWorkspaceServiceAccountRequest, DeleteWorkspaceServiceAccountResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link DeleteWorkspaceServiceAccountCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface DeleteWorkspaceServiceAccountCommandInput extends DeleteWorkspaceServiceAccountRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link DeleteWorkspaceServiceAccountCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface DeleteWorkspaceServiceAccountCommandOutput extends DeleteWorkspaceServiceAccountResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const DeleteWorkspaceServiceAccountCommand_base: {
|
|
24
|
+
new (input: DeleteWorkspaceServiceAccountCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteWorkspaceServiceAccountCommandInput, DeleteWorkspaceServiceAccountCommandOutput, GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DeleteWorkspaceServiceAccountCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteWorkspaceServiceAccountCommandInput, DeleteWorkspaceServiceAccountCommandOutput, GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Deletes a workspace service account from the workspace.</p>
|
|
30
|
+
* <p>This will delete any tokens created for the service account, as well. If the tokens
|
|
31
|
+
* are currently in use, the will fail to authenticate / authorize after they are
|
|
32
|
+
* deleted.</p>
|
|
33
|
+
* <p>Service accounts are only available for workspaces that are compatible with Grafana
|
|
34
|
+
* version 9 and above.</p>
|
|
35
|
+
* @example
|
|
36
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
37
|
+
* ```javascript
|
|
38
|
+
* import { GrafanaClient, DeleteWorkspaceServiceAccountCommand } from "@aws-sdk/client-grafana"; // ES Modules import
|
|
39
|
+
* // const { GrafanaClient, DeleteWorkspaceServiceAccountCommand } = require("@aws-sdk/client-grafana"); // CommonJS import
|
|
40
|
+
* const client = new GrafanaClient(config);
|
|
41
|
+
* const input = { // DeleteWorkspaceServiceAccountRequest
|
|
42
|
+
* serviceAccountId: "STRING_VALUE", // required
|
|
43
|
+
* workspaceId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new DeleteWorkspaceServiceAccountCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // DeleteWorkspaceServiceAccountResponse
|
|
48
|
+
* // serviceAccountId: "STRING_VALUE", // required
|
|
49
|
+
* // workspaceId: "STRING_VALUE", // required
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param DeleteWorkspaceServiceAccountCommandInput - {@link DeleteWorkspaceServiceAccountCommandInput}
|
|
55
|
+
* @returns {@link DeleteWorkspaceServiceAccountCommandOutput}
|
|
56
|
+
* @see {@link DeleteWorkspaceServiceAccountCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link DeleteWorkspaceServiceAccountCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
61
|
+
* <p>You do not have sufficient permissions to perform this action. </p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ConflictException} (client fault)
|
|
64
|
+
* <p>A resource was in an inconsistent state during an update or a deletion.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerException} (server fault)
|
|
67
|
+
* <p>Unexpected error while processing the request. Retry the request.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
+
* <p>The request references a resource that does not exist.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
+
* <p>The request was denied because of request throttling. Retry the request.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ValidationException} (client fault)
|
|
76
|
+
* <p>The value of a parameter in the request caused an error.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link GrafanaServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from Grafana service.</p>
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class DeleteWorkspaceServiceAccountCommand extends DeleteWorkspaceServiceAccountCommand_base {
|
|
84
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
|
|
4
|
+
import { DeleteWorkspaceServiceAccountTokenRequest, DeleteWorkspaceServiceAccountTokenResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link DeleteWorkspaceServiceAccountTokenCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface DeleteWorkspaceServiceAccountTokenCommandInput extends DeleteWorkspaceServiceAccountTokenRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link DeleteWorkspaceServiceAccountTokenCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface DeleteWorkspaceServiceAccountTokenCommandOutput extends DeleteWorkspaceServiceAccountTokenResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const DeleteWorkspaceServiceAccountTokenCommand_base: {
|
|
24
|
+
new (input: DeleteWorkspaceServiceAccountTokenCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteWorkspaceServiceAccountTokenCommandInput, DeleteWorkspaceServiceAccountTokenCommandOutput, GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DeleteWorkspaceServiceAccountTokenCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteWorkspaceServiceAccountTokenCommandInput, DeleteWorkspaceServiceAccountTokenCommandOutput, GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Deletes a token for the workspace service account.</p>
|
|
30
|
+
* <p>This will disable the key associated with the token. If any automation is currently
|
|
31
|
+
* using the key, it will no longer be authenticated or authorized to perform actions with
|
|
32
|
+
* the Grafana HTTP APIs.</p>
|
|
33
|
+
* <p>Service accounts are only available for workspaces that are compatible with Grafana
|
|
34
|
+
* version 9 and above.</p>
|
|
35
|
+
* @example
|
|
36
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
37
|
+
* ```javascript
|
|
38
|
+
* import { GrafanaClient, DeleteWorkspaceServiceAccountTokenCommand } from "@aws-sdk/client-grafana"; // ES Modules import
|
|
39
|
+
* // const { GrafanaClient, DeleteWorkspaceServiceAccountTokenCommand } = require("@aws-sdk/client-grafana"); // CommonJS import
|
|
40
|
+
* const client = new GrafanaClient(config);
|
|
41
|
+
* const input = { // DeleteWorkspaceServiceAccountTokenRequest
|
|
42
|
+
* tokenId: "STRING_VALUE", // required
|
|
43
|
+
* serviceAccountId: "STRING_VALUE", // required
|
|
44
|
+
* workspaceId: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
46
|
+
* const command = new DeleteWorkspaceServiceAccountTokenCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // DeleteWorkspaceServiceAccountTokenResponse
|
|
49
|
+
* // tokenId: "STRING_VALUE", // required
|
|
50
|
+
* // serviceAccountId: "STRING_VALUE", // required
|
|
51
|
+
* // workspaceId: "STRING_VALUE", // required
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param DeleteWorkspaceServiceAccountTokenCommandInput - {@link DeleteWorkspaceServiceAccountTokenCommandInput}
|
|
57
|
+
* @returns {@link DeleteWorkspaceServiceAccountTokenCommandOutput}
|
|
58
|
+
* @see {@link DeleteWorkspaceServiceAccountTokenCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link DeleteWorkspaceServiceAccountTokenCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p>You do not have sufficient permissions to perform this action. </p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ConflictException} (client fault)
|
|
66
|
+
* <p>A resource was in an inconsistent state during an update or a deletion.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerException} (server fault)
|
|
69
|
+
* <p>Unexpected error while processing the request. Retry the request.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>The request references a resource that does not exist.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>The request was denied because of request throttling. Retry the request.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationException} (client fault)
|
|
78
|
+
* <p>The value of a parameter in the request caused an error.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link GrafanaServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from Grafana service.</p>
|
|
82
|
+
*
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
export declare class DeleteWorkspaceServiceAccountTokenCommand extends DeleteWorkspaceServiceAccountTokenCommand_base {
|
|
86
|
+
}
|
|
@@ -90,6 +90,9 @@ declare const DescribeWorkspaceAuthenticationCommand_base: {
|
|
|
90
90
|
* @throws {@link AccessDeniedException} (client fault)
|
|
91
91
|
* <p>You do not have sufficient permissions to perform this action. </p>
|
|
92
92
|
*
|
|
93
|
+
* @throws {@link ConflictException} (client fault)
|
|
94
|
+
* <p>A resource was in an inconsistent state during an update or a deletion.</p>
|
|
95
|
+
*
|
|
93
96
|
* @throws {@link InternalServerException} (server fault)
|
|
94
97
|
* <p>Unexpected error while processing the request. Retry the request.</p>
|
|
95
98
|
*
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
|
|
4
|
+
import { ListWorkspaceServiceAccountTokensRequest, ListWorkspaceServiceAccountTokensResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link ListWorkspaceServiceAccountTokensCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface ListWorkspaceServiceAccountTokensCommandInput extends ListWorkspaceServiceAccountTokensRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link ListWorkspaceServiceAccountTokensCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface ListWorkspaceServiceAccountTokensCommandOutput extends ListWorkspaceServiceAccountTokensResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const ListWorkspaceServiceAccountTokensCommand_base: {
|
|
24
|
+
new (input: ListWorkspaceServiceAccountTokensCommandInput): import("@smithy/smithy-client").CommandImpl<ListWorkspaceServiceAccountTokensCommandInput, ListWorkspaceServiceAccountTokensCommandOutput, GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ListWorkspaceServiceAccountTokensCommandInput): import("@smithy/smithy-client").CommandImpl<ListWorkspaceServiceAccountTokensCommandInput, ListWorkspaceServiceAccountTokensCommandOutput, GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Returns a list of tokens for a workspace service account.</p>
|
|
30
|
+
* <note>
|
|
31
|
+
* <p>This does not return the key for each token. You cannot access keys after they
|
|
32
|
+
* are created. To create a new key, delete the token and recreate it.</p>
|
|
33
|
+
* </note>
|
|
34
|
+
* <p>Service accounts are only available for workspaces that are compatible with Grafana
|
|
35
|
+
* version 9 and above.</p>
|
|
36
|
+
* @example
|
|
37
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
38
|
+
* ```javascript
|
|
39
|
+
* import { GrafanaClient, ListWorkspaceServiceAccountTokensCommand } from "@aws-sdk/client-grafana"; // ES Modules import
|
|
40
|
+
* // const { GrafanaClient, ListWorkspaceServiceAccountTokensCommand } = require("@aws-sdk/client-grafana"); // CommonJS import
|
|
41
|
+
* const client = new GrafanaClient(config);
|
|
42
|
+
* const input = { // ListWorkspaceServiceAccountTokensRequest
|
|
43
|
+
* maxResults: Number("int"),
|
|
44
|
+
* nextToken: "STRING_VALUE",
|
|
45
|
+
* serviceAccountId: "STRING_VALUE", // required
|
|
46
|
+
* workspaceId: "STRING_VALUE", // required
|
|
47
|
+
* };
|
|
48
|
+
* const command = new ListWorkspaceServiceAccountTokensCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // { // ListWorkspaceServiceAccountTokensResponse
|
|
51
|
+
* // nextToken: "STRING_VALUE",
|
|
52
|
+
* // serviceAccountTokens: [ // ServiceAccountTokenList // required
|
|
53
|
+
* // { // ServiceAccountTokenSummary
|
|
54
|
+
* // id: "STRING_VALUE", // required
|
|
55
|
+
* // name: "STRING_VALUE", // required
|
|
56
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
57
|
+
* // expiresAt: new Date("TIMESTAMP"), // required
|
|
58
|
+
* // lastUsedAt: new Date("TIMESTAMP"),
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // serviceAccountId: "STRING_VALUE", // required
|
|
62
|
+
* // workspaceId: "STRING_VALUE", // required
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param ListWorkspaceServiceAccountTokensCommandInput - {@link ListWorkspaceServiceAccountTokensCommandInput}
|
|
68
|
+
* @returns {@link ListWorkspaceServiceAccountTokensCommandOutput}
|
|
69
|
+
* @see {@link ListWorkspaceServiceAccountTokensCommandInput} for command's `input` shape.
|
|
70
|
+
* @see {@link ListWorkspaceServiceAccountTokensCommandOutput} for command's `response` shape.
|
|
71
|
+
* @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
74
|
+
* <p>You do not have sufficient permissions to perform this action. </p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ConflictException} (client fault)
|
|
77
|
+
* <p>A resource was in an inconsistent state during an update or a deletion.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InternalServerException} (server fault)
|
|
80
|
+
* <p>Unexpected error while processing the request. Retry the request.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
83
|
+
* <p>The request references a resource that does not exist.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
86
|
+
* <p>The request was denied because of request throttling. Retry the request.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ValidationException} (client fault)
|
|
89
|
+
* <p>The value of a parameter in the request caused an error.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link GrafanaServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from Grafana service.</p>
|
|
93
|
+
*
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class ListWorkspaceServiceAccountTokensCommand extends ListWorkspaceServiceAccountTokensCommand_base {
|
|
97
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient";
|
|
4
|
+
import { ListWorkspaceServiceAccountsRequest, ListWorkspaceServiceAccountsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link ListWorkspaceServiceAccountsCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface ListWorkspaceServiceAccountsCommandInput extends ListWorkspaceServiceAccountsRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link ListWorkspaceServiceAccountsCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface ListWorkspaceServiceAccountsCommandOutput extends ListWorkspaceServiceAccountsResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const ListWorkspaceServiceAccountsCommand_base: {
|
|
24
|
+
new (input: ListWorkspaceServiceAccountsCommandInput): import("@smithy/smithy-client").CommandImpl<ListWorkspaceServiceAccountsCommandInput, ListWorkspaceServiceAccountsCommandOutput, GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ListWorkspaceServiceAccountsCommandInput): import("@smithy/smithy-client").CommandImpl<ListWorkspaceServiceAccountsCommandInput, ListWorkspaceServiceAccountsCommandOutput, GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Returns a list of service accounts for a workspace.</p>
|
|
30
|
+
* <p>Service accounts are only available for workspaces that are compatible with Grafana
|
|
31
|
+
* version 9 and above.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { GrafanaClient, ListWorkspaceServiceAccountsCommand } from "@aws-sdk/client-grafana"; // ES Modules import
|
|
36
|
+
* // const { GrafanaClient, ListWorkspaceServiceAccountsCommand } = require("@aws-sdk/client-grafana"); // CommonJS import
|
|
37
|
+
* const client = new GrafanaClient(config);
|
|
38
|
+
* const input = { // ListWorkspaceServiceAccountsRequest
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* workspaceId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListWorkspaceServiceAccountsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListWorkspaceServiceAccountsResponse
|
|
46
|
+
* // nextToken: "STRING_VALUE",
|
|
47
|
+
* // serviceAccounts: [ // ServiceAccountList // required
|
|
48
|
+
* // { // ServiceAccountSummary
|
|
49
|
+
* // id: "STRING_VALUE", // required
|
|
50
|
+
* // name: "STRING_VALUE", // required
|
|
51
|
+
* // isDisabled: "STRING_VALUE", // required
|
|
52
|
+
* // grafanaRole: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // workspaceId: "STRING_VALUE", // required
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param ListWorkspaceServiceAccountsCommandInput - {@link ListWorkspaceServiceAccountsCommandInput}
|
|
61
|
+
* @returns {@link ListWorkspaceServiceAccountsCommandOutput}
|
|
62
|
+
* @see {@link ListWorkspaceServiceAccountsCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link ListWorkspaceServiceAccountsCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
67
|
+
* <p>You do not have sufficient permissions to perform this action. </p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ConflictException} (client fault)
|
|
70
|
+
* <p>A resource was in an inconsistent state during an update or a deletion.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InternalServerException} (server fault)
|
|
73
|
+
* <p>Unexpected error while processing the request. Retry the request.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
+
* <p>The request references a resource that does not exist.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
79
|
+
* <p>The request was denied because of request throttling. Retry the request.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ValidationException} (client fault)
|
|
82
|
+
* <p>The value of a parameter in the request caused an error.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link GrafanaServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from Grafana service.</p>
|
|
86
|
+
*
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
export declare class ListWorkspaceServiceAccountsCommand extends ListWorkspaceServiceAccountsCommand_base {
|
|
90
|
+
}
|
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
export * from "./AssociateLicenseCommand";
|
|
2
2
|
export * from "./CreateWorkspaceApiKeyCommand";
|
|
3
3
|
export * from "./CreateWorkspaceCommand";
|
|
4
|
+
export * from "./CreateWorkspaceServiceAccountCommand";
|
|
5
|
+
export * from "./CreateWorkspaceServiceAccountTokenCommand";
|
|
4
6
|
export * from "./DeleteWorkspaceApiKeyCommand";
|
|
5
7
|
export * from "./DeleteWorkspaceCommand";
|
|
8
|
+
export * from "./DeleteWorkspaceServiceAccountCommand";
|
|
9
|
+
export * from "./DeleteWorkspaceServiceAccountTokenCommand";
|
|
6
10
|
export * from "./DescribeWorkspaceAuthenticationCommand";
|
|
7
11
|
export * from "./DescribeWorkspaceCommand";
|
|
8
12
|
export * from "./DescribeWorkspaceConfigurationCommand";
|
|
@@ -10,6 +14,8 @@ export * from "./DisassociateLicenseCommand";
|
|
|
10
14
|
export * from "./ListPermissionsCommand";
|
|
11
15
|
export * from "./ListTagsForResourceCommand";
|
|
12
16
|
export * from "./ListVersionsCommand";
|
|
17
|
+
export * from "./ListWorkspaceServiceAccountTokensCommand";
|
|
18
|
+
export * from "./ListWorkspaceServiceAccountsCommand";
|
|
13
19
|
export * from "./ListWorkspacesCommand";
|
|
14
20
|
export * from "./TagResourceCommand";
|
|
15
21
|
export * from "./UntagResourceCommand";
|