list-pipelines

Описание

Операция ListPipelines получает список конвейеров, связанных с текущей учетной записью AWS.

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

list-pipelines является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе, содержащем несколько страниц, аргумент --query должен извлечь данные из результатов следующих выражений запроса: Pipelines

Синтаксис

  list-pipelines
[--ascending <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--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]

Параметры

--ascending (строка)

Чтобы перечислить конвейеры в хронологическом порядке по дате и времени их создания, введите true. Чтобы перечислить конвейеры в обратном хронологическом порядке, введите false.

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

--starting-token (строка)

Токен, указывающий, с какой позиции начать постраничный вывод. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--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 list-pipelines

Вывод:

{
   "Pipelines": [
       {
           "Status": "Active",
           "ContentConfig": {
               "Bucket": "ets-example",
               "Permissions": []
           },
           "Name": "example-pipeline",
           "ThumbnailConfig": {
               "Bucket": "ets-example",
               "Permissions": []
           },
           "Notifications": {
               "Completed": "arn:aws:sns:us-west-2:123456789012:ets_example",
               "Warning": "",
               "Progressing": "",
               "Error": ""
           },
           "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
           "InputBucket": "ets-example",
           "OutputBucket": "ets-example",
           "Id": "3333333333333-abcde3",
           "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde3"
       },
       {
           "Status": "Paused",
           "ContentConfig": {
               "Bucket": "ets-example",
               "Permissions": []
           },
           "Name": "example-php-test",
           "ThumbnailConfig": {
               "Bucket": "ets-example",
               "Permissions": []
           },
           "Notifications": {
               "Completed": "",
               "Warning": "",
               "Progressing": "",
               "Error": ""
           },
           "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
           "InputBucket": "ets-example",
           "OutputBucket": "ets-example",
           "Id": "3333333333333-abcde2",
           "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde2"
       },
       {
           "Status": "Active",
           "ContentConfig": {
               "Bucket": "ets-west-output",
               "Permissions": []
           },
           "Name": "pipeline-west",
           "ThumbnailConfig": {
               "Bucket": "ets-west-output",
               "Permissions": []
           },
           "Notifications": {
               "Completed": "arn:aws:sns:us-west-2:123456789012:ets-notifications",
               "Warning": "",
               "Progressing": "",
               "Error": ""
           },
           "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role",
           "InputBucket": "ets-west-input",
           "OutputBucket": "ets-west-output",
           "Id": "3333333333333-abcde1",
           "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde1"
       }
   ]
}

Вывод

Конвейеры -> (список)

Массив объектов Pipeline.

(структура)

Конвейер (очередь), используемый для управления заданиями.

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.

(строка)

NextPageToken -> (строка)

Значение, которое используется для доступа ко второй и последующим страницам результатов, если они есть. Если пайплайны помещаются на одной странице или если вы достигли последней страницы результатов, значение NextPageToken равно null .

END_OF_DOCUMENT_MARKER