Learn R Programming

paws.security.identity (version 0.1.12)

guardduty: Amazon GuardDuty

Description

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event 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 AWS 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 AWS 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 AWS 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 .

Usage

guardduty(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- guardduty(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

accept_invitationAccepts the invitation to be monitored by a GuardDuty administrator account
archive_findingsArchives GuardDuty findings that are specified by the list of finding IDs
create_detectorCreates a single Amazon GuardDuty detector
create_filterCreates a filter using the specified finding criteria
create_ip_setCreates a new IPSet, which is called a trusted IP list in the console user interface
create_membersCreates member accounts of the current AWS account by specifying a list of AWS account IDs
create_publishing_destinationCreates a publishing destination to export findings to
create_sample_findingsGenerates example findings of types specified by the list of finding types
create_threat_intel_setCreates a new ThreatIntelSet
decline_invitationsDeclines invitations sent to the current member account by AWS accounts specified by their account IDs
delete_detectorDeletes an Amazon GuardDuty detector that is specified by the detector ID
delete_filterDeletes the filter specified by the filter name
delete_invitationsDeletes invitations sent to the current member account by AWS accounts specified by their account IDs
delete_ip_setDeletes the IPSet specified by the ipSetId
delete_membersDeletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs
delete_publishing_destinationDeletes the publishing definition with the specified destinationId
delete_threat_intel_setDeletes the ThreatIntelSet specified by the ThreatIntelSet ID
describe_organization_configurationReturns information about the account selected as the delegated administrator for GuardDuty
describe_publishing_destinationReturns information about the publishing destination specified by the provided destinationId
disable_organization_admin_accountDisables an AWS account within the Organization as the GuardDuty delegated administrator
disassociate_from_master_accountDisassociates the current GuardDuty member account from its administrator account
disassociate_membersDisassociates GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs
enable_organization_admin_accountEnables an AWS account within the organization as the GuardDuty delegated administrator
get_detectorRetrieves an Amazon GuardDuty detector specified by the detectorId
get_filterReturns the details of the filter specified by the filter name
get_findingsDescribes Amazon GuardDuty findings specified by finding IDs
get_findings_statisticsLists Amazon GuardDuty findings statistics for the specified detector ID
get_invitations_countReturns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation
get_ip_setRetrieves the IPSet specified by the ipSetId
get_master_accountProvides the details for the GuardDuty administrator account associated with the current GuardDuty member account
get_member_detectorsDescribes which data sources are enabled for the member account's detector
get_membersRetrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs
get_threat_intel_setRetrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID
get_usage_statisticsLists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID
invite_membersInvites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty, and allow the current AWS account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account
list_detectorsLists detectorIds of all the existing Amazon GuardDuty detector resources
list_filtersReturns a paginated list of the current filters
list_findingsLists Amazon GuardDuty findings for the specified detector ID
list_invitationsLists all GuardDuty membership invitations that were sent to the current AWS account
list_ip_setsLists the IPSets of the GuardDuty service specified by the detector ID
list_membersLists details about all member accounts for the current GuardDuty administrator account
list_organization_admin_accountsLists the accounts configured as GuardDuty delegated administrators
list_publishing_destinationsReturns a list of publishing destinations associated with the specified dectectorId
list_tags_for_resourceLists tags for a resource
list_threat_intel_setsLists the ThreatIntelSets of the GuardDuty service specified by the detector ID
start_monitoring_membersTurns on GuardDuty monitoring of the specified member accounts
stop_monitoring_membersStops GuardDuty monitoring for the specified member accounts
tag_resourceAdds tags to a resource
unarchive_findingsUnarchives GuardDuty findings specified by the findingIds
untag_resourceRemoves tags from a resource
update_detectorUpdates the Amazon GuardDuty detector specified by the detectorId
update_filterUpdates the filter specified by the filter name
update_findings_feedbackMarks the specified GuardDuty findings as useful or not useful
update_ip_setUpdates the IPSet specified by the IPSet ID
update_member_detectorsContains information on member accounts to be updated
update_organization_configurationUpdates the delegated administrator account with the values provided
update_publishing_destinationUpdates information about the publishing destination specified by the destinationId
update_threat_intel_setUpdates the ThreatIntelSet specified by the ThreatIntelSet ID

Examples

Run this code
if (FALSE) {
svc <- guardduty()
svc$accept_invitation(
  Foo = 123
)
}

Run the code above in your browser using DataLab