list_application_components
¶
list_application_components(
*,
config_overrides: Optional[MigrationHubStrategyClientConfig] = None,
application_component_criteria: Optional[ApplicationComponentCriteria] = None,
filter_value: Optional[String] = None,
sort: Optional[SortOrder] = None,
group_id_filter: Optional[GroupIds] = None,
next_token: Optional[NextToken] = None,
max_results: Optional[MaxResult] = None,
) -> ListApplicationComponentsResponse
Retrieves a list of all the application components (processes).
Parameters:
-
application_component_criteria(Optional[ApplicationComponentCriteria], default:None) –Criteria for filtering the list of application components.
-
filter_value(Optional[String], default:None) –Specify the value based on the application component criteria type. For example, if
applicationComponentCriteriais set toSERVER_IDandfilterValueis set toserver1, then ListApplicationComponents returns all the application components running on server1. -
sort(Optional[SortOrder], default:None) –Specifies whether to sort by ascending (
ASC) or descending (DESC) order. -
group_id_filter(Optional[GroupIds], default:None) –The group ID specified in to filter on.
-
next_token(Optional[NextToken], default:None) –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
maxResultsto 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. -
max_results(Optional[MaxResult], default:None) –The maximum number of items to include in the response. The maximum value is 100.
Raises:
-
AccessDeniedException–The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.
-
InternalServerException–The server experienced an internal error. Try again.
-
ServiceLinkedRoleLockClientException–Exception to indicate that the service-linked role (SLR) is locked.
-
ValidationException–The request body isn't valid.
-
UnknownServiceError–The service returned an error code this client does not model.