Spec-Zone.ru › AWS CLI v2

[ aws . location ]

calculate-route-matrix

Описание

Вычисляет матрицу маршрутов, учитывая следующие обязательные параметры: DeparturePositions и DestinationPositions . CalculateRouteMatrix вычисляет маршруты и возвращает время и расстояние поездки от каждой точки отправления к каждой точке назначения в запросе. Например, при точках отправления A и B, и точках назначения X и Y, CalculateRouteMatrix вернёт время и расстояние для маршрутов от A до X, A до Y, B до X и B до Y (в указанном порядке). Количество возвращённых результатов (и вычисленных маршрутов) будет равно количеству DeparturePositions умноженному на количество DestinationPositions .

Примечание

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

Требует предварительного создания ресурса калькулятора маршрутов.

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

Дополнительные опции включают:

  • Указание времени отправления с помощью DepartureTime или DepartNow . Это вычисляет маршруты на основе прогнозных данных о дорожном движении в указанное время.

Примечание

Вы не можете указать как DepartureTime, так и DepartNow в одном запросе. Указание обоих параметров возвращает ошибку валидации.
  • Указание режима поездки с помощью TravelMode задаёт тип транспорта для вычисления маршрутов. Это также позволяет указать дополнительные предпочтения маршрута в CarModeOptions, если поездка осуществляется на Car, или в TruckModeOptions, если поездка осуществляется на Truck.

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

Синтаксис

  calculate-route-matrix
--calculator-name <value>
--departure-positions <value>
--destination-positions <value>
[--travel-mode <value>]
[--departure-time <value>]
[--depart-now | --no-depart-now]
[--distance-unit <value>]
[--car-mode-options <value>]
[--truck-mode-options <value>]
[--key <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]

Параметры

--calculator-name (строка)

Имя ресурса калькулятора маршрутов, который вы хотите использовать для расчёта матрицы маршрутов.

--departure-positions (список)

Список начальных (исходных) позиций для матрицы маршрутов. Массив точек, каждая из которых представляет собой массив из 2 значений, определённых в формате WGS 84: [longitude, latitude]. Например, [-123.115, 49.285].

Предупреждение

В зависимости от выбранного поставщика данных в ресурсе калькулятора маршрутов могут быть дополнительные ограничения на вводимые данные. См. Ограничения на позиции в руководстве разработчика Amazon Location Service.

Примечание

Для калькуляторов маршрутов, использующих Esri в качестве поставщика данных, если вы указываете начальную точку, которая не расположена на дороге, Amazon Location перемещает позицию на ближайшую дорогу. Значение, полученное после смещения, доступно в результате в SnappedDeparturePositions.

Допустимые значения: [-180 to 180,-90 to 90]

(список)

(двойное)

Краткий синтаксис:

double,double ...

Синтаксис JSON:

[
  [double, ...]
  ...
]

--destination-positions (список)

Список позиций назначения для матрицы маршрутов. Массив точек, каждая из которых представляет собой массив из 2 значений, определённых в формате WGS 84: [longitude, latitude]. Например, [-122.339, 47.615]

Предупреждение

В зависимости от выбранного поставщика данных в ресурсе калькулятора маршрутов могут быть дополнительные ограничения на вводимые данные. См. Ограничения на позиции в руководстве разработчика Amazon Location Service.

Примечание

Для калькуляторов маршрутов, использующих Esri в качестве поставщика данных, если вы указываете конечную точку, которая не расположена на дороге, Amazon Location перемещает позицию на ближайшую дорогу. Значение, полученное после смещения, доступно в результате в SnappedDestinationPositions.

Допустимые значения: [-180 to 180,-90 to 90]

(список)

(двойное)

Краткий синтаксис:

double,double ...

Синтаксис JSON:

[
  [double, ...]
  ...
]

--travel-mode (строка)

Указывает режим транспорта при расчёте маршрута. Используется для оценки скорости перемещения и совместимости с дорогами.

Указанный вами TravelMode также определяет, как вы указываете предпочтения маршрута:

  • Если вы путешествуете на Car, используйте параметр CarModeOptions.
  • Если вы путешествуете на Truck, используйте параметр TruckModeOptions.

Примечание

Bicycle или Motorcycle действительны только при использовании Grab в качестве поставщика данных и только в Юго-Восточной Азии.

Truck недоступен для Grab.

Для получения дополнительной информации об использовании Grab в качестве поставщика данных, см. GrabMaps в руководстве разработчика Amazon Location Service.

Значение по умолчанию: Car

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

  • Car
  • Truck
  • Walking
  • Bicycle
  • Motorcycle

--departure-time (временная метка)

Указывает желаемое время отправления. Используется для расчёта матрицы маршрутов.

Вы не можете установить одновременно DepartureTime и DepartNow. Если ни то, ни другое не установлено, используется наилучшее время суток с учётом текущих дорожных условий.

Примечание

Установка времени отправления в прошлом приводит к ошибке 400 ValidationException.
  • В формате ISO 8601: YYYY-MM-DDThh:mm:ss.sssZ. Например, 2020–07-2T12:15:20.000Z+01:00

--depart-now | --no-depart-now (булево)

Устанавливает время отправления как текущее время. Используется текущее время для расчёта матрицы маршрутов. Вы не можете установить одновременно DepartureTime и DepartNow. Если ни то, ни другое не установлено, используется наилучшее время суток с учётом текущих дорожных условий.

Значение по умолчанию: false

Допустимые значения: false | true

--distance-unit (строка)

Установите систему единиц измерения для указания расстояния.

Значение по умолчанию: Kilometers

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

  • Kilometers
  • Miles

--car-mode-options (структура)

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

Требование: TravelMode должно быть указано как Car.

AvoidFerries -> (булево)

Избегает паромных переправ при расчёте маршрутов.

Значение по умолчанию: false

Допустимые значения: false | true

AvoidTolls -> (булево)

Избегает платных дорог при расчёте маршрутов.

Значение по умолчанию: false

Допустимые значения: false | true

Краткий синтаксис:

AvoidFerries=boolean,AvoidTolls=boolean

Синтаксис JSON:

{
  "AvoidFerries": true|false,
  "AvoidTolls": true|false
}

--truck-mode-options (структура)

Устанавливает предпочтения маршрута при поездке на Truck, такие как избегание маршрутов с использованием паромных переправ или платных дорог, а также технические характеристики грузовика для выбора оптимального маршрута.

Требование: TravelMode должно быть указано как Truck.

AvoidFerries -> (булево)

Избегает паромных переправ при расчёте маршрутов.

Значение по умолчанию: false

Допустимые значения: false | true

AvoidTolls -> (булево)

Избегает платных дорог при расчёте маршрутов.

Значение по умолчанию: false

Допустимые значения: false | true

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

Указывает габариты грузовика, включая длину, высоту, ширину и единицу измерения. Используется для избегания дорог, которые не могут выдержать габариты грузовика.

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

Длина грузовика.

  • Например, 15.5.

Примечание

Для маршрутов, рассчитанных с использованием ресурса HERE, это значение должно быть между 0 и 300 метрами.

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

Высота грузовика.

  • Например, 4.5.

Примечание

Для маршрутов, рассчитанных с использованием ресурса HERE, это значение должно быть между 0 и 50 метрами.

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

Ширина грузовика.

  • Например, 4.5.

Примечание

Для маршрутов, рассчитанных с использованием ресурса HERE, это значение должно быть между 0 и 50 метрами.

Unit -> (строка)

Указывает единицу измерения для габаритов грузовика.

Значение по умолчанию: Meters

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

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

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

Общий вес грузовика.

  • Например, 3500.

Unit -> (строка)

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

Значение по умолчанию: Kilograms

Краткий синтаксис:

AvoidFerries=boolean,AvoidTolls=boolean,Dimensions={Length=double,Height=double,Width=double,Unit=string},Weight={Total=double,Unit=string}

Синтаксис JSON:

{
  "AvoidFerries": true|false,
  "AvoidTolls": true|false,
  "Dimensions": {
    "Length": double,
    "Height": double,
    "Width": double,
    "Unit": "Meters"|"Feet"
  },
  "Weight": {
    "Total": double,
    "Unit": "Kilograms"|"Pounds"
  }
}

--key (строка)

Необязательный API-ключ для авторизации запроса.

--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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Переопределить стандартный URL команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать конкретный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить вывод в цвете.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить вывод страницы CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

RouteMatrix -> (список)

Вычисленная матрица маршрутов, содержащая результаты для всех пар DeparturePositions до DestinationPositions. Каждая строка соответствует одному элементу в DeparturePositions. Каждый элемент в строке соответствует маршруту от этого элемента в DeparturePositions к элементу в DestinationPositions.

(список)

(структура)

Результат вычисленного маршрута для одной пары DeparturePosition DestinationPosition.

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

Общее расстояние для маршрута.

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

Ожидаемая продолжительность маршрута.

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

Ошибка, соответствующая вычислению маршрута между DeparturePosition и DestinationPosition.

Code -> (строка)

Тип ошибки, возникшей при вычислении маршрута.

Message -> (строка)

Сообщение об ошибке, возникшей при вычислении маршрута.

SnappedDeparturePositions -> (список)

Для маршрутов, рассчитанных с помощью ресурса Esri route calculator, начальные точки фиксируются к ближайшей дороге. Для ресурсов Esri route calculator это возвращает список начальных/исходных точек, используемых для вычисления RouteMatrix.

(список)

(двойное)

SnappedDestinationPositions -> (список)

Список конечных точек для матрицы маршрутов, используемой для вычисления RouteMatrix.

(список)

(двойное)

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

Содержит информацию о матрице маршрутов, DataSource, DistanceUnit, RouteCount и ErrorCount.

DataSource -> (строка)

Провайдер данных о дорожном движении и дорожной сети, используемый для вычисления маршрутов. Указывает одного из доступных провайдеров:

  • Esri
  • Grab
  • Here

Дополнительную информацию о поставщиках данных см. на странице Amazon Location Service data providers.

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

Количество ячеек в матрице маршрутов. Равно произведению количества DeparturePositions на количество DestinationPositions.

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

Количество результатов с ошибками в матрице маршрутов. Если это число равно 0, все маршруты были вычислены успешно.

DistanceUnit -> (строка)

Единица измерения расстояний маршрутов.

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

Spec-Zone.ru

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