UpdateConfigurationSetEventDestination method
Updates subscription for a configuration within a folder. The folder is selected based on the service account the request originates from.
Request
PUT /v2/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName} HTTP/2
Path parameters
|
Parameter |
Description |
|
|
Type: String. Configuration name. |
|
|
Type: String. Name of the subscription to update. |
Request headers
Use common request headers in your requests.
Request body
{
"EventDestination": {
"Enabled": <subscription_state>,
"KinesisFirehoseDestination": {
"IamRoleArn": "<compatibility_parameter>",
"DeliveryStreamArn": "<data_stream>"
}
}
}
|
Parameter |
Description |
|
|
Type: Object. Object containing the subscription parameters. |
|
|
Type: Boolean. Subscription state: |
|
|
Type: Object. Object defining the destination for notifications. |
|
|
Type: String. Used only for compatibility with AWS. |
|
|
Type: String. Yandex Data Streams data stream 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. |
|
|
The request quota was exceeded. |