aws-sdk-networkflowmonitor 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-networkflowmonitor/client.rb +1862 -0
- data/lib/aws-sdk-networkflowmonitor/client_api.rb +897 -0
- data/lib/aws-sdk-networkflowmonitor/customizations.rb +0 -0
- data/lib/aws-sdk-networkflowmonitor/endpoint_parameters.rb +59 -0
- data/lib/aws-sdk-networkflowmonitor/endpoint_provider.rb +35 -0
- data/lib/aws-sdk-networkflowmonitor/endpoints.rb +20 -0
- data/lib/aws-sdk-networkflowmonitor/errors.rb +162 -0
- data/lib/aws-sdk-networkflowmonitor/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-networkflowmonitor/resource.rb +26 -0
- data/lib/aws-sdk-networkflowmonitor/types.rb +1825 -0
- data/lib/aws-sdk-networkflowmonitor/waiters.rb +15 -0
- data/lib/aws-sdk-networkflowmonitor.rb +62 -0
- data/sig/client.rbs +469 -0
- data/sig/errors.rbs +37 -0
- data/sig/resource.rbs +82 -0
- data/sig/types.rbs +484 -0
- data/sig/waiters.rbs +13 -0
- metadata +100 -0
@@ -0,0 +1,1825 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::NetworkFlowMonitor
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You don't have sufficient permission to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# The requested resource is in use.
|
27
|
+
#
|
28
|
+
# @!attribute [rw] message
|
29
|
+
# @return [String]
|
30
|
+
#
|
31
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ConflictException AWS API Documentation
|
32
|
+
#
|
33
|
+
class ConflictException < Struct.new(
|
34
|
+
:message)
|
35
|
+
SENSITIVE = []
|
36
|
+
include Aws::Structure
|
37
|
+
end
|
38
|
+
|
39
|
+
# @!attribute [rw] monitor_name
|
40
|
+
# The name of the monitor.
|
41
|
+
# @return [String]
|
42
|
+
#
|
43
|
+
# @!attribute [rw] local_resources
|
44
|
+
# The local resources to monitor. A local resource, in a
|
45
|
+
# bi-directional flow of a workload, is the host where the agent is
|
46
|
+
# installed. For example, if a workload consists of an interaction
|
47
|
+
# between a web service and a backend database (for example, Amazon
|
48
|
+
# Relational Database Service (RDS)), the EC2 instance hosting the web
|
49
|
+
# service, which also runs the agent, is the local resource.
|
50
|
+
# @return [Array<Types::MonitorLocalResource>]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] remote_resources
|
53
|
+
# The remote resources to monitor. A remote resource is the other
|
54
|
+
# endpoint in the bi-directional flow of a workload, with a local
|
55
|
+
# resource. For example, Amazon Relational Database Service (RDS) can
|
56
|
+
# be a remote resource.
|
57
|
+
# @return [Array<Types::MonitorRemoteResource>]
|
58
|
+
#
|
59
|
+
# @!attribute [rw] scope_arn
|
60
|
+
# The Amazon Resource Name (ARN) of the scope for the monitor.
|
61
|
+
# @return [String]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] client_token
|
64
|
+
# A unique, case-sensitive string of up to 64 ASCII characters that
|
65
|
+
# you specify to make an idempotent API request. Don't reuse the same
|
66
|
+
# client token for other API requests.
|
67
|
+
#
|
68
|
+
# **A suitable default value is auto-generated.** You should normally
|
69
|
+
# not need to pass this option.
|
70
|
+
# @return [String]
|
71
|
+
#
|
72
|
+
# @!attribute [rw] tags
|
73
|
+
# The tags for a monitor. You can add a maximum of 200 tags.
|
74
|
+
# @return [Hash<String,String>]
|
75
|
+
#
|
76
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/CreateMonitorInput AWS API Documentation
|
77
|
+
#
|
78
|
+
class CreateMonitorInput < Struct.new(
|
79
|
+
:monitor_name,
|
80
|
+
:local_resources,
|
81
|
+
:remote_resources,
|
82
|
+
:scope_arn,
|
83
|
+
:client_token,
|
84
|
+
:tags)
|
85
|
+
SENSITIVE = []
|
86
|
+
include Aws::Structure
|
87
|
+
end
|
88
|
+
|
89
|
+
# @!attribute [rw] monitor_arn
|
90
|
+
# The Amazon Resource Name (ARN) of the monitor.
|
91
|
+
# @return [String]
|
92
|
+
#
|
93
|
+
# @!attribute [rw] monitor_name
|
94
|
+
# The name of the monitor.
|
95
|
+
# @return [String]
|
96
|
+
#
|
97
|
+
# @!attribute [rw] monitor_status
|
98
|
+
# The status of a monitor. The status can be one of the following
|
99
|
+
#
|
100
|
+
# * `PENDING`: The monitor is in the process of being created.
|
101
|
+
#
|
102
|
+
# * `ACTIVE`: The monitor is active.
|
103
|
+
#
|
104
|
+
# * `INACTIVE`: The monitor is inactive.
|
105
|
+
#
|
106
|
+
# * `ERROR`: Monitor creation failed due to an error.
|
107
|
+
#
|
108
|
+
# * `DELETING`: The monitor is in the process of being deleted.
|
109
|
+
# @return [String]
|
110
|
+
#
|
111
|
+
# @!attribute [rw] local_resources
|
112
|
+
# The local resources to monitor. A local resource, in a
|
113
|
+
# bi-directional flow of a workload, is the host where the agent is
|
114
|
+
# installed.
|
115
|
+
# @return [Array<Types::MonitorLocalResource>]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] remote_resources
|
118
|
+
# The remote resources to monitor. A remote resource is the other
|
119
|
+
# endpoint in the bi-directional flow of a workload, with a local
|
120
|
+
# resource. For example, Amazon Relational Database Service (RDS) can
|
121
|
+
# be a remote resource. The remote resource is identified by its ARN
|
122
|
+
# or an identifier.
|
123
|
+
# @return [Array<Types::MonitorRemoteResource>]
|
124
|
+
#
|
125
|
+
# @!attribute [rw] created_at
|
126
|
+
# The date and time when the monitor was created.
|
127
|
+
# @return [Time]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] modified_at
|
130
|
+
# The last date and time that the monitor was modified.
|
131
|
+
# @return [Time]
|
132
|
+
#
|
133
|
+
# @!attribute [rw] tags
|
134
|
+
# The tags for a monitor.
|
135
|
+
# @return [Hash<String,String>]
|
136
|
+
#
|
137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/CreateMonitorOutput AWS API Documentation
|
138
|
+
#
|
139
|
+
class CreateMonitorOutput < Struct.new(
|
140
|
+
:monitor_arn,
|
141
|
+
:monitor_name,
|
142
|
+
:monitor_status,
|
143
|
+
:local_resources,
|
144
|
+
:remote_resources,
|
145
|
+
:created_at,
|
146
|
+
:modified_at,
|
147
|
+
:tags)
|
148
|
+
SENSITIVE = []
|
149
|
+
include Aws::Structure
|
150
|
+
end
|
151
|
+
|
152
|
+
# @!attribute [rw] targets
|
153
|
+
# The targets to define the scope to be monitored. Currently, a target
|
154
|
+
# is an Amazon Web Services account.
|
155
|
+
# @return [Array<Types::TargetResource>]
|
156
|
+
#
|
157
|
+
# @!attribute [rw] client_token
|
158
|
+
# A unique, case-sensitive string of up to 64 ASCII characters that
|
159
|
+
# you specify to make an idempotent API request. Don't reuse the same
|
160
|
+
# client token for other API requests.
|
161
|
+
#
|
162
|
+
# **A suitable default value is auto-generated.** You should normally
|
163
|
+
# not need to pass this option.
|
164
|
+
# @return [String]
|
165
|
+
#
|
166
|
+
# @!attribute [rw] tags
|
167
|
+
# The tags for a scope. You can add a maximum of 200 tags.
|
168
|
+
# @return [Hash<String,String>]
|
169
|
+
#
|
170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/CreateScopeInput AWS API Documentation
|
171
|
+
#
|
172
|
+
class CreateScopeInput < Struct.new(
|
173
|
+
:targets,
|
174
|
+
:client_token,
|
175
|
+
:tags)
|
176
|
+
SENSITIVE = []
|
177
|
+
include Aws::Structure
|
178
|
+
end
|
179
|
+
|
180
|
+
# @!attribute [rw] scope_id
|
181
|
+
# The identifier for the scope that includes the resources you want to
|
182
|
+
# get metrics for. A scope ID is an internally-generated identifier
|
183
|
+
# that includes all the resources for a specific root account.
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @!attribute [rw] status
|
187
|
+
# The status for a call to create a scope. The status can be one of
|
188
|
+
# the following: `SUCCEEDED`, `IN_PROGRESS`, or `FAILED`.
|
189
|
+
# @return [String]
|
190
|
+
#
|
191
|
+
# @!attribute [rw] scope_arn
|
192
|
+
# The Amazon Resource Name (ARN) of the scope.
|
193
|
+
# @return [String]
|
194
|
+
#
|
195
|
+
# @!attribute [rw] tags
|
196
|
+
# The tags for a scope.
|
197
|
+
# @return [Hash<String,String>]
|
198
|
+
#
|
199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/CreateScopeOutput AWS API Documentation
|
200
|
+
#
|
201
|
+
class CreateScopeOutput < Struct.new(
|
202
|
+
:scope_id,
|
203
|
+
:status,
|
204
|
+
:scope_arn,
|
205
|
+
:tags)
|
206
|
+
SENSITIVE = []
|
207
|
+
include Aws::Structure
|
208
|
+
end
|
209
|
+
|
210
|
+
# @!attribute [rw] monitor_name
|
211
|
+
# The name of the monitor to delete.
|
212
|
+
# @return [String]
|
213
|
+
#
|
214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/DeleteMonitorInput AWS API Documentation
|
215
|
+
#
|
216
|
+
class DeleteMonitorInput < Struct.new(
|
217
|
+
:monitor_name)
|
218
|
+
SENSITIVE = []
|
219
|
+
include Aws::Structure
|
220
|
+
end
|
221
|
+
|
222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/DeleteMonitorOutput AWS API Documentation
|
223
|
+
#
|
224
|
+
class DeleteMonitorOutput < Aws::EmptyStructure; end
|
225
|
+
|
226
|
+
# @!attribute [rw] scope_id
|
227
|
+
# The identifier for the scope that includes the resources you want to
|
228
|
+
# get data results for. A scope ID is an internally-generated
|
229
|
+
# identifier that includes all the resources for a specific root
|
230
|
+
# account.
|
231
|
+
# @return [String]
|
232
|
+
#
|
233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/DeleteScopeInput AWS API Documentation
|
234
|
+
#
|
235
|
+
class DeleteScopeInput < Struct.new(
|
236
|
+
:scope_id)
|
237
|
+
SENSITIVE = []
|
238
|
+
include Aws::Structure
|
239
|
+
end
|
240
|
+
|
241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/DeleteScopeOutput AWS API Documentation
|
242
|
+
#
|
243
|
+
class DeleteScopeOutput < Aws::EmptyStructure; end
|
244
|
+
|
245
|
+
# @!attribute [rw] monitor_name
|
246
|
+
# The name of the monitor.
|
247
|
+
# @return [String]
|
248
|
+
#
|
249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetMonitorInput AWS API Documentation
|
250
|
+
#
|
251
|
+
class GetMonitorInput < Struct.new(
|
252
|
+
:monitor_name)
|
253
|
+
SENSITIVE = []
|
254
|
+
include Aws::Structure
|
255
|
+
end
|
256
|
+
|
257
|
+
# @!attribute [rw] monitor_arn
|
258
|
+
# The Amazon Resource Name (ARN) of the monitor.
|
259
|
+
# @return [String]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] monitor_name
|
262
|
+
# The name of the monitor.
|
263
|
+
# @return [String]
|
264
|
+
#
|
265
|
+
# @!attribute [rw] monitor_status
|
266
|
+
# The status of a monitor. The status can be one of the following
|
267
|
+
#
|
268
|
+
# * `PENDING`: The monitor is in the process of being created.
|
269
|
+
#
|
270
|
+
# * `ACTIVE`: The monitor is active.
|
271
|
+
#
|
272
|
+
# * `INACTIVE`: The monitor is inactive.
|
273
|
+
#
|
274
|
+
# * `ERROR`: Monitor creation failed due to an error.
|
275
|
+
#
|
276
|
+
# * `DELETING`: The monitor is in the process of being deleted.
|
277
|
+
# @return [String]
|
278
|
+
#
|
279
|
+
# @!attribute [rw] local_resources
|
280
|
+
# The local resources for this monitor.
|
281
|
+
# @return [Array<Types::MonitorLocalResource>]
|
282
|
+
#
|
283
|
+
# @!attribute [rw] remote_resources
|
284
|
+
# The remote resources for this monitor.
|
285
|
+
# @return [Array<Types::MonitorRemoteResource>]
|
286
|
+
#
|
287
|
+
# @!attribute [rw] created_at
|
288
|
+
# The date and time when the monitor was created.
|
289
|
+
# @return [Time]
|
290
|
+
#
|
291
|
+
# @!attribute [rw] modified_at
|
292
|
+
# The date and time when the monitor was last modified.
|
293
|
+
# @return [Time]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] tags
|
296
|
+
# The tags for a monitor.
|
297
|
+
# @return [Hash<String,String>]
|
298
|
+
#
|
299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetMonitorOutput AWS API Documentation
|
300
|
+
#
|
301
|
+
class GetMonitorOutput < Struct.new(
|
302
|
+
:monitor_arn,
|
303
|
+
:monitor_name,
|
304
|
+
:monitor_status,
|
305
|
+
:local_resources,
|
306
|
+
:remote_resources,
|
307
|
+
:created_at,
|
308
|
+
:modified_at,
|
309
|
+
:tags)
|
310
|
+
SENSITIVE = []
|
311
|
+
include Aws::Structure
|
312
|
+
end
|
313
|
+
|
314
|
+
# @!attribute [rw] monitor_name
|
315
|
+
# The name of the monitor.
|
316
|
+
# @return [String]
|
317
|
+
#
|
318
|
+
# @!attribute [rw] query_id
|
319
|
+
# The identifier for the query. A query ID is an internally-generated
|
320
|
+
# identifier for a specific query returned from an API call to start a
|
321
|
+
# query.
|
322
|
+
# @return [String]
|
323
|
+
#
|
324
|
+
# @!attribute [rw] next_token
|
325
|
+
# The token for the next set of results. You receive this token from a
|
326
|
+
# previous call.
|
327
|
+
# @return [String]
|
328
|
+
#
|
329
|
+
# @!attribute [rw] max_results
|
330
|
+
# The number of query results that you want to return with this call.
|
331
|
+
# @return [Integer]
|
332
|
+
#
|
333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryResultsMonitorTopContributorsInput AWS API Documentation
|
334
|
+
#
|
335
|
+
class GetQueryResultsMonitorTopContributorsInput < Struct.new(
|
336
|
+
:monitor_name,
|
337
|
+
:query_id,
|
338
|
+
:next_token,
|
339
|
+
:max_results)
|
340
|
+
SENSITIVE = []
|
341
|
+
include Aws::Structure
|
342
|
+
end
|
343
|
+
|
344
|
+
# @!attribute [rw] unit
|
345
|
+
# The units for a metric returned by the query.
|
346
|
+
# @return [String]
|
347
|
+
#
|
348
|
+
# @!attribute [rw] top_contributors
|
349
|
+
# The top contributor network flows overall for a specific metric
|
350
|
+
# type, for example, the number of retransmissions.
|
351
|
+
# @return [Array<Types::MonitorTopContributorsRow>]
|
352
|
+
#
|
353
|
+
# @!attribute [rw] next_token
|
354
|
+
# The token for the next set of results. You receive this token from a
|
355
|
+
# previous call.
|
356
|
+
# @return [String]
|
357
|
+
#
|
358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryResultsMonitorTopContributorsOutput AWS API Documentation
|
359
|
+
#
|
360
|
+
class GetQueryResultsMonitorTopContributorsOutput < Struct.new(
|
361
|
+
:unit,
|
362
|
+
:top_contributors,
|
363
|
+
:next_token)
|
364
|
+
SENSITIVE = []
|
365
|
+
include Aws::Structure
|
366
|
+
end
|
367
|
+
|
368
|
+
# @!attribute [rw] scope_id
|
369
|
+
# The identifier for the scope that includes the resources you want to
|
370
|
+
# get data results for. A scope ID is an internally-generated
|
371
|
+
# identifier that includes all the resources for a specific root
|
372
|
+
# account.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] query_id
|
376
|
+
# The identifier for the query. A query ID is an internally-generated
|
377
|
+
# identifier for a specific query returned from an API call to start a
|
378
|
+
# query.
|
379
|
+
# @return [String]
|
380
|
+
#
|
381
|
+
# @!attribute [rw] next_token
|
382
|
+
# The token for the next set of results. You receive this token from a
|
383
|
+
# previous call.
|
384
|
+
# @return [String]
|
385
|
+
#
|
386
|
+
# @!attribute [rw] max_results
|
387
|
+
# The number of query results that you want to return with this call.
|
388
|
+
# @return [Integer]
|
389
|
+
#
|
390
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryResultsWorkloadInsightsTopContributorsDataInput AWS API Documentation
|
391
|
+
#
|
392
|
+
class GetQueryResultsWorkloadInsightsTopContributorsDataInput < Struct.new(
|
393
|
+
:scope_id,
|
394
|
+
:query_id,
|
395
|
+
:next_token,
|
396
|
+
:max_results)
|
397
|
+
SENSITIVE = []
|
398
|
+
include Aws::Structure
|
399
|
+
end
|
400
|
+
|
401
|
+
# @!attribute [rw] unit
|
402
|
+
# The units for a metric returned by the query.
|
403
|
+
# @return [String]
|
404
|
+
#
|
405
|
+
# @!attribute [rw] datapoints
|
406
|
+
# The datapoints returned by the query.
|
407
|
+
# @return [Array<Types::WorkloadInsightsTopContributorsDataPoint>]
|
408
|
+
#
|
409
|
+
# @!attribute [rw] next_token
|
410
|
+
# The token for the next set of results. You receive this token from a
|
411
|
+
# previous call.
|
412
|
+
# @return [String]
|
413
|
+
#
|
414
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryResultsWorkloadInsightsTopContributorsDataOutput AWS API Documentation
|
415
|
+
#
|
416
|
+
class GetQueryResultsWorkloadInsightsTopContributorsDataOutput < Struct.new(
|
417
|
+
:unit,
|
418
|
+
:datapoints,
|
419
|
+
:next_token)
|
420
|
+
SENSITIVE = []
|
421
|
+
include Aws::Structure
|
422
|
+
end
|
423
|
+
|
424
|
+
# @!attribute [rw] scope_id
|
425
|
+
# The identifier for the scope that includes the resources you want to
|
426
|
+
# get data results for. A scope ID is an internally-generated
|
427
|
+
# identifier that includes all the resources for a specific root
|
428
|
+
# account.
|
429
|
+
# @return [String]
|
430
|
+
#
|
431
|
+
# @!attribute [rw] query_id
|
432
|
+
# The identifier for the query. A query ID is an internally-generated
|
433
|
+
# identifier for a specific query returned from an API call to start a
|
434
|
+
# query.
|
435
|
+
# @return [String]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] next_token
|
438
|
+
# The token for the next set of results. You receive this token from a
|
439
|
+
# previous call.
|
440
|
+
# @return [String]
|
441
|
+
#
|
442
|
+
# @!attribute [rw] max_results
|
443
|
+
# The number of query results that you want to return with this call.
|
444
|
+
# @return [Integer]
|
445
|
+
#
|
446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryResultsWorkloadInsightsTopContributorsInput AWS API Documentation
|
447
|
+
#
|
448
|
+
class GetQueryResultsWorkloadInsightsTopContributorsInput < Struct.new(
|
449
|
+
:scope_id,
|
450
|
+
:query_id,
|
451
|
+
:next_token,
|
452
|
+
:max_results)
|
453
|
+
SENSITIVE = []
|
454
|
+
include Aws::Structure
|
455
|
+
end
|
456
|
+
|
457
|
+
# @!attribute [rw] top_contributors
|
458
|
+
# The top contributor network flows overall for a specific metric
|
459
|
+
# type, for example, the number of retransmissions.
|
460
|
+
# @return [Array<Types::WorkloadInsightsTopContributorsRow>]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] next_token
|
463
|
+
# The token for the next set of results. You receive this token from a
|
464
|
+
# previous call.
|
465
|
+
# @return [String]
|
466
|
+
#
|
467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryResultsWorkloadInsightsTopContributorsOutput AWS API Documentation
|
468
|
+
#
|
469
|
+
class GetQueryResultsWorkloadInsightsTopContributorsOutput < Struct.new(
|
470
|
+
:top_contributors,
|
471
|
+
:next_token)
|
472
|
+
SENSITIVE = []
|
473
|
+
include Aws::Structure
|
474
|
+
end
|
475
|
+
|
476
|
+
# @!attribute [rw] monitor_name
|
477
|
+
# The name of the monitor.
|
478
|
+
# @return [String]
|
479
|
+
#
|
480
|
+
# @!attribute [rw] query_id
|
481
|
+
# The identifier for the query. A query ID is an internally-generated
|
482
|
+
# identifier for a specific query returned from an API call to start a
|
483
|
+
# query.
|
484
|
+
# @return [String]
|
485
|
+
#
|
486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryStatusMonitorTopContributorsInput AWS API Documentation
|
487
|
+
#
|
488
|
+
class GetQueryStatusMonitorTopContributorsInput < Struct.new(
|
489
|
+
:monitor_name,
|
490
|
+
:query_id)
|
491
|
+
SENSITIVE = []
|
492
|
+
include Aws::Structure
|
493
|
+
end
|
494
|
+
|
495
|
+
# @!attribute [rw] status
|
496
|
+
# When you run a query, use this call to check the status of the query
|
497
|
+
# to make sure that the query has `SUCCEEDED` before you review the
|
498
|
+
# results.
|
499
|
+
#
|
500
|
+
# * `QUEUED`: The query is scheduled to run.
|
501
|
+
#
|
502
|
+
# * `RUNNING`: The query is in progress but not complete.
|
503
|
+
#
|
504
|
+
# * `SUCCEEDED`: The query completed sucessfully.
|
505
|
+
#
|
506
|
+
# * `FAILED`: The query failed due to an error.
|
507
|
+
#
|
508
|
+
# * `CANCELED`: The query was canceled.
|
509
|
+
# @return [String]
|
510
|
+
#
|
511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryStatusMonitorTopContributorsOutput AWS API Documentation
|
512
|
+
#
|
513
|
+
class GetQueryStatusMonitorTopContributorsOutput < Struct.new(
|
514
|
+
:status)
|
515
|
+
SENSITIVE = []
|
516
|
+
include Aws::Structure
|
517
|
+
end
|
518
|
+
|
519
|
+
# @!attribute [rw] scope_id
|
520
|
+
# The identifier for the scope that includes the resources you want to
|
521
|
+
# get data results for. A scope ID is an internally-generated
|
522
|
+
# identifier that includes all the resources for a specific root
|
523
|
+
# account. A scope ID is returned from a `CreateScope` API call.
|
524
|
+
# @return [String]
|
525
|
+
#
|
526
|
+
# @!attribute [rw] query_id
|
527
|
+
# The identifier for the query. A query ID is an internally-generated
|
528
|
+
# identifier for a specific query returned from an API call to start a
|
529
|
+
# query.
|
530
|
+
# @return [String]
|
531
|
+
#
|
532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryStatusWorkloadInsightsTopContributorsDataInput AWS API Documentation
|
533
|
+
#
|
534
|
+
class GetQueryStatusWorkloadInsightsTopContributorsDataInput < Struct.new(
|
535
|
+
:scope_id,
|
536
|
+
:query_id)
|
537
|
+
SENSITIVE = []
|
538
|
+
include Aws::Structure
|
539
|
+
end
|
540
|
+
|
541
|
+
# @!attribute [rw] status
|
542
|
+
# The status of a query for top contributors data.
|
543
|
+
#
|
544
|
+
# * `QUEUED`: The query is scheduled to run.
|
545
|
+
#
|
546
|
+
# * `RUNNING`: The query is in progress but not complete.
|
547
|
+
#
|
548
|
+
# * `SUCCEEDED`: The query completed sucessfully.
|
549
|
+
#
|
550
|
+
# * `FAILED`: The query failed due to an error.
|
551
|
+
#
|
552
|
+
# * `CANCELED`: The query was canceled.
|
553
|
+
# @return [String]
|
554
|
+
#
|
555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryStatusWorkloadInsightsTopContributorsDataOutput AWS API Documentation
|
556
|
+
#
|
557
|
+
class GetQueryStatusWorkloadInsightsTopContributorsDataOutput < Struct.new(
|
558
|
+
:status)
|
559
|
+
SENSITIVE = []
|
560
|
+
include Aws::Structure
|
561
|
+
end
|
562
|
+
|
563
|
+
# @!attribute [rw] scope_id
|
564
|
+
# The identifier for the scope that includes the resources you want to
|
565
|
+
# get data results for. A scope ID is an internally-generated
|
566
|
+
# identifier that includes all the resources for a specific root
|
567
|
+
# account.
|
568
|
+
# @return [String]
|
569
|
+
#
|
570
|
+
# @!attribute [rw] query_id
|
571
|
+
# The identifier for the query. A query ID is an internally-generated
|
572
|
+
# identifier for a specific query returned from an API call to start a
|
573
|
+
# query.
|
574
|
+
# @return [String]
|
575
|
+
#
|
576
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryStatusWorkloadInsightsTopContributorsInput AWS API Documentation
|
577
|
+
#
|
578
|
+
class GetQueryStatusWorkloadInsightsTopContributorsInput < Struct.new(
|
579
|
+
:scope_id,
|
580
|
+
:query_id)
|
581
|
+
SENSITIVE = []
|
582
|
+
include Aws::Structure
|
583
|
+
end
|
584
|
+
|
585
|
+
# @!attribute [rw] status
|
586
|
+
# When you run a query, use this call to check the status of the query
|
587
|
+
# to make sure that the query has `SUCCEEDED` before you review the
|
588
|
+
# results.
|
589
|
+
#
|
590
|
+
# * `QUEUED`: The query is scheduled to run.
|
591
|
+
#
|
592
|
+
# * `RUNNING`: The query is in progress but not complete.
|
593
|
+
#
|
594
|
+
# * `SUCCEEDED`: The query completed sucessfully.
|
595
|
+
#
|
596
|
+
# * `FAILED`: The query failed due to an error.
|
597
|
+
#
|
598
|
+
# * `CANCELED`: The query was canceled.
|
599
|
+
# @return [String]
|
600
|
+
#
|
601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryStatusWorkloadInsightsTopContributorsOutput AWS API Documentation
|
602
|
+
#
|
603
|
+
class GetQueryStatusWorkloadInsightsTopContributorsOutput < Struct.new(
|
604
|
+
:status)
|
605
|
+
SENSITIVE = []
|
606
|
+
include Aws::Structure
|
607
|
+
end
|
608
|
+
|
609
|
+
# @!attribute [rw] scope_id
|
610
|
+
# The identifier for the scope that includes the resources you want to
|
611
|
+
# get data results for. A scope ID is an internally-generated
|
612
|
+
# identifier that includes all the resources for a specific root
|
613
|
+
# account. A scope ID is returned from a `CreateScope` API call.
|
614
|
+
# @return [String]
|
615
|
+
#
|
616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetScopeInput AWS API Documentation
|
617
|
+
#
|
618
|
+
class GetScopeInput < Struct.new(
|
619
|
+
:scope_id)
|
620
|
+
SENSITIVE = []
|
621
|
+
include Aws::Structure
|
622
|
+
end
|
623
|
+
|
624
|
+
# @!attribute [rw] scope_id
|
625
|
+
# The identifier for the scope that includes the resources you want to
|
626
|
+
# get data results for. A scope ID is an internally-generated
|
627
|
+
# identifier that includes all the resources for a specific root
|
628
|
+
# account. A scope ID is returned from a `CreateScope` API call.
|
629
|
+
# @return [String]
|
630
|
+
#
|
631
|
+
# @!attribute [rw] status
|
632
|
+
# The status of a scope. The status can be one of the following:
|
633
|
+
# `SUCCEEDED`, `IN_PROGRESS`, or `FAILED`.
|
634
|
+
# @return [String]
|
635
|
+
#
|
636
|
+
# @!attribute [rw] scope_arn
|
637
|
+
# The Amazon Resource Name (ARN) of the scope.
|
638
|
+
# @return [String]
|
639
|
+
#
|
640
|
+
# @!attribute [rw] targets
|
641
|
+
# The targets for a scope
|
642
|
+
# @return [Array<Types::TargetResource>]
|
643
|
+
#
|
644
|
+
# @!attribute [rw] tags
|
645
|
+
# The tags for a scope.
|
646
|
+
# @return [Hash<String,String>]
|
647
|
+
#
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetScopeOutput AWS API Documentation
|
649
|
+
#
|
650
|
+
class GetScopeOutput < Struct.new(
|
651
|
+
:scope_id,
|
652
|
+
:status,
|
653
|
+
:scope_arn,
|
654
|
+
:targets,
|
655
|
+
:tags)
|
656
|
+
SENSITIVE = []
|
657
|
+
include Aws::Structure
|
658
|
+
end
|
659
|
+
|
660
|
+
# An internal error occurred.
|
661
|
+
#
|
662
|
+
# @!attribute [rw] message
|
663
|
+
# @return [String]
|
664
|
+
#
|
665
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/InternalServerException AWS API Documentation
|
666
|
+
#
|
667
|
+
class InternalServerException < Struct.new(
|
668
|
+
:message)
|
669
|
+
SENSITIVE = []
|
670
|
+
include Aws::Structure
|
671
|
+
end
|
672
|
+
|
673
|
+
# Meta data about Kubernetes resources.
|
674
|
+
#
|
675
|
+
# @!attribute [rw] local_service_name
|
676
|
+
# The service name for a local resource.
|
677
|
+
# @return [String]
|
678
|
+
#
|
679
|
+
# @!attribute [rw] local_pod_name
|
680
|
+
# The name of the pod for a local resource.
|
681
|
+
# @return [String]
|
682
|
+
#
|
683
|
+
# @!attribute [rw] local_pod_namespace
|
684
|
+
# The namespace of the pod for a local resource.
|
685
|
+
# @return [String]
|
686
|
+
#
|
687
|
+
# @!attribute [rw] remote_service_name
|
688
|
+
# The service name for a remote resource.
|
689
|
+
# @return [String]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] remote_pod_name
|
692
|
+
# The name of the pod for a remote resource.
|
693
|
+
# @return [String]
|
694
|
+
#
|
695
|
+
# @!attribute [rw] remote_pod_namespace
|
696
|
+
# The namespace of the pod for a remote resource.
|
697
|
+
# @return [String]
|
698
|
+
#
|
699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/KubernetesMetadata AWS API Documentation
|
700
|
+
#
|
701
|
+
class KubernetesMetadata < Struct.new(
|
702
|
+
:local_service_name,
|
703
|
+
:local_pod_name,
|
704
|
+
:local_pod_namespace,
|
705
|
+
:remote_service_name,
|
706
|
+
:remote_pod_name,
|
707
|
+
:remote_pod_namespace)
|
708
|
+
SENSITIVE = []
|
709
|
+
include Aws::Structure
|
710
|
+
end
|
711
|
+
|
712
|
+
# @!attribute [rw] next_token
|
713
|
+
# The token for the next set of results. You receive this token from a
|
714
|
+
# previous call.
|
715
|
+
# @return [String]
|
716
|
+
#
|
717
|
+
# @!attribute [rw] max_results
|
718
|
+
# The number of query results that you want to return with this call.
|
719
|
+
# @return [Integer]
|
720
|
+
#
|
721
|
+
# @!attribute [rw] monitor_status
|
722
|
+
# The status of a monitor. The status can be one of the following
|
723
|
+
#
|
724
|
+
# * `PENDING`: The monitor is in the process of being created.
|
725
|
+
#
|
726
|
+
# * `ACTIVE`: The monitor is active.
|
727
|
+
#
|
728
|
+
# * `INACTIVE`: The monitor is inactive.
|
729
|
+
#
|
730
|
+
# * `ERROR`: Monitor creation failed due to an error.
|
731
|
+
#
|
732
|
+
# * `DELETING`: The monitor is in the process of being deleted.
|
733
|
+
# @return [String]
|
734
|
+
#
|
735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListMonitorsInput AWS API Documentation
|
736
|
+
#
|
737
|
+
class ListMonitorsInput < Struct.new(
|
738
|
+
:next_token,
|
739
|
+
:max_results,
|
740
|
+
:monitor_status)
|
741
|
+
SENSITIVE = []
|
742
|
+
include Aws::Structure
|
743
|
+
end
|
744
|
+
|
745
|
+
# @!attribute [rw] monitors
|
746
|
+
# The monitors that are in an account.
|
747
|
+
# @return [Array<Types::MonitorSummary>]
|
748
|
+
#
|
749
|
+
# @!attribute [rw] next_token
|
750
|
+
# The token for the next set of results. You receive this token from a
|
751
|
+
# previous call.
|
752
|
+
# @return [String]
|
753
|
+
#
|
754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListMonitorsOutput AWS API Documentation
|
755
|
+
#
|
756
|
+
class ListMonitorsOutput < Struct.new(
|
757
|
+
:monitors,
|
758
|
+
:next_token)
|
759
|
+
SENSITIVE = []
|
760
|
+
include Aws::Structure
|
761
|
+
end
|
762
|
+
|
763
|
+
# @!attribute [rw] next_token
|
764
|
+
# The token for the next set of results. You receive this token from a
|
765
|
+
# previous call.
|
766
|
+
# @return [String]
|
767
|
+
#
|
768
|
+
# @!attribute [rw] max_results
|
769
|
+
# The number of query results that you want to return with this call.
|
770
|
+
# @return [Integer]
|
771
|
+
#
|
772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListScopesInput AWS API Documentation
|
773
|
+
#
|
774
|
+
class ListScopesInput < Struct.new(
|
775
|
+
:next_token,
|
776
|
+
:max_results)
|
777
|
+
SENSITIVE = []
|
778
|
+
include Aws::Structure
|
779
|
+
end
|
780
|
+
|
781
|
+
# @!attribute [rw] scopes
|
782
|
+
# The scopes returned by the call.
|
783
|
+
# @return [Array<Types::ScopeSummary>]
|
784
|
+
#
|
785
|
+
# @!attribute [rw] next_token
|
786
|
+
# The token for the next set of results. You receive this token from a
|
787
|
+
# previous call.
|
788
|
+
# @return [String]
|
789
|
+
#
|
790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListScopesOutput AWS API Documentation
|
791
|
+
#
|
792
|
+
class ListScopesOutput < Struct.new(
|
793
|
+
:scopes,
|
794
|
+
:next_token)
|
795
|
+
SENSITIVE = []
|
796
|
+
include Aws::Structure
|
797
|
+
end
|
798
|
+
|
799
|
+
# @!attribute [rw] resource_arn
|
800
|
+
# The Amazon Resource Name (ARN) of the resource.
|
801
|
+
# @return [String]
|
802
|
+
#
|
803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListTagsForResourceInput AWS API Documentation
|
804
|
+
#
|
805
|
+
class ListTagsForResourceInput < Struct.new(
|
806
|
+
:resource_arn)
|
807
|
+
SENSITIVE = []
|
808
|
+
include Aws::Structure
|
809
|
+
end
|
810
|
+
|
811
|
+
# @!attribute [rw] tags
|
812
|
+
# The tags for a resource.
|
813
|
+
# @return [Hash<String,String>]
|
814
|
+
#
|
815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListTagsForResourceOutput AWS API Documentation
|
816
|
+
#
|
817
|
+
class ListTagsForResourceOutput < Struct.new(
|
818
|
+
:tags)
|
819
|
+
SENSITIVE = []
|
820
|
+
include Aws::Structure
|
821
|
+
end
|
822
|
+
|
823
|
+
# A local resource is the host where the agent is installed. Local
|
824
|
+
# resources can be a a subnet, a VPC, or an Availability Zone.
|
825
|
+
#
|
826
|
+
# @!attribute [rw] type
|
827
|
+
# The type of the local resource. Valid values are `AWS::EC2::VPC`
|
828
|
+
# `AWS::AvailabilityZone` or `AWS::EC2::Subnet`.
|
829
|
+
# @return [String]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] identifier
|
832
|
+
# The identifier of the local resource, such as an ARN.
|
833
|
+
# @return [String]
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/MonitorLocalResource AWS API Documentation
|
836
|
+
#
|
837
|
+
class MonitorLocalResource < Struct.new(
|
838
|
+
:type,
|
839
|
+
:identifier)
|
840
|
+
SENSITIVE = []
|
841
|
+
include Aws::Structure
|
842
|
+
end
|
843
|
+
|
844
|
+
# A remote resource is the other endpoint in a network flow. That is,
|
845
|
+
# one endpoint is the local resource and the other is the remote
|
846
|
+
# resource. Remote resources can be a a subnet, a VPC, an Availability
|
847
|
+
# Zone, or an Amazon Web Services service.
|
848
|
+
#
|
849
|
+
# @!attribute [rw] type
|
850
|
+
# The type of the remote resource. Valid values are `AWS::EC2::VPC`
|
851
|
+
# `AWS::AvailabilityZone`, `AWS::EC2::Subnet`, or `AWS::AWSService`.
|
852
|
+
# @return [String]
|
853
|
+
#
|
854
|
+
# @!attribute [rw] identifier
|
855
|
+
# The identifier of the remote resource, such as an ARN.
|
856
|
+
# @return [String]
|
857
|
+
#
|
858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/MonitorRemoteResource AWS API Documentation
|
859
|
+
#
|
860
|
+
class MonitorRemoteResource < Struct.new(
|
861
|
+
:type,
|
862
|
+
:identifier)
|
863
|
+
SENSITIVE = []
|
864
|
+
include Aws::Structure
|
865
|
+
end
|
866
|
+
|
867
|
+
# A summary of information about a monitor, includ the ARN, the name,
|
868
|
+
# and the status.
|
869
|
+
#
|
870
|
+
# @!attribute [rw] monitor_arn
|
871
|
+
# The Amazon Resource Name (ARN) of the monitor.
|
872
|
+
# @return [String]
|
873
|
+
#
|
874
|
+
# @!attribute [rw] monitor_name
|
875
|
+
# The name of the monitor.
|
876
|
+
# @return [String]
|
877
|
+
#
|
878
|
+
# @!attribute [rw] monitor_status
|
879
|
+
# The status of a monitor. The status can be one of the following
|
880
|
+
#
|
881
|
+
# * `PENDING`: The monitor is in the process of being created.
|
882
|
+
#
|
883
|
+
# * `ACTIVE`: The monitor is active.
|
884
|
+
#
|
885
|
+
# * `INACTIVE`: The monitor is inactive.
|
886
|
+
#
|
887
|
+
# * `ERROR`: Monitor creation failed due to an error.
|
888
|
+
#
|
889
|
+
# * `DELETING`: The monitor is in the process of being deleted.
|
890
|
+
# @return [String]
|
891
|
+
#
|
892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/MonitorSummary AWS API Documentation
|
893
|
+
#
|
894
|
+
class MonitorSummary < Struct.new(
|
895
|
+
:monitor_arn,
|
896
|
+
:monitor_name,
|
897
|
+
:monitor_status)
|
898
|
+
SENSITIVE = []
|
899
|
+
include Aws::Structure
|
900
|
+
end
|
901
|
+
|
902
|
+
# A set of information for a top contributor network flow in a monitor.
|
903
|
+
# In a monitor, Network Flow Monitor returns information about the
|
904
|
+
# network flows for top contributors for each metric. Top contributors
|
905
|
+
# are network flows with the top values for each metric type.
|
906
|
+
#
|
907
|
+
# @!attribute [rw] local_ip
|
908
|
+
# The IP address of the local resource for a top contributor network
|
909
|
+
# flow.
|
910
|
+
# @return [String]
|
911
|
+
#
|
912
|
+
# @!attribute [rw] snat_ip
|
913
|
+
# The secure network address translation (SNAT) IP address for a top
|
914
|
+
# contributor network flow.
|
915
|
+
# @return [String]
|
916
|
+
#
|
917
|
+
# @!attribute [rw] local_instance_id
|
918
|
+
# The instance identifier for the local resource for a top contributor
|
919
|
+
# network flow.
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @!attribute [rw] local_vpc_id
|
923
|
+
# The VPC ID for a top contributor network flow for the local
|
924
|
+
# resource.
|
925
|
+
# @return [String]
|
926
|
+
#
|
927
|
+
# @!attribute [rw] local_region
|
928
|
+
# The Amazon Web Services Region for the local resource for a top
|
929
|
+
# contributor network flow.
|
930
|
+
# @return [String]
|
931
|
+
#
|
932
|
+
# @!attribute [rw] local_az
|
933
|
+
# The Availability Zone for the local resource for a top contributor
|
934
|
+
# network flow.
|
935
|
+
# @return [String]
|
936
|
+
#
|
937
|
+
# @!attribute [rw] local_subnet_id
|
938
|
+
# The subnet ID for the local resource for a top contributor network
|
939
|
+
# flow.
|
940
|
+
# @return [String]
|
941
|
+
#
|
942
|
+
# @!attribute [rw] target_port
|
943
|
+
# The target port.
|
944
|
+
# @return [Integer]
|
945
|
+
#
|
946
|
+
# @!attribute [rw] destination_category
|
947
|
+
# The destination category for a top contributors row. Destination
|
948
|
+
# categories can be one of the following:
|
949
|
+
#
|
950
|
+
# * `INTRA_AZ`: Top contributor network flows within a single
|
951
|
+
# Availability Zone
|
952
|
+
#
|
953
|
+
# * `INTER_AZ`: Top contributor network flows between Availability
|
954
|
+
# Zones
|
955
|
+
#
|
956
|
+
# * `INTER_VPC`: Top contributor network flows between VPCs
|
957
|
+
#
|
958
|
+
# * `AWS_SERVICES`: Top contributor network flows to or from Amazon
|
959
|
+
# Web Services services
|
960
|
+
#
|
961
|
+
# * `UNCLASSIFIED`: Top contributor network flows that do not have a
|
962
|
+
# bucket classification
|
963
|
+
# @return [String]
|
964
|
+
#
|
965
|
+
# @!attribute [rw] remote_vpc_id
|
966
|
+
# The VPC ID for a top contributor network flow for the remote
|
967
|
+
# resource.
|
968
|
+
# @return [String]
|
969
|
+
#
|
970
|
+
# @!attribute [rw] remote_region
|
971
|
+
# The Amazon Web Services Region for the remote resource for a top
|
972
|
+
# contributor network flow.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @!attribute [rw] remote_az
|
976
|
+
# The Availability Zone for the remote resource for a top contributor
|
977
|
+
# network flow.
|
978
|
+
# @return [String]
|
979
|
+
#
|
980
|
+
# @!attribute [rw] remote_subnet_id
|
981
|
+
# The subnet ID for the remote resource for a top contributor network
|
982
|
+
# flow.
|
983
|
+
# @return [String]
|
984
|
+
#
|
985
|
+
# @!attribute [rw] remote_instance_id
|
986
|
+
# The instance identifier for the remote resource for a top
|
987
|
+
# contributor network flow.
|
988
|
+
# @return [String]
|
989
|
+
#
|
990
|
+
# @!attribute [rw] remote_ip
|
991
|
+
# The IP address of the remote resource for a top contributor network
|
992
|
+
# flow.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] dnat_ip
|
996
|
+
# The destination network address translation (DNAT) IP address for a
|
997
|
+
# top contributor network flow.
|
998
|
+
# @return [String]
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] value
|
1001
|
+
# The value of the metric for a top contributor network flow.
|
1002
|
+
# @return [Integer]
|
1003
|
+
#
|
1004
|
+
# @!attribute [rw] traversed_constructs
|
1005
|
+
# The constructs traversed by a network flow.
|
1006
|
+
# @return [Array<Types::TraversedComponent>]
|
1007
|
+
#
|
1008
|
+
# @!attribute [rw] kubernetes_metadata
|
1009
|
+
# Meta data about Kubernetes resources.
|
1010
|
+
# @return [Types::KubernetesMetadata]
|
1011
|
+
#
|
1012
|
+
# @!attribute [rw] local_instance_arn
|
1013
|
+
# The Amazon Resource Name (ARN) of a local resource.
|
1014
|
+
# @return [String]
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] local_subnet_arn
|
1017
|
+
# The Amazon Resource Name (ARN) of a local subnet.
|
1018
|
+
# @return [String]
|
1019
|
+
#
|
1020
|
+
# @!attribute [rw] local_vpc_arn
|
1021
|
+
# The Amazon Resource Name (ARN) of a local VPC.
|
1022
|
+
# @return [String]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] remote_instance_arn
|
1025
|
+
# The Amazon Resource Name (ARN) of a remote resource.
|
1026
|
+
# @return [String]
|
1027
|
+
#
|
1028
|
+
# @!attribute [rw] remote_subnet_arn
|
1029
|
+
# The Amazon Resource Name (ARN) of a remote subnet.
|
1030
|
+
# @return [String]
|
1031
|
+
#
|
1032
|
+
# @!attribute [rw] remote_vpc_arn
|
1033
|
+
# The Amazon Resource Name (ARN) of a remote VPC.
|
1034
|
+
# @return [String]
|
1035
|
+
#
|
1036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/MonitorTopContributorsRow AWS API Documentation
|
1037
|
+
#
|
1038
|
+
class MonitorTopContributorsRow < Struct.new(
|
1039
|
+
:local_ip,
|
1040
|
+
:snat_ip,
|
1041
|
+
:local_instance_id,
|
1042
|
+
:local_vpc_id,
|
1043
|
+
:local_region,
|
1044
|
+
:local_az,
|
1045
|
+
:local_subnet_id,
|
1046
|
+
:target_port,
|
1047
|
+
:destination_category,
|
1048
|
+
:remote_vpc_id,
|
1049
|
+
:remote_region,
|
1050
|
+
:remote_az,
|
1051
|
+
:remote_subnet_id,
|
1052
|
+
:remote_instance_id,
|
1053
|
+
:remote_ip,
|
1054
|
+
:dnat_ip,
|
1055
|
+
:value,
|
1056
|
+
:traversed_constructs,
|
1057
|
+
:kubernetes_metadata,
|
1058
|
+
:local_instance_arn,
|
1059
|
+
:local_subnet_arn,
|
1060
|
+
:local_vpc_arn,
|
1061
|
+
:remote_instance_arn,
|
1062
|
+
:remote_subnet_arn,
|
1063
|
+
:remote_vpc_arn)
|
1064
|
+
SENSITIVE = []
|
1065
|
+
include Aws::Structure
|
1066
|
+
end
|
1067
|
+
|
1068
|
+
# The request specifies a resource that doesn't exist.
|
1069
|
+
#
|
1070
|
+
# @!attribute [rw] message
|
1071
|
+
# @return [String]
|
1072
|
+
#
|
1073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ResourceNotFoundException AWS API Documentation
|
1074
|
+
#
|
1075
|
+
class ResourceNotFoundException < Struct.new(
|
1076
|
+
:message)
|
1077
|
+
SENSITIVE = []
|
1078
|
+
include Aws::Structure
|
1079
|
+
end
|
1080
|
+
|
1081
|
+
# A summary of information about a scope, including the ARN, target ID,
|
1082
|
+
# and Amazon Web Services Region.
|
1083
|
+
#
|
1084
|
+
# @!attribute [rw] scope_id
|
1085
|
+
# The identifier for the scope that includes the resources you want to
|
1086
|
+
# get data results for. A scope ID is an internally-generated
|
1087
|
+
# identifier that includes all the resources for a specific root
|
1088
|
+
# account.
|
1089
|
+
# @return [String]
|
1090
|
+
#
|
1091
|
+
# @!attribute [rw] status
|
1092
|
+
# The status of a scope. The status can be one of the following,
|
1093
|
+
# depending on the state of scope creation: `SUCCEEDED`,
|
1094
|
+
# `IN_PROGRESS`, or `FAILED`.
|
1095
|
+
# @return [String]
|
1096
|
+
#
|
1097
|
+
# @!attribute [rw] scope_arn
|
1098
|
+
# The Amazon Resource Name (ARN) of the scope.
|
1099
|
+
# @return [String]
|
1100
|
+
#
|
1101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ScopeSummary AWS API Documentation
|
1102
|
+
#
|
1103
|
+
class ScopeSummary < Struct.new(
|
1104
|
+
:scope_id,
|
1105
|
+
:status,
|
1106
|
+
:scope_arn)
|
1107
|
+
SENSITIVE = []
|
1108
|
+
include Aws::Structure
|
1109
|
+
end
|
1110
|
+
|
1111
|
+
# The request exceeded a service quota.
|
1112
|
+
#
|
1113
|
+
# @!attribute [rw] message
|
1114
|
+
# @return [String]
|
1115
|
+
#
|
1116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ServiceQuotaExceededException AWS API Documentation
|
1117
|
+
#
|
1118
|
+
class ServiceQuotaExceededException < Struct.new(
|
1119
|
+
:message)
|
1120
|
+
SENSITIVE = []
|
1121
|
+
include Aws::Structure
|
1122
|
+
end
|
1123
|
+
|
1124
|
+
# @!attribute [rw] monitor_name
|
1125
|
+
# The name of the monitor.
|
1126
|
+
# @return [String]
|
1127
|
+
#
|
1128
|
+
# @!attribute [rw] start_time
|
1129
|
+
# The timestamp that is the date and time beginning of the period that
|
1130
|
+
# you want to retrieve results for with your query.
|
1131
|
+
# @return [Time]
|
1132
|
+
#
|
1133
|
+
# @!attribute [rw] end_time
|
1134
|
+
# The timestamp that is the date and time end of the period that you
|
1135
|
+
# want to retrieve results for with your query.
|
1136
|
+
# @return [Time]
|
1137
|
+
#
|
1138
|
+
# @!attribute [rw] metric_name
|
1139
|
+
# The metric that you want to query top contributors for. That is, you
|
1140
|
+
# can specify this metric to return the top contributor network flows,
|
1141
|
+
# for this type of metric, for a monitor and (optionally) within a
|
1142
|
+
# specific category, such as network flows between Availability Zones.
|
1143
|
+
# @return [String]
|
1144
|
+
#
|
1145
|
+
# @!attribute [rw] destination_category
|
1146
|
+
# The category that you want to query top contributors for, for a
|
1147
|
+
# specific monitor. Destination categories can be one of the
|
1148
|
+
# following:
|
1149
|
+
#
|
1150
|
+
# * `INTRA_AZ`: Top contributor network flows within a single
|
1151
|
+
# Availability Zone
|
1152
|
+
#
|
1153
|
+
# * `INTER_AZ`: Top contributor network flows between Availability
|
1154
|
+
# Zones
|
1155
|
+
#
|
1156
|
+
# * `INTER_VPC`: Top contributor network flows between VPCs
|
1157
|
+
#
|
1158
|
+
# * `AWS_SERVICES`: Top contributor network flows to or from Amazon
|
1159
|
+
# Web Services services
|
1160
|
+
#
|
1161
|
+
# * `UNCLASSIFIED`: Top contributor network flows that do not have a
|
1162
|
+
# bucket classification
|
1163
|
+
# @return [String]
|
1164
|
+
#
|
1165
|
+
# @!attribute [rw] limit
|
1166
|
+
# The maximum number of top contributors to return.
|
1167
|
+
# @return [Integer]
|
1168
|
+
#
|
1169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StartQueryMonitorTopContributorsInput AWS API Documentation
|
1170
|
+
#
|
1171
|
+
class StartQueryMonitorTopContributorsInput < Struct.new(
|
1172
|
+
:monitor_name,
|
1173
|
+
:start_time,
|
1174
|
+
:end_time,
|
1175
|
+
:metric_name,
|
1176
|
+
:destination_category,
|
1177
|
+
:limit)
|
1178
|
+
SENSITIVE = []
|
1179
|
+
include Aws::Structure
|
1180
|
+
end
|
1181
|
+
|
1182
|
+
# @!attribute [rw] query_id
|
1183
|
+
# The identifier for the query. A query ID is an internally-generated
|
1184
|
+
# identifier for a specific query returned from an API call to start a
|
1185
|
+
# query.
|
1186
|
+
# @return [String]
|
1187
|
+
#
|
1188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StartQueryMonitorTopContributorsOutput AWS API Documentation
|
1189
|
+
#
|
1190
|
+
class StartQueryMonitorTopContributorsOutput < Struct.new(
|
1191
|
+
:query_id)
|
1192
|
+
SENSITIVE = []
|
1193
|
+
include Aws::Structure
|
1194
|
+
end
|
1195
|
+
|
1196
|
+
# @!attribute [rw] scope_id
|
1197
|
+
# The identifier for the scope that includes the resources you want to
|
1198
|
+
# get data results for. A scope ID is an internally-generated
|
1199
|
+
# identifier that includes all the resources for a specific root
|
1200
|
+
# account.
|
1201
|
+
# @return [String]
|
1202
|
+
#
|
1203
|
+
# @!attribute [rw] start_time
|
1204
|
+
# The timestamp that is the date and time beginning of the period that
|
1205
|
+
# you want to retrieve results for with your query.
|
1206
|
+
# @return [Time]
|
1207
|
+
#
|
1208
|
+
# @!attribute [rw] end_time
|
1209
|
+
# The timestamp that is the date and time end of the period that you
|
1210
|
+
# want to retrieve results for with your query.
|
1211
|
+
# @return [Time]
|
1212
|
+
#
|
1213
|
+
# @!attribute [rw] metric_name
|
1214
|
+
# The metric that you want to query top contributors for. That is, you
|
1215
|
+
# can specify this metric to return the top contributor network flows,
|
1216
|
+
# for this type of metric, for a monitor and (optionally) within a
|
1217
|
+
# specific category, such as network flows between Availability Zones.
|
1218
|
+
# @return [String]
|
1219
|
+
#
|
1220
|
+
# @!attribute [rw] destination_category
|
1221
|
+
# The destination category for a top contributors. Destination
|
1222
|
+
# categories can be one of the following:
|
1223
|
+
#
|
1224
|
+
# * `INTRA_AZ`: Top contributor network flows within a single
|
1225
|
+
# Availability Zone
|
1226
|
+
#
|
1227
|
+
# * `INTER_AZ`: Top contributor network flows between Availability
|
1228
|
+
# Zones
|
1229
|
+
#
|
1230
|
+
# * `INTER_VPC`: Top contributor network flows between VPCs
|
1231
|
+
#
|
1232
|
+
# * `AWS_SERVICES`: Top contributor network flows to or from Amazon
|
1233
|
+
# Web Services services
|
1234
|
+
#
|
1235
|
+
# * `UNCLASSIFIED`: Top contributor network flows that do not have a
|
1236
|
+
# bucket classification
|
1237
|
+
# @return [String]
|
1238
|
+
#
|
1239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StartQueryWorkloadInsightsTopContributorsDataInput AWS API Documentation
|
1240
|
+
#
|
1241
|
+
class StartQueryWorkloadInsightsTopContributorsDataInput < Struct.new(
|
1242
|
+
:scope_id,
|
1243
|
+
:start_time,
|
1244
|
+
:end_time,
|
1245
|
+
:metric_name,
|
1246
|
+
:destination_category)
|
1247
|
+
SENSITIVE = []
|
1248
|
+
include Aws::Structure
|
1249
|
+
end
|
1250
|
+
|
1251
|
+
# @!attribute [rw] query_id
|
1252
|
+
# The identifier for the query. A query ID is an internally-generated
|
1253
|
+
# identifier for a specific query returned from an API call to start a
|
1254
|
+
# query.
|
1255
|
+
# @return [String]
|
1256
|
+
#
|
1257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StartQueryWorkloadInsightsTopContributorsDataOutput AWS API Documentation
|
1258
|
+
#
|
1259
|
+
class StartQueryWorkloadInsightsTopContributorsDataOutput < Struct.new(
|
1260
|
+
:query_id)
|
1261
|
+
SENSITIVE = []
|
1262
|
+
include Aws::Structure
|
1263
|
+
end
|
1264
|
+
|
1265
|
+
# @!attribute [rw] scope_id
|
1266
|
+
# The identifier for the scope that includes the resources you want to
|
1267
|
+
# get data results for. A scope ID is an internally-generated
|
1268
|
+
# identifier that includes all the resources for a specific root
|
1269
|
+
# account. A scope ID is returned from a `CreateScope` API call.
|
1270
|
+
# @return [String]
|
1271
|
+
#
|
1272
|
+
# @!attribute [rw] start_time
|
1273
|
+
# The timestamp that is the date and time beginning of the period that
|
1274
|
+
# you want to retrieve results for with your query.
|
1275
|
+
# @return [Time]
|
1276
|
+
#
|
1277
|
+
# @!attribute [rw] end_time
|
1278
|
+
# The timestamp that is the date and time end of the period that you
|
1279
|
+
# want to retrieve results for with your query.
|
1280
|
+
# @return [Time]
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] metric_name
|
1283
|
+
# The metric that you want to query top contributors for. That is, you
|
1284
|
+
# can specify this metric to return the top contributor network flows,
|
1285
|
+
# for this type of metric, for a monitor and (optionally) within a
|
1286
|
+
# specific category, such as network flows between Availability Zones.
|
1287
|
+
# @return [String]
|
1288
|
+
#
|
1289
|
+
# @!attribute [rw] destination_category
|
1290
|
+
# The destination category for a top contributors row. Destination
|
1291
|
+
# categories can be one of the following:
|
1292
|
+
#
|
1293
|
+
# * `INTRA_AZ`: Top contributor network flows within a single
|
1294
|
+
# Availability Zone
|
1295
|
+
#
|
1296
|
+
# * `INTER_AZ`: Top contributor network flows between Availability
|
1297
|
+
# Zones
|
1298
|
+
#
|
1299
|
+
# * `INTER_VPC`: Top contributor network flows between VPCs
|
1300
|
+
#
|
1301
|
+
# * `AWS_SERVICES`: Top contributor network flows to or from Amazon
|
1302
|
+
# Web Services services
|
1303
|
+
#
|
1304
|
+
# * `UNCLASSIFIED`: Top contributor network flows that do not have a
|
1305
|
+
# bucket classification
|
1306
|
+
# @return [String]
|
1307
|
+
#
|
1308
|
+
# @!attribute [rw] limit
|
1309
|
+
# The maximum number of top contributors to return.
|
1310
|
+
# @return [Integer]
|
1311
|
+
#
|
1312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StartQueryWorkloadInsightsTopContributorsInput AWS API Documentation
|
1313
|
+
#
|
1314
|
+
class StartQueryWorkloadInsightsTopContributorsInput < Struct.new(
|
1315
|
+
:scope_id,
|
1316
|
+
:start_time,
|
1317
|
+
:end_time,
|
1318
|
+
:metric_name,
|
1319
|
+
:destination_category,
|
1320
|
+
:limit)
|
1321
|
+
SENSITIVE = []
|
1322
|
+
include Aws::Structure
|
1323
|
+
end
|
1324
|
+
|
1325
|
+
# @!attribute [rw] query_id
|
1326
|
+
# The identifier for the query. A query ID is an internally-generated
|
1327
|
+
# identifier for a specific query returned from an API call to start a
|
1328
|
+
# query.
|
1329
|
+
# @return [String]
|
1330
|
+
#
|
1331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StartQueryWorkloadInsightsTopContributorsOutput AWS API Documentation
|
1332
|
+
#
|
1333
|
+
class StartQueryWorkloadInsightsTopContributorsOutput < Struct.new(
|
1334
|
+
:query_id)
|
1335
|
+
SENSITIVE = []
|
1336
|
+
include Aws::Structure
|
1337
|
+
end
|
1338
|
+
|
1339
|
+
# @!attribute [rw] monitor_name
|
1340
|
+
# The name of the monitor.
|
1341
|
+
# @return [String]
|
1342
|
+
#
|
1343
|
+
# @!attribute [rw] query_id
|
1344
|
+
# The identifier for the query. A query ID is an internally-generated
|
1345
|
+
# identifier for a specific query returned from an API call to start a
|
1346
|
+
# query.
|
1347
|
+
# @return [String]
|
1348
|
+
#
|
1349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StopQueryMonitorTopContributorsInput AWS API Documentation
|
1350
|
+
#
|
1351
|
+
class StopQueryMonitorTopContributorsInput < Struct.new(
|
1352
|
+
:monitor_name,
|
1353
|
+
:query_id)
|
1354
|
+
SENSITIVE = []
|
1355
|
+
include Aws::Structure
|
1356
|
+
end
|
1357
|
+
|
1358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StopQueryMonitorTopContributorsOutput AWS API Documentation
|
1359
|
+
#
|
1360
|
+
class StopQueryMonitorTopContributorsOutput < Aws::EmptyStructure; end
|
1361
|
+
|
1362
|
+
# @!attribute [rw] scope_id
|
1363
|
+
# The identifier for the scope that includes the resources you want to
|
1364
|
+
# get data results for. A scope ID is an internally-generated
|
1365
|
+
# identifier that includes all the resources for a specific root
|
1366
|
+
# account.
|
1367
|
+
# @return [String]
|
1368
|
+
#
|
1369
|
+
# @!attribute [rw] query_id
|
1370
|
+
# The identifier for the query. A query ID is an internally-generated
|
1371
|
+
# identifier for a specific query returned from an API call to start a
|
1372
|
+
# query.
|
1373
|
+
# @return [String]
|
1374
|
+
#
|
1375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StopQueryWorkloadInsightsTopContributorsDataInput AWS API Documentation
|
1376
|
+
#
|
1377
|
+
class StopQueryWorkloadInsightsTopContributorsDataInput < Struct.new(
|
1378
|
+
:scope_id,
|
1379
|
+
:query_id)
|
1380
|
+
SENSITIVE = []
|
1381
|
+
include Aws::Structure
|
1382
|
+
end
|
1383
|
+
|
1384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StopQueryWorkloadInsightsTopContributorsDataOutput AWS API Documentation
|
1385
|
+
#
|
1386
|
+
class StopQueryWorkloadInsightsTopContributorsDataOutput < Aws::EmptyStructure; end
|
1387
|
+
|
1388
|
+
# @!attribute [rw] scope_id
|
1389
|
+
# The identifier for the scope that includes the resources you want to
|
1390
|
+
# get data results for. A scope ID is an internally-generated
|
1391
|
+
# identifier that includes all the resources for a specific root
|
1392
|
+
# account.
|
1393
|
+
# @return [String]
|
1394
|
+
#
|
1395
|
+
# @!attribute [rw] query_id
|
1396
|
+
# The identifier for the query. A query ID is an internally-generated
|
1397
|
+
# identifier for a specific query returned from an API call to start a
|
1398
|
+
# query.
|
1399
|
+
# @return [String]
|
1400
|
+
#
|
1401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StopQueryWorkloadInsightsTopContributorsInput AWS API Documentation
|
1402
|
+
#
|
1403
|
+
class StopQueryWorkloadInsightsTopContributorsInput < Struct.new(
|
1404
|
+
:scope_id,
|
1405
|
+
:query_id)
|
1406
|
+
SENSITIVE = []
|
1407
|
+
include Aws::Structure
|
1408
|
+
end
|
1409
|
+
|
1410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StopQueryWorkloadInsightsTopContributorsOutput AWS API Documentation
|
1411
|
+
#
|
1412
|
+
class StopQueryWorkloadInsightsTopContributorsOutput < Aws::EmptyStructure; end
|
1413
|
+
|
1414
|
+
# @!attribute [rw] resource_arn
|
1415
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1416
|
+
# @return [String]
|
1417
|
+
#
|
1418
|
+
# @!attribute [rw] tags
|
1419
|
+
# The tags for a resource.
|
1420
|
+
# @return [Hash<String,String>]
|
1421
|
+
#
|
1422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/TagResourceInput AWS API Documentation
|
1423
|
+
#
|
1424
|
+
class TagResourceInput < Struct.new(
|
1425
|
+
:resource_arn,
|
1426
|
+
:tags)
|
1427
|
+
SENSITIVE = []
|
1428
|
+
include Aws::Structure
|
1429
|
+
end
|
1430
|
+
|
1431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/TagResourceOutput AWS API Documentation
|
1432
|
+
#
|
1433
|
+
class TagResourceOutput < Aws::EmptyStructure; end
|
1434
|
+
|
1435
|
+
# A target ID is an internally-generated identifier for a target. A
|
1436
|
+
# target allows you to identify all the resources in a Network Flow
|
1437
|
+
# Monitor scope. Currently, a target is always an Amazon Web Services
|
1438
|
+
# account.
|
1439
|
+
#
|
1440
|
+
# @note TargetId is a union - when making an API calls you must set exactly one of the members.
|
1441
|
+
#
|
1442
|
+
# @note TargetId is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of TargetId corresponding to the set member.
|
1443
|
+
#
|
1444
|
+
# @!attribute [rw] account_id
|
1445
|
+
# The identifier for the account for a target.
|
1446
|
+
# @return [String]
|
1447
|
+
#
|
1448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/TargetId AWS API Documentation
|
1449
|
+
#
|
1450
|
+
class TargetId < Struct.new(
|
1451
|
+
:account_id,
|
1452
|
+
:unknown)
|
1453
|
+
SENSITIVE = []
|
1454
|
+
include Aws::Structure
|
1455
|
+
include Aws::Structure::Union
|
1456
|
+
|
1457
|
+
class AccountId < TargetId; end
|
1458
|
+
class Unknown < TargetId; end
|
1459
|
+
end
|
1460
|
+
|
1461
|
+
# A target identifier is a pair of identifying information for a
|
1462
|
+
# resource that is included in a target. A target identifier includes
|
1463
|
+
# the target ID and the target type.
|
1464
|
+
#
|
1465
|
+
# @!attribute [rw] target_id
|
1466
|
+
# The identifier for a target.
|
1467
|
+
# @return [Types::TargetId]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] target_type
|
1470
|
+
# The type of a target. A target type is currently always `ACCOUNT`
|
1471
|
+
# because a target is currently a single Amazon Web Services account.
|
1472
|
+
# @return [String]
|
1473
|
+
#
|
1474
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/TargetIdentifier AWS API Documentation
|
1475
|
+
#
|
1476
|
+
class TargetIdentifier < Struct.new(
|
1477
|
+
:target_id,
|
1478
|
+
:target_type)
|
1479
|
+
SENSITIVE = []
|
1480
|
+
include Aws::Structure
|
1481
|
+
end
|
1482
|
+
|
1483
|
+
# A target resource in a scope. The resource is identified by a Region
|
1484
|
+
# and a target identifier, which includes a target ID and a target type.
|
1485
|
+
#
|
1486
|
+
# @!attribute [rw] target_identifier
|
1487
|
+
# A target identifier is a pair of identifying information for a
|
1488
|
+
# resource that is included in a target. A target identifier includes
|
1489
|
+
# the target ID and the target type.
|
1490
|
+
# @return [Types::TargetIdentifier]
|
1491
|
+
#
|
1492
|
+
# @!attribute [rw] region
|
1493
|
+
# The Amazon Web Services Region where the target resource is located.
|
1494
|
+
# @return [String]
|
1495
|
+
#
|
1496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/TargetResource AWS API Documentation
|
1497
|
+
#
|
1498
|
+
class TargetResource < Struct.new(
|
1499
|
+
:target_identifier,
|
1500
|
+
:region)
|
1501
|
+
SENSITIVE = []
|
1502
|
+
include Aws::Structure
|
1503
|
+
end
|
1504
|
+
|
1505
|
+
# The request was denied due to request throttling.
|
1506
|
+
#
|
1507
|
+
# @!attribute [rw] message
|
1508
|
+
# @return [String]
|
1509
|
+
#
|
1510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ThrottlingException AWS API Documentation
|
1511
|
+
#
|
1512
|
+
class ThrottlingException < Struct.new(
|
1513
|
+
:message)
|
1514
|
+
SENSITIVE = []
|
1515
|
+
include Aws::Structure
|
1516
|
+
end
|
1517
|
+
|
1518
|
+
# A section of the network that a network flow has traveled through.
|
1519
|
+
#
|
1520
|
+
# @!attribute [rw] component_id
|
1521
|
+
# The identifier for the traversed component.
|
1522
|
+
# @return [String]
|
1523
|
+
#
|
1524
|
+
# @!attribute [rw] component_type
|
1525
|
+
# The type of component that was traversed.
|
1526
|
+
# @return [String]
|
1527
|
+
#
|
1528
|
+
# @!attribute [rw] component_arn
|
1529
|
+
# The Amazon Resource Name (ARN) of a tranversed component.
|
1530
|
+
# @return [String]
|
1531
|
+
#
|
1532
|
+
# @!attribute [rw] service_name
|
1533
|
+
# The service name for the traversed component.
|
1534
|
+
# @return [String]
|
1535
|
+
#
|
1536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/TraversedComponent AWS API Documentation
|
1537
|
+
#
|
1538
|
+
class TraversedComponent < Struct.new(
|
1539
|
+
:component_id,
|
1540
|
+
:component_type,
|
1541
|
+
:component_arn,
|
1542
|
+
:service_name)
|
1543
|
+
SENSITIVE = []
|
1544
|
+
include Aws::Structure
|
1545
|
+
end
|
1546
|
+
|
1547
|
+
# @!attribute [rw] resource_arn
|
1548
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1549
|
+
# @return [String]
|
1550
|
+
#
|
1551
|
+
# @!attribute [rw] tag_keys
|
1552
|
+
# Keys that you specified when you tagged a resource.
|
1553
|
+
# @return [Array<String>]
|
1554
|
+
#
|
1555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/UntagResourceInput AWS API Documentation
|
1556
|
+
#
|
1557
|
+
class UntagResourceInput < Struct.new(
|
1558
|
+
:resource_arn,
|
1559
|
+
:tag_keys)
|
1560
|
+
SENSITIVE = []
|
1561
|
+
include Aws::Structure
|
1562
|
+
end
|
1563
|
+
|
1564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/UntagResourceOutput AWS API Documentation
|
1565
|
+
#
|
1566
|
+
class UntagResourceOutput < Aws::EmptyStructure; end
|
1567
|
+
|
1568
|
+
# @!attribute [rw] monitor_name
|
1569
|
+
# The name of the monitor.
|
1570
|
+
# @return [String]
|
1571
|
+
#
|
1572
|
+
# @!attribute [rw] local_resources_to_add
|
1573
|
+
# The local resources to add, as an array of resources with
|
1574
|
+
# identifiers and types.
|
1575
|
+
# @return [Array<Types::MonitorLocalResource>]
|
1576
|
+
#
|
1577
|
+
# @!attribute [rw] local_resources_to_remove
|
1578
|
+
# The local resources to remove, as an array of resources with
|
1579
|
+
# identifiers and types.
|
1580
|
+
# @return [Array<Types::MonitorLocalResource>]
|
1581
|
+
#
|
1582
|
+
# @!attribute [rw] remote_resources_to_add
|
1583
|
+
# The remove resources to add, as an array of resources with
|
1584
|
+
# identifiers and types.
|
1585
|
+
# @return [Array<Types::MonitorRemoteResource>]
|
1586
|
+
#
|
1587
|
+
# @!attribute [rw] remote_resources_to_remove
|
1588
|
+
# The remove resources to remove, as an array of resources with
|
1589
|
+
# identifiers and types.
|
1590
|
+
# @return [Array<Types::MonitorRemoteResource>]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] client_token
|
1593
|
+
# A unique, case-sensitive string of up to 64 ASCII characters that
|
1594
|
+
# you specify to make an idempotent API request. Don't reuse the same
|
1595
|
+
# client token for other API requests.
|
1596
|
+
#
|
1597
|
+
# **A suitable default value is auto-generated.** You should normally
|
1598
|
+
# not need to pass this option.
|
1599
|
+
# @return [String]
|
1600
|
+
#
|
1601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/UpdateMonitorInput AWS API Documentation
|
1602
|
+
#
|
1603
|
+
class UpdateMonitorInput < Struct.new(
|
1604
|
+
:monitor_name,
|
1605
|
+
:local_resources_to_add,
|
1606
|
+
:local_resources_to_remove,
|
1607
|
+
:remote_resources_to_add,
|
1608
|
+
:remote_resources_to_remove,
|
1609
|
+
:client_token)
|
1610
|
+
SENSITIVE = []
|
1611
|
+
include Aws::Structure
|
1612
|
+
end
|
1613
|
+
|
1614
|
+
# @!attribute [rw] monitor_arn
|
1615
|
+
# The Amazon Resource Name (ARN) of the monitor.
|
1616
|
+
# @return [String]
|
1617
|
+
#
|
1618
|
+
# @!attribute [rw] monitor_name
|
1619
|
+
# The name of the monitor.
|
1620
|
+
# @return [String]
|
1621
|
+
#
|
1622
|
+
# @!attribute [rw] monitor_status
|
1623
|
+
# The status of a monitor. The status can be one of the following
|
1624
|
+
#
|
1625
|
+
# * `PENDING`: The monitor is in the process of being created.
|
1626
|
+
#
|
1627
|
+
# * `ACTIVE`: The monitor is active.
|
1628
|
+
#
|
1629
|
+
# * `INACTIVE`: The monitor is inactive.
|
1630
|
+
#
|
1631
|
+
# * `ERROR`: Monitor creation failed due to an error.
|
1632
|
+
#
|
1633
|
+
# * `DELETING`: The monitor is in the process of being deleted.
|
1634
|
+
# @return [String]
|
1635
|
+
#
|
1636
|
+
# @!attribute [rw] local_resources
|
1637
|
+
# The local resources updated for a monitor, as an array of resources
|
1638
|
+
# with identifiers and types.
|
1639
|
+
# @return [Array<Types::MonitorLocalResource>]
|
1640
|
+
#
|
1641
|
+
# @!attribute [rw] remote_resources
|
1642
|
+
# The remote resources updated for a monitor, as an array of resources
|
1643
|
+
# with identifiers and types.
|
1644
|
+
# @return [Array<Types::MonitorRemoteResource>]
|
1645
|
+
#
|
1646
|
+
# @!attribute [rw] created_at
|
1647
|
+
# The date and time when the monitor was created.
|
1648
|
+
# @return [Time]
|
1649
|
+
#
|
1650
|
+
# @!attribute [rw] modified_at
|
1651
|
+
# The last date and time that the monitor was modified.
|
1652
|
+
# @return [Time]
|
1653
|
+
#
|
1654
|
+
# @!attribute [rw] tags
|
1655
|
+
# The tags for a monitor.
|
1656
|
+
# @return [Hash<String,String>]
|
1657
|
+
#
|
1658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/UpdateMonitorOutput AWS API Documentation
|
1659
|
+
#
|
1660
|
+
class UpdateMonitorOutput < Struct.new(
|
1661
|
+
:monitor_arn,
|
1662
|
+
:monitor_name,
|
1663
|
+
:monitor_status,
|
1664
|
+
:local_resources,
|
1665
|
+
:remote_resources,
|
1666
|
+
:created_at,
|
1667
|
+
:modified_at,
|
1668
|
+
:tags)
|
1669
|
+
SENSITIVE = []
|
1670
|
+
include Aws::Structure
|
1671
|
+
end
|
1672
|
+
|
1673
|
+
# @!attribute [rw] scope_id
|
1674
|
+
# The identifier for the scope that includes the resources you want to
|
1675
|
+
# get data results for. A scope ID is an internally-generated
|
1676
|
+
# identifier that includes all the resources for a specific root
|
1677
|
+
# account.
|
1678
|
+
# @return [String]
|
1679
|
+
#
|
1680
|
+
# @!attribute [rw] resources_to_add
|
1681
|
+
# A list of resources to add to a scope.
|
1682
|
+
# @return [Array<Types::TargetResource>]
|
1683
|
+
#
|
1684
|
+
# @!attribute [rw] resources_to_delete
|
1685
|
+
# A list of resources to delete from a scope.
|
1686
|
+
# @return [Array<Types::TargetResource>]
|
1687
|
+
#
|
1688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/UpdateScopeInput AWS API Documentation
|
1689
|
+
#
|
1690
|
+
class UpdateScopeInput < Struct.new(
|
1691
|
+
:scope_id,
|
1692
|
+
:resources_to_add,
|
1693
|
+
:resources_to_delete)
|
1694
|
+
SENSITIVE = []
|
1695
|
+
include Aws::Structure
|
1696
|
+
end
|
1697
|
+
|
1698
|
+
# @!attribute [rw] scope_id
|
1699
|
+
# The identifier for the scope that includes the resources you want to
|
1700
|
+
# get data results for. A scope ID is an internally-generated
|
1701
|
+
# identifier that includes all the resources for a specific root
|
1702
|
+
# account.
|
1703
|
+
# @return [String]
|
1704
|
+
#
|
1705
|
+
# @!attribute [rw] status
|
1706
|
+
# The status for a call to update a scope. The status can be one of
|
1707
|
+
# the following: `SUCCEEDED`, `IN_PROGRESS`, or `FAILED`.
|
1708
|
+
# @return [String]
|
1709
|
+
#
|
1710
|
+
# @!attribute [rw] scope_arn
|
1711
|
+
# The Amazon Resource Name (ARN) of the scope.
|
1712
|
+
# @return [String]
|
1713
|
+
#
|
1714
|
+
# @!attribute [rw] tags
|
1715
|
+
# The tags for a scope.
|
1716
|
+
# @return [Hash<String,String>]
|
1717
|
+
#
|
1718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/UpdateScopeOutput AWS API Documentation
|
1719
|
+
#
|
1720
|
+
class UpdateScopeOutput < Struct.new(
|
1721
|
+
:scope_id,
|
1722
|
+
:status,
|
1723
|
+
:scope_arn,
|
1724
|
+
:tags)
|
1725
|
+
SENSITIVE = []
|
1726
|
+
include Aws::Structure
|
1727
|
+
end
|
1728
|
+
|
1729
|
+
# Invalid request.
|
1730
|
+
#
|
1731
|
+
# @!attribute [rw] message
|
1732
|
+
# @return [String]
|
1733
|
+
#
|
1734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ValidationException AWS API Documentation
|
1735
|
+
#
|
1736
|
+
class ValidationException < Struct.new(
|
1737
|
+
:message)
|
1738
|
+
SENSITIVE = []
|
1739
|
+
include Aws::Structure
|
1740
|
+
end
|
1741
|
+
|
1742
|
+
# A data point for a top contributor network flow in a scope. Network
|
1743
|
+
# Flow Monitor returns information about the network flows with the top
|
1744
|
+
# values for each metric type, which are called top contributors.
|
1745
|
+
#
|
1746
|
+
# @!attribute [rw] timestamps
|
1747
|
+
# An array of the timestamps for the data point.
|
1748
|
+
# @return [Array<Time>]
|
1749
|
+
#
|
1750
|
+
# @!attribute [rw] values
|
1751
|
+
# The values for the data point.
|
1752
|
+
# @return [Array<Float>]
|
1753
|
+
#
|
1754
|
+
# @!attribute [rw] label
|
1755
|
+
# The label identifying the data point.
|
1756
|
+
# @return [String]
|
1757
|
+
#
|
1758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/WorkloadInsightsTopContributorsDataPoint AWS API Documentation
|
1759
|
+
#
|
1760
|
+
class WorkloadInsightsTopContributorsDataPoint < Struct.new(
|
1761
|
+
:timestamps,
|
1762
|
+
:values,
|
1763
|
+
:label)
|
1764
|
+
SENSITIVE = []
|
1765
|
+
include Aws::Structure
|
1766
|
+
end
|
1767
|
+
|
1768
|
+
# A row for a top contributor for a scope.
|
1769
|
+
#
|
1770
|
+
# @!attribute [rw] account_id
|
1771
|
+
# The account ID for a specific row of data.
|
1772
|
+
# @return [String]
|
1773
|
+
#
|
1774
|
+
# @!attribute [rw] local_subnet_id
|
1775
|
+
# The subnet identifier for the local resource.
|
1776
|
+
# @return [String]
|
1777
|
+
#
|
1778
|
+
# @!attribute [rw] local_az
|
1779
|
+
# The identifier for the Availability Zone where the local resource is
|
1780
|
+
# located.
|
1781
|
+
# @return [String]
|
1782
|
+
#
|
1783
|
+
# @!attribute [rw] local_vpc_id
|
1784
|
+
# The identifier for the VPC for the local resource.
|
1785
|
+
# @return [String]
|
1786
|
+
#
|
1787
|
+
# @!attribute [rw] local_region
|
1788
|
+
# The Amazon Web Services Region where the local resource is located.
|
1789
|
+
# @return [String]
|
1790
|
+
#
|
1791
|
+
# @!attribute [rw] remote_identifier
|
1792
|
+
# The identifier of a remote resource.
|
1793
|
+
# @return [String]
|
1794
|
+
#
|
1795
|
+
# @!attribute [rw] value
|
1796
|
+
# The value for a metric.
|
1797
|
+
# @return [Integer]
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] local_subnet_arn
|
1800
|
+
# The Amazon Resource Name (ARN) of a local subnet.
|
1801
|
+
# @return [String]
|
1802
|
+
#
|
1803
|
+
# @!attribute [rw] local_vpc_arn
|
1804
|
+
# The Amazon Resource Name (ARN) of a local VPC.
|
1805
|
+
# @return [String]
|
1806
|
+
#
|
1807
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/WorkloadInsightsTopContributorsRow AWS API Documentation
|
1808
|
+
#
|
1809
|
+
class WorkloadInsightsTopContributorsRow < Struct.new(
|
1810
|
+
:account_id,
|
1811
|
+
:local_subnet_id,
|
1812
|
+
:local_az,
|
1813
|
+
:local_vpc_id,
|
1814
|
+
:local_region,
|
1815
|
+
:remote_identifier,
|
1816
|
+
:value,
|
1817
|
+
:local_subnet_arn,
|
1818
|
+
:local_vpc_arn)
|
1819
|
+
SENSITIVE = []
|
1820
|
+
include Aws::Structure
|
1821
|
+
end
|
1822
|
+
|
1823
|
+
end
|
1824
|
+
end
|
1825
|
+
|