GetConfigurationSetEventDestinations method
Returns information about subscriptions for a configuration in a folder. The folder is selected based on the service account the request originates from.
Request
GET /v2/email/configuration-sets/{ConfigurationSetName}/event-destinations HTTP/2
Path parameters
|
Parameter |
Description |
|
|
Type: String. Configuration name. |
Request headers
Use common request headers in your requests.
Responses
200 OK
{
"EventDestinations": [
{
"Name": "<subscription_name>",
"Enabled": <subscription_state>,
"KinesisFirehoseDestination": {
"DeliveryStreamArn": "<data_stream>"
}
}
]
}
|
Parameter |
Description |
|
|
Type: Array. Array of subscriptions. |
|
|
Type: String. Subscription name. |
|
|
Type: Boolean. Subscription state: |
|
|
Type: Object. Object that specifies the destination for notifications. |
|
|
Type: String. Yandex Data Streams data stream notifications will go to. Format: Example
|
The 200 OK response may contain additional parameters. Its format may vary slightly from the above.
Errors
For all errors, the response body has the same format:
{
"Code": "<error_name>",
"message": "<error_description>"
}
The name of the error is taken from its code, e.g., BadRequestException.
Possible errors:
|
Error code |
Description |
|
|
The request contains invalid headers or parameters. |
|
|
The requested resource was not found. |
|
|
The request quota was exceeded. |