Skip to content

list_application_states

list_application_states(
    *,
    config_overrides: Optional[MigrationHubClientConfig] = None,
    application_ids: Optional[ApplicationIds] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxResults] = None,
) -> ListApplicationStatesResult

Lists all the migration statuses for your applications. If you use the optional ApplicationIds parameter, only the migration statuses for those applications will be returned.

Parameters:

  • application_ids (Optional[ApplicationIds], default: None ) –

    The configurationIds from the Application Discovery Service that uniquely identifies your applications.

  • next_token (Optional[Token], default: None ) –

    If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

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

    Maximum number of results to be returned per page.

Raises:

Source code in docs_src/capo_migration_hub/_services/migration_hub.py
def list_application_states(
    self,
    *,
    config_overrides: Optional[MigrationHubClientConfig] = None,
    application_ids: Optional[
        "capo_migration_hub.types.application_ids.ApplicationIds"
    ] = None,
    next_token: Optional["capo_migration_hub.types.token.Token"] = None,
    max_results: Optional["capo_migration_hub.types.max_results.MaxResults"] = None,
) -> "capo_migration_hub.types.list_application_states_result.ListApplicationStatesResult":
    """<p>Lists all the migration statuses for your applications. If you use the optional <code>ApplicationIds</code> parameter, only the migration statuses for those applications will be returned.</p>

    Args:
        application_ids: <p>The configurationIds from the Application Discovery Service that uniquely identifies your applications.</p>
        next_token: <p>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>.</p>
        max_results: <p>Maximum number of results to be returned per page.</p>

    Raises:
        capo_migration_hub.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_migration_hub.errors.home_region_not_set_exception.HomeRegionNotSetException: <p>The home region is not set. Set the home region to continue.</p>
        capo_migration_hub.errors.internal_server_error.InternalServerError: <p>Exception raised when an internal, configuration, or dependency error is encountered.</p>
        capo_migration_hub.errors.invalid_input_exception.InvalidInputException: <p>Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.</p>
        capo_migration_hub.errors.service_unavailable_exception.ServiceUnavailableException: <p>Exception raised when there is an internal, configuration, or dependency error encountered.</p>
        capo_migration_hub.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_migration_hub.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_migration_hub.types.list_application_states_request.ListApplicationStatesRequest]",
    ) -> OperationResponse[
        "capo_migration_hub.types.list_application_states_result.ListApplicationStatesResult"
    ]:
        import capo_migration_hub._operations.aws_migration_hub.list_application_states

        output, http_response = (
            capo_migration_hub._operations.aws_migration_hub.list_application_states.list_application_states(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApplicationStates")
    )
    input_: capo_migration_hub.types.list_application_states_request.ListApplicationStatesRequest = {}
    if application_ids is not None:
        input_["application_ids"] = application_ids
    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