Spec-Zone.ru › AWS CLI v2

[ aws . connectcases ]

get-layout

Описание

Возвращает детали запрошенного макета.

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

Синтаксис

  get-layout
--domain-id <value>
--layout-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]

Параметры

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

Уникальный идентификатор домена Cases.

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

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

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

Регион для использования. Переопределяет настройки config/env.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Набор сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

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

Вывод

содержимое -> (структура помеченного объединения)

Информация о том, какие поля будут присутствовать в макете, порядок полей и атрибут только для чтения поля.

Примечание

Это структура помеченного объединения. Только один из следующих верхних ключей может быть установлен: basic.

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

Содержание, специфичное для типа BasicLayout. Оно настраивает поля в верхней панели и вкладке «Дополнительная информация» пользовательского интерфейса Cases.

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

Это представляет разделы во вкладке макета страницы.

sections -> (список)

Отсортированный список различных типов разделов, которые можно добавить.

(структура помеченного объединения)

Это представляет разделы в панели или вкладке макета страницы.

Примечание

Это структура помеченного объединения. Только один из следующих верхних ключей может быть установлен: fieldGroup.

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

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

fields -> (список)

Представляет отсортированный список, содержащий информацию о поле.

(структура)

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

id -> (строка)

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

name -> (строка)

Имя группы полей.

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

Это представляет разделы в панели макета страницы.

sections -> (список)

Отсортированный список различных типов разделов, которые можно добавить.

(структура помеченного объединения)

Это представляет разделы в панели или вкладке макета страницы.

Примечание

Это структура помеченного объединения. Только один из следующих верхних ключей может быть установлен: fieldGroup.

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

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

fields -> (список)

Представляет отсортированный список, содержащий информацию о поле.

(структура)

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

id -> (строка)

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

name -> (строка)

Имя группы полей.

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

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

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

Указывает, удален ли ресурс.

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

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

layoutArn -> (строка)

Amazon Resource Name (ARN) только что созданного макета.

layoutId -> (строка)

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

name -> (строка)

Имя макета. Оно должно быть уникальным.

tags -> (массив)

Массив пар ключ-значение, представляющих теги ресурса. Теги используются для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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