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.
385 386 387 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 385 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.
419 420 421 422 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 419 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.
452 453 454 455 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 452 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.
485 486 487 488 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 485 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.
604 605 606 607 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 604 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.
912 913 914 915 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 912 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.
979 980 981 982 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 979 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.
1054 1055 1056 1057 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1054 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.
1104 1105 1106 1107 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1104 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.
1132 1133 1134 1135 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1132 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.
1196 1197 1198 1199 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1196 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.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1229 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.
1252 1253 1254 1255 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1252 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.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1278 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.
1338 1339 1340 1341 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1338 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.
1305 1306 1307 1308 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1305 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.
1379 1380 1381 1382 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1379 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
.
1406 1407 1408 1409 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1406 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.
1433 1434 1435 1436 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1433 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.
1541 1542 1543 1544 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1541 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.
1612 1613 1614 1615 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1612 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
.
1655 1656 1657 1658 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1655 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.
1680 1681 1682 1683 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1680 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.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1722 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.
1760 1761 1762 1763 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1760 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.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1830 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.
1855 1856 1857 1858 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1855 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.
1892 1893 1894 1895 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1892 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.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 1946 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.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2012 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.
2071 2072 2073 2074 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2071 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.
2572 2573 2574 2575 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2572 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.
2636 2637 2638 2639 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2636 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.
2698 2699 2700 2701 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2698 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
.
2677 2678 2679 2680 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2677 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.
2745 2746 2747 2748 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2745 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.
2777 2778 2779 2780 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2777 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.
2840 2841 2842 2843 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2840 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.
2887 2888 2889 2890 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2887 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.
2921 2922 2923 2924 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2921 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.
2968 2969 2970 2971 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 2968 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.
3011 3012 3013 3014 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3011 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.
3108 3109 3110 3111 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3108 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.
3199 3200 3201 3202 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3199 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.
3294 3295 3296 3297 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3294 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.
3338 3339 3340 3341 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3338 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.
3385 3386 3387 3388 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3385 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.
3575 3576 3577 3578 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3575 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.
3671 3672 3673 3674 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3671 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.
3624 3625 3626 3627 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3624 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.
3738 3739 3740 3741 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3738 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.
3782 3783 3784 3785 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3782 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.
3830 3831 3832 3833 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3830 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.
3862 3863 3864 3865 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3862 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.
3913 3914 3915 3916 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3913 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.
3952 3953 3954 3955 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3952 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.
3994 3995 3996 3997 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 3994 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.
4035 4036 4037 4038 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4035 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.
4064 4065 4066 4067 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4064 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
.
4090 4091 4092 4093 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4090 def unarchive_findings(params = {}, = {}) req = build_request(:unarchive_findings, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
4116 4117 4118 4119 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4116 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.
4205 4206 4207 4208 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4205 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.
4279 4280 4281 4282 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4279 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.
4314 4315 4316 4317 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4314 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.
4354 4355 4356 4357 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4354 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.
4416 4417 4418 4419 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4416 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.
4500 4501 4502 4503 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4500 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.
4616 4617 4618 4619 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4616 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
.
4652 4653 4654 4655 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4652 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.
4694 4695 4696 4697 |
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/client.rb', line 4694 def update_threat_intel_set(params = {}, = {}) req = build_request(:update_threat_intel_set, params) req.send_request() end |