aws-sdk-securityhub 1.166.0 → 1.168.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 +859 -14
- data/lib/aws-sdk-securityhub/client_api.rb +201 -0
- data/lib/aws-sdk-securityhub/types.rb +606 -4
- data/lib/aws-sdk-securityhub.rb +1 -1
- data/sig/client.rbs +80 -2
- data/sig/params.rbs +86 -82
- data/sig/types.rbs +154 -6
- metadata +1 -1
|
@@ -752,12 +752,18 @@ module Aws::SecurityHub
|
|
|
752
752
|
# systems or service.
|
|
753
753
|
# @return [Types::ExternalIntegrationConfiguration]
|
|
754
754
|
#
|
|
755
|
+
# @!attribute [rw] resource_fields_update
|
|
756
|
+
# The changes to be applied to resource fields when an automation rule
|
|
757
|
+
# is triggered.
|
|
758
|
+
# @return [Types::AutomationRulesResourceFieldsUpdateV2]
|
|
759
|
+
#
|
|
755
760
|
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AutomationRulesActionV2 AWS API Documentation
|
|
756
761
|
#
|
|
757
762
|
class AutomationRulesActionV2 < Struct.new(
|
|
758
763
|
:type,
|
|
759
764
|
:finding_fields_update,
|
|
760
|
-
:external_integration_configuration
|
|
765
|
+
:external_integration_configuration,
|
|
766
|
+
:resource_fields_update)
|
|
761
767
|
SENSITIVE = []
|
|
762
768
|
include Aws::Structure
|
|
763
769
|
end
|
|
@@ -1477,6 +1483,22 @@ module Aws::SecurityHub
|
|
|
1477
1483
|
include Aws::Structure
|
|
1478
1484
|
end
|
|
1479
1485
|
|
|
1486
|
+
# Allows you to define the structure for modifying specific fields of
|
|
1487
|
+
# resources.
|
|
1488
|
+
#
|
|
1489
|
+
# @!attribute [rw] criticality
|
|
1490
|
+
# The criticality level to be assigned to resources that match the
|
|
1491
|
+
# automation rule criteria.
|
|
1492
|
+
# @return [String]
|
|
1493
|
+
#
|
|
1494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AutomationRulesResourceFieldsUpdateV2 AWS API Documentation
|
|
1495
|
+
#
|
|
1496
|
+
class AutomationRulesResourceFieldsUpdateV2 < Struct.new(
|
|
1497
|
+
:criticality)
|
|
1498
|
+
SENSITIVE = []
|
|
1499
|
+
include Aws::Structure
|
|
1500
|
+
end
|
|
1501
|
+
|
|
1480
1502
|
# Information about an Availability Zone.
|
|
1481
1503
|
#
|
|
1482
1504
|
# @!attribute [rw] zone_name
|
|
@@ -22565,6 +22587,36 @@ module Aws::SecurityHub
|
|
|
22565
22587
|
include Aws::Structure
|
|
22566
22588
|
end
|
|
22567
22589
|
|
|
22590
|
+
# @!attribute [rw] export_job_id
|
|
22591
|
+
# The unique identifier of the export job to cancel. This is the value
|
|
22592
|
+
# returned by `StartExportJobV2`.
|
|
22593
|
+
# @return [String]
|
|
22594
|
+
#
|
|
22595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CancelExportJobV2Request AWS API Documentation
|
|
22596
|
+
#
|
|
22597
|
+
class CancelExportJobV2Request < Struct.new(
|
|
22598
|
+
:export_job_id)
|
|
22599
|
+
SENSITIVE = []
|
|
22600
|
+
include Aws::Structure
|
|
22601
|
+
end
|
|
22602
|
+
|
|
22603
|
+
# @!attribute [rw] export_job_id
|
|
22604
|
+
# The unique identifier of the export job.
|
|
22605
|
+
# @return [String]
|
|
22606
|
+
#
|
|
22607
|
+
# @!attribute [rw] status
|
|
22608
|
+
# The state of the export job after the cancel request.
|
|
22609
|
+
# @return [String]
|
|
22610
|
+
#
|
|
22611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CancelExportJobV2Response AWS API Documentation
|
|
22612
|
+
#
|
|
22613
|
+
class CancelExportJobV2Response < Struct.new(
|
|
22614
|
+
:export_job_id,
|
|
22615
|
+
:status)
|
|
22616
|
+
SENSITIVE = []
|
|
22617
|
+
include Aws::Structure
|
|
22618
|
+
end
|
|
22619
|
+
|
|
22568
22620
|
# An occurrence of sensitive data detected in a Microsoft Excel
|
|
22569
22621
|
# workbook, comma-separated value (CSV) file, or tab-separated value
|
|
22570
22622
|
# (TSV) file.
|
|
@@ -23919,7 +23971,7 @@ module Aws::SecurityHub
|
|
|
23919
23971
|
end
|
|
23920
23972
|
|
|
23921
23973
|
# Defines the parameters and conditions used to evaluate and filter
|
|
23922
|
-
# security findings.
|
|
23974
|
+
# security findings or resources.
|
|
23923
23975
|
#
|
|
23924
23976
|
# @note Criteria is a union - when making an API calls you must set exactly one of the members.
|
|
23925
23977
|
#
|
|
@@ -23929,19 +23981,44 @@ module Aws::SecurityHub
|
|
|
23929
23981
|
# The filtering conditions that align with OCSF standards.
|
|
23930
23982
|
# @return [Types::OcsfFindingFilters]
|
|
23931
23983
|
#
|
|
23984
|
+
# @!attribute [rw] resource_criteria
|
|
23985
|
+
# The filtering conditions for resources.
|
|
23986
|
+
# @return [Types::ResourcesFilters]
|
|
23987
|
+
#
|
|
23932
23988
|
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/Criteria AWS API Documentation
|
|
23933
23989
|
#
|
|
23934
23990
|
class Criteria < Struct.new(
|
|
23935
23991
|
:ocsf_finding_criteria,
|
|
23992
|
+
:resource_criteria,
|
|
23936
23993
|
:unknown)
|
|
23937
23994
|
SENSITIVE = []
|
|
23938
23995
|
include Aws::Structure
|
|
23939
23996
|
include Aws::Structure::Union
|
|
23940
23997
|
|
|
23941
23998
|
class OcsfFindingCriteria < Criteria; end
|
|
23999
|
+
class ResourceCriteria < Criteria; end
|
|
23942
24000
|
class Unknown < Criteria; end
|
|
23943
24001
|
end
|
|
23944
24002
|
|
|
24003
|
+
# Details the source and reason of a criticality.
|
|
24004
|
+
#
|
|
24005
|
+
# @!attribute [rw] source
|
|
24006
|
+
# The source of the criticality.
|
|
24007
|
+
# @return [String]
|
|
24008
|
+
#
|
|
24009
|
+
# @!attribute [rw] reason
|
|
24010
|
+
# The reason the criticality was assigned.
|
|
24011
|
+
# @return [String]
|
|
24012
|
+
#
|
|
24013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CriticalitySource AWS API Documentation
|
|
24014
|
+
#
|
|
24015
|
+
class CriticalitySource < Struct.new(
|
|
24016
|
+
:source,
|
|
24017
|
+
:reason)
|
|
24018
|
+
SENSITIVE = []
|
|
24019
|
+
include Aws::Structure
|
|
24020
|
+
end
|
|
24021
|
+
|
|
23945
24022
|
# A summary of a CSPM connector.
|
|
23946
24023
|
#
|
|
23947
24024
|
# @!attribute [rw] connector_arn
|
|
@@ -25300,6 +25377,187 @@ module Aws::SecurityHub
|
|
|
25300
25377
|
include Aws::Structure
|
|
25301
25378
|
end
|
|
25302
25379
|
|
|
25380
|
+
# Specifies where Security Hub writes the export output. This is a
|
|
25381
|
+
# union: you must specify exactly one member. Currently, the only
|
|
25382
|
+
# supported member is `S3`.
|
|
25383
|
+
#
|
|
25384
|
+
# @note ExportDestination is a union - when making an API calls you must set exactly one of the members.
|
|
25385
|
+
#
|
|
25386
|
+
# @note ExportDestination is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ExportDestination corresponding to the set member.
|
|
25387
|
+
#
|
|
25388
|
+
# @!attribute [rw] s3
|
|
25389
|
+
# The Amazon Simple Storage Service (Amazon S3) bucket and Amazon Web
|
|
25390
|
+
# Services Key Management Service (Amazon Web Services KMS) key that
|
|
25391
|
+
# Security Hub uses to write the export.
|
|
25392
|
+
# @return [Types::S3ExportDestination]
|
|
25393
|
+
#
|
|
25394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ExportDestination AWS API Documentation
|
|
25395
|
+
#
|
|
25396
|
+
class ExportDestination < Struct.new(
|
|
25397
|
+
:s3,
|
|
25398
|
+
:unknown)
|
|
25399
|
+
SENSITIVE = []
|
|
25400
|
+
include Aws::Structure
|
|
25401
|
+
include Aws::Structure::Union
|
|
25402
|
+
|
|
25403
|
+
class S3 < ExportDestination; end
|
|
25404
|
+
class Unknown < ExportDestination; end
|
|
25405
|
+
end
|
|
25406
|
+
|
|
25407
|
+
# Specifies what data to export and how to format it. This is a union:
|
|
25408
|
+
# you must specify exactly one member. Currently, the only supported
|
|
25409
|
+
# member is `Findings`.
|
|
25410
|
+
#
|
|
25411
|
+
# @note ExportOutput is a union - when making an API calls you must set exactly one of the members.
|
|
25412
|
+
#
|
|
25413
|
+
# @note ExportOutput is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ExportOutput corresponding to the set member.
|
|
25414
|
+
#
|
|
25415
|
+
# @!attribute [rw] findings
|
|
25416
|
+
# Configures an export of Security Hub findings, including the output
|
|
25417
|
+
# format and any filters or selected fields.
|
|
25418
|
+
# @return [Types::FindingsOutput]
|
|
25419
|
+
#
|
|
25420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ExportOutput AWS API Documentation
|
|
25421
|
+
#
|
|
25422
|
+
class ExportOutput < Struct.new(
|
|
25423
|
+
:findings,
|
|
25424
|
+
:unknown)
|
|
25425
|
+
SENSITIVE = []
|
|
25426
|
+
include Aws::Structure
|
|
25427
|
+
include Aws::Structure::Union
|
|
25428
|
+
|
|
25429
|
+
class Findings < ExportOutput; end
|
|
25430
|
+
class Unknown < ExportOutput; end
|
|
25431
|
+
end
|
|
25432
|
+
|
|
25433
|
+
# A summary of the output configuration for an export job. The populated
|
|
25434
|
+
# member corresponds to the data type that was exported.
|
|
25435
|
+
#
|
|
25436
|
+
# @note ExportOutputSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ExportOutputSummary corresponding to the set member.
|
|
25437
|
+
#
|
|
25438
|
+
# @!attribute [rw] findings
|
|
25439
|
+
# The output configuration summary for a findings export.
|
|
25440
|
+
# @return [Types::FindingsOutputSummary]
|
|
25441
|
+
#
|
|
25442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ExportOutputSummary AWS API Documentation
|
|
25443
|
+
#
|
|
25444
|
+
class ExportOutputSummary < Struct.new(
|
|
25445
|
+
:findings,
|
|
25446
|
+
:unknown)
|
|
25447
|
+
SENSITIVE = []
|
|
25448
|
+
include Aws::Structure
|
|
25449
|
+
include Aws::Structure::Union
|
|
25450
|
+
|
|
25451
|
+
class Findings < ExportOutputSummary; end
|
|
25452
|
+
class Unknown < ExportOutputSummary; end
|
|
25453
|
+
end
|
|
25454
|
+
|
|
25455
|
+
# Defines the data boundary for a findings export. Scopes determine
|
|
25456
|
+
# which organizational units or organizations to retrieve data from.
|
|
25457
|
+
#
|
|
25458
|
+
# Only a delegated administrator can use this structure. If a delegated
|
|
25459
|
+
# administrator omits it, the export covers the entire organization; any
|
|
25460
|
+
# other caller exports only findings from its own account.
|
|
25461
|
+
#
|
|
25462
|
+
# @!attribute [rw] aws_organizations
|
|
25463
|
+
# A list of Organizations scopes to include in the export. Each entry
|
|
25464
|
+
# in the list specifies an organization or organizational unit to
|
|
25465
|
+
# include for the delegated administrator's account. If the list
|
|
25466
|
+
# specifies multiple entries, the entries are combined using OR logic.
|
|
25467
|
+
# @return [Array<Types::AwsOrganizationScope>]
|
|
25468
|
+
#
|
|
25469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ExportScopes AWS API Documentation
|
|
25470
|
+
#
|
|
25471
|
+
class ExportScopes < Struct.new(
|
|
25472
|
+
:aws_organizations)
|
|
25473
|
+
SENSITIVE = []
|
|
25474
|
+
include Aws::Structure
|
|
25475
|
+
end
|
|
25476
|
+
|
|
25477
|
+
# A summary of an export job, as returned by `ListExportJobsV2`.
|
|
25478
|
+
#
|
|
25479
|
+
# @!attribute [rw] export_job_id
|
|
25480
|
+
# The unique identifier of the export job.
|
|
25481
|
+
# @return [String]
|
|
25482
|
+
#
|
|
25483
|
+
# @!attribute [rw] name
|
|
25484
|
+
# The user-provided name of the export job, if one was specified.
|
|
25485
|
+
# @return [String]
|
|
25486
|
+
#
|
|
25487
|
+
# @!attribute [rw] status
|
|
25488
|
+
# The current state of the export job.
|
|
25489
|
+
# @return [String]
|
|
25490
|
+
#
|
|
25491
|
+
# @!attribute [rw] data_type
|
|
25492
|
+
# The category of data that the export job produces.
|
|
25493
|
+
# @return [String]
|
|
25494
|
+
#
|
|
25495
|
+
# @!attribute [rw] output_configuration
|
|
25496
|
+
# The output configuration of the export job. For findings exports,
|
|
25497
|
+
# this reports the output format. Present only for findings exports;
|
|
25498
|
+
# absent for other data types.
|
|
25499
|
+
# @return [Types::ExportOutputSummary]
|
|
25500
|
+
#
|
|
25501
|
+
# @!attribute [rw] scopes
|
|
25502
|
+
# The organization scopes that the export job was started with, echoed
|
|
25503
|
+
# verbatim. Absent if the caller didn't supply `Scopes`.
|
|
25504
|
+
# @return [Types::ExportScopes]
|
|
25505
|
+
#
|
|
25506
|
+
# @!attribute [rw] destination
|
|
25507
|
+
# The destination that the export job writes to.
|
|
25508
|
+
# @return [Types::ExportDestination]
|
|
25509
|
+
#
|
|
25510
|
+
# @!attribute [rw] failure_code
|
|
25511
|
+
# A code that classifies why the export job failed. Present only when
|
|
25512
|
+
# `Status` is `FAILED`.
|
|
25513
|
+
# @return [String]
|
|
25514
|
+
#
|
|
25515
|
+
# @!attribute [rw] failure_message
|
|
25516
|
+
# A human-readable message about why the export job failed. Present
|
|
25517
|
+
# only when `Status` is `FAILED`.
|
|
25518
|
+
# @return [String]
|
|
25519
|
+
#
|
|
25520
|
+
# @!attribute [rw] started_at
|
|
25521
|
+
# The time when the export job was created.
|
|
25522
|
+
#
|
|
25523
|
+
# For more information about the validation and formatting of
|
|
25524
|
+
# timestamp fields in Security Hub, see [Timestamps][1].
|
|
25525
|
+
#
|
|
25526
|
+
#
|
|
25527
|
+
#
|
|
25528
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps
|
|
25529
|
+
# @return [Time]
|
|
25530
|
+
#
|
|
25531
|
+
# @!attribute [rw] ended_at
|
|
25532
|
+
# The time when the export job reached a terminal state. Absent while
|
|
25533
|
+
# the job is `RUNNING`.
|
|
25534
|
+
#
|
|
25535
|
+
# For more information about the validation and formatting of
|
|
25536
|
+
# timestamp fields in Security Hub, see [Timestamps][1].
|
|
25537
|
+
#
|
|
25538
|
+
#
|
|
25539
|
+
#
|
|
25540
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps
|
|
25541
|
+
# @return [Time]
|
|
25542
|
+
#
|
|
25543
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ExportSummary AWS API Documentation
|
|
25544
|
+
#
|
|
25545
|
+
class ExportSummary < Struct.new(
|
|
25546
|
+
:export_job_id,
|
|
25547
|
+
:name,
|
|
25548
|
+
:status,
|
|
25549
|
+
:data_type,
|
|
25550
|
+
:output_configuration,
|
|
25551
|
+
:scopes,
|
|
25552
|
+
:destination,
|
|
25553
|
+
:failure_code,
|
|
25554
|
+
:failure_message,
|
|
25555
|
+
:started_at,
|
|
25556
|
+
:ended_at)
|
|
25557
|
+
SENSITIVE = []
|
|
25558
|
+
include Aws::Structure
|
|
25559
|
+
end
|
|
25560
|
+
|
|
25303
25561
|
# Provides details about an exposure finding and the effect the specific
|
|
25304
25562
|
# remediation target has on it.
|
|
25305
25563
|
#
|
|
@@ -25731,6 +25989,69 @@ module Aws::SecurityHub
|
|
|
25731
25989
|
include Aws::Structure
|
|
25732
25990
|
end
|
|
25733
25991
|
|
|
25992
|
+
# The configuration for a findings export: the output format, an
|
|
25993
|
+
# optional set of filters, and the fields to include.
|
|
25994
|
+
#
|
|
25995
|
+
# @!attribute [rw] format
|
|
25996
|
+
# The output format of the export. `CSV` produces comma-separated rows
|
|
25997
|
+
# that are suitable for spreadsheets and analysis tools. `OCSF_JSON`
|
|
25998
|
+
# produces newline-delimited JSON records in the Open Cybersecurity
|
|
25999
|
+
# Schema Framework (OCSF) format used elsewhere in Security Hub.
|
|
26000
|
+
# @return [String]
|
|
26001
|
+
#
|
|
26002
|
+
# @!attribute [rw] filters
|
|
26003
|
+
# An optional set of OCSF finding filters that restrict which findings
|
|
26004
|
+
# are exported. The filter structure is the same as the one used by
|
|
26005
|
+
# `GetFindingsV2`. If you omit this member, Security Hub exports all
|
|
26006
|
+
# findings available to the caller. When echoed by `GetExportJobV2`,
|
|
26007
|
+
# relative date ranges are returned unresolved.
|
|
26008
|
+
# @return [Types::OcsfFindingFilters]
|
|
26009
|
+
#
|
|
26010
|
+
# @!attribute [rw] selected_fields
|
|
26011
|
+
# The OCSF finding fields to include in the export, specified as OCSF
|
|
26012
|
+
# field paths (for example, `finding_info.title` or `severity`). You
|
|
26013
|
+
# can specify from 1 to 50 fields.
|
|
26014
|
+
#
|
|
26015
|
+
# Whether this parameter is required depends on the value of `Format`:
|
|
26016
|
+
#
|
|
26017
|
+
# * `CSV` – Required. The field paths that you specify become the
|
|
26018
|
+
# columns of the output, in the order that you provide them. If you
|
|
26019
|
+
# omit this parameter, the request returns a `ValidationException`.
|
|
26020
|
+
#
|
|
26021
|
+
# * `OCSF_JSON` – Not supported. This format includes each finding in
|
|
26022
|
+
# full, so field selection doesn't apply. If you specify this
|
|
26023
|
+
# parameter, the request returns a `ValidationException`.
|
|
26024
|
+
# @return [Array<String>]
|
|
26025
|
+
#
|
|
26026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/FindingsOutput AWS API Documentation
|
|
26027
|
+
#
|
|
26028
|
+
class FindingsOutput < Struct.new(
|
|
26029
|
+
:format,
|
|
26030
|
+
:filters,
|
|
26031
|
+
:selected_fields)
|
|
26032
|
+
SENSITIVE = []
|
|
26033
|
+
include Aws::Structure
|
|
26034
|
+
end
|
|
26035
|
+
|
|
26036
|
+
# A summary of the output configuration for a findings export, returned
|
|
26037
|
+
# by `ListExportJobsV2`. Unlike the configuration returned by
|
|
26038
|
+
# `GetExportJobV2`, it reports only the output format.
|
|
26039
|
+
#
|
|
26040
|
+
# @!attribute [rw] format
|
|
26041
|
+
# The output format of the export. `CSV` produces comma-separated rows
|
|
26042
|
+
# that are suitable for spreadsheets and analysis tools. `OCSF_JSON`
|
|
26043
|
+
# produces newline-delimited JSON records in the Open Cybersecurity
|
|
26044
|
+
# Schema Framework (OCSF) format used elsewhere in Security Hub.
|
|
26045
|
+
# @return [String]
|
|
26046
|
+
#
|
|
26047
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/FindingsOutputSummary AWS API Documentation
|
|
26048
|
+
#
|
|
26049
|
+
class FindingsOutputSummary < Struct.new(
|
|
26050
|
+
:format)
|
|
26051
|
+
SENSITIVE = []
|
|
26052
|
+
include Aws::Structure
|
|
26053
|
+
end
|
|
26054
|
+
|
|
25734
26055
|
# A filter structure that contains a logical combination of string
|
|
25735
26056
|
# filters and nested composite filters for findings trend data.
|
|
25736
26057
|
#
|
|
@@ -26512,6 +26833,105 @@ module Aws::SecurityHub
|
|
|
26512
26833
|
include Aws::Structure
|
|
26513
26834
|
end
|
|
26514
26835
|
|
|
26836
|
+
# @!attribute [rw] export_job_id
|
|
26837
|
+
# The unique identifier of the export job to retrieve. This is the
|
|
26838
|
+
# value returned by `StartExportJobV2`.
|
|
26839
|
+
# @return [String]
|
|
26840
|
+
#
|
|
26841
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetExportJobV2Request AWS API Documentation
|
|
26842
|
+
#
|
|
26843
|
+
class GetExportJobV2Request < Struct.new(
|
|
26844
|
+
:export_job_id)
|
|
26845
|
+
SENSITIVE = []
|
|
26846
|
+
include Aws::Structure
|
|
26847
|
+
end
|
|
26848
|
+
|
|
26849
|
+
# @!attribute [rw] export_job_id
|
|
26850
|
+
# The unique identifier of the export job.
|
|
26851
|
+
# @return [String]
|
|
26852
|
+
#
|
|
26853
|
+
# @!attribute [rw] name
|
|
26854
|
+
# The user-provided name of the export job, if one was specified when
|
|
26855
|
+
# the job was started.
|
|
26856
|
+
# @return [String]
|
|
26857
|
+
#
|
|
26858
|
+
# @!attribute [rw] status
|
|
26859
|
+
# The current state of the export job.
|
|
26860
|
+
# @return [String]
|
|
26861
|
+
#
|
|
26862
|
+
# @!attribute [rw] data_type
|
|
26863
|
+
# The category of data that the export job produces.
|
|
26864
|
+
# @return [String]
|
|
26865
|
+
#
|
|
26866
|
+
# @!attribute [rw] output_configuration
|
|
26867
|
+
# The output configuration that the export job was started with,
|
|
26868
|
+
# including the format and any filters or selected fields.
|
|
26869
|
+
# @return [Types::ExportOutput]
|
|
26870
|
+
#
|
|
26871
|
+
# @!attribute [rw] scopes
|
|
26872
|
+
# The organization scopes that the export job was started with, echoed
|
|
26873
|
+
# verbatim. This parameter is absent if the caller didn't supply
|
|
26874
|
+
# `Scopes`. It contains only the organization or organizational unit
|
|
26875
|
+
# (OU) identifiers that the caller submitted; it never contains
|
|
26876
|
+
# resolved member-account identifiers.
|
|
26877
|
+
# @return [Types::ExportScopes]
|
|
26878
|
+
#
|
|
26879
|
+
# @!attribute [rw] destination
|
|
26880
|
+
# The destination that the export job writes to.
|
|
26881
|
+
# @return [Types::ExportDestination]
|
|
26882
|
+
#
|
|
26883
|
+
# @!attribute [rw] failure_code
|
|
26884
|
+
# A code that classifies why the export job failed. Present only when
|
|
26885
|
+
# `Status` is `FAILED`.
|
|
26886
|
+
# @return [String]
|
|
26887
|
+
#
|
|
26888
|
+
# @!attribute [rw] failure_message
|
|
26889
|
+
# A human-readable message that provides more detail about why the
|
|
26890
|
+
# export job failed. Present only when `Status` is `FAILED`.
|
|
26891
|
+
# @return [String]
|
|
26892
|
+
#
|
|
26893
|
+
# @!attribute [rw] started_at
|
|
26894
|
+
# The time when the export job was created.
|
|
26895
|
+
#
|
|
26896
|
+
# For more information about the validation and formatting of
|
|
26897
|
+
# timestamp fields in Security Hub, see [Timestamps][1].
|
|
26898
|
+
#
|
|
26899
|
+
#
|
|
26900
|
+
#
|
|
26901
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps
|
|
26902
|
+
# @return [Time]
|
|
26903
|
+
#
|
|
26904
|
+
# @!attribute [rw] ended_at
|
|
26905
|
+
# The time when the export job reached a terminal state (`SUCCEEDED`,
|
|
26906
|
+
# `FAILED`, or `CANCELLED`). This parameter is absent while the job is
|
|
26907
|
+
# `RUNNING`.
|
|
26908
|
+
#
|
|
26909
|
+
# For more information about the validation and formatting of
|
|
26910
|
+
# timestamp fields in Security Hub, see [Timestamps][1].
|
|
26911
|
+
#
|
|
26912
|
+
#
|
|
26913
|
+
#
|
|
26914
|
+
# [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps
|
|
26915
|
+
# @return [Time]
|
|
26916
|
+
#
|
|
26917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetExportJobV2Response AWS API Documentation
|
|
26918
|
+
#
|
|
26919
|
+
class GetExportJobV2Response < Struct.new(
|
|
26920
|
+
:export_job_id,
|
|
26921
|
+
:name,
|
|
26922
|
+
:status,
|
|
26923
|
+
:data_type,
|
|
26924
|
+
:output_configuration,
|
|
26925
|
+
:scopes,
|
|
26926
|
+
:destination,
|
|
26927
|
+
:failure_code,
|
|
26928
|
+
:failure_message,
|
|
26929
|
+
:started_at,
|
|
26930
|
+
:ended_at)
|
|
26931
|
+
SENSITIVE = []
|
|
26932
|
+
include Aws::Structure
|
|
26933
|
+
end
|
|
26934
|
+
|
|
26515
26935
|
# @!attribute [rw] finding_aggregator_arn
|
|
26516
26936
|
# The ARN of the finding aggregator to return details for. To obtain
|
|
26517
26937
|
# the ARN, use `ListFindingAggregators`.
|
|
@@ -28419,6 +28839,56 @@ module Aws::SecurityHub
|
|
|
28419
28839
|
include Aws::Structure
|
|
28420
28840
|
end
|
|
28421
28841
|
|
|
28842
|
+
# @!attribute [rw] status
|
|
28843
|
+
# Filters the results to export jobs that have the specified status.
|
|
28844
|
+
# @return [String]
|
|
28845
|
+
#
|
|
28846
|
+
# @!attribute [rw] data_type
|
|
28847
|
+
# Filters the results to export jobs that produce the specified data
|
|
28848
|
+
# type.
|
|
28849
|
+
# @return [String]
|
|
28850
|
+
#
|
|
28851
|
+
# @!attribute [rw] max_results
|
|
28852
|
+
# The maximum number of results to return in a single call. Valid
|
|
28853
|
+
# range is 1–20.
|
|
28854
|
+
# @return [Integer]
|
|
28855
|
+
#
|
|
28856
|
+
# @!attribute [rw] next_token
|
|
28857
|
+
# The token required for pagination. On your first call, set the value
|
|
28858
|
+
# of this parameter to `NULL`. For subsequent calls, to continue
|
|
28859
|
+
# listing data, set the value of this parameter to the value returned
|
|
28860
|
+
# in the previous response.
|
|
28861
|
+
# @return [String]
|
|
28862
|
+
#
|
|
28863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListExportJobsV2Request AWS API Documentation
|
|
28864
|
+
#
|
|
28865
|
+
class ListExportJobsV2Request < Struct.new(
|
|
28866
|
+
:status,
|
|
28867
|
+
:data_type,
|
|
28868
|
+
:max_results,
|
|
28869
|
+
:next_token)
|
|
28870
|
+
SENSITIVE = []
|
|
28871
|
+
include Aws::Structure
|
|
28872
|
+
end
|
|
28873
|
+
|
|
28874
|
+
# @!attribute [rw] items
|
|
28875
|
+
# The export jobs that match the request, as `ExportSummary` objects.
|
|
28876
|
+
# @return [Array<Types::ExportSummary>]
|
|
28877
|
+
#
|
|
28878
|
+
# @!attribute [rw] next_token
|
|
28879
|
+
# The pagination token to use to request the next page of results.
|
|
28880
|
+
# Otherwise, this parameter is null.
|
|
28881
|
+
# @return [String]
|
|
28882
|
+
#
|
|
28883
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListExportJobsV2Response AWS API Documentation
|
|
28884
|
+
#
|
|
28885
|
+
class ListExportJobsV2Response < Struct.new(
|
|
28886
|
+
:items,
|
|
28887
|
+
:next_token)
|
|
28888
|
+
SENSITIVE = []
|
|
28889
|
+
include Aws::Structure
|
|
28890
|
+
end
|
|
28891
|
+
|
|
28422
28892
|
# @!attribute [rw] target_uid
|
|
28423
28893
|
# The unique identifier (ID) of an existing remediation target to list
|
|
28424
28894
|
# exposure findings for.
|
|
@@ -30815,7 +31285,7 @@ module Aws::SecurityHub
|
|
|
30815
31285
|
# be run for remediating the target.
|
|
30816
31286
|
#
|
|
30817
31287
|
# @!attribute [rw] aws_cli
|
|
30818
|
-
# An
|
|
31288
|
+
# An CLI snippet version of the example.
|
|
30819
31289
|
# @return [String]
|
|
30820
31290
|
#
|
|
30821
31291
|
# @!attribute [rw] cli
|
|
@@ -32260,6 +32730,14 @@ module Aws::SecurityHub
|
|
|
32260
32730
|
# structure.
|
|
32261
32731
|
# @return [Types::ResourceInfo]
|
|
32262
32732
|
#
|
|
32733
|
+
# @!attribute [rw] resource_criticality
|
|
32734
|
+
# The criticality assigned to a resource.
|
|
32735
|
+
# @return [String]
|
|
32736
|
+
#
|
|
32737
|
+
# @!attribute [rw] criticality_sources
|
|
32738
|
+
# The sources of criticalities determined from a resource.
|
|
32739
|
+
# @return [Array<Types::CriticalitySource>]
|
|
32740
|
+
#
|
|
32263
32741
|
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ResourceResult AWS API Documentation
|
|
32264
32742
|
#
|
|
32265
32743
|
class ResourceResult < Struct.new(
|
|
@@ -32283,7 +32761,9 @@ module Aws::SecurityHub
|
|
|
32283
32761
|
:resource_config,
|
|
32284
32762
|
:resource_sub_category,
|
|
32285
32763
|
:discovery_type,
|
|
32286
|
-
:resource_info
|
|
32764
|
+
:resource_info,
|
|
32765
|
+
:resource_criticality,
|
|
32766
|
+
:criticality_sources)
|
|
32287
32767
|
SENSITIVE = []
|
|
32288
32768
|
include Aws::Structure
|
|
32289
32769
|
end
|
|
@@ -33220,6 +33700,62 @@ module Aws::SecurityHub
|
|
|
33220
33700
|
include Aws::Structure
|
|
33221
33701
|
end
|
|
33222
33702
|
|
|
33703
|
+
# The Amazon S3 destination for an export, including the bucket, the
|
|
33704
|
+
# Amazon Web Services KMS key used for encryption, and an optional
|
|
33705
|
+
# object key prefix.
|
|
33706
|
+
#
|
|
33707
|
+
# @!attribute [rw] bucket_arn
|
|
33708
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket that Security
|
|
33709
|
+
# Hub writes the export to. You must own the bucket, and its bucket
|
|
33710
|
+
# policy must grant the Security Hub service principal
|
|
33711
|
+
# (`exportv2.securityhub.amazonaws.com`) permission to write objects.
|
|
33712
|
+
# For the required bucket policy, see the Examples section of
|
|
33713
|
+
# `StartExportJobV2`.
|
|
33714
|
+
# @return [String]
|
|
33715
|
+
#
|
|
33716
|
+
# @!attribute [rw] kms_key_arn
|
|
33717
|
+
# The ARN of the Amazon Web Services KMS key that Security Hub uses to
|
|
33718
|
+
# encrypt the export objects with server-side encryption. The key
|
|
33719
|
+
# policy must allow the Security Hub service principal
|
|
33720
|
+
# (`exportv2.securityhub.amazonaws.com`) to use the key through Amazon
|
|
33721
|
+
# S3. For the required key policy, see the Examples section of
|
|
33722
|
+
# `StartExportJobV2`.
|
|
33723
|
+
#
|
|
33724
|
+
# The key must meet all of the following requirements:
|
|
33725
|
+
#
|
|
33726
|
+
# * It must be a symmetric key with a key usage of `ENCRYPT_DECRYPT`.
|
|
33727
|
+
#
|
|
33728
|
+
# * It must be a single-Region key. Multi-Region keys, whose key IDs
|
|
33729
|
+
# begin with `mrk-`, are rejected.
|
|
33730
|
+
#
|
|
33731
|
+
# * You must specify the full key ARN. Key IDs and aliases are
|
|
33732
|
+
# rejected.
|
|
33733
|
+
#
|
|
33734
|
+
# * The key must be in the same Amazon Web Services account as the
|
|
33735
|
+
# export job.
|
|
33736
|
+
#
|
|
33737
|
+
# * The key must be in the same Amazon Web Services Region as the
|
|
33738
|
+
# export job.
|
|
33739
|
+
#
|
|
33740
|
+
# * The key must be in the `aws`, `aws-cn`, or `aws-us-gov` partition.
|
|
33741
|
+
# @return [String]
|
|
33742
|
+
#
|
|
33743
|
+
# @!attribute [rw] object_prefix
|
|
33744
|
+
# An optional key prefix that Security Hub prepends to the Amazon S3
|
|
33745
|
+
# object keys of the export output. Use a prefix to organize exports
|
|
33746
|
+
# within the bucket. The value can be up to 512 characters.
|
|
33747
|
+
# @return [String]
|
|
33748
|
+
#
|
|
33749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/S3ExportDestination AWS API Documentation
|
|
33750
|
+
#
|
|
33751
|
+
class S3ExportDestination < Struct.new(
|
|
33752
|
+
:bucket_arn,
|
|
33753
|
+
:kms_key_arn,
|
|
33754
|
+
:object_prefix)
|
|
33755
|
+
SENSITIVE = []
|
|
33756
|
+
include Aws::Structure
|
|
33757
|
+
end
|
|
33758
|
+
|
|
33223
33759
|
# A security control in Security Hub CSPM describes a security best
|
|
33224
33760
|
# practice related to a specific resource.
|
|
33225
33761
|
#
|
|
@@ -34652,6 +35188,72 @@ module Aws::SecurityHub
|
|
|
34652
35188
|
#
|
|
34653
35189
|
class StartConfigurationPolicyDisassociationResponse < Aws::EmptyStructure; end
|
|
34654
35190
|
|
|
35191
|
+
# @!attribute [rw] name
|
|
35192
|
+
# An optional, user-provided name for the export job that helps you
|
|
35193
|
+
# identify it in `ListExportJobsV2` results. The value can be 1–256
|
|
35194
|
+
# characters. Alphanumeric characters, spaces, and the following ASCII
|
|
35195
|
+
# characters are permitted: `. _ , : ( ) / + -`.
|
|
35196
|
+
# @return [String]
|
|
35197
|
+
#
|
|
35198
|
+
# @!attribute [rw] destination
|
|
35199
|
+
# The destination that Security Hub writes the export to. You must
|
|
35200
|
+
# specify exactly one destination type. Currently, the only supported
|
|
35201
|
+
# type is Amazon S3.
|
|
35202
|
+
# @return [Types::ExportDestination]
|
|
35203
|
+
#
|
|
35204
|
+
# @!attribute [rw] output_configuration
|
|
35205
|
+
# Specifies what data to export and how to format it. You must specify
|
|
35206
|
+
# exactly one output type. Currently, the only supported type is
|
|
35207
|
+
# `Findings`.
|
|
35208
|
+
# @return [Types::ExportOutput]
|
|
35209
|
+
#
|
|
35210
|
+
# @!attribute [rw] scopes
|
|
35211
|
+
# Limits the export to findings from specific organizational units
|
|
35212
|
+
# (OUs) or from the delegated administrator's organization. Only the
|
|
35213
|
+
# delegated administrator account can use this parameter; other
|
|
35214
|
+
# accounts that specify it receive an `AccessDeniedException`.
|
|
35215
|
+
#
|
|
35216
|
+
# This parameter is optional. If you omit it, the delegated
|
|
35217
|
+
# administrator exports findings from all accounts across the entire
|
|
35218
|
+
# organization, and other accounts export only their own findings.
|
|
35219
|
+
#
|
|
35220
|
+
# You can specify up to 10 entries in `Scopes.AwsOrganizations`. If
|
|
35221
|
+
# you specify multiple entries, Security Hub combines them using OR
|
|
35222
|
+
# logic.
|
|
35223
|
+
# @return [Types::ExportScopes]
|
|
35224
|
+
#
|
|
35225
|
+
# @!attribute [rw] client_token
|
|
35226
|
+
# A unique identifier used to ensure idempotency.
|
|
35227
|
+
#
|
|
35228
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
35229
|
+
# not need to pass this option.
|
|
35230
|
+
# @return [String]
|
|
35231
|
+
#
|
|
35232
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/StartExportJobV2Request AWS API Documentation
|
|
35233
|
+
#
|
|
35234
|
+
class StartExportJobV2Request < Struct.new(
|
|
35235
|
+
:name,
|
|
35236
|
+
:destination,
|
|
35237
|
+
:output_configuration,
|
|
35238
|
+
:scopes,
|
|
35239
|
+
:client_token)
|
|
35240
|
+
SENSITIVE = []
|
|
35241
|
+
include Aws::Structure
|
|
35242
|
+
end
|
|
35243
|
+
|
|
35244
|
+
# @!attribute [rw] export_job_id
|
|
35245
|
+
# The unique identifier of the export job that Security Hub started.
|
|
35246
|
+
# Use this value with `GetExportJobV2` or `CancelExportJobV2`.
|
|
35247
|
+
# @return [String]
|
|
35248
|
+
#
|
|
35249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/StartExportJobV2Response AWS API Documentation
|
|
35250
|
+
#
|
|
35251
|
+
class StartExportJobV2Response < Struct.new(
|
|
35252
|
+
:export_job_id)
|
|
35253
|
+
SENSITIVE = []
|
|
35254
|
+
include Aws::Structure
|
|
35255
|
+
end
|
|
35256
|
+
|
|
34655
35257
|
# The definition of a custom action that can be used for stateless
|
|
34656
35258
|
# packet handling.
|
|
34657
35259
|
#
|