You can get information about your customer master keys (CMKs) at any time.

Listing Your CMKs

Before you begin: See Installing and Configuring OSC CLI to set up OSC CLI.


  • To list your CMKs, use the ListKeys command following this syntax:

    Request sample
    $> osc-cli okms ListKeys


    The ListKeys command returns the following elements:

    • Keys: Information about one or more CMKs.

      • KeyArn: The Outscale Resource Name (ORN) of the CMK.
      • KeyId: The ID of the CMK.
    Result sample
    {
        "Keys": [
            {
                "KeyArn": "arn:aws:kms:eu-west-2:987654321234:key/cmk-12345678",
                "KeyId": "cmk-12345678"
            },
            {
                "KeyArn": "arn:aws:kms:eu-west-2:987654321234:key/cmk-98765432",
                "KeyId": "cmk-98765432"
            }
        ]
    }

Getting Information About a CMK

Before you begin: See Installing and Configuring OSC CLI to set up OSC CLI.


  • To get information about a CMK, use the DescribeKey command following this syntax:

    Request sample
    $> osc-cli okms DescribeKey \
        --KeyId cmk-12345678

    This command contains the following attribute that you need to specify:

    • KeyId: The ID of the CMK.


    The DescribeKey command returns the following elements:

    • KeyMetadata: Information about the CMK.

      • Origin: The source of the key material for the CMK (always OKMS).
      • KeyId: The ID of the CMK.

      • Description: A description for the CMK.
      • DeletionDate: The date and time when the CMK will be deleted.
      • KeyManager: The manager of the CMK (always CUSTOMER).
      • Enabled: If true, the CMK is enabled. If false, it is disabled.
      • KeyUsage: The intended use of the CMK (always ENCRYPT_DECRYPT).
      • KeyState: The state of the CMK (Enabled | Disabled | PendingDeletion).
      • CreationDate: The date and time when the CMK was created.
      • Arn: The Outscale Resource Name (ORN) of the CMK.
      • AWSAccountId: The account ID of the owner of the CMK.
    Result sample
    {
        "KeyMetadata": {
            "Origin": "OKMS",
            "KeyId": "cmk-12345678",
            "Description": null,
            "DeletionDate": null,
            "KeyManager": "CUSTOMER",
            "Enabled": true,
            "KeyUsage": "ENCRYPT_DECRYPT",
            "KeyState": "Enabled",
            "CreationDate": "2019-11-22T13:00:00.000000+00:00",
            "Arn": "arn:aws:kms:eu-west-2:987654321234:key/cmk-12345678",
            "AWSAccountId": "987654321234"
        }
    }
Corresponding API Methods



AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.