AWS Key Management Service API Reference API Version 2014-11-01 AWS Key Management Service API Reference AWS Key Management Service: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Key Management Service API Reference Table of Contents Welcome........................................................................................................................................... 1 Actions............................................................................................................................................. 3 CancelKeyDeletion...................................................................................................................... 5 Request Syntax.................................................................................................................. 5 Request Parameters............................................................................................................ 5 Response Syntax................................................................................................................ 5 Response Elements............................................................................................................. 6 Errors............................................................................................................................... 6 Examples........................................................................................................................... 7 See Also............................................................................................................................ 7 ConnectCustomKeyStore............................................................................................................. 8 Request Syntax.................................................................................................................. 9 Request Parameters............................................................................................................ 9 Response Elements............................................................................................................. 9 Errors............................................................................................................................... 9 See Also.......................................................................................................................... 11 CreateAlias.............................................................................................................................. 12 Request Syntax................................................................................................................ 12 Request Parameters.......................................................................................................... 12 Response Elements........................................................................................................... 13 Errors.............................................................................................................................. 13 Examples......................................................................................................................... 14 See Also.......................................................................................................................... 15 CreateCustomKeyStore.............................................................................................................. 16 Request Syntax................................................................................................................ 17 Request Parameters.......................................................................................................... 17 Response Syntax.............................................................................................................. 20 Response Elements........................................................................................................... 21 Errors.............................................................................................................................. 21 See Also.......................................................................................................................... 23 CreateGrant............................................................................................................................. 25 Request Syntax................................................................................................................ 25 Request Parameters.......................................................................................................... 26 Response Syntax.............................................................................................................. 28 Response Elements........................................................................................................... 28 Errors.............................................................................................................................. 29 Examples......................................................................................................................... 30 See Also.......................................................................................................................... 31 CreateKey................................................................................................................................ 32 Request Syntax................................................................................................................ 34 Request Parameters.......................................................................................................... 35 Response Syntax.............................................................................................................. 39 Response Elements........................................................................................................... 40 Errors.............................................................................................................................. 40 Examples......................................................................................................................... 42 See Also.......................................................................................................................... 43 Decrypt................................................................................................................................... 45 Request Syntax................................................................................................................ 46 Request Parameters.......................................................................................................... 46 Response Syntax.............................................................................................................. 47 Response Elements........................................................................................................... 48 Errors.............................................................................................................................. 48 Examples......................................................................................................................... 50 See Also.......................................................................................................................... 50 API Version 2014-11-01 iii AWS Key Management Service API Reference DeleteAlias.............................................................................................................................. 52 Request Syntax................................................................................................................ 52 Request Parameters.......................................................................................................... 52 Response Elements........................................................................................................... 53 Errors.............................................................................................................................. 53 Examples......................................................................................................................... 53 See Also.......................................................................................................................... 54 DeleteCustomKeyStore.............................................................................................................. 55 Request Syntax................................................................................................................ 55 Request Parameters.......................................................................................................... 55 Response Elements........................................................................................................... 56 Errors.............................................................................................................................. 56 See Also.......................................................................................................................... 57 DeleteImportedKeyMaterial ....................................................................................................... 58 Request Syntax................................................................................................................ 58 Request Parameters.......................................................................................................... 58 Response Elements........................................................................................................... 59 Errors.............................................................................................................................. 59 Examples......................................................................................................................... 60 See Also.......................................................................................................................... 60 DescribeCustomKeyStores.......................................................................................................... 61 Request Syntax................................................................................................................ 61 Request Parameters.......................................................................................................... 61 Response Syntax.............................................................................................................. 62 Response Elements........................................................................................................... 63 Errors.............................................................................................................................. 63 See Also.......................................................................................................................... 64 DescribeKey............................................................................................................................. 65 Request Syntax................................................................................................................ 65 Request Parameters.......................................................................................................... 66 Response Syntax.............................................................................................................. 66 Response Elements........................................................................................................... 67 Errors.............................................................................................................................. 67 Examples......................................................................................................................... 68 See Also.......................................................................................................................... 69 DisableKey............................................................................................................................... 70 Request Syntax................................................................................................................ 70 Request Parameters.......................................................................................................... 70 Response Elements........................................................................................................... 70 Errors.............................................................................................................................. 71 Examples......................................................................................................................... 71 See Also.......................................................................................................................... 72 DisableKeyRotation................................................................................................................... 73 Request Syntax................................................................................................................ 73 Request Parameters.......................................................................................................... 73 Response Elements........................................................................................................... 74 Errors.............................................................................................................................. 74 Examples......................................................................................................................... 75 See Also.......................................................................................................................... 75 DisconnectCustomKeyStore........................................................................................................ 77 Request Syntax................................................................................................................ 77 Request Parameters.......................................................................................................... 77 Response Elements........................................................................................................... 78 Errors.............................................................................................................................. 78 See Also.......................................................................................................................... 78 EnableKey............................................................................................................................... 80 Request Syntax................................................................................................................ 80 API Version 2014-11-01 iv AWS Key Management Service API Reference Request Parameters.......................................................................................................... 80 Response Elements........................................................................................................... 80 Errors.............................................................................................................................. 80 Examples......................................................................................................................... 81 See Also.......................................................................................................................... 82 EnableKeyRotation................................................................................................................... 83 Request Syntax................................................................................................................ 83 Request Parameters.......................................................................................................... 83 Response Elements........................................................................................................... 84 Errors.............................................................................................................................. 84 Examples......................................................................................................................... 85 See Also.......................................................................................................................... 85 Encrypt................................................................................................................................... 87 Request Syntax................................................................................................................ 88 Request Parameters.......................................................................................................... 88 Response Syntax.............................................................................................................. 89 Response Elements........................................................................................................... 90 Errors.............................................................................................................................. 90 Examples......................................................................................................................... 91 See Also.......................................................................................................................... 92 GenerateDataKey...................................................................................................................... 93 Request Syntax................................................................................................................ 94 Request Parameters.......................................................................................................... 94 Response Syntax.............................................................................................................. 96 Response Elements........................................................................................................... 96 Errors.............................................................................................................................. 96 Examples......................................................................................................................... 97 See Also.......................................................................................................................... 98 GenerateDataKeyPair................................................................................................................ 99 Request Syntax.............................................................................................................. 100 Request Parameters........................................................................................................ 100 Response Syntax............................................................................................................ 101 Response Elements......................................................................................................... 101 Errors............................................................................................................................ 102 See Also........................................................................................................................ 103 GenerateDataKeyPairWithoutPlaintext....................................................................................... 105 Request Syntax.............................................................................................................. 105 Request Parameters........................................................................................................ 106 Response Syntax............................................................................................................ 107 Response Elements......................................................................................................... 107 Errors............................................................................................................................ 108 See Also........................................................................................................................ 109 GenerateDataKeyWithoutPlaintext............................................................................................ 110 Request Syntax.............................................................................................................. 111 Request Parameters........................................................................................................ 111 Response Syntax............................................................................................................ 112 Response Elements......................................................................................................... 112 Errors............................................................................................................................ 113 Examples....................................................................................................................... 114 See Also........................................................................................................................ 115 GenerateMac.......................................................................................................................... 116 Request Syntax.............................................................................................................. 116 Request Parameters........................................................................................................ 116 Response Syntax............................................................................................................ 117 Response Elements......................................................................................................... 117 Errors............................................................................................................................ 118 See Also........................................................................................................................ 119 API Version 2014-11-01 v AWS Key Management Service API Reference GenerateRandom.................................................................................................................... 120 Request Syntax.............................................................................................................. 120 Request Parameters........................................................................................................ 120 Response Syntax............................................................................................................ 121 Response Elements......................................................................................................... 121 Errors............................................................................................................................ 121 Examples....................................................................................................................... 122 See Also........................................................................................................................ 123 GetKeyPolicy.......................................................................................................................... 124 Request Syntax.............................................................................................................. 124 Request Parameters........................................................................................................ 124 Response Syntax............................................................................................................ 125 Response Elements......................................................................................................... 125 Errors............................................................................................................................ 125 Examples....................................................................................................................... 126 See Also........................................................................................................................ 127 GetKeyRotationStatus............................................................................................................. 128 Request Syntax.............................................................................................................. 128 Request Parameters........................................................................................................ 129 Response Syntax............................................................................................................ 129 Response Elements......................................................................................................... 129 Errors............................................................................................................................ 129 Examples....................................................................................................................... 130 See Also........................................................................................................................ 131 GetParametersForImport......................................................................................................... 132 Request Syntax.............................................................................................................. 132 Request Parameters........................................................................................................ 132 Response Syntax............................................................................................................ 133 Response Elements......................................................................................................... 133 Errors............................................................................................................................ 134 Examples....................................................................................................................... 135 See Also........................................................................................................................ 136 GetPublicKey.......................................................................................................................... 137 Request Syntax.............................................................................................................. 137 Request Parameters........................................................................................................ 137 Response Syntax............................................................................................................ 138 Response Elements......................................................................................................... 138 Errors............................................................................................................................ 140 See Also........................................................................................................................ 141 ImportKeyMaterial .................................................................................................................. 143 Request Syntax.............................................................................................................. 143 Request Parameters........................................................................................................ 144 Response Elements......................................................................................................... 145 Errors............................................................................................................................ 145 Examples....................................................................................................................... 147 See Also........................................................................................................................ 148 ListAliases.............................................................................................................................. 149 Request Syntax.............................................................................................................. 149 Request Parameters........................................................................................................ 149 Response Syntax............................................................................................................ 150 Response Elements......................................................................................................... 150 Errors............................................................................................................................ 151 Examples....................................................................................................................... 151 See Also........................................................................................................................ 153 ListGrants.............................................................................................................................. 154 Request Syntax.............................................................................................................. 154 Request Parameters........................................................................................................ 154 API Version 2014-11-01 vi AWS Key Management Service API Reference Response Syntax............................................................................................................ 155 Response Elements......................................................................................................... 156 Errors............................................................................................................................ 156 Examples....................................................................................................................... 157 See Also........................................................................................................................ 159 ListKeyPolicies........................................................................................................................ 160 Request Syntax.............................................................................................................. 160 Request Parameters........................................................................................................ 160 Response Syntax............................................................................................................ 161 Response Elements......................................................................................................... 161 Errors............................................................................................................................ 162 Examples....................................................................................................................... 162 See Also........................................................................................................................ 163 ListKeys................................................................................................................................. 164 Request Syntax.............................................................................................................. 164 Request Parameters........................................................................................................ 164 Response Syntax............................................................................................................ 165 Response Elements......................................................................................................... 165 Errors............................................................................................................................ 165 Examples....................................................................................................................... 166 See Also........................................................................................................................ 167 ListResourceTags.................................................................................................................... 168 Request Syntax.............................................................................................................. 168 Request Parameters........................................................................................................ 168 Response Syntax............................................................................................................ 169 Response Elements......................................................................................................... 169 Errors............................................................................................................................ 170 Examples....................................................................................................................... 170 See Also........................................................................................................................ 171 ListRetirableGrants.................................................................................................................. 172 Request Syntax.............................................................................................................. 172 Request Parameters........................................................................................................ 172 Response Syntax............................................................................................................ 173 Response Elements......................................................................................................... 173 Errors............................................................................................................................ 174 Examples....................................................................................................................... 175 See Also........................................................................................................................ 175 PutKeyPolicy.......................................................................................................................... 177 Request Syntax.............................................................................................................. 177 Request Parameters........................................................................................................ 177 Response Elements......................................................................................................... 179 Errors............................................................................................................................ 179 Examples....................................................................................................................... 180 See Also........................................................................................................................ 181 ReEncrypt.............................................................................................................................. 183 Request Syntax.............................................................................................................. 184 Request Parameters........................................................................................................ 184 Response Syntax............................................................................................................ 187 Response Elements......................................................................................................... 187 Errors............................................................................................................................ 188 Examples....................................................................................................................... 189 See Also........................................................................................................................ 190 ReplicateKey.......................................................................................................................... 191 Request Syntax.............................................................................................................. 192 Request Parameters........................................................................................................ 192 Response Syntax............................................................................................................ 194 Response Elements......................................................................................................... 195 API Version 2014-11-01 vii AWS Key Management Service API Reference Errors............................................................................................................................ 196 See Also........................................................................................................................ 197 RetireGrant............................................................................................................................ 198 Request Syntax.............................................................................................................. 198 Request Parameters........................................................................................................ 198 Response Elements......................................................................................................... 199 Errors............................................................................................................................ 199 Examples....................................................................................................................... 200 See Also........................................................................................................................ 201 RevokeGrant.......................................................................................................................... 202 Request Syntax.............................................................................................................. 202 Request Parameters........................................................................................................ 202 Response Elements......................................................................................................... 203 Errors............................................................................................................................ 203 Examples....................................................................................................................... 204 See Also........................................................................................................................ 204 ScheduleKeyDeletion............................................................................................................... 206 Request Syntax.............................................................................................................. 206 Request Parameters........................................................................................................ 207 Response Syntax............................................................................................................ 207 Response Elements......................................................................................................... 207 Errors............................................................................................................................ 208 Examples....................................................................................................................... 209 See Also........................................................................................................................ 210 Sign...................................................................................................................................... 211 Request Syntax.............................................................................................................. 211 Request Parameters........................................................................................................ 212 Response Syntax............................................................................................................ 213 Response Elements......................................................................................................... 213 Errors............................................................................................................................ 214 See Also........................................................................................................................ 215 TagResource........................................................................................................................... 216 Request Syntax.............................................................................................................. 216 Request Parameters........................................................................................................ 216 Response Elements......................................................................................................... 217 Errors............................................................................................................................ 217 Examples....................................................................................................................... 218 See Also........................................................................................................................ 219 UntagResource....................................................................................................................... 220 Request Syntax.............................................................................................................. 220 Request Parameters........................................................................................................ 220 Response Elements......................................................................................................... 221 Errors............................................................................................................................ 221 Examples....................................................................................................................... 222 See Also........................................................................................................................ 222 UpdateAlias........................................................................................................................... 224 Request Syntax.............................................................................................................. 224 Request Parameters........................................................................................................ 224 Response Elements......................................................................................................... 225 Errors............................................................................................................................ 225 Examples....................................................................................................................... 226 See Also........................................................................................................................ 227 UpdateCustomKeyStore........................................................................................................... 228 Request Syntax.............................................................................................................. 229 Request Parameters........................................................................................................ 229 Response Elements......................................................................................................... 232 Errors............................................................................................................................ 232 API Version 2014-11-01 viii AWS Key Management Service API Reference See Also........................................................................................................................ 235 UpdateKeyDescription............................................................................................................. 236 Request Syntax.............................................................................................................. 236 Request Parameters........................................................................................................ 236 Response Elements......................................................................................................... 237 Errors............................................................................................................................ 237 Examples....................................................................................................................... 237 See Also........................................................................................................................ 238 UpdatePrimaryRegion............................................................................................................. 239 Request Syntax.............................................................................................................. 240 Request Parameters........................................................................................................ 240 Response Elements......................................................................................................... 240 Errors............................................................................................................................ 240 See Also........................................................................................................................ 241 Verify.................................................................................................................................... 243 Request Syntax.............................................................................................................. 243 Request Parameters........................................................................................................ 243 Response Syntax............................................................................................................ 245 Response Elements......................................................................................................... 245 Errors............................................................................................................................ 246 See Also........................................................................................................................ 247 VerifyMac.............................................................................................................................. 248 Request Syntax.............................................................................................................. 248 Request Parameters........................................................................................................ 248 Response Syntax............................................................................................................ 249 Response Elements......................................................................................................... 250 Errors............................................................................................................................ 250 See Also........................................................................................................................ 251 Data Types.................................................................................................................................... 253 AliasListEntry......................................................................................................................... 254 Contents........................................................................................................................ 254 See Also........................................................................................................................ 254 CustomKeyStoresListEntry....................................................................................................... 256 Contents........................................................................................................................ 256 See Also........................................................................................................................ 259 GrantConstraints.................................................................................................................... 260 Contents........................................................................................................................ 260 See Also........................................................................................................................ 260 GrantListEntry........................................................................................................................ 261 Contents........................................................................................................................ 261 See Also........................................................................................................................ 262 KeyListEntry........................................................................................................................... 263 Contents........................................................................................................................ 263 See Also........................................................................................................................ 263 KeyMetadata.......................................................................................................................... 264 Contents........................................................................................................................ 264 See Also........................................................................................................................ 268 MultiRegionConfiguration........................................................................................................ 269 Contents........................................................................................................................ 269 See Also........................................................................................................................ 269 MultiRegionKey...................................................................................................................... 270 Contents........................................................................................................................ 270 See Also........................................................................................................................ 270 Tag ....................................................................................................................................... 271 Contents........................................................................................................................ 271 See Also........................................................................................................................ 271 XksKeyConfigurationType........................................................................................................ 272 API Version 2014-11-01 ix AWS Key Management Service API Reference Contents........................................................................................................................ 272 See Also........................................................................................................................ 272 XksProxyAuthenticationCredentialType...................................................................................... 273 Contents........................................................................................................................ 273 See Also........................................................................................................................ 273 XksProxyConfigurationType...................................................................................................... 274 Contents........................................................................................................................ 274 See Also........................................................................................................................ 275 Common Parameters...................................................................................................................... 276 Common Errors.............................................................................................................................. 278 API Version 2014-11-01 x
Description: