Skip to content

update_key_group

Operation

update_key_group

update_key_group(request: UpdateKeyGroupInput | UpdateKeyGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateKeyGroupInputDict]) -> UpdateKeyGroupOutput

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.

Parameters:

Name Type Description Default
request UpdateKeyGroupInput | UpdateKeyGroupInputDict | 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[UpdateKeyGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateKeyGroupOutput

An instance of UpdateKeyGroupOutput.

update_key_group async

update_key_group(request: UpdateKeyGroupInput | UpdateKeyGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateKeyGroupInputDict]) -> UpdateKeyGroupOutput

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.

Parameters:

Name Type Description Default
request UpdateKeyGroupInput | UpdateKeyGroupInputDict | 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[UpdateKeyGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateKeyGroupOutput

An instance of UpdateKeyGroupOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateKeyGroupInputDict

Bases: TypedDict

Dictionary form of UpdateKeyGroupInput.

Attributes

id instance-attribute

The identifier of the key group that you are updating.

if_match instance-attribute
if_match: str | None

The version of the key group that you are updating. The version is the key group's ETag value.

key_group_config instance-attribute

The key group configuration.

UpdateKeyGroupInput dataclass

Bases: _SerdeShape

Dataclass for UpdateKeyGroupInput structure.

Attributes

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

The identifier of the key group that you are updating.

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

The version of the key group that you are updating. The version is the key group's ETag value.

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

The key group configuration.

Output

UpdateKeyGroupOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateKeyGroupOutput 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 that was just updated.

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.