Spec-Zone.ru › AWS CLI v2

[ aws . codepipeline ]

list-pipeline-executions

Описание

Получает сводку последних выполнений для пайплайна.

Примечание

При применении фильтра для выполнений пайплайна, завершившихся успешно на этапе, операция возвращает все выполнения в текущей версии пайплайна, начиная с 1 февраля 2024 года.

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

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

Синтаксис

  list-pipeline-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 (структура)

Выполнение пайплайна для фильтрации.

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

Фильтр для выполнений пайплайна, где этап завершился успешно в текущей версии пайплайна.

stageName -> (строка)

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

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

succeededInStage={stageName=string}

Синтаксис JSON:

{
  "succeededInStage": {
    "stageName": "string"
  }
}

--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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

За исключением случаев, когда указано иное, во всех примерах используются правила цитирования, типичные для unix. Эти примеры нужно адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Просмотр истории выполнений пайплайна

Следующий list-pipeline-executions пример демонстрирует историю выполнения пайплайна для пайплайна в вашем аккаунте AWS.

aws codepipeline list-pipeline-executions \
    --pipeline-name MyPipeline

Вывод:

{
    "pipelineExecutionSummaries": [
        {
            "lastUpdateTime": 1496380678.648,
            "pipelineExecutionId": "7cf7f7cb-3137-539g-j458-d7eu3EXAMPLE",
            "startTime": 1496380258.243,
            "status": "Succeeded"
        },
        {
            "lastUpdateTime": 1496591045.634,
            "pipelineExecutionId": "3137f7cb-8d494hj4-039j-d84l-d7eu3EXAMPLE",
            "startTime": 1496590401.222,
            "status": "Succeeded"
        },
        {
            "lastUpdateTime": 1496946071.6456,
            "pipelineExecutionId": "4992f7jf-7cf7-913k-k334-d7eu3EXAMPLE",
            "startTime": 1496945471.5645,
            "status": "Succeeded"
        }
    ]
}

Дополнительная информация находится в разделе Просмотр истории выполнения в Руководстве пользователя AWS CodePipeline.

Вывод

pipelineExecutionSummaries -> (список)

Список выполнений в истории пайплайна.

(структура)

Сводная информация о выполнении пайплайна.

pipelineExecutionId -> (строка)

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

status -> (строка)

Статус выполнения пайплайна.

  • InProgress: Пайплайн выполняется в данный момент.
  • Stopped: Выполнение пайплайна было остановлено вручную. Для получения дополнительной информации см. Остановленные выполнения .
  • Stopping: Выполнение пайплайна получило запрос на ручную остановку. В зависимости от выбранного режима остановки, выполнение либо завершает текущие действия, либо отменяет их. Для получения дополнительной информации см. Остановленные выполнения .
  • Succeeded: Выполнение пайплайна было успешно завершено.
  • Superseded: Пока это выполнение пайплайна ожидает завершения следующей стадии, более новое выполнение продвинулось дальше и продолжило выполнение пайплайна. Для получения дополнительной информации см. Заменённые выполнения .
  • Failed: Выполнение пайплайна не было успешно завершено.

statusSummary -> (строка)

Сводка статуса пайплайна.

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

Дата и время начала выполнения пайплайна в формате временной метки.

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

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

sourceRevisions -> (список)

Список версий исходных артефактов, которые инициировали выполнение пайплайна.

(структура)

Информация о версии (или ревизии) исходного артефакта, который инициировал выполнение пайплайна.

actionName -> (строка)

Название действия, которое обработало ревизию исходного артефакта.

revisionId -> (строка)

Уникальный ID, сгенерированный системой, который идентифицирует номер ревизии артефакта.

revisionSummary -> (строка)

Сводная информация о последней ревизии артефакта. Для репозиториев GitHub и CodeCommit – сообщение коммита. Для ведер Amazon S3 или действий – предоставленное пользователем содержимое codepipeline-artifact-revision-summary ключа, указанного в метаданных объекта.

revisionUrl -> (строка)

ID коммита для ревизии артефакта. Для артефактов, хранящихся в репозиториях GitHub или CodeCommit, ID коммита связан со страницей с деталями коммита.

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

Взаимодействие или событие, которое инициировало выполнение пайплайна, например, автоматическое обнаружение изменений или вызов API StartPipelineExecution.

triggerType -> (строка)

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

triggerDetail -> (строка)

Подробности события, которое запустило выполнение пайплайна, например, ARN веб-хука веб-хука, который инициировал выполнение пайплайна, или ARN пользователя для пользовательской команды start-pipeline-execution CLI.

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

Взаимодействие, которое остановило выполнение пайплайна.

reason -> (строка)

Указанная пользователем причина остановки пайплайна.

executionMode -> (строка)

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

executionType -> (строка)

Тип выполнения пайплайна.

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

Метаданные для выполнения стадии, подлежащей откат.

rollbackTargetPipelineExecutionId -> (строка)

ID выполнения пайплайна, к которому будет откачена стадия.

nextToken -> (строка)

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

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

Spec-Zone.ru

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