cdk-lambda-subminute 2.0.369 → 2.0.371

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.
@@ -13,211 +13,211 @@ declare class Amp extends Service {
13
13
  constructor(options?: Amp.Types.ClientConfiguration)
14
14
  config: Config & Amp.Types.ClientConfiguration;
15
15
  /**
16
- * Create an alert manager definition.
16
+ * The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.
17
17
  */
18
18
  createAlertManagerDefinition(params: Amp.Types.CreateAlertManagerDefinitionRequest, callback?: (err: AWSError, data: Amp.Types.CreateAlertManagerDefinitionResponse) => void): Request<Amp.Types.CreateAlertManagerDefinitionResponse, AWSError>;
19
19
  /**
20
- * Create an alert manager definition.
20
+ * The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.
21
21
  */
22
22
  createAlertManagerDefinition(callback?: (err: AWSError, data: Amp.Types.CreateAlertManagerDefinitionResponse) => void): Request<Amp.Types.CreateAlertManagerDefinitionResponse, AWSError>;
23
23
  /**
24
- * Create logging configuration.
24
+ * The CreateLoggingConfiguration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.
25
25
  */
26
26
  createLoggingConfiguration(params: Amp.Types.CreateLoggingConfigurationRequest, callback?: (err: AWSError, data: Amp.Types.CreateLoggingConfigurationResponse) => void): Request<Amp.Types.CreateLoggingConfigurationResponse, AWSError>;
27
27
  /**
28
- * Create logging configuration.
28
+ * The CreateLoggingConfiguration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.
29
29
  */
30
30
  createLoggingConfiguration(callback?: (err: AWSError, data: Amp.Types.CreateLoggingConfigurationResponse) => void): Request<Amp.Types.CreateLoggingConfigurationResponse, AWSError>;
31
31
  /**
32
- * Create a rule group namespace.
32
+ * The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.
33
33
  */
34
34
  createRuleGroupsNamespace(params: Amp.Types.CreateRuleGroupsNamespaceRequest, callback?: (err: AWSError, data: Amp.Types.CreateRuleGroupsNamespaceResponse) => void): Request<Amp.Types.CreateRuleGroupsNamespaceResponse, AWSError>;
35
35
  /**
36
- * Create a rule group namespace.
36
+ * The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.
37
37
  */
38
38
  createRuleGroupsNamespace(callback?: (err: AWSError, data: Amp.Types.CreateRuleGroupsNamespaceResponse) => void): Request<Amp.Types.CreateRuleGroupsNamespaceResponse, AWSError>;
39
39
  /**
40
- * Create a scraper.
40
+ * The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace. 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 Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User Guide. You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one. The scrapeConfiguration parameter contains the base64-encoded version of the YAML configuration file. For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors in the Amazon Managed Service for Prometheus User Guide.
41
41
  */
42
42
  createScraper(params: Amp.Types.CreateScraperRequest, callback?: (err: AWSError, data: Amp.Types.CreateScraperResponse) => void): Request<Amp.Types.CreateScraperResponse, AWSError>;
43
43
  /**
44
- * Create a scraper.
44
+ * The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace. 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 Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User Guide. You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one. The scrapeConfiguration parameter contains the base64-encoded version of the YAML configuration file. For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors in the Amazon Managed Service for Prometheus User Guide.
45
45
  */
46
46
  createScraper(callback?: (err: AWSError, data: Amp.Types.CreateScraperResponse) => void): Request<Amp.Types.CreateScraperResponse, AWSError>;
47
47
  /**
48
- * Creates a new AMP workspace.
48
+ * Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.
49
49
  */
50
50
  createWorkspace(params: Amp.Types.CreateWorkspaceRequest, callback?: (err: AWSError, data: Amp.Types.CreateWorkspaceResponse) => void): Request<Amp.Types.CreateWorkspaceResponse, AWSError>;
51
51
  /**
52
- * Creates a new AMP workspace.
52
+ * Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.
53
53
  */
54
54
  createWorkspace(callback?: (err: AWSError, data: Amp.Types.CreateWorkspaceResponse) => void): Request<Amp.Types.CreateWorkspaceResponse, AWSError>;
55
55
  /**
56
- * Deletes an alert manager definition.
56
+ * Deletes the alert manager definition from a workspace.
57
57
  */
58
58
  deleteAlertManagerDefinition(params: Amp.Types.DeleteAlertManagerDefinitionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
59
59
  /**
60
- * Deletes an alert manager definition.
60
+ * Deletes the alert manager definition from a workspace.
61
61
  */
62
62
  deleteAlertManagerDefinition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
63
63
  /**
64
- * Delete logging configuration.
64
+ * Deletes the logging configuration for a workspace.
65
65
  */
66
66
  deleteLoggingConfiguration(params: Amp.Types.DeleteLoggingConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
67
67
  /**
68
- * Delete logging configuration.
68
+ * Deletes the logging configuration for a workspace.
69
69
  */
70
70
  deleteLoggingConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
71
71
  /**
72
- * Delete a rule groups namespace.
72
+ * Deletes one rule groups namespace and its associated rule groups definition.
73
73
  */
74
74
  deleteRuleGroupsNamespace(params: Amp.Types.DeleteRuleGroupsNamespaceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
75
75
  /**
76
- * Delete a rule groups namespace.
76
+ * Deletes one rule groups namespace and its associated rule groups definition.
77
77
  */
78
78
  deleteRuleGroupsNamespace(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
79
79
  /**
80
- * Deletes a scraper.
80
+ * The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.
81
81
  */
82
82
  deleteScraper(params: Amp.Types.DeleteScraperRequest, callback?: (err: AWSError, data: Amp.Types.DeleteScraperResponse) => void): Request<Amp.Types.DeleteScraperResponse, AWSError>;
83
83
  /**
84
- * Deletes a scraper.
84
+ * The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.
85
85
  */
86
86
  deleteScraper(callback?: (err: AWSError, data: Amp.Types.DeleteScraperResponse) => void): Request<Amp.Types.DeleteScraperResponse, AWSError>;
87
87
  /**
88
- * Deletes an AMP workspace.
88
+ * Deletes an existing workspace. When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.
89
89
  */
90
90
  deleteWorkspace(params: Amp.Types.DeleteWorkspaceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
91
91
  /**
92
- * Deletes an AMP workspace.
92
+ * Deletes an existing workspace. When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.
93
93
  */
94
94
  deleteWorkspace(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
95
95
  /**
96
- * Describes an alert manager definition.
96
+ * Retrieves the full information about the alert manager definition for a workspace.
97
97
  */
98
98
  describeAlertManagerDefinition(params: Amp.Types.DescribeAlertManagerDefinitionRequest, callback?: (err: AWSError, data: Amp.Types.DescribeAlertManagerDefinitionResponse) => void): Request<Amp.Types.DescribeAlertManagerDefinitionResponse, AWSError>;
99
99
  /**
100
- * Describes an alert manager definition.
100
+ * Retrieves the full information about the alert manager definition for a workspace.
101
101
  */
102
102
  describeAlertManagerDefinition(callback?: (err: AWSError, data: Amp.Types.DescribeAlertManagerDefinitionResponse) => void): Request<Amp.Types.DescribeAlertManagerDefinitionResponse, AWSError>;
103
103
  /**
104
- * Describes logging configuration.
104
+ * Returns complete information about the current logging configuration of the workspace.
105
105
  */
106
106
  describeLoggingConfiguration(params: Amp.Types.DescribeLoggingConfigurationRequest, callback?: (err: AWSError, data: Amp.Types.DescribeLoggingConfigurationResponse) => void): Request<Amp.Types.DescribeLoggingConfigurationResponse, AWSError>;
107
107
  /**
108
- * Describes logging configuration.
108
+ * Returns complete information about the current logging configuration of the workspace.
109
109
  */
110
110
  describeLoggingConfiguration(callback?: (err: AWSError, data: Amp.Types.DescribeLoggingConfigurationResponse) => void): Request<Amp.Types.DescribeLoggingConfigurationResponse, AWSError>;
111
111
  /**
112
- * Describe a rule groups namespace.
112
+ * Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.
113
113
  */
114
114
  describeRuleGroupsNamespace(params: Amp.Types.DescribeRuleGroupsNamespaceRequest, callback?: (err: AWSError, data: Amp.Types.DescribeRuleGroupsNamespaceResponse) => void): Request<Amp.Types.DescribeRuleGroupsNamespaceResponse, AWSError>;
115
115
  /**
116
- * Describe a rule groups namespace.
116
+ * Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.
117
117
  */
118
118
  describeRuleGroupsNamespace(callback?: (err: AWSError, data: Amp.Types.DescribeRuleGroupsNamespaceResponse) => void): Request<Amp.Types.DescribeRuleGroupsNamespaceResponse, AWSError>;
119
119
  /**
120
- * Describe an existing scraper.
120
+ * The DescribeScraper operation displays information about an existing scraper.
121
121
  */
122
122
  describeScraper(params: Amp.Types.DescribeScraperRequest, callback?: (err: AWSError, data: Amp.Types.DescribeScraperResponse) => void): Request<Amp.Types.DescribeScraperResponse, AWSError>;
123
123
  /**
124
- * Describe an existing scraper.
124
+ * The DescribeScraper operation displays information about an existing scraper.
125
125
  */
126
126
  describeScraper(callback?: (err: AWSError, data: Amp.Types.DescribeScraperResponse) => void): Request<Amp.Types.DescribeScraperResponse, AWSError>;
127
127
  /**
128
- * Describes an existing AMP workspace.
128
+ * Returns information about an existing workspace.
129
129
  */
130
130
  describeWorkspace(params: Amp.Types.DescribeWorkspaceRequest, callback?: (err: AWSError, data: Amp.Types.DescribeWorkspaceResponse) => void): Request<Amp.Types.DescribeWorkspaceResponse, AWSError>;
131
131
  /**
132
- * Describes an existing AMP workspace.
132
+ * Returns information about an existing workspace.
133
133
  */
134
134
  describeWorkspace(callback?: (err: AWSError, data: Amp.Types.DescribeWorkspaceResponse) => void): Request<Amp.Types.DescribeWorkspaceResponse, AWSError>;
135
135
  /**
136
- * Gets a default configuration.
136
+ * The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
137
137
  */
138
138
  getDefaultScraperConfiguration(params: Amp.Types.GetDefaultScraperConfigurationRequest, callback?: (err: AWSError, data: Amp.Types.GetDefaultScraperConfigurationResponse) => void): Request<Amp.Types.GetDefaultScraperConfigurationResponse, AWSError>;
139
139
  /**
140
- * Gets a default configuration.
140
+ * The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
141
141
  */
142
142
  getDefaultScraperConfiguration(callback?: (err: AWSError, data: Amp.Types.GetDefaultScraperConfigurationResponse) => void): Request<Amp.Types.GetDefaultScraperConfigurationResponse, AWSError>;
143
143
  /**
144
- * Lists rule groups namespaces.
144
+ * Returns a list of rule groups namespaces in a workspace.
145
145
  */
146
146
  listRuleGroupsNamespaces(params: Amp.Types.ListRuleGroupsNamespacesRequest, callback?: (err: AWSError, data: Amp.Types.ListRuleGroupsNamespacesResponse) => void): Request<Amp.Types.ListRuleGroupsNamespacesResponse, AWSError>;
147
147
  /**
148
- * Lists rule groups namespaces.
148
+ * Returns a list of rule groups namespaces in a workspace.
149
149
  */
150
150
  listRuleGroupsNamespaces(callback?: (err: AWSError, data: Amp.Types.ListRuleGroupsNamespacesResponse) => void): Request<Amp.Types.ListRuleGroupsNamespacesResponse, AWSError>;
151
151
  /**
152
- * Lists all scrapers in a customer account, including scrapers being created or deleted. You may provide filters to return a more specific list of results.
152
+ * The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.
153
153
  */
154
154
  listScrapers(params: Amp.Types.ListScrapersRequest, callback?: (err: AWSError, data: Amp.Types.ListScrapersResponse) => void): Request<Amp.Types.ListScrapersResponse, AWSError>;
155
155
  /**
156
- * Lists all scrapers in a customer account, including scrapers being created or deleted. You may provide filters to return a more specific list of results.
156
+ * The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.
157
157
  */
158
158
  listScrapers(callback?: (err: AWSError, data: Amp.Types.ListScrapersResponse) => void): Request<Amp.Types.ListScrapersResponse, AWSError>;
159
159
  /**
160
- * Lists the tags you have assigned to the resource.
160
+ * The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are workspaces and rule groups namespaces.
161
161
  */
162
162
  listTagsForResource(params: Amp.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Amp.Types.ListTagsForResourceResponse) => void): Request<Amp.Types.ListTagsForResourceResponse, AWSError>;
163
163
  /**
164
- * Lists the tags you have assigned to the resource.
164
+ * The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are workspaces and rule groups namespaces.
165
165
  */
166
166
  listTagsForResource(callback?: (err: AWSError, data: Amp.Types.ListTagsForResourceResponse) => void): Request<Amp.Types.ListTagsForResourceResponse, AWSError>;
167
167
  /**
168
- * Lists all AMP workspaces, including workspaces being created or deleted.
168
+ * Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.
169
169
  */
170
170
  listWorkspaces(params: Amp.Types.ListWorkspacesRequest, callback?: (err: AWSError, data: Amp.Types.ListWorkspacesResponse) => void): Request<Amp.Types.ListWorkspacesResponse, AWSError>;
171
171
  /**
172
- * Lists all AMP workspaces, including workspaces being created or deleted.
172
+ * Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.
173
173
  */
174
174
  listWorkspaces(callback?: (err: AWSError, data: Amp.Types.ListWorkspacesResponse) => void): Request<Amp.Types.ListWorkspacesResponse, AWSError>;
175
175
  /**
176
- * Update an alert manager definition.
176
+ * Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition.
177
177
  */
178
178
  putAlertManagerDefinition(params: Amp.Types.PutAlertManagerDefinitionRequest, callback?: (err: AWSError, data: Amp.Types.PutAlertManagerDefinitionResponse) => void): Request<Amp.Types.PutAlertManagerDefinitionResponse, AWSError>;
179
179
  /**
180
- * Update an alert manager definition.
180
+ * Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition.
181
181
  */
182
182
  putAlertManagerDefinition(callback?: (err: AWSError, data: Amp.Types.PutAlertManagerDefinitionResponse) => void): Request<Amp.Types.PutAlertManagerDefinitionResponse, AWSError>;
183
183
  /**
184
- * Update a rule groups namespace.
184
+ * Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace. You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.
185
185
  */
186
186
  putRuleGroupsNamespace(params: Amp.Types.PutRuleGroupsNamespaceRequest, callback?: (err: AWSError, data: Amp.Types.PutRuleGroupsNamespaceResponse) => void): Request<Amp.Types.PutRuleGroupsNamespaceResponse, AWSError>;
187
187
  /**
188
- * Update a rule groups namespace.
188
+ * Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace. You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.
189
189
  */
190
190
  putRuleGroupsNamespace(callback?: (err: AWSError, data: Amp.Types.PutRuleGroupsNamespaceResponse) => void): Request<Amp.Types.PutRuleGroupsNamespaceResponse, AWSError>;
191
191
  /**
192
- * Creates tags for the specified resource.
192
+ * The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
193
193
  */
194
194
  tagResource(params: Amp.Types.TagResourceRequest, callback?: (err: AWSError, data: Amp.Types.TagResourceResponse) => void): Request<Amp.Types.TagResourceResponse, AWSError>;
195
195
  /**
196
- * Creates tags for the specified resource.
196
+ * The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
197
197
  */
198
198
  tagResource(callback?: (err: AWSError, data: Amp.Types.TagResourceResponse) => void): Request<Amp.Types.TagResourceResponse, AWSError>;
199
199
  /**
200
- * Deletes tags from the specified resource.
200
+ * Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.
201
201
  */
202
202
  untagResource(params: Amp.Types.UntagResourceRequest, callback?: (err: AWSError, data: Amp.Types.UntagResourceResponse) => void): Request<Amp.Types.UntagResourceResponse, AWSError>;
203
203
  /**
204
- * Deletes tags from the specified resource.
204
+ * Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.
205
205
  */
206
206
  untagResource(callback?: (err: AWSError, data: Amp.Types.UntagResourceResponse) => void): Request<Amp.Types.UntagResourceResponse, AWSError>;
207
207
  /**
208
- * Update logging configuration.
208
+ * Updates the log group ARN or the workspace ID of the current logging configuration.
209
209
  */
210
210
  updateLoggingConfiguration(params: Amp.Types.UpdateLoggingConfigurationRequest, callback?: (err: AWSError, data: Amp.Types.UpdateLoggingConfigurationResponse) => void): Request<Amp.Types.UpdateLoggingConfigurationResponse, AWSError>;
211
211
  /**
212
- * Update logging configuration.
212
+ * Updates the log group ARN or the workspace ID of the current logging configuration.
213
213
  */
214
214
  updateLoggingConfiguration(callback?: (err: AWSError, data: Amp.Types.UpdateLoggingConfigurationResponse) => void): Request<Amp.Types.UpdateLoggingConfigurationResponse, AWSError>;
215
215
  /**
216
- * Updates an AMP workspace alias.
216
+ * Updates the alias of an existing workspace.
217
217
  */
218
218
  updateWorkspaceAlias(params: Amp.Types.UpdateWorkspaceAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
219
219
  /**
220
- * Updates an AMP workspace alias.
220
+ * Updates the alias of an existing workspace.
221
221
  */
222
222
  updateWorkspaceAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
223
223
  /**
@@ -257,36 +257,36 @@ declare namespace Amp {
257
257
  export type AlertManagerDefinitionData = Buffer|Uint8Array|Blob|string;
258
258
  export interface AlertManagerDefinitionDescription {
259
259
  /**
260
- * The status of alert manager definition.
260
+ * The date and time that the alert manager definition was created.
261
261
  */
262
- status: AlertManagerDefinitionStatus;
262
+ createdAt: Timestamp;
263
263
  /**
264
- * The alert manager definition.
264
+ * The actual alert manager definition. For details about the alert manager definition, see AlertManagedDefinitionData.
265
265
  */
266
266
  data: AlertManagerDefinitionData;
267
267
  /**
268
- * The time when the alert manager definition was created.
268
+ * The date and time that the alert manager definition was most recently changed.
269
269
  */
270
- createdAt: Timestamp;
270
+ modifiedAt: Timestamp;
271
271
  /**
272
- * The time when the alert manager definition was modified.
272
+ * A structure that displays the current status of the alert manager definition..
273
273
  */
274
- modifiedAt: Timestamp;
274
+ status: AlertManagerDefinitionStatus;
275
275
  }
276
276
  export interface AlertManagerDefinitionStatus {
277
277
  /**
278
- * Status code of this definition.
278
+ * The current status of the alert manager.
279
279
  */
280
280
  statusCode: AlertManagerDefinitionStatusCode;
281
281
  /**
282
- * The reason for failure if any.
282
+ * If there is a failure, the reason for the failure.
283
283
  */
284
284
  statusReason?: String;
285
285
  }
286
286
  export type AlertManagerDefinitionStatusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"|"UPDATE_FAILED"|string;
287
287
  export interface AmpConfiguration {
288
288
  /**
289
- * The ARN of an AMP workspace.
289
+ * ARN of the Amazon Managed Service for Prometheus workspace.
290
290
  */
291
291
  workspaceArn: WorkspaceArn;
292
292
  }
@@ -294,281 +294,281 @@ declare namespace Amp {
294
294
  export type ClusterArn = string;
295
295
  export interface CreateAlertManagerDefinitionRequest {
296
296
  /**
297
- * The ID of the workspace in which to create the alert manager definition.
297
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
298
298
  */
299
- workspaceId: WorkspaceId;
299
+ clientToken?: IdempotencyToken;
300
300
  /**
301
- * The alert manager definition data.
301
+ * The alert manager definition to add. A base64-encoded version of the YAML alert manager definition file. For details about the alert manager definition, see AlertManagedDefinitionData.
302
302
  */
303
303
  data: AlertManagerDefinitionData;
304
304
  /**
305
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
305
+ * The ID of the workspace to add the alert manager definition to.
306
306
  */
307
- clientToken?: IdempotencyToken;
307
+ workspaceId: WorkspaceId;
308
308
  }
309
309
  export interface CreateAlertManagerDefinitionResponse {
310
310
  /**
311
- * The status of alert manager definition.
311
+ * A structure that displays the current status of the alert manager definition.
312
312
  */
313
313
  status: AlertManagerDefinitionStatus;
314
314
  }
315
315
  export interface CreateLoggingConfigurationRequest {
316
316
  /**
317
- * The ID of the workspace to vend logs to.
317
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
318
318
  */
319
- workspaceId: WorkspaceId;
319
+ clientToken?: IdempotencyToken;
320
320
  /**
321
- * The ARN of the CW log group to which the vended log data will be published.
321
+ * The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this API.
322
322
  */
323
323
  logGroupArn: LogGroupArn;
324
324
  /**
325
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
325
+ * The ID of the workspace to create the logging configuration for.
326
326
  */
327
- clientToken?: IdempotencyToken;
327
+ workspaceId: WorkspaceId;
328
328
  }
329
329
  export interface CreateLoggingConfigurationResponse {
330
330
  /**
331
- * The status of the logging configuration.
331
+ * A structure that displays the current status of the logging configuration.
332
332
  */
333
333
  status: LoggingConfigurationStatus;
334
334
  }
335
335
  export interface CreateRuleGroupsNamespaceRequest {
336
336
  /**
337
- * The ID of the workspace in which to create the rule group namespace.
337
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
338
338
  */
339
- workspaceId: WorkspaceId;
340
- /**
341
- * The rule groups namespace name.
342
- */
343
- name: RuleGroupsNamespaceName;
339
+ clientToken?: IdempotencyToken;
344
340
  /**
345
- * The namespace data that define the rule groups.
341
+ * The rules file to use in the new namespace. Contains the base64-encoded version of the YAML rules file. For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
346
342
  */
347
343
  data: RuleGroupsNamespaceData;
348
344
  /**
349
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
345
+ * The name for the new rule groups namespace.
350
346
  */
351
- clientToken?: IdempotencyToken;
347
+ name: RuleGroupsNamespaceName;
352
348
  /**
353
- * Optional, user-provided tags for this rule groups namespace.
349
+ * The list of tag keys and values to associate with the rule groups namespace.
354
350
  */
355
351
  tags?: TagMap;
352
+ /**
353
+ * The ID of the workspace to add the rule groups namespace.
354
+ */
355
+ workspaceId: WorkspaceId;
356
356
  }
357
357
  export interface CreateRuleGroupsNamespaceResponse {
358
358
  /**
359
- * The rule groups namespace name.
359
+ * The Amazon Resource Name (ARN) of the new rule groups namespace.
360
360
  */
361
- name: RuleGroupsNamespaceName;
361
+ arn: RuleGroupsNamespaceArn;
362
362
  /**
363
- * The Amazon Resource Name (ARN) of this rule groups namespace.
363
+ * The name of the new rule groups namespace.
364
364
  */
365
- arn: RuleGroupsNamespaceArn;
365
+ name: RuleGroupsNamespaceName;
366
366
  /**
367
- * The status of rule groups namespace.
367
+ * A structure that returns the current status of the rule groups namespace.
368
368
  */
369
369
  status: RuleGroupsNamespaceStatus;
370
370
  /**
371
- * The tags of this rule groups namespace.
371
+ * The list of tag keys and values that are associated with the namespace.
372
372
  */
373
373
  tags?: TagMap;
374
374
  }
375
375
  export interface CreateScraperRequest {
376
376
  /**
377
- * An optional user-assigned alias for this scraper. This alias is for user reference and does not need to be unique.
377
+ * (optional) a name to associate with the scraper. This is for your use, and does not need to be unique.
378
378
  */
379
379
  alias?: ScraperAlias;
380
380
  /**
381
- * The configuration used to create the scraper.
381
+ * (Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
382
382
  */
383
- scrapeConfiguration: ScrapeConfiguration;
383
+ clientToken?: IdempotencyToken;
384
384
  /**
385
- * The source that the scraper will be discovering and collecting metrics from.
385
+ * The Amazon Managed Service for Prometheus workspace to send metrics to.
386
386
  */
387
- source: Source;
387
+ destination: Destination;
388
388
  /**
389
- * The destination that the scraper will be producing metrics to.
389
+ * The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
390
390
  */
391
- destination: Destination;
391
+ scrapeConfiguration: ScrapeConfiguration;
392
392
  /**
393
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
393
+ * The Amazon EKS cluster from which the scraper will collect metrics.
394
394
  */
395
- clientToken?: IdempotencyToken;
395
+ source: Source;
396
396
  /**
397
- * Optional, user-provided tags for this scraper.
397
+ * (Optional) The list of tag keys and values to associate with the scraper.
398
398
  */
399
399
  tags?: TagMap;
400
400
  }
401
401
  export interface CreateScraperResponse {
402
402
  /**
403
- * The generated ID of the scraper that was just created.
403
+ * The Amazon Resource Name (ARN) of the new scraper.
404
404
  */
405
- scraperId: ScraperId;
405
+ arn: ScraperArn;
406
406
  /**
407
- * The ARN of the scraper that was just created.
407
+ * The ID of the new scraper.
408
408
  */
409
- arn: ScraperArn;
409
+ scraperId: ScraperId;
410
410
  /**
411
- * The status of the scraper that was just created (usually CREATING).
411
+ * A structure that displays the current status of the scraper.
412
412
  */
413
413
  status: ScraperStatus;
414
414
  /**
415
- * The tags of this scraper.
415
+ * The list of tag keys and values that are associated with the scraper.
416
416
  */
417
417
  tags?: TagMap;
418
418
  }
419
419
  export interface CreateWorkspaceRequest {
420
420
  /**
421
- * An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.
421
+ * An alias that you assign to this workspace to help you identify it. It does not need to be unique. Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.
422
422
  */
423
423
  alias?: WorkspaceAlias;
424
424
  /**
425
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
425
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
426
426
  */
427
427
  clientToken?: IdempotencyToken;
428
428
  /**
429
- * Optional, user-provided tags for this workspace.
429
+ * (optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide.
430
430
  */
431
- tags?: TagMap;
431
+ kmsKeyArn?: KmsKeyArn;
432
432
  /**
433
- * Optional, customer managed KMS key used to encrypt data for this workspace
433
+ * The list of tag keys and values to associate with the workspace.
434
434
  */
435
- kmsKeyArn?: KmsKeyArn;
435
+ tags?: TagMap;
436
436
  }
437
437
  export interface CreateWorkspaceResponse {
438
438
  /**
439
- * The generated ID of the workspace that was just created.
439
+ * The ARN for the new workspace.
440
440
  */
441
- workspaceId: WorkspaceId;
441
+ arn: WorkspaceArn;
442
442
  /**
443
- * The ARN of the workspace that was just created.
443
+ * (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
444
444
  */
445
- arn: WorkspaceArn;
445
+ kmsKeyArn?: KmsKeyArn;
446
446
  /**
447
- * The status of the workspace that was just created (usually CREATING).
447
+ * The current status of the new workspace. Immediately after you create the workspace, the status is usually CREATING.
448
448
  */
449
449
  status: WorkspaceStatus;
450
450
  /**
451
- * The tags of this workspace.
451
+ * The list of tag keys and values that are associated with the workspace.
452
452
  */
453
453
  tags?: TagMap;
454
454
  /**
455
- * Customer managed KMS key ARN for this workspace
455
+ * The unique ID for the new workspace.
456
456
  */
457
- kmsKeyArn?: KmsKeyArn;
457
+ workspaceId: WorkspaceId;
458
458
  }
459
459
  export interface DeleteAlertManagerDefinitionRequest {
460
460
  /**
461
- * The ID of the workspace in which to delete the alert manager definition.
461
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
462
462
  */
463
- workspaceId: WorkspaceId;
463
+ clientToken?: IdempotencyToken;
464
464
  /**
465
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
465
+ * The ID of the workspace to delete the alert manager definition from.
466
466
  */
467
- clientToken?: IdempotencyToken;
467
+ workspaceId: WorkspaceId;
468
468
  }
469
469
  export interface DeleteLoggingConfigurationRequest {
470
470
  /**
471
- * The ID of the workspace to vend logs to.
471
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
472
472
  */
473
- workspaceId: WorkspaceId;
473
+ clientToken?: IdempotencyToken;
474
474
  /**
475
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
475
+ * The ID of the workspace containing the logging configuration to delete.
476
476
  */
477
- clientToken?: IdempotencyToken;
477
+ workspaceId: WorkspaceId;
478
478
  }
479
479
  export interface DeleteRuleGroupsNamespaceRequest {
480
480
  /**
481
- * The ID of the workspace to delete rule group definition.
481
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
482
482
  */
483
- workspaceId: WorkspaceId;
483
+ clientToken?: IdempotencyToken;
484
484
  /**
485
- * The rule groups namespace name.
485
+ * The name of the rule groups namespace to delete.
486
486
  */
487
487
  name: RuleGroupsNamespaceName;
488
488
  /**
489
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
489
+ * The ID of the workspace containing the rule groups namespace and definition to delete.
490
490
  */
491
- clientToken?: IdempotencyToken;
491
+ workspaceId: WorkspaceId;
492
492
  }
493
493
  export interface DeleteScraperRequest {
494
494
  /**
495
- * The ID of the scraper to delete.
495
+ * (Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
496
496
  */
497
- scraperId: ScraperId;
497
+ clientToken?: IdempotencyToken;
498
498
  /**
499
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
499
+ * The ID of the scraper to delete.
500
500
  */
501
- clientToken?: IdempotencyToken;
501
+ scraperId: ScraperId;
502
502
  }
503
503
  export interface DeleteScraperResponse {
504
504
  /**
505
- * The ID of the scraper that was deleted.
505
+ * The ID of the scraper to delete.
506
506
  */
507
507
  scraperId: ScraperId;
508
508
  /**
509
- * The status of the scraper that is being deleted.
509
+ * The current status of the scraper.
510
510
  */
511
511
  status: ScraperStatus;
512
512
  }
513
513
  export interface DeleteWorkspaceRequest {
514
514
  /**
515
- * The ID of the workspace to delete.
515
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
516
516
  */
517
- workspaceId: WorkspaceId;
517
+ clientToken?: IdempotencyToken;
518
518
  /**
519
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
519
+ * The ID of the workspace to delete.
520
520
  */
521
- clientToken?: IdempotencyToken;
521
+ workspaceId: WorkspaceId;
522
522
  }
523
523
  export interface DescribeAlertManagerDefinitionRequest {
524
524
  /**
525
- * The ID of the workspace to describe.
525
+ * The ID of the workspace to retrieve the alert manager definition from.
526
526
  */
527
527
  workspaceId: WorkspaceId;
528
528
  }
529
529
  export interface DescribeAlertManagerDefinitionResponse {
530
530
  /**
531
- * The properties of the selected workspace's alert manager definition.
531
+ * The alert manager definition.
532
532
  */
533
533
  alertManagerDefinition: AlertManagerDefinitionDescription;
534
534
  }
535
535
  export interface DescribeLoggingConfigurationRequest {
536
536
  /**
537
- * The ID of the workspace to vend logs to.
537
+ * The ID of the workspace to describe the logging configuration for.
538
538
  */
539
539
  workspaceId: WorkspaceId;
540
540
  }
541
541
  export interface DescribeLoggingConfigurationResponse {
542
542
  /**
543
- * Metadata object containing information about the logging configuration of a workspace.
543
+ * A structure that displays the information about the logging configuration.
544
544
  */
545
545
  loggingConfiguration: LoggingConfigurationMetadata;
546
546
  }
547
547
  export interface DescribeRuleGroupsNamespaceRequest {
548
548
  /**
549
- * The ID of the workspace to describe.
549
+ * The name of the rule groups namespace that you want information for.
550
550
  */
551
- workspaceId: WorkspaceId;
551
+ name: RuleGroupsNamespaceName;
552
552
  /**
553
- * The rule groups namespace.
553
+ * The ID of the workspace containing the rule groups namespace.
554
554
  */
555
- name: RuleGroupsNamespaceName;
555
+ workspaceId: WorkspaceId;
556
556
  }
557
557
  export interface DescribeRuleGroupsNamespaceResponse {
558
558
  /**
559
- * The selected rule groups namespace.
559
+ * The information about the rule groups namespace.
560
560
  */
561
561
  ruleGroupsNamespace: RuleGroupsNamespaceDescription;
562
562
  }
563
563
  export interface DescribeScraperRequest {
564
564
  /**
565
- * The IDs of the scraper to describe.
565
+ * The ID of the scraper to describe.
566
566
  */
567
567
  scraperId: ScraperId;
568
568
  }
569
569
  export interface DescribeScraperResponse {
570
570
  /**
571
- * The properties of the selected scrapers.
571
+ * Contains details about the scraper.
572
572
  */
573
573
  scraper: ScraperDescription;
574
574
  }
@@ -580,27 +580,27 @@ declare namespace Amp {
580
580
  }
581
581
  export interface DescribeWorkspaceResponse {
582
582
  /**
583
- * The properties of the selected workspace.
583
+ * A structure that contains details about the workspace.
584
584
  */
585
585
  workspace: WorkspaceDescription;
586
586
  }
587
587
  export interface Destination {
588
588
  /**
589
- * A representation of an AMP destination.
589
+ * The Amazon Managed Service for Prometheusworkspace to send metrics to.
590
590
  */
591
591
  ampConfiguration?: AmpConfiguration;
592
592
  }
593
593
  export interface EksConfiguration {
594
594
  /**
595
- * The ARN of an EKS cluster.
595
+ * ARN of the Amazon EKS cluster.
596
596
  */
597
597
  clusterArn: ClusterArn;
598
598
  /**
599
- * A list of security group IDs specified for VPC configuration.
599
+ * A list of the security group IDs for the Amazon EKS cluster VPC configuration.
600
600
  */
601
601
  securityGroupIds?: SecurityGroupIds;
602
602
  /**
603
- * A list of subnet IDs specified for VPC configuration.
603
+ * A list of subnet IDs for the Amazon EKS cluster VPC configuration.
604
604
  */
605
605
  subnetIds: SubnetIds;
606
606
  }
@@ -611,7 +611,7 @@ declare namespace Amp {
611
611
  }
612
612
  export interface GetDefaultScraperConfigurationResponse {
613
613
  /**
614
- * The default configuration.
614
+ * The configuration file. Base 64 encoded. For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User Guide.
615
615
  */
616
616
  configuration: _Blob;
617
617
  }
@@ -620,122 +620,125 @@ declare namespace Amp {
620
620
  export type KmsKeyArn = string;
621
621
  export interface ListRuleGroupsNamespacesRequest {
622
622
  /**
623
- * The ID of the workspace.
623
+ * The maximum number of results to return. The default is 100.
624
624
  */
625
- workspaceId: WorkspaceId;
625
+ maxResults?: ListRuleGroupsNamespacesRequestMaxResultsInteger;
626
626
  /**
627
- * Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.
627
+ * Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned.
628
628
  */
629
629
  name?: RuleGroupsNamespaceName;
630
630
  /**
631
- * Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.
631
+ * The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call. For example, if your initial request has maxResults of 10, and there are 12 rule groups namespaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 namespaces.
632
632
  */
633
633
  nextToken?: PaginationToken;
634
634
  /**
635
- * Maximum results to return in response (default=100, maximum=1000).
635
+ * The ID of the workspace containing the rule groups namespaces.
636
636
  */
637
- maxResults?: ListRuleGroupsNamespacesRequestMaxResultsInteger;
637
+ workspaceId: WorkspaceId;
638
638
  }
639
639
  export type ListRuleGroupsNamespacesRequestMaxResultsInteger = number;
640
640
  export interface ListRuleGroupsNamespacesResponse {
641
641
  /**
642
- * The list of the selected rule groups namespaces.
642
+ * A token indicating that there are more results to retrieve. You can use this token as part of your next ListRuleGroupsNamespaces request to retrieve those results.
643
643
  */
644
- ruleGroupsNamespaces: RuleGroupsNamespaceSummaryList;
644
+ nextToken?: PaginationToken;
645
645
  /**
646
- * Pagination token to use when requesting the next page in this list.
646
+ * The returned list of rule groups namespaces.
647
647
  */
648
- nextToken?: PaginationToken;
648
+ ruleGroupsNamespaces: RuleGroupsNamespaceSummaryList;
649
649
  }
650
650
  export interface ListScrapersRequest {
651
651
  /**
652
- * A list of scraper filters.
652
+ * (Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include status, sourceArn, destinationArn, and alias. Filters on the same key are OR'd together, and filters on different keys are AND'd together. For example, status=ACTIVE&amp;status=CREATING&amp;alias=Test, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING. To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query: status=ACTIVE&amp;destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012 If this is included, it filters the results to only the scrapers that match the filter.
653
653
  */
654
654
  filters?: ScraperFilters;
655
655
  /**
656
- * Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListScrapers request.
656
+ * Optional) The maximum number of scrapers to return in one ListScrapers operation. The range is 1-1000. If you omit this parameter, the default of 100 is used.
657
657
  */
658
- nextToken?: PaginationToken;
658
+ maxResults?: ListScrapersRequestMaxResultsInteger;
659
659
  /**
660
- * Maximum results to return in response (default=100, maximum=1000).
660
+ * (Optional) The token for the next set of items to return. (You received this token from a previous call.)
661
661
  */
662
- maxResults?: ListScrapersRequestMaxResultsInteger;
662
+ nextToken?: PaginationToken;
663
663
  }
664
664
  export type ListScrapersRequestMaxResultsInteger = number;
665
665
  export interface ListScrapersResponse {
666
666
  /**
667
- * The list of scrapers, filtered down if a set of filters was provided in the request.
667
+ * A token indicating that there are more results to retrieve. You can use this token as part of your next ListScrapers operation to retrieve those results.
668
668
  */
669
- scrapers: ScraperSummaryList;
669
+ nextToken?: PaginationToken;
670
670
  /**
671
- * Pagination token to use when requesting the next page in this list.
671
+ * A list of ScraperSummary structures giving information about scrapers in the account that match the filters provided.
672
672
  */
673
- nextToken?: PaginationToken;
673
+ scrapers: ScraperSummaryList;
674
674
  }
675
675
  export interface ListTagsForResourceRequest {
676
676
  /**
677
- * The ARN of the resource.
677
+ * The ARN of the resource to list tages for. Must be a workspace or rule groups namespace resource.
678
678
  */
679
679
  resourceArn: String;
680
680
  }
681
681
  export interface ListTagsForResourceResponse {
682
+ /**
683
+ * The list of tag keys and values associated with the resource.
684
+ */
682
685
  tags?: TagMap;
683
686
  }
684
687
  export interface ListWorkspacesRequest {
685
688
  /**
686
- * Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.
687
- */
688
- nextToken?: PaginationToken;
689
- /**
690
- * Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
689
+ * If this is included, it filters the results to only the workspaces with names that start with the value that you specify here. Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.
691
690
  */
692
691
  alias?: WorkspaceAlias;
693
692
  /**
694
- * Maximum results to return in response (default=100, maximum=1000).
693
+ * The maximum number of workspaces to return per request. The default is 100.
695
694
  */
696
695
  maxResults?: ListWorkspacesRequestMaxResultsInteger;
696
+ /**
697
+ * The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call. For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.
698
+ */
699
+ nextToken?: PaginationToken;
697
700
  }
698
701
  export type ListWorkspacesRequestMaxResultsInteger = number;
699
702
  export interface ListWorkspacesResponse {
700
703
  /**
701
- * The list of existing workspaces, including those undergoing creation or deletion.
704
+ * A token indicating that there are more results to retrieve. You can use this token as part of your next ListWorkspaces request to retrieve those results.
702
705
  */
703
- workspaces: WorkspaceSummaryList;
706
+ nextToken?: PaginationToken;
704
707
  /**
705
- * Pagination token to use when requesting the next page in this list.
708
+ * An array of WorkspaceSummary structures containing information about the workspaces requested.
706
709
  */
707
- nextToken?: PaginationToken;
710
+ workspaces: WorkspaceSummaryList;
708
711
  }
709
712
  export type LogGroupArn = string;
710
713
  export interface LoggingConfigurationMetadata {
711
714
  /**
712
- * The status of the logging configuration.
715
+ * The date and time that the logging configuration was created.
713
716
  */
714
- status: LoggingConfigurationStatus;
717
+ createdAt: Timestamp;
715
718
  /**
716
- * The workspace where the logging configuration exists.
719
+ * The ARN of the CloudWatch log group to which the vended log data will be published.
717
720
  */
718
- workspace: WorkspaceId;
721
+ logGroupArn: LogGroupArn;
719
722
  /**
720
- * The ARN of the CW log group to which the vended log data will be published.
723
+ * The date and time that the logging configuration was most recently changed.
721
724
  */
722
- logGroupArn: LogGroupArn;
725
+ modifiedAt: Timestamp;
723
726
  /**
724
- * The time when the logging configuration was created.
727
+ * The current status of the logging configuration.
725
728
  */
726
- createdAt: Timestamp;
729
+ status: LoggingConfigurationStatus;
727
730
  /**
728
- * The time when the logging configuration was modified.
731
+ * The ID of the workspace the logging configuration is for.
729
732
  */
730
- modifiedAt: Timestamp;
733
+ workspace: WorkspaceId;
731
734
  }
732
735
  export interface LoggingConfigurationStatus {
733
736
  /**
734
- * Status code of the logging configuration.
737
+ * The current status of the logging configuration.
735
738
  */
736
739
  statusCode: LoggingConfigurationStatusCode;
737
740
  /**
738
- * The reason for failure if any.
741
+ * If failed, the reason for the failure.
739
742
  */
740
743
  statusReason?: String;
741
744
  }
@@ -743,57 +746,57 @@ declare namespace Amp {
743
746
  export type PaginationToken = string;
744
747
  export interface PutAlertManagerDefinitionRequest {
745
748
  /**
746
- * The ID of the workspace in which to update the alert manager definition.
749
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
747
750
  */
748
- workspaceId: WorkspaceId;
751
+ clientToken?: IdempotencyToken;
749
752
  /**
750
- * The alert manager definition data.
753
+ * The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file. For details about the alert manager definition, see AlertManagedDefinitionData.
751
754
  */
752
755
  data: AlertManagerDefinitionData;
753
756
  /**
754
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
757
+ * The ID of the workspace to update the alert manager definition in.
755
758
  */
756
- clientToken?: IdempotencyToken;
759
+ workspaceId: WorkspaceId;
757
760
  }
758
761
  export interface PutAlertManagerDefinitionResponse {
759
762
  /**
760
- * The status of alert manager definition.
763
+ * A structure that returns the current status of the alert manager definition.
761
764
  */
762
765
  status: AlertManagerDefinitionStatus;
763
766
  }
764
767
  export interface PutRuleGroupsNamespaceRequest {
765
768
  /**
766
- * The ID of the workspace in which to update the rule group namespace.
769
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
767
770
  */
768
- workspaceId: WorkspaceId;
771
+ clientToken?: IdempotencyToken;
769
772
  /**
770
- * The rule groups namespace name.
773
+ * The new rules file to use in the namespace. A base64-encoded version of the YAML rule groups file. For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
771
774
  */
772
- name: RuleGroupsNamespaceName;
775
+ data: RuleGroupsNamespaceData;
773
776
  /**
774
- * The namespace data that define the rule groups.
777
+ * The name of the rule groups namespace that you are updating.
775
778
  */
776
- data: RuleGroupsNamespaceData;
779
+ name: RuleGroupsNamespaceName;
777
780
  /**
778
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
781
+ * The ID of the workspace where you are updating the rule groups namespace.
779
782
  */
780
- clientToken?: IdempotencyToken;
783
+ workspaceId: WorkspaceId;
781
784
  }
782
785
  export interface PutRuleGroupsNamespaceResponse {
783
786
  /**
784
- * The rule groups namespace name.
787
+ * The ARN of the rule groups namespace.
785
788
  */
786
- name: RuleGroupsNamespaceName;
789
+ arn: RuleGroupsNamespaceArn;
787
790
  /**
788
- * The Amazon Resource Name (ARN) of this rule groups namespace.
791
+ * The name of the rule groups namespace that was updated.
789
792
  */
790
- arn: RuleGroupsNamespaceArn;
793
+ name: RuleGroupsNamespaceName;
791
794
  /**
792
- * The status of rule groups namespace.
795
+ * A structure that includes the current status of the rule groups namespace.
793
796
  */
794
797
  status: RuleGroupsNamespaceStatus;
795
798
  /**
796
- * The tags of this rule groups namespace.
799
+ * The list of tag keys and values that are associated with the namespace.
797
800
  */
798
801
  tags?: TagMap;
799
802
  }
@@ -801,76 +804,76 @@ declare namespace Amp {
801
804
  export type RuleGroupsNamespaceData = Buffer|Uint8Array|Blob|string;
802
805
  export interface RuleGroupsNamespaceDescription {
803
806
  /**
804
- * The Amazon Resource Name (ARN) of this rule groups namespace.
807
+ * The ARN of the rule groups namespace.
805
808
  */
806
809
  arn: RuleGroupsNamespaceArn;
807
810
  /**
808
- * The rule groups namespace name.
811
+ * The date and time that the rule groups namespace was created.
809
812
  */
810
- name: RuleGroupsNamespaceName;
813
+ createdAt: Timestamp;
811
814
  /**
812
- * The status of rule groups namespace.
815
+ * The rule groups file used in the namespace. For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
813
816
  */
814
- status: RuleGroupsNamespaceStatus;
817
+ data: RuleGroupsNamespaceData;
815
818
  /**
816
- * The rule groups namespace data.
819
+ * The date and time that the rule groups namespace was most recently changed.
817
820
  */
818
- data: RuleGroupsNamespaceData;
821
+ modifiedAt: Timestamp;
819
822
  /**
820
- * The time when the rule groups namespace was created.
823
+ * The name of the rule groups namespace.
821
824
  */
822
- createdAt: Timestamp;
825
+ name: RuleGroupsNamespaceName;
823
826
  /**
824
- * The time when the rule groups namespace was modified.
827
+ * The current status of the rule groups namespace.
825
828
  */
826
- modifiedAt: Timestamp;
829
+ status: RuleGroupsNamespaceStatus;
827
830
  /**
828
- * The tags of this rule groups namespace.
831
+ * The list of tag keys and values that are associated with the rule groups namespace.
829
832
  */
830
833
  tags?: TagMap;
831
834
  }
832
835
  export type RuleGroupsNamespaceName = string;
833
836
  export interface RuleGroupsNamespaceStatus {
834
837
  /**
835
- * Status code of this namespace.
838
+ * The current status of the namespace.
836
839
  */
837
840
  statusCode: RuleGroupsNamespaceStatusCode;
838
841
  /**
839
- * The reason for failure if any.
842
+ * The reason for the failure, if any.
840
843
  */
841
844
  statusReason?: String;
842
845
  }
843
846
  export type RuleGroupsNamespaceStatusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"|"UPDATE_FAILED"|string;
844
847
  export interface RuleGroupsNamespaceSummary {
845
848
  /**
846
- * The Amazon Resource Name (ARN) of this rule groups namespace.
849
+ * The ARN of the rule groups namespace.
847
850
  */
848
851
  arn: RuleGroupsNamespaceArn;
849
852
  /**
850
- * The rule groups namespace name.
853
+ * The date and time that the rule groups namespace was created.
851
854
  */
852
- name: RuleGroupsNamespaceName;
855
+ createdAt: Timestamp;
853
856
  /**
854
- * The status of rule groups namespace.
857
+ * The date and time that the rule groups namespace was most recently changed.
855
858
  */
856
- status: RuleGroupsNamespaceStatus;
859
+ modifiedAt: Timestamp;
857
860
  /**
858
- * The time when the rule groups namespace was created.
861
+ * The name of the rule groups namespace.
859
862
  */
860
- createdAt: Timestamp;
863
+ name: RuleGroupsNamespaceName;
861
864
  /**
862
- * The time when the rule groups namespace was modified.
865
+ * A structure that displays the current status of the rule groups namespace.
863
866
  */
864
- modifiedAt: Timestamp;
867
+ status: RuleGroupsNamespaceStatus;
865
868
  /**
866
- * The tags of this rule groups namespace.
869
+ * The list of tag keys and values that are associated with the rule groups namespace.
867
870
  */
868
871
  tags?: TagMap;
869
872
  }
870
873
  export type RuleGroupsNamespaceSummaryList = RuleGroupsNamespaceSummary[];
871
874
  export interface ScrapeConfiguration {
872
875
  /**
873
- * Binary data representing a Prometheus configuration file.
876
+ * The base 64 encoded scrape configuration file.
874
877
  */
875
878
  configurationBlob?: _Blob;
876
879
  }
@@ -878,115 +881,115 @@ declare namespace Amp {
878
881
  export type ScraperArn = string;
879
882
  export interface ScraperDescription {
880
883
  /**
881
- * Alias of this scraper.
884
+ * (Optional) A name associated with the scraper.
882
885
  */
883
886
  alias?: ScraperAlias;
884
887
  /**
885
- * Unique string identifying this scraper.
888
+ * The Amazon Resource Name (ARN) of the scraper.
886
889
  */
887
- scraperId: ScraperId;
890
+ arn: ScraperArn;
888
891
  /**
889
- * The Amazon Resource Name (ARN) of this scraper.
892
+ * The date and time that the scraper was created.
890
893
  */
891
- arn: ScraperArn;
894
+ createdAt: Timestamp;
892
895
  /**
893
- * The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.
896
+ * The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
894
897
  */
895
- roleArn: IamRoleArn;
898
+ destination: Destination;
896
899
  /**
897
- * The status of this scraper.
900
+ * The date and time that the scraper was last modified.
898
901
  */
899
- status: ScraperStatus;
902
+ lastModifiedAt: Timestamp;
900
903
  /**
901
- * The time when the scraper was created.
904
+ * The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
902
905
  */
903
- createdAt: Timestamp;
906
+ roleArn: IamRoleArn;
904
907
  /**
905
- * The time when the scraper was last modified.
908
+ * The configuration file in use by the scraper.
906
909
  */
907
- lastModifiedAt: Timestamp;
910
+ scrapeConfiguration: ScrapeConfiguration;
908
911
  /**
909
- * The tags of this scraper.
912
+ * The ID of the scraper.
910
913
  */
911
- tags?: TagMap;
914
+ scraperId: ScraperId;
912
915
  /**
913
- * The reason for failure if any.
916
+ * The Amazon EKS cluster from which the scraper collects metrics.
914
917
  */
915
- statusReason?: StatusReason;
918
+ source: Source;
916
919
  /**
917
- * The configuration used to create the scraper.
920
+ * A structure that contains the current status of the scraper.
918
921
  */
919
- scrapeConfiguration: ScrapeConfiguration;
922
+ status: ScraperStatus;
920
923
  /**
921
- * The source that the scraper is discovering and collecting metrics from.
924
+ * If there is a failure, the reason for the failure.
922
925
  */
923
- source: Source;
926
+ statusReason?: StatusReason;
924
927
  /**
925
- * The destination that the scraper is producing metrics to.
928
+ * (Optional) The list of tag keys and values associated with the scraper.
926
929
  */
927
- destination: Destination;
930
+ tags?: TagMap;
928
931
  }
929
932
  export type ScraperFilters = {[key: string]: FilterValues};
930
933
  export type ScraperId = string;
931
934
  export interface ScraperStatus {
932
935
  /**
933
- * Status code of this scraper.
936
+ * The current status of the scraper.
934
937
  */
935
938
  statusCode: ScraperStatusCode;
936
939
  }
937
940
  export type ScraperStatusCode = "CREATING"|"ACTIVE"|"DELETING"|"CREATION_FAILED"|"DELETION_FAILED"|string;
938
941
  export interface ScraperSummary {
939
942
  /**
940
- * Alias of this scraper.
943
+ * (Optional) A name associated with the scraper.
941
944
  */
942
945
  alias?: ScraperAlias;
943
946
  /**
944
- * Unique string identifying this scraper.
947
+ * The Amazon Resource Name (ARN) of the scraper.
945
948
  */
946
- scraperId: ScraperId;
949
+ arn: ScraperArn;
947
950
  /**
948
- * The Amazon Resource Name (ARN) of this scraper.
951
+ * The date and time that the scraper was created.
949
952
  */
950
- arn: ScraperArn;
953
+ createdAt: Timestamp;
951
954
  /**
952
- * The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.
955
+ * The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
953
956
  */
954
- roleArn: IamRoleArn;
957
+ destination: Destination;
955
958
  /**
956
- * The status of this scraper.
959
+ * The date and time that the scraper was last modified.
957
960
  */
958
- status: ScraperStatus;
961
+ lastModifiedAt: Timestamp;
959
962
  /**
960
- * The time when the scraper was created.
963
+ * The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
961
964
  */
962
- createdAt: Timestamp;
965
+ roleArn: IamRoleArn;
963
966
  /**
964
- * The time when the scraper was last modified.
967
+ * The ID of the scraper.
965
968
  */
966
- lastModifiedAt: Timestamp;
969
+ scraperId: ScraperId;
967
970
  /**
968
- * The tags of this scraper.
971
+ * The Amazon EKS cluster from which the scraper collects metrics.
969
972
  */
970
- tags?: TagMap;
973
+ source: Source;
971
974
  /**
972
- * The reason for failure if any.
975
+ * A structure that contains the current status of the scraper.
973
976
  */
974
- statusReason?: StatusReason;
977
+ status: ScraperStatus;
975
978
  /**
976
- * The source that the scraper is discovering and collecting metrics from.
979
+ * If there is a failure, the reason for the failure.
977
980
  */
978
- source: Source;
981
+ statusReason?: StatusReason;
979
982
  /**
980
- * The destination that the scraper is producing metrics to.
983
+ * (Optional) The list of tag keys and values associated with the scraper.
981
984
  */
982
- destination: Destination;
985
+ tags?: TagMap;
983
986
  }
984
987
  export type ScraperSummaryList = ScraperSummary[];
985
988
  export type SecurityGroupId = string;
986
989
  export type SecurityGroupIds = SecurityGroupId[];
987
990
  export interface Source {
988
991
  /**
989
- * A representation of an EKS source.
992
+ * The Amazon EKS cluster from which a scraper collects metrics.
990
993
  */
991
994
  eksConfiguration?: EksConfiguration;
992
995
  }
@@ -999,9 +1002,12 @@ declare namespace Amp {
999
1002
  export type TagMap = {[key: string]: TagValue};
1000
1003
  export interface TagResourceRequest {
1001
1004
  /**
1002
- * The ARN of the resource.
1005
+ * The ARN of the workspace or rule groups namespace to apply tags to.
1003
1006
  */
1004
1007
  resourceArn: String;
1008
+ /**
1009
+ * The list of tag keys and values to associate with the resource. Keys may not begin with aws:.
1010
+ */
1005
1011
  tags: TagMap;
1006
1012
  }
1007
1013
  export interface TagResourceResponse {
@@ -1010,11 +1016,11 @@ declare namespace Amp {
1010
1016
  export type Timestamp = Date;
1011
1017
  export interface UntagResourceRequest {
1012
1018
  /**
1013
- * The ARN of the resource.
1019
+ * The ARN of the workspace or rule groups namespace.
1014
1020
  */
1015
1021
  resourceArn: String;
1016
1022
  /**
1017
- * One or more tag keys
1023
+ * The keys of the tags to remove.
1018
1024
  */
1019
1025
  tagKeys: TagKeys;
1020
1026
  }
@@ -1022,112 +1028,112 @@ declare namespace Amp {
1022
1028
  }
1023
1029
  export interface UpdateLoggingConfigurationRequest {
1024
1030
  /**
1025
- * The ID of the workspace to vend logs to.
1031
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
1026
1032
  */
1027
- workspaceId: WorkspaceId;
1033
+ clientToken?: IdempotencyToken;
1028
1034
  /**
1029
- * The ARN of the CW log group to which the vended log data will be published.
1035
+ * The ARN of the CloudWatch log group to which the vended log data will be published.
1030
1036
  */
1031
1037
  logGroupArn: LogGroupArn;
1032
1038
  /**
1033
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
1039
+ * The ID of the workspace to update the logging configuration for.
1034
1040
  */
1035
- clientToken?: IdempotencyToken;
1041
+ workspaceId: WorkspaceId;
1036
1042
  }
1037
1043
  export interface UpdateLoggingConfigurationResponse {
1038
1044
  /**
1039
- * The status of the logging configuration.
1045
+ * A structure that contains the current status of the logging configuration.
1040
1046
  */
1041
1047
  status: LoggingConfigurationStatus;
1042
1048
  }
1043
1049
  export interface UpdateWorkspaceAliasRequest {
1044
1050
  /**
1045
- * The ID of the workspace being updated.
1046
- */
1047
- workspaceId: WorkspaceId;
1048
- /**
1049
- * The new alias of the workspace.
1051
+ * The new alias for the workspace. It does not need to be unique. Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.
1050
1052
  */
1051
1053
  alias?: WorkspaceAlias;
1052
1054
  /**
1053
- * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
1055
+ * A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
1054
1056
  */
1055
1057
  clientToken?: IdempotencyToken;
1058
+ /**
1059
+ * The ID of the workspace to update.
1060
+ */
1061
+ workspaceId: WorkspaceId;
1056
1062
  }
1057
1063
  export type Uri = string;
1058
1064
  export type WorkspaceAlias = string;
1059
1065
  export type WorkspaceArn = string;
1060
1066
  export interface WorkspaceDescription {
1061
1067
  /**
1062
- * Unique string identifying this workspace.
1063
- */
1064
- workspaceId: WorkspaceId;
1065
- /**
1066
- * Alias of this workspace.
1068
+ * The alias that is assigned to this workspace to help identify it. It may not be unique.
1067
1069
  */
1068
1070
  alias?: WorkspaceAlias;
1069
1071
  /**
1070
- * The Amazon Resource Name (ARN) of this workspace.
1072
+ * The ARN of the workspace.
1071
1073
  */
1072
1074
  arn: WorkspaceArn;
1073
1075
  /**
1074
- * The status of this workspace.
1076
+ * The date and time that the workspace was created.
1075
1077
  */
1076
- status: WorkspaceStatus;
1078
+ createdAt: Timestamp;
1077
1079
  /**
1078
- * Prometheus endpoint URI.
1080
+ * (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
1081
+ */
1082
+ kmsKeyArn?: KmsKeyArn;
1083
+ /**
1084
+ * The Prometheus endpoint available for this workspace.
1079
1085
  */
1080
1086
  prometheusEndpoint?: Uri;
1081
1087
  /**
1082
- * The time when the workspace was created.
1088
+ * The current status of the workspace.
1083
1089
  */
1084
- createdAt: Timestamp;
1090
+ status: WorkspaceStatus;
1085
1091
  /**
1086
- * The tags of this workspace.
1092
+ * The list of tag keys and values that are associated with the workspace.
1087
1093
  */
1088
1094
  tags?: TagMap;
1089
1095
  /**
1090
- * The customer managed KMS key of this workspace.
1096
+ * The unique ID for the workspace.
1091
1097
  */
1092
- kmsKeyArn?: KmsKeyArn;
1098
+ workspaceId: WorkspaceId;
1093
1099
  }
1094
1100
  export type WorkspaceId = string;
1095
1101
  export interface WorkspaceStatus {
1096
1102
  /**
1097
- * Status code of this workspace.
1103
+ * The current status of the workspace.
1098
1104
  */
1099
1105
  statusCode: WorkspaceStatusCode;
1100
1106
  }
1101
1107
  export type WorkspaceStatusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"|string;
1102
1108
  export interface WorkspaceSummary {
1103
1109
  /**
1104
- * Unique string identifying this workspace.
1105
- */
1106
- workspaceId: WorkspaceId;
1107
- /**
1108
- * Alias of this workspace.
1110
+ * The alias that is assigned to this workspace to help identify it. It may not be unique.
1109
1111
  */
1110
1112
  alias?: WorkspaceAlias;
1111
1113
  /**
1112
- * The AmazonResourceName of this workspace.
1114
+ * The ARN of the workspace.
1113
1115
  */
1114
1116
  arn: WorkspaceArn;
1115
1117
  /**
1116
- * The status of this workspace.
1118
+ * The date and time that the workspace was created.
1117
1119
  */
1118
- status: WorkspaceStatus;
1120
+ createdAt: Timestamp;
1119
1121
  /**
1120
- * The time when the workspace was created.
1122
+ * (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
1121
1123
  */
1122
- createdAt: Timestamp;
1124
+ kmsKeyArn?: KmsKeyArn;
1123
1125
  /**
1124
- * The tags of this workspace.
1126
+ * The current status of the workspace.
1127
+ */
1128
+ status: WorkspaceStatus;
1129
+ /**
1130
+ * The list of tag keys and values that are associated with the workspace.
1125
1131
  */
1126
1132
  tags?: TagMap;
1127
1133
  /**
1128
- * Customer managed KMS key ARN for this workspace
1134
+ * The unique ID for the workspace.
1129
1135
  */
1130
- kmsKeyArn?: KmsKeyArn;
1136
+ workspaceId: WorkspaceId;
1131
1137
  }
1132
1138
  export type WorkspaceSummaryList = WorkspaceSummary[];
1133
1139
  /**