Spec-Zone.ru › AWS CLI v2

[ aws . customer-profiles ]

обновить профиль

Описание

Обновляет свойства профиля. Для обновления профиля клиента требуется ProfileId.

При вызове API UpdateProfile указание значения пустой строки означает удаление любого существующего значения. Отсутствие строкового значения означает, что любое уже существующее значение будет сохранено.

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

Синтаксис

  update-profile
--domain-name <value>
--profile-id <value>
[--additional-information <value>]
[--account-number <value>]
[--party-type <value>]
[--business-name <value>]
[--first-name <value>]
[--middle-name <value>]
[--last-name <value>]
[--birth-date <value>]
[--gender <value>]
[--phone-number <value>]
[--mobile-phone-number <value>]
[--home-phone-number <value>]
[--business-phone-number <value>]
[--email-address <value>]
[--personal-email-address <value>]
[--business-email-address <value>]
[--address <value>]
[--shipping-address <value>]
[--mailing-address <value>]
[--billing-address <value>]
[--attributes <value>]
[--party-type-string <value>]
[--gender-string <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]

Параметры

--domain-name (строка)

Уникальное имя домена.

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

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

--additional-information (строка)

Любая дополнительная информация, относящаяся к профилю клиента.

--account-number (строка)

Номер счета, присвоенный клиенту.

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

Тип профиля, используемого для описания клиента.

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

  • INDIVIDUAL
  • BUSINESS
  • OTHER

--business-name (строка)

Название бизнеса клиента.

--first-name (строка)

Имя клиента (имя).

--middle-name (строка)

Отчество клиента.

--last-name (строка)

Фамилия клиента.

--birth-date (строка)

Дата рождения клиента.

--gender (строка)

Пол, с которым идентифицирует себя клиент.

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

  • MALE
  • FEMALE
  • UNSPECIFIED

--phone-number (строка)

Номер телефона клиента, не указанный как мобильный, домашний или рабочий.

--mobile-phone-number (строка)

Мобильный номер телефона клиента.

--home-phone-number (строка)

Домашний номер телефона клиента.

--business-phone-number (строка)

Рабочий номер телефона клиента.

--email-address (строка)

Адрес электронной почты клиента, не указанный как личный или рабочий.

--personal-email-address (строка)

Личный адрес электронной почты клиента.

--business-email-address (строка)

Рабочий адрес электронной почты клиента.

--address (структура)

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

Address1 -> (строка)

Первая строка адреса клиента.

Address2 -> (строка)

Вторая строка адреса клиента.

Address3 -> (строка)

Третья строка адреса клиента.

Address4 -> (строка)

Четвертая строка адреса клиента.

City -> (строка)

Город проживания клиента.

County -> (строка)

Уезд проживания клиента.

State -> (строка)

Штат проживания клиента.

Province -> (строка)

Провинция проживания клиента.

Country -> (строка)

Страна проживания клиента.

PostalCode -> (строка)

Почтовый индекс адреса клиента.

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

Address1=string,Address2=string,Address3=string,Address4=string,City=string,County=string,State=string,Province=string,Country=string,PostalCode=string

Синтаксис JSON:

{
  "Address1": "string",
  "Address2": "string",
  "Address3": "string",
  "Address4": "string",
  "City": "string",
  "County": "string",
  "State": "string",
  "Province": "string",
  "Country": "string",
  "PostalCode": "string"
}

--shipping-address (структура)

Адрес доставки клиента.

Address1 -> (строка)

Первая строка адреса клиента.

Address2 -> (строка)

Вторая строка адреса клиента.

Address3 -> (строка)

Третья строка адреса клиента.

Address4 -> (строка)

Четвертая строка адреса клиента.

City -> (строка)

Город проживания клиента.

County -> (строка)

Уезд проживания клиента.

State -> (строка)

Штат проживания клиента.

Province -> (строка)

Провинция проживания клиента.

Country -> (строка)

Страна проживания клиента.

PostalCode -> (строка)

Почтовый индекс адреса клиента.

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

Address1=string,Address2=string,Address3=string,Address4=string,City=string,County=string,State=string,Province=string,Country=string,PostalCode=string

Синтаксис JSON:

{
  "Address1": "string",
  "Address2": "string",
  "Address3": "string",
  "Address4": "string",
  "City": "string",
  "County": "string",
  "State": "string",
  "Province": "string",
  "Country": "string",
  "PostalCode": "string"
}

--mailing-address (структура)

Почтовый адрес клиента.

Address1 -> (строка)

Первая строка адреса клиента.

Address2 -> (строка)

Вторая строка адреса клиента.

Address3 -> (строка)

Третья строка адреса клиента.

Address4 -> (строка)

Четвертая строка адреса клиента.

City -> (строка)

Город проживания клиента.

County -> (строка)

Уезд проживания клиента.

State -> (строка)

Штат проживания клиента.

Province -> (строка)

Провинция проживания клиента.

Country -> (строка)

Страна проживания клиента.

PostalCode -> (строка)

Почтовый индекс адреса клиента.

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

Address1=string,Address2=string,Address3=string,Address4=string,City=string,County=string,State=string,Province=string,Country=string,PostalCode=string

Синтаксис JSON:

{
  "Address1": "string",
  "Address2": "string",
  "Address3": "string",
  "Address4": "string",
  "City": "string",
  "County": "string",
  "State": "string",
  "Province": "string",
  "Country": "string",
  "PostalCode": "string"
}

--billing-address (структура)

Адрес выставления счета клиента.

Address1 -> (строка)

Первая строка адреса клиента.

Address2 -> (строка)

Вторая строка адреса клиента.

Address3 -> (строка)

Третья строка адреса клиента.

Address4 -> (строка)

Четвертая строка адреса клиента.

City -> (строка)

Город проживания клиента.

County -> (строка)

Уезд проживания клиента.

State -> (строка)

Штат проживания клиента.

Province -> (строка)

Провинция проживания клиента.

Country -> (строка)

Страна проживания клиента.

PostalCode -> (строка)

Почтовый индекс адреса клиента.

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

Address1=string,Address2=string,Address3=string,Address4=string,City=string,County=string,State=string,Province=string,Country=string,PostalCode=string

Синтаксис JSON:

{
  "Address1": "string",
  "Address2": "string",
  "Address3": "string",
  "Address4": "string",
  "City": "string",
  "County": "string",
  "State": "string",
  "Province": "string",
  "Country": "string",
  "PostalCode": "string"
}

--attributes (массив)

Пара ключ-значение атрибутов профиля клиента.

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--party-type-string (строка)

Альтернатива PartyType, которая принимает любой строковый ввод.

--gender-string (строка)

Альтернатива Gender, которая принимает любой строковый ввод.

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

Вывод

ProfileId -> (строка)

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

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

Spec-Zone.ru

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