CreateConfigurationSetEventDestinations method
Creates a subscription for a configuration in a folder. The folder is selected based on the service account the request originates from.
Request
POST /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.
Request body
{
"EventDestinationName": "<subscription_name>",
"EventDestination": {
"Enabled": <subscription_state>,
"KinesisFirehoseDestination": {
"IamRoleArn": "<role>",
"DeliveryStreamArn": "<data_stream>"
}
}
}
|
Parameter |
Description |
|
|
Type: String. Subscription name. |
|
|
Type: Object. Object with subscription parameters. |
|
|
Type: Boolean. Subscription state: |
|
|
Type: Object. Object which sets the destination for notifications. |
|
|
Type: String. This parameter is not used. It is provided for compatibility with AWS. |
|
|
Type: String. Data stream in Yandex Data Streams notifications are sent to. Format: Example
|
Responses
200 OK
A successful request returns 200 OK in the response.
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. |
|
|
A subscription with this name already exists. Specify a different name. |
|
|
There are conflicting operations. Wait for the previous operation to complete and repeat your request. |
|
|
The request exceeded the quota. |
|
|
The request exceeded the limit. |