Spec-Zone.ru › AWS CLI v2

[ aws . customer-profiles ]

get-domain

Описание

Возвращает информацию о конкретном домене.

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

Синтаксис

  get-domain
--domain-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 (строка)

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

--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-auto-prompt (логическое значение)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров CLI.

Вывод

DomainName -> (строка)

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

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

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

DefaultEncryptionKey -> (строка)

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

DeadLetterQueueUrl -> (строка)

URL очереди сообщений о событиях (SQS) для обработки ошибок при получении данных из сторонних приложений.

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

Статистика, специфичная для использования домена.

ProfileCount -> (целое число большого размера)

Общее количество профилей в домене.

MeteringProfileCount -> (целое число большого размера)

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

ObjectCount -> (целое число большого размера)

Общее количество объектов в домене.

TotalSize -> (целое число большого размера)

Общий размер всех объектов в домене в байтах.

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

Процесс сопоставления дублирующих профилей. Если Matching = true , Amazon Connect Customer Profiles запускает еженедельную пакетную операцию под названием «Задача разрешения идентификации». Если вы не укажете дату и время запуска Задачи разрешения идентификации, по умолчанию она запускается каждую субботу в 00:00 по UTC, чтобы обнаруживать дублирующие профили в ваших доменаx.

После завершения Задачи разрешения идентификации используйте API GetMatches для возврата и проверки результатов. Или, если вы настроили ExportingConfig в MatchingRequest , вы можете загрузить результаты из S3.

Enabled -> (булево)

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

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

День и время запуска Задачи разрешения идентификации каждую неделю.

DayOfTheWeek -> (строка)

День недели, в который должна запускаться Задача разрешения идентификации.

Time -> (строка)

Время, в которое должна запускаться Задача разрешения идентификации.

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

Конфигурационная информация о процессе автоматического объединения.

Enabled -> (булево)

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

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

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

MatchingAttributesList -> (список)

Список критериев соответствия.

(список)

(строка)

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

Как процесс автоматического объединения должен разрешать конфликты между разными профилями. Например, если у профиля A и профиля B одинаковые FirstName и LastName (и это критерии соответствия), какой EmailAddress следует использовать?

ConflictResolvingModel -> (строка)

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

  • RECENCY : Использует данные, которые были обновлены в последний раз.
  • SOURCE : Использует данные из определённого источника. Например, если компания была приобретена или два отдела объединились, используются данные из указанного источника. Если два дублирующих профиля из одного источника, то используется RECENCY ещё раз.

SourceName -> (строка)

Имя ObjectType, которое используется для разрешения конфликтов при объединении профилей при выборе SOURCE в качестве ConflictResolvingModel.

MinAllowedConfidenceScoreForMerging -> (двойное число)

Число от 0 до 1, представляющее минимальный балл уверенности, необходимый для объединения профилей в группе совпадений во время процесса автоматического объединения. Более высокий балл означает, что требуется более высокое сходство для объединения профилей.

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

Конфигурационная информация для экспорта результатов Задач разрешения идентификации, например, в ведро S3.

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

Расположение S3, куда файлы результатов Задач разрешения идентификации записываются.

S3BucketName -> (строка)

Имя ведра S3, в которое Задачи разрешения идентификации записывают файлы результатов.

S3KeyName -> (строка)

Имя ключа S3 расположения, куда Задачи разрешения идентификации записывают файлы результатов.

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

Процесс сопоставления дублирующих профилей с использованием правила-базируемого сопоставления. Если RuleBasedMatching = true, Amazon Connect Customer Profiles начнёт сопоставлять и объединять ваши профили в соответствии с вашей конфигурацией в RuleBasedMatchingRequest. Вы можете использовать API ListRuleBasedMatches и GetSimilarProfiles для возврата и проверки результатов. Кроме того, если вы настроили ExportingConfig в RuleBasedMatchingRequest, вы можете загрузить результаты из S3.

Enabled -> (булево)

Флаг, включающий процесс правила-базированного сопоставления дублирующих профилей.

MatchingRules -> (список)

Настраивает, как процесс правила-базированного сопоставления должен сопоставлять профили. Вы можете иметь до 15 MatchingRule в MatchingRules.

(структура)

Указывает, как процесс правила-базированного сопоставления должен сопоставлять профили. Вы можете выбрать следующие атрибуты для построения Правила сопоставления:

  • AccountNumber
  • Address.Address
  • Address.City
  • Address.Country
  • Address.County
  • Address.PostalCode
  • Address.State
  • Address.Province
  • BirthDate
  • BusinessName
  • EmailAddress
  • FirstName
  • Gender
  • LastName
  • MiddleName
  • PhoneNumber
  • Любые настраиваемые атрибуты профиля, начинающиеся с Attributes

Rule -> (список)

Один уровень правил MatchRules. Настраивает, как процесс правила-базированного сопоставления должен сопоставлять профили.

(строка)

Status -> (строка)

PENDING

  • Первый статус после настройки правила правила-базированного сопоставления. Если это существующий домен, правило-базированное разрешение идентификации ждёт один час перед созданием правила сопоставления. Если это новый домен, система пропустит этап PENDING.

IN_PROGRESS

  • Система создаёт правило правила-базированного сопоставления. На этом статусе система оценивает существующие данные, и вы больше не можете изменить конфигурацию правила-базированного сопоставления.

ACTIVE

  • Правило готово к использованию. Вы можете изменить правило через день после того, как статус станет ACTIVE.

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

MatchingRule

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

Указывает максимальный разрешённый уровень правил.

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

Настраивает информацию о AttributeTypesSelector, где правило-базированное разрешение идентификации использует для сопоставления профилей.

AttributeMatchingModel -> (строка)

Настраивает AttributeMatchingModel, вы можете выбрать либо ONE_TO_ONE, либо MANY_TO_MANY.

Address -> (список)

Тип Address. Вы можете выбрать из Address, BusinessAddress, MaillingAddress и ShippingAddress.

Вы можете использовать тип Address только в MatchingRule. Например, если вы хотите сопоставить профиль по BusinessAddress.City или MaillingAddress.City, вам нужно выбрать BusinessAddress и MaillingAddress для представления типа Address и указать Address.City в правиле сопоставления.

(строка)

PhoneNumber -> (список)

Тип PhoneNumber. Вы можете выбрать из PhoneNumber, HomePhoneNumber и MobilePhoneNumber.

Вы можете использовать тип PhoneNumber только в MatchingRule. Например, если вы хотите сопоставить профиль по Phone или HomePhone, вам нужно выбрать Phone и HomePhone для представления типа PhoneNumber и указать только PhoneNumber в правиле сопоставления.

(строка)

EmailAddress -> (список)

Тип Email. Вы можете выбрать из EmailAddress, BusinessEmailAddress и PersonalEmailAddress.

Вы можете использовать тип EmailAddress только в MatchingRule. Например, если вы хотите сопоставить профиль по PersonalEmailAddress или BusinessEmailAddress, вам нужно выбрать PersonalEmailAddress и BusinessEmailAddress для представления типа EmailAddress и указать только EmailAddress в правиле сопоставления.

(строка)

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

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

ConflictResolvingModel -> (строка)

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

  • RECENCY : Использует данные, которые были обновлены в последний раз.
  • SOURCE : Использует данные из определённого источника. Например, если компания была приобретена или два отдела объединились, используются данные из указанного источника. Если два дублирующих профиля из одного источника, то используется RECENCY ещё раз.

SourceName -> (строка)

Имя ObjectType, которое используется для разрешения конфликтов при объединении профилей при выборе SOURCE в качестве ConflictResolvingModel.

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

Конфигурационная информация о ведре S3, куда Задачи разрешения идентификации записывают файлы результатов.

Примечание

Вам нужно предоставить принципалу службы Customer Profiles право на запись в ваше ведро S3. В противном случае вы получите исключение в ответе API. Пример политики см. в Amazon Connect Customer Profiles — предотвращение конфликтов между службами.

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

Расположение S3, куда файлы результатов Задач разрешения идентификации записываются.

S3BucketName -> (строка)

Имя ведра S3, в которое Задачи разрешения идентификации записывают файлы результатов.

S3KeyName -> (строка)

Имя ключа S3 расположения, куда Задачи разрешения идентификации записывают файлы результатов.

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

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

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

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

Tags -> (карта)

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

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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