Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

get-statistics

Описание

Возвращает количество, среднее значение, сумму, минимальное, максимальное значения, сумму квадратов, дисперсию и стандартное отклонение для указанного агрегированного поля. Если поле агрегации типа String, возвращается только статистика количества.

Требуется разрешение на доступ к действию GetStatistics.

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

Синтаксис

  get-statistics
[--index-name <value>]
--query-string <value>
[--aggregation-field <value>]
[--query-version <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]

Параметры

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

Имя индекса для поиска. Значение по умолчанию - AWS_Things .

--query-string (строка)

Запрос для поиска. Можно указать «*» для строки запроса, чтобы получить количество всех индексированных элементов в вашей учетной записи Amazon Web Services.

--aggregation-field (строка)

Имя поля агрегации.

--query-version (строка)

Версия запроса для поиска.

--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
  • текст
  • таблица
  • 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается на двоичный блок, 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.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительные сведения см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для поиска в индексе устройств агрегированных данных

Следующий get-statistics пример возвращает количество элементов, у которых свойство с именем connectivity.connected установлено в значение false (т.е. количество устройств, которые не подключены) в их тени устройства.

aws iot get-statistics \
    --index-name AWS_Things \
    --query-string "connectivity.connected:false"

Вывод:

{
    "statistics": {
        "count": 6
    }
}

Дополнительные сведения см. в разделе Получение статистики о вашем флоте устройств в Руководстве разработчика AWS IoT.

Вывод

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

Статистика, возвращенная службой индексирования флота на основе запроса и поля агрегации.

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

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

average -> (двойное число)

Среднее значение значений агрегированного поля.

sum -> (двойное число)

Сумма значений агрегированного поля.

minimum -> (двойное число)

Минимальное значение агрегированного поля.

maximum -> (двойное число)

Максимальное значение агрегированного поля.

sumOfSquares -> (двойное число)

Сумма квадратов значений агрегированного поля.

variance -> (двойное число)

Дисперсия значений агрегированного поля.

stdDeviation -> (двойное число)

Стандартное отклонение значений агрегированного поля.

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

Spec-Zone.ru

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