Eventbridge

This page documents function available when using the Eventbridge module, created with @service Eventbridge.

Index

Documentation

Main.Eventbridge.activate_event_sourceMethod
activate_event_source(name)
activate_event_source(name, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the partner event source to activate.
Main.Eventbridge.cancel_replayMethod
cancel_replay(replay_name)
cancel_replay(replay_name, params::Dict{String,<:Any})

Cancels the specified replay.

Arguments

  • replay_name: The name of the replay to cancel.
Main.Eventbridge.create_api_destinationMethod
create_api_destination(connection_arn, http_method, invocation_endpoint, name)
create_api_destination(connection_arn, http_method, invocation_endpoint, name, params::Dict{String,<:Any})

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

Arguments

  • connection_arn: The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.
  • http_method: The method to use for the request to the HTTP invocation endpoint.
  • invocation_endpoint: The URL to the HTTP invocation endpoint for the API destination.
  • name: The name for the API destination to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description for the API destination to create.
  • "InvocationRateLimitPerSecond": The maximum number of requests per second to send to the HTTP invocation endpoint.
Main.Eventbridge.create_archiveMethod
create_archive(archive_name, event_source_arn)
create_archive(archive_name, event_source_arn, params::Dict{String,<:Any})

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.

Arguments

  • archive_name: The name for the archive to create.
  • event_source_arn: The ARN of the event bus that sends events to the archive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description for the archive.
  • "EventPattern": An event pattern to use to filter events sent to the archive.
  • "RetentionDays": The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
Main.Eventbridge.create_connectionMethod
create_connection(auth_parameters, authorization_type, name)
create_connection(auth_parameters, authorization_type, name, params::Dict{String,<:Any})

Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

Arguments

  • auth_parameters: A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
  • authorization_type: The type of authorization to use for the connection. OAUTH tokens are refreshed when a 401 or 407 response is returned.
  • name: The name for the connection to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description for the connection to create.
Main.Eventbridge.create_endpointMethod
create_endpoint(event_buses, name, routing_config)
create_endpoint(event_buses, name, routing_config, params::Dict{String,<:Any})

Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.

Arguments

  • event_buses: Define the event buses used. The names of the event buses must be identical in each Region.
  • name: The name of the global endpoint. For example, "Name":"us-east-2-custombusA-endpoint".
  • routing_config: Configure the routing policy, including the health check and secondary Region..

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description of the global endpoint.
  • "ReplicationConfig": Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.
  • "RoleArn": The ARN of the role used for replication.
Main.Eventbridge.create_event_busMethod
create_event_bus(name)
create_event_bus(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the new event bus. Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to. You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventSourceName": If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
  • "Tags": Tags to associate with the event bus.
Main.Eventbridge.create_partner_event_sourceMethod
create_partner_event_source(account, name)
create_partner_event_source(account, name, params::Dict{String,<:Any})

Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers. Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Events rules and targets. Partner event source names follow this format: partnername/eventnamespace/eventname partnername is determined during partner registration and identifies the partner to Amazon Web Services customers. eventnamespace is determined by the partner and is a way for the partner to categorize their events. eventname is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of eventnamespace and eventname should help Amazon Web Services customers decide whether to create an event bus to receive these events.

Arguments

  • account: The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.
  • name: The name of the partner event source. This name must be unique and must be in the format partnername/eventnamespace/event_name . The Amazon Web Services account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.
Main.Eventbridge.deactivate_event_sourceMethod
deactivate_event_source(name)
deactivate_event_source(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the partner event source to deactivate.
Main.Eventbridge.deauthorize_connectionMethod
deauthorize_connection(name)
deauthorize_connection(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the connection to remove authorization from.
Main.Eventbridge.delete_api_destinationMethod
delete_api_destination(name)
delete_api_destination(name, params::Dict{String,<:Any})

Deletes the specified API destination.

Arguments

  • name: The name of the destination to delete.
Main.Eventbridge.delete_archiveMethod
delete_archive(archive_name)
delete_archive(archive_name, params::Dict{String,<:Any})

Deletes the specified archive.

Arguments

  • archive_name: The name of the archive to delete.
Main.Eventbridge.delete_connectionMethod
delete_connection(name)
delete_connection(name, params::Dict{String,<:Any})

Deletes a connection.

Arguments

  • name: The name of the connection to delete.
Main.Eventbridge.delete_endpointMethod
delete_endpoint(name)
delete_endpoint(name, params::Dict{String,<:Any})

Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

Arguments

  • name: The name of the endpoint you want to delete. For example, "Name":"us-east-2-custombusA-endpoint"..
Main.Eventbridge.delete_event_busMethod
delete_event_bus(name)
delete_event_bus(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the event bus to delete.
Main.Eventbridge.delete_partner_event_sourceMethod
delete_partner_event_source(account, name)
delete_partner_event_source(account, name, params::Dict{String,<:Any})

This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers. When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.

Arguments

  • account: The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.
  • name: The name of the event source to delete.
Main.Eventbridge.delete_ruleMethod
delete_rule(name)
delete_rule(name, params::Dict{String,<:Any})

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, ResourceNotFoundException is returned. Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services 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.

Arguments

  • name: The name of the rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventBusName": The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
  • "Force": If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.
Main.Eventbridge.describe_api_destinationMethod
describe_api_destination(name)
describe_api_destination(name, params::Dict{String,<:Any})

Retrieves details about an API destination.

Arguments

  • name: The name of the API destination to retrieve.
Main.Eventbridge.describe_archiveMethod
describe_archive(archive_name)
describe_archive(archive_name, params::Dict{String,<:Any})

Retrieves details about an archive.

Arguments

  • archive_name: The name of the archive to retrieve.
Main.Eventbridge.describe_connectionMethod
describe_connection(name)
describe_connection(name, params::Dict{String,<:Any})

Retrieves details about a connection.

Arguments

  • name: The name of the connection to retrieve.
Main.Eventbridge.describe_endpointMethod
describe_endpoint(name)
describe_endpoint(name, params::Dict{String,<:Any})

Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

Arguments

  • name: The name of the endpoint you want to get information about. For example, "Name":"us-east-2-custombusA-endpoint".

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "HomeRegion": The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".
Main.Eventbridge.describe_event_busMethod
describe_event_bus()
describe_event_bus(params::Dict{String,<:Any})

Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time. 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Name": The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.
Main.Eventbridge.describe_event_sourceMethod
describe_event_source(name)
describe_event_source(name, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the partner event source to display the details of.
Main.Eventbridge.describe_partner_event_sourceMethod
describe_partner_event_source(name)
describe_partner_event_source(name, params::Dict{String,<:Any})

An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.

Arguments

  • name: The name of the event source to display.
Main.Eventbridge.describe_replayMethod
describe_replay(replay_name)
describe_replay(replay_name, params::Dict{String,<:Any})

Retrieves details about a replay. Use DescribeReplay 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 StartReplay and specify an EventStartTime and an EventEndTime 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 DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

Arguments

  • replay_name: The name of the replay to retrieve.
Main.Eventbridge.describe_ruleMethod
describe_rule(name)
describe_rule(name, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventBusName": The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Main.Eventbridge.disable_ruleMethod
disable_rule(name)
disable_rule(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventBusName": The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Main.Eventbridge.enable_ruleMethod
enable_rule(name)
enable_rule(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventBusName": The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Main.Eventbridge.list_api_destinationsMethod
list_api_destinations()
list_api_destinations(params::Dict{String,<:Any})

Retrieves a list of API destination in the account in the current Region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConnectionArn": The ARN of the connection specified for the API destination.
  • "Limit": The maximum number of API destinations to include in the response.
  • "NamePrefix": A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.
  • "NextToken": The token returned by a previous call to retrieve the next set of results.
Main.Eventbridge.list_archivesMethod
list_archives()
list_archives(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventSourceArn": The ARN of the event source associated with the archive.
  • "Limit": The maximum number of results to return.
  • "NamePrefix": A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.
  • "NextToken": The token returned by a previous call to retrieve the next set of results.
  • "State": The state of the archive.
Main.Eventbridge.list_connectionsMethod
list_connections()
list_connections(params::Dict{String,<:Any})

Retrieves a list of connections from the account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConnectionState": The state of the connection.
  • "Limit": The maximum number of connections to return.
  • "NamePrefix": A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.
  • "NextToken": The token returned by a previous call to retrieve the next set of results.
Main.Eventbridge.list_endpointsMethod
list_endpoints()
list_endpoints(params::Dict{String,<:Any})

List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "HomeRegion": The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".
  • "MaxResults": The maximum number of results returned by the call.
  • "NamePrefix": A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.
  • "NextToken": If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Main.Eventbridge.list_event_busesMethod
list_event_buses()
list_event_buses(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
  • "NamePrefix": Specifying this limits the results to only those event buses with names that start with the specified prefix.
  • "NextToken": The token returned by a previous call to retrieve the next set of results.
Main.Eventbridge.list_event_sourcesMethod
list_event_sources()
list_event_sources(params::Dict{String,<:Any})

You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
  • "NamePrefix": Specifying this limits the results to only those partner event sources with names that start with the specified prefix.
  • "NextToken": The token returned by a previous call to retrieve the next set of results.
Main.Eventbridge.list_partner_event_source_accountsMethod
list_partner_event_source_accounts(event_source_name)
list_partner_event_source_accounts(event_source_name, params::Dict{String,<:Any})

An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.

Arguments

  • event_source_name: The name of the partner event source to display account information about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
  • "NextToken": The token returned by a previous call to this operation. Specifying this retrieves the next set of results.
Main.Eventbridge.list_partner_event_sourcesMethod
list_partner_event_sources(name_prefix)
list_partner_event_sources(name_prefix, params::Dict{String,<:Any})

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 Amazon Web Services customers.

Arguments

  • name_prefix: If you specify this, the results are limited to only those partner event sources that start with the string you specify.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": pecifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
  • "NextToken": The token returned by a previous call to this operation. Specifying this retrieves the next set of results.
Main.Eventbridge.list_replaysMethod
list_replays()
list_replays(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventSourceArn": The ARN of the archive from which the events are replayed.
  • "Limit": The maximum number of replays to retrieve.
  • "NamePrefix": A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.
  • "NextToken": The token returned by a previous call to retrieve the next set of results.
  • "State": The state of the replay.
Main.Eventbridge.list_rule_names_by_targetMethod
list_rule_names_by_target(target_arn)
list_rule_names_by_target(target_arn, params::Dict{String,<:Any})

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.

Arguments

  • target_arn: The Amazon Resource Name (ARN) of the target resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventBusName": The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.
  • "Limit": The maximum number of results to return.
  • "NextToken": The token returned by a previous call to retrieve the next set of results.
Main.Eventbridge.list_rulesMethod
list_rules()
list_rules(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventBusName": The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.
  • "Limit": The maximum number of results to return.
  • "NamePrefix": The prefix matching the rule name.
  • "NextToken": The token returned by a previous call to retrieve the next set of results.
Main.Eventbridge.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The ARN of the EventBridge resource for which you want to view tags.
Main.Eventbridge.list_targets_by_ruleMethod
list_targets_by_rule(rule)
list_targets_by_rule(rule, params::Dict{String,<:Any})

Lists the targets assigned to the specified rule.

Arguments

  • rule: The name of the rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventBusName": The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
  • "Limit": The maximum number of results to return.
  • "NextToken": The token returned by a previous call to retrieve the next set of results.
Main.Eventbridge.put_eventsMethod
put_events(entries)
put_events(entries, params::Dict{String,<:Any})

Sends custom events to Amazon EventBridge so that they can be matched to rules. PutEvents will only process nested JSON up to 1100 levels deep.

Arguments

  • entries: The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EndpointId": The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo. When using Java, you must include auth-crt on the class path.
Main.Eventbridge.put_partner_eventsMethod
put_partner_events(entries)
put_partner_events(entries, params::Dict{String,<:Any})

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

Arguments

  • entries: The list of events to write to the event bus.
Main.Eventbridge.put_permissionMethod
put_permission()
put_permission(params::Dict{String,<:Any})

Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services 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 Amazon Web Services Accounts in the Amazon EventBridge User Guide. The permission policy on the event bus cannot exceed 10 KB in size.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Action": The action that you are enabling the other account to perform.
  • "Condition": This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide. If you specify Condition with an Amazon Web Services organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization. The Condition is a JSON string which must contain Type, Key, and Value fields.
  • "EventBusName": The name of the event bus associated with the rule. If you omit this, the default event bus is used.
  • "Policy": A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.
  • "Principal": The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "" to permit any account to put events to your default event bus. If you specify "" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
  • "StatementId": An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission. Each StatementId must be unique.
Main.Eventbridge.put_ruleMethod
put_rule(name)
put_rule(name, params::Dict{String,<:Any})

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 Amazon Web Services 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 Amazon Web Services 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.

Arguments

  • name: The name of the rule that you are creating or updating.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description of the rule.
  • "EventBusName": The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.
  • "EventPattern": The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.
  • "RoleArn": The Amazon Resource Name (ARN) of the IAM role associated with the rule. If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.
  • "ScheduleExpression": The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
  • "State": Indicates whether the rule is enabled or disabled.
  • "Tags": The list of key-value pairs to associate with the rule.
Main.Eventbridge.put_targetsMethod
put_targets(rule, targets)
put_targets(rule, targets, params::Dict{String,<:Any})

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. Each rule can have up to five (5) targets associated with it at one time. You can configure the following as targets for Events: API destination API Gateway Batch job queue CloudWatch group CodeBuild project CodePipeline EC2 CreateSnapshot API call EC2 Image Builder EC2 RebootInstances API call EC2 StopInstances API call EC2 TerminateInstances API call ECS task Event bus in a different account or Region Event bus in the same account and Region Firehose delivery stream Glue workflow Incident Manager response plan Inspector assessment template Kinesis stream Lambda function Redshift cluster Redshift Serverless workgroup SageMaker Pipeline SNS topic SQS queue Step Functions state machine Systems Manager Automation Systems Manager OpsItem Systems Manager Run Command Creating rules with built-in targets is supported only in the Amazon Web Services 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 needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway 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 Amazon Web Services 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 Pricing. Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services 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 Amazon Web Services 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.

Arguments

  • rule: The name of the rule.
  • targets: The targets to update or add to the rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventBusName": The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Main.Eventbridge.remove_permissionMethod
remove_permission()
remove_permission(params::Dict{String,<:Any})

Revokes the permission of another Amazon Web Services 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventBusName": The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.
  • "RemoveAllPermissions": Specifies whether to remove all permissions.
  • "StatementId": The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.
Main.Eventbridge.remove_targetsMethod
remove_targets(ids, rule)
remove_targets(ids, rule, params::Dict{String,<:Any})

Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked. A successful execution of RemoveTargets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed. 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.

Arguments

  • ids: The IDs of the targets to remove from the rule.
  • rule: The name of the rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventBusName": The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
  • "Force": If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.
Main.Eventbridge.start_replayMethod
start_replay(destination, event_end_time, event_source_arn, event_start_time, replay_name)
start_replay(destination, event_end_time, event_source_arn, event_start_time, replay_name, params::Dict{String,<:Any})

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 EventStartTime and an EventEndTime 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 DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

Arguments

  • destination: A ReplayDestination object that includes details about the destination for the replay.
  • event_end_time: A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.
  • event_source_arn: The ARN of the archive to replay events from.
  • event_start_time: A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.
  • replay_name: The name of the replay to start.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description for the replay to start.
Main.Eventbridge.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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 Amazon Web Services 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.

Arguments

  • resource_arn: The ARN of the EventBridge resource that you're adding tags to.
  • tags: The list of key-value pairs to associate with the resource.
Main.Eventbridge.test_event_patternMethod
test_event_pattern(event, event_pattern)
test_event_pattern(event, event_pattern, params::Dict{String,<:Any})

Tests whether the specified event pattern matches the provided event. Most services in Amazon Web Services 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.

Arguments

  • event: The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in Amazon Web Services Events, and the following fields are mandatory: id account source time region resources detail-type
  • event_pattern: The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
Main.Eventbridge.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The ARN of the EventBridge resource from which you are removing tags.
  • tag_keys: The list of tag keys to remove from the resource.
Main.Eventbridge.update_api_destinationMethod
update_api_destination(name)
update_api_destination(name, params::Dict{String,<:Any})

Updates an API destination.

Arguments

  • name: The name of the API destination to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConnectionArn": The ARN of the connection to use for the API destination.
  • "Description": The name of the API destination to update.
  • "HttpMethod": The method to use for the API destination.
  • "InvocationEndpoint": The URL to the endpoint to use for the API destination.
  • "InvocationRateLimitPerSecond": The maximum number of invocations per second to send to the API destination.
Main.Eventbridge.update_archiveMethod
update_archive(archive_name)
update_archive(archive_name, params::Dict{String,<:Any})

Updates the specified archive.

Arguments

  • archive_name: The name of the archive to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description for the archive.
  • "EventPattern": The event pattern to use to filter events sent to the archive.
  • "RetentionDays": The number of days to retain events in the archive.
Main.Eventbridge.update_connectionMethod
update_connection(name)
update_connection(name, params::Dict{String,<:Any})

Updates settings for a connection.

Arguments

  • name: The name of the connection to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AuthParameters": The authorization parameters to use for the connection.
  • "AuthorizationType": The type of authorization to use for the connection.
  • "Description": A description for the connection.
Main.Eventbridge.update_endpointMethod
update_endpoint(name)
update_endpoint(name, params::Dict{String,<:Any})

Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

Arguments

  • name: The name of the endpoint you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description for the endpoint.
  • "EventBuses": Define event buses used for replication.
  • "ReplicationConfig": Whether event replication was enabled or disabled by this request.
  • "RoleArn": The ARN of the role used by event replication for this request.
  • "RoutingConfig": Configure the routing policy, including the health check and secondary Region.