Spec-Zone.ru › AWS CLI v2

[ aws . lookoutequipment ]

describe-dataset

Описание

Предоставляет JSON-описание данных в каждом наборе временных рядов, включая имена, имена столбцов и типы данных.

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

Синтаксис

  describe-dataset
--dataset-name <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]

Параметры

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

Имя набора данных, который нужно описать.

--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-auto-prompt (логическое)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое)

Отключить автоматическое запрошенние параметров ввода CLI.

Вывод

DatasetName -> (строка)

Название описываемого набора данных.

DatasetArn -> (строка)

Amazon Resource Name (ARN) описываемого набора данных.

CreatedAt -> (маркер времени)

Указывает время создания набора данных в Lookout for Equipment.

LastUpdatedAt -> (маркер времени)

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

Status -> (строка)

Указывает статус набора данных.

Schema -> (строка)

JSON-описание данных в каждом наборе временных рядов, включая имена, имена столбцов и типы данных.

ServerSideKmsKeyId -> (строка)

Предоставляет идентификатор ключа KMS, используемого для шифрования данных набора данных службой Amazon Lookout for Equipment.

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

Указывает конфигурацию расположения в S3 для входных данных для задачи загрузки данных.

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

Информация о расположении для ведра S3, используемого для входных данных для загрузки данных.

Bucket -> (строка)

Название ведра S3, используемого для входных данных для загрузки данных.

Prefix -> (строка)

Префикс для расположения в S3, используемого для входных данных для загрузки данных.

KeyPattern -> (строка)

Шаблон для сопоставления файлов Amazon S3, которые будут использоваться для загрузки. Если схема была создана ранее без KeyPattern, то используется значение по умолчанию KeyPattern {prefix}/{component_name}/* для загрузки файлов из Amazon S3 в соответствии со схемой. Это поле является обязательным при первой загрузке данных.

Допустимые значения: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[РАЗДЕЛИТЕЛЬ]* (Разрешенные разделители: пробел, точка, нижнее подчеркивание, дефис)

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

Приводит статистику, связанную с заданным набором данных для идентификатора последней успешной связанной задачи загрузки. Эти данные в основном относятся к количественной оценке неверных данных, таких как MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData и DuplicateTimeStamps.

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

Параметр, предоставляющий информацию об недостаточных данных для датчиков в наборе данных. Он включает в себя информацию о датчиках, у которых отсутствуют полные данные, и о датчиках с коротким диапазоном дат.

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

Параметр, описывающий общее количество датчиков, у которых отсутствуют полностью данные.

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

Указывает количество датчиков, у которых полностью отсутствуют данные.

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

Параметр, описывающий общее количество датчиков, у которых короткий диапазон дат менее 14 дней в целом.

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

Указывает количество датчиков, у которых менее 14 дней данных.

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

Параметр, предоставляющий информацию о данных, отсутствующих по всем датчикам во входных данных.

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

Указывает количество датчиков, у которых отсутствуют данные.

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

Указывает общее количество пропущенных значений по всем датчикам.

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

Параметр, предоставляющий информацию о данных, неверных по всем датчикам во входных данных.

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

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

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

Указывает общее количество недопустимых значений по всем датчикам.

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

Параметр, предоставляющий информацию об недопустимых временных отметках во входных данных.

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

Указывает общее количество недопустимых временных отметках по всем загруженным данным.

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

Параметр, предоставляющий информацию о дублируемых временных отметках во входных данных.

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

Указывает общее количество дублируемых временных отметках.

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

IngestedFilesSummary, связанные с заданным набором данных для идентификатора последней успешной связанной задачи загрузки.

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

Указывает общее количество файлов, отправленных на загрузку.

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

Указывает количество успешно загруженных файлов.

DiscardedFiles -> (список)

Указывает количество файлов, которые были отброшены. Файл может быть отброшен, потому что его формат недопустим (например, jpg или pdf) или он не читаем.

(структура)

Содержит информацию о ведре S3.

Bucket -> (строка)

Название конкретного ведра S3.

Key -> (строка)

Ключ Amazon Web Services Key Management Service (KMS) используемый для шифрования объекта S3. Без этого ключа данные в ведре недоступны.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которую вы используете для этой задачи загрузки данных.

DataStartTime -> (маркер времени)

Указывает самую раннюю временную метку, соответствующую данным, которые были успешно загружены во время последней загрузки этого набора данных.

DataEndTime -> (маркер времени)

Указывает самую позднюю временную метку, соответствующую данным, которые были успешно загружены во время последней загрузки этого набора данных.

SourceDatasetArn -> (строка)

Amazon Resource Name (ARN) исходного набора данных, из которого был импортирован текущий набор данных, который описывается.

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

Spec-Zone.ru

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