[ aws . customer-profiles ]
Получение шаблона типа объекта профиля
Описание
Возвращает информацию о шаблоне для определенного типа объекта.
Шаблон — это предварительно определённый тип ProfileObjectType, например, «Salesforce-Account» или «Salesforce-Contact». Когда пользователь отправляет ProfileObject с помощью API PutProfileObject, и ObjectTypeName соответствует одному из TemplateIds, используются сопоставления из шаблона.
См. также: Документацию API AWS
Синтаксис
get-profile-object-type-template
--template-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]
Параметры
--template-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
- текст
- таблица
- 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.
Вывод
TemplateId -> (строка)
SourceName -> (строка)
SourceObject -> (строка)
AllowProfileCreation -> (булево)
FALSE. Если флаг AllowProfileCreation установлен в значение FALSE, служба пытается извлечь стандартный профиль и связать этот объект с профилем. Если он установлен в значение TRUE, и если соответствие не найдено, служба создаёт новый стандартный профиль.SourceLastUpdatedTimestampFormat -> (строка)
sourceLastUpdatedTimestamp, который был ранее настроен.Fields -> (словарь)
Словарь имени и поля ObjectType.
ключ -> (строка)
значение -> (структура)
Представляет поле в ProfileObjectType.
Source -> (строка)
Target -> (строка)
ContentType -> (строка)
Keys -> (словарь)
Список уникальных ключей, которые можно использовать для сопоставления данных с профилем.
ключ -> (строка)
значение -> (список)
(структура)
Объект, определяющий элемент Key ProfileObject. Key — специальный элемент, который можно использовать для поиска профиля клиента.
StandardIdentifiers -> (список)
Типы ключей, которые может иметь ProfileObject. Каждый ProfileObject может иметь только 1 УНИКАЛЬНЫЙ ключ, но несколько ПРОФИЛЬНЫХ ключей. ПРОФИЛЬ, АКТИВ, ДЕЛО или ЗАКАЗ означает, что этот ключ может быть использован для привязки объекта к ПРОФИЛЮ, АКТИВУ, ДЕЛУ или ЗАКАЗУ соответственно. УНИКАЛЬНЫЙ означает, что он может быть использован для уникальной идентификации объекта. Если ключ отмечен как ВТОРИЧНЫЙ, он будет использован для поиска профилей после того, как будут обработаны все другие ПРОФИЛЬНЫЕ ключи. КЛЮЧ LOOKUP_ONLY используется только для сопоставления профиля, но не сохраняется для поиска профиля. КЛЮЧ NEW_ONLY используется только в том случае, если профиль ещё не существует перед добавлением объекта, в противном случае он используется только для сопоставления объектов с профилями.
(строка)
FieldNames -> (список)
Ссылка на имя ключа в словаре полей.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|