Spec-Zone.ru › AWS CLI v2

[ aws . customer-profiles ]

получить-поток-работы

Описание

Получить подробности указанного потока работы.

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

Синтаксис

  get-workflow
--domain-name <value>
--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]

Параметры

--domain-name (строка)

Уникальное имя домена.

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

  • base64
  • raw-in-base64-out

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

Отключить просмотрщик командной строки для вывода.

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

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

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

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

Вывод

WorkflowId -> (строка)

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

WorkflowType -> (строка)

Тип потока работы. Единственное поддерживаемое значение — APPFLOW_INTEGRATION.

Status -> (строка)

Статус выполнения потока работы.

ErrorDescription -> (строка)

Сообщения об ошибках потока работы во время выполнения (если таковые имеются).

StartDate -> (метка времени)

Отметка времени начала выполнения потока работы.

LastUpdatedAt -> (метка времени)

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

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

Атрибуты, предоставленные для выполнения потока работы.

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

Атрибуты потока работы, специфичные для потока работы APPFLOW_INTEGRATION.

SourceConnectorType -> (строка)

Указывает тип коннектора источника, например Salesforce, ServiceNow и Marketo. Указывает источник загрузки.

ConnectorProfileName -> (строка)

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

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM. Customer Profiles принимает эту роль, чтобы создавать ресурсы от вашего имени в рамках выполнения потока работы.

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

Метрики выполнения, специфичные для потока работы.

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

Метрики выполнения потока работы для потока работы APPFLOW_INTEGRATION.

RecordsProcessed -> (целое число)

Количество обработанных записей в потоке работы APPFLOW_INTEGRATION.

StepsCompleted -> (целое число)

Общее количество завершенных шагов в потоке работы APPFLOW_INTEGRATION.

TotalSteps -> (целое число)

Общее количество шагов в потоке работы APPFLOW_INTEGRATION.

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

Spec-Zone.ru

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