Skip to content

describe_application_state async

describe_application_state(
    application_id: ApplicationId,
    *,
    config_overrides: Optional[AsyncMigrationHubClientConfig] = None,
) -> DescribeApplicationStateResult

Gets the migration status of an application.

Parameters:

  • application_id (ApplicationId) –

    The configurationId in Application Discovery Service that uniquely identifies the grouped application.

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

  • HomeRegionNotSetException –

    The home region is not set. Set the home region to continue.

  • InternalServerError –

    Exception raised when an internal, configuration, or dependency error is encountered.

  • InvalidInputException –

    Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

  • PolicyErrorException –

    Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

  • ResourceNotFoundException –

    Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

  • ServiceUnavailableException –

    Exception raised when there is an internal, configuration, or dependency error encountered.

  • ThrottlingException –

    The request was denied due to request throttling.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_migration_hub/_services/async_migration_hub.py
async def describe_application_state(
    self,
    application_id: "capo_migration_hub.types.application_id.ApplicationId",
    *,
    config_overrides: Optional[AsyncMigrationHubClientConfig] = None,
) -> "capo_migration_hub.types.describe_application_state_result.DescribeApplicationStateResult":
    """<p>Gets the migration status of an application.</p>

    Args:
        application_id: <p>The configurationId in Application Discovery Service that uniquely identifies the grouped application.</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.policy_error_exception.PolicyErrorException: <p>Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the <code>migrationhub-discovery</code> role is missing or not configured correctly.</p>
        capo_migration_hub.errors.resource_not_found_exception.ResourceNotFoundException: <p>Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_migration_hub.types.describe_application_state_request.DescribeApplicationStateRequest]",
    ) -> AsyncOperationResponse[
        "capo_migration_hub.types.describe_application_state_result.DescribeApplicationStateResult"
    ]:
        import capo_migration_hub._operations.aws_migration_hub.describe_application_state

        (
            output,
            http_response,
        ) = await capo_migration_hub._operations.aws_migration_hub.describe_application_state.async_describe_application_state(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeApplicationState")
    )
    input_: capo_migration_hub.types.describe_application_state_request.DescribeApplicationStateRequest = {
        "application_id": application_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output