Spec-Zone.ru › AWS CLI v2

[ aws . codepipeline ]

get-pipeline-state

Описание

Возвращает информацию о состоянии пайплайна, включая стадии и действия.

Примечание

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

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

Синтаксис

  get-pipeline-state
--name <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]

Параметры

--name (строка)

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

--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
  • 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 (логическое значение)

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

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

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

Примеры

Примечание

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

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

Для получения информации о состоянии пайплайна

Этот пример возвращает последнее состояние пайплайна с именем MyFirstPipeline.

Команда:

aws codepipeline get-pipeline-state --name MyFirstPipeline

Вывод:

{
 "created": 1446137312.204,
 "pipelineName": "MyFirstPipeline",
 "pipelineVersion": 1,
 "stageStates": [
  {
    "actionStates": [
      {
        "actionName": "Source",
        "entityUrl": "https://console.aws.amazon.com/s3/home?#",
        "latestExecution": {
          "lastStatusChange": 1446137358.328,
          "status": "Succeeded"
        }
      }
    ],
    "stageName": "Source"
  },
  {
    "actionStates": [
      {
        "actionName": "CodePipelineDemoFleet",
        "entityUrl": "https://console.aws.amazon.com/codedeploy/home?#/applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet",
        "latestExecution": {
          "externalExecutionId": "d-EXAMPLE",
          "externalExecutionUrl": "https://console.aws.amazon.com/codedeploy/home?#/deployments/d-EXAMPLE",
          "lastStatusChange": 1446137493.131,
          "status": "Succeeded",
          "summary": "Deployment Succeeded"
        }
      }
    ],
    "inboundTransitionState": {
      "enabled": true
    },
    "stageName": "Beta"
  }
 ],
 "updated": 1446137312.204
}

Вывод

pipelineName -> (строка)

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

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

Номер версии конвейера.

Примечание

Созданный конвейер всегда получает номер версии 1.

stageStates -> (список)

Список информации о состоянии этапов конвейера, включая имя этапа, состояние, последние данные о выполнении, отключение этапа и другие данные.

(структура)

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

stageName -> (строка)

Имя этапа.

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

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

pipelineExecutionId -> (строка)

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

status -> (строка)

Состояние этапа или, для завершенного этапа, последнее состояние этапа.

Примечание

Состояние «отменено» означает, что определение конвейера было обновлено до завершения выполнения этапа.

type -> (строка)

Тип выполнения конвейера для этапа, например, выполнение конвейера отката.

inboundExecutions -> (список)

Входящие выполнения для этапа.

(структура)

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

pipelineExecutionId -> (строка)

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

status -> (строка)

Состояние этапа или, для завершенного этапа, последнее состояние этапа.

Примечание

Состояние «отменено» означает, что определение конвейера было обновлено до завершения выполнения этапа.

type -> (строка)

Тип выполнения конвейера для этапа, например, выполнение конвейера отката.

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

Состояние входящего перехода, которое может быть включено или выключено.

enabled -> (булево)

Включён переход между этапами (true) или выключён (false).

lastChangedBy -> (строка)

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

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

Метка времени последнего изменения состояния перехода.

disabledReason -> (строка)

Указанная пользователем причина отключения перехода между двумя этапами конвейера.

actionStates -> (список)

Состояние этапа.

(структура)

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

actionName -> (строка)

Имя действия.

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

Представляет информацию о версии (или ревизии) действия.

revisionId -> (строка)

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

revisionChangeId -> (строка)

Уникальный идентификатор изменения, установившего состояние в эту ревизию (например, идентификатор развертывания или метка времени).

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

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

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

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

actionExecutionId -> (строка)

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

Примечание

Для более старых выполнений это поле может быть пустым. Идентификатор выполнения действия доступен для выполнений, проведённых с марта 2020 года или позже.

status -> (строка)

Состояние действия или, для завершенного действия, последнее состояние действия.

summary -> (строка)

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

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

Последнее изменение статуса действия.

token -> (строка)

Сгенерированный системой токен, используемый для идентификации уникального запроса утверждения. Токен каждого открытого запроса утверждения можно получить, используя команду GetPipelineState. Он используется для проверки того, что запрос утверждения, соответствующий этому токену, по-прежнему действителен.

lastUpdatedBy -> (строка)

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

externalExecutionId -> (строка)

Внешний ID выполнения действия.

externalExecutionUrl -> (строка)

URL ресурса, внешнего Amazon Web Services, используемого при выполнении действия (например, URL внешнего репозитория).

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

Процент завершенности действия по мере его выполнения.

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

Подробности ошибки, возвращённой URL-адресом, внешним по отношению к Amazon Web Services.

code -> (строка)

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

message -> (строка)

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

logStreamARN -> (строка)

Amazon Resource Name (ARN) потока журнала для вычисления действия.

entityUrl -> (строка)

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

revisionUrl -> (строка)

Ссылка URL для получения дополнительной информации о ревизии, например, страницы сведений о коммите.

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

Информация о последнем выполнении в этапе, включая его ID и состояние.

pipelineExecutionId -> (строка)

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

status -> (строка)

Состояние этапа или, для завершенного этапа, последнее состояние этапа.

Примечание

Состояние «отменено» означает, что определение конвейера было обновлено до завершения выполнения этапа.

type -> (строка)

Тип выполнения конвейера для этапа, например, выполнение конвейера отката.

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

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

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

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

status -> (строка)

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

summary -> (строка)

Краткое описание выполнения условия для этапа.

conditionStates -> (список)

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

(структура)

Информация о состоянии условия.

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

Состояние последнего выполнения правила.

status -> (строка)

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

summary -> (строка)

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

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

Последнее изменение состояния условия.

ruleStates -> (список)

Состояние правил для условия.

(структура)

Возвращает информацию о состоянии правила.

Примечание

Значения, возвращаемые в поле revisionId, указывают на информацию о ревизии правила, такую как ID коммита, для текущего состояния.

ruleName -> (строка)

Имя правила.

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

Идентификатор текущей ревизии артефакта, успешно обработанного задачей.

revisionId -> (строка)

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

revisionChangeId -> (строка)

Уникальный идентификатор изменения, установившего состояние в эту ревизию (например, идентификатор развертывания или метка времени).

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

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

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

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

ruleExecutionId -> (строка)

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

status -> (строка)

Состояние выполнения правила, например, FAILED.

summary -> (строка)

Краткое описание выполнения правила.

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

Последнее изменение состояния правила.

token -> (строка)

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

lastUpdatedBy -> (строка)

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

externalExecutionId -> (строка)

Внешний ID выполнения правила.

externalExecutionUrl -> (строка)

URL ресурса, внешнего Amazon Web Services, используемого при выполнении правила (например, URL внешнего репозитория).

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

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

code -> (строка)

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

message -> (строка)

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

entityUrl -> (строка)

Ссылка URL для получения дополнительной информации о состоянии действия, например, страница со сведениями.

revisionUrl -> (строка)

Ссылка URL для получения дополнительной информации о ревизии, например, страница сведений о коммите.

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

Состояние условий успеха для этапа.

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

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

status -> (строка)

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

summary -> (строка)

Краткое описание выполнения условия для этапа.

conditionStates -> (список)

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

(структура)

Информация о состоянии условия.

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

Состояние последнего выполнения правила.

status -> (строка)

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

summary -> (строка)

Краткое описание информации о выполнении для условия.

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

Последнее изменение статуса условия.

ruleStates -> (список)

Состояние правил для условия.

(структура)

Возвращает информацию о состоянии правила.

Примечание

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

ruleName -> (строка)

Имя правила.

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

Идентификатор текущей ревизии артефакта, успешно обработанного задачей.

revisionId -> (строка)

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

revisionChangeId -> (строка)

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

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

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

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

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

ruleExecutionId -> (строка)

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

status -> (строка)

Статус выполнения правила, например, FAILED.

summary -> (строка)

Краткое описание выполнения правила.

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

Последнее изменение статуса правила.

token -> (строка)

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

lastUpdatedBy -> (строка)

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

externalExecutionId -> (строка)

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

externalExecutionUrl -> (строка)

URL ресурса, внешнего по отношению к Amazon Web Services, используемого при выполнении правила (например, URL внешнего репозитория).

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

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

code -> (строка)

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

message -> (строка)

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

entityUrl -> (строка)

Ссылка на URL для получения дополнительной информации о состоянии действия, например, страница со списком деталей.

revisionUrl -> (строка)

Ссылка на URL для получения дополнительной информации о ревизии, например, страница с деталями коммита.

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

Состояние условий сбоя для этапа.

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

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

status -> (строка)

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

summary -> (строка)

Краткое описание выполнения условия для этапа.

conditionStates -> (список)

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

(структура)

Информация о состоянии условия.

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

Состояние последнего выполнения правила.

status -> (строка)

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

summary -> (строка)

Краткое описание информации о выполнении для условия.

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

Последнее изменение статуса условия.

ruleStates -> (список)

Состояние правил для условия.

(структура)

Возвращает информацию о состоянии правила.

Примечание

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

ruleName -> (строка)

Имя правила.

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

Идентификатор текущей ревизии артефакта, успешно обработанного задачей.

revisionId -> (строка)

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

revisionChangeId -> (строка)

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

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

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

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

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

ruleExecutionId -> (строка)

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

status -> (строка)

Статус выполнения правила, например, FAILED.

summary -> (строка)

Краткое описание выполнения правила.

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

Последнее изменение статуса правила.

token -> (строка)

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

lastUpdatedBy -> (строка)

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

externalExecutionId -> (строка)

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

externalExecutionUrl -> (строка)

URL ресурса, внешнего по отношению к Amazon Web Services, используемого при выполнении правила (например, URL внешнего репозитория).

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

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

code -> (строка)

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

message -> (строка)

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

entityUrl -> (строка)

Ссылка на URL для получения дополнительной информации о состоянии действия, например, страница со списком деталей.

revisionUrl -> (строка)

Ссылка на URL для получения дополнительной информации о ревизии, например, страница с деталями коммита.

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

Подробная информация о конкретной автоматической повторной попытке при сбое этапа, включая номер попытки и триггер.

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

Количество попыток для конкретного этапа с автоматическим повтором при сбое этапа. Разрешена одна попытка для автоматического повтора этапа при сбое.

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

Количество попыток для конкретного этапа, где были сделаны ручные повторные попытки после сбоя этапа.

latestRetryTrigger -> (строка)

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

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

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

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

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

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

Spec-Zone.ru

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