SDK for PHP 3.x

Client: Aws\EventBridge\EventBridgeClient
Service ID: eventbridge
Version: 2015-10-07

This page describes the parameters and results for the operations of the Amazon EventBridge (2015-10-07), and shows how to use the Aws\EventBridge\EventBridgeClient object to call the described operations. This documentation is specific to the 2015-10-07 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

ActivateEventSource ( array $params = [] )
Activates a partner event source that has been deactivated.
CancelReplay ( array $params = [] )
Cancels the specified replay.
CreateApiDestination ( array $params = [] )
Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
CreateArchive ( array $params = [] )
Creates an archive of events with the specified settings.
CreateConnection ( array $params = [] )
Creates a connection.
CreateEndpoint ( array $params = [] )
Creates a global endpoint.
CreateEventBus ( array $params = [] )
Creates a new event bus within your account.
CreatePartnerEventSource ( array $params = [] )
Called by an SaaS partner to create a partner event source.
DeactivateEventSource ( array $params = [] )
You can use this operation to temporarily stop receiving events from the specified partner event source.
DeauthorizeConnection ( array $params = [] )
Removes all authorization parameters from the connection.
DeleteApiDestination ( array $params = [] )
Deletes the specified API destination.
DeleteArchive ( array $params = [] )
Deletes the specified archive.
DeleteConnection ( array $params = [] )
Deletes a connection.
DeleteEndpoint ( array $params = [] )
Delete an existing global endpoint.
DeleteEventBus ( array $params = [] )
Deletes the specified custom event bus or partner event bus.
DeletePartnerEventSource ( array $params = [] )
This operation is used by SaaS partners to delete a partner event source.
DeleteRule ( array $params = [] )
Deletes the specified rule.
DescribeApiDestination ( array $params = [] )
Retrieves details about an API destination.
DescribeArchive ( array $params = [] )
Retrieves details about an archive.
DescribeConnection ( array $params = [] )
Retrieves details about a connection.
DescribeEndpoint ( array $params = [] )
Get the information about an existing global endpoint.
DescribeEventBus ( array $params = [] )
Displays details about an event bus in your account.
DescribeEventSource ( array $params = [] )
This operation lists details about a partner event source that is shared with your account.
DescribePartnerEventSource ( array $params = [] )
An SaaS partner can use this operation to list details about a partner event source that they have created.
DescribeReplay ( array $params = [] )
Retrieves details about a replay.
DescribeRule ( array $params = [] )
Describes the specified rule.
DisableRule ( array $params = [] )
Disables the specified rule.
EnableRule ( array $params = [] )
Enables the specified rule.
ListApiDestinations ( array $params = [] )
Retrieves a list of API destination in the account in the current Region.
ListArchives ( array $params = [] )
Lists your archives.
ListConnections ( array $params = [] )
Retrieves a list of connections from the account.
ListEndpoints ( array $params = [] )
List the global endpoints associated with this account.
ListEventBuses ( array $params = [] )
Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
ListEventSources ( array $params = [] )
You can use this to see all the partner event sources that have been shared with your Amazon Web Services account.
ListPartnerEventSourceAccounts ( array $params = [] )
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.
ListPartnerEventSources ( array $params = [] )
An SaaS partner can use this operation to list all the partner event source names that they have created.
ListReplays ( array $params = [] )
Lists your replays.
ListRuleNamesByTarget ( array $params = [] )
Lists the rules for the specified target.
ListRules ( array $params = [] )
Lists your Amazon EventBridge rules.
ListTagsForResource ( array $params = [] )
Displays the tags associated with an EventBridge resource.
ListTargetsByRule ( array $params = [] )
Lists the targets assigned to the specified rule.
PutEvents ( array $params = [] )
Sends custom events to Amazon EventBridge so that they can be matched to rules.
PutPartnerEvents ( array $params = [] )
This is used by SaaS partners to write events to a customer's partner event bus.
PutPermission ( array $params = [] )
Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus.
PutRule ( array $params = [] )
Creates or updates the specified rule.
PutTargets ( array $params = [] )
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
RemovePermission ( array $params = [] )
Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus.
RemoveTargets ( array $params = [] )
Removes the specified targets from the specified rule.
StartReplay ( array $params = [] )
Starts the specified replay.
TagResource ( array $params = [] )
Assigns one or more tags (key-value pairs) to the specified EventBridge resource.
TestEventPattern ( array $params = [] )
Tests whether the specified event pattern matches the provided event.
UntagResource ( array $params = [] )
Removes one or more tags from the specified EventBridge resource.
UpdateApiDestination ( array $params = [] )
Updates an API destination.
UpdateArchive ( array $params = [] )
Updates the specified archive.
UpdateConnection ( array $params = [] )
Updates settings for a connection.
UpdateEndpoint ( array $params = [] )
Update an existing endpoint.
UpdateEventBus ( array $params = [] )
Updates the specified event bus.

Operations

ActivateEventSource

$result = $client->activateEventSource([/* ... */]);
$promise = $client->activateEventSourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->activateEventSource([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the partner event source to activate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

ConcurrentModificationException:

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

InvalidStateException:

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

InternalException:

This exception occurs due to unexpected causes.

OperationDisabledException:

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

CancelReplay

$result = $client->cancelReplay([/* ... */]);
$promise = $client->cancelReplayAsync([/* ... */]);

Cancels the specified replay.

Parameter Syntax

$result = $client->cancelReplay([
    'ReplayName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ReplayName
Required: Yes
Type: string

The name of the replay to cancel.

Result Syntax

[
    'ReplayArn' => '<string>',
    'State' => 'STARTING|RUNNING|CANCELLING|COMPLETED|CANCELLED|FAILED',
    'StateReason' => '<string>',
]

Result Details

Members
ReplayArn
Type: string

The ARN of the replay to cancel.

State
Type: string

The current state of the replay.

StateReason
Type: string

The reason that the replay is in the current state.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

ConcurrentModificationException:

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

IllegalStatusException:

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

InternalException:

This exception occurs due to unexpected causes.

CreateApiDestination

$result = $client->createApiDestination([/* ... */]);
$promise = $client->createApiDestinationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createApiDestination([
    'ConnectionArn' => '<string>', // REQUIRED
    'Description' => '<string>',
    'HttpMethod' => 'POST|GET|HEAD|OPTIONS|PUT|PATCH|DELETE', // REQUIRED
    'InvocationEndpoint' => '<string>', // REQUIRED
    'InvocationRateLimitPerSecond' => <integer>,
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConnectionArn
Required: Yes
Type: string

The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

Description
Type: string

A description for the API destination to create.

HttpMethod
Required: Yes
Type: string

The method to use for the request to the HTTP invocation endpoint.

InvocationEndpoint
Required: Yes
Type: string

The URL to the HTTP invocation endpoint for the API destination.

InvocationRateLimitPerSecond
Type: int

The maximum number of requests per second to send to the HTTP invocation endpoint.

Name
Required: Yes
Type: string

The name for the API destination to create.

Result Syntax

[
    'ApiDestinationArn' => '<string>',
    'ApiDestinationState' => 'ACTIVE|INACTIVE',
    'CreationTime' => <DateTime>,
    'LastModifiedTime' => <DateTime>,
]

Result Details

Members
ApiDestinationArn
Type: string

The ARN of the API destination that was created by the request.

ApiDestinationState
Type: string

The state of the API destination that was created by the request.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp indicating the time that the API destination was created.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp indicating the time that the API destination was last modified.

Errors

ResourceAlreadyExistsException:

The resource you are trying to create already exists.

ResourceNotFoundException:

An entity that you specified does not exist.

LimitExceededException:

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

InternalException:

This exception occurs due to unexpected causes.

CreateArchive

$result = $client->createArchive([/* ... */]);
$promise = $client->createArchiveAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createArchive([
    'ArchiveName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'EventPattern' => '<string>',
    'EventSourceArn' => '<string>', // REQUIRED
    'RetentionDays' => <integer>,
]);

Parameter Details

Members
ArchiveName
Required: Yes
Type: string

The name for the archive to create.

Description
Type: string

A description for the archive.

EventPattern
Type: string

An event pattern to use to filter events sent to the archive.

EventSourceArn
Required: Yes
Type: string

The ARN of the event bus that sends events to the archive.

RetentionDays
Type: int

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

Result Syntax

[
    'ArchiveArn' => '<string>',
    'CreationTime' => <DateTime>,
    'State' => 'ENABLED|DISABLED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
    'StateReason' => '<string>',
]

Result Details

Members
ArchiveArn
Type: string

The ARN of the archive that was created.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the archive was created.

State
Type: string

The state of the archive that was created.

StateReason
Type: string

The reason that the archive is in the state.

Errors

ConcurrentModificationException:

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

ResourceAlreadyExistsException:

The resource you are trying to create already exists.

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

LimitExceededException:

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

InvalidEventPatternException:

The event pattern is not valid.

CreateConnection

$result = $client->createConnection([/* ... */]);
$promise = $client->createConnectionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createConnection([
    'AuthParameters' => [ // REQUIRED
        'ApiKeyAuthParameters' => [
            'ApiKeyName' => '<string>', // REQUIRED
            'ApiKeyValue' => '<string>', // REQUIRED
        ],
        'BasicAuthParameters' => [
            'Password' => '<string>', // REQUIRED
            'Username' => '<string>', // REQUIRED
        ],
        'InvocationHttpParameters' => [
            'BodyParameters' => [
                [
                    'IsValueSecret' => true || false,
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'HeaderParameters' => [
                [
                    'IsValueSecret' => true || false,
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'QueryStringParameters' => [
                [
                    'IsValueSecret' => true || false,
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'OAuthParameters' => [
            'AuthorizationEndpoint' => '<string>', // REQUIRED
            'ClientParameters' => [ // REQUIRED
                'ClientID' => '<string>', // REQUIRED
                'ClientSecret' => '<string>', // REQUIRED
            ],
            'HttpMethod' => 'GET|POST|PUT', // REQUIRED
            'OAuthHttpParameters' => [
                'BodyParameters' => [
                    [
                        'IsValueSecret' => true || false,
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'HeaderParameters' => [
                    [
                        'IsValueSecret' => true || false,
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'QueryStringParameters' => [
                    [
                        'IsValueSecret' => true || false,
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'AuthorizationType' => 'BASIC|OAUTH_CLIENT_CREDENTIALS|API_KEY', // REQUIRED
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
AuthParameters
Required: Yes
Type: CreateConnectionAuthRequestParameters structure

A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

AuthorizationType
Required: Yes
Type: string

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

Description
Type: string

A description for the connection to create.

Name
Required: Yes
Type: string

The name for the connection to create.

Result Syntax

[
    'ConnectionArn' => '<string>',
    'ConnectionState' => 'CREATING|UPDATING|DELETING|AUTHORIZED|DEAUTHORIZED|AUTHORIZING|DEAUTHORIZING',
    'CreationTime' => <DateTime>,
    'LastModifiedTime' => <DateTime>,
]

Result Details

Members
ConnectionArn
Type: string

The ARN of the connection that was created by the request.

ConnectionState
Type: string

The state of the connection that was created by the request.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was created.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last updated.

Errors

ResourceAlreadyExistsException:

The resource you are trying to create already exists.

LimitExceededException:

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

InternalException:

This exception occurs due to unexpected causes.

CreateEndpoint

$result = $client->createEndpoint([/* ... */]);
$promise = $client->createEndpointAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createEndpoint([
    'Description' => '<string>',
    'EventBuses' => [ // REQUIRED
        [
            'EventBusArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'ReplicationConfig' => [
        'State' => 'ENABLED|DISABLED',
    ],
    'RoleArn' => '<string>',
    'RoutingConfig' => [ // REQUIRED
        'FailoverConfig' => [ // REQUIRED
            'Primary' => [ // REQUIRED
                'HealthCheck' => '<string>', // REQUIRED
            ],
            'Secondary' => [ // REQUIRED
                'Route' => '<string>', // REQUIRED
            ],
        ],
    ],
]);

Parameter Details

Members
Description
Type: string

A description of the global endpoint.

EventBuses
Required: Yes
Type: Array of EndpointEventBus structures

Define the event buses used.

The names of the event buses must be identical in each Region.

Name
Required: Yes
Type: string

The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

ReplicationConfig
Type: ReplicationConfig structure

Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

RoleArn
Type: string

The ARN of the role used for replication.

RoutingConfig
Required: Yes
Type: RoutingConfig structure

Configure the routing policy, including the health check and secondary Region..

Result Syntax

[
    'Arn' => '<string>',
    'EventBuses' => [
        [
            'EventBusArn' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
    'ReplicationConfig' => [
        'State' => 'ENABLED|DISABLED',
    ],
    'RoleArn' => '<string>',
    'RoutingConfig' => [
        'FailoverConfig' => [
            'Primary' => [
                'HealthCheck' => '<string>',
            ],
            'Secondary' => [
                'Route' => '<string>',
            ],
        ],
    ],
    'State' => 'ACTIVE|CREATING|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED',
]

Result Details

Members
Arn
Type: string

The ARN of the endpoint that was created by this request.

EventBuses
Type: Array of EndpointEventBus structures

The event buses used by this request.

Name
Type: string

The name of the endpoint that was created by this request.

ReplicationConfig
Type: ReplicationConfig structure

Whether event replication was enabled or disabled by this request.

RoleArn
Type: string

The ARN of the role used by event replication for this request.

RoutingConfig
Type: RoutingConfig structure

The routing configuration defined by this request.

State
Type: string

The state of the endpoint that was created by this request.

Errors

ResourceAlreadyExistsException:

The resource you are trying to create already exists.

LimitExceededException:

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

InternalException:

This exception occurs due to unexpected causes.

CreateEventBus

$result = $client->createEventBus([/* ... */]);
$promise = $client->createEventBusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createEventBus([
    'DeadLetterConfig' => [
        'Arn' => '<string>',
    ],
    'Description' => '<string>',
    'EventSourceName' => '<string>',
    'KmsKeyIdentifier' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
DeadLetterConfig
Type: DeadLetterConfig structure

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

For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

Description
Type: string

The event bus description.

EventSourceName
Type: string

If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

KmsKeyIdentifier
Type: string

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.

For more information, see Managing keys in the Key Management Service Developer Guide.

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.

Name
Required: Yes
Type: string

The name of the new event bus.

Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

Tags
Type: Array of Tag structures

Tags to associate with the event bus.

Result Syntax

[
    'DeadLetterConfig' => [
        'Arn' => '<string>',
    ],
    'Description' => '<string>',
    'EventBusArn' => '<string>',
    'KmsKeyIdentifier' => '<string>',
]

Result Details

Members
DeadLetterConfig
Type: DeadLetterConfig structure

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

For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

Description
Type: string

The event bus description.

EventBusArn
Type: string

The ARN of the new event bus.

KmsKeyIdentifier
Type: string

The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

Errors

ResourceAlreadyExistsException:

The resource you are trying to create already exists.

ResourceNotFoundException:

An entity that you specified does not exist.

InvalidStateException:

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

InternalException:

This exception occurs due to unexpected causes.

ConcurrentModificationException:

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

LimitExceededException:

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

OperationDisabledException:

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

CreatePartnerEventSource

$result = $client->createPartnerEventSource([/* ... */]);
$promise = $client->createPartnerEventSourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createPartnerEventSource([
    'Account' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Account
Required: Yes
Type: string

The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.

Name
Required: Yes
Type: string

The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name . The Amazon Web Services account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.

Result Syntax

[
    'EventSourceArn' => '<string>',
]

Result Details

Members
EventSourceArn
Type: string

The ARN of the partner event source.

Errors

ResourceAlreadyExistsException:

The resource you are trying to create already exists.

InternalException:

This exception occurs due to unexpected causes.

ConcurrentModificationException:

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

LimitExceededException:

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

OperationDisabledException:

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

DeactivateEventSource

$result = $client->deactivateEventSource([/* ... */]);
$promise = $client->deactivateEventSourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deactivateEventSource([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the partner event source to deactivate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

ConcurrentModificationException:

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

InvalidStateException:

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

InternalException:

This exception occurs due to unexpected causes.

OperationDisabledException:

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

DeauthorizeConnection

$result = $client->deauthorizeConnection([/* ... */]);
$promise = $client->deauthorizeConnectionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deauthorizeConnection([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the connection to remove authorization from.

Result Syntax

[
    'ConnectionArn' => '<string>',
    'ConnectionState' => 'CREATING|UPDATING|DELETING|AUTHORIZED|DEAUTHORIZED|AUTHORIZING|DEAUTHORIZING',
    'CreationTime' => <DateTime>,
    'LastAuthorizedTime' => <DateTime>,
    'LastModifiedTime' => <DateTime>,
]

Result Details

Members
ConnectionArn
Type: string

The ARN of the connection that authorization was removed from.

ConnectionState
Type: string

The state of the connection.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was created.

LastAuthorizedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last authorized.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last updated.

Errors

ConcurrentModificationException:

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

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DeleteApiDestination

$result = $client->deleteApiDestination([/* ... */]);
$promise = $client->deleteApiDestinationAsync([/* ... */]);

Deletes the specified API destination.

Parameter Syntax

$result = $client->deleteApiDestination([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the destination to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConcurrentModificationException:

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

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DeleteArchive

$result = $client->deleteArchive([/* ... */]);
$promise = $client->deleteArchiveAsync([/* ... */]);

Deletes the specified archive.

Parameter Syntax

$result = $client->deleteArchive([
    'ArchiveName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ArchiveName
Required: Yes
Type: string

The name of the archive to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConcurrentModificationException:

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

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DeleteConnection

$result = $client->deleteConnection([/* ... */]);
$promise = $client->deleteConnectionAsync([/* ... */]);

Deletes a connection.

Parameter Syntax

$result = $client->deleteConnection([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the connection to delete.

Result Syntax

[
    'ConnectionArn' => '<string>',
    'ConnectionState' => 'CREATING|UPDATING|DELETING|AUTHORIZED|DEAUTHORIZED|AUTHORIZING|DEAUTHORIZING',
    'CreationTime' => <DateTime>,
    'LastAuthorizedTime' => <DateTime>,
    'LastModifiedTime' => <DateTime>,
]

Result Details

Members
ConnectionArn
Type: string

The ARN of the connection that was deleted.

ConnectionState
Type: string

The state of the connection before it was deleted.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was created.

LastAuthorizedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last authorized before it wa deleted.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last modified before it was deleted.

Errors

ConcurrentModificationException:

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

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DeleteEndpoint

$result = $client->deleteEndpoint([/* ... */]);
$promise = $client->deleteEndpointAsync([/* ... */]);

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 .

Parameter Syntax

$result = $client->deleteEndpoint([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the endpoint you want to delete. For example, "Name":"us-east-2-custom_bus_A-endpoint"..

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConcurrentModificationException:

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

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DeleteEventBus

$result = $client->deleteEventBus([/* ... */]);
$promise = $client->deleteEventBusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteEventBus([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the event bus to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

This exception occurs due to unexpected causes.

ConcurrentModificationException:

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

DeletePartnerEventSource

$result = $client->deletePartnerEventSource([/* ... */]);
$promise = $client->deletePartnerEventSourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deletePartnerEventSource([
    'Account' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Account
Required: Yes
Type: string

The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.

Name
Required: Yes
Type: string

The name of the event source to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

This exception occurs due to unexpected causes.

ConcurrentModificationException:

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

OperationDisabledException:

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

DeleteRule

$result = $client->deleteRule([/* ... */]);
$promise = $client->deleteRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteRule([
    'EventBusName' => '<string>',
    'Force' => true || false,
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
EventBusName
Type: string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Force
Type: boolean

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

Name
Required: Yes
Type: string

The name of the rule.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConcurrentModificationException:

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

ManagedRuleException:

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.

InternalException:

This exception occurs due to unexpected causes.

ResourceNotFoundException:

An entity that you specified does not exist.

DescribeApiDestination

$result = $client->describeApiDestination([/* ... */]);
$promise = $client->describeApiDestinationAsync([/* ... */]);

Retrieves details about an API destination.

Parameter Syntax

$result = $client->describeApiDestination([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the API destination to retrieve.

Result Syntax

[
    'ApiDestinationArn' => '<string>',
    'ApiDestinationState' => 'ACTIVE|INACTIVE',
    'ConnectionArn' => '<string>',
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'HttpMethod' => 'POST|GET|HEAD|OPTIONS|PUT|PATCH|DELETE',
    'InvocationEndpoint' => '<string>',
    'InvocationRateLimitPerSecond' => <integer>,
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
]

Result Details

Members
ApiDestinationArn
Type: string

The ARN of the API destination retrieved.

ApiDestinationState
Type: string

The state of the API destination retrieved.

ConnectionArn
Type: string

The ARN of the connection specified for the API destination retrieved.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the API destination was created.

Description
Type: string

The description for the API destination retrieved.

HttpMethod
Type: string

The method to use to connect to the HTTP endpoint.

InvocationEndpoint
Type: string

The URL to use to connect to the HTTP endpoint.

InvocationRateLimitPerSecond
Type: int

The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the API destination was last modified.

Name
Type: string

The name of the API destination retrieved.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DescribeArchive

$result = $client->describeArchive([/* ... */]);
$promise = $client->describeArchiveAsync([/* ... */]);

Retrieves details about an archive.

Parameter Syntax

$result = $client->describeArchive([
    'ArchiveName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ArchiveName
Required: Yes
Type: string

The name of the archive to retrieve.

Result Syntax

[
    'ArchiveArn' => '<string>',
    'ArchiveName' => '<string>',
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'EventCount' => <integer>,
    'EventPattern' => '<string>',
    'EventSourceArn' => '<string>',
    'RetentionDays' => <integer>,
    'SizeBytes' => <integer>,
    'State' => 'ENABLED|DISABLED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
    'StateReason' => '<string>',
]

Result Details

Members
ArchiveArn
Type: string

The ARN of the archive.

ArchiveName
Type: string

The name of the archive.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the archive was created.

Description
Type: string

The description of the archive.

EventCount
Type: long (int|float)

The number of events in the archive.

EventPattern
Type: string

The event pattern used to filter events sent to the archive.

EventSourceArn
Type: string

The ARN of the event source associated with the archive.

RetentionDays
Type: int

The number of days to retain events for in the archive.

SizeBytes
Type: long (int|float)

The size of the archive in bytes.

State
Type: string

The state of the archive.

StateReason
Type: string

The reason that the archive is in the state.

Errors

ResourceAlreadyExistsException:

The resource you are trying to create already exists.

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DescribeConnection

$result = $client->describeConnection([/* ... */]);
$promise = $client->describeConnectionAsync([/* ... */]);

Retrieves details about a connection.

Parameter Syntax

$result = $client->describeConnection([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the connection to retrieve.

Result Syntax

[
    'AuthParameters' => [
        'ApiKeyAuthParameters' => [
            'ApiKeyName' => '<string>',
        ],
        'BasicAuthParameters' => [
            'Username' => '<string>',
        ],
        'InvocationHttpParameters' => [
            'BodyParameters' => [
                [
                    'IsValueSecret' => true || false,
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'HeaderParameters' => [
                [
                    'IsValueSecret' => true || false,
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'QueryStringParameters' => [
                [
                    'IsValueSecret' => true || false,
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'OAuthParameters' => [
            'AuthorizationEndpoint' => '<string>',
            'ClientParameters' => [
                'ClientID' => '<string>',
            ],
            'HttpMethod' => 'GET|POST|PUT',
            'OAuthHttpParameters' => [
                'BodyParameters' => [
                    [
                        'IsValueSecret' => true || false,
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'HeaderParameters' => [
                    [
                        'IsValueSecret' => true || false,
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'QueryStringParameters' => [
                    [
                        'IsValueSecret' => true || false,
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'AuthorizationType' => 'BASIC|OAUTH_CLIENT_CREDENTIALS|API_KEY',
    'ConnectionArn' => '<string>',
    'ConnectionState' => 'CREATING|UPDATING|DELETING|AUTHORIZED|DEAUTHORIZED|AUTHORIZING|DEAUTHORIZING',
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'LastAuthorizedTime' => <DateTime>,
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
    'SecretArn' => '<string>',
    'StateReason' => '<string>',
]

Result Details

Members
AuthParameters

The parameters to use for authorization for the connection.

AuthorizationType
Type: string

The type of authorization specified for the connection.

ConnectionArn
Type: string

The ARN of the connection retrieved.

ConnectionState
Type: string

The state of the connection retrieved.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was created.

Description
Type: string

The description for the connection retrieved.

LastAuthorizedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last authorized.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last modified.

Name
Type: string

The name of the connection retrieved.

SecretArn
Type: string

The ARN of the secret created from the authorization parameters specified for the connection.

StateReason
Type: string

The reason that the connection is in the current connection state.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DescribeEndpoint

$result = $client->describeEndpoint([/* ... */]);
$promise = $client->describeEndpointAsync([/* ... */]);

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 .

Parameter Syntax

$result = $client->describeEndpoint([
    'HomeRegion' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
HomeRegion
Type: string

The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".

Name
Required: Yes
Type: string

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

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'EndpointId' => '<string>',
    'EndpointUrl' => '<string>',
    'EventBuses' => [
        [
            'EventBusArn' => '<string>',
        ],
        // ...
    ],
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
    'ReplicationConfig' => [
        'State' => 'ENABLED|DISABLED',
    ],
    'RoleArn' => '<string>',
    'RoutingConfig' => [
        'FailoverConfig' => [
            'Primary' => [
                'HealthCheck' => '<string>',
            ],
            'Secondary' => [
                'Route' => '<string>',
            ],
        ],
    ],
    'State' => 'ACTIVE|CREATING|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED',
    'StateReason' => '<string>',
]

Result Details

Members
Arn
Type: string

The ARN of the endpoint you asked for information about.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the endpoint you asked for information about was created.

Description
Type: string

The description of the endpoint you asked for information about.

EndpointId
Type: string

The ID of the endpoint you asked for information about.

EndpointUrl
Type: string

The URL of the endpoint you asked for information about.

EventBuses
Type: Array of EndpointEventBus structures

The event buses being used by the endpoint you asked for information about.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time the endpoint you asked for information about was modified.

Name
Type: string

The name of the endpoint you asked for information about.

ReplicationConfig
Type: ReplicationConfig structure

Whether replication is enabled or disabled for the endpoint you asked for information about.

RoleArn
Type: string

The ARN of the role used by the endpoint you asked for information about.

RoutingConfig
Type: RoutingConfig structure

The routing configuration of the endpoint you asked for information about.

State
Type: string

The current state of the endpoint you asked for information about.

StateReason
Type: string

The reason the endpoint you asked for information about is in its current state.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DescribeEventBus

$result = $client->describeEventBus([/* ... */]);
$promise = $client->describeEventBusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeEventBus([
    'Name' => '<string>',
]);

Parameter Details

Members
Name
Type: string

The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'DeadLetterConfig' => [
        'Arn' => '<string>',
    ],
    'Description' => '<string>',
    'KmsKeyIdentifier' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
    'Policy' => '<string>',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event bus was created.

DeadLetterConfig
Type: DeadLetterConfig structure

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

For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

Description
Type: string

The event bus description.

KmsKeyIdentifier
Type: string

The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event bus was last modified.

Name
Type: string

The name of the event bus. Currently, this is always default.

Policy
Type: string

The policy that enables the external account to send events to your account.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DescribeEventSource

$result = $client->describeEventSource([/* ... */]);
$promise = $client->describeEventSourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeEventSource([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the partner event source to display the details of.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedBy' => '<string>',
    'CreationTime' => <DateTime>,
    'ExpirationTime' => <DateTime>,
    'Name' => '<string>',
    'State' => 'PENDING|ACTIVE|DELETED',
]

Result Details

Members
Arn
Type: string

The ARN of the partner event source.

CreatedBy
Type: string

The name of the SaaS partner that created the event source.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the event source was created.

ExpirationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the event source will expire if you do not create a matching event bus.

Name
Type: string

The name of the partner event source.

State
Type: string

The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

OperationDisabledException:

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

DescribePartnerEventSource

$result = $client->describePartnerEventSource([/* ... */]);
$promise = $client->describePartnerEventSourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describePartnerEventSource([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the event source to display.

Result Syntax

[
    'Arn' => '<string>',
    'Name' => '<string>',
]

Result Details

Members
Arn
Type: string

The ARN of the event source.

Name
Type: string

The name of the event source.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

OperationDisabledException:

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

DescribeReplay

$result = $client->describeReplay([/* ... */]);
$promise = $client->describeReplayAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeReplay([
    'ReplayName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ReplayName
Required: Yes
Type: string

The name of the replay to retrieve.

Result Syntax

[
    'Description' => '<string>',
    'Destination' => [
        'Arn' => '<string>',
        'FilterArns' => ['<string>', ...],
    ],
    'EventEndTime' => <DateTime>,
    'EventLastReplayedTime' => <DateTime>,
    'EventSourceArn' => '<string>',
    'EventStartTime' => <DateTime>,
    'ReplayArn' => '<string>',
    'ReplayEndTime' => <DateTime>,
    'ReplayName' => '<string>',
    'ReplayStartTime' => <DateTime>,
    'State' => 'STARTING|RUNNING|CANCELLING|COMPLETED|CANCELLED|FAILED',
    'StateReason' => '<string>',
]

Result Details

Members
Description
Type: string

The description of the replay.

Destination
Type: ReplayDestination structure

A ReplayDestination object that contains details about the replay.

EventEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time stamp for the last event that was replayed from the archive.

EventLastReplayedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the event was last replayed.

EventSourceArn
Type: string

The ARN of the archive events were replayed from.

EventStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time stamp of the first event that was last replayed from the archive.

ReplayArn
Type: string

The ARN of the replay.

ReplayEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the replay stopped.

ReplayName
Type: string

The name of the replay.

ReplayStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the replay started.

State
Type: string

The current state of the replay.

StateReason
Type: string

The reason that the replay is in the current state.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DescribeRule

$result = $client->describeRule([/* ... */]);
$promise = $client->describeRuleAsync([/* ... */]);

Describes the specified rule.

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

Parameter Syntax

$result = $client->describeRule([
    'EventBusName' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
EventBusName
Type: string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Name
Required: Yes
Type: string

The name of the rule.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedBy' => '<string>',
    'Description' => '<string>',
    'EventBusName' => '<string>',
    'EventPattern' => '<string>',
    'ManagedBy' => '<string>',
    'Name' => '<string>',
    'RoleArn' => '<string>',
    'ScheduleExpression' => '<string>',
    'State' => 'ENABLED|DISABLED|ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the rule.

CreatedBy
Type: string

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Description
Type: string

The description of the rule.

EventBusName
Type: string

The name of the event bus associated with the rule.

EventPattern
Type: string

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

ManagedBy
Type: string

If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

Name
Type: string

The name of the rule.

RoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

ScheduleExpression
Type: string

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

State
Type: string

Specifies whether the rule is enabled or disabled.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

DisableRule

$result = $client->disableRule([/* ... */]);
$promise = $client->disableRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disableRule([
    'EventBusName' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
EventBusName
Type: string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Name
Required: Yes
Type: string

The name of the rule.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

ConcurrentModificationException:

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

ManagedRuleException:

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.

InternalException:

This exception occurs due to unexpected causes.

EnableRule

$result = $client->enableRule([/* ... */]);
$promise = $client->enableRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->enableRule([
    'EventBusName' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
EventBusName
Type: string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Name
Required: Yes
Type: string

The name of the rule.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

ConcurrentModificationException:

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

ManagedRuleException:

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.

InternalException:

This exception occurs due to unexpected causes.

ListApiDestinations

$result = $client->listApiDestinations([/* ... */]);
$promise = $client->listApiDestinationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listApiDestinations([
    'ConnectionArn' => '<string>',
    'Limit' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConnectionArn
Type: string

The ARN of the connection specified for the API destination.

Limit
Type: int

The maximum number of API destinations to include in the response.

NamePrefix
Type: string

A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.

NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

Result Syntax

[
    'ApiDestinations' => [
        [
            'ApiDestinationArn' => '<string>',
            'ApiDestinationState' => 'ACTIVE|INACTIVE',
            'ConnectionArn' => '<string>',
            'CreationTime' => <DateTime>,
            'HttpMethod' => 'POST|GET|HEAD|OPTIONS|PUT|PATCH|DELETE',
            'InvocationEndpoint' => '<string>',
            'InvocationRateLimitPerSecond' => <integer>,
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ApiDestinations
Type: Array of ApiDestination structures

An array of ApiDestination objects that include information about an API destination.

NextToken
Type: string

A token you can use in a subsequent request to retrieve the next set of results.

Errors

InternalException:

This exception occurs due to unexpected causes.

ListArchives

$result = $client->listArchives([/* ... */]);
$promise = $client->listArchivesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listArchives([
    'EventSourceArn' => '<string>',
    'Limit' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
    'State' => 'ENABLED|DISABLED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
]);

Parameter Details

Members
EventSourceArn
Type: string

The ARN of the event source associated with the archive.

Limit
Type: int

The maximum number of results to return.

NamePrefix
Type: string

A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

State
Type: string

The state of the archive.

Result Syntax

[
    'Archives' => [
        [
            'ArchiveName' => '<string>',
            'CreationTime' => <DateTime>,
            'EventCount' => <integer>,
            'EventSourceArn' => '<string>',
            'RetentionDays' => <integer>,
            'SizeBytes' => <integer>,
            'State' => 'ENABLED|DISABLED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
            'StateReason' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Archives
Type: Array of Archive structures

An array of Archive objects that include details about an archive.

NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

ListConnections

$result = $client->listConnections([/* ... */]);
$promise = $client->listConnectionsAsync([/* ... */]);

Retrieves a list of connections from the account.

Parameter Syntax

$result = $client->listConnections([
    'ConnectionState' => 'CREATING|UPDATING|DELETING|AUTHORIZED|DEAUTHORIZED|AUTHORIZING|DEAUTHORIZING',
    'Limit' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConnectionState
Type: string

The state of the connection.

Limit
Type: int

The maximum number of connections to return.

NamePrefix
Type: string

A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.

NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

Result Syntax

[
    'Connections' => [
        [
            'AuthorizationType' => 'BASIC|OAUTH_CLIENT_CREDENTIALS|API_KEY',
            'ConnectionArn' => '<string>',
            'ConnectionState' => 'CREATING|UPDATING|DELETING|AUTHORIZED|DEAUTHORIZED|AUTHORIZING|DEAUTHORIZING',
            'CreationTime' => <DateTime>,
            'LastAuthorizedTime' => <DateTime>,
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'StateReason' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Connections
Type: Array of Connection structures

An array of connections objects that include details about the connections.

NextToken
Type: string

A token you can use in a subsequent request to retrieve the next set of results.

Errors

InternalException:

This exception occurs due to unexpected causes.

ListEndpoints

$result = $client->listEndpoints([/* ... */]);
$promise = $client->listEndpointsAsync([/* ... */]);

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 .

Parameter Syntax

$result = $client->listEndpoints([
    'HomeRegion' => '<string>',
    'MaxResults' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members
HomeRegion
Type: string

The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".

MaxResults
Type: int

The maximum number of results returned by the call.

NamePrefix
Type: string

A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

NextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Result Syntax

[
    'Endpoints' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'EndpointId' => '<string>',
            'EndpointUrl' => '<string>',
            'EventBuses' => [
                [
                    'EventBusArn' => '<string>',
                ],
                // ...
            ],
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'ReplicationConfig' => [
                'State' => 'ENABLED|DISABLED',
            ],
            'RoleArn' => '<string>',
            'RoutingConfig' => [
                'FailoverConfig' => [
                    'Primary' => [
                        'HealthCheck' => '<string>',
                    ],
                    'Secondary' => [
                        'Route' => '<string>',
                    ],
                ],
            ],
            'State' => 'ACTIVE|CREATING|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED',
            'StateReason' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Endpoints
Type: Array of Endpoint structures

The endpoints returned by the call.

NextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Errors

InternalException:

This exception occurs due to unexpected causes.

ListEventBuses

$result = $client->listEventBuses([/* ... */]);
$promise = $client->listEventBusesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEventBuses([
    'Limit' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members
Limit
Type: int

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

NamePrefix
Type: string

Specifying this limits the results to only those event buses with names that start with the specified prefix.

NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

Result Syntax

[
    'EventBuses' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Policy' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
EventBuses
Type: Array of EventBus structures

This list of event buses.

NextToken
Type: string

A token you can use in a subsequent operation to retrieve the next set of results.

Errors

InternalException:

This exception occurs due to unexpected causes.

ListEventSources

$result = $client->listEventSources([/* ... */]);
$promise = $client->listEventSourcesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listEventSources([
    'Limit' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members
Limit
Type: int

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

NamePrefix
Type: string

Specifying this limits the results to only those partner event sources with names that start with the specified prefix.

NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

Result Syntax

[
    'EventSources' => [
        [
            'Arn' => '<string>',
            'CreatedBy' => '<string>',
            'CreationTime' => <DateTime>,
            'ExpirationTime' => <DateTime>,
            'Name' => '<string>',
            'State' => 'PENDING|ACTIVE|DELETED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
EventSources
Type: Array of EventSource structures

The list of event sources.

NextToken
Type: string

A token you can use in a subsequent operation to retrieve the next set of results.

Errors

InternalException:

This exception occurs due to unexpected causes.

OperationDisabledException:

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

ListPartnerEventSourceAccounts

$result = $client->listPartnerEventSourceAccounts([/* ... */]);
$promise = $client->listPartnerEventSourceAccountsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listPartnerEventSourceAccounts([
    'EventSourceName' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
EventSourceName
Required: Yes
Type: string

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

Limit
Type: int

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

NextToken
Type: string

The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'PartnerEventSourceAccounts' => [
        [
            'Account' => '<string>',
            'CreationTime' => <DateTime>,
            'ExpirationTime' => <DateTime>,
            'State' => 'PENDING|ACTIVE|DELETED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A token you can use in a subsequent operation to retrieve the next set of results.

PartnerEventSourceAccounts
Type: Array of PartnerEventSourceAccount structures

The list of partner event sources returned by the operation.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

OperationDisabledException:

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

ListPartnerEventSources

$result = $client->listPartnerEventSources([/* ... */]);
$promise = $client->listPartnerEventSourcesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listPartnerEventSources([
    'Limit' => <integer>,
    'NamePrefix' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members
Limit
Type: int

pecifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

NamePrefix
Required: Yes
Type: string

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

NextToken
Type: string

The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'PartnerEventSources' => [
        [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A token you can use in a subsequent operation to retrieve the next set of results.

PartnerEventSources
Type: Array of PartnerEventSource structures

The list of partner event sources returned by the operation.

Errors

InternalException:

This exception occurs due to unexpected causes.

OperationDisabledException:

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

ListReplays

$result = $client->listReplays([/* ... */]);
$promise = $client->listReplaysAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listReplays([
    'EventSourceArn' => '<string>',
    'Limit' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
    'State' => 'STARTING|RUNNING|CANCELLING|COMPLETED|CANCELLED|FAILED',
]);

Parameter Details

Members
EventSourceArn
Type: string

The ARN of the archive from which the events are replayed.

Limit
Type: int

The maximum number of replays to retrieve.

NamePrefix
Type: string

A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.

NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

State
Type: string

The state of the replay.

Result Syntax

[
    'NextToken' => '<string>',
    'Replays' => [
        [
            'EventEndTime' => <DateTime>,
            'EventLastReplayedTime' => <DateTime>,
            'EventSourceArn' => '<string>',
            'EventStartTime' => <DateTime>,
            'ReplayEndTime' => <DateTime>,
            'ReplayName' => '<string>',
            'ReplayStartTime' => <DateTime>,
            'State' => 'STARTING|RUNNING|CANCELLING|COMPLETED|CANCELLED|FAILED',
            'StateReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

Replays
Type: Array of Replay structures

An array of Replay objects that contain information about the replay.

Errors

InternalException:

This exception occurs due to unexpected causes.

ListRuleNamesByTarget

$result = $client->listRuleNamesByTarget([/* ... */]);
$promise = $client->listRuleNamesByTargetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listRuleNamesByTarget([
    'EventBusName' => '<string>',
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'TargetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
EventBusName
Type: string

The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.

Limit
Type: int

The maximum number of results to return.

NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

TargetArn
Required: Yes
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'RuleNames' => ['<string>', ...],
]

Result Details

Members
NextToken
Type: string

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

RuleNames
Type: Array of strings

The names of the rules that can invoke the given target.

Errors

InternalException:

This exception occurs due to unexpected causes.

ResourceNotFoundException:

An entity that you specified does not exist.

ListRules

$result = $client->listRules([/* ... */]);
$promise = $client->listRulesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listRules([
    'EventBusName' => '<string>',
    'Limit' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members
EventBusName
Type: string

The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.

Limit
Type: int

The maximum number of results to return.

NamePrefix
Type: string

The prefix matching the rule name.

NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'Rules' => [
        [
            'Arn' => '<string>',
            'Description' => '<string>',
            'EventBusName' => '<string>',
            'EventPattern' => '<string>',
            'ManagedBy' => '<string>',
            'Name' => '<string>',
            'RoleArn' => '<string>',
            'ScheduleExpression' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

Rules
Type: Array of Rule structures

The rules that match the specified criteria.

Errors

InternalException:

This exception occurs due to unexpected causes.

ResourceNotFoundException:

An entity that you specified does not exist.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the EventBridge resource for which you want to view tags.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
Type: Array of Tag structures

The list of tag keys and values associated with the resource you specified

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

ListTargetsByRule

$result = $client->listTargetsByRule([/* ... */]);
$promise = $client->listTargetsByRuleAsync([/* ... */]);

Lists the targets assigned to the specified rule.

The maximum number of results per page for requests is 100.

Parameter Syntax

$result = $client->listTargetsByRule([
    'EventBusName' => '<string>',
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'Rule' => '<string>', // REQUIRED
]);

Parameter Details

Members
EventBusName
Type: string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Limit
Type: int

The maximum number of results to return.

NextToken
Type: string

The token returned by a previous call to retrieve the next set of results.

Rule
Required: Yes
Type: string

The name of the rule.

Result Syntax

[
    'NextToken' => '<string>',
    'Targets' => [
        [
            'AppSyncParameters' => [
                'GraphQLOperation' => '<string>',
            ],
            'Arn' => '<string>',
            'BatchParameters' => [
                'ArrayProperties' => [
                    'Size' => <integer>,
                ],
                'JobDefinition' => '<string>',
                'JobName' => '<string>',
                'RetryStrategy' => [
                    'Attempts' => <integer>,
                ],
            ],
            'DeadLetterConfig' => [
                'Arn' => '<string>',
            ],
            'EcsParameters' => [
                'CapacityProviderStrategy' => [
                    [
                        'base' => <integer>,
                        'capacityProvider' => '<string>',
                        'weight' => <integer>,
                    ],
                    // ...
                ],
                'EnableECSManagedTags' => true || false,
                'EnableExecuteCommand' => true || false,
                'Group' => '<string>',
                'LaunchType' => 'EC2|FARGATE|EXTERNAL',
                'NetworkConfiguration' => [
                    'awsvpcConfiguration' => [
                        'AssignPublicIp' => 'ENABLED|DISABLED',
                        'SecurityGroups' => ['<string>', ...],
                        'Subnets' => ['<string>', ...],
                    ],
                ],
                'PlacementConstraints' => [
                    [
                        'expression' => '<string>',
                        'type' => 'distinctInstance|memberOf',
                    ],
                    // ...
                ],
                'PlacementStrategy' => [
                    [
                        'field' => '<string>',
                        'type' => 'random|spread|binpack',
                    ],
                    // ...
                ],
                'PlatformVersion' => '<string>',
                'PropagateTags' => 'TASK_DEFINITION',
                'ReferenceId' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'TaskCount' => <integer>,
                'TaskDefinitionArn' => '<string>',
            ],
            'HttpParameters' => [
                'HeaderParameters' => ['<string>', ...],
                'PathParameterValues' => ['<string>', ...],
                'QueryStringParameters' => ['<string>', ...],
            ],
            'Id' => '<string>',
            'Input' => '<string>',
            'InputPath' => '<string>',
            'InputTransformer' => [
                'InputPathsMap' => ['<string>', ...],
                'InputTemplate' => '<string>',
            ],
            'KinesisParameters' => [
                'PartitionKeyPath' => '<string>',
            ],
            'RedshiftDataParameters' => [
                'Database' => '<string>',
                'DbUser' => '<string>',
                'SecretManagerArn' => '<string>',
                'Sql' => '<string>',
                'Sqls' => ['<string>', ...],
                'StatementName' => '<string>',
                'WithEvent' => true || false,
            ],
            'RetryPolicy' => [
                'MaximumEventAgeInSeconds' => <integer>,
                'MaximumRetryAttempts' => <integer>,
            ],
            'RoleArn' => '<string>',
            'RunCommandParameters' => [
                'RunCommandTargets' => [
                    [
                        'Key' => '<string>',
                        'Values' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'SageMakerPipelineParameters' => [
                'PipelineParameterList' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'SqsParameters' => [
                'MessageGroupId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

Targets
Type: Array of Target structures

The targets assigned to the rule.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

PutEvents

$result = $client->putEvents([/* ... */]);
$promise = $client->putEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putEvents([
    'EndpointId' => '<string>',
    'Entries' => [ // REQUIRED
        [
            'Detail' => '<string>',
            'DetailType' => '<string>',
            'EventBusName' => '<string>',
            'Resources' => ['<string>', ...],
            'Source' => '<string>',
            'Time' => <integer || string || DateTime>,
            'TraceHeader' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
EndpointId
Type: string

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

When using Java, you must include auth-crt on the class path.

Entries
Required: Yes
Type: Array of PutEventsRequestEntry structures

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

Result Syntax

[
    'Entries' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'EventId' => '<string>',
        ],
        // ...
    ],
    'FailedEntryCount' => <integer>,
]

Result Details

Members
Entries
Type: Array of PutEventsResultEntry structures

The successfully and unsuccessfully ingested events results. If the ingestion was successful, 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.

For each record, the index of the response element is the same as the index in the request array.

FailedEntryCount
Type: int

The number of failed entries.

Errors

InternalException:

This exception occurs due to unexpected causes.

PutPartnerEvents

$result = $client->putPartnerEvents([/* ... */]);
$promise = $client->putPartnerEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putPartnerEvents([
    'Entries' => [ // REQUIRED
        [
            'Detail' => '<string>',
            'DetailType' => '<string>',
            'Resources' => ['<string>', ...],
            'Source' => '<string>',
            'Time' => <integer || string || DateTime>,
        ],
        // ...
    ],
]);

Parameter Details

Members
Entries
Required: Yes
Type: Array of PutPartnerEventsRequestEntry structures

The list of events to write to the event bus.

Result Syntax

[
    'Entries' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'EventId' => '<string>',
        ],
        // ...
    ],
    'FailedEntryCount' => <integer>,
]

Result Details

Members
Entries
Type: Array of PutPartnerEventsResultEntry structures

The results for each 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.

For each record, the index of the response element is the same as the index in the request array.

FailedEntryCount
Type: int

The number of events from this operation that could not be written to the partner event bus.

Errors

InternalException:

This exception occurs due to unexpected causes.

OperationDisabledException:

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

PutPermission

$result = $client->putPermission([/* ... */]);
$promise = $client->putPermissionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putPermission([
    'Action' => '<string>',
    'Condition' => [
        'Key' => '<string>', // REQUIRED
        'Type' => '<string>', // REQUIRED
        'Value' => '<string>', // REQUIRED
    ],
    'EventBusName' => '<string>',
    'Policy' => '<string>',
    'Principal' => '<string>',
    'StatementId' => '<string>',
]);

Parameter Details

Members
Action
Type: string

The action that you are enabling the other account to perform.

Condition
Type: Condition structure

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.

If you specify Condition with an Amazon Web Services organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

EventBusName
Type: string

The name of the event bus associated with the rule. If you omit this, the default event bus is used.

Policy
Type: string

A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.

Principal
Type: string

The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

StatementId
Type: string

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Each StatementId must be unique.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

PolicyLengthExceededException:

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

InternalException:

This exception occurs due to unexpected causes.

ConcurrentModificationException:

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

OperationDisabledException:

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

PutRule

$result = $client->putRule([/* ... */]);
$promise = $client->putRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putRule([
    'Description' => '<string>',
    'EventBusName' => '<string>',
    'EventPattern' => '<string>',
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>',
    'ScheduleExpression' => '<string>',
    'State' => 'ENABLED|DISABLED|ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Description
Type: string

A description of the rule.

EventBusName
Type: string

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

EventPattern
Type: string

The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .

Name
Required: Yes
Type: string

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

RoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

ScheduleExpression
Type: string

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

State
Type: string

The state of the rule.

Valid values include:

  • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

  • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

  • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

    Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .

    This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

Tags
Type: Array of Tag structures

The list of key-value pairs to associate with the rule.

Result Syntax

[
    'RuleArn' => '<string>',
]

Result Details

Members
RuleArn
Type: string

The Amazon Resource Name (ARN) of the rule.

Errors

InvalidEventPatternException:

The event pattern is not valid.

LimitExceededException:

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

ConcurrentModificationException:

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

ManagedRuleException:

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.

InternalException:

This exception occurs due to unexpected causes.

ResourceNotFoundException:

An entity that you specified does not exist.

PutTargets

$result = $client->putTargets([/* ... */]);
$promise = $client->putTargetsAsync([/* ... */]);

Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

The maximum number of entries per request is 10.

Each rule can have up to five (5) targets associated with it at one time.

For a list of services you can configure as targets for events, see EventBridge targets in the Amazon EventBridge User Guide .

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are:

  • Amazon EBS CreateSnapshot API call

  • Amazon EC2 RebootInstances API call

  • Amazon EC2 StopInstances API call

  • Amazon EC2 TerminateInstances API call

For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:

  • For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.

  • For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets.

For more information, see Authentication and Access Control in the Amazon EventBridge User Guide .

If another Amazon Web Services account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing.

Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services account.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

If you have an IAM role on a cross-account event bus target, a PutTargets call without a role on the same target (same Id and Arn) will not remove the role.

For more information about enabling cross-account events, see PutPermission.

Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

  • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).

  • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.

  • If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).

  • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.

When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

Parameter Syntax

$result = $client->putTargets([
    'EventBusName' => '<string>',
    'Rule' => '<string>', // REQUIRED
    'Targets' => [ // REQUIRED
        [
            'AppSyncParameters' => [
                'GraphQLOperation' => '<string>',
            ],
            'Arn' => '<string>', // REQUIRED
            'BatchParameters' => [
                'ArrayProperties' => [
                    'Size' => <integer>,
                ],
                'JobDefinition' => '<string>', // REQUIRED
                'JobName' => '<string>', // REQUIRED
                'RetryStrategy' => [
                    'Attempts' => <integer>,
                ],
            ],
            'DeadLetterConfig' => [
                'Arn' => '<string>',
            ],
            'EcsParameters' => [
                'CapacityProviderStrategy' => [
                    [
                        'base' => <integer>,
                        'capacityProvider' => '<string>', // REQUIRED
                        'weight' => <integer>,
                    ],
                    // ...
                ],
                'EnableECSManagedTags' => true || false,
                'EnableExecuteCommand' => true || false,
                'Group' => '<string>',
                'LaunchType' => 'EC2|FARGATE|EXTERNAL',
                'NetworkConfiguration' => [
                    'awsvpcConfiguration' => [
                        'AssignPublicIp' => 'ENABLED|DISABLED',
                        'SecurityGroups' => ['<string>', ...],
                        'Subnets' => ['<string>', ...], // REQUIRED
                    ],
                ],
                'PlacementConstraints' => [
                    [
                        'expression' => '<string>',
                        'type' => 'distinctInstance|memberOf',
                    ],
                    // ...
                ],
                'PlacementStrategy' => [
                    [
                        'field' => '<string>',
                        'type' => 'random|spread|binpack',
                    ],
                    // ...
                ],
                'PlatformVersion' => '<string>',
                'PropagateTags' => 'TASK_DEFINITION',
                'ReferenceId' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'TaskCount' => <integer>,
                'TaskDefinitionArn' => '<string>', // REQUIRED
            ],
            'HttpParameters' => [
                'HeaderParameters' => ['<string>', ...],
                'PathParameterValues' => ['<string>', ...],
                'QueryStringParameters' => ['<string>', ...],
            ],
            'Id' => '<string>', // REQUIRED
            'Input' => '<string>',
            'InputPath' => '<string>',
            'InputTransformer' => [
                'InputPathsMap' => ['<string>', ...],
                'InputTemplate' => '<string>', // REQUIRED
            ],
            'KinesisParameters' => [
                'PartitionKeyPath' => '<string>', // REQUIRED
            ],
            'RedshiftDataParameters' => [
                'Database' => '<string>', // REQUIRED
                'DbUser' => '<string>',
                'SecretManagerArn' => '<string>',
                'Sql' => '<string>',
                'Sqls' => ['<string>', ...],
                'StatementName' => '<string>',
                'WithEvent' => true || false,
            ],
            'RetryPolicy' => [
                'MaximumEventAgeInSeconds' => <integer>,
                'MaximumRetryAttempts' => <integer>,
            ],
            'RoleArn' => '<string>',
            'RunCommandParameters' => [
                'RunCommandTargets' => [ // REQUIRED
                    [
                        'Key' => '<string>', // REQUIRED
                        'Values' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
            ],
            'SageMakerPipelineParameters' => [
                'PipelineParameterList' => [
                    [
                        'Name' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'SqsParameters' => [
                'MessageGroupId' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
EventBusName
Type: string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Rule
Required: Yes
Type: string

The name of the rule.

Targets
Required: Yes
Type: Array of Target structures

The targets to update or add to the rule.

Result Syntax

[
    'FailedEntries' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'TargetId' => '<string>',
        ],
        // ...
    ],
    'FailedEntryCount' => <integer>,
]

Result Details

Members
FailedEntries
Type: Array of PutTargetsResultEntry structures

The failed target entries.

FailedEntryCount
Type: int

The number of failed entries.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

ConcurrentModificationException:

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

LimitExceededException:

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

ManagedRuleException:

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.

InternalException:

This exception occurs due to unexpected causes.

RemovePermission

$result = $client->removePermission([/* ... */]);
$promise = $client->removePermissionAsync([/* ... */]);

Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.

Parameter Syntax

$result = $client->removePermission([
    'EventBusName' => '<string>',
    'RemoveAllPermissions' => true || false,
    'StatementId' => '<string>',
]);

Parameter Details

Members
EventBusName
Type: string

The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.

RemoveAllPermissions
Type: boolean

Specifies whether to remove all permissions.

StatementId
Type: string

The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

ConcurrentModificationException:

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

OperationDisabledException:

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

RemoveTargets

$result = $client->removeTargets([/* ... */]);
$promise = $client->removeTargetsAsync([/* ... */]);

Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

A successful execution of RemoveTargets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.

When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

The maximum number of entries per request is 10.

Parameter Syntax

$result = $client->removeTargets([
    'EventBusName' => '<string>',
    'Force' => true || false,
    'Ids' => ['<string>', ...], // REQUIRED
    'Rule' => '<string>', // REQUIRED
]);

Parameter Details

Members
EventBusName
Type: string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Force
Type: boolean

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

Ids
Required: Yes
Type: Array of strings

The IDs of the targets to remove from the rule.

Rule
Required: Yes
Type: string

The name of the rule.

Result Syntax

[
    'FailedEntries' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'TargetId' => '<string>',
        ],
        // ...
    ],
    'FailedEntryCount' => <integer>,
]

Result Details

Members
FailedEntries
Type: Array of RemoveTargetsResultEntry structures

The failed target entries.

FailedEntryCount
Type: int

The number of failed entries.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

ConcurrentModificationException:

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

ManagedRuleException:

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.

InternalException:

This exception occurs due to unexpected causes.

StartReplay

$result = $client->startReplay([/* ... */]);
$promise = $client->startReplayAsync([/* ... */]);

Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

Parameter Syntax

$result = $client->startReplay([
    'Description' => '<string>',
    'Destination' => [ // REQUIRED
        'Arn' => '<string>', // REQUIRED
        'FilterArns' => ['<string>', ...],
    ],
    'EventEndTime' => <integer || string || DateTime>, // REQUIRED
    'EventSourceArn' => '<string>', // REQUIRED
    'EventStartTime' => <integer || string || DateTime>, // REQUIRED
    'ReplayName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
Type: string

A description for the replay to start.

Destination
Required: Yes
Type: ReplayDestination structure

A ReplayDestination object that includes details about the destination for the replay.

EventEndTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

EventSourceArn
Required: Yes
Type: string

The ARN of the archive to replay events from.

EventStartTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

ReplayName
Required: Yes
Type: string

The name of the replay to start.

Result Syntax

[
    'ReplayArn' => '<string>',
    'ReplayStartTime' => <DateTime>,
    'State' => 'STARTING|RUNNING|CANCELLING|COMPLETED|CANCELLED|FAILED',
    'StateReason' => '<string>',
]

Result Details

Members
ReplayArn
Type: string

The ARN of the replay.

ReplayStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the replay started.

State
Type: string

The state of the replay.

StateReason
Type: string

The reason that the replay is in the state.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

ResourceAlreadyExistsException:

The resource you are trying to create already exists.

InvalidEventPatternException:

The event pattern is not valid.

LimitExceededException:

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

InternalException:

This exception occurs due to unexpected causes.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the EventBridge resource that you're adding tags to.

Tags
Required: Yes
Type: Array of Tag structures

The list of key-value pairs to associate with the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

ConcurrentModificationException:

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

InternalException:

This exception occurs due to unexpected causes.

ManagedRuleException:

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.

TestEventPattern

$result = $client->testEventPattern([/* ... */]);
$promise = $client->testEventPatternAsync([/* ... */]);

Tests whether the specified event pattern matches the provided event.

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

Parameter Syntax

$result = $client->testEventPattern([
    'Event' => '<string>', // REQUIRED
    'EventPattern' => '<string>', // REQUIRED
]);

Parameter Details

Members
Event
Required: Yes
Type: string

The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in Amazon Web Services Events, and the following fields are mandatory:

  • id

  • account

  • source

  • time

  • region

  • resources

  • detail-type

EventPattern
Required: Yes
Type: string

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

Result Syntax

[
    'Result' => true || false,
]

Result Details

Members
Result
Type: boolean

Indicates whether the event matches the event pattern.

Errors

InvalidEventPatternException:

The event pattern is not valid.

InternalException:

This exception occurs due to unexpected causes.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the EventBridge resource from which you are removing tags.

TagKeys
Required: Yes
Type: Array of strings

The list of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

ConcurrentModificationException:

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

ManagedRuleException:

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.

UpdateApiDestination

$result = $client->updateApiDestination([/* ... */]);
$promise = $client->updateApiDestinationAsync([/* ... */]);

Updates an API destination.

Parameter Syntax

$result = $client->updateApiDestination([
    'ConnectionArn' => '<string>',
    'Description' => '<string>',
    'HttpMethod' => 'POST|GET|HEAD|OPTIONS|PUT|PATCH|DELETE',
    'InvocationEndpoint' => '<string>',
    'InvocationRateLimitPerSecond' => <integer>,
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConnectionArn
Type: string

The ARN of the connection to use for the API destination.

Description
Type: string

The name of the API destination to update.

HttpMethod
Type: string

The method to use for the API destination.

InvocationEndpoint
Type: string

The URL to the endpoint to use for the API destination.

InvocationRateLimitPerSecond
Type: int

The maximum number of invocations per second to send to the API destination.

Name
Required: Yes
Type: string

The name of the API destination to update.

Result Syntax

[
    'ApiDestinationArn' => '<string>',
    'ApiDestinationState' => 'ACTIVE|INACTIVE',
    'CreationTime' => <DateTime>,
    'LastModifiedTime' => <DateTime>,
]

Result Details

Members
ApiDestinationArn
Type: string

The ARN of the API destination that was updated.

ApiDestinationState
Type: string

The state of the API destination that was updated.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the API destination was created.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the API destination was last modified.

Errors

ConcurrentModificationException:

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

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

LimitExceededException:

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

UpdateArchive

$result = $client->updateArchive([/* ... */]);
$promise = $client->updateArchiveAsync([/* ... */]);

Updates the specified archive.

Parameter Syntax

$result = $client->updateArchive([
    'ArchiveName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'EventPattern' => '<string>',
    'RetentionDays' => <integer>,
]);

Parameter Details

Members
ArchiveName
Required: Yes
Type: string

The name of the archive to update.

Description
Type: string

The description for the archive.

EventPattern
Type: string

The event pattern to use to filter events sent to the archive.

RetentionDays
Type: int

The number of days to retain events in the archive.

Result Syntax

[
    'ArchiveArn' => '<string>',
    'CreationTime' => <DateTime>,
    'State' => 'ENABLED|DISABLED|CREATING|UPDATING|CREATE_FAILED|UPDATE_FAILED',
    'StateReason' => '<string>',
]

Result Details

Members
ArchiveArn
Type: string

The ARN of the archive.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the archive was updated.

State
Type: string

The state of the archive.

StateReason
Type: string

The reason that the archive is in the current state.

Errors

ConcurrentModificationException:

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

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

LimitExceededException:

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

InvalidEventPatternException:

The event pattern is not valid.

UpdateConnection

$result = $client->updateConnection([/* ... */]);
$promise = $client->updateConnectionAsync([/* ... */]);

Updates settings for a connection.

Parameter Syntax

$result = $client->updateConnection([
    'AuthParameters' => [
        'ApiKeyAuthParameters' => [
            'ApiKeyName' => '<string>',
            'ApiKeyValue' => '<string>',
        ],
        'BasicAuthParameters' => [
            'Password' => '<string>',
            'Username' => '<string>',
        ],
        'InvocationHttpParameters' => [
            'BodyParameters' => [
                [
                    'IsValueSecret' => true || false,
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'HeaderParameters' => [
                [
                    'IsValueSecret' => true || false,
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'QueryStringParameters' => [
                [
                    'IsValueSecret' => true || false,
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'OAuthParameters' => [
            'AuthorizationEndpoint' => '<string>',
            'ClientParameters' => [
                'ClientID' => '<string>',
                'ClientSecret' => '<string>',
            ],
            'HttpMethod' => 'GET|POST|PUT',
            'OAuthHttpParameters' => [
                'BodyParameters' => [
                    [
                        'IsValueSecret' => true || false,
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'HeaderParameters' => [
                    [
                        'IsValueSecret' => true || false,
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'QueryStringParameters' => [
                    [
                        'IsValueSecret' => true || false,
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'AuthorizationType' => 'BASIC|OAUTH_CLIENT_CREDENTIALS|API_KEY',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
AuthParameters

The authorization parameters to use for the connection.

AuthorizationType
Type: string

The type of authorization to use for the connection.

Description
Type: string

A description for the connection.

Name
Required: Yes
Type: string

The name of the connection to update.

Result Syntax

[
    'ConnectionArn' => '<string>',
    'ConnectionState' => 'CREATING|UPDATING|DELETING|AUTHORIZED|DEAUTHORIZED|AUTHORIZING|DEAUTHORIZING',
    'CreationTime' => <DateTime>,
    'LastAuthorizedTime' => <DateTime>,
    'LastModifiedTime' => <DateTime>,
]

Result Details

Members
ConnectionArn
Type: string

The ARN of the connection that was updated.

ConnectionState
Type: string

The state of the connection that was updated.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was created.

LastAuthorizedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last authorized.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last modified.

Errors

ConcurrentModificationException:

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

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

LimitExceededException:

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

UpdateEndpoint

$result = $client->updateEndpoint([/* ... */]);
$promise = $client->updateEndpointAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateEndpoint([
    'Description' => '<string>',
    'EventBuses' => [
        [
            'EventBusArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'ReplicationConfig' => [
        'State' => 'ENABLED|DISABLED',
    ],
    'RoleArn' => '<string>',
    'RoutingConfig' => [
        'FailoverConfig' => [ // REQUIRED
            'Primary' => [ // REQUIRED
                'HealthCheck' => '<string>', // REQUIRED
            ],
            'Secondary' => [ // REQUIRED
                'Route' => '<string>', // REQUIRED
            ],
        ],
    ],
]);

Parameter Details

Members
Description
Type: string

A description for the endpoint.

EventBuses
Type: Array of EndpointEventBus structures

Define event buses used for replication.

Name
Required: Yes
Type: string

The name of the endpoint you want to update.

ReplicationConfig
Type: ReplicationConfig structure

Whether event replication was enabled or disabled by this request.

RoleArn
Type: string

The ARN of the role used by event replication for this request.

RoutingConfig
Type: RoutingConfig structure

Configure the routing policy, including the health check and secondary Region.

Result Syntax

[
    'Arn' => '<string>',
    'EndpointId' => '<string>',
    'EndpointUrl' => '<string>',
    'EventBuses' => [
        [
            'EventBusArn' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
    'ReplicationConfig' => [
        'State' => 'ENABLED|DISABLED',
    ],
    'RoleArn' => '<string>',
    'RoutingConfig' => [
        'FailoverConfig' => [
            'Primary' => [
                'HealthCheck' => '<string>',
            ],
            'Secondary' => [
                'Route' => '<string>',
            ],
        ],
    ],
    'State' => 'ACTIVE|CREATING|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED',
]

Result Details

Members
Arn
Type: string

The ARN of the endpoint you updated in this request.

EndpointId
Type: string

The ID of the endpoint you updated in this request.

EndpointUrl
Type: string

The URL of the endpoint you updated in this request.

EventBuses
Type: Array of EndpointEventBus structures

The event buses used for replication for the endpoint you updated in this request.

Name
Type: string

The name of the endpoint you updated in this request.

ReplicationConfig
Type: ReplicationConfig structure

Whether event replication was enabled or disabled for the endpoint you updated in this request.

RoleArn
Type: string

The ARN of the role used by event replication for the endpoint you updated in this request.

RoutingConfig
Type: RoutingConfig structure

The routing configuration you updated in this request.

State
Type: string

The state of the endpoint you updated in this request.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

ConcurrentModificationException:

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

InternalException:

This exception occurs due to unexpected causes.

UpdateEventBus

$result = $client->updateEventBus([/* ... */]);
$promise = $client->updateEventBusAsync([/* ... */]);

Updates the specified event bus.

Parameter Syntax

$result = $client->updateEventBus([
    'DeadLetterConfig' => [
        'Arn' => '<string>',
    ],
    'Description' => '<string>',
    'KmsKeyIdentifier' => '<string>',
    'Name' => '<string>',
]);

Parameter Details

Members
DeadLetterConfig
Type: DeadLetterConfig structure

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

For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

Description
Type: string

The event bus description.

KmsKeyIdentifier
Type: string

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.

For more information, see Managing keys in the Key Management Service Developer Guide.

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.

Name
Type: string

The name of the event bus.

Result Syntax

[
    'Arn' => '<string>',
    'DeadLetterConfig' => [
        'Arn' => '<string>',
    ],
    'Description' => '<string>',
    'KmsKeyIdentifier' => '<string>',
    'Name' => '<string>',
]

Result Details

Members
Arn
Type: string

The event bus Amazon Resource Name (ARN).

DeadLetterConfig
Type: DeadLetterConfig structure

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

For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

Description
Type: string

The event bus description.

KmsKeyIdentifier
Type: string

The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

Name
Type: string

The event bus name.

Errors

ResourceNotFoundException:

An entity that you specified does not exist.

InternalException:

This exception occurs due to unexpected causes.

ConcurrentModificationException:

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

OperationDisabledException:

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

Shapes

ApiDestination

Description

Contains details about an API destination.

Members
ApiDestinationArn
Type: string

The ARN of the API destination.

ApiDestinationState
Type: string

The state of the API destination.

ConnectionArn
Type: string

The ARN of the connection specified for the API destination.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the API destination was created.

HttpMethod
Type: string

The method to use to connect to the HTTP endpoint.

InvocationEndpoint
Type: string

The URL to the endpoint for the API destination.

InvocationRateLimitPerSecond
Type: int

The maximum number of invocations per second to send to the HTTP endpoint.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the API destination was last modified.

Name
Type: string

The name of the API destination.

AppSyncParameters

Description

Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.

Members
GraphQLOperation
Type: string

The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

For more information, see Operations in the AppSync User Guide.

Archive

Description

An Archive object that contains details about an archive.

Members
ArchiveName
Type: string

The name of the archive.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time stamp for the time that the archive was created.

EventCount
Type: long (int|float)

The number of events in the archive.

EventSourceArn
Type: string

The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.

RetentionDays
Type: int

The number of days to retain events in the archive before they are deleted.

SizeBytes
Type: long (int|float)

The size of the archive, in bytes.

State
Type: string

The current state of the archive.

StateReason
Type: string

A description for the reason that the archive is in the current state.

AwsVpcConfiguration

Description

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.

Members
AssignPublicIp
Type: string

Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.

SecurityGroups
Type: Array of strings

Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.

Subnets
Required: Yes
Type: Array of strings

Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

BatchArrayProperties

Description

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.

Members
Size
Type: int

The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

BatchParameters

Description

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

Members
ArrayProperties
Type: BatchArrayProperties structure

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.

JobDefinition
Required: Yes
Type: string

The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

JobName
Required: Yes
Type: string

The name to use for this execution of the job, if the target is an Batch job.

RetryStrategy
Type: BatchRetryStrategy structure

The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

BatchRetryStrategy

Description

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.

Members
Attempts
Type: int

The number of times to attempt to retry, if the job fails. Valid values are 1–10.

CapacityProviderStrategyItem

Description

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

Members
base
Type: int

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

capacityProvider
Required: Yes
Type: string

The short name of the capacity provider.

weight
Type: int

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

ConcurrentModificationException

Description

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

Members

Condition

Description

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:

'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'

Members
Key
Required: Yes
Type: string

Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID.

Type
Required: Yes
Type: string

Specifies the type of condition. Currently the only supported value is StringEquals.

Value
Required: Yes
Type: string

Specifies the value for the key. Currently, this must be the ID of the organization.

Connection

Description

Contains information about a connection.

Members
AuthorizationType
Type: string

The authorization type specified for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

ConnectionArn
Type: string

The ARN of the connection.

ConnectionState
Type: string

The state of the connection.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was created.

LastAuthorizedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last authorized.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the connection was last modified.

Name
Type: string

The name of the connection.

StateReason
Type: string

The reason that the connection is in the connection state.

ConnectionApiKeyAuthResponseParameters

Description

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

Members
ApiKeyName
Type: string

The name of the header to use for the APIKeyValue used for authorization.

ConnectionAuthResponseParameters

Description

Contains the authorization parameters to use for the connection.

Members
ApiKeyAuthParameters

The API Key parameters to use for authorization.

BasicAuthParameters

The authorization parameters for Basic authorization.

InvocationHttpParameters
Type: ConnectionHttpParameters structure

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

OAuthParameters

The OAuth parameters to use for authorization.

ConnectionBasicAuthResponseParameters

Description

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

Members
Username
Type: string

The user name to use for Basic authorization.

ConnectionBodyParameter

Description

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

Members
IsValueSecret
Type: boolean

Specified whether the value is secret.

Key
Type: string

The key for the parameter.

Value
Type: string

The value associated with the key.

ConnectionHeaderParameter

Description

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

Members
IsValueSecret
Type: boolean

Specified whether the value is a secret.

Key
Type: string

The key for the parameter.

Value
Type: string

The value associated with the key.

ConnectionHttpParameters

Description

Contains additional parameters for the connection.

Members
BodyParameters
Type: Array of ConnectionBodyParameter structures

Contains additional body string parameters for the connection.

HeaderParameters
Type: Array of ConnectionHeaderParameter structures

Contains additional header parameters for the connection.

QueryStringParameters
Type: Array of ConnectionQueryStringParameter structures

Contains additional query string parameters for the connection.

ConnectionOAuthClientResponseParameters

Description

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

Members
ClientID
Type: string

The client ID associated with the response to the connection request.

ConnectionOAuthResponseParameters

Description

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

Members
AuthorizationEndpoint
Type: string

The URL to the HTTP endpoint that authorized the request.

ClientParameters

A ConnectionOAuthClientResponseParameters object that contains details about the client parameters returned when OAuth is specified as the authorization type.

HttpMethod
Type: string

The method used to connect to the HTTP endpoint.

OAuthHttpParameters
Type: ConnectionHttpParameters structure

The additional HTTP parameters used for the OAuth authorization request.

ConnectionQueryStringParameter

Description

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.

Members
IsValueSecret
Type: boolean

Specifies whether the value is secret.

Key
Type: string

The key for a query string parameter.

Value
Type: string

The value associated with the key for the query string parameter.

CreateConnectionApiKeyAuthRequestParameters

Description

Contains the API key authorization parameters for the connection.

Members
ApiKeyName
Required: Yes
Type: string

The name of the API key to use for authorization.

ApiKeyValue
Required: Yes
Type: string

The value for the API key to use for authorization.

CreateConnectionAuthRequestParameters

Description

Contains the authorization parameters for the connection.

Members
ApiKeyAuthParameters

A CreateConnectionApiKeyAuthRequestParameters object that contains the API key authorization parameters to use for the connection.

BasicAuthParameters

A CreateConnectionBasicAuthRequestParameters object that contains the Basic authorization parameters to use for the connection.

InvocationHttpParameters
Type: ConnectionHttpParameters structure

A ConnectionHttpParameters object that contains the API key authorization parameters to use for the connection. Note that if you include additional parameters for the target of a rule via HttpParameters, including query strings, the parameters added for the connection take precedence.

OAuthParameters

A CreateConnectionOAuthRequestParameters object that contains the OAuth authorization parameters to use for the connection.

CreateConnectionBasicAuthRequestParameters

Description

Contains the Basic authorization parameters to use for the connection.

Members
Password
Required: Yes
Type: string

The password associated with the user name to use for Basic authorization.

Username
Required: Yes
Type: string

The user name to use for Basic authorization.

CreateConnectionOAuthClientRequestParameters

Description

Contains the Basic authorization parameters to use for the connection.

Members
ClientID
Required: Yes
Type: string

The client ID to use for OAuth authorization for the connection.

ClientSecret
Required: Yes
Type: string

The client secret associated with the client ID to use for OAuth authorization for the connection.

CreateConnectionOAuthRequestParameters

Description

Contains the OAuth authorization parameters to use for the connection.

Members
AuthorizationEndpoint
Required: Yes
Type: string

The URL to the authorization endpoint when OAuth is specified as the authorization type.

ClientParameters
Required: Yes
Type: CreateConnectionOAuthClientRequestParameters structure

A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.

HttpMethod
Required: Yes
Type: string

The method to use for the authorization request.

OAuthHttpParameters
Type: ConnectionHttpParameters structure

A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.

DeadLetterConfig

Description

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

For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

Members
Arn
Type: string

The ARN of the SQS queue specified as the target for the dead-letter queue.

EcsParameters

Description

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

Members
CapacityProviderStrategy
Type: Array of CapacityProviderStrategyItem structures

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

EnableECSManagedTags
Type: boolean

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

EnableExecuteCommand
Type: boolean

Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

Group
Type: string

Specifies an ECS task group for the task. The maximum length is 255 characters.

LaunchType
Type: string

Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

NetworkConfiguration
Type: NetworkConfiguration structure

Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

PlacementConstraints
Type: Array of PlacementConstraint structures

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

PlacementStrategy
Type: Array of PlacementStrategy structures

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

PlatformVersion
Type: string

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

PropagateTags
Type: string

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

ReferenceId
Type: string

The reference ID to use for the task.

Tags
Type: Array of Tag structures

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

TaskCount
Type: int

The number of tasks to create based on TaskDefinition. The default is 1.

TaskDefinitionArn
Required: Yes
Type: string

The ARN of the task definition to use if the event target is an Amazon ECS task.

Endpoint

Description

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 .

Members
Arn
Type: string

The ARN of the endpoint.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the endpoint was created.

Description
Type: string

A description for the endpoint.

EndpointId
Type: string

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

EndpointUrl
Type: string

The URL of the endpoint.

EventBuses
Type: Array of EndpointEventBus structures

The event buses being used by the endpoint.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time the endpoint was modified.

Name
Type: string

The name of the endpoint.

ReplicationConfig
Type: ReplicationConfig structure

Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

RoleArn
Type: string

The ARN of the role used by event replication for the endpoint.

RoutingConfig
Type: RoutingConfig structure

The routing configuration of the endpoint.

State
Type: string

The current state of the endpoint.

StateReason
Type: string

The reason the endpoint is in its current state.

EndpointEventBus

Description

The event buses the endpoint is associated with.

Members
EventBusArn
Required: Yes
Type: string

The ARN of the event bus the endpoint is associated with.

EventBus

Description

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.

Members
Arn
Type: string

The ARN of the event bus.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event bus was created.

Description
Type: string

The event bus description.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event bus was last modified.

Name
Type: string

The name of the event bus.

Policy
Type: string

The permissions policy of the event bus, describing which other Amazon Web Services accounts can write events to this event bus.

EventSource

Description

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.

Members
Arn
Type: string

The ARN of the event source.

CreatedBy
Type: string

The name of the partner that created the event source.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the event source was created.

ExpirationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the event source will expire, if the Amazon Web Services account doesn't create a matching event bus for it.

Name
Type: string

The name of the event source.

State
Type: string

The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.

FailoverConfig

Description

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

Members
Primary
Required: Yes
Type: Primary structure

The main Region of the endpoint.

Secondary
Required: Yes
Type: Secondary structure

The Region that events are routed to when failover is triggered or event replication is enabled.

HttpParameters

Description

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.

Members
HeaderParameters
Type: Associative array of custom strings keys (HeaderKey) to strings

The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

PathParameterValues
Type: Array of strings

The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").

QueryStringParameters
Type: Associative array of custom strings keys (QueryStringKey) to strings

The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

IllegalStatusException

Description

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

Members

InputTransformer

Description

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.

Members
InputPathsMap
Type: Associative array of custom strings keys (InputTransformerPathKey) to strings

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "Amazon Web Services."

InputTemplate
Required: Yes
Type: string

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value>

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder cannot be used as an object key.

The following example shows the syntax for using InputPathsMap and InputTemplate.

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "<instance> is in state <status>"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "<instance> is in state \"<status>\""

}

The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'

}

InternalException

Description

This exception occurs due to unexpected causes.

Members

InvalidEventPatternException

Description

The event pattern is not valid.

Members

InvalidStateException

Description

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

Members

KinesisParameters

Description

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.

Members
PartitionKeyPath
Required: Yes
Type: string

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

LimitExceededException

Description

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

Members

ManagedRuleException

Description

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.

Members

NetworkConfiguration

Description

This structure specifies the network configuration for an ECS task.

Members
awsvpcConfiguration
Type: AwsVpcConfiguration structure

Use this structure to specify 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.

OperationDisabledException

Description

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

Members

PartnerEventSource

Description

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.

Members
Arn
Type: string

The ARN of the partner event source.

Name
Type: string

The name of the partner event source.

PartnerEventSourceAccount

Description

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

Members
Account
Type: string

The Amazon Web Services account ID that the partner event source was offered to.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the event source was created.

ExpirationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the event source will expire, if the Amazon Web Services account doesn't create a matching event bus for it.

State
Type: string

The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.

PlacementConstraint

Description

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

Members
expression
Type: string

A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

type
Type: string

The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

PlacementStrategy

Description

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.

Members
field
Type: string

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

type
Type: string

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).

PolicyLengthExceededException

Description

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

Members

Primary

Description

The primary Region of the endpoint.

Members
HealthCheck
Required: Yes
Type: string

The ARN of the health check used by the endpoint to determine whether failover is triggered.

PutEventsRequestEntry

Description

Represents an event to be submitted.

Members
Detail
Type: string

A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.

Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

DetailType
Type: string

Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

EventBusName
Type: string

The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.

If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the other Region based on the endpoint referenced by the EndpointId. Specifying the event bus ARN is preferred.

Resources
Type: Array of strings

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

Source
Type: string

The source of the event.

Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

Time
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

TraceHeader
Type: string

An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.

To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.

PutEventsResultEntry

Description

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

If the submission was successful, 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.

For information about the errors that are common to all actions, see Common Errors.

Members
ErrorCode
Type: string

The error code that indicates why the event submission failed.

Retryable errors include:

  • InternalFailure

    The request processing has failed because of an unknown error, exception or failure.

  • ThrottlingException

    The request was denied due to request throttling.

Non-retryable errors include:

  • AccessDeniedException

    You do not have sufficient access to perform this action.

  • InvalidAccountIdException

    The account ID provided is not valid.

  • InvalidArgument

    A specified parameter is not valid.

  • MalformedDetail

    The JSON provided is not valid.

  • RedactionFailure

    Redacting the CloudTrail event failed.

  • NotAuthorizedForSourceException

    You do not have permissions to publish events with this source onto this event bus.

  • NotAuthorizedForDetailTypeException

    You do not have permissions to publish events with this detail type onto this event bus.

ErrorMessage
Type: string

The error message that explains why the event submission failed.

EventId
Type: string

The ID of the event.

PutPartnerEventsRequestEntry

Description

The details about an event generated by an SaaS partner.

Members
Detail
Type: string

A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested sub-objects.

Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

DetailType
Type: string

A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

Resources
Type: Array of strings

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

Source
Type: string

The event source that is generating the entry.

Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

Time
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time of the event.

PutPartnerEventsResultEntry

Description

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.

Members
ErrorCode
Type: string

The error code that indicates why the event submission failed.

ErrorMessage
Type: string

The error message that explains why the event submission failed.

EventId
Type: string

The ID of the event.

PutTargetsResultEntry

Description

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

Members
ErrorCode
Type: string

The error code that indicates why the target addition failed. If the value is ConcurrentModificationException, too many requests were made at the same time.

ErrorMessage
Type: string

The error message that explains why the target addition failed.

TargetId
Type: string

The ID of the target.

RedshiftDataParameters

Description

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.

Members
Database
Required: Yes
Type: string

The name of the database. Required when authenticating using temporary credentials.

DbUser
Type: string

The database user name. Required when authenticating using temporary credentials.

SecretManagerArn
Type: string

The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.

Sql
Type: string

The SQL statement text to run.

Sqls
Type: Array of strings

One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

StatementName
Type: string

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

WithEvent
Type: boolean

Indicates whether to send an event back to EventBridge after the SQL statement runs.

RemoveTargetsResultEntry

Description

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

Members
ErrorCode
Type: string

The error code that indicates why the target removal failed. If the value is ConcurrentModificationException, too many requests were made at the same time.

ErrorMessage
Type: string

The error message that explains why the target removal failed.

TargetId
Type: string

The ID of the target.

Replay

Description

A Replay object that contains details about a replay.

Members
EventEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time to start replaying events. Any event with a creation time prior to the EventEndTime specified is replayed.

EventLastReplayedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the last event was replayed.

EventSourceArn
Type: string

The ARN of the archive to replay event from.

EventStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time to start replaying events. This is determined by the time in the event as described in Time.

ReplayEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the replay completed.

ReplayName
Type: string

The name of the replay.

ReplayStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time stamp for the time that the replay started.

State
Type: string

The current state of the replay.

StateReason
Type: string

A description of why the replay is in the current state.

ReplayDestination

Description

A ReplayDestination object that contains details about a replay.

Members
Arn
Required: Yes
Type: string

The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive.

FilterArns
Type: Array of strings

A list of ARNs for rules to replay events to.

ReplicationConfig

Description

Endpoints can replicate all events to the secondary Region.

Members
State
Type: string

The state of event replication.

ResourceAlreadyExistsException

Description

The resource you are trying to create already exists.

Members

ResourceNotFoundException

Description

An entity that you specified does not exist.

Members

RetryPolicy

Description

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

Members
MaximumEventAgeInSeconds
Type: int

The maximum amount of time, in seconds, to continue to make retry attempts.

MaximumRetryAttempts
Type: int

The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.

RoutingConfig

Description

The routing configuration of the endpoint.

Members
FailoverConfig
Required: Yes
Type: FailoverConfig structure

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

Rule

Description

Contains information about a rule in Amazon EventBridge.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the rule.

Description
Type: string

The description of the rule.

EventBusName
Type: string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

EventPattern
Type: string

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

ManagedBy
Type: string

If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.

Name
Type: string

The name of the rule.

RoleArn
Type: string

The Amazon Resource Name (ARN) of the role that is used for target invocation.

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

ScheduleExpression
Type: string

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

State
Type: string

The state of the rule.

Valid values include:

  • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

  • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

  • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

    Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .

    This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

RunCommandParameters

Description

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

Members
RunCommandTargets
Required: Yes
Type: Array of RunCommandTarget structures

Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

RunCommandTarget

Description

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.

Members
Key
Required: Yes
Type: string

Can be either tag: tag-key or InstanceIds.

Values
Required: Yes
Type: Array of strings

If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.

SageMakerPipelineParameter

Description

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

Members
Name
Required: Yes
Type: string

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

Value
Required: Yes
Type: string

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

SageMakerPipelineParameters

Description

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

Members
PipelineParameterList
Type: Array of SageMakerPipelineParameter structures

List of Parameter names and values for SageMaker Model Building Pipeline execution.

Secondary

Description

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

Members
Route
Required: Yes
Type: string

Defines the secondary Region.

SqsParameters

Description

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

Members
MessageGroupId
Type: string

The FIFO message group ID to use as the target.

Tag

Description

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

Members
Key
Required: Yes
Type: string

A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

Value
Required: Yes
Type: string

The value for the specified tag key.

Target

Description

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.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

Members
AppSyncParameters
Type: AppSyncParameters structure

Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.

Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the target.

BatchParameters
Type: BatchParameters structure

If the event target is an Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the Batch User Guide.

DeadLetterConfig
Type: DeadLetterConfig structure

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

EcsParameters
Type: EcsParameters structure

Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.

HttpParameters
Type: HttpParameters structure

Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.

If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

Id
Required: Yes
Type: string

The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.

Input
Type: string

Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

InputPath
Type: string

The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You may use JSON dot notation or bracket notation. For more information about JSON paths, see JSONPath.

InputTransformer
Type: InputTransformer structure

Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.

KinesisParameters
Type: KinesisParameters structure

The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.

RedshiftDataParameters
Type: RedshiftDataParameters structure

Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.

If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

RetryPolicy
Type: RetryPolicy structure

The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.

RoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.

RunCommandParameters
Type: RunCommandParameters structure

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

SageMakerPipelineParameters
Type: SageMakerPipelineParameters structure

Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.

If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.

SqsParameters
Type: SqsParameters structure

Contains the message group ID to use when the target is a FIFO queue.

If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

UpdateConnectionApiKeyAuthRequestParameters

Description

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

Members
ApiKeyName
Type: string

The name of the API key to use for authorization.

ApiKeyValue
Type: string

The value associated with teh API key to use for authorization.

UpdateConnectionAuthRequestParameters

Description

Contains the additional parameters to use for the connection.

Members
ApiKeyAuthParameters

A UpdateConnectionApiKeyAuthRequestParameters object that contains the authorization parameters for API key authorization.

BasicAuthParameters

A UpdateConnectionBasicAuthRequestParameters object that contains the authorization parameters for Basic authorization.

InvocationHttpParameters
Type: ConnectionHttpParameters structure

A ConnectionHttpParameters object that contains the additional parameters to use for the connection.

OAuthParameters

A UpdateConnectionOAuthRequestParameters object that contains the authorization parameters for OAuth authorization.

UpdateConnectionBasicAuthRequestParameters

Description

Contains the Basic authorization parameters for the connection.

Members
Password
Type: string

The password associated with the user name to use for Basic authorization.

Username
Type: string

The user name to use for Basic authorization.

UpdateConnectionOAuthClientRequestParameters

Description

Contains the OAuth authorization parameters to use for the connection.

Members
ClientID
Type: string

The client ID to use for OAuth authorization.

ClientSecret
Type: string

The client secret assciated with the client ID to use for OAuth authorization.

UpdateConnectionOAuthRequestParameters

Description

Contains the OAuth request parameters to use for the connection.

Members
AuthorizationEndpoint
Type: string

The URL to the authorization endpoint when OAuth is specified as the authorization type.

ClientParameters

A UpdateConnectionOAuthClientRequestParameters object that contains the client parameters to use for the connection when OAuth is specified as the authorization type.

HttpMethod
Type: string

The method used to connect to the HTTP endpoint.

OAuthHttpParameters
Type: ConnectionHttpParameters structure

The additional HTTP parameters used for the OAuth authorization request.