Spec-Zone.ru › AWS CLI v2

[ aws . groundstation ]

describe-contact

Описание

Описывает существующий контакт.

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

Синтаксис

  describe-contact
--contact-id <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]

Параметры

--contact-id (строка)

UUID контакта.

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

Вывод

contactId -> (строка)

UUID контакта.

contactStatus -> (строка)

Статус контакта.

dataflowList -> (список)

Список, описывающий источник и пункт назначения для каждого потока данных.

(структура)

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

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

Подробности потока данных для стороны назначения.

configDetails -> (структура помеченных объединений)

Дополнительные сведения для Config, если тип — конечная точка потока данных или демодулятор антенны.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть установлен: antennaDemodDecodeDetails, endpointDetails, s3RecordingDetails.

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

Подробности демодуляции антенны Config в контакте.

outputNode -> (строка)

Имя узла вывода демодулятора антенны, используемого в контакте.

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

Информация о параметрах конечной точки.

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

Конечная точка агента.

agentStatus -> (строка)

Статус AgentEndpoint.

auditResults -> (строка)

Результаты аудита.

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

Адрес egress AgentEndpoint.

mtu -> (целое число)

Максимальный размер блока передачи (MTU) в байтах конечной точки потока данных.

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

Адрес сокета.

name -> (строка)

Имя адреса сокета.

port -> (целое число)

Порт адреса сокета.

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

Адрес ingress AgentEndpoint.

mtu -> (целое число)

Максимальный размер блока передачи (MTU) в байтах конечной точки потока данных.

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

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

name -> (строка)

Адрес сокета IPv4.

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

Диапазон портов адреса сокета.

maximum -> (целое число)

Максимальное значение.

minimum -> (целое число)

Минимальное значение.

name -> (строка)

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

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

Конечная точка потока данных.

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

Адрес сокета конечной точки потока данных.

name -> (строка)

Имя адреса сокета.

port -> (целое число)

Порт адреса сокета.

mtu -> (целое число)

Максимальный размер блока передачи (MTU) в байтах конечной точки потока данных.

name -> (строка)

Имя конечной точки потока данных.

status -> (строка)

Статус конечной точки потока данных.

healthReasons -> (список)

Причины работоспособности конечной точки потока данных. Это поле игнорируется при вызове CreateDataflowEndpointGroup.

(строка)

healthStatus -> (строка)

Статус работоспособности конечной точки потока данных. Это поле игнорируется при вызове CreateDataflowEndpointGroup.

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

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

roleArn -> (строка)

ARN роли, необходимой для подключения потоков к вашим экземплярам.

securityGroupIds -> (список)

Группы безопасности для присоединения к интерфейсам эластичной сети.

(строка)

subnetIds -> (список)

Список подсетей, в которых AWS Ground Station размещает интерфейсы эластичной сети для отправки потоков на ваши экземпляры.

(строка)

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

Подробности записи S3 Config в контакте.

bucketArn -> (строка)

ARN используемого ведра.

keyTemplate -> (строка)

Шаблон ключа, используемый для конфигурации записи S3

configId -> (строка)

UUID Config.

configType -> (строка)

Тип Config.

dataflowDestinationRegion -> (строка)

Регион пункта назначения потока данных.

errorMessage -> (строка)

Сообщение об ошибке для потока данных.

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

Подробности потока данных для стороны источника.

configDetails -> (структура помеченных объединений)

Дополнительные сведения для Config, если тип — dataflow-endpoint или antenna-downlink-demod-decode

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть установлен: antennaDemodDecodeDetails, endpointDetails, s3RecordingDetails.

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

Подробности демодуляции антенны Config в контакте.

outputNode -> (строка)

Имя узла вывода демодулятора антенны, используемого в контакте.

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

Информация о параметрах конечной точки.

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

Конечная точка агента.

agentStatus -> (строка)

Статус AgentEndpoint.

auditResults -> (строка)

Результаты аудита.

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

Адрес egress AgentEndpoint.

mtu -> (целое число)

Максимальный размер блока передачи (MTU) в байтах конечной точки потока данных.

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

Адрес сокета.

name -> (строка)

Имя адреса сокета.

port -> (целое число)

Порт адреса сокета.

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

Адрес ingress AgentEndpoint.

mtu -> (целое число)

Максимальный размер блока передачи (MTU) в байтах конечной точки потока данных.

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

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

name -> (строка)

Адрес сокета IPv4.

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

Диапазон портов адреса сокета.

maximum -> (целое число)

Максимальное значение.

minimum -> (целое число)

Минимальное значение.

name -> (строка)

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

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

Конечная точка потока данных.

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

Адрес сокета конечной точки потока данных.

name -> (строка)

Имя адреса сокета.

port -> (целое число)

Порт адреса сокета.

mtu -> (целое число)

Максимальный размер блока передачи (MTU) в байтах конечной точки потока данных.

name -> (строка)

Имя конечной точки потока данных.

status -> (строка)

Статус конечной точки потока данных.

healthReasons -> (список)

Причины работоспособности конечной точки потока данных. Это поле игнорируется при вызове CreateDataflowEndpointGroup.

(строка)

healthStatus -> (строка)

Статус работоспособности конечной точки потока данных. Это поле игнорируется при вызове CreateDataflowEndpointGroup.

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

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

roleArn -> (строка)

ARN роли, необходимой для подключения потоков к вашим экземплярам.

securityGroupIds -> (список)

Группы безопасности для присоединения к интерфейсам эластичной сети.

(строка)

subnetIds -> (список)

Список подсетей, в которых AWS Ground Station размещает интерфейсы эластичной сети для отправки потоков на ваши экземпляры.

(строка)

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

Подробности записи S3 Config в контакте.

bucketArn -> (строка)

ARN используемого ведра.

keyTemplate -> (строка)

Шаблон ключа, используемый для конфигурации записи S3

configId -> (строка)

UUID Config.

configType -> (строка)

Тип Config.

dataflowSourceRegion -> (строка)

Регион источника потока данных.

endTime -> (временная метка)

Конец контакта по UTC.

errorMessage -> (строка)

Сообщение об ошибке для контакта.

groundStation -> (строка)

Наземная станция для контакта.

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

Максимальный угол возвышения контакта.

unit -> (строка)

Единицы измерения угла возвышения.

value -> (двойное)

Значение угла возвышения.

missionProfileArn -> (строка)

ARN профиля миссии.

postPassEndTime -> (временная метка)

Время после окончания контакта, когда вы хотите получить событие CloudWatch, указывающее на завершение прохода.

prePassStartTime -> (временная метка)

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

region -> (строка)

Регион контакта.

satelliteArn -> (строка)

ARN спутника.

startTime -> (временная метка)

Начало контакта по UTC.

tags -> (карта)

Теги, присвоенные контакту.

key -> (строка)

value -> (строка)

visibilityEndTime -> (временная метка)

Прогнозируемое время по UTC, когда ваш спутник опустится ниже маски приема. Это время основано на текущей активной эфемериде спутника для будущих контактов и эфемериде, которая была активна во время выполнения контакта для завершенных контактов.

visibilityStartTime -> (временная метка)

Прогнозируемое время по UTC, когда ваш спутник поднимется выше маски приема. Это время основано на текущей активной эфемериде спутника для будущих контактов и эфемериде, которая была активна во время выполнения контакта для завершенных контактов.

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

Spec-Zone.ru

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