This API allows you to enable a CMK. Only an enabled CMK can be used.
Only a disabled CMK can be enabled.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key_id |
Yes |
String |
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$ Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f |
sequence |
No |
String |
36-byte serial number of a request message Example: 919c82d4-8046-4722-9094-35c3c6524cff |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key_info |
Yes |
Array of objects |
Information about keys. For details, see Table 4. |
The following example describes how to enable a CMK whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.
{ "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f" }
{ "key_info": { "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "key_state": "2" } }
{ "error": { "error_code": "KMS.XXXX", "error_msg": "XXX" } }
Exception status code. For details, see Status Codes.