Spec-Zone.ru › AWS CLI v2

[ aws . codestar-connections ]

list-connections

Описание

Отображает подключения, связанные с вашей учётной записью.

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

Синтаксис

  list-connections
[--provider-type-filter <value>]
[--host-arn-filter <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-type-filter (строка)

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

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

  • Bitbucket
  • GitHub
  • GitHubEnterpriseServer
  • GitLab
  • GitLabSelfManaged

--host-arn-filter (строка)

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

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

Максимальное количество результатов, возвращаемых за один вызов. Чтобы получить оставшиеся результаты, сделайте ещё один вызов с полученным значением nextToken.

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

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

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

Для отображения подключений

Следующий list-connections пример получает список всех подключений в вашей учётной записи для типа поставщика Bitbucket:

aws codestar-connections list-connections \
--provider-type Bitbucket \
--max-results 5 \
--next-token: next-token

Вывод:

{
    "Connections": [
        {
            "ConnectionName": "my-connection",
            "ProviderType": "Bitbucket",
            "Status": "PENDING",
            "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
            "OwnerAccountId": "123456789012"
        },
        {
            "ConnectionName": "my-other-connection",
            "ProviderType": "Bitbucket",
            "Status": "AVAILABLE",
            "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
            "OwnerAccountId": "123456789012"
        },
    ],
    "NextToken": "next-token"
}

Дополнительную информацию см. в разделе «Список подключений (CLI)» в Руководстве пользователя консоли Developer Tools.

Вывод

Подключения -> (список)

Список подключений и подробные сведения о каждом подключении, такие как состояние, владелец и тип поставщика.

(структура)

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

Примечание: подключение, созданное через CloudFormation, CLI или SDK, по умолчанию имеет статус ОЖИДАЕТСЯ. Вы можете изменить его статус на ДОСТУПНО, обновив подключение в консоли.

ИмяПодключения -> (строка)

Имя подключения. Имена подключений должны быть уникальными в пределах учётной записи Amazon Web Services.

ArnПодключения -> (строка)

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

Примечание

ARN никогда не повторно используется, если подключение удалено.

ТипПоставщика -> (строка)

Имя внешнего поставщика, где настроен ваш сторонний репозиторий кода.

ИдентификаторВладельца -> (строка)

Идентификатор внешнего поставщика, где настроен ваш сторонний репозиторий кода. Для Bitbucket это идентификатор учётной записи владельца репозитория Bitbucket.

СостояниеПодключения -> (строка)

Текущее состояние подключения.

ArnХоста -> (строка)

Amazon Resource Name (ARN) хоста, связанного с подключением.

NextToken -> (строка)

Токен, который можно использовать в следующем вызове ListConnections. Чтобы просмотреть все элементы в списке, продолжайте вызывать эту операцию с каждым последующим токеном, пока не будут возвращены все nextToken значения.

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

Spec-Zone.ru

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