Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

@aws-sdk/client-cloudwatch-events

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:

  • Automatically invoke an Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.

  • Direct specific API records from CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.

  • Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.

Index

Enumerations

Classes

$Command ActivateEventSourceCommand CancelReplayCommand CloudWatchEvents CloudWatchEventsClient CloudWatchEventsServiceException ConcurrentModificationException CreateApiDestinationCommand CreateArchiveCommand CreateConnectionCommand CreateEventBusCommand CreatePartnerEventSourceCommand DeactivateEventSourceCommand DeauthorizeConnectionCommand DeleteApiDestinationCommand DeleteArchiveCommand DeleteConnectionCommand DeleteEventBusCommand DeletePartnerEventSourceCommand DeleteRuleCommand DescribeApiDestinationCommand DescribeArchiveCommand DescribeConnectionCommand DescribeEventBusCommand DescribeEventSourceCommand DescribePartnerEventSourceCommand DescribeReplayCommand DescribeRuleCommand DisableRuleCommand EnableRuleCommand IllegalStatusException InternalException InvalidEventPatternException InvalidStateException LimitExceededException ListApiDestinationsCommand ListArchivesCommand ListConnectionsCommand ListEventBusesCommand ListEventSourcesCommand ListPartnerEventSourceAccountsCommand ListPartnerEventSourcesCommand ListReplaysCommand ListRuleNamesByTargetCommand ListRulesCommand ListTagsForResourceCommand ListTargetsByRuleCommand ManagedRuleException OperationDisabledException PolicyLengthExceededException PutEventsCommand PutPartnerEventsCommand PutPermissionCommand PutRuleCommand PutTargetsCommand RemovePermissionCommand RemoveTargetsCommand ResourceAlreadyExistsException ResourceNotFoundException StartReplayCommand TagResourceCommand TestEventPatternCommand UntagResourceCommand UpdateApiDestinationCommand UpdateArchiveCommand UpdateConnectionCommand __Client

Interfaces

ActivateEventSourceCommandInput ActivateEventSourceCommandOutput ActivateEventSourceRequest ApiDestination Archive AwsVpcConfiguration BatchArrayProperties BatchParameters BatchRetryStrategy CancelReplayCommandInput CancelReplayCommandOutput CancelReplayRequest CancelReplayResponse CapacityProviderStrategyItem ClientDefaults CloudWatchEventsClientConfig CloudWatchEventsClientResolvedConfig Condition Connection ConnectionApiKeyAuthResponseParameters ConnectionAuthResponseParameters ConnectionBasicAuthResponseParameters ConnectionBodyParameter ConnectionHeaderParameter ConnectionHttpParameters ConnectionOAuthClientResponseParameters ConnectionOAuthResponseParameters ConnectionQueryStringParameter CreateApiDestinationCommandInput CreateApiDestinationCommandOutput CreateApiDestinationRequest CreateApiDestinationResponse CreateArchiveCommandInput CreateArchiveCommandOutput CreateArchiveRequest CreateArchiveResponse CreateConnectionApiKeyAuthRequestParameters CreateConnectionAuthRequestParameters CreateConnectionBasicAuthRequestParameters CreateConnectionCommandInput CreateConnectionCommandOutput CreateConnectionOAuthClientRequestParameters CreateConnectionOAuthRequestParameters CreateConnectionRequest CreateConnectionResponse CreateEventBusCommandInput CreateEventBusCommandOutput CreateEventBusRequest CreateEventBusResponse CreatePartnerEventSourceCommandInput CreatePartnerEventSourceCommandOutput CreatePartnerEventSourceRequest CreatePartnerEventSourceResponse DeactivateEventSourceCommandInput DeactivateEventSourceCommandOutput DeactivateEventSourceRequest DeadLetterConfig DeauthorizeConnectionCommandInput DeauthorizeConnectionCommandOutput DeauthorizeConnectionRequest DeauthorizeConnectionResponse DeleteApiDestinationCommandInput DeleteApiDestinationCommandOutput DeleteApiDestinationRequest DeleteApiDestinationResponse DeleteArchiveCommandInput DeleteArchiveCommandOutput DeleteArchiveRequest DeleteArchiveResponse DeleteConnectionCommandInput DeleteConnectionCommandOutput DeleteConnectionRequest DeleteConnectionResponse DeleteEventBusCommandInput DeleteEventBusCommandOutput DeleteEventBusRequest DeletePartnerEventSourceCommandInput DeletePartnerEventSourceCommandOutput DeletePartnerEventSourceRequest DeleteRuleCommandInput DeleteRuleCommandOutput DeleteRuleRequest DescribeApiDestinationCommandInput DescribeApiDestinationCommandOutput DescribeApiDestinationRequest DescribeApiDestinationResponse DescribeArchiveCommandInput DescribeArchiveCommandOutput DescribeArchiveRequest DescribeArchiveResponse DescribeConnectionCommandInput DescribeConnectionCommandOutput DescribeConnectionRequest DescribeConnectionResponse DescribeEventBusCommandInput DescribeEventBusCommandOutput DescribeEventBusRequest DescribeEventBusResponse DescribeEventSourceCommandInput DescribeEventSourceCommandOutput DescribeEventSourceRequest DescribeEventSourceResponse DescribePartnerEventSourceCommandInput DescribePartnerEventSourceCommandOutput DescribePartnerEventSourceRequest DescribePartnerEventSourceResponse DescribeReplayCommandInput DescribeReplayCommandOutput DescribeReplayRequest DescribeReplayResponse DescribeRuleCommandInput DescribeRuleCommandOutput DescribeRuleRequest DescribeRuleResponse DisableRuleCommandInput DisableRuleCommandOutput DisableRuleRequest EcsParameters EnableRuleCommandInput EnableRuleCommandOutput EnableRuleRequest EventBus EventSource HttpParameters InputTransformer KinesisParameters ListApiDestinationsCommandInput ListApiDestinationsCommandOutput ListApiDestinationsRequest ListApiDestinationsResponse ListArchivesCommandInput ListArchivesCommandOutput ListArchivesRequest ListArchivesResponse ListConnectionsCommandInput ListConnectionsCommandOutput ListConnectionsRequest ListConnectionsResponse ListEventBusesCommandInput ListEventBusesCommandOutput ListEventBusesRequest ListEventBusesResponse ListEventSourcesCommandInput ListEventSourcesCommandOutput ListEventSourcesRequest ListEventSourcesResponse ListPartnerEventSourceAccountsCommandInput ListPartnerEventSourceAccountsCommandOutput ListPartnerEventSourceAccountsRequest ListPartnerEventSourceAccountsResponse ListPartnerEventSourcesCommandInput ListPartnerEventSourcesCommandOutput ListPartnerEventSourcesRequest ListPartnerEventSourcesResponse ListReplaysCommandInput ListReplaysCommandOutput ListReplaysRequest ListReplaysResponse ListRuleNamesByTargetCommandInput ListRuleNamesByTargetCommandOutput ListRuleNamesByTargetRequest ListRuleNamesByTargetResponse ListRulesCommandInput ListRulesCommandOutput ListRulesRequest ListRulesResponse ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListTagsForResourceRequest ListTagsForResourceResponse ListTargetsByRuleCommandInput ListTargetsByRuleCommandOutput ListTargetsByRuleRequest ListTargetsByRuleResponse NetworkConfiguration PartnerEventSource PartnerEventSourceAccount PlacementConstraint PlacementStrategy PutEventsCommandInput PutEventsCommandOutput PutEventsRequest PutEventsRequestEntry PutEventsResponse PutEventsResultEntry PutPartnerEventsCommandInput PutPartnerEventsCommandOutput PutPartnerEventsRequest PutPartnerEventsRequestEntry PutPartnerEventsResponse PutPartnerEventsResultEntry PutPermissionCommandInput PutPermissionCommandOutput PutPermissionRequest PutRuleCommandInput PutRuleCommandOutput PutRuleRequest PutRuleResponse PutTargetsCommandInput PutTargetsCommandOutput PutTargetsRequest PutTargetsResponse PutTargetsResultEntry RedshiftDataParameters RemovePermissionCommandInput RemovePermissionCommandOutput RemovePermissionRequest RemoveTargetsCommandInput RemoveTargetsCommandOutput RemoveTargetsRequest RemoveTargetsResponse RemoveTargetsResultEntry Replay ReplayDestination RetryPolicy Rule RunCommandParameters RunCommandTarget SageMakerPipelineParameter SageMakerPipelineParameters SqsParameters StartReplayCommandInput StartReplayCommandOutput StartReplayRequest StartReplayResponse Tag TagResourceCommandInput TagResourceCommandOutput TagResourceRequest TagResourceResponse Target TestEventPatternCommandInput TestEventPatternCommandOutput TestEventPatternRequest TestEventPatternResponse UntagResourceCommandInput UntagResourceCommandOutput UntagResourceRequest UntagResourceResponse UpdateApiDestinationCommandInput UpdateApiDestinationCommandOutput UpdateApiDestinationRequest UpdateApiDestinationResponse UpdateArchiveCommandInput UpdateArchiveCommandOutput UpdateArchiveRequest UpdateArchiveResponse UpdateConnectionApiKeyAuthRequestParameters UpdateConnectionAuthRequestParameters UpdateConnectionBasicAuthRequestParameters UpdateConnectionCommandInput UpdateConnectionCommandOutput UpdateConnectionOAuthClientRequestParameters UpdateConnectionOAuthRequestParameters UpdateConnectionRequest UpdateConnectionResponse __MetadataBearer

Type Aliases

SDK - Clients

SDK - Commands

ActivateEventSourceCommand ActivateEventSourceCommandInput ActivateEventSourceCommandOutput CancelReplayCommand CancelReplayCommandInput CancelReplayCommandOutput CreateApiDestinationCommand CreateApiDestinationCommandInput CreateApiDestinationCommandOutput CreateArchiveCommand CreateArchiveCommandInput CreateArchiveCommandOutput CreateConnectionCommand CreateConnectionCommandInput CreateConnectionCommandOutput CreateEventBusCommand CreateEventBusCommandInput CreateEventBusCommandOutput CreatePartnerEventSourceCommand CreatePartnerEventSourceCommandInput CreatePartnerEventSourceCommandOutput DeactivateEventSourceCommand DeactivateEventSourceCommandInput DeactivateEventSourceCommandOutput DeauthorizeConnectionCommand DeauthorizeConnectionCommandInput DeauthorizeConnectionCommandOutput DeleteApiDestinationCommand DeleteApiDestinationCommandInput DeleteApiDestinationCommandOutput DeleteArchiveCommand DeleteArchiveCommandInput DeleteArchiveCommandOutput DeleteConnectionCommand DeleteConnectionCommandInput DeleteConnectionCommandOutput DeleteEventBusCommand DeleteEventBusCommandInput DeleteEventBusCommandOutput DeletePartnerEventSourceCommand DeletePartnerEventSourceCommandInput DeletePartnerEventSourceCommandOutput DeleteRuleCommand DeleteRuleCommandInput DeleteRuleCommandOutput DescribeApiDestinationCommand DescribeApiDestinationCommandInput DescribeApiDestinationCommandOutput DescribeArchiveCommand DescribeArchiveCommandInput DescribeArchiveCommandOutput DescribeConnectionCommand DescribeConnectionCommandInput DescribeConnectionCommandOutput DescribeEventBusCommand DescribeEventBusCommandInput DescribeEventBusCommandOutput DescribeEventSourceCommand DescribeEventSourceCommandInput DescribeEventSourceCommandOutput DescribePartnerEventSourceCommand DescribePartnerEventSourceCommandInput DescribePartnerEventSourceCommandOutput DescribeReplayCommand DescribeReplayCommandInput DescribeReplayCommandOutput DescribeRuleCommand DescribeRuleCommandInput DescribeRuleCommandOutput DisableRuleCommand DisableRuleCommandInput DisableRuleCommandOutput EnableRuleCommand EnableRuleCommandInput EnableRuleCommandOutput ListApiDestinationsCommand ListApiDestinationsCommandInput ListApiDestinationsCommandOutput ListArchivesCommand ListArchivesCommandInput ListArchivesCommandOutput ListConnectionsCommand ListConnectionsCommandInput ListConnectionsCommandOutput ListEventBusesCommand ListEventBusesCommandInput ListEventBusesCommandOutput ListEventSourcesCommand ListEventSourcesCommandInput ListEventSourcesCommandOutput ListPartnerEventSourceAccountsCommand ListPartnerEventSourceAccountsCommandInput ListPartnerEventSourceAccountsCommandOutput ListPartnerEventSourcesCommand ListPartnerEventSourcesCommandInput ListPartnerEventSourcesCommandOutput ListReplaysCommand ListReplaysCommandInput ListReplaysCommandOutput ListRuleNamesByTargetCommand ListRuleNamesByTargetCommandInput ListRuleNamesByTargetCommandOutput ListRulesCommand ListRulesCommandInput ListRulesCommandOutput ListTagsForResourceCommand ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListTargetsByRuleCommand ListTargetsByRuleCommandInput ListTargetsByRuleCommandOutput PutEventsCommand PutEventsCommandInput PutEventsCommandOutput PutPartnerEventsCommand PutPartnerEventsCommandInput PutPartnerEventsCommandOutput PutPermissionCommand PutPermissionCommandInput PutPermissionCommandOutput PutRuleCommand PutRuleCommandInput PutRuleCommandOutput PutTargetsCommand PutTargetsCommandInput PutTargetsCommandOutput RemovePermissionCommand RemovePermissionCommandInput RemovePermissionCommandOutput RemoveTargetsCommand RemoveTargetsCommandInput RemoveTargetsCommandOutput StartReplayCommand StartReplayCommandInput StartReplayCommandOutput TagResourceCommand TagResourceCommandInput TagResourceCommandOutput TestEventPatternCommand TestEventPatternCommandInput TestEventPatternCommandOutput UntagResourceCommand UntagResourceCommandInput UntagResourceCommandOutput UpdateApiDestinationCommand UpdateApiDestinationCommandInput UpdateApiDestinationCommandOutput UpdateArchiveCommand UpdateArchiveCommandInput UpdateArchiveCommandOutput UpdateConnectionCommand UpdateConnectionCommandInput UpdateConnectionCommandOutput

SDK - Paginators

SDK - Waiters