Skip to content

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 applicationComponentCriteria is set to SERVER_ID and filterValue is set to server1, 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 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.

  • max_results (Optional[MaxResult], default: None ) –

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

Raises:

Source code in docs_src/capo_migrationhubstrategy/_services/migration_hub_strategy.py
def list_application_components(
    self,
    *,
    config_overrides: Optional[MigrationHubStrategyClientConfig] = None,
    application_component_criteria: Optional[
        "capo_migrationhubstrategy.types.application_component_criteria.ApplicationComponentCriteria"
    ] = None,
    filter_value: Optional["capo_migrationhubstrategy.types.string.String"] = None,
    sort: Optional["capo_migrationhubstrategy.types.sort_order.SortOrder"] = None,
    group_id_filter: Optional[
        "capo_migrationhubstrategy.types.group_ids.GroupIds"
    ] = None,
    next_token: Optional[
        "capo_migrationhubstrategy.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_migrationhubstrategy.types.max_result.MaxResult"
    ] = None,
) -> "capo_migrationhubstrategy.types.list_application_components_response.ListApplicationComponentsResponse":
    """<p> Retrieves a list of all the application components (processes). </p>

    Args:
        application_component_criteria: <p> Criteria for filtering the list of application components. </p>
        filter_value: <p> Specify the value based on the application component criteria type. For example, if <code>applicationComponentCriteria</code> is set to <code>SERVER_ID</code> and <code>filterValue</code> is set to <code>server1</code>, then <a>ListApplicationComponents</a> returns all the application components running on server1. </p>
        sort: <p> Specifies whether to sort by ascending (<code>ASC</code>) or descending (<code>DESC</code>) order. </p>
        group_id_filter: <p> The group ID specified in to filter on. </p>
        next_token: <p> 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 <code>maxResults</code> 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. </p>
        max_results: <p> The maximum number of items to include in the response. The maximum value is 100. </p>

    Raises:
        capo_migrationhubstrategy.errors.access_denied_exception.AccessDeniedException: <p> The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.</p>
        capo_migrationhubstrategy.errors.internal_server_exception.InternalServerException: <p> The server experienced an internal error. Try again. </p>
        capo_migrationhubstrategy.errors.service_linked_role_lock_client_exception.ServiceLinkedRoleLockClientException: <p> Exception to indicate that the service-linked role (SLR) is locked. </p>
        capo_migrationhubstrategy.errors.validation_exception.ValidationException: <p> The request body isn't valid. </p>
        capo_migrationhubstrategy.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_migrationhubstrategy.types.list_application_components_request.ListApplicationComponentsRequest]",
    ) -> OperationResponse[
        "capo_migrationhubstrategy.types.list_application_components_response.ListApplicationComponentsResponse"
    ]:
        import capo_migrationhubstrategy._operations.aws_migration_hub_strategy_recommendation.list_application_components

        output, http_response = (
            capo_migrationhubstrategy._operations.aws_migration_hub_strategy_recommendation.list_application_components.list_application_components(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApplicationComponents")
    )
    input_: capo_migrationhubstrategy.types.list_application_components_request.ListApplicationComponentsRequest = {}
    if application_component_criteria is not None:
        input_["application_component_criteria"] = application_component_criteria
    if filter_value is not None:
        input_["filter_value"] = filter_value
    if sort is not None:
        input_["sort"] = sort
    if group_id_filter is not None:
        input_["group_id_filter"] = group_id_filter
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output