This is the multi-page printable view of this section. Click here to print.
Update Description
1 - 1.3
scp-cli kms kms update description
--key_id <value>
--description <value>
Description
Update description.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | Resource id of KMS key | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| description required | string | Description of Key | - |
2 - 1.2
scp-cli kms kms update description
--key_id <value>
--description <value>
Description
Update description.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | Resource id of KMS key | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| description required | string | Description of Key | - |
3 - 1.1
scp-cli kms kms update description
--key_id <value>
--description <value>
Description
Update description.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | Resource id of KMS key | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| description required | string | Description of Key | - |
4 - 1.0
scp-cli kms kms update description
--key_id <value>
--description <value>
Description
Update description.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | Resource id of KMS key | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| description required | string | Description of Key | - |