lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.87.0 vs lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.88.0
- old
+ new
@@ -485,24 +485,39 @@
def archive_findings(params = {}, options = {})
req = build_request(:archive_findings, params)
req.send_request(options)
end
- # Creates a single Amazon GuardDuty detector. A detector is a resource
- # that represents the GuardDuty service. To start using GuardDuty, you
- # must create a detector in each Region where you enable the service.
- # You can have only one detector per account per Region. All data
- # sources are enabled in a new detector by default.
+ # Creates a single GuardDuty detector. A detector is a resource that
+ # represents the GuardDuty service. To start using GuardDuty, you must
+ # create a detector in each Region where you enable the service. You can
+ # have only one detector per account per Region. All data sources are
+ # enabled in a new detector by default.
#
+ # * When you don't specify any `features`, with an exception to
+ # `RUNTIME_MONITORING`, all the optional features are enabled by
+ # default.
+ #
+ # * When you specify some of the `features`, any feature that is not
+ # specified in the API call gets enabled by default, with an exception
+ # to `RUNTIME_MONITORING`.
+ #
+ # Specifying both EKS Runtime Monitoring (`EKS_RUNTIME_MONITORING`) and
+ # Runtime Monitoring (`RUNTIME_MONITORING`) will cause an error. You can
+ # add only one of these two features because Runtime Monitoring already
+ # includes the threat detection for Amazon EKS resources. For more
+ # information, see [Runtime Monitoring][1].
+ #
# There might be regional differences because some data sources might
# not be available in all the Amazon Web Services Regions where
# GuardDuty is presently supported. For more information, see [Regions
- # and endpoints][1].
+ # and endpoints][2].
#
#
#
- # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html
+ # [2]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
#
# @option params [required, Boolean] :enable
# A Boolean value that specifies whether the detector is to be enabled.
#
# @option params [String] :client_token
@@ -2525,10 +2540,18 @@
end
# Lists Amazon GuardDuty findings statistics for the specified detector
# ID.
#
+ # There might be regional differences because some flags might not be
+ # available in all the Regions where GuardDuty is currently supported.
+ # For more information, see [Regions and endpoints][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
+ #
# @option params [required, String] :detector_id
# The ID of the detector that specifies the GuardDuty service whose
# findings' statistics you want to retrieve.
#
# @option params [required, Array<String>] :finding_statistic_types
@@ -2829,16 +2852,16 @@
def get_members(params = {}, options = {})
req = build_request(:get_members, params)
req.send_request(options)
end
- # Retrieves how many active member accounts in your Amazon Web Services
- # organization have each feature enabled within GuardDuty. Only a
- # delegated GuardDuty administrator of an organization can run this API.
+ # Retrieves how many active member accounts have each feature enabled
+ # within GuardDuty. Only a delegated GuardDuty administrator of an
+ # organization can run this API.
#
- # When you create a new Amazon Web Services organization, it might take
- # up to 24 hours to generate the statistics for the entire organization.
+ # When you create a new organization, it might take up to 24 hours to
+ # generate the statistics for the entire organization.
#
# @return [Types::GetOrganizationStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetOrganizationStatisticsResponse#organization_details #organization_details} => Types::OrganizationDetails
#
@@ -3004,11 +3027,11 @@
# usage_statistic_type: "SUM_BY_ACCOUNT", # required, accepts SUM_BY_ACCOUNT, SUM_BY_DATA_SOURCE, SUM_BY_RESOURCE, TOP_RESOURCES, SUM_BY_FEATURES, TOP_ACCOUNTS_BY_FEATURE
# usage_criteria: { # required
# account_ids: ["AccountId"],
# data_sources: ["FLOW_LOGS"], # accepts FLOW_LOGS, CLOUD_TRAIL, DNS_LOGS, S3_LOGS, KUBERNETES_AUDIT_LOGS, EC2_MALWARE_SCAN
# resources: ["String"],
- # features: ["FLOW_LOGS"], # accepts FLOW_LOGS, CLOUD_TRAIL, DNS_LOGS, S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, LAMBDA_NETWORK_LOGS, EKS_RUNTIME_MONITORING, FARGATE_RUNTIME_MONITORING, EC2_RUNTIME_MONITORING
+ # features: ["FLOW_LOGS"], # accepts FLOW_LOGS, CLOUD_TRAIL, DNS_LOGS, S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, LAMBDA_NETWORK_LOGS, EKS_RUNTIME_MONITORING, FARGATE_RUNTIME_MONITORING, EC2_RUNTIME_MONITORING, RDS_DBI_PROTECTION_PROVISIONED, RDS_DBI_PROTECTION_SERVERLESS
# },
# unit: "String",
# max_results: 1,
# next_token: "String",
# })
@@ -3018,11 +3041,11 @@
# resp.usage_statistics.sum_by_account #=> Array
# resp.usage_statistics.sum_by_account[0].account_id #=> String
# resp.usage_statistics.sum_by_account[0].total.amount #=> String
# resp.usage_statistics.sum_by_account[0].total.unit #=> String
# resp.usage_statistics.top_accounts_by_feature #=> Array
- # resp.usage_statistics.top_accounts_by_feature[0].feature #=> String, one of "FLOW_LOGS", "CLOUD_TRAIL", "DNS_LOGS", "S3_DATA_EVENTS", "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", "LAMBDA_NETWORK_LOGS", "EKS_RUNTIME_MONITORING", "FARGATE_RUNTIME_MONITORING", "EC2_RUNTIME_MONITORING"
+ # resp.usage_statistics.top_accounts_by_feature[0].feature #=> String, one of "FLOW_LOGS", "CLOUD_TRAIL", "DNS_LOGS", "S3_DATA_EVENTS", "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", "LAMBDA_NETWORK_LOGS", "EKS_RUNTIME_MONITORING", "FARGATE_RUNTIME_MONITORING", "EC2_RUNTIME_MONITORING", "RDS_DBI_PROTECTION_PROVISIONED", "RDS_DBI_PROTECTION_SERVERLESS"
# resp.usage_statistics.top_accounts_by_feature[0].accounts #=> Array
# resp.usage_statistics.top_accounts_by_feature[0].accounts[0].account_id #=> String
# resp.usage_statistics.top_accounts_by_feature[0].accounts[0].total.amount #=> String
# resp.usage_statistics.top_accounts_by_feature[0].accounts[0].total.unit #=> String
# resp.usage_statistics.sum_by_data_source #=> Array
@@ -3036,11 +3059,11 @@
# resp.usage_statistics.top_resources #=> Array
# resp.usage_statistics.top_resources[0].resource #=> String
# resp.usage_statistics.top_resources[0].total.amount #=> String
# resp.usage_statistics.top_resources[0].total.unit #=> String
# resp.usage_statistics.sum_by_feature #=> Array
- # resp.usage_statistics.sum_by_feature[0].feature #=> String, one of "FLOW_LOGS", "CLOUD_TRAIL", "DNS_LOGS", "S3_DATA_EVENTS", "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", "LAMBDA_NETWORK_LOGS", "EKS_RUNTIME_MONITORING", "FARGATE_RUNTIME_MONITORING", "EC2_RUNTIME_MONITORING"
+ # resp.usage_statistics.sum_by_feature[0].feature #=> String, one of "FLOW_LOGS", "CLOUD_TRAIL", "DNS_LOGS", "S3_DATA_EVENTS", "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", "LAMBDA_NETWORK_LOGS", "EKS_RUNTIME_MONITORING", "FARGATE_RUNTIME_MONITORING", "EC2_RUNTIME_MONITORING", "RDS_DBI_PROTECTION_PROVISIONED", "RDS_DBI_PROTECTION_SERVERLESS"
# resp.usage_statistics.sum_by_feature[0].total.amount #=> String
# resp.usage_statistics.sum_by_feature[0].total.unit #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetUsageStatistics AWS API Documentation
@@ -3313,12 +3336,20 @@
def list_filters(params = {}, options = {})
req = build_request(:list_filters, params)
req.send_request(options)
end
- # Lists Amazon GuardDuty findings for the specified detector ID.
+ # Lists GuardDuty findings for the specified detector ID.
#
+ # There might be regional differences because some flags might not be
+ # available in all the Regions where GuardDuty is currently supported.
+ # For more information, see [Regions and endpoints][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
+ #
# @option params [required, String] :detector_id
# The ID of the detector that specifies the GuardDuty service whose
# findings you want to list.
#
# @option params [Types::FindingCriteria] :finding_criteria
@@ -3834,15 +3865,20 @@
req = build_request(:list_threat_intel_sets, params)
req.send_request(options)
end
# Initiates the malware scan. Invoking this API will automatically
- # create the [Service-linked role ][1] in the corresponding account.
+ # create the [Service-linked role][1] in the corresponding account.
#
+ # When the malware scan starts, you can use the associated scan ID to
+ # track the status of the scan. For more information, see
+ # [DescribeMalwareScans][2].
#
#
+ #
# [1]: https://docs.aws.amazon.com/guardduty/latest/ug/slr-permissions-malware-protection.html
+ # [2]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DescribeMalwareScans.html
#
# @option params [required, String] :resource_arn
# Amazon Resource Name (ARN) of the resource for which you invoked the
# API.
#
@@ -4031,20 +4067,27 @@
def untag_resource(params = {}, options = {})
req = build_request(:untag_resource, params)
req.send_request(options)
end
- # Updates the Amazon GuardDuty detector specified by the detectorId.
+ # Updates the GuardDuty detector specified by the detector ID.
#
+ # Specifying both EKS Runtime Monitoring (`EKS_RUNTIME_MONITORING`) and
+ # Runtime Monitoring (`RUNTIME_MONITORING`) will cause an error. You can
+ # add only one of these two features because Runtime Monitoring already
+ # includes the threat detection for Amazon EKS resources. For more
+ # information, see [Runtime Monitoring][1].
+ #
# There might be regional differences because some data sources might
# not be available in all the Amazon Web Services Regions where
# GuardDuty is presently supported. For more information, see [Regions
- # and endpoints][1].
+ # and endpoints][2].
#
#
#
- # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html
+ # [2]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
#
# @option params [required, String] :detector_id
# The unique ID of the detector to update.
#
# @option params [Boolean] :enable
@@ -4326,18 +4369,25 @@
req.send_request(options)
end
# Contains information on member accounts to be updated.
#
+ # Specifying both EKS Runtime Monitoring (`EKS_RUNTIME_MONITORING`) and
+ # Runtime Monitoring (`RUNTIME_MONITORING`) will cause an error. You can
+ # add only one of these two features because Runtime Monitoring already
+ # includes the threat detection for Amazon EKS resources. For more
+ # information, see [Runtime Monitoring][1].
+ #
# There might be regional differences because some data sources might
# not be available in all the Amazon Web Services Regions where
# GuardDuty is presently supported. For more information, see [Regions
- # and endpoints][1].
+ # and endpoints][2].
#
#
#
- # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html
+ # [2]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
#
# @option params [required, String] :detector_id
# The detector ID of the administrator account.
#
# @option params [required, Array<String>] :account_ids
@@ -4405,18 +4455,25 @@
# Configures the delegated administrator account with the provided
# values. You must provide a value for either
# `autoEnableOrganizationMembers` or `autoEnable`, but not both.
#
+ # Specifying both EKS Runtime Monitoring (`EKS_RUNTIME_MONITORING`) and
+ # Runtime Monitoring (`RUNTIME_MONITORING`) will cause an error. You can
+ # add only one of these two features because Runtime Monitoring already
+ # includes the threat detection for Amazon EKS resources. For more
+ # information, see [Runtime Monitoring][1].
+ #
# There might be regional differences because some data sources might
# not be available in all the Amazon Web Services Regions where
# GuardDuty is presently supported. For more information, see [Regions
- # and endpoints][1].
+ # and endpoints][2].
#
#
#
- # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html
+ # [2]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
#
# @option params [required, String] :detector_id
# The ID of the detector that configures the delegated administrator.
#
# @option params [Boolean] :auto_enable
@@ -4455,10 +4512,17 @@
#
# * `NONE`: Indicates that GuardDuty will not be automatically enabled
# for any account in the organization. The administrator must manage
# GuardDuty for each account in the organization individually.
#
+ # When you update the auto-enable setting from `ALL` or `NEW` to
+ # `NONE`, this action doesn't disable the corresponding option for
+ # your existing accounts. This configuration will apply to the new
+ # accounts that join the organization. After you update the
+ # auto-enable settings, no new account will have the corresponding
+ # option as enabled.
+ #
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.update_organization_configuration({
@@ -4594,10 +4658,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-guardduty'
- context[:gem_version] = '1.87.0'
+ context[:gem_version] = '1.88.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated