lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.105.0 vs lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.106.0
- old
+ new
@@ -484,10 +484,17 @@
# account.
#
# @option params [required, String] :detector_id
# The unique ID of the detector of the GuardDuty member account.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :master_id
# The account ID of the GuardDuty administrator account whose invitation
# you're accepting.
#
# @option params [required, String] :invitation_id
@@ -523,10 +530,17 @@
#
# @option params [required, String] :detector_id
# The ID of the detector that specifies the GuardDuty service whose
# findings you want to archive.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :finding_ids
# The IDs of the findings that you want to archive.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -675,19 +689,26 @@
#
# @option params [required, String] :detector_id
# The detector ID associated with the GuardDuty account for which you
# want to create a filter.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :name
# The name of the filter. Valid characters include period (.),
# underscore (\_), dash (-), and alphanumeric characters. A whitespace
# is considered to be an invalid character.
#
# @option params [String] :description
# The description of the filter. Valid characters include alphanumeric
# characters, and special characters such as hyphen, period, colon,
- # underscore, parentheses (`\{ \}`, `[ ]`, and `( )`), forward slash,
+ # underscore, parentheses (`{ }`, `[ ]`, and `( )`), forward slash,
# horizontal tab, vertical tab, newline, form feed, return, and
# whitespace.
#
# @option params [String] :action
# Specifies the action that is to be applied to the findings that match
@@ -982,10 +1003,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector of the GuardDuty account for which you
# want to create an IPSet.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :name
# The user-friendly name to identify the IPSet.
#
# Allowed characters are alphanumeric, whitespace, dash (-), and
# underscores (\_).
@@ -1149,10 +1177,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector of the GuardDuty account for which you
# want to associate member accounts.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<Types::AccountDetail>] :account_details
# A list of account ID and email address pairs of the accounts that you
# want to associate with the GuardDuty administrator account.
#
# @return [Types::CreateMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1192,10 +1227,17 @@
#
# @option params [required, String] :detector_id
# The ID of the GuardDuty detector associated with the publishing
# destination.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :destination_type
# The type of resource for the publishing destination. Currently only
# Amazon S3 buckets are supported.
#
# @option params [required, Types::DestinationProperties] :destination_properties
@@ -1242,10 +1284,17 @@
# sample findings of all supported finding types.
#
# @option params [required, String] :detector_id
# The ID of the detector for which you need to create sample findings.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Array<String>] :finding_types
# The types of sample findings to generate.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -1272,10 +1321,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector of the GuardDuty account for which you
# want to create a `ThreatIntelSet`.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :name
# A user-friendly ThreatIntelSet name displayed in all findings that are
# generated by activity that involves IP addresses included in this
# ThreatIntelSet.
#
@@ -1366,10 +1422,17 @@
# ID.
#
# @option params [required, String] :detector_id
# The unique ID of the detector that you want to delete.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_detector({
@@ -1388,10 +1451,17 @@
# Deletes the filter specified by the filter name.
#
# @option params [required, String] :detector_id
# The unique ID of the detector that is associated with the filter.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :filter_name
# The name of the filter that you want to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -1415,10 +1485,17 @@
# trusted IP lists in the console user interface.
#
# @option params [required, String] :detector_id
# The unique ID of the detector associated with the IPSet.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :ip_set_id
# The unique ID of the IPSet to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -1504,10 +1581,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector of the GuardDuty account whose members
# you want to delete.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :account_ids
# A list of account IDs of the GuardDuty member accounts that you want
# to delete.
#
# @return [Types::DeleteMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1540,10 +1624,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector associated with the publishing
# destination to delete.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :destination_id
# The ID of the publishing destination to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -1567,10 +1658,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector that is associated with the
# threatIntelSet.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :threat_intel_set_id
# The unique ID of the threatIntelSet that you want to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -1604,10 +1702,17 @@
# [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
#
# @option params [required, String] :detector_id
# The unique ID of the detector that the request is associated with.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [String] :next_token
# You can use this parameter when paginating results. Set the value of
# this parameter to null on your first call to the list action. For
# subsequent calls to the action, fill nextToken in the request with the
# value of NextToken from the previous response to continue listing
@@ -1712,10 +1817,17 @@
#
# @option params [required, String] :detector_id
# The detector ID of the delegated administrator for which you need to
# retrieve the information.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Integer] :max_results
# You can use this parameter to indicate the maximum number of items
# that you want in the response.
#
# @option params [String] :next_token
@@ -1774,10 +1886,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector associated with the publishing
# destination to retrieve.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :destination_id
# The ID of the publishing destination to retrieve.
#
# @return [Types::DescribePublishingDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -2056,10 +2175,17 @@
# GuardDuty security agent running on their resources.
#
# @option params [required, String] :detector_id
# The unique ID of the GuardDuty detector.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Types::CoverageFilterCriteria] :filter_criteria
# Represents the criteria used to filter the coverage statistics.
#
# @option params [required, Array<String>] :statistics_type
# Represents the statistics type used to aggregate the coverage details.
@@ -2114,10 +2240,17 @@
# [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
#
# @option params [required, String] :detector_id
# The unique ID of the detector that you want to get.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @return [Types::GetDetectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetDetectorResponse#created_at #created_at} => String
# * {Types::GetDetectorResponse#finding_publishing_frequency #finding_publishing_frequency} => String
# * {Types::GetDetectorResponse#service_role #service_role} => String
@@ -2171,10 +2304,17 @@
# Returns the details of the filter specified by the filter name.
#
# @option params [required, String] :detector_id
# The unique ID of the detector that is associated with this filter.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :filter_name
# The name of the filter you want to get.
#
# @return [Types::GetFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -2231,10 +2371,17 @@
#
# @option params [required, String] :detector_id
# The ID of the detector that specifies the GuardDuty service whose
# findings you want to retrieve.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :finding_ids
# The IDs of the findings that you want to retrieve.
#
# @option params [Types::SortCriteria] :sort_criteria
# Represents the criteria used for sorting findings.
@@ -2438,10 +2585,19 @@
# resp.findings[0].resource.rds_db_instance_details.db_cluster_identifier #=> String
# resp.findings[0].resource.rds_db_instance_details.db_instance_arn #=> String
# resp.findings[0].resource.rds_db_instance_details.tags #=> Array
# resp.findings[0].resource.rds_db_instance_details.tags[0].key #=> String
# resp.findings[0].resource.rds_db_instance_details.tags[0].value #=> String
+ # resp.findings[0].resource.rds_limitless_db_details.db_shard_group_identifier #=> String
+ # resp.findings[0].resource.rds_limitless_db_details.db_shard_group_resource_id #=> String
+ # resp.findings[0].resource.rds_limitless_db_details.db_shard_group_arn #=> String
+ # resp.findings[0].resource.rds_limitless_db_details.engine #=> String
+ # resp.findings[0].resource.rds_limitless_db_details.engine_version #=> String
+ # resp.findings[0].resource.rds_limitless_db_details.db_cluster_identifier #=> String
+ # resp.findings[0].resource.rds_limitless_db_details.tags #=> Array
+ # resp.findings[0].resource.rds_limitless_db_details.tags[0].key #=> String
+ # resp.findings[0].resource.rds_limitless_db_details.tags[0].value #=> String
# resp.findings[0].resource.rds_db_user_details.user #=> String
# resp.findings[0].resource.rds_db_user_details.application #=> String
# resp.findings[0].resource.rds_db_user_details.database #=> String
# resp.findings[0].resource.rds_db_user_details.ssl #=> String
# resp.findings[0].resource.rds_db_user_details.auth_method #=> String
@@ -2757,10 +2913,17 @@
# [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
#
# @option params [required, String] :detector_id
# The ID of the detector whose findings statistics you want to retrieve.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Array<String>] :finding_statistic_types
# The types of finding statistics to retrieve.
#
# @option params [Types::FindingCriteria] :finding_criteria
# Represents the criteria that is used for querying findings.
@@ -2855,10 +3018,17 @@
# Retrieves the IPSet specified by the `ipSetId`.
#
# @option params [required, String] :detector_id
# The unique ID of the detector that is associated with the IPSet.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :ip_set_id
# The unique ID of the IPSet to retrieve.
#
# @return [Types::GetIPSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -2974,10 +3144,17 @@
# [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
#
# @option params [required, String] :detector_id
# The unique ID of the detector that is associated with this scan.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @return [Types::GetMalwareScanSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetMalwareScanSettingsResponse#scan_resource_criteria #scan_resource_criteria} => Types::ScanResourceCriteria
# * {Types::GetMalwareScanSettingsResponse#ebs_snapshot_preservation #ebs_snapshot_preservation} => String
#
@@ -3012,10 +3189,17 @@
# associated with the current GuardDuty member account.
#
# @option params [required, String] :detector_id
# The unique ID of the detector of the GuardDuty member account.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @return [Types::GetMasterAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetMasterAccountResponse#master #master} => Types::Master
#
# @example Request syntax with placeholder values
@@ -3053,10 +3237,17 @@
# [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
#
# @option params [required, String] :detector_id
# The detector ID for the administrator account.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :account_ids
# A list of member account IDs.
#
# @return [Types::GetMemberDetectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -3108,10 +3299,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector of the GuardDuty account whose members
# you want to retrieve.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :account_ids
# A list of account IDs of the GuardDuty member accounts that you want
# to describe.
#
# @return [Types::GetMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -3188,10 +3386,17 @@
# trial period.
#
# @option params [required, String] :detector_id
# The unique ID of the detector of the GuardDuty member account.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Array<String>] :account_ids
# A list of account identifiers of the GuardDuty member account.
#
# @return [Types::GetRemainingFreeTrialDaysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -3236,10 +3441,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector that is associated with the
# threatIntelSet.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :threat_intel_set_id
# The unique ID of the threatIntelSet that you want to get.
#
# @return [Types::GetThreatIntelSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -3287,10 +3499,17 @@
#
# @option params [required, String] :detector_id
# The ID of the detector that specifies the GuardDuty service whose
# usage statistics you want to retrieve.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :usage_statistic_type
# The type of usage statistics to retrieve.
#
# @option params [required, Types::UsageCriteria] :usage_criteria
# Represents the criteria used for querying usage.
@@ -3419,10 +3638,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector of the GuardDuty account with which you
# want to invite members.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :account_ids
# A list of account IDs of the accounts that you want to invite to
# GuardDuty as members.
#
# @option params [Boolean] :disable_email_notification
@@ -3471,10 +3697,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector whose coverage details you want to
# retrieve.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [String] :next_token
# A token to use for paginating results that are returned in the
# response. Set the value of this parameter to null for the first
# request to a list action. For subsequent calls, use the NextToken
# value returned from the previous request to continue listing results
@@ -3604,10 +3837,17 @@
# Returns a paginated list of the current filters.
#
# @option params [required, String] :detector_id
# The unique ID of the detector that is associated with the filter.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Integer] :max_results
# You can use this parameter to indicate the maximum number of items
# that you want in the response. The default value is 50. The maximum
# value is 50.
#
@@ -3660,10 +3900,17 @@
#
# @option params [required, String] :detector_id
# The ID of the detector that specifies the GuardDuty service whose
# findings you want to list.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Types::FindingCriteria] :finding_criteria
# Represents the criteria used for querying findings. Valid values
# include:
#
# * JSON field name
@@ -3845,10 +4092,17 @@
# returned are the IPSets from the associated administrator account.
#
# @option params [required, String] :detector_id
# The unique ID of the detector that is associated with IPSet.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Integer] :max_results
# You can use this parameter to indicate the maximum number of items you
# want in the response. The default value is 50. The maximum value is
# 50.
#
@@ -3976,10 +4230,17 @@
# administrator account.
#
# @option params [required, String] :detector_id
# The unique ID of the detector that is associated with the member.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Integer] :max_results
# You can use this parameter to indicate the maximum number of items you
# want in the response. The default value is 50. The maximum value is
# 50.
#
@@ -4088,10 +4349,17 @@
#
# @option params [required, String] :detector_id
# The detector ID for which you want to retrieve the publishing
# destination.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Integer] :max_results
# The maximum number of results to return in the response.
#
# @option params [String] :next_token
# A token to use for paginating results that are returned in the
@@ -4171,10 +4439,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector that is associated with the
# threatIntelSet.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Integer] :max_results
# You can use this parameter to indicate the maximum number of items
# that you want in the response. The default value is 50. The maximum
# value is 50.
#
@@ -4264,10 +4539,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector of the GuardDuty administrator account
# associated with the member accounts to monitor.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :account_ids
# A list of account IDs of the GuardDuty member accounts to start
# monitoring.
#
# @return [Types::StartMonitoringMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -4306,10 +4588,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector associated with the GuardDuty
# administrator account that is monitoring member accounts.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :account_ids
# A list of account IDs for the member accounts to stop monitoring.
#
# @return [Types::StopMonitoringMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -4369,10 +4658,17 @@
# Unarchives GuardDuty findings specified by the `findingIds`.
#
# @option params [required, String] :detector_id
# The ID of the detector associated with the findings to unarchive.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :finding_ids
# The IDs of the findings to unarchive.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -4437,10 +4733,17 @@
# [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.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Boolean] :enable
# Specifies whether the detector is enabled or not enabled.
#
# @option params [String] :finding_publishing_frequency
# An enum value that specifies how frequently findings are exported,
@@ -4511,17 +4814,24 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector that specifies the GuardDuty service
# where you want to update a filter.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :filter_name
# The name of the filter.
#
# @option params [String] :description
# The description of the filter. Valid characters include alphanumeric
# characters, and special characters such as hyphen, period, colon,
- # underscore, parentheses (`\{ \}`, `[ ]`, and `( )`), forward slash,
+ # underscore, parentheses (`{ }`, `[ ]`, and `( )`), forward slash,
# horizontal tab, vertical tab, newline, form feed, return, and
# whitespace.
#
# @option params [String] :action
# Specifies the action that is to be applied to the findings that match
@@ -4585,10 +4895,17 @@
#
# @option params [required, String] :detector_id
# The ID of the detector that is associated with the findings for which
# you want to update the feedback.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :finding_ids
# The IDs of the findings that you want to mark as useful or not useful.
#
# @option params [required, String] :feedback
# The feedback for the finding.
@@ -4620,10 +4937,17 @@
#
# @option params [required, String] :detector_id
# The detectorID that specifies the GuardDuty service whose IPSet you
# want to update.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :ip_set_id
# The unique ID that specifies the IPSet that you want to update.
#
# @option params [String] :name
# The unique ID that specifies the IPSet that you want to update.
@@ -4715,10 +5039,17 @@
#
# @option params [required, String] :detector_id
# The unique ID of the detector that specifies the GuardDuty service
# where you want to update scan settings.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Types::ScanResourceCriteria] :scan_resource_criteria
# Represents the criteria to be used in the filter for selecting
# resources to scan.
#
# @option params [String] :ebs_snapshot_preservation
@@ -4783,10 +5114,17 @@
# [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.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, Array<String>] :account_ids
# A list of member account IDs to be updated.
#
# @option params [Types::DataSourceConfigurations] :data_sources
# Describes which data sources will be updated.
@@ -4869,10 +5207,17 @@
# [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.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [Boolean] :auto_enable
# Represents whether or not to automatically enable member accounts in
# the organization.
#
# Even though this is still supported, we recommend using
@@ -4969,10 +5314,17 @@
#
# @option params [required, String] :detector_id
# The ID of the detector associated with the publishing destinations to
# update.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :destination_id
# The ID of the publishing destination to update.
#
# @option params [Types::DestinationProperties] :destination_properties
# A `DestinationProperties` object that includes the `DestinationArn`
@@ -5004,10 +5356,17 @@
#
# @option params [required, String] :detector_id
# The detectorID that specifies the GuardDuty service whose
# ThreatIntelSet you want to update.
#
+ # To find the `detectorId` in the current Region, see the Settings page
+ # in the GuardDuty console, or run the [ListDetectors][1] API.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html
+ #
# @option params [required, String] :threat_intel_set_id
# The unique ID that specifies the ThreatIntelSet that you want to
# update.
#
# @option params [String] :name
@@ -5058,10 +5417,10 @@
params: params,
config: config,
tracer: tracer
)
context[:gem_name] = 'aws-sdk-guardduty'
- context[:gem_version] = '1.105.0'
+ context[:gem_version] = '1.106.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated