{ "version": "2.0", "metadata": { "apiVersion": "2014-11-01", "endpointPrefix": "kms", "jsonVersion": "1.1", "protocol": "json", "serviceAbbreviation": "KMS", "serviceFullName": "AWS Key Management Service", "serviceId": "KMS", "signatureVersion": "v4", "targetPrefix": "TrentService", "uid": "kms-2014-11-01" }, "operations": { "CancelKeyDeletion": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {} } }, "output": { "type": "structure", "members": { "KeyId": {} } } }, "ConnectCustomKeyStore": { "input": { "type": "structure", "required": [ "CustomKeyStoreId" ], "members": { "CustomKeyStoreId": {} } }, "output": { "type": "structure", "members": {} } }, "CreateAlias": { "input": { "type": "structure", "required": [ "AliasName", "TargetKeyId" ], "members": { "AliasName": {}, "TargetKeyId": {} } } }, "CreateCustomKeyStore": { "input": { "type": "structure", "required": [ "CustomKeyStoreName", "CloudHsmClusterId", "TrustAnchorCertificate", "KeyStorePassword" ], "members": { "CustomKeyStoreName": {}, "CloudHsmClusterId": {}, "TrustAnchorCertificate": {}, "KeyStorePassword": { "shape": "Sd" } } }, "output": { "type": "structure", "members": { "CustomKeyStoreId": {} } } }, "CreateGrant": { "input": { "type": "structure", "required": [ "KeyId", "GranteePrincipal", "Operations" ], "members": { "KeyId": {}, "GranteePrincipal": {}, "RetiringPrincipal": {}, "Operations": { "shape": "Sh" }, "Constraints": { "shape": "Sj" }, "GrantTokens": { "shape": "Sn" }, "Name": {} } }, "output": { "type": "structure", "members": { "GrantToken": {}, "GrantId": {} } } }, "CreateKey": { "input": { "type": "structure", "members": { "Policy": {}, "Description": {}, "KeyUsage": {}, "Origin": {}, "CustomKeyStoreId": {}, "BypassPolicyLockoutSafetyCheck": { "type": "boolean" }, "Tags": { "shape": "Sy" } } }, "output": { "type": "structure", "members": { "KeyMetadata": { "shape": "S13" } } } }, "Decrypt": { "input": { "type": "structure", "required": [ "CiphertextBlob" ], "members": { "CiphertextBlob": { "type": "blob" }, "EncryptionContext": { "shape": "Sk" }, "GrantTokens": { "shape": "Sn" } } }, "output": { "type": "structure", "members": { "KeyId": {}, "Plaintext": { "shape": "S1d" } } } }, "DeleteAlias": { "input": { "type": "structure", "required": [ "AliasName" ], "members": { "AliasName": {} } } }, "DeleteCustomKeyStore": { "input": { "type": "structure", "required": [ "CustomKeyStoreId" ], "members": { "CustomKeyStoreId": {} } }, "output": { "type": "structure", "members": {} } }, "DeleteImportedKeyMaterial": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {} } } }, "DescribeCustomKeyStores": { "input": { "type": "structure", "members": { "CustomKeyStoreId": {}, "CustomKeyStoreName": {}, "Limit": { "type": "integer" }, "Marker": {} } }, "output": { "type": "structure", "members": { "CustomKeyStores": { "type": "list", "member": { "type": "structure", "members": { "CustomKeyStoreId": {}, "CustomKeyStoreName": {}, "CloudHsmClusterId": {}, "TrustAnchorCertificate": {}, "ConnectionState": {}, "ConnectionErrorCode": {}, "CreationDate": { "type": "timestamp" } } } }, "NextMarker": {}, "Truncated": { "type": "boolean" } } } }, "DescribeKey": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {}, "GrantTokens": { "shape": "Sn" } } }, "output": { "type": "structure", "members": { "KeyMetadata": { "shape": "S13" } } } }, "DisableKey": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {} } } }, "DisableKeyRotation": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {} } } }, "DisconnectCustomKeyStore": { "input": { "type": "structure", "required": [ "CustomKeyStoreId" ], "members": { "CustomKeyStoreId": {} } }, "output": { "type": "structure", "members": {} } }, "EnableKey": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {} } } }, "EnableKeyRotation": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {} } } }, "Encrypt": { "input": { "type": "structure", "required": [ "KeyId", "Plaintext" ], "members": { "KeyId": {}, "Plaintext": { "shape": "S1d" }, "EncryptionContext": { "shape": "Sk" }, "GrantTokens": { "shape": "Sn" } } }, "output": { "type": "structure", "members": { "CiphertextBlob": { "type": "blob" }, "KeyId": {} } } }, "GenerateDataKey": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {}, "EncryptionContext": { "shape": "Sk" }, "NumberOfBytes": { "type": "integer" }, "KeySpec": {}, "GrantTokens": { "shape": "Sn" } } }, "output": { "type": "structure", "members": { "CiphertextBlob": { "type": "blob" }, "Plaintext": { "shape": "S1d" }, "KeyId": {} } } }, "GenerateDataKeyWithoutPlaintext": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {}, "EncryptionContext": { "shape": "Sk" }, "KeySpec": {}, "NumberOfBytes": { "type": "integer" }, "GrantTokens": { "shape": "Sn" } } }, "output": { "type": "structure", "members": { "CiphertextBlob": { "type": "blob" }, "KeyId": {} } } }, "GenerateRandom": { "input": { "type": "structure", "members": { "NumberOfBytes": { "type": "integer" }, "CustomKeyStoreId": {} } }, "output": { "type": "structure", "members": { "Plaintext": { "shape": "S1d" } } } }, "GetKeyPolicy": { "input": { "type": "structure", "required": [ "KeyId", "PolicyName" ], "members": { "KeyId": {}, "PolicyName": {} } }, "output": { "type": "structure", "members": { "Policy": {} } } }, "GetKeyRotationStatus": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {} } }, "output": { "type": "structure", "members": { "KeyRotationEnabled": { "type": "boolean" } } } }, "GetParametersForImport": { "input": { "type": "structure", "required": [ "KeyId", "WrappingAlgorithm", "WrappingKeySpec" ], "members": { "KeyId": {}, "WrappingAlgorithm": {}, "WrappingKeySpec": {} } }, "output": { "type": "structure", "members": { "KeyId": {}, "ImportToken": { "type": "blob" }, "PublicKey": { "shape": "S1d" }, "ParametersValidTo": { "type": "timestamp" } } } }, "ImportKeyMaterial": { "input": { "type": "structure", "required": [ "KeyId", "ImportToken", "EncryptedKeyMaterial" ], "members": { "KeyId": {}, "ImportToken": { "type": "blob" }, "EncryptedKeyMaterial": { "type": "blob" }, "ValidTo": { "type": "timestamp" }, "ExpirationModel": {} } }, "output": { "type": "structure", "members": {} } }, "ListAliases": { "input": { "type": "structure", "members": { "KeyId": {}, "Limit": { "type": "integer" }, "Marker": {} } }, "output": { "type": "structure", "members": { "Aliases": { "type": "list", "member": { "type": "structure", "members": { "AliasName": {}, "AliasArn": {}, "TargetKeyId": {} } } }, "NextMarker": {}, "Truncated": { "type": "boolean" } } } }, "ListGrants": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "Limit": { "type": "integer" }, "Marker": {}, "KeyId": {} } }, "output": { "shape": "S2o" } }, "ListKeyPolicies": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {}, "Limit": { "type": "integer" }, "Marker": {} } }, "output": { "type": "structure", "members": { "PolicyNames": { "type": "list", "member": {} }, "NextMarker": {}, "Truncated": { "type": "boolean" } } } }, "ListKeys": { "input": { "type": "structure", "members": { "Limit": { "type": "integer" }, "Marker": {} } }, "output": { "type": "structure", "members": { "Keys": { "type": "list", "member": { "type": "structure", "members": { "KeyId": {}, "KeyArn": {} } } }, "NextMarker": {}, "Truncated": { "type": "boolean" } } } }, "ListResourceTags": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {}, "Limit": { "type": "integer" }, "Marker": {} } }, "output": { "type": "structure", "members": { "Tags": { "shape": "Sy" }, "NextMarker": {}, "Truncated": { "type": "boolean" } } } }, "ListRetirableGrants": { "input": { "type": "structure", "required": [ "RetiringPrincipal" ], "members": { "Limit": { "type": "integer" }, "Marker": {}, "RetiringPrincipal": {} } }, "output": { "shape": "S2o" } }, "PutKeyPolicy": { "input": { "type": "structure", "required": [ "KeyId", "PolicyName", "Policy" ], "members": { "KeyId": {}, "PolicyName": {}, "Policy": {}, "BypassPolicyLockoutSafetyCheck": { "type": "boolean" } } } }, "ReEncrypt": { "input": { "type": "structure", "required": [ "CiphertextBlob", "DestinationKeyId" ], "members": { "CiphertextBlob": { "type": "blob" }, "SourceEncryptionContext": { "shape": "Sk" }, "DestinationKeyId": {}, "DestinationEncryptionContext": { "shape": "Sk" }, "GrantTokens": { "shape": "Sn" } } }, "output": { "type": "structure", "members": { "CiphertextBlob": { "type": "blob" }, "SourceKeyId": {}, "KeyId": {} } } }, "RetireGrant": { "input": { "type": "structure", "members": { "GrantToken": {}, "KeyId": {}, "GrantId": {} } } }, "RevokeGrant": { "input": { "type": "structure", "required": [ "KeyId", "GrantId" ], "members": { "KeyId": {}, "GrantId": {} } } }, "ScheduleKeyDeletion": { "input": { "type": "structure", "required": [ "KeyId" ], "members": { "KeyId": {}, "PendingWindowInDays": { "type": "integer" } } }, "output": { "type": "structure", "members": { "KeyId": {}, "DeletionDate": { "type": "timestamp" } } } }, "TagResource": { "input": { "type": "structure", "required": [ "KeyId", "Tags" ], "members": { "KeyId": {}, "Tags": { "shape": "Sy" } } } }, "UntagResource": { "input": { "type": "structure", "required": [ "KeyId", "TagKeys" ], "members": { "KeyId": {}, "TagKeys": { "type": "list", "member": {} } } } }, "UpdateAlias": { "input": { "type": "structure", "required": [ "AliasName", "TargetKeyId" ], "members": { "AliasName": {}, "TargetKeyId": {} } } }, "UpdateCustomKeyStore": { "input": { "type": "structure", "required": [ "CustomKeyStoreId" ], "members": { "CustomKeyStoreId": {}, "NewCustomKeyStoreName": {}, "KeyStorePassword": { "shape": "Sd" }, "CloudHsmClusterId": {} } }, "output": { "type": "structure", "members": {} } }, "UpdateKeyDescription": { "input": { "type": "structure", "required": [ "KeyId", "Description" ], "members": { "KeyId": {}, "Description": {} } } } }, "shapes": { "Sd": { "type": "string", "sensitive": true }, "Sh": { "type": "list", "member": {} }, "Sj": { "type": "structure", "members": { "EncryptionContextSubset": { "shape": "Sk" }, "EncryptionContextEquals": { "shape": "Sk" } } }, "Sk": { "type": "map", "key": {}, "value": {} }, "Sn": { "type": "list", "member": {} }, "Sy": { "type": "list", "member": { "type": "structure", "required": [ "TagKey", "TagValue" ], "members": { "TagKey": {}, "TagValue": {} } } }, "S13": { "type": "structure", "required": [ "KeyId" ], "members": { "AWSAccountId": {}, "KeyId": {}, "Arn": {}, "CreationDate": { "type": "timestamp" }, "Enabled": { "type": "boolean" }, "Description": {}, "KeyUsage": {}, "KeyState": {}, "DeletionDate": { "type": "timestamp" }, "ValidTo": { "type": "timestamp" }, "Origin": {}, "CustomKeyStoreId": {}, "CloudHsmClusterId": {}, "ExpirationModel": {}, "KeyManager": {} } }, "S1d": { "type": "blob", "sensitive": true }, "S2o": { "type": "structure", "members": { "Grants": { "type": "list", "member": { "type": "structure", "members": { "KeyId": {}, "GrantId": {}, "Name": {}, "CreationDate": { "type": "timestamp" }, "GranteePrincipal": {}, "RetiringPrincipal": {}, "IssuingAccount": {}, "Operations": { "shape": "Sh" }, "Constraints": { "shape": "Sj" } } } }, "NextMarker": {}, "Truncated": { "type": "boolean" } } } } }