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

class 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

class BatchParameters

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

BatchRetryStrategy

class 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

class CancelReplayRequest

CancelReplayResponse

class CancelReplayResponse

CapacityProviderStrategyItem

class CapacityProviderStrategyItem

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

ConcurrentModificationException

class ConcurrentModificationException : EventBridgeException

There is concurrent modification on a rule, target, archive, or replay.

Condition

class 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

class Connection

Contains information about a connection.

ConnectionApiKeyAuthResponseParameters

class ConnectionApiKeyAuthResponseParameters

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

ConnectionAuthorizationType

sealed class ConnectionAuthorizationType

ConnectionAuthResponseParameters

class ConnectionAuthResponseParameters

Tthe authorization parameters to use for the connection.

ConnectionBasicAuthResponseParameters

class ConnectionBasicAuthResponseParameters

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

ConnectionBodyParameter

class 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

class 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

class ConnectionHttpParameters

Any additional parameters for the connection.

ConnectionOAuthClientResponseParameters

class ConnectionOAuthClientResponseParameters

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

ConnectionOAuthHttpMethod

sealed class ConnectionOAuthHttpMethod

ConnectionOAuthResponseParameters

class ConnectionOAuthResponseParameters

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

ConnectionQueryStringParameter

class ConnectionQueryStringParameter

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

ConnectionState

sealed class ConnectionState

ConnectivityResourceConfigurationArn

class ConnectivityResourceConfigurationArn

The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.

ConnectivityResourceParameters

class ConnectivityResourceParameters

The parameters for EventBridge to use when invoking the resource endpoint.

CreateApiDestinationRequest

class CreateApiDestinationRequest

CreateApiDestinationResponse

class CreateApiDestinationResponse

CreateArchiveRequest

class CreateArchiveRequest

CreateArchiveResponse

class CreateArchiveResponse

CreateConnectionApiKeyAuthRequestParameters

class CreateConnectionApiKeyAuthRequestParameters

The API key authorization parameters for the connection.

CreateConnectionAuthRequestParameters

class CreateConnectionAuthRequestParameters

The authorization parameters for the connection.

CreateConnectionBasicAuthRequestParameters

class CreateConnectionBasicAuthRequestParameters

Contains the Basic authorization parameters to use for the connection.

CreateConnectionOAuthClientRequestParameters

class CreateConnectionOAuthClientRequestParameters

The Basic authorization parameters to use for the connection.

CreateConnectionOAuthRequestParameters

class CreateConnectionOAuthRequestParameters

Contains the OAuth authorization parameters to use for the connection.

CreateConnectionRequest

class CreateConnectionRequest

CreateConnectionResponse

class CreateConnectionResponse

CreateEndpointRequest

class CreateEndpointRequest

CreateEndpointResponse

class CreateEndpointResponse

CreateEventBusRequest

class CreateEventBusRequest

CreateEventBusResponse

class CreateEventBusResponse

CreatePartnerEventSourceRequest

class CreatePartnerEventSourceRequest

CreatePartnerEventSourceResponse

class CreatePartnerEventSourceResponse

DeactivateEventSourceRequest

class DeactivateEventSourceRequest

DeactivateEventSourceResponse

class DeactivateEventSourceResponse

DeadLetterConfig

class DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

DeauthorizeConnectionRequest

class DeauthorizeConnectionRequest

DeauthorizeConnectionResponse

class DeauthorizeConnectionResponse

DeleteApiDestinationRequest

class DeleteApiDestinationRequest

DeleteApiDestinationResponse

class DeleteApiDestinationResponse

DeleteArchiveRequest

class DeleteArchiveRequest

DeleteArchiveResponse

class DeleteArchiveResponse

DeleteConnectionRequest

class DeleteConnectionRequest

DeleteConnectionResponse

class DeleteConnectionResponse

DeleteEndpointRequest

class DeleteEndpointRequest

DeleteEndpointResponse

class DeleteEndpointResponse

DeleteEventBusRequest

class DeleteEventBusRequest

DeleteEventBusResponse

class DeleteEventBusResponse

DeletePartnerEventSourceRequest

class DeletePartnerEventSourceRequest

DeletePartnerEventSourceResponse

class DeletePartnerEventSourceResponse

DeleteRuleRequest

class DeleteRuleRequest

DeleteRuleResponse

class DeleteRuleResponse

DescribeApiDestinationRequest

class DescribeApiDestinationRequest

DescribeApiDestinationResponse

class DescribeApiDestinationResponse

DescribeArchiveRequest

class DescribeArchiveRequest

DescribeArchiveResponse

class DescribeArchiveResponse

DescribeConnectionConnectivityParameters

class DescribeConnectionConnectivityParameters

If the connection uses a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

DescribeConnectionRequest

class DescribeConnectionRequest

DescribeConnectionResourceParameters

class DescribeConnectionResourceParameters

The parameters for EventBridge to use when invoking the resource endpoint.

DescribeConnectionResponse

class DescribeConnectionResponse

DescribeEndpointRequest

class DescribeEndpointRequest

DescribeEndpointResponse

class DescribeEndpointResponse

DescribeEventBusRequest

class DescribeEventBusRequest

DescribeEventBusResponse

class DescribeEventBusResponse

DescribeEventSourceRequest

class DescribeEventSourceRequest

DescribeEventSourceResponse

class DescribeEventSourceResponse

DescribePartnerEventSourceRequest

class DescribePartnerEventSourceRequest

DescribePartnerEventSourceResponse

class DescribePartnerEventSourceResponse

DescribeReplayRequest

class DescribeReplayRequest

DescribeReplayResponse

class DescribeReplayResponse

DescribeRuleRequest

class DescribeRuleRequest

DescribeRuleResponse

class DescribeRuleResponse

DisableRuleRequest

class DisableRuleRequest

DisableRuleResponse

class DisableRuleResponse

EcsParameters

class EcsParameters

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

EnableRuleRequest

class EnableRuleRequest

EnableRuleResponse

class EnableRuleResponse

Endpoint

class Endpoint

A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

EndpointEventBus

class EndpointEventBus

The event buses the endpoint is associated with.

EndpointState

sealed class EndpointState

EventBridgeException

open class EventBridgeException : AwsServiceException

Base class for all service related exceptions thrown by the EventBridge client

EventBus

class EventBus

An event bus receives events from a source, uses rules to evaluate them, applies any configured input transformation, and routes them to the appropriate target(s). 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

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

EventSourceState

sealed class EventSourceState

FailoverConfig

class FailoverConfig

The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

HttpParameters

class HttpParameters

These are custom parameter to be used when the target is an API Gateway 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.

IllegalStatusException

class IllegalStatusException : EventBridgeException

An error occurred because a replay can be canceled only when the state is Running or Starting.

InputTransformer

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

InternalException

class InternalException : EventBridgeException

This exception occurs due to unexpected causes.

InvalidEventPatternException

class InvalidEventPatternException : EventBridgeException

The event pattern is not valid.

InvalidStateException

class InvalidStateException : EventBridgeException

The specified state is not a valid state for an event source.

KinesisParameters

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

LaunchType

sealed class LaunchType

LimitExceededException

class LimitExceededException : EventBridgeException

The request failed because it attempted to create resource beyond the allowed service quota.

ListApiDestinationsRequest

class ListApiDestinationsRequest

ListApiDestinationsResponse

class ListApiDestinationsResponse

ListArchivesRequest

class ListArchivesRequest

ListArchivesResponse

class ListArchivesResponse

ListConnectionsRequest

class ListConnectionsRequest

ListConnectionsResponse

class ListConnectionsResponse

ListEndpointsRequest

class ListEndpointsRequest

ListEndpointsResponse

class ListEndpointsResponse

ListEventBusesRequest

class ListEventBusesRequest

ListEventBusesResponse

class ListEventBusesResponse

ListEventSourcesRequest

class ListEventSourcesRequest

ListEventSourcesResponse

class ListEventSourcesResponse

ListPartnerEventSourceAccountsRequest

class ListPartnerEventSourceAccountsRequest

ListPartnerEventSourceAccountsResponse

class ListPartnerEventSourceAccountsResponse

ListPartnerEventSourcesRequest

class ListPartnerEventSourcesRequest

ListPartnerEventSourcesResponse

class ListPartnerEventSourcesResponse

ListReplaysRequest

class ListReplaysRequest

ListReplaysResponse

class ListReplaysResponse

ListRuleNamesByTargetRequest

class ListRuleNamesByTargetRequest

ListRuleNamesByTargetResponse

class ListRuleNamesByTargetResponse

ListRulesRequest

class ListRulesRequest

ListRulesResponse

class ListRulesResponse

ListTagsForResourceRequest

class ListTagsForResourceRequest

ListTagsForResourceResponse

class ListTagsForResourceResponse

ListTargetsByRuleRequest

class ListTargetsByRuleRequest

ListTargetsByRuleResponse

class ListTargetsByRuleResponse

ManagedRuleException

class ManagedRuleException : EventBridgeException

This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

NetworkConfiguration

class NetworkConfiguration

This structure specifies the network configuration for an ECS task.

OperationDisabledException

class OperationDisabledException : EventBridgeException

The operation you are attempting is not available in this region.

PartnerEventSource

class PartnerEventSource

PartnerEventSourceAccount

class PartnerEventSourceAccount

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

PlacementConstraint

class PlacementConstraint

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

PlacementConstraintType

sealed class PlacementConstraintType

PlacementStrategy

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

PlacementStrategyType

sealed class PlacementStrategyType

PolicyLengthExceededException

class PolicyLengthExceededException : EventBridgeException

The event bus policy is too long. For more information, see the limits.

Primary

class Primary

The primary Region of the endpoint.

PropagateTags

sealed class PropagateTags

PutEventsRequest

class PutEventsRequest

PutEventsRequestEntry

class PutEventsRequestEntry

Represents an event to be submitted.

PutEventsResponse

class PutEventsResponse

PutEventsResultEntry

class PutEventsResultEntry

Represents the results of an event submitted to an event bus.

PutPartnerEventsRequest

class PutPartnerEventsRequest

PutPartnerEventsRequestEntry

class PutPartnerEventsRequestEntry

The details about an event generated by an SaaS partner.

PutPartnerEventsResponse

class PutPartnerEventsResponse

PutPartnerEventsResultEntry

class PutPartnerEventsResultEntry

The result of an event entry the partner submitted in this request. If the event was successfully submitted, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

PutPermissionRequest

class PutPermissionRequest

PutPermissionResponse

class PutPermissionResponse

PutRuleRequest

class PutRuleRequest

PutRuleResponse

class PutRuleResponse

PutTargetsRequest

class PutTargetsRequest

PutTargetsResponse

class PutTargetsResponse

PutTargetsResultEntry

class PutTargetsResultEntry

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

RedshiftDataParameters

class 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

class RemovePermissionRequest

RemovePermissionResponse

class RemovePermissionResponse

RemoveTargetsRequest

class RemoveTargetsRequest

RemoveTargetsResponse

class RemoveTargetsResponse

RemoveTargetsResultEntry

class RemoveTargetsResultEntry

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

Replay

class Replay

A Replay object that contains details about a replay.

ReplayDestination

class ReplayDestination

A ReplayDestination object that contains details about a replay.

ReplayState

sealed class ReplayState

ReplicationConfig

class ReplicationConfig

Endpoints can replicate all events to the secondary Region.

ReplicationState

sealed class ReplicationState

ResourceAlreadyExistsException

class ResourceAlreadyExistsException : EventBridgeException

The resource you are trying to create already exists.

ResourceNotFoundException

class ResourceNotFoundException : EventBridgeException

An entity that you specified does not exist.

RetryPolicy

class RetryPolicy

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

RoutingConfig

class RoutingConfig

The routing configuration of the endpoint.

Rule

class Rule

Contains information about a rule in Amazon EventBridge.

RuleState

sealed class RuleState

RunCommandParameters

class RunCommandParameters

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

RunCommandTarget

class 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

class SageMakerPipelineParameter

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

SageMakerPipelineParameters

class SageMakerPipelineParameters

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

Secondary

class Secondary

The secondary Region that processes events when failover is triggered or replication is enabled.

SqsParameters

class SqsParameters

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

StartReplayRequest

class StartReplayRequest

StartReplayResponse

class StartReplayResponse

Tag

class Tag

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

TagResourceRequest

class TagResourceRequest

TagResourceResponse

class TagResourceResponse

Target

class 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

class TestEventPatternRequest

TestEventPatternResponse

class TestEventPatternResponse

ThrottlingException

class ThrottlingException : EventBridgeException

This request cannot be completed due to throttling issues.

UntagResourceRequest

class UntagResourceRequest

UntagResourceResponse

class UntagResourceResponse

UpdateApiDestinationRequest