list_environments ¶

list_environments(
    *,
    config_overrides: Optional[Cloud9ClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[MaxResults] = None,
) -> ListEnvironmentsResult

Gets a list of Cloud9 development environment identifiers.

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

Parameters:

next_token (Optional[String], default: None ) –

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
max_results (Optional[MaxResults], default: None ) –

The maximum number of environments to get identifiers for.

Raises:

BadRequestException –

The target request is invalid.
ConflictException –

A conflict occurred.
ForbiddenException –

An access permissions issue occurred.
InternalServerErrorException –

An internal server error occurred.
LimitExceededException –

A service limit was exceeded.
NotFoundException –

The target resource cannot be found.
TooManyRequestsException –

Too many service requests were made over the given time period.
UnknownServiceError –

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

Examples:

ListEnvironments

>>> client.list_environments()

Source code in docs_src/capo_cloud9/_services/cloud9.py

def list_environments(
    self,
    *,
    config_overrides: Optional[Cloud9ClientConfig] = None,
    next_token: Optional["capo_cloud9.types.string.String"] = None,
    max_results: Optional["capo_cloud9.types.max_results.MaxResults"] = None,
) -> "capo_cloud9.types.list_environments_result.ListEnvironmentsResult":
    """<p>Gets a list of Cloud9 development environment identifiers.</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> <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:
        next_token: <p>During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>
        max_results: <p>The maximum number of environments to get identifiers for.</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:
        ListEnvironments

        >>> client.list_environments()
    """

    def _handler(
        req: "OperationRequest[capo_cloud9.types.list_environments_request.ListEnvironmentsRequest]",
    ) -> OperationResponse[
        "capo_cloud9.types.list_environments_result.ListEnvironmentsResult"
    ]:
        import capo_cloud9._operations.aws_cloud9_workspace_management_service.list_environments

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEnvironments")
    )
    input_: capo_cloud9.types.list_environments_request.ListEnvironmentsRequest = {}
    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