Skip to content

describe_environment_status async 

describe_environment_status(
    environment_id: EnvironmentId,
    *,
    config_overrides: Optional[AsyncCloud9ClientConfig] = None,
) -> DescribeEnvironmentStatusResult

Gets status information for an Cloud9 development environment.

Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

Parameters:

  • environment_id (EnvironmentId) –

    The ID of the environment to get status information about.

Raises:

Examples:

DescribeEnvironmentStatus

>>> await client.describe_environment_status(environment_id='8d9967e2f0624182b74e7690ad69ebEX')
Source code in docs_src/capo_cloud9/_services/async_cloud9.py 
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
async def describe_environment_status(
    self,
    environment_id: "capo_cloud9.types.environment_id.EnvironmentId",
    *,
    config_overrides: Optional[AsyncCloud9ClientConfig] = None,
) -> "capo_cloud9.types.describe_environment_status_result.DescribeEnvironmentStatusResult":
    """<p>Gets status information for an Cloud9 development environment.</p> <important> <p>Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. <a href="http://aws.amazon.com/blogs/devops/how-to-migrate-from-aws-cloud9-to-aws-ide-toolkits-or-aws-cloudshell/">Learn more"</a> </p> </important>

    Args:
        environment_id: <p>The ID of the environment to get status information about.</p>

    Raises:
        capo_cloud9.errors.bad_request_exception.BadRequestException: <p>The target request is invalid.</p>
        capo_cloud9.errors.conflict_exception.ConflictException: <p>A conflict occurred.</p>
        capo_cloud9.errors.forbidden_exception.ForbiddenException: <p>An access permissions issue occurred.</p>
        capo_cloud9.errors.internal_server_error_exception.InternalServerErrorException: <p>An internal server error occurred.</p>
        capo_cloud9.errors.limit_exceeded_exception.LimitExceededException: <p>A service limit was exceeded.</p>
        capo_cloud9.errors.not_found_exception.NotFoundException: <p>The target resource cannot be found.</p>
        capo_cloud9.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many service requests were made over the given time period.</p>
        capo_cloud9.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        DescribeEnvironmentStatus

        >>> await client.describe_environment_status(environment_id='8d9967e2f0624182b74e7690ad69ebEX')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloud9.types.describe_environment_status_request.DescribeEnvironmentStatusRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloud9.types.describe_environment_status_result.DescribeEnvironmentStatusResult"
    ]:
        import capo_cloud9._operations.aws_cloud9_workspace_management_service.describe_environment_status

        (
            output,
            http_response,
        ) = await capo_cloud9._operations.aws_cloud9_workspace_management_service.describe_environment_status.async_describe_environment_status(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEnvironmentStatus")
    )
    input_: capo_cloud9.types.describe_environment_status_request.DescribeEnvironmentStatusRequest = {
        "environment_id": environment_id
    }

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