# This file is automatically generated by botocraft. Do not edit directly.
# mypy: disable-error-code="index, override, assignment, union-attr, misc"
from functools import cached_property
from pydantic import Field
from botocraft.mixins.events import EventRule_purge_CreatedBy_attribute
from .abstract import (
Boto3Model,
ReadonlyBoto3Model,
PrimaryBoto3Model,
ReadonlyPrimaryBoto3Model,
Boto3ModelManager,
ReadonlyBoto3ModelManager,
)
from collections import OrderedDict
from typing import ClassVar, Literal, Any, cast
from botocraft.mixins.events import DescribeRuleResponse_to_EventRule
from .abstract import PrimaryBoto3ModelQuerySet
from botocraft.mixins.events import DescribeEventBusResponse_to_EventBus
from botocraft.mixins.tags import TagsDictMixin
from datetime import datetime
from botocraft.mixins.events import event_rules_only
import builtins
from botocraft.services.common import Tag
# ===============
# Managers
# ===============
[docs]class EventRuleManager(Boto3ModelManager):
service_name: str = "events"
[docs] @EventRule_purge_CreatedBy_attribute
def create(
self, model: "EventRule", Tags: "builtins.list[Tag] | None" = None
) -> str:
"""
Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a
rule using `DisableRule <https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html>`_.
Args:
model: The :py:class:`Rule` to create.
Keyword Args:
Tags: The list of key-value pairs to associate with the rule.
"""
data = model.model_dump(exclude_none=True, by_alias=True)
args = dict(
Name=data.get("Name"),
ScheduleExpression=data.get("ScheduleExpression"),
EventPattern=data.get("EventPattern"),
State=data.get("State"),
Description=data.get("Description"),
RoleArn=data.get("RoleArn"),
Tags=self.serialize(Tags),
EventBusName=data.get("EventBusName"),
)
_response = self.client.put_rule(
**{k: v for k, v in args.items() if v is not None}
)
response = PutRuleResponse(**_response)
self.sessionize(response.RuleArn)
return cast("str", response.RuleArn)
[docs] @EventRule_purge_CreatedBy_attribute
def update(
self, model: "EventRule", Tags: "builtins.list[Tag] | None" = None
) -> str:
"""
Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a
rule using `DisableRule <https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html>`_.
Args:
model: The :py:class:`Rule` to update.
Keyword Args:
Tags: The list of key-value pairs to associate with the rule.
"""
data = model.model_dump(exclude_none=True, by_alias=True)
args = dict(
Name=data.get("Name"),
ScheduleExpression=data.get("ScheduleExpression"),
EventPattern=data.get("EventPattern"),
State=data.get("State"),
Description=data.get("Description"),
RoleArn=data.get("RoleArn"),
Tags=self.serialize(Tags),
EventBusName=data.get("EventBusName"),
)
_response = self.client.put_rule(
**{k: v for k, v in args.items() if v is not None}
)
response = PutRuleResponse(**_response)
self.sessionize(response.RuleArn)
return cast("str", response.RuleArn)
[docs] def delete(
self, Name: str, *, EventBusName: "str | None" = None, Force: bool = True
) -> None:
"""
Deletes the specified rule.
Args:
Name: The name of the rule.
Keyword Args:
EventBusName: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
used.
Force: If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
``Force`` as ``True`` to delete the rule. This parameter is ignored for rules that are not managed rules. You can
check whether a rule is a managed rule by using ``DescribeRule`` or ``ListRules`` and checking the ``ManagedBy``
field of the response.
"""
args: dict[str, Any] = dict(
Name=self.serialize(Name),
EventBusName=self.serialize(EventBusName),
Force=self.serialize(Force),
)
self.client.delete_rule(**{k: v for k, v in args.items() if v is not None})
[docs] @DescribeRuleResponse_to_EventRule
def get(
self, Name: str, *, EventBusName: "str | None" = None
) -> "DescribeRuleResponse | None":
"""
Describes the specified rule.
Args:
Name: The name of the rule.
Keyword Args:
EventBusName: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
used.
"""
args: dict[str, Any] = dict(
Name=self.serialize(Name), EventBusName=self.serialize(EventBusName)
)
_response = self.client.describe_rule(
**{k: v for k, v in args.items() if v is not None}
)
response = DescribeRuleResponse(**_response)
if response:
self.sessionize(response)
return response
return None
[docs] def list(
self,
*,
NamePrefix: "str | None" = None,
EventBusName: "str | None" = None,
Limit: "int | None" = None,
) -> PrimaryBoto3ModelQuerySet:
"""
Lists your Amazon EventBridge rules. You can either list all the rules or you
can provide a prefix to match to the rule names.
Keyword Args:
NamePrefix: The prefix matching the rule name.
EventBusName: The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is
used.
Limit: The maximum number of results to return.
"""
paginator = self.client.get_paginator("list_rules")
args: dict[str, Any] = dict(
NamePrefix=self.serialize(NamePrefix),
EventBusName=self.serialize(EventBusName),
Limit=self.serialize(Limit),
)
response_iterator = paginator.paginate(
**{k: v for k, v in args.items() if v is not None}
)
results = []
for _response in response_iterator:
if list(_response.keys()) == ["ResponseMetadata"]:
break
if "ResponseMetadata" in _response:
del _response["ResponseMetadata"]
response = ListRulesResponse(**_response)
if response.Rules:
results.extend(response.Rules)
else:
if getattr(response, "NextToken", None):
continue
break
self.sessionize(results)
if results and isinstance(results[0], Boto3Model):
return PrimaryBoto3ModelQuerySet(results)
return results
[docs] @event_rules_only
def list_by_target(
self,
TargetArn: str,
*,
EventBusName: "str | None" = None,
Limit: "int | None" = None,
) -> "builtins.list[str]":
"""
Lists the rules for the specified target. You can see which of the rules in
Amazon EventBridge can invoke a specific target in your account.
Args:
TargetArn: The Amazon Resource Name (ARN) of the target resource.
Keyword Args:
EventBusName: The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.
Limit: The maximum number of results to return.
"""
paginator = self.client.get_paginator("list_rule_names_by_target")
args: dict[str, Any] = dict(
TargetArn=self.serialize(TargetArn),
EventBusName=self.serialize(EventBusName),
Limit=self.serialize(Limit),
)
response_iterator = paginator.paginate(
**{k: v for k, v in args.items() if v is not None}
)
results: "builtins.list[str]" = []
for _response in response_iterator:
response = ListRuleNamesByTargetResponse(**_response)
if response.RuleNames is not None:
results.extend(response.RuleNames)
else:
break
self.sessionize(results)
return cast("builtins.list[str]", results)
[docs] def list_targets(
self,
Rule: str,
*,
EventBusName: "str | None" = None,
Limit: "int | None" = None,
) -> "builtins.list[EventTarget]":
"""
Lists the targets assigned to the specified rule.
Args:
Rule: The name of the rule.
Keyword Args:
EventBusName: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
used.
Limit: The maximum number of results to return.
"""
paginator = self.client.get_paginator("list_targets_by_rule")
args: dict[str, Any] = dict(
Rule=self.serialize(Rule),
EventBusName=self.serialize(EventBusName),
Limit=self.serialize(Limit),
)
response_iterator = paginator.paginate(
**{k: v for k, v in args.items() if v is not None}
)
results: "builtins.list[EventTarget]" = []
for _response in response_iterator:
response = ListTargetsByRuleResponse(**_response)
if response.Targets is not None:
results.extend(response.Targets)
else:
break
self.sessionize(results)
return cast("builtins.list[EventTarget]", results)
[docs] def enable(self, Name: str, *, EventBusName: "str | None" = None) -> None:
"""
Enables the specified rule. If the rule does not exist, the operation fails.
Args:
Name: The name of the rule.
Keyword Args:
EventBusName: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
used.
"""
args: dict[str, Any] = dict(
Name=self.serialize(Name), EventBusName=self.serialize(EventBusName)
)
self.client.enable_rule(**{k: v for k, v in args.items() if v is not None})
[docs] def disable(self, Name: str, *, EventBusName: "str | None" = None) -> None:
"""
Disables the specified rule. A disabled rule won't match any events, and won't
self-trigger if it has a schedule expression.
Args:
Name: The name of the rule.
Keyword Args:
EventBusName: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
used.
"""
args: dict[str, Any] = dict(
Name=self.serialize(Name), EventBusName=self.serialize(EventBusName)
)
self.client.disable_rule(**{k: v for k, v in args.items() if v is not None})
[docs]class EventTargetManager(Boto3ModelManager):
service_name: str = "events"
[docs] def create(
self, model: "EventTarget", EventBusName: "str | None" = None
) -> "PutTargetsResponse":
"""
Adds the specified targets to the specified rule, or updates the targets if they
are already associated with the rule.
Args:
model: The :py:class:`Target` to create.
Keyword Args:
EventBusName: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
used.
"""
data = model.model_dump(exclude_none=True, by_alias=True)
args = dict(
Rule=data.get("Rule"),
Targets=data.get("Targets"),
EventBusName=self.serialize(EventBusName),
)
_response = self.client.put_targets(
**{k: v for k, v in args.items() if v is not None}
)
response = PutTargetsResponse(**_response)
self.sessionize(response)
return cast("PutTargetsResponse", response)
[docs] def update(
self, model: "EventTarget", EventBusName: "str | None" = None
) -> "PutTargetsResponse":
"""
Adds the specified targets to the specified rule, or updates the targets if they
are already associated with the rule.
Args:
model: The :py:class:`Target` to update.
Keyword Args:
EventBusName: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
used.
"""
data = model.model_dump(exclude_none=True, by_alias=True)
args = dict(
Rule=data.get("Rule"),
Targets=data.get("Targets"),
EventBusName=self.serialize(EventBusName),
)
_response = self.client.put_targets(
**{k: v for k, v in args.items() if v is not None}
)
response = PutTargetsResponse(**_response)
self.sessionize(response)
return cast("PutTargetsResponse", response)
[docs] def delete(
self,
Rule: str,
Ids: "builtins.list[str]",
*,
EventBusName: "str | None" = None,
Force: "bool | None" = None,
) -> "EventTarget":
"""
Removes the specified targets from the specified rule. When the rule is
triggered, those targets are no longer be invoked.
Args:
Rule: The name of the rule.
Ids: The IDs of the targets to remove from the rule.
Keyword Args:
EventBusName: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
used.
Force: If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
``Force`` as ``True`` to remove targets. This parameter is ignored for rules that are not managed rules. You can
check whether a rule is a managed rule by using ``DescribeRule`` or ``ListRules`` and checking the ``ManagedBy``
field of the response.
"""
args: dict[str, Any] = dict(
Rule=self.serialize(Rule),
Ids=self.serialize(Ids),
EventBusName=self.serialize(EventBusName),
Force=self.serialize(Force),
)
_response = self.client.remove_targets(
**{k: v for k, v in args.items() if v is not None}
)
response = RemoveTargetsResponse(**_response)
return response
[docs] def list(
self,
Rule: str,
*,
EventBusName: "str | None" = None,
Limit: "int | None" = None,
) -> PrimaryBoto3ModelQuerySet:
"""
Lists the targets assigned to the specified rule.
Args:
Rule: The name of the rule.
Keyword Args:
EventBusName: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
used.
Limit: The maximum number of results to return.
"""
paginator = self.client.get_paginator("list_targets_by_rule")
args: dict[str, Any] = dict(
Rule=self.serialize(Rule),
EventBusName=self.serialize(EventBusName),
Limit=self.serialize(Limit),
)
response_iterator = paginator.paginate(
**{k: v for k, v in args.items() if v is not None}
)
results = []
for _response in response_iterator:
if list(_response.keys()) == ["ResponseMetadata"]:
break
if "ResponseMetadata" in _response:
del _response["ResponseMetadata"]
response = ListTargetsByRuleResponse(**_response)
if response.Targets:
results.extend(response.Targets)
else:
if getattr(response, "NextToken", None):
continue
break
self.sessionize(results)
if results and isinstance(results[0], Boto3Model):
return PrimaryBoto3ModelQuerySet(results)
return results
[docs] @event_rules_only
def list_rules(
self,
TargetArn: str,
*,
EventBusName: "str | None" = None,
Limit: "int | None" = None,
) -> "builtins.list[str]":
"""
Lists the rules for the specified target. You can see which of the rules in
Amazon EventBridge can invoke a specific target in your account.
Args:
TargetArn: The Amazon Resource Name (ARN) of the target resource.
Keyword Args:
EventBusName: The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.
Limit: The maximum number of results to return.
"""
paginator = self.client.get_paginator("list_rule_names_by_target")
args: dict[str, Any] = dict(
TargetArn=self.serialize(TargetArn),
EventBusName=self.serialize(EventBusName),
Limit=self.serialize(Limit),
)
response_iterator = paginator.paginate(
**{k: v for k, v in args.items() if v is not None}
)
results: "builtins.list[str]" = []
for _response in response_iterator:
response = ListRuleNamesByTargetResponse(**_response)
if response.RuleNames is not None:
results.extend(response.RuleNames)
else:
break
self.sessionize(results)
return cast("builtins.list[str]", results)
[docs]class EventBusManager(Boto3ModelManager):
service_name: str = "events"
[docs] def create(
self,
model: "EventBus",
EventSourceName: "str | None" = None,
KmsKeyIdentifier: "str | None" = None,
DeadLetterConfig: "EventsDeadLetterConfig | None" = None,
LogConfig: "EventsLogConfig | None" = None,
Tags: "builtins.list[Tag] | None" = None,
) -> "CreateEventBusResponse":
"""
Creates a new event bus within your account. This can be a custom event bus
which you can use to receive events from your custom applications and services,
or it can be a partner event bus which can be matched to a partner event source.
Args:
model: The :py:class:`EventBus` to create.
Keyword Args:
EventSourceName: If you are creating a partner event bus, this specifies the partner event source that the new event
bus will be matched with.
KmsKeyIdentifier: The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a
customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN),
KeyId, key alias, or key alias ARN.
DeadLetterConfig: Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).
LogConfig: The logging configuration settings for the event bus.
Tags: Tags to associate with the event bus.
"""
data = model.model_dump(exclude_none=True, by_alias=True)
args = dict(
Name=data.get("Name"),
EventSourceName=self.serialize(EventSourceName),
Description=data.get("Description"),
KmsKeyIdentifier=self.serialize(KmsKeyIdentifier),
DeadLetterConfig=self.serialize(DeadLetterConfig),
LogConfig=self.serialize(LogConfig),
Tags=self.serialize(Tags),
)
_response = self.client.create_event_bus(
**{k: v for k, v in args.items() if v is not None}
)
response = CreateEventBusResponse(**_response)
self.sessionize(response)
return cast("CreateEventBusResponse", response)
[docs] def update(
self,
model: "EventBus",
KmsKeyIdentifier: "str | None" = None,
DeadLetterConfig: "EventsDeadLetterConfig | None" = None,
LogConfig: "EventsLogConfig | None" = None,
) -> "UpdateEventBusResponse":
"""
Updates the specified event bus.
Args:
model: The :py:class:`EventBus` to update.
Keyword Args:
KmsKeyIdentifier: The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a
customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN),
KeyId, key alias, or key alias ARN.
DeadLetterConfig: Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).
LogConfig: The logging configuration settings for the event bus.
"""
data = model.model_dump(exclude_none=True, by_alias=True)
args = dict(
Name=data.get("Name"),
KmsKeyIdentifier=self.serialize(KmsKeyIdentifier),
Description=data.get("Description"),
DeadLetterConfig=self.serialize(DeadLetterConfig),
LogConfig=self.serialize(LogConfig),
)
_response = self.client.update_event_bus(
**{k: v for k, v in args.items() if v is not None}
)
response = UpdateEventBusResponse(**_response)
self.sessionize(response)
return cast("UpdateEventBusResponse", response)
[docs] def delete(self, Name: str) -> None:
"""
Deletes the specified custom event bus or partner event bus. All rules
associated with this event bus need to be deleted. You can't delete your
account's default event bus.
Args:
Name: The name of the event bus to delete.
"""
args: dict[str, Any] = dict(Name=self.serialize(Name))
self.client.delete_event_bus(**{k: v for k, v in args.items() if v is not None})
[docs] @DescribeEventBusResponse_to_EventBus
def get(self, *, Name: "str | None" = None) -> "EventBus | None":
"""
Displays details about an event bus in your account. This can include the
external Amazon Web Services accounts that are permitted to write events to your
default event bus, and the associated policy. For custom event buses and partner
event buses, it displays the name, ARN, policy, state, and creation time.
Keyword Args:
Name: The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.
"""
args: dict[str, Any] = dict(Name=self.serialize(Name))
_response = self.client.describe_event_bus(
**{k: v for k, v in args.items() if v is not None}
)
response = EventBus(**_response)
if response:
self.sessionize(response)
return response
return None
[docs] def list(
self,
*,
NamePrefix: "str | None" = None,
NextToken: "str | None" = None,
Limit: "int | None" = None,
) -> PrimaryBoto3ModelQuerySet:
"""
Lists all the event buses in your account, including the default event bus,
custom event buses, and partner event buses.
Keyword Args:
NamePrefix: Specifying this limits the results to only those event buses with names that start with the specified
prefix.
NextToken: The token returned by a previous call, which you can use to retrieve the next set of results.
Limit: Specifying this limits the number of results returned by this operation. The operation also returns a
NextToken which you can use in a subsequent operation to retrieve the next set of results.
"""
args: dict[str, Any] = dict(
NamePrefix=self.serialize(NamePrefix),
NextToken=self.serialize(NextToken),
Limit=self.serialize(Limit),
)
_response = self.client.list_event_buses(
**{k: v for k, v in args.items() if v is not None}
)
response = ListEventBusesResponse(**_response)
if response and response.EventBuses:
self.sessionize(response.EventBuses)
return PrimaryBoto3ModelQuerySet(response.EventBuses)
return PrimaryBoto3ModelQuerySet([])
[docs] def put_events(
self,
Entries: "builtins.list[PutEventsRequestEntry]",
*,
EndpointId: "str | None" = None,
) -> "PutEventsResponse":
"""
Sends custom events to Amazon EventBridge so that they can be matched to rules.
Args:
Entries: The entry that defines an event in your system. You can specify several parameters for the entry such as
the source and type of the event, resources associated with the event, and so on.
Keyword Args:
EndpointId: The URL subdomain of the endpoint. For example, if the URL for Endpoint is
https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is ``abcde.veo``.
"""
args: dict[str, Any] = dict(
Entries=self.serialize(Entries), EndpointId=self.serialize(EndpointId)
)
_response = self.client.put_events(
**{k: v for k, v in args.items() if v is not None}
)
response = PutEventsResponse(**_response)
results: "PutEventsResponse" = None
if response is not None:
results = response
self.sessionize(results)
return cast("PutEventsResponse", results)
[docs] def list_rules(
self,
*,
NamePrefix: "str | None" = None,
EventBusName: "str | None" = None,
Limit: "int | None" = None,
) -> builtins.list["EventRule"]:
"""
Lists your Amazon EventBridge rules. You can either list all the rules or you
can provide a prefix to match to the rule names.
Keyword Args:
NamePrefix: The prefix matching the rule name.
EventBusName: The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is
used.
Limit: The maximum number of results to return.
"""
paginator = self.client.get_paginator("list_rules")
args: dict[str, Any] = dict(
NamePrefix=self.serialize(NamePrefix),
EventBusName=self.serialize(EventBusName),
Limit=self.serialize(Limit),
)
response_iterator = paginator.paginate(
**{k: v for k, v in args.items() if v is not None}
)
results: builtins.list["EventRule"] = []
for _response in response_iterator:
response = ListRulesResponse(**_response)
if response.Rules is not None:
results.extend(response.Rules)
else:
break
self.sessionize(results)
return cast("builtins.list[EventRule]", results)
# ==============
# Service Models
# ==============
[docs]class EventRule(PrimaryBoto3Model):
"""
Contains information about a rule in Amazon EventBridge.
"""
manager_class: ClassVar[type[Boto3ModelManager]] = EventRuleManager
Name: "str | None" = None
"""
The name of the rule.
"""
Arn: str = Field(default=None, frozen=True)
"""
The Amazon Resource Name (ARN) of the rule.
"""
EventPattern: "str | None" = None
"""
The event pattern of the rule.
For more information, see
`Events and Event Patterns <https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html>`_
in the **Amazon
EventBridge User Guide** .
"""
State: "Literal['ENABLED', 'DISABLED', 'ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS'] | None" = None
"""
The state of the rule.
"""
Description: "str | None" = None
"""
The description of the rule.
"""
ScheduleExpression: "str | None" = None
"""
The scheduling expression.
For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see
`Creating an Amazon EventBridge rule that runs on a schedule <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-
rule-schedule.html>`_.
"""
RoleArn: "str | None" = None
"""
The Amazon Resource Name (ARN) of the role that is used for target invocation.
"""
ManagedBy: str = Field(default=None, frozen=True)
"""
If the rule was created on behalf of your account by an Amazon Web Services service,
this field displays the principal name of the service that created the rule.
"""
EventBusName: "str | None" = None
"""
The name or ARN of the event bus associated with the rule.
If you omit this, the default event bus is used.
"""
CreatedBy: str | None = None
@property
def pk(self) -> str | None:
"""
Return the primary key of the model. This is the value of the :py:attr:`Name`
attribute.
Returns:
The primary key of the model instance.
"""
return self.Name
@property
def arn(self) -> str | None:
"""
Return the ARN of the model. This is the value of the :py:attr:`Arn`
attribute.
Returns:
The ARN of the model instance.
"""
return self.Arn
@property
def name(self) -> str | None:
"""
Return the name of the model. This is the value of the :py:attr:`Name`
attribute.
Returns:
The name of the model instance.
"""
return self.Name
def __hash__(self) -> int:
"""
Return the hash of the model.
This is the value of the
:py:attr:`Name` attribute.
"""
return hash(self.Name)
@cached_property
def targets(self) -> "list[EventTarget] | None":
"""
Return the targets that are associated with this rule, if any.
.. note::
The output of this property is cached on the model instance, so
calling this multiple times will not result in multiple calls to the
AWS API. If you need a fresh copy of the data, you can re-get the
model instance from the manager.
"""
try:
pk = OrderedDict(
{
"Rule": self.Name,
}
)
except AttributeError:
return []
return EventTarget.objects.using(self.session).list(**pk) # type: ignore[arg-type]
[docs] def enable(self) -> "None":
"""
Enable the rule.
"""
return (
cast("EventRuleManager", self.objects) # type: ignore[attr-defined]
.using(self.session)
.enable(
cast("str", self.Name),
)
)
[docs] def disable(self) -> "None":
"""
Disable the rule.
"""
return (
cast("EventRuleManager", self.objects) # type: ignore[attr-defined]
.using(self.session)
.disable(
cast("str", self.Name),
)
)
[docs]class EventsKinesisParameters(Boto3Model):
"""
This object enables you to specify a JSON path to extract from the event and use as
the partition key for the Amazon Kinesis data stream, so that you can control the
shard to which the event goes.
If you do not include this parameter,
the default is to use the ``eventId`` as the partition key.
"""
PartitionKeyPath: str
"""
The JSON path to be extracted from the event and used as the partition key.
For more information, see
`Amazon Kinesis Streams Key Concepts <https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key>`_
in the *Amazon
Kinesis Streams Developer Guide*.
"""
[docs]class RunCommandTarget(Boto3Model):
"""
Information about the EC2 instances that are to be sent the command, specified as
key-value pairs.
Each
``RunCommandTarget`` block can include only one key, but this key may specify multiple values.
"""
Key: str
"""
Can be either ``tag:`` *tag-key* or ``InstanceIds``.
"""
Values: "builtins.list[str]"
"""
If ``Key`` is ``tag:`` *tag-key*, ``Values`` is a list of tag values.
If ``Key`` is ``InstanceIds``, ``Values`` is a
list of Amazon EC2 instance IDs.
"""
[docs]class EventsRunCommandParameters(Boto3Model):
"""
This parameter contains the criteria (either InstanceIds or a tag) used to specify
which EC2 instances are to be sent the command.
"""
RunCommandTargets: "builtins.list[RunCommandTarget]"
"""
Currently, we support including only one RunCommandTarget block, which specifies
either an array of InstanceIds or a tag.
"""
[docs]class EventsAwsVpcConfiguration(Boto3Model):
"""
This structure specifies the VPC subnets and security groups for the task, and
whether a public IP address is to be used.
This structure is relevant only for ECS tasks that use the ``awsvpc`` network mode.
"""
Subnets: "builtins.list[str]"
"""
Specifies the subnets associated with the task.
These subnets must all be in the same VPC. You can specify as many as 16 subnets.
"""
SecurityGroups: "builtins.list[str] | None" = Field(default_factory=list)
"""
Specifies the security groups associated with the task.
These security groups must all be in the same VPC. You can specify as many as five
security groups. If you do not specify a security group, the default security group
for the VPC is used.
"""
AssignPublicIp: "Literal['ENABLED', 'DISABLED'] | None" = None
"""
Specifies whether the task's elastic network interface receives a public IP address.
You can specify ``ENABLED`` only
when ``LaunchType`` in ``EcsParameters`` is set to ``FARGATE``.
"""
[docs]class EventsNetworkConfiguration(Boto3Model):
"""
This structure specifies the network configuration for an ECS task.
"""
awsvpcConfiguration: "EventsAwsVpcConfiguration | None" = None
"""
Use this structure to specify the VPC subnets and security groups for the task, and
whether a public IP address is to be used.
This structure is relevant only for ECS tasks that use the ``awsvpc`` network mode.
"""
[docs]class EventsCapacityProviderStrategyItem(Boto3Model):
"""
The details of a capacity provider strategy.
To learn more, see `CapacityProviderStrategyItem <https://docs.aws.amazon.c
om/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html>`_ in the Amazon ECS API Reference.
"""
capacityProvider: str
"""
The short name of the capacity provider.
"""
weight: "int | None" = None
"""
The weight value designates the relative percentage of the total number of tasks
launched that should use the specified capacity provider.
The weight value is taken into consideration after the base value, if defined, is
satisfied.
"""
base: "int | None" = None
"""
The base value designates how many tasks, at a minimum, to run on the specified
capacity provider.
Only one capacity provider in a capacity provider strategy can have a base defined.
If no value is specified, the default value of 0 is used.
"""
[docs]class EventsPlacementConstraint(Boto3Model):
"""
An object representing a constraint on task placement.
To learn more, see
`Task Placement Constraints <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html>`_
in the Amazon
Elastic Container Service Developer Guide.
"""
type: "Literal['distinctInstance', 'memberOf'] | None" = None
"""
The type of constraint.
Use distinctInstance to ensure that each task in a particular group is running on a
different container instance. Use memberOf to restrict the selection to a group of
valid candidates.
"""
expression: "str | None" = None
"""
A cluster query language expression to apply to the constraint.
You cannot specify an expression if the constraint type
is ``distinctInstance``. To learn more, see `Cluster Query
Language <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html>`_ in the Amazon Elastic
Container Service Developer Guide.
"""
[docs]class EventsPlacementStrategy(Boto3Model):
"""
The task placement strategy for a task or service.
To learn more, see
`Task Placement Strategies <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html>`_
in the Amazon
Elastic Container Service Service Developer Guide.
"""
type: "Literal['random', 'spread', 'binpack'] | None" = None
"""
The type of placement strategy.
The random placement strategy randomly places tasks on available candidates. The
spread placement strategy spreads placement across available candidates evenly based
on the field parameter. The binpack strategy places tasks on available candidates
that have the least available amount of the resource that is specified with the
field parameter. For example, if you binpack on memory, a task is placed on the
instance with the least amount of remaining memory (but still enough to run the
task).
"""
field: "str | None" = None
"""
The field to apply the placement strategy against.
For the spread placement strategy, valid values are instanceId (or host, which has
the same effect), or any platform or custom attribute that is applied to a container
instance, such as attribute:ecs.availability-zone. For the binpack placement
strategy, valid values are cpu and memory. For the random placement strategy, this
field is not used.
"""
[docs]class EventsEcsParameters(TagsDictMixin, Boto3Model):
"""
The custom parameters to be used when the target is an Amazon ECS task.
"""
tag_class: ClassVar[type[Boto3Model]] = Tag
TaskDefinitionArn: str
"""
The ARN of the task definition to use if the event target is an Amazon ECS task.
"""
TaskCount: "int | None" = None
"""
The number of tasks to create based on ``TaskDefinition``.
The default is 1.
"""
LaunchType: "Literal['EC2', 'FARGATE', 'EXTERNAL'] | None" = None
"""
Specifies the launch type on which your task is running.
The launch type that you specify here must match one of the
launch type (compatibilities) of the target task. The ``FARGATE`` value is supported only in the Regions where Fargate
with Amazon ECS is supported. For more information, see `Fargate on Amazon
ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html>`_ in the *Amazon Elastic Container
Service Developer Guide*.
"""
NetworkConfiguration: "EventsNetworkConfiguration | None" = None
"""
Use this structure if the Amazon ECS task uses the ``awsvpc`` network mode.
This structure specifies the VPC subnets and
security groups associated with the task, and whether a public IP address is to be used. This structure is required if
``LaunchType`` is ``FARGATE`` because the ``awsvpc`` mode is required for Fargate tasks.
"""
PlatformVersion: "str | None" = None
"""
Specifies the platform version for the task.
Specify only the numeric portion of the platform version, such as
``1.1.0``.
"""
Group: "str | None" = None
"""
Specifies an ECS task group for the task.
The maximum length is 255 characters.
"""
CapacityProviderStrategy: "builtins.list[EventsCapacityProviderStrategyItem] | None" = Field(
default_factory=list
)
"""
The capacity provider strategy to use for the task.
"""
EnableECSManagedTags: "bool | None" = None
"""
Specifies whether to enable Amazon ECS managed tags for the task.
For more information, see
`Tagging Your Amazon ECS Resources <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html>`_
in the Amazon Elastic
Container Service Developer Guide.
"""
EnableExecuteCommand: "bool | None" = None
"""
Whether or not to enable the execute command functionality for the containers in
this task.
If true, this enables execute command functionality on all containers in the task.
"""
PlacementConstraints: "builtins.list[EventsPlacementConstraint] | None" = Field(
default_factory=list
)
"""
An array of placement constraint objects to use for the task.
You can specify up to 10 constraints per task (including constraints in the task
definition and those specified at runtime).
"""
PlacementStrategy: "builtins.list[EventsPlacementStrategy] | None" = Field(
default_factory=list
)
"""
The placement strategy objects to use for the task.
You can specify a maximum of five strategy rules per task.
"""
PropagateTags: "Literal['TASK_DEFINITION'] | None" = None
"""
Specifies whether to propagate the tags from the task definition to the task.
If no value is specified, the tags are not propagated. Tags can only be propagated
to the task during task creation. To add tags to a task after task creation, use the
TagResource API action.
"""
ReferenceId: "str | None" = None
"""
The reference ID to use for the task.
"""
Tags: "builtins.list[Tag] | None" = Field(default_factory=list)
"""
The metadata that you apply to the task to help you categorize and organize them.
Each tag consists of a key and an optional value, both of which you define. To learn
more, see
`RunTask <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags>`_
in the
Amazon ECS API Reference.
"""
[docs]class BatchArrayProperties(Boto3Model):
"""
The array properties for the submitted job, such as the size of the array.
The array size can be between 2 and 10,000. If you specify array properties for a
job, it becomes an array job. This parameter is used only if the target is an Batch
job.
"""
Size: "int | None" = None
"""
The size of the array, if this is an array batch job.
Valid values are integers between 2 and 10,000.
"""
[docs]class BatchRetryStrategy(Boto3Model):
"""
The retry strategy to use for failed jobs, if the target is an Batch job.
If you specify a retry strategy here, it overrides the retry strategy defined in the
job definition.
"""
Attempts: "int | None" = None
"""
The number of times to attempt to retry, if the job fails.
Valid values are 1-10.
"""
[docs]class EventsBatchParameters(Boto3Model):
"""
The custom parameters to be used when the target is an Batch job.
"""
JobDefinition: str
"""
The ARN or name of the job definition to use if the event target is an Batch job.
This job definition must already exist.
"""
JobName: str
"""
The name to use for this execution of the job, if the target is an Batch job.
"""
ArrayProperties: "BatchArrayProperties | None" = None
"""
The array properties for the submitted job, such as the size of the array.
The array size can be between 2 and 10,000. If you specify array properties for a
job, it becomes an array job. This parameter is used only if the target is an Batch
job.
"""
RetryStrategy: "BatchRetryStrategy | None" = None
"""
The retry strategy to use for failed jobs, if the target is an Batch job.
The retry strategy is the number of times to retry the failed job execution. Valid
values are 1-10. When you specify a retry strategy here, it overrides the retry
strategy defined in the job definition.
"""
[docs]class EventsSqsParameters(Boto3Model):
"""
This structure includes the custom parameter to be used when the target is an SQS
FIFO queue.
"""
MessageGroupId: "str | None" = None
"""
The FIFO message group ID to use as the target.
"""
[docs]class EventsHttpParameters(Boto3Model):
"""
These are custom parameter to be used when the target is an API Gateway APIs or
EventBridge ApiDestinations.
In the latter case, these are merged with any InvocationParameters specified on the
Connection, with any values from the Connection taking precedence.
"""
PathParameterValues: "builtins.list[str] | None" = Field(default_factory=list)
"""
The path parameter values to be used to populate API Gateway API or EventBridge
ApiDestination path wildcards ("*").
"""
HeaderParameters: "dict[str, str] | None" = Field(default_factory=dict)
"""
The headers that need to be sent as part of request invoking the API Gateway API or
EventBridge ApiDestination.
"""
QueryStringParameters: "dict[str, str] | None" = Field(default_factory=dict)
"""
The query string keys/values that need to be sent as part of request invoking the
API Gateway API or EventBridge ApiDestination.
"""
[docs]class EventsRedshiftDataParameters(Boto3Model):
"""
These are custom parameters to be used when the target is a Amazon Redshift cluster
to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
"""
SecretManagerArn: "str | None" = None
"""
The name or ARN of the secret that enables access to the database.
Required when authenticating using Amazon Web Services Secrets Manager.
"""
Database: str
"""
The name of the database.
Required when authenticating using temporary credentials.
"""
DbUser: "str | None" = None
"""
The database user name.
Required when authenticating using temporary credentials.
"""
Sql: "str | None" = None
"""
The SQL statement text to run.
"""
StatementName: "str | None" = None
"""
The name of the SQL statement.
You can name the SQL statement when you create it to identify the query.
"""
WithEvent: "bool | None" = None
"""
Indicates whether to send an event back to EventBridge after the SQL statement runs.
"""
Sqls: "builtins.list[str] | None" = Field(default_factory=list)
"""
One or more SQL statements to run.
The SQL statements are run as a single transaction. They run serially in the order
of the array. Subsequent SQL statements don't start until the previous statement in
the array completes. If any SQL statement fails, then because they are run as one
transaction, all work is rolled back.
"""
[docs]class SageMakerPipelineParameter(Boto3Model):
"""
Name/Value pair of a parameter to start execution of a SageMaker AI Model Building
Pipeline.
"""
Name: str
"""
Name of parameter to start execution of a SageMaker AI Model Building Pipeline.
"""
Value: str
"""
Value of parameter to start execution of a SageMaker AI Model Building Pipeline.
"""
[docs]class EventsSageMakerPipelineParameters(Boto3Model):
"""
These are custom parameters to use when the target is a SageMaker AI Model Building
Pipeline that starts based on EventBridge events.
"""
PipelineParameterList: "builtins.list[SageMakerPipelineParameter] | None" = Field(
default_factory=list
)
"""
List of Parameter names and values for SageMaker AI Model Building Pipeline
execution.
"""
[docs]class EventsDeadLetterConfig(Boto3Model):
"""
Configuration details of the Amazon SQS queue for EventBridge to use as a dead-
letter queue (DLQ).
For more information, see `Using dead-letter queues to process undelivered
events <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq>`_ in the
*EventBridge User Guide*.
"""
Arn: "str | None" = None
"""
The ARN of the SQS queue specified as the target for the dead-letter queue.
"""
[docs]class EventsRetryPolicy(Boto3Model):
"""
A ``RetryPolicy`` object that includes information about the retry policy settings.
"""
MaximumRetryAttempts: "int | None" = None
"""
The maximum number of retry attempts to make before the request fails.
Retry attempts continue until either the maximum
number of attempts is made or until the duration of the ``MaximumEventAgeInSeconds`` is met.
"""
MaximumEventAgeInSeconds: "int | None" = None
"""
The maximum amount of time, in seconds, to continue to make retry attempts.
"""
[docs]class EventsAppSyncParameters(Boto3Model):
"""
Contains the GraphQL operation to be parsed and executed, if the event target is an
AppSync API.
"""
GraphQLOperation: "str | None" = None
"""
The GraphQL operation; that is, the query, mutation, or subscription to be parsed
and executed by the GraphQL service.
"""
[docs]class EventTarget(PrimaryBoto3Model):
"""Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can
be set as a target, see `PutTargets <https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html>`_.
If you are setting the event bus of another account as the target, and that account granted permission to your account
through an organization instead of directly by the account ID, then you must specify a ``RoleArn`` with proper
permissions in the ``Target`` structure. For more information, see `Sending and Receiving Events Between Amazon Web
Services Accounts <https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-
delivery.html>`_ in the *Amazon EventBridge User Guide*.
"""
manager_class: ClassVar[type[Boto3ModelManager]] = EventTargetManager
Id: str = Field(frozen=True)
"""
The ID of the target within the specified rule.
Use this ID to reference the target when updating the rule. We recommend using a
memorable and unique string.
"""
Arn: str = Field(frozen=True)
"""
The Amazon Resource Name (ARN) of the target.
"""
RoleArn: str = Field(default=None, frozen=True)
"""
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the
rule is triggered.
If one rule triggers multiple targets, you can use a different IAM role for each
target.
"""
Input: str = Field(default=None, frozen=True)
"""
Valid JSON text passed to the target.
In this case, nothing from the event itself is passed to the target. For more
information, see `The JavaScript Object Notation (JSON) Data Interchange Format <http://www.rfc-
editor.org/rfc/rfc7159.txt>`_.
"""
InputPath: str = Field(default=None, frozen=True)
"""
The value of the JSONPath that is used for extracting part of the matched event when
passing it to the target.
You may use JSON dot notation or bracket notation. For more information about JSON
paths, see
`JSONPath <http://goessner.net/articles/JsonPath/>`_.
"""
InputTransformer: EventsInputTransformer = Field(default=None, frozen=True)
"""
Settings to enable you to provide custom input to a target based on certain event
data.
You can extract one or more key- value pairs from the event and then use that data
to send customized input to the target.
"""
KinesisParameters: EventsKinesisParameters = Field(default=None, frozen=True)
"""
The custom parameter you can use to control the shard assignment, when the target is
a Kinesis data stream.
If you do
not include this parameter, the default is to use the ``eventId`` as the partition key.
"""
RunCommandParameters: EventsRunCommandParameters = Field(default=None, frozen=True)
"""
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
"""
EcsParameters: EventsEcsParameters = Field(default=None, frozen=True)
"""
Contains the Amazon ECS task definition and task count to be used, if the event
target is an Amazon ECS task.
For more information about Amazon ECS tasks, see
`Task Definitions <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html>`_
in the *Amazon EC2
Container Service Developer Guide*.
"""
BatchParameters: EventsBatchParameters = Field(default=None, frozen=True)
"""
If the event target is an Batch job, this contains the job definition, job name, and
other parameters.
For more information, see
`Jobs <https://docs.aws.amazon.com/batch/latest/userguide/jobs.html>`_
in the *Batch User Guide*.
"""
SqsParameters: EventsSqsParameters = Field(default=None, frozen=True)
"""
Contains the message group ID to use when the target is a FIFO queue.
"""
HttpParameters: EventsHttpParameters = Field(default=None, frozen=True)
"""
Contains the HTTP parameters to use when the target is a API Gateway endpoint or
EventBridge ApiDestination.
"""
RedshiftDataParameters: EventsRedshiftDataParameters = Field(
default=None, frozen=True
)
"""
Contains the Amazon Redshift Data API parameters to use when the target is a Amazon
Redshift cluster.
"""
SageMakerPipelineParameters: EventsSageMakerPipelineParameters = Field(
default=None, frozen=True
)
"""
Contains the SageMaker AI Model Building Pipeline parameters to start execution of a
SageMaker AI Model Building Pipeline.
"""
DeadLetterConfig: EventsDeadLetterConfig = Field(default=None, frozen=True)
"""
The ``DeadLetterConfig`` that defines the target queue to send dead-letter queue
events to.
"""
RetryPolicy: EventsRetryPolicy = Field(default=None, frozen=True)
"""
The retry policy configuration to use for the dead-letter queue.
"""
AppSyncParameters: EventsAppSyncParameters = Field(default=None, frozen=True)
"""
Contains the GraphQL operation to be parsed and executed, if the event target is an
AppSync API.
"""
@property
def pk(self) -> str | None:
"""
Return the primary key of the model. This is the value of the :py:attr:`Id`
attribute.
Returns:
The primary key of the model instance.
"""
return self.Id
@property
def arn(self) -> str | None:
"""
Return the ARN of the model. This is the value of the :py:attr:`Arn`
attribute.
Returns:
The ARN of the model instance.
"""
return self.Arn
@property
def name(self) -> str | None:
"""
Return the name of the model. This is the value of the :py:attr:`Id`
attribute.
Returns:
The name of the model instance.
"""
return self.Id
def __hash__(self) -> int:
"""
Return the hash of the model.
This is the value of the
:py:attr:`Id` attribute.
"""
return hash(self.Id)
@cached_property
def rules(self) -> "EventRule | None":
"""
Return the :py:class:`Rule` object that this target belongs to.
.. note::
The output of this property is cached on the model instance, so
calling this multiple times will not result in multiple calls to the
AWS API. If you need a fresh copy of the data, you can re-get the
model instance from the manager.
"""
try:
pk = OrderedDict(
{
"TargetArn": self.Arn,
}
)
except AttributeError:
return None
return EventRule.objects.using(self.session).list_by_target(**pk) # type: ignore[arg-type]
[docs]class PutEventsRequestEntry(Boto3Model):
"""
Represents an event to be submitted.
"""
Time: "datetime | None" = None
"""
The time stamp of the event, per `RFC3339 <https://www.rfc-editor.org/rfc/rfc3339.txt>`_. If no time stamp is provided,
the time stamp of the `PutEvents <https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html>`_ call
is used.
"""
Source: "str | None" = None
"""
The source of the event.
"""
Resources: "builtins.list[str] | None" = Field(default_factory=list)
"""
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the
event primarily concerns.
Any number, including zero, may be present.
"""
DetailType: "str | None" = None
"""
Free-form string, with a maximum of 128 characters, used to decide what fields to
expect in the event detail.
"""
Detail: "str | None" = None
"""
A valid JSON object.
There is no other schema imposed. The JSON object may contain fields and nested sub-
objects.
"""
EventBusName: "str | None" = None
"""
The name or ARN of the event bus to receive the event.
Only the rules that are associated with this event bus are used to match the event.
If you omit this, the default event bus is used.
"""
TraceHeader: "str | None" = None
"""
An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the
trace-id associated with the event.
"""
[docs]class EventBus(PrimaryBoto3Model):
"""
An event bus receives events from a source, uses rules to evaluate them, applies any
configured input transformation, and routes them to the appropriate target(s).
Your account's default event bus receives events from Amazon Web Services services.
A custom event bus can receive events from your custom applications and services. A
partner event bus receives events from an event source created by an SaaS partner.
These events come from the partners services or applications.
"""
manager_class: ClassVar[type[Boto3ModelManager]] = EventBusManager
Name: "str | None" = None
"""
The name of the event bus.
"""
Arn: str = Field(default=None, frozen=True)
"""
The ARN of the event bus.
"""
Description: "str | None" = None
"""
The event bus description.
"""
Policy: str = Field(default=None, frozen=True)
"""
The permissions policy of the event bus, describing which other Amazon Web Services
accounts can write events to this event bus.
"""
CreationTime: datetime = Field(default=None, frozen=True)
"""
The time the event bus was created.
"""
LastModifiedTime: datetime = Field(default=None, frozen=True)
"""
The time the event bus was last modified.
"""
@property
def pk(self) -> str | None:
"""
Return the primary key of the model. This is the value of the :py:attr:`Name`
attribute.
Returns:
The primary key of the model instance.
"""
return self.Name
@property
def arn(self) -> str | None:
"""
Return the ARN of the model. This is the value of the :py:attr:`Arn`
attribute.
Returns:
The ARN of the model instance.
"""
return self.Arn
@property
def name(self) -> str | None:
"""
Return the name of the model. This is the value of the :py:attr:`Name`
attribute.
Returns:
The name of the model instance.
"""
return self.Name
def __hash__(self) -> int:
"""
Return the hash of the model.
This is the value of the
:py:attr:`Name` attribute.
"""
return hash(self.Name)
[docs] def rules(self) -> builtins.list["EventRule"]:
"""
Return the rules that are associated with this event bus.
"""
return (
cast("EventBusManager", self.objects) # type: ignore[attr-defined]
.using(self.session)
.list_rules(
cast("str", self.Name),
)
)
[docs] def put_events(
self,
Entries: "builtins.list[PutEventsRequestEntry]",
EndpointId: "str | None" = None,
) -> "PutEventsResponse":
"""
Put events to this event bus.
Args:
Entries: The entry that defines an event in your system. You can specify several parameters for the entry such as
the source and type of the event, resources associated with the event, and so on.
Keyword Args:
EndpointId: The URL subdomain of the endpoint. For example, if the URL for Endpoint is
https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is ``abcde.veo``.
"""
return (
cast("EventBusManager", self.objects) # type: ignore[attr-defined]
.using(self.session)
.put_events(Entries, EndpointId=EndpointId)
)
# =======================
# Request/Response Models
# =======================
[docs]class PutRuleResponse(Boto3Model):
RuleArn: "str | None" = None
"""
The Amazon Resource Name (ARN) of the rule.
"""
[docs]class DescribeRuleResponse(Boto3Model):
Name: "str | None" = None
"""
The name of the rule.
"""
Arn: "str | None" = None
"""
The Amazon Resource Name (ARN) of the rule.
"""
EventPattern: "str | None" = None
"""
The event pattern.
For more information, see
`Events and Event Patterns <https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html>`_
in the **Amazon
EventBridge User Guide** .
"""
ScheduleExpression: "str | None" = None
"""
The scheduling expression.
For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
"""
State: "Literal['ENABLED', 'DISABLED', 'ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS'] | None" = None
"""
Specifies whether the rule is enabled or disabled.
"""
Description: "str | None" = None
"""
The description of the rule.
"""
RoleArn: "str | None" = None
"""
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
"""
ManagedBy: "str | None" = None
"""
If this is a managed rule, created by an Amazon Web Services service on your behalf,
this field displays the principal name of the Amazon Web Services service that
created the rule.
"""
EventBusName: "str | None" = None
"""
The name of the event bus associated with the rule.
"""
CreatedBy: "str | None" = None
"""
The account ID of the user that created the rule.
If you use ``PutRule`` to put a rule on an event bus in another
account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However,
the value for ``CreatedBy`` is the account ID as the account that created the rule in the other account.
"""
[docs]class ListRulesResponse(Boto3Model):
Rules: "builtins.list[EventRule] | None" = Field(default_factory=list)
"""
The rules that match the specified criteria.
"""
NextToken: "str | None" = None
"""
A token indicating there are more results available.
If there are no more results, no token is included in the response.
"""
[docs]class ListRuleNamesByTargetResponse(Boto3Model):
RuleNames: "builtins.list[str] | None" = Field(default_factory=list)
"""
The names of the rules that can invoke the given target.
"""
NextToken: "str | None" = None
"""
A token indicating there are more results available.
If there are no more results, no token is included in the response.
"""
[docs]class ListTargetsByRuleResponse(Boto3Model):
Targets: "builtins.list[EventTarget] | None" = Field(default_factory=list)
"""
The targets assigned to the rule.
"""
NextToken: "str | None" = None
"""
A token indicating there are more results available.
If there are no more results, no token is included in the response.
"""
[docs]class PutTargetsResultEntry(Boto3Model):
"""
Represents a target that failed to be added to a rule.
"""
TargetId: "str | None" = None
"""
The ID of the target.
"""
ErrorCode: "str | None" = None
"""
The error code that indicates why the target addition failed.
If the value is ``ConcurrentModificationException``, too
many requests were made at the same time.
"""
ErrorMessage: "str | None" = None
"""
The error message that explains why the target addition failed.
"""
[docs]class PutTargetsResponse(Boto3Model):
FailedEntryCount: "int | None" = None
"""
The number of failed entries.
"""
FailedEntries: "builtins.list[PutTargetsResultEntry] | None" = Field(
default_factory=list
)
"""
The failed target entries.
"""
[docs]class RemoveTargetsResultEntry(Boto3Model):
"""
Represents a target that failed to be removed from a rule.
"""
TargetId: "str | None" = None
"""
The ID of the target.
"""
ErrorCode: "str | None" = None
"""
The error code that indicates why the target removal failed.
If the value is ``ConcurrentModificationException``, too
many requests were made at the same time.
"""
ErrorMessage: "str | None" = None
"""
The error message that explains why the target removal failed.
"""
[docs]class RemoveTargetsResponse(Boto3Model):
FailedEntryCount: "int | None" = None
"""
The number of failed entries.
"""
FailedEntries: "builtins.list[RemoveTargetsResultEntry] | None" = Field(
default_factory=list
)
"""
The failed target entries.
"""
[docs]class EventsLogConfig(Boto3Model):
"""
The logging configuration settings for the event bus.
For more information, see
`Configuring logs for event buses <https://docs.aws.amazon.com/eb-event-bus-logs.html>`_
in the
*EventBridge User Guide*.
"""
IncludeDetail: "Literal['NONE', 'FULL'] | None" = None
"""
Whether EventBridge include detailed event information in the records it generates.
Detailed data can be useful for troubleshooting and debugging. This information
includes details of the event itself, as well as target details.
"""
Level: "Literal['OFF', 'ERROR', 'INFO', 'TRACE'] | None" = None
"""
The level of logging detail to include.
This applies to all log destinations for the event bus.
"""
[docs]class CreateEventBusResponse(Boto3Model):
EventBusArn: "str | None" = None
"""
The ARN of the new event bus.
"""
Description: "str | None" = None
"""
The event bus description.
"""
KmsKeyIdentifier: "str | None" = None
"""
The identifier of the KMS customer managed key for EventBridge to use to encrypt
events on this event bus, if one has been specified.
"""
DeadLetterConfig: "EventsDeadLetterConfig | None" = None
"""
Configuration details of the Amazon SQS queue for EventBridge to use as a dead-
letter queue (DLQ).
"""
LogConfig: "EventsLogConfig | None" = None
"""
The logging configuration settings for the event bus.
"""
[docs]class UpdateEventBusResponse(Boto3Model):
Arn: "str | None" = None
"""
The event bus Amazon Resource Name (ARN).
"""
Name: "str | None" = None
"""
The event bus name.
"""
KmsKeyIdentifier: "str | None" = None
"""
The identifier of the KMS customer managed key for EventBridge to use to encrypt
events on this event bus, if one has been specified.
"""
Description: "str | None" = None
"""
The event bus description.
"""
DeadLetterConfig: "EventsDeadLetterConfig | None" = None
"""
Configuration details of the Amazon SQS queue for EventBridge to use as a dead-
letter queue (DLQ).
"""
LogConfig: "EventsLogConfig | None" = None
"""
The logging configuration settings for the event bus.
"""
[docs]class ListEventBusesResponse(Boto3Model):
EventBuses: "builtins.list[EventBus] | None" = Field(default_factory=list)
"""
This list of event buses.
"""
NextToken: "str | None" = None
"""
A token indicating there are more results available.
If there are no more results, no token is included in the response.
"""
[docs]class PutEventsResultEntry(Boto3Model):
"""
Represents the results of an event submitted to an event bus.
If the submission was successful, the entry has the event ID in it. Otherwise, you
can use the error code and error message to identify the problem with the entry.
For information about the errors that are common to all actions, see
`Common Errors <https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html>`_.
"""
EventId: "str | None" = None
"""
The ID of the event.
"""
ErrorCode: "str | None" = None
"""
The error code that indicates why the event submission failed.
"""
ErrorMessage: "str | None" = None
"""
The error message that explains why the event submission failed.
"""
[docs]class PutEventsResponse(Boto3Model):
FailedEntryCount: "int | None" = None
"""
The number of failed entries.
"""
Entries: "builtins.list[PutEventsResultEntry] | None" = Field(default_factory=list)
"""
The successfully and unsuccessfully ingested events results.
If the ingestion was successful, the entry has the event ID in it. Otherwise, you
can use the error code and error message to identify the problem with the entry.
"""