описание-потока

Описание

Описывает указанный поток.

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

Синтаксис

  describe-workflow
--workflow-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]

Параметры

--workflow-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
текст
таблица
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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку fileb://, всегда будет обрабатываться как двоичное и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое)

Отключить кли-вьювер для вывода.

--cli-auto-prompt (логическое)

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

--no-cli-auto-prompt (логическое)

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

Вывод

Рабочий процесс -> (структура)

Структура, содержащая детали рабочего процесса.

Arn -> (строка)

Указывает уникальное имя Amazon Resource Name (ARN) для рабочего процесса.

Описание -> (строка)

Указывает текстовое описание рабочего процесса.

Шаги -> (список)

Указывает детали шагов, которые находятся в указанном рабочем процессе.

(структура)

Основной строительный блок рабочего процесса.

Тип -> (строка)

В настоящее время поддерживаются следующие типы шагов.

**COPY ** - Скопировать файл в другое место.
**CUSTOM ** - Выполнить пользовательский шаг с целевой функцией Lambda.
**DECRYPT ** - Расшифровать файл, который был зашифрован до загрузки.
**DELETE ** - Удалить файл.
**TAG ** - Добавить метку к файлу.

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, который копируется или расшифровывается.

Ведро -> (строка)

Указывает ведро S3 для входного файла клиента.

Ключ -> (строка)

Имя, присвоенное файлу при его создании в Amazon S3. Используйте ключ объекта для получения объекта.

EfsFileLocation -> (структура)

Указывает детали файла Amazon Elastic File System (Amazon EFS), который расшифровывается.

FileSystemId -> (строка)

Идентификатор файловой системы, присвоенный Amazon EFS.

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

Путь к папке, используемой рабочим процессом.

OverwriteExisting -> (строка)

Флаг, указывающий, следует ли перезаписывать существующий файл с тем же именем. По умолчанию значение FALSE.

Если рабочий процесс обрабатывает файл с тем же именем, что и существующий файл, поведение следующее:

Если OverwriteExisting имеет значение TRUE, существующий файл заменяется обрабатываемым файлом.
Если OverwriteExisting имеет значение FALSE, ничего не происходит, и обработка рабочего процесса останавливается.

SourceFileLocation -> (строка)

Указывает, какой файл использовать в качестве входных данных для шага рабочего процесса: выходные данные предыдущего шага или исходный загруженный файл для рабочего процесса.

Для использования предыдущего файла в качестве входных данных введите ${previous.file}. В этом случае шаг рабочего процесса использует выходной файл предыдущего шага рабочего процесса в качестве входных данных. Это значение по умолчанию.
Для использования исходного загруженного файла в качестве входных данных для этого шага введите ${original.file}.

CustomStepDetails -> (структура)

Подробности шага, вызывающего функцию Lambda.

Состоит из имени функции Lambda, целевого значения и таймаута (в секундах).

Имя -> (строка)

Имя шага, используемое в качестве идентификатора.

Цель -> (строка)

ARN для вызываемой функции 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, который копируется или расшифровывается.

Ведро -> (строка)

Указывает ведро S3 для входного файла клиента.

Ключ -> (строка)

Имя, присвоенное файлу при его создании в Amazon S3. Используйте ключ объекта для получения объекта.

EfsFileLocation -> (структура)

Указывает детали файла Amazon Elastic File System (Amazon EFS), который расшифровывается.

FileSystemId -> (строка)

Идентификатор файловой системы, присвоенный Amazon EFS.

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

Путь к папке, используемой рабочим процессом.

OnExceptionSteps -> (список)

Определяет шаги (действия), которые необходимо выполнить в случае возникновения ошибок во время выполнения рабочей последовательности.

(структура)

Основной строительный блок рабочей последовательности.

Тип -> (строка)

В настоящее время поддерживаются следующие типы шагов.

**COPY ** - Скопировать файл в другое местоположение.
**CUSTOM ** - Выполнить пользовательский шаг с целевой функцией Lambda.
**DECRYPT ** - Расшифровать файл, который был зашифрован до загрузки.
**DELETE ** - Удалить файл.
**TAG ** - Добавить метку к файлу.

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, который копируется или расшифровывается.

Ведро -> (строка)

Указывает ведро S3 для входного файла клиента.

Ключ -> (строка)

Имя, назначенное файлу при его создании в Amazon S3. Для получения объекта используется ключ объекта.

EfsFileLocation -> (структура)

Указывает подробности для файла Amazon Elastic File System (Amazon EFS), который расшифровывается.

FileSystemId -> (строка)

Идентификатор файловой системы, назначенный Amazon EFS.

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

Путь к папке, используемой рабочей последовательностью.

OverwriteExisting -> (строка)

Флаг, указывающий, следует ли перезаписывать существующий файл с тем же именем. Значение по умолчанию — FALSE.

Если рабочая последовательность обрабатывает файл с тем же именем, что и существующий файл, поведение следующее:

Если OverwriteExisting равно TRUE, существующий файл заменяется обрабатываемым файлом.
Если OverwriteExisting равно FALSE, ничего не происходит, и обработка рабочей последовательности прекращается.

SourceFileLocation -> (строка)

Указывает, какой файл использовать в качестве входных данных для шага рабочей последовательности: либо вывод предыдущего шага, либо исходный загруженный файл для рабочей последовательности.

Чтобы использовать предыдущий файл в качестве входных данных, введите ${previous.file}. В этом случае этот шаг рабочей последовательности использует выходной файл из предыдущего шага рабочей последовательности в качестве входных данных. Это значение по умолчанию.
Чтобы использовать исходное расположение загруженного файла в качестве входных данных для этого шага, введите ${original.file}.

CustomStepDetails -> (структура)

Подробности для шага, вызывающего функцию Lambda.

Содержит имя, целевой адрес и таймаут (в секундах) функции Lambda.

Имя -> (строка)

Имя шага, используемое в качестве идентификатора.

Целевой адрес -> (строка)

ARN функции 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, который копируется или расшифровывается.

Ведро -> (строка)

Указывает ведро S3 для входного файла клиента.

Ключ -> (строка)

Имя, назначенное файлу при его создании в Amazon S3. Для получения объекта используется ключ объекта.

EfsFileLocation -> (структура)

Указывает подробности для файла Amazon Elastic File System (Amazon EFS), который расшифровывается.

FileSystemId -> (строка)

Идентификатор файловой системы, назначенный Amazon EFS.

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

Путь к папке, используемой рабочей последовательностью.

WorkflowId -> (строка)

Уникальный идентификатор рабочей последовательности.

Метки -> (список)

Пары ключ-значение, которые могут использоваться для группировки и поиска рабочих последовательностей. Метки — метаданные, прикрепленные к рабочим последовательностям для любых целей.

(структура)

Создает пару ключ-значение для конкретного ресурса. Метки — метаданные, которые вы можете использовать для поиска и группировки ресурса в различных целях. Вы можете применять метки к серверам, пользователям и ролям. Ключ метки может принимать несколько значений. Например, для группировки серверов в целях бухгалтерского учета вы можете создать метку, называемую Group, и назначить значения Research и Accounting этой группе.

Ключ -> (строка)

Имя создаваемой метки.

Значение -> (строка)

Содержит одно или несколько значений, которые вы назначили имени ключа, которое вы создали.

END_OF_DOCUMENT_MARKER