получить-конечные-точки-пользователя
Описание
Получает информацию обо всех конечных точках, связанных с определенным идентификатором пользователя.
См. также: Документацию 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 (строка)
--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 -> (строка)
ApplicationId -> (строка)
Attributes -> (словарь)
Один или несколько пользовательских атрибутов, описывающих конечную точку путем сопоставления имени с массивом значений. Например, значение пользовательского атрибута с именем Interests может быть: [«Наука», «Музыка», «Путешествия»]. Вы можете использовать эти атрибуты в качестве критериев фильтрации при создании сегментов.
key -> (строка)
value -> (список)
ChannelType -> (строка)
CohortId -> (строка)
CreationDate -> (строка)
Demographic -> (структура)
Демографическая информация для конечной точки, например, часовой пояс и платформа.
AppVersion -> (строка)
Locale -> (строка)
Make -> (строка)
Model -> (строка)
ModelVersion -> (строка)
Platform -> (строка)
PlatformVersion -> (строка)
Timezone -> (строка)
EffectiveDate -> (строка)
EndpointStatus -> (строка)
Указывает, отправляются ли сообщения или push-уведомления на конечную точку. Возможные значения: ACTIVE, сообщения отправляются на конечную точку; и INACTIVE, сообщения не отправляются на конечную точку.
Amazon Pinpoint автоматически устанавливает это значение в ACTIVE при создании или обновлении конечной точки. Amazon Pinpoint автоматически устанавливает это значение в INACTIVE, если вы обновите другую конечную точку, у которой указан тот же адрес, что и в свойстве Address.
Id -> (строка)
Location -> (структура)
Географическая информация для конечной точки.
City -> (строка)
Country -> (строка)
Latitude -> (двойное)
Longitude -> (двойное)
PostalCode -> (строка)
Region -> (строка)
Metrics -> (словарь)
Один или несколько пользовательских метрик, которые ваше приложение сообщает Amazon Pinpoint для конечной точки.
key -> (строка)
value -> (двойное)
OptOut -> (строка)
RequestId -> (строка)
User -> (структура)
Один или несколько пользовательских атрибутов пользователя, которые ваше приложение сообщает Amazon Pinpoint для пользователя, связанного с конечной точкой.
UserAttributes -> (словарь)
Один или несколько пользовательских атрибутов, описывающих пользователя путем сопоставления имени с массивом значений. Например, значение атрибута с именем Interests может быть: [«Наука», «Музыка», «Путешествия»]. Вы можете использовать эти атрибуты в качестве критериев фильтрации при создании сегментов. Названия атрибутов чувствительны к регистру.
Имя атрибута может содержать до 50 символов. Значение атрибута может содержать до 100 символов. При определении имени пользовательского атрибута избегайте использования следующих символов: диези (№), двоеточие (:), знак вопроса (?), обратная косая черта () и косая черта (/). Консоль Amazon Pinpoint не может отображать имена атрибутов, содержащие эти символы. Это ограничение не относится к значениям атрибутов.
key -> (строка)
value -> (список)
UserId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.