@aws-sdk/client-grafana 3.325.0 → 3.326.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 (19) hide show
  1. package/dist-types/commands/AssociateLicenseCommand.d.ts +58 -0
  2. package/dist-types/commands/CreateWorkspaceApiKeyCommand.d.ts +8 -0
  3. package/dist-types/commands/CreateWorkspaceCommand.d.ts +58 -0
  4. package/dist-types/commands/DeleteWorkspaceApiKeyCommand.d.ts +7 -0
  5. package/dist-types/commands/DeleteWorkspaceCommand.d.ts +58 -0
  6. package/dist-types/commands/DescribeWorkspaceAuthenticationCommand.d.ts +42 -0
  7. package/dist-types/commands/DescribeWorkspaceCommand.d.ts +58 -0
  8. package/dist-types/commands/DescribeWorkspaceConfigurationCommand.d.ts +6 -0
  9. package/dist-types/commands/DisassociateLicenseCommand.d.ts +58 -0
  10. package/dist-types/commands/ListPermissionsCommand.d.ts +15 -0
  11. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  12. package/dist-types/commands/ListWorkspacesCommand.d.ts +30 -0
  13. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  14. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  15. package/dist-types/commands/UpdatePermissionsCommand.d.ts +21 -0
  16. package/dist-types/commands/UpdateWorkspaceAuthenticationCommand.d.ts +42 -0
  17. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +58 -0
  18. package/dist-types/commands/UpdateWorkspaceConfigurationCommand.d.ts +4 -0
  19. package/package.json +3 -3
package/dist-types/commands/AssociateLicenseCommand.d.ts CHANGED
@@ -34,6 +34,62 @@ export interface AssociateLicenseCommandOutput extends AssociateLicenseResponse,
34
34
  * };
35
35
  * const command = new AssociateLicenseCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // AssociateLicenseResponse
38
+ * // workspace: { // WorkspaceDescription
39
+ * // accountAccessType: "STRING_VALUE",
40
+ * // created: new Date("TIMESTAMP"), // required
41
+ * // dataSources: [ // DataSourceTypesList // required
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // description: "STRING_VALUE",
45
+ * // endpoint: "STRING_VALUE", // required
46
+ * // grafanaVersion: "STRING_VALUE", // required
47
+ * // id: "STRING_VALUE", // required
48
+ * // modified: new Date("TIMESTAMP"), // required
49
+ * // name: "STRING_VALUE",
50
+ * // organizationRoleName: "STRING_VALUE",
51
+ * // notificationDestinations: [ // NotificationDestinationsList
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // organizationalUnits: [ // OrganizationalUnitList
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // permissionType: "STRING_VALUE",
58
+ * // stackSetName: "STRING_VALUE",
59
+ * // status: "STRING_VALUE", // required
60
+ * // workspaceRoleArn: "STRING_VALUE",
61
+ * // licenseType: "STRING_VALUE",
62
+ * // freeTrialConsumed: true || false,
63
+ * // licenseExpiration: new Date("TIMESTAMP"),
64
+ * // freeTrialExpiration: new Date("TIMESTAMP"),
65
+ * // authentication: { // AuthenticationSummary
66
+ * // providers: [ // AuthenticationProviders // required
67
+ * // "STRING_VALUE",
68
+ * // ],
69
+ * // samlConfigurationStatus: "STRING_VALUE",
70
+ * // },
71
+ * // tags: { // TagMap
72
+ * // "<keys>": "STRING_VALUE",
73
+ * // },
74
+ * // vpcConfiguration: { // VpcConfiguration
75
+ * // securityGroupIds: [ // SecurityGroupIds // required
76
+ * // "STRING_VALUE",
77
+ * // ],
78
+ * // subnetIds: [ // SubnetIds // required
79
+ * // "STRING_VALUE",
80
+ * // ],
81
+ * // },
82
+ * // networkAccessControl: { // NetworkAccessConfiguration
83
+ * // prefixListIds: [ // PrefixListIds // required
84
+ * // "STRING_VALUE",
85
+ * // ],
86
+ * // vpceIds: [ // VpceIds // required
87
+ * // "STRING_VALUE",
88
+ * // ],
89
+ * // },
90
+ * // },
91
+ * // };
92
+ *
37
93
  * ```
38
94
  *
39
95
  * @param AssociateLicenseCommandInput - {@link AssociateLicenseCommandInput}
@@ -57,6 +113,8 @@ export interface AssociateLicenseCommandOutput extends AssociateLicenseResponse,
57
113
  * @throws {@link ValidationException} (client fault)
58
114
  * <p>The value of a parameter in the request caused an error.</p>
59
115
  *
116
+ * @throws {@link GrafanaServiceException}
117
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
60
118
  *
61
119
  */
62
120
  export declare class AssociateLicenseCommand extends $Command<AssociateLicenseCommandInput, AssociateLicenseCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/CreateWorkspaceApiKeyCommand.d.ts CHANGED
@@ -36,6 +36,12 @@ export interface CreateWorkspaceApiKeyCommandOutput extends CreateWorkspaceApiKe
36
36
  * };
37
37
  * const command = new CreateWorkspaceApiKeyCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // CreateWorkspaceApiKeyResponse
40
+ * // keyName: "STRING_VALUE", // required
41
+ * // key: "STRING_VALUE", // required
42
+ * // workspaceId: "STRING_VALUE", // required
43
+ * // };
44
+ *
39
45
  * ```
40
46
  *
41
47
  * @param CreateWorkspaceApiKeyCommandInput - {@link CreateWorkspaceApiKeyCommandInput}
@@ -65,6 +71,8 @@ export interface CreateWorkspaceApiKeyCommandOutput extends CreateWorkspaceApiKe
65
71
  * @throws {@link ValidationException} (client fault)
66
72
  * <p>The value of a parameter in the request caused an error.</p>
67
73
  *
74
+ * @throws {@link GrafanaServiceException}
75
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
68
76
  *
69
77
  */
70
78
  export declare class CreateWorkspaceApiKeyCommand extends $Command<CreateWorkspaceApiKeyCommandInput, CreateWorkspaceApiKeyCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/CreateWorkspaceCommand.d.ts CHANGED
@@ -75,6 +75,62 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
75
75
  * };
76
76
  * const command = new CreateWorkspaceCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // { // CreateWorkspaceResponse
79
+ * // workspace: { // WorkspaceDescription
80
+ * // accountAccessType: "STRING_VALUE",
81
+ * // created: new Date("TIMESTAMP"), // required
82
+ * // dataSources: [ // DataSourceTypesList // required
83
+ * // "STRING_VALUE",
84
+ * // ],
85
+ * // description: "STRING_VALUE",
86
+ * // endpoint: "STRING_VALUE", // required
87
+ * // grafanaVersion: "STRING_VALUE", // required
88
+ * // id: "STRING_VALUE", // required
89
+ * // modified: new Date("TIMESTAMP"), // required
90
+ * // name: "STRING_VALUE",
91
+ * // organizationRoleName: "STRING_VALUE",
92
+ * // notificationDestinations: [ // NotificationDestinationsList
93
+ * // "STRING_VALUE",
94
+ * // ],
95
+ * // organizationalUnits: [ // OrganizationalUnitList
96
+ * // "STRING_VALUE",
97
+ * // ],
98
+ * // permissionType: "STRING_VALUE",
99
+ * // stackSetName: "STRING_VALUE",
100
+ * // status: "STRING_VALUE", // required
101
+ * // workspaceRoleArn: "STRING_VALUE",
102
+ * // licenseType: "STRING_VALUE",
103
+ * // freeTrialConsumed: true || false,
104
+ * // licenseExpiration: new Date("TIMESTAMP"),
105
+ * // freeTrialExpiration: new Date("TIMESTAMP"),
106
+ * // authentication: { // AuthenticationSummary
107
+ * // providers: [ // AuthenticationProviders // required
108
+ * // "STRING_VALUE",
109
+ * // ],
110
+ * // samlConfigurationStatus: "STRING_VALUE",
111
+ * // },
112
+ * // tags: { // TagMap
113
+ * // "<keys>": "STRING_VALUE",
114
+ * // },
115
+ * // vpcConfiguration: { // VpcConfiguration
116
+ * // securityGroupIds: [ // SecurityGroupIds // required
117
+ * // "STRING_VALUE",
118
+ * // ],
119
+ * // subnetIds: [ // SubnetIds // required
120
+ * // "STRING_VALUE",
121
+ * // ],
122
+ * // },
123
+ * // networkAccessControl: { // NetworkAccessConfiguration
124
+ * // prefixListIds: [ // PrefixListIds // required
125
+ * // "STRING_VALUE",
126
+ * // ],
127
+ * // vpceIds: [ // VpceIds // required
128
+ * // "STRING_VALUE",
129
+ * // ],
130
+ * // },
131
+ * // },
132
+ * // };
133
+ *
78
134
  * ```
79
135
  *
80
136
  * @param CreateWorkspaceCommandInput - {@link CreateWorkspaceCommandInput}
@@ -101,6 +157,8 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
101
157
  * @throws {@link ValidationException} (client fault)
102
158
  * <p>The value of a parameter in the request caused an error.</p>
103
159
  *
160
+ * @throws {@link GrafanaServiceException}
161
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
104
162
  *
105
163
  */
106
164
  export declare class CreateWorkspaceCommand extends $Command<CreateWorkspaceCommandInput, CreateWorkspaceCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/DeleteWorkspaceApiKeyCommand.d.ts CHANGED
@@ -32,6 +32,11 @@ export interface DeleteWorkspaceApiKeyCommandOutput extends DeleteWorkspaceApiKe
32
32
  * };
33
33
  * const command = new DeleteWorkspaceApiKeyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeleteWorkspaceApiKeyResponse
36
+ * // keyName: "STRING_VALUE", // required
37
+ * // workspaceId: "STRING_VALUE", // required
38
+ * // };
39
+ *
35
40
  * ```
36
41
  *
37
42
  * @param DeleteWorkspaceApiKeyCommandInput - {@link DeleteWorkspaceApiKeyCommandInput}
@@ -58,6 +63,8 @@ export interface DeleteWorkspaceApiKeyCommandOutput extends DeleteWorkspaceApiKe
58
63
  * @throws {@link ValidationException} (client fault)
59
64
  * <p>The value of a parameter in the request caused an error.</p>
60
65
  *
66
+ * @throws {@link GrafanaServiceException}
67
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
61
68
  *
62
69
  */
63
70
  export declare class DeleteWorkspaceApiKeyCommand extends $Command<DeleteWorkspaceApiKeyCommandInput, DeleteWorkspaceApiKeyCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/DeleteWorkspaceCommand.d.ts CHANGED
@@ -31,6 +31,62 @@ export interface DeleteWorkspaceCommandOutput extends DeleteWorkspaceResponse, _
31
31
  * };
32
32
  * const command = new DeleteWorkspaceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteWorkspaceResponse
35
+ * // workspace: { // WorkspaceDescription
36
+ * // accountAccessType: "STRING_VALUE",
37
+ * // created: new Date("TIMESTAMP"), // required
38
+ * // dataSources: [ // DataSourceTypesList // required
39
+ * // "STRING_VALUE",
40
+ * // ],
41
+ * // description: "STRING_VALUE",
42
+ * // endpoint: "STRING_VALUE", // required
43
+ * // grafanaVersion: "STRING_VALUE", // required
44
+ * // id: "STRING_VALUE", // required
45
+ * // modified: new Date("TIMESTAMP"), // required
46
+ * // name: "STRING_VALUE",
47
+ * // organizationRoleName: "STRING_VALUE",
48
+ * // notificationDestinations: [ // NotificationDestinationsList
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // organizationalUnits: [ // OrganizationalUnitList
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // permissionType: "STRING_VALUE",
55
+ * // stackSetName: "STRING_VALUE",
56
+ * // status: "STRING_VALUE", // required
57
+ * // workspaceRoleArn: "STRING_VALUE",
58
+ * // licenseType: "STRING_VALUE",
59
+ * // freeTrialConsumed: true || false,
60
+ * // licenseExpiration: new Date("TIMESTAMP"),
61
+ * // freeTrialExpiration: new Date("TIMESTAMP"),
62
+ * // authentication: { // AuthenticationSummary
63
+ * // providers: [ // AuthenticationProviders // required
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // samlConfigurationStatus: "STRING_VALUE",
67
+ * // },
68
+ * // tags: { // TagMap
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // vpcConfiguration: { // VpcConfiguration
72
+ * // securityGroupIds: [ // SecurityGroupIds // required
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // subnetIds: [ // SubnetIds // required
76
+ * // "STRING_VALUE",
77
+ * // ],
78
+ * // },
79
+ * // networkAccessControl: { // NetworkAccessConfiguration
80
+ * // prefixListIds: [ // PrefixListIds // required
81
+ * // "STRING_VALUE",
82
+ * // ],
83
+ * // vpceIds: [ // VpceIds // required
84
+ * // "STRING_VALUE",
85
+ * // ],
86
+ * // },
87
+ * // },
88
+ * // };
89
+ *
34
90
  * ```
35
91
  *
36
92
  * @param DeleteWorkspaceCommandInput - {@link DeleteWorkspaceCommandInput}
@@ -57,6 +113,8 @@ export interface DeleteWorkspaceCommandOutput extends DeleteWorkspaceResponse, _
57
113
  * @throws {@link ValidationException} (client fault)
58
114
  * <p>The value of a parameter in the request caused an error.</p>
59
115
  *
116
+ * @throws {@link GrafanaServiceException}
117
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
60
118
  *
61
119
  */
62
120
  export declare class DeleteWorkspaceCommand extends $Command<DeleteWorkspaceCommandInput, DeleteWorkspaceCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/DescribeWorkspaceAuthenticationCommand.d.ts CHANGED
@@ -32,6 +32,46 @@ export interface DescribeWorkspaceAuthenticationCommandOutput extends DescribeWo
32
32
  * };
33
33
  * const command = new DescribeWorkspaceAuthenticationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeWorkspaceAuthenticationResponse
36
+ * // authentication: { // AuthenticationDescription
37
+ * // providers: [ // AuthenticationProviders // required
38
+ * // "STRING_VALUE",
39
+ * // ],
40
+ * // saml: { // SamlAuthentication
41
+ * // status: "STRING_VALUE", // required
42
+ * // configuration: { // SamlConfiguration
43
+ * // idpMetadata: { // IdpMetadata Union: only one key present
44
+ * // url: "STRING_VALUE",
45
+ * // xml: "STRING_VALUE",
46
+ * // },
47
+ * // assertionAttributes: { // AssertionAttributes
48
+ * // name: "STRING_VALUE",
49
+ * // login: "STRING_VALUE",
50
+ * // email: "STRING_VALUE",
51
+ * // groups: "STRING_VALUE",
52
+ * // role: "STRING_VALUE",
53
+ * // org: "STRING_VALUE",
54
+ * // },
55
+ * // roleValues: { // RoleValues
56
+ * // editor: [ // RoleValueList
57
+ * // "STRING_VALUE",
58
+ * // ],
59
+ * // admin: [
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // },
63
+ * // allowedOrganizations: [ // AllowedOrganizations
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // loginValidityDuration: Number("int"),
67
+ * // },
68
+ * // },
69
+ * // awsSso: { // AwsSsoAuthentication
70
+ * // ssoClientId: "STRING_VALUE",
71
+ * // },
72
+ * // },
73
+ * // };
74
+ *
35
75
  * ```
36
76
  *
37
77
  * @param DescribeWorkspaceAuthenticationCommandInput - {@link DescribeWorkspaceAuthenticationCommandInput}
@@ -55,6 +95,8 @@ export interface DescribeWorkspaceAuthenticationCommandOutput extends DescribeWo
55
95
  * @throws {@link ValidationException} (client fault)
56
96
  * <p>The value of a parameter in the request caused an error.</p>
57
97
  *
98
+ * @throws {@link GrafanaServiceException}
99
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
58
100
  *
59
101
  */
60
102
  export declare class DescribeWorkspaceAuthenticationCommand extends $Command<DescribeWorkspaceAuthenticationCommandInput, DescribeWorkspaceAuthenticationCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/DescribeWorkspaceCommand.d.ts CHANGED
@@ -31,6 +31,62 @@ export interface DescribeWorkspaceCommandOutput extends DescribeWorkspaceRespons
31
31
  * };
32
32
  * const command = new DescribeWorkspaceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeWorkspaceResponse
35
+ * // workspace: { // WorkspaceDescription
36
+ * // accountAccessType: "STRING_VALUE",
37
+ * // created: new Date("TIMESTAMP"), // required
38
+ * // dataSources: [ // DataSourceTypesList // required
39
+ * // "STRING_VALUE",
40
+ * // ],
41
+ * // description: "STRING_VALUE",
42
+ * // endpoint: "STRING_VALUE", // required
43
+ * // grafanaVersion: "STRING_VALUE", // required
44
+ * // id: "STRING_VALUE", // required
45
+ * // modified: new Date("TIMESTAMP"), // required
46
+ * // name: "STRING_VALUE",
47
+ * // organizationRoleName: "STRING_VALUE",
48
+ * // notificationDestinations: [ // NotificationDestinationsList
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // organizationalUnits: [ // OrganizationalUnitList
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // permissionType: "STRING_VALUE",
55
+ * // stackSetName: "STRING_VALUE",
56
+ * // status: "STRING_VALUE", // required
57
+ * // workspaceRoleArn: "STRING_VALUE",
58
+ * // licenseType: "STRING_VALUE",
59
+ * // freeTrialConsumed: true || false,
60
+ * // licenseExpiration: new Date("TIMESTAMP"),
61
+ * // freeTrialExpiration: new Date("TIMESTAMP"),
62
+ * // authentication: { // AuthenticationSummary
63
+ * // providers: [ // AuthenticationProviders // required
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // samlConfigurationStatus: "STRING_VALUE",
67
+ * // },
68
+ * // tags: { // TagMap
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // vpcConfiguration: { // VpcConfiguration
72
+ * // securityGroupIds: [ // SecurityGroupIds // required
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // subnetIds: [ // SubnetIds // required
76
+ * // "STRING_VALUE",
77
+ * // ],
78
+ * // },
79
+ * // networkAccessControl: { // NetworkAccessConfiguration
80
+ * // prefixListIds: [ // PrefixListIds // required
81
+ * // "STRING_VALUE",
82
+ * // ],
83
+ * // vpceIds: [ // VpceIds // required
84
+ * // "STRING_VALUE",
85
+ * // ],
86
+ * // },
87
+ * // },
88
+ * // };
89
+ *
34
90
  * ```
35
91
  *
36
92
  * @param DescribeWorkspaceCommandInput - {@link DescribeWorkspaceCommandInput}
@@ -54,6 +110,8 @@ export interface DescribeWorkspaceCommandOutput extends DescribeWorkspaceRespons
54
110
  * @throws {@link ValidationException} (client fault)
55
111
  * <p>The value of a parameter in the request caused an error.</p>
56
112
  *
113
+ * @throws {@link GrafanaServiceException}
114
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
57
115
  *
58
116
  */
59
117
  export declare class DescribeWorkspaceCommand extends $Command<DescribeWorkspaceCommandInput, DescribeWorkspaceCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/DescribeWorkspaceConfigurationCommand.d.ts CHANGED
@@ -31,6 +31,10 @@ export interface DescribeWorkspaceConfigurationCommandOutput extends DescribeWor
31
31
  * };
32
32
  * const command = new DescribeWorkspaceConfigurationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeWorkspaceConfigurationResponse
35
+ * // configuration: "STRING_VALUE", // required
36
+ * // };
37
+ *
34
38
  * ```
35
39
  *
36
40
  * @param DescribeWorkspaceConfigurationCommandInput - {@link DescribeWorkspaceConfigurationCommandInput}
@@ -51,6 +55,8 @@ export interface DescribeWorkspaceConfigurationCommandOutput extends DescribeWor
51
55
  * @throws {@link ThrottlingException} (client fault)
52
56
  * <p>The request was denied because of request throttling. Retry the request.</p>
53
57
  *
58
+ * @throws {@link GrafanaServiceException}
59
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
54
60
  *
55
61
  */
56
62
  export declare class DescribeWorkspaceConfigurationCommand extends $Command<DescribeWorkspaceConfigurationCommandInput, DescribeWorkspaceConfigurationCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/DisassociateLicenseCommand.d.ts CHANGED
@@ -32,6 +32,62 @@ export interface DisassociateLicenseCommandOutput extends DisassociateLicenseRes
32
32
  * };
33
33
  * const command = new DisassociateLicenseCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DisassociateLicenseResponse
36
+ * // workspace: { // WorkspaceDescription
37
+ * // accountAccessType: "STRING_VALUE",
38
+ * // created: new Date("TIMESTAMP"), // required
39
+ * // dataSources: [ // DataSourceTypesList // required
40
+ * // "STRING_VALUE",
41
+ * // ],
42
+ * // description: "STRING_VALUE",
43
+ * // endpoint: "STRING_VALUE", // required
44
+ * // grafanaVersion: "STRING_VALUE", // required
45
+ * // id: "STRING_VALUE", // required
46
+ * // modified: new Date("TIMESTAMP"), // required
47
+ * // name: "STRING_VALUE",
48
+ * // organizationRoleName: "STRING_VALUE",
49
+ * // notificationDestinations: [ // NotificationDestinationsList
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // organizationalUnits: [ // OrganizationalUnitList
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // permissionType: "STRING_VALUE",
56
+ * // stackSetName: "STRING_VALUE",
57
+ * // status: "STRING_VALUE", // required
58
+ * // workspaceRoleArn: "STRING_VALUE",
59
+ * // licenseType: "STRING_VALUE",
60
+ * // freeTrialConsumed: true || false,
61
+ * // licenseExpiration: new Date("TIMESTAMP"),
62
+ * // freeTrialExpiration: new Date("TIMESTAMP"),
63
+ * // authentication: { // AuthenticationSummary
64
+ * // providers: [ // AuthenticationProviders // required
65
+ * // "STRING_VALUE",
66
+ * // ],
67
+ * // samlConfigurationStatus: "STRING_VALUE",
68
+ * // },
69
+ * // tags: { // TagMap
70
+ * // "<keys>": "STRING_VALUE",
71
+ * // },
72
+ * // vpcConfiguration: { // VpcConfiguration
73
+ * // securityGroupIds: [ // SecurityGroupIds // required
74
+ * // "STRING_VALUE",
75
+ * // ],
76
+ * // subnetIds: [ // SubnetIds // required
77
+ * // "STRING_VALUE",
78
+ * // ],
79
+ * // },
80
+ * // networkAccessControl: { // NetworkAccessConfiguration
81
+ * // prefixListIds: [ // PrefixListIds // required
82
+ * // "STRING_VALUE",
83
+ * // ],
84
+ * // vpceIds: [ // VpceIds // required
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // },
88
+ * // },
89
+ * // };
90
+ *
35
91
  * ```
36
92
  *
37
93
  * @param DisassociateLicenseCommandInput - {@link DisassociateLicenseCommandInput}
@@ -55,6 +111,8 @@ export interface DisassociateLicenseCommandOutput extends DisassociateLicenseRes
55
111
  * @throws {@link ValidationException} (client fault)
56
112
  * <p>The value of a parameter in the request caused an error.</p>
57
113
  *
114
+ * @throws {@link GrafanaServiceException}
115
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
58
116
  *
59
117
  */
60
118
  export declare class DisassociateLicenseCommand extends $Command<DisassociateLicenseCommandInput, DisassociateLicenseCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/ListPermissionsCommand.d.ts CHANGED
@@ -41,6 +41,19 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
41
41
  * };
42
42
  * const command = new ListPermissionsCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // ListPermissionsResponse
45
+ * // nextToken: "STRING_VALUE",
46
+ * // permissions: [ // PermissionEntryList // required
47
+ * // { // PermissionEntry
48
+ * // user: { // User
49
+ * // id: "STRING_VALUE", // required
50
+ * // type: "STRING_VALUE", // required
51
+ * // },
52
+ * // role: "STRING_VALUE", // required
53
+ * // },
54
+ * // ],
55
+ * // };
56
+ *
44
57
  * ```
45
58
  *
46
59
  * @param ListPermissionsCommandInput - {@link ListPermissionsCommandInput}
@@ -64,6 +77,8 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
64
77
  * @throws {@link ValidationException} (client fault)
65
78
  * <p>The value of a parameter in the request caused an error.</p>
66
79
  *
80
+ * @throws {@link GrafanaServiceException}
81
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
67
82
  *
68
83
  */
69
84
  export declare class ListPermissionsCommand extends $Command<ListPermissionsCommandInput, ListPermissionsCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/ListTagsForResourceCommand.d.ts CHANGED
@@ -34,6 +34,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
34
34
  * };
35
35
  * const command = new ListTagsForResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListTagsForResourceResponse
38
+ * // tags: { // TagMap
39
+ * // "<keys>": "STRING_VALUE",
40
+ * // },
41
+ * // };
42
+ *
37
43
  * ```
38
44
  *
39
45
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -57,6 +63,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
57
63
  * @throws {@link ValidationException} (client fault)
58
64
  * <p>The value of a parameter in the request caused an error.</p>
59
65
  *
66
+ * @throws {@link GrafanaServiceException}
67
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
60
68
  *
61
69
  */
62
70
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/ListWorkspacesCommand.d.ts CHANGED
@@ -33,6 +33,34 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M
33
33
  * };
34
34
  * const command = new ListWorkspacesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListWorkspacesResponse
37
+ * // workspaces: [ // WorkspaceList // required
38
+ * // { // WorkspaceSummary
39
+ * // created: new Date("TIMESTAMP"), // required
40
+ * // description: "STRING_VALUE",
41
+ * // endpoint: "STRING_VALUE", // required
42
+ * // grafanaVersion: "STRING_VALUE", // required
43
+ * // id: "STRING_VALUE", // required
44
+ * // modified: new Date("TIMESTAMP"), // required
45
+ * // name: "STRING_VALUE",
46
+ * // notificationDestinations: [ // NotificationDestinationsList
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // status: "STRING_VALUE", // required
50
+ * // authentication: { // AuthenticationSummary
51
+ * // providers: [ // AuthenticationProviders // required
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // samlConfigurationStatus: "STRING_VALUE",
55
+ * // },
56
+ * // tags: { // TagMap
57
+ * // "<keys>": "STRING_VALUE",
58
+ * // },
59
+ * // },
60
+ * // ],
61
+ * // nextToken: "STRING_VALUE",
62
+ * // };
63
+ *
36
64
  * ```
37
65
  *
38
66
  * @param ListWorkspacesCommandInput - {@link ListWorkspacesCommandInput}
@@ -50,6 +78,8 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M
50
78
  * @throws {@link ThrottlingException} (client fault)
51
79
  * <p>The request was denied because of request throttling. Retry the request.</p>
52
80
  *
81
+ * @throws {@link GrafanaServiceException}
82
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
53
83
  *
54
84
  */
55
85
  export declare class ListWorkspacesCommand extends $Command<ListWorkspacesCommandInput, ListWorkspacesCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/TagResourceCommand.d.ts CHANGED
@@ -39,6 +39,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
39
39
  * };
40
40
  * const command = new TagResourceCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // {};
43
+ *
42
44
  * ```
43
45
  *
44
46
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -62,6 +64,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
62
64
  * @throws {@link ValidationException} (client fault)
63
65
  * <p>The value of a parameter in the request caused an error.</p>
64
66
  *
67
+ * @throws {@link GrafanaServiceException}
68
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
65
69
  *
66
70
  */
67
71
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/UntagResourceCommand.d.ts CHANGED
@@ -35,6 +35,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
35
35
  * };
36
36
  * const command = new UntagResourceCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -58,6 +60,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
58
60
  * @throws {@link ValidationException} (client fault)
59
61
  * <p>The value of a parameter in the request caused an error.</p>
60
62
  *
63
+ * @throws {@link GrafanaServiceException}
64
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
61
65
  *
62
66
  */
63
67
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/UpdatePermissionsCommand.d.ts CHANGED
@@ -44,6 +44,25 @@ export interface UpdatePermissionsCommandOutput extends UpdatePermissionsRespons
44
44
  * };
45
45
  * const command = new UpdatePermissionsCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // UpdatePermissionsResponse
48
+ * // errors: [ // UpdateErrorList // required
49
+ * // { // UpdateError
50
+ * // code: Number("int"), // required
51
+ * // message: "STRING_VALUE", // required
52
+ * // causedBy: { // UpdateInstruction
53
+ * // action: "STRING_VALUE", // required
54
+ * // role: "STRING_VALUE", // required
55
+ * // users: [ // UserList // required
56
+ * // { // User
57
+ * // id: "STRING_VALUE", // required
58
+ * // type: "STRING_VALUE", // required
59
+ * // },
60
+ * // ],
61
+ * // },
62
+ * // },
63
+ * // ],
64
+ * // };
65
+ *
47
66
  * ```
48
67
  *
49
68
  * @param UpdatePermissionsCommandInput - {@link UpdatePermissionsCommandInput}
@@ -67,6 +86,8 @@ export interface UpdatePermissionsCommandOutput extends UpdatePermissionsRespons
67
86
  * @throws {@link ValidationException} (client fault)
68
87
  * <p>The value of a parameter in the request caused an error.</p>
69
88
  *
89
+ * @throws {@link GrafanaServiceException}
90
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
70
91
  *
71
92
  */
72
93
  export declare class UpdatePermissionsCommand extends $Command<UpdatePermissionsCommandInput, UpdatePermissionsCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/UpdateWorkspaceAuthenticationCommand.d.ts CHANGED
@@ -67,6 +67,46 @@ export interface UpdateWorkspaceAuthenticationCommandOutput extends UpdateWorksp
67
67
  * };
68
68
  * const command = new UpdateWorkspaceAuthenticationCommand(input);
69
69
  * const response = await client.send(command);
70
+ * // { // UpdateWorkspaceAuthenticationResponse
71
+ * // authentication: { // AuthenticationDescription
72
+ * // providers: [ // AuthenticationProviders // required
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // saml: { // SamlAuthentication
76
+ * // status: "STRING_VALUE", // required
77
+ * // configuration: { // SamlConfiguration
78
+ * // idpMetadata: { // IdpMetadata Union: only one key present
79
+ * // url: "STRING_VALUE",
80
+ * // xml: "STRING_VALUE",
81
+ * // },
82
+ * // assertionAttributes: { // AssertionAttributes
83
+ * // name: "STRING_VALUE",
84
+ * // login: "STRING_VALUE",
85
+ * // email: "STRING_VALUE",
86
+ * // groups: "STRING_VALUE",
87
+ * // role: "STRING_VALUE",
88
+ * // org: "STRING_VALUE",
89
+ * // },
90
+ * // roleValues: { // RoleValues
91
+ * // editor: [ // RoleValueList
92
+ * // "STRING_VALUE",
93
+ * // ],
94
+ * // admin: [
95
+ * // "STRING_VALUE",
96
+ * // ],
97
+ * // },
98
+ * // allowedOrganizations: [ // AllowedOrganizations
99
+ * // "STRING_VALUE",
100
+ * // ],
101
+ * // loginValidityDuration: Number("int"),
102
+ * // },
103
+ * // },
104
+ * // awsSso: { // AwsSsoAuthentication
105
+ * // ssoClientId: "STRING_VALUE",
106
+ * // },
107
+ * // },
108
+ * // };
109
+ *
70
110
  * ```
71
111
  *
72
112
  * @param UpdateWorkspaceAuthenticationCommandInput - {@link UpdateWorkspaceAuthenticationCommandInput}
@@ -93,6 +133,8 @@ export interface UpdateWorkspaceAuthenticationCommandOutput extends UpdateWorksp
93
133
  * @throws {@link ValidationException} (client fault)
94
134
  * <p>The value of a parameter in the request caused an error.</p>
95
135
  *
136
+ * @throws {@link GrafanaServiceException}
137
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
96
138
  *
97
139
  */
98
140
  export declare class UpdateWorkspaceAuthenticationCommand extends $Command<UpdateWorkspaceAuthenticationCommandInput, UpdateWorkspaceAuthenticationCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/UpdateWorkspaceCommand.d.ts CHANGED
@@ -70,6 +70,62 @@ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, _
70
70
  * };
71
71
  * const command = new UpdateWorkspaceCommand(input);
72
72
  * const response = await client.send(command);
73
+ * // { // UpdateWorkspaceResponse
74
+ * // workspace: { // WorkspaceDescription
75
+ * // accountAccessType: "STRING_VALUE",
76
+ * // created: new Date("TIMESTAMP"), // required
77
+ * // dataSources: [ // DataSourceTypesList // required
78
+ * // "STRING_VALUE",
79
+ * // ],
80
+ * // description: "STRING_VALUE",
81
+ * // endpoint: "STRING_VALUE", // required
82
+ * // grafanaVersion: "STRING_VALUE", // required
83
+ * // id: "STRING_VALUE", // required
84
+ * // modified: new Date("TIMESTAMP"), // required
85
+ * // name: "STRING_VALUE",
86
+ * // organizationRoleName: "STRING_VALUE",
87
+ * // notificationDestinations: [ // NotificationDestinationsList
88
+ * // "STRING_VALUE",
89
+ * // ],
90
+ * // organizationalUnits: [ // OrganizationalUnitList
91
+ * // "STRING_VALUE",
92
+ * // ],
93
+ * // permissionType: "STRING_VALUE",
94
+ * // stackSetName: "STRING_VALUE",
95
+ * // status: "STRING_VALUE", // required
96
+ * // workspaceRoleArn: "STRING_VALUE",
97
+ * // licenseType: "STRING_VALUE",
98
+ * // freeTrialConsumed: true || false,
99
+ * // licenseExpiration: new Date("TIMESTAMP"),
100
+ * // freeTrialExpiration: new Date("TIMESTAMP"),
101
+ * // authentication: { // AuthenticationSummary
102
+ * // providers: [ // AuthenticationProviders // required
103
+ * // "STRING_VALUE",
104
+ * // ],
105
+ * // samlConfigurationStatus: "STRING_VALUE",
106
+ * // },
107
+ * // tags: { // TagMap
108
+ * // "<keys>": "STRING_VALUE",
109
+ * // },
110
+ * // vpcConfiguration: { // VpcConfiguration
111
+ * // securityGroupIds: [ // SecurityGroupIds // required
112
+ * // "STRING_VALUE",
113
+ * // ],
114
+ * // subnetIds: [ // SubnetIds // required
115
+ * // "STRING_VALUE",
116
+ * // ],
117
+ * // },
118
+ * // networkAccessControl: { // NetworkAccessConfiguration
119
+ * // prefixListIds: [ // PrefixListIds // required
120
+ * // "STRING_VALUE",
121
+ * // ],
122
+ * // vpceIds: [ // VpceIds // required
123
+ * // "STRING_VALUE",
124
+ * // ],
125
+ * // },
126
+ * // },
127
+ * // };
128
+ *
73
129
  * ```
74
130
  *
75
131
  * @param UpdateWorkspaceCommandInput - {@link UpdateWorkspaceCommandInput}
@@ -96,6 +152,8 @@ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, _
96
152
  * @throws {@link ValidationException} (client fault)
97
153
  * <p>The value of a parameter in the request caused an error.</p>
98
154
  *
155
+ * @throws {@link GrafanaServiceException}
156
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
99
157
  *
100
158
  */
101
159
  export declare class UpdateWorkspaceCommand extends $Command<UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput, GrafanaClientResolvedConfig> {
package/dist-types/commands/UpdateWorkspaceConfigurationCommand.d.ts CHANGED
@@ -32,6 +32,8 @@ export interface UpdateWorkspaceConfigurationCommandOutput extends UpdateWorkspa
32
32
  * };
33
33
  * const command = new UpdateWorkspaceConfigurationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param UpdateWorkspaceConfigurationCommandInput - {@link UpdateWorkspaceConfigurationCommandInput}
@@ -58,6 +60,8 @@ export interface UpdateWorkspaceConfigurationCommandOutput extends UpdateWorkspa
58
60
  * @throws {@link ValidationException} (client fault)
59
61
  * <p>The value of a parameter in the request caused an error.</p>
60
62
  *
63
+ * @throws {@link GrafanaServiceException}
64
+ * <p>Base exception class for all service exceptions from Grafana service.</p>
61
65
  *
62
66
  */
63
67
  export declare class UpdateWorkspaceConfigurationCommand extends $Command<UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput, GrafanaClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-grafana",
3
3
  "description": "AWS SDK for JavaScript Grafana Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",