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_detector(params = {}) ⇒ Types::CreateDetectorResponse
Creates a single GuardDuty detector.
-
#create_filter(params = {}) ⇒ Types::CreateFilterResponse
Creates a filter using the specified finding criteria.
-
#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_intel_set(params = {}) ⇒ Types::CreateThreatIntelSetResponse
Creates a new ThreatIntelSet.
-
#decline_invitations(params = {}) ⇒ Types::DeclineInvitationsResponse
Declines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
-
#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_intel_set(params = {}) ⇒ Struct
Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
-
#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_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_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_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_intel_set(params = {}) ⇒ Types::GetThreatIntelSetResponse
Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
-
#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_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_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_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_intel_sets(params = {}) ⇒ Types::ListThreatIntelSetsResponse
Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID.
-
#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_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_intel_set(params = {}) ⇒ Struct
Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
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.
444 445 446 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 444 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.
478 479 480 481 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 478 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.
518 519 520 521 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 518 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.
558 559 560 561 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 558 def archive_findings(params = {}, = {}) req = build_request(:archive_findings, 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.
677 678 679 680 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 677 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.
991 992 993 994 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 991 def create_filter(params = {}, = {}) req = build_request(:create_filter, 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.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1065 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.
1136 1137 1138 1139 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1136 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.
1218 1219 1220 1221 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1218 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.
1276 1277 1278 1279 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1276 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.
1311 1312 1313 1314 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1311 def create_sample_findings(params = {}, = {}) req = build_request(:create_sample_findings, 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.
1382 1383 1384 1385 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1382 def create_threat_intel_set(params = {}, = {}) req = build_request(:create_threat_intel_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.
1415 1416 1417 1418 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1415 def decline_invitations(params = {}, = {}) req = build_request(:decline_invitations, params) req.send_request() end |
#delete_detector(params = {}) ⇒ Struct
Deletes an Amazon GuardDuty detector that is specified by the detector ID.
1445 1446 1447 1448 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1445 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.
1478 1479 1480 1481 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1478 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.
1545 1546 1547 1548 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1545 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.
1512 1513 1514 1515 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1512 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.
1569 1570 1571 1572 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1569 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.
1617 1618 1619 1620 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1617 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
.
1651 1652 1653 1654 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1651 def delete_publishing_destination(params = {}, = {}) req = build_request(:delete_publishing_destination, params) req.send_request() end |
#delete_threat_intel_set(params = {}) ⇒ Struct
Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
1685 1686 1687 1688 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1685 def delete_threat_intel_set(params = {}, = {}) req = build_request(:delete_threat_intel_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.
1800 1801 1802 1803 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1800 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.
1878 1879 1880 1881 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1878 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
.
1928 1929 1930 1931 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1928 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.
1953 1954 1955 1956 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1953 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.
1995 1996 1997 1998 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1995 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.
2033 2034 2035 2036 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2033 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.
2103 2104 2105 2106 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2103 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.
2128 2129 2130 2131 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2128 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.
HTTP 200
) but no content.
2165 2166 2167 2168 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2165 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.
2225 2226 2227 2228 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2225 def get_coverage_statistics(params = {}, = {}) req = build_request(:get_coverage_statistics, 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.
2298 2299 2300 2301 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2298 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.
2364 2365 2366 2367 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2364 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.
3007 3008 3009 3010 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3007 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.
3124 3125 3126 3127 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3124 def get_findings_statistics(params = {}, = {}) req = build_request(:get_findings_statistics, 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.
3193 3194 3195 3196 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3193 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
.
3172 3173 3174 3175 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3172 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.
3241 3242 3243 3244 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3241 def get_malware_protection_plan(params = {}, = {}) req = build_request(:get_malware_protection_plan, 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.
3294 3295 3296 3297 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3294 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.
3333 3334 3335 3336 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3333 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.
3403 3404 3405 3406 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3403 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.
3457 3458 3459 3460 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3457 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.
3491 3492 3493 3494 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3491 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.
3545 3546 3547 3548 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3545 def get_remaining_free_trial_days(params = {}, = {}) req = build_request(:get_remaining_free_trial_days, params) req.send_request() end |
#get_threat_intel_set(params = {}) ⇒ Types::GetThreatIntelSetResponse
Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
3595 3596 3597 3598 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3595 def get_threat_intel_set(params = {}, = {}) req = build_request(:get_threat_intel_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.
3699 3700 3701 3702 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3699 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.
3797 3798 3799 3800 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3797 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.
3899 3900 3901 3902 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3899 def list_coverage(params = {}, = {}) req = build_request(:list_coverage, 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.
3943 3944 3945 3946 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3943 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.
3997 3998 3999 4000 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3997 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.
4196 4197 4198 4199 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4196 def list_findings(params = {}, = {}) req = build_request(:list_findings, 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.
4299 4300 4301 4302 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4299 def list_invitations(params = {}, = {}) req = build_request(:list_invitations, params) req.send_request() end |