lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.7.0 vs lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.8.0

- old
+ new

@@ -178,26 +178,26 @@ # Accepts the invitation to be monitored by a master GuardDuty account. # # @option params [required, String] :detector_id # - # @option params [String] :invitation_id + # @option params [required, String] :invitation_id # This value is used to validate the master account to the member # account. # - # @option params [String] :master_id + # @option params [required, String] :master_id # The account ID of the master GuardDuty account whose invitation # you're accepting. # # @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", - # master_id: "MasterId", + # invitation_id: "InvitationId", # required + # master_id: "MasterId", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/AcceptInvitation AWS API Documentation # # @overload accept_invitation(params = {}) @@ -210,20 +210,20 @@ # Archives Amazon GuardDuty findings specified by the list of finding # IDs. # # @option params [required, String] :detector_id # - # @option params [Array<String>] :finding_ids + # @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 - # finding_ids: ["FindingId"], + # finding_ids: ["FindingId"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/ArchiveFindings AWS API Documentation # # @overload archive_findings(params = {}) @@ -235,21 +235,31 @@ # 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 [Boolean] :enable + # @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] :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: # # * {Types::CreateDetectorResponse#detector_id #detector_id} => String # # @example Request syntax with placeholder values # # resp = client.create_detector({ - # enable: false, + # client_token: "__stringMin0Max64", + # enable: false, # required + # finding_publishing_frequency: "FIFTEEN_MINUTES", # accepts FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS # }) # # @example Response structure # # resp.detector_id #=> String @@ -276,15 +286,15 @@ # @option params [String] :description # The description of the filter. # # @option params [required, String] :detector_id # - # @option params [Types::FindingCriteria] :finding_criteria + # @option params [required, Types::FindingCriteria] :finding_criteria # Represents the criteria to be used in the filter for querying # findings. # - # @option params [String] :name + # @option params [required, String] :name # The name of 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 @@ -299,11 +309,11 @@ # resp = client.create_filter({ # action: "NOOP", # accepts NOOP, ARCHIVE # client_token: "__stringMin0Max64", # description: "FilterDescription", # detector_id: "__string", # required - # finding_criteria: { + # finding_criteria: { # required # criterion: { # "__string" => { # eq: ["__string"], # gt: 1, # gte: 1, @@ -311,11 +321,11 @@ # lte: 1, # neq: ["__string"], # }, # }, # }, - # name: "FilterName", + # name: "FilterName", # required # rank: 1, # }) # # @example Response structure # @@ -332,24 +342,28 @@ # Creates a new IPSet - a list of trusted IP addresses that have been # whitelisted for secure communication with AWS infrastructure and # applications. # - # @option params [Boolean] :activate + # @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 # - # @option params [String] :format + # @option params [required, String] :format # The format of the file that contains the IPSet. # - # @option params [String] :location + # @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 [String] :name + # @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. # # @return [Types::CreateIPSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -357,15 +371,16 @@ # * {Types::CreateIPSetResponse#ip_set_id #ip_set_id} => String # # @example Request syntax with placeholder values # # resp = client.create_ip_set({ - # activate: false, + # activate: false, # required + # client_token: "__stringMin0Max64", # detector_id: "__string", # required - # format: "TXT", # accepts TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE - # location: "Location", - # name: "Name", + # format: "TXT", # required, accepts TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE + # location: "Location", # required + # name: "Name", # required # }) # # @example Response structure # # resp.ip_set_id #=> String @@ -381,11 +396,11 @@ # 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 [Array<Types::AccountDetail>] :account_details + # @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 # @@ -394,11 +409,11 @@ # * {Types::CreateMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # # @example Request syntax with placeholder values # # resp = client.create_members({ - # account_details: [ + # account_details: [ # required # { # account_id: "AccountId", # required # email: "Email", # required # }, # ], @@ -449,24 +464,28 @@ # Create a new ThreatIntelSet. ThreatIntelSets consist of known # malicious IP addresses. GuardDuty generates findings based on # ThreatIntelSets. # - # @option params [Boolean] :activate + # @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 # - # @option params [String] :format + # @option params [required, String] :format # The format of the file that contains the ThreatIntelSet. # - # @option params [String] :location + # @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 [String] :name + # @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. # # @return [Types::CreateThreatIntelSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -474,15 +493,16 @@ # * {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, + # activate: false, # required + # client_token: "__stringMin0Max64", # detector_id: "__string", # required - # format: "TXT", # accepts TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE - # location: "Location", - # name: "Name", + # format: "TXT", # required, accepts TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE + # location: "Location", # required + # name: "Name", # required # }) # # @example Response structure # # resp.threat_intel_set_id #=> String @@ -497,22 +517,22 @@ end # Declines invitations sent to the current member account by AWS account # specified by their account IDs. # - # @option params [Array<String>] :account_ids + # @option params [required, Array<String>] :account_ids # A list of account IDs of the AWS accounts that sent invitations to the # current member account that you want to decline invitations from. # # @return [Types::DeclineInvitationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeclineInvitationsResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # # @example Request syntax with placeholder values # # resp = client.decline_invitations({ - # account_ids: ["__string"], + # account_ids: ["__string"], # required # }) # # @example Response structure # # resp.unprocessed_accounts #=> Array @@ -598,22 +618,22 @@ end # Deletes invitations sent to the current member account by AWS accounts # specified by their account IDs. # - # @option params [Array<String>] :account_ids + # @option params [required, Array<String>] :account_ids # A list of account IDs of the AWS accounts that sent invitations to the # current member account that you want to delete invitations from. # # @return [Types::DeleteInvitationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteInvitationsResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # # @example Request syntax with placeholder values # # resp = client.delete_invitations({ - # account_ids: ["__string"], + # account_ids: ["__string"], # required # }) # # @example Response structure # # resp.unprocessed_accounts #=> Array @@ -630,11 +650,11 @@ end # Deletes GuardDuty member accounts (to the current GuardDuty master # account) specified by the account IDs. # - # @option params [Array<String>] :account_ids + # @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 # @@ -643,11 +663,11 @@ # * {Types::DeleteMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # # @example Request syntax with placeholder values # # resp = client.delete_members({ - # account_ids: ["__string"], + # account_ids: ["__string"], # required # detector_id: "__string", # required # }) # # @example Response structure # @@ -711,11 +731,11 @@ end # Disassociates GuardDuty member accounts (to the current GuardDuty # master account) specified by the account IDs. # - # @option params [Array<String>] :account_ids + # @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 # @@ -724,11 +744,11 @@ # * {Types::DisassociateMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # # @example Request syntax with placeholder values # # resp = client.disassociate_members({ - # account_ids: ["__string"], + # account_ids: ["__string"], # required # detector_id: "__string", # required # }) # # @example Response structure # @@ -750,10 +770,11 @@ # @option params [required, String] :detector_id # # @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 # * {Types::GetDetectorResponse#status #status} => String # * {Types::GetDetectorResponse#updated_at #updated_at} => String # # @example Request syntax with placeholder values @@ -763,10 +784,11 @@ # }) # # @example Response structure # # resp.created_at #=> String + # resp.finding_publishing_frequency #=> String, one of "FIFTEEN_MINUTES", "ONE_HOUR", "SIX_HOURS" # resp.service_role #=> String # resp.status #=> String, one of "ENABLED", "DISABLED" # resp.updated_at #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetDetector AWS API Documentation @@ -826,11 +848,11 @@ # Describes Amazon GuardDuty findings specified by finding IDs. # # @option params [required, String] :detector_id # - # @option params [Array<String>] :finding_ids + # @option params [required, Array<String>] :finding_ids # IDs of the findings that you want to retrieve. # # @option params [Types::SortCriteria] :sort_criteria # Represents the criteria used for sorting findings. # @@ -840,11 +862,11 @@ # # @example Request syntax with placeholder values # # resp = client.get_findings({ # detector_id: "__string", # required - # finding_ids: ["FindingId"], + # finding_ids: ["FindingId"], # required # sort_criteria: { # attribute_name: "__string", # order_by: "ASC", # accepts ASC, DESC # }, # }) @@ -972,11 +994,11 @@ # @option params [required, String] :detector_id # # @option params [Types::FindingCriteria] :finding_criteria # Represents the criteria used for querying findings. # - # @option params [Array<String>] :finding_statistic_types + # @option params [required, Array<String>] :finding_statistic_types # Types of finding statistics to retrieve. # # @return [Types::GetFindingsStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetFindingsStatisticsResponse#finding_statistics #finding_statistics} => Types::FindingStatistics @@ -995,11 +1017,11 @@ # lte: 1, # neq: ["__string"], # }, # }, # }, - # finding_statistic_types: ["COUNT_BY_SEVERITY"], # accepts COUNT_BY_SEVERITY + # finding_statistic_types: ["COUNT_BY_SEVERITY"], # required, accepts COUNT_BY_SEVERITY # }) # # @example Response structure # # resp.finding_statistics.count_by_severity #=> Hash @@ -1103,11 +1125,11 @@ end # Retrieves GuardDuty member accounts (to the current GuardDuty master # account) specified by the account IDs. # - # @option params [Array<String>] :account_ids + # @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 # @@ -1117,11 +1139,11 @@ # * {Types::GetMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # # @example Request syntax with placeholder values # # resp = client.get_members({ - # account_ids: ["__string"], + # account_ids: ["__string"], # required # detector_id: "__string", # required # }) # # @example Response structure # @@ -1186,11 +1208,11 @@ # 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 [Array<String>] :account_ids + # @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 # @@ -1208,11 +1230,11 @@ # * {Types::InviteMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # # @example Request syntax with placeholder values # # resp = client.invite_members({ - # account_ids: ["__string"], + # account_ids: ["__string"], # required # detector_id: "__string", # required # disable_email_notification: false, # message: "Message", # }) # @@ -1539,11 +1561,11 @@ # 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 [Array<String>] :account_ids + # @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 # @@ -1552,11 +1574,11 @@ # * {Types::StartMonitoringMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # # @example Request syntax with placeholder values # # resp = client.start_monitoring_members({ - # account_ids: ["__string"], + # account_ids: ["__string"], # required # detector_id: "__string", # required # }) # # @example Response structure # @@ -1576,11 +1598,11 @@ # 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 [Array<String>] :account_ids + # @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 # @@ -1589,11 +1611,11 @@ # * {Types::StopMonitoringMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # # @example Request syntax with placeholder values # # resp = client.stop_monitoring_members({ - # account_ids: ["__string"], + # account_ids: ["__string"], # required # detector_id: "__string", # required # }) # # @example Response structure # @@ -1613,20 +1635,20 @@ # Unarchives Amazon GuardDuty findings specified by the list of finding # IDs. # # @option params [required, String] :detector_id # - # @option params [Array<String>] :finding_ids + # @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 - # finding_ids: ["FindingId"], + # finding_ids: ["FindingId"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/UnarchiveFindings AWS API Documentation # # @overload unarchive_findings(params = {}) @@ -1642,17 +1664,22 @@ # # @option params [Boolean] :enable # Updated boolean value for the detector that specifies whether the # detector is enabled. # + # @option params [String] :finding_publishing_frequency + # A enum value that specifies how frequently customer got Finding + # updates published. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.update_detector({ # detector_id: "__string", # 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 # # @overload update_detector(params = {}) @@ -1728,25 +1755,25 @@ # @option params [String] :comments # Additional feedback about the GuardDuty findings. # # @option params [required, String] :detector_id # - # @option params [String] :feedback + # @option params [required, String] :feedback # Valid values: USEFUL \| NOT\_USEFUL # - # @option params [Array<String>] :finding_ids + # @option params [required, Array<String>] :finding_ids # IDs of the findings that you want to mark as useful or not useful. # # @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", # accepts USEFUL, NOT_USEFUL - # finding_ids: ["FindingId"], + # feedback: "USEFUL", # required, accepts USEFUL, NOT_USEFUL + # finding_ids: ["FindingId"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/UpdateFindingsFeedback AWS API Documentation # # @overload update_findings_feedback(params = {}) @@ -1844,10 +1871,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-guardduty' - context[:gem_version] = '1.7.0' + context[:gem_version] = '1.8.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated