lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.17.0 vs lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.18.0
- old
+ new
@@ -251,27 +251,28 @@
# @!group API Operations
# Accepts the invitation to be monitored by a master GuardDuty account.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty member account.
#
- # @option params [required, String] :invitation_id
- # This value is used to validate the master account to the member
- # account.
- #
# @option params [required, String] :master_id
# The account ID of the master GuardDuty account whose invitation
# you're accepting.
#
+ # @option params [required, String] :invitation_id
+ # This value is used to validate the master account to the member
+ # account.
+ #
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.accept_invitation({
- # detector_id: "__string", # required
- # invitation_id: "InvitationId", # required
- # master_id: "MasterId", # required
+ # detector_id: "DetectorId", # required
+ # master_id: "String", # required
+ # invitation_id: "String", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/AcceptInvitation AWS API Documentation
#
# @overload accept_invitation(params = {})
@@ -283,20 +284,22 @@
# Archives Amazon GuardDuty findings specified by the list of finding
# IDs.
#
# @option params [required, String] :detector_id
+ # The ID of the detector that specifies the GuardDuty service whose
+ # findings you want to archive.
#
# @option params [required, Array<String>] :finding_ids
# IDs of the findings that you want to archive.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.archive_findings({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# finding_ids: ["FindingId"], # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/ArchiveFindings AWS API Documentation
#
@@ -309,17 +312,19 @@
# Creates a single Amazon GuardDuty detector. A detector is an object
# that represents the GuardDuty service. A detector must be created in
# order for GuardDuty to become operational.
#
- # @option params [String] :client_token
- # The idempotency token for the create request.**A suitable default value is auto-generated.** You should normally
- # not need to pass this option.**
- #
# @option params [required, Boolean] :enable
# A boolean value that specifies whether the detector is to be enabled.
#
+ # @option params [String] :client_token
+ # The idempotency token for the create request.
+ #
+ # **A suitable default value is auto-generated.** You should normally
+ # not need to pass this option.**
+ #
# @option params [String] :finding_publishing_frequency
# A enum value that specifies how frequently customer got Finding
# updates published.
#
# @return [Types::CreateDetectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -327,12 +332,12 @@
# * {Types::CreateDetectorResponse#detector_id #detector_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_detector({
- # client_token: "__stringMin0Max64",
# enable: false, # required
+ # client_token: "ClientToken",
# finding_publishing_frequency: "FIFTEEN_MINUTES", # accepts FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS
# })
#
# @example Response structure
#
@@ -347,60 +352,70 @@
req.send_request(options)
end
# Creates a filter using the specified finding criteria.
#
- # @option params [String] :action
- # Specifies the action that is to be applied to the findings that match
- # the filter.
+ # @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty account for which you
+ # want to create a filter.
#
- # @option params [String] :client_token
- # The idempotency token for the create request.**A suitable default value is auto-generated.** You should normally
- # not need to pass this option.**
+ # @option params [required, String] :name
+ # The name of the filter.
#
# @option params [String] :description
# The description of the filter.
#
- # @option params [required, String] :detector_id
+ # @option params [String] :action
+ # Specifies the action that is to be applied to the findings that match
+ # the filter.
#
+ # @option params [Integer] :rank
+ # Specifies the position of the filter in the list of current filters.
+ # Also specifies the order in which this filter is applied to the
+ # findings.
+ #
# @option params [required, Types::FindingCriteria] :finding_criteria
# Represents the criteria to be used in the filter for querying
# findings.
#
- # @option params [required, String] :name
- # The name of the filter.
+ # @option params [String] :client_token
+ # The idempotency token for the create request.
#
- # @option params [Integer] :rank
- # Specifies the position of the filter in the list of current filters.
- # Also specifies the order in which this filter is applied to the
- # findings.
+ # **A suitable default value is auto-generated.** You should normally
+ # not need to pass this option.**
#
# @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateFilterResponse#name #name} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_filter({
- # action: "NOOP", # accepts NOOP, ARCHIVE
- # client_token: "__stringMin0Max64",
+ # detector_id: "DetectorId", # required
+ # name: "FilterName", # required
# description: "FilterDescription",
- # detector_id: "__string", # required
+ # action: "NOOP", # accepts NOOP, ARCHIVE
+ # rank: 1,
# finding_criteria: { # required
# criterion: {
- # "__string" => {
- # eq: ["__string"],
+ # "String" => {
+ # eq: ["String"],
+ # neq: ["String"],
# gt: 1,
# gte: 1,
# lt: 1,
# lte: 1,
- # neq: ["__string"],
+ # equals: ["String"],
+ # not_equals: ["String"],
+ # greater_than: 1,
+ # greater_than_or_equal: 1,
+ # less_than: 1,
+ # less_than_or_equal: 1,
# },
# },
# },
- # name: "FilterName", # required
- # rank: 1,
+ # client_token: "ClientToken",
# })
#
# @example Response structure
#
# resp.name #=> String
@@ -416,45 +431,49 @@
# Creates a new IPSet - a list of trusted IP addresses that have been
# whitelisted for secure communication with AWS infrastructure and
# applications.
#
- # @option params [required, Boolean] :activate
- # A boolean value that indicates whether GuardDuty is to start using the
- # uploaded IPSet.
- #
- # @option params [String] :client_token
- # The idempotency token for the create request.**A suitable default value is auto-generated.** You should normally
- # not need to pass this option.**
- #
# @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty account for which you
+ # want to create an IPSet.
#
+ # @option params [required, String] :name
+ # The user friendly name to identify the IPSet. This name is displayed
+ # in all findings that are triggered by activity that involves IP
+ # addresses included in this IPSet.
+ #
# @option params [required, String] :format
# The format of the file that contains the IPSet.
#
# @option params [required, String] :location
# The URI of the file that contains the IPSet. For example
# (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
#
- # @option params [required, String] :name
- # The user friendly name to identify the IPSet. This name is displayed
- # in all findings that are triggered by activity that involves IP
- # addresses included in this IPSet.
+ # @option params [required, Boolean] :activate
+ # A boolean value that indicates whether GuardDuty is to start using the
+ # uploaded IPSet.
#
+ # @option params [String] :client_token
+ # The idempotency token for the create request.
+ #
+ # **A suitable default value is auto-generated.** You should normally
+ # not need to pass this option.**
+ #
# @return [Types::CreateIPSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateIPSetResponse#ip_set_id #ip_set_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_ip_set({
- # activate: false, # required
- # client_token: "__stringMin0Max64",
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # name: "Name", # required
# format: "TXT", # required, accepts TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE
# location: "Location", # required
- # name: "Name", # required
+ # activate: false, # required
+ # client_token: "ClientToken",
# })
#
# @example Response structure
#
# resp.ip_set_id #=> String
@@ -470,30 +489,32 @@
# Creates member accounts of the current AWS account by specifying a
# list of AWS account IDs. The current AWS account can then invite these
# members to manage GuardDuty in their accounts.
#
+ # @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty account with which you
+ # want to associate member accounts.
+ #
# @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 master GuardDuty account.
#
- # @option params [required, String] :detector_id
- #
# @return [Types::CreateMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
#
# @example Request syntax with placeholder values
#
# resp = client.create_members({
+ # detector_id: "DetectorId", # required
# account_details: [ # required
# {
# account_id: "AccountId", # required
# email: "Email", # required
# },
# ],
- # detector_id: "__string", # required
# })
#
# @example Response structure
#
# resp.unprocessed_accounts #=> Array
@@ -512,20 +533,21 @@
# Generates example findings of types specified by the list of finding
# types. If 'NULL' is specified for findingTypes, the API generates
# example findings of all supported finding types.
#
# @option params [required, String] :detector_id
+ # The ID of the detector to create sample findings for.
#
# @option params [Array<String>] :finding_types
# Types of sample findings that you want to generate.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.create_sample_findings({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# finding_types: ["FindingType"],
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/CreateSampleFindings AWS API Documentation
#
@@ -538,45 +560,49 @@
# Create a new ThreatIntelSet. ThreatIntelSets consist of known
# malicious IP addresses. GuardDuty generates findings based on
# ThreatIntelSets.
#
- # @option params [required, Boolean] :activate
- # A boolean value that indicates whether GuardDuty is to start using the
- # uploaded ThreatIntelSet.
- #
- # @option params [String] :client_token
- # The idempotency token for the create request.**A suitable default value is auto-generated.** You should normally
- # not need to pass this option.**
- #
# @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty account for which you
+ # want to create a threatIntelSet.
#
+ # @option params [required, String] :name
+ # A user-friendly ThreatIntelSet name that is displayed in all finding
+ # generated by activity that involves IP addresses included in this
+ # ThreatIntelSet.
+ #
# @option params [required, String] :format
# The format of the file that contains the ThreatIntelSet.
#
# @option params [required, String] :location
# The URI of the file that contains the ThreatIntelSet. For example
# (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
#
- # @option params [required, String] :name
- # A user-friendly ThreatIntelSet name that is displayed in all finding
- # generated by activity that involves IP addresses included in this
- # ThreatIntelSet.
+ # @option params [required, Boolean] :activate
+ # A boolean value that indicates whether GuardDuty is to start using the
+ # uploaded ThreatIntelSet.
#
+ # @option params [String] :client_token
+ # The idempotency token for the create request.
+ #
+ # **A suitable default value is auto-generated.** You should normally
+ # not need to pass this option.**
+ #
# @return [Types::CreateThreatIntelSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateThreatIntelSetResponse#threat_intel_set_id #threat_intel_set_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_threat_intel_set({
- # activate: false, # required
- # client_token: "__stringMin0Max64",
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # name: "Name", # required
# format: "TXT", # required, accepts TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE
# location: "Location", # required
- # name: "Name", # required
+ # activate: false, # required
+ # client_token: "ClientToken",
# })
#
# @example Response structure
#
# resp.threat_intel_set_id #=> String
@@ -602,11 +628,11 @@
# * {Types::DeclineInvitationsResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
#
# @example Request syntax with placeholder values
#
# resp = client.decline_invitations({
- # account_ids: ["__string"], # required
+ # account_ids: ["AccountId"], # required
# })
#
# @example Response structure
#
# resp.unprocessed_accounts #=> Array
@@ -623,17 +649,18 @@
end
# Deletes a Amazon GuardDuty detector specified by the detector ID.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector that you want to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_detector({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/DeleteDetector AWS API Documentation
#
# @overload delete_detector(params = {})
@@ -644,20 +671,22 @@
end
# Deletes the filter specified by the filter name.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector the filter is associated with.
#
# @option params [required, String] :filter_name
+ # The name of the filter you want to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_filter({
- # detector_id: "__string", # required
- # filter_name: "__string", # required
+ # detector_id: "DetectorId", # required
+ # filter_name: "String", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/DeleteFilter AWS API Documentation
#
# @overload delete_filter(params = {})
@@ -668,20 +697,22 @@
end
# Deletes the IPSet specified by the IPSet ID.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector the ipSet is associated with.
#
# @option params [required, String] :ip_set_id
+ # The unique ID of the ipSet you want to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_ip_set({
- # detector_id: "__string", # required
- # ip_set_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # ip_set_id: "String", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/DeleteIPSet AWS API Documentation
#
# @overload delete_ip_set(params = {})
@@ -703,11 +734,11 @@
# * {Types::DeleteInvitationsResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
#
# @example Request syntax with placeholder values
#
# resp = client.delete_invitations({
- # account_ids: ["__string"], # required
+ # account_ids: ["AccountId"], # required
# })
#
# @example Response structure
#
# resp.unprocessed_accounts #=> Array
@@ -724,25 +755,27 @@
end
# Deletes GuardDuty member accounts (to the current GuardDuty master
# account) specified by the account IDs.
#
+ # @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty account whose members
+ # you want to delete.
+ #
# @option params [required, Array<String>] :account_ids
# A list of account IDs of the GuardDuty member accounts that you want
# to delete.
#
- # @option params [required, String] :detector_id
- #
# @return [Types::DeleteMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
#
# @example Request syntax with placeholder values
#
# resp = client.delete_members({
- # account_ids: ["__string"], # required
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # account_ids: ["AccountId"], # required
# })
#
# @example Response structure
#
# resp.unprocessed_accounts #=> Array
@@ -759,20 +792,22 @@
end
# Deletes ThreatIntelSet specified by the ThreatIntelSet ID.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector the threatIntelSet is associated with.
#
# @option params [required, String] :threat_intel_set_id
+ # The unique ID of the threatIntelSet you want to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_threat_intel_set({
- # detector_id: "__string", # required
- # threat_intel_set_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # threat_intel_set_id: "String", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/DeleteThreatIntelSet AWS API Documentation
#
# @overload delete_threat_intel_set(params = {})
@@ -784,17 +819,18 @@
# Disassociates the current GuardDuty member account from its master
# account.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty member account.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.disassociate_from_master_account({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/DisassociateFromMasterAccount AWS API Documentation
#
# @overload disassociate_from_master_account(params = {})
@@ -805,25 +841,27 @@
end
# Disassociates GuardDuty member accounts (to the current GuardDuty
# master account) specified by the account IDs.
#
+ # @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty account whose members
+ # you want to disassociate from master.
+ #
# @option params [required, Array<String>] :account_ids
# A list of account IDs of the GuardDuty member accounts that you want
# to disassociate from master.
#
- # @option params [required, String] :detector_id
- #
# @return [Types::DisassociateMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DisassociateMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
#
# @example Request syntax with placeholder values
#
# resp = client.disassociate_members({
- # account_ids: ["__string"], # required
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # account_ids: ["AccountId"], # required
# })
#
# @example Response structure
#
# resp.unprocessed_accounts #=> Array
@@ -840,10 +878,11 @@
end
# Retrieves an Amazon GuardDuty detector specified by the detectorId.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector that you want to get.
#
# @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
@@ -852,11 +891,11 @@
# * {Types::GetDetectorResponse#updated_at #updated_at} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_detector({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# })
#
# @example Response structure
#
# resp.created_at #=> String
@@ -875,43 +914,53 @@
end
# Returns the details of the filter specified by the filter name.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector the filter is associated with.
#
# @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:
#
- # * {Types::GetFilterResponse#action #action} => String
- # * {Types::GetFilterResponse#description #description} => String
- # * {Types::GetFilterResponse#finding_criteria #finding_criteria} => Types::FindingCriteria
# * {Types::GetFilterResponse#name #name} => String
+ # * {Types::GetFilterResponse#description #description} => String
+ # * {Types::GetFilterResponse#action #action} => String
# * {Types::GetFilterResponse#rank #rank} => Integer
+ # * {Types::GetFilterResponse#finding_criteria #finding_criteria} => Types::FindingCriteria
#
# @example Request syntax with placeholder values
#
# resp = client.get_filter({
- # detector_id: "__string", # required
- # filter_name: "__string", # required
+ # detector_id: "DetectorId", # required
+ # filter_name: "String", # required
# })
#
# @example Response structure
#
- # resp.action #=> String, one of "NOOP", "ARCHIVE"
- # resp.description #=> String
- # resp.finding_criteria.criterion #=> Hash
- # resp.finding_criteria.criterion["__string"].eq #=> Array
- # resp.finding_criteria.criterion["__string"].eq[0] #=> String
- # resp.finding_criteria.criterion["__string"].gt #=> Integer
- # resp.finding_criteria.criterion["__string"].gte #=> Integer
- # resp.finding_criteria.criterion["__string"].lt #=> Integer
- # resp.finding_criteria.criterion["__string"].lte #=> Integer
- # resp.finding_criteria.criterion["__string"].neq #=> Array
- # resp.finding_criteria.criterion["__string"].neq[0] #=> String
# resp.name #=> String
+ # resp.description #=> String
+ # resp.action #=> String, one of "NOOP", "ARCHIVE"
# resp.rank #=> Integer
+ # resp.finding_criteria.criterion #=> Hash
+ # resp.finding_criteria.criterion["String"].eq #=> Array
+ # resp.finding_criteria.criterion["String"].eq[0] #=> String
+ # resp.finding_criteria.criterion["String"].neq #=> Array
+ # resp.finding_criteria.criterion["String"].neq[0] #=> String
+ # resp.finding_criteria.criterion["String"].gt #=> Integer
+ # resp.finding_criteria.criterion["String"].gte #=> Integer
+ # resp.finding_criteria.criterion["String"].lt #=> Integer
+ # resp.finding_criteria.criterion["String"].lte #=> Integer
+ # resp.finding_criteria.criterion["String"].equals #=> Array
+ # resp.finding_criteria.criterion["String"].equals[0] #=> String
+ # resp.finding_criteria.criterion["String"].not_equals #=> Array
+ # resp.finding_criteria.criterion["String"].not_equals[0] #=> String
+ # resp.finding_criteria.criterion["String"].greater_than #=> Integer
+ # resp.finding_criteria.criterion["String"].greater_than_or_equal #=> Integer
+ # resp.finding_criteria.criterion["String"].less_than #=> Integer
+ # resp.finding_criteria.criterion["String"].less_than_or_equal #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetFilter AWS API Documentation
#
# @overload get_filter(params = {})
# @param [Hash] params ({})
@@ -921,10 +970,12 @@
end
# Describes Amazon GuardDuty findings specified by finding IDs.
#
# @option params [required, String] :detector_id
+ # The ID of the detector that specifies the GuardDuty service whose
+ # findings you want to retrieve.
#
# @option params [required, Array<String>] :finding_ids
# IDs of the findings that you want to retrieve.
#
# @option params [Types::SortCriteria] :sort_criteria
@@ -935,14 +986,14 @@
# * {Types::GetFindingsResponse#findings #findings} => Array<Types::Finding>
#
# @example Request syntax with placeholder values
#
# resp = client.get_findings({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# finding_ids: ["FindingId"], # required
# sort_criteria: {
- # attribute_name: "__string",
+ # attribute_name: "String",
# order_by: "ASC", # accepts ASC, DESC
# },
# })
#
# @example Response structure
@@ -995,10 +1046,11 @@
# resp.findings[0].resource.resource_type #=> String
# resp.findings[0].schema_version #=> String
# resp.findings[0].service.action.action_type #=> String
# resp.findings[0].service.action.aws_api_call_action.api #=> String
# resp.findings[0].service.action.aws_api_call_action.caller_type #=> String
+ # resp.findings[0].service.action.aws_api_call_action.domain_details.domain #=> String
# resp.findings[0].service.action.aws_api_call_action.remote_ip_details.city.city_name #=> String
# resp.findings[0].service.action.aws_api_call_action.remote_ip_details.country.country_code #=> String
# resp.findings[0].service.action.aws_api_call_action.remote_ip_details.country.country_name #=> String
# resp.findings[0].service.action.aws_api_call_action.remote_ip_details.geo_location.lat #=> Float
# resp.findings[0].service.action.aws_api_call_action.remote_ip_details.geo_location.lon #=> Float
@@ -1064,44 +1116,52 @@
# Lists Amazon GuardDuty findings' statistics for the specified
# detector ID.
#
# @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 [Types::FindingCriteria] :finding_criteria
- # Represents the criteria used for querying findings.
- #
# @option params [required, Array<String>] :finding_statistic_types
# Types of finding statistics to retrieve.
#
+ # @option params [Types::FindingCriteria] :finding_criteria
+ # Represents the criteria used for querying findings.
+ #
# @return [Types::GetFindingsStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetFindingsStatisticsResponse#finding_statistics #finding_statistics} => Types::FindingStatistics
#
# @example Request syntax with placeholder values
#
# resp = client.get_findings_statistics({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # finding_statistic_types: ["COUNT_BY_SEVERITY"], # required, accepts COUNT_BY_SEVERITY
# finding_criteria: {
# criterion: {
- # "__string" => {
- # eq: ["__string"],
+ # "String" => {
+ # eq: ["String"],
+ # neq: ["String"],
# gt: 1,
# gte: 1,
# lt: 1,
# lte: 1,
- # neq: ["__string"],
+ # equals: ["String"],
+ # not_equals: ["String"],
+ # greater_than: 1,
+ # greater_than_or_equal: 1,
+ # less_than: 1,
+ # less_than_or_equal: 1,
# },
# },
# },
- # finding_statistic_types: ["COUNT_BY_SEVERITY"], # required, accepts COUNT_BY_SEVERITY
# })
#
# @example Response structure
#
# resp.finding_statistics.count_by_severity #=> Hash
- # resp.finding_statistics.count_by_severity["__string"] #=> Integer
+ # resp.finding_statistics.count_by_severity["String"] #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetFindingsStatistics AWS API Documentation
#
# @overload get_findings_statistics(params = {})
# @param [Hash] params ({})
@@ -1111,32 +1171,34 @@
end
# Retrieves the IPSet specified by the IPSet ID.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector the ipSet is associated with.
#
# @option params [required, String] :ip_set_id
+ # The unique ID of the ipSet you want to get.
#
# @return [Types::GetIPSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::GetIPSetResponse#name #name} => String
# * {Types::GetIPSetResponse#format #format} => String
# * {Types::GetIPSetResponse#location #location} => String
- # * {Types::GetIPSetResponse#name #name} => String
# * {Types::GetIPSetResponse#status #status} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_ip_set({
- # detector_id: "__string", # required
- # ip_set_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # ip_set_id: "String", # required
# })
#
# @example Response structure
#
+ # resp.name #=> String
# resp.format #=> String, one of "TXT", "STIX", "OTX_CSV", "ALIEN_VAULT", "PROOF_POINT", "FIRE_EYE"
# resp.location #=> String
- # resp.name #=> String
# resp.status #=> String, one of "INACTIVE", "ACTIVATING", "ACTIVE", "DEACTIVATING", "ERROR", "DELETE_PENDING", "DELETED"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetIPSet AWS API Documentation
#
# @overload get_ip_set(params = {})
@@ -1169,27 +1231,28 @@
# Provides the details for the GuardDuty master account to the current
# GuardDuty member account.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty member account.
#
# @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
#
# resp = client.get_master_account({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# })
#
# @example Response structure
#
# resp.master.account_id #=> String
# resp.master.invitation_id #=> String
- # resp.master.invited_at #=> String
# resp.master.relationship_status #=> String
+ # resp.master.invited_at #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetMasterAccount AWS API Documentation
#
# @overload get_master_account(params = {})
# @param [Hash] params ({})
@@ -1199,37 +1262,39 @@
end
# Retrieves GuardDuty member accounts (to the current GuardDuty master
# account) specified by the account IDs.
#
+ # @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty account whose members
+ # you want to retrieve.
+ #
# @option params [required, Array<String>] :account_ids
# A list of account IDs of the GuardDuty member accounts that you want
# to describe.
#
- # @option params [required, String] :detector_id
- #
# @return [Types::GetMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetMembersResponse#members #members} => Array<Types::Member>
# * {Types::GetMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
#
# @example Request syntax with placeholder values
#
# resp = client.get_members({
- # account_ids: ["__string"], # required
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # account_ids: ["AccountId"], # required
# })
#
# @example Response structure
#
# resp.members #=> Array
# resp.members[0].account_id #=> String
# resp.members[0].detector_id #=> String
- # resp.members[0].email #=> String
- # resp.members[0].invited_at #=> String
# resp.members[0].master_id #=> String
+ # resp.members[0].email #=> String
# resp.members[0].relationship_status #=> String
+ # resp.members[0].invited_at #=> String
# resp.members[0].updated_at #=> String
# resp.unprocessed_accounts #=> Array
# resp.unprocessed_accounts[0].account_id #=> String
# resp.unprocessed_accounts[0].result #=> String
#
@@ -1244,32 +1309,34 @@
# Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet
# ID.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector the threatIntelSet is associated with.
#
# @option params [required, String] :threat_intel_set_id
+ # The unique ID of the threatIntelSet you want to get.
#
# @return [Types::GetThreatIntelSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::GetThreatIntelSetResponse#name #name} => String
# * {Types::GetThreatIntelSetResponse#format #format} => String
# * {Types::GetThreatIntelSetResponse#location #location} => String
- # * {Types::GetThreatIntelSetResponse#name #name} => String
# * {Types::GetThreatIntelSetResponse#status #status} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_threat_intel_set({
- # detector_id: "__string", # required
- # threat_intel_set_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # threat_intel_set_id: "String", # required
# })
#
# @example Response structure
#
+ # resp.name #=> String
# resp.format #=> String, one of "TXT", "STIX", "OTX_CSV", "ALIEN_VAULT", "PROOF_POINT", "FIRE_EYE"
# resp.location #=> String
- # resp.name #=> String
# resp.status #=> String, one of "INACTIVE", "ACTIVATING", "ACTIVE", "DEACTIVATING", "ERROR", "DELETE_PENDING", "DELETED"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetThreatIntelSet AWS API Documentation
#
# @overload get_threat_intel_set(params = {})
@@ -1282,16 +1349,18 @@
# Invites other AWS accounts (created as members of the current AWS
# account by CreateMembers) to enable GuardDuty and allow the current
# AWS account to view and manage these accounts' GuardDuty findings on
# their behalf as the master account.
#
+ # @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty account with which you
+ # want to invite members.
+ #
# @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 [required, String] :detector_id
- #
# @option params [Boolean] :disable_email_notification
# A boolean value that specifies whether you want to disable email
# notification to the accounts that you’re inviting to GuardDuty as
# members.
#
@@ -1304,14 +1373,14 @@
# * {Types::InviteMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
#
# @example Request syntax with placeholder values
#
# resp = client.invite_members({
- # account_ids: ["__string"], # required
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # account_ids: ["AccountId"], # required
# disable_email_notification: false,
- # message: "Message",
+ # message: "String",
# })
#
# @example Response structure
#
# resp.unprocessed_accounts #=> Array
@@ -1329,25 +1398,31 @@
# Lists detectorIds of all the existing Amazon GuardDuty detector
# resources.
#
# @option params [Integer] :max_results
- # You can use this parameter to indicate the maximum number of items
- # that you want in the response.
+ # 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.
#
# @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
+ # data.
#
# @return [Types::ListDetectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListDetectorsResponse#detector_ids #detector_ids} => Array<String>
# * {Types::ListDetectorsResponse#next_token #next_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.list_detectors({
# max_results: 1,
- # next_token: "__string",
+ # next_token: "String",
# })
#
# @example Response structure
#
# resp.detector_ids #=> Array
@@ -1364,28 +1439,35 @@
end
# Returns a paginated list of the current filters.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector the filter is associated with.
#
# @option params [Integer] :max_results
- # You can use this parameter to indicate the maximum number of items
- # that you want in the response.
+ # 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.
#
# @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
+ # data.
#
# @return [Types::ListFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListFiltersResponse#filter_names #filter_names} => Array<String>
# * {Types::ListFiltersResponse#next_token #next_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.list_filters({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# max_results: 1,
- # next_token: "__string",
+ # next_token: "String",
# })
#
# @example Response structure
#
# resp.filter_names #=> Array
@@ -1402,56 +1484,64 @@
end
# Lists Amazon GuardDuty findings for the specified detector ID.
#
# @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
# Represents the criteria used for querying findings.
#
+ # @option params [Types::SortCriteria] :sort_criteria
+ # Represents the criteria used for sorting findings.
+ #
# @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.
#
# @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 ListFindings action.
- # For subsequent calls to the action fill nextToken in the request with
- # the value of nextToken from the previous response to continue listing
+ # 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
# data.
#
- # @option params [Types::SortCriteria] :sort_criteria
- # Represents the criteria used for sorting findings.
- #
# @return [Types::ListFindingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListFindingsResponse#finding_ids #finding_ids} => Array<String>
# * {Types::ListFindingsResponse#next_token #next_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.list_findings({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# finding_criteria: {
# criterion: {
- # "__string" => {
- # eq: ["__string"],
+ # "String" => {
+ # eq: ["String"],
+ # neq: ["String"],
# gt: 1,
# gte: 1,
# lt: 1,
# lte: 1,
- # neq: ["__string"],
+ # equals: ["String"],
+ # not_equals: ["String"],
+ # greater_than: 1,
+ # greater_than_or_equal: 1,
+ # less_than: 1,
+ # less_than_or_equal: 1,
# },
# },
# },
- # max_results: 1,
- # next_token: "NextToken",
# sort_criteria: {
- # attribute_name: "__string",
+ # attribute_name: "String",
# order_by: "ASC", # accepts ASC, DESC
# },
+ # max_results: 1,
+ # next_token: "String",
# })
#
# @example Response structure
#
# resp.finding_ids #=> Array
@@ -1469,28 +1559,35 @@
# Lists the IPSets of the GuardDuty service specified by the detector
# ID.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector the ipSet is associated with.
#
# @option params [Integer] :max_results
- # You can use this parameter to indicate the maximum number of items
- # that you want in the response.
+ # 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.
#
# @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
+ # data.
#
# @return [Types::ListIPSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListIPSetsResponse#ip_set_ids #ip_set_ids} => Array<String>
# * {Types::ListIPSetsResponse#next_token #next_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.list_ip_sets({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# max_results: 1,
- # next_token: "__string",
+ # next_token: "String",
# })
#
# @example Response structure
#
# resp.ip_set_ids #=> Array
@@ -1508,34 +1605,40 @@
# Lists all GuardDuty membership invitations that were sent to the
# current AWS account.
#
# @option params [Integer] :max_results
- # You can use this parameter to indicate the maximum number of items
- # that you want in the response.
+ # 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.
#
# @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
+ # data.
#
# @return [Types::ListInvitationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListInvitationsResponse#invitations #invitations} => Array<Types::Invitation>
# * {Types::ListInvitationsResponse#next_token #next_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.list_invitations({
# max_results: 1,
- # next_token: "__string",
+ # next_token: "String",
# })
#
# @example Response structure
#
# resp.invitations #=> Array
# resp.invitations[0].account_id #=> String
# resp.invitations[0].invitation_id #=> String
- # resp.invitations[0].invited_at #=> String
# resp.invitations[0].relationship_status #=> String
+ # resp.invitations[0].invited_at #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/ListInvitations AWS API Documentation
#
# @overload list_invitations(params = {})
@@ -1547,42 +1650,52 @@
# Lists details about all member accounts for the current GuardDuty
# master account.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector the member is associated with.
#
# @option params [Integer] :max_results
- # You can use this parameter to indicate the maximum number of items
- # that you want in the response.
+ # 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.
#
# @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
+ # data.
#
# @option params [String] :only_associated
+ # Specifies whether to only return associated members or to return all
+ # members (including members which haven't been invited yet or have
+ # been disassociated).
#
# @return [Types::ListMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListMembersResponse#members #members} => Array<Types::Member>
# * {Types::ListMembersResponse#next_token #next_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.list_members({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# max_results: 1,
- # next_token: "__string",
- # only_associated: "__string",
+ # next_token: "String",
+ # only_associated: "String",
# })
#
# @example Response structure
#
# resp.members #=> Array
# resp.members[0].account_id #=> String
# resp.members[0].detector_id #=> String
- # resp.members[0].email #=> String
- # resp.members[0].invited_at #=> String
# resp.members[0].master_id #=> String
+ # resp.members[0].email #=> String
# resp.members[0].relationship_status #=> String
+ # resp.members[0].invited_at #=> String
# resp.members[0].updated_at #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/ListMembers AWS API Documentation
#
@@ -1595,35 +1708,42 @@
# Lists the ThreatIntelSets of the GuardDuty service specified by the
# detector ID.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector the threatIntelSet is associated with.
#
# @option params [Integer] :max_results
- # You can use this parameter to indicate the maximum number of items
- # that you want in the response.
+ # 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.
#
# @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
+ # data.
#
# @return [Types::ListThreatIntelSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
- # * {Types::ListThreatIntelSetsResponse#next_token #next_token} => String
# * {Types::ListThreatIntelSetsResponse#threat_intel_set_ids #threat_intel_set_ids} => Array<String>
+ # * {Types::ListThreatIntelSetsResponse#next_token #next_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.list_threat_intel_sets({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# max_results: 1,
- # next_token: "__string",
+ # next_token: "String",
# })
#
# @example Response structure
#
- # resp.next_token #=> String
# resp.threat_intel_set_ids #=> Array
# resp.threat_intel_set_ids[0] #=> String
+ # resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/ListThreatIntelSets AWS API Documentation
#
# @overload list_threat_intel_sets(params = {})
# @param [Hash] params ({})
@@ -1635,25 +1755,27 @@
# Re-enables GuardDuty to monitor findings of the member accounts
# specified by the account IDs. A master GuardDuty account can run this
# command after disabling GuardDuty from monitoring these members'
# findings by running StopMonitoringMembers.
#
+ # @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty account whom you want
+ # to re-enable to monitor members' findings.
+ #
# @option params [required, Array<String>] :account_ids
# A list of account IDs of the GuardDuty member accounts whose findings
# you want the master account to monitor.
#
- # @option params [required, String] :detector_id
- #
# @return [Types::StartMonitoringMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::StartMonitoringMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
#
# @example Request syntax with placeholder values
#
# resp = client.start_monitoring_members({
- # account_ids: ["__string"], # required
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # account_ids: ["AccountId"], # required
# })
#
# @example Response structure
#
# resp.unprocessed_accounts #=> Array
@@ -1672,25 +1794,27 @@
# Disables GuardDuty from monitoring findings of the member accounts
# specified by the account IDs. After running this command, a master
# GuardDuty account can run StartMonitoringMembers to re-enable
# GuardDuty to monitor these members’ findings.
#
+ # @option params [required, String] :detector_id
+ # The unique ID of the detector of the GuardDuty account that you want
+ # to stop from monitor members' findings.
+ #
# @option params [required, Array<String>] :account_ids
# A list of account IDs of the GuardDuty member accounts whose findings
# you want the master account to stop monitoring.
#
- # @option params [required, String] :detector_id
- #
# @return [Types::StopMonitoringMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::StopMonitoringMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
#
# @example Request syntax with placeholder values
#
# resp = client.stop_monitoring_members({
- # account_ids: ["__string"], # required
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
+ # account_ids: ["AccountId"], # required
# })
#
# @example Response structure
#
# resp.unprocessed_accounts #=> Array
@@ -1708,20 +1832,22 @@
# Unarchives Amazon GuardDuty findings specified by the list of finding
# IDs.
#
# @option params [required, String] :detector_id
+ # The ID of the detector that specifies the GuardDuty service whose
+ # findings you want to unarchive.
#
# @option params [required, Array<String>] :finding_ids
# IDs of the findings that you want to unarchive.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.unarchive_findings({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# finding_ids: ["FindingId"], # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/UnarchiveFindings AWS API Documentation
#
@@ -1733,10 +1859,11 @@
end
# Updates an Amazon GuardDuty detector specified by the detectorId.
#
# @option params [required, String] :detector_id
+ # The unique ID of the detector that you want to update.
#
# @option params [Boolean] :enable
# Updated boolean value for the detector that specifies whether the
# detector is enabled.
#
@@ -1747,11 +1874,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.update_detector({
- # detector_id: "__string", # required
+ # detector_id: "DetectorId", # required
# enable: false,
# finding_publishing_frequency: "FIFTEEN_MINUTES", # accepts FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/UpdateDetector AWS API Documentation
@@ -1763,54 +1890,63 @@
req.send_request(options)
end
# Updates the filter specified by the filter name.
#
- # @option params [String] :action
- # Specifies the action that is to be applied to the findings that match
- # the filter.
- #
- # @option params [String] :description
- # The description of the filter.
- #
# @option params [required, String] :detector_id
+ # The unique ID of the detector that specifies the GuardDuty service
+ # where you want to update a filter.
#
# @option params [required, String] :filter_name
+ # The name of the filter.
#
- # @option params [Types::FindingCriteria] :finding_criteria
- # Represents the criteria to be used in the filter for querying
- # findings.
+ # @option params [String] :description
+ # The description of the filter.
#
+ # @option params [String] :action
+ # Specifies the action that is to be applied to the findings that match
+ # the filter.
+ #
# @option params [Integer] :rank
# Specifies the position of the filter in the list of current filters.
# Also specifies the order in which this filter is applied to the
# findings.
#
+ # @option params [Types::FindingCriteria] :finding_criteria
+ # Represents the criteria to be used in the filter for querying
+ # findings.
+ #
# @return [Types::UpdateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateFilterResponse#name #name} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_filter({
- # action: "NOOP", # accepts NOOP, ARCHIVE
+ # detector_id: "DetectorId", # required
+ # filter_name: "String", # required
# description: "FilterDescription",
- # detector_id: "__string", # required
- # filter_name: "__string", # required
+ # action: "NOOP", # accepts NOOP, ARCHIVE
+ # rank: 1,
# finding_criteria: {
# criterion: {
- # "__string" => {
- # eq: ["__string"],
+ # "String" => {
+ # eq: ["String"],
+ # neq: ["String"],
# gt: 1,
# gte: 1,
# lt: 1,
# lte: 1,
- # neq: ["__string"],
+ # equals: ["String"],
+ # not_equals: ["String"],
+ # greater_than: 1,
+ # greater_than_or_equal: 1,
+ # less_than: 1,
+ # less_than_or_equal: 1,
# },
# },
# },
- # rank: 1,
# })
#
# @example Response structure
#
# resp.name #=> String
@@ -1824,30 +1960,32 @@
req.send_request(options)
end
# Marks specified Amazon GuardDuty findings as useful or not useful.
#
- # @option params [String] :comments
- # Additional feedback about the GuardDuty findings.
- #
# @option params [required, String] :detector_id
+ # The ID of the detector that specifies the GuardDuty service whose
+ # findings you want to mark as useful or not useful.
#
+ # @option params [required, Array<String>] :finding_ids
+ # IDs of the findings that you want to mark as useful or not useful.
+ #
# @option params [required, String] :feedback
# Valid values: USEFUL \| NOT\_USEFUL
#
- # @option params [required, Array<String>] :finding_ids
- # IDs of the findings that you want to mark as useful or not useful.
+ # @option params [String] :comments
+ # Additional feedback about the GuardDuty findings.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.update_findings_feedback({
- # comments: "Comments",
- # detector_id: "__string", # required
- # feedback: "USEFUL", # required, accepts USEFUL, NOT_USEFUL
+ # detector_id: "DetectorId", # required
# finding_ids: ["FindingId"], # required
+ # feedback: "USEFUL", # required, accepts USEFUL, NOT_USEFUL
+ # comments: "String",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/UpdateFindingsFeedback AWS API Documentation
#
# @overload update_findings_feedback(params = {})
@@ -1857,35 +1995,38 @@
req.send_request(options)
end
# Updates the IPSet specified by the IPSet ID.
#
- # @option params [Boolean] :activate
- # The updated boolean value that specifies whether the IPSet is active
- # or not.
- #
# @option params [required, String] :detector_id
+ # The detectorID that specifies the GuardDuty service whose IPSet you
+ # want to update.
#
# @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.
+ #
# @option params [String] :location
# The updated URI of the file that contains the IPSet. For example
# (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
#
- # @option params [String] :name
- # The unique ID that specifies the IPSet that you want to update.
+ # @option params [Boolean] :activate
+ # The updated boolean value that specifies whether the IPSet is active
+ # or not.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.update_ip_set({
- # activate: false,
- # detector_id: "__string", # required
- # ip_set_id: "__string", # required
- # location: "Location",
+ # detector_id: "DetectorId", # required
+ # ip_set_id: "String", # required
# name: "Name",
+ # location: "Location",
+ # activate: false,
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/UpdateIPSet AWS API Documentation
#
# @overload update_ip_set(params = {})
@@ -1895,36 +2036,40 @@
req.send_request(options)
end
# Updates the ThreatIntelSet specified by ThreatIntelSet ID.
#
- # @option params [Boolean] :activate
- # The updated boolean value that specifies whether the ThreateIntelSet
- # is active or not.
- #
# @option params [required, String] :detector_id
+ # The detectorID that specifies the GuardDuty service whose
+ # ThreatIntelSet you want to update.
#
- # @option params [String] :location
- # The updated URI of the file that contains the ThreateIntelSet. For
- # example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
+ # @option params [required, String] :threat_intel_set_id
+ # The unique ID that specifies the ThreatIntelSet that you want to
+ # update.
#
# @option params [String] :name
# The unique ID that specifies the ThreatIntelSet that you want to
# update.
#
- # @option params [required, String] :threat_intel_set_id
+ # @option params [String] :location
+ # The updated URI of the file that contains the ThreateIntelSet. For
+ # example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
#
+ # @option params [Boolean] :activate
+ # The updated boolean value that specifies whether the ThreateIntelSet
+ # is active or not.
+ #
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.update_threat_intel_set({
- # activate: false,
- # detector_id: "__string", # required
- # location: "Location",
+ # detector_id: "DetectorId", # required
+ # threat_intel_set_id: "String", # required
# name: "Name",
- # threat_intel_set_id: "__string", # required
+ # location: "Location",
+ # activate: false,
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/UpdateThreatIntelSet AWS API Documentation
#
# @overload update_threat_intel_set(params = {})
@@ -1945,10 +2090,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-guardduty'
- context[:gem_version] = '1.17.0'
+ context[:gem_version] = '1.18.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated