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_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 to export findings to.
-
#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_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 an Amazon 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 Amazon 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_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_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_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.
410 411 412 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 410 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.
444 445 446 447 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 444 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.
477 478 479 480 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 477 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.
510 511 512 513 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 510 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.
629 630 631 632 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 629 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.
937 938 939 940 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 937 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.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1004 def create_ip_set(params = {}, = {}) req = build_request(:create_ip_set, 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.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1079 def create_members(params = {}, = {}) req = build_request(:create_members, params) req.send_request() end |
#create_publishing_destination(params = {}) ⇒ Types::CreatePublishingDestinationResponse
Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1129 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.
1157 1158 1159 1160 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1157 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.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1221 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.
1254 1255 1256 1257 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1254 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.
1277 1278 1279 1280 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1277 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.
1303 1304 1305 1306 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1303 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.
1363 1364 1365 1366 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1363 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.
1330 1331 1332 1333 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1330 def delete_ip_set(params = {}, = {}) req = build_request(:delete_ip_set, 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.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1404 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
.
1431 1432 1433 1434 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1431 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.
1458 1459 1460 1461 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1458 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.
1566 1567 1568 1569 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1566 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.
1637 1638 1639 1640 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1637 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
.
1680 1681 1682 1683 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1680 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.
1705 1706 1707 1708 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1705 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.
1747 1748 1749 1750 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1747 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.
1785 1786 1787 1788 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1785 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.
1855 1856 1857 1858 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1855 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.
1880 1881 1882 1883 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1880 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.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1917 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.
1971 1972 1973 1974 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1971 def get_coverage_statistics(params = {}, = {}) req = build_request(:get_coverage_statistics, params) req.send_request() end |
#get_detector(params = {}) ⇒ Types::GetDetectorResponse
Retrieves an Amazon GuardDuty detector specified by the detectorId.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
2037 2038 2039 2040 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2037 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.
2096 2097 2098 2099 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2096 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.
2597 2598 2599 2600 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2597 def get_findings(params = {}, = {}) req = build_request(:get_findings, params) req.send_request() end |
#get_findings_statistics(params = {}) ⇒ Types::GetFindingsStatisticsResponse
Lists Amazon GuardDuty findings statistics 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.
2661 2662 2663 2664 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2661 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.
2723 2724 2725 2726 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2723 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
.
2702 2703 2704 2705 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2702 def get_ip_set(params = {}, = {}) req = build_request(:get_ip_set, 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.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2770 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.
2802 2803 2804 2805 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2802 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.
2865 2866 2867 2868 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2865 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.
2912 2913 2914 2915 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2912 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.
2946 2947 2948 2949 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2946 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.
2993 2994 2995 2996 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2993 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.
3036 3037 3038 3039 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3036 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.
3133 3134 3135 3136 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3133 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.
3224 3225 3226 3227 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3224 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.
3319 3320 3321 3322 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3319 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.
3363 3364 3365 3366 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3363 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.
3410 3411 3412 3413 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3410 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.
3600 3601 3602 3603 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3600 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.
3696 3697 3698 3699 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3696 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.
3649 3650 3651 3652 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3649 def list_ip_sets(params = {}, = {}) req = build_request(:list_ip_sets, 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.
3763 3764 3765 3766 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3763 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.
3807 3808 3809 3810 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3807 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.
3855 3856 3857 3858 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3855 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.
3887 3888 3889 3890 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3887 def (params = {}, = {}) req = build_request(:list_tags_for_resource, 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.
3938 3939 3940 3941 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3938 def list_threat_intel_sets(params = {}, = {}) req = build_request(:list_threat_intel_sets, 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.
When the malware scan starts, you can use the associated scan ID to track the status of the scan. For more information, see DescribeMalwareScans.
3977 3978 3979 3980 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3977 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.
4019 4020 4021 4022 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4019 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.
4060 4061 4062 4063 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4060 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.
4089 4090 4091 4092 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4089 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
.
4115 4116 4117 4118 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4115 def unarchive_findings(params = {}, = {}) req = build_request(:unarchive_findings, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
4141 4142 4143 4144 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4141 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, 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.
4230 4231 4232 4233 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4230 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.
4304 4305 4306 4307 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4304 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.
4339 4340 4341 4342 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4339 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.
4379 4380 4381 4382 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4379 def update_ip_set(params = {}, = {}) req = build_request(:update_ip_set, 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.
4441 4442 4443 4444 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4441 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.
4525 4526 4527 4528 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4525 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.
4641 4642 4643 4644 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4641 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
.
4677 4678 4679 4680 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4677 def update_publishing_destination(params = {}, = {}) req = build_request(:update_publishing_destination, params) req.send_request() end |
#update_threat_intel_set(params = {}) ⇒ Struct
Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
4719 4720 4721 4722 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4719 def update_threat_intel_set(params = {}, = {}) req = build_request(:update_threat_intel_set, params) req.send_request() end |