ListSubscribers
Lists subscribers as summaries. By default the list spans the subscribers the caller account owns across all buses; set EventBusArn to scope it to one bus. Use DescribeSubscriber to retrieve full configuration.
Request Parameters
- EventBusArn
-
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
arn:aws(-[a-z0-9]+)*:events:[a-z][a-z0-9]*(-[a-z0-9]+)*:([0-9]{12}):event-busv2\/[A-Za-z0-9][\.\-_A-Za-z0-9]{0,255}\/[a-z0-9]{25}Required: No
- MaxResults
-
Maximum number of results to return in one page of a List operation.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NamePrefix
-
Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9][\.\-_A-Za-z0-9]*Required: No
- NextToken
-
Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
Response Elements
The following elements are returned by the service.
- NextToken
-
Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
- Subscribers
-
List of subscriber summaries.
Type: Array of SubscriberSummary objects
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
HTTP Status Code: 403
- InternalException
-
The request failed because of an internal service error. Retry the request.
HTTP Status Code: 500
- InvalidInputException
-
A request parameter is missing or not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
