aws-sdk-prometheusservice 1.28.0 → 1.30.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-prometheusservice/client.rb +424 -258
- data/lib/aws-sdk-prometheusservice/client_api.rb +70 -70
- data/lib/aws-sdk-prometheusservice/errors.rb +15 -15
- data/lib/aws-sdk-prometheusservice/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-prometheusservice/types.rb +717 -564
- data/lib/aws-sdk-prometheusservice.rb +1 -1
- data/sig/client.rbs +402 -0
- data/sig/errors.rbs +51 -0
- data/sig/resource.rbs +79 -0
- data/sig/types.rbs +518 -0
- data/sig/waiters.rbs +53 -0
- metadata +13 -8
@@ -10,7 +10,7 @@
|
|
10
10
|
module Aws::PrometheusService
|
11
11
|
module Types
|
12
12
|
|
13
|
-
#
|
13
|
+
# You do not have sufficient access to perform this action.
|
14
14
|
#
|
15
15
|
# @!attribute [rw] message
|
16
16
|
# Description of the error.
|
@@ -24,43 +24,52 @@ module Aws::PrometheusService
|
|
24
24
|
include Aws::Structure
|
25
25
|
end
|
26
26
|
|
27
|
-
#
|
27
|
+
# The details of an alert manager definition.
|
28
28
|
#
|
29
|
-
# @!attribute [rw]
|
30
|
-
# The
|
31
|
-
# @return [
|
29
|
+
# @!attribute [rw] created_at
|
30
|
+
# The date and time that the alert manager definition was created.
|
31
|
+
# @return [Time]
|
32
32
|
#
|
33
33
|
# @!attribute [rw] data
|
34
|
-
# The alert manager definition.
|
35
|
-
# @return [String]
|
34
|
+
# The actual alert manager definition.
|
36
35
|
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
36
|
+
# For details about the alert manager definition, see
|
37
|
+
# [AlertManagedDefinitionData][1].
|
38
|
+
#
|
39
|
+
#
|
40
|
+
#
|
41
|
+
# [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html
|
42
|
+
# @return [String]
|
40
43
|
#
|
41
44
|
# @!attribute [rw] modified_at
|
42
|
-
# The time
|
45
|
+
# The date and time that the alert manager definition was most
|
46
|
+
# recently changed.
|
43
47
|
# @return [Time]
|
44
48
|
#
|
49
|
+
# @!attribute [rw] status
|
50
|
+
# A structure that displays the current status of the alert manager
|
51
|
+
# definition..
|
52
|
+
# @return [Types::AlertManagerDefinitionStatus]
|
53
|
+
#
|
45
54
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/AlertManagerDefinitionDescription AWS API Documentation
|
46
55
|
#
|
47
56
|
class AlertManagerDefinitionDescription < Struct.new(
|
48
|
-
:status,
|
49
|
-
:data,
|
50
57
|
:created_at,
|
51
|
-
:
|
58
|
+
:data,
|
59
|
+
:modified_at,
|
60
|
+
:status)
|
52
61
|
SENSITIVE = []
|
53
62
|
include Aws::Structure
|
54
63
|
end
|
55
64
|
|
56
|
-
#
|
65
|
+
# The status of the alert manager.
|
57
66
|
#
|
58
67
|
# @!attribute [rw] status_code
|
59
|
-
#
|
68
|
+
# The current status of the alert manager.
|
60
69
|
# @return [String]
|
61
70
|
#
|
62
71
|
# @!attribute [rw] status_reason
|
63
|
-
#
|
72
|
+
# If there is a failure, the reason for the failure.
|
64
73
|
# @return [String]
|
65
74
|
#
|
66
75
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/AlertManagerDefinitionStatus AWS API Documentation
|
@@ -72,10 +81,11 @@ module Aws::PrometheusService
|
|
72
81
|
include Aws::Structure
|
73
82
|
end
|
74
83
|
|
75
|
-
#
|
84
|
+
# The `AmpConfiguration` structure defines the Amazon Managed Service
|
85
|
+
# for Prometheus instance a scraper should send metrics to.
|
76
86
|
#
|
77
87
|
# @!attribute [rw] workspace_arn
|
78
|
-
#
|
88
|
+
# ARN of the Amazon Managed Service for Prometheus workspace.
|
79
89
|
# @return [String]
|
80
90
|
#
|
81
91
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/AmpConfiguration AWS API Documentation
|
@@ -86,7 +96,7 @@ module Aws::PrometheusService
|
|
86
96
|
include Aws::Structure
|
87
97
|
end
|
88
98
|
|
89
|
-
#
|
99
|
+
# The request would cause an inconsistent state.
|
90
100
|
#
|
91
101
|
# @!attribute [rw] message
|
92
102
|
# Description of the error.
|
@@ -110,39 +120,47 @@ module Aws::PrometheusService
|
|
110
120
|
include Aws::Structure
|
111
121
|
end
|
112
122
|
|
113
|
-
# Represents the input of a CreateAlertManagerDefinition operation.
|
123
|
+
# Represents the input of a `CreateAlertManagerDefinition` operation.
|
114
124
|
#
|
115
|
-
# @!attribute [rw]
|
116
|
-
#
|
117
|
-
#
|
125
|
+
# @!attribute [rw] client_token
|
126
|
+
# A unique identifier that you can provide to ensure the idempotency
|
127
|
+
# of the request. Case-sensitive.
|
128
|
+
#
|
129
|
+
# **A suitable default value is auto-generated.** You should normally
|
130
|
+
# not need to pass this option.
|
118
131
|
# @return [String]
|
119
132
|
#
|
120
133
|
# @!attribute [rw] data
|
121
|
-
# The alert manager definition
|
122
|
-
#
|
134
|
+
# The alert manager definition to add. A base64-encoded version of the
|
135
|
+
# YAML alert manager definition file.
|
123
136
|
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
# the idempotency of the request.
|
137
|
+
# For details about the alert manager definition, see
|
138
|
+
# [AlertManagedDefinitionData][1].
|
127
139
|
#
|
128
|
-
#
|
129
|
-
#
|
140
|
+
#
|
141
|
+
#
|
142
|
+
# [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html
|
143
|
+
# @return [String]
|
144
|
+
#
|
145
|
+
# @!attribute [rw] workspace_id
|
146
|
+
# The ID of the workspace to add the alert manager definition to.
|
130
147
|
# @return [String]
|
131
148
|
#
|
132
149
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateAlertManagerDefinitionRequest AWS API Documentation
|
133
150
|
#
|
134
151
|
class CreateAlertManagerDefinitionRequest < Struct.new(
|
135
|
-
:
|
152
|
+
:client_token,
|
136
153
|
:data,
|
137
|
-
:
|
154
|
+
:workspace_id)
|
138
155
|
SENSITIVE = []
|
139
156
|
include Aws::Structure
|
140
157
|
end
|
141
158
|
|
142
|
-
# Represents the output of a CreateAlertManagerDefinition operation.
|
159
|
+
# Represents the output of a `CreateAlertManagerDefinition` operation.
|
143
160
|
#
|
144
161
|
# @!attribute [rw] status
|
145
|
-
#
|
162
|
+
# A structure that displays the current status of the alert manager
|
163
|
+
# definition.
|
146
164
|
# @return [Types::AlertManagerDefinitionStatus]
|
147
165
|
#
|
148
166
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateAlertManagerDefinitionResponse AWS API Documentation
|
@@ -153,39 +171,41 @@ module Aws::PrometheusService
|
|
153
171
|
include Aws::Structure
|
154
172
|
end
|
155
173
|
|
156
|
-
# Represents the input of a CreateLoggingConfiguration operation.
|
174
|
+
# Represents the input of a `CreateLoggingConfiguration` operation.
|
157
175
|
#
|
158
|
-
# @!attribute [rw]
|
159
|
-
#
|
176
|
+
# @!attribute [rw] client_token
|
177
|
+
# A unique identifier that you can provide to ensure the idempotency
|
178
|
+
# of the request. Case-sensitive.
|
179
|
+
#
|
180
|
+
# **A suitable default value is auto-generated.** You should normally
|
181
|
+
# not need to pass this option.
|
160
182
|
# @return [String]
|
161
183
|
#
|
162
184
|
# @!attribute [rw] log_group_arn
|
163
|
-
# The ARN of the
|
164
|
-
# published.
|
185
|
+
# The ARN of the CloudWatch log group to which the vended log data
|
186
|
+
# will be published. This log group must exist prior to calling this
|
187
|
+
# API.
|
165
188
|
# @return [String]
|
166
189
|
#
|
167
|
-
# @!attribute [rw]
|
168
|
-
#
|
169
|
-
# the idempotency of the request.
|
170
|
-
#
|
171
|
-
# **A suitable default value is auto-generated.** You should normally
|
172
|
-
# not need to pass this option.
|
190
|
+
# @!attribute [rw] workspace_id
|
191
|
+
# The ID of the workspace to create the logging configuration for.
|
173
192
|
# @return [String]
|
174
193
|
#
|
175
194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateLoggingConfigurationRequest AWS API Documentation
|
176
195
|
#
|
177
196
|
class CreateLoggingConfigurationRequest < Struct.new(
|
178
|
-
:
|
197
|
+
:client_token,
|
179
198
|
:log_group_arn,
|
180
|
-
:
|
199
|
+
:workspace_id)
|
181
200
|
SENSITIVE = []
|
182
201
|
include Aws::Structure
|
183
202
|
end
|
184
203
|
|
185
|
-
# Represents the output of a CreateLoggingConfiguration operation.
|
204
|
+
# Represents the output of a `CreateLoggingConfiguration` operation.
|
186
205
|
#
|
187
206
|
# @!attribute [rw] status
|
188
|
-
#
|
207
|
+
# A structure that displays the current status of the logging
|
208
|
+
# configuration.
|
189
209
|
# @return [Types::LoggingConfigurationStatus]
|
190
210
|
#
|
191
211
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateLoggingConfigurationResponse AWS API Documentation
|
@@ -196,323 +216,352 @@ module Aws::PrometheusService
|
|
196
216
|
include Aws::Structure
|
197
217
|
end
|
198
218
|
|
199
|
-
# Represents the input of a CreateRuleGroupsNamespace operation.
|
219
|
+
# Represents the input of a `CreateRuleGroupsNamespace` operation.
|
200
220
|
#
|
201
|
-
# @!attribute [rw]
|
202
|
-
#
|
203
|
-
#
|
221
|
+
# @!attribute [rw] client_token
|
222
|
+
# A unique identifier that you can provide to ensure the idempotency
|
223
|
+
# of the request. Case-sensitive.
|
204
224
|
#
|
205
|
-
#
|
206
|
-
#
|
225
|
+
# **A suitable default value is auto-generated.** You should normally
|
226
|
+
# not need to pass this option.
|
207
227
|
# @return [String]
|
208
228
|
#
|
209
229
|
# @!attribute [rw] data
|
210
|
-
# The
|
211
|
-
# @return [String]
|
230
|
+
# The rules file to use in the new namespace.
|
212
231
|
#
|
213
|
-
#
|
214
|
-
# Optional, unique, case-sensitive, user-provided identifier to ensure
|
215
|
-
# the idempotency of the request.
|
232
|
+
# Contains the base64-encoded version of the YAML rules file.
|
216
233
|
#
|
217
|
-
#
|
218
|
-
#
|
234
|
+
# For details about the rule groups namespace structure, see
|
235
|
+
# [RuleGroupsNamespaceData][1].
|
236
|
+
#
|
237
|
+
#
|
238
|
+
#
|
239
|
+
# [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html
|
240
|
+
# @return [String]
|
241
|
+
#
|
242
|
+
# @!attribute [rw] name
|
243
|
+
# The name for the new rule groups namespace.
|
219
244
|
# @return [String]
|
220
245
|
#
|
221
246
|
# @!attribute [rw] tags
|
222
|
-
#
|
247
|
+
# The list of tag keys and values to associate with the rule groups
|
248
|
+
# namespace.
|
223
249
|
# @return [Hash<String,String>]
|
224
250
|
#
|
251
|
+
# @!attribute [rw] workspace_id
|
252
|
+
# The ID of the workspace to add the rule groups namespace.
|
253
|
+
# @return [String]
|
254
|
+
#
|
225
255
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateRuleGroupsNamespaceRequest AWS API Documentation
|
226
256
|
#
|
227
257
|
class CreateRuleGroupsNamespaceRequest < Struct.new(
|
228
|
-
:workspace_id,
|
229
|
-
:name,
|
230
|
-
:data,
|
231
258
|
:client_token,
|
232
|
-
:
|
259
|
+
:data,
|
260
|
+
:name,
|
261
|
+
:tags,
|
262
|
+
:workspace_id)
|
233
263
|
SENSITIVE = []
|
234
264
|
include Aws::Structure
|
235
265
|
end
|
236
266
|
|
237
|
-
# Represents the output of a CreateRuleGroupsNamespace operation.
|
267
|
+
# Represents the output of a `CreateRuleGroupsNamespace` operation.
|
238
268
|
#
|
239
|
-
# @!attribute [rw]
|
240
|
-
# The rule groups namespace
|
269
|
+
# @!attribute [rw] arn
|
270
|
+
# The Amazon Resource Name (ARN) of the new rule groups namespace.
|
241
271
|
# @return [String]
|
242
272
|
#
|
243
|
-
# @!attribute [rw]
|
244
|
-
# The
|
273
|
+
# @!attribute [rw] name
|
274
|
+
# The name of the new rule groups namespace.
|
245
275
|
# @return [String]
|
246
276
|
#
|
247
277
|
# @!attribute [rw] status
|
248
|
-
#
|
278
|
+
# A structure that returns the current status of the rule groups
|
279
|
+
# namespace.
|
249
280
|
# @return [Types::RuleGroupsNamespaceStatus]
|
250
281
|
#
|
251
282
|
# @!attribute [rw] tags
|
252
|
-
# The
|
283
|
+
# The list of tag keys and values that are associated with the
|
284
|
+
# namespace.
|
253
285
|
# @return [Hash<String,String>]
|
254
286
|
#
|
255
287
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateRuleGroupsNamespaceResponse AWS API Documentation
|
256
288
|
#
|
257
289
|
class CreateRuleGroupsNamespaceResponse < Struct.new(
|
258
|
-
:name,
|
259
290
|
:arn,
|
291
|
+
:name,
|
260
292
|
:status,
|
261
293
|
:tags)
|
262
294
|
SENSITIVE = []
|
263
295
|
include Aws::Structure
|
264
296
|
end
|
265
297
|
|
266
|
-
# Represents the input of a CreateScraper operation.
|
298
|
+
# Represents the input of a `CreateScraper` operation.
|
267
299
|
#
|
268
300
|
# @!attribute [rw] alias
|
269
|
-
#
|
270
|
-
#
|
301
|
+
# (optional) a name to associate with the scraper. This is for your
|
302
|
+
# use, and does not need to be unique.
|
271
303
|
# @return [String]
|
272
304
|
#
|
273
|
-
# @!attribute [rw]
|
274
|
-
#
|
275
|
-
#
|
305
|
+
# @!attribute [rw] client_token
|
306
|
+
# (Optional) A unique, case-sensitive identifier that you can provide
|
307
|
+
# to ensure the idempotency of the request.
|
276
308
|
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
# @return [Types::Source]
|
309
|
+
# **A suitable default value is auto-generated.** You should normally
|
310
|
+
# not need to pass this option.
|
311
|
+
# @return [String]
|
281
312
|
#
|
282
313
|
# @!attribute [rw] destination
|
283
|
-
# The
|
314
|
+
# The Amazon Managed Service for Prometheus workspace to send metrics
|
315
|
+
# to.
|
284
316
|
# @return [Types::Destination]
|
285
317
|
#
|
286
|
-
# @!attribute [rw]
|
287
|
-
#
|
288
|
-
#
|
318
|
+
# @!attribute [rw] scrape_configuration
|
319
|
+
# The configuration file to use in the new scraper. For more
|
320
|
+
# information, see [Scraper
|
321
|
+
# configuration](prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)
|
322
|
+
# in the *Amazon Managed Service for Prometheus User Guide*.
|
323
|
+
# @return [Types::ScrapeConfiguration]
|
289
324
|
#
|
290
|
-
#
|
291
|
-
#
|
292
|
-
# @return [
|
325
|
+
# @!attribute [rw] source
|
326
|
+
# The Amazon EKS cluster from which the scraper will collect metrics.
|
327
|
+
# @return [Types::Source]
|
293
328
|
#
|
294
329
|
# @!attribute [rw] tags
|
295
|
-
# Optional
|
330
|
+
# (Optional) The list of tag keys and values to associate with the
|
331
|
+
# scraper.
|
296
332
|
# @return [Hash<String,String>]
|
297
333
|
#
|
298
334
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateScraperRequest AWS API Documentation
|
299
335
|
#
|
300
336
|
class CreateScraperRequest < Struct.new(
|
301
337
|
:alias,
|
338
|
+
:client_token,
|
339
|
+
:destination,
|
302
340
|
:scrape_configuration,
|
303
341
|
:source,
|
304
|
-
:destination,
|
305
|
-
:client_token,
|
306
342
|
:tags)
|
307
343
|
SENSITIVE = []
|
308
344
|
include Aws::Structure
|
309
345
|
end
|
310
346
|
|
311
|
-
# Represents the output of a CreateScraper operation.
|
347
|
+
# Represents the output of a `CreateScraper` operation.
|
312
348
|
#
|
313
|
-
# @!attribute [rw]
|
314
|
-
# The
|
349
|
+
# @!attribute [rw] arn
|
350
|
+
# The Amazon Resource Name (ARN) of the new scraper.
|
315
351
|
# @return [String]
|
316
352
|
#
|
317
|
-
# @!attribute [rw]
|
318
|
-
# The
|
353
|
+
# @!attribute [rw] scraper_id
|
354
|
+
# The ID of the new scraper.
|
319
355
|
# @return [String]
|
320
356
|
#
|
321
357
|
# @!attribute [rw] status
|
322
|
-
#
|
358
|
+
# A structure that displays the current status of the scraper.
|
323
359
|
# @return [Types::ScraperStatus]
|
324
360
|
#
|
325
361
|
# @!attribute [rw] tags
|
326
|
-
# The
|
362
|
+
# The list of tag keys and values that are associated with the
|
363
|
+
# scraper.
|
327
364
|
# @return [Hash<String,String>]
|
328
365
|
#
|
329
366
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateScraperResponse AWS API Documentation
|
330
367
|
#
|
331
368
|
class CreateScraperResponse < Struct.new(
|
332
|
-
:scraper_id,
|
333
369
|
:arn,
|
370
|
+
:scraper_id,
|
334
371
|
:status,
|
335
372
|
:tags)
|
336
373
|
SENSITIVE = []
|
337
374
|
include Aws::Structure
|
338
375
|
end
|
339
376
|
|
340
|
-
# Represents the input of a CreateWorkspace operation.
|
377
|
+
# Represents the input of a `CreateWorkspace` operation.
|
341
378
|
#
|
342
379
|
# @!attribute [rw] alias
|
343
|
-
# An
|
344
|
-
#
|
380
|
+
# An alias that you assign to this workspace to help you identify it.
|
381
|
+
# It does not need to be unique.
|
382
|
+
#
|
383
|
+
# Blank spaces at the beginning or end of the alias that you specify
|
384
|
+
# will be trimmed from the value used.
|
345
385
|
# @return [String]
|
346
386
|
#
|
347
387
|
# @!attribute [rw] client_token
|
348
|
-
#
|
349
|
-
#
|
388
|
+
# A unique identifier that you can provide to ensure the idempotency
|
389
|
+
# of the request. Case-sensitive.
|
350
390
|
#
|
351
391
|
# **A suitable default value is auto-generated.** You should normally
|
352
392
|
# not need to pass this option.
|
353
393
|
# @return [String]
|
354
394
|
#
|
355
|
-
# @!attribute [rw] tags
|
356
|
-
# Optional, user-provided tags for this workspace.
|
357
|
-
# @return [Hash<String,String>]
|
358
|
-
#
|
359
395
|
# @!attribute [rw] kms_key_arn
|
360
|
-
#
|
361
|
-
# workspace
|
396
|
+
# (optional) The ARN for a customer managed KMS key to use for
|
397
|
+
# encrypting data within your workspace. For more information about
|
398
|
+
# using your own key in your workspace, see [Encryption at rest][1] in
|
399
|
+
# the *Amazon Managed Service for Prometheus User Guide*.
|
400
|
+
#
|
401
|
+
#
|
402
|
+
#
|
403
|
+
# [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html
|
362
404
|
# @return [String]
|
363
405
|
#
|
406
|
+
# @!attribute [rw] tags
|
407
|
+
# The list of tag keys and values to associate with the workspace.
|
408
|
+
# @return [Hash<String,String>]
|
409
|
+
#
|
364
410
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateWorkspaceRequest AWS API Documentation
|
365
411
|
#
|
366
412
|
class CreateWorkspaceRequest < Struct.new(
|
367
413
|
:alias,
|
368
414
|
:client_token,
|
369
|
-
:
|
370
|
-
:
|
415
|
+
:kms_key_arn,
|
416
|
+
:tags)
|
371
417
|
SENSITIVE = []
|
372
418
|
include Aws::Structure
|
373
419
|
end
|
374
420
|
|
375
|
-
# Represents the output of a CreateWorkspace operation.
|
421
|
+
# Represents the output of a `CreateWorkspace` operation.
|
376
422
|
#
|
377
|
-
# @!attribute [rw]
|
378
|
-
# The
|
423
|
+
# @!attribute [rw] arn
|
424
|
+
# The ARN for the new workspace.
|
379
425
|
# @return [String]
|
380
426
|
#
|
381
|
-
# @!attribute [rw]
|
382
|
-
#
|
427
|
+
# @!attribute [rw] kms_key_arn
|
428
|
+
# (optional) If the workspace was created with a customer managed KMS
|
429
|
+
# key, the ARN for the key used.
|
383
430
|
# @return [String]
|
384
431
|
#
|
385
432
|
# @!attribute [rw] status
|
386
|
-
# The status of the workspace
|
387
|
-
# CREATING
|
433
|
+
# The current status of the new workspace. Immediately after you
|
434
|
+
# create the workspace, the status is usually `CREATING`.
|
388
435
|
# @return [Types::WorkspaceStatus]
|
389
436
|
#
|
390
437
|
# @!attribute [rw] tags
|
391
|
-
# The
|
438
|
+
# The list of tag keys and values that are associated with the
|
439
|
+
# workspace.
|
392
440
|
# @return [Hash<String,String>]
|
393
441
|
#
|
394
|
-
# @!attribute [rw]
|
395
|
-
#
|
442
|
+
# @!attribute [rw] workspace_id
|
443
|
+
# The unique ID for the new workspace.
|
396
444
|
# @return [String]
|
397
445
|
#
|
398
446
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateWorkspaceResponse AWS API Documentation
|
399
447
|
#
|
400
448
|
class CreateWorkspaceResponse < Struct.new(
|
401
|
-
:workspace_id,
|
402
449
|
:arn,
|
450
|
+
:kms_key_arn,
|
403
451
|
:status,
|
404
452
|
:tags,
|
405
|
-
:
|
453
|
+
:workspace_id)
|
406
454
|
SENSITIVE = []
|
407
455
|
include Aws::Structure
|
408
456
|
end
|
409
457
|
|
410
|
-
# Represents the input of a DeleteAlertManagerDefinition operation.
|
411
|
-
#
|
412
|
-
# @!attribute [rw] workspace_id
|
413
|
-
# The ID of the workspace in which to delete the alert manager
|
414
|
-
# definition.
|
415
|
-
# @return [String]
|
458
|
+
# Represents the input of a `DeleteAlertManagerDefinition` operation.
|
416
459
|
#
|
417
460
|
# @!attribute [rw] client_token
|
418
|
-
#
|
419
|
-
#
|
461
|
+
# A unique identifier that you can provide to ensure the idempotency
|
462
|
+
# of the request. Case-sensitive.
|
420
463
|
#
|
421
464
|
# **A suitable default value is auto-generated.** You should normally
|
422
465
|
# not need to pass this option.
|
423
466
|
# @return [String]
|
424
467
|
#
|
468
|
+
# @!attribute [rw] workspace_id
|
469
|
+
# The ID of the workspace to delete the alert manager definition from.
|
470
|
+
# @return [String]
|
471
|
+
#
|
425
472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteAlertManagerDefinitionRequest AWS API Documentation
|
426
473
|
#
|
427
474
|
class DeleteAlertManagerDefinitionRequest < Struct.new(
|
428
|
-
:
|
429
|
-
:
|
475
|
+
:client_token,
|
476
|
+
:workspace_id)
|
430
477
|
SENSITIVE = []
|
431
478
|
include Aws::Structure
|
432
479
|
end
|
433
480
|
|
434
|
-
# Represents the input of a DeleteLoggingConfiguration operation.
|
435
|
-
#
|
436
|
-
# @!attribute [rw] workspace_id
|
437
|
-
# The ID of the workspace to vend logs to.
|
438
|
-
# @return [String]
|
481
|
+
# Represents the input of a `DeleteLoggingConfiguration` operation.
|
439
482
|
#
|
440
483
|
# @!attribute [rw] client_token
|
441
|
-
#
|
442
|
-
#
|
484
|
+
# A unique identifier that you can provide to ensure the idempotency
|
485
|
+
# of the request. Case-sensitive.
|
443
486
|
#
|
444
487
|
# **A suitable default value is auto-generated.** You should normally
|
445
488
|
# not need to pass this option.
|
446
489
|
# @return [String]
|
447
490
|
#
|
491
|
+
# @!attribute [rw] workspace_id
|
492
|
+
# The ID of the workspace containing the logging configuration to
|
493
|
+
# delete.
|
494
|
+
# @return [String]
|
495
|
+
#
|
448
496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteLoggingConfigurationRequest AWS API Documentation
|
449
497
|
#
|
450
498
|
class DeleteLoggingConfigurationRequest < Struct.new(
|
451
|
-
:
|
452
|
-
:
|
499
|
+
:client_token,
|
500
|
+
:workspace_id)
|
453
501
|
SENSITIVE = []
|
454
502
|
include Aws::Structure
|
455
503
|
end
|
456
504
|
|
457
|
-
# Represents the input of a DeleteRuleGroupsNamespace operation.
|
505
|
+
# Represents the input of a `DeleteRuleGroupsNamespace` operation.
|
458
506
|
#
|
459
|
-
# @!attribute [rw]
|
460
|
-
#
|
507
|
+
# @!attribute [rw] client_token
|
508
|
+
# A unique identifier that you can provide to ensure the idempotency
|
509
|
+
# of the request. Case-sensitive.
|
510
|
+
#
|
511
|
+
# **A suitable default value is auto-generated.** You should normally
|
512
|
+
# not need to pass this option.
|
461
513
|
# @return [String]
|
462
514
|
#
|
463
515
|
# @!attribute [rw] name
|
464
|
-
# The rule groups namespace
|
516
|
+
# The name of the rule groups namespace to delete.
|
465
517
|
# @return [String]
|
466
518
|
#
|
467
|
-
# @!attribute [rw]
|
468
|
-
#
|
469
|
-
#
|
470
|
-
#
|
471
|
-
# **A suitable default value is auto-generated.** You should normally
|
472
|
-
# not need to pass this option.
|
519
|
+
# @!attribute [rw] workspace_id
|
520
|
+
# The ID of the workspace containing the rule groups namespace and
|
521
|
+
# definition to delete.
|
473
522
|
# @return [String]
|
474
523
|
#
|
475
524
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteRuleGroupsNamespaceRequest AWS API Documentation
|
476
525
|
#
|
477
526
|
class DeleteRuleGroupsNamespaceRequest < Struct.new(
|
478
|
-
:
|
527
|
+
:client_token,
|
479
528
|
:name,
|
480
|
-
:
|
529
|
+
:workspace_id)
|
481
530
|
SENSITIVE = []
|
482
531
|
include Aws::Structure
|
483
532
|
end
|
484
533
|
|
485
|
-
# Represents the input of a DeleteScraper operation.
|
486
|
-
#
|
487
|
-
# @!attribute [rw] scraper_id
|
488
|
-
# The ID of the scraper to delete.
|
489
|
-
# @return [String]
|
534
|
+
# Represents the input of a `DeleteScraper` operation.
|
490
535
|
#
|
491
536
|
# @!attribute [rw] client_token
|
492
|
-
# Optional
|
493
|
-
# the idempotency of the request.
|
537
|
+
# (Optional) A unique, case-sensitive identifier that you can provide
|
538
|
+
# to ensure the idempotency of the request.
|
494
539
|
#
|
495
540
|
# **A suitable default value is auto-generated.** You should normally
|
496
541
|
# not need to pass this option.
|
497
542
|
# @return [String]
|
498
543
|
#
|
544
|
+
# @!attribute [rw] scraper_id
|
545
|
+
# The ID of the scraper to delete.
|
546
|
+
# @return [String]
|
547
|
+
#
|
499
548
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteScraperRequest AWS API Documentation
|
500
549
|
#
|
501
550
|
class DeleteScraperRequest < Struct.new(
|
502
|
-
:
|
503
|
-
:
|
551
|
+
:client_token,
|
552
|
+
:scraper_id)
|
504
553
|
SENSITIVE = []
|
505
554
|
include Aws::Structure
|
506
555
|
end
|
507
556
|
|
508
|
-
# Represents the output of a DeleteScraper operation.
|
557
|
+
# Represents the output of a `DeleteScraper` operation.
|
509
558
|
#
|
510
559
|
# @!attribute [rw] scraper_id
|
511
|
-
# The ID of the scraper
|
560
|
+
# The ID of the scraper to delete.
|
512
561
|
# @return [String]
|
513
562
|
#
|
514
563
|
# @!attribute [rw] status
|
515
|
-
# The status of the scraper
|
564
|
+
# The current status of the scraper.
|
516
565
|
# @return [Types::ScraperStatus]
|
517
566
|
#
|
518
567
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteScraperResponse AWS API Documentation
|
@@ -524,33 +573,34 @@ module Aws::PrometheusService
|
|
524
573
|
include Aws::Structure
|
525
574
|
end
|
526
575
|
|
527
|
-
# Represents the input of a DeleteWorkspace operation.
|
528
|
-
#
|
529
|
-
# @!attribute [rw] workspace_id
|
530
|
-
# The ID of the workspace to delete.
|
531
|
-
# @return [String]
|
576
|
+
# Represents the input of a `DeleteWorkspace` operation.
|
532
577
|
#
|
533
578
|
# @!attribute [rw] client_token
|
534
|
-
#
|
535
|
-
#
|
579
|
+
# A unique identifier that you can provide to ensure the idempotency
|
580
|
+
# of the request. Case-sensitive.
|
536
581
|
#
|
537
582
|
# **A suitable default value is auto-generated.** You should normally
|
538
583
|
# not need to pass this option.
|
539
584
|
# @return [String]
|
540
585
|
#
|
586
|
+
# @!attribute [rw] workspace_id
|
587
|
+
# The ID of the workspace to delete.
|
588
|
+
# @return [String]
|
589
|
+
#
|
541
590
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteWorkspaceRequest AWS API Documentation
|
542
591
|
#
|
543
592
|
class DeleteWorkspaceRequest < Struct.new(
|
544
|
-
:
|
545
|
-
:
|
593
|
+
:client_token,
|
594
|
+
:workspace_id)
|
546
595
|
SENSITIVE = []
|
547
596
|
include Aws::Structure
|
548
597
|
end
|
549
598
|
|
550
|
-
# Represents the input of a DescribeAlertManagerDefinition operation.
|
599
|
+
# Represents the input of a `DescribeAlertManagerDefinition` operation.
|
551
600
|
#
|
552
601
|
# @!attribute [rw] workspace_id
|
553
|
-
# The ID of the workspace to
|
602
|
+
# The ID of the workspace to retrieve the alert manager definition
|
603
|
+
# from.
|
554
604
|
# @return [String]
|
555
605
|
#
|
556
606
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeAlertManagerDefinitionRequest AWS API Documentation
|
@@ -561,11 +611,10 @@ module Aws::PrometheusService
|
|
561
611
|
include Aws::Structure
|
562
612
|
end
|
563
613
|
|
564
|
-
# Represents the output of a DescribeAlertManagerDefinition operation.
|
614
|
+
# Represents the output of a `DescribeAlertManagerDefinition` operation.
|
565
615
|
#
|
566
616
|
# @!attribute [rw] alert_manager_definition
|
567
|
-
# The
|
568
|
-
# definition.
|
617
|
+
# The alert manager definition.
|
569
618
|
# @return [Types::AlertManagerDefinitionDescription]
|
570
619
|
#
|
571
620
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeAlertManagerDefinitionResponse AWS API Documentation
|
@@ -576,10 +625,10 @@ module Aws::PrometheusService
|
|
576
625
|
include Aws::Structure
|
577
626
|
end
|
578
627
|
|
579
|
-
# Represents the input of a DescribeLoggingConfiguration operation.
|
628
|
+
# Represents the input of a `DescribeLoggingConfiguration` operation.
|
580
629
|
#
|
581
630
|
# @!attribute [rw] workspace_id
|
582
|
-
# The ID of the workspace to
|
631
|
+
# The ID of the workspace to describe the logging configuration for.
|
583
632
|
# @return [String]
|
584
633
|
#
|
585
634
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeLoggingConfigurationRequest AWS API Documentation
|
@@ -590,11 +639,11 @@ module Aws::PrometheusService
|
|
590
639
|
include Aws::Structure
|
591
640
|
end
|
592
641
|
|
593
|
-
# Represents the output of a DescribeLoggingConfiguration operation.
|
642
|
+
# Represents the output of a `DescribeLoggingConfiguration` operation.
|
594
643
|
#
|
595
644
|
# @!attribute [rw] logging_configuration
|
596
|
-
#
|
597
|
-
# configuration
|
645
|
+
# A structure that displays the information about the logging
|
646
|
+
# configuration.
|
598
647
|
# @return [Types::LoggingConfigurationMetadata]
|
599
648
|
#
|
600
649
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeLoggingConfigurationResponse AWS API Documentation
|
@@ -605,29 +654,29 @@ module Aws::PrometheusService
|
|
605
654
|
include Aws::Structure
|
606
655
|
end
|
607
656
|
|
608
|
-
# Represents the input of a DescribeRuleGroupsNamespace operation.
|
657
|
+
# Represents the input of a `DescribeRuleGroupsNamespace` operation.
|
609
658
|
#
|
610
|
-
# @!attribute [rw]
|
611
|
-
# The
|
659
|
+
# @!attribute [rw] name
|
660
|
+
# The name of the rule groups namespace that you want information for.
|
612
661
|
# @return [String]
|
613
662
|
#
|
614
|
-
# @!attribute [rw]
|
615
|
-
# The rule groups namespace.
|
663
|
+
# @!attribute [rw] workspace_id
|
664
|
+
# The ID of the workspace containing the rule groups namespace.
|
616
665
|
# @return [String]
|
617
666
|
#
|
618
667
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeRuleGroupsNamespaceRequest AWS API Documentation
|
619
668
|
#
|
620
669
|
class DescribeRuleGroupsNamespaceRequest < Struct.new(
|
621
|
-
:
|
622
|
-
:
|
670
|
+
:name,
|
671
|
+
:workspace_id)
|
623
672
|
SENSITIVE = []
|
624
673
|
include Aws::Structure
|
625
674
|
end
|
626
675
|
|
627
|
-
# Represents the output of a DescribeRuleGroupsNamespace operation.
|
676
|
+
# Represents the output of a `DescribeRuleGroupsNamespace` operation.
|
628
677
|
#
|
629
678
|
# @!attribute [rw] rule_groups_namespace
|
630
|
-
# The
|
679
|
+
# The information about the rule groups namespace.
|
631
680
|
# @return [Types::RuleGroupsNamespaceDescription]
|
632
681
|
#
|
633
682
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeRuleGroupsNamespaceResponse AWS API Documentation
|
@@ -638,10 +687,10 @@ module Aws::PrometheusService
|
|
638
687
|
include Aws::Structure
|
639
688
|
end
|
640
689
|
|
641
|
-
# Represents the input of a DescribeScraper operation.
|
690
|
+
# Represents the input of a `DescribeScraper` operation.
|
642
691
|
#
|
643
692
|
# @!attribute [rw] scraper_id
|
644
|
-
# The
|
693
|
+
# The ID of the scraper to describe.
|
645
694
|
# @return [String]
|
646
695
|
#
|
647
696
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeScraperRequest AWS API Documentation
|
@@ -652,10 +701,10 @@ module Aws::PrometheusService
|
|
652
701
|
include Aws::Structure
|
653
702
|
end
|
654
703
|
|
655
|
-
# Represents the output of a DescribeScraper operation.
|
704
|
+
# Represents the output of a `DescribeScraper` operation.
|
656
705
|
#
|
657
706
|
# @!attribute [rw] scraper
|
658
|
-
#
|
707
|
+
# Contains details about the scraper.
|
659
708
|
# @return [Types::ScraperDescription]
|
660
709
|
#
|
661
710
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeScraperResponse AWS API Documentation
|
@@ -666,7 +715,7 @@ module Aws::PrometheusService
|
|
666
715
|
include Aws::Structure
|
667
716
|
end
|
668
717
|
|
669
|
-
# Represents the input of a DescribeWorkspace operation.
|
718
|
+
# Represents the input of a `DescribeWorkspace` operation.
|
670
719
|
#
|
671
720
|
# @!attribute [rw] workspace_id
|
672
721
|
# The ID of the workspace to describe.
|
@@ -680,10 +729,10 @@ module Aws::PrometheusService
|
|
680
729
|
include Aws::Structure
|
681
730
|
end
|
682
731
|
|
683
|
-
# Represents the output of a DescribeWorkspace operation.
|
732
|
+
# Represents the output of a `DescribeWorkspace` operation.
|
684
733
|
#
|
685
734
|
# @!attribute [rw] workspace
|
686
|
-
#
|
735
|
+
# A structure that contains details about the workspace.
|
687
736
|
# @return [Types::WorkspaceDescription]
|
688
737
|
#
|
689
738
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeWorkspaceResponse AWS API Documentation
|
@@ -694,15 +743,15 @@ module Aws::PrometheusService
|
|
694
743
|
include Aws::Structure
|
695
744
|
end
|
696
745
|
|
697
|
-
#
|
698
|
-
# to.
|
746
|
+
# Where to send the metrics from a scraper.
|
699
747
|
#
|
700
748
|
# @note Destination is a union - when making an API calls you must set exactly one of the members.
|
701
749
|
#
|
702
750
|
# @note Destination is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Destination corresponding to the set member.
|
703
751
|
#
|
704
752
|
# @!attribute [rw] amp_configuration
|
705
|
-
#
|
753
|
+
# The Amazon Managed Service for Prometheusworkspace to send metrics
|
754
|
+
# to.
|
706
755
|
# @return [Types::AmpConfiguration]
|
707
756
|
#
|
708
757
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/Destination AWS API Documentation
|
@@ -718,18 +767,20 @@ module Aws::PrometheusService
|
|
718
767
|
class Unknown < Destination; end
|
719
768
|
end
|
720
769
|
|
721
|
-
#
|
770
|
+
# The `EksConfiguration` structure describes the connection to the
|
771
|
+
# Amazon EKS cluster from which a scraper collects metrics.
|
722
772
|
#
|
723
773
|
# @!attribute [rw] cluster_arn
|
724
|
-
#
|
774
|
+
# ARN of the Amazon EKS cluster.
|
725
775
|
# @return [String]
|
726
776
|
#
|
727
777
|
# @!attribute [rw] security_group_ids
|
728
|
-
# A list of security group IDs
|
778
|
+
# A list of the security group IDs for the Amazon EKS cluster VPC
|
779
|
+
# configuration.
|
729
780
|
# @return [Array<String>]
|
730
781
|
#
|
731
782
|
# @!attribute [rw] subnet_ids
|
732
|
-
# A list of subnet IDs
|
783
|
+
# A list of subnet IDs for the Amazon EKS cluster VPC configuration.
|
733
784
|
# @return [Array<String>]
|
734
785
|
#
|
735
786
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/EksConfiguration AWS API Documentation
|
@@ -742,7 +793,7 @@ module Aws::PrometheusService
|
|
742
793
|
include Aws::Structure
|
743
794
|
end
|
744
795
|
|
745
|
-
# Represents the input of a GetDefaultScraperConfiguration operation.
|
796
|
+
# Represents the input of a `GetDefaultScraperConfiguration` operation.
|
746
797
|
#
|
747
798
|
# @api private
|
748
799
|
#
|
@@ -750,10 +801,16 @@ module Aws::PrometheusService
|
|
750
801
|
#
|
751
802
|
class GetDefaultScraperConfigurationRequest < Aws::EmptyStructure; end
|
752
803
|
|
753
|
-
# Represents the output of a GetDefaultScraperConfiguration operation.
|
804
|
+
# Represents the output of a `GetDefaultScraperConfiguration` operation.
|
754
805
|
#
|
755
806
|
# @!attribute [rw] configuration
|
756
|
-
# The
|
807
|
+
# The configuration file. Base 64 encoded. For more information, see
|
808
|
+
# [Scraper configuration][1]in the *Amazon Managed Service for
|
809
|
+
# Prometheus User Guide*.
|
810
|
+
#
|
811
|
+
#
|
812
|
+
#
|
813
|
+
# [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration
|
757
814
|
# @return [String]
|
758
815
|
#
|
759
816
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/GetDefaultScraperConfigurationResponse AWS API Documentation
|
@@ -764,7 +821,7 @@ module Aws::PrometheusService
|
|
764
821
|
include Aws::Structure
|
765
822
|
end
|
766
823
|
|
767
|
-
#
|
824
|
+
# An unexpected error occurred during the processing of the request.
|
768
825
|
#
|
769
826
|
# @!attribute [rw] message
|
770
827
|
# Description of the error.
|
@@ -783,105 +840,135 @@ module Aws::PrometheusService
|
|
783
840
|
include Aws::Structure
|
784
841
|
end
|
785
842
|
|
786
|
-
# Represents the input of a ListRuleGroupsNamespaces operation.
|
843
|
+
# Represents the input of a `ListRuleGroupsNamespaces` operation.
|
787
844
|
#
|
788
|
-
# @!attribute [rw]
|
789
|
-
# The
|
790
|
-
# @return [
|
845
|
+
# @!attribute [rw] max_results
|
846
|
+
# The maximum number of results to return. The default is 100.
|
847
|
+
# @return [Integer]
|
791
848
|
#
|
792
849
|
# @!attribute [rw] name
|
793
|
-
#
|
794
|
-
#
|
850
|
+
# Use this parameter to filter the rule groups namespaces that are
|
851
|
+
# returned. Only the namespaces with names that begin with the value
|
852
|
+
# that you specify are returned.
|
795
853
|
# @return [String]
|
796
854
|
#
|
797
855
|
# @!attribute [rw] next_token
|
798
|
-
#
|
799
|
-
# token
|
800
|
-
#
|
856
|
+
# The token for the next set of items to return. You receive this
|
857
|
+
# token from a previous call, and use it to get the next page of
|
858
|
+
# results. The other parameters must be the same as the initial call.
|
859
|
+
#
|
860
|
+
# For example, if your initial request has `maxResults` of 10, and
|
861
|
+
# there are 12 rule groups namespaces to return, then your initial
|
862
|
+
# request will return 10 and a `nextToken`. Using the next token in a
|
863
|
+
# subsequent call will return the remaining 2 namespaces.
|
801
864
|
# @return [String]
|
802
865
|
#
|
803
|
-
# @!attribute [rw]
|
804
|
-
#
|
805
|
-
# @return [
|
866
|
+
# @!attribute [rw] workspace_id
|
867
|
+
# The ID of the workspace containing the rule groups namespaces.
|
868
|
+
# @return [String]
|
806
869
|
#
|
807
870
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListRuleGroupsNamespacesRequest AWS API Documentation
|
808
871
|
#
|
809
872
|
class ListRuleGroupsNamespacesRequest < Struct.new(
|
810
|
-
:
|
873
|
+
:max_results,
|
811
874
|
:name,
|
812
875
|
:next_token,
|
813
|
-
:
|
876
|
+
:workspace_id)
|
814
877
|
SENSITIVE = []
|
815
878
|
include Aws::Structure
|
816
879
|
end
|
817
880
|
|
818
|
-
# Represents the output of a ListRuleGroupsNamespaces operation.
|
819
|
-
#
|
820
|
-
# @!attribute [rw] rule_groups_namespaces
|
821
|
-
# The list of the selected rule groups namespaces.
|
822
|
-
# @return [Array<Types::RuleGroupsNamespaceSummary>]
|
881
|
+
# Represents the output of a `ListRuleGroupsNamespaces` operation.
|
823
882
|
#
|
824
883
|
# @!attribute [rw] next_token
|
825
|
-
#
|
884
|
+
# A token indicating that there are more results to retrieve. You can
|
885
|
+
# use this token as part of your next `ListRuleGroupsNamespaces`
|
886
|
+
# request to retrieve those results.
|
826
887
|
# @return [String]
|
827
888
|
#
|
889
|
+
# @!attribute [rw] rule_groups_namespaces
|
890
|
+
# The returned list of rule groups namespaces.
|
891
|
+
# @return [Array<Types::RuleGroupsNamespaceSummary>]
|
892
|
+
#
|
828
893
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListRuleGroupsNamespacesResponse AWS API Documentation
|
829
894
|
#
|
830
895
|
class ListRuleGroupsNamespacesResponse < Struct.new(
|
831
|
-
:
|
832
|
-
:
|
896
|
+
:next_token,
|
897
|
+
:rule_groups_namespaces)
|
833
898
|
SENSITIVE = []
|
834
899
|
include Aws::Structure
|
835
900
|
end
|
836
901
|
|
837
|
-
# Represents the input of a ListScrapers operation.
|
902
|
+
# Represents the input of a `ListScrapers` operation.
|
838
903
|
#
|
839
904
|
# @!attribute [rw] filters
|
840
|
-
# A list of
|
841
|
-
#
|
905
|
+
# (Optional) A list of key-value pairs to filter the list of scrapers
|
906
|
+
# returned. Keys include `status`, `sourceArn`, `destinationArn`, and
|
907
|
+
# `alias`.
|
842
908
|
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
#
|
846
|
-
#
|
847
|
-
#
|
909
|
+
# Filters on the same key are `OR`'d together, and filters on
|
910
|
+
# different keys are `AND`'d together. For example,
|
911
|
+
# `status=ACTIVE&status=CREATING&alias=Test`, will return all scrapers
|
912
|
+
# that have the alias Test, and are either in status ACTIVE or
|
913
|
+
# CREATING.
|
914
|
+
#
|
915
|
+
# To find all active scrapers that are sending metrics to a specific
|
916
|
+
# Amazon Managed Service for Prometheus workspace, you would use the
|
917
|
+
# ARN of the workspace in a query:
|
918
|
+
#
|
919
|
+
# `status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012`
|
920
|
+
#
|
921
|
+
# If this is included, it filters the results to only the scrapers
|
922
|
+
# that match the filter.
|
923
|
+
# @return [Hash<String,Array<String>>]
|
848
924
|
#
|
849
925
|
# @!attribute [rw] max_results
|
850
|
-
#
|
926
|
+
# Optional) The maximum number of scrapers to return in one
|
927
|
+
# `ListScrapers` operation. The range is 1-1000.
|
928
|
+
#
|
929
|
+
# If you omit this parameter, the default of 100 is used.
|
851
930
|
# @return [Integer]
|
852
931
|
#
|
932
|
+
# @!attribute [rw] next_token
|
933
|
+
# (Optional) The token for the next set of items to return. (You
|
934
|
+
# received this token from a previous call.)
|
935
|
+
# @return [String]
|
936
|
+
#
|
853
937
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListScrapersRequest AWS API Documentation
|
854
938
|
#
|
855
939
|
class ListScrapersRequest < Struct.new(
|
856
940
|
:filters,
|
857
|
-
:
|
858
|
-
:
|
941
|
+
:max_results,
|
942
|
+
:next_token)
|
859
943
|
SENSITIVE = []
|
860
944
|
include Aws::Structure
|
861
945
|
end
|
862
946
|
|
863
|
-
# Represents the output of a ListScrapers operation.
|
864
|
-
#
|
865
|
-
# @!attribute [rw] scrapers
|
866
|
-
# The list of scrapers, filtered down if a set of filters was provided
|
867
|
-
# in the request.
|
868
|
-
# @return [Array<Types::ScraperSummary>]
|
947
|
+
# Represents the output of a `ListScrapers` operation.
|
869
948
|
#
|
870
949
|
# @!attribute [rw] next_token
|
871
|
-
#
|
950
|
+
# A token indicating that there are more results to retrieve. You can
|
951
|
+
# use this token as part of your next `ListScrapers` operation to
|
952
|
+
# retrieve those results.
|
872
953
|
# @return [String]
|
873
954
|
#
|
955
|
+
# @!attribute [rw] scrapers
|
956
|
+
# A list of `ScraperSummary` structures giving information about
|
957
|
+
# scrapers in the account that match the filters provided.
|
958
|
+
# @return [Array<Types::ScraperSummary>]
|
959
|
+
#
|
874
960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListScrapersResponse AWS API Documentation
|
875
961
|
#
|
876
962
|
class ListScrapersResponse < Struct.new(
|
877
|
-
:
|
878
|
-
:
|
963
|
+
:next_token,
|
964
|
+
:scrapers)
|
879
965
|
SENSITIVE = []
|
880
966
|
include Aws::Structure
|
881
967
|
end
|
882
968
|
|
883
969
|
# @!attribute [rw] resource_arn
|
884
|
-
# The ARN of the resource.
|
970
|
+
# The ARN of the resource to list tages for. Must be a workspace or
|
971
|
+
# rule groups namespace resource.
|
885
972
|
# @return [String]
|
886
973
|
#
|
887
974
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListTagsForResourceRequest AWS API Documentation
|
@@ -893,7 +980,7 @@ module Aws::PrometheusService
|
|
893
980
|
end
|
894
981
|
|
895
982
|
# @!attribute [rw] tags
|
896
|
-
# The list of
|
983
|
+
# The list of tag keys and values associated with the resource.
|
897
984
|
# @return [Hash<String,String>]
|
898
985
|
#
|
899
986
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListTagsForResourceResponse AWS API Documentation
|
@@ -904,96 +991,109 @@ module Aws::PrometheusService
|
|
904
991
|
include Aws::Structure
|
905
992
|
end
|
906
993
|
|
907
|
-
# Represents the input of a ListWorkspaces operation.
|
908
|
-
#
|
909
|
-
# @!attribute [rw] next_token
|
910
|
-
# Pagination token to request the next page in a paginated list. This
|
911
|
-
# token is obtained from the output of the previous ListWorkspaces
|
912
|
-
# request.
|
913
|
-
# @return [String]
|
994
|
+
# Represents the input of a `ListWorkspaces` operation.
|
914
995
|
#
|
915
996
|
# @!attribute [rw] alias
|
916
|
-
#
|
917
|
-
#
|
997
|
+
# If this is included, it filters the results to only the workspaces
|
998
|
+
# with names that start with the value that you specify here.
|
999
|
+
#
|
1000
|
+
# Amazon Managed Service for Prometheus will automatically strip any
|
1001
|
+
# blank spaces from the beginning and end of the alias that you
|
1002
|
+
# specify.
|
918
1003
|
# @return [String]
|
919
1004
|
#
|
920
1005
|
# @!attribute [rw] max_results
|
921
|
-
#
|
1006
|
+
# The maximum number of workspaces to return per request. The default
|
1007
|
+
# is 100.
|
922
1008
|
# @return [Integer]
|
923
1009
|
#
|
1010
|
+
# @!attribute [rw] next_token
|
1011
|
+
# The token for the next set of items to return. You receive this
|
1012
|
+
# token from a previous call, and use it to get the next page of
|
1013
|
+
# results. The other parameters must be the same as the initial call.
|
1014
|
+
#
|
1015
|
+
# For example, if your initial request has `maxResults` of 10, and
|
1016
|
+
# there are 12 workspaces to return, then your initial request will
|
1017
|
+
# return 10 and a `nextToken`. Using the next token in a subsequent
|
1018
|
+
# call will return the remaining 2 workspaces.
|
1019
|
+
# @return [String]
|
1020
|
+
#
|
924
1021
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListWorkspacesRequest AWS API Documentation
|
925
1022
|
#
|
926
1023
|
class ListWorkspacesRequest < Struct.new(
|
927
|
-
:next_token,
|
928
1024
|
:alias,
|
929
|
-
:max_results
|
1025
|
+
:max_results,
|
1026
|
+
:next_token)
|
930
1027
|
SENSITIVE = []
|
931
1028
|
include Aws::Structure
|
932
1029
|
end
|
933
1030
|
|
934
|
-
# Represents the output of a ListWorkspaces operation.
|
935
|
-
#
|
936
|
-
# @!attribute [rw] workspaces
|
937
|
-
# The list of existing workspaces, including those undergoing creation
|
938
|
-
# or deletion.
|
939
|
-
# @return [Array<Types::WorkspaceSummary>]
|
1031
|
+
# Represents the output of a `ListWorkspaces` operation.
|
940
1032
|
#
|
941
1033
|
# @!attribute [rw] next_token
|
942
|
-
#
|
1034
|
+
# A token indicating that there are more results to retrieve. You can
|
1035
|
+
# use this token as part of your next `ListWorkspaces` request to
|
1036
|
+
# retrieve those results.
|
943
1037
|
# @return [String]
|
944
1038
|
#
|
1039
|
+
# @!attribute [rw] workspaces
|
1040
|
+
# An array of `WorkspaceSummary` structures containing information
|
1041
|
+
# about the workspaces requested.
|
1042
|
+
# @return [Array<Types::WorkspaceSummary>]
|
1043
|
+
#
|
945
1044
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListWorkspacesResponse AWS API Documentation
|
946
1045
|
#
|
947
1046
|
class ListWorkspacesResponse < Struct.new(
|
948
|
-
:
|
949
|
-
:
|
1047
|
+
:next_token,
|
1048
|
+
:workspaces)
|
950
1049
|
SENSITIVE = []
|
951
1050
|
include Aws::Structure
|
952
1051
|
end
|
953
1052
|
|
954
|
-
#
|
1053
|
+
# Contains information about the logging configuration.
|
955
1054
|
#
|
956
|
-
# @!attribute [rw]
|
957
|
-
# The
|
958
|
-
# @return [
|
1055
|
+
# @!attribute [rw] created_at
|
1056
|
+
# The date and time that the logging configuration was created.
|
1057
|
+
# @return [Time]
|
959
1058
|
#
|
960
|
-
# @!attribute [rw]
|
961
|
-
# The
|
1059
|
+
# @!attribute [rw] log_group_arn
|
1060
|
+
# The ARN of the CloudWatch log group to which the vended log data
|
1061
|
+
# will be published.
|
962
1062
|
# @return [String]
|
963
1063
|
#
|
964
|
-
# @!attribute [rw] log_group_arn
|
965
|
-
# The ARN of the CW log group to which the vended log data will be
|
966
|
-
# published.
|
967
|
-
# @return [String]
|
968
|
-
#
|
969
|
-
# @!attribute [rw] created_at
|
970
|
-
# The time when the logging configuration was created.
|
971
|
-
# @return [Time]
|
972
|
-
#
|
973
1064
|
# @!attribute [rw] modified_at
|
974
|
-
# The time
|
1065
|
+
# The date and time that the logging configuration was most recently
|
1066
|
+
# changed.
|
975
1067
|
# @return [Time]
|
976
1068
|
#
|
1069
|
+
# @!attribute [rw] status
|
1070
|
+
# The current status of the logging configuration.
|
1071
|
+
# @return [Types::LoggingConfigurationStatus]
|
1072
|
+
#
|
1073
|
+
# @!attribute [rw] workspace
|
1074
|
+
# The ID of the workspace the logging configuration is for.
|
1075
|
+
# @return [String]
|
1076
|
+
#
|
977
1077
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/LoggingConfigurationMetadata AWS API Documentation
|
978
1078
|
#
|
979
1079
|
class LoggingConfigurationMetadata < Struct.new(
|
980
|
-
:status,
|
981
|
-
:workspace,
|
982
|
-
:log_group_arn,
|
983
1080
|
:created_at,
|
984
|
-
:
|
1081
|
+
:log_group_arn,
|
1082
|
+
:modified_at,
|
1083
|
+
:status,
|
1084
|
+
:workspace)
|
985
1085
|
SENSITIVE = []
|
986
1086
|
include Aws::Structure
|
987
1087
|
end
|
988
1088
|
|
989
|
-
#
|
1089
|
+
# The status of the logging configuration.
|
990
1090
|
#
|
991
1091
|
# @!attribute [rw] status_code
|
992
|
-
#
|
1092
|
+
# The current status of the logging configuration.
|
993
1093
|
# @return [String]
|
994
1094
|
#
|
995
1095
|
# @!attribute [rw] status_reason
|
996
|
-
#
|
1096
|
+
# If failed, the reason for the failure.
|
997
1097
|
# @return [String]
|
998
1098
|
#
|
999
1099
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/LoggingConfigurationStatus AWS API Documentation
|
@@ -1005,39 +1105,47 @@ module Aws::PrometheusService
|
|
1005
1105
|
include Aws::Structure
|
1006
1106
|
end
|
1007
1107
|
|
1008
|
-
# Represents the input of a PutAlertManagerDefinition operation.
|
1108
|
+
# Represents the input of a `PutAlertManagerDefinition` operation.
|
1009
1109
|
#
|
1010
|
-
# @!attribute [rw]
|
1011
|
-
#
|
1012
|
-
#
|
1110
|
+
# @!attribute [rw] client_token
|
1111
|
+
# A unique identifier that you can provide to ensure the idempotency
|
1112
|
+
# of the request. Case-sensitive.
|
1113
|
+
#
|
1114
|
+
# **A suitable default value is auto-generated.** You should normally
|
1115
|
+
# not need to pass this option.
|
1013
1116
|
# @return [String]
|
1014
1117
|
#
|
1015
1118
|
# @!attribute [rw] data
|
1016
|
-
# The alert manager definition
|
1017
|
-
#
|
1119
|
+
# The alert manager definition to use. A base64-encoded version of the
|
1120
|
+
# YAML alert manager definition file.
|
1018
1121
|
#
|
1019
|
-
#
|
1020
|
-
#
|
1021
|
-
# the idempotency of the request.
|
1122
|
+
# For details about the alert manager definition, see
|
1123
|
+
# [AlertManagedDefinitionData][1].
|
1022
1124
|
#
|
1023
|
-
#
|
1024
|
-
#
|
1125
|
+
#
|
1126
|
+
#
|
1127
|
+
# [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html
|
1128
|
+
# @return [String]
|
1129
|
+
#
|
1130
|
+
# @!attribute [rw] workspace_id
|
1131
|
+
# The ID of the workspace to update the alert manager definition in.
|
1025
1132
|
# @return [String]
|
1026
1133
|
#
|
1027
1134
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutAlertManagerDefinitionRequest AWS API Documentation
|
1028
1135
|
#
|
1029
1136
|
class PutAlertManagerDefinitionRequest < Struct.new(
|
1030
|
-
:
|
1137
|
+
:client_token,
|
1031
1138
|
:data,
|
1032
|
-
:
|
1139
|
+
:workspace_id)
|
1033
1140
|
SENSITIVE = []
|
1034
1141
|
include Aws::Structure
|
1035
1142
|
end
|
1036
1143
|
|
1037
|
-
# Represents the output of a PutAlertManagerDefinition operation.
|
1144
|
+
# Represents the output of a `PutAlertManagerDefinition` operation.
|
1038
1145
|
#
|
1039
1146
|
# @!attribute [rw] status
|
1040
|
-
#
|
1147
|
+
# A structure that returns the current status of the alert manager
|
1148
|
+
# definition.
|
1041
1149
|
# @return [Types::AlertManagerDefinitionStatus]
|
1042
1150
|
#
|
1043
1151
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutAlertManagerDefinitionResponse AWS API Documentation
|
@@ -1048,69 +1156,80 @@ module Aws::PrometheusService
|
|
1048
1156
|
include Aws::Structure
|
1049
1157
|
end
|
1050
1158
|
|
1051
|
-
# Represents the input of a PutRuleGroupsNamespace operation.
|
1159
|
+
# Represents the input of a `PutRuleGroupsNamespace` operation.
|
1052
1160
|
#
|
1053
|
-
# @!attribute [rw]
|
1054
|
-
#
|
1055
|
-
#
|
1161
|
+
# @!attribute [rw] client_token
|
1162
|
+
# A unique identifier that you can provide to ensure the idempotency
|
1163
|
+
# of the request. Case-sensitive.
|
1056
1164
|
#
|
1057
|
-
#
|
1058
|
-
#
|
1165
|
+
# **A suitable default value is auto-generated.** You should normally
|
1166
|
+
# not need to pass this option.
|
1059
1167
|
# @return [String]
|
1060
1168
|
#
|
1061
1169
|
# @!attribute [rw] data
|
1062
|
-
# The
|
1170
|
+
# The new rules file to use in the namespace. A base64-encoded version
|
1171
|
+
# of the YAML rule groups file.
|
1172
|
+
#
|
1173
|
+
# For details about the rule groups namespace structure, see
|
1174
|
+
# [RuleGroupsNamespaceData][1].
|
1175
|
+
#
|
1176
|
+
#
|
1177
|
+
#
|
1178
|
+
# [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html
|
1063
1179
|
# @return [String]
|
1064
1180
|
#
|
1065
|
-
# @!attribute [rw]
|
1066
|
-
#
|
1067
|
-
#
|
1181
|
+
# @!attribute [rw] name
|
1182
|
+
# The name of the rule groups namespace that you are updating.
|
1183
|
+
# @return [String]
|
1068
1184
|
#
|
1069
|
-
#
|
1070
|
-
#
|
1185
|
+
# @!attribute [rw] workspace_id
|
1186
|
+
# The ID of the workspace where you are updating the rule groups
|
1187
|
+
# namespace.
|
1071
1188
|
# @return [String]
|
1072
1189
|
#
|
1073
1190
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutRuleGroupsNamespaceRequest AWS API Documentation
|
1074
1191
|
#
|
1075
1192
|
class PutRuleGroupsNamespaceRequest < Struct.new(
|
1076
|
-
:
|
1077
|
-
:name,
|
1193
|
+
:client_token,
|
1078
1194
|
:data,
|
1079
|
-
:
|
1195
|
+
:name,
|
1196
|
+
:workspace_id)
|
1080
1197
|
SENSITIVE = []
|
1081
1198
|
include Aws::Structure
|
1082
1199
|
end
|
1083
1200
|
|
1084
|
-
# Represents the output of a PutRuleGroupsNamespace operation.
|
1201
|
+
# Represents the output of a `PutRuleGroupsNamespace` operation.
|
1085
1202
|
#
|
1086
|
-
# @!attribute [rw]
|
1087
|
-
# The rule groups namespace
|
1203
|
+
# @!attribute [rw] arn
|
1204
|
+
# The ARN of the rule groups namespace.
|
1088
1205
|
# @return [String]
|
1089
1206
|
#
|
1090
|
-
# @!attribute [rw]
|
1091
|
-
# The
|
1207
|
+
# @!attribute [rw] name
|
1208
|
+
# The name of the rule groups namespace that was updated.
|
1092
1209
|
# @return [String]
|
1093
1210
|
#
|
1094
1211
|
# @!attribute [rw] status
|
1095
|
-
#
|
1212
|
+
# A structure that includes the current status of the rule groups
|
1213
|
+
# namespace.
|
1096
1214
|
# @return [Types::RuleGroupsNamespaceStatus]
|
1097
1215
|
#
|
1098
1216
|
# @!attribute [rw] tags
|
1099
|
-
# The
|
1217
|
+
# The list of tag keys and values that are associated with the
|
1218
|
+
# namespace.
|
1100
1219
|
# @return [Hash<String,String>]
|
1101
1220
|
#
|
1102
1221
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutRuleGroupsNamespaceResponse AWS API Documentation
|
1103
1222
|
#
|
1104
1223
|
class PutRuleGroupsNamespaceResponse < Struct.new(
|
1105
|
-
:name,
|
1106
1224
|
:arn,
|
1225
|
+
:name,
|
1107
1226
|
:status,
|
1108
1227
|
:tags)
|
1109
1228
|
SENSITIVE = []
|
1110
1229
|
include Aws::Structure
|
1111
1230
|
end
|
1112
1231
|
|
1113
|
-
#
|
1232
|
+
# The request references a resources that doesn't exist.
|
1114
1233
|
#
|
1115
1234
|
# @!attribute [rw] message
|
1116
1235
|
# Description of the error.
|
@@ -1134,58 +1253,67 @@ module Aws::PrometheusService
|
|
1134
1253
|
include Aws::Structure
|
1135
1254
|
end
|
1136
1255
|
|
1137
|
-
#
|
1256
|
+
# The details about one rule groups namespace.
|
1138
1257
|
#
|
1139
1258
|
# @!attribute [rw] arn
|
1140
|
-
# The
|
1259
|
+
# The ARN of the rule groups namespace.
|
1141
1260
|
# @return [String]
|
1142
1261
|
#
|
1143
|
-
# @!attribute [rw]
|
1144
|
-
# The rule groups namespace
|
1145
|
-
# @return [
|
1146
|
-
#
|
1147
|
-
# @!attribute [rw] status
|
1148
|
-
# The status of rule groups namespace.
|
1149
|
-
# @return [Types::RuleGroupsNamespaceStatus]
|
1262
|
+
# @!attribute [rw] created_at
|
1263
|
+
# The date and time that the rule groups namespace was created.
|
1264
|
+
# @return [Time]
|
1150
1265
|
#
|
1151
1266
|
# @!attribute [rw] data
|
1152
|
-
# The rule groups namespace
|
1153
|
-
#
|
1267
|
+
# The rule groups file used in the namespace.
|
1268
|
+
#
|
1269
|
+
# For details about the rule groups namespace structure, see
|
1270
|
+
# [RuleGroupsNamespaceData][1].
|
1154
1271
|
#
|
1155
|
-
#
|
1156
|
-
#
|
1157
|
-
#
|
1272
|
+
#
|
1273
|
+
#
|
1274
|
+
# [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html
|
1275
|
+
# @return [String]
|
1158
1276
|
#
|
1159
1277
|
# @!attribute [rw] modified_at
|
1160
|
-
# The time
|
1278
|
+
# The date and time that the rule groups namespace was most recently
|
1279
|
+
# changed.
|
1161
1280
|
# @return [Time]
|
1162
1281
|
#
|
1282
|
+
# @!attribute [rw] name
|
1283
|
+
# The name of the rule groups namespace.
|
1284
|
+
# @return [String]
|
1285
|
+
#
|
1286
|
+
# @!attribute [rw] status
|
1287
|
+
# The current status of the rule groups namespace.
|
1288
|
+
# @return [Types::RuleGroupsNamespaceStatus]
|
1289
|
+
#
|
1163
1290
|
# @!attribute [rw] tags
|
1164
|
-
# The
|
1291
|
+
# The list of tag keys and values that are associated with the rule
|
1292
|
+
# groups namespace.
|
1165
1293
|
# @return [Hash<String,String>]
|
1166
1294
|
#
|
1167
1295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/RuleGroupsNamespaceDescription AWS API Documentation
|
1168
1296
|
#
|
1169
1297
|
class RuleGroupsNamespaceDescription < Struct.new(
|
1170
1298
|
:arn,
|
1171
|
-
:name,
|
1172
|
-
:status,
|
1173
|
-
:data,
|
1174
1299
|
:created_at,
|
1300
|
+
:data,
|
1175
1301
|
:modified_at,
|
1302
|
+
:name,
|
1303
|
+
:status,
|
1176
1304
|
:tags)
|
1177
1305
|
SENSITIVE = []
|
1178
1306
|
include Aws::Structure
|
1179
1307
|
end
|
1180
1308
|
|
1181
|
-
#
|
1309
|
+
# The status information about a rule groups namespace.
|
1182
1310
|
#
|
1183
1311
|
# @!attribute [rw] status_code
|
1184
|
-
#
|
1312
|
+
# The current status of the namespace.
|
1185
1313
|
# @return [String]
|
1186
1314
|
#
|
1187
1315
|
# @!attribute [rw] status_reason
|
1188
|
-
# The reason for failure if any.
|
1316
|
+
# The reason for the failure, if any.
|
1189
1317
|
# @return [String]
|
1190
1318
|
#
|
1191
1319
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/RuleGroupsNamespaceStatus AWS API Documentation
|
@@ -1197,53 +1325,60 @@ module Aws::PrometheusService
|
|
1197
1325
|
include Aws::Structure
|
1198
1326
|
end
|
1199
1327
|
|
1200
|
-
#
|
1328
|
+
# The high-level information about a rule groups namespace. To retrieve
|
1329
|
+
# more information, use `DescribeRuleGroupsNamespace`.
|
1201
1330
|
#
|
1202
1331
|
# @!attribute [rw] arn
|
1203
|
-
# The
|
1332
|
+
# The ARN of the rule groups namespace.
|
1204
1333
|
# @return [String]
|
1205
1334
|
#
|
1206
|
-
# @!attribute [rw] name
|
1207
|
-
# The rule groups namespace name.
|
1208
|
-
# @return [String]
|
1209
|
-
#
|
1210
|
-
# @!attribute [rw] status
|
1211
|
-
# The status of rule groups namespace.
|
1212
|
-
# @return [Types::RuleGroupsNamespaceStatus]
|
1213
|
-
#
|
1214
1335
|
# @!attribute [rw] created_at
|
1215
|
-
# The time
|
1336
|
+
# The date and time that the rule groups namespace was created.
|
1216
1337
|
# @return [Time]
|
1217
1338
|
#
|
1218
1339
|
# @!attribute [rw] modified_at
|
1219
|
-
# The time
|
1340
|
+
# The date and time that the rule groups namespace was most recently
|
1341
|
+
# changed.
|
1220
1342
|
# @return [Time]
|
1221
1343
|
#
|
1344
|
+
# @!attribute [rw] name
|
1345
|
+
# The name of the rule groups namespace.
|
1346
|
+
# @return [String]
|
1347
|
+
#
|
1348
|
+
# @!attribute [rw] status
|
1349
|
+
# A structure that displays the current status of the rule groups
|
1350
|
+
# namespace.
|
1351
|
+
# @return [Types::RuleGroupsNamespaceStatus]
|
1352
|
+
#
|
1222
1353
|
# @!attribute [rw] tags
|
1223
|
-
# The
|
1354
|
+
# The list of tag keys and values that are associated with the rule
|
1355
|
+
# groups namespace.
|
1224
1356
|
# @return [Hash<String,String>]
|
1225
1357
|
#
|
1226
1358
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/RuleGroupsNamespaceSummary AWS API Documentation
|
1227
1359
|
#
|
1228
1360
|
class RuleGroupsNamespaceSummary < Struct.new(
|
1229
1361
|
:arn,
|
1230
|
-
:name,
|
1231
|
-
:status,
|
1232
1362
|
:created_at,
|
1233
1363
|
:modified_at,
|
1364
|
+
:name,
|
1365
|
+
:status,
|
1234
1366
|
:tags)
|
1235
1367
|
SENSITIVE = []
|
1236
1368
|
include Aws::Structure
|
1237
1369
|
end
|
1238
1370
|
|
1239
|
-
# A
|
1371
|
+
# A scrape configuration for a scraper, base 64 encoded. For more
|
1372
|
+
# information, see [Scraper
|
1373
|
+
# configuration](prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)
|
1374
|
+
# in the *Amazon Managed Service for Prometheus User Guide*.
|
1240
1375
|
#
|
1241
1376
|
# @note ScrapeConfiguration is a union - when making an API calls you must set exactly one of the members.
|
1242
1377
|
#
|
1243
1378
|
# @note ScrapeConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ScrapeConfiguration corresponding to the set member.
|
1244
1379
|
#
|
1245
1380
|
# @!attribute [rw] configuration_blob
|
1246
|
-
#
|
1381
|
+
# The base 64 encoded scrape configuration file.
|
1247
1382
|
# @return [String]
|
1248
1383
|
#
|
1249
1384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ScrapeConfiguration AWS API Documentation
|
@@ -1259,82 +1394,85 @@ module Aws::PrometheusService
|
|
1259
1394
|
class Unknown < ScrapeConfiguration; end
|
1260
1395
|
end
|
1261
1396
|
|
1262
|
-
#
|
1397
|
+
# The `ScraperDescription` structure contains the full details about one
|
1398
|
+
# scraper in your account.
|
1263
1399
|
#
|
1264
1400
|
# @!attribute [rw] alias
|
1265
|
-
#
|
1266
|
-
# @return [String]
|
1267
|
-
#
|
1268
|
-
# @!attribute [rw] scraper_id
|
1269
|
-
# Unique string identifying this scraper.
|
1401
|
+
# (Optional) A name associated with the scraper.
|
1270
1402
|
# @return [String]
|
1271
1403
|
#
|
1272
1404
|
# @!attribute [rw] arn
|
1273
|
-
# The Amazon Resource Name (ARN) of
|
1405
|
+
# The Amazon Resource Name (ARN) of the scraper.
|
1274
1406
|
# @return [String]
|
1275
1407
|
#
|
1276
|
-
# @!attribute [rw] role_arn
|
1277
|
-
# The Amazon Resource Name (ARN) of the IAM role that provides
|
1278
|
-
# permissions for the scraper to dsicover, collect, and produce
|
1279
|
-
# metrics on your behalf.
|
1280
|
-
# @return [String]
|
1281
|
-
#
|
1282
|
-
# @!attribute [rw] status
|
1283
|
-
# The status of this scraper.
|
1284
|
-
# @return [Types::ScraperStatus]
|
1285
|
-
#
|
1286
1408
|
# @!attribute [rw] created_at
|
1287
|
-
# The time
|
1409
|
+
# The date and time that the scraper was created.
|
1288
1410
|
# @return [Time]
|
1289
1411
|
#
|
1412
|
+
# @!attribute [rw] destination
|
1413
|
+
# The Amazon Managed Service for Prometheus workspace the scraper
|
1414
|
+
# sends metrics to.
|
1415
|
+
# @return [Types::Destination]
|
1416
|
+
#
|
1290
1417
|
# @!attribute [rw] last_modified_at
|
1291
|
-
# The time
|
1418
|
+
# The date and time that the scraper was last modified.
|
1292
1419
|
# @return [Time]
|
1293
1420
|
#
|
1294
|
-
# @!attribute [rw]
|
1295
|
-
# The
|
1296
|
-
#
|
1297
|
-
#
|
1298
|
-
# @!attribute [rw] status_reason
|
1299
|
-
# The reason for failure if any.
|
1421
|
+
# @!attribute [rw] role_arn
|
1422
|
+
# The Amazon Resource Name (ARN) of the IAM role that provides
|
1423
|
+
# permissions for the scraper to discover and collect metrics on your
|
1424
|
+
# behalf.
|
1300
1425
|
# @return [String]
|
1301
1426
|
#
|
1302
1427
|
# @!attribute [rw] scrape_configuration
|
1303
|
-
# The configuration
|
1428
|
+
# The configuration file in use by the scraper.
|
1304
1429
|
# @return [Types::ScrapeConfiguration]
|
1305
1430
|
#
|
1431
|
+
# @!attribute [rw] scraper_id
|
1432
|
+
# The ID of the scraper.
|
1433
|
+
# @return [String]
|
1434
|
+
#
|
1306
1435
|
# @!attribute [rw] source
|
1307
|
-
# The
|
1308
|
-
# from.
|
1436
|
+
# The Amazon EKS cluster from which the scraper collects metrics.
|
1309
1437
|
# @return [Types::Source]
|
1310
1438
|
#
|
1311
|
-
# @!attribute [rw]
|
1312
|
-
#
|
1313
|
-
# @return [Types::
|
1439
|
+
# @!attribute [rw] status
|
1440
|
+
# A structure that contains the current status of the scraper.
|
1441
|
+
# @return [Types::ScraperStatus]
|
1442
|
+
#
|
1443
|
+
# @!attribute [rw] status_reason
|
1444
|
+
# If there is a failure, the reason for the failure.
|
1445
|
+
# @return [String]
|
1446
|
+
#
|
1447
|
+
# @!attribute [rw] tags
|
1448
|
+
# (Optional) The list of tag keys and values associated with the
|
1449
|
+
# scraper.
|
1450
|
+
# @return [Hash<String,String>]
|
1314
1451
|
#
|
1315
1452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ScraperDescription AWS API Documentation
|
1316
1453
|
#
|
1317
1454
|
class ScraperDescription < Struct.new(
|
1318
1455
|
:alias,
|
1319
|
-
:scraper_id,
|
1320
1456
|
:arn,
|
1321
|
-
:role_arn,
|
1322
|
-
:status,
|
1323
1457
|
:created_at,
|
1458
|
+
:destination,
|
1324
1459
|
:last_modified_at,
|
1325
|
-
:
|
1326
|
-
:status_reason,
|
1460
|
+
:role_arn,
|
1327
1461
|
:scrape_configuration,
|
1462
|
+
:scraper_id,
|
1328
1463
|
:source,
|
1329
|
-
:
|
1464
|
+
:status,
|
1465
|
+
:status_reason,
|
1466
|
+
:tags)
|
1330
1467
|
SENSITIVE = []
|
1331
1468
|
include Aws::Structure
|
1332
1469
|
end
|
1333
1470
|
|
1334
|
-
#
|
1471
|
+
# The `ScraperStatus` structure contains status information about the
|
1472
|
+
# scraper.
|
1335
1473
|
#
|
1336
1474
|
# @!attribute [rw] status_code
|
1337
|
-
#
|
1475
|
+
# The current status of the scraper.
|
1338
1476
|
# @return [String]
|
1339
1477
|
#
|
1340
1478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ScraperStatus AWS API Documentation
|
@@ -1345,79 +1483,85 @@ module Aws::PrometheusService
|
|
1345
1483
|
include Aws::Structure
|
1346
1484
|
end
|
1347
1485
|
|
1348
|
-
#
|
1486
|
+
# The `ScraperSummary` structure contains a summary of the details about
|
1487
|
+
# one scraper in your account.
|
1349
1488
|
#
|
1350
1489
|
# @!attribute [rw] alias
|
1351
|
-
#
|
1352
|
-
# @return [String]
|
1353
|
-
#
|
1354
|
-
# @!attribute [rw] scraper_id
|
1355
|
-
# Unique string identifying this scraper.
|
1490
|
+
# (Optional) A name associated with the scraper.
|
1356
1491
|
# @return [String]
|
1357
1492
|
#
|
1358
1493
|
# @!attribute [rw] arn
|
1359
|
-
# The Amazon Resource Name (ARN) of
|
1494
|
+
# The Amazon Resource Name (ARN) of the scraper.
|
1360
1495
|
# @return [String]
|
1361
1496
|
#
|
1362
|
-
# @!attribute [rw] role_arn
|
1363
|
-
# The Amazon Resource Name (ARN) of the IAM role that provides
|
1364
|
-
# permissions for the scraper to dsicover, collect, and produce
|
1365
|
-
# metrics on your behalf.
|
1366
|
-
# @return [String]
|
1367
|
-
#
|
1368
|
-
# @!attribute [rw] status
|
1369
|
-
# The status of this scraper.
|
1370
|
-
# @return [Types::ScraperStatus]
|
1371
|
-
#
|
1372
1497
|
# @!attribute [rw] created_at
|
1373
|
-
# The time
|
1498
|
+
# The date and time that the scraper was created.
|
1374
1499
|
# @return [Time]
|
1375
1500
|
#
|
1501
|
+
# @!attribute [rw] destination
|
1502
|
+
# The Amazon Managed Service for Prometheus workspace the scraper
|
1503
|
+
# sends metrics to.
|
1504
|
+
# @return [Types::Destination]
|
1505
|
+
#
|
1376
1506
|
# @!attribute [rw] last_modified_at
|
1377
|
-
# The time
|
1507
|
+
# The date and time that the scraper was last modified.
|
1378
1508
|
# @return [Time]
|
1379
1509
|
#
|
1380
|
-
# @!attribute [rw]
|
1381
|
-
# The
|
1382
|
-
#
|
1510
|
+
# @!attribute [rw] role_arn
|
1511
|
+
# The Amazon Resource Name (ARN) of the IAM role that provides
|
1512
|
+
# permissions for the scraper to discover and collect metrics on your
|
1513
|
+
# behalf.
|
1514
|
+
# @return [String]
|
1383
1515
|
#
|
1384
|
-
# @!attribute [rw]
|
1385
|
-
# The
|
1516
|
+
# @!attribute [rw] scraper_id
|
1517
|
+
# The ID of the scraper.
|
1386
1518
|
# @return [String]
|
1387
1519
|
#
|
1388
1520
|
# @!attribute [rw] source
|
1389
|
-
# The
|
1390
|
-
# from.
|
1521
|
+
# The Amazon EKS cluster from which the scraper collects metrics.
|
1391
1522
|
# @return [Types::Source]
|
1392
1523
|
#
|
1393
|
-
# @!attribute [rw]
|
1394
|
-
#
|
1395
|
-
# @return [Types::
|
1524
|
+
# @!attribute [rw] status
|
1525
|
+
# A structure that contains the current status of the scraper.
|
1526
|
+
# @return [Types::ScraperStatus]
|
1527
|
+
#
|
1528
|
+
# @!attribute [rw] status_reason
|
1529
|
+
# If there is a failure, the reason for the failure.
|
1530
|
+
# @return [String]
|
1531
|
+
#
|
1532
|
+
# @!attribute [rw] tags
|
1533
|
+
# (Optional) The list of tag keys and values associated with the
|
1534
|
+
# scraper.
|
1535
|
+
# @return [Hash<String,String>]
|
1396
1536
|
#
|
1397
1537
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ScraperSummary AWS API Documentation
|
1398
1538
|
#
|
1399
1539
|
class ScraperSummary < Struct.new(
|
1400
1540
|
:alias,
|
1401
|
-
:scraper_id,
|
1402
1541
|
:arn,
|
1403
|
-
:role_arn,
|
1404
|
-
:status,
|
1405
1542
|
:created_at,
|
1543
|
+
:destination,
|
1406
1544
|
:last_modified_at,
|
1407
|
-
:
|
1408
|
-
:
|
1545
|
+
:role_arn,
|
1546
|
+
:scraper_id,
|
1409
1547
|
:source,
|
1410
|
-
:
|
1548
|
+
:status,
|
1549
|
+
:status_reason,
|
1550
|
+
:tags)
|
1411
1551
|
SENSITIVE = []
|
1412
1552
|
include Aws::Structure
|
1413
1553
|
end
|
1414
1554
|
|
1415
|
-
#
|
1555
|
+
# Completing the request would cause a service quota to be exceeded.
|
1416
1556
|
#
|
1417
1557
|
# @!attribute [rw] message
|
1418
1558
|
# Description of the error.
|
1419
1559
|
# @return [String]
|
1420
1560
|
#
|
1561
|
+
# @!attribute [rw] quota_code
|
1562
|
+
# Service quotas code of the originating quota.
|
1563
|
+
# @return [String]
|
1564
|
+
#
|
1421
1565
|
# @!attribute [rw] resource_id
|
1422
1566
|
# Identifier of the resource affected.
|
1423
1567
|
# @return [String]
|
@@ -1427,34 +1571,29 @@ module Aws::PrometheusService
|
|
1427
1571
|
# @return [String]
|
1428
1572
|
#
|
1429
1573
|
# @!attribute [rw] service_code
|
1430
|
-
# Service
|
1431
|
-
# @return [String]
|
1432
|
-
#
|
1433
|
-
# @!attribute [rw] quota_code
|
1434
|
-
# Service Quotas requirement to identify originating quota.
|
1574
|
+
# Service quotas code for the originating service.
|
1435
1575
|
# @return [String]
|
1436
1576
|
#
|
1437
1577
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ServiceQuotaExceededException AWS API Documentation
|
1438
1578
|
#
|
1439
1579
|
class ServiceQuotaExceededException < Struct.new(
|
1440
1580
|
:message,
|
1581
|
+
:quota_code,
|
1441
1582
|
:resource_id,
|
1442
1583
|
:resource_type,
|
1443
|
-
:service_code
|
1444
|
-
:quota_code)
|
1584
|
+
:service_code)
|
1445
1585
|
SENSITIVE = []
|
1446
1586
|
include Aws::Structure
|
1447
1587
|
end
|
1448
1588
|
|
1449
|
-
#
|
1450
|
-
# metrics from.
|
1589
|
+
# The source of collected metrics for a scraper.
|
1451
1590
|
#
|
1452
1591
|
# @note Source is a union - when making an API calls you must set exactly one of the members.
|
1453
1592
|
#
|
1454
1593
|
# @note Source is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Source corresponding to the set member.
|
1455
1594
|
#
|
1456
1595
|
# @!attribute [rw] eks_configuration
|
1457
|
-
#
|
1596
|
+
# The Amazon EKS cluster from which a scraper collects metrics.
|
1458
1597
|
# @return [Types::EksConfiguration]
|
1459
1598
|
#
|
1460
1599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/Source AWS API Documentation
|
@@ -1471,11 +1610,13 @@ module Aws::PrometheusService
|
|
1471
1610
|
end
|
1472
1611
|
|
1473
1612
|
# @!attribute [rw] resource_arn
|
1474
|
-
# The ARN of the
|
1613
|
+
# The ARN of the workspace or rule groups namespace to apply tags to.
|
1475
1614
|
# @return [String]
|
1476
1615
|
#
|
1477
1616
|
# @!attribute [rw] tags
|
1478
|
-
# The list of
|
1617
|
+
# The list of tag keys and values to associate with the resource.
|
1618
|
+
#
|
1619
|
+
# Keys may not begin with `aws:`.
|
1479
1620
|
# @return [Hash<String,String>]
|
1480
1621
|
#
|
1481
1622
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/TagResourceRequest AWS API Documentation
|
@@ -1491,41 +1632,41 @@ module Aws::PrometheusService
|
|
1491
1632
|
#
|
1492
1633
|
class TagResourceResponse < Aws::EmptyStructure; end
|
1493
1634
|
|
1494
|
-
#
|
1635
|
+
# The request was denied due to request throttling.
|
1495
1636
|
#
|
1496
1637
|
# @!attribute [rw] message
|
1497
1638
|
# Description of the error.
|
1498
1639
|
# @return [String]
|
1499
1640
|
#
|
1500
|
-
# @!attribute [rw] service_code
|
1501
|
-
# Service Quotas requirement to identify originating service.
|
1502
|
-
# @return [String]
|
1503
|
-
#
|
1504
1641
|
# @!attribute [rw] quota_code
|
1505
|
-
# Service
|
1642
|
+
# Service quotas code for the originating quota.
|
1506
1643
|
# @return [String]
|
1507
1644
|
#
|
1508
1645
|
# @!attribute [rw] retry_after_seconds
|
1509
1646
|
# Advice to clients on when the call can be safely retried.
|
1510
1647
|
# @return [Integer]
|
1511
1648
|
#
|
1649
|
+
# @!attribute [rw] service_code
|
1650
|
+
# Service quotas code for the originating service.
|
1651
|
+
# @return [String]
|
1652
|
+
#
|
1512
1653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ThrottlingException AWS API Documentation
|
1513
1654
|
#
|
1514
1655
|
class ThrottlingException < Struct.new(
|
1515
1656
|
:message,
|
1516
|
-
:service_code,
|
1517
1657
|
:quota_code,
|
1518
|
-
:retry_after_seconds
|
1658
|
+
:retry_after_seconds,
|
1659
|
+
:service_code)
|
1519
1660
|
SENSITIVE = []
|
1520
1661
|
include Aws::Structure
|
1521
1662
|
end
|
1522
1663
|
|
1523
1664
|
# @!attribute [rw] resource_arn
|
1524
|
-
# The ARN of the
|
1665
|
+
# The ARN of the workspace or rule groups namespace.
|
1525
1666
|
# @return [String]
|
1526
1667
|
#
|
1527
1668
|
# @!attribute [rw] tag_keys
|
1528
|
-
#
|
1669
|
+
# The keys of the tags to remove.
|
1529
1670
|
# @return [Array<String>]
|
1530
1671
|
#
|
1531
1672
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UntagResourceRequest AWS API Documentation
|
@@ -1541,39 +1682,40 @@ module Aws::PrometheusService
|
|
1541
1682
|
#
|
1542
1683
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
1543
1684
|
|
1544
|
-
# Represents the input of an UpdateLoggingConfiguration operation.
|
1685
|
+
# Represents the input of an `UpdateLoggingConfiguration` operation.
|
1545
1686
|
#
|
1546
|
-
# @!attribute [rw]
|
1547
|
-
#
|
1687
|
+
# @!attribute [rw] client_token
|
1688
|
+
# A unique identifier that you can provide to ensure the idempotency
|
1689
|
+
# of the request. Case-sensitive.
|
1690
|
+
#
|
1691
|
+
# **A suitable default value is auto-generated.** You should normally
|
1692
|
+
# not need to pass this option.
|
1548
1693
|
# @return [String]
|
1549
1694
|
#
|
1550
1695
|
# @!attribute [rw] log_group_arn
|
1551
|
-
# The ARN of the
|
1552
|
-
# published.
|
1696
|
+
# The ARN of the CloudWatch log group to which the vended log data
|
1697
|
+
# will be published.
|
1553
1698
|
# @return [String]
|
1554
1699
|
#
|
1555
|
-
# @!attribute [rw]
|
1556
|
-
#
|
1557
|
-
# the idempotency of the request.
|
1558
|
-
#
|
1559
|
-
# **A suitable default value is auto-generated.** You should normally
|
1560
|
-
# not need to pass this option.
|
1700
|
+
# @!attribute [rw] workspace_id
|
1701
|
+
# The ID of the workspace to update the logging configuration for.
|
1561
1702
|
# @return [String]
|
1562
1703
|
#
|
1563
1704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateLoggingConfigurationRequest AWS API Documentation
|
1564
1705
|
#
|
1565
1706
|
class UpdateLoggingConfigurationRequest < Struct.new(
|
1566
|
-
:
|
1707
|
+
:client_token,
|
1567
1708
|
:log_group_arn,
|
1568
|
-
:
|
1709
|
+
:workspace_id)
|
1569
1710
|
SENSITIVE = []
|
1570
1711
|
include Aws::Structure
|
1571
1712
|
end
|
1572
1713
|
|
1573
|
-
# Represents the output of an UpdateLoggingConfiguration operation.
|
1714
|
+
# Represents the output of an `UpdateLoggingConfiguration` operation.
|
1574
1715
|
#
|
1575
1716
|
# @!attribute [rw] status
|
1576
|
-
#
|
1717
|
+
# A structure that contains the current status of the logging
|
1718
|
+
# configuration.
|
1577
1719
|
# @return [Types::LoggingConfigurationStatus]
|
1578
1720
|
#
|
1579
1721
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateLoggingConfigurationResponse AWS API Documentation
|
@@ -1584,36 +1726,44 @@ module Aws::PrometheusService
|
|
1584
1726
|
include Aws::Structure
|
1585
1727
|
end
|
1586
1728
|
|
1587
|
-
# Represents the input of an UpdateWorkspaceAlias operation.
|
1588
|
-
#
|
1589
|
-
# @!attribute [rw] workspace_id
|
1590
|
-
# The ID of the workspace being updated.
|
1591
|
-
# @return [String]
|
1729
|
+
# Represents the input of an `UpdateWorkspaceAlias` operation.
|
1592
1730
|
#
|
1593
1731
|
# @!attribute [rw] alias
|
1594
|
-
# The new alias
|
1732
|
+
# The new alias for the workspace. It does not need to be unique.
|
1733
|
+
#
|
1734
|
+
# Amazon Managed Service for Prometheus will automatically strip any
|
1735
|
+
# blank spaces from the beginning and end of the alias that you
|
1736
|
+
# specify.
|
1595
1737
|
# @return [String]
|
1596
1738
|
#
|
1597
1739
|
# @!attribute [rw] client_token
|
1598
|
-
#
|
1599
|
-
#
|
1740
|
+
# A unique identifier that you can provide to ensure the idempotency
|
1741
|
+
# of the request. Case-sensitive.
|
1600
1742
|
#
|
1601
1743
|
# **A suitable default value is auto-generated.** You should normally
|
1602
1744
|
# not need to pass this option.
|
1603
1745
|
# @return [String]
|
1604
1746
|
#
|
1747
|
+
# @!attribute [rw] workspace_id
|
1748
|
+
# The ID of the workspace to update.
|
1749
|
+
# @return [String]
|
1750
|
+
#
|
1605
1751
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateWorkspaceAliasRequest AWS API Documentation
|
1606
1752
|
#
|
1607
1753
|
class UpdateWorkspaceAliasRequest < Struct.new(
|
1608
|
-
:workspace_id,
|
1609
1754
|
:alias,
|
1610
|
-
:client_token
|
1755
|
+
:client_token,
|
1756
|
+
:workspace_id)
|
1611
1757
|
SENSITIVE = []
|
1612
1758
|
include Aws::Structure
|
1613
1759
|
end
|
1614
1760
|
|
1615
|
-
# The input fails to satisfy the constraints specified by an
|
1616
|
-
# service.
|
1761
|
+
# The input fails to satisfy the constraints specified by an Amazon Web
|
1762
|
+
# Services service.
|
1763
|
+
#
|
1764
|
+
# @!attribute [rw] field_list
|
1765
|
+
# The field that caused the error, if applicable.
|
1766
|
+
# @return [Array<Types::ValidationExceptionField>]
|
1617
1767
|
#
|
1618
1768
|
# @!attribute [rw] message
|
1619
1769
|
# Description of the error.
|
@@ -1623,94 +1773,93 @@ module Aws::PrometheusService
|
|
1623
1773
|
# Reason the request failed validation.
|
1624
1774
|
# @return [String]
|
1625
1775
|
#
|
1626
|
-
# @!attribute [rw] field_list
|
1627
|
-
# The field that caused the error, if applicable. If more than one
|
1628
|
-
# field caused the error, pick one and elaborate in the message.
|
1629
|
-
# @return [Array<Types::ValidationExceptionField>]
|
1630
|
-
#
|
1631
1776
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ValidationException AWS API Documentation
|
1632
1777
|
#
|
1633
1778
|
class ValidationException < Struct.new(
|
1779
|
+
:field_list,
|
1634
1780
|
:message,
|
1635
|
-
:reason
|
1636
|
-
:field_list)
|
1781
|
+
:reason)
|
1637
1782
|
SENSITIVE = []
|
1638
1783
|
include Aws::Structure
|
1639
1784
|
end
|
1640
1785
|
|
1641
|
-
#
|
1642
|
-
#
|
1786
|
+
# Information about a field passed into a request that resulted in an
|
1787
|
+
# exception.
|
1643
1788
|
#
|
1644
|
-
# @!attribute [rw]
|
1645
|
-
#
|
1789
|
+
# @!attribute [rw] message
|
1790
|
+
# A message describing why the field caused an exception.
|
1646
1791
|
# @return [String]
|
1647
1792
|
#
|
1648
|
-
# @!attribute [rw]
|
1649
|
-
#
|
1793
|
+
# @!attribute [rw] name
|
1794
|
+
# The name of the field that caused an exception.
|
1650
1795
|
# @return [String]
|
1651
1796
|
#
|
1652
1797
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ValidationExceptionField AWS API Documentation
|
1653
1798
|
#
|
1654
1799
|
class ValidationExceptionField < Struct.new(
|
1655
|
-
:
|
1656
|
-
:
|
1800
|
+
:message,
|
1801
|
+
:name)
|
1657
1802
|
SENSITIVE = []
|
1658
1803
|
include Aws::Structure
|
1659
1804
|
end
|
1660
1805
|
|
1661
|
-
#
|
1662
|
-
#
|
1663
|
-
# @!attribute [rw] workspace_id
|
1664
|
-
# Unique string identifying this workspace.
|
1665
|
-
# @return [String]
|
1806
|
+
# The full details about one Amazon Managed Service for Prometheus
|
1807
|
+
# workspace in your account.
|
1666
1808
|
#
|
1667
1809
|
# @!attribute [rw] alias
|
1668
|
-
#
|
1810
|
+
# The alias that is assigned to this workspace to help identify it. It
|
1811
|
+
# may not be unique.
|
1669
1812
|
# @return [String]
|
1670
1813
|
#
|
1671
1814
|
# @!attribute [rw] arn
|
1672
|
-
# The
|
1815
|
+
# The ARN of the workspace.
|
1673
1816
|
# @return [String]
|
1674
1817
|
#
|
1675
|
-
# @!attribute [rw]
|
1676
|
-
# The
|
1677
|
-
# @return [
|
1818
|
+
# @!attribute [rw] created_at
|
1819
|
+
# The date and time that the workspace was created.
|
1820
|
+
# @return [Time]
|
1821
|
+
#
|
1822
|
+
# @!attribute [rw] kms_key_arn
|
1823
|
+
# (optional) If the workspace was created with a customer managed KMS
|
1824
|
+
# key, the ARN for the key used.
|
1825
|
+
# @return [String]
|
1678
1826
|
#
|
1679
1827
|
# @!attribute [rw] prometheus_endpoint
|
1680
|
-
# Prometheus endpoint
|
1828
|
+
# The Prometheus endpoint available for this workspace.
|
1681
1829
|
# @return [String]
|
1682
1830
|
#
|
1683
|
-
# @!attribute [rw]
|
1684
|
-
# The
|
1685
|
-
# @return [
|
1831
|
+
# @!attribute [rw] status
|
1832
|
+
# The current status of the workspace.
|
1833
|
+
# @return [Types::WorkspaceStatus]
|
1686
1834
|
#
|
1687
1835
|
# @!attribute [rw] tags
|
1688
|
-
# The
|
1836
|
+
# The list of tag keys and values that are associated with the
|
1837
|
+
# workspace.
|
1689
1838
|
# @return [Hash<String,String>]
|
1690
1839
|
#
|
1691
|
-
# @!attribute [rw]
|
1692
|
-
# The
|
1840
|
+
# @!attribute [rw] workspace_id
|
1841
|
+
# The unique ID for the workspace.
|
1693
1842
|
# @return [String]
|
1694
1843
|
#
|
1695
1844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/WorkspaceDescription AWS API Documentation
|
1696
1845
|
#
|
1697
1846
|
class WorkspaceDescription < Struct.new(
|
1698
|
-
:workspace_id,
|
1699
1847
|
:alias,
|
1700
1848
|
:arn,
|
1701
|
-
:status,
|
1702
|
-
:prometheus_endpoint,
|
1703
1849
|
:created_at,
|
1850
|
+
:kms_key_arn,
|
1851
|
+
:prometheus_endpoint,
|
1852
|
+
:status,
|
1704
1853
|
:tags,
|
1705
|
-
:
|
1854
|
+
:workspace_id)
|
1706
1855
|
SENSITIVE = []
|
1707
1856
|
include Aws::Structure
|
1708
1857
|
end
|
1709
1858
|
|
1710
|
-
#
|
1859
|
+
# The status of the workspace.
|
1711
1860
|
#
|
1712
1861
|
# @!attribute [rw] status_code
|
1713
|
-
#
|
1862
|
+
# The current status of the workspace.
|
1714
1863
|
# @return [String]
|
1715
1864
|
#
|
1716
1865
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/WorkspaceStatus AWS API Documentation
|
@@ -1721,46 +1870,50 @@ module Aws::PrometheusService
|
|
1721
1870
|
include Aws::Structure
|
1722
1871
|
end
|
1723
1872
|
|
1724
|
-
#
|
1725
|
-
#
|
1726
|
-
# @!attribute [rw] workspace_id
|
1727
|
-
# Unique string identifying this workspace.
|
1728
|
-
# @return [String]
|
1873
|
+
# The information about one Amazon Managed Service for Prometheus
|
1874
|
+
# workspace in your account.
|
1729
1875
|
#
|
1730
1876
|
# @!attribute [rw] alias
|
1731
|
-
#
|
1877
|
+
# The alias that is assigned to this workspace to help identify it. It
|
1878
|
+
# may not be unique.
|
1732
1879
|
# @return [String]
|
1733
1880
|
#
|
1734
1881
|
# @!attribute [rw] arn
|
1735
|
-
# The
|
1882
|
+
# The ARN of the workspace.
|
1736
1883
|
# @return [String]
|
1737
1884
|
#
|
1738
|
-
# @!attribute [rw] status
|
1739
|
-
# The status of this workspace.
|
1740
|
-
# @return [Types::WorkspaceStatus]
|
1741
|
-
#
|
1742
1885
|
# @!attribute [rw] created_at
|
1743
|
-
# The time
|
1886
|
+
# The date and time that the workspace was created.
|
1744
1887
|
# @return [Time]
|
1745
1888
|
#
|
1889
|
+
# @!attribute [rw] kms_key_arn
|
1890
|
+
# (optional) If the workspace was created with a customer managed KMS
|
1891
|
+
# key, the ARN for the key used.
|
1892
|
+
# @return [String]
|
1893
|
+
#
|
1894
|
+
# @!attribute [rw] status
|
1895
|
+
# The current status of the workspace.
|
1896
|
+
# @return [Types::WorkspaceStatus]
|
1897
|
+
#
|
1746
1898
|
# @!attribute [rw] tags
|
1747
|
-
# The
|
1899
|
+
# The list of tag keys and values that are associated with the
|
1900
|
+
# workspace.
|
1748
1901
|
# @return [Hash<String,String>]
|
1749
1902
|
#
|
1750
|
-
# @!attribute [rw]
|
1751
|
-
#
|
1903
|
+
# @!attribute [rw] workspace_id
|
1904
|
+
# The unique ID for the workspace.
|
1752
1905
|
# @return [String]
|
1753
1906
|
#
|
1754
1907
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/WorkspaceSummary AWS API Documentation
|
1755
1908
|
#
|
1756
1909
|
class WorkspaceSummary < Struct.new(
|
1757
|
-
:workspace_id,
|
1758
1910
|
:alias,
|
1759
1911
|
:arn,
|
1760
|
-
:status,
|
1761
1912
|
:created_at,
|
1913
|
+
:kms_key_arn,
|
1914
|
+
:status,
|
1762
1915
|
:tags,
|
1763
|
-
:
|
1916
|
+
:workspace_id)
|
1764
1917
|
SENSITIVE = []
|
1765
1918
|
include Aws::Structure
|
1766
1919
|
end
|