ListApplicationComponents - Migration Hub Strategy Recommendations

ListApplicationComponents

Retrieves a list of all the application components (processes).

Request Syntax

POST /list-applicationcomponents HTTP/1.1 Content-type: application/json { "applicationComponentCriteria": "string", "filterValue": "string", "groupIdFilter": [ { "name": "string", "value": "string" } ], "maxResults": number, "nextToken": "string", "sort": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

applicationComponentCriteria

Criteria for filtering the list of application components.

Type: String

Valid Values: NOT_DEFINED | APP_NAME | SERVER_ID | APP_TYPE | STRATEGY | DESTINATION

Required: No

filterValue

Specify the value based on the application component criteria type. For example, if applicationComponentCriteria is set to SERVER_ID and filterValue is set to server1, then ListApplicationComponents returns all the application components running on server1.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: .*\S.*

Required: No

groupIdFilter

The group ID specified in to filter on.

Type: Array of Group objects

Required: No

maxResults

The maximum number of items to include in the response. The maximum value is 100.

Type: Integer

Required: No

nextToken

The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*\S.*

Required: No

sort

Specifies whether to sort by ascending (ASC) or descending (DESC) order.

Type: String

Valid Values: ASC | DESC

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "applicationComponentInfos": [ { "analysisStatus": "string", "antipatternReportS3Object": { "s3Bucket": "string", "s3key": "string" }, "antipatternReportStatus": "string", "antipatternReportStatusMessage": "string", "appType": "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", "sourceCodeRepositories": [ { "branch": "string", "repository": "string", "versionControlType": "string" } ], "statusMessage": "string" } ], "nextToken": "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.

applicationComponentInfos

The list of application components with detailed information about each component.

Type: Array of ApplicationComponentDetail objects

nextToken

The token you use to retrieve the next set of results, or null if there are no more results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*\S.*

Errors

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

AccessDeniedException

The AWS user account does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this account.

HTTP Status Code: 403

InternalServerException

The server experienced an internal error. Try again.

HTTP Status Code: 500

ServiceLinkedRoleLockClientException

Exception to indicate that the service-linked role (SLR) is locked.

HTTP Status Code: 400

ValidationException

The request body isn't 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: