aws-sdk-securityhub 1.77.0 → 1.78.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-securityhub/client.rb +291 -2
- data/lib/aws-sdk-securityhub/client_api.rb +231 -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 +700 -13
- data/lib/aws-sdk-securityhub.rb +1 -1
- metadata +2 -2
@@ -1838,8 +1838,8 @@ module Aws::SecurityHub
|
|
1838
1838
|
# @return [Array<String>]
|
1839
1839
|
#
|
1840
1840
|
# @!attribute [rw] sns_topic_arn
|
1841
|
-
#
|
1842
|
-
# vault
|
1841
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the Amazon
|
1842
|
+
# SNS topic for a backup vault's events.
|
1843
1843
|
# @return [String]
|
1844
1844
|
#
|
1845
1845
|
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AwsBackupBackupVaultNotificationsDetails AWS API Documentation
|
@@ -5216,7 +5216,7 @@ module Aws::SecurityHub
|
|
5216
5216
|
#
|
5217
5217
|
# @!attribute [rw] on_demand_max_price_percentage_over_lowest_price
|
5218
5218
|
# The price protection threshold for On-Demand Instances. This is the
|
5219
|
-
# maximum you
|
5219
|
+
# maximum you'll pay for an On-Demand Instance, expressed as a
|
5220
5220
|
# percentage above the least expensive current generation M, C, or R
|
5221
5221
|
# instance type with your specified attributes. When Amazon EC2
|
5222
5222
|
# selects instance types with your attributes, it excludes instance
|
@@ -5235,7 +5235,7 @@ module Aws::SecurityHub
|
|
5235
5235
|
#
|
5236
5236
|
# @!attribute [rw] spot_max_price_percentage_over_lowest_price
|
5237
5237
|
# The price protection threshold for Spot Instances. This is the
|
5238
|
-
# maximum you
|
5238
|
+
# maximum you'll pay for a Spot Instance, expressed as a percentage
|
5239
5239
|
# above the least expensive current generation M, C, or R instance
|
5240
5240
|
# type with your specified attributes. When Amazon EC2 selects
|
5241
5241
|
# instance types with your attributes, it excludes instance types
|
@@ -5418,7 +5418,7 @@ module Aws::SecurityHub
|
|
5418
5418
|
# @!attribute [rw] http_endpoint
|
5419
5419
|
# Enables or disables the HTTP metadata endpoint on your instances. If
|
5420
5420
|
# the parameter is not specified, the default state is enabled, and
|
5421
|
-
# you won
|
5421
|
+
# you won't be able to access your instance metadata.
|
5422
5422
|
# @return [String]
|
5423
5423
|
#
|
5424
5424
|
# @!attribute [rw] http_protocol_ipv_6
|
@@ -13970,7 +13970,9 @@ module Aws::SecurityHub
|
|
13970
13970
|
include Aws::Structure
|
13971
13971
|
end
|
13972
13972
|
|
13973
|
-
#
|
13973
|
+
# You can configure Amazon Redshift to copy snapshots for a cluster to
|
13974
|
+
# another Amazon Web Services Region. This parameter provides
|
13975
|
+
# information about a cross-Region snapshot copy.
|
13974
13976
|
#
|
13975
13977
|
# @!attribute [rw] destination_region
|
13976
13978
|
# The destination Region that snapshots are automatically copied to
|
@@ -13979,7 +13981,7 @@ module Aws::SecurityHub
|
|
13979
13981
|
#
|
13980
13982
|
# @!attribute [rw] manual_snapshot_retention_period
|
13981
13983
|
# The number of days that manual snapshots are retained in the
|
13982
|
-
# destination
|
13984
|
+
# destination Region after they are copied from a source Region.
|
13983
13985
|
#
|
13984
13986
|
# If the value is `-1`, then the manual snapshot is retained
|
13985
13987
|
# indefinitely.
|
@@ -18234,6 +18236,81 @@ module Aws::SecurityHub
|
|
18234
18236
|
include Aws::Structure
|
18235
18237
|
end
|
18236
18238
|
|
18239
|
+
# @!attribute [rw] security_control_ids
|
18240
|
+
# A list of security controls (identified with `SecurityControlId`,
|
18241
|
+
# `SecurityControlArn`, or a mix of both parameters). The security
|
18242
|
+
# control ID or Amazon Resource Name (ARN) is the same across
|
18243
|
+
# standards.
|
18244
|
+
# @return [Array<String>]
|
18245
|
+
#
|
18246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetSecurityControlsRequest AWS API Documentation
|
18247
|
+
#
|
18248
|
+
class BatchGetSecurityControlsRequest < Struct.new(
|
18249
|
+
:security_control_ids)
|
18250
|
+
SENSITIVE = []
|
18251
|
+
include Aws::Structure
|
18252
|
+
end
|
18253
|
+
|
18254
|
+
# @!attribute [rw] security_controls
|
18255
|
+
# An array that returns the identifier, Amazon Resource Name (ARN),
|
18256
|
+
# and other details about a security control. The same information is
|
18257
|
+
# returned whether the request includes `SecurityControlId` or
|
18258
|
+
# `SecurityControlArn`.
|
18259
|
+
# @return [Array<Types::SecurityControl>]
|
18260
|
+
#
|
18261
|
+
# @!attribute [rw] unprocessed_ids
|
18262
|
+
# A security control (identified with `SecurityControlId`,
|
18263
|
+
# `SecurityControlArn`, or a mix of both parameters) for which details
|
18264
|
+
# cannot be returned.
|
18265
|
+
# @return [Array<Types::UnprocessedSecurityControl>]
|
18266
|
+
#
|
18267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetSecurityControlsResponse AWS API Documentation
|
18268
|
+
#
|
18269
|
+
class BatchGetSecurityControlsResponse < Struct.new(
|
18270
|
+
:security_controls,
|
18271
|
+
:unprocessed_ids)
|
18272
|
+
SENSITIVE = []
|
18273
|
+
include Aws::Structure
|
18274
|
+
end
|
18275
|
+
|
18276
|
+
# @!attribute [rw] standards_control_association_ids
|
18277
|
+
# An array with one or more objects that includes a security control
|
18278
|
+
# (identified with `SecurityControlId`, `SecurityControlArn`, or a mix
|
18279
|
+
# of both parameters) and the Amazon Resource Name (ARN) of a
|
18280
|
+
# standard. This field is used to query the enablement status of a
|
18281
|
+
# control in a specified standard. The security control ID or ARN is
|
18282
|
+
# the same across standards.
|
18283
|
+
# @return [Array<Types::StandardsControlAssociationId>]
|
18284
|
+
#
|
18285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetStandardsControlAssociationsRequest AWS API Documentation
|
18286
|
+
#
|
18287
|
+
class BatchGetStandardsControlAssociationsRequest < Struct.new(
|
18288
|
+
:standards_control_association_ids)
|
18289
|
+
SENSITIVE = []
|
18290
|
+
include Aws::Structure
|
18291
|
+
end
|
18292
|
+
|
18293
|
+
# @!attribute [rw] standards_control_association_details
|
18294
|
+
# Provides the enablement status of a security control in a specified
|
18295
|
+
# standard and other details for the control in relation to the
|
18296
|
+
# specified standard.
|
18297
|
+
# @return [Array<Types::StandardsControlAssociationDetail>]
|
18298
|
+
#
|
18299
|
+
# @!attribute [rw] unprocessed_associations
|
18300
|
+
# A security control (identified with `SecurityControlId`,
|
18301
|
+
# `SecurityControlArn`, or a mix of both parameters) whose enablement
|
18302
|
+
# status in a specified standard cannot be returned.
|
18303
|
+
# @return [Array<Types::UnprocessedStandardsControlAssociation>]
|
18304
|
+
#
|
18305
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetStandardsControlAssociationsResponse AWS API Documentation
|
18306
|
+
#
|
18307
|
+
class BatchGetStandardsControlAssociationsResponse < Struct.new(
|
18308
|
+
:standards_control_association_details,
|
18309
|
+
:unprocessed_associations)
|
18310
|
+
SENSITIVE = []
|
18311
|
+
include Aws::Structure
|
18312
|
+
end
|
18313
|
+
|
18237
18314
|
# @!attribute [rw] findings
|
18238
18315
|
# A list of findings to import. To successfully import a finding, it
|
18239
18316
|
# must follow the [Amazon Web Services Security Finding Format][1].
|
@@ -18455,6 +18532,33 @@ module Aws::SecurityHub
|
|
18455
18532
|
include Aws::Structure
|
18456
18533
|
end
|
18457
18534
|
|
18535
|
+
# @!attribute [rw] standards_control_association_updates
|
18536
|
+
# Updates the enablement status of a security control in a specified
|
18537
|
+
# standard.
|
18538
|
+
# @return [Array<Types::StandardsControlAssociationUpdate>]
|
18539
|
+
#
|
18540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchUpdateStandardsControlAssociationsRequest AWS API Documentation
|
18541
|
+
#
|
18542
|
+
class BatchUpdateStandardsControlAssociationsRequest < Struct.new(
|
18543
|
+
:standards_control_association_updates)
|
18544
|
+
SENSITIVE = []
|
18545
|
+
include Aws::Structure
|
18546
|
+
end
|
18547
|
+
|
18548
|
+
# @!attribute [rw] unprocessed_association_updates
|
18549
|
+
# A security control (identified with `SecurityControlId`,
|
18550
|
+
# `SecurityControlArn`, or a mix of both parameters) whose enablement
|
18551
|
+
# status in a specified standard couldn't be updated.
|
18552
|
+
# @return [Array<Types::UnprocessedStandardsControlAssociationUpdate>]
|
18553
|
+
#
|
18554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchUpdateStandardsControlAssociationsResponse AWS API Documentation
|
18555
|
+
#
|
18556
|
+
class BatchUpdateStandardsControlAssociationsResponse < Struct.new(
|
18557
|
+
:unprocessed_association_updates)
|
18558
|
+
SENSITIVE = []
|
18559
|
+
include Aws::Structure
|
18560
|
+
end
|
18561
|
+
|
18458
18562
|
# Boolean filter for querying findings.
|
18459
18563
|
#
|
18460
18564
|
# @!attribute [rw] value
|
@@ -18769,7 +18873,7 @@ module Aws::SecurityHub
|
|
18769
18873
|
end
|
18770
18874
|
|
18771
18875
|
# @!attribute [rw] action_target_arn
|
18772
|
-
# The ARN for the custom action target.
|
18876
|
+
# The Amazon Resource Name (ARN) for the custom action target.
|
18773
18877
|
# @return [String]
|
18774
18878
|
#
|
18775
18879
|
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateActionTargetResponse AWS API Documentation
|
@@ -19118,7 +19222,8 @@ module Aws::SecurityHub
|
|
19118
19222
|
end
|
19119
19223
|
|
19120
19224
|
# @!attribute [rw] action_target_arn
|
19121
|
-
# The ARN of the custom action target to
|
19225
|
+
# The Amazon Resource Name (ARN) of the custom action target to
|
19226
|
+
# delete.
|
19122
19227
|
# @return [String]
|
19123
19228
|
#
|
19124
19229
|
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteActionTargetRequest AWS API Documentation
|
@@ -19311,12 +19416,30 @@ module Aws::SecurityHub
|
|
19311
19416
|
# enabled.
|
19312
19417
|
# @return [Boolean]
|
19313
19418
|
#
|
19419
|
+
# @!attribute [rw] control_finding_generator
|
19420
|
+
# Specifies whether the calling account has consolidated control
|
19421
|
+
# findings turned on. If the value for this field is set to
|
19422
|
+
# `SECURITY_CONTROL`, Security Hub generates a single finding for a
|
19423
|
+
# control check even when the check applies to multiple enabled
|
19424
|
+
# standards.
|
19425
|
+
#
|
19426
|
+
# If the value for this field is set to `STANDARD_CONTROL`, Security
|
19427
|
+
# Hub generates separate findings for a control check when the check
|
19428
|
+
# applies to multiple enabled standards.
|
19429
|
+
#
|
19430
|
+
# The value for this field in a member account matches the value in
|
19431
|
+
# the administrator account. For accounts that aren't part of an
|
19432
|
+
# organization, the default value of this field is `SECURITY_CONTROL`
|
19433
|
+
# if you enabled Security Hub on or after February 9, 2023.
|
19434
|
+
# @return [String]
|
19435
|
+
#
|
19314
19436
|
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeHubResponse AWS API Documentation
|
19315
19437
|
#
|
19316
19438
|
class DescribeHubResponse < Struct.new(
|
19317
19439
|
:hub_arn,
|
19318
19440
|
:subscribed_at,
|
19319
|
-
:auto_enable_controls
|
19441
|
+
:auto_enable_controls,
|
19442
|
+
:control_finding_generator)
|
19320
19443
|
SENSITIVE = []
|
19321
19444
|
include Aws::Structure
|
19322
19445
|
end
|
@@ -19657,11 +19780,29 @@ module Aws::SecurityHub
|
|
19657
19780
|
# `false`.
|
19658
19781
|
# @return [Boolean]
|
19659
19782
|
#
|
19783
|
+
# @!attribute [rw] control_finding_generator
|
19784
|
+
# This field, used when enabling Security Hub, specifies whether the
|
19785
|
+
# calling account has consolidated control findings turned on. If the
|
19786
|
+
# value for this field is set to `SECURITY_CONTROL`, Security Hub
|
19787
|
+
# generates a single finding for a control check even when the check
|
19788
|
+
# applies to multiple enabled standards.
|
19789
|
+
#
|
19790
|
+
# If the value for this field is set to `STANDARD_CONTROL`, Security
|
19791
|
+
# Hub generates separate findings for a control check when the check
|
19792
|
+
# applies to multiple enabled standards.
|
19793
|
+
#
|
19794
|
+
# The value for this field in a member account matches the value in
|
19795
|
+
# the administrator account. For accounts that aren't part of an
|
19796
|
+
# organization, the default value of this field is `SECURITY_CONTROL`
|
19797
|
+
# if you enabled Security Hub on or after February 9, 2023.
|
19798
|
+
# @return [String]
|
19799
|
+
#
|
19660
19800
|
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/EnableSecurityHubRequest AWS API Documentation
|
19661
19801
|
#
|
19662
19802
|
class EnableSecurityHubRequest < Struct.new(
|
19663
19803
|
:tags,
|
19664
|
-
:enable_default_standards
|
19804
|
+
:enable_default_standards,
|
19805
|
+
:control_finding_generator)
|
19665
19806
|
SENSITIVE = []
|
19666
19807
|
include Aws::Structure
|
19667
19808
|
end
|
@@ -20776,6 +20917,104 @@ module Aws::SecurityHub
|
|
20776
20917
|
include Aws::Structure
|
20777
20918
|
end
|
20778
20919
|
|
20920
|
+
# @!attribute [rw] standards_arn
|
20921
|
+
# The Amazon Resource Name (ARN) of the standard that you want to view
|
20922
|
+
# controls for.
|
20923
|
+
# @return [String]
|
20924
|
+
#
|
20925
|
+
# @!attribute [rw] next_token
|
20926
|
+
# Optional pagination parameter.
|
20927
|
+
# @return [String]
|
20928
|
+
#
|
20929
|
+
# @!attribute [rw] max_results
|
20930
|
+
# An optional parameter that limits the total results of the API
|
20931
|
+
# response to the specified number. If this parameter isn't provided
|
20932
|
+
# in the request, the results include the first 25 security controls
|
20933
|
+
# that apply to the specified standard. The results also include a
|
20934
|
+
# `NextToken` parameter that you can use in a subsequent API call to
|
20935
|
+
# get the next 25 controls. This repeats until all controls for the
|
20936
|
+
# standard are returned.
|
20937
|
+
# @return [Integer]
|
20938
|
+
#
|
20939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListSecurityControlDefinitionsRequest AWS API Documentation
|
20940
|
+
#
|
20941
|
+
class ListSecurityControlDefinitionsRequest < Struct.new(
|
20942
|
+
:standards_arn,
|
20943
|
+
:next_token,
|
20944
|
+
:max_results)
|
20945
|
+
SENSITIVE = []
|
20946
|
+
include Aws::Structure
|
20947
|
+
end
|
20948
|
+
|
20949
|
+
# @!attribute [rw] security_control_definitions
|
20950
|
+
# An array of controls that apply to the specified standard.
|
20951
|
+
# @return [Array<Types::SecurityControlDefinition>]
|
20952
|
+
#
|
20953
|
+
# @!attribute [rw] next_token
|
20954
|
+
# A pagination parameter that's included in the response only if it
|
20955
|
+
# was included in the request.
|
20956
|
+
# @return [String]
|
20957
|
+
#
|
20958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListSecurityControlDefinitionsResponse AWS API Documentation
|
20959
|
+
#
|
20960
|
+
class ListSecurityControlDefinitionsResponse < Struct.new(
|
20961
|
+
:security_control_definitions,
|
20962
|
+
:next_token)
|
20963
|
+
SENSITIVE = []
|
20964
|
+
include Aws::Structure
|
20965
|
+
end
|
20966
|
+
|
20967
|
+
# @!attribute [rw] security_control_id
|
20968
|
+
# The identifier of the control (identified with `SecurityControlId`,
|
20969
|
+
# `SecurityControlArn`, or a mix of both parameters) that you want to
|
20970
|
+
# determine the enablement status of in each enabled standard.
|
20971
|
+
# @return [String]
|
20972
|
+
#
|
20973
|
+
# @!attribute [rw] next_token
|
20974
|
+
# Optional pagination parameter.
|
20975
|
+
# @return [String]
|
20976
|
+
#
|
20977
|
+
# @!attribute [rw] max_results
|
20978
|
+
# An optional parameter that limits the total results of the API
|
20979
|
+
# response to the specified number. If this parameter isn't provided
|
20980
|
+
# in the request, the results include the first 25 standard and
|
20981
|
+
# control associations. The results also include a `NextToken`
|
20982
|
+
# parameter that you can use in a subsequent API call to get the next
|
20983
|
+
# 25 associations. This repeats until all associations for the
|
20984
|
+
# specified control are returned. The number of results is limited by
|
20985
|
+
# the number of supported Security Hub standards that you've enabled
|
20986
|
+
# in the calling account.
|
20987
|
+
# @return [Integer]
|
20988
|
+
#
|
20989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListStandardsControlAssociationsRequest AWS API Documentation
|
20990
|
+
#
|
20991
|
+
class ListStandardsControlAssociationsRequest < Struct.new(
|
20992
|
+
:security_control_id,
|
20993
|
+
:next_token,
|
20994
|
+
:max_results)
|
20995
|
+
SENSITIVE = []
|
20996
|
+
include Aws::Structure
|
20997
|
+
end
|
20998
|
+
|
20999
|
+
# @!attribute [rw] standards_control_association_summaries
|
21000
|
+
# An array that provides the enablement status and other details for
|
21001
|
+
# each security control that applies to each enabled standard.
|
21002
|
+
# @return [Array<Types::StandardsControlAssociationSummary>]
|
21003
|
+
#
|
21004
|
+
# @!attribute [rw] next_token
|
21005
|
+
# A pagination parameter that's included in the response only if it
|
21006
|
+
# was included in the request.
|
21007
|
+
# @return [String]
|
21008
|
+
#
|
21009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListStandardsControlAssociationsResponse AWS API Documentation
|
21010
|
+
#
|
21011
|
+
class ListStandardsControlAssociationsResponse < Struct.new(
|
21012
|
+
:standards_control_association_summaries,
|
21013
|
+
:next_token)
|
21014
|
+
SENSITIVE = []
|
21015
|
+
include Aws::Structure
|
21016
|
+
end
|
21017
|
+
|
20779
21018
|
# @!attribute [rw] resource_arn
|
20780
21019
|
# The ARN of the resource to retrieve tags for.
|
20781
21020
|
# @return [String]
|
@@ -22754,6 +22993,132 @@ module Aws::SecurityHub
|
|
22754
22993
|
include Aws::Structure
|
22755
22994
|
end
|
22756
22995
|
|
22996
|
+
# A security control in Security Hub describes a security best practice
|
22997
|
+
# related to a specific resource.
|
22998
|
+
#
|
22999
|
+
# @!attribute [rw] security_control_id
|
23000
|
+
# The unique identifier of a security control across standards. Values
|
23001
|
+
# for this field typically consist of an Amazon Web Service name and a
|
23002
|
+
# number, such as APIGateway.3.
|
23003
|
+
# @return [String]
|
23004
|
+
#
|
23005
|
+
# @!attribute [rw] security_control_arn
|
23006
|
+
# The Amazon Resource Name (ARN) for a security control across
|
23007
|
+
# standards, such as
|
23008
|
+
# `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`.
|
23009
|
+
# This parameter doesn't mention a specific standard.
|
23010
|
+
# @return [String]
|
23011
|
+
#
|
23012
|
+
# @!attribute [rw] title
|
23013
|
+
# The title of a security control.
|
23014
|
+
# @return [String]
|
23015
|
+
#
|
23016
|
+
# @!attribute [rw] description
|
23017
|
+
# The description of a security control across standards. This
|
23018
|
+
# typically summarizes how Security Hub evaluates the control and the
|
23019
|
+
# conditions under which it produces a failed finding. This parameter
|
23020
|
+
# doesn't reference a specific standard.
|
23021
|
+
# @return [String]
|
23022
|
+
#
|
23023
|
+
# @!attribute [rw] remediation_url
|
23024
|
+
# A link to Security Hub documentation that explains how to remediate
|
23025
|
+
# a failed finding for a security control.
|
23026
|
+
# @return [String]
|
23027
|
+
#
|
23028
|
+
# @!attribute [rw] severity_rating
|
23029
|
+
# The severity of a security control. For more information about how
|
23030
|
+
# Security Hub determines control severity, see [Assigning severity to
|
23031
|
+
# control findings][1] in the *Security Hub User Guide*.
|
23032
|
+
#
|
23033
|
+
#
|
23034
|
+
#
|
23035
|
+
# [1]: https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity
|
23036
|
+
# @return [String]
|
23037
|
+
#
|
23038
|
+
# @!attribute [rw] security_control_status
|
23039
|
+
# The status of a security control based on the compliance status of
|
23040
|
+
# its findings. For more information about how control status is
|
23041
|
+
# determined, see [Determining the overall status of a control from
|
23042
|
+
# its findings][1] in the *Security Hub User Guide*.
|
23043
|
+
#
|
23044
|
+
#
|
23045
|
+
#
|
23046
|
+
# [1]: https://docs.aws.amazon.com/securityhub/latest/userguide/controls-overall-status.html
|
23047
|
+
# @return [String]
|
23048
|
+
#
|
23049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/SecurityControl AWS API Documentation
|
23050
|
+
#
|
23051
|
+
class SecurityControl < Struct.new(
|
23052
|
+
:security_control_id,
|
23053
|
+
:security_control_arn,
|
23054
|
+
:title,
|
23055
|
+
:description,
|
23056
|
+
:remediation_url,
|
23057
|
+
:severity_rating,
|
23058
|
+
:security_control_status)
|
23059
|
+
SENSITIVE = []
|
23060
|
+
include Aws::Structure
|
23061
|
+
end
|
23062
|
+
|
23063
|
+
# Provides metadata for a security control, including its unique
|
23064
|
+
# standard-agnostic identifier, title, description, severity,
|
23065
|
+
# availability in Amazon Web Services Regions, and a link to remediation
|
23066
|
+
# steps.
|
23067
|
+
#
|
23068
|
+
# @!attribute [rw] security_control_id
|
23069
|
+
# The unique identifier of a security control across standards. Values
|
23070
|
+
# for this field typically consist of an Amazon Web Service name and a
|
23071
|
+
# number (for example, APIGateway.3). This parameter differs from
|
23072
|
+
# `SecurityControlArn`, which is a unique Amazon Resource Name (ARN)
|
23073
|
+
# assigned to a control. The ARN references the security control ID
|
23074
|
+
# (for example,
|
23075
|
+
# arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).
|
23076
|
+
# @return [String]
|
23077
|
+
#
|
23078
|
+
# @!attribute [rw] title
|
23079
|
+
# The title of a security control.
|
23080
|
+
# @return [String]
|
23081
|
+
#
|
23082
|
+
# @!attribute [rw] description
|
23083
|
+
# The description of a security control across standards. This
|
23084
|
+
# typically summarizes how Security Hub evaluates the control and the
|
23085
|
+
# conditions under which it produces a failed finding. This parameter
|
23086
|
+
# doesn't reference a specific standard.
|
23087
|
+
# @return [String]
|
23088
|
+
#
|
23089
|
+
# @!attribute [rw] remediation_url
|
23090
|
+
# A link to Security Hub documentation that explains how to remediate
|
23091
|
+
# a failed finding for a security control.
|
23092
|
+
# @return [String]
|
23093
|
+
#
|
23094
|
+
# @!attribute [rw] severity_rating
|
23095
|
+
# The severity of a security control. For more information about how
|
23096
|
+
# Security Hub determines control severity, see [Assigning severity to
|
23097
|
+
# control findings][1] in the *Security Hub User Guide*.
|
23098
|
+
#
|
23099
|
+
#
|
23100
|
+
#
|
23101
|
+
# [1]: https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity
|
23102
|
+
# @return [String]
|
23103
|
+
#
|
23104
|
+
# @!attribute [rw] current_region_availability
|
23105
|
+
# Specifies whether a security control is available in the current
|
23106
|
+
# Amazon Web Services Region.
|
23107
|
+
# @return [String]
|
23108
|
+
#
|
23109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/SecurityControlDefinition AWS API Documentation
|
23110
|
+
#
|
23111
|
+
class SecurityControlDefinition < Struct.new(
|
23112
|
+
:security_control_id,
|
23113
|
+
:title,
|
23114
|
+
:description,
|
23115
|
+
:remediation_url,
|
23116
|
+
:severity_rating,
|
23117
|
+
:current_region_availability)
|
23118
|
+
SENSITIVE = []
|
23119
|
+
include Aws::Structure
|
23120
|
+
end
|
23121
|
+
|
22757
23122
|
# The list of detected instances of sensitive data.
|
22758
23123
|
#
|
22759
23124
|
# @!attribute [rw] count
|
@@ -22810,7 +23175,7 @@ module Aws::SecurityHub
|
|
22810
23175
|
# The severity of the finding.
|
22811
23176
|
#
|
22812
23177
|
# The finding provider can provide the initial severity. The finding
|
22813
|
-
# provider can only update the severity if it
|
23178
|
+
# provider can only update the severity if it hasn't been updated using
|
22814
23179
|
# `BatchUpdateFindings`.
|
22815
23180
|
#
|
22816
23181
|
# The finding must have either `Label` or `Normalized` populated. If
|
@@ -23137,6 +23502,207 @@ module Aws::SecurityHub
|
|
23137
23502
|
include Aws::Structure
|
23138
23503
|
end
|
23139
23504
|
|
23505
|
+
# Provides details about a control's enablement status in a specified
|
23506
|
+
# standard.
|
23507
|
+
#
|
23508
|
+
# @!attribute [rw] standards_arn
|
23509
|
+
# The Amazon Resource Name (ARN) of a security standard.
|
23510
|
+
# @return [String]
|
23511
|
+
#
|
23512
|
+
# @!attribute [rw] security_control_id
|
23513
|
+
# The unique identifier of a security control across standards. Values
|
23514
|
+
# for this field typically consist of an Amazon Web Service name and a
|
23515
|
+
# number, such as APIGateway.3.
|
23516
|
+
# @return [String]
|
23517
|
+
#
|
23518
|
+
# @!attribute [rw] security_control_arn
|
23519
|
+
# The ARN of a security control across standards, such as
|
23520
|
+
# `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`.
|
23521
|
+
# This parameter doesn't mention a specific standard.
|
23522
|
+
# @return [String]
|
23523
|
+
#
|
23524
|
+
# @!attribute [rw] association_status
|
23525
|
+
# Specifies whether a control is enabled or disabled in a specified
|
23526
|
+
# standard.
|
23527
|
+
# @return [String]
|
23528
|
+
#
|
23529
|
+
# @!attribute [rw] related_requirements
|
23530
|
+
# The requirement that underlies a control in the compliance framework
|
23531
|
+
# related to the standard.
|
23532
|
+
# @return [Array<String>]
|
23533
|
+
#
|
23534
|
+
# @!attribute [rw] updated_at
|
23535
|
+
# The time at which the enablement status of the control in the
|
23536
|
+
# specified standard was last updated.
|
23537
|
+
# @return [Time]
|
23538
|
+
#
|
23539
|
+
# @!attribute [rw] updated_reason
|
23540
|
+
# The reason for updating the enablement status of a control in a
|
23541
|
+
# specified standard.
|
23542
|
+
# @return [String]
|
23543
|
+
#
|
23544
|
+
# @!attribute [rw] standards_control_title
|
23545
|
+
# The title of a control. This field may reference a specific
|
23546
|
+
# standard.
|
23547
|
+
# @return [String]
|
23548
|
+
#
|
23549
|
+
# @!attribute [rw] standards_control_description
|
23550
|
+
# The description of a control. This typically summarizes how Security
|
23551
|
+
# Hub evaluates the control and the conditions under which it produces
|
23552
|
+
# a failed finding. This parameter may reference a specific standard.
|
23553
|
+
# @return [String]
|
23554
|
+
#
|
23555
|
+
# @!attribute [rw] standards_control_arns
|
23556
|
+
# Provides the input parameter that Security Hub uses to call the
|
23557
|
+
# [UpdateStandardsControl][1] API. This API can be used to enable or
|
23558
|
+
# disable a control in a specified standard.
|
23559
|
+
#
|
23560
|
+
#
|
23561
|
+
#
|
23562
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_UpdateStandardsControl.html
|
23563
|
+
# @return [Array<String>]
|
23564
|
+
#
|
23565
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/StandardsControlAssociationDetail AWS API Documentation
|
23566
|
+
#
|
23567
|
+
class StandardsControlAssociationDetail < Struct.new(
|
23568
|
+
:standards_arn,
|
23569
|
+
:security_control_id,
|
23570
|
+
:security_control_arn,
|
23571
|
+
:association_status,
|
23572
|
+
:related_requirements,
|
23573
|
+
:updated_at,
|
23574
|
+
:updated_reason,
|
23575
|
+
:standards_control_title,
|
23576
|
+
:standards_control_description,
|
23577
|
+
:standards_control_arns)
|
23578
|
+
SENSITIVE = []
|
23579
|
+
include Aws::Structure
|
23580
|
+
end
|
23581
|
+
|
23582
|
+
# An array with one or more objects that includes a security control
|
23583
|
+
# (identified with `SecurityControlId`, `SecurityControlArn`, or a mix
|
23584
|
+
# of both parameters) and the Amazon Resource Name (ARN) of a standard.
|
23585
|
+
# The security control ID or ARN is the same across standards.
|
23586
|
+
#
|
23587
|
+
# @!attribute [rw] security_control_id
|
23588
|
+
# The unique identifier (identified with `SecurityControlId`,
|
23589
|
+
# `SecurityControlArn`, or a mix of both parameters) of a security
|
23590
|
+
# control across standards.
|
23591
|
+
# @return [String]
|
23592
|
+
#
|
23593
|
+
# @!attribute [rw] standards_arn
|
23594
|
+
# The ARN of a standard.
|
23595
|
+
# @return [String]
|
23596
|
+
#
|
23597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/StandardsControlAssociationId AWS API Documentation
|
23598
|
+
#
|
23599
|
+
class StandardsControlAssociationId < Struct.new(
|
23600
|
+
:security_control_id,
|
23601
|
+
:standards_arn)
|
23602
|
+
SENSITIVE = []
|
23603
|
+
include Aws::Structure
|
23604
|
+
end
|
23605
|
+
|
23606
|
+
# An array that provides the enablement status and other details for
|
23607
|
+
# each control that applies to each enabled standard.
|
23608
|
+
#
|
23609
|
+
# @!attribute [rw] standards_arn
|
23610
|
+
# The Amazon Resource Name (ARN) of a standard.
|
23611
|
+
# @return [String]
|
23612
|
+
#
|
23613
|
+
# @!attribute [rw] security_control_id
|
23614
|
+
# A unique standard-agnostic identifier for a control. Values for this
|
23615
|
+
# field typically consist of an Amazon Web Service and a number, such
|
23616
|
+
# as APIGateway.5. This field doesn't reference a specific standard.
|
23617
|
+
# @return [String]
|
23618
|
+
#
|
23619
|
+
# @!attribute [rw] security_control_arn
|
23620
|
+
# The ARN of a control, such as
|
23621
|
+
# `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`.
|
23622
|
+
# This parameter doesn't mention a specific standard.
|
23623
|
+
# @return [String]
|
23624
|
+
#
|
23625
|
+
# @!attribute [rw] association_status
|
23626
|
+
# The enablement status of a control in a specific standard.
|
23627
|
+
# @return [String]
|
23628
|
+
#
|
23629
|
+
# @!attribute [rw] related_requirements
|
23630
|
+
# The requirement that underlies this control in the compliance
|
23631
|
+
# framework related to the standard.
|
23632
|
+
# @return [Array<String>]
|
23633
|
+
#
|
23634
|
+
# @!attribute [rw] updated_at
|
23635
|
+
# The last time that a control's enablement status in a specified
|
23636
|
+
# standard was updated.
|
23637
|
+
# @return [Time]
|
23638
|
+
#
|
23639
|
+
# @!attribute [rw] updated_reason
|
23640
|
+
# The reason for updating the control's enablement status in a
|
23641
|
+
# specified standard.
|
23642
|
+
# @return [String]
|
23643
|
+
#
|
23644
|
+
# @!attribute [rw] standards_control_title
|
23645
|
+
# The title of a control.
|
23646
|
+
# @return [String]
|
23647
|
+
#
|
23648
|
+
# @!attribute [rw] standards_control_description
|
23649
|
+
# The description of a control. This typically summarizes how Security
|
23650
|
+
# Hub evaluates the control and the conditions under which it produces
|
23651
|
+
# a failed finding. The parameter may reference a specific standard.
|
23652
|
+
# @return [String]
|
23653
|
+
#
|
23654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/StandardsControlAssociationSummary AWS API Documentation
|
23655
|
+
#
|
23656
|
+
class StandardsControlAssociationSummary < Struct.new(
|
23657
|
+
:standards_arn,
|
23658
|
+
:security_control_id,
|
23659
|
+
:security_control_arn,
|
23660
|
+
:association_status,
|
23661
|
+
:related_requirements,
|
23662
|
+
:updated_at,
|
23663
|
+
:updated_reason,
|
23664
|
+
:standards_control_title,
|
23665
|
+
:standards_control_description)
|
23666
|
+
SENSITIVE = []
|
23667
|
+
include Aws::Structure
|
23668
|
+
end
|
23669
|
+
|
23670
|
+
# An array of requested updates to the enablement status of controls in
|
23671
|
+
# specified standards. The objects in the array include a security
|
23672
|
+
# control ID, the Amazon Resource Name (ARN) of the standard, the
|
23673
|
+
# requested enablement status, and the reason for updating the
|
23674
|
+
# enablement status.
|
23675
|
+
#
|
23676
|
+
# @!attribute [rw] standards_arn
|
23677
|
+
# The Amazon Resource Name (ARN) of the standard in which you want to
|
23678
|
+
# update the control's enablement status.
|
23679
|
+
# @return [String]
|
23680
|
+
#
|
23681
|
+
# @!attribute [rw] security_control_id
|
23682
|
+
# The unique identifier for the security control whose enablement
|
23683
|
+
# status you want to update.
|
23684
|
+
# @return [String]
|
23685
|
+
#
|
23686
|
+
# @!attribute [rw] association_status
|
23687
|
+
# The desired enablement status of the control in the standard.
|
23688
|
+
# @return [String]
|
23689
|
+
#
|
23690
|
+
# @!attribute [rw] updated_reason
|
23691
|
+
# The reason for updating the control's enablement status in the
|
23692
|
+
# standard.
|
23693
|
+
# @return [String]
|
23694
|
+
#
|
23695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/StandardsControlAssociationUpdate AWS API Documentation
|
23696
|
+
#
|
23697
|
+
class StandardsControlAssociationUpdate < Struct.new(
|
23698
|
+
:standards_arn,
|
23699
|
+
:security_control_id,
|
23700
|
+
:association_status,
|
23701
|
+
:updated_reason)
|
23702
|
+
SENSITIVE = []
|
23703
|
+
include Aws::Structure
|
23704
|
+
end
|
23705
|
+
|
23140
23706
|
# Provides details about the management of a security standard.
|
23141
23707
|
#
|
23142
23708
|
# @!attribute [rw] company
|
@@ -23505,6 +24071,111 @@ module Aws::SecurityHub
|
|
23505
24071
|
include Aws::Structure
|
23506
24072
|
end
|
23507
24073
|
|
24074
|
+
# Provides details about a security control for which a response
|
24075
|
+
# couldn't be returned.
|
24076
|
+
#
|
24077
|
+
# @!attribute [rw] security_control_id
|
24078
|
+
# The control (identified with `SecurityControlId`,
|
24079
|
+
# `SecurityControlArn`, or a mix of both parameters) for which a
|
24080
|
+
# response couldn't be returned.
|
24081
|
+
# @return [String]
|
24082
|
+
#
|
24083
|
+
# @!attribute [rw] error_code
|
24084
|
+
# The error code for the unprocessed security control.
|
24085
|
+
# @return [String]
|
24086
|
+
#
|
24087
|
+
# @!attribute [rw] error_reason
|
24088
|
+
# The reason why the security control was unprocessed.
|
24089
|
+
# @return [String]
|
24090
|
+
#
|
24091
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UnprocessedSecurityControl AWS API Documentation
|
24092
|
+
#
|
24093
|
+
class UnprocessedSecurityControl < Struct.new(
|
24094
|
+
:security_control_id,
|
24095
|
+
:error_code,
|
24096
|
+
:error_reason)
|
24097
|
+
SENSITIVE = []
|
24098
|
+
include Aws::Structure
|
24099
|
+
end
|
24100
|
+
|
24101
|
+
# Provides details about which control's enablement status couldn't be
|
24102
|
+
# retrieved in a specified standard when calling
|
24103
|
+
# [BatchUpdateStandardsControlAssociations][1]. This parameter also
|
24104
|
+
# provides details about why the request was unprocessed.
|
24105
|
+
#
|
24106
|
+
#
|
24107
|
+
#
|
24108
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html
|
24109
|
+
#
|
24110
|
+
# @!attribute [rw] standards_control_association_id
|
24111
|
+
# An array with one or more objects that includes a security control
|
24112
|
+
# (identified with `SecurityControlId`, `SecurityControlArn`, or a mix
|
24113
|
+
# of both parameters) and the Amazon Resource Name (ARN) of a
|
24114
|
+
# standard. This parameter shows the specific controls for which the
|
24115
|
+
# enablement status couldn't be retrieved in specified standards when
|
24116
|
+
# calling [BatchUpdateStandardsControlAssociations][1].
|
24117
|
+
#
|
24118
|
+
#
|
24119
|
+
#
|
24120
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html
|
24121
|
+
# @return [Types::StandardsControlAssociationId]
|
24122
|
+
#
|
24123
|
+
# @!attribute [rw] error_code
|
24124
|
+
# The error code for the unprocessed standard and control association.
|
24125
|
+
# @return [String]
|
24126
|
+
#
|
24127
|
+
# @!attribute [rw] error_reason
|
24128
|
+
# The reason why the standard and control association was unprocessed.
|
24129
|
+
# @return [String]
|
24130
|
+
#
|
24131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UnprocessedStandardsControlAssociation AWS API Documentation
|
24132
|
+
#
|
24133
|
+
class UnprocessedStandardsControlAssociation < Struct.new(
|
24134
|
+
:standards_control_association_id,
|
24135
|
+
:error_code,
|
24136
|
+
:error_reason)
|
24137
|
+
SENSITIVE = []
|
24138
|
+
include Aws::Structure
|
24139
|
+
end
|
24140
|
+
|
24141
|
+
# Provides details about which control's enablement status could not be
|
24142
|
+
# updated in a specified standard when calling the
|
24143
|
+
# [BatchUpdateStandardsControlAssociations][1] API. This parameter also
|
24144
|
+
# provides details about why the request was unprocessed.
|
24145
|
+
#
|
24146
|
+
#
|
24147
|
+
#
|
24148
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html
|
24149
|
+
#
|
24150
|
+
# @!attribute [rw] standards_control_association_update
|
24151
|
+
# An array of control and standard associations for which an update
|
24152
|
+
# failed when calling [BatchUpdateStandardsControlAssociations][1].
|
24153
|
+
#
|
24154
|
+
#
|
24155
|
+
#
|
24156
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html
|
24157
|
+
# @return [Types::StandardsControlAssociationUpdate]
|
24158
|
+
#
|
24159
|
+
# @!attribute [rw] error_code
|
24160
|
+
# The error code for the unprocessed update of the control's
|
24161
|
+
# enablement status in the specified standard.
|
24162
|
+
# @return [String]
|
24163
|
+
#
|
24164
|
+
# @!attribute [rw] error_reason
|
24165
|
+
# The reason why a control's enablement status in the specified
|
24166
|
+
# standard couldn't be updated.
|
24167
|
+
# @return [String]
|
24168
|
+
#
|
24169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UnprocessedStandardsControlAssociationUpdate AWS API Documentation
|
24170
|
+
#
|
24171
|
+
class UnprocessedStandardsControlAssociationUpdate < Struct.new(
|
24172
|
+
:standards_control_association_update,
|
24173
|
+
:error_code,
|
24174
|
+
:error_reason)
|
24175
|
+
SENSITIVE = []
|
24176
|
+
include Aws::Structure
|
24177
|
+
end
|
24178
|
+
|
23508
24179
|
# @!attribute [rw] resource_arn
|
23509
24180
|
# The ARN of the resource to remove the tags from.
|
23510
24181
|
# @return [String]
|
@@ -23741,10 +24412,26 @@ module Aws::SecurityHub
|
|
23741
24412
|
# `false`.
|
23742
24413
|
# @return [Boolean]
|
23743
24414
|
#
|
24415
|
+
# @!attribute [rw] control_finding_generator
|
24416
|
+
# Updates whether the calling account has consolidated control
|
24417
|
+
# findings turned on. If the value for this field is set to
|
24418
|
+
# `SECURITY_CONTROL`, Security Hub generates a single finding for a
|
24419
|
+
# control check even when the check applies to multiple enabled
|
24420
|
+
# standards.
|
24421
|
+
#
|
24422
|
+
# If the value for this field is set to `STANDARD_CONTROL`, Security
|
24423
|
+
# Hub generates separate findings for a control check when the check
|
24424
|
+
# applies to multiple enabled standards.
|
24425
|
+
#
|
24426
|
+
# For accounts that are part of an organization, this value can only
|
24427
|
+
# be updated in the administrator account.
|
24428
|
+
# @return [String]
|
24429
|
+
#
|
23744
24430
|
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateSecurityHubConfigurationRequest AWS API Documentation
|
23745
24431
|
#
|
23746
24432
|
class UpdateSecurityHubConfigurationRequest < Struct.new(
|
23747
|
-
:auto_enable_controls
|
24433
|
+
:auto_enable_controls,
|
24434
|
+
:control_finding_generator)
|
23748
24435
|
SENSITIVE = []
|
23749
24436
|
include Aws::Structure
|
23750
24437
|
end
|