Skip to content

describe_environments

describe_environments(
    environment_ids: BoundedEnvironmentIdList,
    *,
    config_overrides: Optional[Cloud9ClientConfig] = None,
) -> DescribeEnvironmentsResult

Gets information about Cloud9 development environments.

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

Parameters:

Raises:

Examples:

DescribeEnvironments

>>> client.describe_environments(environment_ids=['8d9967e2f0624182b74e7690ad69ebEX', '349c86d4579e4e7298d500ff57a6b2EX'])
Source code in docs_src/capo_cloud9/_services/cloud9.py
def describe_environments(
    self,
    environment_ids: "capo_cloud9.types.bounded_environment_id_list.BoundedEnvironmentIdList",
    *,
    config_overrides: Optional[Cloud9ClientConfig] = None,
) -> "capo_cloud9.types.describe_environments_result.DescribeEnvironmentsResult":
    """<p>Gets information about Cloud9 development environments.</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_ids: <p>The IDs of individual environments to get 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:
        DescribeEnvironments

        >>> client.describe_environments(environment_ids=['8d9967e2f0624182b74e7690ad69ebEX', '349c86d4579e4e7298d500ff57a6b2EX'])
    """

    def _handler(
        req: "OperationRequest[capo_cloud9.types.describe_environments_request.DescribeEnvironmentsRequest]",
    ) -> OperationResponse[
        "capo_cloud9.types.describe_environments_result.DescribeEnvironmentsResult"
    ]:
        import capo_cloud9._operations.aws_cloud9_workspace_management_service.describe_environments

        output, http_response = (
            capo_cloud9._operations.aws_cloud9_workspace_management_service.describe_environments.describe_environments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_cloud9.types.describe_environments_result.DescribeEnvironmentsResult",
    ) -> dict[str, Any]:
        import capo_cloud9.types.describe_environments_result

        return capo_cloud9.types.describe_environments_result.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeEnvironments", redact_output=_redact_output),
    )
    input_: capo_cloud9.types.describe_environments_request.DescribeEnvironmentsRequest = {
        "environment_ids": environment_ids
    }

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