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

GetApplication

Displays detailed information about a specified application.

Request Syntax


GET /applications/applicationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

The ID of the application that will be described.

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

Pattern: ^[0-9a-z]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "application": { 
      "applicationId": "string",
      "architecture": "string",
      "arn": "string",
      "autoStartConfiguration": { 
         "enabled": boolean
      },
      "autoStopConfiguration": { 
         "enabled": boolean,
         "idleTimeoutMinutes": number
      },
      "createdAt": number,
      "imageConfiguration": { 
         "imageUri": "string",
         "resolvedImageDigest": "string"
      },
      "initialCapacity": { 
         "string" : { 
            "workerConfiguration": { 
               "cpu": "string",
               "disk": "string",
               "diskType": "string",
               "memory": "string"
            },
            "workerCount": number
         }
      },
      "interactiveConfiguration": { 
         "livyEndpointEnabled": boolean,
         "studioEnabled": boolean
      },
      "maximumCapacity": { 
         "cpu": "string",
         "disk": "string",
         "memory": "string"
      },
      "monitoringConfiguration": { 
         "cloudWatchLoggingConfiguration": { 
            "enabled": boolean,
            "encryptionKeyArn": "string",
            "logGroupName": "string",
            "logStreamNamePrefix": "string",
            "logTypes": { 
               "string" : [ "string" ]
            }
         },
         "managedPersistenceMonitoringConfiguration": { 
            "enabled": boolean,
            "encryptionKeyArn": "string"
         },
         "prometheusMonitoringConfiguration": { 
            "remoteWriteUrl": "string"
         },
         "s3MonitoringConfiguration": { 
            "encryptionKeyArn": "string",
            "logUri": "string"
         }
      },
      "name": "string",
      "networkConfiguration": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ]
      },
      "releaseLabel": "string",
      "runtimeConfiguration": [ 
         { 
            "classification": "string",
            "configurations": [ 
               "Configuration"
            ],
            "properties": { 
               "string" : "string" 
            }
         }
      ],
      "schedulerConfiguration": { 
         "maxConcurrentRuns": number,
         "queueTimeoutMinutes": number
      },
      "state": "string",
      "stateDetails": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string",
      "updatedAt": number,
      "workerTypeSpecifications": { 
         "string" : { 
            "imageConfiguration": { 
               "imageUri": "string",
               "resolvedImageDigest": "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.

application

The output displays information about the specified application.

Type: Application object

Errors

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

InternalServerException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400