aws-sdk-inspector 1.0.0.rc1
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 +7 -0
- data/lib/aws-sdk-inspector.rb +47 -0
- data/lib/aws-sdk-inspector/client.rb +1293 -0
- data/lib/aws-sdk-inspector/client_api.rb +1047 -0
- data/lib/aws-sdk-inspector/customizations.rb +7 -0
- data/lib/aws-sdk-inspector/errors.rb +23 -0
- data/lib/aws-sdk-inspector/resource.rb +25 -0
- data/lib/aws-sdk-inspector/types.rb +2087 -0
- metadata +80 -0
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module Inspector
|
10
|
+
module Errors
|
11
|
+
|
12
|
+
extend Aws::Errors::DynamicErrors
|
13
|
+
|
14
|
+
# Raised when calling #load or #data on a resource class that can not be
|
15
|
+
# loaded. This can happen when:
|
16
|
+
#
|
17
|
+
# * A resource class has identifiers, but no data attributes.
|
18
|
+
# * Resource data is only available when making an API call that
|
19
|
+
# enumerates all resources of that type.
|
20
|
+
class ResourceNotLoadable < RuntimeError; end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module Inspector
|
10
|
+
class Resource
|
11
|
+
|
12
|
+
# @param options ({})
|
13
|
+
# @option options [Client] :client
|
14
|
+
def initialize(options = {})
|
15
|
+
@client = options[:client] || Client.new(options)
|
16
|
+
end
|
17
|
+
|
18
|
+
# @return [Client]
|
19
|
+
def client
|
20
|
+
@client
|
21
|
+
end
|
22
|
+
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,2087 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module Inspector
|
10
|
+
module Types
|
11
|
+
|
12
|
+
# @note When making an API call, pass AddAttributesToFindingsRequest
|
13
|
+
# data as a hash:
|
14
|
+
#
|
15
|
+
# {
|
16
|
+
# finding_arns: ["Arn"], # required
|
17
|
+
# attributes: [ # required
|
18
|
+
# {
|
19
|
+
# key: "AttributeKey", # required
|
20
|
+
# value: "AttributeValue",
|
21
|
+
# },
|
22
|
+
# ],
|
23
|
+
# }
|
24
|
+
# @!attribute [rw] finding_arns
|
25
|
+
# The ARNs that specify the findings that you want to assign
|
26
|
+
# attributes to.
|
27
|
+
# @return [Array<String>]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] attributes
|
30
|
+
# The array of attributes that you want to assign to specified
|
31
|
+
# findings.
|
32
|
+
# @return [Array<Types::Attribute>]
|
33
|
+
class AddAttributesToFindingsRequest < Struct.new(
|
34
|
+
:finding_arns,
|
35
|
+
:attributes)
|
36
|
+
include Aws::Structure
|
37
|
+
end
|
38
|
+
|
39
|
+
# @!attribute [rw] failed_items
|
40
|
+
# Attribute details that cannot be described. An error code is
|
41
|
+
# provided for each failed item.
|
42
|
+
# @return [Hash<String,Types::FailedItemDetails>]
|
43
|
+
class AddAttributesToFindingsResponse < Struct.new(
|
44
|
+
:failed_items)
|
45
|
+
include Aws::Structure
|
46
|
+
end
|
47
|
+
|
48
|
+
# Used in the exception error that is thrown if you start an assessment
|
49
|
+
# run for an assessment target that includes an EC2 instance that is
|
50
|
+
# already participating in another started assessment run.
|
51
|
+
# @!attribute [rw] agent_id
|
52
|
+
# ID of the agent that is running on an EC2 instance that is already
|
53
|
+
# participating in another started assessment run.
|
54
|
+
# @return [String]
|
55
|
+
#
|
56
|
+
# @!attribute [rw] assessment_run_arn
|
57
|
+
# The ARN of the assessment run that has already been started.
|
58
|
+
# @return [String]
|
59
|
+
class AgentAlreadyRunningAssessment < Struct.new(
|
60
|
+
:agent_id,
|
61
|
+
:assessment_run_arn)
|
62
|
+
include Aws::Structure
|
63
|
+
end
|
64
|
+
|
65
|
+
# Contains information about an Amazon Inspector agent. This data type
|
66
|
+
# is used as a request parameter in the ListAssessmentRunAgents action.
|
67
|
+
# @note When making an API call, pass AgentFilter
|
68
|
+
# data as a hash:
|
69
|
+
#
|
70
|
+
# {
|
71
|
+
# agent_healths: ["HEALTHY"], # required, accepts HEALTHY, UNHEALTHY
|
72
|
+
# agent_health_codes: ["IDLE"], # required, accepts IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, UNKNOWN
|
73
|
+
# }
|
74
|
+
# @!attribute [rw] agent_healths
|
75
|
+
# The current health state of the agent. Values can be set to
|
76
|
+
# **HEALTHY** or **UNHEALTHY**.
|
77
|
+
# @return [Array<String>]
|
78
|
+
#
|
79
|
+
# @!attribute [rw] agent_health_codes
|
80
|
+
# The detailed health state of the agent. Values can be set to
|
81
|
+
# **IDLE**, **RUNNING**, **SHUTDOWN**, **UNHEALTHY**, **THROTTLED**,
|
82
|
+
# and **UNKNOWN**.
|
83
|
+
# @return [Array<String>]
|
84
|
+
class AgentFilter < Struct.new(
|
85
|
+
:agent_healths,
|
86
|
+
:agent_health_codes)
|
87
|
+
include Aws::Structure
|
88
|
+
end
|
89
|
+
|
90
|
+
# Used as a response element in the PreviewAgents action.
|
91
|
+
# @!attribute [rw] agent_id
|
92
|
+
# The ID of the EC2 instance where the agent is installed.
|
93
|
+
# @return [String]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] auto_scaling_group
|
96
|
+
# The Auto Scaling group for the EC2 instance where the agent is
|
97
|
+
# installed.
|
98
|
+
# @return [String]
|
99
|
+
class AgentPreview < Struct.new(
|
100
|
+
:agent_id,
|
101
|
+
:auto_scaling_group)
|
102
|
+
include Aws::Structure
|
103
|
+
end
|
104
|
+
|
105
|
+
# A snapshot of an Amazon Inspector assessment run that contains the
|
106
|
+
# findings of the assessment run .
|
107
|
+
#
|
108
|
+
# Used as the response element in the DescribeAssessmentRuns action.
|
109
|
+
# @!attribute [rw] arn
|
110
|
+
# The ARN of the assessment run.
|
111
|
+
# @return [String]
|
112
|
+
#
|
113
|
+
# @!attribute [rw] name
|
114
|
+
# The auto-generated name for the assessment run.
|
115
|
+
# @return [String]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] assessment_template_arn
|
118
|
+
# The ARN of the assessment template that is associated with the
|
119
|
+
# assessment run.
|
120
|
+
# @return [String]
|
121
|
+
#
|
122
|
+
# @!attribute [rw] state
|
123
|
+
# The state of the assessment run.
|
124
|
+
# @return [String]
|
125
|
+
#
|
126
|
+
# @!attribute [rw] duration_in_seconds
|
127
|
+
# The duration of the assessment run.
|
128
|
+
# @return [Integer]
|
129
|
+
#
|
130
|
+
# @!attribute [rw] rules_package_arns
|
131
|
+
# The rules packages selected for the assessment run.
|
132
|
+
# @return [Array<String>]
|
133
|
+
#
|
134
|
+
# @!attribute [rw] user_attributes_for_findings
|
135
|
+
# The user-defined attributes that are assigned to every generated
|
136
|
+
# finding.
|
137
|
+
# @return [Array<Types::Attribute>]
|
138
|
+
#
|
139
|
+
# @!attribute [rw] created_at
|
140
|
+
# The time when StartAssessmentRun was called.
|
141
|
+
# @return [Time]
|
142
|
+
#
|
143
|
+
# @!attribute [rw] started_at
|
144
|
+
# The time when StartAssessmentRun was called.
|
145
|
+
# @return [Time]
|
146
|
+
#
|
147
|
+
# @!attribute [rw] completed_at
|
148
|
+
# The assessment run completion time that corresponds to the rules
|
149
|
+
# packages evaluation completion time or failure.
|
150
|
+
# @return [Time]
|
151
|
+
#
|
152
|
+
# @!attribute [rw] state_changed_at
|
153
|
+
# The last time when the assessment run's state changed.
|
154
|
+
# @return [Time]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] data_collected
|
157
|
+
# A Boolean value (true or false) that specifies whether the process
|
158
|
+
# of collecting data from the agents is completed.
|
159
|
+
# @return [Boolean]
|
160
|
+
#
|
161
|
+
# @!attribute [rw] state_changes
|
162
|
+
# A list of the assessment run state changes.
|
163
|
+
# @return [Array<Types::AssessmentRunStateChange>]
|
164
|
+
#
|
165
|
+
# @!attribute [rw] notifications
|
166
|
+
# A list of notifications for the event subscriptions. A notification
|
167
|
+
# about a particular generated finding is added to this list only
|
168
|
+
# once.
|
169
|
+
# @return [Array<Types::AssessmentRunNotification>]
|
170
|
+
class AssessmentRun < Struct.new(
|
171
|
+
:arn,
|
172
|
+
:name,
|
173
|
+
:assessment_template_arn,
|
174
|
+
:state,
|
175
|
+
:duration_in_seconds,
|
176
|
+
:rules_package_arns,
|
177
|
+
:user_attributes_for_findings,
|
178
|
+
:created_at,
|
179
|
+
:started_at,
|
180
|
+
:completed_at,
|
181
|
+
:state_changed_at,
|
182
|
+
:data_collected,
|
183
|
+
:state_changes,
|
184
|
+
:notifications)
|
185
|
+
include Aws::Structure
|
186
|
+
end
|
187
|
+
|
188
|
+
# Contains information about an Amazon Inspector agent. This data type
|
189
|
+
# is used as a response element in the ListAssessmentRunAgents action.
|
190
|
+
# @!attribute [rw] agent_id
|
191
|
+
# The AWS account of the EC2 instance where the agent is installed.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] assessment_run_arn
|
195
|
+
# The ARN of the assessment run that is associated with the agent.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] agent_health
|
199
|
+
# The current health state of the agent.
|
200
|
+
# @return [String]
|
201
|
+
#
|
202
|
+
# @!attribute [rw] agent_health_code
|
203
|
+
# The detailed health state of the agent.
|
204
|
+
# @return [String]
|
205
|
+
#
|
206
|
+
# @!attribute [rw] agent_health_details
|
207
|
+
# The description for the agent health code.
|
208
|
+
# @return [String]
|
209
|
+
#
|
210
|
+
# @!attribute [rw] auto_scaling_group
|
211
|
+
# The Auto Scaling group of the EC2 instance that is specified by the
|
212
|
+
# agent ID.
|
213
|
+
# @return [String]
|
214
|
+
#
|
215
|
+
# @!attribute [rw] telemetry_metadata
|
216
|
+
# The Amazon Inspector application data metrics that are collected by
|
217
|
+
# the agent.
|
218
|
+
# @return [Array<Types::TelemetryMetadata>]
|
219
|
+
class AssessmentRunAgent < Struct.new(
|
220
|
+
:agent_id,
|
221
|
+
:assessment_run_arn,
|
222
|
+
:agent_health,
|
223
|
+
:agent_health_code,
|
224
|
+
:agent_health_details,
|
225
|
+
:auto_scaling_group,
|
226
|
+
:telemetry_metadata)
|
227
|
+
include Aws::Structure
|
228
|
+
end
|
229
|
+
|
230
|
+
# Used as the request parameter in the ListAssessmentRuns action.
|
231
|
+
# @note When making an API call, pass AssessmentRunFilter
|
232
|
+
# data as a hash:
|
233
|
+
#
|
234
|
+
# {
|
235
|
+
# name_pattern: "NamePattern",
|
236
|
+
# states: ["CREATED"], # accepts CREATED, START_DATA_COLLECTION_PENDING, START_DATA_COLLECTION_IN_PROGRESS, COLLECTING_DATA, STOP_DATA_COLLECTION_PENDING, DATA_COLLECTED, EVALUATING_RULES, FAILED, COMPLETED, COMPLETED_WITH_ERRORS
|
237
|
+
# duration_range: {
|
238
|
+
# min_seconds: 1,
|
239
|
+
# max_seconds: 1,
|
240
|
+
# },
|
241
|
+
# rules_package_arns: ["Arn"],
|
242
|
+
# start_time_range: {
|
243
|
+
# begin_date: Time.now,
|
244
|
+
# end_date: Time.now,
|
245
|
+
# },
|
246
|
+
# completion_time_range: {
|
247
|
+
# begin_date: Time.now,
|
248
|
+
# end_date: Time.now,
|
249
|
+
# },
|
250
|
+
# state_change_time_range: {
|
251
|
+
# begin_date: Time.now,
|
252
|
+
# end_date: Time.now,
|
253
|
+
# },
|
254
|
+
# }
|
255
|
+
# @!attribute [rw] name_pattern
|
256
|
+
# For a record to match a filter, an explicit value or a string
|
257
|
+
# containing a wildcard that is specified for this data type property
|
258
|
+
# must match the value of the **assessmentRunName** property of the
|
259
|
+
# AssessmentRun data type.
|
260
|
+
# @return [String]
|
261
|
+
#
|
262
|
+
# @!attribute [rw] states
|
263
|
+
# For a record to match a filter, one of the values specified for this
|
264
|
+
# data type property must be the exact match of the value of the
|
265
|
+
# **assessmentRunState** property of the AssessmentRun data type.
|
266
|
+
# @return [Array<String>]
|
267
|
+
#
|
268
|
+
# @!attribute [rw] duration_range
|
269
|
+
# For a record to match a filter, the value that is specified for this
|
270
|
+
# data type property must inclusively match any value between the
|
271
|
+
# specified minimum and maximum values of the **durationInSeconds**
|
272
|
+
# property of the AssessmentRun data type.
|
273
|
+
# @return [Types::DurationRange]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] rules_package_arns
|
276
|
+
# For a record to match a filter, the value that is specified for this
|
277
|
+
# data type property must be contained in the list of values of the
|
278
|
+
# **rulesPackages** property of the AssessmentRun data type.
|
279
|
+
# @return [Array<String>]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] start_time_range
|
282
|
+
# For a record to match a filter, the value that is specified for this
|
283
|
+
# data type property must inclusively match any value between the
|
284
|
+
# specified minimum and maximum values of the **startTime** property
|
285
|
+
# of the AssessmentRun data type.
|
286
|
+
# @return [Types::TimestampRange]
|
287
|
+
#
|
288
|
+
# @!attribute [rw] completion_time_range
|
289
|
+
# For a record to match a filter, the value that is specified for this
|
290
|
+
# data type property must inclusively match any value between the
|
291
|
+
# specified minimum and maximum values of the **completedAt** property
|
292
|
+
# of the AssessmentRun data type.
|
293
|
+
# @return [Types::TimestampRange]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] state_change_time_range
|
296
|
+
# For a record to match a filter, the value that is specified for this
|
297
|
+
# data type property must match the **stateChangedAt** property of the
|
298
|
+
# AssessmentRun data type.
|
299
|
+
# @return [Types::TimestampRange]
|
300
|
+
class AssessmentRunFilter < Struct.new(
|
301
|
+
:name_pattern,
|
302
|
+
:states,
|
303
|
+
:duration_range,
|
304
|
+
:rules_package_arns,
|
305
|
+
:start_time_range,
|
306
|
+
:completion_time_range,
|
307
|
+
:state_change_time_range)
|
308
|
+
include Aws::Structure
|
309
|
+
end
|
310
|
+
|
311
|
+
# Used as one of the elements of the AssessmentRun data type.
|
312
|
+
# @!attribute [rw] date
|
313
|
+
# The date of the notification.
|
314
|
+
# @return [Time]
|
315
|
+
#
|
316
|
+
# @!attribute [rw] event
|
317
|
+
# The event for which a notification is sent.
|
318
|
+
# @return [String]
|
319
|
+
#
|
320
|
+
# @!attribute [rw] message
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @!attribute [rw] error
|
324
|
+
# The Boolean value that specifies whether the notification represents
|
325
|
+
# an error.
|
326
|
+
# @return [Boolean]
|
327
|
+
#
|
328
|
+
# @!attribute [rw] sns_topic_arn
|
329
|
+
# The SNS topic to which the SNS notification is sent.
|
330
|
+
# @return [String]
|
331
|
+
#
|
332
|
+
# @!attribute [rw] sns_publish_status_code
|
333
|
+
# The status code of the SNS notification.
|
334
|
+
# @return [String]
|
335
|
+
class AssessmentRunNotification < Struct.new(
|
336
|
+
:date,
|
337
|
+
:event,
|
338
|
+
:message,
|
339
|
+
:error,
|
340
|
+
:sns_topic_arn,
|
341
|
+
:sns_publish_status_code)
|
342
|
+
include Aws::Structure
|
343
|
+
end
|
344
|
+
|
345
|
+
# Used as one of the elements of the AssessmentRun data type.
|
346
|
+
# @!attribute [rw] state_changed_at
|
347
|
+
# The last time the assessment run state changed.
|
348
|
+
# @return [Time]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] state
|
351
|
+
# The assessment run state.
|
352
|
+
# @return [String]
|
353
|
+
class AssessmentRunStateChange < Struct.new(
|
354
|
+
:state_changed_at,
|
355
|
+
:state)
|
356
|
+
include Aws::Structure
|
357
|
+
end
|
358
|
+
|
359
|
+
# Contains information about an Amazon Inspector application. This data
|
360
|
+
# type is used as the response element in the DescribeAssessmentTargets
|
361
|
+
# action.
|
362
|
+
# @!attribute [rw] arn
|
363
|
+
# The ARN that specifies the Amazon Inspector assessment target.
|
364
|
+
# @return [String]
|
365
|
+
#
|
366
|
+
# @!attribute [rw] name
|
367
|
+
# The name of the Amazon Inspector assessment target.
|
368
|
+
# @return [String]
|
369
|
+
#
|
370
|
+
# @!attribute [rw] resource_group_arn
|
371
|
+
# The ARN that specifies the resource group that is associated with
|
372
|
+
# the assessment target.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] created_at
|
376
|
+
# The time at which the assessment target is created.
|
377
|
+
# @return [Time]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] updated_at
|
380
|
+
# The time at which UpdateAssessmentTarget is called.
|
381
|
+
# @return [Time]
|
382
|
+
class AssessmentTarget < Struct.new(
|
383
|
+
:arn,
|
384
|
+
:name,
|
385
|
+
:resource_group_arn,
|
386
|
+
:created_at,
|
387
|
+
:updated_at)
|
388
|
+
include Aws::Structure
|
389
|
+
end
|
390
|
+
|
391
|
+
# Used as the request parameter in the ListAssessmentTargets action.
|
392
|
+
# @note When making an API call, pass AssessmentTargetFilter
|
393
|
+
# data as a hash:
|
394
|
+
#
|
395
|
+
# {
|
396
|
+
# assessment_target_name_pattern: "NamePattern",
|
397
|
+
# }
|
398
|
+
# @!attribute [rw] assessment_target_name_pattern
|
399
|
+
# For a record to match a filter, an explicit value or a string that
|
400
|
+
# contains a wildcard that is specified for this data type property
|
401
|
+
# must match the value of the **assessmentTargetName** property of the
|
402
|
+
# AssessmentTarget data type.
|
403
|
+
# @return [String]
|
404
|
+
class AssessmentTargetFilter < Struct.new(
|
405
|
+
:assessment_target_name_pattern)
|
406
|
+
include Aws::Structure
|
407
|
+
end
|
408
|
+
|
409
|
+
# Contains information about an Amazon Inspector assessment template.
|
410
|
+
# This data type is used as the response element in the
|
411
|
+
# DescribeAssessmentTemplates action.
|
412
|
+
# @!attribute [rw] arn
|
413
|
+
# The ARN of the assessment template.
|
414
|
+
# @return [String]
|
415
|
+
#
|
416
|
+
# @!attribute [rw] name
|
417
|
+
# The name of the assessment template.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] assessment_target_arn
|
421
|
+
# The ARN of the assessment target that corresponds to this assessment
|
422
|
+
# template.
|
423
|
+
# @return [String]
|
424
|
+
#
|
425
|
+
# @!attribute [rw] duration_in_seconds
|
426
|
+
# The duration in seconds specified for this assessment tempate. The
|
427
|
+
# default value is 3600 seconds (one hour). The maximum value is 86400
|
428
|
+
# seconds (one day).
|
429
|
+
# @return [Integer]
|
430
|
+
#
|
431
|
+
# @!attribute [rw] rules_package_arns
|
432
|
+
# The rules packages that are specified for this assessment template.
|
433
|
+
# @return [Array<String>]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] user_attributes_for_findings
|
436
|
+
# The user-defined attributes that are assigned to every generated
|
437
|
+
# finding from the assessment run that uses this assessment template.
|
438
|
+
# @return [Array<Types::Attribute>]
|
439
|
+
#
|
440
|
+
# @!attribute [rw] created_at
|
441
|
+
# The time at which the assessment template is created.
|
442
|
+
# @return [Time]
|
443
|
+
class AssessmentTemplate < Struct.new(
|
444
|
+
:arn,
|
445
|
+
:name,
|
446
|
+
:assessment_target_arn,
|
447
|
+
:duration_in_seconds,
|
448
|
+
:rules_package_arns,
|
449
|
+
:user_attributes_for_findings,
|
450
|
+
:created_at)
|
451
|
+
include Aws::Structure
|
452
|
+
end
|
453
|
+
|
454
|
+
# Used as the request parameter in the ListAssessmentTemplates action.
|
455
|
+
# @note When making an API call, pass AssessmentTemplateFilter
|
456
|
+
# data as a hash:
|
457
|
+
#
|
458
|
+
# {
|
459
|
+
# name_pattern: "NamePattern",
|
460
|
+
# duration_range: {
|
461
|
+
# min_seconds: 1,
|
462
|
+
# max_seconds: 1,
|
463
|
+
# },
|
464
|
+
# rules_package_arns: ["Arn"],
|
465
|
+
# }
|
466
|
+
# @!attribute [rw] name_pattern
|
467
|
+
# For a record to match a filter, an explicit value or a string that
|
468
|
+
# contains a wildcard that is specified for this data type property
|
469
|
+
# must match the value of the **assessmentTemplateName** property of
|
470
|
+
# the AssessmentTemplate data type.
|
471
|
+
# @return [String]
|
472
|
+
#
|
473
|
+
# @!attribute [rw] duration_range
|
474
|
+
# For a record to match a filter, the value specified for this data
|
475
|
+
# type property must inclusively match any value between the specified
|
476
|
+
# minimum and maximum values of the **durationInSeconds** property of
|
477
|
+
# the AssessmentTemplate data type.
|
478
|
+
# @return [Types::DurationRange]
|
479
|
+
#
|
480
|
+
# @!attribute [rw] rules_package_arns
|
481
|
+
# For a record to match a filter, the values that are specified for
|
482
|
+
# this data type property must be contained in the list of values of
|
483
|
+
# the **rulesPackageArns** property of the AssessmentTemplate data
|
484
|
+
# type.
|
485
|
+
# @return [Array<String>]
|
486
|
+
class AssessmentTemplateFilter < Struct.new(
|
487
|
+
:name_pattern,
|
488
|
+
:duration_range,
|
489
|
+
:rules_package_arns)
|
490
|
+
include Aws::Structure
|
491
|
+
end
|
492
|
+
|
493
|
+
# A collection of attributes of the host from which the finding is
|
494
|
+
# generated.
|
495
|
+
# @!attribute [rw] schema_version
|
496
|
+
# The schema version of this data type.
|
497
|
+
# @return [Integer]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] agent_id
|
500
|
+
# The ID of the agent that is installed on the EC2 instance where the
|
501
|
+
# finding is generated.
|
502
|
+
# @return [String]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] auto_scaling_group
|
505
|
+
# The Auto Scaling group of the EC2 instance where the finding is
|
506
|
+
# generated.
|
507
|
+
# @return [String]
|
508
|
+
#
|
509
|
+
# @!attribute [rw] ami_id
|
510
|
+
# The ID of the Amazon Machine Image (AMI) that is installed on the
|
511
|
+
# EC2 instance where the finding is generated.
|
512
|
+
# @return [String]
|
513
|
+
#
|
514
|
+
# @!attribute [rw] hostname
|
515
|
+
# The hostname of the EC2 instance where the finding is generated.
|
516
|
+
# @return [String]
|
517
|
+
#
|
518
|
+
# @!attribute [rw] ipv4_addresses
|
519
|
+
# The list of IP v4 addresses of the EC2 instance where the finding is
|
520
|
+
# generated.
|
521
|
+
# @return [Array<String>]
|
522
|
+
class AssetAttributes < Struct.new(
|
523
|
+
:schema_version,
|
524
|
+
:agent_id,
|
525
|
+
:auto_scaling_group,
|
526
|
+
:ami_id,
|
527
|
+
:hostname,
|
528
|
+
:ipv4_addresses)
|
529
|
+
include Aws::Structure
|
530
|
+
end
|
531
|
+
|
532
|
+
# This data type is used as a request parameter in the
|
533
|
+
# AddAttributesToFindings and CreateAssessmentTemplate actions.
|
534
|
+
# @note When making an API call, pass Attribute
|
535
|
+
# data as a hash:
|
536
|
+
#
|
537
|
+
# {
|
538
|
+
# key: "AttributeKey", # required
|
539
|
+
# value: "AttributeValue",
|
540
|
+
# }
|
541
|
+
# @!attribute [rw] key
|
542
|
+
# The attribute key.
|
543
|
+
# @return [String]
|
544
|
+
#
|
545
|
+
# @!attribute [rw] value
|
546
|
+
# The value assigned to the attribute key.
|
547
|
+
# @return [String]
|
548
|
+
class Attribute < Struct.new(
|
549
|
+
:key,
|
550
|
+
:value)
|
551
|
+
include Aws::Structure
|
552
|
+
end
|
553
|
+
|
554
|
+
# @note When making an API call, pass CreateAssessmentTargetRequest
|
555
|
+
# data as a hash:
|
556
|
+
#
|
557
|
+
# {
|
558
|
+
# assessment_target_name: "AssessmentTargetName", # required
|
559
|
+
# resource_group_arn: "Arn", # required
|
560
|
+
# }
|
561
|
+
# @!attribute [rw] assessment_target_name
|
562
|
+
# The user-defined name that identifies the assessment target that you
|
563
|
+
# want to create. The name must be unique within the AWS account.
|
564
|
+
# @return [String]
|
565
|
+
#
|
566
|
+
# @!attribute [rw] resource_group_arn
|
567
|
+
# The ARN that specifies the resource group that is used to create the
|
568
|
+
# assessment target.
|
569
|
+
# @return [String]
|
570
|
+
class CreateAssessmentTargetRequest < Struct.new(
|
571
|
+
:assessment_target_name,
|
572
|
+
:resource_group_arn)
|
573
|
+
include Aws::Structure
|
574
|
+
end
|
575
|
+
|
576
|
+
# @!attribute [rw] assessment_target_arn
|
577
|
+
# The ARN that specifies the assessment target that is created.
|
578
|
+
# @return [String]
|
579
|
+
class CreateAssessmentTargetResponse < Struct.new(
|
580
|
+
:assessment_target_arn)
|
581
|
+
include Aws::Structure
|
582
|
+
end
|
583
|
+
|
584
|
+
# @note When making an API call, pass CreateAssessmentTemplateRequest
|
585
|
+
# data as a hash:
|
586
|
+
#
|
587
|
+
# {
|
588
|
+
# assessment_target_arn: "Arn", # required
|
589
|
+
# assessment_template_name: "AssessmentTemplateName", # required
|
590
|
+
# duration_in_seconds: 1, # required
|
591
|
+
# rules_package_arns: ["Arn"], # required
|
592
|
+
# user_attributes_for_findings: [
|
593
|
+
# {
|
594
|
+
# key: "AttributeKey", # required
|
595
|
+
# value: "AttributeValue",
|
596
|
+
# },
|
597
|
+
# ],
|
598
|
+
# }
|
599
|
+
# @!attribute [rw] assessment_target_arn
|
600
|
+
# The ARN that specifies the assessment target for which you want to
|
601
|
+
# create the assessment template.
|
602
|
+
# @return [String]
|
603
|
+
#
|
604
|
+
# @!attribute [rw] assessment_template_name
|
605
|
+
# The user-defined name that identifies the assessment template that
|
606
|
+
# you want to create. You can create several assessment templates for
|
607
|
+
# an assessment target. The names of the assessment templates that
|
608
|
+
# correspond to a particular assessment target must be unique.
|
609
|
+
# @return [String]
|
610
|
+
#
|
611
|
+
# @!attribute [rw] duration_in_seconds
|
612
|
+
# The duration of the assessment run in seconds. The default value is
|
613
|
+
# 3600 seconds (one hour).
|
614
|
+
# @return [Integer]
|
615
|
+
#
|
616
|
+
# @!attribute [rw] rules_package_arns
|
617
|
+
# The ARNs that specify the rules packages that you want to attach to
|
618
|
+
# the assessment template.
|
619
|
+
# @return [Array<String>]
|
620
|
+
#
|
621
|
+
# @!attribute [rw] user_attributes_for_findings
|
622
|
+
# The user-defined attributes that are assigned to every finding that
|
623
|
+
# is generated by the assessment run that uses this assessment
|
624
|
+
# template.
|
625
|
+
# @return [Array<Types::Attribute>]
|
626
|
+
class CreateAssessmentTemplateRequest < Struct.new(
|
627
|
+
:assessment_target_arn,
|
628
|
+
:assessment_template_name,
|
629
|
+
:duration_in_seconds,
|
630
|
+
:rules_package_arns,
|
631
|
+
:user_attributes_for_findings)
|
632
|
+
include Aws::Structure
|
633
|
+
end
|
634
|
+
|
635
|
+
# @!attribute [rw] assessment_template_arn
|
636
|
+
# The ARN that specifies the assessment template that is created.
|
637
|
+
# @return [String]
|
638
|
+
class CreateAssessmentTemplateResponse < Struct.new(
|
639
|
+
:assessment_template_arn)
|
640
|
+
include Aws::Structure
|
641
|
+
end
|
642
|
+
|
643
|
+
# @note When making an API call, pass CreateResourceGroupRequest
|
644
|
+
# data as a hash:
|
645
|
+
#
|
646
|
+
# {
|
647
|
+
# resource_group_tags: [ # required
|
648
|
+
# {
|
649
|
+
# key: "TagKey", # required
|
650
|
+
# value: "TagValue",
|
651
|
+
# },
|
652
|
+
# ],
|
653
|
+
# }
|
654
|
+
# @!attribute [rw] resource_group_tags
|
655
|
+
# A collection of keys and an array of possible values,
|
656
|
+
# '\[\\\{"key":"key1","values":\["Value1","Value2"\]\\},\\\{"key":"Key2","values":\["Value3"\]\\}\]'.
|
657
|
+
#
|
658
|
+
# For
|
659
|
+
# example,'\[\\\{"key":"Name","values":\["TestEC2Instance"\]\\}\]'.
|
660
|
+
# @return [Array<Types::ResourceGroupTag>]
|
661
|
+
class CreateResourceGroupRequest < Struct.new(
|
662
|
+
:resource_group_tags)
|
663
|
+
include Aws::Structure
|
664
|
+
end
|
665
|
+
|
666
|
+
# @!attribute [rw] resource_group_arn
|
667
|
+
# The ARN that specifies the resource group that is created.
|
668
|
+
# @return [String]
|
669
|
+
class CreateResourceGroupResponse < Struct.new(
|
670
|
+
:resource_group_arn)
|
671
|
+
include Aws::Structure
|
672
|
+
end
|
673
|
+
|
674
|
+
# @note When making an API call, pass DeleteAssessmentRunRequest
|
675
|
+
# data as a hash:
|
676
|
+
#
|
677
|
+
# {
|
678
|
+
# assessment_run_arn: "Arn", # required
|
679
|
+
# }
|
680
|
+
# @!attribute [rw] assessment_run_arn
|
681
|
+
# The ARN that specifies the assessment run that you want to delete.
|
682
|
+
# @return [String]
|
683
|
+
class DeleteAssessmentRunRequest < Struct.new(
|
684
|
+
:assessment_run_arn)
|
685
|
+
include Aws::Structure
|
686
|
+
end
|
687
|
+
|
688
|
+
# @note When making an API call, pass DeleteAssessmentTargetRequest
|
689
|
+
# data as a hash:
|
690
|
+
#
|
691
|
+
# {
|
692
|
+
# assessment_target_arn: "Arn", # required
|
693
|
+
# }
|
694
|
+
# @!attribute [rw] assessment_target_arn
|
695
|
+
# The ARN that specifies the assessment target that you want to
|
696
|
+
# delete.
|
697
|
+
# @return [String]
|
698
|
+
class DeleteAssessmentTargetRequest < Struct.new(
|
699
|
+
:assessment_target_arn)
|
700
|
+
include Aws::Structure
|
701
|
+
end
|
702
|
+
|
703
|
+
# @note When making an API call, pass DeleteAssessmentTemplateRequest
|
704
|
+
# data as a hash:
|
705
|
+
#
|
706
|
+
# {
|
707
|
+
# assessment_template_arn: "Arn", # required
|
708
|
+
# }
|
709
|
+
# @!attribute [rw] assessment_template_arn
|
710
|
+
# The ARN that specifies the assessment template that you want to
|
711
|
+
# delete.
|
712
|
+
# @return [String]
|
713
|
+
class DeleteAssessmentTemplateRequest < Struct.new(
|
714
|
+
:assessment_template_arn)
|
715
|
+
include Aws::Structure
|
716
|
+
end
|
717
|
+
|
718
|
+
# @note When making an API call, pass DescribeAssessmentRunsRequest
|
719
|
+
# data as a hash:
|
720
|
+
#
|
721
|
+
# {
|
722
|
+
# assessment_run_arns: ["Arn"], # required
|
723
|
+
# }
|
724
|
+
# @!attribute [rw] assessment_run_arns
|
725
|
+
# The ARN that specifies the assessment run that you want to describe.
|
726
|
+
# @return [Array<String>]
|
727
|
+
class DescribeAssessmentRunsRequest < Struct.new(
|
728
|
+
:assessment_run_arns)
|
729
|
+
include Aws::Structure
|
730
|
+
end
|
731
|
+
|
732
|
+
# @!attribute [rw] assessment_runs
|
733
|
+
# Information about the assessment run.
|
734
|
+
# @return [Array<Types::AssessmentRun>]
|
735
|
+
#
|
736
|
+
# @!attribute [rw] failed_items
|
737
|
+
# Assessment run details that cannot be described. An error code is
|
738
|
+
# provided for each failed item.
|
739
|
+
# @return [Hash<String,Types::FailedItemDetails>]
|
740
|
+
class DescribeAssessmentRunsResponse < Struct.new(
|
741
|
+
:assessment_runs,
|
742
|
+
:failed_items)
|
743
|
+
include Aws::Structure
|
744
|
+
end
|
745
|
+
|
746
|
+
# @note When making an API call, pass DescribeAssessmentTargetsRequest
|
747
|
+
# data as a hash:
|
748
|
+
#
|
749
|
+
# {
|
750
|
+
# assessment_target_arns: ["Arn"], # required
|
751
|
+
# }
|
752
|
+
# @!attribute [rw] assessment_target_arns
|
753
|
+
# The ARNs that specifies the assessment targets that you want to
|
754
|
+
# describe.
|
755
|
+
# @return [Array<String>]
|
756
|
+
class DescribeAssessmentTargetsRequest < Struct.new(
|
757
|
+
:assessment_target_arns)
|
758
|
+
include Aws::Structure
|
759
|
+
end
|
760
|
+
|
761
|
+
# @!attribute [rw] assessment_targets
|
762
|
+
# Information about the assessment targets.
|
763
|
+
# @return [Array<Types::AssessmentTarget>]
|
764
|
+
#
|
765
|
+
# @!attribute [rw] failed_items
|
766
|
+
# Assessment target details that cannot be described. An error code is
|
767
|
+
# provided for each failed item.
|
768
|
+
# @return [Hash<String,Types::FailedItemDetails>]
|
769
|
+
class DescribeAssessmentTargetsResponse < Struct.new(
|
770
|
+
:assessment_targets,
|
771
|
+
:failed_items)
|
772
|
+
include Aws::Structure
|
773
|
+
end
|
774
|
+
|
775
|
+
# @note When making an API call, pass DescribeAssessmentTemplatesRequest
|
776
|
+
# data as a hash:
|
777
|
+
#
|
778
|
+
# {
|
779
|
+
# assessment_template_arns: ["Arn"], # required
|
780
|
+
# }
|
781
|
+
# @!attribute [rw] assessment_template_arns
|
782
|
+
# The ARN that specifiesthe assessment templates that you want to
|
783
|
+
# describe.
|
784
|
+
# @return [Array<String>]
|
785
|
+
class DescribeAssessmentTemplatesRequest < Struct.new(
|
786
|
+
:assessment_template_arns)
|
787
|
+
include Aws::Structure
|
788
|
+
end
|
789
|
+
|
790
|
+
# @!attribute [rw] assessment_templates
|
791
|
+
# Information about the assessment templates.
|
792
|
+
# @return [Array<Types::AssessmentTemplate>]
|
793
|
+
#
|
794
|
+
# @!attribute [rw] failed_items
|
795
|
+
# Assessment template details that cannot be described. An error code
|
796
|
+
# is provided for each failed item.
|
797
|
+
# @return [Hash<String,Types::FailedItemDetails>]
|
798
|
+
class DescribeAssessmentTemplatesResponse < Struct.new(
|
799
|
+
:assessment_templates,
|
800
|
+
:failed_items)
|
801
|
+
include Aws::Structure
|
802
|
+
end
|
803
|
+
|
804
|
+
# @!attribute [rw] role_arn
|
805
|
+
# The ARN that specifies the IAM role that Amazon Inspector uses to
|
806
|
+
# access your AWS account.
|
807
|
+
# @return [String]
|
808
|
+
#
|
809
|
+
# @!attribute [rw] valid
|
810
|
+
# A Boolean value that specifies whether the IAM role has the
|
811
|
+
# necessary policies attached to enable Amazon Inspector to access
|
812
|
+
# your AWS account.
|
813
|
+
# @return [Boolean]
|
814
|
+
#
|
815
|
+
# @!attribute [rw] registered_at
|
816
|
+
# The date when the cross-account access role was registered.
|
817
|
+
# @return [Time]
|
818
|
+
class DescribeCrossAccountAccessRoleResponse < Struct.new(
|
819
|
+
:role_arn,
|
820
|
+
:valid,
|
821
|
+
:registered_at)
|
822
|
+
include Aws::Structure
|
823
|
+
end
|
824
|
+
|
825
|
+
# @note When making an API call, pass DescribeFindingsRequest
|
826
|
+
# data as a hash:
|
827
|
+
#
|
828
|
+
# {
|
829
|
+
# finding_arns: ["Arn"], # required
|
830
|
+
# locale: "EN_US", # accepts EN_US
|
831
|
+
# }
|
832
|
+
# @!attribute [rw] finding_arns
|
833
|
+
# The ARN that specifies the finding that you want to describe.
|
834
|
+
# @return [Array<String>]
|
835
|
+
#
|
836
|
+
# @!attribute [rw] locale
|
837
|
+
# The locale into which you want to translate a finding description,
|
838
|
+
# recommendation, and the short description that identifies the
|
839
|
+
# finding.
|
840
|
+
# @return [String]
|
841
|
+
class DescribeFindingsRequest < Struct.new(
|
842
|
+
:finding_arns,
|
843
|
+
:locale)
|
844
|
+
include Aws::Structure
|
845
|
+
end
|
846
|
+
|
847
|
+
# @!attribute [rw] findings
|
848
|
+
# Information about the finding.
|
849
|
+
# @return [Array<Types::Finding>]
|
850
|
+
#
|
851
|
+
# @!attribute [rw] failed_items
|
852
|
+
# Finding details that cannot be described. An error code is provided
|
853
|
+
# for each failed item.
|
854
|
+
# @return [Hash<String,Types::FailedItemDetails>]
|
855
|
+
class DescribeFindingsResponse < Struct.new(
|
856
|
+
:findings,
|
857
|
+
:failed_items)
|
858
|
+
include Aws::Structure
|
859
|
+
end
|
860
|
+
|
861
|
+
# @note When making an API call, pass DescribeResourceGroupsRequest
|
862
|
+
# data as a hash:
|
863
|
+
#
|
864
|
+
# {
|
865
|
+
# resource_group_arns: ["Arn"], # required
|
866
|
+
# }
|
867
|
+
# @!attribute [rw] resource_group_arns
|
868
|
+
# The ARN that specifies the resource group that you want to describe.
|
869
|
+
# @return [Array<String>]
|
870
|
+
class DescribeResourceGroupsRequest < Struct.new(
|
871
|
+
:resource_group_arns)
|
872
|
+
include Aws::Structure
|
873
|
+
end
|
874
|
+
|
875
|
+
# @!attribute [rw] resource_groups
|
876
|
+
# Information about a resource group.
|
877
|
+
# @return [Array<Types::ResourceGroup>]
|
878
|
+
#
|
879
|
+
# @!attribute [rw] failed_items
|
880
|
+
# Resource group details that cannot be described. An error code is
|
881
|
+
# provided for each failed item.
|
882
|
+
# @return [Hash<String,Types::FailedItemDetails>]
|
883
|
+
class DescribeResourceGroupsResponse < Struct.new(
|
884
|
+
:resource_groups,
|
885
|
+
:failed_items)
|
886
|
+
include Aws::Structure
|
887
|
+
end
|
888
|
+
|
889
|
+
# @note When making an API call, pass DescribeRulesPackagesRequest
|
890
|
+
# data as a hash:
|
891
|
+
#
|
892
|
+
# {
|
893
|
+
# rules_package_arns: ["Arn"], # required
|
894
|
+
# locale: "EN_US", # accepts EN_US
|
895
|
+
# }
|
896
|
+
# @!attribute [rw] rules_package_arns
|
897
|
+
# The ARN that specifies the rules package that you want to describe.
|
898
|
+
# @return [Array<String>]
|
899
|
+
#
|
900
|
+
# @!attribute [rw] locale
|
901
|
+
# The locale that you want to translate a rules package description
|
902
|
+
# into.
|
903
|
+
# @return [String]
|
904
|
+
class DescribeRulesPackagesRequest < Struct.new(
|
905
|
+
:rules_package_arns,
|
906
|
+
:locale)
|
907
|
+
include Aws::Structure
|
908
|
+
end
|
909
|
+
|
910
|
+
# @!attribute [rw] rules_packages
|
911
|
+
# Information about the rules package.
|
912
|
+
# @return [Array<Types::RulesPackage>]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] failed_items
|
915
|
+
# Rules package details that cannot be described. An error code is
|
916
|
+
# provided for each failed item.
|
917
|
+
# @return [Hash<String,Types::FailedItemDetails>]
|
918
|
+
class DescribeRulesPackagesResponse < Struct.new(
|
919
|
+
:rules_packages,
|
920
|
+
:failed_items)
|
921
|
+
include Aws::Structure
|
922
|
+
end
|
923
|
+
|
924
|
+
# This data type is used in the AssessmentTemplateFilter data type.
|
925
|
+
# @note When making an API call, pass DurationRange
|
926
|
+
# data as a hash:
|
927
|
+
#
|
928
|
+
# {
|
929
|
+
# min_seconds: 1,
|
930
|
+
# max_seconds: 1,
|
931
|
+
# }
|
932
|
+
# @!attribute [rw] min_seconds
|
933
|
+
# The minimum value of the duration range. Must be greater than zero.
|
934
|
+
# @return [Integer]
|
935
|
+
#
|
936
|
+
# @!attribute [rw] max_seconds
|
937
|
+
# The maximum value of the duration range. Must be less than or equal
|
938
|
+
# to 604800 seconds (1 week).
|
939
|
+
# @return [Integer]
|
940
|
+
class DurationRange < Struct.new(
|
941
|
+
:min_seconds,
|
942
|
+
:max_seconds)
|
943
|
+
include Aws::Structure
|
944
|
+
end
|
945
|
+
|
946
|
+
# This data type is used in the Subscription data type.
|
947
|
+
# @!attribute [rw] event
|
948
|
+
# The event for which Amazon Simple Notification Service (SNS)
|
949
|
+
# notifications are sent.
|
950
|
+
# @return [String]
|
951
|
+
#
|
952
|
+
# @!attribute [rw] subscribed_at
|
953
|
+
# The time at which SubscribeToEvent is called.
|
954
|
+
# @return [Time]
|
955
|
+
class EventSubscription < Struct.new(
|
956
|
+
:event,
|
957
|
+
:subscribed_at)
|
958
|
+
include Aws::Structure
|
959
|
+
end
|
960
|
+
|
961
|
+
# Includes details about the failed items.
|
962
|
+
# @!attribute [rw] failure_code
|
963
|
+
# The status code of a failed item.
|
964
|
+
# @return [String]
|
965
|
+
#
|
966
|
+
# @!attribute [rw] retryable
|
967
|
+
# Indicates whether you can immediately retry a request for this item
|
968
|
+
# for a specified resource.
|
969
|
+
# @return [Boolean]
|
970
|
+
class FailedItemDetails < Struct.new(
|
971
|
+
:failure_code,
|
972
|
+
:retryable)
|
973
|
+
include Aws::Structure
|
974
|
+
end
|
975
|
+
|
976
|
+
# Contains information about an Amazon Inspector finding. This data type
|
977
|
+
# is used as the response element in the DescribeFindings action.
|
978
|
+
# @!attribute [rw] arn
|
979
|
+
# The ARN that specifies the finding.
|
980
|
+
# @return [String]
|
981
|
+
#
|
982
|
+
# @!attribute [rw] schema_version
|
983
|
+
# The schema version of this data type.
|
984
|
+
# @return [Integer]
|
985
|
+
#
|
986
|
+
# @!attribute [rw] service
|
987
|
+
# The data element is set to "Inspector".
|
988
|
+
# @return [String]
|
989
|
+
#
|
990
|
+
# @!attribute [rw] service_attributes
|
991
|
+
# This data type is used in the Finding data type.
|
992
|
+
# @return [Types::InspectorServiceAttributes]
|
993
|
+
#
|
994
|
+
# @!attribute [rw] asset_type
|
995
|
+
# The type of the host from which the finding is generated.
|
996
|
+
# @return [String]
|
997
|
+
#
|
998
|
+
# @!attribute [rw] asset_attributes
|
999
|
+
# A collection of attributes of the host from which the finding is
|
1000
|
+
# generated.
|
1001
|
+
# @return [Types::AssetAttributes]
|
1002
|
+
#
|
1003
|
+
# @!attribute [rw] id
|
1004
|
+
# The ID of the finding.
|
1005
|
+
# @return [String]
|
1006
|
+
#
|
1007
|
+
# @!attribute [rw] title
|
1008
|
+
# The name of the finding.
|
1009
|
+
# @return [String]
|
1010
|
+
#
|
1011
|
+
# @!attribute [rw] description
|
1012
|
+
# The description of the finding.
|
1013
|
+
# @return [String]
|
1014
|
+
#
|
1015
|
+
# @!attribute [rw] recommendation
|
1016
|
+
# The recommendation for the finding.
|
1017
|
+
# @return [String]
|
1018
|
+
#
|
1019
|
+
# @!attribute [rw] severity
|
1020
|
+
# The finding severity. Values can be set to High, Medium, Low, and
|
1021
|
+
# Informational.
|
1022
|
+
# @return [String]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] numeric_severity
|
1025
|
+
# The numeric value of the finding severity.
|
1026
|
+
# @return [Float]
|
1027
|
+
#
|
1028
|
+
# @!attribute [rw] confidence
|
1029
|
+
# This data element is currently not used.
|
1030
|
+
# @return [Integer]
|
1031
|
+
#
|
1032
|
+
# @!attribute [rw] indicator_of_compromise
|
1033
|
+
# This data element is currently not used.
|
1034
|
+
# @return [Boolean]
|
1035
|
+
#
|
1036
|
+
# @!attribute [rw] attributes
|
1037
|
+
# The system-defined attributes for the finding.
|
1038
|
+
# @return [Array<Types::Attribute>]
|
1039
|
+
#
|
1040
|
+
# @!attribute [rw] user_attributes
|
1041
|
+
# The user-defined attributes that are assigned to the finding.
|
1042
|
+
# @return [Array<Types::Attribute>]
|
1043
|
+
#
|
1044
|
+
# @!attribute [rw] created_at
|
1045
|
+
# The time when the finding was generated.
|
1046
|
+
# @return [Time]
|
1047
|
+
#
|
1048
|
+
# @!attribute [rw] updated_at
|
1049
|
+
# The time when AddAttributesToFindings is called.
|
1050
|
+
# @return [Time]
|
1051
|
+
class Finding < Struct.new(
|
1052
|
+
:arn,
|
1053
|
+
:schema_version,
|
1054
|
+
:service,
|
1055
|
+
:service_attributes,
|
1056
|
+
:asset_type,
|
1057
|
+
:asset_attributes,
|
1058
|
+
:id,
|
1059
|
+
:title,
|
1060
|
+
:description,
|
1061
|
+
:recommendation,
|
1062
|
+
:severity,
|
1063
|
+
:numeric_severity,
|
1064
|
+
:confidence,
|
1065
|
+
:indicator_of_compromise,
|
1066
|
+
:attributes,
|
1067
|
+
:user_attributes,
|
1068
|
+
:created_at,
|
1069
|
+
:updated_at)
|
1070
|
+
include Aws::Structure
|
1071
|
+
end
|
1072
|
+
|
1073
|
+
# This data type is used as a request parameter in the ListFindings
|
1074
|
+
# action.
|
1075
|
+
# @note When making an API call, pass FindingFilter
|
1076
|
+
# data as a hash:
|
1077
|
+
#
|
1078
|
+
# {
|
1079
|
+
# agent_ids: ["AgentId"],
|
1080
|
+
# auto_scaling_groups: ["AutoScalingGroup"],
|
1081
|
+
# rule_names: ["RuleName"],
|
1082
|
+
# severities: ["Low"], # accepts Low, Medium, High, Informational, Undefined
|
1083
|
+
# rules_package_arns: ["Arn"],
|
1084
|
+
# attributes: [
|
1085
|
+
# {
|
1086
|
+
# key: "AttributeKey", # required
|
1087
|
+
# value: "AttributeValue",
|
1088
|
+
# },
|
1089
|
+
# ],
|
1090
|
+
# user_attributes: [
|
1091
|
+
# {
|
1092
|
+
# key: "AttributeKey", # required
|
1093
|
+
# value: "AttributeValue",
|
1094
|
+
# },
|
1095
|
+
# ],
|
1096
|
+
# creation_time_range: {
|
1097
|
+
# begin_date: Time.now,
|
1098
|
+
# end_date: Time.now,
|
1099
|
+
# },
|
1100
|
+
# }
|
1101
|
+
# @!attribute [rw] agent_ids
|
1102
|
+
# For a record to match a filter, one of the values that is specified
|
1103
|
+
# for this data type property must be the exact match of the value of
|
1104
|
+
# the **agentId** property of the Finding data type.
|
1105
|
+
# @return [Array<String>]
|
1106
|
+
#
|
1107
|
+
# @!attribute [rw] auto_scaling_groups
|
1108
|
+
# For a record to match a filter, one of the values that is specified
|
1109
|
+
# for this data type property must be the exact match of the value of
|
1110
|
+
# the **autoScalingGroup** property of the Finding data type.
|
1111
|
+
# @return [Array<String>]
|
1112
|
+
#
|
1113
|
+
# @!attribute [rw] rule_names
|
1114
|
+
# For a record to match a filter, one of the values that is specified
|
1115
|
+
# for this data type property must be the exact match of the value of
|
1116
|
+
# the **ruleName** property of the Finding data type.
|
1117
|
+
# @return [Array<String>]
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] severities
|
1120
|
+
# For a record to match a filter, one of the values that is specified
|
1121
|
+
# for this data type property must be the exact match of the value of
|
1122
|
+
# the **severity** property of the Finding data type.
|
1123
|
+
# @return [Array<String>]
|
1124
|
+
#
|
1125
|
+
# @!attribute [rw] rules_package_arns
|
1126
|
+
# For a record to match a filter, one of the values that is specified
|
1127
|
+
# for this data type property must be the exact match of the value of
|
1128
|
+
# the **rulesPackageArn** property of the Finding data type.
|
1129
|
+
# @return [Array<String>]
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] attributes
|
1132
|
+
# For a record to match a filter, the list of values that are
|
1133
|
+
# specified for this data type property must be contained in the list
|
1134
|
+
# of values of the **attributes** property of the Finding data type.
|
1135
|
+
# @return [Array<Types::Attribute>]
|
1136
|
+
#
|
1137
|
+
# @!attribute [rw] user_attributes
|
1138
|
+
# For a record to match a filter, the value that is specified for this
|
1139
|
+
# data type property must be contained in the list of values of the
|
1140
|
+
# **userAttributes** property of the Finding data type.
|
1141
|
+
# @return [Array<Types::Attribute>]
|
1142
|
+
#
|
1143
|
+
# @!attribute [rw] creation_time_range
|
1144
|
+
# The time range during which the finding is generated.
|
1145
|
+
# @return [Types::TimestampRange]
|
1146
|
+
class FindingFilter < Struct.new(
|
1147
|
+
:agent_ids,
|
1148
|
+
:auto_scaling_groups,
|
1149
|
+
:rule_names,
|
1150
|
+
:severities,
|
1151
|
+
:rules_package_arns,
|
1152
|
+
:attributes,
|
1153
|
+
:user_attributes,
|
1154
|
+
:creation_time_range)
|
1155
|
+
include Aws::Structure
|
1156
|
+
end
|
1157
|
+
|
1158
|
+
# @note When making an API call, pass GetTelemetryMetadataRequest
|
1159
|
+
# data as a hash:
|
1160
|
+
#
|
1161
|
+
# {
|
1162
|
+
# assessment_run_arn: "Arn", # required
|
1163
|
+
# }
|
1164
|
+
# @!attribute [rw] assessment_run_arn
|
1165
|
+
# The ARN that specifies the assessment run that has the telemetry
|
1166
|
+
# data that you want to obtain.
|
1167
|
+
# @return [String]
|
1168
|
+
class GetTelemetryMetadataRequest < Struct.new(
|
1169
|
+
:assessment_run_arn)
|
1170
|
+
include Aws::Structure
|
1171
|
+
end
|
1172
|
+
|
1173
|
+
# @!attribute [rw] telemetry_metadata
|
1174
|
+
# Telemetry details.
|
1175
|
+
# @return [Array<Types::TelemetryMetadata>]
|
1176
|
+
class GetTelemetryMetadataResponse < Struct.new(
|
1177
|
+
:telemetry_metadata)
|
1178
|
+
include Aws::Structure
|
1179
|
+
end
|
1180
|
+
|
1181
|
+
# This data type is used in the Finding data type.
|
1182
|
+
# @!attribute [rw] schema_version
|
1183
|
+
# The schema version of this data type.
|
1184
|
+
# @return [Integer]
|
1185
|
+
#
|
1186
|
+
# @!attribute [rw] assessment_run_arn
|
1187
|
+
# The ARN of the assessment run during which the finding is generated.
|
1188
|
+
# @return [String]
|
1189
|
+
#
|
1190
|
+
# @!attribute [rw] rules_package_arn
|
1191
|
+
# The ARN of the rules package that is used to generate the finding.
|
1192
|
+
# @return [String]
|
1193
|
+
class InspectorServiceAttributes < Struct.new(
|
1194
|
+
:schema_version,
|
1195
|
+
:assessment_run_arn,
|
1196
|
+
:rules_package_arn)
|
1197
|
+
include Aws::Structure
|
1198
|
+
end
|
1199
|
+
|
1200
|
+
# @note When making an API call, pass ListAssessmentRunAgentsRequest
|
1201
|
+
# data as a hash:
|
1202
|
+
#
|
1203
|
+
# {
|
1204
|
+
# assessment_run_arn: "Arn", # required
|
1205
|
+
# filter: {
|
1206
|
+
# agent_healths: ["HEALTHY"], # required, accepts HEALTHY, UNHEALTHY
|
1207
|
+
# agent_health_codes: ["IDLE"], # required, accepts IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, UNKNOWN
|
1208
|
+
# },
|
1209
|
+
# next_token: "PaginationToken",
|
1210
|
+
# max_results: 1,
|
1211
|
+
# }
|
1212
|
+
# @!attribute [rw] assessment_run_arn
|
1213
|
+
# The ARN that specifies the assessment run whose agents you want to
|
1214
|
+
# list.
|
1215
|
+
# @return [String]
|
1216
|
+
#
|
1217
|
+
# @!attribute [rw] filter
|
1218
|
+
# You can use this parameter to specify a subset of data to be
|
1219
|
+
# included in the action's response.
|
1220
|
+
#
|
1221
|
+
# For a record to match a filter, all specified filter attributes must
|
1222
|
+
# match. When multiple values are specified for a filter attribute,
|
1223
|
+
# any of the values can match.
|
1224
|
+
# @return [Types::AgentFilter]
|
1225
|
+
#
|
1226
|
+
# @!attribute [rw] next_token
|
1227
|
+
# You can use this parameter when paginating results. Set the value of
|
1228
|
+
# this parameter to null on your first call to the
|
1229
|
+
# **ListAssessmentRunAgents** action. Subsequent calls to the action
|
1230
|
+
# fill **nextToken** in the request with the value of **NextToken**
|
1231
|
+
# from the previous response to continue listing data.
|
1232
|
+
# @return [String]
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] max_results
|
1235
|
+
# You can use this parameter to indicate the maximum number of items
|
1236
|
+
# that you want in the response. The default value is 10. The maximum
|
1237
|
+
# value is 500.
|
1238
|
+
# @return [Integer]
|
1239
|
+
class ListAssessmentRunAgentsRequest < Struct.new(
|
1240
|
+
:assessment_run_arn,
|
1241
|
+
:filter,
|
1242
|
+
:next_token,
|
1243
|
+
:max_results)
|
1244
|
+
include Aws::Structure
|
1245
|
+
end
|
1246
|
+
|
1247
|
+
# @!attribute [rw] assessment_run_agents
|
1248
|
+
# A list of ARNs that specifies the agents returned by the action.
|
1249
|
+
# @return [Array<Types::AssessmentRunAgent>]
|
1250
|
+
#
|
1251
|
+
# @!attribute [rw] next_token
|
1252
|
+
# When a response is generated, if there is more data to be listed,
|
1253
|
+
# this parameter is present in the response and contains the value to
|
1254
|
+
# use for the **nextToken** parameter in a subsequent pagination
|
1255
|
+
# request. If there is no more data to be listed, this parameter is
|
1256
|
+
# set to null.
|
1257
|
+
# @return [String]
|
1258
|
+
class ListAssessmentRunAgentsResponse < Struct.new(
|
1259
|
+
:assessment_run_agents,
|
1260
|
+
:next_token)
|
1261
|
+
include Aws::Structure
|
1262
|
+
end
|
1263
|
+
|
1264
|
+
# @note When making an API call, pass ListAssessmentRunsRequest
|
1265
|
+
# data as a hash:
|
1266
|
+
#
|
1267
|
+
# {
|
1268
|
+
# assessment_template_arns: ["Arn"],
|
1269
|
+
# filter: {
|
1270
|
+
# name_pattern: "NamePattern",
|
1271
|
+
# states: ["CREATED"], # accepts CREATED, START_DATA_COLLECTION_PENDING, START_DATA_COLLECTION_IN_PROGRESS, COLLECTING_DATA, STOP_DATA_COLLECTION_PENDING, DATA_COLLECTED, EVALUATING_RULES, FAILED, COMPLETED, COMPLETED_WITH_ERRORS
|
1272
|
+
# duration_range: {
|
1273
|
+
# min_seconds: 1,
|
1274
|
+
# max_seconds: 1,
|
1275
|
+
# },
|
1276
|
+
# rules_package_arns: ["Arn"],
|
1277
|
+
# start_time_range: {
|
1278
|
+
# begin_date: Time.now,
|
1279
|
+
# end_date: Time.now,
|
1280
|
+
# },
|
1281
|
+
# completion_time_range: {
|
1282
|
+
# begin_date: Time.now,
|
1283
|
+
# end_date: Time.now,
|
1284
|
+
# },
|
1285
|
+
# state_change_time_range: {
|
1286
|
+
# begin_date: Time.now,
|
1287
|
+
# end_date: Time.now,
|
1288
|
+
# },
|
1289
|
+
# },
|
1290
|
+
# next_token: "PaginationToken",
|
1291
|
+
# max_results: 1,
|
1292
|
+
# }
|
1293
|
+
# @!attribute [rw] assessment_template_arns
|
1294
|
+
# The ARNs that specify the assessment templates whose assessment runs
|
1295
|
+
# you want to list.
|
1296
|
+
# @return [Array<String>]
|
1297
|
+
#
|
1298
|
+
# @!attribute [rw] filter
|
1299
|
+
# You can use this parameter to specify a subset of data to be
|
1300
|
+
# included in the action's response.
|
1301
|
+
#
|
1302
|
+
# For a record to match a filter, all specified filter attributes must
|
1303
|
+
# match. When multiple values are specified for a filter attribute,
|
1304
|
+
# any of the values can match.
|
1305
|
+
# @return [Types::AssessmentRunFilter]
|
1306
|
+
#
|
1307
|
+
# @!attribute [rw] next_token
|
1308
|
+
# You can use this parameter when paginating results. Set the value of
|
1309
|
+
# this parameter to null on your first call to the
|
1310
|
+
# **ListAssessmentRuns** action. Subsequent calls to the action fill
|
1311
|
+
# **nextToken** in the request with the value of **NextToken** from
|
1312
|
+
# the previous response to continue listing data.
|
1313
|
+
# @return [String]
|
1314
|
+
#
|
1315
|
+
# @!attribute [rw] max_results
|
1316
|
+
# You can use this parameter to indicate the maximum number of items
|
1317
|
+
# that you want in the response. The default value is 10. The maximum
|
1318
|
+
# value is 500.
|
1319
|
+
# @return [Integer]
|
1320
|
+
class ListAssessmentRunsRequest < Struct.new(
|
1321
|
+
:assessment_template_arns,
|
1322
|
+
:filter,
|
1323
|
+
:next_token,
|
1324
|
+
:max_results)
|
1325
|
+
include Aws::Structure
|
1326
|
+
end
|
1327
|
+
|
1328
|
+
# @!attribute [rw] assessment_run_arns
|
1329
|
+
# A list of ARNs that specifies the assessment runs that are returned
|
1330
|
+
# by the action.
|
1331
|
+
# @return [Array<String>]
|
1332
|
+
#
|
1333
|
+
# @!attribute [rw] next_token
|
1334
|
+
# When a response is generated, if there is more data to be listed,
|
1335
|
+
# this parameter is present in the response and contains the value to
|
1336
|
+
# use for the **nextToken** parameter in a subsequent pagination
|
1337
|
+
# request. If there is no more data to be listed, this parameter is
|
1338
|
+
# set to null.
|
1339
|
+
# @return [String]
|
1340
|
+
class ListAssessmentRunsResponse < Struct.new(
|
1341
|
+
:assessment_run_arns,
|
1342
|
+
:next_token)
|
1343
|
+
include Aws::Structure
|
1344
|
+
end
|
1345
|
+
|
1346
|
+
# @note When making an API call, pass ListAssessmentTargetsRequest
|
1347
|
+
# data as a hash:
|
1348
|
+
#
|
1349
|
+
# {
|
1350
|
+
# filter: {
|
1351
|
+
# assessment_target_name_pattern: "NamePattern",
|
1352
|
+
# },
|
1353
|
+
# next_token: "PaginationToken",
|
1354
|
+
# max_results: 1,
|
1355
|
+
# }
|
1356
|
+
# @!attribute [rw] filter
|
1357
|
+
# You can use this parameter to specify a subset of data to be
|
1358
|
+
# included in the action's response.
|
1359
|
+
#
|
1360
|
+
# For a record to match a filter, all specified filter attributes must
|
1361
|
+
# match. When multiple values are specified for a filter attribute,
|
1362
|
+
# any of the values can match.
|
1363
|
+
# @return [Types::AssessmentTargetFilter]
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] next_token
|
1366
|
+
# You can use this parameter when paginating results. Set the value of
|
1367
|
+
# this parameter to null on your first call to the
|
1368
|
+
# **ListAssessmentTargets** action. Subsequent calls to the action
|
1369
|
+
# fill **nextToken** in the request with the value of **NextToken**
|
1370
|
+
# from the previous response to continue listing data.
|
1371
|
+
# @return [String]
|
1372
|
+
#
|
1373
|
+
# @!attribute [rw] max_results
|
1374
|
+
# You can use this parameter to indicate the maximum number of items
|
1375
|
+
# you want in the response. The default value is 10. The maximum value
|
1376
|
+
# is 500.
|
1377
|
+
# @return [Integer]
|
1378
|
+
class ListAssessmentTargetsRequest < Struct.new(
|
1379
|
+
:filter,
|
1380
|
+
:next_token,
|
1381
|
+
:max_results)
|
1382
|
+
include Aws::Structure
|
1383
|
+
end
|
1384
|
+
|
1385
|
+
# @!attribute [rw] assessment_target_arns
|
1386
|
+
# A list of ARNs that specifies the assessment targets that are
|
1387
|
+
# returned by the action.
|
1388
|
+
# @return [Array<String>]
|
1389
|
+
#
|
1390
|
+
# @!attribute [rw] next_token
|
1391
|
+
# When a response is generated, if there is more data to be listed,
|
1392
|
+
# this parameter is present in the response and contains the value to
|
1393
|
+
# use for the **nextToken** parameter in a subsequent pagination
|
1394
|
+
# request. If there is no more data to be listed, this parameter is
|
1395
|
+
# set to null.
|
1396
|
+
# @return [String]
|
1397
|
+
class ListAssessmentTargetsResponse < Struct.new(
|
1398
|
+
:assessment_target_arns,
|
1399
|
+
:next_token)
|
1400
|
+
include Aws::Structure
|
1401
|
+
end
|
1402
|
+
|
1403
|
+
# @note When making an API call, pass ListAssessmentTemplatesRequest
|
1404
|
+
# data as a hash:
|
1405
|
+
#
|
1406
|
+
# {
|
1407
|
+
# assessment_target_arns: ["Arn"],
|
1408
|
+
# filter: {
|
1409
|
+
# name_pattern: "NamePattern",
|
1410
|
+
# duration_range: {
|
1411
|
+
# min_seconds: 1,
|
1412
|
+
# max_seconds: 1,
|
1413
|
+
# },
|
1414
|
+
# rules_package_arns: ["Arn"],
|
1415
|
+
# },
|
1416
|
+
# next_token: "PaginationToken",
|
1417
|
+
# max_results: 1,
|
1418
|
+
# }
|
1419
|
+
# @!attribute [rw] assessment_target_arns
|
1420
|
+
# A list of ARNs that specifies the assessment targets whose
|
1421
|
+
# assessment templates you want to list.
|
1422
|
+
# @return [Array<String>]
|
1423
|
+
#
|
1424
|
+
# @!attribute [rw] filter
|
1425
|
+
# You can use this parameter to specify a subset of data to be
|
1426
|
+
# included in the action's response.
|
1427
|
+
#
|
1428
|
+
# For a record to match a filter, all specified filter attributes must
|
1429
|
+
# match. When multiple values are specified for a filter attribute,
|
1430
|
+
# any of the values can match.
|
1431
|
+
# @return [Types::AssessmentTemplateFilter]
|
1432
|
+
#
|
1433
|
+
# @!attribute [rw] next_token
|
1434
|
+
# You can use this parameter when paginating results. Set the value of
|
1435
|
+
# this parameter to null on your first call to the
|
1436
|
+
# **ListAssessmentTemplates** action. Subsequent calls to the action
|
1437
|
+
# fill **nextToken** in the request with the value of **NextToken**
|
1438
|
+
# from the previous response to continue listing data.
|
1439
|
+
# @return [String]
|
1440
|
+
#
|
1441
|
+
# @!attribute [rw] max_results
|
1442
|
+
# You can use this parameter to indicate the maximum number of items
|
1443
|
+
# you want in the response. The default value is 10. The maximum value
|
1444
|
+
# is 500.
|
1445
|
+
# @return [Integer]
|
1446
|
+
class ListAssessmentTemplatesRequest < Struct.new(
|
1447
|
+
:assessment_target_arns,
|
1448
|
+
:filter,
|
1449
|
+
:next_token,
|
1450
|
+
:max_results)
|
1451
|
+
include Aws::Structure
|
1452
|
+
end
|
1453
|
+
|
1454
|
+
# @!attribute [rw] assessment_template_arns
|
1455
|
+
# A list of ARNs that specifies the assessment templates returned by
|
1456
|
+
# the action.
|
1457
|
+
# @return [Array<String>]
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] next_token
|
1460
|
+
# When a response is generated, if there is more data to be listed,
|
1461
|
+
# this parameter is present in the response and contains the value to
|
1462
|
+
# use for the **nextToken** parameter in a subsequent pagination
|
1463
|
+
# request. If there is no more data to be listed, this parameter is
|
1464
|
+
# set to null.
|
1465
|
+
# @return [String]
|
1466
|
+
class ListAssessmentTemplatesResponse < Struct.new(
|
1467
|
+
:assessment_template_arns,
|
1468
|
+
:next_token)
|
1469
|
+
include Aws::Structure
|
1470
|
+
end
|
1471
|
+
|
1472
|
+
# @note When making an API call, pass ListEventSubscriptionsRequest
|
1473
|
+
# data as a hash:
|
1474
|
+
#
|
1475
|
+
# {
|
1476
|
+
# resource_arn: "Arn",
|
1477
|
+
# next_token: "PaginationToken",
|
1478
|
+
# max_results: 1,
|
1479
|
+
# }
|
1480
|
+
# @!attribute [rw] resource_arn
|
1481
|
+
# The ARN of the assessment template for which you want to list the
|
1482
|
+
# existing event subscriptions.
|
1483
|
+
# @return [String]
|
1484
|
+
#
|
1485
|
+
# @!attribute [rw] next_token
|
1486
|
+
# You can use this parameter when paginating results. Set the value of
|
1487
|
+
# this parameter to null on your first call to the
|
1488
|
+
# **ListEventSubscriptions** action. Subsequent calls to the action
|
1489
|
+
# fill **nextToken** in the request with the value of **NextToken**
|
1490
|
+
# from the previous response to continue listing data.
|
1491
|
+
# @return [String]
|
1492
|
+
#
|
1493
|
+
# @!attribute [rw] max_results
|
1494
|
+
# You can use this parameter to indicate the maximum number of items
|
1495
|
+
# you want in the response. The default value is 10. The maximum value
|
1496
|
+
# is 500.
|
1497
|
+
# @return [Integer]
|
1498
|
+
class ListEventSubscriptionsRequest < Struct.new(
|
1499
|
+
:resource_arn,
|
1500
|
+
:next_token,
|
1501
|
+
:max_results)
|
1502
|
+
include Aws::Structure
|
1503
|
+
end
|
1504
|
+
|
1505
|
+
# @!attribute [rw] subscriptions
|
1506
|
+
# Details of the returned event subscriptions.
|
1507
|
+
# @return [Array<Types::Subscription>]
|
1508
|
+
#
|
1509
|
+
# @!attribute [rw] next_token
|
1510
|
+
# When a response is generated, if there is more data to be listed,
|
1511
|
+
# this parameter is present in the response and contains the value to
|
1512
|
+
# use for the **nextToken** parameter in a subsequent pagination
|
1513
|
+
# request. If there is no more data to be listed, this parameter is
|
1514
|
+
# set to null.
|
1515
|
+
# @return [String]
|
1516
|
+
class ListEventSubscriptionsResponse < Struct.new(
|
1517
|
+
:subscriptions,
|
1518
|
+
:next_token)
|
1519
|
+
include Aws::Structure
|
1520
|
+
end
|
1521
|
+
|
1522
|
+
# @note When making an API call, pass ListFindingsRequest
|
1523
|
+
# data as a hash:
|
1524
|
+
#
|
1525
|
+
# {
|
1526
|
+
# assessment_run_arns: ["Arn"],
|
1527
|
+
# filter: {
|
1528
|
+
# agent_ids: ["AgentId"],
|
1529
|
+
# auto_scaling_groups: ["AutoScalingGroup"],
|
1530
|
+
# rule_names: ["RuleName"],
|
1531
|
+
# severities: ["Low"], # accepts Low, Medium, High, Informational, Undefined
|
1532
|
+
# rules_package_arns: ["Arn"],
|
1533
|
+
# attributes: [
|
1534
|
+
# {
|
1535
|
+
# key: "AttributeKey", # required
|
1536
|
+
# value: "AttributeValue",
|
1537
|
+
# },
|
1538
|
+
# ],
|
1539
|
+
# user_attributes: [
|
1540
|
+
# {
|
1541
|
+
# key: "AttributeKey", # required
|
1542
|
+
# value: "AttributeValue",
|
1543
|
+
# },
|
1544
|
+
# ],
|
1545
|
+
# creation_time_range: {
|
1546
|
+
# begin_date: Time.now,
|
1547
|
+
# end_date: Time.now,
|
1548
|
+
# },
|
1549
|
+
# },
|
1550
|
+
# next_token: "PaginationToken",
|
1551
|
+
# max_results: 1,
|
1552
|
+
# }
|
1553
|
+
# @!attribute [rw] assessment_run_arns
|
1554
|
+
# The ARNs of the assessment runs that generate the findings that you
|
1555
|
+
# want to list.
|
1556
|
+
# @return [Array<String>]
|
1557
|
+
#
|
1558
|
+
# @!attribute [rw] filter
|
1559
|
+
# You can use this parameter to specify a subset of data to be
|
1560
|
+
# included in the action's response.
|
1561
|
+
#
|
1562
|
+
# For a record to match a filter, all specified filter attributes must
|
1563
|
+
# match. When multiple values are specified for a filter attribute,
|
1564
|
+
# any of the values can match.
|
1565
|
+
# @return [Types::FindingFilter]
|
1566
|
+
#
|
1567
|
+
# @!attribute [rw] next_token
|
1568
|
+
# You can use this parameter when paginating results. Set the value of
|
1569
|
+
# this parameter to null on your first call to the **ListFindings**
|
1570
|
+
# action. Subsequent calls to the action fill **nextToken** in the
|
1571
|
+
# request with the value of **NextToken** from the previous response
|
1572
|
+
# to continue listing data.
|
1573
|
+
# @return [String]
|
1574
|
+
#
|
1575
|
+
# @!attribute [rw] max_results
|
1576
|
+
# You can use this parameter to indicate the maximum number of items
|
1577
|
+
# you want in the response. The default value is 10. The maximum value
|
1578
|
+
# is 500.
|
1579
|
+
# @return [Integer]
|
1580
|
+
class ListFindingsRequest < Struct.new(
|
1581
|
+
:assessment_run_arns,
|
1582
|
+
:filter,
|
1583
|
+
:next_token,
|
1584
|
+
:max_results)
|
1585
|
+
include Aws::Structure
|
1586
|
+
end
|
1587
|
+
|
1588
|
+
# @!attribute [rw] finding_arns
|
1589
|
+
# A list of ARNs that specifies the findings returned by the action.
|
1590
|
+
# @return [Array<String>]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] next_token
|
1593
|
+
# When a response is generated, if there is more data to be listed,
|
1594
|
+
# this parameter is present in the response and contains the value to
|
1595
|
+
# use for the **nextToken** parameter in a subsequent pagination
|
1596
|
+
# request. If there is no more data to be listed, this parameter is
|
1597
|
+
# set to null.
|
1598
|
+
# @return [String]
|
1599
|
+
class ListFindingsResponse < Struct.new(
|
1600
|
+
:finding_arns,
|
1601
|
+
:next_token)
|
1602
|
+
include Aws::Structure
|
1603
|
+
end
|
1604
|
+
|
1605
|
+
# @note When making an API call, pass ListRulesPackagesRequest
|
1606
|
+
# data as a hash:
|
1607
|
+
#
|
1608
|
+
# {
|
1609
|
+
# next_token: "PaginationToken",
|
1610
|
+
# max_results: 1,
|
1611
|
+
# }
|
1612
|
+
# @!attribute [rw] next_token
|
1613
|
+
# You can use this parameter when paginating results. Set the value of
|
1614
|
+
# this parameter to null on your first call to the
|
1615
|
+
# **ListRulesPackages** action. Subsequent calls to the action fill
|
1616
|
+
# **nextToken** in the request with the value of **NextToken** from
|
1617
|
+
# the previous response to continue listing data.
|
1618
|
+
# @return [String]
|
1619
|
+
#
|
1620
|
+
# @!attribute [rw] max_results
|
1621
|
+
# You can use this parameter to indicate the maximum number of items
|
1622
|
+
# you want in the response. The default value is 10. The maximum value
|
1623
|
+
# is 500.
|
1624
|
+
# @return [Integer]
|
1625
|
+
class ListRulesPackagesRequest < Struct.new(
|
1626
|
+
:next_token,
|
1627
|
+
:max_results)
|
1628
|
+
include Aws::Structure
|
1629
|
+
end
|
1630
|
+
|
1631
|
+
# @!attribute [rw] rules_package_arns
|
1632
|
+
# The list of ARNs that specifies the rules packages returned by the
|
1633
|
+
# action.
|
1634
|
+
# @return [Array<String>]
|
1635
|
+
#
|
1636
|
+
# @!attribute [rw] next_token
|
1637
|
+
# When a response is generated, if there is more data to be listed,
|
1638
|
+
# this parameter is present in the response and contains the value to
|
1639
|
+
# use for the **nextToken** parameter in a subsequent pagination
|
1640
|
+
# request. If there is no more data to be listed, this parameter is
|
1641
|
+
# set to null.
|
1642
|
+
# @return [String]
|
1643
|
+
class ListRulesPackagesResponse < Struct.new(
|
1644
|
+
:rules_package_arns,
|
1645
|
+
:next_token)
|
1646
|
+
include Aws::Structure
|
1647
|
+
end
|
1648
|
+
|
1649
|
+
# @note When making an API call, pass ListTagsForResourceRequest
|
1650
|
+
# data as a hash:
|
1651
|
+
#
|
1652
|
+
# {
|
1653
|
+
# resource_arn: "Arn", # required
|
1654
|
+
# }
|
1655
|
+
# @!attribute [rw] resource_arn
|
1656
|
+
# The ARN that specifies the assessment template whose tags you want
|
1657
|
+
# to list.
|
1658
|
+
# @return [String]
|
1659
|
+
class ListTagsForResourceRequest < Struct.new(
|
1660
|
+
:resource_arn)
|
1661
|
+
include Aws::Structure
|
1662
|
+
end
|
1663
|
+
|
1664
|
+
# @!attribute [rw] tags
|
1665
|
+
# A collection of key and value pairs.
|
1666
|
+
# @return [Array<Types::Tag>]
|
1667
|
+
class ListTagsForResourceResponse < Struct.new(
|
1668
|
+
:tags)
|
1669
|
+
include Aws::Structure
|
1670
|
+
end
|
1671
|
+
|
1672
|
+
# @note When making an API call, pass PreviewAgentsRequest
|
1673
|
+
# data as a hash:
|
1674
|
+
#
|
1675
|
+
# {
|
1676
|
+
# preview_agents_arn: "Arn", # required
|
1677
|
+
# next_token: "PaginationToken",
|
1678
|
+
# max_results: 1,
|
1679
|
+
# }
|
1680
|
+
# @!attribute [rw] preview_agents_arn
|
1681
|
+
# The ARN of the assessment target whose agents you want to preview.
|
1682
|
+
# @return [String]
|
1683
|
+
#
|
1684
|
+
# @!attribute [rw] next_token
|
1685
|
+
# You can use this parameter when paginating results. Set the value of
|
1686
|
+
# this parameter to null on your first call to the **PreviewAgents**
|
1687
|
+
# action. Subsequent calls to the action fill **nextToken** in the
|
1688
|
+
# request with the value of **NextToken** from the previous response
|
1689
|
+
# to continue listing data.
|
1690
|
+
# @return [String]
|
1691
|
+
#
|
1692
|
+
# @!attribute [rw] max_results
|
1693
|
+
# You can use this parameter to indicate the maximum number of items
|
1694
|
+
# you want in the response. The default value is 10. The maximum value
|
1695
|
+
# is 500.
|
1696
|
+
# @return [Integer]
|
1697
|
+
class PreviewAgentsRequest < Struct.new(
|
1698
|
+
:preview_agents_arn,
|
1699
|
+
:next_token,
|
1700
|
+
:max_results)
|
1701
|
+
include Aws::Structure
|
1702
|
+
end
|
1703
|
+
|
1704
|
+
# @!attribute [rw] agent_previews
|
1705
|
+
# The resulting list of agents.
|
1706
|
+
# @return [Array<Types::AgentPreview>]
|
1707
|
+
#
|
1708
|
+
# @!attribute [rw] next_token
|
1709
|
+
# When a response is generated, if there is more data to be listed,
|
1710
|
+
# this parameter is present in the response and contains the value to
|
1711
|
+
# use for the **nextToken** parameter in a subsequent pagination
|
1712
|
+
# request. If there is no more data to be listed, this parameter is
|
1713
|
+
# set to null.
|
1714
|
+
# @return [String]
|
1715
|
+
class PreviewAgentsResponse < Struct.new(
|
1716
|
+
:agent_previews,
|
1717
|
+
:next_token)
|
1718
|
+
include Aws::Structure
|
1719
|
+
end
|
1720
|
+
|
1721
|
+
# @note When making an API call, pass RegisterCrossAccountAccessRoleRequest
|
1722
|
+
# data as a hash:
|
1723
|
+
#
|
1724
|
+
# {
|
1725
|
+
# role_arn: "Arn", # required
|
1726
|
+
# }
|
1727
|
+
# @!attribute [rw] role_arn
|
1728
|
+
# The ARN of the IAM role that Amazon Inspector uses to list your EC2
|
1729
|
+
# instances during the assessment run or when you call the
|
1730
|
+
# PreviewAgents action.
|
1731
|
+
# @return [String]
|
1732
|
+
class RegisterCrossAccountAccessRoleRequest < Struct.new(
|
1733
|
+
:role_arn)
|
1734
|
+
include Aws::Structure
|
1735
|
+
end
|
1736
|
+
|
1737
|
+
# @note When making an API call, pass RemoveAttributesFromFindingsRequest
|
1738
|
+
# data as a hash:
|
1739
|
+
#
|
1740
|
+
# {
|
1741
|
+
# finding_arns: ["Arn"], # required
|
1742
|
+
# attribute_keys: ["AttributeKey"], # required
|
1743
|
+
# }
|
1744
|
+
# @!attribute [rw] finding_arns
|
1745
|
+
# The ARNs that specify the findings that you want to remove
|
1746
|
+
# attributes from.
|
1747
|
+
# @return [Array<String>]
|
1748
|
+
#
|
1749
|
+
# @!attribute [rw] attribute_keys
|
1750
|
+
# The array of attribute keys that you want to remove from specified
|
1751
|
+
# findings.
|
1752
|
+
# @return [Array<String>]
|
1753
|
+
class RemoveAttributesFromFindingsRequest < Struct.new(
|
1754
|
+
:finding_arns,
|
1755
|
+
:attribute_keys)
|
1756
|
+
include Aws::Structure
|
1757
|
+
end
|
1758
|
+
|
1759
|
+
# @!attribute [rw] failed_items
|
1760
|
+
# Attributes details that cannot be described. An error code is
|
1761
|
+
# provided for each failed item.
|
1762
|
+
# @return [Hash<String,Types::FailedItemDetails>]
|
1763
|
+
class RemoveAttributesFromFindingsResponse < Struct.new(
|
1764
|
+
:failed_items)
|
1765
|
+
include Aws::Structure
|
1766
|
+
end
|
1767
|
+
|
1768
|
+
# Contains information about a resource group. The resource group
|
1769
|
+
# defines a set of tags that, when queried, identify the AWS resources
|
1770
|
+
# that make up the assessment target. This data type is used as the
|
1771
|
+
# response element in the DescribeResourceGroups action.
|
1772
|
+
# @!attribute [rw] arn
|
1773
|
+
# The ARN of the resource group.
|
1774
|
+
# @return [String]
|
1775
|
+
#
|
1776
|
+
# @!attribute [rw] tags
|
1777
|
+
# The tags (key and value pairs) of the resource group. This data type
|
1778
|
+
# property is used in the CreateResourceGroup action.
|
1779
|
+
# @return [Array<Types::ResourceGroupTag>]
|
1780
|
+
#
|
1781
|
+
# @!attribute [rw] created_at
|
1782
|
+
# The time at which resource group is created.
|
1783
|
+
# @return [Time]
|
1784
|
+
class ResourceGroup < Struct.new(
|
1785
|
+
:arn,
|
1786
|
+
:tags,
|
1787
|
+
:created_at)
|
1788
|
+
include Aws::Structure
|
1789
|
+
end
|
1790
|
+
|
1791
|
+
# This data type is used as one of the elements of the ResourceGroup
|
1792
|
+
# data type.
|
1793
|
+
# @note When making an API call, pass ResourceGroupTag
|
1794
|
+
# data as a hash:
|
1795
|
+
#
|
1796
|
+
# {
|
1797
|
+
# key: "TagKey", # required
|
1798
|
+
# value: "TagValue",
|
1799
|
+
# }
|
1800
|
+
# @!attribute [rw] key
|
1801
|
+
# A tag key.
|
1802
|
+
# @return [String]
|
1803
|
+
#
|
1804
|
+
# @!attribute [rw] value
|
1805
|
+
# The value assigned to a tag key.
|
1806
|
+
# @return [String]
|
1807
|
+
class ResourceGroupTag < Struct.new(
|
1808
|
+
:key,
|
1809
|
+
:value)
|
1810
|
+
include Aws::Structure
|
1811
|
+
end
|
1812
|
+
|
1813
|
+
# Contains information about an Amazon Inspector rules package. This
|
1814
|
+
# data type is used as the response element in the DescribeRulesPackages
|
1815
|
+
# action.
|
1816
|
+
# @!attribute [rw] arn
|
1817
|
+
# The ARN of the rules package.
|
1818
|
+
# @return [String]
|
1819
|
+
#
|
1820
|
+
# @!attribute [rw] name
|
1821
|
+
# The name of the rules package.
|
1822
|
+
# @return [String]
|
1823
|
+
#
|
1824
|
+
# @!attribute [rw] version
|
1825
|
+
# The version ID of the rules package.
|
1826
|
+
# @return [String]
|
1827
|
+
#
|
1828
|
+
# @!attribute [rw] provider
|
1829
|
+
# The provider of the rules package.
|
1830
|
+
# @return [String]
|
1831
|
+
#
|
1832
|
+
# @!attribute [rw] description
|
1833
|
+
# The description of the rules package.
|
1834
|
+
# @return [String]
|
1835
|
+
class RulesPackage < Struct.new(
|
1836
|
+
:arn,
|
1837
|
+
:name,
|
1838
|
+
:version,
|
1839
|
+
:provider,
|
1840
|
+
:description)
|
1841
|
+
include Aws::Structure
|
1842
|
+
end
|
1843
|
+
|
1844
|
+
# @note When making an API call, pass SetTagsForResourceRequest
|
1845
|
+
# data as a hash:
|
1846
|
+
#
|
1847
|
+
# {
|
1848
|
+
# resource_arn: "Arn", # required
|
1849
|
+
# tags: [
|
1850
|
+
# {
|
1851
|
+
# key: "TagKey", # required
|
1852
|
+
# value: "TagValue",
|
1853
|
+
# },
|
1854
|
+
# ],
|
1855
|
+
# }
|
1856
|
+
# @!attribute [rw] resource_arn
|
1857
|
+
# The ARN of the assessment template that you want to set tags to.
|
1858
|
+
# @return [String]
|
1859
|
+
#
|
1860
|
+
# @!attribute [rw] tags
|
1861
|
+
# A collection of key and value pairs that you want to set to the
|
1862
|
+
# assessment template.
|
1863
|
+
# @return [Array<Types::Tag>]
|
1864
|
+
class SetTagsForResourceRequest < Struct.new(
|
1865
|
+
:resource_arn,
|
1866
|
+
:tags)
|
1867
|
+
include Aws::Structure
|
1868
|
+
end
|
1869
|
+
|
1870
|
+
# @note When making an API call, pass StartAssessmentRunRequest
|
1871
|
+
# data as a hash:
|
1872
|
+
#
|
1873
|
+
# {
|
1874
|
+
# assessment_template_arn: "Arn", # required
|
1875
|
+
# assessment_run_name: "AssessmentRunName",
|
1876
|
+
# }
|
1877
|
+
# @!attribute [rw] assessment_template_arn
|
1878
|
+
# The ARN of the assessment template of the assessment run that you
|
1879
|
+
# want to start.
|
1880
|
+
# @return [String]
|
1881
|
+
#
|
1882
|
+
# @!attribute [rw] assessment_run_name
|
1883
|
+
# You can specify the name for the assessment run, or you can use the
|
1884
|
+
# auto-generated name that is based on the assessment template name.
|
1885
|
+
# The name must be unique for the assessment template.
|
1886
|
+
# @return [String]
|
1887
|
+
class StartAssessmentRunRequest < Struct.new(
|
1888
|
+
:assessment_template_arn,
|
1889
|
+
:assessment_run_name)
|
1890
|
+
include Aws::Structure
|
1891
|
+
end
|
1892
|
+
|
1893
|
+
# @!attribute [rw] assessment_run_arn
|
1894
|
+
# The ARN of the assessment run that has been started.
|
1895
|
+
# @return [String]
|
1896
|
+
class StartAssessmentRunResponse < Struct.new(
|
1897
|
+
:assessment_run_arn)
|
1898
|
+
include Aws::Structure
|
1899
|
+
end
|
1900
|
+
|
1901
|
+
# @note When making an API call, pass StopAssessmentRunRequest
|
1902
|
+
# data as a hash:
|
1903
|
+
#
|
1904
|
+
# {
|
1905
|
+
# assessment_run_arn: "Arn", # required
|
1906
|
+
# }
|
1907
|
+
# @!attribute [rw] assessment_run_arn
|
1908
|
+
# The ARN of the assessment run that you want to stop.
|
1909
|
+
# @return [String]
|
1910
|
+
class StopAssessmentRunRequest < Struct.new(
|
1911
|
+
:assessment_run_arn)
|
1912
|
+
include Aws::Structure
|
1913
|
+
end
|
1914
|
+
|
1915
|
+
# @note When making an API call, pass SubscribeToEventRequest
|
1916
|
+
# data as a hash:
|
1917
|
+
#
|
1918
|
+
# {
|
1919
|
+
# resource_arn: "Arn", # required
|
1920
|
+
# event: "ASSESSMENT_RUN_STARTED", # required, accepts ASSESSMENT_RUN_STARTED, ASSESSMENT_RUN_COMPLETED, ASSESSMENT_RUN_STATE_CHANGED, FINDING_REPORTED, OTHER
|
1921
|
+
# topic_arn: "Arn", # required
|
1922
|
+
# }
|
1923
|
+
# @!attribute [rw] resource_arn
|
1924
|
+
# The ARN of the assessment template that is used during the event for
|
1925
|
+
# which you want to receive SNS notifications.
|
1926
|
+
# @return [String]
|
1927
|
+
#
|
1928
|
+
# @!attribute [rw] event
|
1929
|
+
# The event for which you want to receive SNS notifications.
|
1930
|
+
# @return [String]
|
1931
|
+
#
|
1932
|
+
# @!attribute [rw] topic_arn
|
1933
|
+
# The ARN of the SNS topic to which the SNS notifications are sent.
|
1934
|
+
# @return [String]
|
1935
|
+
class SubscribeToEventRequest < Struct.new(
|
1936
|
+
:resource_arn,
|
1937
|
+
:event,
|
1938
|
+
:topic_arn)
|
1939
|
+
include Aws::Structure
|
1940
|
+
end
|
1941
|
+
|
1942
|
+
# This data type is used as a response element in the
|
1943
|
+
# ListEventSubscriptions action.
|
1944
|
+
# @!attribute [rw] resource_arn
|
1945
|
+
# The ARN of the assessment template that is used during the event for
|
1946
|
+
# which the SNS notification is sent.
|
1947
|
+
# @return [String]
|
1948
|
+
#
|
1949
|
+
# @!attribute [rw] topic_arn
|
1950
|
+
# The ARN of the Amazon Simple Notification Service (SNS) topic to
|
1951
|
+
# which the SNS notifications are sent.
|
1952
|
+
# @return [String]
|
1953
|
+
#
|
1954
|
+
# @!attribute [rw] event_subscriptions
|
1955
|
+
# The list of existing event subscriptions.
|
1956
|
+
# @return [Array<Types::EventSubscription>]
|
1957
|
+
class Subscription < Struct.new(
|
1958
|
+
:resource_arn,
|
1959
|
+
:topic_arn,
|
1960
|
+
:event_subscriptions)
|
1961
|
+
include Aws::Structure
|
1962
|
+
end
|
1963
|
+
|
1964
|
+
# A key and value pair. This data type is used as a request parameter in
|
1965
|
+
# the SetTagsForResource action and a response element in the
|
1966
|
+
# ListTagsForResource action.
|
1967
|
+
# @note When making an API call, pass Tag
|
1968
|
+
# data as a hash:
|
1969
|
+
#
|
1970
|
+
# {
|
1971
|
+
# key: "TagKey", # required
|
1972
|
+
# value: "TagValue",
|
1973
|
+
# }
|
1974
|
+
# @!attribute [rw] key
|
1975
|
+
# A tag key.
|
1976
|
+
# @return [String]
|
1977
|
+
#
|
1978
|
+
# @!attribute [rw] value
|
1979
|
+
# A value assigned to a tag key.
|
1980
|
+
# @return [String]
|
1981
|
+
class Tag < Struct.new(
|
1982
|
+
:key,
|
1983
|
+
:value)
|
1984
|
+
include Aws::Structure
|
1985
|
+
end
|
1986
|
+
|
1987
|
+
# The metadata about the Amazon Inspector application data metrics
|
1988
|
+
# collected by the agent. This data type is used as the response element
|
1989
|
+
# in the GetTelemetryMetadata action.
|
1990
|
+
# @!attribute [rw] message_type
|
1991
|
+
# A specific type of behavioral data that is collected by the agent.
|
1992
|
+
# @return [String]
|
1993
|
+
#
|
1994
|
+
# @!attribute [rw] count
|
1995
|
+
# The count of messages that the agent sends to the Amazon Inspector
|
1996
|
+
# service.
|
1997
|
+
# @return [Integer]
|
1998
|
+
#
|
1999
|
+
# @!attribute [rw] data_size
|
2000
|
+
# The data size of messages that the agent sends to the Amazon
|
2001
|
+
# Inspector service.
|
2002
|
+
# @return [Integer]
|
2003
|
+
class TelemetryMetadata < Struct.new(
|
2004
|
+
:message_type,
|
2005
|
+
:count,
|
2006
|
+
:data_size)
|
2007
|
+
include Aws::Structure
|
2008
|
+
end
|
2009
|
+
|
2010
|
+
# This data type is used in the AssessmentRunFilter data type.
|
2011
|
+
# @note When making an API call, pass TimestampRange
|
2012
|
+
# data as a hash:
|
2013
|
+
#
|
2014
|
+
# {
|
2015
|
+
# begin_date: Time.now,
|
2016
|
+
# end_date: Time.now,
|
2017
|
+
# }
|
2018
|
+
# @!attribute [rw] begin_date
|
2019
|
+
# The minimum value of the timestamp range.
|
2020
|
+
# @return [Time]
|
2021
|
+
#
|
2022
|
+
# @!attribute [rw] end_date
|
2023
|
+
# The maximum value of the timestamp range.
|
2024
|
+
# @return [Time]
|
2025
|
+
class TimestampRange < Struct.new(
|
2026
|
+
:begin_date,
|
2027
|
+
:end_date)
|
2028
|
+
include Aws::Structure
|
2029
|
+
end
|
2030
|
+
|
2031
|
+
# @note When making an API call, pass UnsubscribeFromEventRequest
|
2032
|
+
# data as a hash:
|
2033
|
+
#
|
2034
|
+
# {
|
2035
|
+
# resource_arn: "Arn", # required
|
2036
|
+
# event: "ASSESSMENT_RUN_STARTED", # required, accepts ASSESSMENT_RUN_STARTED, ASSESSMENT_RUN_COMPLETED, ASSESSMENT_RUN_STATE_CHANGED, FINDING_REPORTED, OTHER
|
2037
|
+
# topic_arn: "Arn", # required
|
2038
|
+
# }
|
2039
|
+
# @!attribute [rw] resource_arn
|
2040
|
+
# The ARN of the assessment template that is used during the event for
|
2041
|
+
# which you want to stop receiving SNS notifications.
|
2042
|
+
# @return [String]
|
2043
|
+
#
|
2044
|
+
# @!attribute [rw] event
|
2045
|
+
# The event for which you want to stop receiving SNS notifications.
|
2046
|
+
# @return [String]
|
2047
|
+
#
|
2048
|
+
# @!attribute [rw] topic_arn
|
2049
|
+
# The ARN of the SNS topic to which SNS notifications are sent.
|
2050
|
+
# @return [String]
|
2051
|
+
class UnsubscribeFromEventRequest < Struct.new(
|
2052
|
+
:resource_arn,
|
2053
|
+
:event,
|
2054
|
+
:topic_arn)
|
2055
|
+
include Aws::Structure
|
2056
|
+
end
|
2057
|
+
|
2058
|
+
# @note When making an API call, pass UpdateAssessmentTargetRequest
|
2059
|
+
# data as a hash:
|
2060
|
+
#
|
2061
|
+
# {
|
2062
|
+
# assessment_target_arn: "Arn", # required
|
2063
|
+
# assessment_target_name: "AssessmentTargetName", # required
|
2064
|
+
# resource_group_arn: "Arn", # required
|
2065
|
+
# }
|
2066
|
+
# @!attribute [rw] assessment_target_arn
|
2067
|
+
# The ARN of the assessment target that you want to update.
|
2068
|
+
# @return [String]
|
2069
|
+
#
|
2070
|
+
# @!attribute [rw] assessment_target_name
|
2071
|
+
# The name of the assessment target that you want to update.
|
2072
|
+
# @return [String]
|
2073
|
+
#
|
2074
|
+
# @!attribute [rw] resource_group_arn
|
2075
|
+
# The ARN of the resource group that is used to specify the new
|
2076
|
+
# resource group to associate with the assessment target.
|
2077
|
+
# @return [String]
|
2078
|
+
class UpdateAssessmentTargetRequest < Struct.new(
|
2079
|
+
:assessment_target_arn,
|
2080
|
+
:assessment_target_name,
|
2081
|
+
:resource_group_arn)
|
2082
|
+
include Aws::Structure
|
2083
|
+
end
|
2084
|
+
|
2085
|
+
end
|
2086
|
+
end
|
2087
|
+
end
|