- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeApplicationInstanceCommand
Returns information about an application instance on a device.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PanoramaClient, DescribeApplicationInstanceCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, DescribeApplicationInstanceCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // DescribeApplicationInstanceRequest
ApplicationInstanceId: "STRING_VALUE", // required
};
const command = new DescribeApplicationInstanceCommand(input);
const response = await client.send(command);
// { // DescribeApplicationInstanceResponse
// Name: "STRING_VALUE",
// Description: "STRING_VALUE",
// DefaultRuntimeContextDevice: "STRING_VALUE",
// DefaultRuntimeContextDeviceName: "STRING_VALUE",
// ApplicationInstanceIdToReplace: "STRING_VALUE",
// RuntimeRoleArn: "STRING_VALUE",
// Status: "STRING_VALUE",
// HealthStatus: "STRING_VALUE",
// StatusDescription: "STRING_VALUE",
// CreatedTime: new Date("TIMESTAMP"),
// LastUpdatedTime: new Date("TIMESTAMP"),
// ApplicationInstanceId: "STRING_VALUE",
// Arn: "STRING_VALUE",
// Tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// RuntimeContextStates: [ // ReportedRuntimeContextStates
// { // ReportedRuntimeContextState
// DesiredState: "STRING_VALUE", // required
// RuntimeContextName: "STRING_VALUE", // required
// DeviceReportedStatus: "STRING_VALUE", // required
// DeviceReportedTime: new Date("TIMESTAMP"), // required
// },
// ],
// };
DescribeApplicationInstanceCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ApplicationInstanceId Required | string | undefined | The application instance's ID. |
DescribeApplicationInstanceCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ApplicationInstanceId | string | undefined | The application instance's ID. |
ApplicationInstanceIdToReplace | string | undefined | The ID of the application instance that this instance replaced. |
Arn | string | undefined | The application instance's ARN. |
CreatedTime | Date | undefined | When the application instance was created. |
DefaultRuntimeContextDevice | string | undefined | The device's ID. |
DefaultRuntimeContextDeviceName | string | undefined | The device's bane. |
Description | string | undefined | The application instance's description. |
HealthStatus | ApplicationInstanceHealthStatus | undefined | The application instance's health status. |
LastUpdatedTime | Date | undefined | The application instance was updated. |
Name | string | undefined | The application instance's name. |
RuntimeContextStates | ReportedRuntimeContextState[] | undefined | The application instance's state. |
RuntimeRoleArn | string | undefined | The application instance's runtime role ARN. |
Status | ApplicationInstanceStatus | undefined | The application instance's status. |
StatusDescription | string | undefined | The application instance's status description. |
Tags | Record<string, string> | undefined | The application instance's tags. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The requestor does not have permission to access the target action or resource. |
ConflictException | client | The target resource is in use. |
InternalServerException | server | An internal error occurred. |
ResourceNotFoundException | client | The target resource was not found. |
ValidationException | client | The request contains an invalid parameter value. |
PanoramaServiceException | Base exception class for all service exceptions from Panorama service. |