Chilkat Online Tools

DescribeTable Powershell Example

Amazon Redshift Data API

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

# URL: https://redshift-data.us-west-2.amazonaws.com/
# Use the same region as specified above.
$success = $rest.Connect("redshift-data.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("ClusterIdentifier","string")
$json.UpdateString("ConnectedDatabase","string")
$json.UpdateString("Database","string")
$json.UpdateString("DbUser","string")
$json.UpdateInt("MaxResults",123)
$json.UpdateString("NextToken","string")
$json.UpdateString("Schema","string")
$json.UpdateString("SecretArn","string")
$json.UpdateString("Table","string")

# The JSON request body created by the above code:

# {
#   "ClusterIdentifier": "string",
#   "ConnectedDatabase": "string",
#   "Database": "string",
#   "DbUser": "string",
#   "MaxResults": number,
#   "NextToken": "string",
#   "Schema": "string",
#   "SecretArn": "string",
#   "Table": "string"
# }

$rest.AddHeader("Content-Type","application/x-amz-json-1.1")
$rest.AddHeader("X-Amz-Target","RedshiftData.DescribeTable")

$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

$NextToken = $jResp.StringOf("NextToken")
$TableName = $jResp.StringOf("TableName")
$i = 0
$count_i = $jResp.SizeOfArray("ColumnList")
while ($i -lt $count_i) {
    $jResp.I = $i
    $columnDefault = $jResp.StringOf("ColumnList[i].columnDefault")
    $isCaseSensitive = $jResp.IntOf("ColumnList[i].isCaseSensitive")
    $isCurrency = $jResp.IntOf("ColumnList[i].isCurrency")
    $isSigned = $jResp.IntOf("ColumnList[i].isSigned")
    $label = $jResp.StringOf("ColumnList[i].label")
    $length = $jResp.IntOf("ColumnList[i].length")
    $name = $jResp.StringOf("ColumnList[i].name")
    $nullable = $jResp.IntOf("ColumnList[i].nullable")
    $precision = $jResp.IntOf("ColumnList[i].precision")
    $scale = $jResp.IntOf("ColumnList[i].scale")
    $schemaName = $jResp.StringOf("ColumnList[i].schemaName")
    $tableName = $jResp.StringOf("ColumnList[i].tableName")
    $typeName = $jResp.StringOf("ColumnList[i].typeName")
    $i = $i + 1
}

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

# {
#   "ColumnList": [
#     {
#       "columnDefault": "string",
#       "isCaseSensitive": boolean,
#       "isCurrency": boolean,
#       "isSigned": boolean,
#       "label": "string",
#       "length": number,
#       "name": "string",
#       "nullable": number,
#       "precision": number,
#       "scale": number,
#       "schemaName": "string",
#       "tableName": "string",
#       "typeName": "string"
#     }
#   ],
#   "NextToken": "string",
#   "TableName": "string"
# }