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.AccessDeniedException,
    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,
    client.exceptions.ThrottlingException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_events.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

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:
    ...

generate_presigned_url

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:
    ...

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)
    ...

1. See EmptyResponseMetadataTypeDef

# activate_event_source method usage example with argument unpacking

kwargs: ActivateEventSourceRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.activate_event_source(**kwargs)

1. See ActivateEventSourceRequestRequestTypeDef

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)
    ...

1. See CancelReplayResponseTypeDef

# cancel_replay method usage example with argument unpacking

kwargs: CancelReplayRequestRequestTypeDef = {  # (1)
    "ReplayName": ...,
}

parent.cancel_replay(**kwargs)

1. See CancelReplayRequestRequestTypeDef

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)
    ...

1. See ApiDestinationHttpMethodType
2. See CreateApiDestinationResponseTypeDef

# create_api_destination method usage example with argument unpacking

kwargs: CreateApiDestinationRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ConnectionArn": ...,
    "InvocationEndpoint": ...,
    "HttpMethod": ...,
}

parent.create_api_destination(**kwargs)

1. See CreateApiDestinationRequestRequestTypeDef

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)
    ...

1. See CreateArchiveResponseTypeDef

# create_archive method usage example with argument unpacking

kwargs: CreateArchiveRequestRequestTypeDef = {  # (1)
    "ArchiveName": ...,
    "EventSourceArn": ...,
}

parent.create_archive(**kwargs)

1. See CreateArchiveRequestRequestTypeDef

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 = ...,
    InvocationConnectivityParameters: ConnectivityResourceParametersTypeDef = ...,  # (3)
) -> CreateConnectionResponseTypeDef:  # (4)
    ...

1. See ConnectionAuthorizationTypeType
2. See CreateConnectionAuthRequestParametersTypeDef
3. See ConnectivityResourceParametersTypeDef
4. See CreateConnectionResponseTypeDef

# create_connection method usage example with argument unpacking

kwargs: CreateConnectionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "AuthorizationType": ...,
    "AuthParameters": ...,
}

parent.create_connection(**kwargs)

1. See CreateConnectionRequestRequestTypeDef

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)
    ...

1. See RoutingConfigTypeDef
2. See EndpointEventBusTypeDef
3. See ReplicationConfigTypeDef
4. See CreateEndpointResponseTypeDef

# create_endpoint method usage example with argument unpacking

kwargs: CreateEndpointRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "RoutingConfig": ...,
    "EventBuses": ...,
}

parent.create_endpoint(**kwargs)

1. See CreateEndpointRequestRequestTypeDef

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 = ...,
    Description: str = ...,
    KmsKeyIdentifier: str = ...,
    DeadLetterConfig: DeadLetterConfigTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateEventBusResponseTypeDef:  # (3)
    ...

1. See DeadLetterConfigTypeDef
2. See TagTypeDef
3. See CreateEventBusResponseTypeDef

# create_event_bus method usage example with argument unpacking

kwargs: CreateEventBusRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_event_bus(**kwargs)

1. See CreateEventBusRequestRequestTypeDef

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)
    ...

1. See CreatePartnerEventSourceResponseTypeDef

# create_partner_event_source method usage example with argument unpacking

kwargs: CreatePartnerEventSourceRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Account": ...,
}

parent.create_partner_event_source(**kwargs)

1. See CreatePartnerEventSourceRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# deactivate_event_source method usage example with argument unpacking

kwargs: DeactivateEventSourceRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.deactivate_event_source(**kwargs)

1. See DeactivateEventSourceRequestRequestTypeDef

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)
    ...

1. See DeauthorizeConnectionResponseTypeDef

# deauthorize_connection method usage example with argument unpacking

kwargs: DeauthorizeConnectionRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.deauthorize_connection(**kwargs)

1. See DeauthorizeConnectionRequestRequestTypeDef

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)

1. See DeleteApiDestinationRequestRequestTypeDef

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)

1. See DeleteArchiveRequestRequestTypeDef

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)
    ...

1. See DeleteConnectionResponseTypeDef

# delete_connection method usage example with argument unpacking

kwargs: DeleteConnectionRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_connection(**kwargs)

1. See DeleteConnectionRequestRequestTypeDef

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)

1. See DeleteEndpointRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_event_bus method usage example with argument unpacking

kwargs: DeleteEventBusRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_event_bus(**kwargs)

1. See DeleteEventBusRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_partner_event_source method usage example with argument unpacking

kwargs: DeletePartnerEventSourceRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Account": ...,
}

parent.delete_partner_event_source(**kwargs)

1. See DeletePartnerEventSourceRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_rule method usage example with argument unpacking

kwargs: DeleteRuleRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_rule(**kwargs)

1. See DeleteRuleRequestRequestTypeDef

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)
    ...

1. See DescribeApiDestinationResponseTypeDef

# describe_api_destination method usage example with argument unpacking

kwargs: DescribeApiDestinationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_api_destination(**kwargs)

1. See DescribeApiDestinationRequestRequestTypeDef

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)
    ...

1. See DescribeArchiveResponseTypeDef

# describe_archive method usage example with argument unpacking

kwargs: DescribeArchiveRequestRequestTypeDef = {  # (1)
    "ArchiveName": ...,
}

parent.describe_archive(**kwargs)

1. See DescribeArchiveRequestRequestTypeDef

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)
    ...

1. See DescribeConnectionResponseTypeDef

# describe_connection method usage example with argument unpacking

kwargs: DescribeConnectionRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_connection(**kwargs)

1. See DescribeConnectionRequestRequestTypeDef

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)
    ...

1. See DescribeEndpointResponseTypeDef

# describe_endpoint method usage example with argument unpacking

kwargs: DescribeEndpointRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_endpoint(**kwargs)

1. See DescribeEndpointRequestRequestTypeDef

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)
    ...

1. See DescribeEventBusResponseTypeDef

# describe_event_bus method usage example with argument unpacking

kwargs: DescribeEventBusRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_event_bus(**kwargs)

1. See DescribeEventBusRequestRequestTypeDef

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)
    ...

1. See DescribeEventSourceResponseTypeDef

# describe_event_source method usage example with argument unpacking

kwargs: DescribeEventSourceRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_event_source(**kwargs)

1. See DescribeEventSourceRequestRequestTypeDef

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)
    ...

1. See DescribePartnerEventSourceResponseTypeDef

# describe_partner_event_source method usage example with argument unpacking

kwargs: DescribePartnerEventSourceRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_partner_event_source(**kwargs)

1. See DescribePartnerEventSourceRequestRequestTypeDef

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)
    ...

1. See DescribeReplayResponseTypeDef

# describe_replay method usage example with argument unpacking

kwargs: DescribeReplayRequestRequestTypeDef = {  # (1)
    "ReplayName": ...,
}

parent.describe_replay(**kwargs)

1. See DescribeReplayRequestRequestTypeDef

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)
    ...

1. See DescribeRuleResponseTypeDef

# describe_rule method usage example with argument unpacking

kwargs: DescribeRuleRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_rule(**kwargs)

1. See DescribeRuleRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# disable_rule method usage example with argument unpacking

kwargs: DisableRuleRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.disable_rule(**kwargs)

1. See DisableRuleRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# enable_rule method usage example with argument unpacking

kwargs: EnableRuleRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.enable_rule(**kwargs)

1. See EnableRuleRequestRequestTypeDef

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)
    ...

1. See ListApiDestinationsResponseTypeDef

# list_api_destinations method usage example with argument unpacking

kwargs: ListApiDestinationsRequestRequestTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.list_api_destinations(**kwargs)

1. See ListApiDestinationsRequestRequestTypeDef

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)
    ...

1. See ArchiveStateType
2. See ListArchivesResponseTypeDef

# list_archives method usage example with argument unpacking

kwargs: ListArchivesRequestRequestTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.list_archives(**kwargs)

1. See ListArchivesRequestRequestTypeDef

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)
    ...

1. See ConnectionStateType
2. See ListConnectionsResponseTypeDef

# list_connections method usage example with argument unpacking

kwargs: ListConnectionsRequestRequestTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.list_connections(**kwargs)

1. See ListConnectionsRequestRequestTypeDef

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)
    ...

1. See ListEndpointsResponseTypeDef

# list_endpoints method usage example with argument unpacking

kwargs: ListEndpointsRequestRequestTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.list_endpoints(**kwargs)

1. See ListEndpointsRequestRequestTypeDef

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)
    ...

1. See ListEventBusesResponseTypeDef

# list_event_buses method usage example with argument unpacking

kwargs: ListEventBusesRequestRequestTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.list_event_buses(**kwargs)

1. See ListEventBusesRequestRequestTypeDef

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)
    ...

1. See ListEventSourcesResponseTypeDef

# list_event_sources method usage example with argument unpacking

kwargs: ListEventSourcesRequestRequestTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.list_event_sources(**kwargs)

1. See ListEventSourcesRequestRequestTypeDef

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)
    ...

1. See ListPartnerEventSourceAccountsResponseTypeDef

# list_partner_event_source_accounts method usage example with argument unpacking

kwargs: ListPartnerEventSourceAccountsRequestRequestTypeDef = {  # (1)
    "EventSourceName": ...,
}

parent.list_partner_event_source_accounts(**kwargs)

1. See ListPartnerEventSourceAccountsRequestRequestTypeDef

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)
    ...

1. See ListPartnerEventSourcesResponseTypeDef

# list_partner_event_sources method usage example with argument unpacking

kwargs: ListPartnerEventSourcesRequestRequestTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.list_partner_event_sources(**kwargs)

1. See ListPartnerEventSourcesRequestRequestTypeDef

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)
    ...

1. See ReplayStateType
2. See ListReplaysResponseTypeDef

# list_replays method usage example with argument unpacking

kwargs: ListReplaysRequestRequestTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.list_replays(**kwargs)

1. See ListReplaysRequestRequestTypeDef

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)
    ...

1. See ListRuleNamesByTargetResponseTypeDef

# list_rule_names_by_target method usage example with argument unpacking

kwargs: ListRuleNamesByTargetRequestRequestTypeDef = {  # (1)
    "TargetArn": ...,
}

parent.list_rule_names_by_target(**kwargs)

1. See ListRuleNamesByTargetRequestRequestTypeDef

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)
    ...

1. See ListRulesResponseTypeDef

# list_rules method usage example with argument unpacking

kwargs: ListRulesRequestRequestTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.list_rules(**kwargs)

1. See ListRulesRequestRequestTypeDef

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)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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)
    ...

1. See ListTargetsByRuleResponseTypeDef

# list_targets_by_rule method usage example with argument unpacking

kwargs: ListTargetsByRuleRequestRequestTypeDef = {  # (1)
    "Rule": ...,
}

parent.list_targets_by_rule(**kwargs)

1. See ListTargetsByRuleRequestRequestTypeDef

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)
    ...

1. See PutEventsRequestEntryTypeDef
2. See PutEventsResponseTypeDef

# put_events method usage example with argument unpacking

kwargs: PutEventsRequestRequestTypeDef = {  # (1)
    "Entries": ...,
}

parent.put_events(**kwargs)

1. See PutEventsRequestRequestTypeDef

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)
    ...

1. See PutPartnerEventsRequestEntryTypeDef
2. See PutPartnerEventsResponseTypeDef

# put_partner_events method usage example with argument unpacking

kwargs: PutPartnerEventsRequestRequestTypeDef = {  # (1)
    "Entries": ...,
}

parent.put_partner_events(**kwargs)

1. See PutPartnerEventsRequestRequestTypeDef

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)
    ...

1. See ConditionTypeDef
2. See EmptyResponseMetadataTypeDef

# put_permission method usage example with argument unpacking

kwargs: PutPermissionRequestRequestTypeDef = {  # (1)
    "EventBusName": ...,
}

parent.put_permission(**kwargs)

1. See PutPermissionRequestRequestTypeDef

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)
    ...

1. See RuleStateType
2. See TagTypeDef
3. See PutRuleResponseTypeDef

# put_rule method usage example with argument unpacking

kwargs: PutRuleRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.put_rule(**kwargs)

1. See PutRuleRequestRequestTypeDef

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[TargetUnionTypeDef],  # (1)
    EventBusName: str = ...,
) -> PutTargetsResponseTypeDef:  # (2)
    ...

1. See TargetTypeDef TargetOutputTypeDef
2. See PutTargetsResponseTypeDef

# put_targets method usage example with argument unpacking

kwargs: PutTargetsRequestRequestTypeDef = {  # (1)
    "Rule": ...,
    "Targets": ...,
}

parent.put_targets(**kwargs)

1. See PutTargetsRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# remove_permission method usage example with argument unpacking

kwargs: RemovePermissionRequestRequestTypeDef = {  # (1)
    "StatementId": ...,
}

parent.remove_permission(**kwargs)

1. See RemovePermissionRequestRequestTypeDef

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)
    ...

1. See RemoveTargetsResponseTypeDef

# remove_targets method usage example with argument unpacking

kwargs: RemoveTargetsRequestRequestTypeDef = {  # (1)
    "Rule": ...,
    "Ids": ...,
}

parent.remove_targets(**kwargs)

1. See RemoveTargetsRequestRequestTypeDef

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: TimestampTypeDef,
    EventEndTime: TimestampTypeDef,
    Destination: ReplayDestinationTypeDef,  # (1)
    Description: str = ...,
) -> StartReplayResponseTypeDef:  # (2)
    ...

1. See ReplayDestinationTypeDef
2. See StartReplayResponseTypeDef

# start_replay method usage example with argument unpacking

kwargs: StartReplayRequestRequestTypeDef = {  # (1)
    "ReplayName": ...,
    "EventSourceArn": ...,
    "EventStartTime": ...,
    "EventEndTime": ...,
    "Destination": ...,
}

parent.start_replay(**kwargs)

1. See StartReplayRequestRequestTypeDef

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]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

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)
    ...

1. See TestEventPatternResponseTypeDef

# test_event_pattern method usage example with argument unpacking

kwargs: TestEventPatternRequestRequestTypeDef = {  # (1)
    "EventPattern": ...,
    "Event": ...,
}

parent.test_event_pattern(**kwargs)

1. See TestEventPatternRequestRequestTypeDef

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)

1. See UntagResourceRequestRequestTypeDef

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)
    ...

1. See ApiDestinationHttpMethodType
2. See UpdateApiDestinationResponseTypeDef

# update_api_destination method usage example with argument unpacking

kwargs: UpdateApiDestinationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_api_destination(**kwargs)

1. See UpdateApiDestinationRequestRequestTypeDef

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)
    ...

1. See UpdateArchiveResponseTypeDef

# update_archive method usage example with argument unpacking

kwargs: UpdateArchiveRequestRequestTypeDef = {  # (1)
    "ArchiveName": ...,
}

parent.update_archive(**kwargs)

1. See UpdateArchiveRequestRequestTypeDef

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)
    InvocationConnectivityParameters: ConnectivityResourceParametersTypeDef = ...,  # (3)
) -> UpdateConnectionResponseTypeDef:  # (4)
    ...

1. See ConnectionAuthorizationTypeType
2. See UpdateConnectionAuthRequestParametersTypeDef
3. See ConnectivityResourceParametersTypeDef
4. See UpdateConnectionResponseTypeDef

# update_connection method usage example with argument unpacking

kwargs: UpdateConnectionRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_connection(**kwargs)

1. See UpdateConnectionRequestRequestTypeDef

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)
    ...

1. See RoutingConfigTypeDef
2. See ReplicationConfigTypeDef
3. See EndpointEventBusTypeDef
4. See UpdateEndpointResponseTypeDef

# update_endpoint method usage example with argument unpacking

kwargs: UpdateEndpointRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_endpoint(**kwargs)

1. See UpdateEndpointRequestRequestTypeDef

update_event_bus

Updates the specified event bus.

Type annotations and code completion for boto3.client("events").update_event_bus method. boto3 documentation

# update_event_bus method definition

def update_event_bus(
    self,
    *,
    Name: str = ...,
    KmsKeyIdentifier: str = ...,
    Description: str = ...,
    DeadLetterConfig: DeadLetterConfigTypeDef = ...,  # (1)
) -> UpdateEventBusResponseTypeDef:  # (2)
    ...

1. See DeadLetterConfigTypeDef
2. See UpdateEventBusResponseTypeDef

# update_event_bus method usage example with argument unpacking

kwargs: UpdateEventBusRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_event_bus(**kwargs)

1. See UpdateEventBusRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("events").get_paginator method with overloads.

• client.get_paginator("list_rule_names_by_target") -> ListRuleNamesByTargetPaginator
• client.get_paginator("list_rules") -> ListRulesPaginator
• client.get_paginator("list_targets_by_rule") -> ListTargetsByRulePaginator