sdkms.v1.apis.aws_api module

Fortanix DSM REST API

This is a set of REST APIs for accessing the Fortanix Data Security Manager. This includes APIs for managing accounts, and for performing cryptographic and key management operations.

OpenAPI spec version: 1.0.0-20200608 Contact: support@fortanix.com Generated by: https://github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class sdkms.v1.apis.aws_api.AWSApi(api_client=None)[source]

Bases: object

__init__(api_client=None)[source]
cancel_deletion(key_id, async_call=False, **kwargs)[source]

Cancel scheduled deletion of an AWS KMS key

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • key_id (str) – kid of security object (required)

Return type:

KeyObject

Returns:

If the method is called asynchronously, returns the request thread.

delete_key_material(key_id, async_call=False, **kwargs)[source]

Delete the key material of an AWS KMS key

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • key_id (str) – kid of security object (required)

Return type:

KeyObject

Returns:

If the method is called asynchronously, returns the request thread.

restore(key_id, async_call=False, **kwargs)[source]

Restore an AWS key from its source key material

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • key_id (str) – kid of security object (required)

Return type:

KeyObject

Returns:

If the method is called asynchronously, returns the request thread.

schedule_deletion(key_id, body, async_call=False, **kwargs)[source]

Schedule an AWS KMS key for deletion

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • key_id (str) – kid of security object (required)

  • body (ScheduleDeletionRequest) – Request to schedule deletion for an AWS KMS key (required)

Return type:

KeyObject

Returns:

If the method is called asynchronously, returns the request thread.