UpdateKeyGroup - Amazon CloudFront

UpdateKeyGroup

Updates a key group.

When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:

  1. Get the current key group with GetKeyGroup or GetKeyGroupConfig.

  2. Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.

  3. Call UpdateKeyGroup with the entire key group object, including the fields that you modified and those that you didn’t.

Request Syntax

PUT /2020-05-31/key-group/Id HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <KeyGroupConfig xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/"> <Comment>string</Comment> <Items> <PublicKey>string</PublicKey> </Items> <Name>string</Name> </KeyGroupConfig>

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in XML format.

KeyGroupConfig

Root level tag for the KeyGroupConfig parameters.

Required: Yes

Comment

A comment to describe the key group.

Type: String

Required: No

Items

A list of the identifiers of the public keys in the key group.

Type: Array of strings

Required: Yes

Name

A name to identify the key group.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <KeyGroup> <Id>string</Id> <KeyGroupConfig> <Comment>string</Comment> <Items> <PublicKey>string</PublicKey> </Items> <Name>string</Name> </KeyGroupConfig> <LastModifiedTime>timestamp</LastModifiedTime> </KeyGroup>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

KeyGroup

Root level tag for the KeyGroup parameters.

Required: Yes

Id

The identifier for the key group.

Type: String

KeyGroupConfig

The key group configuration.

Type: KeyGroupConfig object

LastModifiedTime

The date and time when the key group was last modified.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidArgument

An argument is invalid.

HTTP Status Code: 400

InvalidIfMatchVersion

The If-Match version is missing or not valid.

HTTP Status Code: 400

KeyGroupAlreadyExists

A key group with this name already exists. You must provide a unique name. To modify an existing key group, use UpdateKeyGroup.

HTTP Status Code: 409

NoSuchResource

A resource that was specified is not valid.

HTTP Status Code: 404

PreconditionFailed

The precondition given in one or more of the request header fields evaluated to false.

HTTP Status Code: 412

TooManyPublicKeysInKeyGroup

The number of public keys in this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: