describe-connection
Описание
Получает подробную информацию о подключении.
См. также: Документация API AWS
Синтаксис
describe-connection
--name <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]
Параметры
--name (строка)
--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
- таблица
- 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 (логическое значение)
Отключить тулбар AWS CLI для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода для CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода для CLI.
Вывод
ConnectionArn -> (строка)
Name -> (строка)
Description -> (строка)
InvocationConnectivityParameters -> (структура)
Для подключений к частным API. Параметры, используемые EventBridge для вызова конечной точки ресурса.
Для получения дополнительной информации, см. Подключение к частным API в * Руководстве пользователя Amazon EventBridge * .
ResourceParameters -> (структура)
Параметры, используемые EventBridge при вызове конечной точки ресурса.
ResourceConfigurationArn -> (строка)
ResourceAssociationArn -> (строка)
Для подключений к частным API, уникальный идентификатор ресурса (ARN) ассоциации ресурса, созданной EventBridge между подключением и конфигурацией ресурса частного API.
Для получения дополнительной информации, см. Управление ассоциациями ресурсов сети служб для подключений в * Руководстве пользователя Amazon EventBridge * .
ConnectionState -> (строка)
StateReason -> (строка)
AuthorizationType -> (строка)
SecretArn -> (строка)
KmsKeyIdentifier -> (строка)
Идентификатор управляемого пользователем ключа KMS, который EventBridge использует для шифрования подключения, если он был указан.
Для получения дополнительной информации, см. Шифрование подключений в Руководстве пользователя Amazon EventBridge .
AuthParameters -> (структура)
Параметры, используемые для авторизации подключения.
BasicAuthParameters -> (структура)
Параметры авторизации для базовой авторизации.
Username -> (строка)
OAuthParameters -> (структура)
Параметры OAuth, используемые для авторизации.
ClientParameters -> (структура)
Подробная информация о параметрах клиента, возвращаемых при указании OAuth в качестве типа авторизации.
ClientID -> (строка)
AuthorizationEndpoint -> (строка)
HttpMethod -> (строка)
OAuthHttpParameters -> (структура)
Дополнительные HTTP-параметры, используемые для запроса авторизации OAuth.
HeaderParameters -> (список)
Дополнительные параметры заголовка для подключения.
(структура)
Дополнительный параметр, включенный в заголовок. Вы можете включить до 100 дополнительных параметров заголовка в каждом запросе. Объем данных события не может превышать 64 КБ.
Key -> (строка)
Value -> (строка)
IsValueSecret -> (булево)
QueryStringParameters -> (список)
Дополнительные параметры строки запроса для подключения.
(структура)
Дополнительный параметр строки запроса для подключения. Вы можете включить до 100 дополнительных параметров строки запроса в каждом запросе. Каждый дополнительный параметр учитывается в размере данных события, который не может превышать 64 КБ.
Key -> (строка)
Value -> (строка)
IsValueSecret -> (булево)
BodyParameters -> (список)
Дополнительные параметры строки тела для подключения.
(структура)
Дополнительный параметр, включенный в тело. Вы можете включить до 100 дополнительных параметров тела в каждом запросе. Объем данных события не может превышать 64 КБ.
Key -> (строка)
Value -> (строка)
IsValueSecret -> (булево)
ApiKeyAuthParameters -> (структура)
Параметры ключа API, используемые для авторизации.
ApiKeyName -> (строка)
APIKeyValue, используемого для авторизации.InvocationHttpParameters -> (структура)
Дополнительные параметры подключения, передаваемые при каждом вызове HTTP-конечной точки.
HeaderParameters -> (список)
Дополнительные параметры заголовка для подключения.
(структура)
Дополнительный параметр, включенный в заголовок. Вы можете включить до 100 дополнительных параметров заголовка в каждом запросе. Объем данных события не может превышать 64 КБ.
Key -> (строка)
Value -> (строка)
IsValueSecret -> (булево)
QueryStringParameters -> (список)
Дополнительные параметры строки запроса для подключения.
(структура)
Дополнительный параметр строки запроса для подключения. Вы можете включить до 100 дополнительных параметров строки запроса в каждом запросе. Каждый дополнительный параметр учитывается в размере данных события, который не может превышать 64 КБ.
Key -> (строка)
Value -> (строка)
IsValueSecret -> (булево)
BodyParameters -> (список)
Дополнительные параметры строки тела для подключения.
(структура)
Дополнительный параметр, включенный в тело. Вы можете включить до 100 дополнительных параметров тела в каждом запросе. Объем данных события не может превышать 64 КБ.
Key -> (строка)
Value -> (строка)
IsValueSecret -> (булево)
ConnectivityParameters -> (структура)
Для частных конечных точек аутентификации OAuth. Параметры, которые EventBridge использует для аутентификации на конечной точке.
Для получения дополнительной информации, см. Методы авторизации для подключений в * Руководстве пользователя Amazon EventBridge * .
ResourceParameters -> (структура)
Параметры, используемые EventBridge при вызове конечной точки ресурса.
ResourceConfigurationArn -> (строка)
ResourceAssociationArn -> (строка)
Для подключений к частным API, уникальный идентификатор ресурса (ARN) ассоциации ресурса, созданной EventBridge между подключением и конфигурацией ресурса частного API.
Для получения дополнительной информации, см. Управление ассоциациями ресурсов сети служб для подключений в * Руководстве пользователя Amazon EventBridge * .
CreationTime -> (временная метка)
LastModifiedTime -> (временная метка)
LastAuthorizedTime -> (временная метка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.