Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-identity ]

register-app-instance-user-endpoint

Описание

Регистрирует конечную точку в Amazon Chime AppInstanceUser. Конечная точка получает сообщения для пользователя. Для push-уведомлений конечная точка — это мобильное устройство, используемое для получения мобильных push-уведомлений для пользователя.

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

Синтаксис

  register-app-instance-user-endpoint
--app-instance-user-arn <value>
[--name <value>]
--type <value>
--resource-arn <value>
--endpoint-attributes <value>
[--client-request-token <value>]
[--allow-messages <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]

Параметры

--app-instance-user-arn (строка)

ARN AppInstanceUser.

--name (строка)

Название AppInstanceUserEndpoint.

--type (строка)

Тип AppInstanceUserEndpoint. Поддерживаемые типы:

  • APNS: Уведомления для мобильных устройств Apple.
  • APNS_SANDBOX: Песочница для уведомлений для мобильных устройств Apple.
  • GCM: Уведомления для мобильных устройств Android.

Заполните значение ResourceArn для каждого типа, как PinpointAppArn.

Возможные значения:

  • APNS
  • APNS_SANDBOX
  • GCM

--resource-arn (строка)

ARN ресурса, к которому принадлежит конечная точка.

--endpoint-attributes (структура)

Атрибуты Endpoint.

DeviceToken -> (строка)

Токен устройства для типов конечных точек GCM, APNS и APNS_SANDBOX.

VoipDeviceToken -> (строка)

Токен VOIP устройства для типов конечных точек APNS и APNS_SANDBOX.

Сокращенный синтаксис:

DeviceToken=string,VoipDeviceToken=string

Синтаксис JSON:

{
  "DeviceToken": "string",
  "VoipDeviceToken": "string"
}

--client-request-token (строка)

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

--allow-messages (строка)

Булево значение, определяющее, подключена ли конечная точка AppInstanceUserEndpoint для получения сообщений. ALL указывает, что конечная точка получает все сообщения. NONE указывает, что конечная точка не получает никаких сообщений.

Возможные значения:

  • ALL
  • NONE

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

--cli-auto-prompt (логическое)

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

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

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

Вывод

AppInstanceUserArn -> (строка)

ARN AppInstanceUser.

EndpointId -> (строка)

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

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

Spec-Zone.ru

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