aws-sdk-securityhub 1.82.0 → 1.84.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-securityhub/client.rb +1328 -155
- data/lib/aws-sdk-securityhub/client_api.rb +237 -0
- data/lib/aws-sdk-securityhub/endpoints.rb +70 -0
- data/lib/aws-sdk-securityhub/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-securityhub/types.rb +851 -0
- data/lib/aws-sdk-securityhub.rb +1 -1
- metadata +4 -4
@@ -391,6 +391,555 @@ module Aws::SecurityHub
|
|
391
391
|
include Aws::Structure
|
392
392
|
end
|
393
393
|
|
394
|
+
# One or more actions to update finding fields if a finding matches the
|
395
|
+
# defined criteria of the rule.
|
396
|
+
#
|
397
|
+
# @!attribute [rw] type
|
398
|
+
# Specifies that the rule action should update the `Types` finding
|
399
|
+
# field. The `Types` finding field provides one or more finding types
|
400
|
+
# in the format of namespace/category/classifier that classify a
|
401
|
+
# finding. For more information, see [Types taxonomy for ASFF][1] in
|
402
|
+
# the *Security Hub User Guide*.
|
403
|
+
#
|
404
|
+
#
|
405
|
+
#
|
406
|
+
# [1]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html
|
407
|
+
# @return [String]
|
408
|
+
#
|
409
|
+
# @!attribute [rw] finding_fields_update
|
410
|
+
# Specifies that the automation rule action is an update to a finding
|
411
|
+
# field.
|
412
|
+
# @return [Types::AutomationRulesFindingFieldsUpdate]
|
413
|
+
#
|
414
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AutomationRulesAction AWS API Documentation
|
415
|
+
#
|
416
|
+
class AutomationRulesAction < Struct.new(
|
417
|
+
:type,
|
418
|
+
:finding_fields_update)
|
419
|
+
SENSITIVE = []
|
420
|
+
include Aws::Structure
|
421
|
+
end
|
422
|
+
|
423
|
+
# Defines the configuration of an automation rule.
|
424
|
+
#
|
425
|
+
# @!attribute [rw] rule_arn
|
426
|
+
# The Amazon Resource Name (ARN) of a rule.
|
427
|
+
# @return [String]
|
428
|
+
#
|
429
|
+
# @!attribute [rw] rule_status
|
430
|
+
# Whether the rule is active after it is created. If this parameter is
|
431
|
+
# equal to `>ENABLED`, Security Hub will apply the rule to findings
|
432
|
+
# and finding updates after the rule is created.
|
433
|
+
# @return [String]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] rule_order
|
436
|
+
# An integer ranging from 1 to 1000 that represents the order in which
|
437
|
+
# the rule action is applied to findings. Security Hub applies rules
|
438
|
+
# with lower values for this parameter first.
|
439
|
+
# @return [Integer]
|
440
|
+
#
|
441
|
+
# @!attribute [rw] rule_name
|
442
|
+
# The name of the rule.
|
443
|
+
# @return [String]
|
444
|
+
#
|
445
|
+
# @!attribute [rw] description
|
446
|
+
# A description of the rule.
|
447
|
+
# @return [String]
|
448
|
+
#
|
449
|
+
# @!attribute [rw] is_terminal
|
450
|
+
# Specifies whether a rule is the last to be applied with respect to a
|
451
|
+
# finding that matches the rule criteria. This is useful when a
|
452
|
+
# finding matches the criteria for multiple rules, and each rule has
|
453
|
+
# different actions. If the value of this field is set to `true` for a
|
454
|
+
# rule, Security Hub applies the rule action to a finding that matches
|
455
|
+
# the rule criteria and won't evaluate other rules for the finding.
|
456
|
+
# The default value of this field is `false`.
|
457
|
+
# @return [Boolean]
|
458
|
+
#
|
459
|
+
# @!attribute [rw] criteria
|
460
|
+
# A set of [Amazon Web Services Security Finding Format][1] finding
|
461
|
+
# field attributes and corresponding expected values that Security Hub
|
462
|
+
# uses to filter findings. If a finding matches the conditions
|
463
|
+
# specified in this parameter, Security Hub applies the rule action to
|
464
|
+
# the finding.
|
465
|
+
#
|
466
|
+
#
|
467
|
+
#
|
468
|
+
# [1]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html
|
469
|
+
# @return [Types::AutomationRulesFindingFilters]
|
470
|
+
#
|
471
|
+
# @!attribute [rw] actions
|
472
|
+
# One or more actions to update finding fields if a finding matches
|
473
|
+
# the defined criteria of the rule.
|
474
|
+
# @return [Array<Types::AutomationRulesAction>]
|
475
|
+
#
|
476
|
+
# @!attribute [rw] created_at
|
477
|
+
# A timestamp that indicates when the rule was created.
|
478
|
+
#
|
479
|
+
# Uses the `date-time` format specified in [RFC 3339 section 5.6,
|
480
|
+
# Internet Date/Time Format][1]. The value cannot contain spaces. For
|
481
|
+
# example, `2020-03-22T13:22:13.933Z`.
|
482
|
+
#
|
483
|
+
#
|
484
|
+
#
|
485
|
+
# [1]: https://tools.ietf.org/html/rfc3339#section-5.6
|
486
|
+
# @return [Time]
|
487
|
+
#
|
488
|
+
# @!attribute [rw] updated_at
|
489
|
+
# A timestamp that indicates when the rule was most recently updated.
|
490
|
+
#
|
491
|
+
# Uses the `date-time` format specified in [RFC 3339 section 5.6,
|
492
|
+
# Internet Date/Time Format][1]. The value cannot contain spaces. For
|
493
|
+
# example, `2020-03-22T13:22:13.933Z`.
|
494
|
+
#
|
495
|
+
#
|
496
|
+
#
|
497
|
+
# [1]: https://tools.ietf.org/html/rfc3339#section-5.6
|
498
|
+
# @return [Time]
|
499
|
+
#
|
500
|
+
# @!attribute [rw] created_by
|
501
|
+
# The principal that created a rule.
|
502
|
+
# @return [String]
|
503
|
+
#
|
504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AutomationRulesConfig AWS API Documentation
|
505
|
+
#
|
506
|
+
class AutomationRulesConfig < Struct.new(
|
507
|
+
:rule_arn,
|
508
|
+
:rule_status,
|
509
|
+
:rule_order,
|
510
|
+
:rule_name,
|
511
|
+
:description,
|
512
|
+
:is_terminal,
|
513
|
+
:criteria,
|
514
|
+
:actions,
|
515
|
+
:created_at,
|
516
|
+
:updated_at,
|
517
|
+
:created_by)
|
518
|
+
SENSITIVE = []
|
519
|
+
include Aws::Structure
|
520
|
+
end
|
521
|
+
|
522
|
+
# Identifies the finding fields that the automation rule action will
|
523
|
+
# update when a finding matches the defined criteria.
|
524
|
+
#
|
525
|
+
# @!attribute [rw] note
|
526
|
+
# The updated note.
|
527
|
+
# @return [Types::NoteUpdate]
|
528
|
+
#
|
529
|
+
# @!attribute [rw] severity
|
530
|
+
# Updates to the severity information for a finding.
|
531
|
+
# @return [Types::SeverityUpdate]
|
532
|
+
#
|
533
|
+
# @!attribute [rw] verification_state
|
534
|
+
# The rule action will update the `VerificationState` field of a
|
535
|
+
# finding.
|
536
|
+
# @return [String]
|
537
|
+
#
|
538
|
+
# @!attribute [rw] confidence
|
539
|
+
# The rule action will update the `Confidence` field of a finding.
|
540
|
+
# @return [Integer]
|
541
|
+
#
|
542
|
+
# @!attribute [rw] criticality
|
543
|
+
# The rule action will update the `Criticality` field of a finding.
|
544
|
+
# @return [Integer]
|
545
|
+
#
|
546
|
+
# @!attribute [rw] types
|
547
|
+
# The rule action will update the `Types` field of a finding.
|
548
|
+
# @return [Array<String>]
|
549
|
+
#
|
550
|
+
# @!attribute [rw] user_defined_fields
|
551
|
+
# The rule action will update the `UserDefinedFields` field of a
|
552
|
+
# finding.
|
553
|
+
# @return [Hash<String,String>]
|
554
|
+
#
|
555
|
+
# @!attribute [rw] workflow
|
556
|
+
# Used to update information about the investigation into the finding.
|
557
|
+
# @return [Types::WorkflowUpdate]
|
558
|
+
#
|
559
|
+
# @!attribute [rw] related_findings
|
560
|
+
# A list of findings that are related to a finding.
|
561
|
+
# @return [Array<Types::RelatedFinding>]
|
562
|
+
#
|
563
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AutomationRulesFindingFieldsUpdate AWS API Documentation
|
564
|
+
#
|
565
|
+
class AutomationRulesFindingFieldsUpdate < Struct.new(
|
566
|
+
:note,
|
567
|
+
:severity,
|
568
|
+
:verification_state,
|
569
|
+
:confidence,
|
570
|
+
:criticality,
|
571
|
+
:types,
|
572
|
+
:user_defined_fields,
|
573
|
+
:workflow,
|
574
|
+
:related_findings)
|
575
|
+
SENSITIVE = []
|
576
|
+
include Aws::Structure
|
577
|
+
end
|
578
|
+
|
579
|
+
# The criteria that determine which findings a rule applies to.
|
580
|
+
#
|
581
|
+
# @!attribute [rw] product_arn
|
582
|
+
# The Amazon Resource Name (ARN) for a third-party product that
|
583
|
+
# generated a finding in Security Hub.
|
584
|
+
# @return [Array<Types::StringFilter>]
|
585
|
+
#
|
586
|
+
# @!attribute [rw] aws_account_id
|
587
|
+
# The Amazon Web Services account ID in which a finding was generated.
|
588
|
+
# @return [Array<Types::StringFilter>]
|
589
|
+
#
|
590
|
+
# @!attribute [rw] id
|
591
|
+
# The product-specific identifier for a finding.
|
592
|
+
# @return [Array<Types::StringFilter>]
|
593
|
+
#
|
594
|
+
# @!attribute [rw] generator_id
|
595
|
+
# The identifier for the solution-specific component that generated a
|
596
|
+
# finding.
|
597
|
+
# @return [Array<Types::StringFilter>]
|
598
|
+
#
|
599
|
+
# @!attribute [rw] type
|
600
|
+
# One or more finding types in the format of
|
601
|
+
# namespace/category/classifier that classify a finding. For a list of
|
602
|
+
# namespaces, classifiers, and categories, see [Types taxonomy for
|
603
|
+
# ASFF][1] in the *Security Hub User Guide*.
|
604
|
+
#
|
605
|
+
#
|
606
|
+
#
|
607
|
+
# [1]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html
|
608
|
+
# @return [Array<Types::StringFilter>]
|
609
|
+
#
|
610
|
+
# @!attribute [rw] first_observed_at
|
611
|
+
# A timestamp that indicates when the potential security issue
|
612
|
+
# captured by a finding was first observed by the security findings
|
613
|
+
# product.
|
614
|
+
#
|
615
|
+
# Uses the `date-time` format specified in [RFC 3339 section 5.6,
|
616
|
+
# Internet Date/Time Format][1]. The value cannot contain spaces. For
|
617
|
+
# example, `2020-03-22T13:22:13.933Z`.
|
618
|
+
#
|
619
|
+
#
|
620
|
+
#
|
621
|
+
# [1]: https://tools.ietf.org/html/rfc3339#section-5.6
|
622
|
+
# @return [Array<Types::DateFilter>]
|
623
|
+
#
|
624
|
+
# @!attribute [rw] last_observed_at
|
625
|
+
# A timestamp that indicates when the potential security issue
|
626
|
+
# captured by a finding was most recently observed by the security
|
627
|
+
# findings product.
|
628
|
+
#
|
629
|
+
# Uses the `date-time` format specified in [RFC 3339 section 5.6,
|
630
|
+
# Internet Date/Time Format][1]. The value cannot contain spaces. For
|
631
|
+
# example, `2020-03-22T13:22:13.933Z`.
|
632
|
+
#
|
633
|
+
#
|
634
|
+
#
|
635
|
+
# [1]: https://tools.ietf.org/html/rfc3339#section-5.6
|
636
|
+
# @return [Array<Types::DateFilter>]
|
637
|
+
#
|
638
|
+
# @!attribute [rw] created_at
|
639
|
+
# A timestamp that indicates when this finding record was created.
|
640
|
+
#
|
641
|
+
# Uses the `date-time` format specified in [RFC 3339 section 5.6,
|
642
|
+
# Internet Date/Time Format][1]. The value cannot contain spaces. For
|
643
|
+
# example, `2020-03-22T13:22:13.933Z`.
|
644
|
+
#
|
645
|
+
#
|
646
|
+
#
|
647
|
+
# [1]: https://tools.ietf.org/html/rfc3339#section-5.6
|
648
|
+
# @return [Array<Types::DateFilter>]
|
649
|
+
#
|
650
|
+
# @!attribute [rw] updated_at
|
651
|
+
# A timestamp that indicates when the finding record was most recently
|
652
|
+
# updated.
|
653
|
+
#
|
654
|
+
# Uses the `date-time` format specified in [RFC 3339 section 5.6,
|
655
|
+
# Internet Date/Time Format][1]. The value cannot contain spaces. For
|
656
|
+
# example, `2020-03-22T13:22:13.933Z`.
|
657
|
+
#
|
658
|
+
#
|
659
|
+
#
|
660
|
+
# [1]: https://tools.ietf.org/html/rfc3339#section-5.6
|
661
|
+
# @return [Array<Types::DateFilter>]
|
662
|
+
#
|
663
|
+
# @!attribute [rw] confidence
|
664
|
+
# The likelihood that a finding accurately identifies the behavior or
|
665
|
+
# issue that it was intended to identify. `Confidence` is scored on a
|
666
|
+
# 0–100 basis using a ratio scale. A value of `0` means 0 percent
|
667
|
+
# confidence, and a value of `100` means 100 percent confidence. For
|
668
|
+
# example, a data exfiltration detection based on a statistical
|
669
|
+
# deviation of network traffic has low confidence because an actual
|
670
|
+
# exfiltration hasn't been verified. For more information, see
|
671
|
+
# [Confidence][1] in the *Security Hub User Guide*.
|
672
|
+
#
|
673
|
+
#
|
674
|
+
#
|
675
|
+
# [1]: https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-confidence
|
676
|
+
# @return [Array<Types::NumberFilter>]
|
677
|
+
#
|
678
|
+
# @!attribute [rw] criticality
|
679
|
+
# The level of importance that is assigned to the resources that are
|
680
|
+
# associated with a finding. `Criticality` is scored on a 0–100 basis,
|
681
|
+
# using a ratio scale that supports only full integers. A score of `0`
|
682
|
+
# means that the underlying resources have no criticality, and a score
|
683
|
+
# of `100` is reserved for the most critical resources. For more
|
684
|
+
# information, see [Criticality][1] in the *Security Hub User Guide*.
|
685
|
+
#
|
686
|
+
#
|
687
|
+
#
|
688
|
+
# [1]: https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-criticality
|
689
|
+
# @return [Array<Types::NumberFilter>]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] title
|
692
|
+
# A finding's title.
|
693
|
+
# @return [Array<Types::StringFilter>]
|
694
|
+
#
|
695
|
+
# @!attribute [rw] description
|
696
|
+
# A finding's description.
|
697
|
+
# @return [Array<Types::StringFilter>]
|
698
|
+
#
|
699
|
+
# @!attribute [rw] source_url
|
700
|
+
# Provides a URL that links to a page about the current finding in the
|
701
|
+
# finding product.
|
702
|
+
# @return [Array<Types::StringFilter>]
|
703
|
+
#
|
704
|
+
# @!attribute [rw] product_name
|
705
|
+
# Provides the name of the product that generated the finding. For
|
706
|
+
# control-based findings, the product name is Security Hub.
|
707
|
+
# @return [Array<Types::StringFilter>]
|
708
|
+
#
|
709
|
+
# @!attribute [rw] company_name
|
710
|
+
# The name of the company for the product that generated the finding.
|
711
|
+
# For control-based findings, the company is Amazon Web Services.
|
712
|
+
# @return [Array<Types::StringFilter>]
|
713
|
+
#
|
714
|
+
# @!attribute [rw] severity_label
|
715
|
+
# The severity value of the finding.
|
716
|
+
# @return [Array<Types::StringFilter>]
|
717
|
+
#
|
718
|
+
# @!attribute [rw] resource_type
|
719
|
+
# The type of resource that the finding pertains to.
|
720
|
+
# @return [Array<Types::StringFilter>]
|
721
|
+
#
|
722
|
+
# @!attribute [rw] resource_id
|
723
|
+
# The identifier for the given resource type. For Amazon Web Services
|
724
|
+
# resources that are identified by Amazon Resource Names (ARNs), this
|
725
|
+
# is the ARN. For Amazon Web Services resources that lack ARNs, this
|
726
|
+
# is the identifier as defined by the Amazon Web Service that created
|
727
|
+
# the resource. For non-Amazon Web Services resources, this is a
|
728
|
+
# unique identifier that is associated with the resource.
|
729
|
+
# @return [Array<Types::StringFilter>]
|
730
|
+
#
|
731
|
+
# @!attribute [rw] resource_partition
|
732
|
+
# The partition in which the resource that the finding pertains to is
|
733
|
+
# located. A partition is a group of Amazon Web Services Regions. Each
|
734
|
+
# Amazon Web Services account is scoped to one partition.
|
735
|
+
# @return [Array<Types::StringFilter>]
|
736
|
+
#
|
737
|
+
# @!attribute [rw] resource_region
|
738
|
+
# The Amazon Web Services Region where the resource that a finding
|
739
|
+
# pertains to is located.
|
740
|
+
# @return [Array<Types::StringFilter>]
|
741
|
+
#
|
742
|
+
# @!attribute [rw] resource_tags
|
743
|
+
# A list of Amazon Web Services tags associated with a resource at the
|
744
|
+
# time the finding was processed.
|
745
|
+
# @return [Array<Types::MapFilter>]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] resource_details_other
|
748
|
+
# Custom fields and values about the resource that a finding pertains
|
749
|
+
# to.
|
750
|
+
# @return [Array<Types::MapFilter>]
|
751
|
+
#
|
752
|
+
# @!attribute [rw] compliance_status
|
753
|
+
# The result of a security check. This field is only used for findings
|
754
|
+
# generated from controls.
|
755
|
+
# @return [Array<Types::StringFilter>]
|
756
|
+
#
|
757
|
+
# @!attribute [rw] compliance_security_control_id
|
758
|
+
# The security control ID for which a finding was generated. Security
|
759
|
+
# control IDs are the same across standards.
|
760
|
+
# @return [Array<Types::StringFilter>]
|
761
|
+
#
|
762
|
+
# @!attribute [rw] compliance_associated_standards_id
|
763
|
+
# The unique identifier of a standard in which a control is enabled.
|
764
|
+
# This field consists of the resource portion of the Amazon Resource
|
765
|
+
# Name (ARN) returned for a standard in the [DescribeStandards][1] API
|
766
|
+
# response.
|
767
|
+
#
|
768
|
+
#
|
769
|
+
#
|
770
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html
|
771
|
+
# @return [Array<Types::StringFilter>]
|
772
|
+
#
|
773
|
+
# @!attribute [rw] verification_state
|
774
|
+
# Provides the veracity of a finding.
|
775
|
+
# @return [Array<Types::StringFilter>]
|
776
|
+
#
|
777
|
+
# @!attribute [rw] workflow_status
|
778
|
+
# Provides information about the status of the investigation into a
|
779
|
+
# finding.
|
780
|
+
# @return [Array<Types::StringFilter>]
|
781
|
+
#
|
782
|
+
# @!attribute [rw] record_state
|
783
|
+
# Provides the current state of a finding.
|
784
|
+
# @return [Array<Types::StringFilter>]
|
785
|
+
#
|
786
|
+
# @!attribute [rw] related_findings_product_arn
|
787
|
+
# The ARN for the product that generated a related finding.
|
788
|
+
# @return [Array<Types::StringFilter>]
|
789
|
+
#
|
790
|
+
# @!attribute [rw] related_findings_id
|
791
|
+
# The product-generated identifier for a related finding.
|
792
|
+
# @return [Array<Types::StringFilter>]
|
793
|
+
#
|
794
|
+
# @!attribute [rw] note_text
|
795
|
+
# The text of a user-defined note that's added to a finding.
|
796
|
+
# @return [Array<Types::StringFilter>]
|
797
|
+
#
|
798
|
+
# @!attribute [rw] note_updated_at
|
799
|
+
# The timestamp of when the note was updated. Uses the date-time
|
800
|
+
# format specified in [RFC 3339 section 5.6, Internet Date/Time
|
801
|
+
# Format][1]. The value cannot contain spaces. For example,
|
802
|
+
# `2020-03-22T13:22:13.933Z`.
|
803
|
+
#
|
804
|
+
#
|
805
|
+
#
|
806
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6
|
807
|
+
# @return [Array<Types::DateFilter>]
|
808
|
+
#
|
809
|
+
# @!attribute [rw] note_updated_by
|
810
|
+
# The principal that created a note.
|
811
|
+
# @return [Array<Types::StringFilter>]
|
812
|
+
#
|
813
|
+
# @!attribute [rw] user_defined_fields
|
814
|
+
# A list of user-defined name and value string pairs added to a
|
815
|
+
# finding.
|
816
|
+
# @return [Array<Types::MapFilter>]
|
817
|
+
#
|
818
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AutomationRulesFindingFilters AWS API Documentation
|
819
|
+
#
|
820
|
+
class AutomationRulesFindingFilters < Struct.new(
|
821
|
+
:product_arn,
|
822
|
+
:aws_account_id,
|
823
|
+
:id,
|
824
|
+
:generator_id,
|
825
|
+
:type,
|
826
|
+
:first_observed_at,
|
827
|
+
:last_observed_at,
|
828
|
+
:created_at,
|
829
|
+
:updated_at,
|
830
|
+
:confidence,
|
831
|
+
:criticality,
|
832
|
+
:title,
|
833
|
+
:description,
|
834
|
+
:source_url,
|
835
|
+
:product_name,
|
836
|
+
:company_name,
|
837
|
+
:severity_label,
|
838
|
+
:resource_type,
|
839
|
+
:resource_id,
|
840
|
+
:resource_partition,
|
841
|
+
:resource_region,
|
842
|
+
:resource_tags,
|
843
|
+
:resource_details_other,
|
844
|
+
:compliance_status,
|
845
|
+
:compliance_security_control_id,
|
846
|
+
:compliance_associated_standards_id,
|
847
|
+
:verification_state,
|
848
|
+
:workflow_status,
|
849
|
+
:record_state,
|
850
|
+
:related_findings_product_arn,
|
851
|
+
:related_findings_id,
|
852
|
+
:note_text,
|
853
|
+
:note_updated_at,
|
854
|
+
:note_updated_by,
|
855
|
+
:user_defined_fields)
|
856
|
+
SENSITIVE = []
|
857
|
+
include Aws::Structure
|
858
|
+
end
|
859
|
+
|
860
|
+
# Metadata for automation rules in the calling account. The response
|
861
|
+
# includes rules with a `RuleStatus` of `ENABLED` and `DISABLED`.
|
862
|
+
#
|
863
|
+
# @!attribute [rw] rule_arn
|
864
|
+
# The Amazon Resource Name (ARN) for the rule.
|
865
|
+
# @return [String]
|
866
|
+
#
|
867
|
+
# @!attribute [rw] rule_status
|
868
|
+
# Whether the rule is active after it is created. If this parameter is
|
869
|
+
# equal to `ENABLED`, Security Hub will apply the rule to findings and
|
870
|
+
# finding updates after the rule is created. To change the value of
|
871
|
+
# this parameter after creating a rule, use
|
872
|
+
# `BatchUpdateAutomationRules`.
|
873
|
+
# @return [String]
|
874
|
+
#
|
875
|
+
# @!attribute [rw] rule_order
|
876
|
+
# An integer ranging from 1 to 1000 that represents the order in which
|
877
|
+
# the rule action is applied to findings. Security Hub applies rules
|
878
|
+
# with lower values for this parameter first.
|
879
|
+
# @return [Integer]
|
880
|
+
#
|
881
|
+
# @!attribute [rw] rule_name
|
882
|
+
# The name of the rule.
|
883
|
+
# @return [String]
|
884
|
+
#
|
885
|
+
# @!attribute [rw] description
|
886
|
+
# A description of the rule.
|
887
|
+
# @return [String]
|
888
|
+
#
|
889
|
+
# @!attribute [rw] is_terminal
|
890
|
+
# Specifies whether a rule is the last to be applied with respect to a
|
891
|
+
# finding that matches the rule criteria. This is useful when a
|
892
|
+
# finding matches the criteria for multiple rules, and each rule has
|
893
|
+
# different actions. If the value of this field is set to `true` for a
|
894
|
+
# rule, Security Hub applies the rule action to a finding that matches
|
895
|
+
# the rule criteria and won't evaluate other rules for the finding.
|
896
|
+
# The default value of this field is `false`.
|
897
|
+
# @return [Boolean]
|
898
|
+
#
|
899
|
+
# @!attribute [rw] created_at
|
900
|
+
# A timestamp that indicates when the rule was created.
|
901
|
+
#
|
902
|
+
# Uses the `date-time` format specified in [RFC 3339 section 5.6,
|
903
|
+
# Internet Date/Time Format][1]. The value cannot contain spaces. For
|
904
|
+
# example, `2020-03-22T13:22:13.933Z`.
|
905
|
+
#
|
906
|
+
#
|
907
|
+
#
|
908
|
+
# [1]: https://tools.ietf.org/html/rfc3339#section-5.6
|
909
|
+
# @return [Time]
|
910
|
+
#
|
911
|
+
# @!attribute [rw] updated_at
|
912
|
+
# A timestamp that indicates when the rule was most recently updated.
|
913
|
+
#
|
914
|
+
# Uses the `date-time` format specified in [RFC 3339 section 5.6,
|
915
|
+
# Internet Date/Time Format][1]. The value cannot contain spaces. For
|
916
|
+
# example, `2020-03-22T13:22:13.933Z`.
|
917
|
+
#
|
918
|
+
#
|
919
|
+
#
|
920
|
+
# [1]: https://tools.ietf.org/html/rfc3339#section-5.6
|
921
|
+
# @return [Time]
|
922
|
+
#
|
923
|
+
# @!attribute [rw] created_by
|
924
|
+
# The principal that created a rule.
|
925
|
+
# @return [String]
|
926
|
+
#
|
927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AutomationRulesMetadata AWS API Documentation
|
928
|
+
#
|
929
|
+
class AutomationRulesMetadata < Struct.new(
|
930
|
+
:rule_arn,
|
931
|
+
:rule_status,
|
932
|
+
:rule_order,
|
933
|
+
:rule_name,
|
934
|
+
:description,
|
935
|
+
:is_terminal,
|
936
|
+
:created_at,
|
937
|
+
:updated_at,
|
938
|
+
:created_by)
|
939
|
+
SENSITIVE = []
|
940
|
+
include Aws::Structure
|
941
|
+
end
|
942
|
+
|
394
943
|
# Information about an Availability Zone.
|
395
944
|
#
|
396
945
|
# @!attribute [rw] zone_name
|
@@ -19359,6 +19908,38 @@ module Aws::SecurityHub
|
|
19359
19908
|
include Aws::Structure
|
19360
19909
|
end
|
19361
19910
|
|
19911
|
+
# @!attribute [rw] automation_rules_arns
|
19912
|
+
# A list of Amazon Resource Names (ARNs) for the rules that are to be
|
19913
|
+
# deleted.
|
19914
|
+
# @return [Array<String>]
|
19915
|
+
#
|
19916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchDeleteAutomationRulesRequest AWS API Documentation
|
19917
|
+
#
|
19918
|
+
class BatchDeleteAutomationRulesRequest < Struct.new(
|
19919
|
+
:automation_rules_arns)
|
19920
|
+
SENSITIVE = []
|
19921
|
+
include Aws::Structure
|
19922
|
+
end
|
19923
|
+
|
19924
|
+
# @!attribute [rw] processed_automation_rules
|
19925
|
+
# A list of properly processed rule ARNs.
|
19926
|
+
# @return [Array<String>]
|
19927
|
+
#
|
19928
|
+
# @!attribute [rw] unprocessed_automation_rules
|
19929
|
+
# A list of objects containing `RuleArn`, `ErrorCode`, and
|
19930
|
+
# `ErrorMessage`. This parameter tells you which automation rules the
|
19931
|
+
# request didn't delete and why.
|
19932
|
+
# @return [Array<Types::UnprocessedAutomationRule>]
|
19933
|
+
#
|
19934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchDeleteAutomationRulesResponse AWS API Documentation
|
19935
|
+
#
|
19936
|
+
class BatchDeleteAutomationRulesResponse < Struct.new(
|
19937
|
+
:processed_automation_rules,
|
19938
|
+
:unprocessed_automation_rules)
|
19939
|
+
SENSITIVE = []
|
19940
|
+
include Aws::Structure
|
19941
|
+
end
|
19942
|
+
|
19362
19943
|
# @!attribute [rw] standards_subscription_arns
|
19363
19944
|
# The ARNs of the standards subscriptions to disable.
|
19364
19945
|
# @return [Array<String>]
|
@@ -19407,6 +19988,37 @@ module Aws::SecurityHub
|
|
19407
19988
|
include Aws::Structure
|
19408
19989
|
end
|
19409
19990
|
|
19991
|
+
# @!attribute [rw] automation_rules_arns
|
19992
|
+
# A list of rule ARNs to get details for.
|
19993
|
+
# @return [Array<String>]
|
19994
|
+
#
|
19995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetAutomationRulesRequest AWS API Documentation
|
19996
|
+
#
|
19997
|
+
class BatchGetAutomationRulesRequest < Struct.new(
|
19998
|
+
:automation_rules_arns)
|
19999
|
+
SENSITIVE = []
|
20000
|
+
include Aws::Structure
|
20001
|
+
end
|
20002
|
+
|
20003
|
+
# @!attribute [rw] rules
|
20004
|
+
# A list of rule details for the provided rule ARNs.
|
20005
|
+
# @return [Array<Types::AutomationRulesConfig>]
|
20006
|
+
#
|
20007
|
+
# @!attribute [rw] unprocessed_automation_rules
|
20008
|
+
# A list of objects containing `RuleArn`, `ErrorCode`, and
|
20009
|
+
# `ErrorMessage`. This parameter tells you which automation rules the
|
20010
|
+
# request didn't retrieve and why.
|
20011
|
+
# @return [Array<Types::UnprocessedAutomationRule>]
|
20012
|
+
#
|
20013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetAutomationRulesResponse AWS API Documentation
|
20014
|
+
#
|
20015
|
+
class BatchGetAutomationRulesResponse < Struct.new(
|
20016
|
+
:rules,
|
20017
|
+
:unprocessed_automation_rules)
|
20018
|
+
SENSITIVE = []
|
20019
|
+
include Aws::Structure
|
20020
|
+
end
|
20021
|
+
|
19410
20022
|
# @!attribute [rw] security_control_ids
|
19411
20023
|
# A list of security controls (identified with `SecurityControlId`,
|
19412
20024
|
# `SecurityControlArn`, or a mix of both parameters). The security
|
@@ -19522,6 +20134,38 @@ module Aws::SecurityHub
|
|
19522
20134
|
include Aws::Structure
|
19523
20135
|
end
|
19524
20136
|
|
20137
|
+
# @!attribute [rw] update_automation_rules_request_items
|
20138
|
+
# An array of ARNs for the rules that are to be updated. Optionally,
|
20139
|
+
# you can also include `RuleStatus` and `RuleOrder`.
|
20140
|
+
# @return [Array<Types::UpdateAutomationRulesRequestItem>]
|
20141
|
+
#
|
20142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchUpdateAutomationRulesRequest AWS API Documentation
|
20143
|
+
#
|
20144
|
+
class BatchUpdateAutomationRulesRequest < Struct.new(
|
20145
|
+
:update_automation_rules_request_items)
|
20146
|
+
SENSITIVE = []
|
20147
|
+
include Aws::Structure
|
20148
|
+
end
|
20149
|
+
|
20150
|
+
# @!attribute [rw] processed_automation_rules
|
20151
|
+
# A list of properly processed rule ARNs.
|
20152
|
+
# @return [Array<String>]
|
20153
|
+
#
|
20154
|
+
# @!attribute [rw] unprocessed_automation_rules
|
20155
|
+
# A list of objects containing `RuleArn`, `ErrorCode`, and
|
20156
|
+
# `ErrorMessage`. This parameter tells you which automation rules the
|
20157
|
+
# request didn't update and why.
|
20158
|
+
# @return [Array<Types::UnprocessedAutomationRule>]
|
20159
|
+
#
|
20160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchUpdateAutomationRulesResponse AWS API Documentation
|
20161
|
+
#
|
20162
|
+
class BatchUpdateAutomationRulesResponse < Struct.new(
|
20163
|
+
:processed_automation_rules,
|
20164
|
+
:unprocessed_automation_rules)
|
20165
|
+
SENSITIVE = []
|
20166
|
+
include Aws::Structure
|
20167
|
+
end
|
20168
|
+
|
19525
20169
|
# @!attribute [rw] finding_identifiers
|
19526
20170
|
# The list of findings to update. `BatchUpdateFindings` can be used to
|
19527
20171
|
# update up to 100 findings at a time.
|
@@ -20055,6 +20699,82 @@ module Aws::SecurityHub
|
|
20055
20699
|
include Aws::Structure
|
20056
20700
|
end
|
20057
20701
|
|
20702
|
+
# @!attribute [rw] tags
|
20703
|
+
# User-defined tags that help you label the purpose of a rule.
|
20704
|
+
# @return [Hash<String,String>]
|
20705
|
+
#
|
20706
|
+
# @!attribute [rw] rule_status
|
20707
|
+
# Whether the rule is active after it is created. If this parameter is
|
20708
|
+
# equal to `Enabled`, Security Hub will apply the rule to findings and
|
20709
|
+
# finding updates after the rule is created. To change the value of
|
20710
|
+
# this parameter after creating a rule, use
|
20711
|
+
# `BatchUpdateAutomationRules`.
|
20712
|
+
# @return [String]
|
20713
|
+
#
|
20714
|
+
# @!attribute [rw] rule_order
|
20715
|
+
# An integer ranging from 1 to 1000 that represents the order in which
|
20716
|
+
# the rule action is applied to findings. Security Hub applies rules
|
20717
|
+
# with lower values for this parameter first.
|
20718
|
+
# @return [Integer]
|
20719
|
+
#
|
20720
|
+
# @!attribute [rw] rule_name
|
20721
|
+
# The name of the rule.
|
20722
|
+
# @return [String]
|
20723
|
+
#
|
20724
|
+
# @!attribute [rw] description
|
20725
|
+
# A description of the rule.
|
20726
|
+
# @return [String]
|
20727
|
+
#
|
20728
|
+
# @!attribute [rw] is_terminal
|
20729
|
+
# Specifies whether a rule is the last to be applied with respect to a
|
20730
|
+
# finding that matches the rule criteria. This is useful when a
|
20731
|
+
# finding matches the criteria for multiple rules, and each rule has
|
20732
|
+
# different actions. If the value of this field is set to `true` for a
|
20733
|
+
# rule, Security Hub applies the rule action to a finding that matches
|
20734
|
+
# the rule criteria and won't evaluate other rules for the finding.
|
20735
|
+
# The default value of this field is `false`.
|
20736
|
+
# @return [Boolean]
|
20737
|
+
#
|
20738
|
+
# @!attribute [rw] criteria
|
20739
|
+
# A set of ASFF finding field attributes and corresponding expected
|
20740
|
+
# values that Security Hub uses to filter findings. If a finding
|
20741
|
+
# matches the conditions specified in this parameter, Security Hub
|
20742
|
+
# applies the rule action to the finding.
|
20743
|
+
# @return [Types::AutomationRulesFindingFilters]
|
20744
|
+
#
|
20745
|
+
# @!attribute [rw] actions
|
20746
|
+
# One or more actions to update finding fields if a finding matches
|
20747
|
+
# the conditions specified in `Criteria`.
|
20748
|
+
# @return [Array<Types::AutomationRulesAction>]
|
20749
|
+
#
|
20750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateAutomationRuleRequest AWS API Documentation
|
20751
|
+
#
|
20752
|
+
class CreateAutomationRuleRequest < Struct.new(
|
20753
|
+
:tags,
|
20754
|
+
:rule_status,
|
20755
|
+
:rule_order,
|
20756
|
+
:rule_name,
|
20757
|
+
:description,
|
20758
|
+
:is_terminal,
|
20759
|
+
:criteria,
|
20760
|
+
:actions)
|
20761
|
+
SENSITIVE = []
|
20762
|
+
include Aws::Structure
|
20763
|
+
end
|
20764
|
+
|
20765
|
+
# @!attribute [rw] rule_arn
|
20766
|
+
# The Amazon Resource Name (ARN) of the automation rule that you
|
20767
|
+
# created.
|
20768
|
+
# @return [String]
|
20769
|
+
#
|
20770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateAutomationRuleResponse AWS API Documentation
|
20771
|
+
#
|
20772
|
+
class CreateAutomationRuleResponse < Struct.new(
|
20773
|
+
:rule_arn)
|
20774
|
+
SENSITIVE = []
|
20775
|
+
include Aws::Structure
|
20776
|
+
end
|
20777
|
+
|
20058
20778
|
# @!attribute [rw] region_linking_mode
|
20059
20779
|
# Indicates whether to aggregate findings from all of the available
|
20060
20780
|
# Regions in the current partition. Also determines whether to
|
@@ -22112,6 +22832,45 @@ module Aws::SecurityHub
|
|
22112
22832
|
include Aws::Structure
|
22113
22833
|
end
|
22114
22834
|
|
22835
|
+
# @!attribute [rw] next_token
|
22836
|
+
# A token to specify where to start paginating the response. This is
|
22837
|
+
# the `NextToken` from a previously truncated response. On your first
|
22838
|
+
# call to the `ListAutomationRules` API, set the value of this
|
22839
|
+
# parameter to `NULL`.
|
22840
|
+
# @return [String]
|
22841
|
+
#
|
22842
|
+
# @!attribute [rw] max_results
|
22843
|
+
# The maximum number of rules to return in the response. This
|
22844
|
+
# currently ranges from 1 to 100.
|
22845
|
+
# @return [Integer]
|
22846
|
+
#
|
22847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListAutomationRulesRequest AWS API Documentation
|
22848
|
+
#
|
22849
|
+
class ListAutomationRulesRequest < Struct.new(
|
22850
|
+
:next_token,
|
22851
|
+
:max_results)
|
22852
|
+
SENSITIVE = []
|
22853
|
+
include Aws::Structure
|
22854
|
+
end
|
22855
|
+
|
22856
|
+
# @!attribute [rw] automation_rules_metadata
|
22857
|
+
# Metadata for rules in the calling account. The response includes
|
22858
|
+
# rules with a `RuleStatus` of `ENABLED` and `DISABLED`.
|
22859
|
+
# @return [Array<Types::AutomationRulesMetadata>]
|
22860
|
+
#
|
22861
|
+
# @!attribute [rw] next_token
|
22862
|
+
# A pagination token for the response.
|
22863
|
+
# @return [String]
|
22864
|
+
#
|
22865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListAutomationRulesResponse AWS API Documentation
|
22866
|
+
#
|
22867
|
+
class ListAutomationRulesResponse < Struct.new(
|
22868
|
+
:automation_rules_metadata,
|
22869
|
+
:next_token)
|
22870
|
+
SENSITIVE = []
|
22871
|
+
include Aws::Structure
|
22872
|
+
end
|
22873
|
+
|
22115
22874
|
# @!attribute [rw] next_token
|
22116
22875
|
# The token that is required for pagination. On your first call to the
|
22117
22876
|
# `ListEnabledProductsForImport` operation, set the value of this
|
@@ -25625,6 +26384,33 @@ module Aws::SecurityHub
|
|
25625
26384
|
include Aws::Structure
|
25626
26385
|
end
|
25627
26386
|
|
26387
|
+
# A list of objects containing `RuleArn`, `ErrorCode`, and
|
26388
|
+
# `ErrorMessage`. This parameter tells you which automation rules the
|
26389
|
+
# request didn't process and why.
|
26390
|
+
#
|
26391
|
+
# @!attribute [rw] rule_arn
|
26392
|
+
# The Amazon Resource Name (ARN) for the unprocessed automation rule.
|
26393
|
+
# @return [String]
|
26394
|
+
#
|
26395
|
+
# @!attribute [rw] error_code
|
26396
|
+
# The error code associated with the unprocessed automation rule.
|
26397
|
+
# @return [Integer]
|
26398
|
+
#
|
26399
|
+
# @!attribute [rw] error_message
|
26400
|
+
# An error message describing why a request didn't process a specific
|
26401
|
+
# rule.
|
26402
|
+
# @return [String]
|
26403
|
+
#
|
26404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UnprocessedAutomationRule AWS API Documentation
|
26405
|
+
#
|
26406
|
+
class UnprocessedAutomationRule < Struct.new(
|
26407
|
+
:rule_arn,
|
26408
|
+
:error_code,
|
26409
|
+
:error_message)
|
26410
|
+
SENSITIVE = []
|
26411
|
+
include Aws::Structure
|
26412
|
+
end
|
26413
|
+
|
25628
26414
|
# Provides details about a security control for which a response
|
25629
26415
|
# couldn't be returned.
|
25630
26416
|
#
|
@@ -25778,6 +26564,71 @@ module Aws::SecurityHub
|
|
25778
26564
|
#
|
25779
26565
|
class UpdateActionTargetResponse < Aws::EmptyStructure; end
|
25780
26566
|
|
26567
|
+
# Specifies the parameters to update in an existing automation rule.
|
26568
|
+
#
|
26569
|
+
# @!attribute [rw] rule_arn
|
26570
|
+
# The Amazon Resource Name (ARN) for the rule.
|
26571
|
+
# @return [String]
|
26572
|
+
#
|
26573
|
+
# @!attribute [rw] rule_status
|
26574
|
+
# Whether the rule is active after it is created. If this parameter is
|
26575
|
+
# equal to `ENABLED`, Security Hub will apply the rule to findings and
|
26576
|
+
# finding updates after the rule is created. To change the value of
|
26577
|
+
# this parameter after creating a rule, use
|
26578
|
+
# `BatchUpdateAutomationRules`.
|
26579
|
+
# @return [String]
|
26580
|
+
#
|
26581
|
+
# @!attribute [rw] rule_order
|
26582
|
+
# An integer ranging from 1 to 1000 that represents the order in which
|
26583
|
+
# the rule action is applied to findings. Security Hub applies rules
|
26584
|
+
# with lower values for this parameter first.
|
26585
|
+
# @return [Integer]
|
26586
|
+
#
|
26587
|
+
# @!attribute [rw] description
|
26588
|
+
# A description of the rule.
|
26589
|
+
# @return [String]
|
26590
|
+
#
|
26591
|
+
# @!attribute [rw] rule_name
|
26592
|
+
# The name of the rule.
|
26593
|
+
# @return [String]
|
26594
|
+
#
|
26595
|
+
# @!attribute [rw] is_terminal
|
26596
|
+
# Specifies whether a rule is the last to be applied with respect to a
|
26597
|
+
# finding that matches the rule criteria. This is useful when a
|
26598
|
+
# finding matches the criteria for multiple rules, and each rule has
|
26599
|
+
# different actions. If the value of this field is set to `true` for a
|
26600
|
+
# rule, Security Hub applies the rule action to a finding that matches
|
26601
|
+
# the rule criteria and won't evaluate other rules for the finding.
|
26602
|
+
# The default value of this field is `false`.
|
26603
|
+
# @return [Boolean]
|
26604
|
+
#
|
26605
|
+
# @!attribute [rw] criteria
|
26606
|
+
# A set of ASFF finding field attributes and corresponding expected
|
26607
|
+
# values that Security Hub uses to filter findings. If a finding
|
26608
|
+
# matches the conditions specified in this parameter, Security Hub
|
26609
|
+
# applies the rule action to the finding.
|
26610
|
+
# @return [Types::AutomationRulesFindingFilters]
|
26611
|
+
#
|
26612
|
+
# @!attribute [rw] actions
|
26613
|
+
# One or more actions to update finding fields if a finding matches
|
26614
|
+
# the conditions specified in `Criteria`.
|
26615
|
+
# @return [Array<Types::AutomationRulesAction>]
|
26616
|
+
#
|
26617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateAutomationRulesRequestItem AWS API Documentation
|
26618
|
+
#
|
26619
|
+
class UpdateAutomationRulesRequestItem < Struct.new(
|
26620
|
+
:rule_arn,
|
26621
|
+
:rule_status,
|
26622
|
+
:rule_order,
|
26623
|
+
:description,
|
26624
|
+
:rule_name,
|
26625
|
+
:is_terminal,
|
26626
|
+
:criteria,
|
26627
|
+
:actions)
|
26628
|
+
SENSITIVE = []
|
26629
|
+
include Aws::Structure
|
26630
|
+
end
|
26631
|
+
|
25781
26632
|
# @!attribute [rw] finding_aggregator_arn
|
25782
26633
|
# The ARN of the finding aggregator. To obtain the ARN, use
|
25783
26634
|
# `ListFindingAggregators`.
|