AWS Key Management Service

Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an HMAC using the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC to the HMAC that you specify. If the HMACs are identical, the verification succeeds; otherwise, it fails.

Verification indicates that the message hasn't changed since the HMAC was calculated, and the specified key was used to generate and verify the HMAC.

This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide .

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide .

Cross-account use : Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions : kms:VerifyMac (key policy)

Related operations : GenerateMac

See also: AWS API Documentation

Request Syntax

client.verify_mac(
    Message=b'bytes',
    KeyId='string',
    MacAlgorithm='HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512',
    Mac=b'bytes',
    GrantTokens=[
        'string',
    ]
)

type Message

bytes

param Message

[REQUIRED]

The message that will be used in the verification. Enter the same message that was used to generate the HMAC.

GenerateMac and VerifyMac do not provide special handling for message digests. If you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.

type KeyId

string

param KeyId

[REQUIRED]

The KMS key that will be used in the verification.

Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the VerifyMac operation fails.

type MacAlgorithm

string

param MacAlgorithm

[REQUIRED]

The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.

type Mac

bytes

param Mac

[REQUIRED]

The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.

type GrantTokens

list

param GrantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency . For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide .

• (string) --

rtype

dict

returns

Response Syntax

{
    'KeyId': 'string',
    'MacValid': True|False,
    'MacAlgorithm': 'HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512'
}

Response Structure

• (dict) --

  • KeyId (string) --

    The HMAC KMS key used in the verification.

  • MacValid (boolean) --

    A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac ) was generated with the specified Message , HMAC KMS key (KeyID ) and MacAlgorithm. .

    If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

  • MacAlgorithm (string) --

    The MAC algorithm used in the verification.

Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104 .

You can use the HMAC that this operation generates with the VerifyMac operation to demonstrate that the original message has not changed. Also, because a secret key is used to create the hash, you can verify that the party that generated the hash has the required secret key. This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the * Key Management Service Developer Guide * .

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide .

Cross-account use : Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions : kms:GenerateMac (key policy)

Related operations : VerifyMac

See also: AWS API Documentation

Request Syntax

client.generate_mac(
    Message=b'bytes',
    KeyId='string',
    MacAlgorithm='HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512',
    GrantTokens=[
        'string',
    ]
)

type Message

bytes

param Message

[REQUIRED]

The message to be hashed. Specify a message of up to 4,096 bytes.

GenerateMac and VerifyMac do not provide special handling for message digests. If you generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.

type KeyId

string

param KeyId

[REQUIRED]

The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104 .

To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the response.

type MacAlgorithm

string

param MacAlgorithm

[REQUIRED]

The MAC algorithm used in the operation.

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

type GrantTokens

list

param GrantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency . For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide .

• (string) --

rtype

dict

returns

Response Syntax

{
    'Mac': b'bytes',
    'MacAlgorithm': 'HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512',
    'KeyId': 'string'
}

Response Structure

• (dict) --

  • Mac (bytes) --

    The hash-based message authentication code (HMAC) for the given message, key, and MAC algorithm.

  • MacAlgorithm (string) --

    The MAC algorithm that was used to generate the HMAC.

  • KeyId (string) --

    The HMAC KMS key used in the operation.

{'Operations': {'GenerateMac', 'VerifyMac'}}

Adds a grant to a KMS key.

A grant is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key ( DescribeKey ) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for temporary permissions because you can create one, use its permissions, and delete it without changing your key policies or IAM policies.

For detailed information about grants, including grant terminology, see Grants in KMS in the * Key Management Service Developer Guide * . For examples of working with grants in several programming languages, see Programming grants .

The CreateGrant operation returns a GrantToken and a GrantId .

• When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency . Once the grant has achieved eventual consistency, the grantee principal can use the permissions in the grant without identifying the grant. However, to use the permissions in the grant immediately, use the GrantToken that CreateGrant returns. For details, see Using a grant token in the * Key Management Service Developer Guide * .

• The CreateGrant operation also returns a GrantId . You can use the GrantId and a key identifier to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant ID, use the ListGrants or ListRetirableGrants operations.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide .

Cross-account use : Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.

Required permissions : kms:CreateGrant (key policy)

Related operations:

• ListGrants

• ListRetirableGrants

• RetireGrant

• RevokeGrant

See also: AWS API Documentation

Request Syntax

client.create_grant(
    KeyId='string',
    GranteePrincipal='string',
    RetiringPrincipal='string',
    Operations=[
        'Decrypt'|'Encrypt'|'GenerateDataKey'|'GenerateDataKeyWithoutPlaintext'|'ReEncryptFrom'|'ReEncryptTo'|'Sign'|'Verify'|'GetPublicKey'|'CreateGrant'|'RetireGrant'|'DescribeKey'|'GenerateDataKeyPair'|'GenerateDataKeyPairWithoutPlaintext'|'GenerateMac'|'VerifyMac',
    ],
    Constraints={
        'EncryptionContextSubset': {
            'string': 'string'
        },
        'EncryptionContextEquals': {
            'string': 'string'
        }
    },
    GrantTokens=[
        'string',
    ],
    Name='string'
)

type KeyId

string

param KeyId

[REQUIRED]

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey .

type GranteePrincipal

string

param GranteePrincipal

[REQUIRED]

The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference .

type RetiringPrincipal

string

param RetiringPrincipal

The principal that has permission to use the RetireGrant operation to retire the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference .

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide .

type Operations

list

param Operations

[REQUIRED]

A list of operations that the grant permits.

This list must include only operations that are permitted in a grant. Also, the operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide .

• (string) --

type Constraints

dict

param Constraints

Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide . For more information about encryption context, see Encryption context in the * Key Management Service Developer Guide * .

The encryption context grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals ) or includes (EncryptionContextSubset ) the encryption context specified in this structure.

The encryption context grant constraints are supported only on grant operations that include an EncryptionContext parameter, such as cryptographic operations on symmetric encryption KMS keys. Grants with grant constraints can include the DescribeKey and RetireGrant operations, but the constraint doesn't apply to these operations. If a grant with a grant constraint includes the CreateGrant operation, the constraint requires that any grants created with the CreateGrant permission have an equally strict or stricter encryption context constraint.

You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or HMAC KMS keys. These keys don't support an encryption context.

• EncryptionContextSubset (dict) --

  A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

  • (string) --

    • (string) --

• EncryptionContextEquals (dict) --

  A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

  • (string) --

    • (string) --

type GrantTokens

list

param GrantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency . For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide .

• (string) --

type Name

string

param Name

A friendly name for the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens for the same grant ID can be used interchangeably.

rtype

dict

returns

Response Syntax

{
    'GrantToken': 'string',
    'GrantId': 'string'
}

Response Structure

• (dict) --

  • GrantToken (string) --

    The grant token.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency . For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide .

  • GrantId (string) --

    The unique identifier for the grant.

    You can use the GrantId in a ListGrants , RetireGrant , or RevokeGrant operation.

{'CustomerMasterKeySpec': {'HMAC_256', 'HMAC_512', 'HMAC_224', 'HMAC_384'},
 'KeySpec': {'HMAC_256', 'HMAC_512', 'HMAC_224', 'HMAC_384'},
 'KeyUsage': {'GENERATE_VERIFY_MAC'}}

{'KeyMetadata': {'CustomerMasterKeySpec': {'HMAC_224',
                                           'HMAC_256',
                                           'HMAC_384',
                                           'HMAC_512'},
                 'KeySpec': {'HMAC_256', 'HMAC_512', 'HMAC_224', 'HMAC_384'},
                 'KeyUsage': {'GENERATE_VERIFY_MAC'},
                 'MacAlgorithms': ['HMAC_SHA_224 | HMAC_SHA_256 | HMAC_SHA_384 '
                                   '| HMAC_SHA_512']}}

Creates a unique customer managed KMS key in your Amazon Web Services account and Region.

In addition to the required parameters, you can use the optional parameters to specify a key policy, description, tags, and other useful elements for any key type.

To create different types of KMS keys, use the following guidance:

Symmetric encryption KMS key

To create a symmetric encryption KMS key, you aren't required to specify any parameters. The default value for KeySpec , SYMMETRIC_DEFAULT , and the default value for KeyUsage , ENCRYPT_DECRYPT , create a symmetric encryption KMS key.

If you need a key for basic encryption and decryption or you are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair .

Asymmetric KMS keys

To create an asymmetric KMS key, use the KeySpec parameter to specify the type of key material in the KMS key. Then, use the KeyUsage parameter to determine whether the KMS key will be used to encrypt and decrypt or sign and verify. You can't change these properties after the KMS key is created.

Asymmetric KMS keys contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric KMS key never leaves AWS KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of AWS KMS. KMS keys with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key pairs can be used only to sign and verify messages. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide .

HMAC KMS key

To create an HMAC KMS key, set the KeySpec parameter to a key spec value for HMAC KMS keys. Then set the KeyUsage parameter to GENERATE_VERIFY_MAC . You must set the key usage even though GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys. You can't change these properties after the KMS key is created.

HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use HMAC keys to generate ( GenerateMac ) and verify ( VerifyMac ) HMAC codes for messages up to 4096 bytes.

HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the CreateKey operation returns an UnsupportedOperationException . For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide .

Multi-Region primary keys Imported key material

To create a multi-Region primary key in the local Amazon Web Services Region, use the MultiRegion parameter with a value of True . To create a multi-Region replica key , that is, a KMS key with the same key ID and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its primary key to a replica key, use the UpdatePrimaryRegion operation.

You can create multi-Region KMS keys for all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't create multi-Region keys in a custom key store.

This operation supports multi-Region keys , an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide .

To import your own key material, begin by creating a symmetric encryption KMS key with no key material. To do this, use the Origin parameter of CreateKey with a value of EXTERNAL . Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the * Key Management Service Developer Guide * .

This feature supports only symmetric encryption KMS keys, including multi-Region symmetric encryption KMS keys. You cannot import key material into any other type of KMS key.

To create a multi-Region primary key with imported key material, use the Origin parameter of CreateKey with a value of EXTERNAL and the MultiRegion parameter with a value of True . To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide .

Custom key store

To create a symmetric encryption KMS key in a custom key store , use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM . The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the Amazon Web Services Region.

Custom key stores support only symmetric encryption KMS keys. You cannot create an HMAC KMS key or an asymmetric KMS key in a custom key store. For information about custom key stores in KMS see Custom key stores in KMS in the * Key Management Service Developer Guide * .

Cross-account use : No. You cannot use this operation to create a KMS key in a different Amazon Web Services account.

Required permissions : kms:CreateKey (IAM policy). To use the Tags parameter, kms:TagResource (IAM policy). For examples and information about related permissions, see Allow a user to create KMS keys in the Key Management Service Developer Guide .

Related operations:

• DescribeKey

• ListKeys

• ScheduleKeyDeletion

See also: AWS API Documentation

Request Syntax

client.create_key(
    Policy='string',
    Description='string',
    KeyUsage='SIGN_VERIFY'|'ENCRYPT_DECRYPT'|'GENERATE_VERIFY_MAC',
    CustomerMasterKeySpec='RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'SYMMETRIC_DEFAULT'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512',
    KeySpec='RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'SYMMETRIC_DEFAULT'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512',
    Origin='AWS_KMS'|'EXTERNAL'|'AWS_CLOUDHSM',
    CustomKeyStoreId='string',
    BypassPolicyLockoutSafetyCheck=True|False,
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ],
    MultiRegion=True|False
)

type Policy

string

param Policy

The key policy to attach to the KMS key.

If you provide a key policy, it must meet the following criteria:

• If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the * Key Management Service Developer Guide * .

• Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide .

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

The key policy size quota is 32 kilobytes (32768 bytes).

For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the * Identity and Access Management User Guide * .

type Description

string

param Description

A description of the KMS key.

Use a description that helps you decide whether the KMS key is appropriate for a task. The default value is an empty string (no description).

To set or change the description after the key is created, use UpdateKeyDescription .

type KeyUsage

string

param KeyUsage

Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT . This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.

Select only one valid value.

• For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT .

• For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC .

• For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY .

• For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY .

type CustomerMasterKeySpec

string

param CustomerMasterKeySpec

Instead, use the KeySpec parameter.

The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking changes, KMS will support both parameters.

type KeySpec

string

param KeySpec

Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT , creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the * Key Management Service Developer Guide * .

The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm , kms:MacAlgorithm or kms:Signing Algorithm in the * Key Management Service Developer Guide * .

Warning

Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.

KMS supports the following key specs for KMS keys:

• Symmetric encryption key (default)

  • SYMMETRIC_DEFAULT (AES-256-GCM)

• HMAC keys (symmetric)

  • HMAC_224

  • HMAC_256

  • HMAC_384

  • HMAC_512

• Asymmetric RSA key pairs

  • RSA_2048

  • RSA_3072

  • RSA_4096

• Asymmetric NIST-recommended elliptic curve key pairs

  • ECC_NIST_P256 (secp256r1)

  • ECC_NIST_P384 (secp384r1)

  • ECC_NIST_P521 (secp521r1)

• Other asymmetric elliptic curve key pairs

  • ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.

type Origin

string

param Origin

The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS , which means that KMS creates the key material.

To create a KMS key with no key material (for imported key material), set the value to EXTERNAL . For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide . This value is valid only for symmetric encryption KMS keys.

To create a KMS key in an KMS custom key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM . You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric encryption KMS keys.

type CustomKeyStoreId

string

param CustomKeyStoreId

Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM . The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.

This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

The response includes the custom key store ID and the ID of the CloudHSM cluster.

This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.

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 risk that the KMS key 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 * 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 KMS key.

The default value is false.

type Tags

list

param Tags

Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

Note

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide .

To use this parameter, you must have kms:TagResource permission in an IAM policy.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys .

• (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.

  For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the Amazon Web Services Billing and Cost Management User Guide .

  • TagKey (string) -- [REQUIRED]

    The key of the tag.

  • TagValue (string) -- [REQUIRED]

    The value of the tag.

type MultiRegion

boolean

param MultiRegion

Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key.

For a multi-Region key, set this parameter to True . For a single-Region KMS key, omit this parameter or set it to False . The default value is False .

This operation supports multi-Region keys , an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide .

This value creates a primary key , not a replica. To create a replica key , use the ReplicateKey operation.

You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.

rtype

dict

returns

Response Syntax

{
    'KeyMetadata': {
        'AWSAccountId': 'string',
        'KeyId': 'string',
        'Arn': 'string',
        'CreationDate': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Description': 'string',
        'KeyUsage': 'SIGN_VERIFY'|'ENCRYPT_DECRYPT'|'GENERATE_VERIFY_MAC',
        'KeyState': 'Creating'|'Enabled'|'Disabled'|'PendingDeletion'|'PendingImport'|'PendingReplicaDeletion'|'Unavailable'|'Updating',
        'DeletionDate': datetime(2015, 1, 1),
        'ValidTo': datetime(2015, 1, 1),
        'Origin': 'AWS_KMS'|'EXTERNAL'|'AWS_CLOUDHSM',
        'CustomKeyStoreId': 'string',
        'CloudHsmClusterId': 'string',
        'ExpirationModel': 'KEY_MATERIAL_EXPIRES'|'KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyManager': 'AWS'|'CUSTOMER',
        'CustomerMasterKeySpec': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'SYMMETRIC_DEFAULT'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512',
        'KeySpec': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'SYMMETRIC_DEFAULT'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512',
        'EncryptionAlgorithms': [
            'SYMMETRIC_DEFAULT'|'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256',
        ],
        'SigningAlgorithms': [
            'RSASSA_PSS_SHA_256'|'RSASSA_PSS_SHA_384'|'RSASSA_PSS_SHA_512'|'RSASSA_PKCS1_V1_5_SHA_256'|'RSASSA_PKCS1_V1_5_SHA_384'|'RSASSA_PKCS1_V1_5_SHA_512'|'ECDSA_SHA_256'|'ECDSA_SHA_384'|'ECDSA_SHA_512',
        ],
        'MultiRegion': True|False,
        'MultiRegionConfiguration': {
            'MultiRegionKeyType': 'PRIMARY'|'REPLICA',
            'PrimaryKey': {
                'Arn': 'string',
                'Region': 'string'
            },
            'ReplicaKeys': [
                {
                    'Arn': 'string',
                    'Region': 'string'
                },
            ]
        },
        'PendingDeletionWindowInDays': 123,
        'MacAlgorithms': [
            'HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512',
        ]
    }
}

Response Structure

• (dict) --

  • KeyMetadata (dict) --

    Metadata associated with the KMS key.

    • AWSAccountId (string) --

      The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

    • KeyId (string) --

      The globally unique identifier for the KMS key.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference .

    • CreationDate (datetime) --

      The date and time when the KMS key was created.

    • Enabled (boolean) --

      Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.

    • Description (string) --

      The description of the KMS key.

    • KeyUsage (string) --

      The cryptographic operations for which you can use the KMS key.

    • KeyState (string) --

      The current status of the KMS key.

      For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide .

    • DeletionDate (datetime) --

      The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion .

      When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.

    • ValidTo (datetime) --

      The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES , otherwise this value is omitted.

    • Origin (string) --

      The source of the key material for the KMS key. When this value is AWS_KMS , KMS created the key material. When this value is EXTERNAL , the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM , the key material was created in the CloudHSM cluster associated with a custom key store.

    • CustomKeyStoreId (string) --

      A unique identifier for the custom key store that contains the KMS key. This value is present only when the KMS key is created in a custom key store.

    • CloudHsmClusterId (string) --

      The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in a custom key store , KMS creates the key material for the KMS key in the associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key store.

    • ExpirationModel (string) --

      Specifies whether the KMS key's key material expires. This value is present only when Origin is EXTERNAL , otherwise this value is omitted.

    • KeyManager (string) --

      The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide .

    • CustomerMasterKeySpec (string) --

      Instead, use the KeySpec field.

      The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both fields.

    • KeySpec (string) --

      Describes the type of key material in the KMS key.

    • EncryptionAlgorithms (list) --

      The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

      This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT .

      • (string) --

    • SigningAlgorithms (list) --

      The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

      This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY .

      • (string) --

    • MultiRegion (boolean) --

      Indicates whether the KMS key is a multi-Region (True ) or regional (False ) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.

      For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide .

    • MultiRegionConfiguration (dict) --

      Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True .

      For more information about any listed KMS key, use the DescribeKey operation.

      • MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.

      • PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.

      • ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

      • MultiRegionKeyType (string) --

        Indicates whether the KMS key is a PRIMARY or REPLICA key.

      • PrimaryKey (dict) --

        Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.

        • Arn (string) --

          Displays the key ARN of a primary or replica key of a multi-Region key.

        • Region (string) --

          Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

      • ReplicaKeys (list) --

        displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

        • (dict) --

          Describes the primary or replica key in a multi-Region key.

          • Arn (string) --

            Displays the key ARN of a primary or replica key of a multi-Region key.

          • Region (string) --

            Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

    • PendingDeletionWindowInDays (integer) --

      The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion . That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

      When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.

    • MacAlgorithms (list) --

      The message authentication code (MAC) algorithm that the HMAC KMS key supports.

      This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC .

      • (string) --

{'KeyMetadata': {'CustomerMasterKeySpec': {'HMAC_224',
                                           'HMAC_256',
                                           'HMAC_384',
                                           'HMAC_512'},
                 'KeySpec': {'HMAC_256', 'HMAC_512', 'HMAC_224', 'HMAC_384'},
                 'KeyUsage': {'GENERATE_VERIFY_MAC'},
                 'MacAlgorithms': ['HMAC_SHA_224 | HMAC_SHA_256 | HMAC_SHA_384 '
                                   '| HMAC_SHA_512']}}

Provides detailed information about a KMS key. You can run DescribeKey on a customer managed key or an Amazon Web Services managed key .

This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. It includes fields, like KeySpec , that help you distinguish different types of KMS keys. It also displays the key usage (encryption, signing, or generating and verifying MACs) and the algorithms that the KMS key supports. For KMS keys in custom key stores, it includes information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For multi-Region keys, it displays the primary key and all related replica keys.

DescribeKey does not return the following information:

• Aliases associated with the KMS key. To get this information, use ListAliases .

• Whether automatic key rotation is enabled on the KMS key. To get this information, use GetKeyRotationStatus . Also, some key states prevent a KMS key from being automatically rotated. For details, see How Automatic Key Rotation Works in Key Management Service Developer Guide .

• Tags on the KMS key. To get this information, use ListResourceTags .

• Key policies and grants on the KMS key. To get this information, use GetKeyPolicy and ListGrants .

In general, DescribeKey is a non-mutating operation. It returns data about KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey to create Amazon Web Services managed keys from a predefined Amazon Web Services alias with no key ID.

Cross-account use : Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions : kms:DescribeKey (key policy)

Related operations:

• GetKeyPolicy

• GetKeyRotationStatus

• ListAliases

• ListGrants

• ListKeys

• ListResourceTags

• ListRetirableGrants

See also: AWS API Documentation

Request Syntax

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

type KeyId

string

param KeyId

[REQUIRED]

Describes the specified KMS key.

If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates the alias with an Amazon Web Services managed key and returns its KeyId and Arn in the response.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/" . To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To get the alias name and alias ARN, use ListAliases .

type GrantTokens

list

param GrantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency . For more information, see Grant token and Using a grant token in the 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': 'SIGN_VERIFY'|'ENCRYPT_DECRYPT'|'GENERATE_VERIFY_MAC',
        'KeyState': 'Creating'|'Enabled'|'Disabled'|'PendingDeletion'|'PendingImport'|'PendingReplicaDeletion'|'Unavailable'|'Updating',
        'DeletionDate': datetime(2015, 1, 1),
        'ValidTo': datetime(2015, 1, 1),
        'Origin': 'AWS_KMS'|'EXTERNAL'|'AWS_CLOUDHSM',
        'CustomKeyStoreId': 'string',
        'CloudHsmClusterId': 'string',
        'ExpirationModel': 'KEY_MATERIAL_EXPIRES'|'KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyManager': 'AWS'|'CUSTOMER',
        'CustomerMasterKeySpec': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'SYMMETRIC_DEFAULT'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512',
        'KeySpec': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'SYMMETRIC_DEFAULT'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512',
        'EncryptionAlgorithms': [
            'SYMMETRIC_DEFAULT'|'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256',
        ],
        'SigningAlgorithms': [
            'RSASSA_PSS_SHA_256'|'RSASSA_PSS_SHA_384'|'RSASSA_PSS_SHA_512'|'RSASSA_PKCS1_V1_5_SHA_256'|'RSASSA_PKCS1_V1_5_SHA_384'|'RSASSA_PKCS1_V1_5_SHA_512'|'ECDSA_SHA_256'|'ECDSA_SHA_384'|'ECDSA_SHA_512',
        ],
        'MultiRegion': True|False,
        'MultiRegionConfiguration': {
            'MultiRegionKeyType': 'PRIMARY'|'REPLICA',
            'PrimaryKey': {
                'Arn': 'string',
                'Region': 'string'
            },
            'ReplicaKeys': [
                {
                    'Arn': 'string',
                    'Region': 'string'
                },
            ]
        },
        'PendingDeletionWindowInDays': 123,
        'MacAlgorithms': [
            'HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512',
        ]
    }
}

Response Structure

• (dict) --

  • KeyMetadata (dict) --

    Metadata associated with the key.

    • AWSAccountId (string) --

      The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

    • KeyId (string) --

      The globally unique identifier for the KMS key.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference .

    • CreationDate (datetime) --

      The date and time when the KMS key was created.

    • Enabled (boolean) --

      Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.

    • Description (string) --

      The description of the KMS key.

    • KeyUsage (string) --

      The cryptographic operations for which you can use the KMS key.

    • KeyState (string) --

      The current status of the KMS key.

      For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide .

    • DeletionDate (datetime) --

      The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion .

      When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.

    • ValidTo (datetime) --

      The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES , otherwise this value is omitted.

    • Origin (string) --

      The source of the key material for the KMS key. When this value is AWS_KMS , KMS created the key material. When this value is EXTERNAL , the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM , the key material was created in the CloudHSM cluster associated with a custom key store.

    • CustomKeyStoreId (string) --

      A unique identifier for the custom key store that contains the KMS key. This value is present only when the KMS key is created in a custom key store.

    • CloudHsmClusterId (string) --

      The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in a custom key store , KMS creates the key material for the KMS key in the associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key store.

    • ExpirationModel (string) --

      Specifies whether the KMS key's key material expires. This value is present only when Origin is EXTERNAL , otherwise this value is omitted.

    • KeyManager (string) --

      The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide .

    • CustomerMasterKeySpec (string) --

      Instead, use the KeySpec field.

      The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both fields.

    • KeySpec (string) --

      Describes the type of key material in the KMS key.

    • EncryptionAlgorithms (list) --

      The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

      This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT .

      • (string) --

    • SigningAlgorithms (list) --

      The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

      This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY .

      • (string) --

    • MultiRegion (boolean) --

      Indicates whether the KMS key is a multi-Region (True ) or regional (False ) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.

      For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide .

    • MultiRegionConfiguration (dict) --

      Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True .

      For more information about any listed KMS key, use the DescribeKey operation.

      • MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.

      • PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.

      • ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

      • MultiRegionKeyType (string) --

        Indicates whether the KMS key is a PRIMARY or REPLICA key.

      • PrimaryKey (dict) --

        Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.

        • Arn (string) --

          Displays the key ARN of a primary or replica key of a multi-Region key.

        • Region (string) --

          Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

      • ReplicaKeys (list) --

        displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

        • (dict) --

          Describes the primary or replica key in a multi-Region key.

          • Arn (string) --

            Displays the key ARN of a primary or replica key of a multi-Region key.

          • Region (string) --

            Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

    • PendingDeletionWindowInDays (integer) --

      The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion . That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

      When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.

    • MacAlgorithms (list) --

      The message authentication code (MAC) algorithm that the HMAC KMS key supports.

      This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC .

      • (string) --

{'CustomerMasterKeySpec': {'HMAC_256', 'HMAC_512', 'HMAC_224', 'HMAC_384'},
 'KeySpec': {'HMAC_256', 'HMAC_512', 'HMAC_224', 'HMAC_384'},
 'KeyUsage': {'GENERATE_VERIFY_MAC'}}

Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS key, which never leaves KMS unencrypted, callers with kms:GetPublicKey permission can download the public key of an asymmetric KMS key. You can share the public key to allow others to encrypt messages and verify signatures outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide .

You do not need to download the public key. Instead, you can use the public key within KMS by calling the Encrypt , ReEncrypt , or Verify operations with the identifier of an asymmetric KMS key. When you use the public key within KMS, you benefit from the authentication, authorization, and logging that are part of every KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of KMS. For details, see Special Considerations for Downloading Public Keys .

To help you use the public key safely outside of KMS, GetPublicKey returns important information about the public key in the response, including:

• KeySpec : The type of key material in the public key, such as RSA_4096 or ECC_NIST_P521 .

• KeyUsage : Whether the key is used for encryption or signing.

• EncryptionAlgorithms or SigningAlgorithms : A list of the encryption algorithms or the signing algorithms for the key.

Although KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide .

Cross-account use : Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions : kms:GetPublicKey (key policy)

Related operations : CreateKey

See also: AWS API Documentation

Request Syntax

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

type KeyId

string

param KeyId

[REQUIRED]

Identifies the asymmetric KMS key that includes the public key.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/" . To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To get the alias name and alias ARN, use ListAliases .

type GrantTokens

list

param GrantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency . For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide .

• (string) --

rtype

dict

returns

Response Syntax

{
    'KeyId': 'string',
    'PublicKey': b'bytes',
    'CustomerMasterKeySpec': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'SYMMETRIC_DEFAULT'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512',
    'KeySpec': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'SYMMETRIC_DEFAULT'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512',
    'KeyUsage': 'SIGN_VERIFY'|'ENCRYPT_DECRYPT'|'GENERATE_VERIFY_MAC',
    'EncryptionAlgorithms': [
        'SYMMETRIC_DEFAULT'|'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256',
    ],
    'SigningAlgorithms': [
        'RSASSA_PSS_SHA_256'|'RSASSA_PSS_SHA_384'|'RSASSA_PSS_SHA_512'|'RSASSA_PKCS1_V1_5_SHA_256'|'RSASSA_PKCS1_V1_5_SHA_384'|'RSASSA_PKCS1_V1_5_SHA_512'|'ECDSA_SHA_256'|'ECDSA_SHA_384'|'ECDSA_SHA_512',
    ]
}

Response Structure

• (dict) --

  • KeyId (string) --

    The Amazon Resource Name (key ARN ) of the asymmetric KMS key from which the public key was downloaded.

  • PublicKey (bytes) --

    The exported public key.

    The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280 . When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

  • CustomerMasterKeySpec (string) --

    Instead, use the KeySpec field in the GetPublicKey response.

    The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both fields.

  • KeySpec (string) --

    The type of the of the public key that was downloaded.

  • KeyUsage (string) --

    The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY .

    This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.

  • EncryptionAlgorithms (list) --

    The encryption algorithms that KMS supports for this key.

    This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

    This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT .

    • (string) --

  • SigningAlgorithms (list) --

    The signing algorithms that KMS supports for this key.

    This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY .

    • (string) --

{'Grants': {'Operations': {'GenerateMac', 'VerifyMac'}}}

Gets a list of all grants for the specified KMS key.

You must specify the KMS key in all requests. You can filter the grant list by grant ID or grantee principal.

For detailed information about grants, including grant terminology, see Grants in KMS in the * Key Management Service Developer Guide * . For examples of working with grants in several programming languages, see Programming grants .

• CreateGrant

• ListRetirableGrants

• RetireGrant

• RevokeGrant

See also: AWS API Documentation

Request Syntax

client.list_grants(
    Limit=123,
    Marker='string',
    KeyId='string',
    GrantId='string',
    GranteePrincipal='string'
)

type Limit

integer

param Limit

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

type Marker

string

param Marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

type KeyId

string

param KeyId

[REQUIRED]

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey .

type GrantId

string

param GrantId

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

type GranteePrincipal

string

param GranteePrincipal

Returns only grants where the specified principal is the grantee principal for the grant.

rtype

dict

returns

Response Syntax

{
    'Grants': [
        {
            'KeyId': 'string',
            'GrantId': 'string',
            'Name': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'GranteePrincipal': 'string',
            'RetiringPrincipal': 'string',
            'IssuingAccount': 'string',
            'Operations': [
                'Decrypt'|'Encrypt'|'GenerateDataKey'|'GenerateDataKeyWithoutPlaintext'|'ReEncryptFrom'|'ReEncryptTo'|'Sign'|'Verify'|'GetPublicKey'|'CreateGrant'|'RetireGrant'|'DescribeKey'|'GenerateDataKeyPair'|'GenerateDataKeyPairWithoutPlaintext'|'GenerateMac'|'VerifyMac',
            ],
            'Constraints': {
                'EncryptionContextSubset': {
                    'string': 'string'
                },
                'EncryptionContextEquals': {
                    'string': 'string'
                }
            }
        },
    ],
    'NextMarker': 'string',
    'Truncated': True|False
}

Response Structure

• (dict) --

  • Grants (list) --

    A list of grants.

    • (dict) --

      Contains information about a grant.

      • KeyId (string) --

        The unique identifier for the KMS key to which the grant applies.

      • GrantId (string) --

        The unique identifier for the grant.

      • Name (string) --

        The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

      • CreationDate (datetime) --

        The date and time when the grant was created.

      • GranteePrincipal (string) --

        The identity that gets the permissions in the grant.

        The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal , which might represent several different grantee principals.

      • RetiringPrincipal (string) --

        The principal that can retire the grant.

      • IssuingAccount (string) --

        The Amazon Web Services account under which the grant was issued.

      • Operations (list) --

        The list of operations permitted by the grant.

        • (string) --

      • Constraints (dict) --

        A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

        • EncryptionContextSubset (dict) --

          A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

          • (string) --

            • (string) --

        • EncryptionContextEquals (dict) --

          A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

          • (string) --

            • (string) --

  • NextMarker (string) --

    When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

  • Truncated (boolean) --

    A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

{'Grants': {'Operations': {'GenerateMac', 'VerifyMac'}}}

Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal.

You can specify any principal in your Amazon Web Services account. The grants that are returned include grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.

For detailed information about grants, including grant terminology, see Grants in KMS in the * Key Management Service Developer Guide * . For examples of working with grants in several programming languages, see Programming grants .

Cross-account use : You must specify a principal in your Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need kms:ListRetirableGrants permission (or any other additional permission) in any Amazon Web Services account other than your own.

Required permissions : kms:ListRetirableGrants (IAM policy) in your Amazon Web Services account.

Related operations:

• CreateGrant

• ListGrants

• RetireGrant

• RevokeGrant

See also: AWS API Documentation

Request Syntax

client.list_retirable_grants(
    Limit=123,
    Marker='string',
    RetiringPrincipal='string'
)

type Limit

integer

param Limit

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

type Marker

string

param Marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

type RetiringPrincipal

string

param RetiringPrincipal

[REQUIRED]

The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference .

rtype

dict

returns

Response Syntax

{
    'Grants': [
        {
            'KeyId': 'string',
            'GrantId': 'string',
            'Name': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'GranteePrincipal': 'string',
            'RetiringPrincipal': 'string',
            'IssuingAccount': 'string',
            'Operations': [
                'Decrypt'|'Encrypt'|'GenerateDataKey'|'GenerateDataKeyWithoutPlaintext'|'ReEncryptFrom'|'ReEncryptTo'|'Sign'|'Verify'|'GetPublicKey'|'CreateGrant'|'RetireGrant'|'DescribeKey'|'GenerateDataKeyPair'|'GenerateDataKeyPairWithoutPlaintext'|'GenerateMac'|'VerifyMac',
            ],
            'Constraints': {
                'EncryptionContextSubset': {
                    'string': 'string'
                },
                'EncryptionContextEquals': {
                    'string': 'string'
                }
            }
        },
    ],
    'NextMarker': 'string',
    'Truncated': True|False
}

Response Structure

• (dict) --

  • Grants (list) --

    A list of grants.

    • (dict) --

      Contains information about a grant.

      • KeyId (string) --

        The unique identifier for the KMS key to which the grant applies.

      • GrantId (string) --

        The unique identifier for the grant.

      • Name (string) --

        The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

      • CreationDate (datetime) --

        The date and time when the grant was created.

      • GranteePrincipal (string) --

        The identity that gets the permissions in the grant.

        The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal , which might represent several different grantee principals.

      • RetiringPrincipal (string) --

        The principal that can retire the grant.

      • IssuingAccount (string) --

        The Amazon Web Services account under which the grant was issued.

      • Operations (list) --

        The list of operations permitted by the grant.

        • (string) --

      • Constraints (dict) --

        A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

        • EncryptionContextSubset (dict) --

          A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

          • (string) --

            • (string) --

        • EncryptionContextEquals (dict) --

          A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

          • (string) --

            • (string) --

  • NextMarker (string) --

    When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

  • Truncated (boolean) --

    A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

{'ReplicaKeyMetadata': {'CustomerMasterKeySpec': {'HMAC_224',
                                                  'HMAC_256',
                                                  'HMAC_384',
                                                  'HMAC_512'},
                        'KeySpec': {'HMAC_224',
                                    'HMAC_256',
                                    'HMAC_384',
                                    'HMAC_512'},
                        'KeyUsage': {'GENERATE_VERIFY_MAC'},
                        'MacAlgorithms': ['HMAC_SHA_224 | HMAC_SHA_256 | '
                                          'HMAC_SHA_384 | HMAC_SHA_512']}}

Replicates a multi-Region key into the specified Region. This operation creates a multi-Region replica key based on a multi-Region primary key in a different Region of the same Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a different Region. To create a multi-Region primary key, use the CreateKey operation.

This operation supports multi-Region keys , an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide .

A replica key is a fully-functional KMS key that can be used independently of its primary and peer replica keys. A primary key and its replica keys share properties that make them interoperable. They have the same key ID and key material. They also have the same key spec , key usage , key material origin , and automatic key rotation status . KMS automatically synchronizes these shared properties among related multi-Region keys. All other properties of a replica key can differ, including its key policy , tags , aliases , and Key states of KMS keys . KMS pricing and quotas for KMS keys apply to each primary key and replica key.

When this operation completes, the new replica key has a transient key state of Creating . This key state changes to Enabled (or PendingImport ) after a few seconds when the process of creating the new replica key is complete. While the key state is Creating , you can manage key, but you cannot yet use it in cryptographic operations. If you are creating and using the replica key programmatically, retry on KMSInvalidStateException or call DescribeKey to check its KeyState value before using it. For details about the Creating key state, see Key states of KMS keys in the Key Management Service Developer Guide .

You cannot create more than one replica of a primary key in any Region. If the Region already includes a replica of the key you're trying to replicate, ReplicateKey returns an AlreadyExistsException error. If the key state of the existing replica is PendingDeletion , you can cancel the scheduled key deletion ( CancelKeyDeletion ) or wait for the key to be deleted. The new replica key you create will have the same shared properties as the original replica key.

The CloudTrail log of a ReplicateKey operation records a ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region.

If you replicate a multi-Region primary key with imported key material, the replica key is created with no key material. You must import the same key material that you imported into the primary key. For details, see Importing key material into multi-Region keys in the Key Management Service Developer Guide .

To convert a replica key to a primary key, use the UpdatePrimaryRegion operation.

• kms:ReplicateKey on the primary key (in the primary key's Region). Include this permission in the primary key's key policy.

• kms:CreateKey in an IAM policy in the replica Region.

• To use the Tags parameter, kms:TagResource in an IAM policy in the replica Region.

Related operations

• CreateKey

• UpdatePrimaryRegion

See also: AWS API Documentation

Request Syntax

client.replicate_key(
    KeyId='string',
    ReplicaRegion='string',
    Policy='string',
    BypassPolicyLockoutSafetyCheck=True|False,
    Description='string',
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)

type KeyId

string

param KeyId

[REQUIRED]

Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

• Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey .

type ReplicaRegion

string

param ReplicaRegion

[REQUIRED]

The Region ID of the Amazon Web Services Region for this replica key.

Enter the Region ID, such as us-east-1 or ap-southeast-2 . For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference .

Note

HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to replicate an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the ReplicateKey operation returns an UnsupportedOperationException . For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide .

The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region. For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference . For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference .

type Policy

string

param Policy

The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.

The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.

If you provide a key policy, it must meet the following criteria:

• If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the * Key Management Service Developer Guide * .

• Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the * Identity and Access Management User Guide * .

• The key policy size quota is 32 kilobytes (32768 bytes).

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 risk that the KMS key 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 Key Management Service Developer Guide .

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

The default value is false.

type Description

string

param Description

A description of the KMS key. The default value is an empty string (no description).

The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.

type Tags

list

param Tags

Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

Note

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide .

To use this parameter, you must have kms:TagResource permission in an IAM policy.

Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys .

• (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.

  For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the Amazon Web Services Billing and Cost Management User Guide .

  • TagKey (string) -- [REQUIRED]

    The key of the tag.

  • TagValue (string) -- [REQUIRED]

    The value of the tag.

rtype

dict

returns

Response Syntax

{
    'ReplicaKeyMetadata': {
        'AWSAccountId': 'string',
        'KeyId': 'string',
        'Arn': 'string',
        'CreationDate': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Description': 'string',
        'KeyUsage': 'SIGN_VERIFY'|'ENCRYPT_DECRYPT'|'GENERATE_VERIFY_MAC',
        'KeyState': 'Creating'|'Enabled'|'Disabled'|'PendingDeletion'|'PendingImport'|'PendingReplicaDeletion'|'Unavailable'|'Updating',
        'DeletionDate': datetime(2015, 1, 1),
        'ValidTo': datetime(2015, 1, 1),
        'Origin': 'AWS_KMS'|'EXTERNAL'|'AWS_CLOUDHSM',
        'CustomKeyStoreId': 'string',
        'CloudHsmClusterId': 'string',
        'ExpirationModel': 'KEY_MATERIAL_EXPIRES'|'KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyManager': 'AWS'|'CUSTOMER',
        'CustomerMasterKeySpec': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'SYMMETRIC_DEFAULT'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512',
        'KeySpec': 'RSA_2048'|'RSA_3072'|'RSA_4096'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'SYMMETRIC_DEFAULT'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512',
        'EncryptionAlgorithms': [
            'SYMMETRIC_DEFAULT'|'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256',
        ],
        'SigningAlgorithms': [
            'RSASSA_PSS_SHA_256'|'RSASSA_PSS_SHA_384'|'RSASSA_PSS_SHA_512'|'RSASSA_PKCS1_V1_5_SHA_256'|'RSASSA_PKCS1_V1_5_SHA_384'|'RSASSA_PKCS1_V1_5_SHA_512'|'ECDSA_SHA_256'|'ECDSA_SHA_384'|'ECDSA_SHA_512',
        ],
        'MultiRegion': True|False,
        'MultiRegionConfiguration': {
            'MultiRegionKeyType': 'PRIMARY'|'REPLICA',
            'PrimaryKey': {
                'Arn': 'string',
                'Region': 'string'
            },
            'ReplicaKeys': [
                {
                    'Arn': 'string',
                    'Region': 'string'
                },
            ]
        },
        'PendingDeletionWindowInDays': 123,
        'MacAlgorithms': [
            'HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512',
        ]
    },
    'ReplicaPolicy': 'string',
    'ReplicaTags': [
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • ReplicaKeyMetadata (dict) --

    Displays details about the new replica key, including its Amazon Resource Name (key ARN ) and Key states of KMS keys . It also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.

    • AWSAccountId (string) --

      The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

    • KeyId (string) --

      The globally unique identifier for the KMS key.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference .

    • CreationDate (datetime) --

      The date and time when the KMS key was created.

    • Enabled (boolean) --

      Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.

    • Description (string) --

      The description of the KMS key.

    • KeyUsage (string) --

      The cryptographic operations for which you can use the KMS key.

    • KeyState (string) --

      The current status of the KMS key.

      For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide .

    • DeletionDate (datetime) --

      The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion .

      When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.

    • ValidTo (datetime) --

      The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES , otherwise this value is omitted.

    • Origin (string) --

      The source of the key material for the KMS key. When this value is AWS_KMS , KMS created the key material. When this value is EXTERNAL , the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM , the key material was created in the CloudHSM cluster associated with a custom key store.

    • CustomKeyStoreId (string) --

      A unique identifier for the custom key store that contains the KMS key. This value is present only when the KMS key is created in a custom key store.

    • CloudHsmClusterId (string) --

      The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in a custom key store , KMS creates the key material for the KMS key in the associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key store.

    • ExpirationModel (string) --

      Specifies whether the KMS key's key material expires. This value is present only when Origin is EXTERNAL , otherwise this value is omitted.

    • KeyManager (string) --

      The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide .

    • CustomerMasterKeySpec (string) --

      Instead, use the KeySpec field.

      The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both fields.

    • KeySpec (string) --

      Describes the type of key material in the KMS key.

    • EncryptionAlgorithms (list) --

      The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

      This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT .

      • (string) --

    • SigningAlgorithms (list) --

      The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

      This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY .

      • (string) --

    • MultiRegion (boolean) --

      Indicates whether the KMS key is a multi-Region (True ) or regional (False ) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.

      For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide .

    • MultiRegionConfiguration (dict) --

      Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True .

      For more information about any listed KMS key, use the DescribeKey operation.

      • MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.

      • PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.

      • ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

      • MultiRegionKeyType (string) --

        Indicates whether the KMS key is a PRIMARY or REPLICA key.

      • PrimaryKey (dict) --

        Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.

        • Arn (string) --

          Displays the key ARN of a primary or replica key of a multi-Region key.

        • Region (string) --

          Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

      • ReplicaKeys (list) --

        displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

        • (dict) --

          Describes the primary or replica key in a multi-Region key.

          • Arn (string) --

            Displays the key ARN of a primary or replica key of a multi-Region key.

          • Region (string) --

            Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

    • PendingDeletionWindowInDays (integer) --

      The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion . That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

      When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.

    • MacAlgorithms (list) --

      The message authentication code (MAC) algorithm that the HMAC KMS key supports.

      This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC .

      • (string) --

  • ReplicaPolicy (string) --

    The key policy of the new replica key. The value is a key policy document in JSON format.

  • ReplicaTags (list) --

    The tags on the new replica key. The value is a list of tag key and tag value pairs.

    • (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.

      For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the Amazon Web Services Billing and Cost Management User Guide .

      • TagKey (string) --

        The key of the tag.

      • TagValue (string) --

        The value of the tag.