Chilkat Online Tools

DescribeWorkspace Powershell Example

AWS Managed Grafana

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

# URL: https://grafana.us-west-2.amazonaws.com/
# Use the same region as specified above.
$success = $rest.Connect("grafana.us-west-2.amazonaws.com",443,$true,$true)
if ($success -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

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

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestNoBodySb("GET","/workspaces/{workspaceId}",$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

$AccountAccessType = $jResp.StringOf("workspace.accountAccessType")
$SamlConfigurationStatus = $jResp.StringOf("workspace.authentication.samlConfigurationStatus")
$Created = $jResp.IntOf("workspace.created")
$Description = $jResp.StringOf("workspace.description")
$Endpoint = $jResp.StringOf("workspace.endpoint")
$FreeTrialConsumed = $jResp.IntOf("workspace.freeTrialConsumed")
$FreeTrialExpiration = $jResp.IntOf("workspace.freeTrialExpiration")
$GrafanaVersion = $jResp.StringOf("workspace.grafanaVersion")
$Id = $jResp.StringOf("workspace.id")
$LicenseExpiration = $jResp.IntOf("workspace.licenseExpiration")
$LicenseType = $jResp.StringOf("workspace.licenseType")
$Modified = $jResp.IntOf("workspace.modified")
$Name = $jResp.StringOf("workspace.name")
$OrganizationRoleName = $jResp.StringOf("workspace.organizationRoleName")
$PermissionType = $jResp.StringOf("workspace.permissionType")
$StackSetName = $jResp.StringOf("workspace.stackSetName")
$Status = $jResp.StringOf("workspace.status")
$v_String = $jResp.StringOf("workspace.tags.string")
$WorkspaceRoleArn = $jResp.StringOf("workspace.workspaceRoleArn")
$i = 0
$count_i = $jResp.SizeOfArray("workspace.authentication.providers")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("workspace.authentication.providers[i]")
    $i = $i + 1
}

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

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

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

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

# {
#   "workspace": {
#     "accountAccessType": "string",
#     "authentication": {
#       "providers": [
#         "string"
#       ],
#       "samlConfigurationStatus": "string"
#     },
#     "created": number,
#     "dataSources": [
#       "string"
#     ],
#     "description": "string",
#     "endpoint": "string",
#     "freeTrialConsumed": boolean,
#     "freeTrialExpiration": number,
#     "grafanaVersion": "string",
#     "id": "string",
#     "licenseExpiration": number,
#     "licenseType": "string",
#     "modified": number,
#     "name": "string",
#     "notificationDestinations": [
#       "string"
#     ],
#     "organizationalUnits": [
#       "string"
#     ],
#     "organizationRoleName": "string",
#     "permissionType": "string",
#     "stackSetName": "string",
#     "status": "string",
#     "tags": {
#       "string": "string"
#     },
#     "workspaceRoleArn": "string"
#   }
# }