reset_token_vault_key_material¶
Operation¶
reset_token_vault_key_material
¶
reset_token_vault_key_material(request: ResetTokenVaultKeyMaterialInput | ResetTokenVaultKeyMaterialInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ResetTokenVaultKeyMaterialInputDict]) -> ResetTokenVaultKeyMaterialOutput
Resets the key material for a token vault whose customer managed KMS key has been deleted, and re-encrypts the token vault with an Amazon Web Services managed key so that you can use the token vault again.
Warning
This operation can't be undone. The reset permanently deletes the OAuth2 access tokens and refresh tokens stored in the token vault, including tokens obtained through all supported flows. After the reset, your agents must complete these flows again to get new tokens, and for user-delegated flows your users must authorize access again. The reset doesn't delete your credential providers or their configuration.
You can reset a token vault only if its customer managed key has been
deleted. If the key still exists, including when it's disabled or
scheduled for deletion, this operation returns a ValidationException.
To use the token vault again, enable the key or cancel its scheduled
deletion in KMS. To switch to a different key, use SetTokenVaultCMK.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ResetTokenVaultKeyMaterialInput | ResetTokenVaultKeyMaterialInputDict | 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[ResetTokenVaultKeyMaterialInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ResetTokenVaultKeyMaterialOutput
|
An instance of |
reset_token_vault_key_material
async
¶
reset_token_vault_key_material(request: ResetTokenVaultKeyMaterialInput | ResetTokenVaultKeyMaterialInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ResetTokenVaultKeyMaterialInputDict]) -> ResetTokenVaultKeyMaterialOutput
Resets the key material for a token vault whose customer managed KMS key has been deleted, and re-encrypts the token vault with an Amazon Web Services managed key so that you can use the token vault again.
Warning
This operation can't be undone. The reset permanently deletes the OAuth2 access tokens and refresh tokens stored in the token vault, including tokens obtained through all supported flows. After the reset, your agents must complete these flows again to get new tokens, and for user-delegated flows your users must authorize access again. The reset doesn't delete your credential providers or their configuration.
You can reset a token vault only if its customer managed key has been
deleted. If the key still exists, including when it's disabled or
scheduled for deletion, this operation returns a ValidationException.
To use the token vault again, enable the key or cancel its scheduled
deletion in KMS. To switch to a different key, use SetTokenVaultCMK.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ResetTokenVaultKeyMaterialInput | ResetTokenVaultKeyMaterialInputDict | 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[ResetTokenVaultKeyMaterialInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ResetTokenVaultKeyMaterialOutput
|
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.
ResetTokenVaultKeyMaterialInput
dataclass
¶
Output¶
ResetTokenVaultKeyMaterialOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ResetTokenVaultKeyMaterialOutput structure.
Attributes¶
kms_configuration
instance-attribute
¶
kms_configuration: KmsConfiguration
The KMS configuration for the token vault after the reset. The token vault uses an Amazon Web Services managed key.
last_modified_date
instance-attribute
¶
last_modified_date: datetime
The timestamp when the token vault was last modified.
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.