read-pipeline

Описание

Операция ReadPipeline получает подробную информацию о конвейере.

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

Синтаксис

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

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

--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
text
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

on
off
auto

--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 read-pipeline --id 3333333333333-abcde3

Вывод:

{
   "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": "",
           "Warning": "",
           "Progressing": "",
           "Error": "arn:aws:sns:us-east-1:123456789012:ETS_Errors"
       },
       "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
       "InputBucket": "ets-example",
       "Id": "3333333333333-abcde3",
       "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde3"
   },
   "Warnings": [
       {
           "Message": "The SNS notification topic for Error events and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the SNS notification topic and the pipeline.",
           "Code": "6006"
       }
   ]
}

Вывод

Поток -> (структура)

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

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.

(строка)

Warnings -> (список)

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

Использование ресурсов в одной области, таких как ваши ведра Amazon S3, темы уведомлений Amazon SNS и ключи AWS KMS, уменьшает время обработки и предотвращает региональные сборы.

(структура)

Code -> (строка)

Код предупреждения о межрегиональном взаимодействии.

Message -> (строка)

Сообщение, объясняющее, какие ресурсы находятся в другой области по сравнению с конвейерной линией.

Примечание

Ключи AWS KMS должны находиться в той же области, что и конвейерная линия.

END_OF_DOCUMENT_MARKER