Spec-Zone.ru › AWS CLI v2

[ aws . codepipeline ]

list-rule-executions

Описание

Отображает исполнения правил, произошедшие в конвейере, настроенном для условий с правилами.

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

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

Синтаксис

  list-rule-executions
--pipeline-name <value>
[--filter <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]

Параметры

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

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

--filter (структура)

Информация для фильтрации истории исполнения правил.

pipelineExecutionId -> (строка)

Идентификатор исполнения конвейера для фильтрации истории исполнения правил.

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

Поле для фильтрации по последнему исполнению в конвейере.

Примечание

Фильтрация по последнему исполнению доступна для исполнений, запущенных 08 февраля 2024 года или позже.

pipelineExecutionId -> (строка)

Идентификатор исполнения для последнего исполнения в конвейере.

startTimeRange -> (строка)

Время начала для фильтрации по последнему исполнению в конвейере. Допустимые значения:

  • All
  • Latest

Сокращенный синтаксис:

pipelineExecutionId=string,latestInPipelineExecution={pipelineExecutionId=string,startTimeRange=string}

Синтаксис JSON:

{
  "pipelineExecutionId": "string",
  "latestInPipelineExecution": {
    "pipelineExecutionId": "string",
    "startTimeRange": "Latest"|"All"
  }
}

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

ruleExecutionDetails -> (список)

Подробная информация о выводе для просмотра выполнения правил.

(структура)

Подробности о выполнении правила и результатах, полученных для артефакта при прохождении этапов в конвейере.

pipelineExecutionId -> (строка)

Идентификатор выполнения конвейера на этапе, где было выполнено правило. Используйте действие GetPipelineState для получения текущего pipelineExecutionId этапа.

ruleExecutionId -> (строка)

Идентификатор выполнения правила.

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

Номер версии конвейера с этапом, где было выполнено правило.

stageName -> (строка)

Название этапа, на котором было выполнено правило.

ruleName -> (строка)

Имя правила, которое было выполнено на этапе.

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

Время начала выполнения правила.

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

Дата и время последнего изменения выполнения правила в формате метки времени.

updatedBy -> (строка)

ARN пользователя, который изменил данные о выполнении правила.

status -> (строка)

Статус выполнения правила. Категории статусов являются InProgress , Succeeded и Failed .

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

Подробности входных данных для выполнения правила, такие как ARN роли, регион и входные артефакты.

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

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

category -> (строка)

Категория определяет тип правила, которое может быть выполнено на этапе, и ограничивает тип поставщика для правила. Действительная категория - Rule .

owner -> (строка)

Создатель вызываемого правила. Действительное значение для поля Owner в категории правил - AWS .

provider -> (строка)

Поставщик правил, например, правило DeploymentWindow . Список названий поставщиков правил см. в справочнике по правилам CodePipeline.

version -> (строка)

Строка, описывающая версию правила.

configuration -> (карта)

Данные конфигурации для выполнения правила, такие как разрешенные значения для данного запуска.

key -> (строка)

value -> (строка)

resolvedConfiguration -> (карта)

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

key -> (строка)

value -> (строка)

roleArn -> (строка)

ARN службы IAM, которая выполняет объявленное правило. Это предполагается через roleArn для конвейера.

region -> (строка)

Регион Amazon Web Services для правила, например, us-east-1.

inputArtifacts -> (список)

Подробности входных артефактов правила, соответствующих выполнению правила.

(структура)

Подробности артефакта для выполнения действия, такие как местоположение артефакта.

name -> (строка)

Имя объекта артефакта для выполнения действия.

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

Местоположение артефакта Amazon S3 для выполнения действия.

bucket -> (строка)

Ведро Amazon S3 для артефактов действия.

key -> (строка)

Имя артефакта.

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

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

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

Информация о результате выполнения, указанная в подробностях вывода для выполнения правила.

externalExecutionId -> (строка)

Внешний идентификатор для выполнения правила.

externalExecutionSummary -> (строка)

Резюме внешнего поставщика для выполнения правила.

externalExecutionUrl -> (строка)

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

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

Представляет информацию об ошибке в CodePipeline.

code -> (строка)

Системный идентификатор или номер кода ошибки.

message -> (строка)

Текст сообщения об ошибке.

nextToken -> (строка)

Токен, который может быть использован в следующем запросе ListRuleExecutions . Для просмотра всех элементов в списке, продолжайте вызывать эту операцию с каждым последующим токеном, пока не будут возвращены больше значений nextToken.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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