get_key_group¶
Operation¶
get_key_group
¶
get_key_group(request: GetKeyGroupInput | GetKeyGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetKeyGroupInputDict]) -> 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 |
|---|---|---|---|
request
|
GetKeyGroupInput | GetKeyGroupInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetKeyGroupInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetKeyGroupOutput
|
An instance of |
get_key_group
async
¶
get_key_group(request: GetKeyGroupInput | GetKeyGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetKeyGroupInputDict]) -> 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 |
|---|---|---|---|
request
|
GetKeyGroupInput | GetKeyGroupInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetKeyGroupInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetKeyGroupOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
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.
response_metadata
class-attribute
instance-attribute
¶
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.