aws-sdk-inspector 1.0.0.rc1 → 1.0.0.rc2

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