create-workflow
Описание
Позволяет создать рабочие процесс со специфицированными шагами и деталями шагов, которые рабочие процесс вызывает после завершения передачи файла. После создания рабочего процесса, вы можете связать созданный рабочий процесс с любыми серверами передачи, указав поле workflow-details в операциях CreateServer и UpdateServer.
См. также: Документацию AWS API
Синтаксис
create-workflow
[--description <value>]
--steps <value>
[--on-exception-steps <value>]
[--tags <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]
Параметры
--description (строка)
--steps (список)
Указывает детали для шагов, которые находятся в указанном рабочем процессе.
TYPE указывает, какое из следующих действий выполняется на данном шаге.
-
**
COPY** - Скопировать файл в другое место. -
**
CUSTOM** - Выполнить пользовательский шаг с целевой функцией Lambda. -
**
DECRYPT** - Расшифровать файл, который был зашифрован перед загрузкой. -
**
DELETE** - Удалить файл. -
**
TAG** - Добавить тег к файлу.
Примечание
В настоящее время копирование и добавление тегов поддерживаются только для S3.Для расположения файла вы указываете либо ведро и ключ Amazon S3, либо идентификатор и путь файловой системы Amazon EFS.
(структура)
Основной строительный блок рабочего процесса.
Тип -> (строка)
В настоящее время поддерживаются следующие типы шагов.
CopyStepDetails -> (структура)
Подробности для шага, выполняющего копирование файла.
Состоит из следующих значений:
- Описание
- Расположение в Amazon S3 для назначения копии файла.
- Флаг, указывающий, следует ли перезаписывать существующий файл с тем же именем. По умолчанию -
FALSE.
Имя -> (строка)
DestinationFileLocation -> (структура)
Указывает расположение копируемого файла. Используйте ${Transfer:UserName} или ${Transfer:UploadDate} в этом поле, чтобы параметризовать префикс назначения по имени пользователя или дате загрузки.
- Установите значение
DestinationFileLocationв${Transfer:UserName}, чтобы копировать загруженные файлы в ведро Amazon S3 с префиксом, содержащим имя пользователя Transfer Family, который загрузил файл. - Установите значение
DestinationFileLocationв${Transfer:UploadDate}, чтобы копировать загруженные файлы в ведро Amazon S3 с префиксом, содержащим дату загрузки.
Примечание
Система разрешаетUploadDate в формат даты ГГГГ-ММ-ДД, основываясь на дате загрузки файла в UTC.S3FileLocation -> (структура)
Указывает подробности для файла Amazon S3, который копируется или расшифровывается.
Ведро -> (строка)
Ключ -> (строка)
EfsFileLocation -> (структура)
Указывает подробности для файла Amazon Elastic File System (Amazon EFS), который расшифровывается.
FileSystemId -> (строка)
Путь -> (строка)
OverwriteExisting -> (строка)
Флаг, указывающий, следует ли перезаписывать существующий файл с тем же именем. По умолчанию - FALSE.
Если рабочий процесс обрабатывает файл с тем же именем, что и существующий файл, поведение следующее:
- Если
OverwriteExistingравноTRUE, существующий файл заменяется обрабатываемым файлом. - Если
OverwriteExistingравноFALSE, ничего не происходит, и обработка рабочего процесса останавливается.
SourceFileLocation -> (строка)
Указывает, какой файл использовать в качестве входных данных для шага рабочего процесса: выходные данные предыдущего шага или изначально загруженный файл для рабочего процесса.
- Для использования предыдущего файла в качестве входных данных введите
${previous.file}. В этом случае шаг рабочего процесса использует выходной файл предыдущего шага рабочего процесса в качестве входных данных. Это значение по умолчанию. - Для использования исходного загруженного файла в качестве входных данных для этого шага введите
${original.file}.
CustomStepDetails -> (структура)
Подробности для шага, вызывающего функцию Lambda.
Состоит из имени функции Lambda, целевого объекта и таймаута (в секундах).
Имя -> (строка)
Целевой объект -> (строка)
TimeoutSeconds -> (целое число)
SourceFileLocation -> (строка)
Указывает, какой файл использовать в качестве входных данных для шага рабочего процесса: выходные данные предыдущего шага или изначально загруженный файл для рабочего процесса.
- Для использования предыдущего файла в качестве входных данных введите
${previous.file}. В этом случае шаг рабочего процесса использует выходной файл предыдущего шага рабочего процесса в качестве входных данных. Это значение по умолчанию. - Для использования исходного загруженного файла в качестве входных данных для этого шага введите
${original.file}.
DeleteStepDetails -> (структура)
Подробности для шага, удаляющего файл.
Имя -> (строка)
SourceFileLocation -> (строка)
Указывает, какой файл использовать в качестве входных данных для шага рабочего процесса: выходные данные предыдущего шага или изначально загруженный файл для рабочего процесса.
- Для использования предыдущего файла в качестве входных данных введите
${previous.file}. В этом случае шаг рабочего процесса использует выходной файл предыдущего шага рабочего процесса в качестве входных данных. Это значение по умолчанию. - Для использования исходного загруженного файла в качестве входных данных для этого шага введите
${original.file}.
TagStepDetails -> (структура)
Подробности для шага, создающего один или несколько тегов.
Вы указываете один или несколько тегов. Каждый тег содержит пару ключ-значение.
Имя -> (строка)
Теги -> (список)
Массив, содержащий от 1 до 10 пар ключ/значение.
(структура)
Указывает пару ключ-значение, которая назначается файлу во время выполнения шага «Тегирование».
Ключ -> (строка)
Значение -> (строка)
SourceFileLocation -> (строка)
Указывает, какой файл использовать в качестве входных данных для шага рабочего процесса: выходные данные предыдущего шага или изначально загруженный файл для рабочего процесса.
- Для использования предыдущего файла в качестве входных данных введите
${previous.file}. В этом случае шаг рабочего процесса использует выходной файл предыдущего шага рабочего процесса в качестве входных данных. Это значение по умолчанию. - Для использования исходного загруженного файла в качестве входных данных для этого шага введите
${original.file}.
DecryptStepDetails -> (структура)
Подробности для шага, расшифровывающего зашифрованный файл.
Состоит из следующих значений:
- Описание
- Расположение в Amazon S3 или Amazon Elastic File System (Amazon EFS) для исходного файла для расшифровки.
- Расположение в S3 или Amazon EFS для назначения расшифрованного файла.
- Флаг, указывающий, следует ли перезаписывать существующий файл с тем же именем. По умолчанию -
FALSE. - Тип шифрования, который используется. В настоящее время поддерживается только шифрование PGP.
Имя -> (строка)
Тип -> (строка)
PGP.SourceFileLocation -> (строка)
Указывает, какой файл использовать в качестве входных данных для шага рабочего процесса: выходные данные предыдущего шага или изначально загруженный файл для рабочего процесса.
- Для использования предыдущего файла в качестве входных данных введите
${previous.file}. В этом случае шаг рабочего процесса использует выходной файл предыдущего шага рабочего процесса в качестве входных данных. Это значение по умолчанию. - Для использования исходного загруженного файла в качестве входных данных для этого шага введите
${original.file}.
OverwriteExisting -> (строка)
Флаг, указывающий, следует ли перезаписывать существующий файл с тем же именем. По умолчанию - FALSE.
Если рабочий процесс обрабатывает файл с тем же именем, что и существующий файл, поведение следующее:
- Если
OverwriteExistingравноTRUE, существующий файл заменяется обрабатываемым файлом. - Если
OverwriteExistingравноFALSE, ничего не происходит, и обработка рабочего процесса останавливается.
DestinationFileLocation -> (структура)
Указывает расположение для расшифровываемого файла. Используйте ${Transfer:UserName} или ${Transfer:UploadDate} в этом поле, чтобы параметризовать префикс назначения по имени пользователя или дате загрузки.
- Установите значение
DestinationFileLocationв${Transfer:UserName}, чтобы расшифровать загруженные файлы в ведро Amazon S3 с префиксом, содержащим имя пользователя Transfer Family, который загрузил файл. - Установите значение
DestinationFileLocationв${Transfer:UploadDate}, чтобы расшифровать загруженные файлы в ведро Amazon S3 с префиксом, содержащим дату загрузки.
Примечание
Система разрешаетUploadDate в формат даты ГГГГ-ММ-ДД, основываясь на дате загрузки файла в UTC.S3FileLocation -> (структура)
Указывает подробности для файла Amazon S3, который копируется или расшифровывается.
Ведро -> (строка)
Ключ -> (строка)
EfsFileLocation -> (структура)
Указывает подробности для файла Amazon Elastic File System (Amazon EFS), который расшифровывается.
FileSystemId -> (строка)
Путь -> (строка)
JSON Синтаксис:
[
{
"Type": "COPY"|"CUSTOM"|"TAG"|"DELETE"|"DECRYPT",
"CopyStepDetails": {
"Name": "string",
"DestinationFileLocation": {
"S3FileLocation": {
"Bucket": "string",
"Key": "string"
},
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
}
},
"OverwriteExisting": "TRUE"|"FALSE",
"SourceFileLocation": "string"
},
"CustomStepDetails": {
"Name": "string",
"Target": "string",
"TimeoutSeconds": integer,
"SourceFileLocation": "string"
},
"DeleteStepDetails": {
"Name": "string",
"SourceFileLocation": "string"
},
"TagStepDetails": {
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
...
],
"SourceFileLocation": "string"
},
"DecryptStepDetails": {
"Name": "string",
"Type": "PGP",
"SourceFileLocation": "string",
"OverwriteExisting": "TRUE"|"FALSE",
"DestinationFileLocation": {
"S3FileLocation": {
"Bucket": "string",
"Key": "string"
},
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
}
}
}
}
...
]
--on-exception-steps (список)
Указывает шаги (действия), которые нужно выполнить при возникновении ошибок во время выполнения рабочей последовательности.
Примечание
Для пользовательских шагов функция Lambda должна отправитьFAILURE в API обратного вызова, чтобы запустить шаги обработки исключений. Кроме того, если Lambda не отправит SUCCESS до истечения времени ожидания, шаги обработки исключений будут выполнены.(структура)
Основной структурный блок рабочей последовательности.
Тип -> (строка)
В настоящее время поддерживаются следующие типы шагов.
CopyStepDetails -> (структура)
Подробности шага, выполняющего копирование файла.
Содержит следующие значения:
- Описание
- Расположение в Amazon S3 для места назначения копируемого файла.
- Флаг, указывающий, следует ли перезаписывать существующий файл с тем же именем. По умолчанию -
FALSE.
Имя -> (строка)
DestinationFileLocation -> (структура)
Указывает расположение для копируемого файла. Используйте ${Transfer:UserName} или ${Transfer:UploadDate} в этом поле для параметризации префикса назначения по имени пользователя или дате загрузки.
- Установите значение
DestinationFileLocationв значение${Transfer:UserName}, чтобы копировать загруженные файлы в ведро Amazon S3 с префиксом имени пользователя Transfer Family, загрузившего файл. - Установите значение
DestinationFileLocationв значение${Transfer:UploadDate}, чтобы копировать загруженные файлы в ведро Amazon S3 с префиксом даты загрузки.
Примечание
Система преобразуетUploadDate в формат даты ГГГГ-ММ-ДД, основанный на дате загрузки файла в UTC.S3FileLocation -> (структура)
Указывает детали для файла Amazon S3, который копируется или расшифровывается.
Ведро -> (строка)
Ключ -> (строка)
EfsFileLocation -> (структура)
Указывает детали для файла Amazon Elastic File System (Amazon EFS), который расшифровывается.
FileSystemId -> (строка)
Путь -> (строка)
OverwriteExisting -> (строка)
Флаг, указывающий, следует ли перезаписывать существующий файл с тем же именем. По умолчанию - FALSE .
Если рабочая последовательность обрабатывает файл с тем же именем, что и существующий файл, поведение следующее:
- Если
OverwriteExistingравноTRUE, существующий файл заменяется обрабатываемым файлом. - Если
OverwriteExistingравноFALSE, ничего не происходит, и обработка рабочей последовательности прекращается.
SourceFileLocation -> (строка)
Указывает, какой файл использовать в качестве входных данных для шага рабочей последовательности: выходные данные предыдущего шага или изначально загруженный файл для рабочей последовательности.
- Чтобы использовать предыдущий файл в качестве входных данных, введите
${previous.file}. В этом случае этот шаг рабочей последовательности использует выходной файл предыдущего шага рабочей последовательности в качестве входных данных. Это значение по умолчанию. - Чтобы использовать исходное расположение загруженного файла в качестве входных данных для этого шага, введите
${original.file}.
CustomStepDetails -> (структура)
Подробности шага, вызывающего функцию Lambda.
Содержит имя функции Lambda, цель и время ожидания (в секундах).
Имя -> (строка)
Цель -> (строка)
TimeoutSeconds -> (целое число)
SourceFileLocation -> (строка)
Указывает, какой файл использовать в качестве входных данных для шага рабочей последовательности: выходные данные предыдущего шага или изначально загруженный файл для рабочей последовательности.
- Чтобы использовать предыдущий файл в качестве входных данных, введите
${previous.file}. В этом случае этот шаг рабочей последовательности использует выходной файл предыдущего шага рабочей последовательности в качестве входных данных. Это значение по умолчанию. - Чтобы использовать исходное расположение загруженного файла в качестве входных данных для этого шага, введите
${original.file}.
DeleteStepDetails -> (структура)
Подробности шага, удаляющего файл.
Имя -> (строка)
SourceFileLocation -> (строка)
Указывает, какой файл использовать в качестве входных данных для шага рабочей последовательности: выходные данные предыдущего шага или изначально загруженный файл для рабочей последовательности.
- Чтобы использовать предыдущий файл в качестве входных данных, введите
${previous.file}. В этом случае этот шаг рабочей последовательности использует выходной файл предыдущего шага рабочей последовательности в качестве входных данных. Это значение по умолчанию. - Чтобы использовать исходное расположение загруженного файла в качестве входных данных для этого шага, введите
${original.file}.
TagStepDetails -> (структура)
Подробности шага, создающего один или несколько тегов.
Вы указываете один или несколько тегов. Каждый тег содержит пару ключ-значение.
Имя -> (строка)
Tags -> (список)
Массив, содержащий от 1 до 10 пар ключ/значение.
(структура)
Указывает пару ключ-значение, которая назначается файлу во время выполнения шага тегирования.
Ключ -> (строка)
Значение -> (строка)
SourceFileLocation -> (строка)
Указывает, какой файл использовать в качестве входных данных для шага рабочей последовательности: выходные данные предыдущего шага или изначально загруженный файл для рабочей последовательности.
- Чтобы использовать предыдущий файл в качестве входных данных, введите
${previous.file}. В этом случае этот шаг рабочей последовательности использует выходной файл предыдущего шага рабочей последовательности в качестве входных данных. Это значение по умолчанию. - Чтобы использовать исходное расположение загруженного файла в качестве входных данных для этого шага, введите
${original.file}.
DecryptStepDetails -> (структура)
Подробности шага, расшифровывающего зашифрованный файл.
Содержит следующие значения:
- Описание
- Расположение в Amazon S3 или Amazon Elastic File System (Amazon EFS) для исходного файла для расшифровки.
- Расположение в S3 или Amazon EFS для места назначения расшифрованного файла.
- Флаг, указывающий, следует ли перезаписывать существующий файл с тем же именем. По умолчанию -
FALSE. - Тип используемого шифрования. В настоящее время поддерживается только шифрование PGP.
Имя -> (строка)
Тип -> (строка)
PGP .SourceFileLocation -> (строка)
Указывает, какой файл использовать в качестве входных данных для шага рабочей последовательности: выходные данные предыдущего шага или изначально загруженный файл для рабочей последовательности.
- Чтобы использовать предыдущий файл в качестве входных данных, введите
${previous.file}. В этом случае этот шаг рабочей последовательности использует выходной файл предыдущего шага рабочей последовательности в качестве входных данных. Это значение по умолчанию. - Чтобы использовать исходное расположение загруженного файла в качестве входных данных для этого шага, введите
${original.file}.
OverwriteExisting -> (строка)
Флаг, указывающий, следует ли перезаписывать существующий файл с тем же именем. По умолчанию - FALSE .
Если рабочая последовательность обрабатывает файл с тем же именем, что и существующий файл, поведение следующее:
- Если
OverwriteExistingравноTRUE, существующий файл заменяется обрабатываемым файлом. - Если
OverwriteExistingравноFALSE, ничего не происходит, и обработка рабочей последовательности прекращается.
DestinationFileLocation -> (структура)
Указывает расположение для расшифровываемого файла. Используйте ${Transfer:UserName} или ${Transfer:UploadDate} в этом поле для параметризации префикса назначения по имени пользователя или дате загрузки.
- Установите значение
DestinationFileLocationв значение${Transfer:UserName}, чтобы расшифровать загруженные файлы в ведро Amazon S3 с префиксом имени пользователя Transfer Family, загрузившего файл. - Установите значение
DestinationFileLocationв значение${Transfer:UploadDate}, чтобы расшифровать загруженные файлы в ведро Amazon S3 с префиксом даты загрузки.
Примечание
Система преобразуетUploadDate в формат даты ГГГГ-ММ-ДД, основанный на дате загрузки файла в UTC.S3FileLocation -> (структура)
Указывает детали для файла Amazon S3, который копируется или расшифровывается.
Ведро -> (строка)
Ключ -> (строка)
EfsFileLocation -> (структура)
Указывает детали для файла Amazon Elastic File System (Amazon EFS), который расшифровывается.
FileSystemId -> (строка)
Путь -> (строка)
Синтаксис JSON:
[
{
"Type": "COPY"|"CUSTOM"|"TAG"|"DELETE"|"DECRYPT",
"CopyStepDetails": {
"Name": "string",
"DestinationFileLocation": {
"S3FileLocation": {
"Bucket": "string",
"Key": "string"
},
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
}
},
"OverwriteExisting": "TRUE"|"FALSE",
"SourceFileLocation": "string"
},
"CustomStepDetails": {
"Name": "string",
"Target": "string",
"TimeoutSeconds": integer,
"SourceFileLocation": "string"
},
"DeleteStepDetails": {
"Name": "string",
"SourceFileLocation": "string"
},
"TagStepDetails": {
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
...
],
"SourceFileLocation": "string"
},
"DecryptStepDetails": {
"Name": "string",
"Type": "PGP",
"SourceFileLocation": "string",
"OverwriteExisting": "TRUE"|"FALSE",
"DestinationFileLocation": {
"S3FileLocation": {
"Bucket": "string",
"Key": "string"
},
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
}
}
}
}
...
]
--tags (список)
Пары ключ-значение, которые могут быть использованы для группирования и поиска рабочих процессов. Теги — это метаданные, прикрепленные к рабочим процессам для любых целей.
(структура)
Создает пару ключ-значение для определенного ресурса. Теги — это метаданные, которые можно использовать для поиска и группирования ресурса в различных целях. Вы можете применять теги к серверам, пользователям и ролям. Ключ тега может принимать более одного значения. Например, для группирования серверов в бухгалтерских целях можно создать тег с названием Group и назначить значения Research и Accounting этой группе.
Ключ -> (строка)
Значение -> (строка)
Сокращенная синтаксическая запись:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "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 (строка)
Переопределить адрес по умолчанию команды заданным адресом.
--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.
Вывод
WorkflowId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.