DescribeKey PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(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::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "kms")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://kms.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"kms.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"GrantTokens[0]","string")
CkJsonObject::ckUpdateString(json,"KeyId","string")
; The JSON request body created by the above code:
; {
; "GrantTokens": [
; "string"
; ],
; "KeyId": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","TrentService.DescribeKey")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(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
strVal.s
Arn.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.Arn")
AWSAccountId.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.AWSAccountId")
CloudHsmClusterId.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.CloudHsmClusterId")
CreationDate.i = CkJsonObject::ckIntOf(jResp,"KeyMetadata.CreationDate")
CustomerMasterKeySpec.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.CustomerMasterKeySpec")
CustomKeyStoreId.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.CustomKeyStoreId")
DeletionDate.i = CkJsonObject::ckIntOf(jResp,"KeyMetadata.DeletionDate")
Description.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.Description")
Enabled.i = CkJsonObject::ckIntOf(jResp,"KeyMetadata.Enabled")
ExpirationModel.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.ExpirationModel")
KeyId.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.KeyId")
KeyManager.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.KeyManager")
KeySpec.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.KeySpec")
KeyState.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.KeyState")
KeyUsage.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.KeyUsage")
MultiRegion.i = CkJsonObject::ckIntOf(jResp,"KeyMetadata.MultiRegion")
MultiRegionKeyType.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.MultiRegionConfiguration.MultiRegionKeyType")
PrimaryKeyArn.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.MultiRegionConfiguration.PrimaryKey.Arn")
Region.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.MultiRegionConfiguration.PrimaryKey.Region")
Origin.s = CkJsonObject::ckStringOf(jResp,"KeyMetadata.Origin")
PendingDeletionWindowInDays.i = CkJsonObject::ckIntOf(jResp,"KeyMetadata.PendingDeletionWindowInDays")
ValidTo.i = CkJsonObject::ckIntOf(jResp,"KeyMetadata.ValidTo")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"KeyMetadata.EncryptionAlgorithms")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"KeyMetadata.EncryptionAlgorithms[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"KeyMetadata.MacAlgorithms")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"KeyMetadata.MacAlgorithms[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"KeyMetadata.MultiRegionConfiguration.ReplicaKeys")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Arn = CkJsonObject::ckStringOf(jResp,"KeyMetadata.MultiRegionConfiguration.ReplicaKeys[i].Arn")
Region = CkJsonObject::ckStringOf(jResp,"KeyMetadata.MultiRegionConfiguration.ReplicaKeys[i].Region")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"KeyMetadata.SigningAlgorithms")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"KeyMetadata.SigningAlgorithms[i]")
i = i + 1
Wend
; 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::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
