CMEK

Customer Managed Encryption Keys

List CMEKs

List customer managed encryption keys

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter CMEKs returned in the response.

Show Child Parameters

Response

200 application/json

Response for CMEK listing

ListCMEKs

dataarray[object]required
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
get/cmeks
 
200 application/json

Get a CMEK

Get a customer managed encryption key

get

Path Parameters

cmekIdstringrequired

Id of the CMEK

Allowed values:default

Default:default

Example:default

Response

application/json

Response for CMEK

CMEK

idstringrequired
key_arnstringrequired

The ARN of the KMS key to use for encryption

Example:arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

namestringrequired
descriptionstring
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/cmeks/{cmekId}
 
application/json

Replace a CMEK

Replace a customer managed encryption key

put

Path Parameters

cmekIdstringrequired

Id of the CMEK

Allowed values:default

Default:default

Example:default

Body

application/json

Request body schema for putting a CMEK.

key_arnstringrequired

The ARN of the KMS key to use for encryption

Example:arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

namestringrequired

>= 1 characters

descriptionstring

Response

application/json

Response for CMEK

CMEK

idstringrequired
key_arnstringrequired

The ARN of the KMS key to use for encryption

Example:arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

namestringrequired
descriptionstring
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/cmeks/{cmekId}

Body

{ "name": "My KMS Key", "description": "My Key Description", "key_arn": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012" }
 
application/json

Delete a CMEK

Delete a customer managed encryption key

delete

Path Parameters

cmekIdstringrequired

Id of the CMEK

Allowed values:default

Default:default

Example:default

Response

Success

delete/cmeks/{cmekId}