Spec-Zone.ru › AWS CLI v2

[ aws . customer-profiles ]

get-segment-definition

Описание

Получает определение сегмента из домена.

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

Синтаксис

  get-segment-definition
--domain-name <value>
--segment-definition-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]

Параметры

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

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

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

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

Вывод

SegmentDefinitionName -> (строка)

Имя определения сегмента.

DisplayName -> (строка)

Отображаемое имя определения сегмента.

Description -> (строка)

Описание определения сегмента.

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

Критерии сегментации, связанные с этим определением.

Groups -> (список)

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

(структура)

Содержит измерения, определяющие, по чему сегментировать.

Dimensions -> (список)

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

(структура помеченного союза)

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

Примечание

Это структура помеченного союза. Только один из следующих ключевых элементов верхнего уровня может быть задан: ProfileAttributes, CalculatedAttributes.

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

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

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

Поле для описания значений для сегментации в номере счета.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в дополнительной информации.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в имени.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в фамилии.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в отчестве.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в поле пола.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в типе стороны.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в дате рождения.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в номере телефона.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в названии бизнеса.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в номере телефона бизнеса.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в домашнем номере телефона.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в мобильном номере телефона.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в адресе электронной почты.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в личном адресе электронной почты.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в адресе электронной почты бизнеса.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в адресе.

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

Город, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Страна, принадлежащая адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Уезд, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Почтовый индекс, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Провинция, принадлежащая адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Штат, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в адресе доставки.

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

Город, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Страна, принадлежащая адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Уезд, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Почтовый индекс, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Провинция, принадлежащая адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Штат, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации в адресной строке.

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

Город, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Страна, принадлежащая адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Уезд, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Почтовый индекс, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Провинция, принадлежащая адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Штат, принадлежащий адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Поле для описания значений для сегментации по данным адреса для выставления счетов.

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

Город, относящийся к адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Страна, относящаяся к адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Уезд, относящийся к адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Почтовый индекс, относящийся к адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Область, относящаяся к адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

Штат, относящийся к адресу.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

Attributes -> (карта)

Поле для описания значений для сегментации по атрибутам.

key -> (строка)

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

Объект для сегментации по различным полям профиля клиента.

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

CalculatedAttributes -> (карта)

Объект, содержащий вычисленные атрибуты для сегментации.

key -> (строка)

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

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

DimensionType -> (строка)

Действие для сегментации.

Values -> (список)

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

(строка)

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

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

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

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

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

Начальное время включения объектов.

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

Конечное время включения объектов.

Unit -> (строка)

Единица измерения для начала и конца.

SourceSegments -> (список)

Определяет исходный источник данных.

(структура)

Сегменты источника для создания.

SegmentDefinitionName -> (строка)

Уникальное имя определения сегмента.

SourceType -> (строка)

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

Type -> (строка)

Определяет, как взаимодействовать с профилями, найденными в текущем фильтре.

Include -> (строка)

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

SegmentDefinitionArn -> (строка)

Arn определения сегмента.

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

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

Tags -> (карта)

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

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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