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,
]
AdvancedFieldSelectorUnionTypeDef#
# AdvancedFieldSelectorUnionTypeDef definition
AdvancedFieldSelectorUnionTypeDef = Union[
AdvancedFieldSelectorTypeDef, # (1)
AdvancedFieldSelectorOutputTypeDef, # (2)
]
DataResourceUnionTypeDef#
# DataResourceUnionTypeDef definition
DataResourceUnionTypeDef = Union[
DataResourceTypeDef, # (1)
DataResourceOutputTypeDef, # (2)
]
AdvancedEventSelectorUnionTypeDef#
# AdvancedEventSelectorUnionTypeDef definition
AdvancedEventSelectorUnionTypeDef = Union[
AdvancedEventSelectorTypeDef, # (1)
AdvancedEventSelectorOutputTypeDef, # (2)
]
EventSelectorUnionTypeDef#
# EventSelectorUnionTypeDef definition
EventSelectorUnionTypeDef = Union[
EventSelectorTypeDef, # (1)
EventSelectorOutputTypeDef, # (2)
]
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,
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],
GenerateQueryRequestRequestTypeDef#
# GenerateQueryRequestRequestTypeDef definition
class GenerateQueryRequestRequestTypeDef(TypedDict):
EventDataStores: Sequence[str],
Prompt: 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,
ImportStatisticsTypeDef#
# ImportStatisticsTypeDef definition
class ImportStatisticsTypeDef(TypedDict):
PrefixesFound: NotRequired[int],
PrefixesCompleted: NotRequired[int],
FilesCompleted: NotRequired[int],
EventsCompleted: NotRequired[int],
FailedEntries: NotRequired[int],
GetInsightSelectorsRequestRequestTypeDef#
# GetInsightSelectorsRequestRequestTypeDef definition
class GetInsightSelectorsRequestRequestTypeDef(TypedDict):
TrailName: NotRequired[str],
EventDataStore: NotRequired[str],
InsightSelectorTypeDef#
# InsightSelectorTypeDef definition
class InsightSelectorTypeDef(TypedDict):
InsightType: NotRequired[InsightTypeType], # (1)
- See InsightTypeType
GetQueryResultsRequestRequestTypeDef#
# GetQueryResultsRequestRequestTypeDef definition
class GetQueryResultsRequestRequestTypeDef(TypedDict):
QueryId: str,
EventDataStore: NotRequired[str],
NextToken: NotRequired[str],
MaxQueryResults: NotRequired[int],
QueryStatisticsTypeDef#
# QueryStatisticsTypeDef definition
class QueryStatisticsTypeDef(TypedDict):
ResultsCount: NotRequired[int],
TotalResultsCount: NotRequired[int],
BytesScanned: NotRequired[int],
GetResourcePolicyRequestRequestTypeDef#
# GetResourcePolicyRequestRequestTypeDef definition
class GetResourcePolicyRequestRequestTypeDef(TypedDict):
ResourceArn: str,
GetTrailRequestRequestTypeDef#
# GetTrailRequestRequestTypeDef definition
class GetTrailRequestRequestTypeDef(TypedDict):
Name: str,
GetTrailStatusRequestRequestTypeDef#
# GetTrailStatusRequestRequestTypeDef definition
class GetTrailStatusRequestRequestTypeDef(TypedDict):
Name: str,
ImportFailureListItemTypeDef#
# ImportFailureListItemTypeDef definition
class ImportFailureListItemTypeDef(TypedDict):
Location: NotRequired[str],
Status: NotRequired[ImportFailureStatusType], # (1)
ErrorType: NotRequired[str],
ErrorMessage: NotRequired[str],
LastUpdatedTime: NotRequired[datetime],
S3ImportSourceTypeDef#
# S3ImportSourceTypeDef definition
class S3ImportSourceTypeDef(TypedDict):
S3LocationUri: str,
S3BucketRegion: str,
S3BucketAccessRoleArn: str,
ImportsListItemTypeDef#
# ImportsListItemTypeDef definition
class ImportsListItemTypeDef(TypedDict):
ImportId: NotRequired[str],
ImportStatus: NotRequired[ImportStatusType], # (1)
Destinations: NotRequired[List[str]],
CreatedTimestamp: NotRequired[datetime],
UpdatedTimestamp: NotRequired[datetime],
- See ImportStatusType
ListChannelsRequestRequestTypeDef#
# ListChannelsRequestRequestTypeDef definition
class ListChannelsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListEventDataStoresRequestRequestTypeDef#
# ListEventDataStoresRequestRequestTypeDef definition
class ListEventDataStoresRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListImportFailuresRequestRequestTypeDef#
# ListImportFailuresRequestRequestTypeDef definition
class ListImportFailuresRequestRequestTypeDef(TypedDict):
ImportId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListImportsRequestRequestTypeDef#
# ListImportsRequestRequestTypeDef definition
class ListImportsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
Destination: NotRequired[str],
ImportStatus: NotRequired[ImportStatusType], # (1)
NextToken: NotRequired[str],
- See ImportStatusType
PublicKeyTypeDef#
# PublicKeyTypeDef definition
class PublicKeyTypeDef(TypedDict):
Value: NotRequired[bytes],
ValidityStartTime: NotRequired[datetime],
ValidityEndTime: NotRequired[datetime],
Fingerprint: NotRequired[str],
QueryTypeDef#
# QueryTypeDef definition
class QueryTypeDef(TypedDict):
QueryId: NotRequired[str],
QueryStatus: NotRequired[QueryStatusType], # (1)
CreationTime: NotRequired[datetime],
- See QueryStatusType
ListTagsRequestRequestTypeDef#
# ListTagsRequestRequestTypeDef definition
class ListTagsRequestRequestTypeDef(TypedDict):
ResourceIdList: Sequence[str],
NextToken: NotRequired[str],
ListTrailsRequestRequestTypeDef#
# ListTrailsRequestRequestTypeDef definition
class ListTrailsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
TrailInfoTypeDef#
# TrailInfoTypeDef definition
class TrailInfoTypeDef(TypedDict):
TrailARN: NotRequired[str],
Name: NotRequired[str],
HomeRegion: NotRequired[str],
LookupAttributeTypeDef#
# LookupAttributeTypeDef definition
class LookupAttributeTypeDef(TypedDict):
AttributeKey: LookupAttributeKeyType, # (1)
AttributeValue: str,
PutResourcePolicyRequestRequestTypeDef#
# PutResourcePolicyRequestRequestTypeDef definition
class PutResourcePolicyRequestRequestTypeDef(TypedDict):
ResourceArn: str,
ResourcePolicy: str,
RegisterOrganizationDelegatedAdminRequestRequestTypeDef#
# RegisterOrganizationDelegatedAdminRequestRequestTypeDef definition
class RegisterOrganizationDelegatedAdminRequestRequestTypeDef(TypedDict):
MemberAccountId: str,
RestoreEventDataStoreRequestRequestTypeDef#
# RestoreEventDataStoreRequestRequestTypeDef definition
class RestoreEventDataStoreRequestRequestTypeDef(TypedDict):
EventDataStore: str,
StartEventDataStoreIngestionRequestRequestTypeDef#
# StartEventDataStoreIngestionRequestRequestTypeDef definition
class StartEventDataStoreIngestionRequestRequestTypeDef(TypedDict):
EventDataStore: str,
StartLoggingRequestRequestTypeDef#
# StartLoggingRequestRequestTypeDef definition
class StartLoggingRequestRequestTypeDef(TypedDict):
Name: str,
StartQueryRequestRequestTypeDef#
# StartQueryRequestRequestTypeDef definition
class StartQueryRequestRequestTypeDef(TypedDict):
QueryStatement: NotRequired[str],
DeliveryS3Uri: NotRequired[str],
QueryAlias: NotRequired[str],
QueryParameters: NotRequired[Sequence[str]],
StopEventDataStoreIngestionRequestRequestTypeDef#
# StopEventDataStoreIngestionRequestRequestTypeDef definition
class StopEventDataStoreIngestionRequestRequestTypeDef(TypedDict):
EventDataStore: str,
StopImportRequestRequestTypeDef#
# StopImportRequestRequestTypeDef definition
class StopImportRequestRequestTypeDef(TypedDict):
ImportId: str,
StopLoggingRequestRequestTypeDef#
# StopLoggingRequestRequestTypeDef definition
class StopLoggingRequestRequestTypeDef(TypedDict):
Name: str,
UpdateTrailRequestRequestTypeDef#
# UpdateTrailRequestRequestTypeDef definition
class UpdateTrailRequestRequestTypeDef(TypedDict):
Name: str,
S3BucketName: NotRequired[str],
S3KeyPrefix: NotRequired[str],
SnsTopicName: NotRequired[str],
IncludeGlobalServiceEvents: NotRequired[bool],
IsMultiRegionTrail: NotRequired[bool],
EnableLogFileValidation: NotRequired[bool],
CloudWatchLogsLogGroupArn: NotRequired[str],
CloudWatchLogsRoleArn: NotRequired[str],
KmsKeyId: NotRequired[str],
IsOrganizationTrail: NotRequired[bool],
AddTagsRequestRequestTypeDef#
# AddTagsRequestRequestTypeDef definition
class AddTagsRequestRequestTypeDef(TypedDict):
ResourceId: str,
TagsList: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateTrailRequestRequestTypeDef#
# CreateTrailRequestRequestTypeDef definition
class CreateTrailRequestRequestTypeDef(TypedDict):
Name: str,
S3BucketName: str,
S3KeyPrefix: NotRequired[str],
SnsTopicName: NotRequired[str],
IncludeGlobalServiceEvents: NotRequired[bool],
IsMultiRegionTrail: NotRequired[bool],
EnableLogFileValidation: NotRequired[bool],
CloudWatchLogsLogGroupArn: NotRequired[str],
CloudWatchLogsRoleArn: NotRequired[str],
KmsKeyId: NotRequired[str],
IsOrganizationTrail: NotRequired[bool],
TagsList: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
RemoveTagsRequestRequestTypeDef#
# RemoveTagsRequestRequestTypeDef definition
class RemoveTagsRequestRequestTypeDef(TypedDict):
ResourceId: str,
TagsList: Sequence[TagTypeDef], # (1)
- See TagTypeDef
ResourceTagTypeDef#
# ResourceTagTypeDef definition
class ResourceTagTypeDef(TypedDict):
ResourceId: NotRequired[str],
TagsList: NotRequired[List[TagTypeDef]], # (1)
- See TagTypeDef
AdvancedEventSelectorOutputTypeDef#
# AdvancedEventSelectorOutputTypeDef definition
class AdvancedEventSelectorOutputTypeDef(TypedDict):
FieldSelectors: List[AdvancedFieldSelectorOutputTypeDef], # (1)
Name: NotRequired[str],
CancelQueryResponseTypeDef#
# CancelQueryResponseTypeDef definition
class CancelQueryResponseTypeDef(TypedDict):
QueryId: str,
QueryStatus: QueryStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateTrailResponseTypeDef#
# CreateTrailResponseTypeDef definition
class CreateTrailResponseTypeDef(TypedDict):
Name: str,
S3BucketName: str,
S3KeyPrefix: str,
SnsTopicName: str,
SnsTopicARN: str,
IncludeGlobalServiceEvents: bool,
IsMultiRegionTrail: bool,
TrailARN: str,
LogFileValidationEnabled: bool,
CloudWatchLogsLogGroupArn: str,
CloudWatchLogsRoleArn: str,
KmsKeyId: str,
IsOrganizationTrail: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DisableFederationResponseTypeDef#
# DisableFederationResponseTypeDef definition
class DisableFederationResponseTypeDef(TypedDict):
EventDataStoreArn: str,
FederationStatus: FederationStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EnableFederationResponseTypeDef#
# EnableFederationResponseTypeDef definition
class EnableFederationResponseTypeDef(TypedDict):
EventDataStoreArn: str,
FederationStatus: FederationStatusType, # (1)
FederationRoleArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GenerateQueryResponseTypeDef#
# GenerateQueryResponseTypeDef definition
class GenerateQueryResponseTypeDef(TypedDict):
QueryStatement: str,
QueryAlias: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetResourcePolicyResponseTypeDef#
# GetResourcePolicyResponseTypeDef definition
class GetResourcePolicyResponseTypeDef(TypedDict):
ResourceArn: str,
ResourcePolicy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetTrailStatusResponseTypeDef#
# GetTrailStatusResponseTypeDef definition
class GetTrailStatusResponseTypeDef(TypedDict):
IsLogging: bool,
LatestDeliveryError: str,
LatestNotificationError: str,
LatestDeliveryTime: datetime,
LatestNotificationTime: datetime,
StartLoggingTime: datetime,
StopLoggingTime: datetime,
LatestCloudWatchLogsDeliveryError: str,
LatestCloudWatchLogsDeliveryTime: datetime,
LatestDigestDeliveryTime: datetime,
LatestDigestDeliveryError: str,
LatestDeliveryAttemptTime: str,
LatestNotificationAttemptTime: str,
LatestNotificationAttemptSucceeded: str,
LatestDeliveryAttemptSucceeded: str,
TimeLoggingStarted: str,
TimeLoggingStopped: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListInsightsMetricDataResponseTypeDef#
# ListInsightsMetricDataResponseTypeDef definition
class ListInsightsMetricDataResponseTypeDef(TypedDict):
EventSource: str,
EventName: str,
InsightType: InsightTypeType, # (1)
ErrorCode: str,
Timestamps: List[datetime],
Values: List[float],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
PutResourcePolicyResponseTypeDef#
# PutResourcePolicyResponseTypeDef definition
class PutResourcePolicyResponseTypeDef(TypedDict):
ResourceArn: str,
ResourcePolicy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartQueryResponseTypeDef#
# StartQueryResponseTypeDef definition
class StartQueryResponseTypeDef(TypedDict):
QueryId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateTrailResponseTypeDef#
# UpdateTrailResponseTypeDef definition
class UpdateTrailResponseTypeDef(TypedDict):
Name: str,
S3BucketName: str,
S3KeyPrefix: str,
SnsTopicName: str,
SnsTopicARN: str,
IncludeGlobalServiceEvents: bool,
IsMultiRegionTrail: bool,
TrailARN: str,
LogFileValidationEnabled: bool,
CloudWatchLogsLogGroupArn: str,
CloudWatchLogsRoleArn: str,
KmsKeyId: str,
IsOrganizationTrail: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListChannelsResponseTypeDef#
# ListChannelsResponseTypeDef definition
class ListChannelsResponseTypeDef(TypedDict):
Channels: List[ChannelTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
CreateChannelRequestRequestTypeDef#
# CreateChannelRequestRequestTypeDef definition
class CreateChannelRequestRequestTypeDef(TypedDict):
Name: str,
Source: str,
Destinations: Sequence[DestinationTypeDef], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See DestinationTypeDef
- See TagTypeDef
CreateChannelResponseTypeDef#
# CreateChannelResponseTypeDef definition
class CreateChannelResponseTypeDef(TypedDict):
ChannelArn: str,
Name: str,
Source: str,
Destinations: List[DestinationTypeDef], # (1)
Tags: List[TagTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See DestinationTypeDef
- See TagTypeDef
- See ResponseMetadataTypeDef
UpdateChannelRequestRequestTypeDef#
# UpdateChannelRequestRequestTypeDef definition
class UpdateChannelRequestRequestTypeDef(TypedDict):
Channel: str,
Destinations: NotRequired[Sequence[DestinationTypeDef]], # (1)
Name: NotRequired[str],
UpdateChannelResponseTypeDef#
# UpdateChannelResponseTypeDef definition
class UpdateChannelResponseTypeDef(TypedDict):
ChannelArn: str,
Name: str,
Source: str,
Destinations: List[DestinationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EventSelectorOutputTypeDef#
# EventSelectorOutputTypeDef definition
class EventSelectorOutputTypeDef(TypedDict):
ReadWriteType: NotRequired[ReadWriteTypeType], # (1)
IncludeManagementEvents: NotRequired[bool],
DataResources: NotRequired[List[DataResourceOutputTypeDef]], # (2)
ExcludeManagementEventSources: NotRequired[List[str]],
DescribeQueryResponseTypeDef#
# DescribeQueryResponseTypeDef definition
class DescribeQueryResponseTypeDef(TypedDict):
QueryId: str,
QueryString: str,
QueryStatus: QueryStatusType, # (1)
QueryStatistics: QueryStatisticsForDescribeQueryTypeDef, # (2)
ErrorMessage: str,
DeliveryS3Uri: str,
DeliveryStatus: DeliveryStatusType, # (3)
Prompt: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See QueryStatusType
- See QueryStatisticsForDescribeQueryTypeDef
- See DeliveryStatusType
- See ResponseMetadataTypeDef
DescribeTrailsResponseTypeDef#
# DescribeTrailsResponseTypeDef definition
class DescribeTrailsResponseTypeDef(TypedDict):
trailList: List[TrailTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TrailTypeDef
- See ResponseMetadataTypeDef
GetTrailResponseTypeDef#
# GetTrailResponseTypeDef definition
class GetTrailResponseTypeDef(TypedDict):
Trail: TrailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TrailTypeDef
- See ResponseMetadataTypeDef
EventTypeDef#
# EventTypeDef definition
class EventTypeDef(TypedDict):
EventId: NotRequired[str],
EventName: NotRequired[str],
ReadOnly: NotRequired[str],
AccessKeyId: NotRequired[str],
EventTime: NotRequired[datetime],
EventSource: NotRequired[str],
Username: NotRequired[str],
Resources: NotRequired[List[ResourceTypeDef]], # (1)
CloudTrailEvent: NotRequired[str],
- See ResourceTypeDef
GetInsightSelectorsResponseTypeDef#
# GetInsightSelectorsResponseTypeDef definition
class GetInsightSelectorsResponseTypeDef(TypedDict):
TrailARN: str,
InsightSelectors: List[InsightSelectorTypeDef], # (1)
EventDataStoreArn: str,
InsightsDestination: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutInsightSelectorsRequestRequestTypeDef#
# PutInsightSelectorsRequestRequestTypeDef definition
class PutInsightSelectorsRequestRequestTypeDef(TypedDict):
InsightSelectors: Sequence[InsightSelectorTypeDef], # (1)
TrailName: NotRequired[str],
EventDataStore: NotRequired[str],
InsightsDestination: NotRequired[str],
PutInsightSelectorsResponseTypeDef#
# PutInsightSelectorsResponseTypeDef definition
class PutInsightSelectorsResponseTypeDef(TypedDict):
TrailARN: str,
InsightSelectors: List[InsightSelectorTypeDef], # (1)
EventDataStoreArn: str,
InsightsDestination: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetQueryResultsResponseTypeDef#
# GetQueryResultsResponseTypeDef definition
class GetQueryResultsResponseTypeDef(TypedDict):
QueryStatus: QueryStatusType, # (1)
QueryStatistics: QueryStatisticsTypeDef, # (2)
QueryResultRows: List[List[Dict[str, str]]],
ErrorMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
NextToken: NotRequired[str],
ListImportFailuresResponseTypeDef#
# ListImportFailuresResponseTypeDef definition
class ListImportFailuresResponseTypeDef(TypedDict):
Failures: List[ImportFailureListItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ImportSourceTypeDef#
# ImportSourceTypeDef definition
class ImportSourceTypeDef(TypedDict):
S3: S3ImportSourceTypeDef, # (1)
ListImportsResponseTypeDef#
# ListImportsResponseTypeDef definition
class ListImportsResponseTypeDef(TypedDict):
Imports: List[ImportsListItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListImportFailuresRequestListImportFailuresPaginateTypeDef#
# ListImportFailuresRequestListImportFailuresPaginateTypeDef definition
class ListImportFailuresRequestListImportFailuresPaginateTypeDef(TypedDict):
ImportId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListImportsRequestListImportsPaginateTypeDef#
# ListImportsRequestListImportsPaginateTypeDef definition
class ListImportsRequestListImportsPaginateTypeDef(TypedDict):
Destination: NotRequired[str],
ImportStatus: NotRequired[ImportStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListTagsRequestListTagsPaginateTypeDef#
# ListTagsRequestListTagsPaginateTypeDef definition
class ListTagsRequestListTagsPaginateTypeDef(TypedDict):
ResourceIdList: Sequence[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTrailsRequestListTrailsPaginateTypeDef#
# ListTrailsRequestListTrailsPaginateTypeDef definition
class ListTrailsRequestListTrailsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListInsightsMetricDataRequestRequestTypeDef#
# ListInsightsMetricDataRequestRequestTypeDef definition
class ListInsightsMetricDataRequestRequestTypeDef(TypedDict):
EventSource: str,
EventName: str,
InsightType: InsightTypeType, # (1)
ErrorCode: NotRequired[str],
StartTime: NotRequired[TimestampTypeDef],
EndTime: NotRequired[TimestampTypeDef],
Period: NotRequired[int],
DataType: NotRequired[InsightsMetricDataTypeType], # (2)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListPublicKeysRequestListPublicKeysPaginateTypeDef#
# ListPublicKeysRequestListPublicKeysPaginateTypeDef definition
class ListPublicKeysRequestListPublicKeysPaginateTypeDef(TypedDict):
StartTime: NotRequired[TimestampTypeDef],
EndTime: NotRequired[TimestampTypeDef],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPublicKeysRequestRequestTypeDef#
# ListPublicKeysRequestRequestTypeDef definition
class ListPublicKeysRequestRequestTypeDef(TypedDict):
StartTime: NotRequired[TimestampTypeDef],
EndTime: NotRequired[TimestampTypeDef],
NextToken: NotRequired[str],
ListQueriesRequestRequestTypeDef#
# ListQueriesRequestRequestTypeDef definition
class ListQueriesRequestRequestTypeDef(TypedDict):
EventDataStore: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
StartTime: NotRequired[TimestampTypeDef],
EndTime: NotRequired[TimestampTypeDef],
QueryStatus: NotRequired[QueryStatusType], # (1)
- See QueryStatusType
ListPublicKeysResponseTypeDef#
# ListPublicKeysResponseTypeDef definition
class ListPublicKeysResponseTypeDef(TypedDict):
PublicKeyList: List[PublicKeyTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListQueriesResponseTypeDef#
# ListQueriesResponseTypeDef definition
class ListQueriesResponseTypeDef(TypedDict):
Queries: List[QueryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See QueryTypeDef
- See ResponseMetadataTypeDef
ListTrailsResponseTypeDef#
# ListTrailsResponseTypeDef definition
class ListTrailsResponseTypeDef(TypedDict):
Trails: List[TrailInfoTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
LookupEventsRequestLookupEventsPaginateTypeDef#
# LookupEventsRequestLookupEventsPaginateTypeDef definition
class LookupEventsRequestLookupEventsPaginateTypeDef(TypedDict):
LookupAttributes: NotRequired[Sequence[LookupAttributeTypeDef]], # (1)
StartTime: NotRequired[TimestampTypeDef],
EndTime: NotRequired[TimestampTypeDef],
EventCategory: NotRequired[EventCategoryType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
LookupEventsRequestRequestTypeDef#
# LookupEventsRequestRequestTypeDef definition
class LookupEventsRequestRequestTypeDef(TypedDict):
LookupAttributes: NotRequired[Sequence[LookupAttributeTypeDef]], # (1)
StartTime: NotRequired[TimestampTypeDef],
EndTime: NotRequired[TimestampTypeDef],
EventCategory: NotRequired[EventCategoryType], # (2)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTagsResponseTypeDef#
# ListTagsResponseTypeDef definition
class ListTagsResponseTypeDef(TypedDict):
ResourceTagList: List[ResourceTagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
CreateEventDataStoreResponseTypeDef#
# CreateEventDataStoreResponseTypeDef definition
class CreateEventDataStoreResponseTypeDef(TypedDict):
EventDataStoreArn: str,
Name: str,
Status: EventDataStoreStatusType, # (1)
AdvancedEventSelectors: List[AdvancedEventSelectorOutputTypeDef], # (2)
MultiRegionEnabled: bool,
OrganizationEnabled: bool,
RetentionPeriod: int,
TerminationProtectionEnabled: bool,
TagsList: List[TagTypeDef], # (3)
CreatedTimestamp: datetime,
UpdatedTimestamp: datetime,
KmsKeyId: str,
BillingMode: BillingModeType, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See EventDataStoreStatusType
- See AdvancedEventSelectorOutputTypeDef
- See TagTypeDef
- See BillingModeType
- See ResponseMetadataTypeDef
EventDataStoreTypeDef#
# EventDataStoreTypeDef definition
class EventDataStoreTypeDef(TypedDict):
EventDataStoreArn: NotRequired[str],
Name: NotRequired[str],
TerminationProtectionEnabled: NotRequired[bool],
Status: NotRequired[EventDataStoreStatusType], # (1)
AdvancedEventSelectors: NotRequired[List[AdvancedEventSelectorOutputTypeDef]], # (2)
MultiRegionEnabled: NotRequired[bool],
OrganizationEnabled: NotRequired[bool],
RetentionPeriod: NotRequired[int],
CreatedTimestamp: NotRequired[datetime],
UpdatedTimestamp: NotRequired[datetime],
GetEventDataStoreResponseTypeDef#
# GetEventDataStoreResponseTypeDef definition
class GetEventDataStoreResponseTypeDef(TypedDict):
EventDataStoreArn: str,
Name: str,
Status: EventDataStoreStatusType, # (1)
AdvancedEventSelectors: List[AdvancedEventSelectorOutputTypeDef], # (2)
MultiRegionEnabled: bool,
OrganizationEnabled: bool,
RetentionPeriod: int,
TerminationProtectionEnabled: bool,
CreatedTimestamp: datetime,
UpdatedTimestamp: datetime,
KmsKeyId: str,
BillingMode: BillingModeType, # (3)
FederationStatus: FederationStatusType, # (4)
FederationRoleArn: str,
PartitionKeys: List[PartitionKeyTypeDef], # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See EventDataStoreStatusType
- See AdvancedEventSelectorOutputTypeDef
- See BillingModeType
- See FederationStatusType
- See PartitionKeyTypeDef
- See ResponseMetadataTypeDef
RestoreEventDataStoreResponseTypeDef#
# RestoreEventDataStoreResponseTypeDef definition
class RestoreEventDataStoreResponseTypeDef(TypedDict):
EventDataStoreArn: str,
Name: str,
Status: EventDataStoreStatusType, # (1)
AdvancedEventSelectors: List[AdvancedEventSelectorOutputTypeDef], # (2)
MultiRegionEnabled: bool,
OrganizationEnabled: bool,
RetentionPeriod: int,
TerminationProtectionEnabled: bool,
CreatedTimestamp: datetime,
UpdatedTimestamp: datetime,
KmsKeyId: str,
BillingMode: BillingModeType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See EventDataStoreStatusType
- See AdvancedEventSelectorOutputTypeDef
- See BillingModeType
- See ResponseMetadataTypeDef
SourceConfigTypeDef#
# SourceConfigTypeDef definition
class SourceConfigTypeDef(TypedDict):
ApplyToAllRegions: NotRequired[bool],
AdvancedEventSelectors: NotRequired[List[AdvancedEventSelectorOutputTypeDef]], # (1)
UpdateEventDataStoreResponseTypeDef#
# UpdateEventDataStoreResponseTypeDef definition
class UpdateEventDataStoreResponseTypeDef(TypedDict):
EventDataStoreArn: str,
Name: str,
Status: EventDataStoreStatusType, # (1)
AdvancedEventSelectors: List[AdvancedEventSelectorOutputTypeDef], # (2)
MultiRegionEnabled: bool,
OrganizationEnabled: bool,
RetentionPeriod: int,
TerminationProtectionEnabled: bool,
CreatedTimestamp: datetime,
UpdatedTimestamp: datetime,
KmsKeyId: str,
BillingMode: BillingModeType, # (3)
FederationStatus: FederationStatusType, # (4)
FederationRoleArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See EventDataStoreStatusType
- See AdvancedEventSelectorOutputTypeDef
- See BillingModeType
- See FederationStatusType
- See ResponseMetadataTypeDef
AdvancedEventSelectorTypeDef#
# AdvancedEventSelectorTypeDef definition
class AdvancedEventSelectorTypeDef(TypedDict):
FieldSelectors: Sequence[AdvancedFieldSelectorUnionTypeDef], # (1)
Name: NotRequired[str],
GetEventSelectorsResponseTypeDef#
# GetEventSelectorsResponseTypeDef definition
class GetEventSelectorsResponseTypeDef(TypedDict):
TrailARN: str,
EventSelectors: List[EventSelectorOutputTypeDef], # (1)
AdvancedEventSelectors: List[AdvancedEventSelectorOutputTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
PutEventSelectorsResponseTypeDef#
# PutEventSelectorsResponseTypeDef definition
class PutEventSelectorsResponseTypeDef(TypedDict):
TrailARN: str,
EventSelectors: List[EventSelectorOutputTypeDef], # (1)
AdvancedEventSelectors: List[AdvancedEventSelectorOutputTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
EventSelectorTypeDef#
# EventSelectorTypeDef definition
class EventSelectorTypeDef(TypedDict):
ReadWriteType: NotRequired[ReadWriteTypeType], # (1)
IncludeManagementEvents: NotRequired[bool],
DataResources: NotRequired[Sequence[DataResourceUnionTypeDef]], # (2)
ExcludeManagementEventSources: NotRequired[Sequence[str]],
LookupEventsResponseTypeDef#
# LookupEventsResponseTypeDef definition
class LookupEventsResponseTypeDef(TypedDict):
Events: List[EventTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See EventTypeDef
- See ResponseMetadataTypeDef
GetImportResponseTypeDef#
# GetImportResponseTypeDef definition
class GetImportResponseTypeDef(TypedDict):
ImportId: str,
Destinations: List[str],
ImportSource: ImportSourceTypeDef, # (1)
StartEventTime: datetime,
EndEventTime: datetime,
ImportStatus: ImportStatusType, # (2)
CreatedTimestamp: datetime,
UpdatedTimestamp: datetime,
ImportStatistics: ImportStatisticsTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ImportSourceTypeDef
- See ImportStatusType
- See ImportStatisticsTypeDef
- See ResponseMetadataTypeDef
StartImportRequestRequestTypeDef#
# StartImportRequestRequestTypeDef definition
class StartImportRequestRequestTypeDef(TypedDict):
Destinations: NotRequired[Sequence[str]],
ImportSource: NotRequired[ImportSourceTypeDef], # (1)
StartEventTime: NotRequired[TimestampTypeDef],
EndEventTime: NotRequired[TimestampTypeDef],
ImportId: NotRequired[str],
StartImportResponseTypeDef#
# StartImportResponseTypeDef definition
class StartImportResponseTypeDef(TypedDict):
ImportId: str,
Destinations: List[str],
ImportSource: ImportSourceTypeDef, # (1)
StartEventTime: datetime,
EndEventTime: datetime,
ImportStatus: ImportStatusType, # (2)
CreatedTimestamp: datetime,
UpdatedTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
StopImportResponseTypeDef#
# StopImportResponseTypeDef definition
class StopImportResponseTypeDef(TypedDict):
ImportId: str,
ImportSource: ImportSourceTypeDef, # (1)
Destinations: List[str],
ImportStatus: ImportStatusType, # (2)
CreatedTimestamp: datetime,
UpdatedTimestamp: datetime,
StartEventTime: datetime,
EndEventTime: datetime,
ImportStatistics: ImportStatisticsTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ImportSourceTypeDef
- See ImportStatusType
- See ImportStatisticsTypeDef
- See ResponseMetadataTypeDef
ListEventDataStoresResponseTypeDef#
# ListEventDataStoresResponseTypeDef definition
class ListEventDataStoresResponseTypeDef(TypedDict):
EventDataStores: List[EventDataStoreTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
GetChannelResponseTypeDef#
# GetChannelResponseTypeDef definition
class GetChannelResponseTypeDef(TypedDict):
ChannelArn: str,
Name: str,
Source: str,
SourceConfig: SourceConfigTypeDef, # (1)
Destinations: List[DestinationTypeDef], # (2)
IngestionStatus: IngestionStatusTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See SourceConfigTypeDef
- See DestinationTypeDef
- See IngestionStatusTypeDef
- See ResponseMetadataTypeDef
UpdateEventDataStoreRequestRequestTypeDef#
# UpdateEventDataStoreRequestRequestTypeDef definition
class UpdateEventDataStoreRequestRequestTypeDef(TypedDict):
EventDataStore: str,
Name: NotRequired[str],
AdvancedEventSelectors: NotRequired[Sequence[AdvancedEventSelectorTypeDef]], # (1)
MultiRegionEnabled: NotRequired[bool],
OrganizationEnabled: NotRequired[bool],
RetentionPeriod: NotRequired[int],
TerminationProtectionEnabled: NotRequired[bool],
KmsKeyId: NotRequired[str],
BillingMode: NotRequired[BillingModeType], # (2)
CreateEventDataStoreRequestRequestTypeDef#
# CreateEventDataStoreRequestRequestTypeDef definition
class CreateEventDataStoreRequestRequestTypeDef(TypedDict):
Name: str,
AdvancedEventSelectors: NotRequired[Sequence[AdvancedEventSelectorUnionTypeDef]], # (1)
MultiRegionEnabled: NotRequired[bool],
OrganizationEnabled: NotRequired[bool],
RetentionPeriod: NotRequired[int],
TerminationProtectionEnabled: NotRequired[bool],
TagsList: NotRequired[Sequence[TagTypeDef]], # (2)
KmsKeyId: NotRequired[str],
StartIngestion: NotRequired[bool],
BillingMode: NotRequired[BillingModeType], # (3)
- See AdvancedEventSelectorTypeDef AdvancedEventSelectorOutputTypeDef
- See TagTypeDef
- See BillingModeType
PutEventSelectorsRequestRequestTypeDef#
# PutEventSelectorsRequestRequestTypeDef definition
class PutEventSelectorsRequestRequestTypeDef(TypedDict):
TrailName: str,
EventSelectors: NotRequired[Sequence[EventSelectorUnionTypeDef]], # (1)
AdvancedEventSelectors: NotRequired[Sequence[AdvancedEventSelectorTypeDef]], # (2)