[ aws . iotsitewise ]
put-storage-configuration
Описание
Настройка параметров хранения для IoT SiteWise.
См. также: документацию API AWS
Синтаксис
put-storage-configuration
--storage-type <value>
[--multi-layer-storage <value>]
[--disassociated-data-storage <value>]
[--retention-period <value>]
[--warm-tier <value>]
[--warm-tier-retention-period <value>]
[--disallow-ingest-null-na-n | --no-disallow-ingest-null-na-n]
[--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]
Параметры
--storage-type (строка)
Уровень хранения, указанный для данных. Параметр storageType может принимать следующие значения:
-
SITEWISE_DEFAULT_STORAGE– IoT SiteWise сохраняет данные в горячем хранилище. Горячее хранилище — это управляемая службой база данных. -
MULTI_LAYER_STORAGE– IoT SiteWise сохраняет данные как в холодном, так и в горячем хранилище. Холодное хранилище — это управляемый клиентом Amazon S3-ковш.
Возможные значения:
SITEWISE_DEFAULT_STORAGEMULTI_LAYER_STORAGE
--multi-layer-storage (структура)
Идентифицирует место хранения данных. Если вы указали MULTI_LAYER_STORAGE для типа хранения, вы должны указать объект MultiLayerStorage.
customerManagedS3Storage -> (структура)
Содержит информацию о управляемом клиентом Amazon S3-ковше.
s3ResourceArn -> (строка)
roleArn -> (строка)
Сокращенный синтаксис:
customerManagedS3Storage={s3ResourceArn=string,roleArn=string}
Синтаксис JSON:
{
"customerManagedS3Storage": {
"s3ResourceArn": "string",
"roleArn": "string"
}
}
--disassociated-data-storage (строка)
Содержит конфигурацию хранения для временных рядов (потоков данных), которые не связаны с свойствами активов. disassociatedDataStorage может принимать следующие значения:
-
ENABLED– IoT SiteWise принимает временные ряды, которые не связаны со свойствами активов.
Предупреждение
После включенияdisassociatedDataStorage его нельзя отключить.-
DISABLED– IoT SiteWise не принимает временные ряды (потоки данных), которые не связаны со свойствами активов.
Дополнительную информацию см. в разделе Потоки данных в руководстве пользователя IoT SiteWise.
Возможные значения:
ENABLEDDISABLED
--retention-period (структура)
Количество дней, в течение которых данные хранятся в горячем хранилище. По умолчанию данные хранятся неопределенно долго в горячем хранилище.
numberOfDays -> (целое число)
Количество дней хранения данных.
Примечание
Если вы указали значение для этого параметра, параметрunlimited должен быть false .unlimited -> (логическое значение)
Если true, данные хранятся неопределенно долго.
Примечание
Если настроено наtrue, вы не должны указывать значение для параметра numberOfDays.Сокращенный синтаксис:
numberOfDays=integer,unlimited=boolean
Синтаксис JSON:
{
"numberOfDays": integer,
"unlimited": true|false
}
--warm-tier (строка)
Управляемое службой хранилище, оптимизированное для аналитических запросов. Оно хранит периодически загружаемые, буферизованные и исторические данные, загруженные с помощью API CreaeBulkImportJob.
Возможные значения:
ENABLEDDISABLED
--warm-tier-retention-period (структура)
Установите этот период, чтобы указать, как долго данные хранятся в теплом хранилище, прежде чем будут удалены. Это можно установить только при включенном холодном хранилище.
numberOfDays -> (целое число)
unlimited -> (логическое значение)
Сокращенный синтаксис:
numberOfDays=integer,unlimited=boolean
Синтаксис JSON:
{
"numberOfDays": integer,
"unlimited": true|false
}
--disallow-ingest-null-na-n | --no-disallow-ingest-null-na-n (логическое значение)
true.--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
- text
- таблица
- 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 -> (строка)
warmTier -> (строка)
warmTierRetentionPeriod -> (структура)
Установите этот период, чтобы указать, как долго ваши данные хранятся в теплом уровне хранения перед удалением. Вы можете установить это значение только если включен холодный уровень хранения.
numberOfDays -> (целое число)
unlimited -> (логическое значение)
disallowIngestNullNaN -> (логическое значение)
true.
© Copyright 2025, Amazon Web Services. Created using Sphinx.