# {py:mod}`scullery.kms`

```{py:module} scullery.kms
```

```{autodoc2-docstring} scullery.kms
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Kms <scullery.kms.Kms>`
  - ```{autodoc2-docstring} scullery.kms.Kms
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`STATE_PENDING_CREATION <scullery.kms.STATE_PENDING_CREATION>`
  - ```{autodoc2-docstring} scullery.kms.STATE_PENDING_CREATION
    :summary:
    ```
* - {py:obj}`STATE_ENABLED <scullery.kms.STATE_ENABLED>`
  - ```{autodoc2-docstring} scullery.kms.STATE_ENABLED
    :summary:
    ```
* - {py:obj}`STATE_DISABLED <scullery.kms.STATE_DISABLED>`
  - ```{autodoc2-docstring} scullery.kms.STATE_DISABLED
    :summary:
    ```
* - {py:obj}`STATE_PENDING_DELETION <scullery.kms.STATE_PENDING_DELETION>`
  - ```{autodoc2-docstring} scullery.kms.STATE_PENDING_DELETION
    :summary:
    ```
* - {py:obj}`STATE_PENDING_IMPORT <scullery.kms.STATE_PENDING_IMPORT>`
  - ```{autodoc2-docstring} scullery.kms.STATE_PENDING_IMPORT
    :summary:
    ```
* - {py:obj}`STATE_NAMES <scullery.kms.STATE_NAMES>`
  - ```{autodoc2-docstring} scullery.kms.STATE_NAMES
    :summary:
    ```
* - {py:obj}`STATE_BY_NAME <scullery.kms.STATE_BY_NAME>`
  - ```{autodoc2-docstring} scullery.kms.STATE_BY_NAME
    :summary:
    ```
````

### API

````{py:data} STATE_PENDING_CREATION
:canonical: scullery.kms.STATE_PENDING_CREATION
:value: >
   1

```{autodoc2-docstring} scullery.kms.STATE_PENDING_CREATION
```

````

````{py:data} STATE_ENABLED
:canonical: scullery.kms.STATE_ENABLED
:value: >
   2

```{autodoc2-docstring} scullery.kms.STATE_ENABLED
```

````

````{py:data} STATE_DISABLED
:canonical: scullery.kms.STATE_DISABLED
:value: >
   3

```{autodoc2-docstring} scullery.kms.STATE_DISABLED
```

````

````{py:data} STATE_PENDING_DELETION
:canonical: scullery.kms.STATE_PENDING_DELETION
:value: >
   4

```{autodoc2-docstring} scullery.kms.STATE_PENDING_DELETION
```

````

````{py:data} STATE_PENDING_IMPORT
:canonical: scullery.kms.STATE_PENDING_IMPORT
:value: >
   5

```{autodoc2-docstring} scullery.kms.STATE_PENDING_IMPORT
```

````

````{py:data} STATE_NAMES
:canonical: scullery.kms.STATE_NAMES
:value: >
   None

```{autodoc2-docstring} scullery.kms.STATE_NAMES
```

````

````{py:data} STATE_BY_NAME
:canonical: scullery.kms.STATE_BY_NAME
:value: >
   None

```{autodoc2-docstring} scullery.kms.STATE_BY_NAME
```

````

`````{py:class} Kms(session)
:canonical: scullery.kms.Kms

```{autodoc2-docstring} scullery.kms.Kms
```

```{rubric} Initialization
```

```{autodoc2-docstring} scullery.kms.Kms.__init__
```

````{py:attribute} API_HOST
:canonical: scullery.kms.Kms.API_HOST
:value: >
   'kms.{region}.otc.t-systems.com'

```{autodoc2-docstring} scullery.kms.Kms.API_HOST
```

````

````{py:method} api_path(path: str = '') -> str
:canonical: scullery.kms.Kms.api_path

```{autodoc2-docstring} scullery.kms.Kms.api_path
```

````

````{py:property} project_id
:canonical: scullery.kms.Kms.project_id
:type: str

```{autodoc2-docstring} scullery.kms.Kms.project_id
```

````

````{py:method} _keys_base(action: str = '') -> str
:canonical: scullery.kms.Kms._keys_base

```{autodoc2-docstring} scullery.kms.Kms._keys_base
```

````

````{py:method} resolve_key(name: str) -> str
:canonical: scullery.kms.Kms.resolve_key

```{autodoc2-docstring} scullery.kms.Kms.resolve_key
```

````

````{py:method} keys(key_state: int | None = None, limit: int = 2000, marker: str | None = None) -> list
:canonical: scullery.kms.Kms.keys

```{autodoc2-docstring} scullery.kms.Kms.keys
```

````

````{py:method} describe(key_id: str) -> dict
:canonical: scullery.kms.Kms.describe

```{autodoc2-docstring} scullery.kms.Kms.describe
```

````

````{py:method} create(alias: str, description: str | None = None, key_spec: str = 'AES_256', key_usage: str = 'ENCRYPT_DECRYPT') -> dict
:canonical: scullery.kms.Kms.create

```{autodoc2-docstring} scullery.kms.Kms.create
```

````

````{py:method} schedule_deletion(key_id: str, pending_days: int = 7) -> dict
:canonical: scullery.kms.Kms.schedule_deletion

```{autodoc2-docstring} scullery.kms.Kms.schedule_deletion
```

````

````{py:method} cancel_deletion(key_id: str) -> dict
:canonical: scullery.kms.Kms.cancel_deletion

```{autodoc2-docstring} scullery.kms.Kms.cancel_deletion
```

````

````{py:method} enable(key_id: str) -> dict
:canonical: scullery.kms.Kms.enable

```{autodoc2-docstring} scullery.kms.Kms.enable
```

````

````{py:method} disable(key_id: str) -> dict
:canonical: scullery.kms.Kms.disable

```{autodoc2-docstring} scullery.kms.Kms.disable
```

````

````{py:method} get_rotation_status(key_id: str) -> dict
:canonical: scullery.kms.Kms.get_rotation_status

```{autodoc2-docstring} scullery.kms.Kms.get_rotation_status
```

````

````{py:method} rotate(key_id: str, period: int | None = None) -> dict
:canonical: scullery.kms.Kms.rotate

```{autodoc2-docstring} scullery.kms.Kms.rotate
```

````

`````