[ aws . iotanalytics ]
Список хранилищ данных
Описание
Получает список хранилищ данных.
См. также: Документацию API AWS
list-datastores является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлечь данные из результатов следующих выражений запроса: datastoreSummaries
Синтаксис
list-datastores
[--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]
Параметры
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, заданному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения перекроют значения, заданные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен, указывающий, с какой точки следует начать постраничный вывод. Это NextToken из ранее обрезанного ответа.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды будет предоставлен NextToken. Для возобновления постраничного вывода необходимо предоставить значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.
--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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования типа Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в руководстве пользователя AWS CLI.
Для получения списка хранилищ данных
Следующий пример вывода отображает сводную информацию о доступных хранилищах данных.
aws iotanalytics list-datastores
Вывод:
{
"datastoreSummaries": [
{
"status": "ACTIVE",
"datastoreName": "mydatastore",
"creationTime": 1557858971.02,
"lastUpdateTime": 1557858971.02
}
]
}
Дополнительную информацию см. в разделе ListDatastores в Справочнике по API AWS IoT Analytics.
Вывод
datastoreSummaries -> (список)
Список DatastoreSummary объектов.
(структура)
Сводная информация о хранилище данных.
datastoreName -> (строка)
datastoreStorage -> (структура)
Место хранения данных в хранилище данных.
serviceManagedS3 -> (структура)
customerManagedS3 -> (структура)
Используется для хранения данных в ведре Amazon S3, управляемом пользователем.
bucket -> (строка)
keyPrefix -> (строка)
roleArn -> (строка)
iotSiteWiseMultiLayerStorage -> (структура)
Используется для хранения данных, используемых IoT SiteWise, в ведре Amazon S3, управляемом вами.
customerManagedS3Storage -> (структура)
Используется для хранения данных, используемых IoT SiteWise, в ведре Amazon S3, управляемом вами.
bucket -> (строка)
keyPrefix -> (строка)
status -> (строка)
creationTime -> (временная метка)
lastUpdateTime -> (временная метка)
lastMessageArrivalTime -> (временная метка)
Последнее время, когда новое сообщение пришло в хранилище данных.
IoT Analytics обновляет это значение не чаще одного раза в минуту для хранилища данных Amazon Simple Storage Service. Следовательно, значение lastMessageArrivalTime является приблизительным.
Эта функция применяется только к сообщениям, которые поступили в хранилище данных после 23 октября 2020 г.
fileFormatType -> (строка)
datastorePartitions -> (структура)
Содержит информацию о разделах разбиения в хранилище данных.
partitions -> (список)
Список разделов разбиения в хранилище данных.
(структура)
Один раздел для разбиения хранилища данных. Раздел должен быть AttributePartition или TimestampPartition.
attributePartition -> (структура)
Раздел разбиения, определенный attributeName.
attributeName -> (строка)
timestampPartition -> (структура)
Раздел разбиения, определенный атрибутом временной метки.
attributeName -> (строка)
timestampFormat -> (строка)
nextToken -> (строка)
null, если больше результатов нет.
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|