DescribeApplicationInstanceDetails
Returns information about an application instance's configuration manifest.
Request Syntax
GET /application-instances/ApplicationInstanceId
/details 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",
"CreatedTime": number,
"DefaultRuntimeContextDevice": "string",
"Description": "string",
"ManifestOverridesPayload": { ... },
"ManifestPayload": { ... },
"Name": "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\-\_]+$
- CreatedTime
-
When the application instance was created.
Type: Timestamp
- DefaultRuntimeContextDevice
-
The application instance's default runtime context device.
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:
^.*$
- ManifestOverridesPayload
-
Parameter overrides for the configuration manifest.
Type: ManifestOverridesPayload object
Note: This object is a Union. Only one member of this object can be specified or returned.
- ManifestPayload
-
The application instance's configuration manifest.
Type: ManifestPayload object
Note: This object is a Union. Only one member of this object can be specified or returned.
- Name
-
The application instance's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: