Class: Aws::GuardDuty::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::GuardDuty::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb
Overview
An API client for GuardDuty. To construct a client, you need to configure a :region and :credentials.
client = Aws::GuardDuty::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_administrator_invitation(params = {}) ⇒ Struct
Accepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation.
-
#accept_invitation(params = {}) ⇒ Struct
Accepts the invitation to be monitored by a GuardDuty administrator account.
-
#archive_findings(params = {}) ⇒ Struct
Archives GuardDuty findings that are specified by the list of finding IDs.
-
#create_custom_detection_rule_association(params = {}) ⇒ Types::CreateCustomDetectionRuleAssociationResponse
Enables a custom detection rule for your account by creating an association.
-
#create_custom_detection_rule_org_configuration(params = {}) ⇒ Struct
Creates an organization-level configuration that enables a custom detection rule across your organization.
-
#create_detector(params = {}) ⇒ Types::CreateDetectorResponse
Creates a single GuardDuty detector.
-
#create_filter(params = {}) ⇒ Types::CreateFilterResponse
Creates a filter using the specified finding criteria.
-
#create_investigation(params = {}) ⇒ Types::CreateInvestigationResponse
This API is currently available as a preview.
-
#create_ip_set(params = {}) ⇒ Types::CreateIPSetResponse
Creates a new IPSet, which is called a trusted IP list in the console user interface.
-
#create_malware_protection_plan(params = {}) ⇒ Types::CreateMalwareProtectionPlanResponse
Creates a new Malware Protection plan for the protected resource.
-
#create_members(params = {}) ⇒ Types::CreateMembersResponse
Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs.
-
#create_publishing_destination(params = {}) ⇒ Types::CreatePublishingDestinationResponse
Creates a publishing destination where you can export your GuardDuty findings.
-
#create_sample_findings(params = {}) ⇒ Struct
Generates sample findings of types specified by the list of finding types.
-
#create_threat_entity_set(params = {}) ⇒ Types::CreateThreatEntitySetResponse
Creates a new threat entity set.
-
#create_threat_intel_set(params = {}) ⇒ Types::CreateThreatIntelSetResponse
Creates a new ThreatIntelSet.
-
#create_trusted_entity_set(params = {}) ⇒ Types::CreateTrustedEntitySetResponse
Creates a new trusted entity set.
-
#decline_invitations(params = {}) ⇒ Types::DeclineInvitationsResponse
Declines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
-
#delete_custom_detection_rule_association(params = {}) ⇒ Struct
Disables a custom detection rule by deleting its association.
-
#delete_custom_detection_rule_org_configuration(params = {}) ⇒ Struct
Deletes the organization-level configuration for a custom detection rule.
-
#delete_detector(params = {}) ⇒ Struct
Deletes an Amazon GuardDuty detector that is specified by the detector ID.
-
#delete_filter(params = {}) ⇒ Struct
Deletes the filter specified by the filter name.
-
#delete_invitations(params = {}) ⇒ Types::DeleteInvitationsResponse
Deletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
-
#delete_ip_set(params = {}) ⇒ Struct
Deletes the IPSet specified by the
ipSetId. -
#delete_malware_protection_plan(params = {}) ⇒ Struct
Deletes the Malware Protection plan ID associated with the Malware Protection plan resource.
-
#delete_members(params = {}) ⇒ Types::DeleteMembersResponse
Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
-
#delete_publishing_destination(params = {}) ⇒ Struct
Deletes the publishing definition with the specified
destinationId. -
#delete_threat_entity_set(params = {}) ⇒ Struct
Deletes the threat entity set that is associated with the specified
threatEntitySetId. -
#delete_threat_intel_set(params = {}) ⇒ Struct
Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
-
#delete_trusted_entity_set(params = {}) ⇒ Struct
Deletes the trusted entity set that is associated with the specified
trustedEntitySetId. -
#describe_malware_scans(params = {}) ⇒ Types::DescribeMalwareScansResponse
Returns a list of malware scans.
-
#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse
Returns information about the account selected as the delegated administrator for GuardDuty.
-
#describe_publishing_destination(params = {}) ⇒ Types::DescribePublishingDestinationResponse
Returns information about the publishing destination specified by the provided
destinationId. -
#disable_organization_admin_account(params = {}) ⇒ Struct
Removes the existing GuardDuty delegated administrator of the organization.
-
#disassociate_from_administrator_account(params = {}) ⇒ Struct
Disassociates the current GuardDuty member account from its administrator account.
-
#disassociate_from_master_account(params = {}) ⇒ Struct
Disassociates the current GuardDuty member account from its administrator account.
-
#disassociate_members(params = {}) ⇒ Types::DisassociateMembersResponse
Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs.
-
#enable_organization_admin_account(params = {}) ⇒ Struct
Designates an Amazon Web Services account within the organization as your GuardDuty delegated administrator.
-
#get_administrator_account(params = {}) ⇒ Types::GetAdministratorAccountResponse
Provides the details of the GuardDuty administrator account associated with the current GuardDuty member account.
-
#get_coverage_statistics(params = {}) ⇒ Types::GetCoverageStatisticsResponse
Retrieves aggregated statistics for your account.
-
#get_custom_detection_rule(params = {}) ⇒ Types::GetCustomDetectionRuleResponse
Returns details for a custom detection rule in GuardDuty, including its detection logic.
-
#get_custom_detection_rule_association(params = {}) ⇒ Types::GetCustomDetectionRuleAssociationResponse
Returns details for a custom detection rule association.
-
#get_custom_detection_rule_org_configuration(params = {}) ⇒ Types::GetCustomDetectionRuleOrgConfigurationResponse
Returns the organization-level configuration for a custom detection rule.
-
#get_detector(params = {}) ⇒ Types::GetDetectorResponse
Retrieves a GuardDuty detector specified by the detectorId.
-
#get_filter(params = {}) ⇒ Types::GetFilterResponse
Returns the details of the filter specified by the filter name.
-
#get_findings(params = {}) ⇒ Types::GetFindingsResponse
Describes Amazon GuardDuty findings specified by finding IDs.
-
#get_findings_statistics(params = {}) ⇒ Types::GetFindingsStatisticsResponse
Lists GuardDuty findings statistics for the specified detector ID.
-
#get_investigation(params = {}) ⇒ Types::GetInvestigationResponse
This API is currently available as a preview.
-
#get_invitations_count(params = {}) ⇒ Types::GetInvitationsCountResponse
Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
-
#get_ip_set(params = {}) ⇒ Types::GetIPSetResponse
Retrieves the IPSet specified by the
ipSetId. -
#get_malware_protection_plan(params = {}) ⇒ Types::GetMalwareProtectionPlanResponse
Retrieves the Malware Protection plan details associated with a Malware Protection plan ID.
-
#get_malware_scan(params = {}) ⇒ Types::GetMalwareScanResponse
Retrieves the detailed information for a specific malware scan.
-
#get_malware_scan_settings(params = {}) ⇒ Types::GetMalwareScanSettingsResponse
Returns the details of the malware scan settings.
-
#get_master_account(params = {}) ⇒ Types::GetMasterAccountResponse
Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.
-
#get_member_detectors(params = {}) ⇒ Types::GetMemberDetectorsResponse
Describes which data sources are enabled for the member account's detector.
-
#get_members(params = {}) ⇒ Types::GetMembersResponse
Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.
-
#get_organization_statistics(params = {}) ⇒ Types::GetOrganizationStatisticsResponse
Retrieves how many active member accounts have each feature enabled within GuardDuty.
-
#get_remaining_free_trial_days(params = {}) ⇒ Types::GetRemainingFreeTrialDaysResponse
Provides the number of days left for each data source used in the free trial period.
-
#get_threat_entity_set(params = {}) ⇒ Types::GetThreatEntitySetResponse
Retrieves the threat entity set associated with the specified
threatEntitySetId. -
#get_threat_intel_set(params = {}) ⇒ Types::GetThreatIntelSetResponse
Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
-
#get_trusted_entity_set(params = {}) ⇒ Types::GetTrustedEntitySetResponse
Retrieves the trusted entity set associated with the specified
trustedEntitySetId. -
#get_usage_statistics(params = {}) ⇒ Types::GetUsageStatisticsResponse
Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID.
-
#invite_members(params = {}) ⇒ Types::InviteMembersResponse
Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API.
-
#list_coverage(params = {}) ⇒ Types::ListCoverageResponse
Lists coverage details for your GuardDuty account.
-
#list_custom_detection_rule_associations(params = {}) ⇒ Types::ListCustomDetectionRuleAssociationsResponse
Returns all custom detection rule associations for your account.
-
#list_custom_detection_rule_org_configurations(params = {}) ⇒ Types::ListCustomDetectionRuleOrgConfigurationsResponse
Returns all organization-level configurations for custom detection rules.
-
#list_custom_detection_rules(params = {}) ⇒ Types::ListCustomDetectionRulesResponse
Returns all available custom detection rules in GuardDuty.
-
#list_detectors(params = {}) ⇒ Types::ListDetectorsResponse
Lists detectorIds of all the existing Amazon GuardDuty detector resources.
-
#list_filters(params = {}) ⇒ Types::ListFiltersResponse
Returns a paginated list of the current filters.
-
#list_findings(params = {}) ⇒ Types::ListFindingsResponse
Lists GuardDuty findings for the specified detector ID.
-
#list_investigation_records(params = {}) ⇒ Types::ListInvestigationRecordsResponse
This API is currently available as a preview.
-
#list_investigations(params = {}) ⇒ Types::ListInvestigationsResponse
This API is currently available as a preview.
-
#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse
Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services account.
-
#list_ip_sets(params = {}) ⇒ Types::ListIPSetsResponse
Lists the IPSets of the GuardDuty service specified by the detector ID.
-
#list_malware_protection_plans(params = {}) ⇒ Types::ListMalwareProtectionPlansResponse
Lists the Malware Protection plan IDs associated with the protected resources in your Amazon Web Services account.
-
#list_malware_scans(params = {}) ⇒ Types::ListMalwareScansResponse
Returns a list of malware scans.
-
#list_members(params = {}) ⇒ Types::ListMembersResponse
Lists details about all member accounts for the current GuardDuty administrator account.
-
#list_organization_admin_accounts(params = {}) ⇒ Types::ListOrganizationAdminAccountsResponse
Lists the accounts designated as GuardDuty delegated administrators.
-
#list_publishing_destinations(params = {}) ⇒ Types::ListPublishingDestinationsResponse
Returns a list of publishing destinations associated with the specified
detectorId. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for a resource.
-
#list_threat_entity_sets(params = {}) ⇒ Types::ListThreatEntitySetsResponse
Lists the threat entity sets associated with the specified GuardDuty detector ID.
-
#list_threat_intel_sets(params = {}) ⇒ Types::ListThreatIntelSetsResponse
Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID.
-
#list_trusted_entity_sets(params = {}) ⇒ Types::ListTrustedEntitySetsResponse
Lists the trusted entity sets associated with the specified GuardDuty detector ID.
-
#send_object_malware_scan(params = {}) ⇒ Struct
Initiates a malware scan for a specific S3 object.
-
#start_malware_scan(params = {}) ⇒ Types::StartMalwareScanResponse
Initiates the malware scan.
-
#start_monitoring_members(params = {}) ⇒ Types::StartMonitoringMembersResponse
Turns on GuardDuty monitoring of the specified member accounts.
-
#stop_monitoring_members(params = {}) ⇒ Types::StopMonitoringMembersResponse
Stops GuardDuty monitoring for the specified member accounts.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
-
#unarchive_findings(params = {}) ⇒ Struct
Unarchives GuardDuty findings specified by the
findingIds. -
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_custom_detection_rule_association(params = {}) ⇒ Struct
Updates the mode of an existing custom detection rule association.
-
#update_custom_detection_rule_org_configuration(params = {}) ⇒ Struct
Updates the organization-level configuration for a custom detection rule, including the mode and include/exclude account lists.
-
#update_detector(params = {}) ⇒ Struct
Updates the GuardDuty detector specified by the detector ID.
-
#update_filter(params = {}) ⇒ Types::UpdateFilterResponse
Updates the filter specified by the filter name.
-
#update_findings_feedback(params = {}) ⇒ Struct
Marks the specified GuardDuty findings as useful or not useful.
-
#update_ip_set(params = {}) ⇒ Struct
Updates the IPSet specified by the IPSet ID.
-
#update_malware_protection_plan(params = {}) ⇒ Struct
Updates an existing Malware Protection plan resource.
-
#update_malware_scan_settings(params = {}) ⇒ Struct
Updates the malware scan settings.
-
#update_member_detectors(params = {}) ⇒ Types::UpdateMemberDetectorsResponse
Contains information on member accounts to be updated.
-
#update_organization_configuration(params = {}) ⇒ Struct
Configures the delegated administrator account with the provided values.
-
#update_publishing_destination(params = {}) ⇒ Struct
Updates information about the publishing destination specified by the
destinationId. -
#update_threat_entity_set(params = {}) ⇒ Struct
Updates the threat entity set associated with the specified
threatEntitySetId. -
#update_threat_intel_set(params = {}) ⇒ Struct
Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
-
#update_trusted_entity_set(params = {}) ⇒ Struct
Updates the trusted entity set associated with the specified
trustedEntitySetId.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
479 480 481 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#accept_administrator_invitation(params = {}) ⇒ Struct
Accepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation.
513 514 515 516 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 513 def accept_administrator_invitation(params = {}, = {}) req = build_request(:accept_administrator_invitation, params) req.send_request() end |
#accept_invitation(params = {}) ⇒ Struct
Accepts the invitation to be monitored by a GuardDuty administrator account.
553 554 555 556 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 553 def accept_invitation(params = {}, = {}) req = build_request(:accept_invitation, params) req.send_request() end |
#archive_findings(params = {}) ⇒ Struct
Archives GuardDuty findings that are specified by the list of finding IDs.
593 594 595 596 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 593 def archive_findings(params = {}, = {}) req = build_request(:archive_findings, params) req.send_request() end |
#create_custom_detection_rule_association(params = {}) ⇒ Types::CreateCustomDetectionRuleAssociationResponse
Enables a custom detection rule for your account by creating an association. You specify the rule and the mode in which it operates.
648 649 650 651 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 648 def create_custom_detection_rule_association(params = {}, = {}) req = build_request(:create_custom_detection_rule_association, params) req.send_request() end |
#create_custom_detection_rule_org_configuration(params = {}) ⇒ Struct
Creates an organization-level configuration that enables a custom detection rule across your organization. This operation is available only to the delegated administrator account.
695 696 697 698 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 695 def create_custom_detection_rule_org_configuration(params = {}, = {}) req = build_request(:create_custom_detection_rule_org_configuration, params) req.send_request() end |
#create_detector(params = {}) ⇒ Types::CreateDetectorResponse
Creates a single GuardDuty detector. A detector is a resource 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.
When you don't specify any
features, with an exception toRUNTIME_MONITORING, all the optional features are enabled by default.When you specify some of the
features, any feature that is not specified in the API call gets enabled by default, with an exception toRUNTIME_MONITORING.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and
Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can
add only one of these two features because Runtime Monitoring already
includes the threat detection for Amazon EKS resources. For more
information, see Runtime Monitoring.
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.
814 815 816 817 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 814 def create_detector(params = {}, = {}) req = build_request(:create_detector, params) req.send_request() end |
#create_filter(params = {}) ⇒ Types::CreateFilterResponse
Creates a filter using the specified finding criteria. The maximum number of saved filters per Amazon Web Services account per Region is 100. For more information, see Quotas for GuardDuty.
2236 2237 2238 2239 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2236 def create_filter(params = {}, = {}) req = build_request(:create_filter, params) req.send_request() end |
#create_investigation(params = {}) ⇒ Types::CreateInvestigationResponse
This API is currently available as a preview. During the preview, you can initiate up to 10 investigations per account per day, with a total limit of 100 investigations per account. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).
Initiates a GuardDuty investigation that automatically analyzes security findings, correlates related activity, performs account-level analysis, and produces a structured investigation summary with recommended next steps.
Only the administrator account can create an investigation. Member accounts don't have permission to create investigations from their accounts.
To use this operation, the AI_ANALYST feature must be enabled on
your detector.
This feature uses Amazon Bedrock models that leverage Cross-Region Inference (CRIS), which automatically selects the optimal Amazon Web Services Region within your geography to process the investigation analysis and generate the investigation report. This maximizes available compute resources, model availability, and delivers the best customer experience. Your data remains stored only in the Region where the investigation request originates, however, investigation data and summary results may be processed outside that Region. All data is transmitted encrypted across Amazon's secure network. For more information, see GuardDuty Investigation.
2402 2403 2404 2405 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2402 def create_investigation(params = {}, = {}) req = build_request(:create_investigation, params) req.send_request() end |
#create_ip_set(params = {}) ⇒ Types::CreateIPSetResponse
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 Amazon Web Services infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the administrator account can use this operation.
2315 2316 2317 2318 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2315 def create_ip_set(params = {}, = {}) req = build_request(:create_ip_set, params) req.send_request() end |
#create_malware_protection_plan(params = {}) ⇒ Types::CreateMalwareProtectionPlanResponse
Creates a new Malware Protection plan for the protected resource.
When you create a Malware Protection plan, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.
2473 2474 2475 2476 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2473 def create_malware_protection_plan(params = {}, = {}) req = build_request(:create_malware_protection_plan, params) req.send_request() end |
#create_members(params = {}) ⇒ Types::CreateMembersResponse
Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs. This step is a prerequisite for managing the associated member accounts either by invitation or through an organization.
As a delegated administrator, using CreateMembers will enable
GuardDuty in the added member accounts, with the exception of the
organization delegated administrator account. A delegated
administrator must enable GuardDuty prior to being added as a member.
When you use CreateMembers as an Organizations delegated administrator, GuardDuty applies your organization's auto-enable settings to the member accounts in this request, irrespective of the accounts being new or existing members. For more information about the existing auto-enable settings for your organization, see DescribeOrganizationConfiguration.
If you disassociate a member account that was added by invitation, the member account details obtained from this API, including the associated email addresses, will be retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
When the member accounts added through Organizations are later disassociated, you (administrator) can't invite them by calling the InviteMembers API. You can create an association with these member accounts again only by calling the CreateMembers API.
2555 2556 2557 2558 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2555 def create_members(params = {}, = {}) req = build_request(:create_members, params) req.send_request() end |
#create_publishing_destination(params = {}) ⇒ Types::CreatePublishingDestinationResponse
Creates a publishing destination where you can export your GuardDuty findings. Before you start exporting the findings, the destination resource must exist.
2620 2621 2622 2623 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2620 def create_publishing_destination(params = {}, = {}) req = build_request(:create_publishing_destination, params) req.send_request() end |
#create_sample_findings(params = {}) ⇒ Struct
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.
2655 2656 2657 2658 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2655 def create_sample_findings(params = {}, = {}) req = build_request(:create_sample_findings, params) req.send_request() end |
#create_threat_entity_set(params = {}) ⇒ Types::CreateThreatEntitySetResponse
Creates a new threat entity set. In a threat entity set, you can provide known malicious threat entities for your Amazon Web Services environment. GuardDuty generates findings based on the entries in the threat entity sets. Only users of the administrator account can manage entity sets, which automatically apply to member accounts.
2743 2744 2745 2746 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2743 def create_threat_entity_set(params = {}, = {}) req = build_request(:create_threat_entity_set, params) req.send_request() end |
#create_threat_intel_set(params = {}) ⇒ Types::CreateThreatIntelSetResponse
Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator account can use this operation.
2819 2820 2821 2822 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2819 def create_threat_intel_set(params = {}, = {}) req = build_request(:create_threat_intel_set, params) req.send_request() end |
#create_trusted_entity_set(params = {}) ⇒ Types::CreateTrustedEntitySetResponse
Creates a new trusted entity set. In the trusted entity set, you can provide IP addresses and domains that you believe are secure for communication in your Amazon Web Services environment. GuardDuty will not generate findings for the entries that are specified in a trusted entity set. At any given time, you can have only one trusted entity set.
Only users of the administrator account can manage the entity sets, which automatically apply to member accounts.
2911 2912 2913 2914 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2911 def create_trusted_entity_set(params = {}, = {}) req = build_request(:create_trusted_entity_set, params) req.send_request() end |
#decline_invitations(params = {}) ⇒ Types::DeclineInvitationsResponse
Declines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
2944 2945 2946 2947 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2944 def decline_invitations(params = {}, = {}) req = build_request(:decline_invitations, params) req.send_request() end |
#delete_custom_detection_rule_association(params = {}) ⇒ Struct
Disables a custom detection rule by deleting its association. This operation is idempotent.
2971 2972 2973 2974 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2971 def delete_custom_detection_rule_association(params = {}, = {}) req = build_request(:delete_custom_detection_rule_association, params) req.send_request() end |
#delete_custom_detection_rule_org_configuration(params = {}) ⇒ Struct
Deletes the organization-level configuration for a custom detection rule. This operation is available only to the delegated administrator account.
3000 3001 3002 3003 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3000 def delete_custom_detection_rule_org_configuration(params = {}, = {}) req = build_request(:delete_custom_detection_rule_org_configuration, params) req.send_request() end |
#delete_detector(params = {}) ⇒ Struct
Deletes an Amazon GuardDuty detector that is specified by the detector ID.
3030 3031 3032 3033 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3030 def delete_detector(params = {}, = {}) req = build_request(:delete_detector, params) req.send_request() end |
#delete_filter(params = {}) ⇒ Struct
Deletes the filter specified by the filter name.
3063 3064 3065 3066 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3063 def delete_filter(params = {}, = {}) req = build_request(:delete_filter, params) req.send_request() end |
#delete_invitations(params = {}) ⇒ Types::DeleteInvitationsResponse
Deletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
3130 3131 3132 3133 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3130 def delete_invitations(params = {}, = {}) req = build_request(:delete_invitations, params) req.send_request() end |
#delete_ip_set(params = {}) ⇒ Struct
Deletes the IPSet specified by the ipSetId. IPSets are called
trusted IP lists in the console user interface.
3097 3098 3099 3100 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3097 def delete_ip_set(params = {}, = {}) req = build_request(:delete_ip_set, params) req.send_request() end |
#delete_malware_protection_plan(params = {}) ⇒ Struct
Deletes the Malware Protection plan ID associated with the Malware Protection plan resource. Use this API only when you no longer want to protect the resource associated with this Malware Protection plan ID.
3154 3155 3156 3157 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3154 def delete_malware_protection_plan(params = {}, = {}) req = build_request(:delete_malware_protection_plan, params) req.send_request() end |
#delete_members(params = {}) ⇒ Types::DeleteMembersResponse
Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
With autoEnableOrganizationMembers configuration for your
organization set to ALL, you'll receive an error if you attempt to
disable GuardDuty for a member account in your organization.
3202 3203 3204 3205 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3202 def delete_members(params = {}, = {}) req = build_request(:delete_members, params) req.send_request() end |
#delete_publishing_destination(params = {}) ⇒ Struct
Deletes the publishing definition with the specified destinationId.
3236 3237 3238 3239 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3236 def delete_publishing_destination(params = {}, = {}) req = build_request(:delete_publishing_destination, params) req.send_request() end |
#delete_threat_entity_set(params = {}) ⇒ Struct
Deletes the threat entity set that is associated with the specified
threatEntitySetId.
3272 3273 3274 3275 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3272 def delete_threat_entity_set(params = {}, = {}) req = build_request(:delete_threat_entity_set, params) req.send_request() end |
#delete_threat_intel_set(params = {}) ⇒ Struct
Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
3306 3307 3308 3309 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3306 def delete_threat_intel_set(params = {}, = {}) req = build_request(:delete_threat_intel_set, params) req.send_request() end |
#delete_trusted_entity_set(params = {}) ⇒ Struct
Deletes the trusted entity set that is associated with the specified
trustedEntitySetId.
3342 3343 3344 3345 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3342 def delete_trusted_entity_set(params = {}, = {}) req = build_request(:delete_trusted_entity_set, params) req.send_request() end |
#describe_malware_scans(params = {}) ⇒ Types::DescribeMalwareScansResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3458 3459 3460 3461 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3458 def describe_malware_scans(params = {}, = {}) req = build_request(:describe_malware_scans, params) req.send_request() end |
#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3536 3537 3538 3539 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3536 def describe_organization_configuration(params = {}, = {}) req = build_request(:describe_organization_configuration, params) req.send_request() end |
#describe_publishing_destination(params = {}) ⇒ Types::DescribePublishingDestinationResponse
Returns information about the publishing destination specified by the
provided destinationId.
3590 3591 3592 3593 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3590 def describe_publishing_destination(params = {}, = {}) req = build_request(:describe_publishing_destination, params) req.send_request() end |
#disable_organization_admin_account(params = {}) ⇒ Struct
Removes the existing GuardDuty delegated administrator of the organization. Only the organization's management account can run this API operation.
3615 3616 3617 3618 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3615 def disable_organization_admin_account(params = {}, = {}) req = build_request(:disable_organization_admin_account, params) req.send_request() end |
#disassociate_from_administrator_account(params = {}) ⇒ Struct
Disassociates the current GuardDuty member account from its administrator account.
When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
With autoEnableOrganizationMembers configuration for your
organization set to ALL, you'll receive an error if you attempt to
disable GuardDuty in a member account.
3657 3658 3659 3660 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3657 def disassociate_from_administrator_account(params = {}, = {}) req = build_request(:disassociate_from_administrator_account, params) req.send_request() end |
#disassociate_from_master_account(params = {}) ⇒ Struct
Disassociates the current GuardDuty member account from its administrator account.
When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
3695 3696 3697 3698 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3695 def disassociate_from_master_account(params = {}, = {}) req = build_request(:disassociate_from_master_account, params) req.send_request() end |
#disassociate_members(params = {}) ⇒ Types::DisassociateMembersResponse
Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs.
When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
With autoEnableOrganizationMembers configuration for your
organization set to ALL, you'll receive an error if you attempt to
disassociate a member account before removing them from your
organization.
If you disassociate a member account that was added by invitation, the member account details obtained from this API, including the associated email addresses, will be retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
When the member accounts added through Organizations are later disassociated, you (administrator) can't invite them by calling the InviteMembers API. You can create an association with these member accounts again only by calling the CreateMembers API.
3765 3766 3767 3768 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3765 def disassociate_members(params = {}, = {}) req = build_request(:disassociate_members, params) req.send_request() end |
#enable_organization_admin_account(params = {}) ⇒ Struct
Designates an Amazon Web Services account within the organization as your GuardDuty delegated administrator. Only the organization's management account can run this API operation.
3790 3791 3792 3793 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3790 def enable_organization_admin_account(params = {}, = {}) req = build_request(:enable_organization_admin_account, params) req.send_request() end |
#get_administrator_account(params = {}) ⇒ Types::GetAdministratorAccountResponse
Provides the details of the GuardDuty administrator account associated with the current GuardDuty member account.
Based on the type of account that runs this API, the following list shows how the API behavior varies:
When the GuardDuty administrator account runs this API, it will return success (
HTTP 200) but no content.When a member account runs this API, it will return the details of the GuardDuty administrator account that is associated with this calling member account.
When an individual account (not associated with an organization) runs this API, it will return success (
HTTP 200) but no content.
3835 3836 3837 3838 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3835 def get_administrator_account(params = {}, = {}) req = build_request(:get_administrator_account, params) req.send_request() end |
#get_coverage_statistics(params = {}) ⇒ Types::GetCoverageStatisticsResponse
Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you can retrieve the statistics for all the 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.
3895 3896 3897 3898 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3895 def get_coverage_statistics(params = {}, = {}) req = build_request(:get_coverage_statistics, params) req.send_request() end |
#get_custom_detection_rule(params = {}) ⇒ Types::GetCustomDetectionRuleResponse
Returns details for a custom detection rule in GuardDuty, including its detection logic.
3940 3941 3942 3943 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3940 def get_custom_detection_rule(params = {}, = {}) req = build_request(:get_custom_detection_rule, params) req.send_request() end |
#get_custom_detection_rule_association(params = {}) ⇒ Types::GetCustomDetectionRuleAssociationResponse
Returns details for a custom detection rule association.
3982 3983 3984 3985 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3982 def get_custom_detection_rule_association(params = {}, = {}) req = build_request(:get_custom_detection_rule_association, params) req.send_request() end |
#get_custom_detection_rule_org_configuration(params = {}) ⇒ Types::GetCustomDetectionRuleOrgConfigurationResponse
Returns the organization-level configuration for a custom detection rule.
4026 4027 4028 4029 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4026 def get_custom_detection_rule_org_configuration(params = {}, = {}) req = build_request(:get_custom_detection_rule_org_configuration, params) req.send_request() end |
#get_detector(params = {}) ⇒ Types::GetDetectorResponse
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.
4101 4102 4103 4104 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4101 def get_detector(params = {}, = {}) req = build_request(:get_detector, params) req.send_request() end |
#get_filter(params = {}) ⇒ Types::GetFilterResponse
Returns the details of the filter specified by the filter name.
4177 4178 4179 4180 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4177 def get_filter(params = {}, = {}) req = build_request(:get_filter, params) req.send_request() end |
#get_findings(params = {}) ⇒ Types::GetFindingsResponse
Describes Amazon GuardDuty findings specified by finding IDs.
4912 4913 4914 4915 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4912 def get_findings(params = {}, = {}) req = build_request(:get_findings, params) req.send_request() end |
#get_findings_statistics(params = {}) ⇒ Types::GetFindingsStatisticsResponse
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.
5031 5032 5033 5034 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5031 def get_findings_statistics(params = {}, = {}) req = build_request(:get_findings_statistics, params) req.send_request() end |
#get_investigation(params = {}) ⇒ Types::GetInvestigationResponse
This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).
Retrieves the results and status of a specific GuardDuty investigation.
GuardDuty returns the results, including the summary and the scope of
the investigation, only when the investigation status is COMPLETED.
By default, GuardDuty returns the summary as text in Summary. To
return a typed summary in SummaryData instead, set SummaryFormat
to STRUCTURED.
An administrator account can retrieve any investigation within the organization. Member accounts can only retrieve investigations that belong to them.
5261 5262 5263 5264 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5261 def get_investigation(params = {}, = {}) req = build_request(:get_investigation, params) req.send_request() end |
#get_invitations_count(params = {}) ⇒ Types::GetInvitationsCountResponse
Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
5282 5283 5284 5285 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5282 def get_invitations_count(params = {}, = {}) req = build_request(:get_invitations_count, params) req.send_request() end |
#get_ip_set(params = {}) ⇒ Types::GetIPSetResponse
Retrieves the IPSet specified by the ipSetId.
5081 5082 5083 5084 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5081 def get_ip_set(params = {}, = {}) req = build_request(:get_ip_set, params) req.send_request() end |
#get_malware_protection_plan(params = {}) ⇒ Types::GetMalwareProtectionPlanResponse
Retrieves the Malware Protection plan details associated with a Malware Protection plan ID.
5330 5331 5332 5333 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5330 def get_malware_protection_plan(params = {}, = {}) req = build_request(:get_malware_protection_plan, params) req.send_request() end |
#get_malware_scan(params = {}) ⇒ Types::GetMalwareScanResponse
Retrieves the detailed information for a specific malware scan. Each member account can view the malware scan details for their own account. An administrator can view malware scan details for all accounts in the organization.
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.
5440 5441 5442 5443 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5440 def get_malware_scan(params = {}, = {}) req = build_request(:get_malware_scan, params) req.send_request() end |
#get_malware_scan_settings(params = {}) ⇒ Types::GetMalwareScanSettingsResponse
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.
5493 5494 5495 5496 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5493 def get_malware_scan_settings(params = {}, = {}) req = build_request(:get_malware_scan_settings, params) req.send_request() end |
#get_master_account(params = {}) ⇒ Types::GetMasterAccountResponse
Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.
5532 5533 5534 5535 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5532 def get_master_account(params = {}, = {}) req = build_request(:get_master_account, params) req.send_request() end |
#get_member_detectors(params = {}) ⇒ Types::GetMemberDetectorsResponse
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.
5604 5605 5606 5607 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5604 def get_member_detectors(params = {}, = {}) req = build_request(:get_member_detectors, params) req.send_request() end |
#get_members(params = {}) ⇒ Types::GetMembersResponse
Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.
5658 5659 5660 5661 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5658 def get_members(params = {}, = {}) req = build_request(:get_members, params) req.send_request() end |
#get_organization_statistics(params = {}) ⇒ Types::GetOrganizationStatisticsResponse
Retrieves how many active member accounts have each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API.
When you create a new organization, it might take up to 24 hours to generate the statistics for the entire organization.
5692 5693 5694 5695 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5692 def get_organization_statistics(params = {}, = {}) req = build_request(:get_organization_statistics, params) req.send_request() end |
#get_remaining_free_trial_days(params = {}) ⇒ Types::GetRemainingFreeTrialDaysResponse
Provides the number of days left for each data source used in the free trial period.
5746 5747 5748 5749 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5746 def get_remaining_free_trial_days(params = {}, = {}) req = build_request(:get_remaining_free_trial_days, params) req.send_request() end |
#get_threat_entity_set(params = {}) ⇒ Types::GetThreatEntitySetResponse
Retrieves the threat entity set associated with the specified
threatEntitySetId.
5804 5805 5806 5807 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5804 def get_threat_entity_set(params = {}, = {}) req = build_request(:get_threat_entity_set, params) req.send_request() end |
#get_threat_intel_set(params = {}) ⇒ Types::GetThreatIntelSetResponse
Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
5856 5857 5858 5859 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5856 def get_threat_intel_set(params = {}, = {}) req = build_request(:get_threat_intel_set, params) req.send_request() end |
#get_trusted_entity_set(params = {}) ⇒ Types::GetTrustedEntitySetResponse
Retrieves the trusted entity set associated with the specified
trustedEntitySetId.
5907 5908 5909 5910 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 5907 def get_trusted_entity_set(params = {}, = {}) req = build_request(:get_trusted_entity_set, params) req.send_request() end |
#get_usage_statistics(params = {}) ⇒ Types::GetUsageStatisticsResponse
Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID. For newly enabled detectors or data sources, the cost returned will include only the usage so far under 30 days. This may differ from the cost metrics in the console, which project usage over 30 days to provide a monthly cost estimate. For more information, see Understanding How Usage Costs are Calculated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6011 6012 6013 6014 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 6011 def get_usage_statistics(params = {}, = {}) req = build_request(:get_usage_statistics, params) req.send_request() end |
#invite_members(params = {}) ⇒ Types::InviteMembersResponse
Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API. If you are using Amazon Web Services Organizations to manage your GuardDuty environment, this step is not needed. For more information, see Managing accounts with organizations.
To invite Amazon Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API to add accounts by invitation. The invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can choose to accept the invitation from only one Amazon Web Services account. For more information, see Managing GuardDuty accounts by invitation.
After the invite has been accepted and you choose to disassociate a member account (by using DisassociateMembers) from your account, the details of the member account obtained by invoking CreateMembers, including the associated email addresses, will be retained. This is done so that you can invoke InviteMembers without the need to invoke CreateMembers again. To remove the details associated with a member account, you must also invoke DeleteMembers.
If you disassociate a member account that was added by invitation, the member account details obtained from this API, including the associated email addresses, will be retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
When the member accounts added through Organizations are later disassociated, you (administrator) can't invite them by calling the InviteMembers API. You can create an association with these member accounts again only by calling the CreateMembers API.
6109 6110 6111 6112 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 6109 def invite_members(params = {}, = {}) req = build_request(:invite_members, params) req.send_request() end |
#list_coverage(params = {}) ⇒ Types::ListCoverageResponse
Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can retrieve all resources associated with the active member accounts in your organization.
Make sure the accounts have Runtime Monitoring enabled and GuardDuty agent running on their resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6211 6212 6213 6214 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 6211 def list_coverage(params = {}, = {}) req = build_request(:list_coverage, params) req.send_request() end |
#list_custom_detection_rule_associations(params = {}) ⇒ Types::ListCustomDetectionRuleAssociationsResponse
Returns all custom detection rule associations for your account. You can filter by rule ID and mode.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6266 6267 6268 6269 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 6266 def list_custom_detection_rule_associations(params = {}, = {}) req = build_request(:list_custom_detection_rule_associations, params) req.send_request() end |
#list_custom_detection_rule_org_configurations(params = {}) ⇒ Types::ListCustomDetectionRuleOrgConfigurationsResponse
Returns all organization-level configurations for custom detection rules. You can filter the results by status.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6316 6317 6318 6319 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 6316 def list_custom_detection_rule_org_configurations(params = {}, = {}) req = build_request(:list_custom_detection_rule_org_configurations, params) req.send_request() end |
#list_custom_detection_rules(params = {}) ⇒ Types::ListCustomDetectionRulesResponse
Returns all available custom detection rules in GuardDuty. You can filter the results by data source, severity, tactic, technique, and service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6380 6381 6382 6383 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 6380 def list_custom_detection_rules(params = {}, = {}) req = build_request(:list_custom_detection_rules, params) req.send_request() end |
#list_detectors(params = {}) ⇒ Types::ListDetectorsResponse
Lists detectorIds of all the existing Amazon GuardDuty detector resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6424 6425 6426 6427 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 6424 def list_detectors(params = {}, = {}) req = build_request(:list_detectors, params) req.send_request() end |
#list_filters(params = {}) ⇒ Types::ListFiltersResponse
Returns a paginated list of the current filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6478 6479 6480 6481 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 6478 def list_filters(params = {}, = {}) req = build_request(:list_filters, params) req.send_request() end |
#list_findings(params = {}) ⇒ Types::ListFindingsResponse
Lists GuardDuty findings for the specified detector ID.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6679 6680 6681 6682 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 6679 def list_findings(params = {}, = {}) req = build_request(:list_findings, params) req.send_request() end |
#list_investigation_records(params = {}) ⇒ Types::ListInvestigationRecordsResponse
This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).
Returns the records for a specific GuardDuty investigation. Each record is one step in the reasoning that GuardDuty followed to reach the results of the investigation.
An administrator account can list the records of any investigation within the organization. Member accounts can only list the records of investigations that belong to them.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7171 7172 7173 7174 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7171 def list_investigation_records(params = {}, = {}) req = build_request(:list_investigation_records, params) req.send_request() end |
#list_investigations(params = {}) ⇒ Types::ListInvestigationsResponse
This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).
Returns a list of investigations associated with the specified GuardDuty detector. You can filter the investigations by status, risk level, confidence, finding ID, and investigation type, and sort them by start time, end time, status, risk level, or confidence.
An administrator account sees all investigations across the organization. Member accounts see only the investigations that belong to them.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7268 7269 7270 7271 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7268 def list_investigations(params = {}, = {}) req = build_request(:list_investigations, params) req.send_request() end |
#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse
Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7315 7316 7317 7318 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7315 def list_invitations(params = {}, = {}) req = build_request(:list_invitations, params) req.send_request() end |
#list_ip_sets(params = {}) ⇒ Types::ListIPSetsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6735 6736 6737 6738 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 6735 def list_ip_sets(params = {}, = {}) req = build_request(:list_ip_sets, params) req.send_request() end |
#list_malware_protection_plans(params = {}) ⇒ Types::ListMalwareProtectionPlansResponse
Lists the Malware Protection plan IDs associated with the protected resources in your Amazon Web Services account.
7351 7352 7353 7354 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7351 def list_malware_protection_plans(params = {}, = {}) req = build_request(:list_malware_protection_plans, params) req.send_request() end |
#list_malware_scans(params = {}) ⇒ Types::ListMalwareScansResponse
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 of its members' accounts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7425 7426 7427 7428 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7425 def list_malware_scans(params = {}, = {}) req = build_request(:list_malware_scans, params) req.send_request() end |
#list_members(params = {}) ⇒ Types::ListMembersResponse
Lists details about all member accounts for the current GuardDuty administrator account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7499 7500 7501 7502 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7499 def list_members(params = {}, = {}) req = build_request(:list_members, params) req.send_request() end |
#list_organization_admin_accounts(params = {}) ⇒ Types::ListOrganizationAdminAccountsResponse
Lists the accounts designated as GuardDuty delegated administrators. Only the organization's management account can run this API operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7543 7544 7545 7546 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7543 def list_organization_admin_accounts(params = {}, = {}) req = build_request(:list_organization_admin_accounts, params) req.send_request() end |
#list_publishing_destinations(params = {}) ⇒ Types::ListPublishingDestinationsResponse
Returns a list of publishing destinations associated with the
specified detectorId.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7599 7600 7601 7602 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7599 def list_publishing_destinations(params = {}, = {}) req = build_request(:list_publishing_destinations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.
7631 7632 7633 7634 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7631 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_threat_entity_sets(params = {}) ⇒ Types::ListThreatEntitySetsResponse
Lists the threat entity sets associated with the specified GuardDuty detector ID. If you use this operation from a member account, the threat entity sets that are returned as a response, belong to the administrator account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7688 7689 7690 7691 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7688 def list_threat_entity_sets(params = {}, = {}) req = build_request(:list_threat_entity_sets, params) req.send_request() end |
#list_threat_intel_sets(params = {}) ⇒ Types::ListThreatIntelSetsResponse
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 administrator account are returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7746 7747 7748 7749 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7746 def list_threat_intel_sets(params = {}, = {}) req = build_request(:list_threat_intel_sets, params) req.send_request() end |
#list_trusted_entity_sets(params = {}) ⇒ Types::ListTrustedEntitySetsResponse
Lists the trusted entity sets associated with the specified GuardDuty detector ID. If you use this operation from a member account, the trusted entity sets that are returned as a response, belong to the administrator account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7803 7804 7805 7806 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7803 def list_trusted_entity_sets(params = {}, = {}) req = build_request(:list_trusted_entity_sets, params) req.send_request() end |
#send_object_malware_scan(params = {}) ⇒ Struct
Initiates a malware scan for a specific S3 object. This API allows you to perform on-demand malware scanning of individual objects in S3 buckets that have Malware Protection for S3 enabled.
When you use this API, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.
7840 7841 7842 7843 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7840 def send_object_malware_scan(params = {}, = {}) req = build_request(:send_object_malware_scan, params) req.send_request() end |
#start_malware_scan(params = {}) ⇒ Types::StartMalwareScanResponse
Initiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account if the resourceArn belongs to an EC2 instance.
When the malware scan starts, you can use the associated scan ID to track the status of the scan. For more information, see ListMalwareScans and GetMalwareScan.
When you use this API, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.
7910 7911 7912 7913 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7910 def start_malware_scan(params = {}, = {}) req = build_request(:start_malware_scan, params) req.send_request() end |
#start_monitoring_members(params = {}) ⇒ Types::StartMonitoringMembersResponse
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.
7959 7960 7961 7962 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 7959 def start_monitoring_members(params = {}, = {}) req = build_request(:start_monitoring_members, params) req.send_request() end |
#stop_monitoring_members(params = {}) ⇒ Types::StopMonitoringMembersResponse
Stops GuardDuty monitoring for the specified member accounts. Use the
StartMonitoringMembers operation to restart monitoring for those
accounts.
With autoEnableOrganizationMembers configuration for your
organization set to ALL, you'll receive an error if you attempt to
stop monitoring the member accounts in your organization.
8007 8008 8009 8010 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 8007 def stop_monitoring_members(params = {}, = {}) req = build_request(:stop_monitoring_members, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
8036 8037 8038 8039 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 8036 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#unarchive_findings(params = {}) ⇒ Struct
Unarchives GuardDuty findings specified by the findingIds.
8069 8070 8071 8072 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 8069 def unarchive_findings(params = {}, = {}) req = build_request(:unarchive_findings, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
8095 8096 8097 8098 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 8095 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_custom_detection_rule_association(params = {}) ⇒ Struct
Updates the mode of an existing custom detection rule association.
8125 8126 8127 8128 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 8125 def update_custom_detection_rule_association(params = {}, = {}) req = build_request(:update_custom_detection_rule_association, params) req.send_request() end |
#update_custom_detection_rule_org_configuration(params = {}) ⇒ Struct
Updates the organization-level configuration for a custom detection rule, including the mode and include/exclude account lists.
8163 8164 8165 8166 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 8163 def update_custom_detection_rule_org_configuration(params = {}, = {}) req = build_request(:update_custom_detection_rule_org_configuration, params) req.send_request() end |
#update_detector(params = {}) ⇒ Struct
Updates the GuardDuty detector specified by the detector ID.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and
Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can
add only one of these two features because Runtime Monitoring already
includes the threat detection for Amazon EKS resources. For more
information, see Runtime Monitoring.
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.
8259 8260 8261 8262 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 8259 def update_detector(params = {}, = {}) req = build_request(:update_detector, params) req.send_request() end |
#update_filter(params = {}) ⇒ Types::UpdateFilterResponse
Updates the filter specified by the filter name.
9660 9661 9662 9663 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 9660 def update_filter(params = {}, = {}) req = build_request(:update_filter, params) req.send_request() end |
#update_findings_feedback(params = {}) ⇒ Struct
Marks the specified GuardDuty findings as useful or not useful.
9702 9703 9704 9705 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 9702 def update_findings_feedback(params = {}, = {}) req = build_request(:update_findings_feedback, params) req.send_request() end |
#update_ip_set(params = {}) ⇒ Struct
Updates the IPSet specified by the IPSet ID.
9754 9755 9756 9757 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 9754 def update_ip_set(params = {}, = {}) req = build_request(:update_ip_set, params) req.send_request() end |
#update_malware_protection_plan(params = {}) ⇒ Struct
Updates an existing Malware Protection plan resource.
9800 9801 9802 9803 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 9800 def update_malware_protection_plan(params = {}, = {}) req = build_request(:update_malware_protection_plan, params) req.send_request() end |
#update_malware_scan_settings(params = {}) ⇒ Struct
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.
9869 9870 9871 9872 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 9869 def update_malware_scan_settings(params = {}, = {}) req = build_request(:update_malware_scan_settings, params) req.send_request() end |
#update_member_detectors(params = {}) ⇒ Types::UpdateMemberDetectorsResponse
Contains information on member accounts to be updated.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and
Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can
add only one of these two features because Runtime Monitoring already
includes the threat detection for Amazon EKS resources. For more
information, see Runtime Monitoring.
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.
9960 9961 9962 9963 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 9960 def update_member_detectors(params = {}, = {}) req = build_request(:update_member_detectors, params) req.send_request() end |
#update_organization_configuration(params = {}) ⇒ Struct
Configures the delegated administrator account with the provided
values. You must provide a value for either
autoEnableOrganizationMembers or autoEnable, but not both.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and
Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can
add only one of these two features because Runtime Monitoring already
includes the threat detection for Amazon EKS resources. For more
information, see Runtime Monitoring.
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.
10085 10086 10087 10088 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 10085 def update_organization_configuration(params = {}, = {}) req = build_request(:update_organization_configuration, params) req.send_request() end |
#update_publishing_destination(params = {}) ⇒ Struct
Updates information about the publishing destination specified by the
destinationId.
10129 10130 10131 10132 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 10129 def update_publishing_destination(params = {}, = {}) req = build_request(:update_publishing_destination, params) req.send_request() end |
#update_threat_entity_set(params = {}) ⇒ Struct
Updates the threat entity set associated with the specified
threatEntitySetId.
10188 10189 10190 10191 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 10188 def update_threat_entity_set(params = {}, = {}) req = build_request(:update_threat_entity_set, params) req.send_request() end |
#update_threat_intel_set(params = {}) ⇒ Struct
Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
10242 10243 10244 10245 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 10242 def update_threat_intel_set(params = {}, = {}) req = build_request(:update_threat_intel_set, params) req.send_request() end |
#update_trusted_entity_set(params = {}) ⇒ Struct
Updates the trusted entity set associated with the specified
trustedEntitySetId.
10301 10302 10303 10304 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 10301 def update_trusted_entity_set(params = {}, = {}) req = build_request(:update_trusted_entity_set, params) req.send_request() end |