update-pipeline-notifications

Описание

Операция UpdatePipelineNotifications позволяет обновить уведомления Amazon Simple Notification Service (Amazon SNS) для конвейера.

При обновлении уведомлений для конвейера Elastic Transcoder возвращает значения, указанные в запросе.

См. также: Документация AWS API

Синтаксис

  update-pipeline-notifications
--id <value>
--notifications <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--id (строка)

Идентификатор конвейера, для которого необходимо изменить параметры уведомлений.

--notifications (структура)

ARN темы Amazon Simple Notification Service (Amazon SNS), на которую необходимо отправлять уведомления о статусе задания.

Предупреждение

Для получения уведомлений необходимо также подписаться на новую тему в консоли Amazon SNS.

Progressing : ARN темы Amazon SNS, на которую необходимо отправлять уведомления, когда Elastic Transcoder начал обработку заданий, добавленных в этот конвейер. Это ARN, возвращенный Amazon SNS при создании темы.
Complete : ARN темы Amazon SNS, на которую необходимо отправлять уведомления, когда Elastic Transcoder завершил обработку задания. Это ARN, возвращенный Amazon SNS при создании темы.
Warning : ARN темы Amazon SNS, на которую необходимо отправлять уведомления, когда Elastic Transcoder обнаружил условие предупреждения. Это ARN, возвращенный Amazon SNS при создании темы.
Error : ARN темы Amazon SNS, на которую необходимо отправлять уведомления, когда Elastic Transcoder обнаружил условие ошибки. Это ARN, возвращенный Amazon SNS при создании темы.

Progressing -> (строка)

Тема Amazon Simple Notification Service (Amazon SNS), на которую необходимо отправлять уведомления, когда Elastic Transcoder начал обработку задания.

Completed -> (строка)

Тема Amazon SNS, на которую необходимо отправлять уведомления, когда Elastic Transcoder завершил обработку задания.

Warning -> (строка)

Тема Amazon SNS, на которую необходимо отправлять уведомления, когда Elastic Transcoder обнаружил условие предупреждения.

Error -> (строка)

Тема Amazon SNS, на которую необходимо отправлять уведомления, когда Elastic Transcoder обнаружил условие ошибки.

Сокращенный синтаксис:

Progressing=string,Completed=string,Warning=string,Error=string

Синтаксис JSON:

{
  "Progressing": "string",
  "Completed": "string",
  "Warning": "string",
  "Error": "string"
}

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, оно валидирует входные данные команд и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись в журнал.

--endpoint-url (строка)

Переопределить значение URL по умолчанию команды на указанный URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команд.

json
текст
таблица
yaml
yaml-потоковый

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

включено
выключено
автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр указан.

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, который будет использоваться для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно, независимо от значения cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод страниц AWS CLI.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода командной строки.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода командной строки.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования, аналогичные unix. Эти примеры потребуют адаптации к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Обновление уведомлений конвейера ElasticTranscoder

В этом примере обновляются уведомления указанного конвейера ElasticTranscoder.

Команда:

aws elastictranscoder update-pipeline-notifications --id 1111111111111-abcde1 --notifications Progressing=arn:aws:sns:us-west-2:0123456789012:my-topic,Completed=arn:aws:sns:us-west-2:0123456789012:my-topic,Warning=arn:aws:sns:us-west-2:0123456789012:my-topic,Error=arn:aws:sns:us-east-1:111222333444:ETS_Errors

Вывод:

{
   "Pipeline": {
       "Status": "Active",
       "ContentConfig": {
           "Bucket": "ets-example",
           "StorageClass": "Standard",
           "Permissions": [
               {
                   "Access": [
                       "FullControl"
                   ],
                   "Grantee": "marketing-promos@example.com",
                   "GranteeType": "Email"
               }
           ]
       },
       "Name": "Default",
       "ThumbnailConfig": {
           "Bucket": "ets-example",
           "StorageClass": "ReducedRedundancy",
           "Permissions": [
               {
                   "Access": [
                       "FullControl"
                   ],
                   "Grantee": "marketing-promos@example.com",
                   "GranteeType": "Email"
               }
           ]
       },
       "Notifications": {
           "Completed": "arn:aws:sns:us-west-2:0123456789012:my-topic",
           "Warning": "arn:aws:sns:us-west-2:0123456789012:my-topic",
           "Progressing": "arn:aws:sns:us-west-2:0123456789012:my-topic",
           "Error": "arn:aws:sns:us-east-1:111222333444:ETS_Errors"
       },
       "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
       "InputBucket": "ets-example",
       "Id": "1111111111111-abcde1",
       "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/1111111111111-abcde1"
   }
}

Вывод

Пайплайн -> (структура)

Раздел тела ответа, содержащий информацию о пайплайне, связанном с этим уведомлением.

Id -> (строка)

Идентификатор пайплайна. Используйте это значение для идентификации пайплайна, в котором вы хотите выполнить различные операции, такие как создание задания или предопределения.

Arn -> (строка)

Amazon Resource Name (ARN) пайплайна.

Name -> (строка)

Имя пайплайна. Рекомендуется, чтобы имя было уникальным в рамках учетной записи AWS, но уникальность не проверяется.

Ограничения: Максимальная длина 40 символов

Status -> (строка)

Текущий статус пайплайна:

Active : Пайплайн обрабатывает задания.
Paused : Пайплайн в данный момент не обрабатывает задания.

InputBucket -> (строка)

Amazon S3-ведро, из которого Elastic Transcoder получает медиафайлы для транскодирования и графические файлы (если есть) для водяных знаков.

OutputBucket -> (строка)

Amazon S3-ведро, в которое Elastic Transcoder сохраняет транскодированные файлы, миниатюры и плейлисты. Вы указываете это значение или оба значения ContentConfig и ThumbnailConfig .

Role -> (строка)

IAM Amazon Resource Name (ARN) для роли, которую Elastic Transcoder использует для транскодирования заданий для данного пайплайна.

AwsKmsKeyArn -> (строка)

Ключ AWS Key Management Service (AWS KMS), который вы хотите использовать с этим пайплайном.

Если вы используете s3 или s3-aws-kms в качестве своего Encryption:Mode , вам не нужно предоставлять ключ со своим заданием, так как по умолчанию создается ключ AWS-KMS. Вам нужно указать ключ AWS-KMS только если вы хотите использовать нестандартный ключ AWS-KMS или если вы используете Encryption:Mode типов aes-cbc-pkcs7 , aes-ctr или aes-gcm .

Notifications -> (структура)

Тема Amazon Simple Notification Service (Amazon SNS), которую вы хотите уведомить о статусе задания.

Предупреждение

Для получения уведомлений вы также должны подписаться на новую тему в консоли Amazon SNS.

Progressing (необязательно): Тема Amazon Simple Notification Service (Amazon SNS), о которой вы хотите уведомить, когда Elastic Transcoder начал обработку задания.
Complete (необязательно): Тема Amazon SNS, о которой вы хотите уведомить, когда Elastic Transcoder завершил обработку задания.
Warning (необязательно): Тема Amazon SNS, о которой вы хотите уведомить, когда Elastic Transcoder столкнулся с предупреждением.
Error (необязательно): Тема Amazon SNS, о которой вы хотите уведомить, когда Elastic Transcoder столкнулся с ошибкой.

Progressing -> (строка)

Тема Amazon Simple Notification Service (Amazon SNS), о которой вы хотите уведомить, когда Elastic Transcoder начал обработку задания.

Completed -> (строка)

Тема Amazon SNS, о которой вы хотите уведомить, когда Elastic Transcoder завершил обработку задания.

Warning -> (строка)

Тема Amazon SNS, о которой вы хотите уведомить, когда Elastic Transcoder столкнулся с предупреждением.

Error -> (строка)

Тема Amazon SNS, о которой вы хотите уведомить, когда Elastic Transcoder столкнулся с ошибкой.

ContentConfig -> (структура)

Информация об Amazon S3-ведре, в которое вы хотите, чтобы Elastic Transcoder сохранял транскодированные файлы и плейлисты. Вы указываете оба значения ContentConfig и ThumbnailConfig , или значение OutputBucket .

Bucket : Amazon S3-ведро, в которое вы хотите, чтобы Elastic Transcoder сохранял транскодированные файлы и плейлисты.
Permissions : Список пользователей и/или предопределенных групп Amazon S3, которым вы хотите предоставить доступ к транскодированным файлам и плейлистам, и тип доступа.

GranteeType: Тип значения, которое отображается в объекте Grantee :
- Canonical : либо канонический идентификатор пользователя для учетной записи AWS, либо идентификатор доступа к источнику для Amazon CloudFront-распределения.
- Email : зарегистрированный адрес электронной почты учетной записи AWS.
- Group : одна из следующих предопределенных групп Amazon S3: AllUsers , AuthenticatedUsers или LogDelivery .
Grantee : Пользователь или группа AWS, которым вы хотите предоставить доступ к транскодированным файлам и плейлистам.
Access : Разрешение, которое вы хотите предоставить пользователю AWS, указанному в Grantee . Допустимые значения включают:
- READ : Уполномоченное лицо может читать объекты и метаданные для объектов, которые Elastic Transcoder добавляет в Amazon S3-ведро.
- READ_ACP : Уполномоченное лицо может читать ACL для объектов, которые Elastic Transcoder добавляет в Amazon S3-ведро.
- WRITE_ACP : Уполномоченное лицо может записывать ACL для объектов, которые Elastic Transcoder добавляет в Amazon S3-ведро.
- FULL_CONTROL : Уполномоченное лицо имеет READ , READ_ACP и WRITE_ACP разрешения для объектов, которые Elastic Transcoder добавляет в Amazon S3-ведро.

StorageClass : Класс хранилища Amazon S3, Standard или ReducedRedundancy, который вы хотите назначить Elastic Transcoder для видеофайлов и плейлистов, хранящихся в Amazon S3-ведре.

Bucket -> (строка)

Amazon S3-ведро, в которое вы хотите, чтобы Elastic Transcoder сохранял транскодированные файлы. Укажите это значение, когда все из следующего верно:

Вы хотите сохранить транскодированные файлы, миниатюры (если есть) и плейлисты (если есть) вместе в одном ведре.
Вы не хотите указывать пользователей или группы, которые имеют доступ к транскодированным файлам, миниатюрам и плейлистам.
Вы не хотите указывать разрешения, предоставляемые Elastic Transcoder для файлов.
Вы хотите связать транскодированные файлы и миниатюры с классом хранилища Amazon S3 Standard.

Если вы хотите сохранить транскодированные файлы и плейлисты в одном ведре, а миниатюры в другом ведре, укажите, какие пользователи могут получить доступ к транскодированным файлам или какие разрешения имеют пользователи, или измените класс хранилища Amazon S3, пропустите OutputBucket и укажите значения для ContentConfig и ThumbnailConfig вместо этого.

StorageClass -> (строка)

Класс хранилища Amazon S3, Standard или ReducedRedundancy , который вы хотите назначить Elastic Transcoder для видеофайлов и плейлистов, хранящихся в Amazon S3-ведре.

Permissions -> (список)

Необязательно. Объект Permissions определяет, какие пользователи и/или предопределенные группы Amazon S3 должны иметь доступ к транскодированным файлам и плейлистам, и какой тип доступа они должны иметь. Вы можете предоставить разрешения до 30 пользователей и/или предопределенных групп Amazon S3.

Если вы включаете Permissions , Elastic Transcoder предоставляет только те разрешения, которые вы указали. Он не предоставляет полные разрешения владельцу роли, указанной в Role . Если вы хотите, чтобы этот пользователь имел полный контроль, вы должны явно предоставить пользователю полный контроль.

Если вы опустите Permissions , Elastic Transcoder предоставит полный контроль над транскодированными файлами и плейлистами владельцу роли, указанной в Role , и не предоставит никаких других разрешений любому другому пользователю или группе.

(структура)

Структура Permission .

GranteeType -> (строка)

Тип значения, отображаемого в объекте Grantee:

Canonical : либо канонический идентификатор пользователя для учетной записи AWS, либо идентификатор доступа к источнику для Amazon CloudFront-распределения.

Предупреждение

Канонический идентификатор пользователя отличается от номера учетной записи AWS.

Email : зарегистрированный адрес электронной почты учетной записи AWS.
Group : одна из следующих предопределенных групп Amazon S3: AllUsers , AuthenticatedUsers или LogDelivery .

Grantee -> (строка)

Пользователь или группа AWS, которым вы хотите предоставить доступ к транскодированным файлам и плейлистам. Для идентификации пользователя или группы вы можете указать канонический идентификатор пользователя для учетной записи AWS, идентификатор доступа к источнику для CloudFront-распределения, зарегистрированный адрес электронной почты учетной записи AWS или предопределенную группу Amazon S3.

Access -> (список)

Разрешение, которое вы хотите предоставить пользователю AWS, указанному в Grantee. Допустимые значения включают:

READ : Уполномоченное лицо может читать миниатюры и метаданные для миниатюр, которые Elastic Transcoder добавляет в Amazon S3-ведро.
READ_ACP : Уполномоченное лицо может читать ACL для миниатюр, которые Elastic Transcoder добавляет в Amazon S3-ведро.
WRITE_ACP : Уполномоченное лицо может записывать ACL для миниатюр, которые Elastic Transcoder добавляет в Amazon S3-ведро.
FULL_CONTROL : Уполномоченное лицо имеет READ, READ_ACP и WRITE_ACP разрешения для миниатюр, которые Elastic Transcoder добавляет в Amazon S3-ведро.

(строка)

ThumbnailConfig -> (структура)

Информация о ведре Amazon S3, в котором Elastic Transcoder должен сохранять файлы миниатюр. Вы должны указать как ContentConfig и ThumbnailConfig , так и OutputBucket .

Bucket : Ведро Amazon S3, в котором Elastic Transcoder должен сохранять файлы миниатюр.
Permissions : Список пользователей и/или предварительно определённых групп Amazon S3, которым вы хотите предоставить доступ к файлам миниатюр, и тип доступа.
- GranteeType: Тип значения, которое появляется в объекте Grantee:
  - Canonical : Либо канонический идентификатор пользователя для учётной записи AWS, либо идентификатор доступа к источнику для распределения Amazon CloudFront.
  Предупреждение
  
  Канонический идентификатор пользователя не совпадает с номером учётной записи AWS.
  - Email : Зарегистрированный адрес электронной почты учётной записи AWS.
  - Group : Одна из следующих предварительно определённых групп Amazon S3: AllUsers , AuthenticatedUsers или LogDelivery .
- Grantee : Пользователь или группа AWS, которым вы хотите предоставить доступ к файлам миниатюр.
- Access: Разрешение, которое вы хотите предоставить пользователю AWS, указанному в Grantee. Допустимые значения включают:
  - READ : Уполномоченное лицо может читать миниатюры и метаданные для миниатюр, которые Elastic Transcoder добавляет в ведро Amazon S3.
  - READ_ACP : Уполномоченное лицо может читать ACL объекта для миниатюр, которые Elastic Transcoder добавляет в ведро Amazon S3.
  - WRITE_ACP : Уполномоченное лицо может записывать ACL для миниатюр, которые Elastic Transcoder добавляет в ведро Amazon S3.
  - FULL_CONTROL : Уполномоченное лицо обладает разрешениями READ, READ_ACP и WRITE_ACP для миниатюр, которые Elastic Transcoder добавляет в ведро Amazon S3.
StorageClass : Класс хранения Amazon S3, Standard или ReducedRedundancy , который вы хотите, чтобы Elastic Transcoder назначил миниатюрам, которые он хранит в вашем ведре Amazon S3.

Bucket -> (string)

Ведро Amazon S3, в котором вы хотите, чтобы Elastic Transcoder сохранял закодированные файлы. Укажите это значение, если все нижеперечисленное верно:

Вы хотите сохранить закодированные файлы, миниатюры (если есть) и плейлисты (если есть) вместе в одном ведре.
Вы не хотите указывать пользователей или группы, имеющие доступ к закодированным файлам, миниатюрам и плейлистам.
Вы не хотите указывать разрешения, предоставляемые Elastic Transcoder для файлов.
Вы хотите связать закодированные файлы и миниатюры с классом хранения Amazon S3 Standard.

Если вы хотите сохранить закодированные файлы и плейлисты в одном ведре, а миниатюры в другом, укажите, какие пользователи могут получить доступ к закодированным файлам или разрешения, которыми они обладают, или измените класс хранения Amazon S3. Для этого опустите OutputBucket и укажите значения для ContentConfig и ThumbnailConfig вместо него.

StorageClass -> (string)

Класс хранения Amazon S3, Standard или ReducedRedundancy , который вы хотите, чтобы Elastic Transcoder назначил видеофайлам и плейлистам, которые он хранит в вашем ведре Amazon S3.

Permissions -> (list)

Необязательно. Объект Permissions указывает, каких пользователей и/или предварительно определённых групп Amazon S3 вы хотите предоставить доступ к закодированным файлам и плейлистам, и какой тип доступа вы хотите предоставить. Вы можете предоставить разрешения максимум 30 пользователям и/или предварительно определённым группам Amazon S3.

Если вы включите Permissions , Elastic Transcoder предоставит только разрешения, которые вы укажете. Он не предоставляет полные разрешения владельцу роли, указанной в Role . Если вы хотите, чтобы у этого пользователя были полные права, вы должны явно предоставить ему полные права.

Если вы опустите Permissions , Elastic Transcoder предоставит полные права на закодированные файлы и плейлисты владельцу роли, указанной в Role , и не предоставит никаких других разрешений никому другому пользователю или группе.

(structure)

Структура Permission .

GranteeType -> (string)

Тип значения, которое появляется в объекте Grantee:

Canonical : Либо канонический идентификатор пользователя для учётной записи AWS, либо идентификатор доступа к источнику для распределения Amazon CloudFront.

Предупреждение

Канонический идентификатор пользователя не совпадает с номером учётной записи AWS.

Email : Зарегистрированный адрес электронной почты учётной записи AWS.
Group : Одна из следующих предварительно определённых групп Amazon S3: AllUsers , AuthenticatedUsers или LogDelivery .

Grantee -> (string)

Пользователь или группа AWS, которым вы хотите предоставить доступ к закодированным файлам и плейлистам. Для идентификации пользователя или группы вы можете указать канонический идентификатор пользователя для учётной записи AWS, идентификатор доступа к источнику для распределения CloudFront, зарегистрированный адрес электронной почты учётной записи AWS или предварительно определённую группу Amazon S3.

Access -> (list)

Разрешение, которое вы хотите предоставить пользователю AWS, указанному в Grantee. Допустимые значения включают:

READ : Уполномоченное лицо может читать миниатюры и метаданные для миниатюр, которые Elastic Transcoder добавляет в ведро Amazon S3.
READ_ACP : Уполномоченное лицо может читать ACL объекта для миниатюр, которые Elastic Transcoder добавляет в ведро Amazon S3.
WRITE_ACP : Уполномоченное лицо может записывать ACL для миниатюр, которые Elastic Transcoder добавляет в ведро Amazon S3.
FULL_CONTROL : Уполномоченное лицо обладает разрешениями READ, READ_ACP и WRITE_ACP для миниатюр, которые Elastic Transcoder добавляет в ведро Amazon S3.

(string)