GetKeyGroupConfig - Amazon CloudFront

GetKeyGroupConfig

Gets a key group configuration.

To get a key group configuration, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.

Request Syntax

GET /2020-05-31/key-group/Id/config HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id

The identifier of the key group whose configuration you are getting. To get the identifier, use ListKeyGroups.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

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

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.

KeyGroupConfig

Root level tag for the KeyGroupConfig parameters.

Required: Yes

Comment

A comment to describe the key group. The comment cannot be longer than 128 characters.

Type: String

Items

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

Type: Array of strings

Name

A name to identify the key group.

Type: String

Errors

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

NoSuchResource

A resource that was specified is not valid.

HTTP Status Code: 404

See Also

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