Spec-Zone.ru › AWS CLI v2

[ aws . datapipeline ]

put-pipeline-definition

Описание

Добавляет задачи, расписания и предварительные условия в указанную конвейерную линию. Вы можете использовать PutPipelineDefinition для заполнения новой конвейерной линии.

PutPipelineDefinition также проверяет конфигурацию при её добавлении в конвейерную линию. Изменения в конвейерной линии сохраняются, если в конвейере отсутствуют следующие три ошибки валидации.
  • У объекта отсутствует поле имени или идентификатора.
  • Поле строки или ссылки пусто.
  • Количество объектов в конвейерной линии превышает максимальное разрешенное количество.
  • Конвейерная линия находится в состоянии FINISHED.

Определения объекта конвейерной линии передаются действию PutPipelineDefinition и возвращаются действием GetPipelineDefinition.

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

Синтаксис

  put-pipeline-definition
--pipeline-id <value>
[--parameter-objects <value>]
[--parameter-values <value>]
--pipeline-definition <value>
[--parameter-values-uri <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]

Параметры

--pipeline-id (строка)

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

--parameter-objects (строка) Объекты параметров в формате JSON. Если объекты параметров находятся в файле, вы можете использовать file://syntax для указания имени файла. Вы также можете указать их в определении конвейерной линии. Объекты параметров, указанные в командной строке, заменят объекты в определении.

--parameter-values (строка) Значения параметров в формате JSON. Вы можете указать их в виде пар ключ-значение в формате ключ=значение. Несколько параметров разделяются пробелом. Для параметров типа списка вы можете использовать то же имя ключа и указать каждое значение как пару ключ-значение. Например: arrayValue=value1 arrayValue=value2

--pipeline-definition (строка) Определение конвейерной линии в формате JSON. Если определение конвейерной линии находится в файле, вы можете использовать file://syntax для указания имени файла.

--parameter-values-uri (строка) Значения параметров в формате JSON. Если значения параметров находятся в файле, вы можете использовать file://syntax для указания имени файла. Вы также можете указать их в определении конвейерной линии. Значения параметров, указанные в командной строке, заменят значения в определении.

--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.

Для загрузки определения конвейерной линии

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

aws datapipeline put-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE --pipeline-definition file://my-pipeline-definition.json

Следующий пример вывода:

{
  "validationErrors": [],
  "errored": false,
  "validationWarnings": []
}

Вывод

validationErrors -> (список)

Ошибки валидации, связанные с объектами, определенными в pipelineObjects.

(структура)

Определяет ошибку валидации. Ошибки валидации препятствуют активации конвейерной линии. Набор ошибок валидации, которые могут быть возвращены, определен в AWS Data Pipeline.

id -> (строка)

Идентификатор объекта, содержащего ошибку валидации.

errors -> (список)

Описание ошибки валидации.

(строка)

validationWarnings -> (список)

Предупреждения валидации, связанные с объектами, определенными в pipelineObjects.

(структура)

Определяет предупреждение валидации. Предупреждения валидации не препятствуют активации конвейерной линии. Набор предупреждений валидации, которые могут быть возвращены, определен в AWS Data Pipeline.

id -> (строка)

Идентификатор объекта, содержащего предупреждение валидации.

warnings -> (список)

Описание предупреждения валидации.

(строка)

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

Указывает, были ли ошибки валидации, и определение конвейерной линии сохранено, но не может быть активировано до тех пор, пока вы не исправите конвейерную линию и не вызовете PutPipelineDefinition для подтверждения исправленной конвейерной линии.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API