[−][src]Trait rusoto_events::EventBridge

pub trait EventBridge {
#[must_use]    pub fn activate_event_source<'life0, 'async_trait>(
        &'life0 self, 
        input: ActivateEventSourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<ActivateEventSourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn create_event_bus<'life0, 'async_trait>(
        &'life0 self, 
        input: CreateEventBusRequest
    ) -> Pin<Box<dyn Future<Output = Result<CreateEventBusResponse, RusotoError<CreateEventBusError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn create_partner_event_source<'life0, 'async_trait>(
        &'life0 self, 
        input: CreatePartnerEventSourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<CreatePartnerEventSourceResponse, RusotoError<CreatePartnerEventSourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn deactivate_event_source<'life0, 'async_trait>(
        &'life0 self, 
        input: DeactivateEventSourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeactivateEventSourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn delete_event_bus<'life0, 'async_trait>(
        &'life0 self, 
        input: DeleteEventBusRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteEventBusError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn delete_partner_event_source<'life0, 'async_trait>(
        &'life0 self, 
        input: DeletePartnerEventSourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeletePartnerEventSourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn delete_rule<'life0, 'async_trait>(
        &'life0 self, 
        input: DeleteRuleRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteRuleError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn describe_event_bus<'life0, 'async_trait>(
        &'life0 self, 
        input: DescribeEventBusRequest
    ) -> Pin<Box<dyn Future<Output = Result<DescribeEventBusResponse, RusotoError<DescribeEventBusError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn describe_event_source<'life0, 'async_trait>(
        &'life0 self, 
        input: DescribeEventSourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<DescribeEventSourceResponse, RusotoError<DescribeEventSourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn describe_partner_event_source<'life0, 'async_trait>(
        &'life0 self, 
        input: DescribePartnerEventSourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<DescribePartnerEventSourceResponse, RusotoError<DescribePartnerEventSourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn describe_rule<'life0, 'async_trait>(
        &'life0 self, 
        input: DescribeRuleRequest
    ) -> Pin<Box<dyn Future<Output = Result<DescribeRuleResponse, RusotoError<DescribeRuleError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn disable_rule<'life0, 'async_trait>(
        &'life0 self, 
        input: DisableRuleRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DisableRuleError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn enable_rule<'life0, 'async_trait>(
        &'life0 self, 
        input: EnableRuleRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<EnableRuleError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn list_event_buses<'life0, 'async_trait>(
        &'life0 self, 
        input: ListEventBusesRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListEventBusesResponse, RusotoError<ListEventBusesError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn list_event_sources<'life0, 'async_trait>(
        &'life0 self, 
        input: ListEventSourcesRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListEventSourcesResponse, RusotoError<ListEventSourcesError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn list_partner_event_source_accounts<'life0, 'async_trait>(
        &'life0 self, 
        input: ListPartnerEventSourceAccountsRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListPartnerEventSourceAccountsResponse, RusotoError<ListPartnerEventSourceAccountsError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn list_partner_event_sources<'life0, 'async_trait>(
        &'life0 self, 
        input: ListPartnerEventSourcesRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListPartnerEventSourcesResponse, RusotoError<ListPartnerEventSourcesError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn list_rule_names_by_target<'life0, 'async_trait>(
        &'life0 self, 
        input: ListRuleNamesByTargetRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListRuleNamesByTargetResponse, RusotoError<ListRuleNamesByTargetError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn list_rules<'life0, 'async_trait>(
        &'life0 self, 
        input: ListRulesRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListRulesResponse, RusotoError<ListRulesError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn list_tags_for_resource<'life0, 'async_trait>(
        &'life0 self, 
        input: ListTagsForResourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn list_targets_by_rule<'life0, 'async_trait>(
        &'life0 self, 
        input: ListTargetsByRuleRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListTargetsByRuleResponse, RusotoError<ListTargetsByRuleError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn put_events<'life0, 'async_trait>(
        &'life0 self, 
        input: PutEventsRequest
    ) -> Pin<Box<dyn Future<Output = Result<PutEventsResponse, RusotoError<PutEventsError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn put_partner_events<'life0, 'async_trait>(
        &'life0 self, 
        input: PutPartnerEventsRequest
    ) -> Pin<Box<dyn Future<Output = Result<PutPartnerEventsResponse, RusotoError<PutPartnerEventsError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn put_permission<'life0, 'async_trait>(
        &'life0 self, 
        input: PutPermissionRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<PutPermissionError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn put_rule<'life0, 'async_trait>(
        &'life0 self, 
        input: PutRuleRequest
    ) -> Pin<Box<dyn Future<Output = Result<PutRuleResponse, RusotoError<PutRuleError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn put_targets<'life0, 'async_trait>(
        &'life0 self, 
        input: PutTargetsRequest
    ) -> Pin<Box<dyn Future<Output = Result<PutTargetsResponse, RusotoError<PutTargetsError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn remove_permission<'life0, 'async_trait>(
        &'life0 self, 
        input: RemovePermissionRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<RemovePermissionError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn remove_targets<'life0, 'async_trait>(
        &'life0 self, 
        input: RemoveTargetsRequest
    ) -> Pin<Box<dyn Future<Output = Result<RemoveTargetsResponse, RusotoError<RemoveTargetsError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn tag_resource<'life0, 'async_trait>(
        &'life0 self, 
        input: TagResourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn test_event_pattern<'life0, 'async_trait>(
        &'life0 self, 
        input: TestEventPatternRequest
    ) -> Pin<Box<dyn Future<Output = Result<TestEventPatternResponse, RusotoError<TestEventPatternError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    pub fn untag_resource<'life0, 'async_trait>(
        &'life0 self, 
        input: UntagResourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
}

Trait representing the capabilities of the Amazon EventBridge API. Amazon EventBridge clients implement this trait.

Required methods

`#[must_use]pub fn activate_event_source<'life0, 'async_trait>( &'life0 self, input: ActivateEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<ActivateEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

`#[must_use]pub fn create_event_bus<'life0, 'async_trait>( &'life0 self, input: CreateEventBusRequest ) -> Pin<Box<dyn Future<Output = Result<CreateEventBusResponse, RusotoError<CreateEventBusError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn create_partner_event_source<'life0, 'async_trait>( &'life0 self, input: CreatePartnerEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<CreatePartnerEventSourceResponse, RusotoError<CreatePartnerEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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:

partner_name/event_namespace/event_name

partner_name is determined during partner registration and identifies the partner to AWS customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help AWS customers decide whether to create an event bus to receive these events.

`#[must_use]pub fn deactivate_event_source<'life0, 'async_trait>( &'life0 self, input: DeactivateEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeactivateEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn delete_event_bus<'life0, 'async_trait>( &'life0 self, input: DeleteEventBusRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteEventBusError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn delete_partner_event_source<'life0, 'async_trait>( &'life0 self, input: DeletePartnerEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeletePartnerEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn delete_rule<'life0, 'async_trait>( &'life0 self, input: DeleteRuleRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

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 Force option, but you should do so only if you are sure the other service is not still using that rule.

`#[must_use]pub fn describe_event_bus<'life0, 'async_trait>( &'life0 self, input: DescribeEventBusRequest ) -> Pin<Box<dyn Future<Output = Result<DescribeEventBusResponse, RusotoError<DescribeEventBusError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn describe_event_source<'life0, 'async_trait>( &'life0 self, input: DescribeEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<DescribeEventSourceResponse, RusotoError<DescribeEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

This operation lists details about a partner event source that is shared with your account.

`#[must_use]pub fn describe_partner_event_source<'life0, 'async_trait>( &'life0 self, input: DescribePartnerEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<DescribePartnerEventSourceResponse, RusotoError<DescribePartnerEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn describe_rule<'life0, 'async_trait>( &'life0 self, input: DescribeRuleRequest ) -> Pin<Box<dyn Future<Output = Result<DescribeRuleResponse, RusotoError<DescribeRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

`#[must_use]pub fn disable_rule<'life0, 'async_trait>( &'life0 self, input: DisableRuleRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DisableRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn enable_rule<'life0, 'async_trait>( &'life0 self, input: EnableRuleRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<EnableRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn list_event_buses<'life0, 'async_trait>( &'life0 self, input: ListEventBusesRequest ) -> Pin<Box<dyn Future<Output = Result<ListEventBusesResponse, RusotoError<ListEventBusesError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

`#[must_use]pub fn list_event_sources<'life0, 'async_trait>( &'life0 self, input: ListEventSourcesRequest ) -> Pin<Box<dyn Future<Output = Result<ListEventSourcesResponse, RusotoError<ListEventSourcesError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn list_partner_event_source_accounts<'life0, 'async_trait>( &'life0 self, input: ListPartnerEventSourceAccountsRequest ) -> Pin<Box<dyn Future<Output = Result<ListPartnerEventSourceAccountsResponse, RusotoError<ListPartnerEventSourceAccountsError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn list_partner_event_sources<'life0, 'async_trait>( &'life0 self, input: ListPartnerEventSourcesRequest ) -> Pin<Box<dyn Future<Output = Result<ListPartnerEventSourcesResponse, RusotoError<ListPartnerEventSourcesError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn list_rule_names_by_target<'life0, 'async_trait>( &'life0 self, input: ListRuleNamesByTargetRequest ) -> Pin<Box<dyn Future<Output = Result<ListRuleNamesByTargetResponse, RusotoError<ListRuleNamesByTargetError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn list_rules<'life0, 'async_trait>( &'life0 self, input: ListRulesRequest ) -> Pin<Box<dyn Future<Output = Result<ListRulesResponse, RusotoError<ListRulesError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn list_tags_for_resource<'life0, 'async_trait>( &'life0 self, input: ListTagsForResourceRequest ) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.

`#[must_use]pub fn list_targets_by_rule<'life0, 'async_trait>( &'life0 self, input: ListTargetsByRuleRequest ) -> Pin<Box<dyn Future<Output = Result<ListTargetsByRuleResponse, RusotoError<ListTargetsByRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Lists the targets assigned to the specified rule.

`#[must_use]pub fn put_events<'life0, 'async_trait>( &'life0 self, input: PutEventsRequest ) -> Pin<Box<dyn Future<Output = Result<PutEventsResponse, RusotoError<PutEventsError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Sends custom events to Amazon EventBridge so that they can be matched to rules.

`#[must_use]pub fn put_partner_events<'life0, 'async_trait>( &'life0 self, input: PutPartnerEventsRequest ) -> Pin<Box<dyn Future<Output = Result<PutPartnerEventsResponse, RusotoError<PutPartnerEventsError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.

`#[must_use]pub fn put_permission<'life0, 'async_trait>( &'life0 self, input: PutPermissionRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<PutPermissionError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. 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 PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

The permission policy on the default event bus cannot exceed 10 KB in size.

`#[must_use]pub fn put_rule<'life0, 'async_trait>( &'life0 self, input: PutRuleRequest ) -> Pin<Box<dyn Future<Output = Result<PutRuleResponse, RusotoError<PutRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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 PutRule command. If you omit arguments in PutRule, 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 PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.

If you are updating an existing rule, any tags you specify in the PutRule 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.

`#[must_use]pub fn put_targets<'life0, 'async_trait>( &'life0 self, input: PutTargetsRequest ) -> Pin<Box<dyn Future<Output = Result<PutTargetsResponse, RusotoError<PutTargetsError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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:

EC2 instances
SSM Run Command
SSM Automation
AWS Lambda functions
Data streams in Amazon Kinesis Data Streams
Data delivery streams in Amazon Kinesis Data Firehose
Amazon ECS tasks
AWS Step Functions state machines
AWS Batch jobs
AWS CodeBuild projects
Pipelines in AWS CodePipeline
Amazon Inspector assessment templates
Amazon SNS topics
Amazon SQS queues, including FIFO queues
The default event bus of another AWS account
Amazon API Gateway REST APIs

Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.

For some target types, PutTargets 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 KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters 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 RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.

If another AWS account is in the same region and has granted you permission (using PutPermission), 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 Arn value when you run PutTargets. 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.

Input, InputPath, and InputTransformer are not available with PutTarget 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 RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

For more information about enabling cross-account events, see PutPermission.

Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

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).
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
If InputPath is specified in the form of JSONPath (for example, $.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).
If InputTransformer 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.

When you specify InputPath or InputTransformer, 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, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

`#[must_use]pub fn remove_permission<'life0, 'async_trait>( &'life0 self, input: RemovePermissionRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<RemovePermissionError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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 StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.

`#[must_use]pub fn remove_targets<'life0, 'async_trait>( &'life0 self, input: RemoveTargetsRequest ) -> Pin<Box<dyn Future<Output = Result<RemoveTargetsResponse, RusotoError<RemoveTargetsError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

`#[must_use]pub fn tag_resource<'life0, 'async_trait>( &'life0 self, input: TagResourceRequest ) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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

`#[must_use]pub fn test_event_pattern<'life0, 'async_trait>( &'life0 self, input: TestEventPatternRequest ) -> Pin<Box<dyn Future<Output = Result<TestEventPatternResponse, RusotoError<TestEventPatternError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`#[must_use]pub fn untag_resource<'life0, 'async_trait>( &'life0 self, input: UntagResourceRequest ) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged.

Loading content...

Implementors

`impl EventBridge for EventBridgeClient`[src]

`pub fn activate_event_source<'life0, 'async_trait>( &'life0 self, input: ActivateEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<ActivateEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

`pub fn create_event_bus<'life0, 'async_trait>( &'life0 self, input: CreateEventBusRequest ) -> Pin<Box<dyn Future<Output = Result<CreateEventBusResponse, RusotoError<CreateEventBusError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn create_partner_event_source<'life0, 'async_trait>( &'life0 self, input: CreatePartnerEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<CreatePartnerEventSourceResponse, RusotoError<CreatePartnerEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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:

partner_name/event_namespace/event_name

partner_name is determined during partner registration and identifies the partner to AWS customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help AWS customers decide whether to create an event bus to receive these events.

`pub fn deactivate_event_source<'life0, 'async_trait>( &'life0 self, input: DeactivateEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeactivateEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn delete_event_bus<'life0, 'async_trait>( &'life0 self, input: DeleteEventBusRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteEventBusError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn delete_partner_event_source<'life0, 'async_trait>( &'life0 self, input: DeletePartnerEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeletePartnerEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn delete_rule<'life0, 'async_trait>( &'life0 self, input: DeleteRuleRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

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 Force option, but you should do so only if you are sure the other service is not still using that rule.

`pub fn describe_event_bus<'life0, 'async_trait>( &'life0 self, input: DescribeEventBusRequest ) -> Pin<Box<dyn Future<Output = Result<DescribeEventBusResponse, RusotoError<DescribeEventBusError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn describe_event_source<'life0, 'async_trait>( &'life0 self, input: DescribeEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<DescribeEventSourceResponse, RusotoError<DescribeEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

This operation lists details about a partner event source that is shared with your account.

`pub fn describe_partner_event_source<'life0, 'async_trait>( &'life0 self, input: DescribePartnerEventSourceRequest ) -> Pin<Box<dyn Future<Output = Result<DescribePartnerEventSourceResponse, RusotoError<DescribePartnerEventSourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn describe_rule<'life0, 'async_trait>( &'life0 self, input: DescribeRuleRequest ) -> Pin<Box<dyn Future<Output = Result<DescribeRuleResponse, RusotoError<DescribeRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

`pub fn disable_rule<'life0, 'async_trait>( &'life0 self, input: DisableRuleRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DisableRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn enable_rule<'life0, 'async_trait>( &'life0 self, input: EnableRuleRequest ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<EnableRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn list_event_buses<'life0, 'async_trait>( &'life0 self, input: ListEventBusesRequest ) -> Pin<Box<dyn Future<Output = Result<ListEventBusesResponse, RusotoError<ListEventBusesError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

`pub fn list_event_sources<'life0, 'async_trait>( &'life0 self, input: ListEventSourcesRequest ) -> Pin<Box<dyn Future<Output = Result<ListEventSourcesResponse, RusotoError<ListEventSourcesError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn list_partner_event_source_accounts<'life0, 'async_trait>( &'life0 self, input: ListPartnerEventSourceAccountsRequest ) -> Pin<Box<dyn Future<Output = Result<ListPartnerEventSourceAccountsResponse, RusotoError<ListPartnerEventSourceAccountsError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn list_partner_event_sources<'life0, 'async_trait>( &'life0 self, input: ListPartnerEventSourcesRequest ) -> Pin<Box<dyn Future<Output = Result<ListPartnerEventSourcesResponse, RusotoError<ListPartnerEventSourcesError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn list_rule_names_by_target<'life0, 'async_trait>( &'life0 self, input: ListRuleNamesByTargetRequest ) -> Pin<Box<dyn Future<Output = Result<ListRuleNamesByTargetResponse, RusotoError<ListRuleNamesByTargetError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn list_rules<'life0, 'async_trait>( &'life0 self, input: ListRulesRequest ) -> Pin<Box<dyn Future<Output = Result<ListRulesResponse, RusotoError<ListRulesError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

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.

`pub fn list_tags_for_resource<'life0, 'async_trait>( &'life0 self, input: ListTagsForResourceRequest ) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.

`pub fn list_targets_by_rule<'life0, 'async_trait>( &'life0 self, input: ListTargetsByRuleRequest ) -> Pin<Box<dyn Future<Output = Result<ListTargetsByRuleResponse, RusotoError<ListTargetsByRuleError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]

Lists the targets assigned to the specified rule.

`pub fn put_events<'life0, 'async_trait>( &'life0 self, input: PutEventsRequest ) -> Pin<Box<dyn Future<Output = Result<PutEventsResponse, RusotoError<PutEventsError>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,` [src]