---
title: "put-object-retention"
slug: "put-object-retention"
updated: 2026-10-08T09:49:32Z
published: 2026-10-08T09:49:32Z
canonical: "cli.ncloud-docs.com/put-object-retention"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# put-object-retention

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

Ncloud Storageオブジェクトにリテンション設定を適用します。リテンションが設定されたオブジェクトは、指定された期限まで削除または変更することはできません。

              参考

              

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

## 構文

`put-object-retention`構文は次の通りです。

```
aws s3api put-object-retention \
    --bucket <bucket> \
    --key <key> \
    --retention <retention> \
    [--version-id <version-id>] \
    [--bypass-governance-retention | --no-bypass-governance-retention] \
    [--content-md5 <content-md5>] \
    [--checksum-algorithm <checksum-algorithm>] \
    --endpoint-url <endpoint-url>
```

## オプション

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

### 必須オプション

`put-object-retention`の必須オプションです。

| オプション | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `--bucket` | String | Required | バケット名 |
| `--key` | String | Required | オブジェクト名 |
| `--retention` | String | Required | オブジェクトのリテンション設定 - JSON形式で入力 - `Mode`: `GOVERNANCE` \| `COMPLIANCE` - `RetainUntilDate`: リテンション期限。ISO 8601形式、未来の日時のみ指定可能 - 空の JSON(`{}`)入力時、リテンションを解除 |

### 任意オプション

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

| オプション | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `--version-id` | String | Optional | オブジェクトバージョン ID |
| `--bypass-governance-retention` | Boolean | Optional | `GOVERNANCE`モードリテンション設定のバイパス - バイパス権限が必要 |
| `--no-bypass-governance-retention` | Boolean | Optional | `GOVERNANCE`モードリテンション設定をバイパスしない |
| `--content-md5` | String | Optional | リクエストデータの Base64エンコードされた128ビット MD5ハッシュ値 - リクエストデータの整合性検証に使用 - 未入力の場合、自動計算 |
| `--checksum-algorithm` | String | Optional | リクエストデータ検証に使用するチェックサムアルゴリズム - `CRC32` \| `CRC32C` \| `SHA1` \| `SHA256` \| `CRC64NVME` |

### 共通オプション

`aws`コマンドで共通して使用するオプションについては、[Ncloud Storageのオプション](/docs/ja/storage-ncloudstorage#%EC%98%B5%EC%85%98)をご参照ください。

## 例

リテンションの設定リクエストが成功すると、設定が適用され、結果は出力されません。

### コマンド

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

```
aws s3api put-object-retention --bucket my-locked-bucket \
    --key locked.txt \
    --retention '{"Mode":"GOVERNANCE","RetainUntilDate":"2026-08-25T00:00:00Z"}' \
    --endpoint-url=https://kr.ncloudstorage.com
```

## 関連コマンド

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

- [put-object-lock-configuration](/docs/ja/put-object-lock-configuration)
- [get-object-lock-configuration](/docs/ja/get-object-lock-configuration)
- [get-object-retention](/docs/ja/get-object-retention)
- [put-object-legal-hold](/docs/ja/put-object-legal-hold)
- [get-object-legal-hold](/docs/ja/get-object-legal-hold)