aws-sdk-applicationdiscoveryservice 1.0.0.rc1 → 1.0.0.rc2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-applicationdiscoveryservice/client.rb +833 -465
- data/lib/aws-sdk-applicationdiscoveryservice/client_api.rb +563 -362
- data/lib/aws-sdk-applicationdiscoveryservice/errors.rb +4 -13
- data/lib/aws-sdk-applicationdiscoveryservice/resource.rb +12 -14
- data/lib/aws-sdk-applicationdiscoveryservice/types.rb +1104 -658
- data/lib/aws-sdk-applicationdiscoveryservice.rb +1 -1
- metadata +2 -2
@@ -1,668 +1,1114 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
module
|
10
|
-
module Types
|
11
|
-
|
12
|
-
# Information about agents that were instructed to start collecting
|
13
|
-
# data. Information includes the agent ID, a description of the
|
14
|
-
# operation, and whether or not the agent configuration was updated.
|
15
|
-
# @!attribute [rw] agent_id
|
16
|
-
# The agent ID.
|
17
|
-
# @return [String]
|
18
|
-
#
|
19
|
-
# @!attribute [rw] operation_succeeded
|
20
|
-
# Information about the status of the `StartDataCollection` and
|
21
|
-
# `StopDataCollection` operations. The system has recorded the data
|
22
|
-
# collection operation. The agent receives this command the next time
|
23
|
-
# it polls for a new command.
|
24
|
-
# @return [Boolean]
|
25
|
-
#
|
26
|
-
# @!attribute [rw] description
|
27
|
-
# A description of the operation performed.
|
28
|
-
# @return [String]
|
29
|
-
class AgentConfigurationStatus < Struct.new(
|
30
|
-
:agent_id,
|
31
|
-
:operation_succeeded,
|
32
|
-
:description)
|
33
|
-
include Aws::Structure
|
34
|
-
end
|
35
|
-
|
36
|
-
# Information about agents associated with the user’s AWS account.
|
37
|
-
# Information includes agent IDs, IP addresses, media access control
|
38
|
-
# (MAC) addresses, agent health, hostname where the agent resides, and
|
39
|
-
# agent version for each agent.
|
40
|
-
# @!attribute [rw] agent_id
|
41
|
-
# The agent ID.
|
42
|
-
# @return [String]
|
43
|
-
#
|
44
|
-
# @!attribute [rw] host_name
|
45
|
-
# The name of the host where the agent resides. The host can be a
|
46
|
-
# server or virtual machine.
|
47
|
-
# @return [String]
|
48
|
-
#
|
49
|
-
# @!attribute [rw] agent_network_info_list
|
50
|
-
# Network details about the host where the agent resides.
|
51
|
-
# @return [Array<Types::AgentNetworkInfo>]
|
52
|
-
#
|
53
|
-
# @!attribute [rw] connector_id
|
54
|
-
# This data type is currently not valid.
|
55
|
-
# @return [String]
|
56
|
-
#
|
57
|
-
# @!attribute [rw] version
|
58
|
-
# The agent version.
|
59
|
-
# @return [String]
|
60
|
-
#
|
61
|
-
# @!attribute [rw] health
|
62
|
-
# The health of the agent.
|
63
|
-
# @return [String]
|
64
|
-
class AgentInfo < Struct.new(
|
65
|
-
:agent_id,
|
66
|
-
:host_name,
|
67
|
-
:agent_network_info_list,
|
68
|
-
:connector_id,
|
69
|
-
:version,
|
70
|
-
:health)
|
71
|
-
include Aws::Structure
|
72
|
-
end
|
73
|
-
|
74
|
-
# Network details about the host where the agent resides.
|
75
|
-
# @!attribute [rw] ip_address
|
76
|
-
# The IP address for the host where the agent resides.
|
77
|
-
# @return [String]
|
78
|
-
#
|
79
|
-
# @!attribute [rw] mac_address
|
80
|
-
# The MAC address for the host where the agent resides.
|
81
|
-
# @return [String]
|
82
|
-
class AgentNetworkInfo < Struct.new(
|
83
|
-
:ip_address,
|
84
|
-
:mac_address)
|
85
|
-
include Aws::Structure
|
86
|
-
end
|
87
|
-
|
88
|
-
# Tags for a configuration item. Tags are metadata that help you
|
89
|
-
# categorize IT assets.
|
90
|
-
# @!attribute [rw] configuration_type
|
91
|
-
# A type of IT asset that you want to tag.
|
92
|
-
# @return [String]
|
93
|
-
#
|
94
|
-
# @!attribute [rw] configuration_id
|
95
|
-
# The configuration ID for the item you want to tag. You can specify a
|
96
|
-
# list of keys and values.
|
97
|
-
# @return [String]
|
98
|
-
#
|
99
|
-
# @!attribute [rw] key
|
100
|
-
# A type of tag to filter on. For example, *serverType*.
|
101
|
-
# @return [String]
|
102
|
-
#
|
103
|
-
# @!attribute [rw] value
|
104
|
-
# A value to filter on. For example *key = serverType* and *value =
|
105
|
-
# web server*.
|
106
|
-
# @return [String]
|
107
|
-
#
|
108
|
-
# @!attribute [rw] time_of_creation
|
109
|
-
# The time the configuration tag was created in Coordinated Universal
|
110
|
-
# Time (UTC).
|
111
|
-
# @return [Time]
|
112
|
-
class ConfigurationTag < Struct.new(
|
113
|
-
:configuration_type,
|
114
|
-
:configuration_id,
|
115
|
-
:key,
|
116
|
-
:value,
|
117
|
-
:time_of_creation)
|
118
|
-
include Aws::Structure
|
119
|
-
end
|
120
|
-
|
121
|
-
# @note When making an API call, pass CreateTagsRequest
|
122
|
-
# data as a hash:
|
123
|
-
#
|
124
|
-
# {
|
125
|
-
# configuration_ids: ["ConfigurationId"], # required
|
126
|
-
# tags: [ # required
|
127
|
-
# {
|
128
|
-
# key: "TagKey", # required
|
129
|
-
# value: "TagValue", # required
|
130
|
-
# },
|
131
|
-
# ],
|
132
|
-
# }
|
133
|
-
# @!attribute [rw] configuration_ids
|
134
|
-
# A list of configuration items that you want to tag.
|
135
|
-
# @return [Array<String>]
|
136
|
-
#
|
137
|
-
# @!attribute [rw] tags
|
138
|
-
# Tags that you want to associate with one or more configuration
|
139
|
-
# items. Specify the tags that you want to create in a *key*-*value*
|
140
|
-
# format. For example:
|
141
|
-
#
|
142
|
-
# `\{"key": "serverType", "value": "webServer"\}`
|
143
|
-
# @return [Array<Types::Tag>]
|
144
|
-
class CreateTagsRequest < Struct.new(
|
145
|
-
:configuration_ids,
|
146
|
-
:tags)
|
147
|
-
include Aws::Structure
|
148
|
-
end
|
149
|
-
|
150
|
-
class CreateTagsResponse < Aws::EmptyStructure; end
|
151
|
-
|
152
|
-
# @note When making an API call, pass DeleteTagsRequest
|
153
|
-
# data as a hash:
|
154
|
-
#
|
155
|
-
# {
|
156
|
-
# configuration_ids: ["ConfigurationId"], # required
|
157
|
-
# tags: [
|
158
|
-
# {
|
159
|
-
# key: "TagKey", # required
|
160
|
-
# value: "TagValue", # required
|
161
|
-
# },
|
162
|
-
# ],
|
163
|
-
# }
|
164
|
-
# @!attribute [rw] configuration_ids
|
165
|
-
# A list of configuration items with tags that you want to delete.
|
166
|
-
# @return [Array<String>]
|
167
|
-
#
|
168
|
-
# @!attribute [rw] tags
|
169
|
-
# Tags that you want to delete from one or more configuration items.
|
170
|
-
# Specify the tags that you want to delete in a *key*-*value* format.
|
171
|
-
# For example:
|
172
|
-
#
|
173
|
-
# `\{"key": "serverType", "value": "webServer"\}`
|
174
|
-
# @return [Array<Types::Tag>]
|
175
|
-
class DeleteTagsRequest < Struct.new(
|
176
|
-
:configuration_ids,
|
177
|
-
:tags)
|
178
|
-
include Aws::Structure
|
179
|
-
end
|
180
|
-
|
181
|
-
class DeleteTagsResponse < Aws::EmptyStructure; end
|
182
|
-
|
183
|
-
# @note When making an API call, pass DescribeAgentsRequest
|
184
|
-
# data as a hash:
|
185
|
-
#
|
186
|
-
# {
|
187
|
-
# agent_ids: ["AgentId"],
|
188
|
-
# max_results: 1,
|
189
|
-
# next_token: "NextToken",
|
190
|
-
# }
|
191
|
-
# @!attribute [rw] agent_ids
|
192
|
-
# The agent IDs for which you want information. If you specify no IDs,
|
193
|
-
# the system returns information about all agents associated with your
|
194
|
-
# AWS user account.
|
195
|
-
# @return [Array<String>]
|
196
|
-
#
|
197
|
-
# @!attribute [rw] max_results
|
198
|
-
# The total number of agents to return. The maximum value is 100.
|
199
|
-
# @return [Integer]
|
200
|
-
#
|
201
|
-
# @!attribute [rw] next_token
|
202
|
-
# A token to start the list. Use this token to get the next set of
|
203
|
-
# results.
|
204
|
-
# @return [String]
|
205
|
-
class DescribeAgentsRequest < Struct.new(
|
206
|
-
:agent_ids,
|
207
|
-
:max_results,
|
208
|
-
:next_token)
|
209
|
-
include Aws::Structure
|
210
|
-
end
|
211
|
-
|
212
|
-
# @!attribute [rw] agents_info
|
213
|
-
# Lists AWS agents by ID or lists all agents associated with your user
|
214
|
-
# account if you did not specify an agent ID. The output includes
|
215
|
-
# agent IDs, IP addresses, media access control (MAC) addresses, agent
|
216
|
-
# health, host name where the agent resides, and the version number of
|
217
|
-
# each agent.
|
218
|
-
# @return [Array<Types::AgentInfo>]
|
219
|
-
#
|
220
|
-
# @!attribute [rw] next_token
|
221
|
-
# The call returns a token. Use this token to get the next set of
|
222
|
-
# results.
|
223
|
-
# @return [String]
|
224
|
-
class DescribeAgentsResponse < Struct.new(
|
225
|
-
:agents_info,
|
226
|
-
:next_token)
|
227
|
-
include Aws::Structure
|
228
|
-
end
|
229
|
-
|
230
|
-
# @note When making an API call, pass DescribeConfigurationsRequest
|
231
|
-
# data as a hash:
|
232
|
-
#
|
233
|
-
# {
|
234
|
-
# configuration_ids: ["ConfigurationId"], # required
|
235
|
-
# }
|
236
|
-
# @!attribute [rw] configuration_ids
|
237
|
-
# One or more configuration IDs.
|
238
|
-
# @return [Array<String>]
|
239
|
-
class DescribeConfigurationsRequest < Struct.new(
|
240
|
-
:configuration_ids)
|
241
|
-
include Aws::Structure
|
242
|
-
end
|
243
|
-
|
244
|
-
# @!attribute [rw] configurations
|
245
|
-
# A key in the response map. The value is an array of data.
|
246
|
-
# @return [Array<Hash<String,String>>]
|
247
|
-
class DescribeConfigurationsResponse < Struct.new(
|
248
|
-
:configurations)
|
249
|
-
include Aws::Structure
|
250
|
-
end
|
251
|
-
|
252
|
-
# @note When making an API call, pass DescribeExportConfigurationsRequest
|
253
|
-
# data as a hash:
|
254
|
-
#
|
255
|
-
# {
|
256
|
-
# export_ids: ["ConfigurationsExportId"],
|
257
|
-
# max_results: 1,
|
258
|
-
# next_token: "NextToken",
|
259
|
-
# }
|
260
|
-
# @!attribute [rw] export_ids
|
261
|
-
# A unique identifier that you can use to query the export status.
|
262
|
-
# @return [Array<String>]
|
263
|
-
#
|
264
|
-
# @!attribute [rw] max_results
|
265
|
-
# The maximum number of results that you want to display as a part of
|
266
|
-
# the query.
|
267
|
-
# @return [Integer]
|
268
|
-
#
|
269
|
-
# @!attribute [rw] next_token
|
270
|
-
# A token to get the next set of results. For example, if you
|
271
|
-
# specified 100 IDs for
|
272
|
-
# `DescribeConfigurationsRequest$configurationIds` but set
|
273
|
-
# `DescribeExportConfigurationsRequest$maxResults` to 10, you will get
|
274
|
-
# results in a set of 10. Use the token in the query to get the next
|
275
|
-
# set of 10.
|
276
|
-
# @return [String]
|
277
|
-
class DescribeExportConfigurationsRequest < Struct.new(
|
278
|
-
:export_ids,
|
279
|
-
:max_results,
|
280
|
-
:next_token)
|
281
|
-
include Aws::Structure
|
282
|
-
end
|
283
|
-
|
284
|
-
# @!attribute [rw] exports_info
|
285
|
-
# Returns export details. When the status is complete, the response
|
286
|
-
# includes a URL for an Amazon S3 bucket where you can view the data
|
287
|
-
# in a CSV file.
|
288
|
-
# @return [Array<Types::ExportInfo>]
|
289
|
-
#
|
290
|
-
# @!attribute [rw] next_token
|
291
|
-
# A token to get the next set of results. For example, if you
|
292
|
-
# specified 100 IDs for
|
293
|
-
# `DescribeConfigurationsRequest$configurationIds` but set
|
294
|
-
# `DescribeExportConfigurationsRequest$maxResults` to 10, you will get
|
295
|
-
# results in a set of 10. Use the token in the query to get the next
|
296
|
-
# set of 10.
|
297
|
-
# @return [String]
|
298
|
-
class DescribeExportConfigurationsResponse < Struct.new(
|
299
|
-
:exports_info,
|
300
|
-
:next_token)
|
301
|
-
include Aws::Structure
|
302
|
-
end
|
303
|
-
|
304
|
-
# @note When making an API call, pass DescribeTagsRequest
|
305
|
-
# data as a hash:
|
306
|
-
#
|
307
|
-
# {
|
308
|
-
# filters: [
|
309
|
-
# {
|
310
|
-
# name: "FilterName", # required
|
311
|
-
# values: ["FilterValue"], # required
|
312
|
-
# },
|
313
|
-
# ],
|
314
|
-
# max_results: 1,
|
315
|
-
# next_token: "NextToken",
|
316
|
-
# }
|
317
|
-
# @!attribute [rw] filters
|
318
|
-
# You can filter the list using a *key*-*value* format. You can
|
319
|
-
# separate these items by using logical operators. Allowed filters
|
320
|
-
# include `tagKey`, `tagValue`, and `configurationId`.
|
321
|
-
# @return [Array<Types::TagFilter>]
|
322
|
-
#
|
323
|
-
# @!attribute [rw] max_results
|
324
|
-
# The total number of items to return. The maximum value is 100.
|
325
|
-
# @return [Integer]
|
326
|
-
#
|
327
|
-
# @!attribute [rw] next_token
|
328
|
-
# A token to start the list. Use this token to get the next set of
|
329
|
-
# results.
|
330
|
-
# @return [String]
|
331
|
-
class DescribeTagsRequest < Struct.new(
|
332
|
-
:filters,
|
333
|
-
:max_results,
|
334
|
-
:next_token)
|
335
|
-
include Aws::Structure
|
336
|
-
end
|
337
|
-
|
338
|
-
# @!attribute [rw] tags
|
339
|
-
# Depending on the input, this is a list of configuration items tagged
|
340
|
-
# with a specific tag, or a list of tags for a specific configuration
|
341
|
-
# item.
|
342
|
-
# @return [Array<Types::ConfigurationTag>]
|
343
|
-
#
|
344
|
-
# @!attribute [rw] next_token
|
345
|
-
# The call returns a token. Use this token to get the next set of
|
346
|
-
# results.
|
347
|
-
# @return [String]
|
348
|
-
class DescribeTagsResponse < Struct.new(
|
349
|
-
:tags,
|
350
|
-
:next_token)
|
351
|
-
include Aws::Structure
|
352
|
-
end
|
353
|
-
|
354
|
-
# @!attribute [rw] export_id
|
355
|
-
# A unique identifier that you can use to query the export status.
|
356
|
-
# @return [String]
|
357
|
-
class ExportConfigurationsResponse < Struct.new(
|
358
|
-
:export_id)
|
359
|
-
include Aws::Structure
|
360
|
-
end
|
361
|
-
|
362
|
-
# Information regarding the export status of the discovered data. The
|
363
|
-
# value is an array of objects.
|
364
|
-
# @!attribute [rw] export_id
|
365
|
-
# A unique identifier that you can use to query the export.
|
366
|
-
# @return [String]
|
367
|
-
#
|
368
|
-
# @!attribute [rw] export_status
|
369
|
-
# The status of the configuration data export. The status can succeed,
|
370
|
-
# fail, or be in-progress.
|
371
|
-
# @return [String]
|
372
|
-
#
|
373
|
-
# @!attribute [rw] status_message
|
374
|
-
# Helpful status messages for API callers. For example: Too many
|
375
|
-
# exports in the last 6 hours. Export in progress. Export was
|
376
|
-
# successful.
|
377
|
-
# @return [String]
|
378
|
-
#
|
379
|
-
# @!attribute [rw] configurations_download_url
|
380
|
-
# A URL for an Amazon S3 bucket where you can review the configuration
|
381
|
-
# data. The URL is displayed only if the export succeeded.
|
382
|
-
# @return [String]
|
383
|
-
#
|
384
|
-
# @!attribute [rw] export_request_time
|
385
|
-
# The time the configuration data export was initiated.
|
386
|
-
# @return [Time]
|
387
|
-
class ExportInfo < Struct.new(
|
388
|
-
:export_id,
|
389
|
-
:export_status,
|
390
|
-
:status_message,
|
391
|
-
:configurations_download_url,
|
392
|
-
:export_request_time)
|
393
|
-
include Aws::Structure
|
394
|
-
end
|
395
|
-
|
396
|
-
# A filter that can use conditional operators.
|
397
|
-
# @note When making an API call, pass Filter
|
398
|
-
# data as a hash:
|
399
|
-
#
|
400
|
-
# {
|
401
|
-
# name: "String", # required
|
402
|
-
# values: ["FilterValue"], # required
|
403
|
-
# condition: "Condition", # required
|
404
|
-
# }
|
405
|
-
# @!attribute [rw] name
|
406
|
-
# The name of the filter. The following filter names are allowed for
|
407
|
-
# `SERVER` configuration items.
|
408
|
-
#
|
409
|
-
# **Server**
|
410
|
-
#
|
411
|
-
# * `server.hostName`
|
412
|
-
#
|
413
|
-
# * `server.osName`
|
414
|
-
#
|
415
|
-
# * `server.osVersion`
|
416
|
-
#
|
417
|
-
# * `server.configurationid`
|
418
|
-
#
|
419
|
-
# * `server.agentid`
|
420
|
-
#
|
421
|
-
# The name of the filter. The following filter names are allowed for
|
422
|
-
# `PROCESS` configuration items.
|
423
|
-
#
|
424
|
-
# **Process**
|
425
|
-
#
|
426
|
-
# * `process.configurationid`
|
427
|
-
#
|
428
|
-
# * `process.name`
|
429
|
-
#
|
430
|
-
# * `process.commandLine`
|
431
|
-
#
|
432
|
-
# * `server.configurationid`
|
433
|
-
#
|
434
|
-
# * `server.hostName`
|
435
|
-
#
|
436
|
-
# * `server.osName`
|
437
|
-
#
|
438
|
-
# * `server.osVersion`
|
439
|
-
#
|
440
|
-
# * `server.agentId`
|
441
|
-
#
|
442
|
-
# The name of the filter. The following filter names are allowed for
|
443
|
-
# `CONNECTION` configuration items.
|
444
|
-
#
|
445
|
-
# **Connection**
|
446
|
-
#
|
447
|
-
# * `connection.sourceIp`
|
448
|
-
#
|
449
|
-
# * `connection.destinationIp`
|
450
|
-
#
|
451
|
-
# * `connection.destinationPort`
|
452
|
-
#
|
453
|
-
# * `sourceProcess.configurationId`
|
454
|
-
#
|
455
|
-
# * `sourceProcess.name`
|
456
|
-
#
|
457
|
-
# * `sourceProcess.commandLine`
|
458
|
-
#
|
459
|
-
# * `destinationProcess.configurationId`
|
460
|
-
#
|
461
|
-
# * `destinationProcess.name`
|
462
|
-
#
|
463
|
-
# * `destinationProcess.commandLine`
|
464
|
-
#
|
465
|
-
# * `sourceServer.configurationId`
|
466
|
-
#
|
467
|
-
# * `sourceServer.hostName`
|
468
|
-
#
|
469
|
-
# * `sourceServer.osName`
|
470
|
-
#
|
471
|
-
# * `sourceServer.osVersion`
|
472
|
-
#
|
473
|
-
# * `sourceServer.agentId`
|
474
|
-
#
|
475
|
-
# * `destinationServer.configurationId`
|
476
|
-
#
|
477
|
-
# * `destinationServer.hostName`
|
478
|
-
#
|
479
|
-
# * `destinationServer.osName`
|
480
|
-
#
|
481
|
-
# * `destinationServer.osVersion`
|
482
|
-
#
|
483
|
-
# * `destinationServer.agentId`
|
484
|
-
# @return [String]
|
485
|
-
#
|
486
|
-
# @!attribute [rw] values
|
487
|
-
# A string value that you want to filter on. For example, if you
|
488
|
-
# choose the `destinationServer.osVersion` filter name, you could
|
489
|
-
# specify `Ubuntu` for the value.
|
490
|
-
# @return [Array<String>]
|
491
|
-
#
|
492
|
-
# @!attribute [rw] condition
|
493
|
-
# A conditional operator. The following operators are valid: EQUALS,
|
494
|
-
# NOT\_EQUALS, CONTAINS, NOT\_CONTAINS. If you specify multiple
|
495
|
-
# filters, the system utilizes all filters as though concatenated by
|
496
|
-
# *AND*. If you specify multiple values for a particular filter, the
|
497
|
-
# system differentiates the values using *OR*. Calling either
|
498
|
-
# *DescribeConfigurations* or *ListConfigurations* returns attributes
|
499
|
-
# of matching configuration items.
|
500
|
-
# @return [String]
|
501
|
-
class Filter < Struct.new(
|
502
|
-
:name,
|
503
|
-
:values,
|
504
|
-
:condition)
|
505
|
-
include Aws::Structure
|
506
|
-
end
|
507
|
-
|
508
|
-
# @note When making an API call, pass ListConfigurationsRequest
|
509
|
-
# data as a hash:
|
510
|
-
#
|
511
|
-
# {
|
512
|
-
# configuration_type: "SERVER", # required, accepts SERVER, PROCESS, CONNECTION
|
513
|
-
# filters: [
|
514
|
-
# {
|
515
|
-
# name: "String", # required
|
516
|
-
# values: ["FilterValue"], # required
|
517
|
-
# condition: "Condition", # required
|
518
|
-
# },
|
519
|
-
# ],
|
520
|
-
# max_results: 1,
|
521
|
-
# next_token: "NextToken",
|
522
|
-
# }
|
523
|
-
# @!attribute [rw] configuration_type
|
524
|
-
# A valid configuration identified by the Discovery Service.
|
525
|
-
# @return [String]
|
526
|
-
#
|
527
|
-
# @!attribute [rw] filters
|
528
|
-
# You can filter the list using a *key*-*value* format. For example:
|
529
|
-
#
|
530
|
-
# `\{"key": "serverType", "value": "webServer"\}`
|
531
|
-
#
|
532
|
-
# You can separate these items by using logical operators.
|
533
|
-
# @return [Array<Types::Filter>]
|
534
|
-
#
|
535
|
-
# @!attribute [rw] max_results
|
536
|
-
# The total number of items to return. The maximum value is 100.
|
537
|
-
# @return [Integer]
|
538
|
-
#
|
539
|
-
# @!attribute [rw] next_token
|
540
|
-
# A token to start the list. Use this token to get the next set of
|
541
|
-
# results.
|
542
|
-
# @return [String]
|
543
|
-
class ListConfigurationsRequest < Struct.new(
|
544
|
-
:configuration_type,
|
545
|
-
:filters,
|
546
|
-
:max_results,
|
547
|
-
:next_token)
|
548
|
-
include Aws::Structure
|
549
|
-
end
|
550
|
-
|
551
|
-
# @!attribute [rw] configurations
|
552
|
-
# Returns configuration details, including the configuration ID,
|
553
|
-
# attribute names, and attribute values.
|
554
|
-
# @return [Array<Hash<String,String>>]
|
555
|
-
#
|
556
|
-
# @!attribute [rw] next_token
|
557
|
-
# The call returns a token. Use this token to get the next set of
|
558
|
-
# results.
|
559
|
-
# @return [String]
|
560
|
-
class ListConfigurationsResponse < Struct.new(
|
561
|
-
:configurations,
|
562
|
-
:next_token)
|
563
|
-
include Aws::Structure
|
564
|
-
end
|
565
|
-
|
566
|
-
# @note When making an API call, pass StartDataCollectionByAgentIdsRequest
|
567
|
-
# data as a hash:
|
568
|
-
#
|
569
|
-
# {
|
570
|
-
# agent_ids: ["AgentId"], # required
|
571
|
-
# }
|
572
|
-
# @!attribute [rw] agent_ids
|
573
|
-
# The IDs of the agents that you want to start collecting data. If you
|
574
|
-
# send a request to an AWS agent ID that you do not have permission to
|
575
|
-
# contact, according to your AWS account, the service does not throw
|
576
|
-
# an exception. Instead, it returns the error in the *Description*
|
577
|
-
# field. If you send a request to multiple agents and you do not have
|
578
|
-
# permission to contact some of those agents, the system does not
|
579
|
-
# throw an exception. Instead, the system shows `Failed` in the
|
580
|
-
# *Description* field.
|
581
|
-
# @return [Array<String>]
|
582
|
-
class StartDataCollectionByAgentIdsRequest < Struct.new(
|
583
|
-
:agent_ids)
|
584
|
-
include Aws::Structure
|
585
|
-
end
|
586
|
-
|
587
|
-
# @!attribute [rw] agents_configuration_status
|
588
|
-
# Information about agents that were instructed to start collecting
|
589
|
-
# data. Information includes the agent ID, a description of the
|
590
|
-
# operation performed, and whether or not the agent configuration was
|
591
|
-
# updated.
|
592
|
-
# @return [Array<Types::AgentConfigurationStatus>]
|
593
|
-
class StartDataCollectionByAgentIdsResponse < Struct.new(
|
594
|
-
:agents_configuration_status)
|
595
|
-
include Aws::Structure
|
596
|
-
end
|
597
|
-
|
598
|
-
# @note When making an API call, pass StopDataCollectionByAgentIdsRequest
|
599
|
-
# data as a hash:
|
600
|
-
#
|
601
|
-
# {
|
602
|
-
# agent_ids: ["AgentId"], # required
|
603
|
-
# }
|
604
|
-
# @!attribute [rw] agent_ids
|
605
|
-
# The IDs of the agents that you want to stop collecting data.
|
606
|
-
# @return [Array<String>]
|
607
|
-
class StopDataCollectionByAgentIdsRequest < Struct.new(
|
608
|
-
:agent_ids)
|
609
|
-
include Aws::Structure
|
610
|
-
end
|
611
|
-
|
612
|
-
# @!attribute [rw] agents_configuration_status
|
613
|
-
# Information about agents that were instructed to stop collecting
|
614
|
-
# data. Information includes the agent ID, a description of the
|
615
|
-
# operation performed, and whether or not the agent configuration was
|
616
|
-
# updated.
|
617
|
-
# @return [Array<Types::AgentConfigurationStatus>]
|
618
|
-
class StopDataCollectionByAgentIdsResponse < Struct.new(
|
619
|
-
:agents_configuration_status)
|
620
|
-
include Aws::Structure
|
621
|
-
end
|
622
|
-
|
623
|
-
# Metadata that help you categorize IT assets.
|
624
|
-
# @note When making an API call, pass Tag
|
625
|
-
# data as a hash:
|
626
|
-
#
|
627
|
-
# {
|
628
|
-
# key: "TagKey", # required
|
629
|
-
# value: "TagValue", # required
|
630
|
-
# }
|
631
|
-
# @!attribute [rw] key
|
632
|
-
# A type of tag to filter on.
|
633
|
-
# @return [String]
|
634
|
-
#
|
635
|
-
# @!attribute [rw] value
|
636
|
-
# A value for a tag key to filter on.
|
637
|
-
# @return [String]
|
638
|
-
class Tag < Struct.new(
|
639
|
-
:key,
|
640
|
-
:value)
|
641
|
-
include Aws::Structure
|
642
|
-
end
|
643
|
-
|
644
|
-
# The name of a tag filter. Valid names are: `tagKey`, `tagValue`,
|
645
|
-
# `configurationId`.
|
646
|
-
# @note When making an API call, pass TagFilter
|
647
|
-
# data as a hash:
|
648
|
-
#
|
649
|
-
# {
|
650
|
-
# name: "FilterName", # required
|
651
|
-
# values: ["FilterValue"], # required
|
652
|
-
# }
|
653
|
-
# @!attribute [rw] name
|
654
|
-
# A name of a tag filter.
|
655
|
-
# @return [String]
|
656
|
-
#
|
657
|
-
# @!attribute [rw] values
|
658
|
-
# Values of a tag filter.
|
659
|
-
# @return [Array<String>]
|
660
|
-
class TagFilter < Struct.new(
|
661
|
-
:name,
|
662
|
-
:values)
|
663
|
-
include Aws::Structure
|
664
|
-
end
|
8
|
+
module Aws::ApplicationDiscoveryService
|
9
|
+
module Types
|
665
10
|
|
11
|
+
# Information about agents or Connectors that were instructed to start
|
12
|
+
# collecting data. Information includes the agent/Connector ID, a
|
13
|
+
# description of the operation, and whether or not the agent/Connector
|
14
|
+
# configuration was updated.
|
15
|
+
#
|
16
|
+
# @!attribute [rw] agent_id
|
17
|
+
# The agent/Connector ID.
|
18
|
+
# @return [String]
|
19
|
+
#
|
20
|
+
# @!attribute [rw] operation_succeeded
|
21
|
+
# Information about the status of the `StartDataCollection` and
|
22
|
+
# `StopDataCollection` operations. The system has recorded the data
|
23
|
+
# collection operation. The agent/Connector receives this command the
|
24
|
+
# next time it polls for a new command.
|
25
|
+
# @return [Boolean]
|
26
|
+
#
|
27
|
+
# @!attribute [rw] description
|
28
|
+
# A description of the operation performed.
|
29
|
+
# @return [String]
|
30
|
+
#
|
31
|
+
class AgentConfigurationStatus < Struct.new(
|
32
|
+
:agent_id,
|
33
|
+
:operation_succeeded,
|
34
|
+
:description)
|
35
|
+
include Aws::Structure
|
666
36
|
end
|
37
|
+
|
38
|
+
# Information about agents or connectors associated with the user’s AWS
|
39
|
+
# account. Information includes agent or connector IDs, IP addresses,
|
40
|
+
# media access control (MAC) addresses, agent or connector health,
|
41
|
+
# hostname where the agent or connector resides, and agent version for
|
42
|
+
# each agent.
|
43
|
+
#
|
44
|
+
# @!attribute [rw] agent_id
|
45
|
+
# The agent or connector ID.
|
46
|
+
# @return [String]
|
47
|
+
#
|
48
|
+
# @!attribute [rw] host_name
|
49
|
+
# The name of the host where the agent or connector resides. The host
|
50
|
+
# can be a server or virtual machine.
|
51
|
+
# @return [String]
|
52
|
+
#
|
53
|
+
# @!attribute [rw] agent_network_info_list
|
54
|
+
# Network details about the host where the agent or connector resides.
|
55
|
+
# @return [Array<Types::AgentNetworkInfo>]
|
56
|
+
#
|
57
|
+
# @!attribute [rw] connector_id
|
58
|
+
# The ID of the connector.
|
59
|
+
# @return [String]
|
60
|
+
#
|
61
|
+
# @!attribute [rw] version
|
62
|
+
# The agent or connector version.
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] health
|
66
|
+
# The health of the agent or connector.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
# @!attribute [rw] last_health_ping_time
|
70
|
+
# Time since agent or connector health was reported.
|
71
|
+
# @return [String]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] collection_status
|
74
|
+
# Status of the collection process for an agent or connector.
|
75
|
+
# @return [String]
|
76
|
+
#
|
77
|
+
# @!attribute [rw] agent_type
|
78
|
+
# Type of agent.
|
79
|
+
# @return [String]
|
80
|
+
#
|
81
|
+
# @!attribute [rw] registered_time
|
82
|
+
# Agent's first registration time stamp in UTC.
|
83
|
+
# @return [String]
|
84
|
+
#
|
85
|
+
class AgentInfo < Struct.new(
|
86
|
+
:agent_id,
|
87
|
+
:host_name,
|
88
|
+
:agent_network_info_list,
|
89
|
+
:connector_id,
|
90
|
+
:version,
|
91
|
+
:health,
|
92
|
+
:last_health_ping_time,
|
93
|
+
:collection_status,
|
94
|
+
:agent_type,
|
95
|
+
:registered_time)
|
96
|
+
include Aws::Structure
|
97
|
+
end
|
98
|
+
|
99
|
+
# Network details about the host where the agent/Connector resides.
|
100
|
+
#
|
101
|
+
# @!attribute [rw] ip_address
|
102
|
+
# The IP address for the host where the agent/Connector resides.
|
103
|
+
# @return [String]
|
104
|
+
#
|
105
|
+
# @!attribute [rw] mac_address
|
106
|
+
# The MAC address for the host where the agent/Connector resides.
|
107
|
+
# @return [String]
|
108
|
+
#
|
109
|
+
class AgentNetworkInfo < Struct.new(
|
110
|
+
:ip_address,
|
111
|
+
:mac_address)
|
112
|
+
include Aws::Structure
|
113
|
+
end
|
114
|
+
|
115
|
+
# @note When making an API call, you may pass AssociateConfigurationItemsToApplicationRequest
|
116
|
+
# data as a hash:
|
117
|
+
#
|
118
|
+
# {
|
119
|
+
# application_configuration_id: "ApplicationId", # required
|
120
|
+
# configuration_ids: ["ConfigurationId"], # required
|
121
|
+
# }
|
122
|
+
#
|
123
|
+
# @!attribute [rw] application_configuration_id
|
124
|
+
# The configuration ID of an application with which items are to be
|
125
|
+
# associated.
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] configuration_ids
|
129
|
+
# The ID of each configuration item to be associated with an
|
130
|
+
# application.
|
131
|
+
# @return [Array<String>]
|
132
|
+
#
|
133
|
+
class AssociateConfigurationItemsToApplicationRequest < Struct.new(
|
134
|
+
:application_configuration_id,
|
135
|
+
:configuration_ids)
|
136
|
+
include Aws::Structure
|
137
|
+
end
|
138
|
+
|
139
|
+
class AssociateConfigurationItemsToApplicationResponse < Aws::EmptyStructure; end
|
140
|
+
|
141
|
+
# Tags for a configuration item. Tags are metadata that help you
|
142
|
+
# categorize IT assets.
|
143
|
+
#
|
144
|
+
# @!attribute [rw] configuration_type
|
145
|
+
# A type of IT asset that you want to tag.
|
146
|
+
# @return [String]
|
147
|
+
#
|
148
|
+
# @!attribute [rw] configuration_id
|
149
|
+
# The configuration ID for the item you want to tag. You can specify a
|
150
|
+
# list of keys and values.
|
151
|
+
# @return [String]
|
152
|
+
#
|
153
|
+
# @!attribute [rw] key
|
154
|
+
# A type of tag to filter on. For example, *serverType*.
|
155
|
+
# @return [String]
|
156
|
+
#
|
157
|
+
# @!attribute [rw] value
|
158
|
+
# A value to filter on. For example *key = serverType* and *value =
|
159
|
+
# web server*.
|
160
|
+
# @return [String]
|
161
|
+
#
|
162
|
+
# @!attribute [rw] time_of_creation
|
163
|
+
# The time the configuration tag was created in Coordinated Universal
|
164
|
+
# Time (UTC).
|
165
|
+
# @return [Time]
|
166
|
+
#
|
167
|
+
class ConfigurationTag < Struct.new(
|
168
|
+
:configuration_type,
|
169
|
+
:configuration_id,
|
170
|
+
:key,
|
171
|
+
:value,
|
172
|
+
:time_of_creation)
|
173
|
+
include Aws::Structure
|
174
|
+
end
|
175
|
+
|
176
|
+
# @note When making an API call, you may pass CreateApplicationRequest
|
177
|
+
# data as a hash:
|
178
|
+
#
|
179
|
+
# {
|
180
|
+
# name: "String", # required
|
181
|
+
# description: "String",
|
182
|
+
# }
|
183
|
+
#
|
184
|
+
# @!attribute [rw] name
|
185
|
+
# Name of the application to be created.
|
186
|
+
# @return [String]
|
187
|
+
#
|
188
|
+
# @!attribute [rw] description
|
189
|
+
# Description of the application to be created.
|
190
|
+
# @return [String]
|
191
|
+
#
|
192
|
+
class CreateApplicationRequest < Struct.new(
|
193
|
+
:name,
|
194
|
+
:description)
|
195
|
+
include Aws::Structure
|
196
|
+
end
|
197
|
+
|
198
|
+
# @!attribute [rw] configuration_id
|
199
|
+
# Configuration ID of an application to be created.
|
200
|
+
# @return [String]
|
201
|
+
#
|
202
|
+
class CreateApplicationResponse < Struct.new(
|
203
|
+
:configuration_id)
|
204
|
+
include Aws::Structure
|
205
|
+
end
|
206
|
+
|
207
|
+
# @note When making an API call, you may pass CreateTagsRequest
|
208
|
+
# data as a hash:
|
209
|
+
#
|
210
|
+
# {
|
211
|
+
# configuration_ids: ["ConfigurationId"], # required
|
212
|
+
# tags: [ # required
|
213
|
+
# {
|
214
|
+
# key: "TagKey", # required
|
215
|
+
# value: "TagValue", # required
|
216
|
+
# },
|
217
|
+
# ],
|
218
|
+
# }
|
219
|
+
#
|
220
|
+
# @!attribute [rw] configuration_ids
|
221
|
+
# A list of configuration items that you want to tag.
|
222
|
+
# @return [Array<String>]
|
223
|
+
#
|
224
|
+
# @!attribute [rw] tags
|
225
|
+
# Tags that you want to associate with one or more configuration
|
226
|
+
# items. Specify the tags that you want to create in a *key*-*value*
|
227
|
+
# format. For example:
|
228
|
+
#
|
229
|
+
# `\{"key": "serverType", "value": "webServer"\}`
|
230
|
+
# @return [Array<Types::Tag>]
|
231
|
+
#
|
232
|
+
class CreateTagsRequest < Struct.new(
|
233
|
+
:configuration_ids,
|
234
|
+
:tags)
|
235
|
+
include Aws::Structure
|
236
|
+
end
|
237
|
+
|
238
|
+
class CreateTagsResponse < Aws::EmptyStructure; end
|
239
|
+
|
240
|
+
# Inventory data for installed discovery agents.
|
241
|
+
#
|
242
|
+
# @!attribute [rw] active_agents
|
243
|
+
# Number of active discovery agents.
|
244
|
+
# @return [Integer]
|
245
|
+
#
|
246
|
+
# @!attribute [rw] healthy_agents
|
247
|
+
# Number of healthy discovery agents
|
248
|
+
# @return [Integer]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] black_listed_agents
|
251
|
+
# Number of blacklisted discovery agents.
|
252
|
+
# @return [Integer]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] shutdown_agents
|
255
|
+
# Number of discovery agents with status SHUTDOWN.
|
256
|
+
# @return [Integer]
|
257
|
+
#
|
258
|
+
# @!attribute [rw] unhealthy_agents
|
259
|
+
# Number of unhealthy discovery agents.
|
260
|
+
# @return [Integer]
|
261
|
+
#
|
262
|
+
# @!attribute [rw] total_agents
|
263
|
+
# Total number of discovery agents.
|
264
|
+
# @return [Integer]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] unknown_agents
|
267
|
+
# Number of unknown discovery agents.
|
268
|
+
# @return [Integer]
|
269
|
+
#
|
270
|
+
class CustomerAgentInfo < Struct.new(
|
271
|
+
:active_agents,
|
272
|
+
:healthy_agents,
|
273
|
+
:black_listed_agents,
|
274
|
+
:shutdown_agents,
|
275
|
+
:unhealthy_agents,
|
276
|
+
:total_agents,
|
277
|
+
:unknown_agents)
|
278
|
+
include Aws::Structure
|
279
|
+
end
|
280
|
+
|
281
|
+
# Inventory data for installed discovery connectors.
|
282
|
+
#
|
283
|
+
# @!attribute [rw] active_connectors
|
284
|
+
# Number of active discovery connectors.
|
285
|
+
# @return [Integer]
|
286
|
+
#
|
287
|
+
# @!attribute [rw] healthy_connectors
|
288
|
+
# Number of healthy discovery connectors.
|
289
|
+
# @return [Integer]
|
290
|
+
#
|
291
|
+
# @!attribute [rw] black_listed_connectors
|
292
|
+
# Number of blacklisted discovery connectors.
|
293
|
+
# @return [Integer]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] shutdown_connectors
|
296
|
+
# Number of discovery connectors with status SHUTDOWN,
|
297
|
+
# @return [Integer]
|
298
|
+
#
|
299
|
+
# @!attribute [rw] unhealthy_connectors
|
300
|
+
# Number of unhealthy discovery connectors.
|
301
|
+
# @return [Integer]
|
302
|
+
#
|
303
|
+
# @!attribute [rw] total_connectors
|
304
|
+
# Total number of discovery connectors.
|
305
|
+
# @return [Integer]
|
306
|
+
#
|
307
|
+
# @!attribute [rw] unknown_connectors
|
308
|
+
# Number of unknown discovery connectors.
|
309
|
+
# @return [Integer]
|
310
|
+
#
|
311
|
+
class CustomerConnectorInfo < Struct.new(
|
312
|
+
:active_connectors,
|
313
|
+
:healthy_connectors,
|
314
|
+
:black_listed_connectors,
|
315
|
+
:shutdown_connectors,
|
316
|
+
:unhealthy_connectors,
|
317
|
+
:total_connectors,
|
318
|
+
:unknown_connectors)
|
319
|
+
include Aws::Structure
|
320
|
+
end
|
321
|
+
|
322
|
+
# @note When making an API call, you may pass DeleteApplicationsRequest
|
323
|
+
# data as a hash:
|
324
|
+
#
|
325
|
+
# {
|
326
|
+
# configuration_ids: ["ApplicationId"], # required
|
327
|
+
# }
|
328
|
+
#
|
329
|
+
# @!attribute [rw] configuration_ids
|
330
|
+
# Configuration ID of an application to be deleted.
|
331
|
+
# @return [Array<String>]
|
332
|
+
#
|
333
|
+
class DeleteApplicationsRequest < Struct.new(
|
334
|
+
:configuration_ids)
|
335
|
+
include Aws::Structure
|
336
|
+
end
|
337
|
+
|
338
|
+
class DeleteApplicationsResponse < Aws::EmptyStructure; end
|
339
|
+
|
340
|
+
# @note When making an API call, you may pass DeleteTagsRequest
|
341
|
+
# data as a hash:
|
342
|
+
#
|
343
|
+
# {
|
344
|
+
# configuration_ids: ["ConfigurationId"], # required
|
345
|
+
# tags: [
|
346
|
+
# {
|
347
|
+
# key: "TagKey", # required
|
348
|
+
# value: "TagValue", # required
|
349
|
+
# },
|
350
|
+
# ],
|
351
|
+
# }
|
352
|
+
#
|
353
|
+
# @!attribute [rw] configuration_ids
|
354
|
+
# A list of configuration items with tags that you want to delete.
|
355
|
+
# @return [Array<String>]
|
356
|
+
#
|
357
|
+
# @!attribute [rw] tags
|
358
|
+
# Tags that you want to delete from one or more configuration items.
|
359
|
+
# Specify the tags that you want to delete in a *key*-*value* format.
|
360
|
+
# For example:
|
361
|
+
#
|
362
|
+
# `\{"key": "serverType", "value": "webServer"\}`
|
363
|
+
# @return [Array<Types::Tag>]
|
364
|
+
#
|
365
|
+
class DeleteTagsRequest < Struct.new(
|
366
|
+
:configuration_ids,
|
367
|
+
:tags)
|
368
|
+
include Aws::Structure
|
369
|
+
end
|
370
|
+
|
371
|
+
class DeleteTagsResponse < Aws::EmptyStructure; end
|
372
|
+
|
373
|
+
# @note When making an API call, you may pass DescribeAgentsRequest
|
374
|
+
# data as a hash:
|
375
|
+
#
|
376
|
+
# {
|
377
|
+
# agent_ids: ["AgentId"],
|
378
|
+
# filters: [
|
379
|
+
# {
|
380
|
+
# name: "String", # required
|
381
|
+
# values: ["FilterValue"], # required
|
382
|
+
# condition: "Condition", # required
|
383
|
+
# },
|
384
|
+
# ],
|
385
|
+
# max_results: 1,
|
386
|
+
# next_token: "NextToken",
|
387
|
+
# }
|
388
|
+
#
|
389
|
+
# @!attribute [rw] agent_ids
|
390
|
+
# The agent or the Connector IDs for which you want information. If
|
391
|
+
# you specify no IDs, the system returns information about all
|
392
|
+
# agents/Connectors associated with your AWS user account.
|
393
|
+
# @return [Array<String>]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] filters
|
396
|
+
# You can filter the request using various logical operators and a
|
397
|
+
# *key*-*value* format. For example:
|
398
|
+
#
|
399
|
+
# `\{"key": "collectionStatus", "value": "STARTED"\}`
|
400
|
+
#
|
401
|
+
# For a complete list of filter options and guidance about using them
|
402
|
+
# with this action, see [Managing AWS Application Discovery Service
|
403
|
+
# Agents and the AWS Application Discovery Connector ][1].
|
404
|
+
#
|
405
|
+
#
|
406
|
+
#
|
407
|
+
# [1]: http://docs.aws.amazon.com/application-discovery/latest/APIReference/managing-agent.html
|
408
|
+
# @return [Array<Types::Filter>]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] max_results
|
411
|
+
# The total number of agents/Connectors to return in a single page of
|
412
|
+
# output. The maximum value is 100.
|
413
|
+
# @return [Integer]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] next_token
|
416
|
+
# Token to retrieve the next set of results. For example, if you
|
417
|
+
# previously specified 100 IDs for `DescribeAgentsRequest$agentIds`
|
418
|
+
# but set `DescribeAgentsRequest$maxResults` to 10, you received a set
|
419
|
+
# of 10 results along with a token. Use that token in this query to
|
420
|
+
# get the next set of 10.
|
421
|
+
# @return [String]
|
422
|
+
#
|
423
|
+
class DescribeAgentsRequest < Struct.new(
|
424
|
+
:agent_ids,
|
425
|
+
:filters,
|
426
|
+
:max_results,
|
427
|
+
:next_token)
|
428
|
+
include Aws::Structure
|
429
|
+
end
|
430
|
+
|
431
|
+
# @!attribute [rw] agents_info
|
432
|
+
# Lists agents or the Connector by ID or lists all agents/Connectors
|
433
|
+
# associated with your user account if you did not specify an
|
434
|
+
# agent/Connector ID. The output includes agent/Connector IDs, IP
|
435
|
+
# addresses, media access control (MAC) addresses, agent/Connector
|
436
|
+
# health, host name where the agent/Connector resides, and the version
|
437
|
+
# number of each agent/Connector.
|
438
|
+
# @return [Array<Types::AgentInfo>]
|
439
|
+
#
|
440
|
+
# @!attribute [rw] next_token
|
441
|
+
# Token to retrieve the next set of results. For example, if you
|
442
|
+
# specified 100 IDs for `DescribeAgentsRequest$agentIds` but set
|
443
|
+
# `DescribeAgentsRequest$maxResults` to 10, you received a set of 10
|
444
|
+
# results along with this token. Use this token in the next query to
|
445
|
+
# retrieve the next set of 10.
|
446
|
+
# @return [String]
|
447
|
+
#
|
448
|
+
class DescribeAgentsResponse < Struct.new(
|
449
|
+
:agents_info,
|
450
|
+
:next_token)
|
451
|
+
include Aws::Structure
|
452
|
+
end
|
453
|
+
|
454
|
+
# @note When making an API call, you may pass DescribeConfigurationsRequest
|
455
|
+
# data as a hash:
|
456
|
+
#
|
457
|
+
# {
|
458
|
+
# configuration_ids: ["ConfigurationId"], # required
|
459
|
+
# }
|
460
|
+
#
|
461
|
+
# @!attribute [rw] configuration_ids
|
462
|
+
# One or more configuration IDs.
|
463
|
+
# @return [Array<String>]
|
464
|
+
#
|
465
|
+
class DescribeConfigurationsRequest < Struct.new(
|
466
|
+
:configuration_ids)
|
467
|
+
include Aws::Structure
|
468
|
+
end
|
469
|
+
|
470
|
+
# @!attribute [rw] configurations
|
471
|
+
# A key in the response map. The value is an array of data.
|
472
|
+
# @return [Array<Hash<String,String>>]
|
473
|
+
#
|
474
|
+
class DescribeConfigurationsResponse < Struct.new(
|
475
|
+
:configurations)
|
476
|
+
include Aws::Structure
|
477
|
+
end
|
478
|
+
|
479
|
+
# @note When making an API call, you may pass DescribeExportConfigurationsRequest
|
480
|
+
# data as a hash:
|
481
|
+
#
|
482
|
+
# {
|
483
|
+
# export_ids: ["ConfigurationsExportId"],
|
484
|
+
# max_results: 1,
|
485
|
+
# next_token: "NextToken",
|
486
|
+
# }
|
487
|
+
#
|
488
|
+
# @!attribute [rw] export_ids
|
489
|
+
# A unique identifier that you can use to query the export status.
|
490
|
+
# @return [Array<String>]
|
491
|
+
#
|
492
|
+
# @!attribute [rw] max_results
|
493
|
+
# The maximum number of results that you want to display as a part of
|
494
|
+
# the query.
|
495
|
+
# @return [Integer]
|
496
|
+
#
|
497
|
+
# @!attribute [rw] next_token
|
498
|
+
# A token to get the next set of results. For example, if you
|
499
|
+
# specified 100 IDs for
|
500
|
+
# `DescribeExportConfigurationsRequest$exportIds` but set
|
501
|
+
# `DescribeExportConfigurationsRequest$maxResults` to 10, you will get
|
502
|
+
# results in a set of 10. Use the token in the query to get the next
|
503
|
+
# set of 10.
|
504
|
+
# @return [String]
|
505
|
+
#
|
506
|
+
class DescribeExportConfigurationsRequest < Struct.new(
|
507
|
+
:export_ids,
|
508
|
+
:max_results,
|
509
|
+
:next_token)
|
510
|
+
include Aws::Structure
|
511
|
+
end
|
512
|
+
|
513
|
+
# @!attribute [rw] exports_info
|
514
|
+
# Returns export details. When the status is complete, the response
|
515
|
+
# includes a URL for an Amazon S3 bucket where you can view the data
|
516
|
+
# in a CSV file.
|
517
|
+
# @return [Array<Types::ExportInfo>]
|
518
|
+
#
|
519
|
+
# @!attribute [rw] next_token
|
520
|
+
# A token to get the next set of results. For example, if you
|
521
|
+
# specified 100 IDs for
|
522
|
+
# `DescribeExportConfigurationsRequest$exportIds` but set
|
523
|
+
# `DescribeExportConfigurationsRequest$maxResults` to 10, you will get
|
524
|
+
# results in a set of 10. Use the token in the query to get the next
|
525
|
+
# set of 10.
|
526
|
+
# @return [String]
|
527
|
+
#
|
528
|
+
class DescribeExportConfigurationsResponse < Struct.new(
|
529
|
+
:exports_info,
|
530
|
+
:next_token)
|
531
|
+
include Aws::Structure
|
532
|
+
end
|
533
|
+
|
534
|
+
# @note When making an API call, you may pass DescribeTagsRequest
|
535
|
+
# data as a hash:
|
536
|
+
#
|
537
|
+
# {
|
538
|
+
# filters: [
|
539
|
+
# {
|
540
|
+
# name: "FilterName", # required
|
541
|
+
# values: ["FilterValue"], # required
|
542
|
+
# },
|
543
|
+
# ],
|
544
|
+
# max_results: 1,
|
545
|
+
# next_token: "NextToken",
|
546
|
+
# }
|
547
|
+
#
|
548
|
+
# @!attribute [rw] filters
|
549
|
+
# You can filter the list using a *key*-*value* format. You can
|
550
|
+
# separate these items by using logical operators. Allowed filters
|
551
|
+
# include `tagKey`, `tagValue`, and `configurationId`.
|
552
|
+
#
|
553
|
+
# For a complete list of filter options and guidance about using them
|
554
|
+
# with this action, see [Managing AWS Application Discovery Service
|
555
|
+
# Agents and the AWS Application Discovery Connector ][1].
|
556
|
+
#
|
557
|
+
#
|
558
|
+
#
|
559
|
+
# [1]: http://docs.aws.amazon.com/application-discovery/latest/APIReference/managing-agents.html
|
560
|
+
# @return [Array<Types::TagFilter>]
|
561
|
+
#
|
562
|
+
# @!attribute [rw] max_results
|
563
|
+
# The total number of items to return in a single page of output. The
|
564
|
+
# maximum value is 100.
|
565
|
+
# @return [Integer]
|
566
|
+
#
|
567
|
+
# @!attribute [rw] next_token
|
568
|
+
# A token to start the list. Use this token to get the next set of
|
569
|
+
# results.
|
570
|
+
# @return [String]
|
571
|
+
#
|
572
|
+
class DescribeTagsRequest < Struct.new(
|
573
|
+
:filters,
|
574
|
+
:max_results,
|
575
|
+
:next_token)
|
576
|
+
include Aws::Structure
|
577
|
+
end
|
578
|
+
|
579
|
+
# @!attribute [rw] tags
|
580
|
+
# Depending on the input, this is a list of configuration items tagged
|
581
|
+
# with a specific tag, or a list of tags for a specific configuration
|
582
|
+
# item.
|
583
|
+
# @return [Array<Types::ConfigurationTag>]
|
584
|
+
#
|
585
|
+
# @!attribute [rw] next_token
|
586
|
+
# The call returns a token. Use this token to get the next set of
|
587
|
+
# results.
|
588
|
+
# @return [String]
|
589
|
+
#
|
590
|
+
class DescribeTagsResponse < Struct.new(
|
591
|
+
:tags,
|
592
|
+
:next_token)
|
593
|
+
include Aws::Structure
|
594
|
+
end
|
595
|
+
|
596
|
+
# @note When making an API call, you may pass DisassociateConfigurationItemsFromApplicationRequest
|
597
|
+
# data as a hash:
|
598
|
+
#
|
599
|
+
# {
|
600
|
+
# application_configuration_id: "ApplicationId", # required
|
601
|
+
# configuration_ids: ["ConfigurationId"], # required
|
602
|
+
# }
|
603
|
+
#
|
604
|
+
# @!attribute [rw] application_configuration_id
|
605
|
+
# Configuration ID of an application from which each item will be
|
606
|
+
# disassociated.
|
607
|
+
# @return [String]
|
608
|
+
#
|
609
|
+
# @!attribute [rw] configuration_ids
|
610
|
+
# Configuration ID of each item be be disassociated from an
|
611
|
+
# application.
|
612
|
+
# @return [Array<String>]
|
613
|
+
#
|
614
|
+
class DisassociateConfigurationItemsFromApplicationRequest < Struct.new(
|
615
|
+
:application_configuration_id,
|
616
|
+
:configuration_ids)
|
617
|
+
include Aws::Structure
|
618
|
+
end
|
619
|
+
|
620
|
+
class DisassociateConfigurationItemsFromApplicationResponse < Aws::EmptyStructure; end
|
621
|
+
|
622
|
+
# @!attribute [rw] export_id
|
623
|
+
# A unique identifier that you can use to query the export status.
|
624
|
+
# @return [String]
|
625
|
+
#
|
626
|
+
class ExportConfigurationsResponse < Struct.new(
|
627
|
+
:export_id)
|
628
|
+
include Aws::Structure
|
629
|
+
end
|
630
|
+
|
631
|
+
# Information regarding the export status of the discovered data. The
|
632
|
+
# value is an array of objects.
|
633
|
+
#
|
634
|
+
# @!attribute [rw] export_id
|
635
|
+
# A unique identifier that you can use to query the export.
|
636
|
+
# @return [String]
|
637
|
+
#
|
638
|
+
# @!attribute [rw] export_status
|
639
|
+
# The status of the configuration data export. The status can succeed,
|
640
|
+
# fail, or be in-progress.
|
641
|
+
# @return [String]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] status_message
|
644
|
+
# Helpful status messages for API callers. For example: Too many
|
645
|
+
# exports in the last 6 hours. Export in progress. Export was
|
646
|
+
# successful.
|
647
|
+
# @return [String]
|
648
|
+
#
|
649
|
+
# @!attribute [rw] configurations_download_url
|
650
|
+
# A URL for an Amazon S3 bucket where you can review the configuration
|
651
|
+
# data. The URL is displayed only if the export succeeded.
|
652
|
+
# @return [String]
|
653
|
+
#
|
654
|
+
# @!attribute [rw] export_request_time
|
655
|
+
# The time the configuration data export was initiated.
|
656
|
+
# @return [Time]
|
657
|
+
#
|
658
|
+
class ExportInfo < Struct.new(
|
659
|
+
:export_id,
|
660
|
+
:export_status,
|
661
|
+
:status_message,
|
662
|
+
:configurations_download_url,
|
663
|
+
:export_request_time)
|
664
|
+
include Aws::Structure
|
665
|
+
end
|
666
|
+
|
667
|
+
# A filter that can use conditional operators.
|
668
|
+
#
|
669
|
+
# for a complete list of filters and guidance for using them with the
|
670
|
+
# Application Discovery Service, see [Querying Discovered Configuration
|
671
|
+
# Items][1].
|
672
|
+
#
|
673
|
+
#
|
674
|
+
#
|
675
|
+
# [1]: http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html
|
676
|
+
#
|
677
|
+
# @note When making an API call, you may pass Filter
|
678
|
+
# data as a hash:
|
679
|
+
#
|
680
|
+
# {
|
681
|
+
# name: "String", # required
|
682
|
+
# values: ["FilterValue"], # required
|
683
|
+
# condition: "Condition", # required
|
684
|
+
# }
|
685
|
+
#
|
686
|
+
# @!attribute [rw] name
|
687
|
+
# The name of the filter.
|
688
|
+
# @return [String]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] values
|
691
|
+
# A string value that you want to filter on. For example, if you
|
692
|
+
# choose the `destinationServer.osVersion` filter name, you could
|
693
|
+
# specify `Ubuntu` for the value.
|
694
|
+
# @return [Array<String>]
|
695
|
+
#
|
696
|
+
# @!attribute [rw] condition
|
697
|
+
# A conditional operator. The following operators are valid: EQUALS,
|
698
|
+
# NOT\_EQUALS, CONTAINS, NOT\_CONTAINS. If you specify multiple
|
699
|
+
# filters, the system utilizes all filters as though concatenated by
|
700
|
+
# *AND*. If you specify multiple values for a particular filter, the
|
701
|
+
# system differentiates the values using *OR*. Calling either
|
702
|
+
# *DescribeConfigurations* or *ListConfigurations* returns attributes
|
703
|
+
# of matching configuration items.
|
704
|
+
# @return [String]
|
705
|
+
#
|
706
|
+
class Filter < Struct.new(
|
707
|
+
:name,
|
708
|
+
:values,
|
709
|
+
:condition)
|
710
|
+
include Aws::Structure
|
711
|
+
end
|
712
|
+
|
713
|
+
# @api private
|
714
|
+
#
|
715
|
+
class GetDiscoverySummaryRequest < Aws::EmptyStructure; end
|
716
|
+
|
717
|
+
# @!attribute [rw] servers
|
718
|
+
# Number of servers discovered.
|
719
|
+
# @return [Integer]
|
720
|
+
#
|
721
|
+
# @!attribute [rw] applications
|
722
|
+
# Number of applications discovered.
|
723
|
+
# @return [Integer]
|
724
|
+
#
|
725
|
+
# @!attribute [rw] servers_mapped_to_applications
|
726
|
+
# Number of servers mapped to applications.
|
727
|
+
# @return [Integer]
|
728
|
+
#
|
729
|
+
# @!attribute [rw] servers_mappedto_tags
|
730
|
+
# Number of servers mapped to tags.
|
731
|
+
# @return [Integer]
|
732
|
+
#
|
733
|
+
# @!attribute [rw] agent_summary
|
734
|
+
# Details about discovered agents, including agent status and health.
|
735
|
+
# @return [Types::CustomerAgentInfo]
|
736
|
+
#
|
737
|
+
# @!attribute [rw] connector_summary
|
738
|
+
# Details about discovered connectors, including connector status and
|
739
|
+
# health.
|
740
|
+
# @return [Types::CustomerConnectorInfo]
|
741
|
+
#
|
742
|
+
class GetDiscoverySummaryResponse < Struct.new(
|
743
|
+
:servers,
|
744
|
+
:applications,
|
745
|
+
:servers_mapped_to_applications,
|
746
|
+
:servers_mappedto_tags,
|
747
|
+
:agent_summary,
|
748
|
+
:connector_summary)
|
749
|
+
include Aws::Structure
|
750
|
+
end
|
751
|
+
|
752
|
+
# @note When making an API call, you may pass ListConfigurationsRequest
|
753
|
+
# data as a hash:
|
754
|
+
#
|
755
|
+
# {
|
756
|
+
# configuration_type: "SERVER", # required, accepts SERVER, PROCESS, CONNECTION, APPLICATION
|
757
|
+
# filters: [
|
758
|
+
# {
|
759
|
+
# name: "String", # required
|
760
|
+
# values: ["FilterValue"], # required
|
761
|
+
# condition: "Condition", # required
|
762
|
+
# },
|
763
|
+
# ],
|
764
|
+
# max_results: 1,
|
765
|
+
# next_token: "NextToken",
|
766
|
+
# order_by: [
|
767
|
+
# {
|
768
|
+
# field_name: "String", # required
|
769
|
+
# sort_order: "ASC", # accepts ASC, DESC
|
770
|
+
# },
|
771
|
+
# ],
|
772
|
+
# }
|
773
|
+
#
|
774
|
+
# @!attribute [rw] configuration_type
|
775
|
+
# A valid configuration identified by the Discovery Service.
|
776
|
+
# @return [String]
|
777
|
+
#
|
778
|
+
# @!attribute [rw] filters
|
779
|
+
# You can filter the request using various logical operators and a
|
780
|
+
# *key*-*value* format. For example:
|
781
|
+
#
|
782
|
+
# `\{"key": "serverType", "value": "webServer"\}`
|
783
|
+
#
|
784
|
+
# For a complete list of filter options and guidance about using them
|
785
|
+
# with this action, see [Querying Discovered Configuration Items][1].
|
786
|
+
#
|
787
|
+
#
|
788
|
+
#
|
789
|
+
# [1]: http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html#ListConfigurations
|
790
|
+
# @return [Array<Types::Filter>]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] max_results
|
793
|
+
# The total number of items to return. The maximum value is 100.
|
794
|
+
# @return [Integer]
|
795
|
+
#
|
796
|
+
# @!attribute [rw] next_token
|
797
|
+
# Token to retrieve the next set of results. For example, if a
|
798
|
+
# previous call to ListConfigurations returned 100 items, but you set
|
799
|
+
# `ListConfigurationsRequest$maxResults` to 10, you received a set of
|
800
|
+
# 10 results along with a token. Use that token in this query to get
|
801
|
+
# the next set of 10.
|
802
|
+
# @return [String]
|
803
|
+
#
|
804
|
+
# @!attribute [rw] order_by
|
805
|
+
# Certain filter criteria return output that can be sorted in
|
806
|
+
# ascending or descending order. For a list of output characteristics
|
807
|
+
# for each filter, see [Querying Discovered Configuration Items][1].
|
808
|
+
#
|
809
|
+
#
|
810
|
+
#
|
811
|
+
# [1]: http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html#ListConfigurations
|
812
|
+
# @return [Array<Types::OrderByElement>]
|
813
|
+
#
|
814
|
+
class ListConfigurationsRequest < Struct.new(
|
815
|
+
:configuration_type,
|
816
|
+
:filters,
|
817
|
+
:max_results,
|
818
|
+
:next_token,
|
819
|
+
:order_by)
|
820
|
+
include Aws::Structure
|
821
|
+
end
|
822
|
+
|
823
|
+
# @!attribute [rw] configurations
|
824
|
+
# Returns configuration details, including the configuration ID,
|
825
|
+
# attribute names, and attribute values.
|
826
|
+
# @return [Array<Hash<String,String>>]
|
827
|
+
#
|
828
|
+
# @!attribute [rw] next_token
|
829
|
+
# Token to retrieve the next set of results. For example, if your call
|
830
|
+
# to ListConfigurations returned 100 items, but you set
|
831
|
+
# `ListConfigurationsRequest$maxResults` to 10, you received a set of
|
832
|
+
# 10 results along with this token. Use this token in the next query
|
833
|
+
# to retrieve the next set of 10.
|
834
|
+
# @return [String]
|
835
|
+
#
|
836
|
+
class ListConfigurationsResponse < Struct.new(
|
837
|
+
:configurations,
|
838
|
+
:next_token)
|
839
|
+
include Aws::Structure
|
840
|
+
end
|
841
|
+
|
842
|
+
# @note When making an API call, you may pass ListServerNeighborsRequest
|
843
|
+
# data as a hash:
|
844
|
+
#
|
845
|
+
# {
|
846
|
+
# configuration_id: "ConfigurationId", # required
|
847
|
+
# port_information_needed: false,
|
848
|
+
# neighbor_configuration_ids: ["ConfigurationId"],
|
849
|
+
# max_results: 1,
|
850
|
+
# next_token: "String",
|
851
|
+
# }
|
852
|
+
#
|
853
|
+
# @!attribute [rw] configuration_id
|
854
|
+
# Configuration ID of the server for which neighbors are being listed.
|
855
|
+
# @return [String]
|
856
|
+
#
|
857
|
+
# @!attribute [rw] port_information_needed
|
858
|
+
# Flag to indicate if port and protocol information is needed as part
|
859
|
+
# of the response.
|
860
|
+
# @return [Boolean]
|
861
|
+
#
|
862
|
+
# @!attribute [rw] neighbor_configuration_ids
|
863
|
+
# List of configuration IDs to test for one-hop-away.
|
864
|
+
# @return [Array<String>]
|
865
|
+
#
|
866
|
+
# @!attribute [rw] max_results
|
867
|
+
# Maximum number of results to return in a single page of output.
|
868
|
+
# @return [Integer]
|
869
|
+
#
|
870
|
+
# @!attribute [rw] next_token
|
871
|
+
# Token to retrieve the next set of results. For example, if you
|
872
|
+
# previously specified 100 IDs for
|
873
|
+
# `ListServerNeighborsRequest$neighborConfigurationIds` but set
|
874
|
+
# `ListServerNeighborsRequest$maxResults` to 10, you received a set of
|
875
|
+
# 10 results along with a token. Use that token in this query to get
|
876
|
+
# the next set of 10.
|
877
|
+
# @return [String]
|
878
|
+
#
|
879
|
+
class ListServerNeighborsRequest < Struct.new(
|
880
|
+
:configuration_id,
|
881
|
+
:port_information_needed,
|
882
|
+
:neighbor_configuration_ids,
|
883
|
+
:max_results,
|
884
|
+
:next_token)
|
885
|
+
include Aws::Structure
|
886
|
+
end
|
887
|
+
|
888
|
+
# @!attribute [rw] neighbors
|
889
|
+
# List of distinct servers that are one hop away from the given
|
890
|
+
# server.
|
891
|
+
# @return [Array<Types::NeighborConnectionDetail>]
|
892
|
+
#
|
893
|
+
# @!attribute [rw] next_token
|
894
|
+
# Token to retrieve the next set of results. For example, if you
|
895
|
+
# specified 100 IDs for
|
896
|
+
# `ListServerNeighborsRequest$neighborConfigurationIds` but set
|
897
|
+
# `ListServerNeighborsRequest$maxResults` to 10, you received a set of
|
898
|
+
# 10 results along with this token. Use this token in the next query
|
899
|
+
# to retrieve the next set of 10.
|
900
|
+
# @return [String]
|
901
|
+
#
|
902
|
+
# @!attribute [rw] known_dependency_count
|
903
|
+
# Count of distinct servers that are one hop away from the given
|
904
|
+
# server.
|
905
|
+
# @return [Integer]
|
906
|
+
#
|
907
|
+
class ListServerNeighborsResponse < Struct.new(
|
908
|
+
:neighbors,
|
909
|
+
:next_token,
|
910
|
+
:known_dependency_count)
|
911
|
+
include Aws::Structure
|
912
|
+
end
|
913
|
+
|
914
|
+
# Details about neighboring servers.
|
915
|
+
#
|
916
|
+
# @!attribute [rw] source_server_id
|
917
|
+
# ID of server that opened the network connection.
|
918
|
+
# @return [String]
|
919
|
+
#
|
920
|
+
# @!attribute [rw] destination_server_id
|
921
|
+
# ID of the server that accepted the networker connection.
|
922
|
+
# @return [String]
|
923
|
+
#
|
924
|
+
# @!attribute [rw] destination_port
|
925
|
+
# Destination network port for the connection.
|
926
|
+
# @return [Integer]
|
927
|
+
#
|
928
|
+
# @!attribute [rw] transport_protocol
|
929
|
+
# Network protocol used for the connection.
|
930
|
+
# @return [String]
|
931
|
+
#
|
932
|
+
# @!attribute [rw] connections_count
|
933
|
+
# Number of open network connections with the neighboring server.
|
934
|
+
# @return [Integer]
|
935
|
+
#
|
936
|
+
class NeighborConnectionDetail < Struct.new(
|
937
|
+
:source_server_id,
|
938
|
+
:destination_server_id,
|
939
|
+
:destination_port,
|
940
|
+
:transport_protocol,
|
941
|
+
:connections_count)
|
942
|
+
include Aws::Structure
|
943
|
+
end
|
944
|
+
|
945
|
+
# Field and direction for ordered output.
|
946
|
+
#
|
947
|
+
# @note When making an API call, you may pass OrderByElement
|
948
|
+
# data as a hash:
|
949
|
+
#
|
950
|
+
# {
|
951
|
+
# field_name: "String", # required
|
952
|
+
# sort_order: "ASC", # accepts ASC, DESC
|
953
|
+
# }
|
954
|
+
#
|
955
|
+
# @!attribute [rw] field_name
|
956
|
+
# Field to order on.
|
957
|
+
# @return [String]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] sort_order
|
960
|
+
# Ordering direction.
|
961
|
+
# @return [String]
|
962
|
+
#
|
963
|
+
class OrderByElement < Struct.new(
|
964
|
+
:field_name,
|
965
|
+
:sort_order)
|
966
|
+
include Aws::Structure
|
967
|
+
end
|
968
|
+
|
969
|
+
# @note When making an API call, you may pass StartDataCollectionByAgentIdsRequest
|
970
|
+
# data as a hash:
|
971
|
+
#
|
972
|
+
# {
|
973
|
+
# agent_ids: ["AgentId"], # required
|
974
|
+
# }
|
975
|
+
#
|
976
|
+
# @!attribute [rw] agent_ids
|
977
|
+
# The IDs of the agents or Connectors that you want to start
|
978
|
+
# collecting data. If you send a request to an agent/Connector ID that
|
979
|
+
# you do not have permission to contact, according to your AWS
|
980
|
+
# account, the service does not throw an exception. Instead, it
|
981
|
+
# returns the error in the *Description* field. If you send a request
|
982
|
+
# to multiple agents/Connectors and you do not have permission to
|
983
|
+
# contact some of those agents/Connectors, the system does not throw
|
984
|
+
# an exception. Instead, the system shows `Failed` in the
|
985
|
+
# *Description* field.
|
986
|
+
# @return [Array<String>]
|
987
|
+
#
|
988
|
+
class StartDataCollectionByAgentIdsRequest < Struct.new(
|
989
|
+
:agent_ids)
|
990
|
+
include Aws::Structure
|
991
|
+
end
|
992
|
+
|
993
|
+
# @!attribute [rw] agents_configuration_status
|
994
|
+
# Information about agents or the Connector that were instructed to
|
995
|
+
# start collecting data. Information includes the agent/Connector ID,
|
996
|
+
# a description of the operation performed, and whether or not the
|
997
|
+
# agent/Connector configuration was updated.
|
998
|
+
# @return [Array<Types::AgentConfigurationStatus>]
|
999
|
+
#
|
1000
|
+
class StartDataCollectionByAgentIdsResponse < Struct.new(
|
1001
|
+
:agents_configuration_status)
|
1002
|
+
include Aws::Structure
|
1003
|
+
end
|
1004
|
+
|
1005
|
+
# @note When making an API call, you may pass StopDataCollectionByAgentIdsRequest
|
1006
|
+
# data as a hash:
|
1007
|
+
#
|
1008
|
+
# {
|
1009
|
+
# agent_ids: ["AgentId"], # required
|
1010
|
+
# }
|
1011
|
+
#
|
1012
|
+
# @!attribute [rw] agent_ids
|
1013
|
+
# The IDs of the agents or Connectors that you want to stop collecting
|
1014
|
+
# data.
|
1015
|
+
# @return [Array<String>]
|
1016
|
+
#
|
1017
|
+
class StopDataCollectionByAgentIdsRequest < Struct.new(
|
1018
|
+
:agent_ids)
|
1019
|
+
include Aws::Structure
|
1020
|
+
end
|
1021
|
+
|
1022
|
+
# @!attribute [rw] agents_configuration_status
|
1023
|
+
# Information about agents or the Connector that were instructed to
|
1024
|
+
# stop collecting data. Information includes the agent/Connector ID, a
|
1025
|
+
# description of the operation performed, and whether or not the
|
1026
|
+
# agent/Connector configuration was updated.
|
1027
|
+
# @return [Array<Types::AgentConfigurationStatus>]
|
1028
|
+
#
|
1029
|
+
class StopDataCollectionByAgentIdsResponse < Struct.new(
|
1030
|
+
:agents_configuration_status)
|
1031
|
+
include Aws::Structure
|
1032
|
+
end
|
1033
|
+
|
1034
|
+
# Metadata that help you categorize IT assets.
|
1035
|
+
#
|
1036
|
+
# @note When making an API call, you may pass Tag
|
1037
|
+
# data as a hash:
|
1038
|
+
#
|
1039
|
+
# {
|
1040
|
+
# key: "TagKey", # required
|
1041
|
+
# value: "TagValue", # required
|
1042
|
+
# }
|
1043
|
+
#
|
1044
|
+
# @!attribute [rw] key
|
1045
|
+
# A type of tag to filter on.
|
1046
|
+
# @return [String]
|
1047
|
+
#
|
1048
|
+
# @!attribute [rw] value
|
1049
|
+
# A value for a tag key to filter on.
|
1050
|
+
# @return [String]
|
1051
|
+
#
|
1052
|
+
class Tag < Struct.new(
|
1053
|
+
:key,
|
1054
|
+
:value)
|
1055
|
+
include Aws::Structure
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
# The name of a tag filter. Valid names are: `tagKey`, `tagValue`,
|
1059
|
+
# `configurationId`.
|
1060
|
+
#
|
1061
|
+
# @note When making an API call, you may pass TagFilter
|
1062
|
+
# data as a hash:
|
1063
|
+
#
|
1064
|
+
# {
|
1065
|
+
# name: "FilterName", # required
|
1066
|
+
# values: ["FilterValue"], # required
|
1067
|
+
# }
|
1068
|
+
#
|
1069
|
+
# @!attribute [rw] name
|
1070
|
+
# A name of a tag filter.
|
1071
|
+
# @return [String]
|
1072
|
+
#
|
1073
|
+
# @!attribute [rw] values
|
1074
|
+
# Values of a tag filter.
|
1075
|
+
# @return [Array<String>]
|
1076
|
+
#
|
1077
|
+
class TagFilter < Struct.new(
|
1078
|
+
:name,
|
1079
|
+
:values)
|
1080
|
+
include Aws::Structure
|
1081
|
+
end
|
1082
|
+
|
1083
|
+
# @note When making an API call, you may pass UpdateApplicationRequest
|
1084
|
+
# data as a hash:
|
1085
|
+
#
|
1086
|
+
# {
|
1087
|
+
# configuration_id: "ApplicationId", # required
|
1088
|
+
# name: "String",
|
1089
|
+
# description: "String",
|
1090
|
+
# }
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] configuration_id
|
1093
|
+
# Configuration ID of the application to be updated.
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] name
|
1097
|
+
# New name of the application to be updated.
|
1098
|
+
# @return [String]
|
1099
|
+
#
|
1100
|
+
# @!attribute [rw] description
|
1101
|
+
# New description of the application to be updated.
|
1102
|
+
# @return [String]
|
1103
|
+
#
|
1104
|
+
class UpdateApplicationRequest < Struct.new(
|
1105
|
+
:configuration_id,
|
1106
|
+
:name,
|
1107
|
+
:description)
|
1108
|
+
include Aws::Structure
|
1109
|
+
end
|
1110
|
+
|
1111
|
+
class UpdateApplicationResponse < Aws::EmptyStructure; end
|
1112
|
+
|
667
1113
|
end
|
668
1114
|
end
|