Chilkat Online Tools

DescribeKey Powershell Example

AWS Key Management Service

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$rest = New-Object Chilkat.Rest

$authAws = New-Object Chilkat.AuthAws
$authAws.AccessKey = "AWS_ACCESS_KEY"
$authAws.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.Region = "us-west-2"
$authAws.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 -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

# 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 = New-Object Chilkat.JsonObject
$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")

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode
$("response status code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($sbResponseBody.GetAsString())
    exit
}

$jResp = New-Object Chilkat.JsonObject
$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

$Arn = $jResp.StringOf("KeyMetadata.Arn")
$AWSAccountId = $jResp.StringOf("KeyMetadata.AWSAccountId")
$CloudHsmClusterId = $jResp.StringOf("KeyMetadata.CloudHsmClusterId")
$CreationDate = $jResp.IntOf("KeyMetadata.CreationDate")
$CustomerMasterKeySpec = $jResp.StringOf("KeyMetadata.CustomerMasterKeySpec")
$CustomKeyStoreId = $jResp.StringOf("KeyMetadata.CustomKeyStoreId")
$DeletionDate = $jResp.IntOf("KeyMetadata.DeletionDate")
$Description = $jResp.StringOf("KeyMetadata.Description")
$Enabled = $jResp.IntOf("KeyMetadata.Enabled")
$ExpirationModel = $jResp.StringOf("KeyMetadata.ExpirationModel")
$KeyId = $jResp.StringOf("KeyMetadata.KeyId")
$KeyManager = $jResp.StringOf("KeyMetadata.KeyManager")
$KeySpec = $jResp.StringOf("KeyMetadata.KeySpec")
$KeyState = $jResp.StringOf("KeyMetadata.KeyState")
$KeyUsage = $jResp.StringOf("KeyMetadata.KeyUsage")
$MultiRegion = $jResp.IntOf("KeyMetadata.MultiRegion")
$MultiRegionKeyType = $jResp.StringOf("KeyMetadata.MultiRegionConfiguration.MultiRegionKeyType")
$PrimaryKeyArn = $jResp.StringOf("KeyMetadata.MultiRegionConfiguration.PrimaryKey.Arn")
$Region = $jResp.StringOf("KeyMetadata.MultiRegionConfiguration.PrimaryKey.Region")
$Origin = $jResp.StringOf("KeyMetadata.Origin")
$PendingDeletionWindowInDays = $jResp.IntOf("KeyMetadata.PendingDeletionWindowInDays")
$ValidTo = $jResp.IntOf("KeyMetadata.ValidTo")
$i = 0
$count_i = $jResp.SizeOfArray("KeyMetadata.EncryptionAlgorithms")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("KeyMetadata.EncryptionAlgorithms[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("KeyMetadata.MacAlgorithms")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("KeyMetadata.MacAlgorithms[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("KeyMetadata.MultiRegionConfiguration.ReplicaKeys")
while ($i -lt $count_i) {
    $jResp.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 -lt $count_i) {
    $jResp.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
#   }
# }