lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.18.0 vs lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.19.0

- old
+ new

@@ -325,20 +325,26 @@ # # @option params [String] :finding_publishing_frequency # A enum value that specifies how frequently customer got Finding # updates published. # + # @option params [Hash<String,String>] :tags + # The tags to be added to a new detector resource. + # # @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, # required # client_token: "ClientToken", # finding_publishing_frequency: "FIFTEEN_MINUTES", # accepts FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS + # tags: { + # "TagKey" => "TagValue", + # }, # }) # # @example Response structure # # resp.detector_id #=> String @@ -381,10 +387,13 @@ # 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 [Hash<String,String>] :tags + # The tags to be added to a new filter resource. + # # @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 @@ -412,10 +421,13 @@ # less_than_or_equal: 1, # }, # }, # }, # client_token: "ClientToken", + # tags: { + # "TagKey" => "TagValue", + # }, # }) # # @example Response structure # # resp.name #=> String @@ -457,10 +469,13 @@ # 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 [Hash<String,String>] :tags + # The tags to be added to a new IP set resource. + # # @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 @@ -470,10 +485,13 @@ # name: "Name", # required # format: "TXT", # required, accepts TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE # location: "Location", # required # activate: false, # required # client_token: "ClientToken", + # tags: { + # "TagKey" => "TagValue", + # }, # }) # # @example Response structure # # resp.ip_set_id #=> String @@ -586,10 +604,13 @@ # 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 [Hash<String,String>] :tags + # The tags to be added to a new Threat List resource. + # # @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 @@ -599,10 +620,13 @@ # name: "Name", # required # format: "TXT", # required, accepts TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE # location: "Location", # required # activate: false, # required # client_token: "ClientToken", + # tags: { + # "TagKey" => "TagValue", + # }, # }) # # @example Response structure # # resp.threat_intel_set_id #=> String @@ -887,10 +911,11 @@ # * {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 + # * {Types::GetDetectorResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.get_detector({ # detector_id: "DetectorId", # required @@ -901,10 +926,12 @@ # 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 + # resp.tags #=> Hash + # resp.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetDetector AWS API Documentation # # @overload get_detector(params = {}) # @param [Hash] params ({}) @@ -926,10 +953,11 @@ # * {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 + # * {Types::GetFilterResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.get_filter({ # detector_id: "DetectorId", # required @@ -957,10 +985,12 @@ # 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 + # resp.tags #=> Hash + # resp.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetFilter AWS API Documentation # # @overload get_filter(params = {}) # @param [Hash] params ({}) @@ -1182,10 +1212,11 @@ # # * {Types::GetIPSetResponse#name #name} => String # * {Types::GetIPSetResponse#format #format} => String # * {Types::GetIPSetResponse#location #location} => String # * {Types::GetIPSetResponse#status #status} => String + # * {Types::GetIPSetResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.get_ip_set({ # detector_id: "DetectorId", # required @@ -1196,10 +1227,12 @@ # # resp.name #=> String # resp.format #=> String, one of "TXT", "STIX", "OTX_CSV", "ALIEN_VAULT", "PROOF_POINT", "FIRE_EYE" # resp.location #=> String # resp.status #=> String, one of "INACTIVE", "ACTIVATING", "ACTIVE", "DEACTIVATING", "ERROR", "DELETE_PENDING", "DELETED" + # resp.tags #=> Hash + # resp.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetIPSet AWS API Documentation # # @overload get_ip_set(params = {}) # @param [Hash] params ({}) @@ -1320,10 +1353,11 @@ # # * {Types::GetThreatIntelSetResponse#name #name} => String # * {Types::GetThreatIntelSetResponse#format #format} => String # * {Types::GetThreatIntelSetResponse#location #location} => String # * {Types::GetThreatIntelSetResponse#status #status} => String + # * {Types::GetThreatIntelSetResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.get_threat_intel_set({ # detector_id: "DetectorId", # required @@ -1334,10 +1368,12 @@ # # resp.name #=> String # resp.format #=> String, one of "TXT", "STIX", "OTX_CSV", "ALIEN_VAULT", "PROOF_POINT", "FIRE_EYE" # resp.location #=> String # resp.status #=> String, one of "INACTIVE", "ACTIVATING", "ACTIVE", "DEACTIVATING", "ERROR", "DELETE_PENDING", "DELETED" + # resp.tags #=> Hash + # resp.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetThreatIntelSet AWS API Documentation # # @overload get_threat_intel_set(params = {}) # @param [Hash] params ({}) @@ -1704,10 +1740,42 @@ def list_members(params = {}, options = {}) req = build_request(:list_members, params) req.send_request(options) end + # Lists tags for a resource. Tagging is currently supported for + # detectors, finding filters, IP sets, and Threat Intel sets, with a + # limit of 50 tags per resource. When invoked, this operation returns + # all assigned tags for a given resource.. + # + # @option params [required, String] :resource_arn + # The Amazon Resource Name (ARN) for the given GuardDuty resource + # + # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt; + # + # @example Request syntax with placeholder values + # + # resp = client.list_tags_for_resource({ + # resource_arn: "GuardDutyArn", # required + # }) + # + # @example Response structure + # + # resp.tags #=> Hash + # resp.tags["TagKey"] #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/ListTagsForResource AWS API Documentation + # + # @overload list_tags_for_resource(params = {}) + # @param [Hash] params ({}) + def list_tags_for_resource(params = {}, options = {}) + req = build_request(:list_tags_for_resource, params) + req.send_request(options) + end + # 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. @@ -1828,10 +1896,38 @@ def stop_monitoring_members(params = {}, options = {}) req = build_request(:stop_monitoring_members, params) req.send_request(options) end + # Adds tags to a resource. + # + # @option params [required, String] :resource_arn + # The Amazon Resource Name (ARN) for the given GuardDuty resource + # + # @option params [required, Hash<String,String>] :tags + # The tags to be added to a resource. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.tag_resource({ + # resource_arn: "GuardDutyArn", # required + # tags: { # required + # "TagKey" => "TagValue", + # }, + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/TagResource AWS API Documentation + # + # @overload tag_resource(params = {}) + # @param [Hash] params ({}) + def tag_resource(params = {}, options = {}) + req = build_request(:tag_resource, params) + req.send_request(options) + end + # 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 @@ -1856,10 +1952,36 @@ def unarchive_findings(params = {}, options = {}) req = build_request(:unarchive_findings, params) req.send_request(options) end + # Removes tags from a resource. + # + # @option params [required, String] :resource_arn + # The Amazon Resource Name (ARN) for the given GuardDuty resource + # + # @option params [required, Array<String>] :tag_keys + # The tag keys to remove from a resource. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.untag_resource({ + # resource_arn: "GuardDutyArn", # required + # tag_keys: ["TagKey"], # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/UntagResource AWS API Documentation + # + # @overload untag_resource(params = {}) + # @param [Hash] params ({}) + def untag_resource(params = {}, options = {}) + req = build_request(:untag_resource, params) + req.send_request(options) + 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. # @@ -2090,10 +2212,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-guardduty' - context[:gem_version] = '1.18.0' + context[:gem_version] = '1.19.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated