lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.63.0 vs lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.64.0

- old
+ new

@@ -471,10 +471,19 @@ # that represents the GuardDuty service. To start using GuardDuty, you # must create a detector in each Region where you enable the service. # You can have only one detector per account per Region. All data # sources are enabled in a new detector by default. # + # 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]. + # + # + # + # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html + # # @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. @@ -486,10 +495,19 @@ # A value that specifies how frequently updated findings are exported. # # @option params [Types::DataSourceConfigurations] :data_sources # Describes which data sources will be enabled for the detector. # + # 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]. + # + # + # + # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html + # # @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: # @@ -548,13 +566,13 @@ # The name of the filter. Valid characters include period (.), # underscore (\_), dash (-), and alphanumeric characters. A whitespace # is considered to be an invalid character. # # @option params [String] :description - # The description of the filter. Valid special characters include period - # (.), underscore (\_), dash (-), and whitespace. The new line character - # is considered to be an invalid input for description. + # The description of the filter. Valid characters include alphanumeric + # characters, and special characters such as `-`, `.`, `:`, `\{ \}`, `[ + # ]`, `( )`, `/`, `\t`, `\n`, `\x0B`, `\f`, `\r`, `_`, and whitespace. # # @option params [String] :action # Specifies the action that is to be applied to the findings that match # the filter. # @@ -571,12 +589,10 @@ # # * accountId # # * region # - # * confidence - # # * id # # * resource.accessKeyDetails.accessKeyId # # * resource.accessKeyDetails.principalId @@ -671,17 +687,10 @@ # # * resource.s3BucketDetails.tags.value # # * resource.s3BucketDetails.type # - # * service.archived - # - # 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.resourceRole # # * severity # # * type @@ -762,11 +771,11 @@ # to create an IPSet for. # # @option params [required, String] :name # The user-friendly name to identify the IPSet. # - # Allowed characters are alphanumerics, spaces, hyphens (-), and + # Allowed characters are alphanumeric, whitespace, dash (-), and # underscores (\_). # # @option params [required, String] :format # The format of the file that contains the IPSet. # @@ -826,13 +835,13 @@ # administrator this action will enable GuardDuty in the added member # accounts, with the exception of the organization delegated # administrator account, which must enable GuardDuty prior to being # added as a member. # - # If you are adding accounts by invitation use this action after - # GuardDuty has been enabled in potential member accounts and before - # using [ `Invite Members` ][1]. + # If you are adding accounts by invitation, use this action after + # GuardDuty has bee enabled in potential member accounts and before + # using [InviteMembers][1]. # # # # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html # @@ -923,13 +932,13 @@ def create_publishing_destination(params = {}, options = {}) req = build_request(:create_publishing_destination, params) req.send_request(options) end - # Generates example findings of types specified by the list of finding + # Generates sample 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. + # sample 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 @@ -1252,10 +1261,19 @@ # Returns a list of malware scans. Each member account can view the # malware scans for their own accounts. An administrator can view the # malware scans for all the member accounts. # + # 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]. + # + # + # + # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html + # # @option params [required, String] :detector_id # The unique ID of the detector that the request is associated with. # # @option params [String] :next_token # You can use this parameter when paginating results. Set the value of @@ -1272,12 +1290,17 @@ # @option params [Types::FilterCriteria] :filter_criteria # Represents the criteria to be used in the filter for describing scan # entries. # # @option params [Types::SortCriteria] :sort_criteria - # Represents the criteria used for sorting scan entries. + # Represents the criteria used for sorting scan entries. The [ + # `attributeName` ][1] is required and it must be `scanStartTime`. # + # + # + # [1]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_SortCriteria.html#guardduty-Type-SortCriteria-attributeName + # # @return [Types::DescribeMalwareScansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeMalwareScansResponse#scans #scans} => Array&lt;Types::Scan&gt; # * {Types::DescribeMalwareScansResponse#next_token #next_token} => String # @@ -1344,10 +1367,19 @@ end # Returns information about the account selected as the delegated # administrator for GuardDuty. # + # 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]. + # + # + # + # [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. # # @return [Types::DescribeOrganizationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1585,10 +1617,19 @@ req.send_request(options) end # Retrieves an Amazon 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]. + # + # + # + # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html + # # @option params [required, String] :detector_id # The unique ID of the detector that you want to get. # # @return [Types::GetDetectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2126,10 +2167,19 @@ req.send_request(options) end # Returns the details of the malware scan settings. # + # 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]. + # + # + # + # [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. # # @return [Types::GetMalwareScanSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -2197,10 +2247,19 @@ end # Describes which data sources are enabled for the member account's # detector. # + # 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]. + # + # + # + # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html + # # @option params [required, String] :detector_id # The detector ID for the administrator account. # # @option params [required, Array<String>] :account_ids # The account ID of the member account. @@ -3276,10 +3335,19 @@ req.send_request(options) end # Updates the Amazon 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]. + # + # + # + # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html + # # @option params [required, String] :detector_id # The unique ID of the detector to update. # # @option params [Boolean] :enable # Specifies whether the detector is enabled or not enabled. @@ -3289,10 +3357,19 @@ # such as to CloudWatch Events. # # @option params [Types::DataSourceConfigurations] :data_sources # Describes which data sources will be updated. # + # 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]. + # + # + # + # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.update_detector({ @@ -3333,13 +3410,15 @@ # # @option params [required, String] :filter_name # The name of the filter. # # @option params [String] :description - # The description of the filter. Valid special characters include period - # (.), underscore (\_), dash (-), and whitespace. The new line character - # is considered to be an invalid input for description. + # The description of the filter. Valid characters include alphanumeric + # characters, and special characters such as hyphen, period, colon, + # underscore, parentheses (`\{ \}`, `[ ]`, and `( )`), forward slash, + # horizontal tab, vertical tab, newline, form feed, return, and + # whitespace. # # @option params [String] :action # Specifies the action that is to be applied to the findings that match # the filter. # @@ -3472,10 +3551,19 @@ req.send_request(options) end # Updates the malware scan settings. # + # 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]. + # + # + # + # [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 specifies the GuardDuty service # where you want to update scan settings. # # @option params [Types::ScanResourceCriteria] :scan_resource_criteria @@ -3525,10 +3613,19 @@ req.send_request(options) end # Contains information on member accounts to be updated. # + # 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]. + # + # + # + # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html + # # @option params [required, String] :detector_id # The detector ID of the administrator account. # # @option params [required, Array<String>] :account_ids # A list of member account IDs to be updated. @@ -3577,10 +3674,19 @@ req.send_request(options) end # Updates the delegated administrator account with the values provided. # + # 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]. + # + # + # + # [1]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html + # # @option params [required, String] :detector_id # The ID of the detector to update the delegated administrator for. # # @option params [required, Boolean] :auto_enable # Indicates whether to automatically enable member accounts in the @@ -3713,10 +3819,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-guardduty' - context[:gem_version] = '1.63.0' + context[:gem_version] = '1.64.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated