[ aws . cloudformation ]
list-types
Описание
Возвращает сводную информацию об расширениях, которые были зарегистрированы в CloudFormation.
См. также: Документация API AWS
list-types является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную загрузку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе на запрос с постраничной загрузкой аргумент --query должен извлечь данные из результатов следующих выражений запросов: TypeSummaries
Синтаксис
list-types
[--visibility <value>]
[--provisioning-type <value>]
[--deprecated-status <value>]
[--type <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Параметры
--visibility (строка)
Область видимости и использования расширений в операциях CloudFormation.
Допустимые значения:
-
PRIVATE: Расширения, видимые и доступные в рамках этой учетной записи и региона. Это включает:- Приватные расширения, зарегистрированные в этой учетной записи и регионе.
- Общедоступные расширения, активированные в этой учетной записи и регионе.
-
PUBLIC: Расширения, общедоступные и доступные для активации в любой учетной записи Amazon Web Services. Это включает расширения Amazon Web Services, а также расширения сторонних издателей.
По умолчанию PRIVATE.
Возможные значения:
PUBLICPRIVATE
--provisioning-type (строка)
Для типов ресурсов поведение развертывания типа ресурса. CloudFormation определяет тип развертывания во время регистрации, на основе типов обработчиков в пакете обработчиков схем, представленных для регистрации.
Допустимые значения:
-
FULLY_MUTABLE: Тип ресурса включает обработчик обновлений для обработки обновлений типа во время операций обновления стека. -
IMMUTABLE: Тип ресурса не включает обработчик обновлений, поэтому тип не может быть обновлен и должен быть заменен во время операций обновления стека. -
NON_PROVISIONABLE: Тип ресурса не включает обработчики создания, чтения и удаления и, следовательно, фактически не может быть развернут.
По умолчанию FULLY_MUTABLE.
Возможные значения:
NON_PROVISIONABLEIMMUTABLEFULLY_MUTABLE
--deprecated-status (строка)
Статус устаревания расширения, для которого вы хотите получить сводную информацию.
Допустимые значения:
-
LIVE: Расширение зарегистрировано для использования в операциях CloudFormation. -
DEPRECATED: Расширение дезактивировано и больше не может быть использовано в операциях CloudFormation.
Возможные значения:
LIVEDEPRECATED
--type (строка)
Тип расширения.
Возможные значения:
RESOURCEMODULEHOOK
--filters (структура)
Критерии фильтрации для определения расширений, которые необходимо вернуть.
Фильтры должны быть совместимы с Visibility для возврата корректных результатов. Например, указание AWS_TYPES для Category и PRIVATE для Visibility возвращает пустой список типов, но указание PUBLIC для Visibility возвращает нужный список.
Category -> (строка)
Категория расширений, которые необходимо вернуть.
-
REGISTERED: Приватные расширения, зарегистрированные для этой учетной записи и региона. -
ACTIVATED: Общедоступные расширения, активированные для этой учетной записи и региона. -
THIRD_PARTY: Расширения, доступные для использования от издателей, отличных от Amazon. Это включает:- Приватные расширения, зарегистрированные в учетной записи.
- Общедоступные расширения от издателей, отличных от Amazon, независимо от того, активированы они или нет.
-
AWS_TYPES: Расширения, доступные для использования от Amazon.
PublisherId -> (строка)
Идентификатор издателя расширения.
Расширения, опубликованные Amazon, не присвоены идентификатор издателя. Используйте категорию AWS_TYPES для указания списка типов, опубликованных Amazon.
TypeNamePrefix -> (строка)
Синтаксис сокращенного ввода:
Category=string,PublisherId=string,TypeNamePrefix=string
Синтаксис JSON:
{
"Category": "REGISTERED"|"ACTIVATED"|"THIRD_PARTY"|"AWS_TYPES",
"PublisherId": "string",
"TypeNamePrefix": "string"
}
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставляемому --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения из JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята дословно. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания точки начала постраничной загрузки. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения данных в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной загрузки укажите значение NextToken в аргументе starting-token последующей команды. **Не используйте** элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.
--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-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования для Unix. Эти примеры потребуется адаптировать к правилам цитирования вашей терминальной среды. Подробнее см. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для отображения приватных типов ресурсов в учетной записи
Следующий list-types пример отображает список приватных типов ресурсов, в настоящее время зарегистрированных в текущей учетной записи AWS.
aws cloudformation list-types
Вывод:
{
"TypeSummaries": [
{
"Description": "WordPress blog resource for internal use",
"LastUpdated": "2019-12-04T18:28:15.059Z",
"TypeName": "My::WordPress::BlogExample",
"TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-WordPress-BlogExample",
"DefaultVersionId": "00000005",
"Type": "RESOURCE"
},
{
"Description": "Customized resource derived from AWS::Logs::LogGroup",
"LastUpdated": "2019-12-04T18:28:15.059Z",
"TypeName": "My::Logs::LogGroup",
"TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup",
"DefaultVersionId": "00000003",
"Type": "RESOURCE"
}
]
}
Для получения дополнительной информации см. раздел Использование реестра CloudFormation в Руководстве пользователя AWS CloudFormation.
Вывод
TypeSummaries -> (список)
Список структур TypeSummary, содержащих информацию о заданных расширениях.
(структура)
Содержит сводную информацию о заданном расширении CloudFormation.
Type -> (строка)
TypeName -> (строка)
Имя расширения.
Если вы указали TypeNameAlias при вызове операции ActivateType API в вашей учётной записи и регионе, CloudFormation использует этот псевдоним как имя типа.
DefaultVersionId -> (строка)
Идентификатор версии расширения по умолчанию. Версия по умолчанию используется, если версия расширения не указана.
Это относится только к частным расширениям, зарегистрированным в вашей учётной записи. Для общедоступных расширений, как предоставленных Amazon, так и опубликованных третьими сторонами, CloudFormation возвращает null . Для получения дополнительной информации см. RegisterType.
Чтобы установить версию по умолчанию для расширения, используйте SetTypeDefaultVersion.
TypeArn -> (строка)
LastUpdated -> (метка времени)
Дата регистрации указанной версии расширения. Это относится только к:
- Частным расширениям, зарегистрированным в вашей учётной записи. Для получения дополнительной информации см. RegisterType.
- Общедоступным расширениям, активированным в вашей учётной записи с указанным автоматическим обновлением. Для получения дополнительной информации см. ActivateType.
Для всех других типов расширений CloudFormation возвращает null.
Description -> (строка)
PublisherId -> (строка)
OriginalTypeName -> (строка)
Для общедоступных расширений, активированных для этой учётной записи и региона, имя типа общедоступного расширения.
Если вы указали TypeNameAlias при включении расширения в этой учётной записи и регионе, CloudFormation использует этот псевдоним как имя типа расширения в этой учётной записи и регионе, а не имя типа общедоступного расширения. Для получения дополнительной информации см. Использование псевдонимов для ссылки на расширения в Руководстве пользователя CloudFormation.
PublicVersionNumber -> (строка)
Для общедоступных расширений, активированных для этой учётной записи и региона, версия общедоступного расширения, используемая для операций CloudFormation в этой учётной записи и регионе.
Как вы указали AutoUpdate при включении расширения, влияет на то, автоматически ли CloudFormation обновляет расширение в этой учётной записи и регионе при выпуске новой версии. Для получения дополнительной информации см. Автоматическое использование новых версий расширений в Руководстве пользователя CloudFormation.
LatestPublicVersion -> (строка)
Для общедоступных расширений, активированных для этой учётной записи и региона, самая последняя доступная версия общедоступного расширения. Для расширений, кроме активированных расширений третьих сторон, CloudFormation возвращает null .
Как вы указали AutoUpdate при включении расширения, влияет на то, автоматически ли CloudFormation обновляет расширение в этой учётной записи и регионе при выпуске новой версии. Для получения дополнительной информации см. Автоматическое использование новых версий расширений в Руководстве пользователя CloudFormation.
PublisherIdentity -> (строка)
Сервис, используемый для проверки идентичности издателя.
Для получения дополнительной информации см. Публикация расширений для их общего использования в Руководстве пользователя CloudFormation Command Line Interface (CLI).
PublisherName -> (строка)
IsActivated -> (булево)
Активировано ли расширение для этой учётной записи и региона.
Это относится только к общедоступным расширениям третьих сторон. Расширения, опубликованные Amazon, активированы по умолчанию.
NextToken -> (строка)
NextToken устанавливается в токен. Чтобы получить следующий набор результатов, вызовите этот метод ещё раз и назначьте этот токен параметру NextToken объекта запроса. Если запрос возвращает все результаты, NextToken устанавливается в null.
© Copyright 2025, Amazon Web Services. Created using Sphinx.