Spec-Zone.ru › AWS CLI v2

[ aws . codecommit ]

describe-pull-request-events

Описание

Возвращает информацию об одном или нескольких событиях запроса на вытягивание.

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

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

Синтаксис

  describe-pull-request-events
--pull-request-id <value>
[--pull-request-event-type <value>]
[--actor-arn <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]

Параметры

--pull-request-id (строка)

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

--pull-request-event-type (строка)

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

Возможные значения:

  • PULL_REQUEST_CREATED
  • PULL_REQUEST_STATUS_CHANGED
  • PULL_REQUEST_SOURCE_REFERENCE_UPDATED
  • PULL_REQUEST_MERGE_STATE_CHANGED
  • PULL_REQUEST_APPROVAL_RULE_CREATED
  • PULL_REQUEST_APPROVAL_RULE_UPDATED
  • PULL_REQUEST_APPROVAL_RULE_DELETED
  • PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN
  • PULL_REQUEST_APPROVAL_STATE_CHANGED

--actor-arn (строка)

Идентификатор Amazon Resource Name (ARN) пользователя, действия которого привели к событию. Примеры включают обновление запроса на вытягивание с новыми коммитами или изменение статуса запроса на вытягивание.

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

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

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

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

--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
  • таблица
  • 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.

Для просмотра событий в запросе на вытягивание

Следующий пример describe-pull-request-events извлекает события для запроса на вытягивание с идентификатором '8'.

aws codecommit describe-pull-request-events --pull-request-id 8

Вывод:

{
    "pullRequestEvents": [
        {
            "pullRequestId": "8",
            "pullRequestEventType": "PULL_REQUEST_CREATED",
            "eventDate": 1510341779.53,
            "actor": "arn:aws:iam::111111111111:user/Zhang_Wei"
        },
        {
            "pullRequestStatusChangedEventMetadata": {
                "pullRequestStatus": "CLOSED"
            },
            "pullRequestId": "8",
            "pullRequestEventType": "PULL_REQUEST_STATUS_CHANGED",
            "eventDate": 1510341930.72,
            "actor": "arn:aws:iam::111111111111:user/Jane_Doe"
        }
    ]
}

Вывод

pullRequestEvents -> (список)

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

(структура)

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

pullRequestId -> (строка)

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

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

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

pullRequestEventType -> (строка)

Тип события запроса на добавление (например, событие изменения состояния (PULL_REQUEST_STATUS_CHANGED) или событие обновления (PULL_REQUEST_SOURCE_REFERENCE_UPDATED)).

actorArn -> (строка)

Amazon Resource Name (ARN) пользователя, чьи действия привели к событию. Примеры включают обновление запроса на добавление дополнительными коммитами или изменение статуса запроса на добавление.

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

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

repositoryName -> (строка)

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

sourceCommitId -> (строка)

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

destinationCommitId -> (строка)

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

mergeBase -> (строка)

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

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

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

pullRequestStatus -> (строка)

Измененный статус запроса на добавление.

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

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

repositoryName -> (строка)

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

beforeCommitId -> (строка)

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

afterCommitId -> (строка)

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

mergeBase -> (строка)

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

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

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

repositoryName -> (строка)

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

destinationReference -> (строка)

Имя ветки, в которую сливается запрос на добавление.

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

Информация о событии изменения состояния слияния.

isMerged -> (логическое значение)

Булево значение, указывающее, был ли произведён merge.

mergedBy -> (строка)

Amazon Resource Name (ARN) пользователя, который произвёл слияние ветвей.

mergeCommitId -> (строка)

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

mergeOption -> (строка)

Использованная стратегия слияния.

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

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

approvalRuleName -> (строка)

Имя правила утверждения.

approvalRuleId -> (строка)

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

approvalRuleContent -> (строка)

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

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

Информация об изменении состояния утверждения для запроса на добавление.

revisionId -> (строка)

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

approvalStatus -> (строка)

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

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

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

revisionId -> (строка)

Идентификатор ревизии запроса на добавление, когда произошло событие переопределения.

overrideStatus -> (строка)

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

nextToken -> (строка)

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

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

Spec-Zone.ru

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