deleteImage
カスタム AWS ParallelCluster イメージの削除を開始します。
リクエストの構文
DELETE /v3/images/custom/{imageId} { "force": boolean, "region": "string" }
リクエスト本文
- imageId
-
イメージの ID。
タイプ: 文字列
必須: はい
- force
-
trueに設定すると、AMI を強制的に削除します。AMI を使用しているインスタンスがある場合や、AMI が共有されている場合は、このパラメータを使用します。デフォルト:false。型: ブール値
必須：いいえ
- region
-
イメージが作成された AWS リージョン。
タイプ: 文字列
必須: いいえ
レスポンスの構文
{ "image": { "imageId": "string", "ec2AmiInfo": { "amiId": "string" }, "region": "string", "version": "string", "cloudformationStackArn": "string", "imageBuildStatus": "DELETE_IN_PROGRESS", "cloudformationStackStatus": "DELETE_IN_PROGRESS" } }
レスポンス本文
- 画像
-
- cloudformationStackArn
-
メイン CloudFormation スタックの Amazon リソースネーム (ARN)。
タイプ: 文字列
- cloudformationStackStatus
-
CloudFormation スタックの状態。
タイプ: 文字列
有効な値:
CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE - ec2AmiInfo
-
- amiId
-
Amazon EC2 AMI ID。
タイプ: 文字列
- imageBuildStatus
-
イメージビルドのステータス。
タイプ: 文字列
有効な値:
BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE - imageId
-
イメージの ID。
タイプ: 文字列
- region
-
イメージが作成された AWS リージョン。
タイプ: 文字列
- version
-
イメージのビルドに使用された AWS ParallelCluster バージョン。
タイプ: 文字列
例
