Spec-Zone.ru › AWS CLI v2

[ aws . cloudfront ]

describe-function

Описание

Получает конфигурационную информацию и метаданные о функции CloudFront, но не код функции. Чтобы получить код функции, используйте GetFunction .

Чтобы получить конфигурационную информацию и метаданные о функции, вы должны указать имя функции и этап. Эти значения можно получить с помощью ListFunctions .

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

Синтаксис

  describe-function
--name <value>
[--stage <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]

Параметры

--name (строка)

Имя функции, о которой вы получаете информацию.

--stage (строка)

Этап функции, либо DEVELOPMENT, либо LIVE.

Возможные значения:

  • DEVELOPMENT
  • LIVE

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

Вывод

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

Содержит конфигурационную информацию и метаданные о функции CloudFront.

Name -> (строка)

Имя функции CloudFront.

Status -> (строка)

Статус функции CloudFront.

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

Содержит конфигурационную информацию о функции CloudFront.

Comment -> (строка)

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

Runtime -> (строка)

Версия среды выполнения функции.

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

Конфигурация ассоциаций хранилища ключей.

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

Количество ассоциаций хранилища ключей.

Items -> (список)

Элементы ассоциации хранилища ключей.

(структура)

Ассоциация хранилища ключей.

KeyValueStoreARN -> (строка)

Amazon Resource Name (ARN) ассоциации хранилища ключей.

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

Содержит метаданные о функции CloudFront.

FunctionARN -> (строка)

Amazon Resource Name (ARN) функции. ARN однозначно идентифицирует функцию.

Stage -> (строка)

Этап функции, либо DEVELOPMENT, либо LIVE.

Когда функция находится на этапе DEVELOPMENT, вы можете протестировать ее с помощью TestFunction и обновить ее с помощью UpdateFunction.

Когда функция находится на этапе LIVE, вы можете прикрепить ее к поведению кеша распределения, используя ARN функции.

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

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

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

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

ETag -> (строка)

Идентификатор версии текущей версии функции CloudFront.

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

Spec-Zone.ru

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