EventBridgeClient
Index > EventBridge > EventBridgeClient
Auto-generated documentation for EventBridge type annotations stubs module mypy-boto3-events.
EventBridgeClient
Type annotations and code completion for boto3.client("events")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_events.client import EventBridgeClient
def get_events_client() -> EventBridgeClient:
return Session().client("events")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("events").exceptions
structure.
client = boto3.client("events")
try:
do_something(client)
except (
client.ClientError,
client.ConcurrentModificationException,
client.IllegalStatusException,
client.InternalException,
client.InvalidEventPatternException,
client.InvalidStateException,
client.LimitExceededException,
client.ManagedRuleException,
client.OperationDisabledException,
client.PolicyLengthExceededException,
client.ResourceAlreadyExistsException,
client.ResourceNotFoundException,
) as e:
print(e)
from mypy_boto3_events.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
activate_event_source
Activates a partner event source that has been deactivated.
Type annotations and code completion for boto3.client("events").activate_event_source
method.
boto3 documentation
def activate_event_source(
self,
*,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: ActivateEventSourceRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.activate_event_source(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("events").can_paginate
method.
boto3 documentation
cancel_replay
Cancels the specified replay.
Type annotations and code completion for boto3.client("events").cancel_replay
method.
boto3 documentation
def cancel_replay(
self,
*,
ReplayName: str,
) -> CancelReplayResponseTypeDef: # (1)
...
kwargs: CancelReplayRequestRequestTypeDef = { # (1)
"ReplayName": ...,
}
parent.cancel_replay(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("events").close
method.
boto3 documentation
create_api_destination
Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
Type annotations and code completion for boto3.client("events").create_api_destination
method.
boto3 documentation
def create_api_destination(
self,
*,
Name: str,
ConnectionArn: str,
InvocationEndpoint: str,
HttpMethod: ApiDestinationHttpMethodType, # (1)
Description: str = ...,
InvocationRateLimitPerSecond: int = ...,
) -> CreateApiDestinationResponseTypeDef: # (2)
...
kwargs: CreateApiDestinationRequestRequestTypeDef = { # (1)
"Name": ...,
"ConnectionArn": ...,
"InvocationEndpoint": ...,
"HttpMethod": ...,
}
parent.create_api_destination(**kwargs)
create_archive
Creates an archive of events with the specified settings.
Type annotations and code completion for boto3.client("events").create_archive
method.
boto3 documentation
def create_archive(
self,
*,
ArchiveName: str,
EventSourceArn: str,
Description: str = ...,
EventPattern: str = ...,
RetentionDays: int = ...,
) -> CreateArchiveResponseTypeDef: # (1)
...
kwargs: CreateArchiveRequestRequestTypeDef = { # (1)
"ArchiveName": ...,
"EventSourceArn": ...,
}
parent.create_archive(**kwargs)
create_connection
Creates a connection.
Type annotations and code completion for boto3.client("events").create_connection
method.
boto3 documentation
def create_connection(
self,
*,
Name: str,
AuthorizationType: ConnectionAuthorizationTypeType, # (1)
AuthParameters: CreateConnectionAuthRequestParametersTypeDef, # (2)
Description: str = ...,
) -> CreateConnectionResponseTypeDef: # (3)
...
- See ConnectionAuthorizationTypeType
- See CreateConnectionAuthRequestParametersTypeDef
- See CreateConnectionResponseTypeDef
kwargs: CreateConnectionRequestRequestTypeDef = { # (1)
"Name": ...,
"AuthorizationType": ...,
"AuthParameters": ...,
}
parent.create_connection(**kwargs)
create_endpoint
Creates a global endpoint.
Type annotations and code completion for boto3.client("events").create_endpoint
method.
boto3 documentation
def create_endpoint(
self,
*,
Name: str,
RoutingConfig: RoutingConfigTypeDef, # (1)
EventBuses: Sequence[EndpointEventBusTypeDef], # (2)
Description: str = ...,
ReplicationConfig: ReplicationConfigTypeDef = ..., # (3)
RoleArn: str = ...,
) -> CreateEndpointResponseTypeDef: # (4)
...
- See RoutingConfigTypeDef
- See EndpointEventBusTypeDef
- See ReplicationConfigTypeDef
- See CreateEndpointResponseTypeDef
kwargs: CreateEndpointRequestRequestTypeDef = { # (1)
"Name": ...,
"RoutingConfig": ...,
"EventBuses": ...,
}
parent.create_endpoint(**kwargs)
create_event_bus
Creates a new event bus within your account.
Type annotations and code completion for boto3.client("events").create_event_bus
method.
boto3 documentation
def create_event_bus(
self,
*,
Name: str,
EventSourceName: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateEventBusResponseTypeDef: # (2)
...
kwargs: CreateEventBusRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_event_bus(**kwargs)
create_partner_event_source
Called by an SaaS partner to create a partner event source.
Type annotations and code completion for boto3.client("events").create_partner_event_source
method.
boto3 documentation
def create_partner_event_source(
self,
*,
Name: str,
Account: str,
) -> CreatePartnerEventSourceResponseTypeDef: # (1)
...
kwargs: CreatePartnerEventSourceRequestRequestTypeDef = { # (1)
"Name": ...,
"Account": ...,
}
parent.create_partner_event_source(**kwargs)
deactivate_event_source
You can use this operation to temporarily stop receiving events from the specified partner event source.
Type annotations and code completion for boto3.client("events").deactivate_event_source
method.
boto3 documentation
def deactivate_event_source(
self,
*,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeactivateEventSourceRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.deactivate_event_source(**kwargs)
deauthorize_connection
Removes all authorization parameters from the connection.
Type annotations and code completion for boto3.client("events").deauthorize_connection
method.
boto3 documentation
def deauthorize_connection(
self,
*,
Name: str,
) -> DeauthorizeConnectionResponseTypeDef: # (1)
...
kwargs: DeauthorizeConnectionRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.deauthorize_connection(**kwargs)
delete_api_destination
Deletes the specified API destination.
Type annotations and code completion for boto3.client("events").delete_api_destination
method.
boto3 documentation
kwargs: DeleteApiDestinationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_api_destination(**kwargs)
delete_archive
Deletes the specified archive.
Type annotations and code completion for boto3.client("events").delete_archive
method.
boto3 documentation
kwargs: DeleteArchiveRequestRequestTypeDef = { # (1)
"ArchiveName": ...,
}
parent.delete_archive(**kwargs)
delete_connection
Deletes a connection.
Type annotations and code completion for boto3.client("events").delete_connection
method.
boto3 documentation
def delete_connection(
self,
*,
Name: str,
) -> DeleteConnectionResponseTypeDef: # (1)
...
kwargs: DeleteConnectionRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_connection(**kwargs)
delete_endpoint
Delete an existing global endpoint.
Type annotations and code completion for boto3.client("events").delete_endpoint
method.
boto3 documentation
kwargs: DeleteEndpointRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_endpoint(**kwargs)
delete_event_bus
Deletes the specified custom event bus or partner event bus.
Type annotations and code completion for boto3.client("events").delete_event_bus
method.
boto3 documentation
def delete_event_bus(
self,
*,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteEventBusRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_event_bus(**kwargs)
delete_partner_event_source
This operation is used by SaaS partners to delete a partner event source.
Type annotations and code completion for boto3.client("events").delete_partner_event_source
method.
boto3 documentation
def delete_partner_event_source(
self,
*,
Name: str,
Account: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeletePartnerEventSourceRequestRequestTypeDef = { # (1)
"Name": ...,
"Account": ...,
}
parent.delete_partner_event_source(**kwargs)
delete_rule
Deletes the specified rule.
Type annotations and code completion for boto3.client("events").delete_rule
method.
boto3 documentation
def delete_rule(
self,
*,
Name: str,
EventBusName: str = ...,
Force: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRuleRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_rule(**kwargs)
describe_api_destination
Retrieves details about an API destination.
Type annotations and code completion for boto3.client("events").describe_api_destination
method.
boto3 documentation
def describe_api_destination(
self,
*,
Name: str,
) -> DescribeApiDestinationResponseTypeDef: # (1)
...
kwargs: DescribeApiDestinationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_api_destination(**kwargs)
describe_archive
Retrieves details about an archive.
Type annotations and code completion for boto3.client("events").describe_archive
method.
boto3 documentation
def describe_archive(
self,
*,
ArchiveName: str,
) -> DescribeArchiveResponseTypeDef: # (1)
...
kwargs: DescribeArchiveRequestRequestTypeDef = { # (1)
"ArchiveName": ...,
}
parent.describe_archive(**kwargs)
describe_connection
Retrieves details about a connection.
Type annotations and code completion for boto3.client("events").describe_connection
method.
boto3 documentation
def describe_connection(
self,
*,
Name: str,
) -> DescribeConnectionResponseTypeDef: # (1)
...
kwargs: DescribeConnectionRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_connection(**kwargs)
describe_endpoint
Get the information about an existing global endpoint.
Type annotations and code completion for boto3.client("events").describe_endpoint
method.
boto3 documentation
def describe_endpoint(
self,
*,
Name: str,
HomeRegion: str = ...,
) -> DescribeEndpointResponseTypeDef: # (1)
...
kwargs: DescribeEndpointRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_endpoint(**kwargs)
describe_event_bus
Displays details about an event bus in your account.
Type annotations and code completion for boto3.client("events").describe_event_bus
method.
boto3 documentation
def describe_event_bus(
self,
*,
Name: str = ...,
) -> DescribeEventBusResponseTypeDef: # (1)
...
kwargs: DescribeEventBusRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_event_bus(**kwargs)
describe_event_source
This operation lists details about a partner event source that is shared with your account.
Type annotations and code completion for boto3.client("events").describe_event_source
method.
boto3 documentation
def describe_event_source(
self,
*,
Name: str,
) -> DescribeEventSourceResponseTypeDef: # (1)
...
kwargs: DescribeEventSourceRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_event_source(**kwargs)
describe_partner_event_source
An SaaS partner can use this operation to list details about a partner event source that they have created.
Type annotations and code completion for boto3.client("events").describe_partner_event_source
method.
boto3 documentation
def describe_partner_event_source(
self,
*,
Name: str,
) -> DescribePartnerEventSourceResponseTypeDef: # (1)
...
kwargs: DescribePartnerEventSourceRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_partner_event_source(**kwargs)
describe_replay
Retrieves details about a replay.
Type annotations and code completion for boto3.client("events").describe_replay
method.
boto3 documentation
def describe_replay(
self,
*,
ReplayName: str,
) -> DescribeReplayResponseTypeDef: # (1)
...
kwargs: DescribeReplayRequestRequestTypeDef = { # (1)
"ReplayName": ...,
}
parent.describe_replay(**kwargs)
describe_rule
Describes the specified rule.
Type annotations and code completion for boto3.client("events").describe_rule
method.
boto3 documentation
def describe_rule(
self,
*,
Name: str,
EventBusName: str = ...,
) -> DescribeRuleResponseTypeDef: # (1)
...
kwargs: DescribeRuleRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_rule(**kwargs)
disable_rule
Disables the specified rule.
Type annotations and code completion for boto3.client("events").disable_rule
method.
boto3 documentation
def disable_rule(
self,
*,
Name: str,
EventBusName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisableRuleRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.disable_rule(**kwargs)
enable_rule
Enables the specified rule.
Type annotations and code completion for boto3.client("events").enable_rule
method.
boto3 documentation
def enable_rule(
self,
*,
Name: str,
EventBusName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: EnableRuleRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.enable_rule(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("events").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_api_destinations
Retrieves a list of API destination in the account in the current Region.
Type annotations and code completion for boto3.client("events").list_api_destinations
method.
boto3 documentation
def list_api_destinations(
self,
*,
NamePrefix: str = ...,
ConnectionArn: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListApiDestinationsResponseTypeDef: # (1)
...
kwargs: ListApiDestinationsRequestRequestTypeDef = { # (1)
"NamePrefix": ...,
}
parent.list_api_destinations(**kwargs)
list_archives
Lists your archives.
Type annotations and code completion for boto3.client("events").list_archives
method.
boto3 documentation
def list_archives(
self,
*,
NamePrefix: str = ...,
EventSourceArn: str = ...,
State: ArchiveStateType = ..., # (1)
NextToken: str = ...,
Limit: int = ...,
) -> ListArchivesResponseTypeDef: # (2)
...
kwargs: ListArchivesRequestRequestTypeDef = { # (1)
"NamePrefix": ...,
}
parent.list_archives(**kwargs)
list_connections
Retrieves a list of connections from the account.
Type annotations and code completion for boto3.client("events").list_connections
method.
boto3 documentation
def list_connections(
self,
*,
NamePrefix: str = ...,
ConnectionState: ConnectionStateType = ..., # (1)
NextToken: str = ...,
Limit: int = ...,
) -> ListConnectionsResponseTypeDef: # (2)
...
kwargs: ListConnectionsRequestRequestTypeDef = { # (1)
"NamePrefix": ...,
}
parent.list_connections(**kwargs)
list_endpoints
List the global endpoints associated with this account.
Type annotations and code completion for boto3.client("events").list_endpoints
method.
boto3 documentation
def list_endpoints(
self,
*,
NamePrefix: str = ...,
HomeRegion: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListEndpointsResponseTypeDef: # (1)
...
kwargs: ListEndpointsRequestRequestTypeDef = { # (1)
"NamePrefix": ...,
}
parent.list_endpoints(**kwargs)
list_event_buses
Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
Type annotations and code completion for boto3.client("events").list_event_buses
method.
boto3 documentation
def list_event_buses(
self,
*,
NamePrefix: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListEventBusesResponseTypeDef: # (1)
...
kwargs: ListEventBusesRequestRequestTypeDef = { # (1)
"NamePrefix": ...,
}
parent.list_event_buses(**kwargs)
list_event_sources
You can use this to see all the partner event sources that have been shared with your Amazon Web Services account.
Type annotations and code completion for boto3.client("events").list_event_sources
method.
boto3 documentation
def list_event_sources(
self,
*,
NamePrefix: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListEventSourcesResponseTypeDef: # (1)
...
kwargs: ListEventSourcesRequestRequestTypeDef = { # (1)
"NamePrefix": ...,
}
parent.list_event_sources(**kwargs)
list_partner_event_source_accounts
An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with.
Type annotations and code completion for boto3.client("events").list_partner_event_source_accounts
method.
boto3 documentation
def list_partner_event_source_accounts(
self,
*,
EventSourceName: str,
NextToken: str = ...,
Limit: int = ...,
) -> ListPartnerEventSourceAccountsResponseTypeDef: # (1)
...
kwargs: ListPartnerEventSourceAccountsRequestRequestTypeDef = { # (1)
"EventSourceName": ...,
}
parent.list_partner_event_source_accounts(**kwargs)
list_partner_event_sources
An SaaS partner can use this operation to list all the partner event source names that they have created.
Type annotations and code completion for boto3.client("events").list_partner_event_sources
method.
boto3 documentation
def list_partner_event_sources(
self,
*,
NamePrefix: str,
NextToken: str = ...,
Limit: int = ...,
) -> ListPartnerEventSourcesResponseTypeDef: # (1)
...
kwargs: ListPartnerEventSourcesRequestRequestTypeDef = { # (1)
"NamePrefix": ...,
}
parent.list_partner_event_sources(**kwargs)
list_replays
Lists your replays.
Type annotations and code completion for boto3.client("events").list_replays
method.
boto3 documentation
def list_replays(
self,
*,
NamePrefix: str = ...,
State: ReplayStateType = ..., # (1)
EventSourceArn: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListReplaysResponseTypeDef: # (2)
...
kwargs: ListReplaysRequestRequestTypeDef = { # (1)
"NamePrefix": ...,
}
parent.list_replays(**kwargs)
list_rule_names_by_target
Lists the rules for the specified target.
Type annotations and code completion for boto3.client("events").list_rule_names_by_target
method.
boto3 documentation
def list_rule_names_by_target(
self,
*,
TargetArn: str,
EventBusName: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListRuleNamesByTargetResponseTypeDef: # (1)
...
kwargs: ListRuleNamesByTargetRequestRequestTypeDef = { # (1)
"TargetArn": ...,
}
parent.list_rule_names_by_target(**kwargs)
list_rules
Lists your Amazon EventBridge rules.
Type annotations and code completion for boto3.client("events").list_rules
method.
boto3 documentation
def list_rules(
self,
*,
NamePrefix: str = ...,
EventBusName: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListRulesResponseTypeDef: # (1)
...
kwargs: ListRulesRequestRequestTypeDef = { # (1)
"NamePrefix": ...,
}
parent.list_rules(**kwargs)
list_tags_for_resource
Displays the tags associated with an EventBridge resource.
Type annotations and code completion for boto3.client("events").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
list_targets_by_rule
Lists the targets assigned to the specified rule.
Type annotations and code completion for boto3.client("events").list_targets_by_rule
method.
boto3 documentation
def list_targets_by_rule(
self,
*,
Rule: str,
EventBusName: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListTargetsByRuleResponseTypeDef: # (1)
...
kwargs: ListTargetsByRuleRequestRequestTypeDef = { # (1)
"Rule": ...,
}
parent.list_targets_by_rule(**kwargs)
put_events
Sends custom events to Amazon EventBridge so that they can be matched to rules.
Type annotations and code completion for boto3.client("events").put_events
method.
boto3 documentation
def put_events(
self,
*,
Entries: Sequence[PutEventsRequestEntryTypeDef], # (1)
EndpointId: str = ...,
) -> PutEventsResponseTypeDef: # (2)
...
kwargs: PutEventsRequestRequestTypeDef = { # (1)
"Entries": ...,
}
parent.put_events(**kwargs)
put_partner_events
This is used by SaaS partners to write events to a customer's partner event bus.
Type annotations and code completion for boto3.client("events").put_partner_events
method.
boto3 documentation
def put_partner_events(
self,
*,
Entries: Sequence[PutPartnerEventsRequestEntryTypeDef], # (1)
) -> PutPartnerEventsResponseTypeDef: # (2)
...
kwargs: PutPartnerEventsRequestRequestTypeDef = { # (1)
"Entries": ...,
}
parent.put_partner_events(**kwargs)
put_permission
Running PutPermission
permits the specified Amazon Web Services account or
Amazon Web Services organization to put events to the specified event bus.
Type annotations and code completion for boto3.client("events").put_permission
method.
boto3 documentation
def put_permission(
self,
*,
EventBusName: str = ...,
Action: str = ...,
Principal: str = ...,
StatementId: str = ...,
Condition: ConditionTypeDef = ..., # (1)
Policy: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: PutPermissionRequestRequestTypeDef = { # (1)
"EventBusName": ...,
}
parent.put_permission(**kwargs)
put_rule
Creates or updates the specified rule.
Type annotations and code completion for boto3.client("events").put_rule
method.
boto3 documentation