AWS Fundamentals Logo
AWS Fundamentals
aws guardduty

AWS Amazon GuardDuty CLI Commands

87 CLI commands available for Amazon GuardDuty.

CommandSample
accept-administrator-invitation

Accepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation.

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. Only the administrator account can archive findings. Member accounts don't have permission to archive findings from their accounts.

create-detector

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

create-filter

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.

create-ip-set

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 IPSet

create-malware-protection-plan

Creates a new Malware Protection plan for the protected resource. When you create a Malware Protection plan, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.

create-members

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

create-publishing-destination

Creates a publishing destination where you can export your GuardDuty findings. Before you start exporting the findings, the destination resource must exist.

create-sample-findings

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.

create-threat-entity-set

Creates a new threat entity set. In a threat entity set, you can provide known malicious IP addresses and domains for your Amazon Web Services environment. GuardDuty generates findings based on the entries in the threat entity sets. Only users of the administrator account can manage entity sets, whi

create-threat-intel-set

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.

create-trusted-entity-set

Creates a new trusted entity set. In the trusted entity set, you can provide IP addresses and domains that you believe are secure for communication in your Amazon Web Services environment. GuardDuty will not generate findings for the entries that are specified in a trusted entity set. At any given t

decline-invitations

Declines invitations sent to the current member account by Amazon Web Services 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 Amazon Web Services accounts specified by their account IDs.

delete-ip-set

Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the console user interface.

delete-malware-protection-plan

Deletes the Malware Protection plan ID associated with the Malware Protection plan resource. Use this API only when you no longer want to protect the resource associated with this Malware Protection plan ID.

delete-members

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.

delete-publishing-destination

Deletes the publishing definition with the specified destinationId.

delete-threat-entity-set

Deletes the threat entity set that is associated with the specified threatEntitySetId.

delete-threat-intel-set

Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.

delete-trusted-entity-set

Deletes the trusted entity set that is associated with the specified trustedEntitySetId.

describe-malware-scans

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

describe-organization-configuration

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 endpo

describe-publishing-destination

Returns information about the publishing destination specified by the provided destinationId.

disable-organization-admin-account

Removes the existing GuardDuty delegated administrator of the organization. Only the organization's management account can run this API operation.

disassociate-from-administrator-account

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

disassociate-from-master-account

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

disassociate-members

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, a

enable-organization-admin-account

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.

get-administrator-account

Provides the details of the GuardDuty administrator account associated with the current GuardDuty member account. Based on the type of account that runs this API, the following list shows how the API behavior varies: When the GuardDuty administrator account runs this API, it will return success (H

get-coverage-statistics

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 res

get-detector

Retrieves a 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.

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 GuardDuty findings statistics for the specified detector ID. You must provide either findingStatisticTypes or groupBy parameter, and not both. You can use the maxResults and orderBy parameters only when using groupBy. There might be regional differences because some flags might not be availabl

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-malware-protection-plan

Retrieves the Malware Protection plan details associated with a Malware Protection plan ID.

get-malware-scan

Retrieves the detailed information for a specific malware scan. Each member account can view the malware scan details for their own account. An administrator can view malware scan details for all accounts in the organization. There might be regional differences because some data sources might not be

get-malware-scan-settings

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.

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. 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.

get-members

Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.

get-organization-statistics

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.

get-remaining-free-trial-days

Provides the number of days left for each data source used in the free trial period.

get-threat-entity-set

Retrieves the threat entity set associated with the specified threatEntitySetId.

get-threat-intel-set

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

get-trusted-entity-set

Retrieves the trusted entity set associated with the specified trustedEntitySetId.

get-usage-statistics

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 prov

invite-members

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 accoun

list-coverage

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.

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 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.

list-invitations

Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services account.

list-ip-sets

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.

list-malware-protection-plans

Lists the Malware Protection plan IDs associated with the protected resources in your Amazon Web Services account.

list-malware-scans

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 of its members' accounts.

list-members

Lists details about all member accounts for the current GuardDuty administrator account.

list-organization-admin-accounts

Lists the accounts designated as GuardDuty delegated administrators. Only the organization's management account can run this API operation.

list-publishing-destinations

Returns a list of publishing destinations associated with the specified detectorId.

list-tags-for-resource

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.

list-threat-entity-sets

Lists the threat entity sets associated with the specified GuardDuty detector ID. If you use this operation from a member account, the threat entity sets that are returned as a response, belong to the administrator account.

list-threat-intel-sets

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.

list-trusted-entity-sets

Lists the trusted entity sets associated with the specified GuardDuty detector ID. If you use this operation from a member account, the trusted entity sets that are returned as a response, belong to the administrator account.

send-object-malware-scan

Initiates a malware scan for a specific S3 object. This API allows you to perform on-demand malware scanning of individual objects in S3 buckets that have Malware Protection for S3 enabled. When you use this API, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more

start-malware-scan

Initiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account if the resourceArn belongs to an EC2 instance. When the malware scan starts, you can use the associated scan ID to track the status of the scan. For more information, see List

start-monitoring-members

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.

stop-monitoring-members

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 acc

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 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 fo

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-malware-protection-plan

Updates an existing Malware Protection plan resource.

update-malware-scan-settings

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.

update-member-detectors

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 Amaz

update-organization-configuration

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. Yo

update-publishing-destination

Updates information about the publishing destination specified by the destinationId.

update-threat-entity-set

Updates the threat entity set associated with the specified threatEntitySetId.

update-threat-intel-set

Updates the ThreatIntelSet specified by the ThreatIntelSet ID.

update-trusted-entity-set

Updates the trusted entity set associated with the specified trustedEntitySetId.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Stats

Total Commands87
ServiceGuardDuty