GuardDutyClient

Index > GuardDuty > GuardDutyClient

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

GuardDutyClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_guardduty.client import GuardDutyClient

session = Session()
async with session.client("guardduty") as client:
    client: GuardDutyClient

Exceptions

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

Usage example

async with session.client("guardduty") as client:
    try:
        do_something(client)
    except (
            client.BadRequestException,
        client.ClientError,
        client.InternalServerErrorException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_guardduty.client import Exceptions

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

Methods

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 session.client("guardduty").accept_administrator_invitation method. boto3 documentation

Method definition

await def accept_administrator_invitation(
    self,
    *,
    DetectorId: str,
    AdministratorId: str,
    InvitationId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("guardduty").accept_invitation method. boto3 documentation

Method definition

await def accept_invitation(
    self,
    *,
    DetectorId: str,
    MasterId: str,
    InvitationId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("guardduty").archive_findings method. boto3 documentation

Method definition

await def archive_findings(
    self,
    *,
    DetectorId: str,
    FindingIds: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.archive_findings(**kwargs)

1. See ArchiveFindingsRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

await def close(
    self,
) -> None:
    ...

create_detector

Creates a single Amazon GuardDuty detector.

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

Method definition

await def create_detector(
    self,
    *,
    Enable: bool,
    ClientToken: str = ...,
    FindingPublishingFrequency: FindingPublishingFrequencyType = ...,  # (1)
    DataSources: DataSourceConfigurationsTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateDetectorResponseTypeDef:  # (3)
    ...

1. See FindingPublishingFrequencyType
2. See DataSourceConfigurationsTypeDef
3. See CreateDetectorResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").create_filter method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("guardduty").create_ip_set method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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

parent.create_ip_set(**kwargs)

1. See CreateIPSetRequestRequestTypeDef

create_members

.

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

Method definition

await def create_members(
    self,
    *,
    DetectorId: str,
    AccountDetails: Sequence[AccountDetailTypeDef],  # (1)
) -> CreateMembersResponseTypeDef:  # (2)
    ...

1. See AccountDetailTypeDef
2. See CreateMembersResponseTypeDef

Usage example with kwargs

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

parent.create_members(**kwargs)

1. See CreateMembersRequestRequestTypeDef

create_publishing_destination

Creates a publishing destination to export findings to.

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

Method definition

await 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

Usage example with kwargs

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

parent.create_publishing_destination(**kwargs)

1. See CreatePublishingDestinationRequestRequestTypeDef

create_sample_findings

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

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

Method definition

await def create_sample_findings(
    self,
    *,
    DetectorId: str,
    FindingTypes: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("guardduty").create_threat_intel_set method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("guardduty").decline_invitations method. boto3 documentation

Method definition

await def decline_invitations(
    self,
    *,
    AccountIds: Sequence[str],
) -> DeclineInvitationsResponseTypeDef:  # (1)
    ...

1. See DeclineInvitationsResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").delete_detector method. boto3 documentation

Method definition

await def delete_detector(
    self,
    *,
    DetectorId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("guardduty").delete_filter method. boto3 documentation

Method definition

await def delete_filter(
    self,
    *,
    DetectorId: str,
    FilterName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_filter(**kwargs)

1. See DeleteFilterRequestRequestTypeDef

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 session.client("guardduty").delete_invitations method. boto3 documentation

Method definition

await def delete_invitations(
    self,
    *,
    AccountIds: Sequence[str],
) -> DeleteInvitationsResponseTypeDef:  # (1)
    ...

1. See DeleteInvitationsResponseTypeDef

Usage example with kwargs

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

parent.delete_invitations(**kwargs)

1. See DeleteInvitationsRequestRequestTypeDef

delete_ip_set

Deletes the IPSet specified by the ipSetId.

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

Method definition

await def delete_ip_set(
    self,
    *,
    DetectorId: str,
    IpSetId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_ip_set(**kwargs)

1. See DeleteIPSetRequestRequestTypeDef

delete_members

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

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

Method definition

await def delete_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> DeleteMembersResponseTypeDef:  # (1)
    ...

1. See DeleteMembersResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").delete_publishing_destination method. boto3 documentation

Method definition

await def delete_publishing_destination(
    self,
    *,
    DetectorId: str,
    DestinationId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("guardduty").delete_threat_intel_set method. boto3 documentation

Method definition

await def delete_threat_intel_set(
    self,
    *,
    DetectorId: str,
    ThreatIntelSetId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("guardduty").describe_malware_scans method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("guardduty").describe_organization_configuration method. boto3 documentation

Method definition

await def describe_organization_configuration(
    self,
    *,
    DetectorId: str,
) -> DescribeOrganizationConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeOrganizationConfigurationResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").describe_publishing_destination method. boto3 documentation

Method definition

await def describe_publishing_destination(
    self,
    *,
    DetectorId: str,
    DestinationId: str,
) -> DescribePublishingDestinationResponseTypeDef:  # (1)
    ...

1. See DescribePublishingDestinationResponseTypeDef

Usage example with kwargs

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

parent.describe_publishing_destination(**kwargs)

1. See DescribePublishingDestinationRequestRequestTypeDef

disable_organization_admin_account

Disables an Amazon Web Services account within the Organization as the GuardDuty delegated administrator.

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

Method definition

await def disable_organization_admin_account(
    self,
    *,
    AdminAccountId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("guardduty").disassociate_from_administrator_account method. boto3 documentation

Method definition

await def disassociate_from_administrator_account(
    self,
    *,
    DetectorId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("guardduty").disassociate_from_master_account method. boto3 documentation

Method definition

await def disassociate_from_master_account(
    self,
    *,
    DetectorId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_from_master_account(**kwargs)

1. See DisassociateFromMasterAccountRequestRequestTypeDef

disassociate_members

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

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

Method definition

await def disassociate_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> DisassociateMembersResponseTypeDef:  # (1)
    ...

1. See DisassociateMembersResponseTypeDef

Usage example with kwargs

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

parent.disassociate_members(**kwargs)

1. See DisassociateMembersRequestRequestTypeDef

enable_organization_admin_account

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

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

Method definition

await def enable_organization_admin_account(
    self,
    *,
    AdminAccountId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.enable_organization_admin_account(**kwargs)

1. See EnableOrganizationAdminAccountRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

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

get_administrator_account

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

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

Method definition

await def get_administrator_account(
    self,
    *,
    DetectorId: str,
) -> GetAdministratorAccountResponseTypeDef:  # (1)
    ...

1. See GetAdministratorAccountResponseTypeDef

Usage example with kwargs

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

parent.get_administrator_account(**kwargs)

1. See GetAdministratorAccountRequestRequestTypeDef

get_detector

Retrieves an Amazon GuardDuty detector specified by the detectorId.

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

Method definition

await def get_detector(
    self,
    *,
    DetectorId: str,
) -> GetDetectorResponseTypeDef:  # (1)
    ...

1. See GetDetectorResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").get_filter method. boto3 documentation

Method definition

await def get_filter(
    self,
    *,
    DetectorId: str,
    FilterName: str,
) -> GetFilterResponseTypeDef:  # (1)
    ...

1. See GetFilterResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").get_findings method. boto3 documentation

Method definition

await def get_findings(
    self,
    *,
    DetectorId: str,
    FindingIds: Sequence[str],
    SortCriteria: SortCriteriaTypeDef = ...,  # (1)
) -> GetFindingsResponseTypeDef:  # (2)
    ...

1. See SortCriteriaTypeDef
2. See GetFindingsResponseTypeDef

Usage example with kwargs

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

parent.get_findings(**kwargs)

1. See GetFindingsRequestRequestTypeDef

get_findings_statistics

Lists Amazon GuardDuty findings statistics for the specified detector ID.

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

Method definition

await def get_findings_statistics(
    self,
    *,
    DetectorId: str,
    FindingStatisticTypes: Sequence[FindingStatisticTypeType],  # (1)
    FindingCriteria: FindingCriteriaTypeDef = ...,  # (2)
) -> GetFindingsStatisticsResponseTypeDef:  # (3)
    ...

1. See FindingStatisticTypeType
2. See FindingCriteriaTypeDef
3. See GetFindingsStatisticsResponseTypeDef

Usage example with kwargs

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

parent.get_findings_statistics(**kwargs)

1. See GetFindingsStatisticsRequestRequestTypeDef

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 session.client("guardduty").get_invitations_count method. boto3 documentation

Method definition

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

1. See GetInvitationsCountResponseTypeDef

get_ip_set

Retrieves the IPSet specified by the ipSetId .

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

Method definition

await def get_ip_set(
    self,
    *,
    DetectorId: str,
    IpSetId: str,
) -> GetIPSetResponseTypeDef:  # (1)
    ...

1. See GetIPSetResponseTypeDef

Usage example with kwargs

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

parent.get_ip_set(**kwargs)

1. See GetIPSetRequestRequestTypeDef

get_malware_scan_settings

Returns the details of the malware scan settings.

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

Method definition

await def get_malware_scan_settings(
    self,
    *,
    DetectorId: str,
) -> GetMalwareScanSettingsResponseTypeDef:  # (1)
    ...

1. See GetMalwareScanSettingsResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").get_master_account method. boto3 documentation

Method definition

await def get_master_account(
    self,
    *,
    DetectorId: str,
) -> GetMasterAccountResponseTypeDef:  # (1)
    ...

1. See GetMasterAccountResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").get_member_detectors method. boto3 documentation

Method definition

await def get_member_detectors(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> GetMemberDetectorsResponseTypeDef:  # (1)
    ...

1. See GetMemberDetectorsResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").get_members method. boto3 documentation

Method definition

await def get_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> GetMembersResponseTypeDef:  # (1)
    ...

1. See GetMembersResponseTypeDef

Usage example with kwargs

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

parent.get_members(**kwargs)

1. See GetMembersRequestRequestTypeDef

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 session.client("guardduty").get_remaining_free_trial_days method. boto3 documentation

Method definition

await def get_remaining_free_trial_days(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str] = ...,
) -> GetRemainingFreeTrialDaysResponseTypeDef:  # (1)
    ...

1. See GetRemainingFreeTrialDaysResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").get_threat_intel_set method. boto3 documentation

Method definition

await def get_threat_intel_set(
    self,
    *,
    DetectorId: str,
    ThreatIntelSetId: str,
) -> GetThreatIntelSetResponseTypeDef:  # (1)
    ...

1. See GetThreatIntelSetResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").get_usage_statistics method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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

parent.get_usage_statistics(**kwargs)

1. See GetUsageStatisticsRequestRequestTypeDef

invite_members

Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account.

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

Method definition

await def invite_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
    DisableEmailNotification: bool = ...,
    Message: str = ...,
) -> InviteMembersResponseTypeDef:  # (1)
    ...

1. See InviteMembersResponseTypeDef

Usage example with kwargs

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

parent.invite_members(**kwargs)

1. See InviteMembersRequestRequestTypeDef

list_detectors

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

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

Method definition

await def list_detectors(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDetectorsResponseTypeDef:  # (1)
    ...

1. See ListDetectorsResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").list_filters method. boto3 documentation

Method definition

await def list_filters(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListFiltersResponseTypeDef:  # (1)
    ...

1. See ListFiltersResponseTypeDef

Usage example with kwargs

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

parent.list_filters(**kwargs)

1. See ListFiltersRequestRequestTypeDef

list_findings

Lists Amazon GuardDuty findings for the specified detector ID.

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

Method definition

await 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

Usage example with kwargs

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

parent.list_findings(**kwargs)

1. See ListFindingsRequestRequestTypeDef

list_invitations

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

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

Method definition

await def list_invitations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInvitationsResponseTypeDef:  # (1)
    ...

1. See ListInvitationsResponseTypeDef

Usage example with kwargs

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

parent.list_invitations(**kwargs)

1. See ListInvitationsRequestRequestTypeDef

list_ip_sets

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

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

Method definition

await def list_ip_sets(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListIPSetsResponseTypeDef:  # (1)
    ...

1. See ListIPSetsResponseTypeDef

Usage example with kwargs

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

parent.list_ip_sets(**kwargs)

1. See ListIPSetsRequestRequestTypeDef

list_members

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

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

Method definition

await def list_members(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    OnlyAssociated: str = ...,
) -> ListMembersResponseTypeDef:  # (1)
    ...

1. See ListMembersResponseTypeDef

Usage example with kwargs

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

parent.list_members(**kwargs)

1. See ListMembersRequestRequestTypeDef

list_organization_admin_accounts

Lists the accounts configured as GuardDuty delegated administrators.

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

Method definition

await def list_organization_admin_accounts(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListOrganizationAdminAccountsResponseTypeDef:  # (1)
    ...

1. See ListOrganizationAdminAccountsResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").list_publishing_destinations method. boto3 documentation

Method definition

await def list_publishing_destinations(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPublishingDestinationsResponseTypeDef:  # (1)
    ...

1. See ListPublishingDestinationsResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").list_tags_for_resource method. boto3 documentation

Method definition

await def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").list_threat_intel_sets method. boto3 documentation

Method definition

await def list_threat_intel_sets(
    self,
    *,
    DetectorId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListThreatIntelSetsResponseTypeDef:  # (1)
    ...

1. See ListThreatIntelSetsResponseTypeDef

Usage example with kwargs

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

parent.list_threat_intel_sets(**kwargs)

1. See ListThreatIntelSetsRequestRequestTypeDef

start_monitoring_members

Turns on GuardDuty monitoring of the specified member accounts.

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

Method definition

await def start_monitoring_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> StartMonitoringMembersResponseTypeDef:  # (1)
    ...

1. See StartMonitoringMembersResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").stop_monitoring_members method. boto3 documentation

Method definition

await def stop_monitoring_members(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
) -> StopMonitoringMembersResponseTypeDef:  # (1)
    ...

1. See StopMonitoringMembersResponseTypeDef

Usage example with kwargs

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 session.client("guardduty").tag_resource method. boto3 documentation

Method definition

await def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("guardduty").unarchive_findings method. boto3 documentation

Method definition

await def unarchive_findings(
    self,
    *,
    DetectorId: str,
    FindingIds: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("guardduty").untag_resource method. boto3 documentation

Method definition

await def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_detector

Updates the Amazon GuardDuty detector specified by the detectorId.

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

Method definition

await def update_detector(
    self,
    *,
    DetectorId: str,
    Enable: bool = ...,
    FindingPublishingFrequency: FindingPublishingFrequencyType = ...,  # (1)
    DataSources: DataSourceConfigurationsTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See FindingPublishingFrequencyType
2. See DataSourceConfigurationsTypeDef

Usage example with kwargs

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 session.client("guardduty").update_filter method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("guardduty").update_findings_feedback method. boto3 documentation

Method definition

await def update_findings_feedback(
    self,
    *,
    DetectorId: str,
    FindingIds: Sequence[str],
    Feedback: FeedbackType,  # (1)
    Comments: str = ...,
) -> Dict[str, Any]:
    ...

1. See FeedbackType

Usage example with kwargs

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 session.client("guardduty").update_ip_set method. boto3 documentation

Method definition

await def update_ip_set(
    self,
    *,
    DetectorId: str,
    IpSetId: str,
    Name: str = ...,
    Location: str = ...,
    Activate: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.update_ip_set(**kwargs)

1. See UpdateIPSetRequestRequestTypeDef

update_malware_scan_settings

Updates the malware scan settings.

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

Method definition

await def update_malware_scan_settings(
    self,
    *,
    DetectorId: str,
    ScanResourceCriteria: ScanResourceCriteriaTypeDef = ...,  # (1)
    EbsSnapshotPreservation: EbsSnapshotPreservationType = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See ScanResourceCriteriaTypeDef
2. See EbsSnapshotPreservationType

Usage example with kwargs

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 session.client("guardduty").update_member_detectors method. boto3 documentation

Method definition

await def update_member_detectors(
    self,
    *,
    DetectorId: str,
    AccountIds: Sequence[str],
    DataSources: DataSourceConfigurationsTypeDef = ...,  # (1)
) -> UpdateMemberDetectorsResponseTypeDef:  # (2)
    ...

1. See DataSourceConfigurationsTypeDef
2. See UpdateMemberDetectorsResponseTypeDef

Usage example with kwargs

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

parent.update_member_detectors(**kwargs)

1. See UpdateMemberDetectorsRequestRequestTypeDef

update_organization_configuration

Updates the delegated administrator account with the values provided.

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

Method definition

await def update_organization_configuration(
    self,
    *,
    DetectorId: str,
    AutoEnable: bool,
    DataSources: OrganizationDataSourceConfigurationsTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See OrganizationDataSourceConfigurationsTypeDef

Usage example with kwargs

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

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 session.client("guardduty").update_publishing_destination method. boto3 documentation

Method definition

await def update_publishing_destination(
    self,
    *,
    DetectorId: str,
    DestinationId: str,
    DestinationProperties: DestinationPropertiesTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See DestinationPropertiesTypeDef

Usage example with kwargs

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 session.client("guardduty").update_threat_intel_set method. boto3 documentation

Method definition

await def update_threat_intel_set(
    self,
    *,
    DetectorId: str,
    ThreatIntelSetId: str,
    Name: str = ...,
    Location: str = ...,
    Activate: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.update_threat_intel_set(**kwargs)

1. See UpdateThreatIntelSetRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> GuardDutyClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

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

• client.get_paginator("describe_malware_scans") -> DescribeMalwareScansPaginator
• client.get_paginator("list_detectors") -> ListDetectorsPaginator
• client.get_paginator("list_filters") -> ListFiltersPaginator
• client.get_paginator("list_findings") -> ListFindingsPaginator
• client.get_paginator("list_ip_sets") -> ListIPSetsPaginator
• client.get_paginator("list_invitations") -> ListInvitationsPaginator
• client.get_paginator("list_members") -> ListMembersPaginator
• client.get_paginator("list_organization_admin_accounts") -> ListOrganizationAdminAccountsPaginator
• client.get_paginator("list_threat_intel_sets") -> ListThreatIntelSetsPaginator