Spec-Zone.ru › AWS CLI v2

[ aws . servicecatalog ]

describe-record

Описание

Получает информацию об указанной операции запроса.

Используйте эту операцию после вызова операции запроса (например, ProvisionProduct , TerminateProvisionedProduct или UpdateProvisionedProduct ).

Примечание

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

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

Синтаксис

  describe-record
[--accept-language <value>]
--id <value>
[--page-token <value>]
[--page-size <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]

Параметры

--accept-language (строка)

Код языка.

  • jp - Японский
  • zh - Китайский

--id (строка)

Идентификатор записи продукта. Этот идентификатор возвращается операцией запроса.

--page-token (строка)

Токен страницы для следующего набора результатов. Чтобы получить первый набор результатов, используйте null.

--page-size (целое число)

Максимальное количество элементов для возврата в этом вызове.

--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 (строка)

Включение/отключение цветного вывода.

  • вкл
  • выкл
  • авто

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

Вывод

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

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

RecordId -> (строка)

Идентификатор записи.

ProvisionedProductName -> (строка)

Наименование продукта.

Status -> (строка)

Состояние продукта.

  • CREATED - Запрос создан, но операция не начата.
  • IN_PROGRESS - Запрашиваемая операция выполняется.
  • IN_PROGRESS_IN_ERROR - Продукт находится в процессе изменения, но запрошенная операция завершилась неудачно, и происходит исправление. Например, откат.
  • SUCCEEDED - Запрошенная операция успешно завершена.
  • FAILED - Запрошенная операция завершилась неудачно. Проведите расследование, используя возвращенные сообщения об ошибках.

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

Временная метка создания в UTC.

UpdatedTime -> (временная метка)

Время последнего обновления записи.

ProvisionedProductType -> (строка)

Тип продукта. Доступные значения: CFN_STACK , CFN_STACKSET , TERRAFORM_OPEN_SOURCE , TERRAFORM_CLOUD и EXTERNAL .

RecordType -> (строка)

Тип записи.

  • PROVISION_PRODUCT
  • UPDATE_PROVISIONED_PRODUCT
  • TERMINATE_PROVISIONED_PRODUCT

ProvisionedProductId -> (строка)

Идентификатор продукта.

ProductId -> (строка)

Идентификатор продукта.

ProvisioningArtifactId -> (строка)

Идентификатор артефакта.

PathId -> (строка)

Идентификатор пути.

RecordErrors -> (список)

Возникшие ошибки.

(структура)

Код ошибки и описание, полученные в результате операции.

Code -> (строка)

Числовое значение ошибки.

Description -> (строка)

Описание ошибки.

RecordTags -> (список)

Одна или несколько меток.

(структура)

Информация о метке, которая представляет собой пару ключ-значение.

Key -> (строка)

Ключ метки.

Value -> (строка)

Значение метки.

LaunchRoleArn -> (строка)

ARN роли запуска, связанной с продуктом.

RecordOutputs -> (список)

Информация о созданном продукте в результате запроса. Например, вывод для продукта, основанного на CloudFormation, который создает ведро S3, будет включать URL-адрес ведра S3.

(структура)

Вывод для продукта, созданного в результате запроса. Например, вывод для продукта, основанного на CloudFormation, который создает ведро S3, будет включать URL-адрес ведра S3.

OutputKey -> (строка)

Ключ вывода.

OutputValue -> (строка)

Значение вывода.

Description -> (строка)

Описание вывода.

NextPageToken -> (строка)

Токен страницы для получения следующего набора результатов. Если дополнительных результатов нет, это значение равно null.

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

Spec-Zone.ru

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