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
# EventBridgeClient usage example
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.
# Exceptions.exceptions usage example
client = boto3.client("events")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ConcurrentModificationException,
client.exceptions.IllegalStatusException,
client.exceptions.InternalException,
client.exceptions.InvalidEventPatternException,
client.exceptions.InvalidStateException,
client.exceptions.LimitExceededException,
client.exceptions.ManagedRuleException,
client.exceptions.OperationDisabledException,
client.exceptions.PolicyLengthExceededException,
client.exceptions.ResourceAlreadyExistsException,
client.exceptions.ResourceNotFoundException,
) as e:
print(e)# Exceptions.exceptions type checking example
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
# activate_event_source method definition
def activate_event_source(
self,
*,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# activate_event_source method usage example with argument unpacking
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
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...cancel_replay#
Cancels the specified replay.
Type annotations and code completion for boto3.client("events").cancel_replay method.
boto3 documentation
# cancel_replay method definition
def cancel_replay(
self,
*,
ReplayName: str,
) -> CancelReplayResponseTypeDef: # (1)
...# cancel_replay method usage example with argument unpacking
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
# close method definition
def close(
self,
) -> None:
...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
# create_api_destination method definition
def create_api_destination(
self,
*,
Name: str,
ConnectionArn: str,
InvocationEndpoint: str,
HttpMethod: ApiDestinationHttpMethodType, # (1)
Description: str = ...,
InvocationRateLimitPerSecond: int = ...,
) -> CreateApiDestinationResponseTypeDef: # (2)
...# create_api_destination method usage example with argument unpacking
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
# create_archive method definition
def create_archive(
self,
*,
ArchiveName: str,
EventSourceArn: str,
Description: str = ...,
EventPattern: str = ...,
RetentionDays: int = ...,
) -> CreateArchiveResponseTypeDef: # (1)
...# create_archive method usage example with argument unpacking
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
# create_connection method definition
def create_connection(
self,
*,
Name: str,
AuthorizationType: ConnectionAuthorizationTypeType, # (1)
AuthParameters: CreateConnectionAuthRequestParametersTypeDef, # (2)
Description: str = ...,
) -> CreateConnectionResponseTypeDef: # (3)
...- See ConnectionAuthorizationTypeType
- See CreateConnectionAuthRequestParametersTypeDef
- See CreateConnectionResponseTypeDef
# create_connection method usage example with argument unpacking
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
# create_endpoint method definition
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
# create_endpoint method usage example with argument unpacking
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
# create_event_bus method definition
def create_event_bus(
self,
*,
Name: str,
EventSourceName: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateEventBusResponseTypeDef: # (2)
...# create_event_bus method usage example with argument unpacking
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
# create_partner_event_source method definition
def create_partner_event_source(
self,
*,
Name: str,
Account: str,
) -> CreatePartnerEventSourceResponseTypeDef: # (1)
...# create_partner_event_source method usage example with argument unpacking
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
# deactivate_event_source method definition
def deactivate_event_source(
self,
*,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# deactivate_event_source method usage example with argument unpacking
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
# deauthorize_connection method definition
def deauthorize_connection(
self,
*,
Name: str,
) -> DeauthorizeConnectionResponseTypeDef: # (1)
...# deauthorize_connection method usage example with argument unpacking
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
# delete_api_destination method definition
def delete_api_destination(
self,
*,
Name: str,
) -> Dict[str, Any]:
...# delete_api_destination method usage example with argument unpacking
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
# delete_archive method definition
def delete_archive(
self,
*,
ArchiveName: str,
) -> Dict[str, Any]:
...# delete_archive method usage example with argument unpacking
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
# delete_connection method definition
def delete_connection(
self,
*,
Name: str,
) -> DeleteConnectionResponseTypeDef: # (1)
...# delete_connection method usage example with argument unpacking
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
# delete_endpoint method definition
def delete_endpoint(
self,
*,
Name: str,
) -> Dict[str, Any]:
...# delete_endpoint method usage example with argument unpacking
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
# delete_event_bus method definition
def delete_event_bus(
self,
*,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_event_bus method usage example with argument unpacking
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
# delete_partner_event_source method definition
def delete_partner_event_source(
self,
*,
Name: str,
Account: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_partner_event_source method usage example with argument unpacking
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
# delete_rule method definition
def delete_rule(
self,
*,
Name: str,
EventBusName: str = ...,
Force: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_rule method usage example with argument unpacking
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
# describe_api_destination method definition
def describe_api_destination(
self,
*,
Name: str,
) -> DescribeApiDestinationResponseTypeDef: # (1)
...# describe_api_destination method usage example with argument unpacking
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
# describe_archive method definition
def describe_archive(
self,
*,
ArchiveName: str,
) -> DescribeArchiveResponseTypeDef: # (1)
...# describe_archive method usage example with argument unpacking
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
# describe_connection method definition
def describe_connection(
self,
*,
Name: str,
) -> DescribeConnectionResponseTypeDef: # (1)
...# describe_connection method usage example with argument unpacking
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
# describe_endpoint method definition
def describe_endpoint(
self,
*,
Name: str,
HomeRegion: str = ...,
) -> DescribeEndpointResponseTypeDef: # (1)
...# describe_endpoint method usage example with argument unpacking
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
# describe_event_bus method definition
def describe_event_bus(
self,
*,
Name: str = ...,
) -> DescribeEventBusResponseTypeDef: # (1)
...# describe_event_bus method usage example with argument unpacking
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
# describe_event_source method definition
def describe_event_source(
self,
*,
Name: str,
) -> DescribeEventSourceResponseTypeDef: # (1)
...# describe_event_source method usage example with argument unpacking
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
# describe_partner_event_source method definition
def describe_partner_event_source(
self,
*,
Name: str,
) -> DescribePartnerEventSourceResponseTypeDef: # (1)
...# describe_partner_event_source method usage example with argument unpacking
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
# describe_replay method definition
def describe_replay(
self,
*,
ReplayName: str,
) -> DescribeReplayResponseTypeDef: # (1)
...# describe_replay method usage example with argument unpacking
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
# describe_rule method definition
def describe_rule(
self,
*,
Name: str,
EventBusName: str = ...,
) -> DescribeRuleResponseTypeDef: # (1)
...# describe_rule method usage example with argument unpacking
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
# disable_rule method definition
def disable_rule(
self,
*,
Name: str,
EventBusName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disable_rule method usage example with argument unpacking
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
# enable_rule method definition
def enable_rule(
self,
*,
Name: str,
EventBusName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# enable_rule method usage example with argument unpacking
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
# generate_presigned_url method definition
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
# list_api_destinations method definition
def list_api_destinations(
self,
*,
NamePrefix: str = ...,
ConnectionArn: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListApiDestinationsResponseTypeDef: # (1)
...# list_api_destinations method usage example with argument unpacking
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
# list_archives method definition
def list_archives(
self,
*,
NamePrefix: str = ...,
EventSourceArn: str = ...,
State: ArchiveStateType = ..., # (1)
NextToken: str = ...,
Limit: int = ...,
) -> ListArchivesResponseTypeDef: # (2)
...# list_archives method usage example with argument unpacking
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
# list_connections method definition
def list_connections(
self,
*,
NamePrefix: str = ...,
ConnectionState: ConnectionStateType = ..., # (1)
NextToken: str = ...,
Limit: int = ...,
) -> ListConnectionsResponseTypeDef: # (2)
...# list_connections method usage example with argument unpacking
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
# list_endpoints method definition
def list_endpoints(
self,
*,
NamePrefix: str = ...,
HomeRegion: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListEndpointsResponseTypeDef: # (1)
...# list_endpoints method usage example with argument unpacking
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
# list_event_buses method definition
def list_event_buses(
self,
*,
NamePrefix: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListEventBusesResponseTypeDef: # (1)
...# list_event_buses method usage example with argument unpacking
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
# list_event_sources method definition
def list_event_sources(
self,
*,
NamePrefix: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListEventSourcesResponseTypeDef: # (1)
...# list_event_sources method usage example with argument unpacking
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
# list_partner_event_source_accounts method definition
def list_partner_event_source_accounts(
self,
*,
EventSourceName: str,
NextToken: str = ...,
Limit: int = ...,
) -> ListPartnerEventSourceAccountsResponseTypeDef: # (1)
...# list_partner_event_source_accounts method usage example with argument unpacking
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
# list_partner_event_sources method definition
def list_partner_event_sources(
self,
*,
NamePrefix: str,
NextToken: str = ...,
Limit: int = ...,
) -> ListPartnerEventSourcesResponseTypeDef: # (1)
...# list_partner_event_sources method usage example with argument unpacking
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
# list_replays method definition
def list_replays(
self,
*,
NamePrefix: str = ...,
State: ReplayStateType = ..., # (1)
EventSourceArn: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListReplaysResponseTypeDef: # (2)
...# list_replays method usage example with argument unpacking
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
# list_rule_names_by_target method definition
def list_rule_names_by_target(
self,
*,
TargetArn: str,
EventBusName: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListRuleNamesByTargetResponseTypeDef: # (1)
...# list_rule_names_by_target method usage example with argument unpacking
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
# list_rules method definition
def list_rules(
self,
*,
NamePrefix: str = ...,
EventBusName: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListRulesResponseTypeDef: # (1)
...# list_rules method usage example with argument unpacking
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
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
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
# list_targets_by_rule method definition
def list_targets_by_rule(
self,
*,
Rule: str,
EventBusName: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListTargetsByRuleResponseTypeDef: # (1)
...# list_targets_by_rule method usage example with argument unpacking
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
# put_events method definition
def put_events(
self,
*,
Entries: Sequence[PutEventsRequestEntryTypeDef], # (1)
EndpointId: str = ...,
) -> PutEventsResponseTypeDef: # (2)
...# put_events method usage example with argument unpacking
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
# put_partner_events method definition
def put_partner_events(
self,
*,
Entries: Sequence[PutPartnerEventsRequestEntryTypeDef], # (1)
) -> PutPartnerEventsResponseTypeDef: # (2)
...# put_partner_events method usage example with argument unpacking
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
# put_permission method definition
def put_permission(
self,
*,
EventBusName: str = ...,
Action: str = ...,
Principal: str = ...,
StatementId: str = ...,
Condition: ConditionTypeDef = ..., # (1)
Policy: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...# put_permission method usage example with argument unpacking
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
# put_rule method definition
def put_rule(
self,
*,
Name: str,
ScheduleExpression: str = ...,
EventPattern: str = ...,
State: RuleStateType = ..., # (1)
Description: str = ...,
RoleArn: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
EventBusName: str = ...,
) -> PutRuleResponseTypeDef: # (3)
...- See RuleStateType
- See TagTypeDef
- See PutRuleResponseTypeDef
# put_rule method usage example with argument unpacking
kwargs: PutRuleRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.put_rule(**kwargs)put_targets#
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Type annotations and code completion for boto3.client("events").put_targets method.
boto3 documentation
# put_targets method definition
def put_targets(
self,
*,
Rule: str,
Targets: Sequence[TargetTypeDef], # (1)
EventBusName: str = ...,
) -> PutTargetsResponseTypeDef: # (2)
...# put_targets method usage example with argument unpacking
kwargs: PutTargetsRequestRequestTypeDef = { # (1)
"Rule": ...,
"Targets": ...,
}
parent.put_targets(**kwargs)remove_permission#
Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus.
Type annotations and code completion for boto3.client("events").remove_permission method.
boto3 documentation
# remove_permission method definition
def remove_permission(
self,
*,
StatementId: str = ...,
RemoveAllPermissions: bool = ...,
EventBusName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# remove_permission method usage example with argument unpacking
kwargs: RemovePermissionRequestRequestTypeDef = { # (1)
"StatementId": ...,
}
parent.remove_permission(**kwargs)remove_targets#
Removes the specified targets from the specified rule.
Type annotations and code completion for boto3.client("events").remove_targets method.
boto3 documentation
# remove_targets method definition
def remove_targets(
self,
*,
Rule: str,
Ids: Sequence[str],
EventBusName: str = ...,
Force: bool = ...,
) -> RemoveTargetsResponseTypeDef: # (1)
...# remove_targets method usage example with argument unpacking
kwargs: RemoveTargetsRequestRequestTypeDef = { # (1)
"Rule": ...,
"Ids": ...,
}
parent.remove_targets(**kwargs)start_replay#
Starts the specified replay.
Type annotations and code completion for boto3.client("events").start_replay method.
boto3 documentation
# start_replay method definition
def start_replay(
self,
*,
ReplayName: str,
EventSourceArn: str,
EventStartTime: Union[datetime, str],
EventEndTime: Union[datetime, str],
Destination: ReplayDestinationTypeDef, # (1)
Description: str = ...,
) -> StartReplayResponseTypeDef: # (2)
...# start_replay method usage example with argument unpacking
kwargs: StartReplayRequestRequestTypeDef = { # (1)
"ReplayName": ...,
"EventSourceArn": ...,
"EventStartTime": ...,
"EventEndTime": ...,
"Destination": ...,
}
parent.start_replay(**kwargs)tag_resource#
Assigns one or more tags (key-value pairs) to the specified EventBridge resource.
Type annotations and code completion for boto3.client("events").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)test_event_pattern#
Tests whether the specified event pattern matches the provided event.
Type annotations and code completion for boto3.client("events").test_event_pattern method.
boto3 documentation
# test_event_pattern method definition
def test_event_pattern(
self,
*,
EventPattern: str,
Event: str,
) -> TestEventPatternResponseTypeDef: # (1)
...# test_event_pattern method usage example with argument unpacking
kwargs: TestEventPatternRequestRequestTypeDef = { # (1)
"EventPattern": ...,
"Event": ...,
}
parent.test_event_pattern(**kwargs)untag_resource#
Removes one or more tags from the specified EventBridge resource.
Type annotations and code completion for boto3.client("events").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)update_api_destination#
Updates an API destination.
Type annotations and code completion for boto3.client("events").update_api_destination method.
boto3 documentation
# update_api_destination method definition
def update_api_destination(
self,
*,
Name: str,
Description: str = ...,
ConnectionArn: str = ...,
InvocationEndpoint: str = ...,
HttpMethod: ApiDestinationHttpMethodType = ..., # (1)
InvocationRateLimitPerSecond: int = ...,
) -> UpdateApiDestinationResponseTypeDef: # (2)
...# update_api_destination method usage example with argument unpacking
kwargs: UpdateApiDestinationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.update_api_destination(**kwargs)update_archive#
Updates the specified archive.
Type annotations and code completion for boto3.client("events").update_archive method.
boto3 documentation
# update_archive method definition
def update_archive(
self,
*,
ArchiveName: str,
Description: str = ...,
EventPattern: str = ...,
RetentionDays: int = ...,
) -> UpdateArchiveResponseTypeDef: # (1)
...# update_archive method usage example with argument unpacking
kwargs: UpdateArchiveRequestRequestTypeDef = { # (1)
"ArchiveName": ...,
}
parent.update_archive(**kwargs)update_connection#
Updates settings for a connection.
Type annotations and code completion for boto3.client("events").update_connection method.
boto3 documentation
# update_connection method definition
def update_connection(
self,
*,
Name: str,
Description: str = ...,
AuthorizationType: ConnectionAuthorizationTypeType = ..., # (1)
AuthParameters: UpdateConnectionAuthRequestParametersTypeDef = ..., # (2)
) -> UpdateConnectionResponseTypeDef: # (3)
...- See ConnectionAuthorizationTypeType
- See UpdateConnectionAuthRequestParametersTypeDef
- See UpdateConnectionResponseTypeDef
# update_connection method usage example with argument unpacking
kwargs: UpdateConnectionRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.update_connection(**kwargs)update_endpoint#
Update an existing endpoint.
Type annotations and code completion for boto3.client("events").update_endpoint method.
boto3 documentation
# update_endpoint method definition
def update_endpoint(
self,
*,
Name: str,
Description: str = ...,
RoutingConfig: RoutingConfigTypeDef = ..., # (1)
ReplicationConfig: ReplicationConfigTypeDef = ..., # (2)
EventBuses: Sequence[EndpointEventBusTypeDef] = ..., # (3)
RoleArn: str = ...,
) -> UpdateEndpointResponseTypeDef: # (4)
...- See RoutingConfigTypeDef
- See ReplicationConfigTypeDef
- See EndpointEventBusTypeDef
- See UpdateEndpointResponseTypeDef
# update_endpoint method usage example with argument unpacking
kwargs: UpdateEndpointRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.update_endpoint(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("events").get_paginator method with overloads.
client.get_paginator("list_rule_names_by_target")-> ListRuleNamesByTargetPaginatorclient.get_paginator("list_rules")-> ListRulesPaginatorclient.get_paginator("list_targets_by_rule")-> ListTargetsByRulePaginator