Spec-Zone.ru › AWS CLI v2

[ aws . groundstation ]

list-contacts

Описание

Возвращает список контактов.

Если statusList содержит AVAILABLE, запрос должен включать groundStation , missionprofileArn и satelliteArn .

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

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

Синтаксис

  list-contacts
--end-time <value>
[--ground-station <value>]
[--mission-profile-arn <value>]
[--satellite-arn <value>]
--start-time <value>
--status-list <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]

Параметры

--end-time (метка времени)

Конечное время контакта в UTC.

--ground-station (строка)

Имя наземной станции.

--mission-profile-arn (строка)

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

--satellite-arn (строка)

ARN спутника.

--start-time (метка времени)

Начальное время контакта в UTC.

--status-list (список)

Статус резервации контакта.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  SCHEDULING
  FAILED_TO_SCHEDULE
  SCHEDULED
  CANCELLED
  AWS_CANCELLED
  PREPASS
  PASS
  POSTPASS
  COMPLETED
  FAILED
  AVAILABLE
  CANCELLING
  AWS_FAILED

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

contactList -> (список)

Список контактов.

(структура)

Данные, описывающие контакт.

contactId -> (строка)

UUID контакта.

contactStatus -> (строка)

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

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

Конечное время контакта в UTC.

errorMessage -> (строка)

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

groundStation -> (строка)

Имя наземной станции.

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

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

unit -> (строка)

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

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

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

missionProfileArn -> (строка)

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

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

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

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

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

region -> (строка)

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

satelliteArn -> (строка)

ARN спутника.

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

Начальное время контакта в UTC.

tags -> (массив)

Теги, назначенные контакту.

key -> (строка)

value -> (строка)

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

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

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

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

nextToken -> (строка)

Следующий маркер, возвращаемый в ответе предыдущего вызова ListContacts. Используется для получения следующей страницы результатов.

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

Spec-Zone.ru

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