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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeEventSource

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

Note

This operation is run by AWS customers, not by SaaS partners.

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 display the details of.

Type: String

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

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

Required: Yes

Response Syntax

{ "Arn": "string", "CreatedBy": "string", "CreationTime": number, "ExpirationTime": number, "Name": "string", "State": "string" }

Response Elements

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

The following data is returned in JSON format by the service.

Arn

The ARN of the partner event source.

Type: String

CreatedBy

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

Type: String

CreationTime

The date and time that the event source was created.

Type: Timestamp

ExpirationTime

The date and time that the event source will expire if you don't create a matching event bus.

Type: Timestamp

Name

The name of the partner event source.

Type: String

State

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

Type: String

Valid Values: PENDING | ACTIVE | DELETED

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

ResourceNotFoundException

An entity that you specified doesn't exist.

HTTP Status Code: 400

Example

Describe event source

The following is an example of a DescribeEventSource request and response.

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.DescribeEventSource { "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> { "Arn": "arn:aws:events:us-east-2::event-source/aws.partner/PartnerName/acct1/repo1", "CreatedBy": "PartnerName", "CreationTime": 2019-07-12T23:20:50.52Z, "ExpirationTime": 2019-07-26T23:20:50.52Z, "Name": "aws.partner/PartnerName/acct1/repo1", "State": "ACTIVE" }

See Also

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