Spec-Zone.ru › AWS CLI v2

[ aws . amplify ]

list-domain-associations

Описание

Возвращает ассоциации доменов для приложения Amplify.

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

list-domain-associations — это постраничная операция. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой аргумент --query должен извлекать данные из результатов следующих выражений запроса: domainAssociations

Синтаксис

  list-domain-associations
--app-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

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

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

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен, указывающий, с какой точки начать постраничную обработку. Это NextToken из ранее обрубленного ответа.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную обработку, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

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

Вывод

domainAssociations -> (список)

Список ассоциаций доменов.

(структура)

Описание ассоциации между пользовательским доменом и приложением Amplify.

domainAssociationArn -> (строка)

Amazon Resource Name (ARN) для ассоциации домена.

domainName -> (строка)

Имя домена.

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

Включает автоматическое создание поддоменов для ветвей.

autoSubDomainCreationPatterns -> (список)

Устанавливает шаблоны ветвей для автоматического создания поддоменов.

(строка)

autoSubDomainIAMRole -> (строка)

Необходимая роль сервиса AWS Identity and Access Management (IAM) для Amazon Resource Name (ARN) для автоматического создания поддоменов.

domainStatus -> (строка)

Текущий статус ассоциации домена.

updateStatus -> (строка)

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

REQUESTING_CERTIFICATE

Сертификат находится в процессе обновления.

PENDING_VERIFICATION

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

IMPORTING_CUSTOM_CERTIFICATE

Указывает, что пользовательский сертификат Amplify находится в процессе импорта. Это происходит во время создания пользовательского домена или при обновлении пользовательского домена для использования пользовательского сертификата.

PENDING_DEPLOYMENT

Указывает, что изменения поддомена или сертификата распространяются.

AWAITING_APP_CNAME

Amplify ожидает распространения записей CNAME, соответствующих поддоменам. Если ваш пользовательский домен находится на Route 53, Amplify обрабатывает это автоматически. Дополнительную информацию о пользовательских доменах см. в Руководстве пользователя Amplify Hosting.

UPDATE_COMPLETE

Сертификат был связан с доменом.

UPDATE_FAILED

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

statusReason -> (строка)

Дополнительная информация, описывающая причину состояния ассоциации домена.

certificateVerificationDNSRecord -> (строка)

Запись DNS для проверки сертификата.

subDomains -> (список)

Поддомены для ассоциации домена.

(структура)

Поддомен для ассоциации домена.

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

Описание настроек поддомена.

prefix -> (строка)

Настройка префикса для поддомена.

branchName -> (строка)

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

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

Статус проверки поддомена

dnsRecord -> (строка)

Запись DNS для поддомена.

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

Описание SSL/TLS сертификата для ассоциации домена. Это может быть ваш собственный пользовательский сертификат или стандартный сертификат, который Amplify предоставляет вам.

Если вы обновляете свой домен для использования другого сертификата, certificate указывает на новый создаваемый сертификат вместо текущего активного сертификата. В противном случае certificate указывает на текущий активный сертификат.

type -> (строка)

Тип SSL/TLS сертификата, который вы хотите использовать.

Укажите AMPLIFY_MANAGED для использования стандартного сертификата, который Amplify предоставляет вам.

Укажите CUSTOM для использования вашего собственного сертификата, который вы уже добавили в Certificate Manager в вашей учетной записи Amazon Web Services. Убедитесь, что вы запросили (или импортировали) сертификат в регионе США Восточный (Вирджиния) (us-east-1). Дополнительную информацию об использовании ACM см. в Руководстве пользователя ACM.

customCertificateArn -> (строка)

Amazon Resource Name (ARN) для пользовательского сертификата, который вы уже добавили в Certificate Manager в вашей учетной записи Amazon Web Services.

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

certificateVerificationDNSRecord -> (строка)

Запись DNS для проверки сертификата.

nextToken -> (строка)

Токен постраничной обработки. Если не null, токен постраничной обработки возвращается в результате. Передайте его значение в другом запросе, чтобы получить больше записей.

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

Spec-Zone.ru

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