Spec-Zone.ru › AWS CLI v2

[ aws . customer-profiles ]

get-profile-object-type

Описание

Возвращает типы объектов для определённого домена.

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

Синтаксис

  get-profile-object-type
--domain-name <value>
--object-type-name <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 (строка)

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

--object-type-name (строка)

Имя типа объекта профиля.

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

Вывод

ObjectTypeName -> (строка)

Имя типа объекта профиля.

Description -> (строка)

Описание типа объекта профиля.

TemplateId -> (строка)

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

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

Количество дней до истечения срока действия данных в объекте.

EncryptionKey -> (строка)

Ключ, предоставленный клиентом, для шифрования объекта профиля, который будет создан в этом типе объекта профиля.

AllowProfileCreation -> (логическое значение)

Указывает, должен ли быть создан профиль при получении данных, если для объекта этого типа его нет. Значение по умолчанию - FALSE. Если флаг AllowProfileCreation установлен в FALSE, служба пытается получить стандартный профиль и связать этот объект с профилем. Если он установлен в TRUE, и если совпадений не найдено, служба создает новый стандартный профиль.

SourceLastUpdatedTimestampFormat -> (строка)

Формат вашего sourceLastUpdatedTimestamp, который был ранее настроен.

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

Максимальное количество доступных профильных объектов.

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

Максимальное количество профильных объектов, назначенных типу объекта.

Fields -> (карта)

Карта имени и поля ObjectType.

key -> (строка)

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

Представляет поле в ProfileObjectType.

Source -> (строка)

Поле ProfileObject. Например: _source.FirstName, где «_source» — ProfileObjectType пользователя Zendesk, а «FirstName» — поле в этом ObjectType.

Target -> (строка)

Расположение данных в стандартной модели ProfileObject. Например: _profile.Address.PostalCode.

ContentType -> (строка)

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

Keys -> (карта)

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

key -> (строка)

value -> (список)

(структура)

Объект, определяющий элемент Key ProfileObject. Key — это специальный элемент, который может быть использован для поиска профиля клиента.

StandardIdentifiers -> (список)

Типы ключей, которые может иметь ProfileObject. Каждый ProfileObject может иметь только 1 УНИКАЛЬНЫЙ ключ, но несколько ПРОФИЛЬНЫХ ключей. PROFILE, ASSET, CASE или ORDER означают, что этот ключ может быть использован для привязки объекта к PROFILE, ASSET, CASE или ORDER соответственно. UNIQUE означает, что он может быть использован для уникальной идентификации объекта. Если ключ помечен как SECONDARY, он будет использован для поиска профилей после того, как будут обработаны все другие ключи PROFILE. Ключ LOOKUP_ONLY используется только для соответствия профилю, но не сохраняется для поиска профиля. Ключ NEW_ONLY используется только если профиль ещё не существует перед включением объекта, в противном случае он используется только для сопоставления объектов с профилями.

(строка)

FieldNames -> (список)

Ссылка на имя ключа карты полей.

(строка)

CreatedAt -> (временная метка)

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

LastUpdatedAt -> (временная метка)

Временная метка последнего редактирования домена.

Tags -> (карта)

Теги, используемые для организации, отслеживания или контроля доступа к этому ресурсу.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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