list-code-reviews

Описание

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

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

Синтаксис

  list-code-reviews
[--provider-types <value>]
[--states <value>]
[--repository-names <value>]
--type <value>
[--max-results <value>]
[--next-token <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]

Параметры

--provider-types (список)

Список типов поставщиков для фильтрации, которая должна быть применена перед отображением результата. Например, providerTypes=[GitHub] отображает обзоры кода из GitHub.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  CodeCommit
  GitHub
  Bitbucket
  GitHubEnterpriseServer
  S3Bucket

--states (список)

Список состояний для фильтрации, которая должна быть применена перед отображением результата. Например, states=[Pending] отображает обзоры кода в состоянии Ожидание.

Допустимые состояния обзоров кода:

Completed : Обзор кода завершен.
Pending : Обзор кода начат, но не завершен и не прерван.
Failed : Обзор кода прерван.
Deleting : Обзор кода удаляется.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Completed
  Pending
  Failed
  Deleting

--repository-names (список)

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

(строка)

Синтаксис:

"string" "string" ...

--type (строка)

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

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

PullRequest
RepositoryAnalysis

--max-results (целое число)

Максимальное количество результатов, возвращаемых за один вызов. По умолчанию 100.

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

Если возвращается nextToken, доступны дополнительные результаты. Значение nextToken — уникальный маркер постраничной навигации для каждой страницы. Повторите вызов, используя возвращённый маркер, чтобы получить следующую страницу. Все остальные аргументы остаются неизменными.

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

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

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

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

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

Примеры

Примечание

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

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

Для вывода списка обзоров кода, созданных в вашей учётной записи AWS за последние 90 дней.

Следующий list-code-reviews пример выводит список обзоров кода, созданных за последние 90 дней с использованием pull-запросов.

aws codeguru-reviewer list-code-reviews \
    --type PullRequest

Вывод:

{
    "CodeReviewSummaries": [
        {
            "LastUpdatedTimeStamp": 1588897288.054,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "ProviderType": "GitHub",
            "PullRequestId": "5",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 24,
                "FindingsCount": 1
            },
            "CreatedTimeStamp": 1588897068.512,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        },
        {
            "LastUpdatedTimeStamp": 1588869793.263,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "ProviderType": "GitHub",
            "PullRequestId": "4",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 29,
                "FindingsCount": 0
            },
            "CreatedTimeStamp": 1588869575.949,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        },
        {
            "LastUpdatedTimeStamp": 1588870511.211,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "ProviderType": "GitHub",
            "PullRequestId": "4",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 2,
                "FindingsCount": 0
            },
            "CreatedTimeStamp": 1588870292.425,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        },
        {
            "LastUpdatedTimeStamp": 1588118522.452,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "ProviderType": "GitHub",
            "PullRequestId": "3",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 29,
                "FindingsCount": 0
            },
            "CreatedTimeStamp": 1588118301.131,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        },
        {
            "LastUpdatedTimeStamp": 1588112205.207,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
            "ProviderType": "GitHub",
            "PullRequestId": "2",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 25,
                "FindingsCount": 0
            },
            "CreatedTimeStamp": 1588111987.443,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        },
        {
            "LastUpdatedTimeStamp": 1588104489.981,
            "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
            "ProviderType": "GitHub",
            "PullRequestId": "1",
            "MetricsSummary": {
                "MeteredLinesOfCodeCount": 25,
                "FindingsCount": 0
            },
            "CreatedTimeStamp": 1588104270.223,
            "State": "Completed",
            "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
            "Owner": "sample-owner",
            "RepositoryName": "sample-repository-name",
            "Type": "PullRequest"
        }
    ]
}

Дополнительную информацию см. в разделе Просмотр всех обзоров кода в Руководстве пользователя Amazon CodeGuru Reviewer.

Вывод

CodeReviewSummaries -> (список)

Список обзоров кода, соответствующих критериям запроса.

(структура)

Информация о сводке обзора кода.

Name -> (строка)

Название обзора кода.

CodeReviewArn -> (строка)

Amazon Resource Name (ARN) объекта CodeReview.

RepositoryName -> (строка)

Название репозитория.

Owner -> (строка)

Владелец репозитория. Для репозитория Amazon Web Services CodeCommit это идентификатор учетной записи Amazon Web Services, владеющей репозиторием. Для репозитория GitHub, GitHub Enterprise Server или Bitbucket это имя пользователя учетной записи, владеющей репозиторием. Для репозитория S3 это может быть имя пользователя или идентификатор учетной записи Amazon Web Services.

ProviderType -> (строка)

Тип поставщика ассоциации репозитория.

State -> (строка)

Состояние обзора кода.

Допустимые состояния обзора кода:

Completed : Обзор кода завершен.
Pending : Обзор кода начат и не завершен или не прерван.
Failed : Обзор кода завершен с ошибкой.
Deleting : Обзор кода удаляется.

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

Время, в миллисекундах с начала эпохи, когда был создан обзор кода.

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

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

Type -> (строка)

Тип обзора кода.

PullRequestId -> (строка)

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

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

Статистические данные из обзора кода.

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

Количество измеримых строк кода в обзоре кода. Для начального запроса на вытягивание обзора кода и всех последующих ревизий это включает все строки кода в файлах, добавленных в запрос на вытягивание. В последующих ревизиях для файлов, которые уже существовали в запросе на вытягивание, это включает только измененные строки кода. В обоих случаях это не включает строки, не являющиеся кодом, такие как комментарии и инструкции импорта. Например, если вы отправили запрос на вытягивание, содержащий 5 файлов, каждый из которых содержит 500 строк кода, и в последующей ревизии вы добавили новый файл с 200 строками кода и также изменили в общей сложности 25 строк в начальных 5 файлах, то MeteredLinesOfCodeCount включает первые 5 файлов (5 * 500 = 2500 строк), новый файл (200 строк) и 25 измененных строк кода в общей сложности 2725 строк кода.

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

Количество строк кода, подавленных в обзоре кода на основе элемента excludeFiles в файле aws-codeguru-reviewer.yml. Для анализа всего репозитория это число включает все строки кода во всех файлах, которые подавлены. Для запросов на вытягивание это число включает только измененные строки кода, которые подавлены. В обоих случаях это число не включает строки, не являющиеся кодом, такие как комментарии и инструкции импорта. Например, если вы инициируете анализ всего репозитория для репозитория, содержащего 5 файлов, каждый с 100 строками кода, и 2 файла перечислены как исключенные в файле aws-codeguru-reviewer.yml, то SuppressedLinesOfCodeCount возвращает 200 (2 * 100) как общее количество строк подавленного кода. Однако, если вы отправляете запрос на вытягивание для того же репозитория, то SuppressedLinesOfCodeCount включает только строки в 2 измененных файлах. Если изменился только один из 2 файлов в запросе на вытягивание, то SuppressedLinesOfCodeCount возвращает 100 (1 * 100) как общее количество строк подавленного кода.

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

Общее количество рекомендаций, найденных в обзоре кода.

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

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

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

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

SourceCommit -> (строка)

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

DestinationCommit -> (строка)

SHA целевого коммита, используемого для создания разницы коммитов. Это поле обязательно для обзора кода запроса на вытягивание.

MergeBaseCommit -> (строка)

SHA базового коммита слияния.

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

SourceCodeType, определяющий вершину ветки в ассоциированном репозитории.

BranchName -> (строка)

Имя ветки в ассоциированном репозитории. RepositoryHeadSourceCodeType указывает на вершину этой ветки.

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

Тип SourceCodeType, определяющий имя исходной ветки и имя целевой ветки в ассоциированном репозитории.

SourceBranchName -> (строка)

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

DestinationBranchName -> (строка)

Целевая ветка для разницы в ассоциированном репозитории.

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

Информация об ассоциированном репозитории в ведре S3, включающая его имя и объект S3RepositoryDetails. Объект S3RepositoryDetails включает имя ведра S3, ключ S3 для .zip-файла исходного кода и ключ S3 для .zip-файла артефактов сборки. S3BucketRepository требуется в SourceCodeType для обзоров кода на основе S3BucketRepository.

Name -> (строка)

Название репозитория, когда ProviderType является S3Bucket.

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

Объект S3RepositoryDetails, определяющий имя ведра S3 и объект CodeArtifacts. Объект CodeArtifacts включает ключи объектов S3 для .zip-файла исходного кода и .zip-файла артефактов сборки.

BucketName -> (строка)

Имя ведра S3, используемого для связывания нового репозитория S3. Оно должно начинаться с codeguru-reviewer-.

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

Объект CodeArtifacts. Объект CodeArtifacts включает ключ объекта S3 для .zip-файла исходного кода и .zip-файла артефактов сборки, содержащих файлы .jar или .class.

SourceCodeArtifactsObjectKey -> (строка)

Ключ объекта S3 для .zip-файла исходного кода. Это обязательно для всех обзоров кода.

BuildArtifactsObjectKey -> (строка)

Ключ объекта S3 для .zip-файла артефактов сборки, содержащего файлы .jar или .class. Это обязательно для обзора кода с анализом безопасности. Дополнительную информацию см. в разделе «Создание обзоров кода с помощью GitHub Actions» в руководстве пользователя Amazon CodeGuru Reviewer.

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

Метаданные, связанные с обзором кода. Это относится к любому типу обзора кода, поддерживаемому CodeGuru Reviewer. Поле RequestMetadaa фиксирует любые метаданные события. Например, это могут быть метаданные, связанные с триггером события, таким как push или запрос на вытягивание.

RequestId -> (строка)

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

Requester -> (строка)

Идентификатор, например, имя или идентификатор учетной записи, связанный с запрашивающим. Requester используется для захвата author/actor имени запроса события.

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

Информация о событии, связанном с обзором кода.

Name -> (строка)

Название события. Возможные имена: pull_request, workflow_dispatch, schedule и push

State -> (строка)

Состояние события. Состояние может быть открытым, закрытым или другим.

VendorName -> (строка)

Имя поставщика репозитория, используемого для загрузки кода в ведро S3 для обзора кода CI/CD. Например, если код и артефакты загружаются в ведро S3 для обзора кода CI/CD скриптами GitHub из репозитория GitHub, то ProviderType поставщика репозитория CI/CD — GitHub. Дополнительную информацию см. в определении ProviderType в RepositoryAssociation.

NextToken -> (строка)

Токен пагинации.

END_OF_DOCUMENT_MARKER