Skip to content

GuardDutyClient#

Index > GuardDuty > GuardDutyClient

Auto-generated documentation for GuardDuty type annotations stubs module types-boto3-guardduty.

GuardDutyClient#

Type annotations and code completion for boto3.client("guardduty"). boto3 documentation

# GuardDutyClient usage example

from boto3.session import Session
from types_boto3_guardduty.client import GuardDutyClient

def get_guardduty_client() -> GuardDutyClient:
    return Session().client("guardduty")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("guardduty").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("guardduty")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_guardduty.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("guardduty").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("guardduty").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

accept_administrator_invitation#

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

Type annotations and code completion for boto3.client("guardduty").accept_administrator_invitation method. boto3 documentation

# accept_administrator_invitation method definition

def accept_administrator_invitation(
    self,
    *,
    DetectorId: str,
    AdministratorId: str,
    InvitationId: str,
) -> dict[str, Any]:
    ...
# accept_administrator_invitation method usage example with argument unpacking

kwargs: AcceptAdministratorInvitationRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "AdministratorId": ...,
    "InvitationId": ...,
}

parent.accept_administrator_invitation(**kwargs)
  1. See AcceptAdministratorInvitationRequestRequestTypeDef

accept_invitation#

Accepts the invitation to be monitored by a GuardDuty administrator account.

Type annotations and code completion for boto3.client("guardduty").accept_invitation method. boto3 documentation

# accept_invitation method definition

def accept_invitation(
    self,
    *,
    DetectorId: str,
    MasterId: str,
    InvitationId: str,
) -> dict[str, Any]:
    ...
# accept_invitation method usage example with argument unpacking

kwargs: AcceptInvitationRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "MasterId": ...,
    "InvitationId": ...,
}

parent.accept_invitation(**kwargs)
  1. See AcceptInvitationRequestRequestTypeDef

archive_findings#

Archives GuardDuty findings that are specified by the list of finding IDs.

Type annotations and code completion for boto3.client("guardduty").archive_findings method. boto3 documentation

# archive_findings method definition

def archive_findings(
    self,
    *,
    DetectorId: str,
    FindingIds: Sequence[str],
) -> dict[str, Any]:
    ...
# archive_findings method usage example with argument unpacking

kwargs: ArchiveFindingsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "FindingIds": ...,
}

parent.archive_findings(**kwargs)
  1. See ArchiveFindingsRequestRequestTypeDef

create_detector#

Creates a single GuardDuty detector.

Type annotations and code completion for boto3.client("guardduty").create_detector method. boto3 documentation

# create_detector method definition

def create_detector(
    self,
    *,
    Enable: bool,
    ClientToken: str = ...,
    FindingPublishingFrequency: FindingPublishingFrequencyType = ...,  # (1)
    DataSources: DataSourceConfigurationsTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
    Features: Sequence[DetectorFeatureConfigurationTypeDef] = ...,  # (3)
) -> CreateDetectorResponseTypeDef:  # (4)
    ...
  1. See FindingPublishingFrequencyType
  2. See DataSourceConfigurationsTypeDef
  3. See DetectorFeatureConfigurationTypeDef
  4. See CreateDetectorResponseTypeDef 
# create_detector method usage example with argument unpacking

kwargs: CreateDetectorRequestRequestTypeDef = {  # (1)
    "Enable": ...,
}

parent.create_detector(**kwargs)
  1. See CreateDetectorRequestRequestTypeDef

create_filter#

Creates a filter using the specified finding criteria.

Type annotations and code completion for boto3.client("guardduty").create_filter method. boto3 documentation

# create_filter method definition

def create_filter(
    self,
    *,
    DetectorId: str,
    Name: str,
    FindingCriteria: FindingCriteriaTypeDef,  # (1)
    Description: str = ...,
    Action: FilterActionType = ...,  # (2)
    Rank: int = ...,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateFilterResponseTypeDef:  # (3)
    ...
  1. See FindingCriteriaTypeDef
  2. See FilterActionType
  3. See CreateFilterResponseTypeDef 
# create_filter method usage example with argument unpacking

kwargs: CreateFilterRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "Name": ...,
    "FindingCriteria": ...,
}

parent.create_filter(**kwargs)
  1. See CreateFilterRequestRequestTypeDef

create_ip_set#

Creates a new IPSet, which is called a trusted IP list in the console user interface.

Type annotations and code completion for boto3.client("guardduty").create_ip_set method. boto3 documentation

# create_ip_set method definition

def create_ip_set(
    self,
    *,
    DetectorId: str,
    Name: str,
    Format: IpSetFormatType,  # (1)
    Location: str,
    Activate: bool,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateIPSetResponseTypeDef:  # (2)
    ...
  1. See IpSetFormatType
  2. See CreateIPSetResponseTypeDef 
# create_ip_set method usage example with argument unpacking

kwargs: CreateIPSetRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "Name": ...,
    "Format": ...,
    "Location": ...,
    "Activate": ...,
}

parent.create_ip_set(**kwargs)
  1. See CreateIPSetRequestRequestTypeDef

create_malware_protection_plan#

Creates a new Malware Protection plan for the protected resource.

Type annotations and code completion for boto3.client("guardduty").create_malware_protection_plan method. boto3 documentation

# create_malware_protection_plan method definition

def create_malware_protection_plan(
    self,
    *,
    Role: str,
    ProtectedResource: CreateProtectedResourceTypeDef,  # (1)
    ClientToken: str = ...,
    Actions: MalwareProtectionPlanActionsTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateMalwareProtectionPlanResponseTypeDef:  # (3)
    ...
  1. See CreateProtectedResourceTypeDef
  2. See MalwareProtectionPlanActionsTypeDef
  3. See CreateMalwareProtectionPlanResponseTypeDef 
# create_malware_protection_plan method usage example with argument unpacking

kwargs: CreateMalwareProtectionPlanRequestRequestTypeDef = {  # (1)
    "Role": ...,
    "ProtectedResource": ...,
}

parent.create_malware_protection_plan(**kwargs)
  1. See CreateMalwareProtectionPlanRequestRequestTypeDef

create_members#

Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs.

Type annotations and code completion for boto3.client("guardduty").create_members method. boto3 documentation

# create_members method definition

def create_members(
    self,
    *,
    DetectorId: str,
    AccountDetails: Sequence[AccountDetailTypeDef],  # (1)
) -> CreateMembersResponseTypeDef:  # (2)
    ...
  1. See AccountDetailTypeDef
  2. See CreateMembersResponseTypeDef 
# create_members method usage example with argument unpacking

kwargs: CreateMembersRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "AccountDetails": ...,
}

parent.create_members(**kwargs)
  1. See CreateMembersRequestRequestTypeDef

create_publishing_destination#

Creates a publishing destination where you can export your GuardDuty findings.

Type annotations and code completion for boto3.client("guardduty").create_publishing_destination method. boto3 documentation

# create_publishing_destination method definition

def create_publishing_destination(
    self,
    *,
    DetectorId: str,
    DestinationType: DestinationTypeType,  # (1)
    DestinationProperties: DestinationPropertiesTypeDef,  # (2)
    ClientToken: str = ...,
) -> CreatePublishingDestinationResponseTypeDef:  # (3)
    ...
  1. See DestinationTypeType
  2. See DestinationPropertiesTypeDef
  3. See CreatePublishingDestinationResponseTypeDef 
# create_publishing_destination method usage example with argument unpacking

kwargs: CreatePublishingDestinationRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "DestinationType": ...,
    "DestinationProperties": ...,
}

parent.create_publishing_destination(**kwargs)
  1. See CreatePublishingDestinationRequestRequestTypeDef

create_sample_findings#

Generates sample findings of types specified by the list of finding types.

Type annotations and code completion for boto3.client("guardduty").create_sample_findings method. boto3 documentation

# create_sample_findings method definition

def create_sample_findings(
    self,
    *,
    DetectorId: str,
    FindingTypes: Sequence[str] = ...,
) -> dict[str, Any]:
    ...
# create_sample_findings method usage example with argument unpacking

kwargs: CreateSampleFindingsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.create_sample_findings(**kwargs)
  1. See CreateSampleFindingsRequestRequestTypeDef

create_threat_intel_set#

Creates a new ThreatIntelSet.

Type annotations and code completion for boto3.client("guardduty").create_threat_intel_set method. boto3 documentation

# create_threat_intel_set method definition

def create_threat_intel_set(
    self,
    *,
    DetectorId: str,
    Name: str,
    Format: ThreatIntelSetFormatType,  # (1)
    Location: str,
    Activate: bool,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateThreatIntelSetResponseTypeDef:  # (2)
    ...
  1. See ThreatIntelSetFormatType
  2. See CreateThreatIntelSetResponseTypeDef 
# create_threat_intel_set method usage example with argument unpacking

kwargs: CreateThreatIntelSetRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "Name": ...,
    "Format": ...,
    "Location": ...,
    "Activate": ...,
}

parent.create_threat_intel_set(**kwargs)
  1. See CreateThreatIntelSetRequestRequestTypeDef

decline_invitations#

Declines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.

Type annotations and code completion for boto3.client("guardduty").decline_invitations method. boto3 documentation

# decline_invitations method definition

def decline_invitations(
    self,
    *,
    AccountIds: Sequence[str],
) -> DeclineInvitationsResponseTypeDef:  # (1)
    ...
  1. See DeclineInvitationsResponseTypeDef 
# decline_invitations method usage example with argument unpacking

kwargs: DeclineInvitationsRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

parent.decline_invitations(**kwargs)
  1. See DeclineInvitationsRequestRequestTypeDef

delete_detector#

Deletes an Amazon GuardDuty detector that is specified by the detector ID.

Type annotations and code completion for boto3.client("guardduty").delete_detector method. boto3 documentation

# delete_detector method definition

def delete_detector(
    self,
    *,
    DetectorId: str,
) -> dict[str, Any]:
    ...
# delete_detector method usage example with argument unpacking

kwargs: DeleteDetectorRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.delete_detector(**kwargs)
  1. See DeleteDetectorRequestRequestTypeDef

delete_filter#

Deletes the filter specified by the filter name.

Type annotations and code completion for boto3.client("guardduty").delete_filter method. boto3 documentation

# delete_filter method definition

def delete_filter(
    self,
    *,
    DetectorId: str,
    FilterName: str,
) -> dict[str, Any]:
    ...
# delete_filter method usage example with argument unpacking

kwargs: DeleteFilterRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "FilterName": ...,
}

parent.delete_filter(**kwargs)
  1. See DeleteFilterRequestRequestTypeDef

delete_ip_set#

Deletes the IPSet specified by the ipSetId.

Type annotations and code completion for boto3.client("guardduty").delete_ip_set method. boto3 documentation

# delete_ip_set method definition

def delete_ip_set(
    self,
    *,
    DetectorId: str,
    IpSetId: str,
) -> dict[str, Any]:
    ...
# delete_ip_set method usage example with argument unpacking

kwargs: DeleteIPSetRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "IpSetId": ...,
}

parent.delete_ip_set(**kwargs)
  1. See DeleteIPSetRequestRequestTypeDef

delete_invitations#

Deletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.

Type annotations and code completion for boto3.client("guardduty").delete_invitations method. boto3 documentation

# delete_invitations method definition

def delete_invitations(
    self,
    *,
    AccountIds: Sequence[str],
) -> DeleteInvitationsResponseTypeDef:  # (1)
    ...
  1. See DeleteInvitationsResponseTypeDef 
# delete_invitations method usage example with argument unpacking

kwargs: DeleteInvitationsRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

parent.delete_invitations(**kwargs)
  1. See DeleteInvitationsRequestRequestTypeDef

delete_malware_protection_plan#

Deletes the Malware Protection plan ID associated with the Malware Protection plan resource.

Type annotations and code completion for boto3.client("guardduty").delete_malware_protection_plan method. boto3 documentation

# delete_malware_protection_plan method definition

def delete_malware_protection_plan(
    self,
    *,
    MalwareProtectionPlanId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_malware_protection_plan method usage example with argument unpacking

kwargs: DeleteMalwareProtectionPlanRequestRequestTypeDef = {  # (1)
    "MalwareProtectionPlanId": ...,
}

parent.delete_malware_protection_plan(**kwargs)
  1. See DeleteMalwareProtectionPlanRequestRequestTypeDef

delete_members#

Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.

Type annotations and code completion for boto3.client("guardduty").delete_members method. boto3 documentation

# delete_members method definition

def delete_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> DeleteMembersResponseTypeDef:  # (1)
    ...
  1. See DeleteMembersResponseTypeDef 
# delete_members method usage example with argument unpacking

kwargs: DeleteMembersRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "AccountIds": ...,
}

parent.delete_members(**kwargs)
  1. See DeleteMembersRequestRequestTypeDef

delete_publishing_destination#

Deletes the publishing definition with the specified destinationId.

Type annotations and code completion for boto3.client("guardduty").delete_publishing_destination method. boto3 documentation

# delete_publishing_destination method definition

def delete_publishing_destination(
    self,
    *,
    DetectorId: str,
    DestinationId: str,
) -> dict[str, Any]:
    ...
# delete_publishing_destination method usage example with argument unpacking

kwargs: DeletePublishingDestinationRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "DestinationId": ...,
}

parent.delete_publishing_destination(**kwargs)
  1. See DeletePublishingDestinationRequestRequestTypeDef

delete_threat_intel_set#

Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.

Type annotations and code completion for boto3.client("guardduty").delete_threat_intel_set method. boto3 documentation

# delete_threat_intel_set method definition

def delete_threat_intel_set(
    self,
    *,
    DetectorId: str,
    ThreatIntelSetId: str,
) -> dict[str, Any]:
    ...
# delete_threat_intel_set method usage example with argument unpacking

kwargs: DeleteThreatIntelSetRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "ThreatIntelSetId": ...,
}

parent.delete_threat_intel_set(**kwargs)
  1. See DeleteThreatIntelSetRequestRequestTypeDef

describe_malware_scans#

Returns a list of malware scans.

Type annotations and code completion for boto3.client("guardduty").describe_malware_scans method. boto3 documentation

# describe_malware_scans method definition

def describe_malware_scans(
    self,
    *,
    DetectorId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    FilterCriteria: FilterCriteriaTypeDef = ...,  # (1)
    SortCriteria: SortCriteriaTypeDef = ...,  # (2)
) -> DescribeMalwareScansResponseTypeDef:  # (3)
    ...
  1. See FilterCriteriaTypeDef
  2. See SortCriteriaTypeDef
  3. See DescribeMalwareScansResponseTypeDef 
# describe_malware_scans method usage example with argument unpacking

kwargs: DescribeMalwareScansRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.describe_malware_scans(**kwargs)
  1. See DescribeMalwareScansRequestRequestTypeDef

describe_organization_configuration#

Returns information about the account selected as the delegated administrator for GuardDuty.

Type annotations and code completion for boto3.client("guardduty").describe_organization_configuration method. boto3 documentation

# describe_organization_configuration method definition

def describe_organization_configuration(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeOrganizationConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeOrganizationConfigurationResponseTypeDef 
# describe_organization_configuration method usage example with argument unpacking

kwargs: DescribeOrganizationConfigurationRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.describe_organization_configuration(**kwargs)
  1. See DescribeOrganizationConfigurationRequestRequestTypeDef

describe_publishing_destination#

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

Type annotations and code completion for boto3.client("guardduty").describe_publishing_destination method. boto3 documentation

# describe_publishing_destination method definition

def describe_publishing_destination(
    self,
    *,
    DetectorId: str,
    DestinationId: str,
) -> DescribePublishingDestinationResponseTypeDef:  # (1)
    ...
  1. See DescribePublishingDestinationResponseTypeDef 
# describe_publishing_destination method usage example with argument unpacking

kwargs: DescribePublishingDestinationRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "DestinationId": ...,
}

parent.describe_publishing_destination(**kwargs)
  1. See DescribePublishingDestinationRequestRequestTypeDef

disable_organization_admin_account#

Removes the existing GuardDuty delegated administrator of the organization.

Type annotations and code completion for boto3.client("guardduty").disable_organization_admin_account method. boto3 documentation

# disable_organization_admin_account method definition

def disable_organization_admin_account(
    self,
    *,
    AdminAccountId: str,
) -> dict[str, Any]:
    ...
# disable_organization_admin_account method usage example with argument unpacking

kwargs: DisableOrganizationAdminAccountRequestRequestTypeDef = {  # (1)
    "AdminAccountId": ...,
}

parent.disable_organization_admin_account(**kwargs)
  1. See DisableOrganizationAdminAccountRequestRequestTypeDef

disassociate_from_administrator_account#

Disassociates the current GuardDuty member account from its administrator account.

Type annotations and code completion for boto3.client("guardduty").disassociate_from_administrator_account method. boto3 documentation

# disassociate_from_administrator_account method definition

def disassociate_from_administrator_account(
    self,
    *,
    DetectorId: str,
) -> dict[str, Any]:
    ...
# disassociate_from_administrator_account method usage example with argument unpacking

kwargs: DisassociateFromAdministratorAccountRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.disassociate_from_administrator_account(**kwargs)
  1. See DisassociateFromAdministratorAccountRequestRequestTypeDef

disassociate_from_master_account#

Disassociates the current GuardDuty member account from its administrator account.

Type annotations and code completion for boto3.client("guardduty").disassociate_from_master_account method. boto3 documentation

# disassociate_from_master_account method definition

def disassociate_from_master_account(
    self,
    *,
    DetectorId: str,
) -> dict[str, Any]:
    ...
# disassociate_from_master_account method usage example with argument unpacking

kwargs: DisassociateFromMasterAccountRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.disassociate_from_master_account(**kwargs)
  1. See DisassociateFromMasterAccountRequestRequestTypeDef

disassociate_members#

Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs.

Type annotations and code completion for boto3.client("guardduty").disassociate_members method. boto3 documentation

# disassociate_members method definition

def disassociate_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> DisassociateMembersResponseTypeDef:  # (1)
    ...
  1. See DisassociateMembersResponseTypeDef 
# disassociate_members method usage example with argument unpacking

kwargs: DisassociateMembersRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "AccountIds": ...,
}

parent.disassociate_members(**kwargs)
  1. See DisassociateMembersRequestRequestTypeDef

enable_organization_admin_account#

Designates an Amazon Web Services account within the organization as your GuardDuty delegated administrator.

Type annotations and code completion for boto3.client("guardduty").enable_organization_admin_account method. boto3 documentation

# enable_organization_admin_account method definition

def enable_organization_admin_account(
    self,
    *,
    AdminAccountId: str,
) -> dict[str, Any]:
    ...
# enable_organization_admin_account method usage example with argument unpacking

kwargs: EnableOrganizationAdminAccountRequestRequestTypeDef = {  # (1)
    "AdminAccountId": ...,
}

parent.enable_organization_admin_account(**kwargs)
  1. See EnableOrganizationAdminAccountRequestRequestTypeDef

get_administrator_account#

Provides the details of the GuardDuty administrator account associated with the current GuardDuty member account.

Type annotations and code completion for boto3.client("guardduty").get_administrator_account method. boto3 documentation

# get_administrator_account method definition

def get_administrator_account(
    self,
    *,
    DetectorId: str,
) -> GetAdministratorAccountResponseTypeDef:  # (1)
    ...
  1. See GetAdministratorAccountResponseTypeDef 
# get_administrator_account method usage example with argument unpacking

kwargs: GetAdministratorAccountRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.get_administrator_account(**kwargs)
  1. See GetAdministratorAccountRequestRequestTypeDef

get_coverage_statistics#

Retrieves aggregated statistics for your account.

Type annotations and code completion for boto3.client("guardduty").get_coverage_statistics method. boto3 documentation

# get_coverage_statistics method definition

def get_coverage_statistics(
    self,
    *,
    DetectorId: str,
    StatisticsType: Sequence[CoverageStatisticsTypeType],  # (1)
    FilterCriteria: CoverageFilterCriteriaTypeDef = ...,  # (2)
) -> GetCoverageStatisticsResponseTypeDef:  # (3)
    ...
  1. See CoverageStatisticsTypeType
  2. See CoverageFilterCriteriaTypeDef
  3. See GetCoverageStatisticsResponseTypeDef 
# get_coverage_statistics method usage example with argument unpacking

kwargs: GetCoverageStatisticsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "StatisticsType": ...,
}

parent.get_coverage_statistics(**kwargs)
  1. See GetCoverageStatisticsRequestRequestTypeDef

get_detector#

Retrieves a GuardDuty detector specified by the detectorId.

Type annotations and code completion for boto3.client("guardduty").get_detector method. boto3 documentation

# get_detector method definition

def get_detector(
    self,
    *,
    DetectorId: str,
) -> GetDetectorResponseTypeDef:  # (1)
    ...
  1. See GetDetectorResponseTypeDef 
# get_detector method usage example with argument unpacking

kwargs: GetDetectorRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.get_detector(**kwargs)
  1. See GetDetectorRequestRequestTypeDef

get_filter#

Returns the details of the filter specified by the filter name.

Type annotations and code completion for boto3.client("guardduty").get_filter method. boto3 documentation

# get_filter method definition

def get_filter(
    self,
    *,
    DetectorId: str,
    FilterName: str,
) -> GetFilterResponseTypeDef:  # (1)
    ...
  1. See GetFilterResponseTypeDef 
# get_filter method usage example with argument unpacking

kwargs: GetFilterRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "FilterName": ...,
}

parent.get_filter(**kwargs)
  1. See GetFilterRequestRequestTypeDef

get_findings#

Describes Amazon GuardDuty findings specified by finding IDs.

Type annotations and code completion for boto3.client("guardduty").get_findings method. boto3 documentation

# get_findings method definition

def get_findings(
    self,
    *,
    DetectorId: str,
    FindingIds: Sequence[str],
    SortCriteria: SortCriteriaTypeDef = ...,  # (1)
) -> GetFindingsResponseTypeDef:  # (2)
    ...
  1. See SortCriteriaTypeDef
  2. See GetFindingsResponseTypeDef 
# get_findings method usage example with argument unpacking

kwargs: GetFindingsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "FindingIds": ...,
}

parent.get_findings(**kwargs)
  1. See GetFindingsRequestRequestTypeDef

get_findings_statistics#

Lists GuardDuty findings statistics for the specified detector ID.

Type annotations and code completion for boto3.client("guardduty").get_findings_statistics method. boto3 documentation

# get_findings_statistics method definition

def get_findings_statistics(
    self,
    *,
    DetectorId: str,
    FindingStatisticTypes: Sequence[FindingStatisticTypeType] = ...,  # (1)
    FindingCriteria: FindingCriteriaTypeDef = ...,  # (2)
    GroupBy: GroupByTypeType = ...,  # (3)
    OrderBy: OrderByType = ...,  # (4)
    MaxResults: int = ...,
) -> GetFindingsStatisticsResponseTypeDef:  # (5)
    ...
  1. See FindingStatisticTypeType
  2. See FindingCriteriaTypeDef
  3. See GroupByTypeType
  4. See OrderByType
  5. See GetFindingsStatisticsResponseTypeDef 
# get_findings_statistics method usage example with argument unpacking

kwargs: GetFindingsStatisticsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.get_findings_statistics(**kwargs)
  1. See GetFindingsStatisticsRequestRequestTypeDef

get_ip_set#

Retrieves the IPSet specified by the ipSetId.

Type annotations and code completion for boto3.client("guardduty").get_ip_set method. boto3 documentation

# get_ip_set method definition

def get_ip_set(
    self,
    *,
    DetectorId: str,
    IpSetId: str,
) -> GetIPSetResponseTypeDef:  # (1)
    ...
  1. See GetIPSetResponseTypeDef 
# get_ip_set method usage example with argument unpacking

kwargs: GetIPSetRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "IpSetId": ...,
}

parent.get_ip_set(**kwargs)
  1. See GetIPSetRequestRequestTypeDef

get_invitations_count#

Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.

Type annotations and code completion for boto3.client("guardduty").get_invitations_count method. boto3 documentation

# get_invitations_count method definition

def get_invitations_count(
    self,
) -> GetInvitationsCountResponseTypeDef:  # (1)
    ...
  1. See GetInvitationsCountResponseTypeDef

get_malware_protection_plan#

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

Type annotations and code completion for boto3.client("guardduty").get_malware_protection_plan method. boto3 documentation

# get_malware_protection_plan method definition

def get_malware_protection_plan(
    self,
    *,
    MalwareProtectionPlanId: str,
) -> GetMalwareProtectionPlanResponseTypeDef:  # (1)
    ...
  1. See GetMalwareProtectionPlanResponseTypeDef 
# get_malware_protection_plan method usage example with argument unpacking

kwargs: GetMalwareProtectionPlanRequestRequestTypeDef = {  # (1)
    "MalwareProtectionPlanId": ...,
}

parent.get_malware_protection_plan(**kwargs)
  1. See GetMalwareProtectionPlanRequestRequestTypeDef

get_malware_scan_settings#

Returns the details of the malware scan settings.

Type annotations and code completion for boto3.client("guardduty").get_malware_scan_settings method. boto3 documentation

# get_malware_scan_settings method definition

def get_malware_scan_settings(
    self,
    *,
    DetectorId: str,
) -> GetMalwareScanSettingsResponseTypeDef:  # (1)
    ...
  1. See GetMalwareScanSettingsResponseTypeDef 
# get_malware_scan_settings method usage example with argument unpacking

kwargs: GetMalwareScanSettingsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.get_malware_scan_settings(**kwargs)
  1. See GetMalwareScanSettingsRequestRequestTypeDef

get_master_account#

Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.

Type annotations and code completion for boto3.client("guardduty").get_master_account method. boto3 documentation

# get_master_account method definition

def get_master_account(
    self,
    *,
    DetectorId: str,
) -> GetMasterAccountResponseTypeDef:  # (1)
    ...
  1. See GetMasterAccountResponseTypeDef 
# get_master_account method usage example with argument unpacking

kwargs: GetMasterAccountRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.get_master_account(**kwargs)
  1. See GetMasterAccountRequestRequestTypeDef

get_member_detectors#

Describes which data sources are enabled for the member account's detector.

Type annotations and code completion for boto3.client("guardduty").get_member_detectors method. boto3 documentation

# get_member_detectors method definition

def get_member_detectors(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> GetMemberDetectorsResponseTypeDef:  # (1)
    ...
  1. See GetMemberDetectorsResponseTypeDef 
# get_member_detectors method usage example with argument unpacking

kwargs: GetMemberDetectorsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "AccountIds": ...,
}

parent.get_member_detectors(**kwargs)
  1. See GetMemberDetectorsRequestRequestTypeDef

get_members#

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

Type annotations and code completion for boto3.client("guardduty").get_members method. boto3 documentation

# get_members method definition

def get_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> GetMembersResponseTypeDef:  # (1)
    ...
  1. See GetMembersResponseTypeDef 
# get_members method usage example with argument unpacking

kwargs: GetMembersRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "AccountIds": ...,
}

parent.get_members(**kwargs)
  1. See GetMembersRequestRequestTypeDef

get_organization_statistics#

Retrieves how many active member accounts have each feature enabled within GuardDuty.

Type annotations and code completion for boto3.client("guardduty").get_organization_statistics method. boto3 documentation

# get_organization_statistics method definition

def get_organization_statistics(
    self,
) -> GetOrganizationStatisticsResponseTypeDef:  # (1)
    ...
  1. See GetOrganizationStatisticsResponseTypeDef

get_remaining_free_trial_days#

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

Type annotations and code completion for boto3.client("guardduty").get_remaining_free_trial_days method. boto3 documentation

# get_remaining_free_trial_days method definition

def get_remaining_free_trial_days(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str] = ...,
) -> GetRemainingFreeTrialDaysResponseTypeDef:  # (1)
    ...
  1. See GetRemainingFreeTrialDaysResponseTypeDef 
# get_remaining_free_trial_days method usage example with argument unpacking

kwargs: GetRemainingFreeTrialDaysRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.get_remaining_free_trial_days(**kwargs)
  1. See GetRemainingFreeTrialDaysRequestRequestTypeDef

get_threat_intel_set#

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

Type annotations and code completion for boto3.client("guardduty").get_threat_intel_set method. boto3 documentation

# get_threat_intel_set method definition

def get_threat_intel_set(
    self,
    *,
    DetectorId: str,
    ThreatIntelSetId: str,
) -> GetThreatIntelSetResponseTypeDef:  # (1)
    ...
  1. See GetThreatIntelSetResponseTypeDef 
# get_threat_intel_set method usage example with argument unpacking

kwargs: GetThreatIntelSetRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "ThreatIntelSetId": ...,
}

parent.get_threat_intel_set(**kwargs)
  1. See GetThreatIntelSetRequestRequestTypeDef

get_usage_statistics#

Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID.

Type annotations and code completion for boto3.client("guardduty").get_usage_statistics method. boto3 documentation

# get_usage_statistics method definition

def get_usage_statistics(
    self,
    *,
    DetectorId: str,
    UsageStatisticType: UsageStatisticTypeType,  # (1)
    UsageCriteria: UsageCriteriaTypeDef,  # (2)
    Unit: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetUsageStatisticsResponseTypeDef:  # (3)
    ...
  1. See UsageStatisticTypeType
  2. See UsageCriteriaTypeDef
  3. See GetUsageStatisticsResponseTypeDef 
# get_usage_statistics method usage example with argument unpacking

kwargs: GetUsageStatisticsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "UsageStatisticType": ...,
    "UsageCriteria": ...,
}

parent.get_usage_statistics(**kwargs)
  1. See GetUsageStatisticsRequestRequestTypeDef

invite_members#

Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API.

Type annotations and code completion for boto3.client("guardduty").invite_members method. boto3 documentation

# invite_members method definition

def invite_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
    DisableEmailNotification: bool = ...,
    Message: str = ...,
) -> InviteMembersResponseTypeDef:  # (1)
    ...
  1. See InviteMembersResponseTypeDef 
# invite_members method usage example with argument unpacking

kwargs: InviteMembersRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "AccountIds": ...,
}

parent.invite_members(**kwargs)
  1. See InviteMembersRequestRequestTypeDef

list_coverage#

Lists coverage details for your GuardDuty account.

Type annotations and code completion for boto3.client("guardduty").list_coverage method. boto3 documentation

# list_coverage method definition

def list_coverage(
    self,
    *,
    DetectorId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    FilterCriteria: CoverageFilterCriteriaTypeDef = ...,  # (1)
    SortCriteria: CoverageSortCriteriaTypeDef = ...,  # (2)
) -> ListCoverageResponseTypeDef:  # (3)
    ...
  1. See CoverageFilterCriteriaTypeDef
  2. See CoverageSortCriteriaTypeDef
  3. See ListCoverageResponseTypeDef 
# list_coverage method usage example with argument unpacking

kwargs: ListCoverageRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.list_coverage(**kwargs)
  1. See ListCoverageRequestRequestTypeDef

list_detectors#

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

Type annotations and code completion for boto3.client("guardduty").list_detectors method. boto3 documentation

# list_detectors method definition

def list_detectors(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDetectorsResponseTypeDef:  # (1)
    ...
  1. See ListDetectorsResponseTypeDef 
# list_detectors method usage example with argument unpacking

kwargs: ListDetectorsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_detectors(**kwargs)
  1. See ListDetectorsRequestRequestTypeDef

list_filters#

Returns a paginated list of the current filters.

Type annotations and code completion for boto3.client("guardduty").list_filters method. boto3 documentation

# list_filters method definition

def list_filters(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListFiltersResponseTypeDef:  # (1)
    ...
  1. See ListFiltersResponseTypeDef 
# list_filters method usage example with argument unpacking

kwargs: ListFiltersRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.list_filters(**kwargs)
  1. See ListFiltersRequestRequestTypeDef

list_findings#

Lists GuardDuty findings for the specified detector ID.

Type annotations and code completion for boto3.client("guardduty").list_findings method. boto3 documentation

# list_findings method definition

def list_findings(
    self,
    *,
    DetectorId: str,
    FindingCriteria: FindingCriteriaTypeDef = ...,  # (1)
    SortCriteria: SortCriteriaTypeDef = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListFindingsResponseTypeDef:  # (3)
    ...
  1. See FindingCriteriaTypeDef
  2. See SortCriteriaTypeDef
  3. See ListFindingsResponseTypeDef 
# list_findings method usage example with argument unpacking

kwargs: ListFindingsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.list_findings(**kwargs)
  1. See ListFindingsRequestRequestTypeDef

list_ip_sets#

Lists the IPSets of the GuardDuty service specified by the detector ID.

Type annotations and code completion for boto3.client("guardduty").list_ip_sets method. boto3 documentation

# list_ip_sets method definition

def list_ip_sets(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListIPSetsResponseTypeDef:  # (1)
    ...
  1. See ListIPSetsResponseTypeDef 
# list_ip_sets method usage example with argument unpacking

kwargs: ListIPSetsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.list_ip_sets(**kwargs)
  1. See ListIPSetsRequestRequestTypeDef

list_invitations#

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

Type annotations and code completion for boto3.client("guardduty").list_invitations method. boto3 documentation

# list_invitations method definition

def list_invitations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInvitationsResponseTypeDef:  # (1)
    ...
  1. See ListInvitationsResponseTypeDef 
# list_invitations method usage example with argument unpacking

kwargs: ListInvitationsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_invitations(**kwargs)
  1. See ListInvitationsRequestRequestTypeDef

list_malware_protection_plans#

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

Type annotations and code completion for boto3.client("guardduty").list_malware_protection_plans method. boto3 documentation

# list_malware_protection_plans method definition

def list_malware_protection_plans(
    self,
    *,
    NextToken: str = ...,
) -> ListMalwareProtectionPlansResponseTypeDef:  # (1)
    ...
  1. See ListMalwareProtectionPlansResponseTypeDef 
# list_malware_protection_plans method usage example with argument unpacking

kwargs: ListMalwareProtectionPlansRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_malware_protection_plans(**kwargs)
  1. See ListMalwareProtectionPlansRequestRequestTypeDef

list_members#

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

Type annotations and code completion for boto3.client("guardduty").list_members method. boto3 documentation

# list_members method definition

def list_members(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    OnlyAssociated: str = ...,
) -> ListMembersResponseTypeDef:  # (1)
    ...
  1. See ListMembersResponseTypeDef 
# list_members method usage example with argument unpacking

kwargs: ListMembersRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.list_members(**kwargs)
  1. See ListMembersRequestRequestTypeDef

list_organization_admin_accounts#

Lists the accounts designated as GuardDuty delegated administrators.

Type annotations and code completion for boto3.client("guardduty").list_organization_admin_accounts method. boto3 documentation

# list_organization_admin_accounts method definition

def list_organization_admin_accounts(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListOrganizationAdminAccountsResponseTypeDef:  # (1)
    ...
  1. See ListOrganizationAdminAccountsResponseTypeDef 
# list_organization_admin_accounts method usage example with argument unpacking

kwargs: ListOrganizationAdminAccountsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_organization_admin_accounts(**kwargs)
  1. See ListOrganizationAdminAccountsRequestRequestTypeDef

list_publishing_destinations#

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

Type annotations and code completion for boto3.client("guardduty").list_publishing_destinations method. boto3 documentation

# list_publishing_destinations method definition

def list_publishing_destinations(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPublishingDestinationsResponseTypeDef:  # (1)
    ...
  1. See ListPublishingDestinationsResponseTypeDef 
# list_publishing_destinations method usage example with argument unpacking

kwargs: ListPublishingDestinationsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.list_publishing_destinations(**kwargs)
  1. See ListPublishingDestinationsRequestRequestTypeDef

list_tags_for_resource#

Lists tags for a resource.

Type annotations and code completion for boto3.client("guardduty").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_threat_intel_sets#

Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID.

Type annotations and code completion for boto3.client("guardduty").list_threat_intel_sets method. boto3 documentation

# list_threat_intel_sets method definition

def list_threat_intel_sets(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListThreatIntelSetsResponseTypeDef:  # (1)
    ...
  1. See ListThreatIntelSetsResponseTypeDef 
# list_threat_intel_sets method usage example with argument unpacking

kwargs: ListThreatIntelSetsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.list_threat_intel_sets(**kwargs)
  1. See ListThreatIntelSetsRequestRequestTypeDef

start_malware_scan#

Initiates the malware scan.

Type annotations and code completion for boto3.client("guardduty").start_malware_scan method. boto3 documentation

# start_malware_scan method definition

def start_malware_scan(
    self,
    *,
    ResourceArn: str,
) -> StartMalwareScanResponseTypeDef:  # (1)
    ...
  1. See StartMalwareScanResponseTypeDef 
# start_malware_scan method usage example with argument unpacking

kwargs: StartMalwareScanRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.start_malware_scan(**kwargs)
  1. See StartMalwareScanRequestRequestTypeDef

start_monitoring_members#

Turns on GuardDuty monitoring of the specified member accounts.

Type annotations and code completion for boto3.client("guardduty").start_monitoring_members method. boto3 documentation

# start_monitoring_members method definition

def start_monitoring_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> StartMonitoringMembersResponseTypeDef:  # (1)
    ...
  1. See StartMonitoringMembersResponseTypeDef 
# start_monitoring_members method usage example with argument unpacking

kwargs: StartMonitoringMembersRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "AccountIds": ...,
}

parent.start_monitoring_members(**kwargs)
  1. See StartMonitoringMembersRequestRequestTypeDef

stop_monitoring_members#

Stops GuardDuty monitoring for the specified member accounts.

Type annotations and code completion for boto3.client("guardduty").stop_monitoring_members method. boto3 documentation

# stop_monitoring_members method definition

def stop_monitoring_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> StopMonitoringMembersResponseTypeDef:  # (1)
    ...
  1. See StopMonitoringMembersResponseTypeDef 
# stop_monitoring_members method usage example with argument unpacking

kwargs: StopMonitoringMembersRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "AccountIds": ...,
}

parent.stop_monitoring_members(**kwargs)
  1. See StopMonitoringMembersRequestRequestTypeDef

tag_resource#

Adds tags to a resource.

Type annotations and code completion for boto3.client("guardduty").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

unarchive_findings#

Unarchives GuardDuty findings specified by the findingIds.

Type annotations and code completion for boto3.client("guardduty").unarchive_findings method. boto3 documentation

# unarchive_findings method definition

def unarchive_findings(
    self,
    *,
    DetectorId: str,
    FindingIds: Sequence[str],
) -> dict[str, Any]:
    ...
# unarchive_findings method usage example with argument unpacking

kwargs: UnarchiveFindingsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "FindingIds": ...,
}

parent.unarchive_findings(**kwargs)
  1. See UnarchiveFindingsRequestRequestTypeDef

untag_resource#

Removes tags from a resource.

Type annotations and code completion for boto3.client("guardduty").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_detector#

Updates the GuardDuty detector specified by the detector ID.

Type annotations and code completion for boto3.client("guardduty").update_detector method. boto3 documentation

# update_detector method definition

def update_detector(
    self,
    *,
    DetectorId: str,
    Enable: bool = ...,
    FindingPublishingFrequency: FindingPublishingFrequencyType = ...,  # (1)
    DataSources: DataSourceConfigurationsTypeDef = ...,  # (2)
    Features: Sequence[DetectorFeatureConfigurationTypeDef] = ...,  # (3)
) -> dict[str, Any]:
    ...
  1. See FindingPublishingFrequencyType
  2. See DataSourceConfigurationsTypeDef
  3. See DetectorFeatureConfigurationTypeDef 
# update_detector method usage example with argument unpacking

kwargs: UpdateDetectorRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.update_detector(**kwargs)
  1. See UpdateDetectorRequestRequestTypeDef

update_filter#

Updates the filter specified by the filter name.

Type annotations and code completion for boto3.client("guardduty").update_filter method. boto3 documentation

# update_filter method definition

def update_filter(
    self,
    *,
    DetectorId: str,
    FilterName: str,
    Description: str = ...,
    Action: FilterActionType = ...,  # (1)
    Rank: int = ...,
    FindingCriteria: FindingCriteriaTypeDef = ...,  # (2)
) -> UpdateFilterResponseTypeDef:  # (3)
    ...
  1. See FilterActionType
  2. See FindingCriteriaTypeDef
  3. See UpdateFilterResponseTypeDef 
# update_filter method usage example with argument unpacking

kwargs: UpdateFilterRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "FilterName": ...,
}

parent.update_filter(**kwargs)
  1. See UpdateFilterRequestRequestTypeDef

update_findings_feedback#

Marks the specified GuardDuty findings as useful or not useful.

Type annotations and code completion for boto3.client("guardduty").update_findings_feedback method. boto3 documentation

# update_findings_feedback method definition

def update_findings_feedback(
    self,
    *,
    DetectorId: str,
    FindingIds: Sequence[str],
    Feedback: FeedbackType,  # (1)
    Comments: str = ...,
) -> dict[str, Any]:
    ...
  1. See FeedbackType 
# update_findings_feedback method usage example with argument unpacking

kwargs: UpdateFindingsFeedbackRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "FindingIds": ...,
    "Feedback": ...,
}

parent.update_findings_feedback(**kwargs)
  1. See UpdateFindingsFeedbackRequestRequestTypeDef

update_ip_set#

Updates the IPSet specified by the IPSet ID.

Type annotations and code completion for boto3.client("guardduty").update_ip_set method. boto3 documentation

# update_ip_set method definition

def update_ip_set(
    self,
    *,
    DetectorId: str,
    IpSetId: str,
    Name: str = ...,
    Location: str = ...,
    Activate: bool = ...,
) -> dict[str, Any]:
    ...
# update_ip_set method usage example with argument unpacking

kwargs: UpdateIPSetRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "IpSetId": ...,
}

parent.update_ip_set(**kwargs)
  1. See UpdateIPSetRequestRequestTypeDef

update_malware_protection_plan#

Updates an existing Malware Protection plan resource.

Type annotations and code completion for boto3.client("guardduty").update_malware_protection_plan method. boto3 documentation

# update_malware_protection_plan method definition

def update_malware_protection_plan(
    self,
    *,
    MalwareProtectionPlanId: str,
    Role: str = ...,
    Actions: MalwareProtectionPlanActionsTypeDef = ...,  # (1)
    ProtectedResource: UpdateProtectedResourceTypeDef = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See MalwareProtectionPlanActionsTypeDef
  2. See UpdateProtectedResourceTypeDef
  3. See EmptyResponseMetadataTypeDef 
# update_malware_protection_plan method usage example with argument unpacking

kwargs: UpdateMalwareProtectionPlanRequestRequestTypeDef = {  # (1)
    "MalwareProtectionPlanId": ...,
}

parent.update_malware_protection_plan(**kwargs)
  1. See UpdateMalwareProtectionPlanRequestRequestTypeDef

update_malware_scan_settings#

Updates the malware scan settings.

Type annotations and code completion for boto3.client("guardduty").update_malware_scan_settings method. boto3 documentation

# update_malware_scan_settings method definition

def update_malware_scan_settings(
    self,
    *,
    DetectorId: str,
    ScanResourceCriteria: ScanResourceCriteriaTypeDef = ...,  # (1)
    EbsSnapshotPreservation: EbsSnapshotPreservationType = ...,  # (2)
) -> dict[str, Any]:
    ...
  1. See ScanResourceCriteriaTypeDef
  2. See EbsSnapshotPreservationType 
# update_malware_scan_settings method usage example with argument unpacking

kwargs: UpdateMalwareScanSettingsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.update_malware_scan_settings(**kwargs)
  1. See UpdateMalwareScanSettingsRequestRequestTypeDef

update_member_detectors#

Contains information on member accounts to be updated.

Type annotations and code completion for boto3.client("guardduty").update_member_detectors method. boto3 documentation

# update_member_detectors method definition

def update_member_detectors(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
    DataSources: DataSourceConfigurationsTypeDef = ...,  # (1)
    Features: Sequence[MemberFeaturesConfigurationTypeDef] = ...,  # (2)
) -> UpdateMemberDetectorsResponseTypeDef:  # (3)
    ...
  1. See DataSourceConfigurationsTypeDef
  2. See MemberFeaturesConfigurationTypeDef
  3. See UpdateMemberDetectorsResponseTypeDef 
# update_member_detectors method usage example with argument unpacking

kwargs: UpdateMemberDetectorsRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "AccountIds": ...,
}

parent.update_member_detectors(**kwargs)
  1. See UpdateMemberDetectorsRequestRequestTypeDef

update_organization_configuration#

Configures the delegated administrator account with the provided values.

Type annotations and code completion for boto3.client("guardduty").update_organization_configuration method. boto3 documentation

# update_organization_configuration method definition

def update_organization_configuration(
    self,
    *,
    DetectorId: str,
    AutoEnable: bool = ...,
    DataSources: OrganizationDataSourceConfigurationsTypeDef = ...,  # (1)
    Features: Sequence[OrganizationFeatureConfigurationTypeDef] = ...,  # (2)
    AutoEnableOrganizationMembers: AutoEnableMembersType = ...,  # (3)
) -> dict[str, Any]:
    ...
  1. See OrganizationDataSourceConfigurationsTypeDef
  2. See OrganizationFeatureConfigurationTypeDef
  3. See AutoEnableMembersType 
# update_organization_configuration method usage example with argument unpacking

kwargs: UpdateOrganizationConfigurationRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
}

parent.update_organization_configuration(**kwargs)
  1. See UpdateOrganizationConfigurationRequestRequestTypeDef

update_publishing_destination#

Updates information about the publishing destination specified by the destinationId.

Type annotations and code completion for boto3.client("guardduty").update_publishing_destination method. boto3 documentation

# update_publishing_destination method definition

def update_publishing_destination(
    self,
    *,
    DetectorId: str,
    DestinationId: str,
    DestinationProperties: DestinationPropertiesTypeDef = ...,  # (1)
) -> dict[str, Any]:
    ...
  1. See DestinationPropertiesTypeDef 
# update_publishing_destination method usage example with argument unpacking

kwargs: UpdatePublishingDestinationRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "DestinationId": ...,
}

parent.update_publishing_destination(**kwargs)
  1. See UpdatePublishingDestinationRequestRequestTypeDef

update_threat_intel_set#

Updates the ThreatIntelSet specified by the ThreatIntelSet ID.

Type annotations and code completion for boto3.client("guardduty").update_threat_intel_set method. boto3 documentation

# update_threat_intel_set method definition

def update_threat_intel_set(
    self,
    *,
    DetectorId: str,
    ThreatIntelSetId: str,
    Name: str = ...,
    Location: str = ...,
    Activate: bool = ...,
) -> dict[str, Any]:
    ...
# update_threat_intel_set method usage example with argument unpacking

kwargs: UpdateThreatIntelSetRequestRequestTypeDef = {  # (1)
    "DetectorId": ...,
    "ThreatIntelSetId": ...,
}

parent.update_threat_intel_set(**kwargs)
  1. See UpdateThreatIntelSetRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("guardduty").get_paginator method with overloads.