Spec-Zone.ru › AWS CLI v2

[ aws . customer-profiles ]

определение-расчётного-атрибута

Описание

Создаёт новое определение расчётного атрибута. После создания новые данные объектов, внесённые в Customer Profiles, будут включены в расчётный атрибут, который можно получить для профиля с помощью API GetCalculatedAttributeForProfile. Определение расчётного атрибута делает его доступным для всех профилей в домене. Каждый расчётный атрибут может ссылаться только на один ObjectType и не более чем на два поля из этого ObjectType.

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

Синтаксис

  create-calculated-attribute-definition
--domain-name <value>
--calculated-attribute-name <value>
[--display-name <value>]
[--description <value>]
--attribute-details <value>
[--conditions <value>]
[--filter <value>]
--statistic <value>
[--tags <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]

Параметры

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

Уникальное имя домена.

--calculated-attribute-name (строка)

Уникальное имя расчётного атрибута.

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

Отображаемое имя расчётного атрибута.

--description (строка)

Описание расчётного атрибута.

--attribute-details (структура)

Математическое выражение и список элементов атрибутов, указанных в этом выражении.

Атрибуты -> (список)

Список элементов атрибутов, указанных в математическом выражении.

(структура)

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

Имя -> (строка)

Имя атрибута, определённого в типе объекта профиля.

Выражение -> (строка)

Математическое выражение, выполняемое над элементами атрибутов, указанными в списке атрибутов. Каждый элемент в выражении должен соответствовать структуре "{ИмяОбъекта.ИмяАтрибута}".

Краткая форма синтаксиса:

Attributes=[{Name=string},{Name=string}],Expression=string

Синтаксис JSON:

{
  "Attributes": [
    {
      "Name": "string"
    }
    ...
  ],
  "Expression": "string"
}

--conditions (структура)

Условие, включающее диапазон, количество объектов и порог для расчётного атрибута.

Диапазон -> (структура)

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

Значение -> (целое число)

Количество времени указанной единицы.

Единица -> (строка)

Единица измерения времени.

КоличествоОбъектов -> (целое число)

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

Порог -> (структура)

Порог для расчётного атрибута.

Значение -> (строка)

Значение порога.

Оператор -> (строка)

Оператор порога.

Краткая форма синтаксиса:

Range={Value=integer,Unit=string},ObjectCount=integer,Threshold={Value=string,Operator=string}

Синтаксис JSON:

{
  "Range": {
    "Value": integer,
    "Unit": "DAYS"
  },
  "ObjectCount": integer,
  "Threshold": {
    "Value": "string",
    "Operator": "EQUAL_TO"|"GREATER_THAN"|"LESS_THAN"|"NOT_EQUAL_TO"
  }
}

--filter (структура)

Определяет, как отфильтровать входящие объекты, чтобы включить часть расчётного атрибута.

Включить -> (строка)

Определить, включать или исключать объекты для расчёта расчётного атрибута, которые соответствуют критериям групп фильтра.

Группы -> (список)

Содержит список групп фильтров в определении фильтра.

(структура)

Объект, содержащий измерения для фильтрации.

Тип -> (строка)

Тип логической связи между измерениями группы фильтра.

Измерения -> (список)

Объект, содержащий атрибуты для фильтрации.

(структура)

Содержит карту имён атрибутов к измерениям атрибутов.

Атрибуты -> (карта)

Является ли атрибут в карте FilterDimension

ключ -> (строка)

значение -> (структура)

Объект, определяющий, как отфильтровать входящие объекты для расчётного атрибута.

ТипИзмерения -> (строка)

Действие для фильтрации.

Значения -> (список)

Значения для применения TypeИзмерения.

(строка)

Синтаксис JSON:

{
  "Include": "ALL"|"ANY"|"NONE",
  "Groups": [
    {
      "Type": "ALL"|"ANY"|"NONE",
      "Dimensions": [
        {
          "Attributes": {"string": {
                "DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH"|"BEFORE"|"AFTER"|"BETWEEN"|"NOT_BETWEEN"|"ON"|"GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL"|"LESS_THAN_OR_EQUAL"|"EQUAL",
                "Values": ["string", ...]
              }
            ...}
        }
        ...
      ]
    }
    ...
  ]
}

--statistic (строка)

Операция агрегирования для расчётного атрибута.

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

  • FIRST_OCCURRENCE
  • LAST_OCCURRENCE
  • COUNT
  • SUM
  • MINIMUM
  • MAXIMUM
  • AVERAGE
  • MAX_OCCURRENCE

--tags (карта)

Теги, используемые для организации, отслеживания или управления доступом к данному ресурсу.

ключ -> (строка)

значение -> (строка)

Краткая форма синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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-auto-prompt (логическое значение)

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

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

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

Вывод

CalculatedAttributeName -> (строка)

Уникальное имя вычисляемого атрибута.

DisplayName -> (строка)

Имя вычисляемого атрибута для отображения.

Description -> (строка)

Описание вычисляемого атрибута.

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

Математическое выражение и список элементов атрибутов, указанных в этом выражении.

Attributes -> (список)

Список элементов атрибутов, указанных в математическом выражении.

(структура)

Подробности одного элемента атрибута, указанного в математическом выражении.

Name -> (строка)

Имя атрибута, определенного в типе объекта профиля.

Expression -> (строка)

Математическое выражение, выполняемое над элементами атрибутов, предоставленными в списке атрибутов. Каждый элемент в выражении должен соответствовать структуре "{ObjectTypeName.AttributeName}".

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

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

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

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

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

Величина времени заданного типа.

Unit -> (строка)

Единица времени.

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

Количество объектов профиля, используемых для вычисляемого атрибута.

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

Порог для вычисляемого атрибута.

Value -> (строка)

Значение порога.

Operator -> (строка)

Оператор порога.

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

Фильтр, используемый в запросе.

Include -> (строка)

Определить, включать или исключать объекты для вычисления вычисляемого атрибута, соответствующие критериям групп фильтра.

Groups -> (список)

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

(структура)

Объект, содержащий измерения для фильтрации.

Type -> (строка)

Тип логической связи между измерениями группы фильтра.

Dimensions -> (список)

Объект, содержащий атрибуты для фильтрации.

(структура)

Содержит отображение имен атрибутов на измерения атрибутов.

Attributes -> (отображение)

Является ли атрибут в отображении FilterDimension.

key -> (строка)

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

Объект, определяющий, как фильтровать входящие объекты для вычисляемого атрибута.

DimensionType -> (строка)

Действие для фильтрации.

Values -> (список)

Значения для применения DimensionType.

(строка)

Statistic -> (строка)

Операция агрегирования для вычисляемого атрибута.

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

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

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

Метка времени последнего редактирования определения вычисляемого атрибута.

Tags -> (отображение)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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