ListPartnerEventSources
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 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 which 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
- OperationDisabledException
-
The operation you are attempting is not available in this region.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: