Details
| ID | AWS - GuardDuty |
|---|---|
| Provider | Amazon |
| Category | IT Services |
| From Version | 5.0.0 |
| Docker Image | demisto/boto3py3:1.0.0.10221838 |
| Supported Modules | Agentix XSIAM |
README
Amazon Web Services Guard Duty Service (gd)
Use this integration to detect and manage threats to your AWS system. We recommend that you use roles that have the following
built-in AWS policies:
- AmazonGuardDutyFullAccess
- AmazonGuardDutyReadOnlyAccess
For detailed instructions about setting up authentication, see: AWS Integrations - Authentication.
Prerequisites
It is important that you familiarize yourself with and complete all steps detailed in
the Amazon AWS Integrations Configuration Guide
Some changes have been made that might affect your existing content.
If you are upgrading from a previous of this integration, see Breaking Changes.
Configure AWS - GuardDuty in Cortex
| Parameter | Description | Required |
|---|---|---|
| AWS Default Region | The AWS Region for this instance of the integration. For example, us-west-2 | True |
| Role Arn | The Amazon Resource Name (ARN) role used for EC2 instance authentication. If this is used, an access key and secret key are not required. | False |
| Fetch incidents | False | |
| Incident type | Incident type | False |
| Role Session Name | A descriptive name for the assumed role session. For example, xsiam-IAM.integration-Role_SESSION | False |
| Role Session Duration | The maximum length of each session in seconds. Default: 900 seconds. The Cortex XSOAR integration will have the permissions assigned only when the session is initiated and for the defined duration. | False |
| Access Key | The access key ID used for authentication, that was configured during IAM user configuration. If this is used, Role ARN is not required. | False |
| Secret Key | The secret key used for authentication, that was configured during IAM user configuration. If this is used, Role ARN is not required. | False |
| Timeout | The time in seconds until a timeout exception is reached. You can specify just the read timeout (for example 60) or also the connect timeout followed after a comma (for example 60,10). If a connect timeout is not specified, a default of 10 second will be used. | False |
| Retries | The maximum number of retry attempts when connection or throttling errors are encountered. Set to 0 to disable retries. The default value is 5 and the limit is 10. Note: Increasing the number of retries will increase the execution time. | False |
| How many incidents to fetch each time | Default 10 |
False |
| First fetch timestamp | First fetch query <number> <time unit>, e.g., 7 days. Default 3 days |
False |
| Guard Duty Severity level | The severity level or higher of findings to be fetched: Low, Medium, or High. For example, if you set the severity level to Medium, only findings with severity level Medium or High will be fetched. | False |
| Archive findings After Fetch | You can set whether findings that are fetched will be moved to the GuardDuty archive. | False |
| Incidents Fetch Interval | Time interval for fetching incidents. | False |
| Trust any certificate (not secure) | False | |
| Use system proxy settings | False |
Fetched Incidents Data
- The integration fetches newly created Guard DutyFindings.
Each integration instance can fetch findings from a single AWS Region. - Each region can have a maximum of 1,000 member accounts that are linked to a guard duty master account. For more information see
the Amazon GuardDuty documentation. - You can set the severity level of the findings to be fetched. “Low”, “Medium”, “High”. For example, if you set the severity
level to “Medium”, the integration will only fetch findings with severity level of Medium and higher.
Commands
You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully
execute a command, a DBot message appears in the War Room with the command details.
aws-gd-create-detector
Create an AWS Guard Duty Detector on the integration instance specified aws account.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:CreateDetector
Base Command
aws-gd-create-detector
Input
| Argument Name | Description | Required |
|---|---|---|
| enabled | A boolean value that specifies whether the detector is to be enabled. Possible values are: True, False. Default is True. | Required |
| enableS3Logs | The status of S3 data event logs as a data source. Possible values are: True, False. | Optional |
| enableKubernetesLogs | The status of Kubernetes audit logs as a data source. Possible values are: True, False. | Optional |
| ebsVolumesMalwareProtection | Describes the configuration for scanning EBS volumes as a data source. Possible values are: True, False. | Optional |
| findingFrequency | Specifies how frequently updated findings are exported. Possible values are: Fifteen Minutes, One Hour, Six Hours. | Optional |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Detectors.DetectorId | string | The unique ID of the created detector. |
Command Example
!aws-gd-create-detector enabled=True region=eu-west-2
aws-gd-delete-detector
Deletes a Amazon GuardDuty detector specified by the detector ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:DeleteDetector
Base Command
aws-gd-delete-detector
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The unique ID that specifies the detector that you want to delete. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
There is no context output for this command.
Command Example
!aws-gd-delete-detector detectorId=38b1235ed3fe245279cd0c8e235db0715ac5561eb
aws-gd-get-detector
Retrieves an Amazon GuardDuty detector specified by the detectorId.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:GetDetector
Base Command
aws-gd-get-detector
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The unique ID of the detector that you want to retrieve. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Detectors.DetectorId | string | The unique ID of the created detector. |
| AWS.GuardDuty.Detectors.CreatedAt | string | The first time a resource was created. |
| AWS.GuardDuty.Detectors.ServiceRole | string | Customer serviceRole name or ARN for accessing customer resources. |
| AWS.GuardDuty.Detectors.Status | string | The status of detector. |
| AWS.GuardDuty.Detectors.UpdatedAt | string | The time a resource was last updated. |
| AWS.GuardDuty.Detectors.CloudTrailStatus | string | Describes whether CloudTrail is enabled as a data source for the detector. |
| AWS.GuardDuty.Detectors.DNSLogsStatus | string | Denotes whether DNS logs are enabled as a data source. |
| AWS.GuardDuty.Detectors.FlowLogsStatus | string | Denotes whether VPC flow logs are enabled as a data source. |
| AWS.GuardDuty.Detectors.S3LogsStatus | string | Describes whether S3 data event logs are automatically enabled for new members of the organization. |
| AWS.GuardDuty.Detectors.KubernetesAuditLogsStatus | string | Describes whether Kubernetes audit logs are enabled as a data source. |
| AWS.GuardDuty.Detectors.MalwareProtectionStatus | string | Describes whether scanning EBS volumes is enabled as a data source. |
| AWS.GuardDuty.Detectors.MalwareProtectionReason | string | Specifies the reason why scanning EBS volumes (Malware Protection) was not enabled as a data source. |
| AWS.GuardDuty.Detectors.Tags | string | The tags of the detector resource. |
Command Example
!aws-gd-get-detector detectorId=38b1ed3fe279fdascd0c8edb071dsf5ac5561eb region=eu-west-2
aws-gd-update-detector
Updates an Amazon GuardDuty detector specified by the detectorId.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:UpdateDetector
Base Command
aws-gd-update-detector
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The unique ID of the detector that you want to update. | Required |
| enable | Updated boolean value for the detector that specifies whether the detector is enabled. Possible values are: True, False. Default is True. | Required |
| enableS3Logs | The status of S3 data event logs as a data source. Possible values are: True, False. | Optional |
| enableKubernetesLogs | The status of Kubernetes audit logs as a data source. Possible values are: True, False. | Optional |
| ebsVolumesMalwareProtection | Describes the configuration for scanning EBS volumes as data source. Possible values are: True, False. | Optional |
| findingFrequency | A value that specifies how frequently updated findings are exported. Possible values are: Fifteen Minutes, One Hour, Six Hours. | Optional |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
There is no context output for this command.
Command Example
aws-gd-update-detector detectorId=38b1ed3fe279fdascd0c8edb071dsf5ac5561eb enable=True
aws-gd-create-ip-set
A list of trusted IP addresses on allow list for secure communication with AWS infrastructure and applications.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:CreateIPSet
Base Command
aws-gd-create-ip-set
Input
| Argument Name | Description | Required |
|---|---|---|
| activate | A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet. Possible values are: True, False. Default is True. | Optional |
| detectorId | The unique ID of the detector that you want to update. | Required |
| format | The format of the file that contains the IPSet. Possible values are: TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE. | Required |
| location | The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). | Optional |
| name | The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet. | Optional |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Detectors.IPSet.IpSetId | unknown | The unique identifier for an IP Set. |
Command Example
!aws-gd-create-ip-set format=TXT location=https://s3.eu-central-1.amazonaws.com/test/ipset.txt activate=True detectorId=38b1ed3fe279czvasdd0c8edb0715azdsfc5561eb name=test region=eu-west-2
aws-gd-delete-ip-set
Deletes the IPSet specified by the IPSet ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:DeleteIPSet
Base Command
aws-gd-delete-ip-set
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The detectorID that specifies the GuardDuty service whose IPSet you want to delete. | Required |
| ipSetId | The unique ID that specifies the IPSet that you want to delete. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
There is no context output for this command.
Command Example
!aws-gd-delete-ip-set detectorId=38b1ed3fe279cd0c8edb0715ac5561eb ipSetId=7eb1f440be5931f168280b574a26d44d region=eu-west-2
aws-gd-list-detectors
Lists detectorIds of all the existing Amazon GuardDuty detector resources.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:ListDetectors
Base Command
aws-gd-list-detectors
Input
| Argument Name | Description | Required |
|---|---|---|
| limit | Number of total results to query. Default is 50. |
Optional |
| page | Specific page to query. | Optional |
| page_size | Number of total results in each page. Default is 50. |
Optional |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Detectors.DetectorId | string | The unique identifier for a detector. |
Command Example
!aws-gd-list-detectors region=eu-west-2
aws-gd-update-ip-set
Updates the IPSet specified by the IPSet ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:UpdateIPSet
Base Command
aws-gd-update-ip-set
Input
| Argument Name | Description | Required |
|---|---|---|
| activate | The updated boolean value that specifies whether the IPSet is active or not. Possible values are: True, False. | Optional |
| detectorId | The detectorID that specifies the GuardDuty service whose IPSet you want to update. | Required |
| ipSetId | The unique ID that specifies the IPSet that you want to update. | Required |
| location | The updated URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). | Optional |
| name | The user friendly name to identify the IPSet. | Optional |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
There is no context output for this command.
Command Example
!aws-gd-update-ip-set detectorId=38b1ed3fe279cd0c8edb0715ac5561eb ipSetId=7eb1f440be5931f168280b574a26d44d activate=False region=eu-west-2
aws-gd-get-ip-set
Retrieves the IPSet specified by the IPSet ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:GetIPSet
Base Command
aws-gd-get-ip-set
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The detectorID that specifies the GuardDuty service whose IPSet you want to retrieve. | Required |
| ipSetId | The unique ID that specifies the IPSet that you want to describe. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Detectors.IPSet.IpSetId | string | The unique ID for the IPSet. |
| AWS.GuardDuty.Detectors.IPSet.Format | string | The format of the file that contains the IPSet. |
| AWS.GuardDuty.Detectors.IPSet.Location | string | The URI of the file that contains the IPSet. |
| AWS.GuardDuty.Detectors.IPSet.Name | string | he user friendly name to identify the IPSet. |
| AWS.GuardDuty.Detectors.IPSet.Status | string | The status of ipSet file uploaded. |
Command Example
!aws-gd-get-ip-set detectorId=38b1ed3fesdf279cd0c8edbdsf071sdgfac5561eb ipSetId=7eb1sdff440be5931f1682adf80b574a26d44d region=eu-west-2
aws-gd-list-ip-sets
Lists the IPSets of the GuardDuty service specified by the detector ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:ListIPSet
Base Command
aws-gd-list-ip-sets
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The unique ID of the detector that you want to retrieve. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
| limit | Number of total results to query. Default is 50. |
Optional |
| page | Specific page to query. | Optional |
| page_size | Number of total results in each page. Default is 50. |
Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Detectors.IPSet.IpSetId | unknown | The unique identifier for an IP Set |
Command Example
!aws-gd-list-ip-sets detectorId=38b1ed3fesdf279cd0c8edbdsf071sdgfac5561eb region=eu-west-2
aws-gd-create-threatintel-set
Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on
ThreatIntelSets.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:CreateThreatIntelSet
Base Command
aws-gd-create-threatintel-set
Input
| Argument Name | Description | Required |
|---|---|---|
| activate | A boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet. Possible values are: True, False. Default is True. | Required |
| detectorId | The unique ID of the detector that you want to update. | Required |
| format | The format of the file that contains the ThreatIntelSet. Possible values are: TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE. | Required |
| location | The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). | Required |
| name | A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Detectors.ThreatIntelSet.ThreatIntelSetId | string | The unique identifier for an threat intel set. |
Command Example
!aws-gd-create-threatintel-set format=TXT location=https://s3.eu-central-1.amazonaws.com/test/threatintel.txt activate=True detectorId=38b1ed3fe279czvasdd0c8edb0715azdsfc5561eb name=test region=eu-west-2
aws-gd-delete-threatintel-set
Deletes ThreatIntelSet specified by the ThreatIntelSet ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:DeleteThreatIntelSet
Base Command
aws-gd-delete-threatintel-set
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to delete. | Required |
| threatIntelSetId | The unique ID that specifies the ThreatIntelSet that you want to delete. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
There is no context output for this command.
Command Example
!aws-gd-delete-threatintel-set detectorId=38b1ed3fe279cd0c8edb0715ac5561eb threatIntelSetId=7eb1f440be5931f168280b574a26d44d region=eu-west-2
aws-gd-get-threatintel-set
Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:GetThreatIntelSet
Base Command
aws-gd-get-threatintel-set
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to describe. | Required |
| threatIntelSetId | The unique ID that specifies the ThreatIntelSet that you want to describe. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Detectors.ThreatIntelSet.ThreatIntelSetId | string | The unique ID that specifies the ThreatIntelSet. |
| AWS.GuardDuty.Detectors.ThreatIntelSet.Format | string | The format of the threatIntelSet. |
| AWS.GuardDuty.Detectors.ThreatIntelSet.Location | string | The URI of the file that contains the ThreatIntelSet. |
| AWS.GuardDuty.Detectors.ThreatIntelSet.Name | string | A user-friendly ThreatIntelSet name. |
| AWS.GuardDuty.Detectors.ThreatIntelSet.Status | string | The status of threatIntelSet file uploaded. |
Command Example
!aws-gd-get-threatintel-set detectorId=38b1ed3fe279cd0c8edb0715ac5561eb threatIntelSetId=7eb1f440be5931f168280b574a26d44d region=eu-west-2
aws-gd-list-threatintel-sets
Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:ListThreatIntelSet
Base Command
aws-gd-list-threatintel-sets
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The detectorID that specifies the GuardDuty service whose ThreatIntelSets you want to list. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
| limit | Number of total results to query. Default is 50. |
Optional |
| page | Specific page to query. | Optional |
| page_size | Number of total results in each page. Default is 50. |
Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Detectors.ThreatIntelSet.ThreatIntelSetId | string | The unique identifier for an threat intel set |
Command Example
!aws-gd-list-threatintel-sets detectorId=38b1ed3fe279cd0c8edb0715ac5561eb region=eu-west-2
aws-gd-update-threatintel-set
Updates the ThreatIntelSet specified by ThreatIntelSet ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:UpdateThreatIntelSet
Base Command
aws-gd-update-threatintel-set
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update. | Required |
| threatIntelSetId | The unique ID that specifies the ThreatIntelSet that you want to update. | Optional |
| activate | The updated boolean value that specifies whether the ThreatIntelSet is active or not. Possible values are: True, False. | Optional |
| location | The updated URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). | Optional |
| name | The user-friendly ThreatIntelSet name. | Optional |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
There is no context output for this command.
Command Example
!aws-gd-update-threatintel-set detectorId=38b1ed3fe279cd0c8edb0715ac5561eb threatIntelSetId=7eb1f440be5931f168280b574a26d44d activate=False region=eu-west-2
aws-gd-list-findings
Lists Amazon GuardDuty findings for the specified detector ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:ListFindings
Base Command
aws-gd-list-findings
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The ID of the detector that specifies the GuardDuty service whose findings you want to list. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
| limit | Number of total results to query. Default is 50. |
Optional |
| page | Specific page to query. | Optional |
| page_size | Number of total results in each page. Default is 50. |
Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Findings.FindingId | string | The unique identifier for the Finding |
Command Example
!aws-gd-list-findings detectorId=38b1ed3fe279cd0c8edb0715ac5561eb region=eu-west-2
aws-gd-get-findings
Describes Amazon GuardDuty findings specified by finding IDs.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:GetFindings
Base Command
aws-gd-get-findings
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve. | Required |
| findingIds | IDs of the findings that you want to retrieve. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
| returnRawResponse | Select ‘true’ to save all fields from the response to the context. Otherwise, complex fields will be stored in JSON format. Default value is False. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Findings.AccountId | string | The ID of the account in which the finding was generated. |
| AWS.GuardDuty.Findings.CreatedAt | string | The time and date when the finding was created. |
| AWS.GuardDuty.Findings.Description | string | The description of the finding. |
| AWS.GuardDuty.Findings.Region | string | The region where the finding was generated. |
| AWS.GuardDuty.Findings.Id | string | The ID of the finding. |
| AWS.GuardDuty.Findings.Title | string | The title of the finding. |
| AWS.GuardDuty.Findings.Severity | string | The severity of the finding. |
| AWS.GuardDuty.Findings.Type | string | The type of finding. |
| AWS.GuardDuty.Findings.UpdatedAt | string | The time and date when the finding was last updated. |
| AWS.GuardDuty.Findings.Arn | string | The ARN of the finding. |
| AWS.GuardDuty.Findings.Confidence | string | The confidence score for the finding. |
| AWS.GuardDuty.Findings.Partition | string | The partition associated with the finding. |
| AWS.GuardDuty.Findings.ResourceType | string | The type of Amazon Web Services resource. |
| AWS.GuardDuty.Findings.SchemaVersion | string | The version of the schema used for the finding. |
| AWS.GuardDuty.Findings.Service | string | Contains additional information about the generated finding. |
| AWS.GuardDuty.Findings.Resource.AccessKeyDetails | string | The IAM access key details (IAM user information) of a user that engaged in the activity that prompted GuardDuty to generate a finding. |
| AWS.GuardDuty.Findings.Resource.InstanceDetails | string | The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a finding. |
| AWS.GuardDuty.Findings.Resource.EksClusterDetails | string | Details about the EKS cluster involved in a Kubernetes finding. |
| AWS.GuardDuty.Findings.Resource.KubernetesDetails | string | Details about the Kubernetes user and workload involved in a Kubernetes finding. |
| AWS.GuardDuty.Findings.Resource.EbsVolumeDetails | string | Contains a list of scanned and skipped EBS volumes with details. |
| AWS.GuardDuty.Findings.Resource.EcsClusterDetails | string | Contains information about the details of the ECS Cluster. |
| AWS.GuardDuty.Findings.Resource.ContainerDetails | string | Details of a container. |
| AWS.GuardDuty.Findings.Resource.S3BucketDetails | string | Contains information on the S3 bucket. |
Command Example
!aws-gd-get-findings detectorIds=4f1fc7cd7dsg26sdf4328d8dc813 findingIds=96b1ac608sdf00e5183c3dds115c36aac328b,0ab180f5801sdg954418f3806c2a45282c9
aws-gd-create-sample-findings
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.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:CreateSampleFindings
Base Command
aws-gd-create-sample-findings
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The ID of the detector to create sample findings for. | Required |
| findingTypes | Types of sample findings that you want to generate. Separated by comma. | Optional |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
There is no context output for this command.
Command Example
!aws-gd-create-sample-findings detectorId=4f1fc7cd7dsg2adf6sdf4328d8dc813 findingTypes=NULL region=eu-central-1
aws-gd-archive-findings
Archives Amazon GuardDuty findings specified by the list of finding IDs.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:ArchiveFindings
Base Command
aws-gd-archive-findings
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The ID of the detector that specifies the GuardDuty service whose findings you want to archive. | Required |
| findingIds | IDs of the findings that you want to archive. Separated by comma. | Optional |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
There is no context output for this command.
Command Example
!aws-gd-archive-findings detectorIds=4f1fc7cd7dsg26sdf4328d8dc813 findingIds=96b1ac608sdf00e5183c3dds115c36aac328b,0ab180f5801sdg954418f3806c2a45282c9
aws-gd-unarchive-findings
Unarchives Amazon GuardDuty findings specified by the list of finding IDs.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:UnarchiveFindings
Base Command
aws-gd-unarchive-findings
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The ID of the detector that specifies the GuardDuty service whose findings you want to unarchive. | Required |
| findingIds | IDs of the findings that you want to unarchive. | Optional |
Context Output
There is no context output for this command.
Command Example
!aws-gd-unarchive-findings detectorIds=4f1fc7cd7dsg26sdf4328d8dc813 findingIds=96b1ac608sdf00e5183c3dds115c36aac328b,0ab180f5801sdg954418f3806c2a45282c9
aws-gd-update-findings-feedback
Marks specified Amazon GuardDuty findings as useful or not useful.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:UpdateFindingsFeedback
Base Command
aws-gd-update-findings-feedback
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The ID of the detector that specifies the GuardDuty service whose findings you want to mark as useful or not useful. | Required |
| findingIds | IDs of the findings that you want to mark as useful or not useful. | Optional |
| comments | Additional feedback about the GuardDuty findings. | Optional |
| feedback | Specify whether the finding was useful or not. Possible values are: USEFUL, NOT_USEFUL. | Optional |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
There is no context output for this command.
Command Example
!aws-gd-update-findings-feedback detectorIds=4f1fc7cd7dsg26sdf4328d8dc813 findingIds=96b1ac608sdf00e5183c3dds115c36aac328b comments=Good Job feedback=USEFUL
aws-gd-list-members
Describes Amazon GuardDuty members for the specified detector ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:ListMembers
Base Command
aws-gd-list-members
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The ID of the detector that specifies the GuardDuty service whose members you want to retrieve. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
| limit | Number of total results to query. Default is 50. |
Optional |
| page | Specific page to query. | Optional |
| page_size | Number of total results in each page. Default is 50. |
Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Members.AccountId | string | The unique account ID of the member. |
| AWS.GuardDuty.Members.DetectorId | string | The unique detector ID of the member. |
| AWS.GuardDuty.Members.MasterId | string | The unique detector ID of the master. |
| AWS.GuardDuty.Members.Email | string | The email of the member. |
| AWS.GuardDuty.Members.RelationshipStatus | string | The relationship status of member. |
| AWS.GuardDuty.Members.InvitedAt | string | The first time a member was invited. |
| AWS.GuardDuty.Members.UpdatedAt | string | The time a member was last updated. |
Command Example
!aws-gd-list-members detectorIds=4f1fc7cd7dsg26sdf4328d8dc813
aws-gd-get-members
Describes Amazon GuardDuty members for the specified detector ID & account ID.
AWS IAM Policy Permission
Effect: Allow
Action: guardduty:GetMembers
Base Command
aws-gd-get-members
Input
| Argument Name | Description | Required |
|---|---|---|
| detectorId | The ID of the detector that specifies the GuardDuty service whose members you want to retrieve. | Required |
| accountIds | The ID of the account that specifies the GuardDuty service whose details you want to retrieve. | Required |
| region | The AWS Region, if not specified the default region will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AWS.GuardDuty.Members.AccountId | string | The unique account ID of the member. |
| AWS.GuardDuty.Members.DetectorId | string | The unique detector ID of the member. |
| AWS.GuardDuty.Members.MasterId | string | The unique detector ID of the master. |
| AWS.GuardDuty.Members.Email | string | The email of the member. |
| AWS.GuardDuty.Members.RelationshipStatus | string | The relationship status of member. |
| AWS.GuardDuty.Members.InvitedAt | string | The first time a member was invited. |
| AWS.GuardDuty.Members.UpdatedAt | string | The time a member was last updated. |
Command Example
!aws-gd-get-members detectorIds=4f1fc7cd7dsg26sdf4328d8dc813 accountIds=1f3fc2cd1dag26sdf4338d8aa813
Breaking changes from the previous version of this integration - AWS-GuardDuty
The following sections list the changes in this version.
Commands
Fetch incidents command - Findings that are fetched are no longer moved automatically to the GuardDuty archive.
Parameters
The following parameters were added in this version:
- How many incidents to fetch each time
- First fetch timestamp
- Archive findings After Fetch
Configuration parameters
defaultRegion— AWS Default Region (required)roleArn— Role ArnisFetch— Fetch incidentsincidentType— Incident typeroleSessionName— Role Session NamesessionDuration— Role Session Durationcredentials— Access Keyaccess_key— Access Keysecret_key— Secret Keytimeout— Timeoutretries— Retriesendpoint_url— PrivateLink service URL.sts_endpoint_url— STS PrivateLink URL.sts_regional_endpoint— AWS STS Regional Endpointsfetch_limit— How many incidents to fetch each timefirst_fetch_time— First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days, 3 months, 1 year)gs_severity— Guard Duty Severity levelis_archive— Archive findings After FetchincidentFetchInterval— Incidents Fetch Intervalinsecure— Trust any certificate (not secure)proxy— Use system proxy settings
Commands (23)
-
aws-gd-archive-findingsArchives Amazon GuardDuty findings specified by the list of finding IDs.
-
aws-gd-create-detectorCreate an AWS Guard Duty Detector on the integration instance specified aws account.
-
aws-gd-create-ip-setA list of trusted IP addresses on allow list for secure communication with AWS infrastructure and applications.
-
aws-gd-create-sample-findingsGenerates 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.
-
aws-gd-create-threatintel-setCreate a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets.
-
aws-gd-delete-detectorDeletes a Amazon GuardDuty detector specified by the detector ID.
-
aws-gd-delete-ip-setDeletes the IPSet specified by the IPSet ID.
-
aws-gd-delete-threatintel-setDeletes ThreatIntelSet specified by the ThreatIntelSet ID.
-
aws-gd-get-detectorRetrieves an Amazon GuardDuty detector specified by the detectorId.
-
aws-gd-get-findingsDescribes Amazon GuardDuty findings specified by finding IDs.
-
aws-gd-get-ip-setRetrieves the IPSet specified by the IPSet ID.
-
aws-gd-get-membersDescribes Amazon GuardDuty members for the specified detector ID & account ID.
-
aws-gd-get-threatintel-setRetrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
-
aws-gd-list-detectorsLists detectorIds of all the existing Amazon GuardDuty detector resources.
-
aws-gd-list-findingsLists Amazon GuardDuty findings for the specified detector ID.
-
aws-gd-list-ip-setsLists the IPSets of the GuardDuty service specified by the detector ID.
-
aws-gd-list-membersDescribes Amazon GuardDuty members for the specified detector ID.
-
aws-gd-list-threatintel-setsLists the ThreatIntelSets of the GuardDuty service specified by the detector ID.
-
aws-gd-unarchive-findingsUnarchives Amazon GuardDuty findings specified by the list of finding IDs.
-
aws-gd-update-detectorUpdates an Amazon GuardDuty detector specified by the detectorId.
-
aws-gd-update-findings-feedbackMarks specified Amazon GuardDuty findings as useful or not useful.
-
aws-gd-update-ip-setUpdates the IPSet specified by the IPSet ID.
-
aws-gd-update-threatintel-setUpdates the ThreatIntelSet specified by ThreatIntelSet ID.
category: IT Services provider: Amazon commonfields: id: AWS - GuardDuty version: -1 sectionorder: - Connect - Collect configuration: - display: AWS Default Region name: defaultRegion required: true type: 0 section: Connect - display: Role Arn name: roleArn type: 0 section: Connect required: false - display: Fetch incidents name: isFetch type: 8 section: Collect required: false - display: Incident type name: incidentType type: 13 required: false section: Collect - display: Role Session Name name: roleSessionName type: 0 section: Connect required: false - display: Role Session Duration name: sessionDuration type: 0 section: Connect advanced: true required: false - display: Access Key name: credentials type: 9 displaypassword: Secret Key required: false section: Connect - display: Access Key name: access_key type: 0 section: Connect hidden: true required: false - display: Secret Key name: secret_key type: 4 section: Connect hidden: true required: false - display: Timeout name: timeout defaultvalue: 60,10 additionalinfo: "The time in seconds till a timeout exception is reached. You can specify just the read timeout (for example 60) or also the connect timeout followed after a comma (for example 60,10). If a connect timeout is not specified, a default of 10 second will be used." type: 0 section: Connect advanced: true required: false - display: Retries name: retries type: 0 defaultvalue: 5 additionalinfo: "The maximum number of retry attempts when connection or throttling errors are encountered. Set to 0 to disable retries. The default value is 5 and the limit is 10. Note: Increasing the number of retries will increase the execution time." section: Connect advanced: true required: false - display: PrivateLink service URL. name: endpoint_url type: 0 section: Connect advanced: true required: false - display: STS PrivateLink URL. name: sts_endpoint_url type: 0 section: Connect advanced: true required: false - display: AWS STS Regional Endpoints additionalinfo: Sets the AWS_STS_REGIONAL_ENDPOINTS environment variable to specify the AWS STS endpoint resolution logic. By default, this option is set to “legacy” in AWS. Leave empty if the environment variable is already set using server configuration. name: sts_regional_endpoint options: - legacy - regional type: 15 section: Connect required: false - display: How many incidents to fetch each time name: fetch_limit type: 0 defaultvalue: '10' required: false section: Collect - display: First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days, 3 months, 1 year) name: first_fetch_time type: 0 defaultvalue: "3 days" required: false section: Collect - display: Guard Duty Severity level name: gs_severity type: 16 additionalinfo: 'You can set the severity level of the findings to be fetched: "Low", "Medium", "High". For example, if you set the severity level to "Medium", the integration will only fetch findings with severity level of Medium and higher.' section: Collect advanced: true options: - Low - Medium - High required: false - display: Archive findings After Fetch name: is_archive type: 8 defaultvalue: "false" additionalinfo: You can set whether findings that are fetched will be moved to the GuardDuty archive. required: false section: Collect advanced: true - display: Incidents Fetch Interval name: incidentFetchInterval type: 19 defaultvalue: '1' required: false section: Collect - display: Trust any certificate (not secure) name: insecure type: 8 section: Connect advanced: true required: false - display: Use system proxy settings name: proxy type: 8 section: Connect advanced: true required: false description: Amazon Web Services Guard Duty Service (gd). display: AWS - GuardDuty name: AWS - GuardDuty script: commands: - arguments: - auto: PREDEFINED defaultValue: 'True' description: A boolean value that specifies whether the detector is to be enabled. name: enabled predefined: - 'True' - 'False' required: true - description: The status of S3 data event logs as a data source. name: enableS3Logs auto: PREDEFINED predefined: - 'True' - 'False' - description: The status of Kubernetes audit logs as a data source. name: enableKubernetesLogs auto: PREDEFINED predefined: - 'True' - 'False' - description: Describes the configuration for scanning EBS volumes as a data source. name: ebsVolumesMalwareProtection auto: PREDEFINED predefined: - 'True' - 'False' - description: Specifies how frequently updated findings are exported. name: findingFrequency auto: PREDEFINED predefined: - 'Fifteen Minutes' - 'One Hour' - 'Six Hours' - description: The AWS Region. If not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Create an AWS Guard Duty Detector on the integration instance specified aws account. name: aws-gd-create-detector outputs: - contextPath: AWS.GuardDuty.Detectors.DetectorId description: The unique ID of the created detector. type: string - arguments: - description: The unique ID that specifies the detector that you want to delete. name: detectorId required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Deletes a Amazon GuardDuty detector specified by the detector ID. name: aws-gd-delete-detector - arguments: - description: The unique ID of the detector that you want to retrieve. name: detectorId required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Retrieves an Amazon GuardDuty detector specified by the detectorId. name: aws-gd-get-detector outputs: - contextPath: AWS.GuardDuty.Detectors.DetectorId description: The unique ID of the created detector. type: string - contextPath: AWS.GuardDuty.Detectors.CreatedAt description: The first time a resource was created. type: string - contextPath: AWS.GuardDuty.Detectors.ServiceRole description: Customer serviceRole name or ARN for accessing customer resources. type: string - contextPath: AWS.GuardDuty.Detectors.Status description: The status of detector. type: string - contextPath: AWS.GuardDuty.Detectors.UpdatedAt description: The time a resource was last updated. type: string - contextPath: AWS.GuardDuty.Detectors.CloudTrailStatus description: Describes whether CloudTrail is enabled as a data source for the detector. type: string - contextPath: AWS.GuardDuty.Detectors.DNSLogsStatus description: Denotes whether DNS logs are enabled as a data source. type: string - contextPath: AWS.GuardDuty.Detectors.FlowLogsStatus description: Denotes whether VPC flow logs are enabled as a data source. type: string - contextPath: AWS.GuardDuty.Detectors.S3LogsStatus description: Describes whether S3 data event logs are automatically enabled for new members of the organization. type: string - contextPath: AWS.GuardDuty.Detectors.KubernetesAuditLogsStatus description: Describes whether Kubernetes audit logs are enabled as a data source. type: string - contextPath: AWS.GuardDuty.Detectors.MalwareProtectionStatus description: Describes whether scanning EBS volumes is enabled as a data source. type: string - contextPath: AWS.GuardDuty.Detectors.MalwareProtectionReason description: The reason why scanning EBS volumes (Malware Protection) was not enabled as a data source. type: string - contextPath: AWS.GuardDuty.Detectors.Tags description: The tags of the detector resource. type: string - arguments: - description: The unique ID of the detector that you want to update. name: detectorId required: true - auto: PREDEFINED defaultValue: 'True' description: Updated boolean value for the detector that specifies whether the detector is enabled. name: enable predefined: - 'True' - 'False' required: true - description: The status of S3 data event logs as a data source. name: enableS3Logs auto: PREDEFINED predefined: - 'True' - 'False' - description: The status of Kubernetes audit logs as a data source. name: enableKubernetesLogs auto: PREDEFINED predefined: - 'True' - 'False' - description: Describes the configuration for scanning EBS volumes as a data source. name: ebsVolumesMalwareProtection auto: PREDEFINED predefined: - 'True' - 'False' - description: Specifies how frequently updated findings are exported. name: findingFrequency auto: PREDEFINED predefined: - 'Fifteen Minutes' - 'One Hour' - 'Six Hours' - description: The AWS Region. If not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Updates an Amazon GuardDuty detector specified by the detectorId. name: aws-gd-update-detector - arguments: - auto: PREDEFINED defaultValue: 'True' description: A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet. name: activate predefined: - 'True' - 'False' - description: The unique ID of the detector that you want to update. name: detectorId required: true - auto: PREDEFINED description: The format of the file that contains the IPSet. name: format predefined: - TXT - STIX - OTX_CSV - ALIEN_VAULT - PROOF_POINT - FIRE_EYE required: true - description: The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). name: location - description: The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet. name: name - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: A list of trusted IP addresses on allow list for secure communication with AWS infrastructure and applications. name: aws-gd-create-ip-set outputs: - contextPath: AWS.GuardDuty.Detectors.IPSet.IpSetId description: The unique identifier for an IP Set. type: Unknown - arguments: - description: The detectorID that specifies the GuardDuty service whose IPSet you want to delete. name: detectorId required: true - description: The unique ID that specifies the IPSet that you want to delete. name: ipSetId required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Deletes the IPSet specified by the IPSet ID. name: aws-gd-delete-ip-set - arguments: - description: Number of total results to query. name: limit defaultValue: '50' - description: Specific page to query. name: page - description: Number of total results in each page. name: page_size defaultValue: '50' - description: The AWS Region. If not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Lists detectorIds of all the existing Amazon GuardDuty detector resources. name: aws-gd-list-detectors outputs: - contextPath: AWS.GuardDuty.Detectors.DetectorId description: The unique identifier for a detector. type: string - arguments: - auto: PREDEFINED description: The updated boolean value that specifies whether the IPSet is active or not. name: activate predefined: - 'True' - 'False' - description: The detectorID that specifies the GuardDuty service whose IPSet you want to update. name: detectorId required: true - description: The unique ID that specifies the IPSet that you want to update. name: ipSetId required: true - description: The updated URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). name: location - description: The user friendly name to identify the IPSet. name: name - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Updates the IPSet specified by the IPSet ID. name: aws-gd-update-ip-set - arguments: - description: The detectorID that specifies the GuardDuty service whose IPSet you want to retrieve. name: detectorId required: true - description: The unique ID that specifies the IPSet that you want to describe. name: ipSetId required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Retrieves the IPSet specified by the IPSet ID. name: aws-gd-get-ip-set outputs: - contextPath: AWS.GuardDuty.Detectors.IPSet.IpSetId description: The unique ID for the IPSet. type: string - contextPath: AWS.GuardDuty.Detectors.IPSet.Format description: The format of the file that contains the IPSet. type: string - contextPath: AWS.GuardDuty.Detectors.IPSet.Location description: The URI of the file that contains the IPSet. type: string - contextPath: AWS.GuardDuty.Detectors.IPSet.Name description: he user friendly name to identify the IPSet. type: string - contextPath: AWS.GuardDuty.Detectors.IPSet.Status description: The status of ipSet file uploaded. type: string - arguments: - description: The unique ID of the detector that you want to retrieve. name: detectorId required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration - defaultValue: '50' description: Number of total results to query. name: limit - description: Specific page to query. name: page - defaultValue: '50' description: Number of total results in each page. name: page_size description: Lists the IPSets of the GuardDuty service specified by the detector ID. name: aws-gd-list-ip-sets outputs: - contextPath: AWS.GuardDuty.Detectors.IPSet.IpSetId description: The unique identifier for an IP Set. type: Unknown - arguments: - auto: PREDEFINED defaultValue: 'True' description: A boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet. name: activate predefined: - 'True' - 'False' required: true - description: The unique ID of the detector that you want to update. name: detectorId required: true - auto: PREDEFINED description: The format of the file that contains the ThreatIntelSet. name: format predefined: - TXT - STIX - OTX_CSV - ALIEN_VAULT - PROOF_POINT - FIRE_EYE required: true - description: The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). name: location required: true - description: A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet. name: name required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. name: aws-gd-create-threatintel-set outputs: - contextPath: AWS.GuardDuty.Detectors.ThreatIntelSet.ThreatIntelSetId description: The unique identifier for an threat intel set. type: string - arguments: - description: The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to delete. name: detectorId required: true - description: The unique ID that specifies the ThreatIntelSet that you want to delete. name: threatIntelSetId required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Deletes ThreatIntelSet specified by the ThreatIntelSet ID. name: aws-gd-delete-threatintel-set - arguments: - description: The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to describe. name: detectorId required: true - description: The unique ID that specifies the ThreatIntelSet that you want to describe. name: threatIntelSetId required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID. name: aws-gd-get-threatintel-set outputs: - contextPath: AWS.GuardDuty.Detectors.ThreatIntelSet.ThreatIntelSetId description: The unique ID that specifies the ThreatIntelSet. type: string - contextPath: AWS.GuardDuty.Detectors.ThreatIntelSet.Format description: The format of the threatIntelSet. type: string - contextPath: AWS.GuardDuty.Detectors.ThreatIntelSet.Location description: The URI of the file that contains the ThreatIntelSet. type: string - contextPath: AWS.GuardDuty.Detectors.ThreatIntelSet.Name description: A user-friendly ThreatIntelSet name. type: string - contextPath: AWS.GuardDuty.Detectors.ThreatIntelSet.Status description: The status of threatIntelSet file uploaded. type: string - arguments: - description: The detectorID that specifies the GuardDuty service whose ThreatIntelSets you want to list. name: detectorId required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration - defaultValue: '50' description: Number of total results to query. name: limit - description: Specific page to query. name: page - defaultValue: '50' description: Number of total results in each page. name: page_size description: Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. name: aws-gd-list-threatintel-sets outputs: - contextPath: AWS.GuardDuty.Detectors.ThreatIntelSet.ThreatIntelSetId description: The unique identifier for an threat intel set. type: string - arguments: - description: The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update. name: detectorId required: true - description: The unique ID that specifies the ThreatIntelSet that you want to update. name: threatIntelSetId - auto: PREDEFINED description: The updated boolean value that specifies whether the ThreatIntelSet is active or not. name: activate predefined: - 'True' - 'False' - description: The updated URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). name: location - description: The user-friendly ThreatIntelSet name. name: name - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Updates the ThreatIntelSet specified by ThreatIntelSet ID. name: aws-gd-update-threatintel-set - arguments: - description: The ID of the detector that specifies the GuardDuty service whose findings you want to list. name: detectorId required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration - defaultValue: '50' description: Number of total results to query. name: limit - description: Specific page to query. name: page - defaultValue: '50' description: Number of total results in each page. name: page_size description: Lists Amazon GuardDuty findings for the specified detector ID. name: aws-gd-list-findings outputs: - contextPath: AWS.GuardDuty.Findings.FindingId description: The unique identifier for the Finding. type: string - arguments: - description: The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve. name: detectorId required: true - description: IDs of the findings that you want to retrieve. name: findingIds required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration - name: returnRawResponse description: Select 'true' to save all fields from the response to the context. Otherwise, complex fields will be stored in JSON format. Default value is False. auto: PREDEFINED predefined: - 'true' - 'false' defaultValue: false description: Describes Amazon GuardDuty findings specified by finding IDs. name: aws-gd-get-findings outputs: - contextPath: 'AWS.GuardDuty.Findings.AccountId' description: The ID of the account in which the finding was generated. type: string - contextPath: 'AWS.GuardDuty.Findings.CreatedAt' description: The time and date when the finding was created. type: string - contextPath: 'AWS.GuardDuty.Findings.Description' description: The description of the finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Region' description: The region where the finding was generated. type: string - contextPath: 'AWS.GuardDuty.Findings.Id' description: The ID of the finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Title' description: The title of the finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Severity' description: The severity of the finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Type' description: The type of the finding. type: string - contextPath: 'AWS.GuardDuty.Findings.UpdatedAt' description: The time and date when the finding was last updated. type: string - contextPath: 'AWS.GuardDuty.Findings.Arn' description: The ARN of the finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Confidence' description: The confidence score for the finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Partition' description: The partition associated with the finding. type: string - contextPath: 'AWS.GuardDuty.Findings.ResourceType' description: The type of Amazon Web Services resource. type: string - contextPath: 'AWS.GuardDuty.Findings.SchemaVersion' description: The version of the schema used for the finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Resource.AccessKeyDetails' description: The IAM access key details (IAM user information) of a user that engaged in the activity that prompted GuardDuty to generate a finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Resource.InstanceDetails' description: The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Resource.EksClusterDetails' description: Details about the EKS cluster involved in a Kubernetes finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Resource.KubernetesDetails' description: Details about the Kubernetes user and workload involved in a Kubernetes finding. type: string - contextPath: 'AWS.GuardDuty.Findings.Resource.EbsVolumeDetails' description: Contains a list of scanned and skipped EBS volumes with details. type: string - contextPath: 'AWS.GuardDuty.Findings.Resource.EcsClusterDetails' description: Contains information about the details of the ECS cluster. type: string - contextPath: 'AWS.GuardDuty.Findings.Resource.ContainerDetails' description: Details of a container. type: string - contextPath: 'AWS.GuardDuty.Findings.Resource.S3BucketDetails' description: Contains information on the S3 bucket. type: string - contextPath: 'AWS.GuardDuty.Findings.Service' description: Contains additional information about the generated finding. type: string - arguments: - description: The ID of the detector to create sample findings for. name: detectorId required: true - description: Types of sample findings that you want to generate. Separated by comma. name: findingTypes - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: 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. name: aws-gd-create-sample-findings - arguments: - description: The ID of the detector that specifies the GuardDuty service whose findings you want to archive. name: detectorId required: true - description: IDs of the findings that you want to archive. Separated by comma. name: findingIds - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Archives Amazon GuardDuty findings specified by the list of finding IDs. name: aws-gd-archive-findings - arguments: - description: The ID of the detector that specifies the GuardDuty service whose findings you want to unarchive. name: detectorId required: true - description: IDs of the findings that you want to unarchive. name: findingIds description: Unarchives Amazon GuardDuty findings specified by the list of finding IDs. name: aws-gd-unarchive-findings - arguments: - description: The ID of the detector that specifies the GuardDuty service whose findings you want to mark as useful or not useful. name: detectorId required: true - description: IDs of the findings that you want to mark as useful or not useful. name: findingIds - description: Additional feedback about the GuardDuty findings. name: comments - auto: PREDEFINED description: Specify whether the finding was useful or not. name: feedback predefined: - USEFUL - NOT_USEFUL - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Marks specified Amazon GuardDuty findings as useful or not useful. name: aws-gd-update-findings-feedback - arguments: - description: The ID of the detector that specifies the GuardDuty service whose members you want to retrieve. name: detectorId required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration - defaultValue: '50' description: Number of total results to query. name: limit - description: Specific page to query. name: page - defaultValue: '50' description: Number of total results in each page. name: page_size description: Describes Amazon GuardDuty members for the specified detector ID. name: aws-gd-list-members outputs: - contextPath: AWS.GuardDuty.Members.AccountId description: The unique account ID of the member. type: string - contextPath: AWS.GuardDuty.Members.DetectorId description: The unique detector ID of the member. type: string - contextPath: AWS.GuardDuty.Members.MasterId description: The unique detector ID of the master. type: string - contextPath: AWS.GuardDuty.Members.Email description: The email of the member. type: string - contextPath: AWS.GuardDuty.Members.RelationshipStatus description: The relationship status of member. type: string - contextPath: AWS.GuardDuty.Members.InvitedAt description: The first time a member was invited. type: string - contextPath: AWS.GuardDuty.Members.UpdatedAt description: The time a member was last updated. type: string - arguments: - description: The ID of the detector that specifies the GuardDuty service whose members you want to retrieve. name: detectorId required: true - description: The ID of the account that specifies the GuardDuty service whose details you want to retrieve. name: accountIds required: true - description: The AWS Region, if not specified the default region will be used. name: region - description: The Amazon Resource Name (ARN) of the role to assume. name: roleArn - description: An identifier for the assumed role session. name: roleSessionName - description: The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. name: roleSessionDuration description: Describes Amazon GuardDuty members for the specified detector ID & account ID. name: aws-gd-get-members outputs: - contextPath: AWS.GuardDuty.Members.AccountId description: The unique account ID of the member. type: string - contextPath: AWS.GuardDuty.Members.DetectorId description: The unique detector ID of the member. type: string - contextPath: AWS.GuardDuty.Members.MasterId description: The unique detector ID of the master. type: string - contextPath: AWS.GuardDuty.Members.Email description: The email of the member. type: string - contextPath: AWS.GuardDuty.Members.RelationshipStatus description: The relationship status of member. type: string - contextPath: AWS.GuardDuty.Members.InvitedAt description: The first time a member was invited. type: string - contextPath: AWS.GuardDuty.Members.UpdatedAt description: The time a member was last updated. type: string dockerimage: demisto/boto3py3:1.0.0.10221838 isfetch: true runonce: false script: '-' subtype: python3 type: python tests: - No tests fromversion: 5.0.0 defaultmapperin: AWSGuardDuty - Incoming Mapper defaultclassifier: AWSGuardDuty - Classifier