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

ListEventSources

You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus.

Note

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

Request Syntax

{ "Limit": number, "NamePrefix": "string", "NextToken": "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.

Limit

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NamePrefix

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

Type: String

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

Pattern: [/\.\-_A-Za-z0-9]+

Required: No

NextToken

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

Type: String

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

Required: No

Response Syntax

{ "EventSources": [ { "Arn": "string", "CreatedBy": "string", "CreationTime": number, "ExpirationTime": number, "Name": "string", "State": "string" } ], "NextToken": "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.

EventSources

The list of event sources.

Type: Array of EventSource objects

NextToken

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

Type: String

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

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

Example

Lists the event sources shared with this account

The following is an example of a ListEventSources 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.ListEventSources { "NamePrefix": "aws.partner/PartnerName/"

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "EventSources": [ { "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: