Chilkat Online Tools

GetDeployment Ruby Example

AWS CodeDeploy

require 'chilkat'

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

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
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("codedeploy")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://codedeploy.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("codedeploy.us-west-2.amazonaws.com",443,true,true)
if (success != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("deploymentId","string")

# The JSON request body created by the above code:

# {
#   "deploymentId": "string"
# }

rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","CodeDeploy_20141006.GetDeployment")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
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

AdditionalDeploymentStatusInfo = jResp.stringOf("deploymentInfo.additionalDeploymentStatusInfo")
ApplicationName = jResp.stringOf("deploymentInfo.applicationName")
Enabled = jResp.IntOf("deploymentInfo.autoRollbackConfiguration.enabled")
ActionOnTimeout = jResp.stringOf("deploymentInfo.blueGreenDeploymentConfiguration.deploymentReadyOption.actionOnTimeout")
WaitTimeInMinutes = jResp.IntOf("deploymentInfo.blueGreenDeploymentConfiguration.deploymentReadyOption.waitTimeInMinutes")
Action = jResp.stringOf("deploymentInfo.blueGreenDeploymentConfiguration.greenFleetProvisioningOption.action")
TerminateBlueInstancesOnDeploymentSuccessAction = jResp.stringOf("deploymentInfo.blueGreenDeploymentConfiguration.terminateBlueInstancesOnDeploymentSuccess.action")
TerminationWaitTimeInMinutes = jResp.IntOf("deploymentInfo.blueGreenDeploymentConfiguration.terminateBlueInstancesOnDeploymentSuccess.terminationWaitTimeInMinutes")
CompleteTime = jResp.IntOf("deploymentInfo.completeTime")
ComputePlatform = jResp.stringOf("deploymentInfo.computePlatform")
CreateTime = jResp.IntOf("deploymentInfo.createTime")
Creator = jResp.stringOf("deploymentInfo.creator")
DeploymentConfigName = jResp.stringOf("deploymentInfo.deploymentConfigName")
DeploymentGroupName = jResp.stringOf("deploymentInfo.deploymentGroupName")
DeploymentId = jResp.stringOf("deploymentInfo.deploymentId")
Failed = jResp.IntOf("deploymentInfo.deploymentOverview.Failed")
InProgress = jResp.IntOf("deploymentInfo.deploymentOverview.InProgress")
Pending = jResp.IntOf("deploymentInfo.deploymentOverview.Pending")
Ready = jResp.IntOf("deploymentInfo.deploymentOverview.Ready")
Skipped = jResp.IntOf("deploymentInfo.deploymentOverview.Skipped")
Succeeded = jResp.IntOf("deploymentInfo.deploymentOverview.Succeeded")
DeploymentOption = jResp.stringOf("deploymentInfo.deploymentStyle.deploymentOption")
DeploymentType = jResp.stringOf("deploymentInfo.deploymentStyle.deploymentType")
Description = jResp.stringOf("deploymentInfo.description")
Code = jResp.stringOf("deploymentInfo.errorInformation.code")
Message = jResp.stringOf("deploymentInfo.errorInformation.message")
ExternalId = jResp.stringOf("deploymentInfo.externalId")
FileExistsBehavior = jResp.stringOf("deploymentInfo.fileExistsBehavior")
IgnoreApplicationStopFailures = jResp.IntOf("deploymentInfo.ignoreApplicationStopFailures")
InstanceTerminationWaitTimeStarted = jResp.IntOf("deploymentInfo.instanceTerminationWaitTimeStarted")
Content = jResp.stringOf("deploymentInfo.previousRevision.appSpecContent.content")
Sha256 = jResp.stringOf("deploymentInfo.previousRevision.appSpecContent.sha256")
CommitId = jResp.stringOf("deploymentInfo.previousRevision.gitHubLocation.commitId")
Repository = jResp.stringOf("deploymentInfo.previousRevision.gitHubLocation.repository")
RevisionType = jResp.stringOf("deploymentInfo.previousRevision.revisionType")
Bucket = jResp.stringOf("deploymentInfo.previousRevision.s3Location.bucket")
BundleType = jResp.stringOf("deploymentInfo.previousRevision.s3Location.bundleType")
ETag = jResp.stringOf("deploymentInfo.previousRevision.s3Location.eTag")
Key = jResp.stringOf("deploymentInfo.previousRevision.s3Location.key")
Version = jResp.stringOf("deploymentInfo.previousRevision.s3Location.version")
StringContent = jResp.stringOf("deploymentInfo.previousRevision.string.content")
StringSha256 = jResp.stringOf("deploymentInfo.previousRevision.string.sha256")
AutoUpdateOutdatedInstancesRootDeploymentId = jResp.stringOf("deploymentInfo.relatedDeployments.autoUpdateOutdatedInstancesRootDeploymentId")
AppSpecContentContent = jResp.stringOf("deploymentInfo.revision.appSpecContent.content")
AppSpecContentSha256 = jResp.stringOf("deploymentInfo.revision.appSpecContent.sha256")
GitHubLocationCommitId = jResp.stringOf("deploymentInfo.revision.gitHubLocation.commitId")
GitHubLocationRepository = jResp.stringOf("deploymentInfo.revision.gitHubLocation.repository")
RevisionRevisionType = jResp.stringOf("deploymentInfo.revision.revisionType")
S3LocationBucket = jResp.stringOf("deploymentInfo.revision.s3Location.bucket")
S3LocationBundleType = jResp.stringOf("deploymentInfo.revision.s3Location.bundleType")
S3LocationETag = jResp.stringOf("deploymentInfo.revision.s3Location.eTag")
S3LocationKey = jResp.stringOf("deploymentInfo.revision.s3Location.key")
S3LocationVersion = jResp.stringOf("deploymentInfo.revision.s3Location.version")
StringContent = jResp.stringOf("deploymentInfo.revision.string.content")
StringSha256 = jResp.stringOf("deploymentInfo.revision.string.sha256")
RollbackDeploymentId = jResp.stringOf("deploymentInfo.rollbackInfo.rollbackDeploymentId")
RollbackMessage = jResp.stringOf("deploymentInfo.rollbackInfo.rollbackMessage")
RollbackTriggeringDeploymentId = jResp.stringOf("deploymentInfo.rollbackInfo.rollbackTriggeringDeploymentId")
StartTime = jResp.IntOf("deploymentInfo.startTime")
Status = jResp.stringOf("deploymentInfo.status")
UpdateOutdatedInstancesOnly = jResp.IntOf("deploymentInfo.updateOutdatedInstancesOnly")
i = 0
count_i = jResp.SizeOfArray("deploymentInfo.autoRollbackConfiguration.events")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("deploymentInfo.autoRollbackConfiguration.events[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("deploymentInfo.deploymentStatusMessages")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("deploymentInfo.deploymentStatusMessages[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("deploymentInfo.loadBalancerInfo.elbInfoList")
while i < count_i
    jResp.put_I(i)
    name = jResp.stringOf("deploymentInfo.loadBalancerInfo.elbInfoList[i].name")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("deploymentInfo.loadBalancerInfo.targetGroupInfoList")
while i < count_i
    jResp.put_I(i)
    name = jResp.stringOf("deploymentInfo.loadBalancerInfo.targetGroupInfoList[i].name")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("deploymentInfo.loadBalancerInfo.targetGroupPairInfoList")
while i < count_i
    jResp.put_I(i)
    j = 0
    count_j = jResp.SizeOfArray("deploymentInfo.loadBalancerInfo.targetGroupPairInfoList[i].prodTrafficRoute.listenerArns")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("deploymentInfo.loadBalancerInfo.targetGroupPairInfoList[i].prodTrafficRoute.listenerArns[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("deploymentInfo.loadBalancerInfo.targetGroupPairInfoList[i].targetGroups")
    while j < count_j
        jResp.put_J(j)
        name = jResp.stringOf("deploymentInfo.loadBalancerInfo.targetGroupPairInfoList[i].targetGroups[j].name")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("deploymentInfo.loadBalancerInfo.targetGroupPairInfoList[i].testTrafficRoute.listenerArns")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("deploymentInfo.loadBalancerInfo.targetGroupPairInfoList[i].testTrafficRoute.listenerArns[j]")
        j = j + 1
    end
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("deploymentInfo.relatedDeployments.autoUpdateOutdatedInstancesDeploymentIds")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("deploymentInfo.relatedDeployments.autoUpdateOutdatedInstancesDeploymentIds[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("deploymentInfo.targetInstances.autoScalingGroups")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("deploymentInfo.targetInstances.autoScalingGroups[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("deploymentInfo.targetInstances.ec2TagSet.ec2TagSetList")
while i < count_i
    jResp.put_I(i)
    j = 0
    count_j = jResp.SizeOfArray("deploymentInfo.targetInstances.ec2TagSet.ec2TagSetList[i]")
    while j < count_j
        jResp.put_J(j)
        Key = jResp.stringOf("deploymentInfo.targetInstances.ec2TagSet.ec2TagSetList[i][j].Key")
        v_Type = jResp.stringOf("deploymentInfo.targetInstances.ec2TagSet.ec2TagSetList[i][j].Type")
        Value = jResp.stringOf("deploymentInfo.targetInstances.ec2TagSet.ec2TagSetList[i][j].Value")
        j = j + 1
    end
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("deploymentInfo.targetInstances.tagFilters")
while i < count_i
    jResp.put_I(i)
    Key = jResp.stringOf("deploymentInfo.targetInstances.tagFilters[i].Key")
    v_Type = jResp.stringOf("deploymentInfo.targetInstances.tagFilters[i].Type")
    Value = jResp.stringOf("deploymentInfo.targetInstances.tagFilters[i].Value")
    i = i + 1
end

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

# {
#   "deploymentInfo": {
#     "additionalDeploymentStatusInfo": "string",
#     "applicationName": "string",
#     "autoRollbackConfiguration": {
#       "enabled": boolean,
#       "events": [
#         "string"
#       ]
#     },
#     "blueGreenDeploymentConfiguration": {
#       "deploymentReadyOption": {
#         "actionOnTimeout": "string",
#         "waitTimeInMinutes": number
#       },
#       "greenFleetProvisioningOption": {
#         "action": "string"
#       },
#       "terminateBlueInstancesOnDeploymentSuccess": {
#         "action": "string",
#         "terminationWaitTimeInMinutes": number
#       }
#     },
#     "completeTime": number,
#     "computePlatform": "string",
#     "createTime": number,
#     "creator": "string",
#     "deploymentConfigName": "string",
#     "deploymentGroupName": "string",
#     "deploymentId": "string",
#     "deploymentOverview": {
#       "Failed": number,
#       "InProgress": number,
#       "Pending": number,
#       "Ready": number,
#       "Skipped": number,
#       "Succeeded": number
#     },
#     "deploymentStatusMessages": [
#       "string"
#     ],
#     "deploymentStyle": {
#       "deploymentOption": "string",
#       "deploymentType": "string"
#     },
#     "description": "string",
#     "errorInformation": {
#       "code": "string",
#       "message": "string"
#     },
#     "externalId": "string",
#     "fileExistsBehavior": "string",
#     "ignoreApplicationStopFailures": boolean,
#     "instanceTerminationWaitTimeStarted": boolean,
#     "loadBalancerInfo": {
#       "elbInfoList": [
#         {
#           "name": "string"
#         }
#       ],
#       "targetGroupInfoList": [
#         {
#           "name": "string"
#         }
#       ],
#       "targetGroupPairInfoList": [
#         {
#           "prodTrafficRoute": {
#             "listenerArns": [
#               "string"
#             ]
#           },
#           "targetGroups": [
#             {
#               "name": "string"
#             }
#           ],
#           "testTrafficRoute": {
#             "listenerArns": [
#               "string"
#             ]
#           }
#         }
#       ]
#     },
#     "previousRevision": {
#       "appSpecContent": {
#         "content": "string",
#         "sha256": "string"
#       },
#       "gitHubLocation": {
#         "commitId": "string",
#         "repository": "string"
#       },
#       "revisionType": "string",
#       "s3Location": {
#         "bucket": "string",
#         "bundleType": "string",
#         "eTag": "string",
#         "key": "string",
#         "version": "string"
#       },
#       "string": {
#         "content": "string",
#         "sha256": "string"
#       }
#     },
#     "relatedDeployments": {
#       "autoUpdateOutdatedInstancesDeploymentIds": [
#         "string"
#       ],
#       "autoUpdateOutdatedInstancesRootDeploymentId": "string"
#     },
#     "revision": {
#       "appSpecContent": {
#         "content": "string",
#         "sha256": "string"
#       },
#       "gitHubLocation": {
#         "commitId": "string",
#         "repository": "string"
#       },
#       "revisionType": "string",
#       "s3Location": {
#         "bucket": "string",
#         "bundleType": "string",
#         "eTag": "string",
#         "key": "string",
#         "version": "string"
#       },
#       "string": {
#         "content": "string",
#         "sha256": "string"
#       }
#     },
#     "rollbackInfo": {
#       "rollbackDeploymentId": "string",
#       "rollbackMessage": "string",
#       "rollbackTriggeringDeploymentId": "string"
#     },
#     "startTime": number,
#     "status": "string",
#     "targetInstances": {
#       "autoScalingGroups": [
#         "string"
#       ],
#       "ec2TagSet": {
#         "ec2TagSetList": [
#           [
#             {
#               "Key": "string",
#               "Type": "string",
#               "Value": "string"
#             }
#           ]
#         ]
#       },
#       "tagFilters": [
#         {
#           "Key": "string",
#           "Type": "string",
#           "Value": "string"
#         }
#       ]
#     },
#     "updateOutdatedInstancesOnly": boolean
#   }
# }