Spec-Zone.ru › AWS CLI v2

[ aws . lookoutmetrics ]

обновить-набор-метрики

Описание

Обновляет набор данных.

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

Синтаксис

  update-metric-set
--metric-set-arn <value>
[--metric-set-description <value>]
[--metric-list <value>]
[--offset <value>]
[--timestamp-column <value>]
[--dimension-list <value>]
[--metric-set-frequency <value>]
[--metric-source <value>]
[--dimension-filter-list <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 набора данных для обновления.

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

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

--metric-list (список)

Список метрик.

(структура)

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

MetricName -> (строка)

Название метрики.

AggregationFunction -> (строка)

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

Namespace -> (строка)

Имя пространства имён метрики.

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

MetricName=string,AggregationFunction=string,Namespace=string ...

Синтаксис JSON:

[
  {
    "MetricName": "string",
    "AggregationFunction": "AVG"|"SUM",
    "Namespace": "string"
  }
  ...
]

--offset (целое число)

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

--timestamp-column (структура)

Столбец временной метки.

ColumnName -> (строка)

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

ColumnFormat -> (строка)

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

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

ColumnName=string,ColumnFormat=string

Синтаксис JSON:

{
  "ColumnName": "string",
  "ColumnFormat": "string"
}

--dimension-list (список)

Список размерностей.

(строка)

Синтаксис:

"string" "string" ...

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

Интервал набора данных.

Возможные значения:

  • P1D
  • PT1H
  • PT10M
  • PT5M

--metric-source (структура)

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

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

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

RoleArn -> (строка)

ARN роли 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 Relational Database Service (RDS).

DBInstanceIdentifier -> (строка)

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

DatabaseHost -> (строка)

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

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

Порт доступа к базе данных.

SecretManagerArn -> (строка)

ARN роли AWS Secrets Manager.

DatabaseName -> (строка)

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

TableName -> (строка)

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

RoleArn -> (строка)

ARN роли.

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

Информация о конфигурации Amazon Virtual Private Cloud (VPC).

SubnetIdList -> (список)

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

(строка)

SecurityGroupIdList -> (список)

Список идентификаторов групп безопасности.

(строка)

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

Подробности источника данных Amazon Redshift.

ClusterIdentifier -> (строка)

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

DatabaseHost -> (строка)

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

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

Порт доступа к базе данных.

SecretManagerArn -> (строка)

ARN роли AWS Secrets Manager.

DatabaseName -> (строка)

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

TableName -> (строка)

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

RoleArn -> (строка)

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

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

Информация о конфигурации Amazon Virtual Private Cloud (VPC).

SubnetIdList -> (список)

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

(строка)

SecurityGroupIdList -> (список)

Список идентификаторов групп безопасности.

(строка)

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

Подробности о источнике данных Amazon Athena.

RoleArn -> (строка)

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

DatabaseName -> (строка)

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

DataCatalog -> (строка)

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

TableName -> (строка)

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

WorkGroupName -> (строка)

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

S3ResultsPath -> (строка)

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

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

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

RunBackTestMode -> (булево)

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

Синтаксис JSON:

{
  "S3SourceConfig": {
    "RoleArn": "string",
    "TemplatedPathList": ["string", ...],
    "HistoricalDataPathList": ["string", ...],
    "FileFormatDescriptor": {
      "CsvFormatDescriptor": {
        "FileCompression": "NONE"|"GZIP",
        "Charset": "string",
        "ContainsHeader": true|false,
        "Delimiter": "string",
        "HeaderList": ["string", ...],
        "QuoteSymbol": "string"
      },
      "JsonFormatDescriptor": {
        "FileCompression": "NONE"|"GZIP",
        "Charset": "string"
      }
    }
  },
  "AppFlowConfig": {
    "RoleArn": "string",
    "FlowName": "string"
  },
  "CloudWatchConfig": {
    "RoleArn": "string",
    "BackTestConfiguration": {
      "RunBackTestMode": true|false
    }
  },
  "RDSSourceConfig": {
    "DBInstanceIdentifier": "string",
    "DatabaseHost": "string",
    "DatabasePort": integer,
    "SecretManagerArn": "string",
    "DatabaseName": "string",
    "TableName": "string",
    "RoleArn": "string",
    "VpcConfiguration": {
      "SubnetIdList": ["string", ...],
      "SecurityGroupIdList": ["string", ...]
    }
  },
  "RedshiftSourceConfig": {
    "ClusterIdentifier": "string",
    "DatabaseHost": "string",
    "DatabasePort": integer,
    "SecretManagerArn": "string",
    "DatabaseName": "string",
    "TableName": "string",
    "RoleArn": "string",
    "VpcConfiguration": {
      "SubnetIdList": ["string", ...],
      "SecurityGroupIdList": ["string", ...]
    }
  },
  "AthenaSourceConfig": {
    "RoleArn": "string",
    "DatabaseName": "string",
    "DataCatalog": "string",
    "TableName": "string",
    "WorkGroupName": "string",
    "S3ResultsPath": "string",
    "BackTestConfiguration": {
      "RunBackTestMode": true|false
    }
  }
}

--dimension-filter-list (список)

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

(структура)

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

Name -> (строка)

Размерность для фильтрации.

FilterList -> (список)

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

(структура)

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

DimensionValue -> (строка)

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

FilterOperation -> (строка)

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

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

Name=string,FilterList=[{DimensionValue=string,FilterOperation=string},{DimensionValue=string,FilterOperation=string}] ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "FilterList": [
      {
        "DimensionValue": "string",
        "FilterOperation": "EQUALS"
      }
      ...
    ]
  }
  ...
]

--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 (boolean)

Включить отладку.

--endpoint-url (string)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр предоставлен.

--ca-bundle (string)

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

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию - 60 секунд.

--cli-binary-format (string)

Стиль форматирования для бинарных блоков. По умолчанию используется формат 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 (boolean)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

MetricSetArn -> (string)

ARN набора метрик.

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

Spec-Zone.ru

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