Amazon GuardDuty

2025/11/19 - Amazon GuardDuty - 2 new 3 updated api methods

Changes  Add support for scanning and viewing scan results for backup resource types

ListMalwareScans (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.list_malware_scans(
    MaxResults=123,
    NextToken='string',
    FilterCriteria={
        'ListMalwareScansFilterCriterion': [
            {
                'ListMalwareScansCriterionKey': 'RESOURCE_ARN'|'SCAN_ID'|'ACCOUNT_ID'|'GUARDDUTY_FINDING_ID'|'RESOURCE_TYPE'|'SCAN_START_TIME'|'SCAN_STATUS'|'SCAN_TYPE',
                'FilterCondition': {
                    'EqualsValue': 'string',
                    'GreaterThan': 123,
                    'LessThan': 123
                }
            },
        ]
    },
    SortCriteria={
        'AttributeName': 'string',
        'OrderBy': 'ASC'|'DESC'
    }
)
type MaxResults:

integer

param MaxResults:

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

type NextToken:

string

param NextToken:

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing results.

type FilterCriteria:

dict

param FilterCriteria:

Represents the criteria used to filter the malware scan entries.

  • ListMalwareScansFilterCriterion (list) --

    Represents a condition that when matched will be added to the response of the operation.

    • (dict) --

      Represents a condition that when matched will be added to the response of the operation. Irrespective of using any filter criteria, an administrator account can view the scan entries for all of its member accounts. However, each member account can view the scan entries only for their own account.

      • ListMalwareScansCriterionKey (string) --

        An enum value representing possible scan properties to match with given scan entries.

      • FilterCondition (dict) --

        Contains information about the condition.

        • EqualsValue (string) --

          Represents an equal condition to be applied to a single field when querying for scan entries.

        • GreaterThan (integer) --

          Represents a greater than condition to be applied to a single field when querying for scan entries.

        • LessThan (integer) --

          Represents a less than condition to be applied to a single field when querying for scan entries.

type SortCriteria:

dict

param SortCriteria:

Represents the criteria used for sorting malware scan entries.

  • AttributeName (string) --

    Represents the finding attribute, such as accountId, that sorts the findings.

  • OrderBy (string) --

    The order by which the sorted findings are to be displayed.

rtype:

dict

returns:

Response Syntax

{
    'Scans': [
        {
            'ResourceArn': 'string',
            'ResourceType': 'EBS_RECOVERY_POINT'|'EBS_SNAPSHOT'|'EBS_VOLUME'|'EC2_AMI'|'EC2_INSTANCE'|'EC2_RECOVERY_POINT'|'S3_RECOVERY_POINT'|'S3_BUCKET',
            'ScanId': 'string',
            'ScanStatus': 'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ISSUES'|'FAILED'|'SKIPPED',
            'ScanResultStatus': 'NO_THREATS_FOUND'|'THREATS_FOUND',
            'ScanType': 'BACKUP_INITIATED'|'ON_DEMAND'|'GUARDDUTY_INITIATED',
            'ScanStartedAt': datetime(2015, 1, 1),
            'ScanCompletedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Scans (list) --

      The list of malware scans associated with the provided input parameters.

      • (dict) --

        Contains information about a particular malware scan.

        • ResourceArn (string) --

          Amazon Resource Name (ARN) of the resource for the given malware scan.

        • ResourceType (string) --

          The type of resource that was scanned for malware.

        • ScanId (string) --

          A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

        • ScanStatus (string) --

          An enum value representing the current status of the malware scan.

        • ScanResultStatus (string) --

          An enum value representing the result of the malware scan.

        • ScanType (string) --

          An enum value representing the type of scan that was initiated.

        • ScanStartedAt (datetime) --

          The timestamp representing when the malware scan was started.

        • ScanCompletedAt (datetime) --

          The timestamp representing when the malware scan was completed.

    • NextToken (string) --

      The pagination parameter to be used on the next list operation to retrieve more scans.

GetMalwareScan (new) Link ¶

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 available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

See also: AWS API Documentation

Request Syntax

client.get_malware_scan(
    ScanId='string'
)
type ScanId:

string

param ScanId:

[REQUIRED]

A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

rtype:

dict

returns:

Response Syntax

{
    'ScanId': 'string',
    'DetectorId': 'string',
    'AdminDetectorId': 'string',
    'ResourceArn': 'string',
    'ResourceType': 'EBS_RECOVERY_POINT'|'EBS_SNAPSHOT'|'EBS_VOLUME'|'EC2_AMI'|'EC2_INSTANCE'|'EC2_RECOVERY_POINT'|'S3_RECOVERY_POINT'|'S3_BUCKET',
    'ScannedResourcesCount': 123,
    'SkippedResourcesCount': 123,
    'FailedResourcesCount': 123,
    'ScannedResources': [
        {
            'ScannedResourceArn': 'string',
            'ScannedResourceType': 'EBS_RECOVERY_POINT'|'EBS_SNAPSHOT'|'EBS_VOLUME'|'EC2_AMI'|'EC2_INSTANCE'|'EC2_RECOVERY_POINT'|'S3_RECOVERY_POINT'|'S3_BUCKET',
            'ScannedResourceStatus': 'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ISSUES'|'FAILED'|'SKIPPED',
            'ScanStatusReason': 'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'SNAPSHOT_SIZE_LIMIT_EXCEEDED'|'RESOURCE_UNAVAILABLE'|'INCONSISTENT_SOURCE'|'INCREMENTAL_NO_DIFFERENCE'|'NO_EBS_VOLUMES_FOUND'|'UNSUPPORTED_PRODUCT_CODE_TYPE'|'AMI_SNAPSHOT_LIMIT_EXCEEDED'|'UNRELATED_RESOURCES'|'BASE_RESOURCE_NOT_SCANNED'|'BASE_CREATED_AFTER_TARGET'|'UNSUPPORTED_FOR_INCREMENTAL'|'UNSUPPORTED_AMI'|'UNSUPPORTED_SNAPSHOT'|'UNSUPPORTED_COMPOSITE_RECOVERY_POINT',
            'ResourceDetails': {
                'EbsVolume': {
                    'VolumeArn': 'string',
                    'VolumeType': 'string',
                    'DeviceName': 'string',
                    'VolumeSizeInGB': 123,
                    'EncryptionType': 'string',
                    'SnapshotArn': 'string',
                    'KmsKeyArn': 'string'
                },
                'EbsSnapshot': {
                    'DeviceName': 'string'
                }
            }
        },
    ],
    'ScanConfiguration': {
        'Role': 'string',
        'TriggerDetails': {
            'GuardDutyFindingId': 'string',
            'Description': 'string',
            'TriggerType': 'BACKUP'|'GUARDDUTY'
        },
        'IncrementalScanDetails': {
            'BaselineResourceArn': 'string'
        },
        'RecoveryPoint': {
            'BackupVaultName': 'string'
        }
    },
    'ScanCategory': 'FULL_SCAN'|'INCREMENTAL_SCAN',
    'ScanStatus': 'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ISSUES'|'FAILED'|'SKIPPED',
    'ScanStatusReason': 'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'SNAPSHOT_SIZE_LIMIT_EXCEEDED'|'RESOURCE_UNAVAILABLE'|'INCONSISTENT_SOURCE'|'INCREMENTAL_NO_DIFFERENCE'|'NO_EBS_VOLUMES_FOUND'|'UNSUPPORTED_PRODUCT_CODE_TYPE'|'AMI_SNAPSHOT_LIMIT_EXCEEDED'|'UNRELATED_RESOURCES'|'BASE_RESOURCE_NOT_SCANNED'|'BASE_CREATED_AFTER_TARGET'|'UNSUPPORTED_FOR_INCREMENTAL'|'UNSUPPORTED_AMI'|'UNSUPPORTED_SNAPSHOT'|'UNSUPPORTED_COMPOSITE_RECOVERY_POINT',
    'ScanType': 'BACKUP_INITIATED'|'ON_DEMAND'|'GUARDDUTY_INITIATED',
    'ScanStartedAt': datetime(2015, 1, 1),
    'ScanCompletedAt': datetime(2015, 1, 1),
    'ScanResultDetails': {
        'ScanResultStatus': 'NO_THREATS_FOUND'|'THREATS_FOUND',
        'SkippedFileCount': 123,
        'FailedFileCount': 123,
        'ThreatFoundFileCount': 123,
        'TotalFileCount': 123,
        'TotalBytes': 123,
        'UniqueThreatCount': 123,
        'Threats': [
            {
                'Name': 'string',
                'Source': 'AMAZON'|'BITDEFENDER',
                'Count': 123,
                'Hash': 'string',
                'ItemDetails': [
                    {
                        'ResourceArn': 'string',
                        'ItemPath': 'string',
                        'Hash': 'string',
                        'AdditionalInfo': {
                            'VersionId': 'string',
                            'DeviceName': 'string'
                        }
                    },
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ScanId (string) --

      A unique identifier associated with the malware scan. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

    • DetectorId (string) --

      The unique ID of the detector that is associated with the request, if it belongs to an account which is a GuardDuty customer.

      To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    • AdminDetectorId (string) --

      The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId. If the customer is not a GuardDuty customer, this field will not be present..

      To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    • ResourceArn (string) --

      Amazon Resource Name (ARN) of the resource on which a malware scan was invoked.

    • ResourceType (string) --

      The type of resource that was scanned for malware.

    • ScannedResourcesCount (integer) --

      The total number of resources that were successfully scanned. This is dependent on the resource type.

    • SkippedResourcesCount (integer) --

      The total number of resources that were skipped during the scan.

    • FailedResourcesCount (integer) --

      The total number of resources that failed to be scanned.

    • ScannedResources (list) --

      A list of resources along with their metadata that were scanned as part of the malware scan operation.

      • (dict) --

        Contains information about a resource that was scanned as part of the malware scan operation.

        • ScannedResourceArn (string) --

          Amazon Resource Name (ARN) of the scanned resource.

        • ScannedResourceType (string) --

          The resource type of the scanned resource.

        • ScannedResourceStatus (string) --

          The status of the scanned resource.

        • ScanStatusReason (string) --

          The reason for the scan status of this particular resource, if applicable.

        • ResourceDetails (dict) --

          Information about the scanned resource.

          • EbsVolume (dict) --

            Contains information about the EBS volume that was scanned.

            • VolumeArn (string) --

              EBS volume ARN information.

            • VolumeType (string) --

              The EBS volume type.

            • DeviceName (string) --

              The device name for the EBS volume.

            • VolumeSizeInGB (integer) --

              EBS volume size in GB.

            • EncryptionType (string) --

              EBS volume encryption type.

            • SnapshotArn (string) --

              Snapshot ARN of the EBS volume.

            • KmsKeyArn (string) --

              KMS key ARN used to encrypt the EBS volume.

          • EbsSnapshot (dict) --

            Contains information about the EBS snapshot that was scanned.

            • DeviceName (string) --

              The device name of the EBS snapshot that was scanned.

    • ScanConfiguration (dict) --

      Information about the scan configuration used for the malware scan.

      • Role (string) --

        Amazon Resource Name (ARN) of the IAM role that should contain the required permissions for the scan.

      • TriggerDetails (dict) --

        Information about the entity that triggered the malware scan.

        • GuardDutyFindingId (string) --

          The ID of the GuardDuty finding that triggered the malware scan.

        • Description (string) --

          The description of the scan trigger.

        • TriggerType (string) --

          Specifies the trigger type that started the malware scan.

      • IncrementalScanDetails (dict) --

        Information about the incremental scan configuration, if applicable.

        • BaselineResourceArn (string) --

          Amazon Resource Name (ARN) of the baseline resource used for incremental scanning. The scan will only process changes since this baseline resource was created.

      • RecoveryPoint (dict) --

        Information about the recovery point configuration used for the scan, if applicable.

        • BackupVaultName (string) --

          The name of the Amazon Web Services Backup vault that contains the recovery point for the scanned.

    • ScanCategory (string) --

      The category of the malware scan, indicating the type of scan performed.

    • ScanStatus (string) --

      A value representing the current status of the malware scan.

    • ScanStatusReason (string) --

      Represents the reason for the current scan status, if applicable.

    • ScanType (string) --

      A value representing the initiator of the scan.

    • ScanStartedAt (datetime) --

      The timestamp representing when the malware scan was started.

    • ScanCompletedAt (datetime) --

      The timestamp representing when the malware scan was completed.

    • ScanResultDetails (dict) --

      Detailed information about the results of the malware scan, if the scan completed.

      • ScanResultStatus (string) --

        Status indicating whether threats were found for a completed scan.

      • SkippedFileCount (integer) --

        The total number of files that were skipped during the scan.

      • FailedFileCount (integer) --

        The total number of files that failed to be scanned.

      • ThreatFoundFileCount (integer) --

        The total number of files in which threats were detected.

      • TotalFileCount (integer) --

        The total number of files that were processed during the scan.

      • TotalBytes (integer) --

        The total number of bytes that were scanned.

      • UniqueThreatCount (integer) --

        The total number of unique threats that were detected during the scan.

      • Threats (list) --

        The threats that were detected during the malware scan.

        • (dict) --

          Contains information about a specific threat that was detected during the malware scan.

          • Name (string) --

            The name of the detected threat.

          • Source (string) --

            The source that detected this threat.

          • Count (integer) --

            The number of instances of this threat that were detected.

          • Hash (string) --

            The hash value associated with the detected threat.

          • ItemDetails (list) --

            Additional information about where this threat was detected.

            • (dict) --

              Contains detailed information about where a threat was detected.

              • ResourceArn (string) --

                Amazon Resource Name (ARN) of the resource where the threat was detected.

              • ItemPath (string) --

                The path where the threat was detected.

              • Hash (string) --

                The hash value of the infected item.

              • AdditionalInfo (dict) --

                Additional information about the detected threat item.

                • VersionId (string) --

                  The version ID of the S3 object, if applicable.

                • DeviceName (string) --

                  The device name of the EBS volume, if applicable.

DescribeMalwareScans (updated) Link ¶
Changes (response)
{'Scans': {'TriggerDetails': {'TriggerType': 'BACKUP | GUARDDUTY'}}}

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 where GuardDuty is presently supported. For more information, see Regions and endpoints.

See also: AWS API Documentation

Request Syntax

client.describe_malware_scans(
    DetectorId='string',
    NextToken='string',
    MaxResults=123,
    FilterCriteria={
        'FilterCriterion': [
            {
                'CriterionKey': 'EC2_INSTANCE_ARN'|'SCAN_ID'|'ACCOUNT_ID'|'GUARDDUTY_FINDING_ID'|'SCAN_START_TIME'|'SCAN_STATUS'|'SCAN_TYPE',
                'FilterCondition': {
                    'EqualsValue': 'string',
                    'GreaterThan': 123,
                    'LessThan': 123
                }
            },
        ]
    },
    SortCriteria={
        'AttributeName': 'string',
        'OrderBy': 'ASC'|'DESC'
    }
)
type DetectorId:

string

param DetectorId:

[REQUIRED]

The unique ID of the detector that the request is associated with.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

type NextToken:

string

param NextToken:

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

type MaxResults:

integer

param MaxResults:

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

type FilterCriteria:

dict

param FilterCriteria:

Represents the criteria to be used in the filter for describing scan entries.

  • FilterCriterion (list) --

    Represents a condition that when matched will be added to the response of the operation.

    • (dict) --

      Represents a condition that when matched will be added to the response of the operation. Irrespective of using any filter criteria, an administrator account can view the scan entries for all of its member accounts. However, each member account can view the scan entries only for their own account.

      • CriterionKey (string) --

        An enum value representing possible scan properties to match with given scan entries.

      • FilterCondition (dict) --

        Contains information about the condition.

        • EqualsValue (string) --

          Represents an equal condition to be applied to a single field when querying for scan entries.

        • GreaterThan (integer) --

          Represents a greater than condition to be applied to a single field when querying for scan entries.

        • LessThan (integer) --

          Represents a less than condition to be applied to a single field when querying for scan entries.

type SortCriteria:

dict

param SortCriteria:

Represents the criteria used for sorting scan entries. The attributeName is required and it must be scanStartTime.

  • AttributeName (string) --

    Represents the finding attribute, such as accountId, that sorts the findings.

  • OrderBy (string) --

    The order by which the sorted findings are to be displayed.

rtype:

dict

returns:

Response Syntax

{
    'Scans': [
        {
            'DetectorId': 'string',
            'AdminDetectorId': 'string',
            'ScanId': 'string',
            'ScanStatus': 'RUNNING'|'COMPLETED'|'FAILED'|'SKIPPED',
            'FailureReason': 'string',
            'ScanStartTime': datetime(2015, 1, 1),
            'ScanEndTime': datetime(2015, 1, 1),
            'TriggerDetails': {
                'GuardDutyFindingId': 'string',
                'Description': 'string',
                'TriggerType': 'BACKUP'|'GUARDDUTY'
            },
            'ResourceDetails': {
                'InstanceArn': 'string'
            },
            'ScanResultDetails': {
                'ScanResult': 'CLEAN'|'INFECTED'
            },
            'AccountId': 'string',
            'TotalBytes': 123,
            'FileCount': 123,
            'AttachedVolumes': [
                {
                    'VolumeArn': 'string',
                    'VolumeType': 'string',
                    'DeviceName': 'string',
                    'VolumeSizeInGB': 123,
                    'EncryptionType': 'string',
                    'SnapshotArn': 'string',
                    'KmsKeyArn': 'string'
                },
            ],
            'ScanType': 'GUARDDUTY_INITIATED'|'ON_DEMAND'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Scans (list) --

      Contains information about malware scans associated with GuardDuty Malware Protection for EC2.

      • (dict) --

        Contains information about malware scans associated with GuardDuty Malware Protection for EC2.

        • DetectorId (string) --

          The unique ID of the detector that is associated with the request.

          To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

        • AdminDetectorId (string) --

          The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId.

          To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

        • ScanId (string) --

          The unique scan ID associated with a scan entry.

        • ScanStatus (string) --

          An enum value representing possible scan statuses.

        • FailureReason (string) --

          Represents the reason for FAILED scan status.

        • ScanStartTime (datetime) --

          The timestamp of when the scan was triggered.

        • ScanEndTime (datetime) --

          The timestamp of when the scan was finished.

        • TriggerDetails (dict) --

          Specifies the reason why the scan was initiated.

          • GuardDutyFindingId (string) --

            The ID of the GuardDuty finding that triggered the malware scan.

          • Description (string) --

            The description of the scan trigger.

          • TriggerType (string) --

            Specifies the trigger type that started the malware scan.

        • ResourceDetails (dict) --

          Represents the resources that were scanned in the scan entry.

          • InstanceArn (string) --

            Instance ARN that was scanned in the scan entry.

        • ScanResultDetails (dict) --

          Represents the result of the scan.

          • ScanResult (string) --

            An enum value representing possible scan results.

        • AccountId (string) --

          The ID for the account that belongs to the scan.

        • TotalBytes (integer) --

          Represents total bytes that were scanned.

        • FileCount (integer) --

          Represents the number of files that were scanned.

        • AttachedVolumes (list) --

          List of volumes that were attached to the original instance to be scanned.

          • (dict) --

            Contains EBS volume details.

            • VolumeArn (string) --

              EBS volume ARN information.

            • VolumeType (string) --

              The EBS volume type.

            • DeviceName (string) --

              The device name for the EBS volume.

            • VolumeSizeInGB (integer) --

              EBS volume size in GB.

            • EncryptionType (string) --

              EBS volume encryption type.

            • SnapshotArn (string) --

              Snapshot ARN of the EBS volume.

            • KmsKeyArn (string) --

              KMS key ARN used to encrypt the EBS volume.

        • ScanType (string) --

          Specifies the scan type that invoked the malware scan.

    • NextToken (string) --

      The pagination parameter to be used on the next list operation to retrieve more items.

GetFindings (updated) Link ¶
Changes (response)
{'Findings': {'Resource': {'EbsSnapshotDetails': {'SnapshotArn': 'string'},
                           'Ec2ImageDetails': {'ImageArn': 'string'},
                           'RecoveryPointDetails': {'BackupVaultName': 'string',
                                                    'RecoveryPointArn': 'string'}},
              'Service': {'MalwareScanDetails': {'ScanCategory': 'FULL_SCAN | '
                                                                 'INCREMENTAL_SCAN',
                                                 'ScanConfiguration': {'IncrementalScanDetails': {'BaselineResourceArn': 'string'},
                                                                       'TriggerType': 'BACKUP '
                                                                                      '| '
                                                                                      'GUARDDUTY'},
                                                 'ScanId': 'string',
                                                 'ScanType': 'BACKUP_INITIATED '
                                                             '| ON_DEMAND | '
                                                             'GUARDDUTY_INITIATED',
                                                 'Threats': {'Count': 'long',
                                                             'Hash': 'string',
                                                             'ItemDetails': [{'AdditionalInfo': {'DeviceName': 'string',
                                                                                                 'VersionId': 'string'},
                                                                              'Hash': 'string',
                                                                              'ItemPath': 'string',
                                                                              'ResourceArn': 'string'}]},
                                                 'UniqueThreatCount': 'integer'}}}}

Describes Amazon GuardDuty findings specified by finding IDs.

See also: AWS API Documentation

Request Syntax

client.get_findings(
    DetectorId='string',
    FindingIds=[
        'string',
    ],
    SortCriteria={
        'AttributeName': 'string',
        'OrderBy': 'ASC'|'DESC'
    }
)
type DetectorId:

string

param DetectorId:

[REQUIRED]

The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

type FindingIds:

list

param FindingIds:

[REQUIRED]

The IDs of the findings that you want to retrieve.

  • (string) --

type SortCriteria:

dict

param SortCriteria:

Represents the criteria used for sorting findings.

  • AttributeName (string) --

    Represents the finding attribute, such as accountId, that sorts the findings.

  • OrderBy (string) --

    The order by which the sorted findings are to be displayed.

rtype:

dict

returns:

Response Syntax

{
    'Findings': [
        {
            'AccountId': 'string',
            'Arn': 'string',
            'Confidence': 123.0,
            'CreatedAt': 'string',
            'Description': 'string',
            'Id': 'string',
            'Partition': 'string',
            'Region': 'string',
            'Resource': {
                'AccessKeyDetails': {
                    'AccessKeyId': 'string',
                    'PrincipalId': 'string',
                    'UserName': 'string',
                    'UserType': 'string'
                },
                'S3BucketDetails': [
                    {
                        'Arn': 'string',
                        'Name': 'string',
                        'Type': 'string',
                        'CreatedAt': datetime(2015, 1, 1),
                        'Owner': {
                            'Id': 'string'
                        },
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ],
                        'DefaultServerSideEncryption': {
                            'EncryptionType': 'string',
                            'KmsMasterKeyArn': 'string'
                        },
                        'PublicAccess': {
                            'PermissionConfiguration': {
                                'BucketLevelPermissions': {
                                    'AccessControlList': {
                                        'AllowsPublicReadAccess': True|False,
                                        'AllowsPublicWriteAccess': True|False
                                    },
                                    'BucketPolicy': {
                                        'AllowsPublicReadAccess': True|False,
                                        'AllowsPublicWriteAccess': True|False
                                    },
                                    'BlockPublicAccess': {
                                        'IgnorePublicAcls': True|False,
                                        'RestrictPublicBuckets': True|False,
                                        'BlockPublicAcls': True|False,
                                        'BlockPublicPolicy': True|False
                                    }
                                },
                                'AccountLevelPermissions': {
                                    'BlockPublicAccess': {
                                        'IgnorePublicAcls': True|False,
                                        'RestrictPublicBuckets': True|False,
                                        'BlockPublicAcls': True|False,
                                        'BlockPublicPolicy': True|False
                                    }
                                }
                            },
                            'EffectivePermission': 'string'
                        },
                        'S3ObjectDetails': [
                            {
                                'ObjectArn': 'string',
                                'Key': 'string',
                                'ETag': 'string',
                                'Hash': 'string',
                                'VersionId': 'string'
                            },
                        ]
                    },
                ],
                'InstanceDetails': {
                    'AvailabilityZone': 'string',
                    'IamInstanceProfile': {
                        'Arn': 'string',
                        'Id': 'string'
                    },
                    'ImageDescription': 'string',
                    'ImageId': 'string',
                    'InstanceId': 'string',
                    'InstanceState': 'string',
                    'InstanceType': 'string',
                    'OutpostArn': 'string',
                    'LaunchTime': 'string',
                    'NetworkInterfaces': [
                        {
                            'Ipv6Addresses': [
                                'string',
                            ],
                            'NetworkInterfaceId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddresses': [
                                {
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'PublicDnsName': 'string',
                            'PublicIp': 'string',
                            'SecurityGroups': [
                                {
                                    'GroupId': 'string',
                                    'GroupName': 'string'
                                },
                            ],
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'Platform': 'string',
                    'ProductCodes': [
                        {
                            'Code': 'string',
                            'ProductType': 'string'
                        },
                    ],
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
                'EksClusterDetails': {
                    'Name': 'string',
                    'Arn': 'string',
                    'VpcId': 'string',
                    'Status': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'CreatedAt': datetime(2015, 1, 1)
                },
                'KubernetesDetails': {
                    'KubernetesUserDetails': {
                        'Username': 'string',
                        'Uid': 'string',
                        'Groups': [
                            'string',
                        ],
                        'SessionName': [
                            'string',
                        ],
                        'ImpersonatedUser': {
                            'Username': 'string',
                            'Groups': [
                                'string',
                            ]
                        }
                    },
                    'KubernetesWorkloadDetails': {
                        'Name': 'string',
                        'Type': 'string',
                        'Uid': 'string',
                        'Namespace': 'string',
                        'HostNetwork': True|False,
                        'Containers': [
                            {
                                'ContainerRuntime': 'string',
                                'Id': 'string',
                                'Name': 'string',
                                'Image': 'string',
                                'ImagePrefix': 'string',
                                'VolumeMounts': [
                                    {
                                        'Name': 'string',
                                        'MountPath': 'string'
                                    },
                                ],
                                'SecurityContext': {
                                    'Privileged': True|False,
                                    'AllowPrivilegeEscalation': True|False
                                }
                            },
                        ],
                        'Volumes': [
                            {
                                'Name': 'string',
                                'HostPath': {
                                    'Path': 'string'
                                }
                            },
                        ],
                        'ServiceAccountName': 'string',
                        'HostIPC': True|False,
                        'HostPID': True|False
                    }
                },
                'ResourceType': 'string',
                'EbsVolumeDetails': {
                    'ScannedVolumeDetails': [
                        {
                            'VolumeArn': 'string',
                            'VolumeType': 'string',
                            'DeviceName': 'string',
                            'VolumeSizeInGB': 123,
                            'EncryptionType': 'string',
                            'SnapshotArn': 'string',
                            'KmsKeyArn': 'string'
                        },
                    ],
                    'SkippedVolumeDetails': [
                        {
                            'VolumeArn': 'string',
                            'VolumeType': 'string',
                            'DeviceName': 'string',
                            'VolumeSizeInGB': 123,
                            'EncryptionType': 'string',
                            'SnapshotArn': 'string',
                            'KmsKeyArn': 'string'
                        },
                    ]
                },
                'EcsClusterDetails': {
                    'Name': 'string',
                    'Arn': 'string',
                    'Status': 'string',
                    'ActiveServicesCount': 123,
                    'RegisteredContainerInstancesCount': 123,
                    'RunningTasksCount': 123,
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'TaskDetails': {
                        'Arn': 'string',
                        'DefinitionArn': 'string',
                        'Version': 'string',
                        'TaskCreatedAt': datetime(2015, 1, 1),
                        'StartedAt': datetime(2015, 1, 1),
                        'StartedBy': 'string',
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ],
                        'Volumes': [
                            {
                                'Name': 'string',
                                'HostPath': {
                                    'Path': 'string'
                                }
                            },
                        ],
                        'Containers': [
                            {
                                'ContainerRuntime': 'string',
                                'Id': 'string',
                                'Name': 'string',
                                'Image': 'string',
                                'ImagePrefix': 'string',
                                'VolumeMounts': [
                                    {
                                        'Name': 'string',
                                        'MountPath': 'string'
                                    },
                                ],
                                'SecurityContext': {
                                    'Privileged': True|False,
                                    'AllowPrivilegeEscalation': True|False
                                }
                            },
                        ],
                        'Group': 'string',
                        'LaunchType': 'string'
                    }
                },
                'ContainerDetails': {
                    'ContainerRuntime': 'string',
                    'Id': 'string',
                    'Name': 'string',
                    'Image': 'string',
                    'ImagePrefix': 'string',
                    'VolumeMounts': [
                        {
                            'Name': 'string',
                            'MountPath': 'string'
                        },
                    ],
                    'SecurityContext': {
                        'Privileged': True|False,
                        'AllowPrivilegeEscalation': True|False
                    }
                },
                'RdsDbInstanceDetails': {
                    'DbInstanceIdentifier': 'string',
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'DbClusterIdentifier': 'string',
                    'DbInstanceArn': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
                'RdsLimitlessDbDetails': {
                    'DbShardGroupIdentifier': 'string',
                    'DbShardGroupResourceId': 'string',
                    'DbShardGroupArn': 'string',
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'DbClusterIdentifier': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
                'RdsDbUserDetails': {
                    'User': 'string',
                    'Application': 'string',
                    'Database': 'string',
                    'Ssl': 'string',
                    'AuthMethod': 'string'
                },
                'LambdaDetails': {
                    'FunctionArn': 'string',
                    'FunctionName': 'string',
                    'Description': 'string',
                    'LastModifiedAt': datetime(2015, 1, 1),
                    'RevisionId': 'string',
                    'FunctionVersion': 'string',
                    'Role': 'string',
                    'VpcConfig': {
                        'SubnetIds': [
                            'string',
                        ],
                        'VpcId': 'string',
                        'SecurityGroups': [
                            {
                                'GroupId': 'string',
                                'GroupName': 'string'
                            },
                        ]
                    },
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
                'EbsSnapshotDetails': {
                    'SnapshotArn': 'string'
                },
                'Ec2ImageDetails': {
                    'ImageArn': 'string'
                },
                'RecoveryPointDetails': {
                    'RecoveryPointArn': 'string',
                    'BackupVaultName': 'string'
                }
            },
            'SchemaVersion': 'string',
            'Service': {
                'Action': {
                    'ActionType': 'string',
                    'AwsApiCallAction': {
                        'Api': 'string',
                        'CallerType': 'string',
                        'DomainDetails': {
                            'Domain': 'string'
                        },
                        'ErrorCode': 'string',
                        'UserAgent': 'string',
                        'RemoteIpDetails': {
                            'City': {
                                'CityName': 'string'
                            },
                            'Country': {
                                'CountryCode': 'string',
                                'CountryName': 'string'
                            },
                            'GeoLocation': {
                                'Lat': 123.0,
                                'Lon': 123.0
                            },
                            'IpAddressV4': 'string',
                            'IpAddressV6': 'string',
                            'Organization': {
                                'Asn': 'string',
                                'AsnOrg': 'string',
                                'Isp': 'string',
                                'Org': 'string'
                            }
                        },
                        'ServiceName': 'string',
                        'RemoteAccountDetails': {
                            'AccountId': 'string',
                            'Affiliated': True|False
                        },
                        'AffectedResources': {
                            'string': 'string'
                        }
                    },
                    'DnsRequestAction': {
                        'Domain': 'string',
                        'Protocol': 'string',
                        'Blocked': True|False,
                        'DomainWithSuffix': 'string',
                        'VpcOwnerAccountId': 'string'
                    },
                    'NetworkConnectionAction': {
                        'Blocked': True|False,
                        'ConnectionDirection': 'string',
                        'LocalPortDetails': {
                            'Port': 123,
                            'PortName': 'string'
                        },
                        'Protocol': 'string',
                        'LocalIpDetails': {
                            'IpAddressV4': 'string',
                            'IpAddressV6': 'string'
                        },
                        'LocalNetworkInterface': 'string',
                        'RemoteIpDetails': {
                            'City': {
                                'CityName': 'string'
                            },
                            'Country': {
                                'CountryCode': 'string',
                                'CountryName': 'string'
                            },
                            'GeoLocation': {
                                'Lat': 123.0,
                                'Lon': 123.0
                            },
                            'IpAddressV4': 'string',
                            'IpAddressV6': 'string',
                            'Organization': {
                                'Asn': 'string',
                                'AsnOrg': 'string',
                                'Isp': 'string',
                                'Org': 'string'
                            }
                        },
                        'RemotePortDetails': {
                            'Port': 123,
                            'PortName': 'string'
                        }
                    },
                    'PortProbeAction': {
                        'Blocked': True|False,
                        'PortProbeDetails': [
                            {
                                'LocalPortDetails': {
                                    'Port': 123,
                                    'PortName': 'string'
                                },
                                'LocalIpDetails': {
                                    'IpAddressV4': 'string',
                                    'IpAddressV6': 'string'
                                },
                                'RemoteIpDetails': {
                                    'City': {
                                        'CityName': 'string'
                                    },
                                    'Country': {
                                        'CountryCode': 'string',
                                        'CountryName': 'string'
                                    },
                                    'GeoLocation': {
                                        'Lat': 123.0,
                                        'Lon': 123.0
                                    },
                                    'IpAddressV4': 'string',
                                    'IpAddressV6': 'string',
                                    'Organization': {
                                        'Asn': 'string',
                                        'AsnOrg': 'string',
                                        'Isp': 'string',
                                        'Org': 'string'
                                    }
                                }
                            },
                        ]
                    },
                    'KubernetesApiCallAction': {
                        'RequestUri': 'string',
                        'Verb': 'string',
                        'SourceIps': [
                            'string',
                        ],
                        'UserAgent': 'string',
                        'RemoteIpDetails': {
                            'City': {
                                'CityName': 'string'
                            },
                            'Country': {
                                'CountryCode': 'string',
                                'CountryName': 'string'
                            },
                            'GeoLocation': {
                                'Lat': 123.0,
                                'Lon': 123.0
                            },
                            'IpAddressV4': 'string',
                            'IpAddressV6': 'string',
                            'Organization': {
                                'Asn': 'string',
                                'AsnOrg': 'string',
                                'Isp': 'string',
                                'Org': 'string'
                            }
                        },
                        'StatusCode': 123,
                        'Parameters': 'string',
                        'Resource': 'string',
                        'Subresource': 'string',
                        'Namespace': 'string',
                        'ResourceName': 'string'
                    },
                    'RdsLoginAttemptAction': {
                        'RemoteIpDetails': {
                            'City': {
                                'CityName': 'string'
                            },
                            'Country': {
                                'CountryCode': 'string',
                                'CountryName': 'string'
                            },
                            'GeoLocation': {
                                'Lat': 123.0,
                                'Lon': 123.0
                            },
                            'IpAddressV4': 'string',
                            'IpAddressV6': 'string',
                            'Organization': {
                                'Asn': 'string',
                                'AsnOrg': 'string',
                                'Isp': 'string',
                                'Org': 'string'
                            }
                        },
                        'LoginAttributes': [
                            {
                                'User': 'string',
                                'Application': 'string',
                                'FailedLoginAttempts': 123,
                                'SuccessfulLoginAttempts': 123
                            },
                        ]
                    },
                    'KubernetesPermissionCheckedDetails': {
                        'Verb': 'string',
                        'Resource': 'string',
                        'Namespace': 'string',
                        'Allowed': True|False
                    },
                    'KubernetesRoleBindingDetails': {
                        'Kind': 'string',
                        'Name': 'string',
                        'Uid': 'string',
                        'RoleRefName': 'string',
                        'RoleRefKind': 'string'
                    },
                    'KubernetesRoleDetails': {
                        'Kind': 'string',
                        'Name': 'string',
                        'Uid': 'string'
                    }
                },
                'Evidence': {
                    'ThreatIntelligenceDetails': [
                        {
                            'ThreatListName': 'string',
                            'ThreatNames': [
                                'string',
                            ],
                            'ThreatFileSha256': 'string'
                        },
                    ]
                },
                'Archived': True|False,
                'Count': 123,
                'DetectorId': 'string',
                'EventFirstSeen': 'string',
                'EventLastSeen': 'string',
                'ResourceRole': 'string',
                'ServiceName': 'string',
                'UserFeedback': 'string',
                'AdditionalInfo': {
                    'Value': 'string',
                    'Type': 'string'
                },
                'FeatureName': 'string',
                'EbsVolumeScanDetails': {
                    'ScanId': 'string',
                    'ScanStartedAt': datetime(2015, 1, 1),
                    'ScanCompletedAt': datetime(2015, 1, 1),
                    'TriggerFindingId': 'string',
                    'Sources': [
                        'string',
                    ],
                    'ScanDetections': {
                        'ScannedItemCount': {
                            'TotalGb': 123,
                            'Files': 123,
                            'Volumes': 123
                        },
                        'ThreatsDetectedItemCount': {
                            'Files': 123
                        },
                        'HighestSeverityThreatDetails': {
                            'Severity': 'string',
                            'ThreatName': 'string',
                            'Count': 123
                        },
                        'ThreatDetectedByName': {
                            'ItemCount': 123,
                            'UniqueThreatNameCount': 123,
                            'Shortened': True|False,
                            'ThreatNames': [
                                {
                                    'Name': 'string',
                                    'Severity': 'string',
                                    'ItemCount': 123,
                                    'FilePaths': [
                                        {
                                            'FilePath': 'string',
                                            'VolumeArn': 'string',
                                            'Hash': 'string',
                                            'FileName': 'string'
                                        },
                                    ]
                                },
                            ]
                        }
                    },
                    'ScanType': 'GUARDDUTY_INITIATED'|'ON_DEMAND'
                },
                'RuntimeDetails': {
                    'Process': {
                        'Name': 'string',
                        'ExecutablePath': 'string',
                        'ExecutableSha256': 'string',
                        'NamespacePid': 123,
                        'Pwd': 'string',
                        'Pid': 123,
                        'StartTime': datetime(2015, 1, 1),
                        'Uuid': 'string',
                        'ParentUuid': 'string',
                        'User': 'string',
                        'UserId': 123,
                        'Euid': 123,
                        'Lineage': [
                            {
                                'StartTime': datetime(2015, 1, 1),
                                'NamespacePid': 123,
                                'UserId': 123,
                                'Name': 'string',
                                'Pid': 123,
                                'Uuid': 'string',
                                'ExecutablePath': 'string',
                                'Euid': 123,
                                'ParentUuid': 'string'
                            },
                        ]
                    },
                    'Context': {
                        'ModifyingProcess': {
                            'Name': 'string',
                            'ExecutablePath': 'string',
                            'ExecutableSha256': 'string',
                            'NamespacePid': 123,
                            'Pwd': 'string',
                            'Pid': 123,
                            'StartTime': datetime(2015, 1, 1),
                            'Uuid': 'string',
                            'ParentUuid': 'string',
                            'User': 'string',
                            'UserId': 123,
                            'Euid': 123,
                            'Lineage': [
                                {
                                    'StartTime': datetime(2015, 1, 1),
                                    'NamespacePid': 123,
                                    'UserId': 123,
                                    'Name': 'string',
                                    'Pid': 123,
                                    'Uuid': 'string',
                                    'ExecutablePath': 'string',
                                    'Euid': 123,
                                    'ParentUuid': 'string'
                                },
                            ]
                        },
                        'ModifiedAt': datetime(2015, 1, 1),
                        'ScriptPath': 'string',
                        'LibraryPath': 'string',
                        'LdPreloadValue': 'string',
                        'SocketPath': 'string',
                        'RuncBinaryPath': 'string',
                        'ReleaseAgentPath': 'string',
                        'MountSource': 'string',
                        'MountTarget': 'string',
                        'FileSystemType': 'string',
                        'Flags': [
                            'string',
                        ],
                        'ModuleName': 'string',
                        'ModuleFilePath': 'string',
                        'ModuleSha256': 'string',
                        'ShellHistoryFilePath': 'string',
                        'TargetProcess': {
                            'Name': 'string',
                            'ExecutablePath': 'string',
                            'ExecutableSha256': 'string',
                            'NamespacePid': 123,
                            'Pwd': 'string',
                            'Pid': 123,
                            'StartTime': datetime(2015, 1, 1),
                            'Uuid': 'string',
                            'ParentUuid': 'string',
                            'User': 'string',
                            'UserId': 123,
                            'Euid': 123,
                            'Lineage': [
                                {
                                    'StartTime': datetime(2015, 1, 1),
                                    'NamespacePid': 123,
                                    'UserId': 123,
                                    'Name': 'string',
                                    'Pid': 123,
                                    'Uuid': 'string',
                                    'ExecutablePath': 'string',
                                    'Euid': 123,
                                    'ParentUuid': 'string'
                                },
                            ]
                        },
                        'AddressFamily': 'string',
                        'IanaProtocolNumber': 123,
                        'MemoryRegions': [
                            'string',
                        ],
                        'ToolName': 'string',
                        'ToolCategory': 'string',
                        'ServiceName': 'string',
                        'CommandLineExample': 'string',
                        'ThreatFilePath': 'string'
                    }
                },
                'Detection': {
                    'Anomaly': {
                        'Profiles': {
                            'string': {
                                'string': [
                                    {
                                        'ProfileType': 'FREQUENCY',
                                        'ProfileSubtype': 'FREQUENT'|'INFREQUENT'|'UNSEEN'|'RARE',
                                        'Observations': {
                                            'Text': [
                                                'string',
                                            ]
                                        }
                                    },
                                ]
                            }
                        },
                        'Unusual': {
                            'Behavior': {
                                'string': {
                                    'string': {
                                        'ProfileType': 'FREQUENCY',
                                        'ProfileSubtype': 'FREQUENT'|'INFREQUENT'|'UNSEEN'|'RARE',
                                        'Observations': {
                                            'Text': [
                                                'string',
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    'Sequence': {
                        'Uid': 'string',
                        'Description': 'string',
                        'Actors': [
                            {
                                'Id': 'string',
                                'User': {
                                    'Name': 'string',
                                    'Uid': 'string',
                                    'Type': 'string',
                                    'CredentialUid': 'string',
                                    'Account': {
                                        'Uid': 'string',
                                        'Name': 'string'
                                    }
                                },
                                'Session': {
                                    'Uid': 'string',
                                    'MfaStatus': 'ENABLED'|'DISABLED',
                                    'CreatedTime': datetime(2015, 1, 1),
                                    'Issuer': 'string'
                                },
                                'Process': {
                                    'Name': 'string',
                                    'Path': 'string',
                                    'Sha256': 'string'
                                }
                            },
                        ],
                        'Resources': [
                            {
                                'Uid': 'string',
                                'Name': 'string',
                                'AccountId': 'string',
                                'ResourceType': 'EC2_INSTANCE'|'EC2_NETWORK_INTERFACE'|'S3_BUCKET'|'S3_OBJECT'|'ACCESS_KEY'|'EKS_CLUSTER'|'KUBERNETES_WORKLOAD'|'CONTAINER',
                                'Region': 'string',
                                'Service': 'string',
                                'CloudPartition': 'string',
                                'Tags': [
                                    {
                                        'Key': 'string',
                                        'Value': 'string'
                                    },
                                ],
                                'Data': {
                                    'S3Bucket': {
                                        'OwnerId': 'string',
                                        'CreatedAt': datetime(2015, 1, 1),
                                        'EncryptionType': 'string',
                                        'EncryptionKeyArn': 'string',
                                        'EffectivePermission': 'string',
                                        'PublicReadAccess': 'BLOCKED'|'ALLOWED',
                                        'PublicWriteAccess': 'BLOCKED'|'ALLOWED',
                                        'AccountPublicAccess': {
                                            'PublicAclAccess': 'BLOCKED'|'ALLOWED',
                                            'PublicPolicyAccess': 'BLOCKED'|'ALLOWED',
                                            'PublicAclIgnoreBehavior': 'IGNORED'|'NOT_IGNORED',
                                            'PublicBucketRestrictBehavior': 'RESTRICTED'|'NOT_RESTRICTED'
                                        },
                                        'BucketPublicAccess': {
                                            'PublicAclAccess': 'BLOCKED'|'ALLOWED',
                                            'PublicPolicyAccess': 'BLOCKED'|'ALLOWED',
                                            'PublicAclIgnoreBehavior': 'IGNORED'|'NOT_IGNORED',
                                            'PublicBucketRestrictBehavior': 'RESTRICTED'|'NOT_RESTRICTED'
                                        },
                                        'S3ObjectUids': [
                                            'string',
                                        ]
                                    },
                                    'Ec2Instance': {
                                        'AvailabilityZone': 'string',
                                        'ImageDescription': 'string',
                                        'InstanceState': 'string',
                                        'IamInstanceProfile': {
                                            'Arn': 'string',
                                            'Id': 'string'
                                        },
                                        'InstanceType': 'string',
                                        'OutpostArn': 'string',
                                        'Platform': 'string',
                                        'ProductCodes': [
                                            {
                                                'Code': 'string',
                                                'ProductType': 'string'
                                            },
                                        ],
                                        'Ec2NetworkInterfaceUids': [
                                            'string',
                                        ]
                                    },
                                    'AccessKey': {
                                        'PrincipalId': 'string',
                                        'UserName': 'string',
                                        'UserType': 'string'
                                    },
                                    'Ec2NetworkInterface': {
                                        'Ipv6Addresses': [
                                            'string',
                                        ],
                                        'PrivateIpAddresses': [
                                            {
                                                'PrivateDnsName': 'string',
                                                'PrivateIpAddress': 'string'
                                            },
                                        ],
                                        'PublicIp': 'string',
                                        'SecurityGroups': [
                                            {
                                                'GroupId': 'string',
                                                'GroupName': 'string'
                                            },
                                        ],
                                        'SubNetId': 'string',
                                        'VpcId': 'string'
                                    },
                                    'S3Object': {
                                        'ETag': 'string',
                                        'Key': 'string',
                                        'VersionId': 'string'
                                    },
                                    'EksCluster': {
                                        'Arn': 'string',
                                        'CreatedAt': datetime(2015, 1, 1),
                                        'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'PENDING',
                                        'VpcId': 'string',
                                        'Ec2InstanceUids': [
                                            'string',
                                        ]
                                    },
                                    'KubernetesWorkload': {
                                        'ContainerUids': [
                                            'string',
                                        ],
                                        'Namespace': 'string',
                                        'KubernetesResourcesTypes': 'PODS'|'JOBS'|'CRONJOBS'|'DEPLOYMENTS'|'DAEMONSETS'|'STATEFULSETS'|'REPLICASETS'|'REPLICATIONCONTROLLERS'
                                    },
                                    'Container': {
                                        'Image': 'string',
                                        'ImageUid': 'string'
                                    }
                                }
                            },
                        ],
                        'Endpoints': [
                            {
                                'Id': 'string',
                                'Ip': 'string',
                                'Domain': 'string',
                                'Port': 123,
                                'Location': {
                                    'City': 'string',
                                    'Country': 'string',
                                    'Latitude': 123.0,
                                    'Longitude': 123.0
                                },
                                'AutonomousSystem': {
                                    'Name': 'string',
                                    'Number': 123
                                },
                                'Connection': {
                                    'Direction': 'INBOUND'|'OUTBOUND'
                                }
                            },
                        ],
                        'Signals': [
                            {
                                'Uid': 'string',
                                'Type': 'FINDING'|'CLOUD_TRAIL'|'S3_DATA_EVENTS'|'EKS_AUDIT_LOGS'|'FLOW_LOGS'|'DNS_LOGS'|'RUNTIME_MONITORING',
                                'Description': 'string',
                                'Name': 'string',
                                'CreatedAt': datetime(2015, 1, 1),
                                'UpdatedAt': datetime(2015, 1, 1),
                                'FirstSeenAt': datetime(2015, 1, 1),
                                'LastSeenAt': datetime(2015, 1, 1),
                                'Severity': 123.0,
                                'Count': 123,
                                'ResourceUids': [
                                    'string',
                                ],
                                'ActorIds': [
                                    'string',
                                ],
                                'EndpointIds': [
                                    'string',
                                ],
                                'SignalIndicators': [
                                    {
                                        'Key': 'SUSPICIOUS_USER_AGENT'|'SUSPICIOUS_NETWORK'|'MALICIOUS_IP'|'TOR_IP'|'ATTACK_TACTIC'|'HIGH_RISK_API'|'ATTACK_TECHNIQUE'|'UNUSUAL_API_FOR_ACCOUNT'|'UNUSUAL_ASN_FOR_ACCOUNT'|'UNUSUAL_ASN_FOR_USER'|'SUSPICIOUS_PROCESS'|'MALICIOUS_DOMAIN'|'MALICIOUS_PROCESS'|'CRYPTOMINING_IP'|'CRYPTOMINING_DOMAIN'|'CRYPTOMINING_PROCESS',
                                        'Values': [
                                            'string',
                                        ],
                                        'Title': 'string'
                                    },
                                ]
                            },
                        ],
                        'SequenceIndicators': [
                            {
                                'Key': 'SUSPICIOUS_USER_AGENT'|'SUSPICIOUS_NETWORK'|'MALICIOUS_IP'|'TOR_IP'|'ATTACK_TACTIC'|'HIGH_RISK_API'|'ATTACK_TECHNIQUE'|'UNUSUAL_API_FOR_ACCOUNT'|'UNUSUAL_ASN_FOR_ACCOUNT'|'UNUSUAL_ASN_FOR_USER'|'SUSPICIOUS_PROCESS'|'MALICIOUS_DOMAIN'|'MALICIOUS_PROCESS'|'CRYPTOMINING_IP'|'CRYPTOMINING_DOMAIN'|'CRYPTOMINING_PROCESS',
                                'Values': [
                                    'string',
                                ],
                                'Title': 'string'
                            },
                        ],
                        'AdditionalSequenceTypes': [
                            'string',
                        ]
                    }
                },
                'MalwareScanDetails': {
                    'Threats': [
                        {
                            'Name': 'string',
                            'Source': 'string',
                            'ItemPaths': [
                                {
                                    'NestedItemPath': 'string',
                                    'Hash': 'string'
                                },
                            ],
                            'Count': 123,
                            'Hash': 'string',
                            'ItemDetails': [
                                {
                                    'ResourceArn': 'string',
                                    'ItemPath': 'string',
                                    'Hash': 'string',
                                    'AdditionalInfo': {
                                        'VersionId': 'string',
                                        'DeviceName': 'string'
                                    }
                                },
                            ]
                        },
                    ],
                    'ScanId': 'string',
                    'ScanType': 'BACKUP_INITIATED'|'ON_DEMAND'|'GUARDDUTY_INITIATED',
                    'ScanCategory': 'FULL_SCAN'|'INCREMENTAL_SCAN',
                    'ScanConfiguration': {
                        'TriggerType': 'BACKUP'|'GUARDDUTY',
                        'IncrementalScanDetails': {
                            'BaselineResourceArn': 'string'
                        }
                    },
                    'UniqueThreatCount': 123
                }
            },
            'Severity': 123.0,
            'Title': 'string',
            'Type': 'string',
            'UpdatedAt': 'string',
            'AssociatedAttackSequenceArn': 'string'
        },
    ]
}


**Response Structure**
::

    # This section is too large to render.
    # Please see the AWS API Documentation linked below.

`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/GetFindings>`_
StartMalwareScan (updated) Link ¶
Changes (request)
{'ClientToken': 'string',
 'ScanConfiguration': {'IncrementalScanDetails': {'BaselineResourceArn': 'string'},
                       'RecoveryPoint': {'BackupVaultName': 'string'},
                       'Role': 'string'}}

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 ListMalwareScans and GetMalwareScan.

When you use this API, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.

See also: AWS API Documentation

Request Syntax

client.start_malware_scan(
    ResourceArn='string',
    ClientToken='string',
    ScanConfiguration={
        'Role': 'string',
        'IncrementalScanDetails': {
            'BaselineResourceArn': 'string'
        },
        'RecoveryPoint': {
            'BackupVaultName': 'string'
        }
    }
)
type ResourceArn:

string

param ResourceArn:

[REQUIRED]

Amazon Resource Name (ARN) of the resource for which you invoked the API.

type ClientToken:

string

param ClientToken:

The idempotency token for the create request.

This field is autopopulated if not provided.

type ScanConfiguration:

dict

param ScanConfiguration:

Contains information about the configuration to be used for the malware scan.

  • Role (string) -- [REQUIRED]

    Amazon Resource Name (ARN) of the IAM role that is used for scanning the resource.

  • IncrementalScanDetails (dict) --

    Contains information about the incremental scan configuration. When specified, the scan will only process changes since the baseline resource.

    • BaselineResourceArn (string) -- [REQUIRED]

      Amazon Resource Name (ARN) of the baseline resource used for incremental scanning. The scan will only process changes since this baseline resource was created.

  • RecoveryPoint (dict) --

    Contains information about the recovery point configuration for the requested scan.

    • BackupVaultName (string) -- [REQUIRED]

      The name of the Amazon Web Services Backup vault that contains the name of the recovery point to be scanned.

rtype:

dict

returns:

Response Syntax

{
    'ScanId': 'string'
}

Response Structure

  • (dict) --

    • ScanId (string) --

      A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.