Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

удаление-инвентаризации

Описание

Удаление пользовательского типа инвентаризации или данных, связанных с пользовательским типом инвентаризации. Удаление пользовательского типа инвентаризации также называется удалением пользовательской схемы инвентаризации.

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

Синтаксис

  delete-inventory
--type-name <value>
[--schema-delete-option <value>]
[--dry-run | --no-dry-run]
[--client-token <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-name (строка)

Название пользовательского типа инвентаризации, для которого требуется удалить все ранее собранные данные или сам тип инвентаризации.

--schema-delete-option (строка)

Используйте SchemaDeleteOption для удаления пользовательского типа инвентаризации (схемы). Если вы не выберете этот вариант, система удалит только существующие данные инвентаризации, связанные с пользовательским типом инвентаризации. Выберите один из следующих вариантов:

DisableSchema: если вы выберете этот вариант, система проигнорирует все данные инвентаризации для указанной версии и всех более ранних версий. Чтобы снова включить эту схему, необходимо вызвать операцию PutInventory для версии, большей, чем отключенная версия.

DeleteSchema: этот вариант удаляет указанный пользовательский тип из службы инвентаризации. Вы можете повторно создать схему позже, если захотите.

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

  • DisableSchema
  • DeleteSchema

--dry-run | --no-dry-run (логическое значение)

Используйте этот параметр, чтобы просмотреть сводку запроса на удаление без удаления данных или типа данных. Этот параметр полезен, когда вы хотите только понять, что будет удалено. После проверки того, что удаляемые данные соответствуют вашим намерениям, можно запустить ту же команду без указания параметра DryRun.

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

Используемый токен идемпотентности.

--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 в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования UNIX. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для удаления пользовательского типа инвентаризации

В этом примере удаляется пользовательская схема инвентаризации.

Команда:

aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DeleteSchema"

Вывод:

{
  "DeletionId": "d72ac9e8-1f60-4d40-b1c6-bf8c78c68c4d",
  "TypeName": "Custom:RackInfo",
  "DeletionSummary": {
      "TotalCount": 1,
      "RemainingCount": 1,
      "SummaryItems": [
          {
              "Version": "1.0",
              "Count": 1,
              "RemainingCount": 1
          }
      ]
  }
}

Для отключения пользовательского типа инвентаризации

В этом примере отключается пользовательская схема инвентаризации.

Команда:

aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DisableSchema"

Вывод:

{
  "DeletionId": "6961492a-8163-44ec-aa1e-923364dd0850",
  "TypeName": "Custom:RackInformation",
  "DeletionSummary": {
      "TotalCount": 0,
      "RemainingCount": 0,
      "SummaryItems": []
  }
}

Вывод

DeletionId -> (строка)

Каждая операция DeleteInventory получает уникальный идентификатор. Этот параметр возвращает уникальный идентификатор. Вы можете использовать этот идентификатор для запроса состояния операции удаления. Этот параметр полезен для гарантии завершения операции удаления перед началом других операций.

TypeName -> (строка)

Название типа данных инвентаризации, указанное в запросе.

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

Сводка операции удаления. Дополнительную информацию о данной сводке см. в разделе Удаление пользовательской инвентаризации в руководстве пользователя Amazon Web Services Systems Manager.

TotalCount -> (целое число)

Общее количество элементов для удаления. Это количество не меняется во время операции удаления.

RemainingCount -> (целое число)

Остающееся количество элементов для удаления.

SummaryItems -> (список)

Список подсчетов и версий удаленных элементов.

(структура)

Количество, оставшееся количество или номер версии в сводке удаления инвентаризации.

Version -> (строка)

Версия типа инвентаризации.

Count -> (целое число)

Количество удаленных элементов.

RemainingCount -> (целое число)

Остающееся количество элементов для удаления.

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

Spec-Zone.ru

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