Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

describe-view

Описание

Получает представление для указанного экземпляра Amazon Connect и идентификатора представления.

Идентификатор представления может быть передан как ViewId или ARN.

$SAVED необходимо указать, если представление не опубликовано.

Идентификатор представления может содержать необязательный квалификатор, например, <view-id>:$SAVED, который представляет собой либо фактический номер версии, либо управляемый Amazon Connect квалификатор $SAVED | $LATEST. Если он не указан, то $LATEST предполагается для управляемых клиентом представлений, и возвращается ошибка, если доступного опубликованного содержимого нет. Версия 1 предполагается для управляемых Amazon Web Services представлений.

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

Синтаксис

  describe-view
--instance-id <value>
--view-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]

Параметры

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

Идентификатор экземпляра Amazon Connect. Идентификатор экземпляра можно найти в ARN экземпляра.

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

ViewId представления. Для управляемых Amazon Web Services представлений это должен быть ARN.

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

Вывод

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

Все данные представления содержатся в объекте Представление.

Id -> (строка)

Идентификатор представления.

Arn -> (строка)

Amazon Resource Name (ARN) представления.

Имя -> (строка)

Имя представления.

Статус -> (строка)

Указывает статус представления как SAVED или PUBLISHED. Статус PUBLISHED инициирует проверку содержимого.

Тип -> (строка)

Тип представления - CUSTOMER_MANAGED.

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

Описание представления.

Версия -> (целое число)

Текущая версия представления.

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

Описание версии.

Содержимое -> (структура)

Содержимое представления, содержащее все необходимое содержимое для отображения представления, кроме входных данных времени выполнения.

InputSchema -> (строка)

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

Шаблон -> (строка)

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

Действия -> (список)

Список возможных действий из представления.

(строка)

Теги -> (отображение)

Теги, связанные с ресурсом представления (не специфичны для версии представления).

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

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

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

Дата создания представления.

ДатаПоследнегоИзменения -> (метка времени)

Последняя метка времени операций UpdateViewContent или CreateViewVersion.

ViewContentSha256 -> (строка)

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

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

Spec-Zone.ru

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