Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

получить-конечные-точки-пользователя

Описание

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

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

Синтаксис

  get-user-endpoints
--application-id <value>
--user-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.

--user-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
  • text
  • таблица
  • 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 (логическое значение)

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

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

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

Вывод

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

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

Item -> (список)

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

(структура)

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

Address -> (строка)

Адрес назначения для сообщений или push-уведомлений, которые вы отправляете на конечную точку. Адрес варьируется в зависимости от канала. Например, адрес для канала push-уведомлений обычно является токеном, предоставленным службой push-уведомлений, например, токеном устройства Apple Push Notification service (APNs) или токеном регистрации Firebase Cloud Messaging (FCM). Адрес для канала SMS — это номер телефона в формате E.164, например +12065550100. Адрес для канала электронной почты — это адрес электронной почты.

ApplicationId -> (строка)

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

Attributes -> (словарь)

Один или несколько пользовательских атрибутов, описывающих конечную точку путем сопоставления имени с массивом значений. Например, значение пользовательского атрибута с именем Interests может быть: [«Наука», «Музыка», «Путешествия»]. Вы можете использовать эти атрибуты в качестве критериев фильтрации при создании сегментов.

key -> (строка)

value -> (список)

(строка)

ChannelType -> (строка)

Канал, используемый при отправке сообщений или push-уведомлений на конечную точку.

CohortId -> (строка)

Число от 0 до 99, представляющее когорту, к которой относится конечная точка. Конечные точки случайным образом группируются по когортам, и каждая когорта содержит примерно 1 процент конечных точек для приложения. Amazon Pinpoint назначает когортам распределения holdout или treatment для кампаний.

CreationDate -> (строка)

Дата и время создания конечной точки в формате ISO 8601.

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

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

AppVersion -> (строка)

Версия приложения, связанного с конечной точкой.

Locale -> (строка)

Локаль конечной точки в следующем формате: двухбуквенный код ISO 639-1, за которым следует символ подчеркивания (_), за которым следует двухбуквенный код ISO 3166-1.

Make -> (строка)

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

Model -> (строка)

Наименование или номер модели устройства конечной точки, например iPhone или SM-G900F.

ModelVersion -> (строка)

Версия модели устройства конечной точки.

Platform -> (строка)

Платформа устройства конечной точки, например ios.

PlatformVersion -> (строка)

Версия платформы устройства конечной точки.

Timezone -> (строка)

Часовой пояс конечной точки, указанный как имя базы данных tz, например America/Los_Angeles.

EffectiveDate -> (строка)

Дата и время последнего обновления конечной точки в формате ISO 8601.

EndpointStatus -> (строка)

Указывает, отправляются ли сообщения или push-уведомления на конечную точку. Возможные значения: ACTIVE, сообщения отправляются на конечную точку; и INACTIVE, сообщения не отправляются на конечную точку.

Amazon Pinpoint автоматически устанавливает это значение в ACTIVE при создании или обновлении конечной точки. Amazon Pinpoint автоматически устанавливает это значение в INACTIVE, если вы обновите другую конечную точку, у которой указан тот же адрес, что и в свойстве Address.

Id -> (строка)

Уникальный идентификатор, который вы назначили конечной точке. Идентификатор должен быть глобально уникальным идентификатором (GUID), чтобы избежать конфликтов с другими идентификаторами конечных точек, связанных с приложением.

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

Географическая информация для конечной точки.

City -> (строка)

Название города, где расположена конечная точка.

Country -> (строка)

Двухбуквенный код в формате ISO 3166-1 alpha-2 для страны или региона, где расположена конечная точка. Например, US для Соединенных Штатов.

Latitude -> (двойное)

Координата широты расположения конечной точки, округлённая до одного десятичного знака.

Longitude -> (двойное)

Координата долготы расположения конечной точки, округлённая до одного десятичного знака.

PostalCode -> (строка)

Почтовый индекс или ZIP-код района, где расположена конечная точка.

Region -> (строка)

Название региона, где расположена конечная точка. Для мест в США это название штата.

Metrics -> (словарь)

Один или несколько пользовательских метрик, которые ваше приложение сообщает Amazon Pinpoint для конечной точки.

key -> (строка)

value -> (двойное)

OptOut -> (строка)

Указывает, отказался ли пользователь, связанный с конечной точкой, от получения сообщений и push-уведомлений от вас. Возможные значения: ALL, пользователь отказался от получения любых сообщений или push-уведомлений; и NONE, пользователь не отказался от получения всех сообщений и push-уведомлений.

RequestId -> (строка)

Уникальный идентификатор последнего запроса на обновление конечной точки.

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

Один или несколько пользовательских атрибутов пользователя, которые ваше приложение сообщает Amazon Pinpoint для пользователя, связанного с конечной точкой.

UserAttributes -> (словарь)

Один или несколько пользовательских атрибутов, описывающих пользователя путем сопоставления имени с массивом значений. Например, значение атрибута с именем Interests может быть: [«Наука», «Музыка», «Путешествия»]. Вы можете использовать эти атрибуты в качестве критериев фильтрации при создании сегментов. Названия атрибутов чувствительны к регистру.

Имя атрибута может содержать до 50 символов. Значение атрибута может содержать до 100 символов. При определении имени пользовательского атрибута избегайте использования следующих символов: диези (№), двоеточие (:), знак вопроса (?), обратная косая черта () и косая черта (/). Консоль Amazon Pinpoint не может отображать имена атрибутов, содержащие эти символы. Это ограничение не относится к значениям атрибутов.

key -> (строка)

value -> (список)

(строка)

UserId -> (строка)

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

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

Spec-Zone.ru

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