Skip to content

Type definitions#

Index > Detective > Type definitions

Auto-generated documentation for Detective type annotations stubs module mypy-boto3-detective.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AcceptInvitationRequestRequestTypeDef#

# AcceptInvitationRequestRequestTypeDef definition

class AcceptInvitationRequestRequestTypeDef(TypedDict):
    GraphArn: str,

AccountTypeDef#

# AccountTypeDef definition

class AccountTypeDef(TypedDict):
    AccountId: str,
    EmailAddress: str,

AdministratorTypeDef#

# AdministratorTypeDef definition

class AdministratorTypeDef(TypedDict):
    AccountId: NotRequired[str],
    GraphArn: NotRequired[str],
    DelegationTime: NotRequired[datetime],

BatchGetGraphMemberDatasourcesRequestRequestTypeDef#

# BatchGetGraphMemberDatasourcesRequestRequestTypeDef definition

class BatchGetGraphMemberDatasourcesRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    AccountIds: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

UnprocessedAccountTypeDef#

# UnprocessedAccountTypeDef definition

class UnprocessedAccountTypeDef(TypedDict):
    AccountId: NotRequired[str],
    Reason: NotRequired[str],

BatchGetMembershipDatasourcesRequestRequestTypeDef#

# BatchGetMembershipDatasourcesRequestRequestTypeDef definition

class BatchGetMembershipDatasourcesRequestRequestTypeDef(TypedDict):
    GraphArns: Sequence[str],

UnprocessedGraphTypeDef#

# UnprocessedGraphTypeDef definition

class UnprocessedGraphTypeDef(TypedDict):
    GraphArn: NotRequired[str],
    Reason: NotRequired[str],

CreateGraphRequestRequestTypeDef#

# CreateGraphRequestRequestTypeDef definition

class CreateGraphRequestRequestTypeDef(TypedDict):
    Tags: NotRequired[Mapping[str, str]],

TimestampForCollectionTypeDef#

# TimestampForCollectionTypeDef definition

class TimestampForCollectionTypeDef(TypedDict):
    Timestamp: NotRequired[datetime],

DatasourcePackageUsageInfoTypeDef#

# DatasourcePackageUsageInfoTypeDef definition

class DatasourcePackageUsageInfoTypeDef(TypedDict):
    VolumeUsageInBytes: NotRequired[int],
    VolumeUsageUpdateTime: NotRequired[datetime],

DeleteGraphRequestRequestTypeDef#

# DeleteGraphRequestRequestTypeDef definition

class DeleteGraphRequestRequestTypeDef(TypedDict):
    GraphArn: str,

DeleteMembersRequestRequestTypeDef#

# DeleteMembersRequestRequestTypeDef definition

class DeleteMembersRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    AccountIds: Sequence[str],

DescribeOrganizationConfigurationRequestRequestTypeDef#

# DescribeOrganizationConfigurationRequestRequestTypeDef definition

class DescribeOrganizationConfigurationRequestRequestTypeDef(TypedDict):
    GraphArn: str,

DisassociateMembershipRequestRequestTypeDef#

# DisassociateMembershipRequestRequestTypeDef definition

class DisassociateMembershipRequestRequestTypeDef(TypedDict):
    GraphArn: str,

EnableOrganizationAdminAccountRequestRequestTypeDef#

# EnableOrganizationAdminAccountRequestRequestTypeDef definition

class EnableOrganizationAdminAccountRequestRequestTypeDef(TypedDict):
    AccountId: str,

StringFilterTypeDef#

# StringFilterTypeDef definition

class StringFilterTypeDef(TypedDict):
    Value: str,

FlaggedIpAddressDetailTypeDef#

# FlaggedIpAddressDetailTypeDef definition

class FlaggedIpAddressDetailTypeDef(TypedDict):
    IpAddress: NotRequired[str],
    Reason: NotRequired[ReasonType],  # (1)
  1. See ReasonType

GetInvestigationRequestRequestTypeDef#

# GetInvestigationRequestRequestTypeDef definition

class GetInvestigationRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    InvestigationId: str,

GetMembersRequestRequestTypeDef#

# GetMembersRequestRequestTypeDef definition

class GetMembersRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    AccountIds: Sequence[str],

GraphTypeDef#

# GraphTypeDef definition

class GraphTypeDef(TypedDict):
    Arn: NotRequired[str],
    CreatedTime: NotRequired[datetime],

ImpossibleTravelDetailTypeDef#

# ImpossibleTravelDetailTypeDef definition

class ImpossibleTravelDetailTypeDef(TypedDict):
    StartingIpAddress: NotRequired[str],
    EndingIpAddress: NotRequired[str],
    StartingLocation: NotRequired[str],
    EndingLocation: NotRequired[str],
    HourlyTimeDelta: NotRequired[int],

NewAsoDetailTypeDef#

# NewAsoDetailTypeDef definition

class NewAsoDetailTypeDef(TypedDict):
    Aso: NotRequired[str],
    IsNewForEntireAccount: NotRequired[bool],

NewGeolocationDetailTypeDef#

# NewGeolocationDetailTypeDef definition

class NewGeolocationDetailTypeDef(TypedDict):
    Location: NotRequired[str],
    IpAddress: NotRequired[str],
    IsNewForEntireAccount: NotRequired[bool],

NewUserAgentDetailTypeDef#

# NewUserAgentDetailTypeDef definition

class NewUserAgentDetailTypeDef(TypedDict):
    UserAgent: NotRequired[str],
    IsNewForEntireAccount: NotRequired[bool],

RelatedFindingDetailTypeDef#

# RelatedFindingDetailTypeDef definition

class RelatedFindingDetailTypeDef(TypedDict):
    Arn: NotRequired[str],
    Type: NotRequired[str],
    IpAddress: NotRequired[str],

RelatedFindingGroupDetailTypeDef#

# RelatedFindingGroupDetailTypeDef definition

class RelatedFindingGroupDetailTypeDef(TypedDict):
    Id: NotRequired[str],

TTPsObservedDetailTypeDef#

# TTPsObservedDetailTypeDef definition

class TTPsObservedDetailTypeDef(TypedDict):
    Tactic: NotRequired[str],
    Technique: NotRequired[str],
    Procedure: NotRequired[str],
    IpAddress: NotRequired[str],
    APIName: NotRequired[str],
    APISuccessCount: NotRequired[int],
    APIFailureCount: NotRequired[int],

InvestigationDetailTypeDef#

# InvestigationDetailTypeDef definition

class InvestigationDetailTypeDef(TypedDict):
    InvestigationId: NotRequired[str],
    Severity: NotRequired[SeverityType],  # (1)
    Status: NotRequired[StatusType],  # (2)
    State: NotRequired[StateType],  # (3)
    CreatedTime: NotRequired[datetime],
    EntityArn: NotRequired[str],
    EntityType: NotRequired[EntityTypeType],  # (4)
  1. See SeverityType
  2. See StatusType
  3. See StateType
  4. See EntityTypeType

ListDatasourcePackagesRequestRequestTypeDef#

# ListDatasourcePackagesRequestRequestTypeDef definition

class ListDatasourcePackagesRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListGraphsRequestRequestTypeDef#

# ListGraphsRequestRequestTypeDef definition

class ListGraphsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListIndicatorsRequestRequestTypeDef#

# ListIndicatorsRequestRequestTypeDef definition

class ListIndicatorsRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    InvestigationId: str,
    IndicatorType: NotRequired[IndicatorTypeType],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See IndicatorTypeType

SortCriteriaTypeDef#

# SortCriteriaTypeDef definition

class SortCriteriaTypeDef(TypedDict):
    Field: NotRequired[FieldType],  # (1)
    SortOrder: NotRequired[SortOrderType],  # (2)
  1. See FieldType
  2. See SortOrderType

ListInvitationsRequestRequestTypeDef#

# ListInvitationsRequestRequestTypeDef definition

class ListInvitationsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListMembersRequestRequestTypeDef#

# ListMembersRequestRequestTypeDef definition

class ListMembersRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListOrganizationAdminAccountsRequestRequestTypeDef#

# ListOrganizationAdminAccountsRequestRequestTypeDef definition

class ListOrganizationAdminAccountsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

RejectInvitationRequestRequestTypeDef#

# RejectInvitationRequestRequestTypeDef definition

class RejectInvitationRequestRequestTypeDef(TypedDict):
    GraphArn: str,

StartMonitoringMemberRequestRequestTypeDef#

# StartMonitoringMemberRequestRequestTypeDef definition

class StartMonitoringMemberRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    AccountId: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateDatasourcePackagesRequestRequestTypeDef#

# UpdateDatasourcePackagesRequestRequestTypeDef definition

class UpdateDatasourcePackagesRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    DatasourcePackages: Sequence[DatasourcePackageType],  # (1)
  1. See DatasourcePackageType

UpdateInvestigationStateRequestRequestTypeDef#

# UpdateInvestigationStateRequestRequestTypeDef definition

class UpdateInvestigationStateRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    InvestigationId: str,
    State: StateType,  # (1)
  1. See StateType

UpdateOrganizationConfigurationRequestRequestTypeDef#

# UpdateOrganizationConfigurationRequestRequestTypeDef definition

class UpdateOrganizationConfigurationRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    AutoEnable: NotRequired[bool],

CreateMembersRequestRequestTypeDef#

# CreateMembersRequestRequestTypeDef definition

class CreateMembersRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    Accounts: Sequence[AccountTypeDef],  # (1)
    Message: NotRequired[str],
    DisableEmailNotification: NotRequired[bool],
  1. See AccountTypeDef

CreateGraphResponseTypeDef#

# CreateGraphResponseTypeDef definition

class CreateGraphResponseTypeDef(TypedDict):
    GraphArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeOrganizationConfigurationResponseTypeDef#

# DescribeOrganizationConfigurationResponseTypeDef definition

class DescribeOrganizationConfigurationResponseTypeDef(TypedDict):
    AutoEnable: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetInvestigationResponseTypeDef#

# GetInvestigationResponseTypeDef definition

class GetInvestigationResponseTypeDef(TypedDict):
    GraphArn: str,
    InvestigationId: str,
    EntityArn: str,
    EntityType: EntityTypeType,  # (1)
    CreatedTime: datetime,
    ScopeStartTime: datetime,
    ScopeEndTime: datetime,
    Status: StatusType,  # (2)
    Severity: SeverityType,  # (3)
    State: StateType,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See EntityTypeType
  2. See StatusType
  3. See SeverityType
  4. See StateType
  5. See ResponseMetadataTypeDef

ListOrganizationAdminAccountsResponseTypeDef#

# ListOrganizationAdminAccountsResponseTypeDef definition

class ListOrganizationAdminAccountsResponseTypeDef(TypedDict):
    Administrators: List[AdministratorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AdministratorTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartInvestigationResponseTypeDef#

# StartInvestigationResponseTypeDef definition

class StartInvestigationResponseTypeDef(TypedDict):
    InvestigationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteMembersResponseTypeDef#

# DeleteMembersResponseTypeDef definition

class DeleteMembersResponseTypeDef(TypedDict):
    AccountIds: List[str],
    UnprocessedAccounts: List[UnprocessedAccountTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UnprocessedAccountTypeDef
  2. See ResponseMetadataTypeDef

DatasourcePackageIngestDetailTypeDef#

# DatasourcePackageIngestDetailTypeDef definition

class DatasourcePackageIngestDetailTypeDef(TypedDict):
    DatasourcePackageIngestState: NotRequired[DatasourcePackageIngestStateType],  # (1)
    LastIngestStateChange: NotRequired[Dict[DatasourcePackageIngestStateType, TimestampForCollectionTypeDef]],  # (2)
  1. See DatasourcePackageIngestStateType
  2. See DatasourcePackageIngestStateType TimestampForCollectionTypeDef

MembershipDatasourcesTypeDef#

# MembershipDatasourcesTypeDef definition

class MembershipDatasourcesTypeDef(TypedDict):
    AccountId: NotRequired[str],
    GraphArn: NotRequired[str],
    DatasourcePackageIngestHistory: NotRequired[Dict[DatasourcePackageType, Dict[DatasourcePackageIngestStateType, TimestampForCollectionTypeDef]]],  # (1)
  1. See DatasourcePackageType DatasourcePackageIngestStateType TimestampForCollectionTypeDef

MemberDetailTypeDef#

# MemberDetailTypeDef definition

class MemberDetailTypeDef(TypedDict):
    AccountId: NotRequired[str],
    EmailAddress: NotRequired[str],
    GraphArn: NotRequired[str],
    MasterId: NotRequired[str],
    AdministratorId: NotRequired[str],
    Status: NotRequired[MemberStatusType],  # (1)
    DisabledReason: NotRequired[MemberDisabledReasonType],  # (2)
    InvitedTime: NotRequired[datetime],
    UpdatedTime: NotRequired[datetime],
    VolumeUsageInBytes: NotRequired[int],
    VolumeUsageUpdatedTime: NotRequired[datetime],
    PercentOfGraphUtilization: NotRequired[float],
    PercentOfGraphUtilizationUpdatedTime: NotRequired[datetime],
    InvitationType: NotRequired[InvitationTypeType],  # (3)
    VolumeUsageByDatasourcePackage: NotRequired[Dict[DatasourcePackageType, DatasourcePackageUsageInfoTypeDef]],  # (4)
    DatasourcePackageIngestStates: NotRequired[Dict[DatasourcePackageType, DatasourcePackageIngestStateType]],  # (5)
  1. See MemberStatusType
  2. See MemberDisabledReasonType
  3. See InvitationTypeType
  4. See DatasourcePackageType DatasourcePackageUsageInfoTypeDef
  5. See DatasourcePackageType DatasourcePackageIngestStateType

DateFilterTypeDef#

# DateFilterTypeDef definition

class DateFilterTypeDef(TypedDict):
    StartInclusive: Union[datetime, str],
    EndInclusive: Union[datetime, str],

StartInvestigationRequestRequestTypeDef#

# StartInvestigationRequestRequestTypeDef definition

class StartInvestigationRequestRequestTypeDef(TypedDict):
    GraphArn: str,
    EntityArn: str,
    ScopeStartTime: Union[datetime, str],
    ScopeEndTime: Union[datetime, str],

ListGraphsResponseTypeDef#

# ListGraphsResponseTypeDef definition

class ListGraphsResponseTypeDef(TypedDict):
    GraphList: List[GraphTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See GraphTypeDef
  2. See ResponseMetadataTypeDef

IndicatorDetailTypeDef#

# IndicatorDetailTypeDef definition

class IndicatorDetailTypeDef(TypedDict):
    TTPsObservedDetail: NotRequired[TTPsObservedDetailTypeDef],  # (1)
    ImpossibleTravelDetail: NotRequired[ImpossibleTravelDetailTypeDef],  # (2)
    FlaggedIpAddressDetail: NotRequired[FlaggedIpAddressDetailTypeDef],  # (3)
    NewGeolocationDetail: NotRequired[NewGeolocationDetailTypeDef],  # (4)
    NewAsoDetail: NotRequired[NewAsoDetailTypeDef],  # (5)
    NewUserAgentDetail: NotRequired[NewUserAgentDetailTypeDef],  # (6)
    RelatedFindingDetail: NotRequired[RelatedFindingDetailTypeDef],  # (7)
    RelatedFindingGroupDetail: NotRequired[RelatedFindingGroupDetailTypeDef],  # (8)
  1. See TTPsObservedDetailTypeDef
  2. See ImpossibleTravelDetailTypeDef
  3. See FlaggedIpAddressDetailTypeDef
  4. See NewGeolocationDetailTypeDef
  5. See NewAsoDetailTypeDef
  6. See NewUserAgentDetailTypeDef
  7. See