Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/cloudwatchevents.ts?docs=full";

§Classes

CloudWatchEvents

§Interfaces

ActivateEventSourceRequest
ApiDestination

Contains details about an API destination.

Archive

An Archive object that contains details about an archive.

AwsVpcConfiguration

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

BatchArrayProperties

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

BatchParameters

The custom parameters to be used when the target is an Batch job.

BatchRetryStrategy

The retry strategy to use for failed jobs, if the target is an Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

CancelReplayRequest
CancelReplayResponse
CapacityProviderStrategyItem

The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

Condition

A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain Amazon Web Services organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the Amazon Web Services organization. Following is an example value for Condition:

Connection

Contains information about a connection.

ConnectionApiKeyAuthResponseParameters

Contains the authorization parameters for the connection if API Key is specified as the authorization type.

ConnectionAuthResponseParameters

Contains the authorization parameters to use for the connection.

ConnectionBasicAuthResponseParameters

Contains the authorization parameters for the connection if Basic is specified as the authorization type.

ConnectionBodyParameter

Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.

ConnectionHeaderParameter

Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.

ConnectionHttpParameters

Contains additional parameters for the connection.

ConnectionOAuthClientResponseParameters

Contains the client response parameters for the connection when OAuth is specified as the authorization type.

ConnectionOAuthResponseParameters

Contains the response parameters when OAuth is specified as the authorization type.

ConnectionQueryStringParameter

Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.

CreateApiDestinationRequest
CreateApiDestinationResponse
CreateArchiveRequest
CreateArchiveResponse
CreateConnectionApiKeyAuthRequestParameters

Contains the API key authorization parameters for the connection.

CreateConnectionAuthRequestParameters

Contains the authorization parameters for the connection.

CreateConnectionBasicAuthRequestParameters

Contains the Basic authorization parameters to use for the connection.

CreateConnectionOAuthClientRequestParameters

Contains the Basic authorization parameters to use for the connection.

CreateConnectionOAuthRequestParameters

Contains the OAuth authorization parameters to use for the connection.

CreateConnectionRequest
CreateConnectionResponse
CreateEventBusRequest
CreateEventBusResponse
CreatePartnerEventSourceRequest
CreatePartnerEventSourceResponse
DeactivateEventSourceRequest
DeadLetterConfig

A DeadLetterConfig object that contains information about a dead-letter queue configuration.

DeauthorizeConnectionRequest
DeauthorizeConnectionResponse
DeleteApiDestinationRequest
DeleteArchiveRequest
DeleteConnectionRequest
DeleteConnectionResponse
DeleteEventBusRequest
DeletePartnerEventSourceRequest
DeleteRuleRequest
DescribeApiDestinationRequest
DescribeApiDestinationResponse
DescribeArchiveRequest
DescribeArchiveResponse
DescribeConnectionRequest
DescribeConnectionResponse
DescribeEventBusRequest
DescribeEventBusResponse
DescribeEventSourceRequest
DescribeEventSourceResponse
DescribePartnerEventSourceRequest
DescribePartnerEventSourceResponse
DescribeReplayRequest
DescribeReplayResponse
DescribeRuleRequest
DescribeRuleResponse
DisableRuleRequest
EcsParameters

The custom parameters to be used when the target is an Amazon ECS task.

EnableRuleRequest
EventBus

An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives events from Amazon Web Services services. A custom event bus can receive events from your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.

EventSource

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.

HttpParameters

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

InputTransformer

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

KinesisParameters

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

ListApiDestinationsRequest
ListApiDestinationsResponse
ListArchivesRequest
ListArchivesResponse
ListConnectionsRequest
ListConnectionsResponse
ListEventBusesRequest
ListEventBusesResponse
ListEventSourcesRequest
ListEventSourcesResponse
ListPartnerEventSourceAccountsRequest
ListPartnerEventSourceAccountsResponse
ListPartnerEventSourcesRequest
ListPartnerEventSourcesResponse
ListReplaysRequest
ListReplaysResponse
ListRuleNamesByTargetRequest
ListRuleNamesByTargetResponse
ListRulesRequest
ListRulesResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
ListTargetsByRuleRequest
ListTargetsByRuleResponse
NetworkConfiguration

This structure specifies the network configuration for an ECS task.

PartnerEventSource

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.

PartnerEventSourceAccount

The Amazon Web Services account that a partner event source has been offered to.

PlacementConstraint

An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

PlacementStrategy

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.

PutEventsRequest
PutEventsRequestEntry

Represents an event to be submitted.

PutEventsResponse
PutEventsResultEntry

Represents an event that failed to be submitted.

PutPartnerEventsRequest
PutPartnerEventsRequestEntry

The details about an event generated by an SaaS partner.

PutPartnerEventsResponse
PutPartnerEventsResultEntry

Represents an event that a partner tried to generate, but failed.

PutPermissionRequest
PutRuleRequest
PutRuleResponse
PutTargetsRequest
PutTargetsResponse
PutTargetsResultEntry

Represents a target that failed to be added to a rule.

RedshiftDataParameters

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

RemovePermissionRequest
RemoveTargetsRequest
RemoveTargetsResponse
RemoveTargetsResultEntry

Represents a target that failed to be removed from a rule.

Replay

A Replay object that contains details about a replay.

ReplayDestination

A ReplayDestination object that contains details about a replay.

RetryPolicy

A RetryPolicy object that includes information about the retry policy settings.

Rule

Contains information about a rule in Amazon EventBridge.

RunCommandParameters

This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.

RunCommandTarget

Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values.

SageMakerPipelineParameter

Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.

SageMakerPipelineParameters

These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on EventBridge events.

SqsParameters

This structure includes the custom parameter to be used when the target is an SQS FIFO queue.

StartReplayRequest
StartReplayResponse
Tag

A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.

TagResourceRequest
Target

Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

TestEventPatternRequest
TestEventPatternResponse
UntagResourceRequest
UpdateApiDestinationRequest
UpdateApiDestinationResponse
UpdateArchiveRequest
UpdateArchiveResponse
UpdateConnectionApiKeyAuthRequestParameters

Contains the API key authorization parameters to use to update the connection.

UpdateConnectionAuthRequestParameters

Contains the additional parameters to use for the connection.

UpdateConnectionBasicAuthRequestParameters

Contains the Basic authorization parameters for the connection.

UpdateConnectionOAuthClientRequestParameters

Contains the OAuth authorization parameters to use for the connection.

UpdateConnectionOAuthRequestParameters

Contains the OAuth request parameters to use for the connection.

UpdateConnectionRequest
UpdateConnectionResponse

§Type Aliases

ApiDestinationHttpMethod
ApiDestinationState
ArchiveState
AssignPublicIp
ConnectionAuthorizationType
ConnectionOAuthHttpMethod
ConnectionState
EventSourceState
LaunchType
PlacementConstraintType
PlacementStrategyType
PropagateTags
ReplayState
RuleState