GetApplication
Describes the details of a specific application.
Request Syntax
GET /applications/applicationId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The identifier of the application.
Pattern:
^\S{1,80}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"applicationArn": "string",
"applicationId": "string",
"creationTime": number,
"deployedVersion": {
"applicationVersion": number,
"status": "string",
"statusReason": "string"
},
"description": "string",
"engineType": "string",
"environmentId": "string",
"kmsKeyId": "string",
"lastStartTime": number,
"latestVersion": {
"applicationVersion": number,
"creationTime": number,
"status": "string",
"statusReason": "string"
},
"listenerArns": [ "string" ],
"listenerPorts": [ number ],
"loadBalancerDnsName": "string",
"logGroups": [
{
"logGroupName": "string",
"logType": "string"
}
],
"name": "string",
"roleArn": "string",
"status": "string",
"statusReason": "string",
"tags": {
"string" : "string"
},
"targetGroupArns": [ "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.
- applicationArn
-
The Amazon Resource Name (ARN) of the application.
Type: String
Pattern:
^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$
- applicationId
-
The identifier of the application.
Type: String
Pattern:
^\S{1,80}$
- creationTime
-
The timestamp when this application was created.
Type: Timestamp
- deployedVersion
-
The version of the application that is deployed.
Type: DeployedVersionSummary object
- description
-
The description of the application.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
- engineType
-
The type of the target platform for the application.
Type: String
Valid Values:
microfocus | bluage
- environmentId
-
The identifier of the runtime environment where you want to deploy the application.
Type: String
Pattern:
^\S{1,80}$
- kmsKeyId
-
The identifier of a customer managed key.
Type: String
- lastStartTime
-
The timestamp when you last started the application. Null until the application runs for the first time.
Type: Timestamp
- latestVersion
-
The latest version of the application.
Type: ApplicationVersionSummary object
- listenerArns
-
The Amazon Resource Name (ARN) for the network load balancer listener created in your AWS account. AWS Mainframe Modernization creates this listener for you the first time you deploy an application.
Type: Array of strings
Array Members: Minimum number of 1 item.
Pattern:
^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$
- listenerPorts
-
The port associated with the network load balancer listener created in your AWS account.
Type: Array of integers
Array Members: Minimum number of 1 item.
- loadBalancerDnsName
-
The public DNS name of the load balancer created in your AWS account.
Type: String
Pattern:
^\S{1,100}$
- logGroups
-
The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. AWS Mainframe Modernization pushes the application log to CloudWatch under the customer's account.
Type: Array of LogGroupSummary objects
- name
-
The unique identifier of the application.
Type: String
Pattern:
^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$
- roleArn
-
The Amazon Resource Name (ARN) of the role associated with the application.
Type: String
Pattern:
^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$
- status
-
The status of the application.
Type: String
Valid Values:
Creating | Created | Available | Ready | Starting | Running | Stopping | Stopped | Failed | Deleting | Deleting From Environment
- statusReason
-
The reason for the reported status.
Type: String
-
A list of tags associated with the application.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:).+$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
- targetGroupArns
-
Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.
Type: Array of strings
Array Members: Minimum number of 1 item.
Pattern:
^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The account or role doesn't have the right permissions to make the request.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred during the processing of the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests made exceeds the limit.
HTTP Status Code: 429
- ValidationException
-
One or more parameters provided in the request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: