Cloud Keys 2020 Python Edition

Questions / Feedback?

key_state Property

The CMK's state.

Syntax

def get_key_state(key_index: int) -> int: ...

Default Value

0

Remarks

The CMK's state.

This property reflects the CMK's state. Possible values are:

  • aksEnabled (0): The CMK is enabled and ready for use. (Also the default value used when list_keys is called.)
  • aksDisabled (1): The CMK is disabled and cannot be used until it is enabled again.
  • aksPendingDeletion (2): The CMK is pending deletion and cannot be used unless the deletion is canceled.
  • aksPendingImport (3): The CMK has been created, but external key material has not yet been imported into it, so it cannot be used.
  • aksUnavailable (4): The CMK is currently unavailable because the CloudHSM cluster that contains its key material has been disconnected from Amazon KMS.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 Python Edition - Version 20.0 [Build 8157]