Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

обновить-актив

Описание

Обновляет имя актива. Дополнительную информацию см. в разделе Обновление активов и моделей в Руководстве пользователя IoT SiteWise.

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

Синтаксис

  update-asset
--asset-id <value>
--asset-name <value>
[--client-token <value>]
[--asset-description <value>]
[--asset-external-id <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]

Параметры

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

Идентификатор актива, который нужно обновить. Это может быть фактический идентификатор в формате UUID или externalId:, за которым следует внешний идентификатор, если он есть. Дополнительную информацию см. в разделе Ссылка на объекты с внешними идентификаторами в Руководстве пользователя IoT SiteWise.

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

Наглядное имя актива.

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

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

--asset-description (строка)

Описание актива.

--asset-external-id (строка)

Внешний идентификатор, который нужно назначить активу. У актива не должно быть внешнего идентификатора. Внешний идентификатор должен быть уникальным в вашей учетной записи Amazon Web Services. Дополнительную информацию см. в разделе Использование внешних идентификаторов в Руководстве пользователя IoT SiteWise.

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

Чтобы обновить имя актива

Следующий пример update-asset обновляет имя актива ветряной турбины.

aws iotsitewise update-asset \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --asset-name "Wind Turbine 2"

Вывод:

{
    "assetStatus": {
        "state": "UPDATING"
    }
}

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

Вывод

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

Состояние актива, содержащее состояние (UPDATING после успешного выполнения этой операции) и любое сообщение об ошибке.

state -> (строка)

Текущее состояние актива.

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

Содержит связанную информацию об ошибке, если таковая имеется.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке.

details -> (список)

Список подробных ошибок.

(структура)

Содержит подробную информацию об ошибке.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке.

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

Spec-Zone.ru

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