[ aws . cloudcontrol ]
delete-resource
Описание
Удаляет указанный ресурс. Подробнее см. в разделе Удаление ресурса в руководстве пользователя по API Cloud Control Amazon Web Services.
После отправки запроса на удаление ресурса можно отследить его выполнение, вызвав GetResourceRequestStatus с использованием RequestToken полученного в результате вызова DeleteResource.
См. также: Документация API AWS
Синтаксис
delete-resource
--type-name <value>
[--type-version-id <value>]
[--role-arn <value>]
[--client-token <value>]
--identifier <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 (строка)
--type-version-id (строка)
--role-arn (строка)
Идентификатор Amazon Resource Name (ARN) роли Identity and Access Management (IAM) для API Cloud Control, используемой при выполнении данной операции над ресурсом. Указанная роль должна обладать необходимыми правами для выполнения операции. Требуемые права для каждого обработчика событий определены в разделе ``handlers`` схемы определения типа ресурса.
Если роль не указана, Cloud Control API использует временную сессию, созданную с использованием учетных данных пользователя Amazon Web Services.
Дополнительную информацию см. в руководстве пользователя по API Cloud Control Amazon Web Services в разделе Указание учетных данных.
--client-token (строка)
Уникальный идентификатор для обеспечения идемпотентности запроса к ресурсу. Для обеспечения идемпотентности рекомендуется указывать этот токен, чтобы API Cloud Control Amazon Web Services мог точно отличать повторные запросы от новых запросов к ресурсу. Вы можете повторить запрос к ресурсу, чтобы убедиться, что он был успешно получен.
Токен клиента действителен в течение 36 часов после его использования. По истечении этого срока запрос к ресурсу с тем же токеном клиента рассматривается как новый запрос.
Если токен клиента не указан, он генерируется для включения в запрос.
Дополнительную информацию см. в руководстве пользователя по API Cloud Control Amazon Web Services в разделе Обеспечение уникальности запросов к операциям с ресурсами.
--identifier (строка)
Идентификатор ресурса.
Вы можете указать первичный идентификатор или любой вторичный идентификатор, определенный для типа ресурса в его схеме ресурса. Вы можете указать только один идентификатор. Первичные идентификаторы можно указывать в виде строки или JSON; вторичные идентификаторы должны указываться в формате JSON.
Для составных первичных идентификаторов (то есть таких, которые состоят из нескольких свойств ресурса, объединенных вместе), чтобы указать первичный идентификатор в виде строки, перечислите значения свойств в порядке их указания в определении первичного идентификатора, разделенные | .
Дополнительную информацию см. в руководстве пользователя по API Cloud Control Amazon Web Services в разделе Идентификация ресурсов.
--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 в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе Использование кавычек со строками.
Удаление ресурса
Следующий delete-resource пример удаляет ресурс AWS::Kinesis::Stream с идентификатором ResourceExample из вашей учетной записи AWS.
aws cloudcontrol delete-resource \
--type-name AWS::Kinesis::Stream \
--identifier ResourceExample
Вывод:
{
"ProgressEvent": {
"TypeName": "AWS::Kinesis::Stream",
"Identifier": "ResourceExample",
"RequestToken": "e48f26ff-d0f9-4ab8-a878-120db1edf111",
"Operation": "DELETE",
"OperationStatus": "IN_PROGRESS",
"EventTime": 1632950300.14
}
}
Дополнительную информацию см. в руководстве пользователя API Cloud Control в разделе Удаление ресурса.
Вывод
ProgressEvent -> (структура)
Представляет текущий статус запроса на удаление ресурса.
После отправки запроса на удаление ресурса можно отследить его выполнение, вызвав GetResourceRequestStatus с использованием RequestToken полученного в результате вызова DeleteResource .
TypeName -> (строка)
Identifier -> (строка)
Основной идентификатор ресурса.
Примечание
В некоторых случаях идентификатор ресурса может быть доступен до того, как операция над ресурсом достигнет статусаSUCCESS .RequestToken -> (строка)
Уникальный токен, представляющий запрос на операцию с ресурсом.
Используйте RequestToken с GetResourceRequestStatus для получения текущего статуса запроса на операцию с ресурсом.
HooksRequestToken -> (строка)
Operation -> (строка)
OperationStatus -> (строка)
Текущий статус запроса на операцию с ресурсом.
-
PENDING: Операция над ресурсом еще не началась. -
IN_PROGRESS: Операция над ресурсом в процессе. -
SUCCESS: Операция над ресурсом успешно завершена. -
FAILED: Операция над ресурсом завершилась неудачно. Для получения дополнительной информации обратитесь к коду ошибки и сообщению об ошибке. -
CANCEL_IN_PROGRESS: Операция над ресурсом отменяется. -
CANCEL_COMPLETE: Операция над ресурсом отменена.
EventTime -> (отметка времени)
ResourceModel -> (строка)
StatusMessage -> (строка)
ErrorCode -> (строка)
Для запросов со статусом FAILED соответствующий код ошибки.
Для определений кодов ошибок см. Коды ошибок обработчика в руководстве пользователя CloudFormation Command Line Interface для разработки расширений.
RetryAfter -> (отметка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.