[ aws . cloudformation ]
batch-describe-type-configurations
Описание
Возвращает данные конфигурации для указанных расширений CloudFormation из реестра CloudFormation для учетной записи и региона.
Дополнительную информацию см. в разделе Редактирование данных конфигурации для расширений в вашей учетной записи в Руководстве пользователя CloudFormation.
См. также: Документацию API AWS
Синтаксис
batch-describe-type-configurations
--type-configuration-identifiers <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]
Параметры
--type-configuration-identifiers (список)
Список идентификаторов желаемых конфигураций расширений.
(структура)
Идентифицирующая информация для конфигурации расширения CloudFormation.
TypeArn -> (строка)
Amazon Resource Name (ARN) расширения в данной учетной записи и регионе.
Для общедоступных расширений это будет ARN, назначенный при вызове операции ActivateType API в данной учетной записи и регионе. Для частных расширений это будет ARN, назначенный при вызове операции RegisterType API в данной учетной записи и регионе.
TypeConfigurationAlias -> (строка)
TypeConfigurationArn -> (строка)
Type -> (строка)
TypeName -> (строка)
Сокращенный синтаксис:
TypeArn=string,TypeConfigurationAlias=string,TypeConfigurationArn=string,Type=string,TypeName=string ...
Синтаксис JSON:
[
{
"TypeArn": "string",
"TypeConfigurationAlias": "string",
"TypeConfigurationArn": "string",
"Type": "RESOURCE"|"MODULE"|"HOOK",
"TypeName": "string"
}
...
]
--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
- таблица
- 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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.
Для пакетного описания конфигурации типа
Следующий batch-describe-type-configurations пример настраивает данные для типа.
aws cloudformation batch-describe-type-configurations \
--region us-west-2 \
--type-configuration-identifiers TypeArn="arn:aws:cloudformation:us-west-2:123456789012:type/resource/Example-Test-Type,TypeConfigurationAlias=MyConfiguration"
Вывод:
{
"Errors": [],
"UnprocessedTypeConfigurations": [],
"TypeConfigurations": [
{
"Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/Example-Test-Type",
"Alias": "MyConfiguration",
"Configuration": "{\n\"Example\": {\n\"ApiKey\": \"examplekey\",\n\"ApplicationKey\": \"examplekey1\",\n\"ApiURL\": \"exampleurl\"\n }\n}",
"LastUpdated": "2021-10-01T15:25:46.210000+00:00",
"TypeArn": "arn:aws:cloudformation:us-east-1:123456789012:type/resource/Example-Test-Type"
}
]
}
Дополнительную информацию см. в разделе Использование реестра AWS CloudFormation в Руководстве пользователя AWS CloudFormation.
Вывод
Errors -> (список)
Список информации о любых ошибках, возникших во время настройки указанных конфигураций.
(структура)
Подробная информация об ошибке, возникшей во время настройки данных конфигурации для расширения CloudFormation.
ErrorCode -> (строка)
ErrorMessage -> (строка)
TypeConfigurationIdentifier -> (структура)
Идентифицирующая информация для конфигурации расширения CloudFormation.
TypeArn -> (строка)
Amazon Resource Name (ARN) расширения в данной учетной записи и регионе.
Для общедоступных расширений это будет ARN, назначенный при вызове операции ActivateType API в данной учетной записи и регионе. Для частных расширений это будет ARN, назначенный при вызове операции RegisterType API в данной учетной записи и регионе.
TypeConfigurationAlias -> (строка)
TypeConfigurationArn -> (строка)
Type -> (строка)
TypeName -> (строка)
UnprocessedTypeConfigurations -> (список)
Список любых указанных конфигураций расширений, которые CloudFormation не смог обработать по какой-либо причине.
(структура)
Идентифицирующая информация для конфигурации расширения CloudFormation.
TypeArn -> (строка)
Amazon Resource Name (ARN) расширения в данной учетной записи и регионе.
Для общедоступных расширений это будет ARN, назначенный при вызове операции ActivateType API в данной учетной записи и регионе. Для частных расширений это будет ARN, назначенный при вызове операции RegisterType API в данной учетной записи и регионе.
TypeConfigurationAlias -> (строка)
TypeConfigurationArn -> (строка)
Type -> (строка)
TypeName -> (строка)
TypeConfigurations -> (список)
Список любых указанных конфигураций расширений из реестра CloudFormation.
(структура)
Подробная информация о спецификации расширения CloudFormation в данной учетной записи и регионе.
Дополнительную информацию см. в разделе Редактирование данных конфигурации для расширений в вашей учетной записи в Руководстве пользователя CloudFormation.
Arn -> (строка)
Alias -> (строка)
Configuration -> (строка)
JSON-строка, определяющая данные конфигурации расширения в данной учетной записи и регионе.
Если для указанного расширения конфигурация не задана, CloudFormation возвращает {}.
LastUpdated -> (отметка времени)
Время последнего обновления данных конфигурации для этого расширения.
Если для указанного расширения конфигурация не задана, CloudFormation возвращает null.
TypeArn -> (строка)
Amazon Resource Name (ARN) расширения в данной учетной записи и регионе.
Для общедоступных расширений это будет ARN, назначенный при вызове операции ActivateType API в данной учетной записи и регионе. Для частных расширений это будет ARN, назначенный при вызове операции RegisterType API в данной учетной записи и регионе.
TypeName -> (строка)
IsDefaultConfiguration -> (логическое значение)
© Copyright 2025, Amazon Web Services. Created using Sphinx.