Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

create-registration

Описание

Создаёт новую регистрацию на основе поля RegistrationType.

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

Синтаксис

  create-registration
--registration-type <value>
[--tags <value>]
[--client-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]

Параметры

--registration-type (строка)

Тип формы регистрации для создания. Список RegistrationTypes можно получить с помощью действия DescribeRegistrationTypeDefinitions.

--tags (список)

Массив тегов (пар ключ-значение) для ассоциации с регистрацией.

(структура)

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

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

Идентификатор или имя ключа тега.

Значение -> (строка)

Строковое значение, связанное с ключом тега.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если вы не укажете client 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.

Вывод

RegistrationArn -> (строка)

Amazon Resource Name (ARN) для регистрации.

RegistrationId -> (строка)

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

RegistrationType -> (строка)

Тип формы регистрации для создания. Список RegistrationTypes можно получить с помощью действия DescribeRegistrationTypeDefinitions.

RegistrationStatus -> (строка)

Статус регистрации.

  • CLOSED : Номер телефона или идентификатор отправителя был удалён, и вам также необходимо удалить регистрацию для номера.
  • CREATED : Ваша регистрация создана, но не отправлена.
  • COMPLETE : Ваша регистрация одобрена, и ваш идентификатор отправки создан.
  • DELETED : Регистрация удалена.
  • PROVISIONING : Ваша регистрация одобрена, и ваш идентификатор отправки создаётся.
  • REQUIRES_AUTHENTICATION : Вам необходимо завершить проверку по электронной почте.
  • REQUIRES_UPDATES : Вам нужно исправить свою регистрацию и повторно отправить её.
  • REVIEWING : Ваша регистрация принята и находится на рассмотрении.
  • SUBMITTED : Ваша регистрация отправлена и ожидает рассмотрения.

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

Текущий номер версии регистрации.

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

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

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

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

Tags -> (список)

Массив тегов (пар ключ-значение) для ассоциации с регистрацией.

(структура)

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

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

Идентификатор или имя ключа тега.

Значение -> (строка)

Строковое значение, связанное с ключом тега.

CreatedTimestamp -> (метка времени)

Время создания регистрации в формате временной метки Unix.

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

Spec-Zone.ru

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