list-repository-associations

Описание

Возвращает список объектов RepositoryAssociationSummary, содержащих сводную информацию об ассоциации репозитория. Вы можете фильтровать возвращаемый список по ProviderType , Name , State и Owner .

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

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

Синтаксис

  list-repository-associations
[--provider-types <value>]
[--states <value>]
[--names <value>]
[--owners <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]

Параметры

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

Список типов поставщиков, используемых в качестве фильтра.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  CodeCommit
  GitHub
  Bitbucket
  GitHubEnterpriseServer
  S3Bucket

--states (список)

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

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

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.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Associated
  Associating
  Failed
  Disassociating
  Disassociated

--names (список)

Список имен репозиториев, используемых в качестве фильтра.

(строка)

Синтаксис:

"string" "string" ...

--owners (список)

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

(строка)

Синтаксис:

"string" "string" ...

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

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

Токен для указания места начала постраничной обработки. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничность в руководстве пользователя AWS Command Line Interface.

--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
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.

Для перечисления ассоциаций репозиториев в вашей учетной записи AWS

Следующий list-repository-associations пример возвращает список объектов репозитория, связанных с ассоциацией, в вашей учетной записи. Вы можете фильтровать возвращаемый список по ProviderType, Name, State и Owner.

aws codeguru-reviewer list-repository-associations

Вывод:

{
    "RepositoryAssociationSummaries": [
        {
            "LastUpdatedTimeStamp": 1595886609.616,
            "Name": "test",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Owner": "sample-owner",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "ProviderType": "Bitbucket"
        },
        {
            "LastUpdatedTimeStamp": 1595636969.035,
            "Name": "CodeDeploy-CodePipeline-ECS-Tutorial",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "Owner": "123456789012",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "ProviderType": "CodeCommit"
        },
        {
            "LastUpdatedTimeStamp": 1595634785.983,
            "Name": "My-ecs-beta-repo",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "Owner": "123456789012",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "ProviderType": "CodeCommit"
        },
        {
            "LastUpdatedTimeStamp": 1590712811.77,
            "Name": "MyTestCodeCommit",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "Owner": "123456789012",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "ProviderType": "CodeCommit"
        },
        {
            "LastUpdatedTimeStamp": 1588102637.649,
            "Name": "aws-codeguru-profiler-sample-application",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
            "Owner": "sample-owner",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
            "ProviderType": "GitHub"
        },
        {
            "LastUpdatedTimeStamp": 1588028233.995,
            "Name": "codeguru-profiler-demo-app",
            "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
            "Owner": "sample-owner",
            "State": "Associated",
            "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
            "ProviderType": "GitHub"
        }
    ]
}

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

Вывод

RepositoryAssociationSummaries -> (список)

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

(структура)

Сводная информация об ассоциации репозитория. Операция ListRepositoryAssociations возвращает список объектов RepositoryAssociationSummary.

AssociationArn -> (строка)

Идентификатор ресурса Amazon (ARN) объекта RepositoryAssociation. Этот ARN можно получить, вызвав ListRepositoryAssociations.

ConnectionArn -> (строка)

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

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

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

AssociationId -> (строка)

Идентификатор ассоциации репозитория.

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.

NextToken -> (строка)

Значение nextToken, которое нужно включить в будущий запрос ListRecommendations. Когда результаты запроса ListRecommendations превышают maxResults, это значение можно использовать для получения следующей страницы результатов. Это значение null, когда больше результатов нет.