Spec-Zone.ru › AWS CLI v2

[ aws . appconfig ]

получить-расширение

Описание

Возвращает информацию об расширении AppConfig.

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

Синтаксис

  get-extension
--extension-identifier <value>
[--version-number <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]

Параметры

--extension-identifier (строка)

Имя, идентификатор или Amazon Resource Name (ARN) расширения.

--version-number (целое число)

Номер версии расширения. Если номер версии не был определен, AppConfig использует самую высокую версию.

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Получение подробностей о расширении

Следующий get-extension пример отображает информацию об расширении.

aws appconfig get-extension \
    --region us-west-2 \
    --extension-identifier S3-backup-extension

Вывод:

{
    "Id": "1A2B3C4D",
    "Name": "S3-backup-extension",
    "VersionNumber": 1,
    "Arn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1",
    "Actions": {
        "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [
            {
                "Name": "S3backup",
                "Uri": "arn:aws:lambda:us-west-2:123456789012:function:S3backupfunction",
                "RoleArn": "arn:aws:iam::123456789012:role/appconfigextensionrole"
            }
        ]
    },
    "Parameters": {
        "S3bucket": {
            "Required": true
        }
    }
}

Дополнительную информацию см. в разделе Работа с расширениями AWS AppConfig в руководстве пользователя AWS AppConfig.

Вывод

Id -> (строка)

Сгенерированный системой идентификатор расширения.

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

Имя расширения.

Номер версии -> (целое число)

Номер версии расширения.

Arn -> (строка)

Сгенерированный системой Amazon Resource Name (ARN) для расширения.

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

Информация об расширении.

Действия -> (отображение)

Действия, определенные в расширении.

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

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

(структура)

Действие определяет задачи, выполняемые расширением в процессе AppConfig. Каждое действие включает точку действия, как показано в следующей таблице:

  • PRE_CREATE_HOSTED_CONFIGURATION_VERSION
  • PRE_START_DEPLOYMENT
  • AT_DEPLOYMENT_TICK
  • ON_DEPLOYMENT_START
  • ON_DEPLOYMENT_STEP
  • ON_DEPLOYMENT_BAKING
  • ON_DEPLOYMENT_COMPLETE
  • ON_DEPLOYMENT_ROLLED_BACK

Каждое действие также включает имя, URI функции Lambda и Amazon Resource Name (ARN) для роли делегирования Identity and Access Management. Вы указываете имя, URI и ARN для каждой точки действия, определенной в расширении.

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

Имя действия.

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

Информация об действии.

Uri -> (строка)

URI расширения, связанное с точкой действия в определении расширения. URI может быть Amazon Resource Name (ARN) для одного из следующих: функция Lambda, очередь Amazon Simple Queue Service, тема Amazon Simple Notification Service или служба событий Amazon EventBridge по умолчанию.

RoleArn -> (строка)

Amazon Resource Name (ARN) для роли делегирования Identity and Access Management.

Параметры -> (отображение)

Параметры, принимаемые расширением. Вы указываете значения параметров при ассоциации расширения с ресурсом AppConfig, используя действие API CreateExtensionAssociation. Для действий расширения Lambda эти параметры включаются в объект запроса Lambda.

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

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

Значение, такое как Amazon Resource Name (ARN) или тема Amazon Simple Notification Service, введенное в расширение при вызове. Значения параметров указываются при ассоциации расширения. Дополнительную информацию об расширениях см. в Руководстве пользователя AppConfig.

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

Информация о параметре.

Обязательный -> (булево)

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

Динамический -> (булево)

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

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

Spec-Zone.ru

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