lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.98.0 vs lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.99.0

- old
+ new

@@ -668,12 +668,12 @@ # # # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_limits.html # # @option params [required, String] :detector_id - # The ID of the detector belonging to the GuardDuty account that you - # want to create a filter for. + # The detector ID associated with the GuardDuty account for which you + # want to create a filter. # # @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. @@ -975,12 +975,12 @@ # applications. GuardDuty doesn't generate findings for IP addresses # that are included in IPSets. Only users from the administrator account # can use this operation. # # @option params [required, String] :detector_id - # The unique ID of the detector of the GuardDuty account that you want - # to create an IPSet for. + # 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. # # Allowed characters are alphanumeric, whitespace, dash (-), and @@ -1052,12 +1052,12 @@ # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # # @option params [required, String] :role - # IAM role with permissions required to scan and add tags to the - # associated protected resource. + # Amazon Resource Name (ARN) of the IAM role that has the permissions to + # scan and add tags to the associated protected resource. # # @option params [required, Types::CreateProtectedResource] :protected_resource # Information about the protected resource that is associated with the # created Malware Protection plan. Presently, `S3Bucket` is the only # supported protected resource. @@ -1142,12 +1142,12 @@ # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DescribeOrganizationConfiguration.html # [2]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html # [3]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html # # @option params [required, String] :detector_id - # The unique ID of the detector of the GuardDuty account that you want - # to associate member accounts with. + # The unique ID of the detector of the GuardDuty account for 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 GuardDuty administrator account. # @@ -1180,12 +1180,13 @@ def create_members(params = {}, options = {}) req = build_request(:create_members, params) req.send_request(options) end - # Creates a publishing destination to export findings to. The resource - # to export findings to must exist before you use this operation. + # Creates a publishing destination where you can export your GuardDuty + # findings. Before you start exporting the findings, the destination + # resource must exist. # # @option params [required, String] :detector_id # The ID of the GuardDuty detector associated with the publishing # destination. # @@ -1235,11 +1236,11 @@ # Generates sample findings of types specified by the list of finding # types. If 'NULL' is specified for `findingTypes`, the API generates # sample findings of all supported finding types. # # @option params [required, String] :detector_id - # The ID of the detector to create sample findings for. + # The ID of the detector for which you need to create sample findings. # # @option params [Array<String>] :finding_types # The types of sample findings to generate. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -1264,12 +1265,12 @@ # malicious IP addresses. GuardDuty generates findings based on # ThreatIntelSets. Only users of the administrator account can use this # operation. # # @option params [required, String] :detector_id - # The unique ID of the detector of the GuardDuty account that you want - # to create a threatIntelSet for. + # 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 displayed in all findings that are # generated by activity that involves IP addresses included in this # ThreatIntelSet. @@ -1381,11 +1382,11 @@ end # Deletes the filter specified by the filter name. # # @option params [required, String] :detector_id - # The unique ID of the detector that the filter is associated with. + # The unique ID of the detector that is associated with the filter. # # @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}. @@ -1559,12 +1560,12 @@ end # Deletes the ThreatIntelSet specified by the ThreatIntelSet ID. # # @option params [required, String] :detector_id - # The unique ID of the detector that the threatIntelSet is associated - # with. + # The unique ID of the detector that is associated with the + # threatIntelSet. # # @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}. @@ -1704,12 +1705,12 @@ # # # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html # # @option params [required, String] :detector_id - # The ID of the detector to retrieve information about the delegated - # administrator from. + # The detector ID of the delegated administrator for which you need to + # retrieve the information. # # @option params [Integer] :max_results # You can use this parameter to indicate the maximum number of items # that you want in the response. # @@ -2049,15 +2050,14 @@ # resources associated with the active member accounts in your # organization who have enabled Runtime Monitoring and have the # GuardDuty security agent running on their resources. # # @option params [required, String] :detector_id - # The unique ID of the GuardDuty detector associated to the coverage - # statistics. + # The unique ID of the GuardDuty detector. # # @option params [Types::CoverageFilterCriteria] :filter_criteria - # Represents the criteria used to filter the coverage statistics + # 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. # # @return [Types::GetCoverageStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -2096,11 +2096,11 @@ def get_coverage_statistics(params = {}, options = {}) req = build_request(:get_coverage_statistics, params) req.send_request(options) end - # Retrieves an Amazon GuardDuty detector specified by the detectorId. + # Retrieves a GuardDuty detector specified by the detectorId. # # There might be regional differences because some data sources might # not be available in all the Amazon Web Services Regions where # GuardDuty is presently supported. For more information, see [Regions # and endpoints][1]. @@ -2165,11 +2165,11 @@ end # Returns the details of the filter specified by the filter name. # # @option params [required, String] :detector_id - # The unique ID of the detector that the filter is associated with. + # The unique ID of the detector that is associated with this filter. # # @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: @@ -2734,40 +2734,59 @@ def get_findings(params = {}, options = {}) req = build_request(:get_findings, params) req.send_request(options) end - # Lists Amazon GuardDuty findings statistics for the specified detector - # ID. + # Lists GuardDuty findings statistics for the specified detector ID. # + # You must provide either `findingStatisticTypes` or `groupBy` + # parameter, and not both. You can use the `maxResults` and `orderBy` + # parameters only when using `groupBy`. + # # There might be regional differences because some flags might not be # available in all the Regions where GuardDuty is currently supported. # For more information, see [Regions and endpoints][1]. # # # # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html # # @option params [required, String] :detector_id - # The ID of the detector that specifies the GuardDuty service whose - # findings' statistics you want to retrieve. + # The ID of the detector whose findings statistics you want to retrieve. # - # @option params [required, Array<String>] :finding_statistic_types + # @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. # + # @option params [String] :group_by + # Displays the findings statistics grouped by one of the listed valid + # values. + # + # @option params [String] :order_by + # Displays the sorted findings in the requested order. The default value + # of `orderBy` is `DESC`. + # + # You can use this parameter only with the `groupBy` parameter. + # + # @option params [Integer] :max_results + # The maximum number of results to be returned in the response. The + # default value is 25. + # + # You can use this parameter only with the `groupBy` parameter. + # # @return [Types::GetFindingsStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetFindingsStatisticsResponse#finding_statistics #finding_statistics} => Types::FindingStatistics + # * {Types::GetFindingsStatisticsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.get_findings_statistics({ # detector_id: "DetectorId", # required - # finding_statistic_types: ["COUNT_BY_SEVERITY"], # required, accepts COUNT_BY_SEVERITY + # finding_statistic_types: ["COUNT_BY_SEVERITY"], # accepts COUNT_BY_SEVERITY # finding_criteria: { # criterion: { # "String" => { # eq: ["String"], # neq: ["String"], @@ -2782,16 +2801,43 @@ # less_than: 1, # less_than_or_equal: 1, # }, # }, # }, + # group_by: "ACCOUNT", # accepts ACCOUNT, DATE, FINDING_TYPE, RESOURCE, SEVERITY + # order_by: "ASC", # accepts ASC, DESC + # max_results: 1, # }) # # @example Response structure # # resp.finding_statistics.count_by_severity #=> Hash # resp.finding_statistics.count_by_severity["String"] #=> Integer + # resp.finding_statistics.grouped_by_account #=> Array + # resp.finding_statistics.grouped_by_account[0].account_id #=> String + # resp.finding_statistics.grouped_by_account[0].last_generated_at #=> Time + # resp.finding_statistics.grouped_by_account[0].total_findings #=> Integer + # resp.finding_statistics.grouped_by_date #=> Array + # resp.finding_statistics.grouped_by_date[0].date #=> Time + # resp.finding_statistics.grouped_by_date[0].last_generated_at #=> Time + # resp.finding_statistics.grouped_by_date[0].severity #=> Float + # resp.finding_statistics.grouped_by_date[0].total_findings #=> Integer + # resp.finding_statistics.grouped_by_finding_type #=> Array + # resp.finding_statistics.grouped_by_finding_type[0].finding_type #=> String + # resp.finding_statistics.grouped_by_finding_type[0].last_generated_at #=> Time + # resp.finding_statistics.grouped_by_finding_type[0].total_findings #=> Integer + # resp.finding_statistics.grouped_by_resource #=> Array + # resp.finding_statistics.grouped_by_resource[0].account_id #=> String + # resp.finding_statistics.grouped_by_resource[0].last_generated_at #=> Time + # resp.finding_statistics.grouped_by_resource[0].resource_id #=> String + # resp.finding_statistics.grouped_by_resource[0].resource_type #=> String + # resp.finding_statistics.grouped_by_resource[0].total_findings #=> Integer + # resp.finding_statistics.grouped_by_severity #=> Array + # resp.finding_statistics.grouped_by_severity[0].last_generated_at #=> Time + # resp.finding_statistics.grouped_by_severity[0].severity #=> Float + # resp.finding_statistics.grouped_by_severity[0].total_findings #=> Integer + # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetFindingsStatistics AWS API Documentation # # @overload get_findings_statistics(params = {}) # @param [Hash] params ({}) @@ -2801,11 +2847,11 @@ end # Retrieves the IPSet specified by the `ipSetId`. # # @option params [required, String] :detector_id - # The unique ID of the detector that the IPSet is associated with. + # The unique ID of the detector that is associated with the IPSet. # # @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: @@ -2920,12 +2966,11 @@ # # # [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 scan setting is associated - # with. + # The unique ID of the detector that is associated with this scan. # # @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 @@ -3003,11 +3048,11 @@ # # @option params [required, String] :detector_id # The detector ID for the administrator account. # # @option params [required, Array<String>] :account_ids - # The account ID of the member account. + # A list of member account IDs. # # @return [Types::GetMemberDetectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetMemberDetectorsResponse#member_data_source_configurations #member_data_source_configurations} => Array&lt;Types::MemberDataSourceConfiguration&gt; # * {Types::GetMemberDetectorsResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; @@ -3182,12 +3227,12 @@ # Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet # ID. # # @option params [required, String] :detector_id - # The unique ID of the detector that the threatIntelSet is associated - # with. + # The unique ID of the detector that is associated with the + # threatIntelSet. # # @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: @@ -3365,12 +3410,12 @@ # [4]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html # [5]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html # [6]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html # # @option params [required, String] :detector_id - # The unique ID of the detector of the GuardDuty account that you want - # to invite members with. + # 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. # @@ -3551,11 +3596,11 @@ end # Returns a paginated list of the current filters. # # @option params [required, String] :detector_id - # The unique ID of the detector that the filter is associated with. + # The unique ID of the detector that is associated with the filter. # # @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. @@ -3708,10 +3753,12 @@ # When this attribute is set to 'true', only archived findings are # listed. When it's set to 'false', only unarchived findings are # listed. When this attribute is not set, all existing findings are # listed. # + # * service.ebsVolumeScanDetails.scanId + # # * service.resourceRole # # * severity # # * type @@ -3790,11 +3837,11 @@ # Lists the IPSets of the GuardDuty service specified by the detector # ID. If you use this operation from a member account, the IPSets # returned are the IPSets from the associated administrator account. # # @option params [required, String] :detector_id - # The unique ID of the detector that the IPSet is associated with. + # The unique ID of the detector that is associated with IPSet. # # @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. @@ -3921,11 +3968,11 @@ # Lists details about all member accounts for the current GuardDuty # administrator account. # # @option params [required, String] :detector_id - # The unique ID of the detector the member is associated with. + # The unique ID of the detector that is associated with the member. # # @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. @@ -4032,11 +4079,12 @@ # Returns a list of publishing destinations associated with the # specified `detectorId`. # # @option params [required, String] :detector_id - # The ID of the detector to retrieve publishing destinations for. + # The detector ID for which you want to retrieve the publishing + # destination. # # @option params [Integer] :max_results # The maximum number of results to return in the response. # # @option params [String] :next_token @@ -4114,12 +4162,12 @@ # detector ID. If you use this operation from a member account, the # ThreatIntelSets associated with the administrator account are # returned. # # @option params [required, String] :detector_id - # The unique ID of the detector that the threatIntelSet is associated - # with. + # The unique ID of the detector that is associated with the + # threatIntelSet. # # @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. @@ -4528,12 +4576,12 @@ end # Marks the specified GuardDuty findings as useful or not useful. # # @option params [required, String] :detector_id - # The ID of the detector associated with the findings to update feedback - # for. + # The ID of the detector that is associated with the findings for which + # you want to update the feedback. # # @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 @@ -4606,12 +4654,12 @@ # # @option params [required, String] :malware_protection_plan_id # A unique identifier associated with the Malware Protection plan. # # @option params [String] :role - # IAM role with permissions required to scan and add tags to the - # associated protected resource. + # Amazon Resource Name (ARN) of the IAM role with permissions to scan + # and add tags to the associated protected resource. # # @option params [Types::MalwareProtectionPlanActions] :actions # Information about whether the tags will be added to the S3 object # after scanning. # @@ -5004,10 +5052,10 @@ params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-guardduty' - context[:gem_version] = '1.98.0' + context[:gem_version] = '1.99.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated