Spec-Zone.ru › AWS CLI v2

[ aws . customer-profiles ]

put-profile-object-type

Описание

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

Чтобы добавить или удалить теги существующего типа объекта, см. TagResource /UntagResource.

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

Синтаксис

  put-profile-object-type
--domain-name <value>
--object-type-name <value>
--description <value>
[--template-id <value>]
[--expiration-days <value>]
[--encryption-key <value>]
[--allow-profile-creation | --no-allow-profile-creation]
[--source-last-updated-timestamp-format <value>]
[--max-profile-object-count <value>]
[--fields <value>]
[--keys <value>]
[--tags <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 (строка)

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

--description (строка)

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

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

Уникальный идентификатор шаблона объекта. Для некоторых атрибутов в запросе служба будет использовать значение по умолчанию из шаблона объекта, когда присутствует параметр TemplateId. Если эти атрибуты присутствуют в запросе, служба может вернуть BadRequestException. Эти атрибуты включают: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields и Keys. Например, если AllowProfileCreation установлено в значение true, а TemplateId – в значение true, служба может вернуть BadRequestException.

--expiration-days (целое число)

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

--encryption-key (строка)

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

--allow-profile-creation | --no-allow-profile-creation (булево)

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

--source-last-updated-timestamp-format (строка)

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

--max-profile-object-count (целое число)

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

--fields (массив)

Массив имен и полей типа ObjectType.

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

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

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

Source -> (строка)

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

Target -> (строка)

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

ContentType -> (строка)

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

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

KeyName1=Source=string,Target=string,ContentType=string,KeyName2=Source=string,Target=string,ContentType=string

Синтаксис JSON:

{"string": {
      "Source": "string",
      "Target": "string",
      "ContentType": "STRING"|"NUMBER"|"PHONE_NUMBER"|"EMAIL_ADDRESS"|"NAME"
    }
  ...}

--keys (массив)

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

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

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

(структура)

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

StandardIdentifiers -> (список)

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

(строка)

FieldNames -> (список)

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

(строка)

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

KeyName1=[{StandardIdentifiers=[string,string],FieldNames=[string,string]},{StandardIdentifiers=[string,string],FieldNames=[string,string]}],KeyName2=[{StandardIdentifiers=[string,string],FieldNames=[string,string]},{StandardIdentifiers=[string,string],FieldNames=[string,string]}]

Синтаксис JSON:

{"string": [
      {
        "StandardIdentifiers": ["PROFILE"|"ASSET"|"CASE"|"ORDER"|"COMMUNICATION_RECORD"|"UNIQUE"|"SECONDARY"|"LOOKUP_ONLY"|"NEW_ONLY", ...],
        "FieldNames": ["string", ...]
      }
      ...
    ]
  ...}

--tags (массив)

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

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

Вывод

Тип объекта профиля -> (строка)

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

Описание -> (строка)

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

Идентификатор шаблона -> (строка)

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

Дни до истечения срока действия -> (целое число)

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

Ключ шифрования -> (строка)

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

Разрешить создание профиля -> (булево)

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

Формат метки последнего обновления источника -> (строка)

Формат вашей sourceLastUpdatedTimestamp, который был ранее настроен в полях, обработанных с помощью SimpleDateFormat. Если у вас есть sourceLastUpdatedTimestamp в вашем поле, вам необходимо настроить sourceLastUpdatedTimestampFormat.

Максимальное количество объектов профиля -> (целое число)

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

Максимальное доступное количество объектов профиля -> (целое число)

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

Поля -> (массив)

Массив имени и поля ObjectType.

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

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

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

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

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

Цель -> (строка)

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

Тип содержимого -> (строка)

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

Ключи -> (массив)

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

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

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

(структура)

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

Стандартные идентификаторы -> (список)

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

(строка)

Имена полей -> (список)

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

(строка)

Создано -> (метка времени)

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

Последнее обновление -> (метка времени)

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

Теги -> (массив)

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

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

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

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

Spec-Zone.ru

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