Spec-Zone.ru › AWS CLI v2

[ aws . events ]

describe-endpoint

Описание

Получение информации об имеющемся глобальном конечной точке. Дополнительную информацию о глобальных конечных точках см. в разделе «Делайте приложения регионально-устойчивыми с помощью глобальных конечных точек и репликации событий» в * Руководстве пользователя Amazon EventBridge *.

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

Синтаксис

  describe-endpoint
--name <value>
[--home-region <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 (строка)

Название конечной точки, о которой вы хотите получить информацию. Например, "Name":"us-east-2-custom_bus_A-endpoint".

--home-region (строка)

Основной регион конечной точки, о которой вы хотите получить информацию. Например "HomeRegion": "us-east-1".

--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 (логическое значение)

Отключение пейджера CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматическое запрошение параметров ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключение автоматического запроса параметров ввода CLI.

Вывод

Имя -> (строка)

Название конечной точки, о которой вы запросили информацию.

Описание -> (строка)

Описание конечной точки, о которой вы запросили информацию.

Arn -> (строка)

ARN конечной точки, о которой вы запросили информацию.

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

Настройка маршрутизации конечной точки, о которой вы запросили информацию.

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

Настройка отказоустойчивости для конечной точки. Это включает в себя то, что инициирует сбой, и что происходит при его возникновении.

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

Основной регион конечной точки.

HealthCheck -> (строка)

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

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

Регион, в который маршрутизируются события при возникновении сбоя или включении репликации событий.

Route -> (строка)

Определяет вторичный регион.

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

Включена или выключена репликация для конечной точки, о которой вы запросили информацию.

State -> (строка)

Состояние репликации событий.

EventBuses -> (список)

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

(структура)

События, с которыми ассоциирована конечная точка.

EventBusArn -> (строка)

ARN события, с которым ассоциирована конечная точка.

RoleArn -> (строка)

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

EndpointId -> (строка)

Идентификатор конечной точки, о которой вы запросили информацию.

EndpointUrl -> (строка)

URL конечной точки, о которой вы запросили информацию.

State -> (строка)

Текущее состояние конечной точки, о которой вы запросили информацию.

StateReason -> (строка)

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

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

Время создания конечной точки, о которой вы запросили информацию.

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

Последнее время изменения конечной точки, о которой вы запросили информацию.

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

Spec-Zone.ru

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