delete-object

Prev Next

Classic/VPC環境で利用できます。

Ncloud Storageに保存したオブジェクトを削除します。

コマンド

コマンド構文は次の通りです。

aws s3api delete-object --bucket <value> --key <value> [--options]
参考

削除対象オブジェクトが保存されているバケットのバージョン管理設定状態に応じて動作が異なる場合があります。

  • バケットにバージョン管理が設定されていない場合、オブジェクトは完全に削除されます。
  • バージョン管理が有効になっている場合、オブジェクトに削除マーカーが挿入され、このバージョンがオブジェクトの最新バージョンになります。オブジェクトを完全に削除したい場合は、バージョン idを指定してオブジェクトを削除してください。
  • バージョン管理が一時停止されている場合、バージョン表示を指定せずにコマンドを呼び出すとバージョン IDが NULLのオブジェクトのみ削除できます。バージョン IDがあるオブジェクトが現在のバージョンの場合、バージョン IDが NULLの削除マーカーを挿入し、この削除マーカーがオブジェクトの現在のバージョンになります。オブジェクトの特定のバージョンを削除したい場合、バージョン IDを指定するとそのバージョンを削除できます。

パラメータ

パラメータの説明は次の通りです。

パラメータ タイプ 必須の有無 説明 制限事項
--bucket <value> string Y オブジェクトが保存されているバケットの名前 -
--key <value> string Y 削除対象オブジェクトの名前(key値) -
--endpoint-url <value> string Y コマンド呼び出しのデフォルト URLを指定 krリージョンのみ対応、呼び出しドメイン情報はNcloud Storageの概要を参照
--version-id <value> string N バージョン管理が適用されたバケットから特定のバージョンのオブジェクトを削除する場合、バージョン IDを指定 -
--cli-input-json | --cli-input-yaml string N 提供した jsonまたは yaml文字列で引数を入力 jsonと yamlは一緒に指定できない
--generate-cli-skeleton <value> integer N APIコマンドを実行せずに、後に inputとして使用できるパラメータテンプレートを作成 -
--debug boolean N デバッグロギングを使用 -
--no-verify-ssl boolean N SSL証明書を検証する基本動作を再定義 -
--no-paginate boolean N 自動 pagination無効化、結果に対して最初のページが一度だけ呼び出される -
--output <value> string N レスポンスの形式を指定 選択可能なオプション
  • json
  • text
  • table
  • yaml
  • yaml-stream
--query <value> string N レスポンスデータの絞り込みに使用する JMESPathクエリ -
--profile <value> string N 認証情報ファイルで特定の profileを使用 -
--region <value> string N リージョンを指定 krのみ対応
--color <value> string N output color設定 選択可能なオプション
  • on
  • off
  • auto
--no-sign-request boolean N 認証情報のロードを無効化 -
--ca-bundle <value> string N SSL証明書の確認時に使用する CA証明書を指定 -
--cli-read-timeout <value> int N 最大読み取り時間、0を入力するとタイムアウトではなく、ブロック状態に変更される デフォルトは60秒に設定
--cli-connect-timeout <value> int N 最大接続時間、0を入力するとタイムアウトではなく、ブロック状態に変更される デフォルトは60秒に設定
--no-cli-pager boolean N レスポンスの cli pagerを無効化 -
--cli-auto-prompt boolean N CLI入力パラメータの自動プロンプト設定 -
--no-cli-auto-prompt boolean N CLI入力パラメータの自動プロンプトを無効化 -

権限

Sub Accountユーザーがこのコマンドを使用するには、Change/DeleteObjectアクションの権限が必要です。

delete-objectコマンドの呼び出し例とレスポンス例を説明します。

オブジェクトを削除

呼び出し例

オブジェクトが保存されているバケットとオブジェクト名を指定してコマンドを呼び出すと、オブジェクトを削除できます。呼び出しのサンプルコードは次の通りです。

aws s3api delete-object --bucket bucket-a --key img.png --endpoint-url=https://kr.ncloudstorage.com

関連コマンド

関連コマンドは次の通りです。