Skip to content

Type definitions#

Index > CloudTrail > Type definitions

Auto-generated documentation for CloudTrail type annotations stubs module mypy-boto3-cloudtrail.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AdvancedEventSelectorUnionTypeDef#

# AdvancedEventSelectorUnionTypeDef definition

AdvancedEventSelectorUnionTypeDef = Union[
    AdvancedEventSelectorTypeDef,  # (1)
    AdvancedEventSelectorOutputTypeDef,  # (2)
]
  1. See AdvancedEventSelectorTypeDef
  2. See AdvancedEventSelectorOutputTypeDef

EventSelectorUnionTypeDef#

# EventSelectorUnionTypeDef definition

EventSelectorUnionTypeDef = Union[
    EventSelectorTypeDef,  # (1)
    EventSelectorOutputTypeDef,  # (2)
]
  1. See EventSelectorTypeDef
  2. See EventSelectorOutputTypeDef

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

AdvancedFieldSelectorOutputTypeDef#

# AdvancedFieldSelectorOutputTypeDef definition

class AdvancedFieldSelectorOutputTypeDef(TypedDict):
    Field: str,
    Equals: NotRequired[List[str]],
    StartsWith: NotRequired[List[str]],
    EndsWith: NotRequired[List[str]],
    NotEquals: NotRequired[List[str]],
    NotStartsWith: NotRequired[List[str]],
    NotEndsWith: NotRequired[List[str]],

AdvancedFieldSelectorTypeDef#

# AdvancedFieldSelectorTypeDef definition

class AdvancedFieldSelectorTypeDef(TypedDict):
    Field: str,
    Equals: NotRequired[Sequence[str]],
    StartsWith: NotRequired[Sequence[str]],
    EndsWith: NotRequired[Sequence[str]],
    NotEquals: NotRequired[Sequence[str]],
    NotStartsWith: NotRequired[Sequence[str]],
    NotEndsWith: NotRequired[Sequence[str]],

CancelQueryRequestRequestTypeDef#

# CancelQueryRequestRequestTypeDef definition

class CancelQueryRequestRequestTypeDef(TypedDict):
    QueryId: str,
    EventDataStore: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ChannelTypeDef#

# ChannelTypeDef definition

class ChannelTypeDef(TypedDict):
    ChannelArn: NotRequired[str],
    Name: NotRequired[str],

DestinationTypeDef#

# DestinationTypeDef definition

class DestinationTypeDef(TypedDict):
    Type: DestinationTypeType,  # (1)
    Location: str,
  1. See DestinationTypeType

DataResourceOutputTypeDef#

# DataResourceOutputTypeDef definition

class DataResourceOutputTypeDef(TypedDict):
    Type: NotRequired[str],
    Values: NotRequired[List[str]],

DataResourceTypeDef#

# DataResourceTypeDef definition

class DataResourceTypeDef(TypedDict):
    Type: NotRequired[str],
    Values: NotRequired[Sequence[str]],

DeleteChannelRequestRequestTypeDef#

# DeleteChannelRequestRequestTypeDef definition

class DeleteChannelRequestRequestTypeDef(TypedDict):
    Channel: str,

DeleteEventDataStoreRequestRequestTypeDef#

# DeleteEventDataStoreRequestRequestTypeDef definition

class DeleteEventDataStoreRequestRequestTypeDef(TypedDict):
    EventDataStore: str,

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef definition

class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DeleteTrailRequestRequestTypeDef#

# DeleteTrailRequestRequestTypeDef definition

class DeleteTrailRequestRequestTypeDef(TypedDict):
    Name: str,

DeregisterOrganizationDelegatedAdminRequestRequestTypeDef#

# DeregisterOrganizationDelegatedAdminRequestRequestTypeDef definition

class DeregisterOrganizationDelegatedAdminRequestRequestTypeDef(TypedDict):
    DelegatedAdminAccountId: str,

DescribeQueryRequestRequestTypeDef#

# DescribeQueryRequestRequestTypeDef definition

class DescribeQueryRequestRequestTypeDef(TypedDict):
    EventDataStore: NotRequired[str],
    QueryId: NotRequired[str],
    QueryAlias: NotRequired[str],

QueryStatisticsForDescribeQueryTypeDef#

# QueryStatisticsForDescribeQueryTypeDef definition

class QueryStatisticsForDescribeQueryTypeDef(TypedDict):
    EventsMatched: NotRequired[int],
    EventsScanned: NotRequired[int],
    BytesScanned: NotRequired[int],
    ExecutionTimeInMillis: NotRequired[int],
    CreationTime: NotRequired[datetime],

DescribeTrailsRequestRequestTypeDef#

# DescribeTrailsRequestRequestTypeDef definition

class DescribeTrailsRequestRequestTypeDef(TypedDict):
    trailNameList: NotRequired[Sequence[str]],
    includeShadowTrails: NotRequired[bool],

TrailTypeDef#

# TrailTypeDef definition

class TrailTypeDef(TypedDict):
    Name: NotRequired[str],
    S3BucketName: NotRequired[str],
    S3KeyPrefix: NotRequired[str],
    SnsTopicName: NotRequired[str],
    SnsTopicARN: NotRequired[str],
    IncludeGlobalServiceEvents: NotRequired[bool],
    IsMultiRegionTrail: NotRequired[bool],
    HomeRegion: NotRequired[str],
    TrailARN: NotRequired[str],
    LogFileValidationEnabled: NotRequired[bool],
    CloudWatchLogsLogGroupArn: NotRequired[str],
    CloudWatchLogsRoleArn: NotRequired[str],
    KmsKeyId: NotRequired[str],
    HasCustomEventSelectors: NotRequired[bool],
    HasInsightSelectors: NotRequired[bool],
    IsOrganizationTrail: NotRequired[bool],

DisableFederationRequestRequestTypeDef#

# DisableFederationRequestRequestTypeDef definition

class DisableFederationRequestRequestTypeDef(TypedDict):
    EventDataStore: str,

EnableFederationRequestRequestTypeDef#

# EnableFederationRequestRequestTypeDef definition

class EnableFederationRequestRequestTypeDef(TypedDict):
    EventDataStore: str,
    FederationRoleArn: str,

ResourceTypeDef#

# ResourceTypeDef definition

class ResourceTypeDef(TypedDict):
    ResourceType: NotRequired[str],
    ResourceName: NotRequired[str],

GetChannelRequestRequestTypeDef#

# GetChannelRequestRequestTypeDef definition

class GetChannelRequestRequestTypeDef(TypedDict):
    Channel: str,

IngestionStatusTypeDef#

# IngestionStatusTypeDef definition

class IngestionStatusTypeDef(TypedDict):
    LatestIngestionSuccessTime: NotRequired[datetime],
    LatestIngestionSuccessEventID: NotRequired[str],
    LatestIngestionErrorCode: NotRequired[str],
    LatestIngestionAttemptTime: NotRequired[datetime],
    LatestIngestionAttemptEventID: NotRequired[str],

GetEventDataStoreRequestRequestTypeDef#

# GetEventDataStoreRequestRequestTypeDef definition

class GetEventDataStoreRequestRequestTypeDef(TypedDict):
    EventDataStore: str,

PartitionKeyTypeDef#

# PartitionKeyTypeDef definition

class PartitionKeyTypeDef(TypedDict):
    Name: str,
    Type: str,

GetEventSelectorsRequestRequestTypeDef#

# GetEventSelectorsRequestRequestTypeDef definition

class GetEventSelectorsRequestRequestTypeDef(TypedDict):
    TrailName: str,

GetImportRequestRequestTypeDef#

# GetImportRequestRequestTypeDef definition

class GetImportRequestRequestTypeDef(TypedDict):
    ImportId: str,