AWS API Changes

2017/07/06 - AWS Key Management Service - 2 updated api methods

Changes This release of AWS Key Management Service introduces the ability to determine whether a key is AWS managed or customer managed.

CreateKey (updated)

Link ¶
Changes (response)

{'KeyMetadata': {'KeyManager': 'AWS | CUSTOMER'}}

Creates a customer master key (CMK).

You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:

The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide

See also: AWS API Documentation

Request Syntax

client.create_key(
    Policy='string',
    Description='string',
    KeyUsage='ENCRYPT_DECRYPT',
    Origin='AWS_KMS'|'EXTERNAL',
    BypassPolicyLockoutSafetyCheck=True|False,
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)

type Policy

string

param Policy

The key policy to attach to the CMK.

If you specify a policy and do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria:

It must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
The principals that are specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide .

If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide .

The policy size limit is 32 KiB (32768 bytes).

type Description

string

param Description

A description of the CMK.

Use a description that helps you decide whether the CMK is appropriate for a task.

type KeyUsage

string

param KeyUsage

The intended use of the CMK.

You can use CMKs only for symmetric encryption and decryption.

type Origin

string

param Origin

The source of the CMK's key material.

The default is AWS_KMS , which means AWS KMS creates the key material. When this parameter is set to EXTERNAL , the request creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide .

The CMK's Origin is immutable and is set when the CMK is created.

type BypassPolicyLockoutSafetyCheck

boolean

param BypassPolicyLockoutSafetyCheck

A flag to indicate whether to bypass the key policy lockout safety check.

Warning

Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .

Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.

The default value is false.

type Tags

list

param Tags

One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource .

(dict) --

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
- TagKey (string) -- [REQUIRED]
  
  The key of the tag.
- TagValue (string) -- [REQUIRED]
  
  The value of the tag.

rtype

dict

returns

Response Syntax

{
    'KeyMetadata': {
        'AWSAccountId': 'string',
        'KeyId': 'string',
        'Arn': 'string',
        'CreationDate': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Description': 'string',
        'KeyUsage': 'ENCRYPT_DECRYPT',
        'KeyState': 'Enabled'|'Disabled'|'PendingDeletion'|'PendingImport',
        'DeletionDate': datetime(2015, 1, 1),
        'ValidTo': datetime(2015, 1, 1),
        'Origin': 'AWS_KMS'|'EXTERNAL',
        'ExpirationModel': 'KEY_MATERIAL_EXPIRES'|'KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyManager': 'AWS'|'CUSTOMER'
    }
}

Response Structure

(dict) --
- KeyMetadata (dict) --
  
  Metadata associated with the CMK.
  - AWSAccountId (string) --
    
    The twelve-digit account ID of the AWS account that owns the CMK.
  - KeyId (string) --
    
    The globally unique identifier for the CMK.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference .
  - CreationDate (datetime) --
    
    The date and time when the CMK was created.
  - Enabled (boolean) --
    
    Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
  - Description (string) --
    
    The description of the CMK.
  - KeyUsage (string) --
    
    The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT , which means you can use the CMK for the Encrypt and Decrypt operations.
  - KeyState (string) --
    
    The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
  - DeletionDate (datetime) --
    
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion , otherwise this value is omitted.
  - ValidTo (datetime) --
    
    The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES , otherwise this value is omitted.
  - Origin (string) --
    
    The source of the CMK's key material. When this value is AWS_KMS , AWS KMS created the key material. When this value is EXTERNAL , the key material was imported from your existing key management infrastructure or the CMK lacks key material.
  - ExpirationModel (string) --
    
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL , otherwise this value is omitted.
  - KeyManager (string) --
    
    The CMK's manager. CMKs are either customer-managed or AWS-managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide .

DescribeKey (updated)

Link ¶
Changes (response)

{'KeyMetadata': {'KeyManager': 'AWS | CUSTOMER'}}

Provides detailed information about the specified customer master key.

See also: AWS API Documentation

Request Syntax

client.describe_key(
    KeyId='string',
    GrantTokens=[
        'string',
    ]
)

type KeyId

string

param KeyId

[REQUIRED]

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName

type GrantTokens

list

param GrantTokens

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide .

(string) --

rtype

dict

returns

Response Syntax

{
    'KeyMetadata': {
        'AWSAccountId': 'string',
        'KeyId': 'string',
        'Arn': 'string',
        'CreationDate': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Description': 'string',
        'KeyUsage': 'ENCRYPT_DECRYPT',
        'KeyState': 'Enabled'|'Disabled'|'PendingDeletion'|'PendingImport',
        'DeletionDate': datetime(2015, 1, 1),
        'ValidTo': datetime(2015, 1, 1),
        'Origin': 'AWS_KMS'|'EXTERNAL',
        'ExpirationModel': 'KEY_MATERIAL_EXPIRES'|'KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyManager': 'AWS'|'CUSTOMER'
    }
}

Response Structure

(dict) --
- KeyMetadata (dict) --
  
  Metadata associated with the key.
  - AWSAccountId (string) --
    
    The twelve-digit account ID of the AWS account that owns the CMK.
  - KeyId (string) --
    
    The globally unique identifier for the CMK.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference .
  - CreationDate (datetime) --
    
    The date and time when the CMK was created.
  - Enabled (boolean) --
    
    Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
  - Description (string) --
    
    The description of the CMK.
  - KeyUsage (string) --
    
    The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT , which means you can use the CMK for the Encrypt and Decrypt operations.
  - KeyState (string) --
    
    The state of the CMK.
    
    For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
  - DeletionDate (datetime) --
    
    The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion , otherwise this value is omitted.
  - ValidTo (datetime) --
    
    The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES , otherwise this value is omitted.
  - Origin (string) --
    
    The source of the CMK's key material. When this value is AWS_KMS , AWS KMS created the key material. When this value is EXTERNAL , the key material was imported from your existing key management infrastructure or the CMK lacks key material.
  - ExpirationModel (string) --
    
    Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL , otherwise this value is omitted.
  - KeyManager (string) --
    
    The CMK's manager. CMKs are either customer-managed or AWS-managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide .