CreatePublicKey
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
Request Syntax
POST /2020-05-31/public-key HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<PublicKeyConfig xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/">
<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 string included in the request to help make sure that the request can't be replayed.
Type: String
Required: Yes
- Comment
-
A comment to describe the public key. The comment cannot be longer than 128 characters.
Type: String
Required: No
- EncodedKey
-
The public key that you can use with signed URLs and signed cookies, or with field-level encryption.
Type: String
Required: Yes
- Name
-
A name to help identify the public key.
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
-
The date and time when the public key was uploaded.
Type: Timestamp
- Id
-
The identifier of the public key.
Type: String
- PublicKeyConfig
-
Configuration information about a public key that you can use with signed URLs and signed cookies, or with field-level encryption.
Type: PublicKeyConfig object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidArgument
-
An 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:
