DescribeCertificate 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, "acm")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://acm.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"acm.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,"CertificateArn","string")
; The JSON request body created by the above code:
; {
; "CertificateArn": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","CertificateManager.DescribeCertificate")
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
Name.s
ResourceRecordType.s
Value.s
ValidationDomain.s
ValidationMethod.s
ValidationStatus.s
j.i
count_j.i
strVal.s
OID.s
ResourceRecordName.s
ResourceRecordValue.s
CertificateArn.s = CkJsonObject::ckStringOf(jResp,"Certificate.CertificateArn")
CertificateAuthorityArn.s = CkJsonObject::ckStringOf(jResp,"Certificate.CertificateAuthorityArn")
CreatedAt.i = CkJsonObject::ckIntOf(jResp,"Certificate.CreatedAt")
DomainName.s = CkJsonObject::ckStringOf(jResp,"Certificate.DomainName")
FailureReason.s = CkJsonObject::ckStringOf(jResp,"Certificate.FailureReason")
ImportedAt.i = CkJsonObject::ckIntOf(jResp,"Certificate.ImportedAt")
IssuedAt.i = CkJsonObject::ckIntOf(jResp,"Certificate.IssuedAt")
Issuer.s = CkJsonObject::ckStringOf(jResp,"Certificate.Issuer")
KeyAlgorithm.s = CkJsonObject::ckStringOf(jResp,"Certificate.KeyAlgorithm")
NotAfter.i = CkJsonObject::ckIntOf(jResp,"Certificate.NotAfter")
NotBefore.i = CkJsonObject::ckIntOf(jResp,"Certificate.NotBefore")
CertificateTransparencyLoggingPreference.s = CkJsonObject::ckStringOf(jResp,"Certificate.Options.CertificateTransparencyLoggingPreference")
RenewalEligibility.s = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalEligibility")
RenewalStatus.s = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalSummary.RenewalStatus")
RenewalStatusReason.s = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalSummary.RenewalStatusReason")
UpdatedAt.i = CkJsonObject::ckIntOf(jResp,"Certificate.RenewalSummary.UpdatedAt")
RevocationReason.s = CkJsonObject::ckStringOf(jResp,"Certificate.RevocationReason")
RevokedAt.i = CkJsonObject::ckIntOf(jResp,"Certificate.RevokedAt")
Serial.s = CkJsonObject::ckStringOf(jResp,"Certificate.Serial")
SignatureAlgorithm.s = CkJsonObject::ckStringOf(jResp,"Certificate.SignatureAlgorithm")
Status.s = CkJsonObject::ckStringOf(jResp,"Certificate.Status")
Subject.s = CkJsonObject::ckStringOf(jResp,"Certificate.Subject")
v_Type.s = CkJsonObject::ckStringOf(jResp,"Certificate.Type")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Certificate.DomainValidationOptions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
DomainName = CkJsonObject::ckStringOf(jResp,"Certificate.DomainValidationOptions[i].DomainName")
Name = CkJsonObject::ckStringOf(jResp,"Certificate.DomainValidationOptions[i].ResourceRecord.Name")
ResourceRecordType = CkJsonObject::ckStringOf(jResp,"Certificate.DomainValidationOptions[i].ResourceRecord.Type")
Value = CkJsonObject::ckStringOf(jResp,"Certificate.DomainValidationOptions[i].ResourceRecord.Value")
ValidationDomain = CkJsonObject::ckStringOf(jResp,"Certificate.DomainValidationOptions[i].ValidationDomain")
ValidationMethod = CkJsonObject::ckStringOf(jResp,"Certificate.DomainValidationOptions[i].ValidationMethod")
ValidationStatus = CkJsonObject::ckStringOf(jResp,"Certificate.DomainValidationOptions[i].ValidationStatus")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"Certificate.DomainValidationOptions[i].ValidationEmails")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"Certificate.DomainValidationOptions[i].ValidationEmails[j]")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"Certificate.ExtendedKeyUsages")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Name = CkJsonObject::ckStringOf(jResp,"Certificate.ExtendedKeyUsages[i].Name")
OID = CkJsonObject::ckStringOf(jResp,"Certificate.ExtendedKeyUsages[i].OID")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"Certificate.InUseBy")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"Certificate.InUseBy[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"Certificate.KeyUsages")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Name = CkJsonObject::ckStringOf(jResp,"Certificate.KeyUsages[i].Name")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"Certificate.RenewalSummary.DomainValidationOptions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
DomainName = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalSummary.DomainValidationOptions[i].DomainName")
ResourceRecordName = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalSummary.DomainValidationOptions[i].ResourceRecord.Name")
ResourceRecordType = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalSummary.DomainValidationOptions[i].ResourceRecord.Type")
ResourceRecordValue = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalSummary.DomainValidationOptions[i].ResourceRecord.Value")
ValidationDomain = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalSummary.DomainValidationOptions[i].ValidationDomain")
ValidationMethod = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalSummary.DomainValidationOptions[i].ValidationMethod")
ValidationStatus = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalSummary.DomainValidationOptions[i].ValidationStatus")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"Certificate.RenewalSummary.DomainValidationOptions[i].ValidationEmails")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"Certificate.RenewalSummary.DomainValidationOptions[i].ValidationEmails[j]")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"Certificate.SubjectAlternativeNames")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"Certificate.SubjectAlternativeNames[i]")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "Certificate": {
; "CertificateArn": "string",
; "CertificateAuthorityArn": "string",
; "CreatedAt": number,
; "DomainName": "string",
; "DomainValidationOptions": [
; {
; "DomainName": "string",
; "ResourceRecord": {
; "Name": "string",
; "Type": "string",
; "Value": "string"
; },
; "ValidationDomain": "string",
; "ValidationEmails": [
; "string"
; ],
; "ValidationMethod": "string",
; "ValidationStatus": "string"
; }
; ],
; "ExtendedKeyUsages": [
; {
; "Name": "string",
; "OID": "string"
; }
; ],
; "FailureReason": "string",
; "ImportedAt": number,
; "InUseBy": [
; "string"
; ],
; "IssuedAt": number,
; "Issuer": "string",
; "KeyAlgorithm": "string",
; "KeyUsages": [
; {
; "Name": "string"
; }
; ],
; "NotAfter": number,
; "NotBefore": number,
; "Options": {
; "CertificateTransparencyLoggingPreference": "string"
; },
; "RenewalEligibility": "string",
; "RenewalSummary": {
; "DomainValidationOptions": [
; {
; "DomainName": "string",
; "ResourceRecord": {
; "Name": "string",
; "Type": "string",
; "Value": "string"
; },
; "ValidationDomain": "string",
; "ValidationEmails": [
; "string"
; ],
; "ValidationMethod": "string",
; "ValidationStatus": "string"
; }
; ],
; "RenewalStatus": "string",
; "RenewalStatusReason": "string",
; "UpdatedAt": number
; },
; "RevocationReason": "string",
; "RevokedAt": number,
; "Serial": "string",
; "SignatureAlgorithm": "string",
; "Status": "string",
; "Subject": "string",
; "SubjectAlternativeNames": [
; "string"
; ],
; "Type": "string"
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
