[ aws . codeguru-reviewer ]
associate-repository
Описание
Используется для ассоциации репозитория Amazon Web Services CodeCommit или репозитория, управляемого Amazon Web Services CodeStar Connections, с Amazon CodeGuru Reviewer. При ассоциации репозитория CodeGuru Reviewer анализирует изменения исходного кода в запросах на вытягивание (pull requests) репозитория и предоставляет автоматические рекомендации. Рекомендации можно просмотреть в консоли CodeGuru Reviewer. Для получения дополнительной информации см. Рекомендации в Amazon CodeGuru Reviewer в руководстве пользователя Amazon CodeGuru Reviewer.
Если вы ассоциируете репозиторий CodeCommit или S3, он должен находиться в той же области Amazon Web Services и учетной записи Amazon Web Services, где настроены обзоры кода CodeGuru Reviewer.
Репозитории Bitbucket и GitHub Enterprise Server управляются Amazon Web Services CodeStar Connections для подключения к CodeGuru Reviewer. Для получения дополнительной информации см. Ассоциация репозитория в руководстве пользователя Amazon CodeGuru Reviewer.
Примечание
Вы не можете использовать CodeGuru Reviewer SDK или Amazon Web Services CLI для ассоциации репозитория GitHub с Amazon CodeGuru Reviewer. Для ассоциации репозитория GitHub используйте консоль. Для получения дополнительной информации см. Начало работы с CodeGuru Reviewer в руководстве пользователя CodeGuru Reviewer.См. также: Документация API AWS
Синтаксис
associate-repository
--repository <value>
[--client-request-token <value>]
[--tags <value>]
[--kms-key-details <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]
Параметры
--repository (структура)
Ассоциируемый репозиторий.
CodeCommit -> (структура)
Информация об репозитории Amazon Web Services CodeCommit.
Name -> (строка)
Bitbucket -> (структура)
Информация о репозитории Bitbucket.
Name -> (строка)
ConnectionArn -> (строка)
arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. Для получения дополнительной информации см. Connection в справке по API Amazon Web Services CodeStar Connections.Owner -> (строка)
GitHubEnterpriseServer -> (структура)
Информация о репозитории GitHub Enterprise Server.
Name -> (строка)
ConnectionArn -> (строка)
arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. Для получения дополнительной информации см. Connection в справке по API Amazon Web Services CodeStar Connections.Owner -> (строка)
S3Bucket -> (структура)
Информация о репозитории в ведре S3.
Name -> (строка)
BucketName -> (строка)
codeguru-reviewer-.Упрощенный синтаксис:
CodeCommit={Name=string},Bitbucket={Name=string,ConnectionArn=string,Owner=string},GitHubEnterpriseServer={Name=string,ConnectionArn=string,Owner=string},S3Bucket={Name=string,BucketName=string}
Синтаксис JSON:
{
"CodeCommit": {
"Name": "string"
},
"Bitbucket": {
"Name": "string",
"ConnectionArn": "string",
"Owner": "string"
},
"GitHubEnterpriseServer": {
"Name": "string",
"ConnectionArn": "string",
"Owner": "string"
},
"S3Bucket": {
"Name": "string",
"BucketName": "string"
}
}
--client-request-token (строка)
--tags (массив)
Массив пар ключ-значение, используемых для тегирования ассоциированного репозитория. Тег — это метка пользовательского атрибута, состоящая из двух частей:
- Ключ тега (например,
CostCenter,Environment,ProjectилиSecret). Ключи тегов чувствительны к регистру. - Необязательное поле, известное как значение тега (например,
111122223333,Productionили название команды). Пропуск значения тега эквивалентен использованию пустой строки. Значения тегов, как и ключи, чувствительны к регистру.
key -> (строка)
value -> (строка)
Упрощенный синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--kms-key-details (структура)
Объект KMSKeyDetails, содержащий:
- Вариант шифрования для этой ассоциации репозитория. Он либо принадлежит Amazon Web Services Key Management Service (KMS) (
AWS_OWNED_CMK), либо управляется клиентом (CUSTOMER_MANAGED_CMK). - Идентификатор ключа Amazon Web Services KMS, связанного с этой ассоциацией репозитория.
KMSKeyId -> (строка)
EncryptionOption -> (строка)
AWS_OWNED_CMK), либо управляется клиентом (CUSTOMER_MANAGED_CMK).Упрощенный синтаксис:
KMSKeyId=string,EncryptionOption=string
Синтаксис JSON:
{
"KMSKeyId": "string",
"EncryptionOption": "AWS_OWNED_CMK"|"CUSTOMER_MANAGED_CMK"
}
--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 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.
Пример 1: Создание ассоциации репозитория Bitbucket
Следующий associate-repository пример создает ассоциацию репозитория с использованием существующего репозитория Bitbucket.
aws codeguru-reviewer associate-repository \
--repository 'Bitbucket={Owner=sample-owner, Name=mySampleRepo, ConnectionArn=arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 }'
Вывод:
{
"RepositoryAssociation": {
"ProviderType": "Bitbucket",
"Name": "mySampleRepo",
"LastUpdatedTimeStamp": 1596216896.979,
"AssociationId": "association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"CreatedTimeStamp": 1596216896.979,
"ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"State": "Associating",
"StateReason": "Pending Repository Association",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"Owner": "sample-owner"
}
}
Дополнительную информацию см. в разделе «Создание ассоциации репозитория Bitbucket в Amazon CodeGuru Reviewer» в Руководстве пользователя Amazon CodeGuru Reviewer.
Пример 2: Создание ассоциации репозитория GitHub Enterprise
Следующий associate-repository пример создает ассоциацию репозитория с использованием существующего репозитория GitHub Enterprise.
aws codeguru-reviewer associate-repository \
--repository 'GitHubEnterpriseServer={Owner=sample-owner, Name=mySampleRepo, ConnectionArn=arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 }'
Вывод:
{
"RepositoryAssociation": {
"ProviderType": "GitHubEnterpriseServer",
"Name": "mySampleRepo",
"LastUpdatedTimeStamp": 1596216896.979,
"AssociationId": "association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"CreatedTimeStamp": 1596216896.979,
"ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"State": "Associating",
"StateReason": "Pending Repository Association",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"Owner": "sample-owner"
}
}
Дополнительную информацию см. в разделе «Создание ассоциации репозитория GitHub Enterprise Server в Amazon CodeGuru Reviewer» в Руководстве пользователя Amazon Codeguru Reviewer.
Пример 3: Создание ассоциации репозитория AWS CodeCommit
Следующий associate-repository пример создает ассоциацию репозитория с использованием существующего репозитория AWS CodeCommit.
aws codeguru-reviewer associate-repository \
--repository CodeCommit={Name=mySampleRepo}
Вывод:
{
"RepositoryAssociation": {
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"Name": "My-ecs-beta-repo",
"LastUpdatedTimeStamp": 1595634764.029,
"ProviderType": "CodeCommit",
"CreatedTimeStamp": 1595634764.029,
"Owner": "544120495673",
"State": "Associating",
"StateReason": "Pending Repository Association",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:544120495673:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
}
Дополнительную информацию см. в разделе «Создание ассоциации репозитория AWS CodeCommit в Amazon CodeGuru Reviewer» в Руководстве пользователя Amazon CodeGuru Reviewer.
Вывод
RepositoryAssociation -> (структура)
Информация об ассоциации репозитория.
AssociationId -> (строка)
AssociationArn -> (строка)
ConnectionArn -> (строка)
arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. Дополнительную информацию см. в разделе «Подключение» в Справочнике по API Amazon Web Services CodeStar Connections.Name -> (строка)
Owner -> (строка)
ProviderType -> (строка)
State -> (строка)
Состояние ассоциации репозитория.
Допустимые состояния ассоциации репозитория:
-
Associated : Ассоциация репозитория завершена.
-
Associating : CodeGuru Reviewer:
- Настраивает уведомления о запросах на вытягивание. Это необходимо для того, чтобы запросы на вытягивание запускали проверку CodeGuru Reviewer.
Примечание
Если ваш репозиторий
ProviderTypeнаходится в состоянииGitHub,GitHub Enterprise ServerилиBitbucket, CodeGuru Reviewer создаёт веб-хуки в вашем репозитории для запуска проверок CodeGuru Reviewer. Если вы удалите эти веб-хуки, проверки кода в вашем репозитории не смогут быть запущены.- Настраивает доступ к исходному коду. Это необходимо для того, чтобы CodeGuru Reviewer мог безопасно клонировать код в вашем репозитории.
-
Failed : Ассоциация или диссоциация репозитория завершилась ошибкой.
-
Disassociating : CodeGuru Reviewer удаляет уведомления о запросах на вытягивание и доступ к исходному коду репозитория.
-
Disassociated : CodeGuru Reviewer успешно диссоциировал репозиторий. Вы можете создать новую ассоциацию с этим репозиторием, если хотите в дальнейшем проверять исходный код в нём. Вы можете управлять доступом к кодовым обзорам, созданным в связанном репозитории, с помощью тегов после его диссоциации. Дополнительную информацию см. в разделе «Использование тегов для управления доступом к связанным репозиториям» в Руководстве пользователя Amazon CodeGuru Reviewer.
StateReason -> (строка)
LastUpdatedTimeStamp -> (отметка времени)
CreatedTimeStamp -> (отметка времени)
KMSKeyDetails -> (структура)
Объект KMSKeyDetails, который содержит:
- Вариант шифрования для этой ассоциации репозитория. Он либо принадлежит Amazon Web Services Key Management Service (KMS) (
AWS_OWNED_CMK), либо управляется пользователем (CUSTOMER_MANAGED_CMK). - Идентификатор ключа Amazon Web Services KMS, связанного с этой ассоциацией репозитория.
KMSKeyId -> (строка)
EncryptionOption -> (строка)
AWS_OWNED_CMK), либо управляется пользователем (CUSTOMER_MANAGED_CMK).S3RepositoryDetails -> (структура)
Указывает имя ведра S3 и объект CodeArtifacts, содержащий ключи объектов S3 для файла исходного кода .zip и для файла сархивированных артефактов сборки .zip, содержащих файлы .jar или .class.
BucketName -> (строка)
codeguru-reviewer-.CodeArtifacts -> (структура)
Объект CodeArtifacts. Объект CodeArtifacts включает ключ объекта S3 для файла исходного кода .zip и для файла сархивированных артефактов сборки .zip, содержащих файлы .jar или .class.
SourceCodeArtifactsObjectKey -> (строка)
BuildArtifactsObjectKey -> (строка)
Tags -> (массив)
Массив пар ключ-значение, используемых для маркировки связанного репозитория. Тег — это метка пользовательского атрибута, состоящая из двух частей:
- Ключ тега (например,
CostCenter,Environment,ProjectилиSecret). Ключи тегов чувствительны к регистру. - Необязательное поле, известное как значение тега (например,
111122223333,Productionили имя команды). Пропуск значения тега равнозначно использованию пустой строки. Значения тегов, как и ключи тегов, чувствительны к регистру.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.