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.

ListPartnerEventSources

An SaaS partner can use this operation to list all the partner event source names that they have created.

Note

This operation is not used by AWS customers.

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

pecifying 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

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

Type: String

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

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

Required: Yes

NextToken

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

Type: String

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

Required: No

Response Syntax

{ "NextToken": "string", "PartnerEventSources": [ { "Arn": "string", "Name": "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.

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.

PartnerEventSources

The list of partner event sources returned by the operation.

Type: Array of PartnerEventSource objects

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 partner event sources.

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

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "PartnerEventSources": [ { "Arn": "arn:aws:events:us-east-2::event-source/aws.partner/PartnerName/acct1/event_source_for_customer1", "Name": "aws.partner/PartnerName/acct1/event_source_for_customer1" }, { "Arn": "arn:aws:events:us-east-2::event-source/aws.partner/PartnerName/acct1/event_source_for_customer2", "Name": "aws.partner/PartnerName/acct1/event_source_for_customer2" } ] }

See Also

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