PNG
IHDR ; IDATxܻn0K
)(pA7LeG{ §㻢|ذaÆ
6lذaÆ
6lذaÆ
6lom$^yذag5 bÆ
6lذaÆ
6lذa{
6lذaÆ
`}HFkm,mӪôô!x|'ܢ˟;E:9&ᶒ}{v]n&6
h_tڠ͵-ҫZ;Z$.Pkž)!o>}leQfJTu іچ\X=8Rن4`Vwl>nG^is"ms$ui?wbs[m6K4O.4%/bC%tMז -lG6mrz2s%9s@-k9=)kB5\+͂ZsٲRn~GRCwIcIn7jJhۛNCS|j08yiHKֶۛkɈ+;SzL /F*\Ԕ#"5m2[S=gnaPeғL
lذaÆ
6l^ḵaÆ
6lذaÆ
6lذa;
_ذaÆ
6lذaÆ
6lذaÆ
R IENDB`
package Paws::CloudWatchEvents;
use Moose;
sub service { 'events' }
sub signing_name { 'events' }
sub version { '2015-10-07' }
sub target_prefix { 'AWSEvents' }
sub json_version { "1.1" }
has max_attempts => (is => 'ro', isa => 'Int', default => 5);
has retry => (is => 'ro', isa => 'HashRef', default => sub {
{ base => 'rand', type => 'exponential', growth_factor => 2 }
});
has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
] });
with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
sub ActivateEventSource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ActivateEventSource', @_);
return $self->caller->do_call($self, $call_object);
}
sub CancelReplay {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::CancelReplay', @_);
return $self->caller->do_call($self, $call_object);
}
sub CreateApiDestination {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::CreateApiDestination', @_);
return $self->caller->do_call($self, $call_object);
}
sub CreateArchive {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::CreateArchive', @_);
return $self->caller->do_call($self, $call_object);
}
sub CreateConnection {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::CreateConnection', @_);
return $self->caller->do_call($self, $call_object);
}
sub CreateEventBus {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::CreateEventBus', @_);
return $self->caller->do_call($self, $call_object);
}
sub CreatePartnerEventSource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::CreatePartnerEventSource', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeactivateEventSource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DeactivateEventSource', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeauthorizeConnection {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DeauthorizeConnection', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeleteApiDestination {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DeleteApiDestination', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeleteArchive {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DeleteArchive', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeleteConnection {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DeleteConnection', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeleteEventBus {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DeleteEventBus', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeletePartnerEventSource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DeletePartnerEventSource', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeleteRule {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DeleteRule', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeApiDestination {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DescribeApiDestination', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeArchive {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DescribeArchive', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeConnection {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DescribeConnection', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeEventBus {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DescribeEventBus', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeEventSource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DescribeEventSource', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribePartnerEventSource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DescribePartnerEventSource', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeReplay {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DescribeReplay', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeRule {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DescribeRule', @_);
return $self->caller->do_call($self, $call_object);
}
sub DisableRule {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::DisableRule', @_);
return $self->caller->do_call($self, $call_object);
}
sub EnableRule {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::EnableRule', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListApiDestinations {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListApiDestinations', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListArchives {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListArchives', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListConnections {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListConnections', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListEventBuses {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListEventBuses', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListEventSources {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListEventSources', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListPartnerEventSourceAccounts {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListPartnerEventSourceAccounts', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListPartnerEventSources {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListPartnerEventSources', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListReplays {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListReplays', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListRuleNamesByTarget {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListRuleNamesByTarget', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListRules {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListRules', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListTagsForResource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListTagsForResource', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListTargetsByRule {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::ListTargetsByRule', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutEvents {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::PutEvents', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutPartnerEvents {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::PutPartnerEvents', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutPermission {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::PutPermission', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutRule {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::PutRule', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutTargets {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::PutTargets', @_);
return $self->caller->do_call($self, $call_object);
}
sub RemovePermission {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::RemovePermission', @_);
return $self->caller->do_call($self, $call_object);
}
sub RemoveTargets {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::RemoveTargets', @_);
return $self->caller->do_call($self, $call_object);
}
sub StartReplay {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::StartReplay', @_);
return $self->caller->do_call($self, $call_object);
}
sub TagResource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::TagResource', @_);
return $self->caller->do_call($self, $call_object);
}
sub TestEventPattern {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::TestEventPattern', @_);
return $self->caller->do_call($self, $call_object);
}
sub UntagResource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::UntagResource', @_);
return $self->caller->do_call($self, $call_object);
}
sub UpdateApiDestination {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::UpdateApiDestination', @_);
return $self->caller->do_call($self, $call_object);
}
sub UpdateArchive {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::UpdateArchive', @_);
return $self->caller->do_call($self, $call_object);
}
sub UpdateConnection {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatchEvents::UpdateConnection', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListAllRuleNamesByTarget {
my $self = shift;
my $callback = shift @_ if (ref($_[0]) eq 'CODE');
my $result = $self->ListRuleNamesByTarget(@_);
my $next_result = $result;
if (not defined $callback) {
while ($next_result->NextToken) {
$next_result = $self->ListRuleNamesByTarget(@_, NextToken => $next_result->NextToken);
push @{ $result->RuleNames }, @{ $next_result->RuleNames };
}
return $result;
} else {
while ($result->NextToken) {
$callback->($_ => 'RuleNames') foreach (@{ $result->RuleNames });
$result = $self->ListRuleNamesByTarget(@_, NextToken => $result->NextToken);
}
$callback->($_ => 'RuleNames') foreach (@{ $result->RuleNames });
}
return undef
}
sub ListAllRules {
my $self = shift;
my $callback = shift @_ if (ref($_[0]) eq 'CODE');
my $result = $self->ListRules(@_);
my $next_result = $result;
if (not defined $callback) {
while ($next_result->NextToken) {
$next_result = $self->ListRules(@_, NextToken => $next_result->NextToken);
push @{ $result->Rules }, @{ $next_result->Rules };
}
return $result;
} else {
while ($result->NextToken) {
$callback->($_ => 'Rules') foreach (@{ $result->Rules });
$result = $self->ListRules(@_, NextToken => $result->NextToken);
}
$callback->($_ => 'Rules') foreach (@{ $result->Rules });
}
return undef
}
sub ListAllTargetsByRule {
my $self = shift;
my $callback = shift @_ if (ref($_[0]) eq 'CODE');
my $result = $self->ListTargetsByRule(@_);
my $next_result = $result;
if (not defined $callback) {
while ($next_result->NextToken) {
$next_result = $self->ListTargetsByRule(@_, NextToken => $next_result->NextToken);
push @{ $result->Targets }, @{ $next_result->Targets };
}
return $result;
} else {
while ($result->NextToken) {
$callback->($_ => 'Targets') foreach (@{ $result->Targets });
$result = $self->ListTargetsByRule(@_, NextToken => $result->NextToken);
}
$callback->($_ => 'Targets') foreach (@{ $result->Targets });
}
return undef
}
sub operations { qw/ActivateEventSource CancelReplay CreateApiDestination CreateArchive CreateConnection CreateEventBus CreatePartnerEventSource DeactivateEventSource DeauthorizeConnection DeleteApiDestination DeleteArchive DeleteConnection DeleteEventBus DeletePartnerEventSource DeleteRule DescribeApiDestination DescribeArchive DescribeConnection DescribeEventBus DescribeEventSource DescribePartnerEventSource DescribeReplay DescribeRule DisableRule EnableRule ListApiDestinations ListArchives ListConnections ListEventBuses ListEventSources ListPartnerEventSourceAccounts ListPartnerEventSources ListReplays ListRuleNamesByTarget ListRules ListTagsForResource ListTargetsByRule PutEvents PutPartnerEvents PutPermission PutRule PutTargets RemovePermission RemoveTargets StartReplay TagResource TestEventPattern UntagResource UpdateApiDestination UpdateArchive UpdateConnection / }
1;
### main pod documentation begin ###
=head1 NAME
Paws::CloudWatchEvents - Perl Interface to AWS Amazon EventBridge
=head1 SYNOPSIS
use Paws;
my $obj = Paws->service('CloudWatchEvents');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);
=head1 DESCRIPTION
Amazon EventBridge helps you to respond to state changes in your AWS
resources. When your resources change state, they automatically send
events into an event stream. You can create rules that match selected
events in the stream and route them to targets to take action. You can
also use rules to take action on a predetermined schedule. For example,
you can configure rules to:
=over
=item *
Automatically invoke an AWS Lambda function to update DNS entries when
an event notifies you that Amazon EC2 instance enters the running
state.
=item *
Direct specific API records from AWS CloudTrail to an Amazon Kinesis
data stream for detailed analysis of potential security or availability
risks.
=item *
Periodically invoke a built-in target to create a snapshot of an Amazon
EBS volume.
=back
For more information about the features of Amazon EventBridge, see the
Amazon EventBridge User Guide
(https://docs.aws.amazon.com/eventbridge/latest/userguide).
For the AWS API documentation, see L
=head1 METHODS
=head2 ActivateEventSource
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: nothing
Activates a partner event source that has been deactivated. Once
activated, your matching event bus will start receiving events from the
event source.
=head2 CancelReplay
=over
=item ReplayName => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Cancels the specified replay.
=head2 CreateApiDestination
=over
=item ConnectionArn => Str
=item HttpMethod => Str
=item InvocationEndpoint => Str
=item Name => Str
=item [Description => Str]
=item [InvocationRateLimitPerSecond => Int]
=back
Each argument is described in detail in: L
Returns: a L instance
Creates an API destination, which is an HTTP invocation endpoint
configured as a target for events.
=head2 CreateArchive
=over
=item ArchiveName => Str
=item EventSourceArn => Str
=item [Description => Str]
=item [EventPattern => Str]
=item [RetentionDays => Int]
=back
Each argument is described in detail in: L
Returns: a L instance
Creates an archive of events with the specified settings. When you
create an archive, incoming events might not immediately start being
sent to the archive. Allow a short period of time for changes to take
effect. If you do not specify a pattern to filter events sent to the
archive, all events are sent to the archive except replayed events.
Replayed events are not sent to an archive.
=head2 CreateConnection
=over
=item AuthorizationType => Str
=item AuthParameters => L
=item Name => Str
=item [Description => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Creates a connection. A connection defines the authorization type and
credentials to use for authorization with an API destination HTTP
endpoint.
=head2 CreateEventBus
=over
=item Name => Str
=item [EventSourceName => Str]
=item [Tags => ArrayRef[L]]
=back
Each argument is described in detail in: L
Returns: a L instance
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.
=head2 CreatePartnerEventSource
=over
=item Account => Str
=item Name => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Called by an SaaS partner to create a partner event source. This
operation is not used by AWS customers.
Each partner event source can be used by one AWS account to create a
matching partner event bus in that AWS account. A SaaS partner must
create one partner event source for each AWS account that wants to
receive those event types.
A partner event source creates events based on resources within the
SaaS partner's service or application.
An AWS account that creates a partner event bus that matches the
partner event source can use that event bus to receive events from the
partner, and then process them using AWS Events rules and targets.
Partner event source names follow this format:
C/I/I>
I is determined during partner registration and
identifies the partner to AWS customers. I is
determined by the partner and is a way for the partner to categorize
their events. I is determined by the partner, and should
uniquely identify an event-generating resource within the partner
system. The combination of I and I should
help AWS customers decide whether to create an event bus to receive
these events.
=head2 DeactivateEventSource
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: nothing
You can use this operation to temporarily stop receiving events from
the specified partner event source. The matching event bus is not
deleted.
When you deactivate a partner event source, the source goes into
PENDING state. If it remains in PENDING state for more than two weeks,
it is deleted.
To activate a deactivated partner event source, use
ActivateEventSource.
=head2 DeauthorizeConnection
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Removes all authorization parameters from the connection. This lets you
remove the secret from the connection so you can reuse it without
having to create a new connection.
=head2 DeleteApiDestination
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Deletes the specified API destination.
=head2 DeleteArchive
=over
=item ArchiveName => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Deletes the specified archive.
=head2 DeleteConnection
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Deletes a connection.
=head2 DeleteEventBus
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: nothing
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.
=head2 DeletePartnerEventSource
=over
=item Account => Str
=item Name => Str
=back
Each argument is described in detail in: L
Returns: nothing
This operation is used by SaaS partners to delete a partner event
source. This operation is not used by AWS customers.
When you delete an event source, the status of the corresponding
partner event bus in the AWS customer account becomes DELETED.
=head2 DeleteRule
=over
=item Name => Str
=item [EventBusName => Str]
=item [Force => Bool]
=back
Each argument is described in detail in: L
Returns: nothing
Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using
RemoveTargets.
When you delete a rule, incoming events might continue to match to the
deleted rule. Allow a short period of time for changes to take effect.
If you call delete rule multiple times for the same rule, all calls
will succeed. When you call delete rule for a non-existent custom
eventbus, C is returned.
Managed rules are rules created and managed by another AWS service on
your behalf. These rules are created by those other AWS services to
support functionality in those services. You can delete these rules
using the C option, but you should do so only if you are sure
the other service is not still using that rule.
=head2 DescribeApiDestination
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Retrieves details about an API destination.
=head2 DescribeArchive
=over
=item ArchiveName => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Retrieves details about an archive.
=head2 DescribeConnection
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Retrieves details about a connection.
=head2 DescribeEventBus
=over
=item [Name => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Displays details about an event bus in your account. This can include
the external AWS 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.
To enable your account to receive events from other accounts on its
default event bus, use PutPermission.
For more information about partner event buses, see CreateEventBus.
=head2 DescribeEventSource
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: a L instance
This operation lists details about a partner event source that is
shared with your account.
=head2 DescribePartnerEventSource
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: a L instance
An SaaS partner can use this operation to list details about a partner
event source that they have created. AWS customers do not use this
operation. Instead, AWS customers can use DescribeEventSource to see
details about a partner event source that is shared with them.
=head2 DescribeReplay
=over
=item ReplayName => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Retrieves details about a replay. Use C to determine
the progress of a running replay. A replay processes events to replay
based on the time in the event, and replays them using 1 minute
intervals. If you use C and specify an C
and an C that covers a 20 minute time range, the events
are replayed from the first minute of that 20 minute range first. Then
the events from the second minute are replayed. You can use
C to determine the progress of a replay. The value
returned for C indicates the time within the
specified time range associated with the last event replayed.
=head2 DescribeRule
=over
=item Name => Str
=item [EventBusName => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Describes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets
associated with a rule, use ListTargetsByRule.
=head2 DisableRule
=over
=item Name => Str
=item [EventBusName => Str]
=back
Each argument is described in detail in: L
Returns: nothing
Disables the specified rule. A disabled rule won't match any events,
and won't self-trigger if it has a schedule expression.
When you disable a rule, incoming events might continue to match to the
disabled rule. Allow a short period of time for changes to take effect.
=head2 EnableRule
=over
=item Name => Str
=item [EventBusName => Str]
=back
Each argument is described in detail in: L
Returns: nothing
Enables the specified rule. If the rule does not exist, the operation
fails.
When you enable a rule, incoming events might not immediately start
matching to a newly enabled rule. Allow a short period of time for
changes to take effect.
=head2 ListApiDestinations
=over
=item [ConnectionArn => Str]
=item [Limit => Int]
=item [NamePrefix => Str]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Retrieves a list of API destination in the account in the current
Region.
=head2 ListArchives
=over
=item [EventSourceArn => Str]
=item [Limit => Int]
=item [NamePrefix => Str]
=item [NextToken => Str]
=item [State => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Lists your archives. You can either list all the archives or you can
provide a prefix to match to the archive names. Filter parameters are
exclusive.
=head2 ListConnections
=over
=item [ConnectionState => Str]
=item [Limit => Int]
=item [NamePrefix => Str]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Retrieves a list of connections from the account.
=head2 ListEventBuses
=over
=item [Limit => Int]
=item [NamePrefix => Str]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Lists all the event buses in your account, including the default event
bus, custom event buses, and partner event buses.
=head2 ListEventSources
=over
=item [Limit => Int]
=item [NamePrefix => Str]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
You can use this to see all the partner event sources that have been
shared with your AWS account. For more information about partner event
sources, see CreateEventBus.
=head2 ListPartnerEventSourceAccounts
=over
=item EventSourceName => Str
=item [Limit => Int]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
An SaaS partner can use this operation to display the AWS account ID
that a particular partner event source name is associated with. This
operation is not used by AWS customers.
=head2 ListPartnerEventSources
=over
=item NamePrefix => Str
=item [Limit => Int]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
An SaaS partner can use this operation to list all the partner event
source names that they have created. This operation is not used by AWS
customers.
=head2 ListReplays
=over
=item [EventSourceArn => Str]
=item [Limit => Int]
=item [NamePrefix => Str]
=item [NextToken => Str]
=item [State => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Lists your replays. You can either list all the replays or you can
provide a prefix to match to the replay names. Filter parameters are
exclusive.
=head2 ListRuleNamesByTarget
=over
=item TargetArn => Str
=item [EventBusName => Str]
=item [Limit => Int]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
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.
=head2 ListRules
=over
=item [EventBusName => Str]
=item [Limit => Int]
=item [NamePrefix => Str]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Lists your Amazon EventBridge rules. You can either list all the rules
or you can provide a prefix to match to the rule names.
ListRules does not list the targets of a rule. To see the targets
associated with a rule, use ListTargetsByRule.
=head2 ListTagsForResource
=over
=item ResourceARN => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Displays the tags associated with an EventBridge resource. In
EventBridge, rules and event buses can be tagged.
=head2 ListTargetsByRule
=over
=item Rule => Str
=item [EventBusName => Str]
=item [Limit => Int]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Lists the targets assigned to the specified rule.
=head2 PutEvents
=over
=item Entries => ArrayRef[L]
=back
Each argument is described in detail in: L
Returns: a L instance
Sends custom events to Amazon EventBridge so that they can be matched
to rules.
=head2 PutPartnerEvents
=over
=item Entries => ArrayRef[L]
=back
Each argument is described in detail in: L
Returns: a L instance
This is used by SaaS partners to write events to a customer's partner
event bus. AWS customers do not use this operation.
=head2 PutPermission
=over
=item [Action => Str]
=item [Condition => L]
=item [EventBusName => Str]
=item [Policy => Str]
=item [Principal => Str]
=item [StatementId => Str]
=back
Each argument is described in detail in: L
Returns: nothing
Running C permits the specified AWS account or AWS
organization to put events to the specified I. Amazon
EventBridge (CloudWatch Events) rules in your account are triggered by
these events arriving to an event bus in your account.
For another account to send events to your account, that external
account must have an EventBridge rule with your account's event bus as
a target.
To enable multiple AWS accounts to put events to your event bus, run
C once for each of these accounts. Or, if all the
accounts are members of the same AWS organization, you can run
C once specifying C as "*" and specifying the
AWS organization ID in C, to grant permissions to all
accounts in that organization.
If you grant permissions using an organization, then accounts in that
organization must specify a C with proper permissions when
they use C to add your account's event bus as a target. For
more information, see Sending and Receiving Events Between AWS Accounts
(https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html)
in the I.
The permission policy on the default event bus cannot exceed 10 KB in
size.
=head2 PutRule
=over
=item Name => Str
=item [Description => Str]
=item [EventBusName => Str]
=item [EventPattern => Str]
=item [RoleArn => Str]
=item [ScheduleExpression => Str]
=item [State => Str]
=item [Tags => ArrayRef[L]]
=back
Each argument is described in detail in: L
Returns: a L instance
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.
A single rule watches for events from a single event bus. Events
generated by AWS services go to your account's default event bus.
Events generated by SaaS partner services or applications go to the
matching partner event bus. If you have custom applications or
services, you can specify whether their events go to your default event
bus or a custom event bus that you have created. For more information,
see CreateEventBus.
If you are updating an existing rule, the rule is replaced with what
you specify in this C command. If you omit arguments in
C, the old values for those arguments are not kept. Instead,
they are replaced with null values.
When you create or update a rule, incoming events might not immediately
start matching to new or updated rules. Allow a short period of time
for changes to take effect.
A rule must contain at least an EventPattern or ScheduleExpression.
Rules with EventPatterns are triggered when a matching event is
observed. Rules with ScheduleExpressions self-trigger based on the
given schedule. A rule can have both an EventPattern and a
ScheduleExpression, in which case the rule triggers on matching events
as well as on a schedule.
When you initially create a rule, you can optionally assign one or more
tags to the rule. Tags can help you organize and categorize your
resources. You can also use them to scope user permissions, by granting
a user permission to access or change only rules with certain tag
values. To use the C operation and assign tags, you must have
both the C and C permissions.
If you are updating an existing rule, any tags you specify in the
C operation are ignored. To update the tags of an existing
rule, use TagResource and UntagResource.
Most services in AWS treat : or / as the same character in Amazon
Resource Names (ARNs). However, EventBridge uses an exact match in
event patterns and rules. Be sure to use the correct ARN characters
when creating event patterns so that they match the ARN syntax in the
event you want to match.
In EventBridge, it is possible to create rules that lead to infinite
loops, where a rule is fired repeatedly. For example, a rule might
detect that ACLs have changed on an S3 bucket, and trigger software to
change them to the desired state. If the rule is not written carefully,
the subsequent change to the ACLs fires the rule again, creating an
infinite loop.
To prevent this, write the rules so that the triggered actions do not
re-fire the same rule. For example, your rule could fire only if ACLs
are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We
recommend that you use budgeting, which alerts you when charges exceed
your specified limit. For more information, see Managing Your Costs
with Budgets
(https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html).
=head2 PutTargets
=over
=item Rule => Str
=item Targets => ArrayRef[L]
=item [EventBusName => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Adds the specified targets to the specified rule, or updates the
targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for Events:
=over
=item *
API destination
(https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html)
=item *
Amazon API Gateway REST API endpoints
=item *
API Gateway
=item *
AWS Batch job queue
=item *
CloudWatch Logs group
=item *
CodeBuild project
=item *
CodePineline
=item *
Amazon EC2 C API call
=item *
Amazon EC2 C API call
=item *
Amazon EC2 C API call
=item *
Amazon EC2 C API call
=item *
Amazon ECS tasks
=item *
Event bus in a different AWS account or Region.
You can use an event bus in the US East (N. Virginia) us-east-1, US
West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a
target for a rule.
=item *
Firehose delivery stream (Kinesis Data Firehose)
=item *
Inspector assessment template (Amazon Inspector)
=item *
Kinesis stream (Kinesis Data Stream)
=item *
AWS Lambda function
=item *
Redshift clusters (Data API statement execution)
=item *
Amazon SNS topic
=item *
Amazon SQS queues (includes FIFO queues
=item *
SSM Automation
=item *
SSM OpsItem
=item *
SSM Run Command
=item *
Step Functions state machines
=back
Creating rules with built-in targets is supported only in the AWS
Management Console. The built-in targets are C, C, C,
and C.
For some target types, C provides target-specific
parameters. If the target is a Kinesis data stream, you can optionally
specify which shard the event goes to by using the C
argument. To invoke a command on multiple EC2 instances with one rule,
you can use the C field.
To be able to make API calls against the resources that you own, Amazon
EventBridge (CloudWatch Events) needs the appropriate permissions. For
AWS Lambda and Amazon SNS resources, EventBridge relies on
resource-based policies. For EC2 instances, Kinesis data streams, AWS
Step Functions state machines and API Gateway REST APIs, EventBridge
relies on IAM roles that you specify in the C argument in
C. For more information, see Authentication and Access
Control
(https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html)
in the I.
If another AWS account is in the same region and has granted you
permission (using C), you can send events to that
account. Set that account's event bus as a target of the rules in your
account. To send the matched events to the other account, specify that
account's event bus as the C value when you run C. If
your account sends events to another account, your account is charged
for each sent event. Each event sent to another account is charged as a
custom event. The account receiving the event is not charged. For more
information, see Amazon EventBridge (CloudWatch Events) Pricing
(https://aws.amazon.com/eventbridge/pricing/).
C, C, and C are not available with
C if the target is an event bus of a different AWS account.
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
C with proper permissions in the C structure. For more
information, see Sending and Receiving Events Between AWS Accounts
(https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html)
in the I.
For more information about enabling cross-account events, see
PutPermission.
B, B, and B are mutually exclusive
and optional parameters of a target. When a rule is triggered due to a
matched event:
=over
=item *
If none of the following arguments are specified for a target, then the
entire event is passed to the target in JSON format (unless the target
is Amazon EC2 Run Command or Amazon ECS task, in which case nothing
from the event is passed to the target).
=item *
If B is specified in the form of valid JSON, then the matched
event is overridden with this constant.
=item *
If B is specified in the form of JSONPath (for example,
C<$.detail>), then only the part of the event specified in the path is
passed to the target (for example, only the detail part of the event is
passed).
=item *
If B is specified, then one or more specified
JSONPaths are extracted from the event and used as values in a template
that you specify as the input to the target.
=back
When you specify C or C, you must use JSON
dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon
after, new or updated targets might not be immediately invoked. Allow a
short period of time for changes to take effect.
This action can partially fail if too many requests are made at the
same time. If that happens, C is non-zero in the
response and each entry in C provides the ID of the
failed target and the error code.
=head2 RemovePermission
=over
=item [EventBusName => Str]
=item [RemoveAllPermissions => Bool]
=item [StatementId => Str]
=back
Each argument is described in detail in: L
Returns: nothing
Revokes the permission of another AWS account to be able to put events
to the specified event bus. Specify the account to revoke by the
C value that you associated with the account when you
granted it permission with C. You can find the
C by using DescribeEventBus.
=head2 RemoveTargets
=over
=item Ids => ArrayRef[Str|Undef]
=item Rule => Str
=item [EventBusName => Str]
=item [Force => Bool]
=back
Each argument is described in detail in: L
Returns: a L instance
Removes the specified targets from the specified rule. When the rule is
triggered, those targets are no longer be invoked.
When you remove a target, when the associated rule triggers, removed
targets might continue to be invoked. Allow a short period of time for
changes to take effect.
This action can partially fail if too many requests are made at the
same time. If that happens, C is non-zero in the
response and each entry in C provides the ID of the
failed target and the error code.
=head2 StartReplay
=over
=item Destination => L
=item EventEndTime => Str
=item EventSourceArn => Str
=item EventStartTime => Str
=item ReplayName => Str
=item [Description => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Starts the specified replay. Events are not necessarily replayed in the
exact same order that they were added to the archive. A replay
processes events to replay based on the time in the event, and replays
them using 1 minute intervals. If you specify an C and
an C that covers a 20 minute time range, the events are
replayed from the first minute of that 20 minute range first. Then the
events from the second minute are replayed. You can use
C to determine the progress of a replay. The value
returned for C indicates the time within the
specified time range associated with the last event replayed.
=head2 TagResource
=over
=item ResourceARN => Str
=item Tags => ArrayRef[L]
=back
Each argument is described in detail in: L
Returns: a L instance
Assigns one or more tags (key-value pairs) to the specified EventBridge
resource. Tags can help you organize and categorize your resources. You
can also use them to scope user permissions by granting a user
permission to access or change only resources with certain tag values.
In EventBridge, rules and event buses can be tagged.
Tags don't have any semantic meaning to AWS and are interpreted
strictly as strings of characters.
You can use the C action with a resource that already has
tags. If you specify a new tag key, this tag is appended to the list of
tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you
specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
=head2 TestEventPattern
=over
=item Event => Str
=item EventPattern => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Tests whether the specified event pattern matches the provided event.
Most services in AWS treat : or / as the same character in Amazon
Resource Names (ARNs). However, EventBridge uses an exact match in
event patterns and rules. Be sure to use the correct ARN characters
when creating event patterns so that they match the ARN syntax in the
event you want to match.
=head2 UntagResource
=over
=item ResourceARN => Str
=item TagKeys => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: a L instance
Removes one or more tags from the specified EventBridge resource. In
Amazon EventBridge (CloudWatch Events), rules and event buses can be
tagged.
=head2 UpdateApiDestination
=over
=item Name => Str
=item [ConnectionArn => Str]
=item [Description => Str]
=item [HttpMethod => Str]
=item [InvocationEndpoint => Str]
=item [InvocationRateLimitPerSecond => Int]
=back
Each argument is described in detail in: L
Returns: a L instance
Updates an API destination.
=head2 UpdateArchive
=over
=item ArchiveName => Str
=item [Description => Str]
=item [EventPattern => Str]
=item [RetentionDays => Int]
=back
Each argument is described in detail in: L
Returns: a L instance
Updates the specified archive.
=head2 UpdateConnection
=over
=item Name => Str
=item [AuthorizationType => Str]
=item [AuthParameters => L]
=item [Description => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Updates settings for a connection.
=head1 PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
=head2 ListAllRuleNamesByTarget(sub { },TargetArn => Str, [EventBusName => Str, Limit => Int, NextToken => Str])
=head2 ListAllRuleNamesByTarget(TargetArn => Str, [EventBusName => Str, Limit => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- RuleNames, passing the object as the first parameter, and the string 'RuleNames' as the second parameter
If not, it will return a a L instance with all the Cs; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
=head2 ListAllRules(sub { },[EventBusName => Str, Limit => Int, NamePrefix => Str, NextToken => Str])
=head2 ListAllRules([EventBusName => Str, Limit => Int, NamePrefix => Str, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Rules, passing the object as the first parameter, and the string 'Rules' as the second parameter
If not, it will return a a L instance with all the Cs; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
=head2 ListAllTargetsByRule(sub { },Rule => Str, [EventBusName => Str, Limit => Int, NextToken => Str])
=head2 ListAllTargetsByRule(Rule => Str, [EventBusName => Str, Limit => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Targets, passing the object as the first parameter, and the string 'Targets' as the second parameter
If not, it will return a a L instance with all the Cs; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
=head1 SEE ALSO
This service class forms part of L
=head1 BUGS and CONTRIBUTIONS
The source code is located here: L
Please report bugs to: L
=cut