CreatePublicKey
Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.
Request Syntax
POST /2018-06-18/public-key HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <PublicKeyConfig xmlns="http://cloudfront.amazonaws.com/doc/2018-06-18/"> <CallerReference>string</CallerReference> <Comment>string</Comment> <EncodedKey>string</EncodedKey> <Name>string</Name> </PublicKeyConfig>
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in XML format.
- PublicKeyConfig
-
Root level tag for the PublicKeyConfig parameters.
Required: Yes
- CallerReference
-
A unique number that ensures the request can't be replayed.
Type: String
Required: Yes
- Comment
-
An optional comment about a public key.
Type: String
Required: No
- EncodedKey
-
The encoded public key that you want to add to CloudFront to use with features like field-level encryption.
Type: String
Required: Yes
- Name
-
The name for a public key you add to CloudFront to use with features like field-level encryption.
Type: String
Required: Yes
Response Syntax
HTTP/1.1 201 <?xml version="1.0" encoding="UTF-8"?> <PublicKey> <CreatedTime>timestamp</CreatedTime> <Id>string</Id> <PublicKeyConfig> <CallerReference>string</CallerReference> <Comment>string</Comment> <EncodedKey>string</EncodedKey> <Name>string</Name> </PublicKeyConfig> </PublicKey>
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in XML format by the service.
- PublicKey
-
Root level tag for the PublicKey parameters.
Required: Yes
- CreatedTime
-
A time you added a public key to CloudFront.
Type: Timestamp
- Id
-
A unique ID assigned to a public key you've added to CloudFront.
Type: String
- PublicKeyConfig
-
A complex data type for a public key you add to CloudFront to use with features like field-level encryption.
Type: PublicKeyConfig object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidArgument
-
The argument is invalid.
HTTP Status Code: 400
- PublicKeyAlreadyExists
-
The specified public key already exists.
HTTP Status Code: 409
- TooManyPublicKeys
-
The maximum number of public keys for field-level encryption have been created. To create a new public key, delete one of the existing keys.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
