lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.42.0 vs lib/aws-sdk-guardduty/client.rb in aws-sdk-guardduty-1.43.0

- old
+ new

@@ -325,22 +325,23 @@ super end # @!group API Operations - # Accepts the invitation to be monitored by a master GuardDuty account. + # Accepts the invitation to be monitored by a GuardDuty administrator + # account. # # @option params [required, String] :detector_id # The unique ID of the detector of the GuardDuty member account. # # @option params [required, String] :master_id - # The account ID of the master GuardDuty account whose invitation + # The account ID of the GuardDuty administrator account whose invitation # you're accepting. # # @option params [required, String] :invitation_id - # The value that is used to validate the master account to the member - # account. + # The value that is used to validate the administrator account to the + # member account. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -360,12 +361,12 @@ end # Archives GuardDuty findings that are specified by the list of finding # IDs. # - # <note markdown="1"> Only the master account can archive findings. Member accounts don't - # have permission to archive findings from their accounts. + # <note markdown="1"> Only the administrator account can archive findings. Member accounts + # don't have permission to archive findings from their accounts. # # </note> # # @option params [required, String] :detector_id # The ID of the detector that specifies the GuardDuty service whose @@ -406,16 +407,14 @@ # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # # @option params [String] :finding_publishing_frequency - # An enum value that specifies how frequently updated findings are - # exported. + # A value that specifies how frequently updated findings are exported. # # @option params [Types::DataSourceConfigurations] :data_sources - # An object that describes which data sources will be enabled for the - # detector. + # Describes which data sources will be enabled for the detector. # # @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: @@ -452,15 +451,17 @@ end # Creates a filter using the specified finding criteria. # # @option params [required, String] :detector_id - # The unique ID of the detector of the GuardDuty account that you want - # to create a filter for. + # The ID of the detector belonging to the GuardDuty account that you + # want to create a filter for. # # @option params [required, String] :name - # The name of the filter. + # The name of the filter. Minimum length of 3. Maximum length of 64. + # Valid characters include alphanumeric characters, dot (.), underscore + # (\_), and dash (-). Spaces are not allowed. # # @option params [String] :description # The description of the filter. # # @option params [String] :action @@ -528,10 +529,12 @@ # # * service.action.awsApiCallAction.api # # * service.action.awsApiCallAction.callerType # + # * service.action.awsApiCallAction.errorCode + # # * service.action.awsApiCallAction.remoteIpDetails.city.cityName # # * service.action.awsApiCallAction.remoteIpDetails.country.countryName # # * service.action.awsApiCallAction.remoteIpDetails.ipAddressV4 @@ -647,12 +650,12 @@ # Creates a new IPSet, which is called a trusted IP list in the console # user interface. An IPSet is a list of IP addresses that are trusted # for secure communication with AWS infrastructure and applications. # GuardDuty doesn't generate findings for IP addresses that are - # included in IPSets. Only users from the master account can use this - # operation. + # 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. # @@ -718,12 +721,13 @@ # associated member accounts either by invitation or through an # organization. # # When using `Create Members` as an organizations delegated # administrator this action will enable GuardDuty in the added member - # accounts, with the exception of the organization master account, which - # must enable GuardDuty prior to being added as a 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]. # @@ -735,11 +739,11 @@ # The unique ID of the detector of the GuardDuty account that you want # to associate member accounts with. # # @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. + # want to associate with the GuardDuty administrator account. # # @return [Types::CreateMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # @@ -848,11 +852,11 @@ req.send_request(options) end # Creates a new ThreatIntelSet. ThreatIntelSets consist of known # malicious IP addresses. GuardDuty generates findings based on - # ThreatIntelSets. Only users of the master account can use this + # 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. @@ -1051,12 +1055,12 @@ def delete_invitations(params = {}, options = {}) req = build_request(:delete_invitations, params) req.send_request(options) end - # Deletes GuardDuty member accounts (to the current GuardDuty master - # account) specified by the account IDs. + # Deletes GuardDuty member accounts (to the current GuardDuty + # administrator 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. # @@ -1243,12 +1247,12 @@ def disable_organization_admin_account(params = {}, options = {}) req = build_request(:disable_organization_admin_account, params) req.send_request(options) end - # Disassociates the current GuardDuty member account from its master - # account. + # Disassociates the current GuardDuty member account from its + # administrator 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}. @@ -1267,19 +1271,19 @@ req = build_request(:disassociate_from_master_account, params) req.send_request(options) end # Disassociates GuardDuty member accounts (to the current GuardDuty - # master account) specified by the account IDs. + # administrator 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 the master account. + # you want to disassociate from the administrator account. # # @option params [required, Array<String>] :account_ids # A list of account IDs of the GuardDuty member accounts that you want - # to disassociate from the master account. + # to disassociate from the administrator account. # # @return [Types::DisassociateMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DisassociateMembersResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # @@ -1725,12 +1729,12 @@ def get_invitations_count(params = {}, options = {}) req = build_request(:get_invitations_count, params) req.send_request(options) end - # Provides the details for the GuardDuty master account associated with - # the current GuardDuty member account. + # Provides the details for the GuardDuty administrator account + # associated with 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: @@ -1761,11 +1765,11 @@ # Describes which data sources are enabled for the member account's # detector. # # @option params [required, String] :detector_id - # The detector ID for the master account. + # The detector ID for the administrator account. # # @option params [required, Array<String>] :account_ids # The account ID of the member account. # # @return [Types::GetMemberDetectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1799,12 +1803,12 @@ def get_member_detectors(params = {}, options = {}) req = build_request(:get_member_detectors, params) req.send_request(options) end - # Retrieves GuardDuty member accounts (to the current GuardDuty master - # account) specified by the account IDs. + # Retrieves GuardDuty member accounts (of the current GuardDuty + # administrator 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. # @@ -1976,12 +1980,12 @@ req.send_request(options) end # 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. + # AWS account to view and manage these accounts' findings on their + # behalf as the GuardDuty administrator account. # # @option params [required, String] :detector_id # The unique ID of the detector of the GuardDuty account that you want # to invite members with. # @@ -2299,11 +2303,11 @@ req.send_request(options) end # 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 master account. + # 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. # # @option params [Integer] :max_results @@ -2394,11 +2398,11 @@ req = build_request(:list_invitations, params) req.send_request(options) end # Lists details about all member accounts for the current GuardDuty - # master account. + # administrator account. # # @option params [required, String] :detector_id # The unique ID of the detector the member is associated with. # # @option params [Integer] :max_results @@ -2577,11 +2581,12 @@ req.send_request(options) end # Lists the ThreatIntelSets of the GuardDuty service specified by the # detector ID. If you use this operation from a member account, the - # ThreatIntelSets associated with the master account are returned. + # 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. # @@ -2630,11 +2635,11 @@ # Turns on GuardDuty monitoring of the specified member accounts. Use # this operation to restart monitoring of accounts that you stopped # monitoring with the `StopMonitoringMembers` operation. # # @option params [required, String] :detector_id - # The unique ID of the detector of the GuardDuty master account + # The unique ID of the detector of the GuardDuty administrator account # associated with the member accounts to monitor. # # @option params [required, Array<String>] :account_ids # A list of account IDs of the GuardDuty member accounts to start # monitoring. @@ -2668,12 +2673,12 @@ # Stops GuardDuty monitoring for the specified member accounts. Use the # `StartMonitoringMembers` operation to restart monitoring for those # accounts. # # @option params [required, String] :detector_id - # The unique ID of the detector associated with the GuardDuty master - # account that is monitoring member accounts. + # The unique ID of the detector associated with the GuardDuty + # administrator account that is monitoring member accounts. # # @option params [required, Array<String>] :account_ids # A list of account IDs for the member accounts to stop monitoring. # # @return [Types::StopMonitoringMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -2794,11 +2799,11 @@ # @option params [String] :finding_publishing_frequency # An enum value that specifies how frequently findings are exported, # such as to CloudWatch Events. # # @option params [Types::DataSourceConfigurations] :data_sources - # An object that describes which data sources will be updated. + # Describes which data sources will be updated. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -2969,17 +2974,17 @@ end # Contains information on member accounts to be updated. # # @option params [required, String] :detector_id - # The detector ID of the master account. + # The detector ID of the administrator account. # # @option params [required, Array<String>] :account_ids # A list of member account IDs to be updated. # # @option params [Types::DataSourceConfigurations] :data_sources - # An object describes which data sources will be updated. + # Describes which data sources will be updated. # # @return [Types::UpdateMemberDetectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateMemberDetectorsResponse#unprocessed_accounts #unprocessed_accounts} => Array&lt;Types::UnprocessedAccount&gt; # @@ -3018,11 +3023,11 @@ # @option params [required, Boolean] :auto_enable # Indicates whether to automatically enable member accounts in the # organization. # # @option params [Types::OrganizationDataSourceConfigurations] :data_sources - # An object describes which data sources will be updated. + # Describes which data sources will be updated. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -3094,12 +3099,11 @@ # @option params [String] :name # The unique ID that specifies the ThreatIntelSet that 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. + # The updated URI of the file that contains the ThreateIntelSet. # # @option params [Boolean] :activate # The updated Boolean value that specifies whether the ThreateIntelSet # is active or not. # @@ -3135,10 +3139,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-guardduty' - context[:gem_version] = '1.42.0' + context[:gem_version] = '1.43.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated