aws-sdk-securityhub 1.164.0 → 1.166.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-securityhub/client.rb +227 -1
- data/lib/aws-sdk-securityhub/client_api.rb +238 -0
- data/lib/aws-sdk-securityhub/types.rb +813 -2
- data/lib/aws-sdk-securityhub.rb +1 -1
- data/sig/client.rbs +47 -0
- data/sig/types.rbs +191 -0
- metadata +3 -3
|
@@ -25300,6 +25300,54 @@ module Aws::SecurityHub
|
|
|
25300
25300
|
include Aws::Structure
|
|
25301
25301
|
end
|
|
25302
25302
|
|
|
25303
|
+
# Provides details about an exposure finding and the effect the specific
|
|
25304
|
+
# remediation target has on it.
|
|
25305
|
+
#
|
|
25306
|
+
# @!attribute [rw] metadata_uid
|
|
25307
|
+
# The unique identifier (ID) of the Security Hub exposure finding,
|
|
25308
|
+
# found under the `metadata.uid` field of the finding.
|
|
25309
|
+
# @return [String]
|
|
25310
|
+
#
|
|
25311
|
+
# @!attribute [rw] title
|
|
25312
|
+
# The title of the exposure finding.
|
|
25313
|
+
# @return [String]
|
|
25314
|
+
#
|
|
25315
|
+
# @!attribute [rw] previous_severity
|
|
25316
|
+
# The severity of the exposure finding before the remediation target
|
|
25317
|
+
# is resolved.
|
|
25318
|
+
# @return [String]
|
|
25319
|
+
#
|
|
25320
|
+
# @!attribute [rw] projected_severity
|
|
25321
|
+
# The severity of the exposure finding after the remediation target is
|
|
25322
|
+
# resolved.
|
|
25323
|
+
# @return [String]
|
|
25324
|
+
#
|
|
25325
|
+
# @!attribute [rw] impact
|
|
25326
|
+
# The impact resolving a remediation target has on the exposure
|
|
25327
|
+
# finding.
|
|
25328
|
+
#
|
|
25329
|
+
# * `Reduces` specifies that resolving the remediation target lowers
|
|
25330
|
+
# the severity of the exposure finding, but does not resolve it.
|
|
25331
|
+
#
|
|
25332
|
+
# * `Resolves` specifies that resolving the remediation target
|
|
25333
|
+
# resolves the exposure finding.
|
|
25334
|
+
#
|
|
25335
|
+
# * `Unchanged` specifies that resolving the remediation target does
|
|
25336
|
+
# not change the severity of the exposure finding.
|
|
25337
|
+
# @return [String]
|
|
25338
|
+
#
|
|
25339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ExposureFinding AWS API Documentation
|
|
25340
|
+
#
|
|
25341
|
+
class ExposureFinding < Struct.new(
|
|
25342
|
+
:metadata_uid,
|
|
25343
|
+
:title,
|
|
25344
|
+
:previous_severity,
|
|
25345
|
+
:projected_severity,
|
|
25346
|
+
:impact)
|
|
25347
|
+
SENSITIVE = []
|
|
25348
|
+
include Aws::Structure
|
|
25349
|
+
end
|
|
25350
|
+
|
|
25303
25351
|
# Defines the settings and parameters required for integrating external
|
|
25304
25352
|
# security tools and services.
|
|
25305
25353
|
#
|
|
@@ -25908,7 +25956,8 @@ module Aws::SecurityHub
|
|
|
25908
25956
|
# @return [String]
|
|
25909
25957
|
#
|
|
25910
25958
|
# @!attribute [rw] status
|
|
25911
|
-
#
|
|
25959
|
+
# Specifies whether the free trial period is currently active. Valid
|
|
25960
|
+
# values:
|
|
25912
25961
|
#
|
|
25913
25962
|
# * `ACTIVE` specifies that the free trial period is ongoing.
|
|
25914
25963
|
#
|
|
@@ -27049,6 +27098,81 @@ module Aws::SecurityHub
|
|
|
27049
27098
|
include Aws::Structure
|
|
27050
27099
|
end
|
|
27051
27100
|
|
|
27101
|
+
# @!attribute [rw] target_uid
|
|
27102
|
+
# The unique identifier (ID) of an existing remediation target to
|
|
27103
|
+
# return. Returns the single matching target. You can't use
|
|
27104
|
+
# `TargetUid` together with `MetadataUid` or `Filters`.
|
|
27105
|
+
# @return [String]
|
|
27106
|
+
#
|
|
27107
|
+
# @!attribute [rw] metadata_uid
|
|
27108
|
+
# The unique identifier (ID) of the Security Hub exposure finding,
|
|
27109
|
+
# found under the `metadata.uid` field of the finding. Returns the
|
|
27110
|
+
# remediation targets associated with that finding. You can't use
|
|
27111
|
+
# `MetadataUid` together with `TargetUid` or `Filters`.
|
|
27112
|
+
# @return [String]
|
|
27113
|
+
#
|
|
27114
|
+
# @!attribute [rw] filters
|
|
27115
|
+
# Filters remediation targets based on a set of criteria. You can't
|
|
27116
|
+
# use `Filters` together with `TargetUid` or `MetadataUid`.
|
|
27117
|
+
# @return [Types::RemediationFilters]
|
|
27118
|
+
#
|
|
27119
|
+
# @!attribute [rw] show_guidance
|
|
27120
|
+
# Specifies whether to show remediation target guidance.
|
|
27121
|
+
# @return [Boolean]
|
|
27122
|
+
#
|
|
27123
|
+
# @!attribute [rw] guidance_format
|
|
27124
|
+
# The format of the remediation guidance examples to return. Valid
|
|
27125
|
+
# values are `All`, `AwsCli`, `Cli`, `Python`, `Terraform`, `Cdk`,
|
|
27126
|
+
# `CloudFormation`, `IaC`, and `Template`. If you don't specify a
|
|
27127
|
+
# value, all formats are returned. Applies only when `ShowGuidance` is
|
|
27128
|
+
# `true`.
|
|
27129
|
+
# @return [String]
|
|
27130
|
+
#
|
|
27131
|
+
# @!attribute [rw] max_results
|
|
27132
|
+
# The maximum number of results to return. Valid range is 1-100. If
|
|
27133
|
+
# you don't specify a value, the operation returns up to 25 results.
|
|
27134
|
+
# @return [Integer]
|
|
27135
|
+
#
|
|
27136
|
+
# @!attribute [rw] next_token
|
|
27137
|
+
# The token used to paginate the remediations target list returned. On
|
|
27138
|
+
# your first call to `GetRemediationsV2`, omit this parameter or set
|
|
27139
|
+
# it to `NULL`. For subsequent calls, use the `NextToken` value
|
|
27140
|
+
# returned in the previous response to retrieve the next page of
|
|
27141
|
+
# results.
|
|
27142
|
+
# @return [String]
|
|
27143
|
+
#
|
|
27144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetRemediationsV2Request AWS API Documentation
|
|
27145
|
+
#
|
|
27146
|
+
class GetRemediationsV2Request < Struct.new(
|
|
27147
|
+
:target_uid,
|
|
27148
|
+
:metadata_uid,
|
|
27149
|
+
:filters,
|
|
27150
|
+
:show_guidance,
|
|
27151
|
+
:guidance_format,
|
|
27152
|
+
:max_results,
|
|
27153
|
+
:next_token)
|
|
27154
|
+
SENSITIVE = []
|
|
27155
|
+
include Aws::Structure
|
|
27156
|
+
end
|
|
27157
|
+
|
|
27158
|
+
# @!attribute [rw] items
|
|
27159
|
+
# An array of remediation targets returned by the operation.
|
|
27160
|
+
# @return [Array<Types::RemediationV2Item>]
|
|
27161
|
+
#
|
|
27162
|
+
# @!attribute [rw] next_token
|
|
27163
|
+
# The pagination token to use to request the next page of results.
|
|
27164
|
+
# Otherwise, this parameter is null.
|
|
27165
|
+
# @return [String]
|
|
27166
|
+
#
|
|
27167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetRemediationsV2Response AWS API Documentation
|
|
27168
|
+
#
|
|
27169
|
+
class GetRemediationsV2Response < Struct.new(
|
|
27170
|
+
:items,
|
|
27171
|
+
:next_token)
|
|
27172
|
+
SENSITIVE = []
|
|
27173
|
+
include Aws::Structure
|
|
27174
|
+
end
|
|
27175
|
+
|
|
27052
27176
|
# @!attribute [rw] group_by_rules
|
|
27053
27177
|
# How resource statistics should be aggregated and organized in the
|
|
27054
27178
|
# response.
|
|
@@ -27875,6 +27999,26 @@ module Aws::SecurityHub
|
|
|
27875
27999
|
include Aws::Structure
|
|
27876
28000
|
end
|
|
27877
28001
|
|
|
28002
|
+
# A knowledge base article that provides additional guidance related to
|
|
28003
|
+
# the remediation target.
|
|
28004
|
+
#
|
|
28005
|
+
# @!attribute [rw] title
|
|
28006
|
+
# The title of the `KbArticle`.
|
|
28007
|
+
# @return [String]
|
|
28008
|
+
#
|
|
28009
|
+
# @!attribute [rw] url
|
|
28010
|
+
# The URL of the `KbArticle`.
|
|
28011
|
+
# @return [String]
|
|
28012
|
+
#
|
|
28013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/KbArticle AWS API Documentation
|
|
28014
|
+
#
|
|
28015
|
+
class KbArticle < Struct.new(
|
|
28016
|
+
:title,
|
|
28017
|
+
:url)
|
|
28018
|
+
SENSITIVE = []
|
|
28019
|
+
include Aws::Structure
|
|
28020
|
+
end
|
|
28021
|
+
|
|
27878
28022
|
# A keyword filter for querying findings.
|
|
27879
28023
|
#
|
|
27880
28024
|
# @!attribute [rw] value
|
|
@@ -28275,6 +28419,74 @@ module Aws::SecurityHub
|
|
|
28275
28419
|
include Aws::Structure
|
|
28276
28420
|
end
|
|
28277
28421
|
|
|
28422
|
+
# @!attribute [rw] target_uid
|
|
28423
|
+
# The unique identifier (ID) of an existing remediation target to list
|
|
28424
|
+
# exposure findings for.
|
|
28425
|
+
# @return [String]
|
|
28426
|
+
#
|
|
28427
|
+
# @!attribute [rw] max_results
|
|
28428
|
+
# The maximum number of results to return. Valid range is 1-100. If
|
|
28429
|
+
# you don't specify a value, the operation returns up to 25 results.
|
|
28430
|
+
# @return [Integer]
|
|
28431
|
+
#
|
|
28432
|
+
# @!attribute [rw] next_token
|
|
28433
|
+
# The token used to paginate the exposures list returned. On your
|
|
28434
|
+
# first call to `ListExposuresByRemediationV2`, omit this parameter or
|
|
28435
|
+
# set it to `NULL`. For subsequent calls, use the `NextToken` value
|
|
28436
|
+
# returned in the previous response to retrieve the next page of
|
|
28437
|
+
# results.
|
|
28438
|
+
# @return [String]
|
|
28439
|
+
#
|
|
28440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListExposuresByRemediationV2Request AWS API Documentation
|
|
28441
|
+
#
|
|
28442
|
+
class ListExposuresByRemediationV2Request < Struct.new(
|
|
28443
|
+
:target_uid,
|
|
28444
|
+
:max_results,
|
|
28445
|
+
:next_token)
|
|
28446
|
+
SENSITIVE = []
|
|
28447
|
+
include Aws::Structure
|
|
28448
|
+
end
|
|
28449
|
+
|
|
28450
|
+
# @!attribute [rw] items
|
|
28451
|
+
# An array of exposure findings returned by the operation.
|
|
28452
|
+
# @return [Array<Types::ExposureFinding>]
|
|
28453
|
+
#
|
|
28454
|
+
# @!attribute [rw] target_uid
|
|
28455
|
+
# The unique identifier (ID) of the remediation target that the
|
|
28456
|
+
# exposure findings are associated with.
|
|
28457
|
+
# @return [String]
|
|
28458
|
+
#
|
|
28459
|
+
# @!attribute [rw] resource
|
|
28460
|
+
# Provides comprehensive details about a resource.
|
|
28461
|
+
# @return [Types::RemediationResource]
|
|
28462
|
+
#
|
|
28463
|
+
# @!attribute [rw] total_count
|
|
28464
|
+
# The total count of exposure findings associated with the remediation
|
|
28465
|
+
# target.
|
|
28466
|
+
# @return [Integer]
|
|
28467
|
+
#
|
|
28468
|
+
# @!attribute [rw] trait
|
|
28469
|
+
# The specific trait associated with the remediation target.
|
|
28470
|
+
# @return [Types::RemediationTrait]
|
|
28471
|
+
#
|
|
28472
|
+
# @!attribute [rw] next_token
|
|
28473
|
+
# The pagination token to use to request the next page of results.
|
|
28474
|
+
# Otherwise, this parameter is null.
|
|
28475
|
+
# @return [String]
|
|
28476
|
+
#
|
|
28477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListExposuresByRemediationV2Response AWS API Documentation
|
|
28478
|
+
#
|
|
28479
|
+
class ListExposuresByRemediationV2Response < Struct.new(
|
|
28480
|
+
:items,
|
|
28481
|
+
:target_uid,
|
|
28482
|
+
:resource,
|
|
28483
|
+
:total_count,
|
|
28484
|
+
:trait,
|
|
28485
|
+
:next_token)
|
|
28486
|
+
SENSITIVE = []
|
|
28487
|
+
include Aws::Structure
|
|
28488
|
+
end
|
|
28489
|
+
|
|
28278
28490
|
# @!attribute [rw] next_token
|
|
28279
28491
|
# The token returned with the previous set of results. Identifies the
|
|
28280
28492
|
# next set of results to return.
|
|
@@ -30491,6 +30703,598 @@ module Aws::SecurityHub
|
|
|
30491
30703
|
include Aws::Structure
|
|
30492
30704
|
end
|
|
30493
30705
|
|
|
30706
|
+
# Enables the creation of criteria for remediation targets.
|
|
30707
|
+
#
|
|
30708
|
+
# @!attribute [rw] string_filters
|
|
30709
|
+
# Enables filtering based on string field values.
|
|
30710
|
+
# @return [Array<Types::RemediationStringFilter>]
|
|
30711
|
+
#
|
|
30712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationCompositeFilter AWS API Documentation
|
|
30713
|
+
#
|
|
30714
|
+
class RemediationCompositeFilter < Struct.new(
|
|
30715
|
+
:string_filters)
|
|
30716
|
+
SENSITIVE = []
|
|
30717
|
+
include Aws::Structure
|
|
30718
|
+
end
|
|
30719
|
+
|
|
30720
|
+
# Contains the criteria used to filter remediation targets, such as
|
|
30721
|
+
# resource type, priority, or status.
|
|
30722
|
+
#
|
|
30723
|
+
# @!attribute [rw] composite_filters
|
|
30724
|
+
# A collection of complex filtering conditions that can be applied to
|
|
30725
|
+
# remediation target data.
|
|
30726
|
+
# @return [Array<Types::RemediationCompositeFilter>]
|
|
30727
|
+
#
|
|
30728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationFilters AWS API Documentation
|
|
30729
|
+
#
|
|
30730
|
+
class RemediationFilters < Struct.new(
|
|
30731
|
+
:composite_filters)
|
|
30732
|
+
SENSITIVE = []
|
|
30733
|
+
include Aws::Structure
|
|
30734
|
+
end
|
|
30735
|
+
|
|
30736
|
+
# A remediation guidebook outlining guidance in resolving the
|
|
30737
|
+
# remediation target.
|
|
30738
|
+
#
|
|
30739
|
+
# @!attribute [rw] target_type_name
|
|
30740
|
+
# The name of the remediation target type.
|
|
30741
|
+
# @return [String]
|
|
30742
|
+
#
|
|
30743
|
+
# @!attribute [rw] pattern
|
|
30744
|
+
# The remediation pattern of the remediation target.
|
|
30745
|
+
# @return [String]
|
|
30746
|
+
#
|
|
30747
|
+
# @!attribute [rw] version
|
|
30748
|
+
# The guidance version.
|
|
30749
|
+
# @return [String]
|
|
30750
|
+
#
|
|
30751
|
+
# @!attribute [rw] context
|
|
30752
|
+
# The context behind the remediation target's existence and guidance.
|
|
30753
|
+
# @return [Types::RemediationGuidanceContext]
|
|
30754
|
+
#
|
|
30755
|
+
# @!attribute [rw] specification
|
|
30756
|
+
# The specification of the remediation target guidance. This outlines
|
|
30757
|
+
# required resource parameters and permissions, remediation steps, and
|
|
30758
|
+
# the end state.
|
|
30759
|
+
# @return [Types::RemediationGuidanceSpecification]
|
|
30760
|
+
#
|
|
30761
|
+
# @!attribute [rw] examples
|
|
30762
|
+
# Provided remediation guidance examples in different formats that can
|
|
30763
|
+
# be run for remediating the target.
|
|
30764
|
+
# @return [Types::RemediationGuidanceExamples]
|
|
30765
|
+
#
|
|
30766
|
+
# @!attribute [rw] metadata
|
|
30767
|
+
# The metadata of the remediation guidance.
|
|
30768
|
+
# @return [Types::RemediationGuidanceMetadata]
|
|
30769
|
+
#
|
|
30770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationGuidance AWS API Documentation
|
|
30771
|
+
#
|
|
30772
|
+
class RemediationGuidance < Struct.new(
|
|
30773
|
+
:target_type_name,
|
|
30774
|
+
:pattern,
|
|
30775
|
+
:version,
|
|
30776
|
+
:context,
|
|
30777
|
+
:specification,
|
|
30778
|
+
:examples,
|
|
30779
|
+
:metadata)
|
|
30780
|
+
SENSITIVE = []
|
|
30781
|
+
include Aws::Structure
|
|
30782
|
+
end
|
|
30783
|
+
|
|
30784
|
+
# The context behind the remediation target's existence and guidance.
|
|
30785
|
+
#
|
|
30786
|
+
# @!attribute [rw] problem_statement
|
|
30787
|
+
# Explains the cause which directly created the remediation target.
|
|
30788
|
+
# @return [String]
|
|
30789
|
+
#
|
|
30790
|
+
# @!attribute [rw] risk_assessment
|
|
30791
|
+
# An assessment of the existing risk the remediation target creates.
|
|
30792
|
+
# @return [String]
|
|
30793
|
+
#
|
|
30794
|
+
# @!attribute [rw] affected_scope
|
|
30795
|
+
# The scope of the resources affected by the resolution of the
|
|
30796
|
+
# remediation target.
|
|
30797
|
+
# @return [String]
|
|
30798
|
+
#
|
|
30799
|
+
# @!attribute [rw] prerequisites
|
|
30800
|
+
# An array of prerequisite steps in resolving the remediation target.
|
|
30801
|
+
# @return [Array<String>]
|
|
30802
|
+
#
|
|
30803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationGuidanceContext AWS API Documentation
|
|
30804
|
+
#
|
|
30805
|
+
class RemediationGuidanceContext < Struct.new(
|
|
30806
|
+
:problem_statement,
|
|
30807
|
+
:risk_assessment,
|
|
30808
|
+
:affected_scope,
|
|
30809
|
+
:prerequisites)
|
|
30810
|
+
SENSITIVE = []
|
|
30811
|
+
include Aws::Structure
|
|
30812
|
+
end
|
|
30813
|
+
|
|
30814
|
+
# Provided remediation guidance examples in different formats that can
|
|
30815
|
+
# be run for remediating the target.
|
|
30816
|
+
#
|
|
30817
|
+
# @!attribute [rw] aws_cli
|
|
30818
|
+
# An AWS CLI snippet version of the example.
|
|
30819
|
+
# @return [String]
|
|
30820
|
+
#
|
|
30821
|
+
# @!attribute [rw] cli
|
|
30822
|
+
# A CLI snippet version of the example.
|
|
30823
|
+
# @return [String]
|
|
30824
|
+
#
|
|
30825
|
+
# @!attribute [rw] python
|
|
30826
|
+
# A Python snippet version of the example.
|
|
30827
|
+
# @return [String]
|
|
30828
|
+
#
|
|
30829
|
+
# @!attribute [rw] terraform
|
|
30830
|
+
# A Terraform snippet version of the example.
|
|
30831
|
+
# @return [String]
|
|
30832
|
+
#
|
|
30833
|
+
# @!attribute [rw] cdk
|
|
30834
|
+
# A CDK snippet version of the example.
|
|
30835
|
+
# @return [String]
|
|
30836
|
+
#
|
|
30837
|
+
# @!attribute [rw] cloud_formation
|
|
30838
|
+
# A CloudFormation snippet version of the example.
|
|
30839
|
+
# @return [String]
|
|
30840
|
+
#
|
|
30841
|
+
# @!attribute [rw] ia_c
|
|
30842
|
+
# An IaC snippet version of the example.
|
|
30843
|
+
# @return [String]
|
|
30844
|
+
#
|
|
30845
|
+
# @!attribute [rw] template
|
|
30846
|
+
# A Template snippet version of the example.
|
|
30847
|
+
# @return [String]
|
|
30848
|
+
#
|
|
30849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationGuidanceExamples AWS API Documentation
|
|
30850
|
+
#
|
|
30851
|
+
class RemediationGuidanceExamples < Struct.new(
|
|
30852
|
+
:aws_cli,
|
|
30853
|
+
:cli,
|
|
30854
|
+
:python,
|
|
30855
|
+
:terraform,
|
|
30856
|
+
:cdk,
|
|
30857
|
+
:cloud_formation,
|
|
30858
|
+
:ia_c,
|
|
30859
|
+
:template)
|
|
30860
|
+
SENSITIVE = []
|
|
30861
|
+
include Aws::Structure
|
|
30862
|
+
end
|
|
30863
|
+
|
|
30864
|
+
# The metadata of the remediation guidance.
|
|
30865
|
+
#
|
|
30866
|
+
# @!attribute [rw] resource_type
|
|
30867
|
+
# The resource type of the remediation target.
|
|
30868
|
+
# @return [String]
|
|
30869
|
+
#
|
|
30870
|
+
# @!attribute [rw] exposure_type
|
|
30871
|
+
# The exposure type of the related exposure findings.
|
|
30872
|
+
# @return [String]
|
|
30873
|
+
#
|
|
30874
|
+
# @!attribute [rw] trait_titles
|
|
30875
|
+
# The titles of traits this guidance applies to.
|
|
30876
|
+
# @return [Array<String>]
|
|
30877
|
+
#
|
|
30878
|
+
# @!attribute [rw] reversibility
|
|
30879
|
+
# The extent to which changes made in accordance with the guidance can
|
|
30880
|
+
# be reversed, for example `Fully reversible`.
|
|
30881
|
+
# @return [String]
|
|
30882
|
+
#
|
|
30883
|
+
# @!attribute [rw] fix_effect
|
|
30884
|
+
# When the fix takes effect, for example `Immediate` or `Deferred`.
|
|
30885
|
+
# @return [String]
|
|
30886
|
+
#
|
|
30887
|
+
# @!attribute [rw] risk_level
|
|
30888
|
+
# The risk when implementing the guidance provided.
|
|
30889
|
+
# @return [String]
|
|
30890
|
+
#
|
|
30891
|
+
# @!attribute [rw] automation_level
|
|
30892
|
+
# The extent to which the guidance can be automated, for example
|
|
30893
|
+
# `Full`.
|
|
30894
|
+
# @return [String]
|
|
30895
|
+
#
|
|
30896
|
+
# @!attribute [rw] human_review_required
|
|
30897
|
+
# Specifies whether human review is required.
|
|
30898
|
+
# @return [Boolean]
|
|
30899
|
+
#
|
|
30900
|
+
# @!attribute [rw] generated_at
|
|
30901
|
+
# Timestamp of when the guidance was generated.
|
|
30902
|
+
#
|
|
30903
|
+
# For more information about the validation and formatting of
|
|
30904
|
+
# timestamp fields in Security Hub CSPM, see [Timestamps][1].
|
|
30905
|
+
#
|
|
30906
|
+
#
|
|
30907
|
+
#
|
|
30908
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps
|
|
30909
|
+
# @return [Time]
|
|
30910
|
+
#
|
|
30911
|
+
# @!attribute [rw] verification_status
|
|
30912
|
+
# Verification status of the guidance.
|
|
30913
|
+
# @return [String]
|
|
30914
|
+
#
|
|
30915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationGuidanceMetadata AWS API Documentation
|
|
30916
|
+
#
|
|
30917
|
+
class RemediationGuidanceMetadata < Struct.new(
|
|
30918
|
+
:resource_type,
|
|
30919
|
+
:exposure_type,
|
|
30920
|
+
:trait_titles,
|
|
30921
|
+
:reversibility,
|
|
30922
|
+
:fix_effect,
|
|
30923
|
+
:risk_level,
|
|
30924
|
+
:automation_level,
|
|
30925
|
+
:human_review_required,
|
|
30926
|
+
:generated_at,
|
|
30927
|
+
:verification_status)
|
|
30928
|
+
SENSITIVE = []
|
|
30929
|
+
include Aws::Structure
|
|
30930
|
+
end
|
|
30931
|
+
|
|
30932
|
+
# The specification of the remediation target guidance. This outlines
|
|
30933
|
+
# required resource parameters and permissions, remediation steps, and
|
|
30934
|
+
# the end state.
|
|
30935
|
+
#
|
|
30936
|
+
# @!attribute [rw] parameters
|
|
30937
|
+
# An array of the parameters used in running the steps provided.
|
|
30938
|
+
# @return [Array<Types::RemediationParameter>]
|
|
30939
|
+
#
|
|
30940
|
+
# @!attribute [rw] steps
|
|
30941
|
+
# An array of ordered steps for resolving the remediation targets.
|
|
30942
|
+
# @return [Array<Types::RemediationStep>]
|
|
30943
|
+
#
|
|
30944
|
+
# @!attribute [rw] expected_end_state
|
|
30945
|
+
# The expected end state of the associated resources after completion
|
|
30946
|
+
# of the steps.
|
|
30947
|
+
# @return [String]
|
|
30948
|
+
#
|
|
30949
|
+
# @!attribute [rw] required_permissions
|
|
30950
|
+
# An array of required permissions to run the steps.
|
|
30951
|
+
# @return [Array<String>]
|
|
30952
|
+
#
|
|
30953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationGuidanceSpecification AWS API Documentation
|
|
30954
|
+
#
|
|
30955
|
+
class RemediationGuidanceSpecification < Struct.new(
|
|
30956
|
+
:parameters,
|
|
30957
|
+
:steps,
|
|
30958
|
+
:expected_end_state,
|
|
30959
|
+
:required_permissions)
|
|
30960
|
+
SENSITIVE = []
|
|
30961
|
+
include Aws::Structure
|
|
30962
|
+
end
|
|
30963
|
+
|
|
30964
|
+
# The outcome from resolving the remediation target.
|
|
30965
|
+
#
|
|
30966
|
+
# @!attribute [rw] resolved_findings_count
|
|
30967
|
+
# The number of associated exposure findings that are resolved by
|
|
30968
|
+
# remediating the target.
|
|
30969
|
+
# @return [Integer]
|
|
30970
|
+
#
|
|
30971
|
+
# @!attribute [rw] severity_reduction_findings_count
|
|
30972
|
+
# The number of associated exposure findings whose severity is reduced
|
|
30973
|
+
# by remediating the target.
|
|
30974
|
+
# @return [Integer]
|
|
30975
|
+
#
|
|
30976
|
+
# @!attribute [rw] severity_unchanged_count
|
|
30977
|
+
# The number of associated exposure findings whose severity is
|
|
30978
|
+
# unchanged by remediating the target.
|
|
30979
|
+
# @return [Integer]
|
|
30980
|
+
#
|
|
30981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationOutcome AWS API Documentation
|
|
30982
|
+
#
|
|
30983
|
+
class RemediationOutcome < Struct.new(
|
|
30984
|
+
:resolved_findings_count,
|
|
30985
|
+
:severity_reduction_findings_count,
|
|
30986
|
+
:severity_unchanged_count)
|
|
30987
|
+
SENSITIVE = []
|
|
30988
|
+
include Aws::Structure
|
|
30989
|
+
end
|
|
30990
|
+
|
|
30991
|
+
# A parameter used in running the guidance steps.
|
|
30992
|
+
#
|
|
30993
|
+
# @!attribute [rw] name
|
|
30994
|
+
# The name of the parameter.
|
|
30995
|
+
# @return [String]
|
|
30996
|
+
#
|
|
30997
|
+
# @!attribute [rw] type
|
|
30998
|
+
# The type of the parameter.
|
|
30999
|
+
# @return [String]
|
|
31000
|
+
#
|
|
31001
|
+
# @!attribute [rw] description
|
|
31002
|
+
# A description of the parameter.
|
|
31003
|
+
# @return [String]
|
|
31004
|
+
#
|
|
31005
|
+
# @!attribute [rw] required
|
|
31006
|
+
# Specifies whether the parameter is required for running the guidance
|
|
31007
|
+
# steps.
|
|
31008
|
+
# @return [Boolean]
|
|
31009
|
+
#
|
|
31010
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationParameter AWS API Documentation
|
|
31011
|
+
#
|
|
31012
|
+
class RemediationParameter < Struct.new(
|
|
31013
|
+
:name,
|
|
31014
|
+
:type,
|
|
31015
|
+
:description,
|
|
31016
|
+
:required)
|
|
31017
|
+
SENSITIVE = []
|
|
31018
|
+
include Aws::Structure
|
|
31019
|
+
end
|
|
31020
|
+
|
|
31021
|
+
# Provides comprehensive details about a resource.
|
|
31022
|
+
#
|
|
31023
|
+
# @!attribute [rw] account_id
|
|
31024
|
+
# The Amazon Web Services account that recorded the resource data in
|
|
31025
|
+
# Security Hub.
|
|
31026
|
+
# @return [String]
|
|
31027
|
+
#
|
|
31028
|
+
# @!attribute [rw] region
|
|
31029
|
+
# The Amazon Web Services Region in which Security Hub recorded the
|
|
31030
|
+
# resource data.
|
|
31031
|
+
# @return [String]
|
|
31032
|
+
#
|
|
31033
|
+
# @!attribute [rw] resource_owner_account_id
|
|
31034
|
+
# The identifier of the cloud account that owns the resource. For
|
|
31035
|
+
# Amazon Web Services resources, this is the Amazon Web Services
|
|
31036
|
+
# account ID. For Azure resources, this is the Azure subscription ID.
|
|
31037
|
+
# @return [String]
|
|
31038
|
+
#
|
|
31039
|
+
# @!attribute [rw] resource_owner_org_id
|
|
31040
|
+
# The identifier of the cloud organization that owns the resource. For
|
|
31041
|
+
# Amazon Web Services resources, this is the Organizations ID. For
|
|
31042
|
+
# Azure resources, this is the Azure tenant ID.
|
|
31043
|
+
# @return [String]
|
|
31044
|
+
#
|
|
31045
|
+
# @!attribute [rw] type
|
|
31046
|
+
# The type of the resource.
|
|
31047
|
+
# @return [String]
|
|
31048
|
+
#
|
|
31049
|
+
# @!attribute [rw] name
|
|
31050
|
+
# The name of the resource.
|
|
31051
|
+
# @return [String]
|
|
31052
|
+
#
|
|
31053
|
+
# @!attribute [rw] id
|
|
31054
|
+
# The unique identifier for a resource.
|
|
31055
|
+
# @return [String]
|
|
31056
|
+
#
|
|
31057
|
+
# @!attribute [rw] resource_guid
|
|
31058
|
+
# The global identifier used to identify a resource.
|
|
31059
|
+
# @return [String]
|
|
31060
|
+
#
|
|
31061
|
+
# @!attribute [rw] resource_region
|
|
31062
|
+
# The native cloud region where the resource is located. For Amazon
|
|
31063
|
+
# Web Services, this is an Amazon Web Services Region (for example,
|
|
31064
|
+
# `us-east-1`). For Azure resources, this is the Azure region (for
|
|
31065
|
+
# example, `westus2`). This field is always included.
|
|
31066
|
+
# @return [String]
|
|
31067
|
+
#
|
|
31068
|
+
# @!attribute [rw] cloud_provider
|
|
31069
|
+
# The cloud provider where the resource exists.
|
|
31070
|
+
#
|
|
31071
|
+
# * `AWS` specifies that the resource exists in Amazon Web Services.
|
|
31072
|
+
#
|
|
31073
|
+
# * `Azure` specifies that the resource exists in Microsoft Azure.
|
|
31074
|
+
# @return [String]
|
|
31075
|
+
#
|
|
31076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationResource AWS API Documentation
|
|
31077
|
+
#
|
|
31078
|
+
class RemediationResource < Struct.new(
|
|
31079
|
+
:account_id,
|
|
31080
|
+
:region,
|
|
31081
|
+
:resource_owner_account_id,
|
|
31082
|
+
:resource_owner_org_id,
|
|
31083
|
+
:type,
|
|
31084
|
+
:name,
|
|
31085
|
+
:id,
|
|
31086
|
+
:resource_guid,
|
|
31087
|
+
:resource_region,
|
|
31088
|
+
:cloud_provider)
|
|
31089
|
+
SENSITIVE = []
|
|
31090
|
+
include Aws::Structure
|
|
31091
|
+
end
|
|
31092
|
+
|
|
31093
|
+
# A step in the remediation guidance.
|
|
31094
|
+
#
|
|
31095
|
+
# @!attribute [rw] phase
|
|
31096
|
+
# The phase of the remediation plan that this step belongs to (for
|
|
31097
|
+
# example, `FIX`).
|
|
31098
|
+
# @return [String]
|
|
31099
|
+
#
|
|
31100
|
+
# @!attribute [rw] description
|
|
31101
|
+
# A description of what the step does.
|
|
31102
|
+
# @return [String]
|
|
31103
|
+
#
|
|
31104
|
+
# @!attribute [rw] service
|
|
31105
|
+
# Which service this step is performed in.
|
|
31106
|
+
# @return [String]
|
|
31107
|
+
#
|
|
31108
|
+
# @!attribute [rw] action
|
|
31109
|
+
# The action to be taken for this step.
|
|
31110
|
+
# @return [String]
|
|
31111
|
+
#
|
|
31112
|
+
# @!attribute [rw] logic
|
|
31113
|
+
# The logic behind the existence of this step.
|
|
31114
|
+
# @return [String]
|
|
31115
|
+
#
|
|
31116
|
+
# @!attribute [rw] inverse
|
|
31117
|
+
# The inverse of the step, to be used if the step needs to be rolled
|
|
31118
|
+
# back.
|
|
31119
|
+
# @return [String]
|
|
31120
|
+
#
|
|
31121
|
+
# @!attribute [rw] verify_after
|
|
31122
|
+
# The action to take after the step to verify its success.
|
|
31123
|
+
# @return [String]
|
|
31124
|
+
#
|
|
31125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationStep AWS API Documentation
|
|
31126
|
+
#
|
|
31127
|
+
class RemediationStep < Struct.new(
|
|
31128
|
+
:phase,
|
|
31129
|
+
:description,
|
|
31130
|
+
:service,
|
|
31131
|
+
:action,
|
|
31132
|
+
:logic,
|
|
31133
|
+
:inverse,
|
|
31134
|
+
:verify_after)
|
|
31135
|
+
SENSITIVE = []
|
|
31136
|
+
include Aws::Structure
|
|
31137
|
+
end
|
|
31138
|
+
|
|
31139
|
+
# A string filter for filtering remediation targets.
|
|
31140
|
+
#
|
|
31141
|
+
# @!attribute [rw] field_name
|
|
31142
|
+
# The name of the filter field. Valid values are `Resource.Type`,
|
|
31143
|
+
# `Priority`, `Status`, `Resource.Id`,
|
|
31144
|
+
# `Resource.ResourceOwnerAccountId`, and `Resource.CloudProvider`.
|
|
31145
|
+
# @return [String]
|
|
31146
|
+
#
|
|
31147
|
+
# @!attribute [rw] filter
|
|
31148
|
+
# The string filter definition.
|
|
31149
|
+
# @return [Types::RemediationStringFilterCondition]
|
|
31150
|
+
#
|
|
31151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationStringFilter AWS API Documentation
|
|
31152
|
+
#
|
|
31153
|
+
class RemediationStringFilter < Struct.new(
|
|
31154
|
+
:field_name,
|
|
31155
|
+
:filter)
|
|
31156
|
+
SENSITIVE = []
|
|
31157
|
+
include Aws::Structure
|
|
31158
|
+
end
|
|
31159
|
+
|
|
31160
|
+
# The condition to apply to the string filter.
|
|
31161
|
+
#
|
|
31162
|
+
# @!attribute [rw] value
|
|
31163
|
+
# The value the string filter is comparing against.
|
|
31164
|
+
# @return [String]
|
|
31165
|
+
#
|
|
31166
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationStringFilterCondition AWS API Documentation
|
|
31167
|
+
#
|
|
31168
|
+
class RemediationStringFilterCondition < Struct.new(
|
|
31169
|
+
:value)
|
|
31170
|
+
SENSITIVE = []
|
|
31171
|
+
include Aws::Structure
|
|
31172
|
+
end
|
|
31173
|
+
|
|
31174
|
+
# A summary of the remediation target.
|
|
31175
|
+
#
|
|
31176
|
+
# @!attribute [rw] action
|
|
31177
|
+
# A summarized action to take for the remediation target.
|
|
31178
|
+
# @return [String]
|
|
31179
|
+
#
|
|
31180
|
+
# @!attribute [rw] description
|
|
31181
|
+
# A description of the remediation target.
|
|
31182
|
+
# @return [String]
|
|
31183
|
+
#
|
|
31184
|
+
# @!attribute [rw] is_immediate
|
|
31185
|
+
# Specifies whether the effect of this target is immediate.
|
|
31186
|
+
# @return [Boolean]
|
|
31187
|
+
#
|
|
31188
|
+
# @!attribute [rw] post_remediation_steps
|
|
31189
|
+
# An array of steps to be taken after remediation.
|
|
31190
|
+
# @return [Array<String>]
|
|
31191
|
+
#
|
|
31192
|
+
# @!attribute [rw] kb_articles
|
|
31193
|
+
# An array of `KbArticle` objects.
|
|
31194
|
+
# @return [Array<Types::KbArticle>]
|
|
31195
|
+
#
|
|
31196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationSummaryDetail AWS API Documentation
|
|
31197
|
+
#
|
|
31198
|
+
class RemediationSummaryDetail < Struct.new(
|
|
31199
|
+
:action,
|
|
31200
|
+
:description,
|
|
31201
|
+
:is_immediate,
|
|
31202
|
+
:post_remediation_steps,
|
|
31203
|
+
:kb_articles)
|
|
31204
|
+
SENSITIVE = []
|
|
31205
|
+
include Aws::Structure
|
|
31206
|
+
end
|
|
31207
|
+
|
|
31208
|
+
# The trait associated with the remediation target.
|
|
31209
|
+
#
|
|
31210
|
+
# @!attribute [rw] type
|
|
31211
|
+
# The trait type.
|
|
31212
|
+
# @return [String]
|
|
31213
|
+
#
|
|
31214
|
+
# @!attribute [rw] title
|
|
31215
|
+
# The trait title.
|
|
31216
|
+
# @return [String]
|
|
31217
|
+
#
|
|
31218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationTrait AWS API Documentation
|
|
31219
|
+
#
|
|
31220
|
+
class RemediationTrait < Struct.new(
|
|
31221
|
+
:type,
|
|
31222
|
+
:title)
|
|
31223
|
+
SENSITIVE = []
|
|
31224
|
+
include Aws::Structure
|
|
31225
|
+
end
|
|
31226
|
+
|
|
31227
|
+
# A remediation target.
|
|
31228
|
+
#
|
|
31229
|
+
# @!attribute [rw] target_uid
|
|
31230
|
+
# The unique identifier (ID) of the remediation target.
|
|
31231
|
+
# @return [String]
|
|
31232
|
+
#
|
|
31233
|
+
# @!attribute [rw] outcome
|
|
31234
|
+
# The outcome of the remediation target's resolution.
|
|
31235
|
+
# @return [Types::RemediationOutcome]
|
|
31236
|
+
#
|
|
31237
|
+
# @!attribute [rw] priority
|
|
31238
|
+
# The remediation target's priority. Valid values are `Critical`,
|
|
31239
|
+
# `High`, `Medium`, and `Low`.
|
|
31240
|
+
# @return [String]
|
|
31241
|
+
#
|
|
31242
|
+
# @!attribute [rw] remediation_summary
|
|
31243
|
+
# A summary of the remediation target.
|
|
31244
|
+
# @return [Types::RemediationSummaryDetail]
|
|
31245
|
+
#
|
|
31246
|
+
# @!attribute [rw] resource
|
|
31247
|
+
# The remediation target's associated resource.
|
|
31248
|
+
# @return [Types::RemediationResource]
|
|
31249
|
+
#
|
|
31250
|
+
# @!attribute [rw] status
|
|
31251
|
+
# The current status of the remediation target.
|
|
31252
|
+
#
|
|
31253
|
+
# * `New` specifies that the remediation target was newly identified.
|
|
31254
|
+
#
|
|
31255
|
+
# * `Updated` specifies that the remediation target changed after it
|
|
31256
|
+
# was identified.
|
|
31257
|
+
#
|
|
31258
|
+
# * `Resolved` specifies that the remediation target is no longer
|
|
31259
|
+
# present.
|
|
31260
|
+
# @return [String]
|
|
31261
|
+
#
|
|
31262
|
+
# @!attribute [rw] trait
|
|
31263
|
+
# The trait associated with the remediation target.
|
|
31264
|
+
# @return [Types::RemediationTrait]
|
|
31265
|
+
#
|
|
31266
|
+
# @!attribute [rw] guidance
|
|
31267
|
+
# The remediation target's guidance. Returned only when
|
|
31268
|
+
# `ShowGuidance` is `true` in the request.
|
|
31269
|
+
# @return [Types::RemediationGuidance]
|
|
31270
|
+
#
|
|
31271
|
+
# @!attribute [rw] updated_at
|
|
31272
|
+
# The remediation target's last updated timestamp.
|
|
31273
|
+
#
|
|
31274
|
+
# For more information about the validation and formatting of
|
|
31275
|
+
# timestamp fields in Security Hub CSPM, see [Timestamps][1].
|
|
31276
|
+
#
|
|
31277
|
+
#
|
|
31278
|
+
#
|
|
31279
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps
|
|
31280
|
+
# @return [Time]
|
|
31281
|
+
#
|
|
31282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/RemediationV2Item AWS API Documentation
|
|
31283
|
+
#
|
|
31284
|
+
class RemediationV2Item < Struct.new(
|
|
31285
|
+
:target_uid,
|
|
31286
|
+
:outcome,
|
|
31287
|
+
:priority,
|
|
31288
|
+
:remediation_summary,
|
|
31289
|
+
:resource,
|
|
31290
|
+
:status,
|
|
31291
|
+
:trait,
|
|
31292
|
+
:guidance,
|
|
31293
|
+
:updated_at)
|
|
31294
|
+
SENSITIVE = []
|
|
31295
|
+
include Aws::Structure
|
|
31296
|
+
end
|
|
31297
|
+
|
|
30494
31298
|
# A resource related to a finding.
|
|
30495
31299
|
#
|
|
30496
31300
|
# @!attribute [rw] type
|
|
@@ -33962,7 +34766,14 @@ module Aws::SecurityHub
|
|
|
33962
34766
|
# * To search for values that include the filter value, use
|
|
33963
34767
|
# `CONTAINS`. For example, the filter `Title CONTAINS CloudFront`
|
|
33964
34768
|
# matches findings that have a `Title` that includes the string
|
|
33965
|
-
# CloudFront
|
|
34769
|
+
# `CloudFront`.
|
|
34770
|
+
#
|
|
34771
|
+
# * To search for values that contain a word matching the filter
|
|
34772
|
+
# value, regardless of case, use `CONTAINS_WORD`. For example, the
|
|
34773
|
+
# filter `Title CONTAINS_WORD lambda` matches a finding whose
|
|
34774
|
+
# `Title` is `GuardDuty Lambda Protection`, because the `Title`
|
|
34775
|
+
# contains the word Lambda. Including special characters in the
|
|
34776
|
+
# filter value might produce unexpected search results.
|
|
33966
34777
|
#
|
|
33967
34778
|
# * To search for values that exactly match the filter value, use
|
|
33968
34779
|
# `EQUALS`. For example, the filter `AwsAccountId EQUALS
|