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)
- 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)
- See SeverityType
- See StatusType
- See StateType
- 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],
SortCriteriaTypeDef#
# SortCriteriaTypeDef definition
class SortCriteriaTypeDef(TypedDict):
Field: NotRequired[FieldType], # (1)
SortOrder: NotRequired[SortOrderType], # (2)
- See FieldType
- 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)
UpdateInvestigationStateRequestRequestTypeDef#
# UpdateInvestigationStateRequestRequestTypeDef definition
class UpdateInvestigationStateRequestRequestTypeDef(TypedDict):
GraphArn: str,
InvestigationId: str,
State: StateType, # (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],
- See AccountTypeDef
CreateGraphResponseTypeDef#
# CreateGraphResponseTypeDef definition
class CreateGraphResponseTypeDef(TypedDict):
GraphArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeOrganizationConfigurationResponseTypeDef#
# DescribeOrganizationConfigurationResponseTypeDef definition
class DescribeOrganizationConfigurationResponseTypeDef(TypedDict):
AutoEnable: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
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)
- See EntityTypeType
- See StatusType
- See SeverityType
- See StateType
- See ResponseMetadataTypeDef
ListOrganizationAdminAccountsResponseTypeDef#
# ListOrganizationAdminAccountsResponseTypeDef definition
class ListOrganizationAdminAccountsResponseTypeDef(TypedDict):
Administrators: List[AdministratorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartInvestigationResponseTypeDef#
# StartInvestigationResponseTypeDef definition
class StartInvestigationResponseTypeDef(TypedDict):
InvestigationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteMembersResponseTypeDef#
# DeleteMembersResponseTypeDef definition
class DeleteMembersResponseTypeDef(TypedDict):
AccountIds: List[str],
UnprocessedAccounts: List[UnprocessedAccountTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DatasourcePackageIngestDetailTypeDef#
# DatasourcePackageIngestDetailTypeDef definition
class DatasourcePackageIngestDetailTypeDef(TypedDict):
DatasourcePackageIngestState: NotRequired[DatasourcePackageIngestStateType], # (1)
LastIngestStateChange: NotRequired[Dict[DatasourcePackageIngestStateType, TimestampForCollectionTypeDef]], # (2)
- See DatasourcePackageIngestStateType
- See DatasourcePackageIngestStateType TimestampForCollectionTypeDef
MembershipDatasourcesTypeDef#
# MembershipDatasourcesTypeDef definition
class MembershipDatasourcesTypeDef(TypedDict):
AccountId: NotRequired[str],
GraphArn: NotRequired[str],
DatasourcePackageIngestHistory: NotRequired[Dict[DatasourcePackageType, Dict[DatasourcePackageIngestStateType, TimestampForCollectionTypeDef]]], # (1)
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)
- See MemberStatusType
- See MemberDisabledReasonType
- See InvitationTypeType
- See DatasourcePackageType DatasourcePackageUsageInfoTypeDef
- See DatasourcePackageType DatasourcePackageIngestStateType
DateFilterTypeDef#
# DateFilterTypeDef definition
class DateFilterTypeDef(TypedDict):
StartInclusive: TimestampTypeDef,
EndInclusive: TimestampTypeDef,
StartInvestigationRequestRequestTypeDef#
# StartInvestigationRequestRequestTypeDef definition
class StartInvestigationRequestRequestTypeDef(TypedDict):
GraphArn: str,
EntityArn: str,
ScopeStartTime: TimestampTypeDef,
ScopeEndTime: TimestampTypeDef,
ListGraphsResponseTypeDef#
# ListGraphsResponseTypeDef definition
class ListGraphsResponseTypeDef(TypedDict):
GraphList: List[GraphTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See GraphTypeDef
- 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)
- See TTPsObservedDetailTypeDef
- See ImpossibleTravelDetailTypeDef
- See FlaggedIpAddressDetailTypeDef
- See NewGeolocationDetailTypeDef
- See NewAsoDetailTypeDef
- See NewUserAgentDetailTypeDef
- See RelatedFindingDetailTypeDef
- See RelatedFindingGroupDetailTypeDef
ListInvestigationsResponseTypeDef#
# ListInvestigationsResponseTypeDef definition
class ListInvestigationsResponseTypeDef(TypedDict):
InvestigationDetails: List[InvestigationDetailTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListDatasourcePackagesResponseTypeDef#
# ListDatasourcePackagesResponseTypeDef definition
class ListDatasourcePackagesResponseTypeDef(TypedDict):
DatasourcePackages: Dict[DatasourcePackageType, DatasourcePackageIngestDetailTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
BatchGetGraphMemberDatasourcesResponseTypeDef#
# BatchGetGraphMemberDatasourcesResponseTypeDef definition
class BatchGetGraphMemberDatasourcesResponseTypeDef(TypedDict):
MemberDatasources: List[MembershipDatasourcesTypeDef], # (1)
UnprocessedAccounts: List[UnprocessedAccountTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
BatchGetMembershipDatasourcesResponseTypeDef#
# BatchGetMembershipDatasourcesResponseTypeDef definition
class BatchGetMembershipDatasourcesResponseTypeDef(TypedDict):
MembershipDatasources: List[MembershipDatasourcesTypeDef], # (1)
UnprocessedGraphs: List[UnprocessedGraphTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
CreateMembersResponseTypeDef#
# CreateMembersResponseTypeDef definition
class CreateMembersResponseTypeDef(TypedDict):
Members: List[MemberDetailTypeDef], # (1)
UnprocessedAccounts: List[UnprocessedAccountTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetMembersResponseTypeDef#
# GetMembersResponseTypeDef definition
class GetMembersResponseTypeDef(TypedDict):
MemberDetails: List[MemberDetailTypeDef], # (1)
UnprocessedAccounts: List[UnprocessedAccountTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListInvitationsResponseTypeDef#
# ListInvitationsResponseTypeDef definition
class ListInvitationsResponseTypeDef(TypedDict):
Invitations: List[MemberDetailTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListMembersResponseTypeDef#
# ListMembersResponseTypeDef definition
class ListMembersResponseTypeDef(TypedDict):
MemberDetails: List[MemberDetailTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
FilterCriteriaTypeDef#
# FilterCriteriaTypeDef definition
class FilterCriteriaTypeDef(TypedDict):
Severity: NotRequired[StringFilterTypeDef], # (1)
Status: NotRequired[StringFilterTypeDef], # (1)
State: NotRequired[StringFilterTypeDef], # (1)
EntityArn: NotRequired[StringFilterTypeDef], # (1)
CreatedTime: NotRequired[DateFilterTypeDef], # (5)
- See StringFilterTypeDef
- See StringFilterTypeDef
- See StringFilterTypeDef
- See StringFilterTypeDef
- See DateFilterTypeDef
IndicatorTypeDef#
# IndicatorTypeDef definition
class IndicatorTypeDef(TypedDict):
IndicatorType: NotRequired[IndicatorTypeType], # (1)
IndicatorDetail: NotRequired[IndicatorDetailTypeDef], # (2)
ListInvestigationsRequestRequestTypeDef#
# ListInvestigationsRequestRequestTypeDef definition
class ListInvestigationsRequestRequestTypeDef(TypedDict):
GraphArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
FilterCriteria: NotRequired[FilterCriteriaTypeDef], # (1)
SortCriteria: NotRequired[SortCriteriaTypeDef], # (2)
ListIndicatorsResponseTypeDef#
# ListIndicatorsResponseTypeDef definition
class ListIndicatorsResponseTypeDef(TypedDict):
GraphArn: str,
InvestigationId: str,
Indicators: List[IndicatorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],