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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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([
    'EventSourceName' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Targets' => [
        [
            '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>',
                '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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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.

You can configure the following as targets for Events:

• API destination

• Amazon API Gateway REST API endpoints

• API Gateway

• Batch job queue

• CloudWatch Logs group

• CodeBuild project

• CodePipeline

• Amazon EC2 CreateSnapshot API call

• Amazon EC2 RebootInstances API call

• Amazon EC2 StopInstances API call

• Amazon EC2 TerminateInstances API call

• Amazon ECS tasks

• Event bus in a different Amazon Web Services account or Region.

  You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.

• Firehose delivery stream (Kinesis Data Firehose)

• Inspector assessment template (Amazon Inspector)

• Kinesis stream (Kinesis Data Stream)

• Lambda function

• Redshift clusters (Data API statement execution)

• Amazon SNS topic

• Amazon SQS queues (includes FIFO queues

• SSM Automation

• SSM OpsItem

• SSM Run Command

• Step Functions state machines

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and 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 REST 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.

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.

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
        [
            '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>', // REQUIRED
                '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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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.

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.