Spec-Zone.ru › AWS CLI v2

[ aws . iotanalytics ]

создание-хранилища-данных

Описание

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

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

Синтаксис

  create-datastore
--datastore-name <value>
[--datastore-storage <value>]
[--retention-period <value>]
[--tags <value>]
[--file-format-configuration <value>]
[--datastore-partitions <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 (строка)

Имя хранилища данных.

--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"
    }
  }
}

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

Срок хранения данных сообщений в днях для хранилища данных. При выборе хранилища customerManagedS3 этот параметр игнорируется.

unlimited -> (булево)

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

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

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

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

unlimited=boolean,numberOfDays=integer

Синтаксис JSON:

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

--tags (список)

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

(структура)

Набор пар ключ-значение, используемых для управления ресурсом.

key -> (строка)

Ключ тега.

value -> (строка)

Значение тега.

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

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "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"
        }
        ...
      ]
    }
  }
}

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

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

partitions -> (список)

Список измерений разбиения в хранилище данных.

(структура)

Одно измерение для разбиения хранилища данных. Измерение должно быть AttributePartition или TimestampPartition.

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

Измерение разбиения, определённое attributeName.

attributeName -> (строка)

Имя атрибута, определяющего измерение разбиения.

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

Измерение разбиения, определённое атрибутом даты/времени.

attributeName -> (строка)

Имя атрибута разбиения, определённого датой/временем.

timestampFormat -> (строка)

Формат даты/времени разбиения, определённого датой/временем. По умолчанию используется количество секунд с эпохи (1 января 1970 года в полночь по UTC).

Синтаксис JSON:

{
  "partitions": [
    {
      "attributePartition": {
        "attributeName": "string"
      },
      "timestampPartition": {
        "attributeName": "string",
        "timestampFormat": "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
  • текст
  • таблица
  • 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.

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

Создание хранилища данных

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

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

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

{
    "datastoreName": "mydatastore",
    "retentionPeriod": {
        "numberOfDays": 90
    },
    "tags": [
        {
            "key": "Environment",
            "value": "Production"
        }
    ]
}

Вывод:

{
    "datastoreName": "mydatastore",
    "datastoreArn": "arn:aws:iotanalytics:us-west-2:123456789012:datastore/mydatastore",
    "retentionPeriod": {
        "numberOfDays": 90,
        "unlimited": false
    }
}

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

Вывод

datastoreName -> (строка)

Имя хранилища данных.

datastoreArn -> (строка)

ARN хранилища данных.

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

Срок хранения данных сообщений в днях для хранилища данных.

unlimited -> (логическое)

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

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

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

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

Spec-Zone.ru

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