Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeApplicationInstance

Returns information about an application instance on a device.

Request Syntax


GET /application-instances/ApplicationInstanceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationInstanceId

The application instance's ID.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApplicationInstanceId": "string",
   "ApplicationInstanceIdToReplace": "string",
   "Arn": "string",
   "CreatedTime": number,
   "DefaultRuntimeContextDevice": "string",
   "DefaultRuntimeContextDeviceName": "string",
   "Description": "string",
   "HealthStatus": "string",
   "LastUpdatedTime": number,
   "Name": "string",
   "RuntimeContextStates": [ 
      { 
         "DesiredState": "string",
         "DeviceReportedStatus": "string",
         "DeviceReportedTime": number,
         "RuntimeContextName": "string"
      }
   ],
   "RuntimeRoleArn": "string",
   "Status": "string",
   "StatusDescription": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApplicationInstanceId

The application instance's ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

ApplicationInstanceIdToReplace

The ID of the application instance that this instance replaced.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

Arn

The application instance's ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

CreatedTime

When the application instance was created.

Type: Timestamp

DefaultRuntimeContextDevice

The device's ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

DefaultRuntimeContextDeviceName

The device's bane.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

Description

The application instance's description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: ^.*$

HealthStatus

The application instance's health status.

Type: String

Valid Values: RUNNING | ERROR | NOT_AVAILABLE

LastUpdatedTime

The application instance was updated.

Type: Timestamp

Name

The application instance's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

RuntimeContextStates

The application instance's state.

Type: Array of ReportedRuntimeContextState objects

RuntimeRoleArn

The application instance's runtime role ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$

Status

The application instance's status.

Type: String

StatusDescription

The application instance's status description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Tags

The application instance's tags.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^.+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^.*$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The requestor does not have permission to access the target action or resource.

HTTP Status Code: 403

ConflictException

The target resource is in use.

HTTP Status Code: 409

InternalServerException

An internal error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The target resource was not found.

HTTP Status Code: 404

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400