@aws-sdk/client-amp 3.509.0 → 3.511.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 +18 -1
- package/dist-types/Amp.d.ts +18 -1
- package/dist-types/AmpClient.d.ts +18 -1
- package/dist-types/commands/CreateAlertManagerDefinitionCommand.d.ts +12 -8
- package/dist-types/commands/CreateLoggingConfigurationCommand.d.ts +8 -5
- package/dist-types/commands/CreateRuleGroupsNamespaceCommand.d.ts +13 -8
- package/dist-types/commands/CreateScraperCommand.d.ts +26 -8
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +10 -7
- package/dist-types/commands/DeleteAlertManagerDefinitionCommand.d.ts +8 -7
- package/dist-types/commands/DeleteLoggingConfigurationCommand.d.ts +7 -6
- package/dist-types/commands/DeleteRuleGroupsNamespaceCommand.d.ts +8 -7
- package/dist-types/commands/DeleteScraperCommand.d.ts +9 -7
- package/dist-types/commands/DeleteWorkspaceCommand.d.ts +12 -7
- package/dist-types/commands/DescribeAlertManagerDefinitionCommand.d.ts +8 -6
- package/dist-types/commands/DescribeLoggingConfigurationCommand.d.ts +7 -5
- package/dist-types/commands/DescribeRuleGroupsNamespaceCommand.d.ts +8 -6
- package/dist-types/commands/DescribeScraperCommand.d.ts +8 -6
- package/dist-types/commands/DescribeWorkspaceCommand.d.ts +7 -6
- package/dist-types/commands/GetDefaultScraperConfigurationCommand.d.ts +5 -4
- package/dist-types/commands/ListRuleGroupsNamespacesCommand.d.ts +7 -6
- package/dist-types/commands/ListScrapersCommand.d.ts +8 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +9 -6
- package/dist-types/commands/ListWorkspacesCommand.d.ts +7 -5
- package/dist-types/commands/PutAlertManagerDefinitionCommand.d.ts +11 -8
- package/dist-types/commands/PutRuleGroupsNamespaceCommand.d.ts +15 -8
- package/dist-types/commands/TagResourceCommand.d.ts +13 -6
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -6
- package/dist-types/commands/UpdateLoggingConfigurationCommand.d.ts +8 -6
- package/dist-types/commands/UpdateWorkspaceAliasCommand.d.ts +9 -8
- package/dist-types/index.d.ts +18 -1
- package/dist-types/models/models_0.d.ts +360 -260
- package/package.json +14 -14
package/README.md
CHANGED
|
@@ -6,7 +6,24 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript Amp Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
Amazon Managed Service for Prometheus
|
|
9
|
+
<p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
|
|
10
|
+
container metrics that makes it easier to securely monitor container environments at
|
|
11
|
+
scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
|
|
12
|
+
model and query language that you use today to monitor the performance of your
|
|
13
|
+
containerized workloads, and also enjoy improved scalability, availability, and security
|
|
14
|
+
without having to manage the underlying infrastructure.</p>
|
|
15
|
+
<p>For more information about Amazon Managed Service for Prometheus, see the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html">Amazon Managed Service for Prometheus</a> User Guide.</p>
|
|
16
|
+
<p>Amazon Managed Service for Prometheus includes two APIs.</p>
|
|
17
|
+
<ul>
|
|
18
|
+
<li>
|
|
19
|
+
<p>Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert
|
|
20
|
+
managers.</p>
|
|
21
|
+
</li>
|
|
22
|
+
<li>
|
|
23
|
+
<p>Use the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis">Prometheus-compatible API</a> to work within your Prometheus
|
|
24
|
+
workspace.</p>
|
|
25
|
+
</li>
|
|
26
|
+
</ul>
|
|
10
27
|
|
|
11
28
|
## Installing
|
|
12
29
|
|
package/dist-types/Amp.d.ts
CHANGED
|
@@ -186,7 +186,24 @@ export interface Amp {
|
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
188
188
|
* @public
|
|
189
|
-
* Amazon Managed Service for Prometheus
|
|
189
|
+
* <p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
|
|
190
|
+
* container metrics that makes it easier to securely monitor container environments at
|
|
191
|
+
* scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
|
|
192
|
+
* model and query language that you use today to monitor the performance of your
|
|
193
|
+
* containerized workloads, and also enjoy improved scalability, availability, and security
|
|
194
|
+
* without having to manage the underlying infrastructure.</p>
|
|
195
|
+
* <p>For more information about Amazon Managed Service for Prometheus, see the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html">Amazon Managed Service for Prometheus</a> User Guide.</p>
|
|
196
|
+
* <p>Amazon Managed Service for Prometheus includes two APIs.</p>
|
|
197
|
+
* <ul>
|
|
198
|
+
* <li>
|
|
199
|
+
* <p>Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert
|
|
200
|
+
* managers.</p>
|
|
201
|
+
* </li>
|
|
202
|
+
* <li>
|
|
203
|
+
* <p>Use the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis">Prometheus-compatible API</a> to work within your Prometheus
|
|
204
|
+
* workspace.</p>
|
|
205
|
+
* </li>
|
|
206
|
+
* </ul>
|
|
190
207
|
*/
|
|
191
208
|
export declare class Amp extends AmpClient implements Amp {
|
|
192
209
|
}
|
|
@@ -178,7 +178,24 @@ export interface AmpClientResolvedConfig extends AmpClientResolvedConfigType {
|
|
|
178
178
|
}
|
|
179
179
|
/**
|
|
180
180
|
* @public
|
|
181
|
-
* Amazon Managed Service for Prometheus
|
|
181
|
+
* <p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
|
|
182
|
+
* container metrics that makes it easier to securely monitor container environments at
|
|
183
|
+
* scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
|
|
184
|
+
* model and query language that you use today to monitor the performance of your
|
|
185
|
+
* containerized workloads, and also enjoy improved scalability, availability, and security
|
|
186
|
+
* without having to manage the underlying infrastructure.</p>
|
|
187
|
+
* <p>For more information about Amazon Managed Service for Prometheus, see the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html">Amazon Managed Service for Prometheus</a> User Guide.</p>
|
|
188
|
+
* <p>Amazon Managed Service for Prometheus includes two APIs.</p>
|
|
189
|
+
* <ul>
|
|
190
|
+
* <li>
|
|
191
|
+
* <p>Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert
|
|
192
|
+
* managers.</p>
|
|
193
|
+
* </li>
|
|
194
|
+
* <li>
|
|
195
|
+
* <p>Use the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis">Prometheus-compatible API</a> to work within your Prometheus
|
|
196
|
+
* workspace.</p>
|
|
197
|
+
* </li>
|
|
198
|
+
* </ul>
|
|
182
199
|
*/
|
|
183
200
|
export declare class AmpClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, AmpClientResolvedConfig> {
|
|
184
201
|
/**
|
|
@@ -26,7 +26,10 @@ declare const CreateAlertManagerDefinitionCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
*
|
|
29
|
+
* <p>The <code>CreateAlertManagerDefinition</code> operation creates the alert manager
|
|
30
|
+
* definition in a workspace. If a workspace already has an alert manager definition, don't
|
|
31
|
+
* use this operation to update it. Instead, use
|
|
32
|
+
* <code>PutAlertManagerDefinition</code>.</p>
|
|
30
33
|
* @example
|
|
31
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
35
|
* ```javascript
|
|
@@ -56,25 +59,26 @@ declare const CreateAlertManagerDefinitionCommand_base: {
|
|
|
56
59
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
57
60
|
*
|
|
58
61
|
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
-
*
|
|
62
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
60
63
|
*
|
|
61
64
|
* @throws {@link ConflictException} (client fault)
|
|
62
|
-
*
|
|
65
|
+
* <p>The request would cause an inconsistent state.</p>
|
|
63
66
|
*
|
|
64
67
|
* @throws {@link InternalServerException} (server fault)
|
|
65
|
-
*
|
|
68
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
66
69
|
*
|
|
67
70
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
|
-
*
|
|
71
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
69
72
|
*
|
|
70
73
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
71
|
-
*
|
|
74
|
+
* <p>Completing the request would cause a service quota to be exceeded.</p>
|
|
72
75
|
*
|
|
73
76
|
* @throws {@link ThrottlingException} (client fault)
|
|
74
|
-
*
|
|
77
|
+
* <p>The request was denied due to request throttling.</p>
|
|
75
78
|
*
|
|
76
79
|
* @throws {@link ValidationException} (client fault)
|
|
77
|
-
* The input fails to satisfy the constraints specified by an
|
|
80
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
81
|
+
* service.</p>
|
|
78
82
|
*
|
|
79
83
|
* @throws {@link AmpServiceException}
|
|
80
84
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,9 @@ declare const CreateLoggingConfigurationCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
*
|
|
29
|
+
* <p>The <code>CreateLoggingConfiguration</code> operation creates a logging configuration
|
|
30
|
+
* for the workspace. Use this operation to set the CloudWatch log group to which
|
|
31
|
+
* the logs will be published to.</p>
|
|
30
32
|
* @example
|
|
31
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
34
|
* ```javascript
|
|
@@ -56,16 +58,17 @@ declare const CreateLoggingConfigurationCommand_base: {
|
|
|
56
58
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
57
59
|
*
|
|
58
60
|
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
-
*
|
|
61
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
60
62
|
*
|
|
61
63
|
* @throws {@link InternalServerException} (server fault)
|
|
62
|
-
*
|
|
64
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
63
65
|
*
|
|
64
66
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
-
*
|
|
67
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
66
68
|
*
|
|
67
69
|
* @throws {@link ValidationException} (client fault)
|
|
68
|
-
* The input fails to satisfy the constraints specified by an
|
|
70
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
71
|
+
* service.</p>
|
|
69
72
|
*
|
|
70
73
|
* @throws {@link AmpServiceException}
|
|
71
74
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,11 @@ declare const CreateRuleGroupsNamespaceCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
*
|
|
29
|
+
* <p>The <code>CreateRuleGroupsNamespace</code> operation creates a rule groups namespace
|
|
30
|
+
* within a workspace. A rule groups namespace is associated with exactly one rules file. A
|
|
31
|
+
* workspace can have multiple rule groups namespaces.</p>
|
|
32
|
+
* <p>Use this operation only to create new rule groups namespaces. To update an existing
|
|
33
|
+
* rule groups namespace, use <code>PutRuleGroupsNamespace</code>.</p>
|
|
30
34
|
* @example
|
|
31
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
36
|
* ```javascript
|
|
@@ -65,25 +69,26 @@ declare const CreateRuleGroupsNamespaceCommand_base: {
|
|
|
65
69
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
66
70
|
*
|
|
67
71
|
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
-
*
|
|
72
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
69
73
|
*
|
|
70
74
|
* @throws {@link ConflictException} (client fault)
|
|
71
|
-
*
|
|
75
|
+
* <p>The request would cause an inconsistent state.</p>
|
|
72
76
|
*
|
|
73
77
|
* @throws {@link InternalServerException} (server fault)
|
|
74
|
-
*
|
|
78
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
75
79
|
*
|
|
76
80
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
-
*
|
|
81
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
78
82
|
*
|
|
79
83
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
80
|
-
*
|
|
84
|
+
* <p>Completing the request would cause a service quota to be exceeded.</p>
|
|
81
85
|
*
|
|
82
86
|
* @throws {@link ThrottlingException} (client fault)
|
|
83
|
-
*
|
|
87
|
+
* <p>The request was denied due to request throttling.</p>
|
|
84
88
|
*
|
|
85
89
|
* @throws {@link ValidationException} (client fault)
|
|
86
|
-
* The input fails to satisfy the constraints specified by an
|
|
90
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
91
|
+
* service.</p>
|
|
87
92
|
*
|
|
88
93
|
* @throws {@link AmpServiceException}
|
|
89
94
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,24 @@ declare const CreateScraperCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
*
|
|
29
|
+
* <p>The <code>CreateScraper</code> operation creates a scraper to collect metrics. A
|
|
30
|
+
* scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS
|
|
31
|
+
* cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the
|
|
32
|
+
* scraper to control what metrics are collected, and what transformations are applied
|
|
33
|
+
* prior to sending them to your workspace.</p>
|
|
34
|
+
* <p>If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see
|
|
35
|
+
* <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper">Using roles for scraping metrics from EKS</a> in the <i>Amazon Managed Service for Prometheus User
|
|
36
|
+
* Guide</i>.</p>
|
|
37
|
+
* <p>You cannot update a scraper. If you want to change the configuration of the scraper,
|
|
38
|
+
* create a new scraper and delete the old one.</p>
|
|
39
|
+
* <p>The <code>scrapeConfiguration</code> parameter contains the base64-encoded version of
|
|
40
|
+
* the YAML configuration file.</p>
|
|
41
|
+
* <note>
|
|
42
|
+
* <p>For more information about collectors, including what metrics are collected, and
|
|
43
|
+
* how to configure the scraper, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html">Amazon Web Services managed
|
|
44
|
+
* collectors</a> in the <i>Amazon Managed Service for Prometheus User
|
|
45
|
+
* Guide</i>.</p>
|
|
46
|
+
* </note>
|
|
30
47
|
* @example
|
|
31
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
49
|
* ```javascript
|
|
@@ -81,25 +98,26 @@ declare const CreateScraperCommand_base: {
|
|
|
81
98
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
82
99
|
*
|
|
83
100
|
* @throws {@link AccessDeniedException} (client fault)
|
|
84
|
-
*
|
|
101
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
85
102
|
*
|
|
86
103
|
* @throws {@link ConflictException} (client fault)
|
|
87
|
-
*
|
|
104
|
+
* <p>The request would cause an inconsistent state.</p>
|
|
88
105
|
*
|
|
89
106
|
* @throws {@link InternalServerException} (server fault)
|
|
90
|
-
*
|
|
107
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
91
108
|
*
|
|
92
109
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
93
|
-
*
|
|
110
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
94
111
|
*
|
|
95
112
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
96
|
-
*
|
|
113
|
+
* <p>Completing the request would cause a service quota to be exceeded.</p>
|
|
97
114
|
*
|
|
98
115
|
* @throws {@link ThrottlingException} (client fault)
|
|
99
|
-
*
|
|
116
|
+
* <p>The request was denied due to request throttling.</p>
|
|
100
117
|
*
|
|
101
118
|
* @throws {@link ValidationException} (client fault)
|
|
102
|
-
* The input fails to satisfy the constraints specified by an
|
|
119
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
120
|
+
* service.</p>
|
|
103
121
|
*
|
|
104
122
|
* @throws {@link AmpServiceException}
|
|
105
123
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,9 @@ declare const CreateWorkspaceCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
* Creates a
|
|
29
|
+
* <p>Creates a Prometheus workspace. A workspace is a logical space dedicated to the
|
|
30
|
+
* storage and querying of Prometheus metrics. You can have one or more workspaces in each
|
|
31
|
+
* Region in your account.</p>
|
|
30
32
|
* @example
|
|
31
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
34
|
* ```javascript
|
|
@@ -64,22 +66,23 @@ declare const CreateWorkspaceCommand_base: {
|
|
|
64
66
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
65
67
|
*
|
|
66
68
|
* @throws {@link AccessDeniedException} (client fault)
|
|
67
|
-
*
|
|
69
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
68
70
|
*
|
|
69
71
|
* @throws {@link ConflictException} (client fault)
|
|
70
|
-
*
|
|
72
|
+
* <p>The request would cause an inconsistent state.</p>
|
|
71
73
|
*
|
|
72
74
|
* @throws {@link InternalServerException} (server fault)
|
|
73
|
-
*
|
|
75
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
74
76
|
*
|
|
75
77
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
76
|
-
*
|
|
78
|
+
* <p>Completing the request would cause a service quota to be exceeded.</p>
|
|
77
79
|
*
|
|
78
80
|
* @throws {@link ThrottlingException} (client fault)
|
|
79
|
-
*
|
|
81
|
+
* <p>The request was denied due to request throttling.</p>
|
|
80
82
|
*
|
|
81
83
|
* @throws {@link ValidationException} (client fault)
|
|
82
|
-
* The input fails to satisfy the constraints specified by an
|
|
84
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
85
|
+
* service.</p>
|
|
83
86
|
*
|
|
84
87
|
* @throws {@link AmpServiceException}
|
|
85
88
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,7 @@ declare const DeleteAlertManagerDefinitionCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
* Deletes
|
|
29
|
+
* <p>Deletes the alert manager definition from a workspace.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -50,22 +50,23 @@ declare const DeleteAlertManagerDefinitionCommand_base: {
|
|
|
50
50
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
51
51
|
*
|
|
52
52
|
* @throws {@link AccessDeniedException} (client fault)
|
|
53
|
-
*
|
|
53
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link ConflictException} (client fault)
|
|
56
|
-
*
|
|
56
|
+
* <p>The request would cause an inconsistent state.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link InternalServerException} (server fault)
|
|
59
|
-
*
|
|
59
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
-
*
|
|
62
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ThrottlingException} (client fault)
|
|
65
|
-
*
|
|
65
|
+
* <p>The request was denied due to request throttling.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link ValidationException} (client fault)
|
|
68
|
-
* The input fails to satisfy the constraints specified by an
|
|
68
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
69
|
+
* service.</p>
|
|
69
70
|
*
|
|
70
71
|
* @throws {@link AmpServiceException}
|
|
71
72
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,7 @@ declare const DeleteLoggingConfigurationCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
*
|
|
29
|
+
* <p>Deletes the logging configuration for a workspace.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -50,19 +50,20 @@ declare const DeleteLoggingConfigurationCommand_base: {
|
|
|
50
50
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
51
51
|
*
|
|
52
52
|
* @throws {@link AccessDeniedException} (client fault)
|
|
53
|
-
*
|
|
53
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link ConflictException} (client fault)
|
|
56
|
-
*
|
|
56
|
+
* <p>The request would cause an inconsistent state.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link InternalServerException} (server fault)
|
|
59
|
-
*
|
|
59
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
-
*
|
|
62
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ValidationException} (client fault)
|
|
65
|
-
* The input fails to satisfy the constraints specified by an
|
|
65
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
66
|
+
* service.</p>
|
|
66
67
|
*
|
|
67
68
|
* @throws {@link AmpServiceException}
|
|
68
69
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,7 @@ declare const DeleteRuleGroupsNamespaceCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
*
|
|
29
|
+
* <p>Deletes one rule groups namespace and its associated rule groups definition.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -51,22 +51,23 @@ declare const DeleteRuleGroupsNamespaceCommand_base: {
|
|
|
51
51
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
52
52
|
*
|
|
53
53
|
* @throws {@link AccessDeniedException} (client fault)
|
|
54
|
-
*
|
|
54
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link ConflictException} (client fault)
|
|
57
|
-
*
|
|
57
|
+
* <p>The request would cause an inconsistent state.</p>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link InternalServerException} (server fault)
|
|
60
|
-
*
|
|
60
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
|
-
*
|
|
63
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link ThrottlingException} (client fault)
|
|
66
|
-
*
|
|
66
|
+
* <p>The request was denied due to request throttling.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ValidationException} (client fault)
|
|
69
|
-
* The input fails to satisfy the constraints specified by an
|
|
69
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
70
|
+
* service.</p>
|
|
70
71
|
*
|
|
71
72
|
* @throws {@link AmpServiceException}
|
|
72
73
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,8 @@ declare const DeleteScraperCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
*
|
|
29
|
+
* <p>The <code>DeleteScraper</code> operation deletes one scraper, and stops any metrics
|
|
30
|
+
* collection that the scraper performs.</p>
|
|
30
31
|
* @example
|
|
31
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
33
|
* ```javascript
|
|
@@ -55,22 +56,23 @@ declare const DeleteScraperCommand_base: {
|
|
|
55
56
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
56
57
|
*
|
|
57
58
|
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
-
*
|
|
59
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
59
60
|
*
|
|
60
61
|
* @throws {@link ConflictException} (client fault)
|
|
61
|
-
*
|
|
62
|
+
* <p>The request would cause an inconsistent state.</p>
|
|
62
63
|
*
|
|
63
64
|
* @throws {@link InternalServerException} (server fault)
|
|
64
|
-
*
|
|
65
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
65
66
|
*
|
|
66
67
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
-
*
|
|
68
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
68
69
|
*
|
|
69
70
|
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
-
*
|
|
71
|
+
* <p>The request was denied due to request throttling.</p>
|
|
71
72
|
*
|
|
72
73
|
* @throws {@link ValidationException} (client fault)
|
|
73
|
-
* The input fails to satisfy the constraints specified by an
|
|
74
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
75
|
+
* service.</p>
|
|
74
76
|
*
|
|
75
77
|
* @throws {@link AmpServiceException}
|
|
76
78
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,11 @@ declare const DeleteWorkspaceCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
* Deletes an
|
|
29
|
+
* <p>Deletes an existing workspace. </p>
|
|
30
|
+
* <note>
|
|
31
|
+
* <p>When you delete a workspace, the data that has been ingested into it is not
|
|
32
|
+
* immediately deleted. It will be permanently deleted within one month.</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
|
|
@@ -50,22 +54,23 @@ declare const DeleteWorkspaceCommand_base: {
|
|
|
50
54
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
51
55
|
*
|
|
52
56
|
* @throws {@link AccessDeniedException} (client fault)
|
|
53
|
-
*
|
|
57
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
54
58
|
*
|
|
55
59
|
* @throws {@link ConflictException} (client fault)
|
|
56
|
-
*
|
|
60
|
+
* <p>The request would cause an inconsistent state.</p>
|
|
57
61
|
*
|
|
58
62
|
* @throws {@link InternalServerException} (server fault)
|
|
59
|
-
*
|
|
63
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
60
64
|
*
|
|
61
65
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
-
*
|
|
66
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
63
67
|
*
|
|
64
68
|
* @throws {@link ThrottlingException} (client fault)
|
|
65
|
-
*
|
|
69
|
+
* <p>The request was denied due to request throttling.</p>
|
|
66
70
|
*
|
|
67
71
|
* @throws {@link ValidationException} (client fault)
|
|
68
|
-
* The input fails to satisfy the constraints specified by an
|
|
72
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
73
|
+
* service.</p>
|
|
69
74
|
*
|
|
70
75
|
* @throws {@link AmpServiceException}
|
|
71
76
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,8 @@ declare const DescribeAlertManagerDefinitionCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
*
|
|
29
|
+
* <p>Retrieves the full information about the alert manager definition for a
|
|
30
|
+
* workspace.</p>
|
|
30
31
|
* @example
|
|
31
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
33
|
* ```javascript
|
|
@@ -59,19 +60,20 @@ declare const DescribeAlertManagerDefinitionCommand_base: {
|
|
|
59
60
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
60
61
|
*
|
|
61
62
|
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
-
*
|
|
63
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
63
64
|
*
|
|
64
65
|
* @throws {@link InternalServerException} (server fault)
|
|
65
|
-
*
|
|
66
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
66
67
|
*
|
|
67
68
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
|
-
*
|
|
69
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
69
70
|
*
|
|
70
71
|
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
-
*
|
|
72
|
+
* <p>The request was denied due to request throttling.</p>
|
|
72
73
|
*
|
|
73
74
|
* @throws {@link ValidationException} (client fault)
|
|
74
|
-
* The input fails to satisfy the constraints specified by an
|
|
75
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
76
|
+
* service.</p>
|
|
75
77
|
*
|
|
76
78
|
* @throws {@link AmpServiceException}
|
|
77
79
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,8 @@ declare const DescribeLoggingConfigurationCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
*
|
|
29
|
+
* <p>Returns complete information about the current logging configuration of the
|
|
30
|
+
* workspace.</p>
|
|
30
31
|
* @example
|
|
31
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
33
|
* ```javascript
|
|
@@ -60,16 +61,17 @@ declare const DescribeLoggingConfigurationCommand_base: {
|
|
|
60
61
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
61
62
|
*
|
|
62
63
|
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
-
*
|
|
64
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
64
65
|
*
|
|
65
66
|
* @throws {@link InternalServerException} (server fault)
|
|
66
|
-
*
|
|
67
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
67
68
|
*
|
|
68
69
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
|
-
*
|
|
70
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
70
71
|
*
|
|
71
72
|
* @throws {@link ValidationException} (client fault)
|
|
72
|
-
* The input fails to satisfy the constraints specified by an
|
|
73
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
74
|
+
* service.</p>
|
|
73
75
|
*
|
|
74
76
|
* @throws {@link AmpServiceException}
|
|
75
77
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|
|
@@ -26,7 +26,8 @@ declare const DescribeRuleGroupsNamespaceCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
*
|
|
29
|
+
* <p>Returns complete information about one rule groups namespace. To retrieve a list of
|
|
30
|
+
* rule groups namespaces, use <code>ListRuleGroupsNamespaces</code>.</p>
|
|
30
31
|
* @example
|
|
31
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
33
|
* ```javascript
|
|
@@ -65,19 +66,20 @@ declare const DescribeRuleGroupsNamespaceCommand_base: {
|
|
|
65
66
|
* @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
|
|
66
67
|
*
|
|
67
68
|
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
-
*
|
|
69
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
69
70
|
*
|
|
70
71
|
* @throws {@link InternalServerException} (server fault)
|
|
71
|
-
*
|
|
72
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
72
73
|
*
|
|
73
74
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
-
*
|
|
75
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
75
76
|
*
|
|
76
77
|
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
-
*
|
|
78
|
+
* <p>The request was denied due to request throttling.</p>
|
|
78
79
|
*
|
|
79
80
|
* @throws {@link ValidationException} (client fault)
|
|
80
|
-
* The input fails to satisfy the constraints specified by an
|
|
81
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
82
|
+
* service.</p>
|
|
81
83
|
*
|
|
82
84
|
* @throws {@link AmpServiceException}
|
|
83
85
|
* <p>Base exception class for all service exceptions from Amp service.</p>
|