GetApplicationComponentDetails
Retrieves details about an application component.
Request Syntax
GET /get-applicationcomponent-details/applicationComponentId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- applicationComponentId
-
The ID of the application component. The ID is unique within an AWS account.
Length Constraints: Minimum length of 0. Maximum length of 44.
Pattern:
[0-9a-zA-Z-]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"applicationComponentDetail": {
"analysisStatus": "string",
"antipatternReportS3Object": {
"s3Bucket": "string",
"s3key": "string"
},
"antipatternReportStatus": "string",
"antipatternReportStatusMessage": "string",
"appType": "string",
"appUnitError": {
"appUnitErrorCategory": "string"
},
"associatedServerId": "string",
"databaseConfigDetail": {
"secretName": "string"
},
"id": "string",
"inclusionStatus": "string",
"lastAnalyzedTimestamp": number,
"listAntipatternSeveritySummary": [
{
"count": number,
"severity": "string"
}
],
"moreServerAssociationExists": boolean,
"name": "string",
"osDriver": "string",
"osVersion": "string",
"recommendationSet": {
"strategy": "string",
"targetDestination": "string",
"transformationTool": {
"description": "string",
"name": "string",
"tranformationToolInstallationLink": "string"
}
},
"resourceSubType": "string",
"resultList": [
{
"analysisStatus": { ... },
"analysisType": "string",
"antipatternReportResultList": [
{
"analyzerName": { ... },
"antiPatternReportS3Object": {
"s3Bucket": "string",
"s3key": "string"
},
"antipatternReportStatus": "string",
"antipatternReportStatusMessage": "string"
}
],
"statusMessage": "string"
}
],
"runtimeStatus": "string",
"runtimeStatusMessage": "string",
"sourceCodeRepositories": [
{
"branch": "string",
"projectName": "string",
"repository": "string",
"versionControlType": "string"
}
],
"statusMessage": "string"
},
"associatedApplications": [
{
"id": "string",
"name": "string"
}
],
"associatedServerIds": [ "string" ],
"moreApplicationResource": boolean
}
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.
- applicationComponentDetail
-
Detailed information about an application component.
Type: ApplicationComponentDetail object
- associatedApplications
-
The associated application group as defined in AWS Application Discovery Service.
Type: Array of AssociatedApplication objects
- associatedServerIds
-
A list of the IDs of the servers on which the application component is running.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
.*\S.*
- moreApplicationResource
-
Set to true if the application component belongs to more than one application group.
Type: Boolean
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
The server experienced an internal error. Try again.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified ID in the request is not found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: