Метод CreateConfigurationSetEventDestinations
Создает подписку для конфигурации в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.
Запрос
POST /v2/email/configuration-sets/{ConfigurationSetName}/event-destinations HTTP/2
Path-параметры
|
Параметр |
Описание |
|
|
Тип: string. Название конфигурации. |
Заголовки запроса
Используйте в запросе общие заголовки.
Тело запроса
{
"EventDestinationName": "<название_подписки>",
"EventDestination": {
"Enabled": <состояние_подписки>,
"KinesisFirehoseDestination": {
"IamRoleArn": "<роль>",
"DeliveryStreamArn": "<поток_данных>"
}
}
}
|
Параметр |
Описание |
|
|
Тип: string. Название подписки. |
|
|
Тип: object. Объект, который содержит параметры подписки. |
|
|
Тип: boolean. Состояние подписки: |
|
|
Тип: object. Объект, который определяет место назначения для отправки уведомлений. |
|
|
Тип: string. Параметр не используется. Предназначен для совместимости с AWS. |
|
|
Тип: string. Поток данных Yandex Data Streams, в который отправляются уведомления. Формат: Пример
|
Ответы
200 OK
Ответ 200 OK возвращается в случае успешного выполнения запроса.
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе переданы неправильные заголовки или параметры. |
|
|
Не найден запрашиваемый ресурс. |
|
|
Подписка с таким названием уже существует, выберите другие имя. |
|
|
Конфликт операций. Дождитесь завершения предыдущей операции и повторите запрос. |
|
|
При вызове запроса превышена квота. |
|
|
При вызове запроса превышен лимит. |