Skip to content

CloudFront  >  Operations  >  get_key_group

get_key_group

Operation

get_key_group async 

get_key_group(input: GetKeyGroupInput, plugins: list[Plugin] | None = None) -> GetKeyGroupOutput

Gets a key group, including the date and time when the key group was last modified.

To get a key group, 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 GetKeyGroupInput

An instance of GetKeyGroupInput.

 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
GetKeyGroupOutput

An instance of GetKeyGroupOutput.

Input

GetKeyGroupInput dataclass

Bases: _SerdeShape

Dataclass for GetKeyGroupInput structure.

Attributes

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

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

Output

GetKeyGroupOutput dataclass

Bases: _SerdeShape

Dataclass for GetKeyGroupOutput structure.

Attributes

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

The identifier for this version of the key group.

key_group class-attribute instance-attribute 
key_group: KeyGroup | None = ...

The key group.

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.