обновить-статус-пайплайна

Описание

Операция UpdatePipelineStatus приостанавливает или возобновляет работу пайплайна, чтобы тот остановил или запустил обработку заданий.

Изменение статуса пайплайна полезно, если нужно отменить одно или несколько заданий. Отменить задания после того, как Elastic Transcoder начал их обработку, нельзя; если приостановить пайплайн, в который были отправлены задания, у вас будет больше времени, чтобы получить идентификаторы заданий, которые нужно отменить, и отправить запрос CancelJob.

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

Синтаксис

  update-pipeline-status
--id <value>
--status <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 (строка)

Идентификатор пайплайна для обновления.

--status (строка)

Желаемый статус пайплайна:

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

--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 (булево)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для обновления статуса пайплайна ElasticTranscoder

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

Команда:

aws elastictranscoder update-pipeline-status --id 1111111111111-abcde1 --status Paused

Вывод:

{
   "Pipeline": {
       "Status": "Paused",
       "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": "",
           "Warning": "",
           "Progressing": "",
           "Error": "arn:aws:sns:us-east-1:803981987763: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 -> (строка)

Ведро 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.

(строка)