View Source AWS.GuardDuty (aws-elixir v0.13.1)
Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail management event logs, CloudTrail S3 data event logs, EKS audit logs, and DNS logs.
It uses threat intelligence feeds (such as lists of malicious IPs and domains) and machine learning to identify unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances that serve malware or mine bitcoin.
GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise. Some examples of this are unauthorized infrastructure deployments such as EC2 instances deployed in a Region that has never been used, or unusual API calls like a password policy change to reduce password strength.
GuardDuty informs you of the status of your Amazon Web Services environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see the Amazon GuardDuty User Guide .
Link to this section Summary
Functions
Accepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation.
Accepts the invitation to be monitored by a GuardDuty administrator account.
Archives GuardDuty findings that are specified by the list of finding IDs.
Creates a single Amazon GuardDuty detector.
Creates a filter using the specified finding criteria.
Creates a new IPSet, which is called a trusted IP list in the console user interface.
Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs.
Creates a publishing destination to export findings to.
Generates example findings of types specified by the list of finding types.
Creates a new ThreatIntelSet.
Declines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
Deletes an Amazon GuardDuty detector that is specified by the detector ID.
Deletes the filter specified by the filter name.
Deletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
Deletes the IPSet specified by the ipSetId
.
Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
Deletes the publishing definition with the specified destinationId
.
Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
Returns a list of malware scans.
Returns information about the account selected as the delegated administrator for GuardDuty.
Returns information about the publishing destination specified by the provided
destinationId
.
Disables an Amazon Web Services account within the Organization as the GuardDuty delegated administrator.
Disassociates the current GuardDuty member account from its administrator account.
Disassociates the current GuardDuty member account from its administrator account.
Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
Enables an Amazon Web Services account within the organization as the GuardDuty delegated administrator.
Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.
Retrieves an Amazon GuardDuty detector specified by the detectorId.
Returns the details of the filter specified by the filter name.
Describes Amazon GuardDuty findings specified by finding IDs.
Lists Amazon GuardDuty findings statistics for the specified detector ID.
Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
Retrieves the IPSet specified by the ipSetId
.
Returns the details of the malware scan settings.
Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.
Describes which data sources are enabled for the member account's detector.
Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.
Provides the number of days left for each data source used in the free trial period.
Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID.
Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account.
Lists detectorIds of all the existing Amazon GuardDuty detector resources.
Returns a paginated list of the current filters.
Lists Amazon GuardDuty findings for the specified detector ID.
Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services account.
Lists the IPSets of the GuardDuty service specified by the detector ID.
Lists details about all member accounts for the current GuardDuty administrator account.
Lists the accounts configured as GuardDuty delegated administrators.
Returns a list of publishing destinations associated with the specified
detectorId
.
Lists tags for a resource.
Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID.
Turns on GuardDuty monitoring of the specified member accounts.
Stops GuardDuty monitoring for the specified member accounts.
Adds tags to a resource.
Unarchives GuardDuty findings specified by the findingIds
.
Removes tags from a resource.
Updates the Amazon GuardDuty detector specified by the detectorId.
Updates the filter specified by the filter name.
Marks the specified GuardDuty findings as useful or not useful.
Updates the IPSet specified by the IPSet ID.
Updates the malware scan settings.
Contains information on member accounts to be updated.
Updates the delegated administrator account with the values provided.
Updates information about the publishing destination specified by the
destinationId
.
Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
Link to this section Functions
accept_administrator_invitation(client, detector_id, input, options \\ [])
View SourceAccepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation.
Accepts the invitation to be monitored by a GuardDuty administrator account.
Archives GuardDuty findings that are specified by the list of finding IDs.
Only the administrator account can archive findings. Member accounts don't have permission to archive findings from their accounts.
Creates a single Amazon 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.
Creates a filter using the specified finding criteria.
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.
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.
When using Create Members
as an organizations delegated administrator this
action will enable GuardDuty in the added member accounts, with the exception of
the organization delegated administrator account, which must enable GuardDuty
prior to being added as a member.
If you are adding accounts by invitation use this action after GuardDuty has
been enabled in potential member accounts and before using Invite Members
.
create_publishing_destination(client, detector_id, input, options \\ [])
View SourceCreates a publishing destination to export findings to.
The resource to export findings to must exist before you use this operation.
Generates example findings of types specified by the list of finding types.
If 'NULL' is specified for findingTypes
, the API generates example findings of
all supported finding types.
create_threat_intel_set(client, detector_id, input, options \\ [])
View SourceCreates 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.
Declines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
Deletes an Amazon GuardDuty detector that is specified by the detector ID.
delete_filter(client, detector_id, filter_name, input, options \\ [])
View SourceDeletes the filter specified by the filter name.
Deletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
delete_ip_set(client, detector_id, ip_set_id, input, options \\ [])
View SourceDeletes the IPSet specified by the ipSetId
.
IPSets are called trusted IP lists in the console user interface.
Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
delete_publishing_destination(client, destination_id, detector_id, input, options \\ [])
View SourceDeletes the publishing definition with the specified destinationId
.
delete_threat_intel_set(client, detector_id, threat_intel_set_id, input, options \\ [])
View SourceDeletes the ThreatIntelSet specified by the ThreatIntelSet ID.
Returns a list of malware scans.
describe_organization_configuration(client, detector_id, options \\ [])
View SourceReturns information about the account selected as the delegated administrator for GuardDuty.
describe_publishing_destination(client, destination_id, detector_id, options \\ [])
View SourceReturns information about the publishing destination specified by the provided
destinationId
.
Disables an Amazon Web Services account within the Organization as the GuardDuty delegated administrator.
disassociate_from_administrator_account(client, detector_id, input, options \\ [])
View SourceDisassociates the current GuardDuty member account from its administrator account.
disassociate_from_master_account(client, detector_id, input, options \\ [])
View SourceDisassociates the current GuardDuty member account from its administrator account.
Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
Enables an Amazon Web Services account within the organization as the GuardDuty delegated administrator.
Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.
Retrieves an Amazon GuardDuty detector specified by the detectorId.
Returns the details of the filter specified by the filter name.
Describes Amazon GuardDuty findings specified by finding IDs.
get_findings_statistics(client, detector_id, input, options \\ [])
View SourceLists Amazon GuardDuty findings statistics for the specified detector ID.
Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
Retrieves the IPSet specified by the ipSetId
.
Returns the details of the malware scan settings.
Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.
Describes which data sources are enabled for the member account's detector.
Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.
get_remaining_free_trial_days(client, detector_id, input, options \\ [])
View SourceProvides the number of days left for each data source used in the free trial period.
get_threat_intel_set(client, detector_id, threat_intel_set_id, options \\ [])
View SourceRetrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
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.
Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account.
list_detectors(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists detectorIds of all the existing Amazon GuardDuty detector resources.
list_filters(client, detector_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a paginated list of the current filters.
Lists Amazon GuardDuty findings for the specified detector ID.
list_invitations(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all GuardDuty membership invitations that were sent to the current Amazon Web Services account.
list_ip_sets(client, detector_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists 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.
list_members( client, detector_id, max_results \\ nil, next_token \\ nil, only_associated \\ nil, options \\ [] )
View SourceLists details about all member accounts for the current GuardDuty administrator account.
list_organization_admin_accounts(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the accounts configured as GuardDuty delegated administrators.
list_publishing_destinations( client, detector_id, max_results \\ nil, next_token \\ nil, options \\ [] )
View SourceReturns a list of publishing destinations associated with the specified
detectorId
.
Lists tags for a resource.
Tagging is currently supported for detectors, finding filters, IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.
list_threat_intel_sets(client, detector_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists 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.
start_monitoring_members(client, detector_id, input, options \\ [])
View SourceTurns on GuardDuty monitoring of the specified member accounts.
Use this operation to restart monitoring of accounts that you stopped monitoring
with the StopMonitoringMembers
operation.
stop_monitoring_members(client, detector_id, input, options \\ [])
View SourceStops GuardDuty monitoring for the specified member accounts.
Use the StartMonitoringMembers
operation to restart monitoring for those
accounts.
Adds tags to a resource.
Unarchives GuardDuty findings specified by the findingIds
.
Removes tags from a resource.
Updates the Amazon GuardDuty detector specified by the detectorId.
update_filter(client, detector_id, filter_name, input, options \\ [])
View SourceUpdates the filter specified by the filter name.
update_findings_feedback(client, detector_id, input, options \\ [])
View SourceMarks the specified GuardDuty findings as useful or not useful.
update_ip_set(client, detector_id, ip_set_id, input, options \\ [])
View SourceUpdates the IPSet specified by the IPSet ID.
update_malware_scan_settings(client, detector_id, input, options \\ [])
View SourceUpdates the malware scan settings.
update_member_detectors(client, detector_id, input, options \\ [])
View SourceContains information on member accounts to be updated.
update_organization_configuration(client, detector_id, input, options \\ [])
View SourceUpdates the delegated administrator account with the values provided.
update_publishing_destination(client, destination_id, detector_id, input, options \\ [])
View SourceUpdates information about the publishing destination specified by the
destinationId
.
update_threat_intel_set(client, detector_id, threat_intel_set_id, input, options \\ [])
View SourceUpdates the ThreatIntelSet specified by the ThreatIntelSet ID.