Learn R Programming

paws.security.identity (version 0.1.11)

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())

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_invitation Accepts the invitation to be monitored by a GuardDuty administrator account
archive_findings Archives GuardDuty findings that are specified by the list of finding IDs
create_detector Creates a single Amazon GuardDuty detector
create_filter Creates a filter using the specified finding criteria
create_ip_set Creates a new IPSet, which is called a trusted IP list in the console user interface
create_members Creates member accounts of the current AWS account by specifying a list of AWS account IDs
create_publishing_destination Creates a publishing destination to export findings to
create_sample_findings Generates example findings of types specified by the list of finding types
create_threat_intel_set Creates a new ThreatIntelSet
decline_invitations Declines invitations sent to the current member account by AWS accounts specified by their account IDs
delete_detector Deletes an Amazon GuardDuty detector that is specified by the detector ID
delete_filter Deletes the filter specified by the filter name
delete_invitations Deletes invitations sent to the current member account by AWS accounts specified by their account IDs
delete_ip_set Deletes the IPSet specified by the ipSetId
delete_members Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs
delete_publishing_destination Deletes the publishing definition with the specified destinationId
delete_threat_intel_set Deletes the ThreatIntelSet specified by the ThreatIntelSet ID
describe_organization_configuration Returns information about the account selected as the delegated administrator for GuardDuty
describe_publishing_destination Returns information about the publishing destination specified by the provided destinationId
disable_organization_admin_account Disables an AWS account within the Organization as the GuardDuty delegated administrator
disassociate_from_master_account Disassociates the current GuardDuty member account from its administrator account
disassociate_members Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs
enable_organization_admin_account Enables an AWS account within the organization as the GuardDuty delegated administrator
get_detector Retrieves an Amazon GuardDuty detector specified by the detectorId
get_filter Returns the details of the filter specified by the filter name
get_findings Describes Amazon GuardDuty findings specified by finding IDs
get_findings_statistics Lists Amazon GuardDuty findings statistics for the specified detector ID
get_invitations_count Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation
get_ip_set Retrieves the IPSet specified by the ipSetId
get_master_account Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account
get_member_detectors Describes which data sources are enabled for the member account's detector
get_members Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs
get_threat_intel_set Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID
get_usage_statistics Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID
invite_members Invites 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_detectors Lists detectorIds of all the existing Amazon GuardDuty detector resources
list_filters Returns a paginated list of the current filters
list_findings Lists Amazon GuardDuty findings for the specified detector ID
list_invitations Lists all GuardDuty membership invitations that were sent to the current AWS account
list_ip_sets Lists the IPSets of the GuardDuty service specified by the detector ID
list_members Lists details about all member accounts for the current GuardDuty administrator account
list_organization_admin_accounts Lists the accounts configured as GuardDuty delegated administrators
list_publishing_destinations Returns a list of publishing destinations associated with the specified dectectorId
list_tags_for_resource Lists tags for a resource
list_threat_intel_sets Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID
start_monitoring_members Turns on GuardDuty monitoring of the specified member accounts
stop_monitoring_members Stops GuardDuty monitoring for the specified member accounts
tag_resource Adds tags to a resource
unarchive_findings Unarchives GuardDuty findings specified by the findingIds
untag_resource Removes tags from a resource
update_detector Updates the Amazon GuardDuty detector specified by the detectorId
update_filter Updates the filter specified by the filter name
update_findings_feedback Marks the specified GuardDuty findings as useful or not useful
update_ip_set Updates the IPSet specified by the IPSet ID
update_member_detectors Contains information on member accounts to be updated
update_organization_configuration Updates the delegated administrator account with the values provided
update_publishing_destination Updates information about the publishing destination specified by the destinationId

Examples

Run this code
# NOT RUN {
svc <- guardduty()
svc$accept_invitation(
  Foo = 123
)
# }
# NOT RUN {
# }

Run the code above in your browser using DataLab