DescribeKey C++ Example
#include <CkRest.h>
#include <CkAuthAws.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
void ChilkatSample(void)
{
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkRest rest;
bool success;
CkAuthAws authAws;
authAws.put_AccessKey("AWS_ACCESS_KEY");
authAws.put_SecretKey("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.)
authAws.put_Region("us-west-2");
authAws.put_ServiceName("kms");
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws);
// URL: https://kms.us-west-2.amazonaws.com/
// Use the same region as specified above.
success = rest.Connect("kms.us-west-2.amazonaws.com",443,true,true);
if (success != true) {
std::cout << "ConnectFailReason: " << rest.get_ConnectFailReason() << "\r\n";
std::cout << rest.lastErrorText() << "\r\n";
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
CkJsonObject json;
json.UpdateString("GrantTokens[0]","string");
json.UpdateString("KeyId","string");
// The JSON request body created by the above code:
// {
// "GrantTokens": [
// "string"
// ],
// "KeyId": "string"
// }
rest.AddHeader("Content-Type","application/x-amz-json-1.1");
rest.AddHeader("X-Amz-Target","TrentService.DescribeKey");
CkStringBuilder sbRequestBody;
json.EmitSb(sbRequestBody);
CkStringBuilder sbResponseBody;
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody);
if (success != true) {
std::cout << rest.lastErrorText() << "\r\n";
return;
}
int respStatusCode = rest.get_ResponseStatusCode();
std::cout << "response status code = " << respStatusCode << "\r\n";
if (respStatusCode != 200) {
std::cout << "Response Header:" << "\r\n";
std::cout << rest.responseHeader() << "\r\n";
std::cout << "Response Body:" << "\r\n";
std::cout << sbResponseBody.getAsString() << "\r\n";
return;
}
CkJsonObject jResp;
jResp.LoadSb(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.
const char *strVal = 0;
const char *Arn = jResp.stringOf("KeyMetadata.Arn");
const char *AWSAccountId = jResp.stringOf("KeyMetadata.AWSAccountId");
const char *CloudHsmClusterId = jResp.stringOf("KeyMetadata.CloudHsmClusterId");
int CreationDate = jResp.IntOf("KeyMetadata.CreationDate");
const char *CustomerMasterKeySpec = jResp.stringOf("KeyMetadata.CustomerMasterKeySpec");
const char *CustomKeyStoreId = jResp.stringOf("KeyMetadata.CustomKeyStoreId");
int DeletionDate = jResp.IntOf("KeyMetadata.DeletionDate");
const char *Description = jResp.stringOf("KeyMetadata.Description");
int Enabled = jResp.IntOf("KeyMetadata.Enabled");
const char *ExpirationModel = jResp.stringOf("KeyMetadata.ExpirationModel");
const char *KeyId = jResp.stringOf("KeyMetadata.KeyId");
const char *KeyManager = jResp.stringOf("KeyMetadata.KeyManager");
const char *KeySpec = jResp.stringOf("KeyMetadata.KeySpec");
const char *KeyState = jResp.stringOf("KeyMetadata.KeyState");
const char *KeyUsage = jResp.stringOf("KeyMetadata.KeyUsage");
int MultiRegion = jResp.IntOf("KeyMetadata.MultiRegion");
const char *MultiRegionKeyType = jResp.stringOf("KeyMetadata.MultiRegionConfiguration.MultiRegionKeyType");
const char *PrimaryKeyArn = jResp.stringOf("KeyMetadata.MultiRegionConfiguration.PrimaryKey.Arn");
const char *Region = jResp.stringOf("KeyMetadata.MultiRegionConfiguration.PrimaryKey.Region");
const char *Origin = jResp.stringOf("KeyMetadata.Origin");
int PendingDeletionWindowInDays = jResp.IntOf("KeyMetadata.PendingDeletionWindowInDays");
int ValidTo = jResp.IntOf("KeyMetadata.ValidTo");
int i = 0;
int count_i = jResp.SizeOfArray("KeyMetadata.EncryptionAlgorithms");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf("KeyMetadata.EncryptionAlgorithms[i]");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("KeyMetadata.MacAlgorithms");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf("KeyMetadata.MacAlgorithms[i]");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("KeyMetadata.MultiRegionConfiguration.ReplicaKeys");
while (i < count_i) {
jResp.put_I(i);
Arn = jResp.stringOf("KeyMetadata.MultiRegionConfiguration.ReplicaKeys[i].Arn");
Region = jResp.stringOf("KeyMetadata.MultiRegionConfiguration.ReplicaKeys[i].Region");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("KeyMetadata.SigningAlgorithms");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf("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
// }
// }
}