Chilkat Online Tools

DescribeKey C Example

AWS Key Management Service

#include <C_CkRest.h>
#include <C_CkAuthAws.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkRest rest;
    BOOL success;
    HCkAuthAws authAws;
    HCkJsonObject json;
    HCkStringBuilder sbRequestBody;
    HCkStringBuilder sbResponseBody;
    int respStatusCode;
    HCkJsonObject jResp;
    const char *strVal;
    const char *Arn;
    const char *AWSAccountId;
    const char *CloudHsmClusterId;
    int CreationDate;
    const char *CustomerMasterKeySpec;
    const char *CustomKeyStoreId;
    int DeletionDate;
    const char *Description;
    int Enabled;
    const char *ExpirationModel;
    const char *KeyId;
    const char *KeyManager;
    const char *KeySpec;
    const char *KeyState;
    const char *KeyUsage;
    int MultiRegion;
    const char *MultiRegionKeyType;
    const char *PrimaryKeyArn;
    const char *Region;
    const char *Origin;
    int PendingDeletionWindowInDays;
    int ValidTo;
    int i;
    int count_i;

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    rest = CkRest_Create();

    authAws = CkAuthAws_Create();
    CkAuthAws_putAccessKey(authAws,"AWS_ACCESS_KEY");
    CkAuthAws_putSecretKey(authAws,"AWS_SECRET_KEY");

    // Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
    CkAuthAws_putRegion(authAws,"us-west-2");
    CkAuthAws_putServiceName(authAws,"kms");
    // SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest_SetAuthAws(rest,authAws);

    // URL: https://kms.us-west-2.amazonaws.com/
    // Use the same region as specified above.
    success = CkRest_Connect(rest,"kms.us-west-2.amazonaws.com",443,TRUE,TRUE);
    if (success != TRUE) {
        printf("ConnectFailReason: %d\n",CkRest_getConnectFailReason(rest));
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        CkAuthAws_Dispose(authAws);
        return;
    }

    // The following code creates the JSON request body.
    // The JSON created by this code is shown below.

    // Use this online tool to generate code from sample JSON:
    // Generate Code to Create JSON

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"GrantTokens[0]","string");
    CkJsonObject_UpdateString(json,"KeyId","string");

    // The JSON request body created by the above code:

    // {
    //   "GrantTokens": [
    //     "string"
    //   ],
    //   "KeyId": "string"
    // }

    CkRest_AddHeader(rest,"Content-Type","application/x-amz-json-1.1");
    CkRest_AddHeader(rest,"X-Amz-Target","TrentService.DescribeKey");

    sbRequestBody = CkStringBuilder_Create();
    CkJsonObject_EmitSb(json,sbRequestBody);
    sbResponseBody = CkStringBuilder_Create();
    success = CkRest_FullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    respStatusCode = CkRest_getResponseStatusCode(rest);
    printf("response status code = %d\n",respStatusCode);
    if (respStatusCode != 200) {
        printf("Response Header:\n");
        printf("%s\n",CkRest_responseHeader(rest));
        printf("Response Body:\n");
        printf("%s\n",CkStringBuilder_getAsString(sbResponseBody));
        CkRest_Dispose(rest);
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);

    // The following code parses the JSON response.
    // A sample JSON response is shown below the sample code.

    // Use this online tool to generate parsing code from sample JSON:
    // Generate Parsing Code from JSON

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
    // See this example explaining how this memory should be used: const char * functions.

    Arn = CkJsonObject_stringOf(jResp,"KeyMetadata.Arn");
    AWSAccountId = CkJsonObject_stringOf(jResp,"KeyMetadata.AWSAccountId");
    CloudHsmClusterId = CkJsonObject_stringOf(jResp,"KeyMetadata.CloudHsmClusterId");
    CreationDate = CkJsonObject_IntOf(jResp,"KeyMetadata.CreationDate");
    CustomerMasterKeySpec = CkJsonObject_stringOf(jResp,"KeyMetadata.CustomerMasterKeySpec");
    CustomKeyStoreId = CkJsonObject_stringOf(jResp,"KeyMetadata.CustomKeyStoreId");
    DeletionDate = CkJsonObject_IntOf(jResp,"KeyMetadata.DeletionDate");
    Description = CkJsonObject_stringOf(jResp,"KeyMetadata.Description");
    Enabled = CkJsonObject_IntOf(jResp,"KeyMetadata.Enabled");
    ExpirationModel = CkJsonObject_stringOf(jResp,"KeyMetadata.ExpirationModel");
    KeyId = CkJsonObject_stringOf(jResp,"KeyMetadata.KeyId");
    KeyManager = CkJsonObject_stringOf(jResp,"KeyMetadata.KeyManager");
    KeySpec = CkJsonObject_stringOf(jResp,"KeyMetadata.KeySpec");
    KeyState = CkJsonObject_stringOf(jResp,"KeyMetadata.KeyState");
    KeyUsage = CkJsonObject_stringOf(jResp,"KeyMetadata.KeyUsage");
    MultiRegion = CkJsonObject_IntOf(jResp,"KeyMetadata.MultiRegion");
    MultiRegionKeyType = CkJsonObject_stringOf(jResp,"KeyMetadata.MultiRegionConfiguration.MultiRegionKeyType");
    PrimaryKeyArn = CkJsonObject_stringOf(jResp,"KeyMetadata.MultiRegionConfiguration.PrimaryKey.Arn");
    Region = CkJsonObject_stringOf(jResp,"KeyMetadata.MultiRegionConfiguration.PrimaryKey.Region");
    Origin = CkJsonObject_stringOf(jResp,"KeyMetadata.Origin");
    PendingDeletionWindowInDays = CkJsonObject_IntOf(jResp,"KeyMetadata.PendingDeletionWindowInDays");
    ValidTo = CkJsonObject_IntOf(jResp,"KeyMetadata.ValidTo");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"KeyMetadata.EncryptionAlgorithms");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"KeyMetadata.EncryptionAlgorithms[i]");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"KeyMetadata.MacAlgorithms");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"KeyMetadata.MacAlgorithms[i]");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"KeyMetadata.MultiRegionConfiguration.ReplicaKeys");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        Arn = CkJsonObject_stringOf(jResp,"KeyMetadata.MultiRegionConfiguration.ReplicaKeys[i].Arn");
        Region = CkJsonObject_stringOf(jResp,"KeyMetadata.MultiRegionConfiguration.ReplicaKeys[i].Region");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"KeyMetadata.SigningAlgorithms");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"KeyMetadata.SigningAlgorithms[i]");
        i = i + 1;
    }

    // A sample JSON response body parsed by the above code:

    // {
    //   "KeyMetadata": {
    //     "Arn": "string",
    //     "AWSAccountId": "string",
    //     "CloudHsmClusterId": "string",
    //     "CreationDate": number,
    //     "CustomerMasterKeySpec": "string",
    //     "CustomKeyStoreId": "string",
    //     "DeletionDate": number,
    //     "Description": "string",
    //     "Enabled": boolean,
    //     "EncryptionAlgorithms": [
    //       "string"
    //     ],
    //     "ExpirationModel": "string",
    //     "KeyId": "string",
    //     "KeyManager": "string",
    //     "KeySpec": "string",
    //     "KeyState": "string",
    //     "KeyUsage": "string",
    //     "MacAlgorithms": [
    //       "string"
    //     ],
    //     "MultiRegion": boolean,
    //     "MultiRegionConfiguration": {
    //       "MultiRegionKeyType": "string",
    //       "PrimaryKey": {
    //         "Arn": "string",
    //         "Region": "string"
    //       },
    //       "ReplicaKeys": [
    //         {
    //           "Arn": "string",
    //           "Region": "string"
    //         }
    //       ]
    //     },
    //     "Origin": "string",
    //     "PendingDeletionWindowInDays": number,
    //     "SigningAlgorithms": [
    //       "string"
    //     ],
    //     "ValidTo": number
    //   }
    // }


    CkRest_Dispose(rest);
    CkAuthAws_Dispose(authAws);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbRequestBody);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }