удалить-сегмент

Описание

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

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

Синтаксис

  delete-segment
--application-id <value>
--segment-id <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 (строка)

Уникальный идентификатор приложения. Этот идентификатор отображается как Идентификатор проекта в консоли Amazon Pinpoint.

--segment-id (строка)

Уникальный идентификатор сегмента.

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

Вывод

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

Предоставляет информацию о конфигурации, размерах и других настройках сегмента.

ApplicationId -> (строка)

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

Arn -> (строка)

Amazon Resource Name (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 -> (строка)

Тип измерения недавности для сегмента. Допустимые значения: ACTIVE (конечные точки, активные в течение указанного периода, включаются в сегмент) и INACTIVE (конечные точки, неактивные в течение указанного периода, включаются в сегмент).

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

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

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

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

DimensionType -> (строка)

Тип измерения сегмента. Допустимые значения: INCLUSIVE (конечные точки, соответствующие критериям, включаются в сегмент) и EXCLUSIVE (конечные точки, соответствующие критериям, исключаются из сегмента).

Values -> (список)

Значения критериев для измерения сегмента. В зависимости от значения свойства DimensionType конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.

(строка)

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

Критерии канала для сегмента.

DimensionType -> (строка)

Values -> (список)

(строка)

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

Критерии типа устройства для сегмента.

DimensionType -> (строка)

Values -> (список)

(строка)

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

Критерии производителя устройства для сегмента.

DimensionType -> (строка)

Values -> (список)

(строка)

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

Критерии модели устройства для сегмента.

DimensionType -> (строка)

Values -> (список)

(строка)

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

Критерии платформы устройства для сегмента.

DimensionType -> (строка)

Values -> (список)

(строка)

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

Критерии местоположения, такие как регион или GPS-координаты, для сегмента.

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

Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.

DimensionType -> (строка)

Values -> (список)

(строка)

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

GPS-местоположение и диапазон для сегмента.

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

GPS-координаты для измерения расстояния.

Latitude -> (вещественное число с двойной точностью)

Широта координаты местоположения.

Longitude -> (вещественное число с двойной точностью)

Долгота координаты местоположения.

RangeInKilometers -> (вещественное число с двойной точностью)

Диапазон в километрах от GPS-координат.

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

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

Оператор для сравнения значений метрики. Допустимые значения: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL и EQUAL.

Value -> (вещественное число с двойной точностью)

Значение для сравнения.

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

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

key -> (строка)

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

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

AttributeType -> (строка)

Тип измерения сегмента. Допустимые значения:

INCLUSIVE - конечные точки с атрибутами, соответствующими значениям, включаются в сегмент.
EXCLUSIVE - конечные точки с атрибутами, соответствующими значениям, исключаются из сегмента.
CONTAINS - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
BEFORE - конечные точки с атрибутами, представленными в формате даты/времени ISO_INSTANT, предшествующими значению, включаются в сегмент.
AFTER - конечные точки с атрибутами, представленными в формате даты/времени ISO_INSTANT, последующими за значением, включаются в сегмент.
ON - конечные точки с атрибутами, представленными в формате даты ISO_INSTANT, совпадающими со значением, включаются в сегмент. Время при этом сравнении игнорируется.
BETWEEN - конечные точки с атрибутами, представленными в формате даты/времени ISO_INSTANT, находящиеся между значениями, включаются в сегмент.

Values -> (список)

(строка)

Id -> (строка)

Уникальный идентификатор сегмента.

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

Настройки задания импорта, связанного с сегментом.

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

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

key -> (строка)

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

ExternalId -> (строка)

(Устаревшее) Ваш идентификатор учетной записи AWS, который вы присвоили ключу внешнего идентификатора в политике доверия IAM. Amazon Pinpoint ранее использовал это значение для принятия роли IAM при импорте определений конечных точек, но мы убрали это требование. Мы не рекомендуем использовать внешние идентификаторы для ролей IAM, которые принимаются Amazon Pinpoint.

Format -> (строка)

Формат файлов, которые были импортированы для создания сегмента. Допустимые значения: CSV (для формата с разделителями запятыми) и JSON (для формата с разделителями новых строк в формате JSON).

RoleArn -> (строка)

Amazon Resource Name (ARN) роли AWS Identity and Access Management (IAM), которая предоставила Amazon Pinpoint доступ к расположению Amazon S3 для импорта определений конечных точек.

S3Url -> (строка)

URL хранилища Amazon Simple Storage Service (Amazon S3), из которого были импортированы определения конечных точек для создания сегмента.

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

Количество успешно импортированных определений конечных точек для создания сегмента.

LastModifiedDate -> (строка)

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

Name -> (строка)

Имя сегмента.

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

Список одного или нескольких групп сегментов, применимых к сегменту. Каждая группа сегментов состоит из нуля или более базовых сегментов и измерений, применяемых к этим базовым сегментам.

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

Массив, определяющий набор критериев сегмента для оценки при обработке групп сегментов для сегмента.

(структура)

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

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

Массив, определяющий измерения для сегмента.

(структура)

Определяет параметры измерений для сегмента.

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

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

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

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

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

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

Тип измерения сегмента, используемого. Допустимые значения:

ВКЛЮЧАЮЩИЙ - конечные точки, имеющие совпадающие атрибуты и значения, включаются в сегмент.
ИСКЛЮЧАЮЩИЙ - конечные точки, имеющие совпадающие атрибуты и значения, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, имеющие атрибуты с совпадающими подстроками значений, включаются в сегмент.
ДО - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT, до значения, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT, после значения, включаются в сегмент.
В - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, в значение, включаются в сегмент. Время при этом сравнении игнорируется.
МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT, между значениями, включаются в сегмент.

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

Критерии значений для измерения сегмента. В зависимости от значения свойства ТипАтрибута, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют критериям значений.

(строка)

Поведение -> (структура)

Критерии поведения, например, насколько недавно пользователи использовали ваше приложение, для сегмента.

Недавность -> (структура)

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

Длительность -> (строка)

Длительность, используемая для определения активности или неактивности конечной точки.

ТипНедавности -> (строка)

Тип измерения недавности для сегмента. Допустимые значения: АКТИВНО, конечные точки, которые были активны в течение указанного периода, включаются в сегмент; и НЕАКТИВНО, конечные точки, которые не были активны в течение указанного периода, исключаются из сегмента.

Демографические -> (структура)

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

ВерсияПриложения -> (структура)

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

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

Тип измерения сегмента, используемого. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

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

Критерии значений для измерения сегмента. В зависимости от значения свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериям значений.

(строка)

Канал -> (структура)

Критерии канала для сегмента.

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

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

(строка)

ТипУстройства -> (структура)

Критерии типа устройства для сегмента.

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

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

(строка)

Производитель -> (структура)

Критерии производителя устройства для сегмента.

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

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

(строка)

Модель -> (структура)

Критерии модели устройства для сегмента.

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

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

(строка)

Платформа -> (структура)

Критерии платформы устройства для сегмента.

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

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

(строка)

Местоположение -> (структура)

Критерии местоположения, такие как регион или координаты GPS, для сегмента.

Страна -> (структура)

Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.

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

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

(строка)

GPSТочка -> (структура)

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)

Номер версии сегмента.