Typed dictionaries
Index > EventBridge > Typed dictionaries
Auto-generated documentation for EventBridge type annotations stubs module mypy-boto3-events.
ActivateEventSourceRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ActivateEventSourceRequestRequestTypeDef
def get_value() -> ActivateEventSourceRequestRequestTypeDef:
return {
"Name": ...,
}
ApiDestinationTypeDef
Usage Example
from mypy_boto3_events.type_defs import ApiDestinationTypeDef
def get_value() -> ApiDestinationTypeDef:
return {
"ApiDestinationArn": ...,
}
Definition
class ApiDestinationTypeDef(TypedDict):
ApiDestinationArn: NotRequired[str],
Name: NotRequired[str],
ApiDestinationState: NotRequired[ApiDestinationStateType], # (1)
ConnectionArn: NotRequired[str],
InvocationEndpoint: NotRequired[str],
HttpMethod: NotRequired[ApiDestinationHttpMethodType], # (2)
InvocationRateLimitPerSecond: NotRequired[int],
CreationTime: NotRequired[datetime],
LastModifiedTime: NotRequired[datetime],
ArchiveTypeDef
Usage Example
from mypy_boto3_events.type_defs import ArchiveTypeDef
def get_value() -> ArchiveTypeDef:
return {
"ArchiveName": ...,
}
Definition
class ArchiveTypeDef(TypedDict):
ArchiveName: NotRequired[str],
EventSourceArn: NotRequired[str],
State: NotRequired[ArchiveStateType], # (1)
StateReason: NotRequired[str],
RetentionDays: NotRequired[int],
SizeBytes: NotRequired[int],
EventCount: NotRequired[int],
CreationTime: NotRequired[datetime],
- See ArchiveStateType
AwsVpcConfigurationTypeDef
Usage Example
from mypy_boto3_events.type_defs import AwsVpcConfigurationTypeDef
def get_value() -> AwsVpcConfigurationTypeDef:
return {
"Subnets": ...,
}
Definition
class AwsVpcConfigurationTypeDef(TypedDict):
Subnets: List[str],
SecurityGroups: NotRequired[List[str]],
AssignPublicIp: NotRequired[AssignPublicIpType], # (1)
BatchArrayPropertiesTypeDef
Usage Example
from mypy_boto3_events.type_defs import BatchArrayPropertiesTypeDef
def get_value() -> BatchArrayPropertiesTypeDef:
return {
"Size": ...,
}
BatchRetryStrategyTypeDef
Usage Example
from mypy_boto3_events.type_defs import BatchRetryStrategyTypeDef
def get_value() -> BatchRetryStrategyTypeDef:
return {
"Attempts": ...,
}
CancelReplayRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import CancelReplayRequestRequestTypeDef
def get_value() -> CancelReplayRequestRequestTypeDef:
return {
"ReplayName": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_events.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CapacityProviderStrategyItemTypeDef
Usage Example
from mypy_boto3_events.type_defs import CapacityProviderStrategyItemTypeDef
def get_value() -> CapacityProviderStrategyItemTypeDef:
return {
"capacityProvider": ...,
}
Definition
class CapacityProviderStrategyItemTypeDef(TypedDict):
capacityProvider: str,
weight: NotRequired[int],
base: NotRequired[int],
ConditionTypeDef
Usage Example
from mypy_boto3_events.type_defs import ConditionTypeDef
def get_value() -> ConditionTypeDef:
return {
"Type": ...,
"Key": ...,
"Value": ...,
}
ConnectionApiKeyAuthResponseParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import ConnectionApiKeyAuthResponseParametersTypeDef
def get_value() -> ConnectionApiKeyAuthResponseParametersTypeDef:
return {
"ApiKeyName": ...,
}
Definition
class ConnectionApiKeyAuthResponseParametersTypeDef(TypedDict):
ApiKeyName: NotRequired[str],
ConnectionBasicAuthResponseParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import ConnectionBasicAuthResponseParametersTypeDef
def get_value() -> ConnectionBasicAuthResponseParametersTypeDef:
return {
"Username": ...,
}
Definition
class ConnectionBasicAuthResponseParametersTypeDef(TypedDict):
Username: NotRequired[str],
ConnectionBodyParameterTypeDef
Usage Example
from mypy_boto3_events.type_defs import ConnectionBodyParameterTypeDef
def get_value() -> ConnectionBodyParameterTypeDef:
return {
"Key": ...,
}
Definition
class ConnectionBodyParameterTypeDef(TypedDict):
Key: NotRequired[str],
Value: NotRequired[str],
IsValueSecret: NotRequired[bool],
ConnectionHeaderParameterTypeDef
Usage Example
from mypy_boto3_events.type_defs import ConnectionHeaderParameterTypeDef
def get_value() -> ConnectionHeaderParameterTypeDef:
return {
"Key": ...,
}
Definition
class ConnectionHeaderParameterTypeDef(TypedDict):
Key: NotRequired[str],
Value: NotRequired[str],
IsValueSecret: NotRequired[bool],
ConnectionQueryStringParameterTypeDef
Usage Example
from mypy_boto3_events.type_defs import ConnectionQueryStringParameterTypeDef
def get_value() -> ConnectionQueryStringParameterTypeDef:
return {
"Key": ...,
}
Definition
class ConnectionQueryStringParameterTypeDef(TypedDict):
Key: NotRequired[str],
Value: NotRequired[str],
IsValueSecret: NotRequired[bool],
ConnectionOAuthClientResponseParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import ConnectionOAuthClientResponseParametersTypeDef
def get_value() -> ConnectionOAuthClientResponseParametersTypeDef:
return {
"ClientID": ...,
}
Definition
class ConnectionOAuthClientResponseParametersTypeDef(TypedDict):
ClientID: NotRequired[str],
ConnectionTypeDef
Usage Example
from mypy_boto3_events.type_defs import ConnectionTypeDef
def get_value() -> ConnectionTypeDef:
return {
"ConnectionArn": ...,
}
Definition
class ConnectionTypeDef(TypedDict):
ConnectionArn: NotRequired[str],
Name: NotRequired[str],
ConnectionState: NotRequired[ConnectionStateType], # (1)
StateReason: NotRequired[str],
AuthorizationType: NotRequired[ConnectionAuthorizationTypeType], # (2)
CreationTime: NotRequired[datetime],
LastModifiedTime: NotRequired[datetime],
LastAuthorizedTime: NotRequired[datetime],
CreateApiDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreateApiDestinationRequestRequestTypeDef
def get_value() -> CreateApiDestinationRequestRequestTypeDef:
return {
"Name": ...,
"ConnectionArn": ...,
"InvocationEndpoint": ...,
"HttpMethod": ...,
}
Definition
class CreateApiDestinationRequestRequestTypeDef(TypedDict):
Name: str,
ConnectionArn: str,
InvocationEndpoint: str,
HttpMethod: ApiDestinationHttpMethodType, # (1)
Description: NotRequired[str],
InvocationRateLimitPerSecond: NotRequired[int],
CreateArchiveRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreateArchiveRequestRequestTypeDef
def get_value() -> CreateArchiveRequestRequestTypeDef:
return {
"ArchiveName": ...,
"EventSourceArn": ...,
}
Definition
class CreateArchiveRequestRequestTypeDef(TypedDict):
ArchiveName: str,
EventSourceArn: str,
Description: NotRequired[str],
EventPattern: NotRequired[str],
RetentionDays: NotRequired[int],
CreateConnectionApiKeyAuthRequestParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreateConnectionApiKeyAuthRequestParametersTypeDef
def get_value() -> CreateConnectionApiKeyAuthRequestParametersTypeDef:
return {
"ApiKeyName": ...,
"ApiKeyValue": ...,
}
Definition
class CreateConnectionApiKeyAuthRequestParametersTypeDef(TypedDict):
ApiKeyName: str,
ApiKeyValue: str,
CreateConnectionBasicAuthRequestParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreateConnectionBasicAuthRequestParametersTypeDef
def get_value() -> CreateConnectionBasicAuthRequestParametersTypeDef:
return {
"Username": ...,
"Password": ...,
}
Definition
class CreateConnectionBasicAuthRequestParametersTypeDef(TypedDict):
Username: str,
Password: str,
CreateConnectionOAuthClientRequestParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreateConnectionOAuthClientRequestParametersTypeDef
def get_value() -> CreateConnectionOAuthClientRequestParametersTypeDef:
return {
"ClientID": ...,
"ClientSecret": ...,
}
Definition
class CreateConnectionOAuthClientRequestParametersTypeDef(TypedDict):
ClientID: str,
ClientSecret: str,
EndpointEventBusTypeDef
Usage Example
from mypy_boto3_events.type_defs import EndpointEventBusTypeDef
def get_value() -> EndpointEventBusTypeDef:
return {
"EventBusArn": ...,
}
ReplicationConfigTypeDef
Usage Example
from mypy_boto3_events.type_defs import ReplicationConfigTypeDef
def get_value() -> ReplicationConfigTypeDef:
return {
"State": ...,
}
Definition
class ReplicationConfigTypeDef(TypedDict):
State: NotRequired[ReplicationStateType], # (1)
TagTypeDef
Usage Example
from mypy_boto3_events.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
CreatePartnerEventSourceRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreatePartnerEventSourceRequestRequestTypeDef
def get_value() -> CreatePartnerEventSourceRequestRequestTypeDef:
return {
"Name": ...,
"Account": ...,
}
DeactivateEventSourceRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeactivateEventSourceRequestRequestTypeDef
def get_value() -> DeactivateEventSourceRequestRequestTypeDef:
return {
"Name": ...,
}
DeadLetterConfigTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeadLetterConfigTypeDef
def get_value() -> DeadLetterConfigTypeDef:
return {
"Arn": ...,
}
DeauthorizeConnectionRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeauthorizeConnectionRequestRequestTypeDef
def get_value() -> DeauthorizeConnectionRequestRequestTypeDef:
return {
"Name": ...,
}
DeleteApiDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeleteApiDestinationRequestRequestTypeDef
def get_value() -> DeleteApiDestinationRequestRequestTypeDef:
return {
"Name": ...,
}
DeleteArchiveRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeleteArchiveRequestRequestTypeDef
def get_value() -> DeleteArchiveRequestRequestTypeDef:
return {
"ArchiveName": ...,
}
DeleteConnectionRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeleteConnectionRequestRequestTypeDef
def get_value() -> DeleteConnectionRequestRequestTypeDef:
return {
"Name": ...,
}
DeleteEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeleteEndpointRequestRequestTypeDef
def get_value() -> DeleteEndpointRequestRequestTypeDef:
return {
"Name": ...,
}
DeleteEventBusRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeleteEventBusRequestRequestTypeDef
def get_value() -> DeleteEventBusRequestRequestTypeDef:
return {
"Name": ...,
}
DeletePartnerEventSourceRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeletePartnerEventSourceRequestRequestTypeDef
def get_value() -> DeletePartnerEventSourceRequestRequestTypeDef:
return {
"Name": ...,
"Account": ...,
}
DeleteRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeleteRuleRequestRequestTypeDef
def get_value() -> DeleteRuleRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class DeleteRuleRequestRequestTypeDef(TypedDict):
Name: str,
EventBusName: NotRequired[str],
Force: NotRequired[bool],
DescribeApiDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeApiDestinationRequestRequestTypeDef
def get_value() -> DescribeApiDestinationRequestRequestTypeDef:
return {
"Name": ...,
}
DescribeArchiveRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeArchiveRequestRequestTypeDef
def get_value() -> DescribeArchiveRequestRequestTypeDef:
return {
"ArchiveName": ...,
}
DescribeConnectionRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeConnectionRequestRequestTypeDef
def get_value() -> DescribeConnectionRequestRequestTypeDef:
return {
"Name": ...,
}
DescribeEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeEndpointRequestRequestTypeDef
def get_value() -> DescribeEndpointRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class DescribeEndpointRequestRequestTypeDef(TypedDict):
Name: str,
HomeRegion: NotRequired[str],
DescribeEventBusRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeEventBusRequestRequestTypeDef
def get_value() -> DescribeEventBusRequestRequestTypeDef:
return {
"Name": ...,
}
DescribeEventSourceRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeEventSourceRequestRequestTypeDef
def get_value() -> DescribeEventSourceRequestRequestTypeDef:
return {
"Name": ...,
}
DescribePartnerEventSourceRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribePartnerEventSourceRequestRequestTypeDef
def get_value() -> DescribePartnerEventSourceRequestRequestTypeDef:
return {
"Name": ...,
}
DescribeReplayRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeReplayRequestRequestTypeDef
def get_value() -> DescribeReplayRequestRequestTypeDef:
return {
"ReplayName": ...,
}
ReplayDestinationTypeDef
Usage Example
from mypy_boto3_events.type_defs import ReplayDestinationTypeDef
def get_value() -> ReplayDestinationTypeDef:
return {
"Arn": ...,
}
DescribeRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeRuleRequestRequestTypeDef
def get_value() -> DescribeRuleRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class DescribeRuleRequestRequestTypeDef(TypedDict):
Name: str,
EventBusName: NotRequired[str],
DisableRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import DisableRuleRequestRequestTypeDef
def get_value() -> DisableRuleRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class DisableRuleRequestRequestTypeDef(TypedDict):
Name: str,
EventBusName: NotRequired[str],
PlacementConstraintTypeDef
Usage Example
from mypy_boto3_events.type_defs import PlacementConstraintTypeDef
def get_value() -> PlacementConstraintTypeDef:
return {
"type": ...,
}
Definition
class PlacementConstraintTypeDef(TypedDict):
type: NotRequired[PlacementConstraintTypeType], # (1)
expression: NotRequired[str],
PlacementStrategyTypeDef
Usage Example
from mypy_boto3_events.type_defs import PlacementStrategyTypeDef
def get_value() -> PlacementStrategyTypeDef:
return {
"type": ...,
}
Definition
class PlacementStrategyTypeDef(TypedDict):
type: NotRequired[PlacementStrategyTypeType], # (1)
field: NotRequired[str],
EnableRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import EnableRuleRequestRequestTypeDef
def get_value() -> EnableRuleRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class EnableRuleRequestRequestTypeDef(TypedDict):
Name: str,
EventBusName: NotRequired[str],
EventBusTypeDef
Usage Example
from mypy_boto3_events.type_defs import EventBusTypeDef
def get_value() -> EventBusTypeDef:
return {
"Name": ...,
}
Definition
class EventBusTypeDef(TypedDict):
Name: NotRequired[str],
Arn: NotRequired[str],
Policy: NotRequired[str],
EventSourceTypeDef
Usage Example
from mypy_boto3_events.type_defs import EventSourceTypeDef
def get_value() -> EventSourceTypeDef:
return {
"Arn": ...,
}
Definition
class EventSourceTypeDef(TypedDict):
Arn: NotRequired[str],
CreatedBy: NotRequired[str],
CreationTime: NotRequired[datetime],
ExpirationTime: NotRequired[datetime],
Name: NotRequired[str],
State: NotRequired[EventSourceStateType], # (1)
PrimaryTypeDef
Usage Example
from mypy_boto3_events.type_defs import PrimaryTypeDef
def get_value() -> PrimaryTypeDef:
return {
"HealthCheck": ...,
}
SecondaryTypeDef
Usage Example
from mypy_boto3_events.type_defs import SecondaryTypeDef
def get_value() -> SecondaryTypeDef:
return {
"Route": ...,
}
HttpParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import HttpParametersTypeDef
def get_value() -> HttpParametersTypeDef:
return {
"PathParameterValues": ...,
}
Definition
class HttpParametersTypeDef(TypedDict):
PathParameterValues: NotRequired[List[str]],
HeaderParameters: NotRequired[Dict[str, str]],
QueryStringParameters: NotRequired[Dict[str, str]],
InputTransformerTypeDef
Usage Example
from mypy_boto3_events.type_defs import InputTransformerTypeDef
def get_value() -> InputTransformerTypeDef:
return {
"InputTemplate": ...,
}
Definition
class InputTransformerTypeDef(TypedDict):
InputTemplate: str,
InputPathsMap: NotRequired[Dict[str, str]],
KinesisParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import KinesisParametersTypeDef
def get_value() -> KinesisParametersTypeDef:
return {
"PartitionKeyPath": ...,
}
ListApiDestinationsRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListApiDestinationsRequestRequestTypeDef
def get_value() -> ListApiDestinationsRequestRequestTypeDef:
return {
"NamePrefix": ...,
}
Definition
class ListApiDestinationsRequestRequestTypeDef(TypedDict):
NamePrefix: NotRequired[str],
ConnectionArn: NotRequired[str],
NextToken: NotRequired[str],
Limit: NotRequired[int],
ListArchivesRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListArchivesRequestRequestTypeDef
def get_value() -> ListArchivesRequestRequestTypeDef:
return {
"NamePrefix": ...,
}
Definition
class ListArchivesRequestRequestTypeDef(TypedDict):
NamePrefix: NotRequired[str],
EventSourceArn: NotRequired[str],
State: NotRequired[ArchiveStateType], # (1)
NextToken: NotRequired[str],
Limit: NotRequired[int],
- See ArchiveStateType
ListConnectionsRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListConnectionsRequestRequestTypeDef
def get_value() -> ListConnectionsRequestRequestTypeDef:
return {
"NamePrefix": ...,
}
Definition
class ListConnectionsRequestRequestTypeDef(TypedDict):
NamePrefix: NotRequired[str],
ConnectionState: NotRequired[ConnectionStateType], # (1)
NextToken: NotRequired[str],
Limit: NotRequired[int],
ListEndpointsRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListEndpointsRequestRequestTypeDef
def get_value() -> ListEndpointsRequestRequestTypeDef:
return {
"NamePrefix": ...,
}
Definition
class ListEndpointsRequestRequestTypeDef(TypedDict):
NamePrefix: NotRequired[str],
HomeRegion: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListEventBusesRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListEventBusesRequestRequestTypeDef
def get_value() -> ListEventBusesRequestRequestTypeDef:
return {
"NamePrefix": ...,
}
Definition
class ListEventBusesRequestRequestTypeDef(TypedDict):
NamePrefix: NotRequired[str],
NextToken: NotRequired[str],
Limit: NotRequired[int],
ListEventSourcesRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListEventSourcesRequestRequestTypeDef
def get_value() -> ListEventSourcesRequestRequestTypeDef:
return {
"NamePrefix": ...,
}
Definition
class ListEventSourcesRequestRequestTypeDef(TypedDict):
NamePrefix: NotRequired[str],
NextToken: NotRequired[str],
Limit: NotRequired[int],
ListPartnerEventSourceAccountsRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListPartnerEventSourceAccountsRequestRequestTypeDef
def get_value() -> ListPartnerEventSourceAccountsRequestRequestTypeDef:
return {
"EventSourceName": ...,
}
Definition
class ListPartnerEventSourceAccountsRequestRequestTypeDef(TypedDict):
EventSourceName: str,
NextToken: NotRequired[str],
Limit: NotRequired[int],
PartnerEventSourceAccountTypeDef
Usage Example
from mypy_boto3_events.type_defs import PartnerEventSourceAccountTypeDef
def get_value() -> PartnerEventSourceAccountTypeDef:
return {
"Account": ...,
}
Definition
class PartnerEventSourceAccountTypeDef(TypedDict):
Account: NotRequired[str],
CreationTime: NotRequired[datetime],
ExpirationTime: NotRequired[datetime],
State: NotRequired[EventSourceStateType], # (1)
ListPartnerEventSourcesRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListPartnerEventSourcesRequestRequestTypeDef
def get_value() -> ListPartnerEventSourcesRequestRequestTypeDef:
return {
"NamePrefix": ...,
}
Definition
class ListPartnerEventSourcesRequestRequestTypeDef(TypedDict):
NamePrefix: str,
NextToken: NotRequired[str],
Limit: NotRequired[int],
PartnerEventSourceTypeDef
Usage Example
from mypy_boto3_events.type_defs import PartnerEventSourceTypeDef
def get_value() -> PartnerEventSourceTypeDef:
return {
"Arn": ...,
}
Definition
class PartnerEventSourceTypeDef(TypedDict):
Arn: NotRequired[str],
Name: NotRequired[str],
ListReplaysRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListReplaysRequestRequestTypeDef
def get_value() -> ListReplaysRequestRequestTypeDef:
return {
"NamePrefix": ...,
}
Definition
class ListReplaysRequestRequestTypeDef(TypedDict):
NamePrefix: NotRequired[str],
State: NotRequired[ReplayStateType], # (1)
EventSourceArn: NotRequired[str],
NextToken: NotRequired[str],
Limit: NotRequired[int],
- See ReplayStateType
ReplayTypeDef
Usage Example
from mypy_boto3_events.type_defs import ReplayTypeDef
def get_value() -> ReplayTypeDef:
return {
"ReplayName": ...,
}
Definition
class ReplayTypeDef(TypedDict):
ReplayName: NotRequired[str],
EventSourceArn: NotRequired[str],
State: NotRequired[ReplayStateType], # (1)
StateReason: NotRequired[str],
EventStartTime: NotRequired[datetime],
EventEndTime: NotRequired[datetime],
EventLastReplayedTime: NotRequired[datetime],
ReplayStartTime: NotRequired[datetime],
ReplayEndTime: NotRequired[datetime],
- See ReplayStateType
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_events.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListRuleNamesByTargetRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListRuleNamesByTargetRequestRequestTypeDef
def get_value() -> ListRuleNamesByTargetRequestRequestTypeDef:
return {
"TargetArn": ...,
}
Definition
class ListRuleNamesByTargetRequestRequestTypeDef(TypedDict):
TargetArn: str,
EventBusName: NotRequired[str],
NextToken: NotRequired[str],
Limit: NotRequired[int],
ListRulesRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListRulesRequestRequestTypeDef
def get_value() -> ListRulesRequestRequestTypeDef:
return {
"NamePrefix": ...,
}
Definition
class ListRulesRequestRequestTypeDef(TypedDict):
NamePrefix: NotRequired[str],
EventBusName: NotRequired[str],
NextToken: NotRequired[str],
Limit: NotRequired[int],
RuleTypeDef
Usage Example
from mypy_boto3_events.type_defs import RuleTypeDef
def get_value() -> RuleTypeDef:
return {
"Name": ...,
}
Definition
class RuleTypeDef(TypedDict):
Name: NotRequired[str],
Arn: NotRequired[str],
EventPattern: NotRequired[str],
State: NotRequired[RuleStateType], # (1)
Description: NotRequired[str],
ScheduleExpression: NotRequired[str],
RoleArn: NotRequired[str],
ManagedBy: NotRequired[str],
EventBusName: NotRequired[str],
- See RuleStateType
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
}
ListTargetsByRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import ListTargetsByRuleRequestRequestTypeDef
def get_value() -> ListTargetsByRuleRequestRequestTypeDef:
return {
"Rule": ...,
}
Definition
class ListTargetsByRuleRequestRequestTypeDef(TypedDict):
Rule: str,
EventBusName: NotRequired[str],
NextToken: NotRequired[str],
Limit: NotRequired[int],
PutEventsRequestEntryTypeDef
Usage Example
from mypy_boto3_events.type_defs import PutEventsRequestEntryTypeDef
def get_value() -> PutEventsRequestEntryTypeDef:
return {
"Time": ...,
}
Definition
class PutEventsRequestEntryTypeDef(TypedDict):
Time: NotRequired[Union[datetime, str]],
Source: NotRequired[str],
Resources: NotRequired[Sequence[str]],
DetailType: NotRequired[str],
Detail: NotRequired[str],
EventBusName: NotRequired[str],
TraceHeader: NotRequired[str],
PutEventsResultEntryTypeDef
Usage Example
from mypy_boto3_events.type_defs import PutEventsResultEntryTypeDef
def get_value() -> PutEventsResultEntryTypeDef:
return {
"EventId": ...,
}
Definition
class PutEventsResultEntryTypeDef(TypedDict):
EventId: NotRequired[str],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
PutPartnerEventsRequestEntryTypeDef
Usage Example
from mypy_boto3_events.type_defs import PutPartnerEventsRequestEntryTypeDef
def get_value() -> PutPartnerEventsRequestEntryTypeDef:
return {
"Time": ...,
}
Definition
class PutPartnerEventsRequestEntryTypeDef(TypedDict):
Time: NotRequired[Union[datetime, str]],
Source: NotRequired[str],
Resources: NotRequired[Sequence[str]],
DetailType: NotRequired[str],
Detail: NotRequired[str],
PutPartnerEventsResultEntryTypeDef
Usage Example
from mypy_boto3_events.type_defs import PutPartnerEventsResultEntryTypeDef
def get_value() -> PutPartnerEventsResultEntryTypeDef:
return {
"EventId": ...,
}
Definition
class PutPartnerEventsResultEntryTypeDef(TypedDict):
EventId: NotRequired[str],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
PutTargetsResultEntryTypeDef
Usage Example
from mypy_boto3_events.type_defs import PutTargetsResultEntryTypeDef
def get_value() -> PutTargetsResultEntryTypeDef:
return {
"TargetId": ...,
}
Definition
class PutTargetsResultEntryTypeDef(TypedDict):
TargetId: NotRequired[str],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
RedshiftDataParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import RedshiftDataParametersTypeDef
def get_value() -> RedshiftDataParametersTypeDef:
return {
"Database": ...,
"Sql": ...,
}
Definition
class RedshiftDataParametersTypeDef(TypedDict):
Database: str,
Sql: str,
SecretManagerArn: NotRequired[str],
DbUser: NotRequired[str],
StatementName: NotRequired[str],
WithEvent: NotRequired[bool],
RemovePermissionRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import RemovePermissionRequestRequestTypeDef
def get_value() -> RemovePermissionRequestRequestTypeDef:
return {
"StatementId": ...,
}
Definition
class RemovePermissionRequestRequestTypeDef(TypedDict):
StatementId: NotRequired[str],
RemoveAllPermissions: NotRequired[bool],
EventBusName: NotRequired[str],
RemoveTargetsRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import RemoveTargetsRequestRequestTypeDef
def get_value() -> RemoveTargetsRequestRequestTypeDef:
return {
"Rule": ...,
"Ids": ...,
}
Definition
class RemoveTargetsRequestRequestTypeDef(TypedDict):
Rule: str,
Ids: Sequence[str],
EventBusName: NotRequired[str],
Force: NotRequired[bool],
RemoveTargetsResultEntryTypeDef
Usage Example
from mypy_boto3_events.type_defs import RemoveTargetsResultEntryTypeDef
def get_value() -> RemoveTargetsResultEntryTypeDef:
return {
"TargetId": ...,
}
Definition
class RemoveTargetsResultEntryTypeDef(TypedDict):
TargetId: NotRequired[str],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
RetryPolicyTypeDef
Usage Example
from mypy_boto3_events.type_defs import RetryPolicyTypeDef
def get_value() -> RetryPolicyTypeDef:
return {
"MaximumRetryAttempts": ...,
}
Definition
class RetryPolicyTypeDef(TypedDict):
MaximumRetryAttempts: NotRequired[int],
MaximumEventAgeInSeconds: NotRequired[int],
RunCommandTargetTypeDef
Usage Example
from mypy_boto3_events.type_defs import RunCommandTargetTypeDef
def get_value() -> RunCommandTargetTypeDef:
return {
"Key": ...,
"Values": ...,
}
SageMakerPipelineParameterTypeDef
Usage Example
from mypy_boto3_events.type_defs import SageMakerPipelineParameterTypeDef
def get_value() -> SageMakerPipelineParameterTypeDef:
return {
"Name": ...,
"Value": ...,
}
SqsParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import SqsParametersTypeDef
def get_value() -> SqsParametersTypeDef:
return {
"MessageGroupId": ...,
}
TestEventPatternRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import TestEventPatternRequestRequestTypeDef
def get_value() -> TestEventPatternRequestRequestTypeDef:
return {
"EventPattern": ...,
"Event": ...,
}
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateApiDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import UpdateApiDestinationRequestRequestTypeDef
def get_value() -> UpdateApiDestinationRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class UpdateApiDestinationRequestRequestTypeDef(TypedDict):
Name: str,
Description: NotRequired[str],
ConnectionArn: NotRequired[str],
InvocationEndpoint: NotRequired[str],
HttpMethod: NotRequired[ApiDestinationHttpMethodType], # (1)
InvocationRateLimitPerSecond: NotRequired[int],
UpdateArchiveRequestRequestTypeDef
Usage Example
from mypy_boto3_events.type_defs import UpdateArchiveRequestRequestTypeDef
def get_value() -> UpdateArchiveRequestRequestTypeDef:
return {
"ArchiveName": ...,
}
Definition
class UpdateArchiveRequestRequestTypeDef(TypedDict):
ArchiveName: str,
Description: NotRequired[str],
EventPattern: NotRequired[str],
RetentionDays: NotRequired[int],
UpdateConnectionApiKeyAuthRequestParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import UpdateConnectionApiKeyAuthRequestParametersTypeDef
def get_value() -> UpdateConnectionApiKeyAuthRequestParametersTypeDef:
return {
"ApiKeyName": ...,
}
Definition
class UpdateConnectionApiKeyAuthRequestParametersTypeDef(TypedDict):
ApiKeyName: NotRequired[str],
ApiKeyValue: NotRequired[str],
UpdateConnectionBasicAuthRequestParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import UpdateConnectionBasicAuthRequestParametersTypeDef
def get_value() -> UpdateConnectionBasicAuthRequestParametersTypeDef:
return {
"Username": ...,
}
Definition
class UpdateConnectionBasicAuthRequestParametersTypeDef(TypedDict):
Username: NotRequired[str],
Password: NotRequired[str],
UpdateConnectionOAuthClientRequestParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import UpdateConnectionOAuthClientRequestParametersTypeDef
def get_value() -> UpdateConnectionOAuthClientRequestParametersTypeDef:
return {
"ClientID": ...,
}
Definition
class UpdateConnectionOAuthClientRequestParametersTypeDef(TypedDict):
ClientID: NotRequired[str],
ClientSecret: NotRequired[str],
NetworkConfigurationTypeDef
Usage Example
from mypy_boto3_events.type_defs import NetworkConfigurationTypeDef
def get_value() -> NetworkConfigurationTypeDef:
return {
"awsvpcConfiguration": ...,
}
Definition
class NetworkConfigurationTypeDef(TypedDict):
awsvpcConfiguration: NotRequired[AwsVpcConfigurationTypeDef], # (1)
BatchParametersTypeDef
Usage Example
from mypy_boto3_events.type_defs import BatchParametersTypeDef
def get_value() -> BatchParametersTypeDef:
return {
"JobDefinition": ...,
"JobName": ...,
}
Definition
class BatchParametersTypeDef(TypedDict):
JobDefinition: str,
JobName: str,
ArrayProperties: NotRequired[BatchArrayPropertiesTypeDef], # (1)
RetryStrategy: NotRequired[BatchRetryStrategyTypeDef], # (2)
CancelReplayResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import CancelReplayResponseTypeDef
def get_value() -> CancelReplayResponseTypeDef:
return {
"ReplayArn": ...,
"State": ...,
"StateReason": ...,
"ResponseMetadata": ...,
}
Definition
class CancelReplayResponseTypeDef(TypedDict):
ReplayArn: str,
State: ReplayStateType, # (1)
StateReason: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateApiDestinationResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreateApiDestinationResponseTypeDef
def get_value() -> CreateApiDestinationResponseTypeDef:
return {
"ApiDestinationArn": ...,
"ApiDestinationState": ...,
"CreationTime": ...,
"LastModifiedTime": ...,
"ResponseMetadata": ...,
}
Definition
class CreateApiDestinationResponseTypeDef(TypedDict):
ApiDestinationArn: str,
ApiDestinationState: ApiDestinationStateType, # (1)
CreationTime: datetime,
LastModifiedTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateArchiveResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreateArchiveResponseTypeDef
def get_value() -> CreateArchiveResponseTypeDef:
return {
"ArchiveArn": ...,
"State": ...,
"StateReason": ...,
"CreationTime": ...,
"ResponseMetadata": ...,
}
Definition
class CreateArchiveResponseTypeDef(TypedDict):
ArchiveArn: str,
State: ArchiveStateType, # (1)
StateReason: str,
CreationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateConnectionResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreateConnectionResponseTypeDef
def get_value() -> CreateConnectionResponseTypeDef:
return {
"ConnectionArn": ...,
"ConnectionState": ...,
"CreationTime": ...,
"LastModifiedTime": ...,
"ResponseMetadata": ...,
}
Definition
class CreateConnectionResponseTypeDef(TypedDict):
ConnectionArn: str,
ConnectionState: ConnectionStateType, # (1)
CreationTime: datetime,
LastModifiedTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateEventBusResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreateEventBusResponseTypeDef
def get_value() -> CreateEventBusResponseTypeDef:
return {
"EventBusArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateEventBusResponseTypeDef(TypedDict):
EventBusArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreatePartnerEventSourceResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import CreatePartnerEventSourceResponseTypeDef
def get_value() -> CreatePartnerEventSourceResponseTypeDef:
return {
"EventSourceArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreatePartnerEventSourceResponseTypeDef(TypedDict):
EventSourceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeauthorizeConnectionResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeauthorizeConnectionResponseTypeDef
def get_value() -> DeauthorizeConnectionResponseTypeDef:
return {
"ConnectionArn": ...,
"ConnectionState": ...,
"CreationTime": ...,
"LastModifiedTime": ...,
"LastAuthorizedTime": ...,
"ResponseMetadata": ...,
}
Definition
class DeauthorizeConnectionResponseTypeDef(TypedDict):
ConnectionArn: str,
ConnectionState: ConnectionStateType, # (1)
CreationTime: datetime,
LastModifiedTime: datetime,
LastAuthorizedTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteConnectionResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import DeleteConnectionResponseTypeDef
def get_value() -> DeleteConnectionResponseTypeDef:
return {
"ConnectionArn": ...,
"ConnectionState": ...,
"CreationTime": ...,
"LastModifiedTime": ...,
"LastAuthorizedTime": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteConnectionResponseTypeDef(TypedDict):
ConnectionArn: str,
ConnectionState: ConnectionStateType, # (1)
CreationTime: datetime,
LastModifiedTime: datetime,
LastAuthorizedTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeApiDestinationResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeApiDestinationResponseTypeDef
def get_value() -> DescribeApiDestinationResponseTypeDef:
return {
"ApiDestinationArn": ...,
"Name": ...,
"Description": ...,
"ApiDestinationState": ...,
"ConnectionArn": ...,
"InvocationEndpoint": ...,
"HttpMethod": ...,
"InvocationRateLimitPerSecond": ...,
"CreationTime": ...,
"LastModifiedTime": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeApiDestinationResponseTypeDef(TypedDict):
ApiDestinationArn: str,
Name: str,
Description: str,
ApiDestinationState: ApiDestinationStateType, # (1)
ConnectionArn: str,
InvocationEndpoint: str,
HttpMethod: ApiDestinationHttpMethodType, # (2)
InvocationRateLimitPerSecond: int,
CreationTime: datetime,
LastModifiedTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribeArchiveResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeArchiveResponseTypeDef
def get_value() -> DescribeArchiveResponseTypeDef:
return {
"ArchiveArn": ...,
"ArchiveName": ...,
"EventSourceArn": ...,
"Description": ...,
"EventPattern": ...,
"State": ...,
"StateReason": ...,
"RetentionDays": ...,
"SizeBytes": ...,
"EventCount": ...,
"CreationTime": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeArchiveResponseTypeDef(TypedDict):
ArchiveArn: str,
ArchiveName: str,
EventSourceArn: str,
Description: str,
EventPattern: str,
State: ArchiveStateType, # (1)
StateReason: str,
RetentionDays: int,
SizeBytes: int,
EventCount: int,
CreationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeEventBusResponseTypeDef
Usage Example
from mypy_boto3_events.type_defs import DescribeEventBusResponseTypeDef
def get_value() -> DescribeEventBusResponseTypeDef:
return {
"Name": ...,
"Arn": ...,
"Policy": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeEventBusResponseTypeDef(TypedDict):
Name: str,
Arn: str,
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)