Spec-Zone.ru › AWS CLI v2

[ aws . lookoutmetrics ]

describe-metric-set

Описание

Описывает набор данных.

Действия API Amazon Lookout for Metrics имеют конечную согласованность. Если вы выполняете операцию чтения ресурса сразу после его создания или изменения, используйте повторные попытки, чтобы дать время для завершения операции записи.

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

Синтаксис

  describe-metric-set
--metric-set-arn <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]

Параметры

--metric-set-arn (строка)

ARN набора данных.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из вашего файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

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

Вывод

MetricSetArn -> (строка)

Идентификатор ресурса набора метрик.

AnomalyDetectorArn -> (строка)

Идентификатор ресурса детектора аномалий, содержащего набор метрик.

MetricSetName -> (строка)

Имя набора метрик.

MetricSetDescription -> (строка)

Описание набора метрик.

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

Время создания набора метрик.

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

Время последнего изменения набора метрик.

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

Время ожидания детектора после окончания интервала перед импортом данных. Смещение поддерживается только для источников S3, Redshift, Athena.

MetricList -> (список)

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

(структура)

Вычисление, полученное путём сравнения измерения и размерности из исходных данных.

MetricName -> (строка)

Имя метрики.

AggregationFunction -> (строка)

Функция для вычисления метрики.

Namespace -> (строка)

Пространство имён метрики.

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

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

ColumnName -> (строка)

Имя столбца со временем.

ColumnFormat -> (строка)

Формат столбца со временем.

DimensionList -> (список)

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

(строка)

MetricSetFrequency -> (строка)

Интервал, с которым данные анализируются на предмет аномалий.

Timezone -> (строка)

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

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

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

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

Содержит информацию о настройках ведра S3, содержащего исходные файлы.

RoleArn -> (строка)

Идентификатор ресурса IAM-роли с правами чтения и записи в исходное ведро S3.

TemplatedPathList -> (список)

Список шаблонов путей к исходным файлам.

(строка)

HistoricalDataPathList -> (список)

Список путей к файлам исторических данных.

(строка)

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

Содержит информацию о формате исходного файла.

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

Содержит информацию о том, как следует анализировать файл данных CSV.

FileCompression -> (строка)

Уровень сжатия исходного файла CSV.

Charset -> (строка)

Кодировка символов исходного файла CSV.

ContainsHeader -> (логическое значение)

Содержит ли исходный файл CSV заголовок.

Delimiter -> (строка)

Разделитель в исходном файле CSV.

HeaderList -> (список)

Список заголовков исходного файла CSV, если они есть.

(строка)

QuoteSymbol -> (строка)

Символ кавычек.

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

Содержит информацию о том, как следует анализировать файл данных JSON.

FileCompression -> (строка)

Уровень сжатия исходного файла CSV.

Charset -> (строка)

Кодировка символов исходного файла JSON.

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

Детали источника данных AppFlow.

RoleArn -> (строка)

IAM-роль, предоставляющая Amazon Lookout for Metrics доступ к потоку.

FlowName -> (строка)

Имя потока.

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

Детали источника данных Amazon CloudWatch.

RoleArn -> (строка)

IAM-роль, предоставляющая Amazon Lookout for Metrics доступ к данным в Amazon CloudWatch.

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

Настройки режима моделирования.

RunBackTestMode -> (логическое значение)

Выполнить моделирование вместо мониторинга новых данных.

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

Детали источника данных Amazon RDS.

DBInstanceIdentifier -> (строка)

Строка, идентифицирующая экземпляр базы данных.

DatabaseHost -> (строка)

Имя хоста базы данных.

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

Номер порта для доступа к базе данных.

SecretManagerArn -> (строка)

Идентификатор ресурса AWS Secrets Manager.

DatabaseName -> (строка)

Имя базы данных RDS.

TableName -> (строка)

Имя таблицы в базе данных.

RoleArn -> (строка)

Идентификатор ресурса роли.

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

Объект, содержащий информацию о конфигурации Amazon VPC.

SubnetIdList -> (список)

Массив строк, содержащих идентификаторы подсетей Amazon VPC (например, subnet-0bb1c79de3EXAMPLE).

(строка)

SecurityGroupIdList -> (список)

Массив строк, содержащих список групп безопасности.

(строка)

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

Детали источника данных Amazon Redshift.

ClusterIdentifier -> (строка)

Строка, идентифицирующая кластер Redshift.

DatabaseHost -> (строка)

Имя хоста базы данных.

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

Номер порта для доступа к базе данных.

SecretManagerArn -> (строка)

Идентификатор ресурса AWS Secrets Manager.

DatabaseName -> (строка)

Имя базы данных Redshift.

TableName -> (строка)

Имя таблицы базы данных Redshift.

RoleArn -> (строка)

Идентификатор ресурса роли с доступом к базе данных.

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

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

SubnetIdList -> (список)

Массив строк, содержащих идентификаторы подсетей Amazon VPC (например, subnet-0bb1c79de3EXAMPLE).

(строка)

SecurityGroupIdList -> (список)

Массив строк, содержащих список групп безопасности.

(строка)

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

Детали источника данных Amazon Athena.

RoleArn -> (строка)

IAM-роль, предоставляющая Amazon Lookout for Metrics доступ к данным.

DatabaseName -> (строка)

Имя базы данных.

DataCatalog -> (строка)

Каталог данных базы данных.

TableName -> (строка)

Имя таблицы базы данных.

WorkGroupName -> (строка)

Имя рабочей группы базы данных.

S3ResultsPath -> (строка)

Путь к результатам в S3.

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

Настройки режима моделирования.

RunBackTestMode -> (логическое значение)

Выполнить моделирование вместо мониторинга новых данных.

DimensionFilterList -> (список)

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

(структура)

Описание списка фильтров для выбора подмножества значений размерностей. Каждый фильтр состоит из размерности и одного из её значений, которое необходимо включить. При указании нескольких размерностей или значений размерности соединяются операцией И, а значения — операцией ИЛИ.

Name -> (строка)

Размерность, по которой нужно фильтровать.

FilterList -> (список)

Список фильтров, которые применяются.

(структура)

Описание фильтра для выбора подмножества значений размерностей. Каждый фильтр состоит из размерности, которую необходимо включить, и оператора условия. Оператор условия указан в объекте FilterOperation.

DimensionValue -> (строка)

Значение, которое нужно включить в фильтр.

FilterOperation -> (строка)

Оператор условия.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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