version_state Property
The key version's state.
Syntax
def get_version_state(version_index: int) -> str: ...
Default Value
""
Remarks
The key version's state.
This property reflects the key version's state. Possible values are:
- PENDING_GENERATION: The version is still being generated, and cannot be used yet. Once generation has finished, it will become ENABLED.
- ENABLED: The version is enabled and available for use.
- DISABLED: The version is disabled; it cannot be used unless it is enabled again. It may be destroyed.
- DESTROY_SCHEDULED: The version's cryptographic material is scheduled for destruction, and will be destroyed at the time reflected by version_destruction_date unless cancel_destruction before then.
- DESTROYED: The version's cryptographic material has been destroyed, and the version is no longer usable. This state is permanent once entered.
- PENDING_IMPORT*: Cryptographic material has not finished importing, and the version cannot be used yet. Once the import has finished, it will become ENABLED.
- IMPORT_FAILED*: The version was not imported successfully; it cannot be used, and any imported cryptographic material has been discarded.
The version_index parameter specifies the index of the item in the array. The size of the array is controlled by the version_count property.
This property is read-only.