Skip to content

CloudFront  >  Operations  >  get_key_group_config

get_key_group_config

Operation

get_key_group_config async 

get_key_group_config(input: GetKeyGroupConfigInput, plugins: list[Plugin] | None = None) -> GetKeyGroupConfigOutput

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.

Parameters:

Name Type Description Default
input GetKeyGroupConfigInput

An instance of GetKeyGroupConfigInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetKeyGroupConfigOutput

An instance of GetKeyGroupConfigOutput.

Input

GetKeyGroupConfigInput dataclass

Bases: _SerdeShape

Dataclass for GetKeyGroupConfigInput structure.

Attributes

id class-attribute instance-attribute 
id: str | None = ...

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

Output

GetKeyGroupConfigOutput dataclass

Bases: _SerdeShape

Dataclass for GetKeyGroupConfigOutput structure.

Attributes

e_tag class-attribute instance-attribute 
e_tag: str | None = ...

The identifier for this version of the key group.

key_group_config class-attribute instance-attribute 
key_group_config: KeyGroupConfig | None = ...

The key group configuration.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.