Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

list-executions

Описание

Отображает все выполняемые задания для указанного рабочего процесса.

Примечание

Если указанный идентификатор рабочего процесса не найден, ListExecutions возвращает исключение ResourceNotFound.

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

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

Синтаксис

  list-executions
--workflow-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <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]

Параметры

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

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

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

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

Маркер для указания места начала постраничной загрузки. Это NextToken из ранее урезанного ответа.

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

--page-size (целое число)

Размер каждой страницы для получения данных в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выходных данных команды. Уменьшение размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить временное ограничение вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя 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
  • текст
  • таблица
  • 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.

Вывод

NextToken -> (строка)

ListExecutions возвращает параметр NextToken в выводе. Вы можете передать параметр NextToken в последующей команде для продолжения перечисления дополнительных заданий.

WorkflowId -> (строка)

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

Executions -> (список)

Возвращает подробности каждого задания в массиве ListedExecution.

(структура)

Возвращает свойства указанного задания.

ExecutionId -> (строка)

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

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

Структура, описывающая расположение файла Amazon S3 или EFS. Это расположение файла при запуске задания: если файл копируется, это начальное (а не целевое) расположение файла.

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

Указывает детали S3 для используемого файла, такие как ведро, ETag и т. д.

Bucket -> (строка)

Указывает S3-ведро, содержащее используемый файл.

Key -> (строка)

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

VersionId -> (строка)

Указывает версию файла.

Etag -> (строка)

Тег сущности — это хэш объекта. ETag отражает изменения только содержимого объекта, а не его метаданных.

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

Указывает идентификатор Amazon EFS и путь к используемому файлу.

FileSystemId -> (строка)

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

Path -> (строка)

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

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

Контейнерный объект для данных сеанса, связанных с рабочим процессом.

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

Идентификатор сервера (ServerId), идентификатор сеанса (SessionId) и пользователь (UserName) составляют UserDetails.

UserName -> (строка)

Уникальная строка, идентифицирующая пользователя Transfer Family, связанного с сервером.

ServerId -> (строка)

Уникальный идентификатор, назначенный системой, для экземпляра сервера Transfer.

SessionId -> (строка)

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

Status -> (строка)

Статус — это один из статусов выполнения. Может быть в процессе выполнения, завершен, произошла ошибка или обрабатывается исключение.

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

Spec-Zone.ru

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