Amazon EventBridge
API Reference (API Version 2015-10-07)

DeactivateEventSource

An AWS customer uses this operation to temporarily stop receiving events from the specified partner event source. The matching event bus isn't 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's deleted.

To activate a deactivated partner event source, use ActivateEventSource.

Request Syntax

{ "Name": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name of the partner event source to deactivate.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

InvalidStateException

The specified state isn't a valid state for an event source.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified doesn't exist.

HTTP Status Code: 400

Example

Deactivate an event source

The following example deactivates the event source named aws.partner/PartnerName/acct1/repo1.

Sample Request

POST / HTTP/1.1 Host: events.<region>.<domain> x-amz-Date: <Date> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature> User-Agent: <UserAgentString> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Connection: Keep-Alive X-Amz-Target: AWSEvents.DeactivateEventSource { "Name": "aws.partner/PartnerName/acct1/repo1" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: