DescribeApp
Returns the state of the given custom app.
Request Syntax
GET /describeapp?app=App&domain=Domain&simulation=Simulation HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- App
-
The name of the app.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[a-zA-Z0-9_.-]+$Required: Yes
- Domain
-
The name of the domain of the app.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_.-]+$Required: Yes
- Simulation
-
The name of the simulation of the app.
Length Constraints: Minimum length of 1. Maximum length of 64.
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
{
"Description": "string",
"Domain": "string",
"EndpointInfo": {
"Address": "string",
"IngressPortMappings": [
{
"Actual": number,
"Declared": number
}
]
},
"LaunchOverrides": {
"LaunchCommands": [ "string" ]
},
"Name": "string",
"Simulation": "string",
"Status": "string",
"TargetStatus": "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.
- Description
-
The description of the app.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
- Domain
-
The name of the domain of the app.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_.-]+$ - EndpointInfo
-
Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.
Type: SimulationAppEndpointInfo object
- LaunchOverrides
-
Options that apply when the app starts. These options override default behavior.
Type: LaunchOverrides object
- Name
-
The name of the app.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[a-zA-Z0-9_.-]+$ - Simulation
-
The name of the simulation of the app.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_.-]+$ - Status
-
The current lifecycle state of the custom app.
Type: String
Valid Values:
STARTING | STARTED | STOPPING | STOPPED | ERROR | UNKNOWN - TargetStatus
-
The desired lifecycle state of the custom app.
Type: String
Valid Values:
UNKNOWN | STARTED | STOPPED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 403
- InternalServerException
-
HTTP Status Code: 500
- ResourceNotFoundException
-
HTTP Status Code: 404
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
