delete-object

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

Ncloud Storageバケットに保存されているオブジェクトを削除します。

参考

Sub Accountユーザーがこのコマンドを実行するには、Change/DeleteObjectアクションの権限が必要です。GOVERNANCEモードのリテンションをバイパスして削除する場合(--bypass-governance-retention)、Change/BypassGovernanceRetentionアクションの権限が追加で必要になります。

構文

delete-object構文は次の通りです。

aws s3api delete-object \
    --bucket <bucket> \
    --key <key> \
    [--version-id <version-id>] \
    [--bypass-governance-retention | --no-bypass-governance-retention] \
    --endpoint-url <endpoint-url>

参考

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

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

オプション

delete-objectの実行時に指定できるオプションについて説明します。

必須オプション

delete-objectの必須オプションです。

オプション	タイプ	必須の有無	説明
`--bucket`	String	Required	バケット名
`--key`	String	Required	オブジェクト名

任意オプション

delete-objectの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション	タイプ	必須の有無	説明
`--version-id`	String	Optional	オブジェクトのバージョン ID バージョン管理が適用されたバケットで特定のバージョンのオブジェクトを削除する場合
`--bypass-governance-retention`	Boolean	Optional	`GOVERNANCE`モードリテンション設定のバイパス `GOVERNANCE`リテンションが設定されたオブジェクトバージョンを削除する際に使用バイパス権限が必要
`--no-bypass-governance-retention`	Boolean	Optional	`GOVERNANCE`モードリテンション設定をバイパスしない

共通オプション

awsコマンドで共通して使用するオプションについては、Ncloud Storageのオプションをご参照ください。

例

オブジェクトの削除リクエストが成功すると、オブジェクトが削除され、結果は出力されません。

コマンド

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

aws s3api delete-object --bucket my-test-bucket \
    --key img/copy.png \
    --endpoint-url=https://kr.ncloudstorage.com