[ aws . iotsitewise ]
describe-storage-configuration
Описание
Получает информацию о конфигурации хранилища для IoT SiteWise.
См. также: Документация API AWS
Синтаксис
describe-storage-configuration
[--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]
Параметры
--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 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.
Вывод
storageType -> (строка)
Уровень хранилища, который вы указали для данных. Параметр storageType может принимать одно из следующих значений:
-
SITEWISE_DEFAULT_STORAGE— IoT SiteWise сохраняет данные в горячем уровне. Горячий уровень — это управляемая службой база данных. -
MULTI_LAYER_STORAGE— IoT SiteWise сохраняет данные как в холодном, так и в горячем уровне. Холодный уровень — это управляемый клиентом Amazon S3-бакет.
multiLayerStorage -> (структура)
Содержит информацию о хранилище назначения.
customerManagedS3Storage -> (структура)
Содержит информацию о управляемом клиентом Amazon S3-бакете.
s3ResourceArn -> (строка)
roleArn -> (строка)
disassociatedDataStorage -> (строка)
Содержит конфигурацию хранилища для временных рядов (потоков данных), не связанных с свойствами активов. Параметр disassociatedDataStorage может принимать одно из следующих значений:
-
ENABLED— IoT SiteWise принимает временные ряды, не связанные со свойствами активов.
Предупреждение
После включенияdisassociatedDataStorage его нельзя отключить.-
DISABLED— IoT SiteWise не принимает временные ряды (потоки данных), не связанные со свойствами активов.
Дополнительную информацию см. в разделе Потоки данных в Руководстве пользователя IoT SiteWise.
retentionPeriod -> (структура)
Количество дней, в течение которого данные хранятся в горячем уровне. По умолчанию данные хранятся неограниченно в горячем уровне.
numberOfDays -> (целое число)
Количество дней хранения данных.
Примечание
Если вы указали значение для этого параметра, параметрunlimited должен быть false.unlimited -> (логическое значение)
Если значение true, данные хранятся неограниченно.
Примечание
Если настроеноtrue, вы не должны указывать значение для параметра numberOfDays.configurationStatus -> (структура)
Содержит текущую информацию о состоянии конфигурации.
state -> (строка)
error -> (структура)
Содержит информацию об ошибке, если таковая имеется.
code -> (строка)
message -> (строка)
lastUpdateDate -> (отметка времени)
warmTier -> (строка)
warmTierRetentionPeriod -> (структура)
Установите этот период, чтобы указать, как долго данные хранятся в теплом уровне, прежде чем будут удалены. Вы можете установить его только в том случае, если включен холодный уровень.
numberOfDays -> (целое число)
unlimited -> (логическое значение)
disallowIngestNullNaN -> (логическое значение)
true.
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|