Spec-Zone.ru › AWS CLI v2

[ aws . codeguru-reviewer ]

describe-repository-association

Описание

Возвращает объект RepositoryAssociation, содержащий информацию о запрошенной ассоциации репозитория.

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

Синтаксис

  describe-repository-association
--association-arn <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]

Параметры

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

Amazon Resource Name (ARN) объекта RepositoryAssociation. Вы можете получить этот ARN, вызвав ListRepositoryAssociations .

--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: Возвращение информации об ассоциации репозитория GitHub

Следующий describe-repository-association пример возвращает информацию об ассоциации репозитория, использующей репозиторий GitHub Enterprise и находящейся в состоянии Associated.

aws codeguru-reviewer describe-repository-association \
    --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Вывод:

{
    "RepositoryAssociation": {
        "AssociationId": "b822717e-0711-4e8a-bada-0e738289c75e",
        "Name": "mySampleRepo",
        "LastUpdatedTimeStamp": 1588102637.649,
        "ProviderType": "GitHub",
        "CreatedTimeStamp": 1588102615.636,
        "Owner": "sample-owner",
        "State": "Associated",
        "StateReason": "Pull Request Notification configuration successful",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
    }
}

Для получения дополнительной информации см. Создание ассоциации репозитория GitHub Enterprise в Amazon CodeGuru Reviewer в Руководстве пользователя Amazon CodeGuru Reviewer.

Пример 2: Возвращение информации о несостоявшейся ассоциации репозитория

Следующий describe-repository-association пример возвращает информацию об ассоциации репозитория, использующей репозиторий GitHub Enterprise и находящейся в состоянии Failed.

aws codeguru-reviewer describe-repository-association \
    --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Вывод:

{
    "RepositoryAssociation": {
        "ProviderType": "GitHubEnterpriseServer",
        "Name": "mySampleRepo",
        "LastUpdatedTimeStamp": 1596217036.892,
        "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "CreatedTimeStamp": 1596216896.979,
        "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "State": "Failed",
        "StateReason": "Failed, Please retry.",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
        "Owner": "sample-owner"
    }
}

Для получения дополнительной информации см. Создание ассоциации репозитория GitHub Enterprise в Amazon CodeGuru Reviewer в Руководстве пользователя Amazon CodeGuru Reviewer.

Пример 3: Возвращение информации об ассоциации репозитория, которая отсоединяется

Следующий describe-repository-association пример возвращает информацию об ассоциации репозитория, использующей репозиторий GitHub Enterprise и находящейся в состоянии Disassociating.

aws codeguru-reviewer describe-repository-association \
    --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Вывод:

{
    "RepositoryAssociation": {
        "ProviderType": "GitHubEnterpriseServer",
        "Name": "mySampleRepo",
        "LastUpdatedTimeStamp": 1596217036.892,
        "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "CreatedTimeStamp": 1596216896.979,
        "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "State": "Disassociating",
        "StateReason": "Source code access removal in progress",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
        "Owner": "sample-owner"
    }
}

Для получения дополнительной информации см. Создание ассоциации репозитория GitHub Enterprise в Amazon CodeGuru Reviewer в Руководстве пользователя Amazon CodeGuru Reviewer.

Вывод

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

Информация о подключении к репозиторию.

AssociationId -> (строка)

Идентификатор подключения к репозиторию.

AssociationArn -> (строка)

Amazon Resource Name (ARN), определяющий подключение к репозиторию.

ConnectionArn -> (строка)

Amazon Resource Name (ARN) подключения Amazon Web Services CodeStar Connections. Его формат — arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. Дополнительная информация в разделе «Подключение» в документации по API Amazon Web Services CodeStar Connections.

Name -> (строка)

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

Owner -> (строка)

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

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

Объект, содержащий:

  • Способ шифрования для данного подключения к репозиторию. Он может быть управляемым Amazon Web Services Key Management Service (KMS) (AWS_OWNED_CMK) или управляемым клиентом (CUSTOMER_MANAGED_CMK).
  • Идентификатор ключа Amazon Web Services KMS, связанного с данным подключением к репозиторию.

KMSKeyId -> (строка)

Идентификатор ключа Amazon Web Services KMS, связанного с подключением к репозиторию.

EncryptionOption -> (строка)

Способ шифрования для подключения к репозиторию. Он может быть управляемым Amazon Web Services Key Management Service (KMS) (AWS_OWNED_CMK) или управляемым клиентом (CUSTOMER_MANAGED_CMK).

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

Указывает имя ведра S3 и объект, содержащий ключи объектов S3 для файла исходного кода .zip и файла с результатами сборки .zip, содержащего файлы .jar или .class.

BucketName -> (строка)

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

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

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

SourceCodeArtifactsObjectKey -> (строка)

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

BuildArtifactsObjectKey -> (строка)

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

Tags -> (массив)

Массив пар ключ-значение, используемых для маркировки подключенного репозитория. Тег — это метка пользовательского атрибута, состоящая из двух частей:

  • Ключ тега (например, CostCenter , Environment , Project или Secret). Ключи тегов чувствительны к регистру.
  • Необязательное поле, известное как значение тега (например, 111122223333 , Production или имя команды). Пропуск значения тега эквивалентен использованию пустой строки. Значения тегов, как и ключи, чувствительны к регистру.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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