- 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.
CreateApplicationInstanceCommand
Creates an application instance and deploys it to a device.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PanoramaClient, CreateApplicationInstanceCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, CreateApplicationInstanceCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // CreateApplicationInstanceRequest
Name: "STRING_VALUE",
Description: "STRING_VALUE",
ManifestPayload: { // ManifestPayload Union: only one key present
PayloadData: "STRING_VALUE",
},
ManifestOverridesPayload: { // ManifestOverridesPayload Union: only one key present
PayloadData: "STRING_VALUE",
},
ApplicationInstanceIdToReplace: "STRING_VALUE",
RuntimeRoleArn: "STRING_VALUE",
DefaultRuntimeContextDevice: "STRING_VALUE", // required
Tags: { // TagMap
"<keys>": "STRING_VALUE",
},
};
const command = new CreateApplicationInstanceCommand(input);
const response = await client.send(command);
// { // CreateApplicationInstanceResponse
// ApplicationInstanceId: "STRING_VALUE", // required
// };
CreateApplicationInstanceCommand Input
See CreateApplicationInstanceCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
DefaultRuntimeContextDevice Required | string | undefined | A device's ID. |
ManifestPayload Required | ManifestPayload | undefined | The application's manifest document. |
ApplicationInstanceIdToReplace | string | undefined | The ID of an application instance to replace with the new instance. |
Description | string | undefined | A description for the application instance. |
ManifestOverridesPayload | ManifestOverridesPayload | undefined | Setting overrides for the application manifest. |
Name | string | undefined | A name for the application instance. |
RuntimeRoleArn | string | undefined | The ARN of a runtime role for the application instance. |
Tags | Record<string, string> | undefined | Tags for the application instance. |
CreateApplicationInstanceCommand Output
See CreateApplicationInstanceCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ApplicationInstanceId Required | string | undefined | The application instance's ID. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The requestor does not have permission to access the target action or resource. |
InternalServerException | server | An internal error occurred. |
ServiceQuotaExceededException | client | The request would cause a limit to be exceeded. |
ValidationException | client | The request contains an invalid parameter value. |
PanoramaServiceException | Base exception class for all service exceptions from Panorama service. |