Spec-Zone.ru › AWS CLI v2

[ aws . customer-profiles ]

batch-get-profile

Описание

Получение группы профилей.

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

Синтаксис

  batch-get-profile
--domain-name <value>
--profile-ids <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-ids (список)

Список уникальных идентификаторов профилей клиентов для получения.

(строка)

Синтаксис:

"string" "string" ...

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла параметров.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

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

Вывод

Ошибки -> (список)

Для получения информации об ошибках, общих для всех действий, см. Общие ошибки .

(структура)

Объект ошибки, описывающий причину неудачи конкретного профиля.

Код -> (строка)

Код состояния, объясняющий причину неудачи конкретного профиля.

Message -> (строка)

Сообщение, описывающее причину неудачи конкретного профиля.

ProfileId -> (строка)

Идентификатор профиля, который не удался.

Профили -> (список)

Массив объектов профиля.

(структура)

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

ProfileId -> (строка)

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

AccountNumber -> (строка)

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

AdditionalInformation -> (строка)

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

PartyType -> (строка)

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

BusinessName -> (строка)

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

FirstName -> (строка)

Имя клиента.

MiddleName -> (строка)

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

LastName -> (строка)

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

BirthDate -> (строка)

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

Gender -> (строка)

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

PhoneNumber -> (строка)

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

MobilePhoneNumber -> (строка)

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

HomePhoneNumber -> (строка)

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

BusinessPhoneNumber -> (строка)

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

EmailAddress -> (строка)

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

PersonalEmailAddress -> (строка)

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

BusinessEmailAddress -> (строка)

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

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

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

Address1 -> (строка)

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

Address2 -> (строка)

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

Address3 -> (строка)

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

Address4 -> (строка)

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

City -> (строка)

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

County -> (строка)

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

State -> (строка)

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

Province -> (строка)

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

Country -> (строка)

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

PostalCode -> (строка)

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

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

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

Address1 -> (строка)

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

Address2 -> (строка)

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

Address3 -> (строка)

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

Address4 -> (строка)

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

City -> (строка)

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

County -> (строка)

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

State -> (строка)

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

Province -> (строка)

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

Country -> (строка)

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

PostalCode -> (строка)

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

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

Адрес для отправки корреспонденции клиенту.

Address1 -> (строка)

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

Address2 -> (строка)

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

Address3 -> (строка)

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

Address4 -> (строка)

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

City -> (строка)

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

County -> (строка)

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

State -> (строка)

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

Province -> (строка)

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

Country -> (строка)

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

PostalCode -> (строка)

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

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

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

Address1 -> (строка)

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

Address2 -> (строка)

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

Address3 -> (строка)

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

Address4 -> (строка)

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

City -> (строка)

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

County -> (строка)

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

State -> (строка)

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

Province -> (строка)

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

Country -> (строка)

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

PostalCode -> (строка)

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

Attributes -> (массив)

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

key -> (строка)

value -> (строка)

FoundByItems -> (список)

Список элементов, используемых для поиска профиля в ответе SearchProfiles. Элемент — это пара ключ-значение, которая соответствует атрибуту в профиле.

Если необязательный параметр AdditionalSearchKeys был включен в запрос SearchProfiles, список FoundByItems следует интерпретировать на основе используемого в запросе LogicalOperator:

  • AND — профиль в ответе соответствует всем ключам поиска, указанным в запросе. Список FoundByItems будет включать все пары ключ-значение, указанные в запросе (так как это требование логики поиска AND).
  • OR — профиль в ответе соответствует хотя бы одному из ключей поиска, указанных в запросе. Список FoundByItems будет включать каждую пару ключ-значение, по которой был найден профиль.

Отношение OR является поведением по умолчанию, если параметр LogicalOperator не включен в запрос SearchProfiles.

(структура)

Тип данных, состоящий из KeyName и списка Values, которые использовались для поиска профиля в ответе на запрос SearchProfiles.

KeyName -> (строка)

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

Values -> (список)

Список значений ключей.

(строка)

PartyTypeString -> (строка)

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

GenderString -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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