Spec-Zone.ru › AWS CLI v2

[ aws . iotanalytics ]

обновить-хранилище-данных

Описание

Используется для обновления настроек хранилища данных.

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

Синтаксис

  update-datastore
--datastore-name <value>
[--retention-period <value>]
[--datastore-storage <value>]
[--file-format-configuration <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]

Параметры

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

Имя хранилища данных, которое нужно обновить.

--retention-period (структура)

Срок хранения данных сообщений в днях для хранилища данных. Срок хранения нельзя обновить, если хранилище данных использует управляемое клиентом хранилище Amazon S3.

unlimited -> (булево)

Если true, данные сообщений хранятся неопределенно долго.

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

Количество дней хранения данных сообщений. Параметр unlimited должен быть false.

Сокращенный синтаксис:

unlimited=boolean,numberOfDays=integer

Синтаксис JSON:

{
  "unlimited": true|false,
  "numberOfDays": integer
}

--datastore-storage (структура)

Место хранения данных в хранилище данных. Можно выбрать хранилище serviceManagedS3, хранилище customerManagedS3 или хранилище iotSiteWiseMultiLayerStorage. По умолчанию используется serviceManagedS3. Выбор хранилища Amazon S3 изменить нельзя после создания хранилища данных.

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

Используется для хранения данных в ведре Amazon S3, управляемом IoT Analytics. Выбор хранилища Amazon S3 изменить нельзя после создания хранилища данных.

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

S3-управляемое клиентом; при выборе хранилища, управляемого клиентом, параметр retentionPeriod игнорируется. Выбор хранилища Amazon S3 изменить нельзя после создания хранилища данных.

bucket -> (строка)

Имя ведра Amazon S3, в котором хранятся данные.

keyPrefix -> (строка)

(Необязательно) Префикс, используемый для создания ключей объектов данных хранилища данных. Каждый объект в ведре Amazon S3 имеет ключ, являющийся его уникальным идентификатором в ведре. Каждый объект в ведре имеет ровно один ключ. Префикс должен оканчиваться обратным слэшем (/).

roleArn -> (строка)

ARN роли, предоставляющей IoT Analytics разрешения на взаимодействие с вашими ресурсами Amazon S3.

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

Используется для хранения данных, используемых IoT SiteWise, в ведре Amazon S3, которым вы управляете. Выбор хранилища Amazon S3 изменить нельзя после создания хранилища данных.

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

Используется для хранения данных, используемых IoT SiteWise, в ведре Amazon S3, которым вы управляете.

bucket -> (строка)

Имя ведра Amazon S3, в котором хранятся данные.

keyPrefix -> (строка)

(Необязательно) Префикс, используемый для создания ключей объектов данных хранилища данных. Каждый объект в ведре Amazon S3 имеет ключ, являющийся его уникальным идентификатором в ведре. Каждый объект в ведре имеет ровно один ключ. Префикс должен оканчиваться обратным слэшем (/).

Сокращенный синтаксис:

serviceManagedS3={},customerManagedS3={bucket=string,keyPrefix=string,roleArn=string},iotSiteWiseMultiLayerStorage={customerManagedS3Storage={bucket=string,keyPrefix=string}}

Синтаксис JSON:

{
  "serviceManagedS3": {

  },
  "customerManagedS3": {
    "bucket": "string",
    "keyPrefix": "string",
    "roleArn": "string"
  },
  "iotSiteWiseMultiLayerStorage": {
    "customerManagedS3Storage": {
      "bucket": "string",
      "keyPrefix": "string"
    }
  }
}

--file-format-configuration (структура)

Содержит конфигурационную информацию о форматах файлов. Хранилища данных IoT Analytics поддерживают форматы JSON и Parquet.

По умолчанию используется формат JSON. Можно указать только один формат.

Изменить формат файла после создания хранилища данных нельзя.

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

Содержит конфигурационную информацию о формате JSON.

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

Содержит конфигурационную информацию о формате Parquet.

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

Информация, необходимая для определения схемы.

columns -> (список)

Указывает один или несколько столбцов, в которых хранятся данные.

В каждой схеме может быть до 100 столбцов. В каждом столбце может быть до 100 вложенных типов.

(структура)

Содержит информацию о столбце, в котором хранятся данные.

name -> (строка)

Имя столбца.

type -> (строка)

Тип данных. Дополнительную информацию о поддерживаемых типах данных см. в разделе «Общие типы данных» в Руководстве разработчика Glue.

Синтаксис JSON:

{
  "jsonConfiguration": {

  },
  "parquetConfiguration": {
    "schemaDefinition": {
      "columns": [
        {
          "name": "string",
          "type": "string"
        }
        ...
      ]
    }
  }
}

--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.

Примеры

Примечание

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

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных оболочек. Эти примеры нужно адаптировать к правилам цитирования вашей оболочки. Дополнительную информацию см. в разделе «Использование кавычек со строками» в AWS CLI User Guide.

Для обновления хранилища данных

В следующем update-datastore примере изменяются настройки указанного хранилища данных.

aws iotanalytics update-datastore \
    --cli-input-json file://update-datastore.json

Содержимое update-datastore.json:

{
    "datastoreName": "mydatastore",
    "retentionPeriod": {
        "numberOfDays": 93
    }
}

Эта команда не генерирует вывод.

Дополнительную информацию см. в разделе UpdateDatastore в Справочнике по API AWS IoT Analytics.

Вывод

Отсутствует

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

Spec-Zone.ru

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