Skip to content

Type definitions#

Index > EventBridge > Type definitions

Auto-generated documentation for EventBridge type annotations stubs module mypy-boto3-events.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ActivateEventSourceRequestRequestTypeDef#

# ActivateEventSourceRequestRequestTypeDef definition

class ActivateEventSourceRequestRequestTypeDef(TypedDict):
    Name: str,

ApiDestinationTypeDef#

# ApiDestinationTypeDef 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],
  1. See ApiDestinationStateType
  2. See ApiDestinationHttpMethodType

ArchiveTypeDef#

# ArchiveTypeDef 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],
  1. See ArchiveStateType

AwsVpcConfigurationTypeDef#

# AwsVpcConfigurationTypeDef definition

class AwsVpcConfigurationTypeDef(TypedDict):
    Subnets: List[str],
    SecurityGroups: NotRequired[List[str]],
    AssignPublicIp: NotRequired[AssignPublicIpType],  # (1)
  1. See AssignPublicIpType

BatchArrayPropertiesTypeDef#

# BatchArrayPropertiesTypeDef definition

class BatchArrayPropertiesTypeDef(TypedDict):
    Size: NotRequired[int],

BatchRetryStrategyTypeDef#

# BatchRetryStrategyTypeDef definition

class BatchRetryStrategyTypeDef(TypedDict):
    Attempts: NotRequired[int],

CancelReplayRequestRequestTypeDef#

# CancelReplayRequestRequestTypeDef definition

class CancelReplayRequestRequestTypeDef(TypedDict):
    ReplayName: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CapacityProviderStrategyItemTypeDef#

# CapacityProviderStrategyItemTypeDef definition

class CapacityProviderStrategyItemTypeDef(TypedDict):
    capacityProvider: str,
    weight: NotRequired[int],
    base: NotRequired[int],

ConditionTypeDef#

# ConditionTypeDef definition

class ConditionTypeDef(TypedDict):
    Type: str,
    Key: str,
    Value: str,

ConnectionApiKeyAuthResponseParametersTypeDef#

# ConnectionApiKeyAuthResponseParametersTypeDef definition

class ConnectionApiKeyAuthResponseParametersTypeDef(TypedDict):
    ApiKeyName: NotRequired[str],

ConnectionBasicAuthResponseParametersTypeDef#

# ConnectionBasicAuthResponseParametersTypeDef definition

class ConnectionBasicAuthResponseParametersTypeDef(TypedDict):
    Username: NotRequired[str],

ConnectionBodyParameterTypeDef#

# ConnectionBodyParameterTypeDef definition

class ConnectionBodyParameterTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],
    IsValueSecret: NotRequired[bool],

ConnectionHeaderParameterTypeDef#

# ConnectionHeaderParameterTypeDef definition

class ConnectionHeaderParameterTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],
    IsValueSecret: NotRequired[bool],

ConnectionQueryStringParameterTypeDef#

# ConnectionQueryStringParameterTypeDef definition

class ConnectionQueryStringParameterTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],
    IsValueSecret: NotRequired[bool],

ConnectionOAuthClientResponseParametersTypeDef#

# ConnectionOAuthClientResponseParametersTypeDef definition

class ConnectionOAuthClientResponseParametersTypeDef(TypedDict):
    ClientID: NotRequired[str],

ConnectionTypeDef#

# ConnectionTypeDef 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],
  1. See ConnectionStateType
  2. See ConnectionAuthorizationTypeType

CreateApiDestinationRequestRequestTypeDef#

# CreateApiDestinationRequestRequestTypeDef definition

class CreateApiDestinationRequestRequestTypeDef(TypedDict):
    Name: str,
    ConnectionArn: str,
    InvocationEndpoint: str,
    HttpMethod: ApiDestinationHttpMethodType,  # (1)
    Description: NotRequired[str],
    InvocationRateLimitPerSecond: NotRequired[int],
  1. See ApiDestinationHttpMethodType

CreateArchiveRequestRequestTypeDef#

# CreateArchiveRequestRequestTypeDef definition

class CreateArchiveRequestRequestTypeDef(TypedDict):
    ArchiveName: str,
    EventSourceArn: str,
    Description: NotRequired[str],
    EventPattern: NotRequired[str],
    RetentionDays: NotRequired[int],

CreateConnectionApiKeyAuthRequestParametersTypeDef#

# CreateConnectionApiKeyAuthRequestParametersTypeDef definition

class CreateConnectionApiKeyAuthRequestParametersTypeDef(TypedDict):
    ApiKeyName: str,
    ApiKeyValue: str,

CreateConnectionBasicAuthRequestParametersTypeDef#

# CreateConnectionBasicAuthRequestParametersTypeDef definition

class CreateConnectionBasicAuthRequestParametersTypeDef(TypedDict):
    Username: str,
    Password: str,

CreateConnectionOAuthClientRequestParametersTypeDef#

# CreateConnectionOAuthClientRequestParametersTypeDef definition

class CreateConnectionOAuthClientRequestParametersTypeDef(TypedDict):
    ClientID: str,
    ClientSecret: str,

EndpointEventBusTypeDef#

# EndpointEventBusTypeDef definition

class EndpointEventBusTypeDef(TypedDict):
    EventBusArn: str,

ReplicationConfigTypeDef#

# ReplicationConfigTypeDef definition

class ReplicationConfigTypeDef(TypedDict):
    State: NotRequired[ReplicationStateType],  # (1)
  1. See ReplicationStateType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

CreatePartnerEventSourceRequestRequestTypeDef#

# CreatePartnerEventSourceRequestRequestTypeDef definition

class CreatePartnerEventSourceRequestRequestTypeDef(TypedDict):
    Name: str,
    Account: str,

DeactivateEventSourceRequestRequestTypeDef#

# DeactivateEventSourceRequestRequestTypeDef definition

class DeactivateEventSourceRequestRequestTypeDef(TypedDict):
    Name: str,

DeadLetterConfigTypeDef#

# DeadLetterConfigTypeDef definition

class DeadLetterConfigTypeDef(TypedDict):
    Arn: NotRequired[str],

DeauthorizeConnectionRequestRequestTypeDef#

# DeauthorizeConnectionRequestRequestTypeDef definition

class DeauthorizeConnectionRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteApiDestinationRequestRequestTypeDef#

# DeleteApiDestinationRequestRequestTypeDef definition

class DeleteApiDestinationRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteArchiveRequestRequestTypeDef#

# DeleteArchiveRequestRequestTypeDef definition

class DeleteArchiveRequestRequestTypeDef(TypedDict):
    ArchiveName: str,

DeleteConnectionRequestRequestTypeDef#

# DeleteConnectionRequestRequestTypeDef definition

class DeleteConnectionRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteEndpointRequestRequestTypeDef#

# DeleteEndpointRequestRequestTypeDef definition

class DeleteEndpointRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteEventBusRequestRequestTypeDef#

# DeleteEventBusRequestRequestTypeDef definition

class DeleteEventBusRequestRequestTypeDef(TypedDict):
    Name: str,

DeletePartnerEventSourceRequestRequestTypeDef#

# DeletePartnerEventSourceRequestRequestTypeDef definition

class DeletePartnerEventSourceRequestRequestTypeDef(TypedDict):
    Name: str,
    Account: str,

DeleteRuleRequestRequestTypeDef#

# DeleteRuleRequestRequestTypeDef definition

class DeleteRuleRequestRequestTypeDef(TypedDict):
    Name: str,
    EventBusName: NotRequired[str],
    Force: NotRequired[bool],

DescribeApiDestinationRequestRequestTypeDef#

# DescribeApiDestinationRequestRequestTypeDef definition

class DescribeApiDestinationRequestRequestTypeDef(TypedDict):
    Name: str,

DescribeArchiveRequestRequestTypeDef#

# DescribeArchiveRequestRequestTypeDef definition

class DescribeArchiveRequestRequestTypeDef(TypedDict):
    ArchiveName: str,

DescribeConnectionRequestRequestTypeDef#

# DescribeConnectionRequestRequestTypeDef definition

class DescribeConnectionRequestRequestTypeDef(TypedDict):
    Name: str,

DescribeEndpointRequestRequestTypeDef#

# DescribeEndpointRequestRequestTypeDef definition

class DescribeEndpointRequestRequestTypeDef(TypedDict):
    Name: str,
    HomeRegion: NotRequired[str],

DescribeEventBusRequestRequestTypeDef#

# DescribeEventBusRequestRequestTypeDef definition

class DescribeEventBusRequestRequestTypeDef(TypedDict):
    Name: NotRequired[str],

DescribeEventSourceRequestRequestTypeDef#

# DescribeEventSourceRequestRequestTypeDef definition

class DescribeEventSourceRequestRequestTypeDef(TypedDict):
    Name: str,

DescribePartnerEventSourceRequestRequestTypeDef#

# DescribePartnerEventSourceRequestRequestTypeDef definition

class DescribePartnerEventSourceRequestRequestTypeDef(TypedDict):
    Name: str,

DescribeReplayRequestRequestTypeDef#

# DescribeReplayRequestRequestTypeDef definition

class DescribeReplayRequestRequestTypeDef(TypedDict):
    ReplayName: str,

ReplayDestinationTypeDef#

# ReplayDestinationTypeDef definition

class ReplayDestinationTypeDef(TypedDict):
    Arn: str,
    FilterArns: NotRequired[List[str]],

DescribeRuleRequestRequestTypeDef#

# DescribeRuleRequestRequestTypeDef definition

class DescribeRuleRequestRequestTypeDef(TypedDict):
    Name: str,
    EventBusName: NotRequired[str],

DisableRuleRequestRequestTypeDef#

# DisableRuleRequestRequestTypeDef definition

class DisableRuleRequestRequestTypeDef(TypedDict):
    Name: str,
    EventBusName: NotRequired[str],

PlacementConstraintTypeDef#

# PlacementConstraintTypeDef definition

class PlacementConstraintTypeDef(TypedDict):
    type: NotRequired[PlacementConstraintTypeType],  # (1)
    expression: NotRequired[str],
  1. See PlacementConstraintTypeType

PlacementStrategyTypeDef#