describe-type

Описание

Возвращает подробную информацию об зарегистрированном расширении.

Если вы укажете VersionId, DescribeType возвращает информацию об этой конкретной версии расширения. В противном случае, она возвращает информацию о версии расширения по умолчанию.

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

Синтаксис

  describe-type
[--type <value>]
[--type-name <value>]
[--arn <value>]
[--version-id <value>]
[--publisher-id <value>]
[--public-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]

Параметры

--type (строка)

Тип расширения.

Условие: Вы должны указать либо TypeName и Type , либо Arn .

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

RESOURCE
MODULE
HOOK

--type-name (строка)

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

Условие: Вы должны указать либо TypeName и Type , либо Arn .

--arn (строка)

Amazon Resource Name (ARN) расширения.

Условие: Вы должны указать либо TypeName и Type , либо Arn .

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

Идентификатор конкретной версии расширения. Идентификатор версии — это значение в конце Amazon Resource Name (ARN), назначенное версии расширения при её регистрации.

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

Идентификатор издателя расширения.

Расширения, предоставляемые Amazon Web Services, не имеют идентификатора издателя.

--public-version-number (строка)

Номер версии публичного расширения стороннего разработчика.

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

Для отображения информации о типе

Следующий describe-type пример отображает информацию для указанного типа.

aws cloudformation describe-type \
    --type-name My::Logs::LogGroup \
    --type RESOURCE

Вывод:

{
    "SourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git",
    "Description": "Customized resource derived from AWS::Logs::LogGroup",
    "TimeCreated": "2019-12-03T23:29:33.321Z",
    "Visibility": "PRIVATE",
    "TypeName": "My::Logs::LogGroup",
    "LastUpdated": "2019-12-03T23:29:33.321Z",
    "DeprecatedStatus": "LIVE",
    "ProvisioningType": "FULLY_MUTABLE",
    "Type": "RESOURCE",
    "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000001",
    "Schema": "[details omitted]"
}

Для получения дополнительной информации см. Использование Реестра CloudFormation в Руководстве пользователя AWS CloudFormation.

Вывод

Arn -> (строка)

Amazon Resource Name (ARN) расширения.

Тип -> (строка)

Тип расширения.

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

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

Если расширение является типом публичного стороннего разработчика, который вы активировали с алиасом имени типа, CloudFormation возвращает алиас имени типа. Дополнительные сведения см. в разделе Активация типа.

DefaultVersionId -> (строка)

Идентификатор стандартной версии расширения. Стандартная версия используется, если версия расширения не указана.

Это относится только к частным расширениям, которые вы зарегистрировали в своей учетной записи. Для общедоступных расширений, как предоставленных Amazon Web Services, так и опубликованных сторонними разработчиками, CloudFormation возвращает null . Дополнительные сведения см. в разделе Регистрация типа.

Чтобы установить стандартную версию расширения, используйте SetTypeDefaultVersion.

IsDefaultVersion -> (булево)

Указана ли данная версия расширения как стандартная.

Это относится только к частным расширениям, которые вы зарегистрировали в своей учетной записи, и расширениям, опубликованным Amazon Web Services. Для общедоступных расширений сторонних разработчиков, независимо от того, активированы они в вашей учетной записи, CloudFormation возвращает null.

TypeTestsStatus -> (строка)

Статус контрактных тестов зарегистрированной версии расширения. Чтобы вернуть статус тестов расширения конкретной версии расширения, необходимо указать VersionId.

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

PASSED : Расширение успешно прошло все контрактные тесты. Расширение должно иметь статус теста PASSED перед публикацией. Дополнительные сведения см. в разделе Публикация расширений для их предоставления для общего использования в руководстве пользователя CloudFormation Command Line Interface (CLI).
FAILED : Расширение не прошло один или несколько контрактных тестов.
IN_PROGRESS : В настоящее время выполняются контрактные тесты расширения.
NOT_TESTED : Контрактные тесты расширения еще не выполнялись.

TypeTestsStatusDescription -> (строка)

Описание статуса теста. Чтобы вернуть статус тестов расширения конкретной версии расширения, необходимо указать VersionId.

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

Описание расширения.

Схема -> (строка)

Схема, определяющая расширение.

Дополнительные сведения о схемах расширения см. в разделе Схема типа ресурса в руководстве пользователя CloudFormation Command Line Interface (CLI).

ProvisioningType -> (строка)

Для расширений типов ресурсов поведение подготовки ресурсов. CloudFormation определяет тип подготовки при регистрации, основываясь на типах обработчиков в пакете обработчиков схемы, который был предоставлен.

Допустимые значения включают:

FULLY_MUTABLE : Тип ресурса включает обработчик обновлений для обработки обновлений типа во время операций обновления стека.
IMMUTABLE : Тип ресурса не включает обработчик обновлений, поэтому тип не может быть обновлен и должен быть вместо этого заменен во время операций обновления стека.
NON_PROVISIONABLE : Тип ресурса не включает все следующие обработчики и, следовательно, не может быть подготовлен.
- создание
- чтение
- удаление

DeprecatedStatus -> (строка)

Статус устаревания версии расширения.

Допустимые значения включают:

LIVE : Расширение активировано или зарегистрировано и может быть использовано в операциях CloudFormation, в зависимости от его поведения подготовки и области видимости.
DEPRECATED : Расширение было деактивировано или дезактивировано и больше не может быть использовано в операциях CloudFormation.

Для общедоступных расширений сторонних разработчиков CloudFormation возвращает null.

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

Содержит информацию о конфигурации ведения журнала для частных расширений. Это относится только к частным расширениям, которые вы зарегистрировали в своей учетной записи. Для общедоступных расширений, как предоставленных Amazon Web Services, так и опубликованных сторонними разработчиками, CloudFormation возвращает null . Дополнительные сведения см. в разделе Регистрация типа.

LogRoleArn -> (строка)

Amazon Resource Name (ARN) роли, которую CloudFormation должен принять при отправке записей журнала в CloudWatch Logs.

LogGroupName -> (строка)

Группа Amazon CloudWatch Logs, в которую CloudFormation отправляет информацию о журналах ошибок при вызове обработчиков расширения.

RequiredActivatedTypes -> (список)

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

(структура)

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

Дополнительные сведения см. в разделе Требования к активации общедоступных модулей сторонних разработчиков в руководстве пользователя CloudFormation.

TypeNameAlias -> (строка)

Алиас, назначенный общедоступному расширению в данной учетной записи и регионе. Если вы указали алиас для расширения, CloudFormation обрабатывает алиас как имя типа расширения в рамках данной учетной записи и региона. Вы должны использовать алиас для ссылки на расширение в ваших шаблонах, API-вызовах и консоли CloudFormation.

OriginalTypeName -> (строка)

Имя типа общедоступного расширения.

Если вы указали TypeNameAlias при включении расширения в данной учетной записи и регионе, CloudFormation обрабатывает этот алиас как имя типа расширения в рамках учетной записи и региона, а не имя типа общедоступного расширения. Дополнительные сведения см. в разделе Использование алиасов для ссылки на расширения в руководстве пользователя CloudFormation.

PublisherId -> (строка)

Идентификатор издателя расширения.

SupportedMajorVersions -> (список)

Список основных версий типа расширения, поддерживаемых макросом.

(целое число)

ExecutionRoleArn -> (строка)

Amazon Resource Name (ARN) роли выполнения IAM, используемой для регистрации расширения. Это относится только к частным расширениям, которые вы зарегистрировали в своей учетной записи. Дополнительные сведения см. в разделе Регистрация типа.

Если зарегистрированное расширение вызывает какие-либо API Amazon Web Services, вам необходимо создать * роль выполнения IAM *, которая включает необходимые разрешения для вызова этих API Amazon Web Services, и подготовить эту роль выполнения в вашей учетной записи. Затем CloudFormation принимает эту роль выполнения, чтобы предоставить вашему расширению соответствующие учетные данные.

Видимость -> (строка)

Область, в которой расширение видно и может использоваться в операциях CloudFormation.

Допустимые значения включают:

PRIVATE : Расширение видно и может использоваться только в рамках учетной записи, в которой оно зарегистрировано. CloudFormation помечает все регистрируемые расширения как PRIVATE.
PUBLIC : Расширение общедоступно и может использоваться в любой учетной записи Amazon Web Services.

SourceUrl -> (строка)

URL исходного кода расширения.

DocumentationUrl -> (строка)

URL страницы с подробной документацией по данному расширению.

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

Дата регистрации указанной версии расширения. Это относится только к:

Частным расширениям, которые вы зарегистрировали в своей учетной записи. Дополнительные сведения см. в разделе Регистрация типа.
Общедоступным расширениям, которые вы активировали в своей учетной записи с указанием автоматического обновления. Дополнительные сведения см. в разделе Активация типа.

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

Дата регистрации или активации указанной версии частного расширения в вашей учетной записи.

ConfigurationSchema -> (строка)

Строка JSON, представляющая текущие данные конфигурации расширения в данной учетной записи и регионе.

Чтобы установить данные конфигурации расширения, используйте SetTypeConfiguration. Дополнительные сведения см. в разделе Редактирование данных конфигурации для расширений в вашей учетной записи в руководстве пользователя CloudFormation.

PublisherId -> (строка)

Идентификатор издателя расширения.

Это относится только к общедоступным расширениям сторонних разработчиков. Для частных зарегистрированных расширений и расширений, предоставляемых Amazon Web Services, CloudFormation возвращает null.

OriginalTypeName -> (строка)

Для общедоступных расширений, которые были активированы для данной учетной записи и региона, имя типа общедоступного расширения.

OriginalTypeArn -> (строка)

Для общедоступных расширений, которые были активированы для данной учетной записи и региона, Amazon Resource Name (ARN) общедоступного расширения.

PublicVersionNumber -> (строка)

Номер версии общедоступного расширения стороннего разработчика.

Это относится только к тому случаю, если вы указали общедоступное расширение, которое вы активировали в своей учетной записи, или указали общедоступное расширение без указания версии. Для всех других расширений CloudFormation возвращает null.

LatestPublicVersion -> (строка)

Самая последняя версия общедоступного расширения, доступная для использования.

Это относится только к тому случаю, если вы указали общедоступное расширение и не указали версию. Для всех других запросов CloudFormation возвращает null.

IsActivated -> (булево)

Активировано ли расширение в учетной записи и регионе.

Это относится только к общедоступным расширениям сторонних разработчиков. Для всех остальных расширений CloudFormation возвращает null.

AutoUpdate -> (булево)

Автоматически ли CloudFormation обновляет расширение в данной учетной записи и регионе, когда сторонний издатель расширения публикует новую незначительную версию. Версии, выпущенные издателем, должны быть обновлены вручную. Дополнительные сведения см. в разделе Автоматическое использование новых версий расширений в руководстве пользователя CloudFormation.