rboto-guardduty

rboto is an independent project maintained by Ferrumio. It is not affiliated with, sponsored by, or endorsed by Amazon Web Services (AWS).

Preview (Alpha). rboto is under active development. APIs may change between releases.

rboto provides an async-only, typed Python client for Amazon GuardDuty, powered by Rust. This package contains GuardDutyClient and 102 operations.

Installation

Requires Python 3.12 or newer and a native wheel for your Python version and platform.

python -m pip install "rboto[guardduty]"

You can also install rboto-guardduty directly; it installs the matching rboto package. Only the selected service is installed.

These are the package names to use when a release is available on your package index. If your index has no release yet, follow the source installation instructions.

Usage

Configure credentials through your environment, shared profile, or workload role. The example uses us-east-1; select a region where your service and resources are available. Resource names, identifiers, input files, and model IDs in the example are placeholders to replace with your own.

import asyncio

from rboto import GuardDutyClient


async def main() -> None:
    client = GuardDutyClient(region="us-east-1")
    response = await client.list_detectors(max_results=10)
    print(response.detector_ids)


if __name__ == "__main__":
    asyncio.run(main())

In an application with an event loop, call await main() instead of asyncio.run(main()). Reuse the client across calls. Constructing a client does not send a request.

API conventions

• Import the client with from rboto import GuardDutyClient.

• Every operation is asynchronous: use await client.method(...).

• Operation arguments are keyword-only and use the Python names listed below.

• Structured inputs use typed dictionaries and tagged unions from rboto_guardduty.types.

• Regular responses expose typed attributes; response.to_dict() converts them to a dictionary.

• Event-stream responses may be typed dictionaries containing async iterators. Follow the declared return type; consume event streams with async for.

• Byte streams are consumed asynchronously. await stream.read() buffers the complete body; iterate the stream when processing a large response.

• Direct operation calls return one page.

• Use async for page in client.paginators.method(...) for supported paginated operations. Paginators accept the same typed arguments as the corresponding client method.

• Catch modeled exceptions from rboto_guardduty.exceptions. Their error_code, message, and operation_name identify service failures.

Clients also accept profile, endpoint_url, or shared Session settings. See configuration, errors, and streaming.

Operations

This is the complete operation catalog for this generated package. “Required arguments” lists arguments without defaults in the Python signature. Service-side conditions may require additional arguments. Each method links to its complete signature, including optional arguments. Nested input definitions are in rboto_guardduty.types; native response definitions are in the package's _native.pyi.

Method	Required arguments	Return type
accept_administrator_invitation	detector_id: str, administrator_id: str, invitation_id: str	AcceptAdministratorInvitationOutput
accept_invitation	detector_id: str, master_id: str, invitation_id: str	AcceptInvitationOutput
archive_findings	detector_id: str, finding_ids: _Sequence[str]	ArchiveFindingsOutput
create_custom_detection_rule_association	rule_id: str, mode: AssociationMode	CreateCustomDetectionRuleAssociationOutput
create_custom_detection_rule_org_configuration	rule_id: str, mode: AssociationMode	CreateCustomDetectionRuleOrgConfigurationOutput
create_detector	enable: bool	CreateDetectorOutput
create_filter	detector_id: str, name: str, finding_criteria: FindingCriteria	CreateFilterOutput
create_investigation	detector_id: str, trigger_prompt: str	CreateInvestigationOutput
create_ip_set	detector_id: str, name: str, format: IpSetFormat, location: str, activate: bool	CreateIPSetOutput
create_malware_protection_plan	role: str, protected_resource: CreateProtectedResource	CreateMalwareProtectionPlanOutput
create_members	detector_id: str, account_details: _Sequence[AccountDetail]	CreateMembersOutput
create_publishing_destination	detector_id: str, destination_type: DestinationType, destination_properties: DestinationProperties	CreatePublishingDestinationOutput
create_sample_findings	detector_id: str	CreateSampleFindingsOutput
create_threat_entity_set	detector_id: str, name: str, format: ThreatEntitySetFormat, location: str, activate: bool	CreateThreatEntitySetOutput
create_threat_intel_set	detector_id: str, name: str, format: ThreatIntelSetFormat, location: str, activate: bool	CreateThreatIntelSetOutput
create_trusted_entity_set	detector_id: str, name: str, format: TrustedEntitySetFormat, location: str, activate: bool	CreateTrustedEntitySetOutput
decline_invitations	account_ids: _Sequence[str]	DeclineInvitationsOutput
delete_custom_detection_rule_association	rule_id: str, association_id: str	DeleteCustomDetectionRuleAssociationOutput
delete_custom_detection_rule_org_configuration	rule_id: str, mode: AssociationMode	DeleteCustomDetectionRuleOrgConfigurationOutput
delete_detector	detector_id: str	DeleteDetectorOutput
delete_filter	detector_id: str, filter_name: str	DeleteFilterOutput
delete_invitations	account_ids: _Sequence[str]	DeleteInvitationsOutput
delete_ip_set	detector_id: str, ip_set_id: str	DeleteIPSetOutput
delete_malware_protection_plan	malware_protection_plan_id: str	None
delete_members	detector_id: str, account_ids: _Sequence[str]	DeleteMembersOutput
delete_publishing_destination	detector_id: str, destination_id: str	DeletePublishingDestinationOutput
delete_threat_entity_set	detector_id: str, threat_entity_set_id: str	DeleteThreatEntitySetOutput
delete_threat_intel_set	detector_id: str, threat_intel_set_id: str	DeleteThreatIntelSetOutput
delete_trusted_entity_set	detector_id: str, trusted_entity_set_id: str	DeleteTrustedEntitySetOutput
describe_malware_scans	detector_id: str	DescribeMalwareScansOutput
describe_organization_configuration	detector_id: str	DescribeOrganizationConfigurationOutput
describe_publishing_destination	detector_id: str, destination_id: str	DescribePublishingDestinationOutput
disable_organization_admin_account	admin_account_id: str	DisableOrganizationAdminAccountOutput
disassociate_from_administrator_account	detector_id: str	DisassociateFromAdministratorAccountOutput
disassociate_from_master_account	detector_id: str	DisassociateFromMasterAccountOutput
disassociate_members	detector_id: str, account_ids: _Sequence[str]	DisassociateMembersOutput
enable_organization_admin_account	admin_account_id: str	EnableOrganizationAdminAccountOutput
get_administrator_account	detector_id: str	GetAdministratorAccountOutput
get_coverage_statistics	detector_id: str, statistics_type: _Sequence[CoverageStatisticsType]	GetCoverageStatisticsOutput
get_custom_detection_rule	rule_id: str	GetCustomDetectionRuleOutput
get_custom_detection_rule_association	rule_id: str, association_id: str	GetCustomDetectionRuleAssociationOutput
get_custom_detection_rule_org_configuration	rule_id: str, mode: AssociationMode	GetCustomDetectionRuleOrgConfigurationOutput
get_detector	detector_id: str	GetDetectorOutput
get_filter	detector_id: str, filter_name: str	GetFilterOutput
get_findings	detector_id: str, finding_ids: _Sequence[str]	GetFindingsOutput
get_findings_statistics	detector_id: str	GetFindingsStatisticsOutput
get_investigation	detector_id: str, investigation_id: str	GetInvestigationOutput
get_invitations_count	None	GetInvitationsCountOutput
get_ip_set	detector_id: str, ip_set_id: str	GetIPSetOutput
get_malware_protection_plan	malware_protection_plan_id: str	GetMalwareProtectionPlanOutput
get_malware_scan	scan_id: str	GetMalwareScanOutput
get_malware_scan_settings	detector_id: str	GetMalwareScanSettingsOutput
get_master_account	detector_id: str	GetMasterAccountOutput
get_member_detectors	detector_id: str, account_ids: _Sequence[str]	GetMemberDetectorsOutput
get_members	detector_id: str, account_ids: _Sequence[str]	GetMembersOutput
get_organization_statistics	None	GetOrganizationStatisticsOutput
get_remaining_free_trial_days	detector_id: str, account_ids: _Sequence[str]	GetRemainingFreeTrialDaysOutput
get_threat_entity_set	detector_id: str, threat_entity_set_id: str	GetThreatEntitySetOutput
get_threat_intel_set	detector_id: str, threat_intel_set_id: str	GetThreatIntelSetOutput
get_trusted_entity_set	detector_id: str, trusted_entity_set_id: str	GetTrustedEntitySetOutput
get_usage_statistics	detector_id: str, usage_statistic_type: UsageStatisticType, usage_criteria: UsageCriteria	GetUsageStatisticsOutput
invite_members	detector_id: str, account_ids: _Sequence[str]	InviteMembersOutput
list_coverage	detector_id: str	ListCoverageOutput
list_custom_detection_rule_associations	None	ListCustomDetectionRuleAssociationsOutput
list_custom_detection_rule_org_configurations	None	ListCustomDetectionRuleOrgConfigurationsOutput
list_custom_detection_rules	None	ListCustomDetectionRulesOutput
list_detectors	None	ListDetectorsOutput
list_filters	detector_id: str	ListFiltersOutput
list_findings	detector_id: str	ListFindingsOutput
list_investigations	detector_id: str	ListInvestigationsOutput
list_invitations	None	ListInvitationsOutput
list_ip_sets	detector_id: str	ListIPSetsOutput
list_malware_protection_plans	None	ListMalwareProtectionPlansOutput
list_malware_scans	None	ListMalwareScansOutput
list_members	detector_id: str	ListMembersOutput
list_organization_admin_accounts	None	ListOrganizationAdminAccountsOutput
list_publishing_destinations	detector_id: str	ListPublishingDestinationsOutput
list_tags_for_resource	resource_arn: str	ListTagsForResourceOutput
list_threat_entity_sets	detector_id: str	ListThreatEntitySetsOutput
list_threat_intel_sets	detector_id: str	ListThreatIntelSetsOutput
list_trusted_entity_sets	detector_id: str	ListTrustedEntitySetsOutput
send_object_malware_scan	None	SendObjectMalwareScanOutput
start_malware_scan	resource_arn: str	StartMalwareScanOutput
start_monitoring_members	detector_id: str, account_ids: _Sequence[str]	StartMonitoringMembersOutput
stop_monitoring_members	detector_id: str, account_ids: _Sequence[str]	StopMonitoringMembersOutput
tag_resource	resource_arn: str, tags: dict[str, str]	TagResourceOutput
unarchive_findings	detector_id: str, finding_ids: _Sequence[str]	UnarchiveFindingsOutput
untag_resource	resource_arn: str, tag_keys: _Sequence[str]	UntagResourceOutput
update_custom_detection_rule_association	rule_id: str, association_id: str, mode: AssociationMode	UpdateCustomDetectionRuleAssociationOutput
update_custom_detection_rule_org_configuration	rule_id: str, mode: AssociationMode	UpdateCustomDetectionRuleOrgConfigurationOutput
update_detector	detector_id: str	UpdateDetectorOutput
update_filter	detector_id: str, filter_name: str	UpdateFilterOutput
update_findings_feedback	detector_id: str, finding_ids: _Sequence[str], feedback: Feedback	UpdateFindingsFeedbackOutput
update_ip_set	detector_id: str, ip_set_id: str	UpdateIPSetOutput
update_malware_protection_plan	malware_protection_plan_id: str	None
update_malware_scan_settings	detector_id: str	UpdateMalwareScanSettingsOutput
update_member_detectors	detector_id: str, account_ids: _Sequence[str]	UpdateMemberDetectorsOutput
update_organization_configuration	detector_id: str	UpdateOrganizationConfigurationOutput
update_publishing_destination	detector_id: str, destination_id: str	UpdatePublishingDestinationOutput
update_threat_entity_set	detector_id: str, threat_entity_set_id: str	UpdateThreatEntitySetOutput
update_threat_intel_set	detector_id: str, threat_intel_set_id: str	UpdateThreatIntelSetOutput
update_trusted_entity_set	detector_id: str, trusted_entity_set_id: str	UpdateTrustedEntitySetOutput

Complete signatures

accept_administrator_invitation

async def accept_administrator_invitation(
    *,
    detector_id: str,
    administrator_id: str,
    invitation_id: str,
) -> AcceptAdministratorInvitationOutput: ...

accept_invitation

async def accept_invitation(
    *,
    detector_id: str,
    master_id: str,
    invitation_id: str,
) -> AcceptInvitationOutput: ...

archive_findings

async def archive_findings(
    *,
    detector_id: str,
    finding_ids: _Sequence[str],
) -> ArchiveFindingsOutput: ...

create_custom_detection_rule_association

async def create_custom_detection_rule_association(
    *,
    rule_id: str,
    mode: AssociationMode,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateCustomDetectionRuleAssociationOutput: ...

create_custom_detection_rule_org_configuration

async def create_custom_detection_rule_org_configuration(
    *,
    rule_id: str,
    mode: AssociationMode,
    include_account_ids: _Sequence[str] | None = None,
    exclude_account_ids: _Sequence[str] | None = None,
    client_token: str | None = None,
) -> CreateCustomDetectionRuleOrgConfigurationOutput: ...

create_detector

async def create_detector(
    *,
    enable: bool,
    client_token: str | None = None,
    finding_publishing_frequency: FindingPublishingFrequency | None = None,
    data_sources: DataSourceConfigurations | None = None,
    tags: dict[str, str] | None = None,
    features: _Sequence[DetectorFeatureConfiguration] | None = None,
) -> CreateDetectorOutput: ...

create_filter

async def create_filter(
    *,
    detector_id: str,
    name: str,
    finding_criteria: FindingCriteria,
    description: str | None = None,
    action: FilterAction | None = None,
    rank: int | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateFilterOutput: ...

create_investigation

async def create_investigation(
    *,
    detector_id: str,
    trigger_prompt: str,
    client_token: str | None = None,
) -> CreateInvestigationOutput: ...

create_ip_set

async def create_ip_set(
    *,
    detector_id: str,
    name: str,
    format: IpSetFormat,
    location: str,
    activate: bool,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
    expected_bucket_owner: str | None = None,
) -> CreateIPSetOutput: ...

create_malware_protection_plan

async def create_malware_protection_plan(
    *,
    role: str,
    protected_resource: CreateProtectedResource,
    client_token: str | None = None,
    actions: MalwareProtectionPlanActions | None = None,
    tags: dict[str, str] | None = None,
) -> CreateMalwareProtectionPlanOutput: ...

create_members

async def create_members(
    *,
    detector_id: str,
    account_details: _Sequence[AccountDetail],
) -> CreateMembersOutput: ...

create_publishing_destination

async def create_publishing_destination(
    *,
    detector_id: str,
    destination_type: DestinationType,
    destination_properties: DestinationProperties,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreatePublishingDestinationOutput: ...

create_sample_findings

async def create_sample_findings(
    *,
    detector_id: str,
    finding_types: _Sequence[str] | None = None,
) -> CreateSampleFindingsOutput: ...

create_threat_entity_set

async def create_threat_entity_set(
    *,
    detector_id: str,
    name: str,
    format: ThreatEntitySetFormat,
    location: str,
    activate: bool,
    expected_bucket_owner: str | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateThreatEntitySetOutput: ...

create_threat_intel_set

async def create_threat_intel_set(
    *,
    detector_id: str,
    name: str,
    format: ThreatIntelSetFormat,
    location: str,
    activate: bool,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
    expected_bucket_owner: str | None = None,
) -> CreateThreatIntelSetOutput: ...

create_trusted_entity_set

async def create_trusted_entity_set(
    *,
    detector_id: str,
    name: str,
    format: TrustedEntitySetFormat,
    location: str,
    activate: bool,
    expected_bucket_owner: str | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateTrustedEntitySetOutput: ...

decline_invitations

async def decline_invitations(
    *,
    account_ids: _Sequence[str],
) -> DeclineInvitationsOutput: ...

delete_custom_detection_rule_association

async def delete_custom_detection_rule_association(
    *,
    rule_id: str,
    association_id: str,
) -> DeleteCustomDetectionRuleAssociationOutput: ...

delete_custom_detection_rule_org_configuration

async def delete_custom_detection_rule_org_configuration(
    *,
    rule_id: str,
    mode: AssociationMode,
) -> DeleteCustomDetectionRuleOrgConfigurationOutput: ...

delete_detector

async def delete_detector(
    *,
    detector_id: str,
) -> DeleteDetectorOutput: ...

delete_filter

async def delete_filter(
    *,
    detector_id: str,
    filter_name: str,
) -> DeleteFilterOutput: ...

delete_invitations

async def delete_invitations(
    *,
    account_ids: _Sequence[str],
) -> DeleteInvitationsOutput: ...

delete_ip_set

async def delete_ip_set(
    *,
    detector_id: str,
    ip_set_id: str,
) -> DeleteIPSetOutput: ...

delete_malware_protection_plan

async def delete_malware_protection_plan(
    *,
    malware_protection_plan_id: str,
) -> None: ...

delete_members

async def delete_members(
    *,
    detector_id: str,
    account_ids: _Sequence[str],
) -> DeleteMembersOutput: ...

delete_publishing_destination

async def delete_publishing_destination(
    *,
    detector_id: str,
    destination_id: str,
) -> DeletePublishingDestinationOutput: ...

delete_threat_entity_set

async def delete_threat_entity_set(
    *,
    detector_id: str,
    threat_entity_set_id: str,
) -> DeleteThreatEntitySetOutput: ...

delete_threat_intel_set

async def delete_threat_intel_set(
    *,
    detector_id: str,
    threat_intel_set_id: str,
) -> DeleteThreatIntelSetOutput: ...

delete_trusted_entity_set

async def delete_trusted_entity_set(
    *,
    detector_id: str,
    trusted_entity_set_id: str,
) -> DeleteTrustedEntitySetOutput: ...

describe_malware_scans

async def describe_malware_scans(
    *,
    detector_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
    filter_criteria: FilterCriteria | None = None,
    sort_criteria: SortCriteria | None = None,
) -> DescribeMalwareScansOutput: ...

Also available as client.paginators.describe_malware_scans(...), returning an async iterator of the response type above.

describe_organization_configuration

async def describe_organization_configuration(
    *,
    detector_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> DescribeOrganizationConfigurationOutput: ...

Also available as client.paginators.describe_organization_configuration(...), returning an async iterator of the response type above.

describe_publishing_destination

async def describe_publishing_destination(
    *,
    detector_id: str,
    destination_id: str,
) -> DescribePublishingDestinationOutput: ...

disable_organization_admin_account

async def disable_organization_admin_account(
    *,
    admin_account_id: str,
) -> DisableOrganizationAdminAccountOutput: ...

disassociate_from_administrator_account

async def disassociate_from_administrator_account(
    *,
    detector_id: str,
) -> DisassociateFromAdministratorAccountOutput: ...

disassociate_from_master_account

async def disassociate_from_master_account(
    *,
    detector_id: str,
) -> DisassociateFromMasterAccountOutput: ...

disassociate_members

async def disassociate_members(
    *,
    detector_id: str,
    account_ids: _Sequence[str],
) -> DisassociateMembersOutput: ...

enable_organization_admin_account

async def enable_organization_admin_account(
    *,
    admin_account_id: str,
) -> EnableOrganizationAdminAccountOutput: ...

get_administrator_account

async def get_administrator_account(
    *,
    detector_id: str,
) -> GetAdministratorAccountOutput: ...

get_coverage_statistics

async def get_coverage_statistics(
    *,
    detector_id: str,
    statistics_type: _Sequence[CoverageStatisticsType],
    filter_criteria: CoverageFilterCriteria | None = None,
) -> GetCoverageStatisticsOutput: ...

get_custom_detection_rule

async def get_custom_detection_rule(
    *,
    rule_id: str,
) -> GetCustomDetectionRuleOutput: ...

get_custom_detection_rule_association

async def get_custom_detection_rule_association(
    *,
    rule_id: str,
    association_id: str,
) -> GetCustomDetectionRuleAssociationOutput: ...

get_custom_detection_rule_org_configuration

async def get_custom_detection_rule_org_configuration(
    *,
    rule_id: str,
    mode: AssociationMode,
) -> GetCustomDetectionRuleOrgConfigurationOutput: ...

get_detector

async def get_detector(
    *,
    detector_id: str,
) -> GetDetectorOutput: ...

get_filter

async def get_filter(
    *,
    detector_id: str,
    filter_name: str,
) -> GetFilterOutput: ...

get_findings

async def get_findings(
    *,
    detector_id: str,
    finding_ids: _Sequence[str],
    sort_criteria: SortCriteria | None = None,
) -> GetFindingsOutput: ...

get_findings_statistics

async def get_findings_statistics(
    *,
    detector_id: str,
    finding_statistic_types: _Sequence[FindingStatisticType] | None = None,
    finding_criteria: FindingCriteria | None = None,
    group_by: GroupByType | None = None,
    order_by: OrderBy | None = None,
    max_results: int | None = None,
) -> GetFindingsStatisticsOutput: ...

get_investigation

async def get_investigation(
    *,
    detector_id: str,
    investigation_id: str,
) -> GetInvestigationOutput: ...

get_invitations_count

async def get_invitations_count() -> GetInvitationsCountOutput: ...

get_ip_set

async def get_ip_set(
    *,
    detector_id: str,
    ip_set_id: str,
) -> GetIPSetOutput: ...

get_malware_protection_plan

async def get_malware_protection_plan(
    *,
    malware_protection_plan_id: str,
) -> GetMalwareProtectionPlanOutput: ...

get_malware_scan

async def get_malware_scan(
    *,
    scan_id: str,
) -> GetMalwareScanOutput: ...

get_malware_scan_settings

async def get_malware_scan_settings(
    *,
    detector_id: str,
) -> GetMalwareScanSettingsOutput: ...

get_master_account

async def get_master_account(
    *,
    detector_id: str,
) -> GetMasterAccountOutput: ...

get_member_detectors

async def get_member_detectors(
    *,
    detector_id: str,
    account_ids: _Sequence[str],
) -> GetMemberDetectorsOutput: ...

get_members

async def get_members(
    *,
    detector_id: str,
    account_ids: _Sequence[str],
) -> GetMembersOutput: ...

get_organization_statistics

async def get_organization_statistics() -> GetOrganizationStatisticsOutput: ...

get_remaining_free_trial_days

async def get_remaining_free_trial_days(
    *,
    detector_id: str,
    account_ids: _Sequence[str],
) -> GetRemainingFreeTrialDaysOutput: ...

get_threat_entity_set

async def get_threat_entity_set(
    *,
    detector_id: str,
    threat_entity_set_id: str,
) -> GetThreatEntitySetOutput: ...

get_threat_intel_set

async def get_threat_intel_set(
    *,
    detector_id: str,
    threat_intel_set_id: str,
) -> GetThreatIntelSetOutput: ...

get_trusted_entity_set

async def get_trusted_entity_set(
    *,
    detector_id: str,
    trusted_entity_set_id: str,
) -> GetTrustedEntitySetOutput: ...

get_usage_statistics

async def get_usage_statistics(
    *,
    detector_id: str,
    usage_statistic_type: UsageStatisticType,
    usage_criteria: UsageCriteria,
    unit: str | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> GetUsageStatisticsOutput: ...

Also available as client.paginators.get_usage_statistics(...), returning an async iterator of the response type above.

invite_members

async def invite_members(
    *,
    detector_id: str,
    account_ids: _Sequence[str],
    disable_email_notification: bool | None = None,
    message: str | None = None,
) -> InviteMembersOutput: ...

list_coverage

async def list_coverage(
    *,
    detector_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
    filter_criteria: CoverageFilterCriteria | None = None,
    sort_criteria: CoverageSortCriteria | None = None,
) -> ListCoverageOutput: ...

Also available as client.paginators.list_coverage(...), returning an async iterator of the response type above.

list_custom_detection_rule_associations

async def list_custom_detection_rule_associations(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
    rule_id: str | None = None,
    mode: AssociationMode | None = None,
) -> ListCustomDetectionRuleAssociationsOutput: ...

Also available as client.paginators.list_custom_detection_rule_associations(...), returning an async iterator of the response type above.

list_custom_detection_rule_org_configurations

async def list_custom_detection_rule_org_configurations(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
    status: DetectionRuleConfigurationStatus | None = None,
) -> ListCustomDetectionRuleOrgConfigurationsOutput: ...

Also available as client.paginators.list_custom_detection_rule_org_configurations(...), returning an async iterator of the response type above.

list_custom_detection_rules

async def list_custom_detection_rules(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
    filters: _Sequence[DetectionRuleFilter] | None = None,
) -> ListCustomDetectionRulesOutput: ...

Also available as client.paginators.list_custom_detection_rules(...), returning an async iterator of the response type above.

list_detectors

async def list_detectors(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListDetectorsOutput: ...

Also available as client.paginators.list_detectors(...), returning an async iterator of the response type above.

list_filters

async def list_filters(
    *,
    detector_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListFiltersOutput: ...

Also available as client.paginators.list_filters(...), returning an async iterator of the response type above.

list_findings

async def list_findings(
    *,
    detector_id: str,
    finding_criteria: FindingCriteria | None = None,
    sort_criteria: SortCriteria | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListFindingsOutput: ...

Also available as client.paginators.list_findings(...), returning an async iterator of the response type above.

list_investigations

async def list_investigations(
    *,
    detector_id: str,
    sort_criteria: InvestigationSortCriteria | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListInvestigationsOutput: ...

Also available as client.paginators.list_investigations(...), returning an async iterator of the response type above.

list_invitations

async def list_invitations(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListInvitationsOutput: ...

Also available as client.paginators.list_invitations(...), returning an async iterator of the response type above.

list_ip_sets

async def list_ip_sets(
    *,
    detector_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListIPSetsOutput: ...

Also available as client.paginators.list_ip_sets(...), returning an async iterator of the response type above.

list_malware_protection_plans

async def list_malware_protection_plans(
    *,
    next_token: str | None = None,
) -> ListMalwareProtectionPlansOutput: ...

list_malware_scans

async def list_malware_scans(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
    filter_criteria: ListMalwareScansFilterCriteria | None = None,
    sort_criteria: SortCriteria | None = None,
) -> ListMalwareScansOutput: ...

Also available as client.paginators.list_malware_scans(...), returning an async iterator of the response type above.

list_members

async def list_members(
    *,
    detector_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
    only_associated: str | None = None,
) -> ListMembersOutput: ...

Also available as client.paginators.list_members(...), returning an async iterator of the response type above.

list_organization_admin_accounts

async def list_organization_admin_accounts(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListOrganizationAdminAccountsOutput: ...

Also available as client.paginators.list_organization_admin_accounts(...), returning an async iterator of the response type above.

list_publishing_destinations

async def list_publishing_destinations(
    *,
    detector_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListPublishingDestinationsOutput: ...

Also available as client.paginators.list_publishing_destinations(...), returning an async iterator of the response type above.

list_tags_for_resource

async def list_tags_for_resource(
    *,
    resource_arn: str,
) -> ListTagsForResourceOutput: ...

list_threat_entity_sets

async def list_threat_entity_sets(
    *,
    detector_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListThreatEntitySetsOutput: ...

Also available as client.paginators.list_threat_entity_sets(...), returning an async iterator of the response type above.

list_threat_intel_sets

async def list_threat_intel_sets(
    *,
    detector_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListThreatIntelSetsOutput: ...

Also available as client.paginators.list_threat_intel_sets(...), returning an async iterator of the response type above.

list_trusted_entity_sets

async def list_trusted_entity_sets(
    *,
    detector_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListTrustedEntitySetsOutput: ...

Also available as client.paginators.list_trusted_entity_sets(...), returning an async iterator of the response type above.

send_object_malware_scan

async def send_object_malware_scan(
    *,
    s3_object: S3ObjectForSendObjectMalwareScan | None = None,
) -> SendObjectMalwareScanOutput: ...

start_malware_scan

async def start_malware_scan(
    *,
    resource_arn: str,
    client_token: str | None = None,
    scan_configuration: StartMalwareScanConfiguration | None = None,
) -> StartMalwareScanOutput: ...

start_monitoring_members

async def start_monitoring_members(
    *,
    detector_id: str,
    account_ids: _Sequence[str],
) -> StartMonitoringMembersOutput: ...

stop_monitoring_members

async def stop_monitoring_members(
    *,
    detector_id: str,
    account_ids: _Sequence[str],
) -> StopMonitoringMembersOutput: ...

tag_resource

async def tag_resource(
    *,
    resource_arn: str,
    tags: dict[str, str],
) -> TagResourceOutput: ...

unarchive_findings

async def unarchive_findings(
    *,
    detector_id: str,
    finding_ids: _Sequence[str],
) -> UnarchiveFindingsOutput: ...

untag_resource

async def untag_resource(
    *,
    resource_arn: str,
    tag_keys: _Sequence[str],
) -> UntagResourceOutput: ...

update_custom_detection_rule_association

async def update_custom_detection_rule_association(
    *,
    rule_id: str,
    association_id: str,
    mode: AssociationMode,
) -> UpdateCustomDetectionRuleAssociationOutput: ...

update_custom_detection_rule_org_configuration

async def update_custom_detection_rule_org_configuration(
    *,
    rule_id: str,
    mode: AssociationMode,
    include_account_ids: _Sequence[str] | None = None,
    exclude_account_ids: _Sequence[str] | None = None,
) -> UpdateCustomDetectionRuleOrgConfigurationOutput: ...

update_detector

async def update_detector(
    *,
    detector_id: str,
    enable: bool | None = None,
    finding_publishing_frequency: FindingPublishingFrequency | None = None,
    data_sources: DataSourceConfigurations | None = None,
    features: _Sequence[DetectorFeatureConfiguration] | None = None,
) -> UpdateDetectorOutput: ...

update_filter

async def update_filter(
    *,
    detector_id: str,
    filter_name: str,
    description: str | None = None,
    action: FilterAction | None = None,
    rank: int | None = None,
    finding_criteria: FindingCriteria | None = None,
) -> UpdateFilterOutput: ...

update_findings_feedback

async def update_findings_feedback(
    *,
    detector_id: str,
    finding_ids: _Sequence[str],
    feedback: Feedback,
    comments: str | None = None,
) -> UpdateFindingsFeedbackOutput: ...

update_ip_set

async def update_ip_set(
    *,
    detector_id: str,
    ip_set_id: str,
    name: str | None = None,
    location: str | None = None,
    activate: bool | None = None,
    expected_bucket_owner: str | None = None,
) -> UpdateIPSetOutput: ...

update_malware_protection_plan

async def update_malware_protection_plan(
    *,
    malware_protection_plan_id: str,
    role: str | None = None,
    actions: MalwareProtectionPlanActions | None = None,
    protected_resource: UpdateProtectedResource | None = None,
) -> None: ...

update_malware_scan_settings

async def update_malware_scan_settings(
    *,
    detector_id: str,
    scan_resource_criteria: ScanResourceCriteria | None = None,
    ebs_snapshot_preservation: EbsSnapshotPreservation | None = None,
) -> UpdateMalwareScanSettingsOutput: ...

update_member_detectors

async def update_member_detectors(
    *,
    detector_id: str,
    account_ids: _Sequence[str],
    data_sources: DataSourceConfigurations | None = None,
    features: _Sequence[MemberFeaturesConfiguration] | None = None,
) -> UpdateMemberDetectorsOutput: ...

update_organization_configuration

async def update_organization_configuration(
    *,
    detector_id: str,
    auto_enable: bool | None = None,
    data_sources: OrganizationDataSourceConfigurations | None = None,
    features: _Sequence[OrganizationFeatureConfiguration] | None = None,
    auto_enable_organization_members: AutoEnableMembers | None = None,
) -> UpdateOrganizationConfigurationOutput: ...

update_publishing_destination

async def update_publishing_destination(
    *,
    detector_id: str,
    destination_id: str,
    destination_properties: DestinationProperties | None = None,
) -> UpdatePublishingDestinationOutput: ...

update_threat_entity_set

async def update_threat_entity_set(
    *,
    detector_id: str,
    threat_entity_set_id: str,
    name: str | None = None,
    location: str | None = None,
    expected_bucket_owner: str | None = None,
    activate: bool | None = None,
) -> UpdateThreatEntitySetOutput: ...

update_threat_intel_set

async def update_threat_intel_set(
    *,
    detector_id: str,
    threat_intel_set_id: str,
    name: str | None = None,
    location: str | None = None,
    activate: bool | None = None,
    expected_bucket_owner: str | None = None,
) -> UpdateThreatIntelSetOutput: ...

update_trusted_entity_set

async def update_trusted_entity_set(
    *,
    detector_id: str,
    trusted_entity_set_id: str,
    name: str | None = None,
    location: str | None = None,
    expected_bucket_owner: str | None = None,
    activate: bool | None = None,
) -> UpdateTrustedEntitySetOutput: ...

Links

• Service guide
• Repository
• Issues
• Releases

Licensed under Apache-2.0.