GetJobDetails 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, "codepipeline")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://codepipeline.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"codepipeline.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,"jobId","string")
; The JSON request body created by the above code:
; {
; "jobId": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","CodePipeline_20150709.GetJobDetails")
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
BucketName.s
ObjectKey.s
locationType.s
name.s
revision.s
S3LocationBucketName.s
S3LocationObjectKey.s
AccountId.s = CkJsonObject::ckStringOf(jResp,"jobDetails.accountId")
v_String.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.actionConfiguration.configuration.string")
Category.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.actionTypeId.category")
Owner.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.actionTypeId.owner")
Provider.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.actionTypeId.provider")
Version.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.actionTypeId.version")
AccessKeyId.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.artifactCredentials.accessKeyId")
SecretAccessKey.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.artifactCredentials.secretAccessKey")
SessionToken.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.artifactCredentials.sessionToken")
ContinuationToken.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.continuationToken")
Id.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.encryptionKey.id")
v_Type.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.encryptionKey.type")
ActionExecutionId.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.pipelineContext.action.actionExecutionId")
Name.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.pipelineContext.action.name")
PipelineArn.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.pipelineContext.pipelineArn")
PipelineExecutionId.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.pipelineContext.pipelineExecutionId")
PipelineName.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.pipelineContext.pipelineName")
StageName.s = CkJsonObject::ckStringOf(jResp,"jobDetails.data.pipelineContext.stage.name")
jobDetailsId.s = CkJsonObject::ckStringOf(jResp,"jobDetails.id")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"jobDetails.data.inputArtifacts")
While i < count_i
CkJsonObject::setCkI(jResp, i)
BucketName = CkJsonObject::ckStringOf(jResp,"jobDetails.data.inputArtifacts[i].location.s3Location.bucketName")
ObjectKey = CkJsonObject::ckStringOf(jResp,"jobDetails.data.inputArtifacts[i].location.s3Location.objectKey")
locationType = CkJsonObject::ckStringOf(jResp,"jobDetails.data.inputArtifacts[i].location.type")
name = CkJsonObject::ckStringOf(jResp,"jobDetails.data.inputArtifacts[i].name")
revision = CkJsonObject::ckStringOf(jResp,"jobDetails.data.inputArtifacts[i].revision")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"jobDetails.data.outputArtifacts")
While i < count_i
CkJsonObject::setCkI(jResp, i)
S3LocationBucketName = CkJsonObject::ckStringOf(jResp,"jobDetails.data.outputArtifacts[i].location.s3Location.bucketName")
S3LocationObjectKey = CkJsonObject::ckStringOf(jResp,"jobDetails.data.outputArtifacts[i].location.s3Location.objectKey")
locationType = CkJsonObject::ckStringOf(jResp,"jobDetails.data.outputArtifacts[i].location.type")
name = CkJsonObject::ckStringOf(jResp,"jobDetails.data.outputArtifacts[i].name")
revision = CkJsonObject::ckStringOf(jResp,"jobDetails.data.outputArtifacts[i].revision")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "jobDetails": {
; "accountId": "string",
; "data": {
; "actionConfiguration": {
; "configuration": {
; "string": "string"
; }
; },
; "actionTypeId": {
; "category": "string",
; "owner": "string",
; "provider": "string",
; "version": "string"
; },
; "artifactCredentials": {
; "accessKeyId": "string",
; "secretAccessKey": "string",
; "sessionToken": "string"
; },
; "continuationToken": "string",
; "encryptionKey": {
; "id": "string",
; "type": "string"
; },
; "inputArtifacts": [
; {
; "location": {
; "s3Location": {
; "bucketName": "string",
; "objectKey": "string"
; },
; "type": "string"
; },
; "name": "string",
; "revision": "string"
; }
; ],
; "outputArtifacts": [
; {
; "location": {
; "s3Location": {
; "bucketName": "string",
; "objectKey": "string"
; },
; "type": "string"
; },
; "name": "string",
; "revision": "string"
; }
; ],
; "pipelineContext": {
; "action": {
; "actionExecutionId": "string",
; "name": "string"
; },
; "pipelineArn": "string",
; "pipelineExecutionId": "string",
; "pipelineName": "string",
; "stage": {
; "name": "string"
; }
; }
; },
; "id": "string"
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
