get-segments
Описание
Получает информацию о конфигурации, размерности и других параметрах всех сегментов, связанных с приложением.
См. также: Документацию API AWS
Синтаксис
get-segments
--application-id <value>
[--page-size <value>]
[--token <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]
Параметры
--application-id (строка)
--page-size (строка)
--token (строка)
--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 для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать входные параметры CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы ввода данных CLI.
Вывод
SegmentsResponse -> (структура)
Предоставляет информацию обо всех сегментах, связанных с приложением.
Item -> (список)
Массив ответов, по одному для каждого сегмента, связанного с приложением (ресурс Segments), или каждой версии сегмента, связанного с приложением (ресурс Segment Versions).
(структура)
Предоставляет информацию о конфигурации, размерах и других настройках сегмента.
ApplicationId -> (строка)
Arn -> (строка)
CreationDate -> (строка)
Dimensions -> (структура)
Настройки размеров сегмента.
Attributes -> (карта)
Один или несколько пользовательских атрибутов, используемых в качестве критериев для сегмента.
key -> (строка)
value -> (структура)
Указывает критерии, основанные на атрибутах, для включения или исключения конечных точек из сегмента.
AttributeType -> (строка)
Тип измерения сегмента. Допустимые значения:
- INCLUSIVE - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
- EXCLUSIVE - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
- CONTAINS - конечные точки, у которых атрибуты содержат в себе подстроки значений, включаются в сегмент.
- BEFORE - конечные точки с атрибутами, интерпретируемыми как даты и время в формате ISO_INSTANT, предшествующие значению, включаются в сегмент.
- AFTER - конечные точки с атрибутами, интерпретируемыми как даты и время в формате ISO_INSTANT, последующие значению, включаются в сегмент.
- ON - конечные точки с атрибутами, интерпретируемыми как даты в формате ISO_INSTANT, совпадающие со значением, включаются в сегмент. Время в этом сравнении игнорируется.
- BETWEEN - конечные точки с атрибутами, интерпретируемыми как даты и время в формате ISO_INSTANT, находящиеся между значениями, включаются в сегмент.
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства AttributeType, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют значениям критериев.
(строка)
Behavior -> (структура)
Критерии, основанные на поведении, например, как недавно пользователи использовали ваше приложение, для сегмента.
Recency -> (структура)
Настройки измерения, основанные на том, как недавно конечная точка была активна.
Duration -> (строка)
RecencyType -> (строка)
Demographic -> (структура)
Критерии, основанные на демографических данных, такие как платформа устройства, для сегмента.
AppVersion -> (структура)
Критерии версии приложения для сегмента.
DimensionType -> (строка)
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства DimensionType, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Channel -> (структура)
Критерии канала для сегмента.
DimensionType -> (строка)
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства DimensionType, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
DeviceType -> (структура)
Критерии типа устройства для сегмента.
DimensionType -> (строка)
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства DimensionType, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Make -> (структура)
Критерии производителя устройства для сегмента.
DimensionType -> (строка)
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства DimensionType, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Model -> (структура)
Критерии модели устройства для сегмента.
DimensionType -> (строка)
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства DimensionType, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Platform -> (структура)
Критерии платформы устройства для сегмента.
DimensionType -> (строка)
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства DimensionType, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Location -> (структура)
Критерии местоположения, такие как регион или координаты GPS, для сегмента.
Country -> (структура)
Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.
DimensionType -> (строка)
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства DimensionType, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
GPSPoint -> (структура)
GPS-местоположение и радиус для сегмента.
Coordinates -> (структура)
Координаты GPS для измерения расстояния.
Latitude -> (число с плавающей запятой)
Longitude -> (число с плавающей запятой)
RangeInKilometers -> (число с плавающей запятой)
Metrics -> (карта)
Один или несколько пользовательских метрик, используемых в качестве критериев для сегмента.
key -> (строка)
value -> (структура)
Определяет критерии, основанные на метриках, для включения или исключения конечных точек из сегмента. Эти критерии получены из пользовательских метрик, которые вы определяете для конечных точек.
ComparisonOperator -> (строка)
Value -> (число с плавающей запятой)
UserAttributes -> (карта)
Один или несколько пользовательских атрибутов, используемых в качестве критериев для сегмента.
key -> (строка)
value -> (структура)
Указывает критерии, основанные на атрибутах, для включения или исключения конечных точек из сегмента.
AttributeType -> (строка)
Тип измерения сегмента. Допустимые значения:
- INCLUSIVE - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
- EXCLUSIVE - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
- CONTAINS - конечные точки, у которых атрибуты содержат в себе подстроки значений, включаются в сегмент.
- BEFORE - конечные точки с атрибутами, интерпретируемыми как даты и время в формате ISO_INSTANT, предшествующие значению, включаются в сегмент.
- AFTER - конечные точки с атрибутами, интерпретируемыми как даты и время в формате ISO_INSTANT, последующие значению, включаются в сегмент.
- ON - конечные точки с атрибутами, интерпретируемыми как даты в формате ISO_INSTANT, совпадающие со значением, включаются в сегмент. Время в этом сравнении игнорируется.
- BETWEEN - конечные точки с атрибутами, интерпретируемыми как даты и время в формате ISO_INSTANT, находящиеся между значениями, включаются в сегмент.
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства AttributeType, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют значениям критериев.
(строка)
Id -> (строка)
ImportDefinition -> (структура)
Настройки задания импорта, связанного с сегментом.
ChannelCounts -> (карта)
Количество типов каналов в определениях конечных точек, импортированных для создания сегмента.
key -> (строка)
value -> (целое число)
ExternalId -> (строка)
Format -> (строка)
RoleArn -> (строка)
S3Url -> (строка)
Size -> (целое число)
LastModifiedDate -> (строка)
Name -> (строка)
SegmentGroups -> (структура)
Список одного или нескольких групп сегментов, которые применяются к сегменту. Каждая группа сегментов состоит из нуля или более базовых сегментов и измерений, которые применяются к этим базовым сегментам.
Группы -> (список)
Массив, определяющий набор критериев сегмента для оценки при обработке групп сегментов для сегмента.
(структура)
Указывает базовые сегменты и измерения для сегмента, а также взаимоотношения между этими базовыми сегментами и измерениями.
Измерения -> (список)
Массив, определяющий измерения для сегмента.
(структура)
Указывает параметры измерений для сегмента.
Атрибуты -> (отображение)
Один или несколько пользовательских атрибутов, используемых в качестве критериев для сегмента.
ключ -> (строка)
значение -> (структура)
Указывает критерии, основанные на атрибутах, для включения или исключения конечных точек из сегмента.
ТипАтрибута -> (строка)
Тип измерения сегмента для использования. Допустимые значения:
- ВКЛЮЧАЮЩИЙ - конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
- ИСКЛЮЧАЮЩИЙ - конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
- СОДЕРЖИТ - конечные точки, имеющие подстроки атрибутов, соответствующие значениям, включаются в сегмент.
- ДО - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и времени до значения, включаются в сегмент.
- ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и времени после значения, включаются в сегмент.
- В - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты на значении, включаются в сегмент. Время при этом сравнении игнорируется.
- МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и времени между значениями, включаются в сегмент.
Значения -> (список)
Критериальные значения для измерения сегмента. В зависимости от значения свойства ТипАтрибута, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют критериальным значениям.
(строка)
Поведение -> (структура)
Критерии, основанные на поведении, такие как недавнее использование приложения пользователями, для сегмента.
Недавность -> (структура)
Параметры измерений, основанные на том, как недавно конечная точка была активна.
Длительность -> (строка)
ТипНедавности -> (строка)
Демографические -> (структура)
Критерии, основанные на демографии, такие как платформа устройства, для сегмента.
ВерсияПриложения -> (структура)
Критерии версии приложения для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Критериальные значения для измерения сегмента. В зависимости от значения свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.
(строка)
Канал -> (структура)
Критерии канала для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Критериальные значения для измерения сегмента. В зависимости от значения свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.
(строка)
ТипУстройства -> (структура)
Критерии типа устройства для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Критериальные значения для измерения сегмента. В зависимости от значения свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.
(строка)
Производитель -> (структура)
Критерии производителя устройства для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Критериальные значения для измерения сегмента. В зависимости от значения свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.
(строка)
Модель -> (структура)
Критерии модели устройства для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Критериальные значения для измерения сегмента. В зависимости от значения свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.
(строка)
Платформа -> (структура)
Критерии платформы устройства для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Критериальные значения для измерения сегмента. В зависимости от значения свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.
(строка)
Местоположение -> (структура)
Критерии, основанные на местоположении, такие как регион или GPS-координаты, для сегмента.
Страна -> (структура)
Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Критериальные значения для измерения сегмента. В зависимости от значения свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.
(строка)
GPSТочка -> (структура)
GPS-местоположение и радиус для сегмента.
Координаты -> (структура)
GPS-координаты для измерения расстояния.
Широта -> (двойное)
Долгота -> (двойное)
ДиапазонВКилометрах -> (двойное)
Метрики -> (отображение)
Один или несколько пользовательских метрик, используемых в качестве критериев для сегмента.
ключ -> (строка)
значение -> (структура)
Указывает критерии, основанные на метриках, для включения или исключения конечных точек из сегмента. Эти критерии получены из пользовательских метрик, которые вы определяете для конечных точек.
ОператорСравнения -> (строка)
Значение -> (двойное)
АтрибутыПользователей -> (отображение)
Один или несколько пользовательских атрибутов, используемых в качестве критериев для сегмента.
ключ -> (строка)
значение -> (структура)
Указывает критерии, основанные на атрибутах, для включения или исключения конечных точек из сегмента.
ТипАтрибута -> (строка)
Тип измерения сегмента для использования. Допустимые значения:
- ВКЛЮЧАЮЩИЙ - конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
- ИСКЛЮЧАЮЩИЙ - конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
- СОДЕРЖИТ - конечные точки, имеющие подстроки атрибутов, соответствующие значениям, включаются в сегмент.
- ДО - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и времени до значения, включаются в сегмент.
- ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и времени после значения, включаются в сегмент.
- В - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты на значении, включаются в сегмент. Время при этом сравнении игнорируется.
- МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и времени между значениями, включаются в сегмент.
Значения -> (список)
Критериальные значения для измерения сегмента. В зависимости от значения свойства ТипАтрибута, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют критериальным значениям.
(строка)
ИсходныеСегменты -> (список)
Базовый сегмент, на котором строится сегмент. Базовый сегмент, также называемый исходным сегментом, определяет начальную популяцию конечных точек для сегмента. При добавлении измерений к сегменту Amazon Pinpoint фильтрует базовый сегмент, используя указанные измерения.
Вы можете указать более одного сегмента с измерениями или только один импортированный сегмент. Если вы укажете импортированный сегмент, консоль Amazon Pinpoint отображает оценку размера сегмента, которая указывает размер импортированного сегмента без применения к нему каких-либо фильтров.
(структура)
Указывает идентификатор и версию сегмента.
Id -> (строка)
Версия -> (целое число)
ТипИсточника -> (строка)
Тип -> (строка)
Включать -> (строка)
ТипСегмента -> (строка)
Тип сегмента. Допустимые значения:
- DIMENSIONAL - Динамический сегмент, который использует критерии выбора, задаваемые вами, и основан на данных конечных точек, которые сообщает ваше приложение. Динамические сегменты могут со временем изменяться.
- IMPORT - Статический сегмент, который использует критерии выбора, задаваемые вами, и основан на определениях конечных точек, импортируемых из файла. Импортированные сегменты статичны; они не меняются со временем.
tags -> (map)
Строковая карта пар «ключ-значение», которая идентифицирует теги, связанные с сегментом. Каждый тег состоит из требуемого ключа тега и соответствующего значения тега.
key -> (string)
value -> (string)
Version -> (integer)
NextToken -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.