aws-sdk
Version:
AWS SDK for JavaScript
375 lines • 182 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class EventBridge extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: EventBridge.Types.ClientConfiguration)
config: Config & EventBridge.Types.ClientConfiguration;
/**
* Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
*/
activateEventSource(params: EventBridge.Types.ActivateEventSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
*/
activateEventSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Cancels the specified replay.
*/
cancelReplay(params: EventBridge.Types.CancelReplayRequest, callback?: (err: AWSError, data: EventBridge.Types.CancelReplayResponse) => void): Request<EventBridge.Types.CancelReplayResponse, AWSError>;
/**
* Cancels the specified replay.
*/
cancelReplay(callback?: (err: AWSError, data: EventBridge.Types.CancelReplayResponse) => void): Request<EventBridge.Types.CancelReplayResponse, AWSError>;
/**
* Creates an API destination, which is an HTTP invocation endpoint configured as a target for events. API destinations do not support private destinations, such as interface VPC endpoints. For more information, see API destinations in the EventBridge User Guide.
*/
createApiDestination(params: EventBridge.Types.CreateApiDestinationRequest, callback?: (err: AWSError, data: EventBridge.Types.CreateApiDestinationResponse) => void): Request<EventBridge.Types.CreateApiDestinationResponse, AWSError>;
/**
* Creates an API destination, which is an HTTP invocation endpoint configured as a target for events. API destinations do not support private destinations, such as interface VPC endpoints. For more information, see API destinations in the EventBridge User Guide.
*/
createApiDestination(callback?: (err: AWSError, data: EventBridge.Types.CreateApiDestinationResponse) => void): Request<EventBridge.Types.CreateApiDestinationResponse, AWSError>;
/**
* 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. Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if: You call CreateArchive on an event bus set to use a customer managed key for encryption. You call CreateDiscoverer on an event bus set to use a customer managed key for encryption. You call UpdatedEventBus to set a customer managed key on an event bus with an archives or schema discovery enabled. To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
*/
createArchive(params: EventBridge.Types.CreateArchiveRequest, callback?: (err: AWSError, data: EventBridge.Types.CreateArchiveResponse) => void): Request<EventBridge.Types.CreateArchiveResponse, AWSError>;
/**
* 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. Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if: You call CreateArchive on an event bus set to use a customer managed key for encryption. You call CreateDiscoverer on an event bus set to use a customer managed key for encryption. You call UpdatedEventBus to set a customer managed key on an event bus with an archives or schema discovery enabled. To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
*/
createArchive(callback?: (err: AWSError, data: EventBridge.Types.CreateArchiveResponse) => void): Request<EventBridge.Types.CreateArchiveResponse, AWSError>;
/**
* Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
*/
createConnection(params: EventBridge.Types.CreateConnectionRequest, callback?: (err: AWSError, data: EventBridge.Types.CreateConnectionResponse) => void): Request<EventBridge.Types.CreateConnectionResponse, AWSError>;
/**
* Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
*/
createConnection(callback?: (err: AWSError, data: EventBridge.Types.CreateConnectionResponse) => void): Request<EventBridge.Types.CreateConnectionResponse, AWSError>;
/**
* 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.
*/
createEndpoint(params: EventBridge.Types.CreateEndpointRequest, callback?: (err: AWSError, data: EventBridge.Types.CreateEndpointResponse) => void): Request<EventBridge.Types.CreateEndpointResponse, AWSError>;
/**
* 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.
*/
createEndpoint(callback?: (err: AWSError, data: EventBridge.Types.CreateEndpointResponse) => void): Request<EventBridge.Types.CreateEndpointResponse, AWSError>;
/**
* 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.
*/
createEventBus(params: EventBridge.Types.CreateEventBusRequest, callback?: (err: AWSError, data: EventBridge.Types.CreateEventBusResponse) => void): Request<EventBridge.Types.CreateEventBusResponse, AWSError>;
/**
* 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.
*/
createEventBus(callback?: (err: AWSError, data: EventBridge.Types.CreateEventBusResponse) => void): Request<EventBridge.Types.CreateEventBusResponse, AWSError>;
/**
* 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: partner_name/event_namespace/event_name partner_name is determined during partner registration, and identifies the partner to Amazon Web Services 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 event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account. The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.
*/
createPartnerEventSource(params: EventBridge.Types.CreatePartnerEventSourceRequest, callback?: (err: AWSError, data: EventBridge.Types.CreatePartnerEventSourceResponse) => void): Request<EventBridge.Types.CreatePartnerEventSourceResponse, AWSError>;
/**
* 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: partner_name/event_namespace/event_name partner_name is determined during partner registration, and identifies the partner to Amazon Web Services 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 event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account. The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.
*/
createPartnerEventSource(callback?: (err: AWSError, data: EventBridge.Types.CreatePartnerEventSourceResponse) => void): Request<EventBridge.Types.CreatePartnerEventSourceResponse, AWSError>;
/**
* 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.
*/
deactivateEventSource(params: EventBridge.Types.DeactivateEventSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deactivateEventSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deauthorizeConnection(params: EventBridge.Types.DeauthorizeConnectionRequest, callback?: (err: AWSError, data: EventBridge.Types.DeauthorizeConnectionResponse) => void): Request<EventBridge.Types.DeauthorizeConnectionResponse, AWSError>;
/**
* 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.
*/
deauthorizeConnection(callback?: (err: AWSError, data: EventBridge.Types.DeauthorizeConnectionResponse) => void): Request<EventBridge.Types.DeauthorizeConnectionResponse, AWSError>;
/**
* Deletes the specified API destination.
*/
deleteApiDestination(params: EventBridge.Types.DeleteApiDestinationRequest, callback?: (err: AWSError, data: EventBridge.Types.DeleteApiDestinationResponse) => void): Request<EventBridge.Types.DeleteApiDestinationResponse, AWSError>;
/**
* Deletes the specified API destination.
*/
deleteApiDestination(callback?: (err: AWSError, data: EventBridge.Types.DeleteApiDestinationResponse) => void): Request<EventBridge.Types.DeleteApiDestinationResponse, AWSError>;
/**
* Deletes the specified archive.
*/
deleteArchive(params: EventBridge.Types.DeleteArchiveRequest, callback?: (err: AWSError, data: EventBridge.Types.DeleteArchiveResponse) => void): Request<EventBridge.Types.DeleteArchiveResponse, AWSError>;
/**
* Deletes the specified archive.
*/
deleteArchive(callback?: (err: AWSError, data: EventBridge.Types.DeleteArchiveResponse) => void): Request<EventBridge.Types.DeleteArchiveResponse, AWSError>;
/**
* Deletes a connection.
*/
deleteConnection(params: EventBridge.Types.DeleteConnectionRequest, callback?: (err: AWSError, data: EventBridge.Types.DeleteConnectionResponse) => void): Request<EventBridge.Types.DeleteConnectionResponse, AWSError>;
/**
* Deletes a connection.
*/
deleteConnection(callback?: (err: AWSError, data: EventBridge.Types.DeleteConnectionResponse) => void): Request<EventBridge.Types.DeleteConnectionResponse, AWSError>;
/**
* 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 .
*/
deleteEndpoint(params: EventBridge.Types.DeleteEndpointRequest, callback?: (err: AWSError, data: EventBridge.Types.DeleteEndpointResponse) => void): Request<EventBridge.Types.DeleteEndpointResponse, AWSError>;
/**
* 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 .
*/
deleteEndpoint(callback?: (err: AWSError, data: EventBridge.Types.DeleteEndpointResponse) => void): Request<EventBridge.Types.DeleteEndpointResponse, AWSError>;
/**
* 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.
*/
deleteEventBus(params: EventBridge.Types.DeleteEventBusRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deleteEventBus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deletePartnerEventSource(params: EventBridge.Types.DeletePartnerEventSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deletePartnerEventSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deleteRule(params: EventBridge.Types.DeleteRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deleteRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retrieves details about an API destination.
*/
describeApiDestination(params: EventBridge.Types.DescribeApiDestinationRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeApiDestinationResponse) => void): Request<EventBridge.Types.DescribeApiDestinationResponse, AWSError>;
/**
* Retrieves details about an API destination.
*/
describeApiDestination(callback?: (err: AWSError, data: EventBridge.Types.DescribeApiDestinationResponse) => void): Request<EventBridge.Types.DescribeApiDestinationResponse, AWSError>;
/**
* Retrieves details about an archive.
*/
describeArchive(params: EventBridge.Types.DescribeArchiveRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeArchiveResponse) => void): Request<EventBridge.Types.DescribeArchiveResponse, AWSError>;
/**
* Retrieves details about an archive.
*/
describeArchive(callback?: (err: AWSError, data: EventBridge.Types.DescribeArchiveResponse) => void): Request<EventBridge.Types.DescribeArchiveResponse, AWSError>;
/**
* Retrieves details about a connection.
*/
describeConnection(params: EventBridge.Types.DescribeConnectionRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeConnectionResponse) => void): Request<EventBridge.Types.DescribeConnectionResponse, AWSError>;
/**
* Retrieves details about a connection.
*/
describeConnection(callback?: (err: AWSError, data: EventBridge.Types.DescribeConnectionResponse) => void): Request<EventBridge.Types.DescribeConnectionResponse, AWSError>;
/**
* 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 .
*/
describeEndpoint(params: EventBridge.Types.DescribeEndpointRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeEndpointResponse) => void): Request<EventBridge.Types.DescribeEndpointResponse, AWSError>;
/**
* 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 .
*/
describeEndpoint(callback?: (err: AWSError, data: EventBridge.Types.DescribeEndpointResponse) => void): Request<EventBridge.Types.DescribeEndpointResponse, AWSError>;
/**
* 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.
*/
describeEventBus(params: EventBridge.Types.DescribeEventBusRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeEventBusResponse) => void): Request<EventBridge.Types.DescribeEventBusResponse, AWSError>;
/**
* 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.
*/
describeEventBus(callback?: (err: AWSError, data: EventBridge.Types.DescribeEventBusResponse) => void): Request<EventBridge.Types.DescribeEventBusResponse, AWSError>;
/**
* This operation lists details about a partner event source that is shared with your account.
*/
describeEventSource(params: EventBridge.Types.DescribeEventSourceRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeEventSourceResponse) => void): Request<EventBridge.Types.DescribeEventSourceResponse, AWSError>;
/**
* This operation lists details about a partner event source that is shared with your account.
*/
describeEventSource(callback?: (err: AWSError, data: EventBridge.Types.DescribeEventSourceResponse) => void): Request<EventBridge.Types.DescribeEventSourceResponse, AWSError>;
/**
* 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.
*/
describePartnerEventSource(params: EventBridge.Types.DescribePartnerEventSourceRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribePartnerEventSourceResponse) => void): Request<EventBridge.Types.DescribePartnerEventSourceResponse, AWSError>;
/**
* 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.
*/
describePartnerEventSource(callback?: (err: AWSError, data: EventBridge.Types.DescribePartnerEventSourceResponse) => void): Request<EventBridge.Types.DescribePartnerEventSourceResponse, AWSError>;
/**
* 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.
*/
describeReplay(params: EventBridge.Types.DescribeReplayRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeReplayResponse) => void): Request<EventBridge.Types.DescribeReplayResponse, AWSError>;
/**
* 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.
*/
describeReplay(callback?: (err: AWSError, data: EventBridge.Types.DescribeReplayResponse) => void): Request<EventBridge.Types.DescribeReplayResponse, AWSError>;
/**
* Describes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
*/
describeRule(params: EventBridge.Types.DescribeRuleRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeRuleResponse) => void): Request<EventBridge.Types.DescribeRuleResponse, AWSError>;
/**
* Describes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
*/
describeRule(callback?: (err: AWSError, data: EventBridge.Types.DescribeRuleResponse) => void): Request<EventBridge.Types.DescribeRuleResponse, AWSError>;
/**
* 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.
*/
disableRule(params: EventBridge.Types.DisableRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
disableRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
enableRule(params: EventBridge.Types.EnableRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
enableRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retrieves a list of API destination in the account in the current Region.
*/
listApiDestinations(params: EventBridge.Types.ListApiDestinationsRequest, callback?: (err: AWSError, data: EventBridge.Types.ListApiDestinationsResponse) => void): Request<EventBridge.Types.ListApiDestinationsResponse, AWSError>;
/**
* Retrieves a list of API destination in the account in the current Region.
*/
listApiDestinations(callback?: (err: AWSError, data: EventBridge.Types.ListApiDestinationsResponse) => void): Request<EventBridge.Types.ListApiDestinationsResponse, AWSError>;
/**
* 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.
*/
listArchives(params: EventBridge.Types.ListArchivesRequest, callback?: (err: AWSError, data: EventBridge.Types.ListArchivesResponse) => void): Request<EventBridge.Types.ListArchivesResponse, AWSError>;
/**
* 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.
*/
listArchives(callback?: (err: AWSError, data: EventBridge.Types.ListArchivesResponse) => void): Request<EventBridge.Types.ListArchivesResponse, AWSError>;
/**
* Retrieves a list of connections from the account.
*/
listConnections(params: EventBridge.Types.ListConnectionsRequest, callback?: (err: AWSError, data: EventBridge.Types.ListConnectionsResponse) => void): Request<EventBridge.Types.ListConnectionsResponse, AWSError>;
/**
* Retrieves a list of connections from the account.
*/
listConnections(callback?: (err: AWSError, data: EventBridge.Types.ListConnectionsResponse) => void): Request<EventBridge.Types.ListConnectionsResponse, AWSError>;
/**
* 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 .
*/
listEndpoints(params: EventBridge.Types.ListEndpointsRequest, callback?: (err: AWSError, data: EventBridge.Types.ListEndpointsResponse) => void): Request<EventBridge.Types.ListEndpointsResponse, AWSError>;
/**
* 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 .
*/
listEndpoints(callback?: (err: AWSError, data: EventBridge.Types.ListEndpointsResponse) => void): Request<EventBridge.Types.ListEndpointsResponse, AWSError>;
/**
* Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
*/
listEventBuses(params: EventBridge.Types.ListEventBusesRequest, callback?: (err: AWSError, data: EventBridge.Types.ListEventBusesResponse) => void): Request<EventBridge.Types.ListEventBusesResponse, AWSError>;
/**
* Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
*/
listEventBuses(callback?: (err: AWSError, data: EventBridge.Types.ListEventBusesResponse) => void): Request<EventBridge.Types.ListEventBusesResponse, AWSError>;
/**
* 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.
*/
listEventSources(params: EventBridge.Types.ListEventSourcesRequest, callback?: (err: AWSError, data: EventBridge.Types.ListEventSourcesResponse) => void): Request<EventBridge.Types.ListEventSourcesResponse, AWSError>;
/**
* 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.
*/
listEventSources(callback?: (err: AWSError, data: EventBridge.Types.ListEventSourcesResponse) => void): Request<EventBridge.Types.ListEventSourcesResponse, AWSError>;
/**
* 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.
*/
listPartnerEventSourceAccounts(params: EventBridge.Types.ListPartnerEventSourceAccountsRequest, callback?: (err: AWSError, data: EventBridge.Types.ListPartnerEventSourceAccountsResponse) => void): Request<EventBridge.Types.ListPartnerEventSourceAccountsResponse, AWSError>;
/**
* 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.
*/
listPartnerEventSourceAccounts(callback?: (err: AWSError, data: EventBridge.Types.ListPartnerEventSourceAccountsResponse) => void): Request<EventBridge.Types.ListPartnerEventSourceAccountsResponse, AWSError>;
/**
* 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.
*/
listPartnerEventSources(params: EventBridge.Types.ListPartnerEventSourcesRequest, callback?: (err: AWSError, data: EventBridge.Types.ListPartnerEventSourcesResponse) => void): Request<EventBridge.Types.ListPartnerEventSourcesResponse, AWSError>;
/**
* 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.
*/
listPartnerEventSources(callback?: (err: AWSError, data: EventBridge.Types.ListPartnerEventSourcesResponse) => void): Request<EventBridge.Types.ListPartnerEventSourcesResponse, AWSError>;
/**
* 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.
*/
listReplays(params: EventBridge.Types.ListReplaysRequest, callback?: (err: AWSError, data: EventBridge.Types.ListReplaysResponse) => void): Request<EventBridge.Types.ListReplaysResponse, AWSError>;
/**
* 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.
*/
listReplays(callback?: (err: AWSError, data: EventBridge.Types.ListReplaysResponse) => void): Request<EventBridge.Types.ListReplaysResponse, AWSError>;
/**
* 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. The maximum number of results per page for requests is 100.
*/
listRuleNamesByTarget(params: EventBridge.Types.ListRuleNamesByTargetRequest, callback?: (err: AWSError, data: EventBridge.Types.ListRuleNamesByTargetResponse) => void): Request<EventBridge.Types.ListRuleNamesByTargetResponse, AWSError>;
/**
* 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. The maximum number of results per page for requests is 100.
*/
listRuleNamesByTarget(callback?: (err: AWSError, data: EventBridge.Types.ListRuleNamesByTargetResponse) => void): Request<EventBridge.Types.ListRuleNamesByTargetResponse, AWSError>;
/**
* Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. The maximum number of results per page for requests is 100. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
*/
listRules(params: EventBridge.Types.ListRulesRequest, callback?: (err: AWSError, data: EventBridge.Types.ListRulesResponse) => void): Request<EventBridge.Types.ListRulesResponse, AWSError>;
/**
* Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. The maximum number of results per page for requests is 100. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
*/
listRules(callback?: (err: AWSError, data: EventBridge.Types.ListRulesResponse) => void): Request<EventBridge.Types.ListRulesResponse, AWSError>;
/**
* Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
*/
listTagsForResource(params: EventBridge.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: EventBridge.Types.ListTagsForResourceResponse) => void): Request<EventBridge.Types.ListTagsForResourceResponse, AWSError>;
/**
* Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
*/
listTagsForResource(callback?: (err: AWSError, data: EventBridge.Types.ListTagsForResourceResponse) => void): Request<EventBridge.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the targets assigned to the specified rule. The maximum number of results per page for requests is 100.
*/
listTargetsByRule(params: EventBridge.Types.ListTargetsByRuleRequest, callback?: (err: AWSError, data: EventBridge.Types.ListTargetsByRuleResponse) => void): Request<EventBridge.Types.ListTargetsByRuleResponse, AWSError>;
/**
* Lists the targets assigned to the specified rule. The maximum number of results per page for requests is 100.
*/
listTargetsByRule(callback?: (err: AWSError, data: EventBridge.Types.ListTargetsByRuleResponse) => void): Request<EventBridge.Types.ListTargetsByRuleResponse, AWSError>;
/**
* Sends custom events to Amazon EventBridge so that they can be matched to rules. The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the event and any necessary characters and keys of the JSON representation of the event. To learn more, see Calculating PutEvents event entry size in the Amazon EventBridge User Guide PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807. PutEvents will only process nested JSON up to 1100 levels deep.
*/
putEvents(params: EventBridge.Types.PutEventsRequest, callback?: (err: AWSError, data: EventBridge.Types.PutEventsResponse) => void): Request<EventBridge.Types.PutEventsResponse, AWSError>;
/**
* Sends custom events to Amazon EventBridge so that they can be matched to rules. The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the event and any necessary characters and keys of the JSON representation of the event. To learn more, see Calculating PutEvents event entry size in the Amazon EventBridge User Guide PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807. PutEvents will only process nested JSON up to 1100 levels deep.
*/
putEvents(callback?: (err: AWSError, data: EventBridge.Types.PutEventsResponse) => void): Request<EventBridge.Types.PutEventsResponse, AWSError>;
/**
* 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. For information on calculating event batch size, see Calculating EventBridge PutEvents event entry size in the EventBridge User Guide.
*/
putPartnerEvents(params: EventBridge.Types.PutPartnerEventsRequest, callback?: (err: AWSError, data: EventBridge.Types.PutPartnerEventsResponse) => void): Request<EventBridge.Types.PutPartnerEventsResponse, AWSError>;
/**
* 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. For information on calculating event batch size, see Calculating EventBridge PutEvents event entry size in the EventBridge User Guide.
*/
putPartnerEvents(callback?: (err: AWSError, data: EventBridge.Types.PutPartnerEventsResponse) => void): Request<EventBridge.Types.PutPartnerEventsResponse, AWSError>;
/**
* 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.
*/
putPermission(params: EventBridge.Types.PutPermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
putPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
putRule(params: EventBridge.Types.PutRuleRequest, callback?: (err: AWSError, data: EventBridge.Types.PutRuleResponse) => void): Request<EventBridge.Types.PutRuleResponse, AWSError>;
/**
* 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.
*/
putRule(callback?: (err: AWSError, data: EventBridge.Types.PutRuleResponse) => void): Request<EventBridge.Types.PutRuleResponse, AWSError>;
/**
* Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resourc