@Generated(value="software.amazon.awssdk:codegen") public interface Cloud9Client extends SdkClient, SdkAutoCloseable
builder() method.
AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.
In the background, these tools are available through development environments running on Amazon Elastic Compute Cloud (Amazon EC2) instances (known as Amazon EC2 environments), your own servers (known as SSH environments), or a combination. This enables you to create and switch between multiple environments, with each environment set up for a specific development project.
For more information about AWS Cloud9, see the AWS Cloud9 User Guide.
AWS Cloud9 supports these operations:
CreateEnvironmentEC2: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance,
and then hosts the environment on the instance.
CreateEnvironmentMembership: Adds an environment member to an environment.
DeleteEnvironment: Deletes an environment. If the environment is hosted on an Amazon EC2 instance, also
terminates the instance.
DeleteEnvironmentMembership: Deletes an environment member from an environment.
DescribeEnvironmentMemberships: Gets information about environment members for an environment.
DescribeEnvironments: Gets information about environments.
DescribeEnvironmentStatus: Gets status information for an environment.
ListEnvironments: Gets a list of environment identifiers.
UpdateEnvironment: Changes the settings of an existing environment.
UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static Cloud9ClientBuilder |
builder()
Create a builder that can be used to configure and create a
Cloud9Client. |
static Cloud9Client |
create()
Create a
Cloud9Client with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider. |
default CreateEnvironmentEC2Response |
createEnvironmentEC2(Consumer<CreateEnvironmentEC2Request.Builder> createEnvironmentEC2Request)
Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance,
and then hosts the environment on the instance.
|
default CreateEnvironmentEC2Response |
createEnvironmentEC2(CreateEnvironmentEC2Request createEnvironmentEC2Request)
Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance,
and then hosts the environment on the instance.
|
default CreateEnvironmentMembershipResponse |
createEnvironmentMembership(Consumer<CreateEnvironmentMembershipRequest.Builder> createEnvironmentMembershipRequest)
Adds an environment member to an AWS Cloud9 development environment.
|
default CreateEnvironmentMembershipResponse |
createEnvironmentMembership(CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest)
Adds an environment member to an AWS Cloud9 development environment.
|
default DeleteEnvironmentResponse |
deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)
Deletes an AWS Cloud9 development environment.
|
default DeleteEnvironmentResponse |
deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Deletes an AWS Cloud9 development environment.
|
default DeleteEnvironmentMembershipResponse |
deleteEnvironmentMembership(Consumer<DeleteEnvironmentMembershipRequest.Builder> deleteEnvironmentMembershipRequest)
Deletes an environment member from an AWS Cloud9 development environment.
|
default DeleteEnvironmentMembershipResponse |
deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest)
Deletes an environment member from an AWS Cloud9 development environment.
|
default DescribeEnvironmentMembershipsResponse |
describeEnvironmentMemberships()
Gets information about environment members for an AWS Cloud9 development environment.
|
default DescribeEnvironmentMembershipsResponse |
describeEnvironmentMemberships(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest)
Gets information about environment members for an AWS Cloud9 development environment.
|
default DescribeEnvironmentMembershipsResponse |
describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest)
Gets information about environment members for an AWS Cloud9 development environment.
|
default DescribeEnvironmentMembershipsIterable |
describeEnvironmentMembershipsPaginator()
Gets information about environment members for an AWS Cloud9 development environment.
|
default DescribeEnvironmentMembershipsIterable |
describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest)
Gets information about environment members for an AWS Cloud9 development environment.
|
default DescribeEnvironmentsResponse |
describeEnvironments(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest)
Gets information about AWS Cloud9 development environments.
|
default DescribeEnvironmentsResponse |
describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
Gets information about AWS Cloud9 development environments.
|
default DescribeEnvironmentStatusResponse |
describeEnvironmentStatus(Consumer<DescribeEnvironmentStatusRequest.Builder> describeEnvironmentStatusRequest)
Gets status information for an AWS Cloud9 development environment.
|
default DescribeEnvironmentStatusResponse |
describeEnvironmentStatus(DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest)
Gets status information for an AWS Cloud9 development environment.
|
default ListEnvironmentsResponse |
listEnvironments()
Gets a list of AWS Cloud9 development environment identifiers.
|
default ListEnvironmentsResponse |
listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
Gets a list of AWS Cloud9 development environment identifiers.
|
default ListEnvironmentsResponse |
listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
Gets a list of AWS Cloud9 development environment identifiers.
|
default ListEnvironmentsIterable |
listEnvironmentsPaginator()
Gets a list of AWS Cloud9 development environment identifiers.
|
default ListEnvironmentsIterable |
listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)
Gets a list of AWS Cloud9 development environment identifiers.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateEnvironmentResponse |
updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)
Changes the settings of an existing AWS Cloud9 development environment.
|
default UpdateEnvironmentResponse |
updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
Changes the settings of an existing AWS Cloud9 development environment.
|
default UpdateEnvironmentMembershipResponse |
updateEnvironmentMembership(Consumer<UpdateEnvironmentMembershipRequest.Builder> updateEnvironmentMembershipRequest)
Changes the settings of an existing environment member for an AWS Cloud9 development environment.
|
default UpdateEnvironmentMembershipResponse |
updateEnvironmentMembership(UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest)
Changes the settings of an existing environment member for an AWS Cloud9 development environment.
|
serviceNameclosestatic final String SERVICE_NAME
static Cloud9Client create()
Cloud9Client with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider.static Cloud9ClientBuilder builder()
Cloud9Client.default CreateEnvironmentEC2Response createEnvironmentEC2(CreateEnvironmentEC2Request createEnvironmentEC2Request) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then hosts the environment on the instance.
createEnvironmentEC2Request - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateEnvironmentEC2Response createEnvironmentEC2(Consumer<CreateEnvironmentEC2Request.Builder> createEnvironmentEC2Request) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then hosts the environment on the instance.
createEnvironmentEC2Request - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateEnvironmentMembershipResponse createEnvironmentMembership(CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Adds an environment member to an AWS Cloud9 development environment.
createEnvironmentMembershipRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateEnvironmentMembershipResponse createEnvironmentMembership(Consumer<CreateEnvironmentMembershipRequest.Builder> createEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Adds an environment member to an AWS Cloud9 development environment.
createEnvironmentMembershipRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Deletes an AWS Cloud9 development environment. If the environment is hosted on an Amazon Elastic Compute Cloud (Amazon EC2) instance, also terminates the instance.
deleteEnvironmentRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteEnvironmentResponse deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Deletes an AWS Cloud9 development environment. If the environment is hosted on an Amazon Elastic Compute Cloud (Amazon EC2) instance, also terminates the instance.
deleteEnvironmentRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteEnvironmentMembershipResponse deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Deletes an environment member from an AWS Cloud9 development environment.
deleteEnvironmentMembershipRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteEnvironmentMembershipResponse deleteEnvironmentMembership(Consumer<DeleteEnvironmentMembershipRequest.Builder> deleteEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Deletes an environment member from an AWS Cloud9 development environment.
deleteEnvironmentMembershipRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships() throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets information about environment members for an AWS Cloud9 development environment.
BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondescribeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest),
AWS API Documentationdefault DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets information about environment members for an AWS Cloud9 development environment.
describeEnvironmentMembershipsRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets information about environment members for an AWS Cloud9 development environment.
describeEnvironmentMembershipsRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator() throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets information about environment members for an AWS Cloud9 development environment.
This is a variant of
describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client
.describeEnvironmentMembershipsPaginator(request);
for (software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation.
BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondescribeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest),
AWS API Documentationdefault DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets information about environment members for an AWS Cloud9 development environment.
This is a variant of
describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client
.describeEnvironmentMembershipsPaginator(request);
for (software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation.
describeEnvironmentMembershipsRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeEnvironmentStatusResponse describeEnvironmentStatus(DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets status information for an AWS Cloud9 development environment.
describeEnvironmentStatusRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeEnvironmentStatusResponse describeEnvironmentStatus(Consumer<DescribeEnvironmentStatusRequest.Builder> describeEnvironmentStatusRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets status information for an AWS Cloud9 development environment.
describeEnvironmentStatusRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeEnvironmentsResponse describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets information about AWS Cloud9 development environments.
describeEnvironmentsRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeEnvironmentsResponse describeEnvironments(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets information about AWS Cloud9 development environments.
describeEnvironmentsRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault ListEnvironmentsResponse listEnvironments() throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets a list of AWS Cloud9 development environment identifiers.
BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptionlistEnvironments(ListEnvironmentsRequest),
AWS API
Documentationdefault ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets a list of AWS Cloud9 development environment identifiers.
listEnvironmentsRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets a list of AWS Cloud9 development environment identifiers.
listEnvironmentsRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault ListEnvironmentsIterable listEnvironmentsPaginator() throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets a list of AWS Cloud9 development environment identifiers.
This is a variant of
listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client
.listEnvironmentsPaginator(request);
for (software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest) operation.
BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptionlistEnvironmentsPaginator(ListEnvironmentsRequest),
AWS API
Documentationdefault ListEnvironmentsIterable listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Gets a list of AWS Cloud9 development environment identifiers.
This is a variant of
listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client
.listEnvironmentsPaginator(request);
for (software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest) operation.
listEnvironmentsRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Changes the settings of an existing AWS Cloud9 development environment.
updateEnvironmentRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Changes the settings of an existing AWS Cloud9 development environment.
updateEnvironmentRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateEnvironmentMembershipResponse updateEnvironmentMembership(UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Changes the settings of an existing environment member for an AWS Cloud9 development environment.
updateEnvironmentMembershipRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateEnvironmentMembershipResponse updateEnvironmentMembership(Consumer<UpdateEnvironmentMembershipRequest.Builder> updateEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, SdkServiceException, SdkClientException, Cloud9Exception
Changes the settings of an existing environment member for an AWS Cloud9 development environment.
updateEnvironmentMembershipRequest - BadRequestException - The target request is invalid.ConflictException - A conflict occurred.NotFoundException - The target resource cannot be found.ForbiddenException - An access permissions issue occurred.TooManyRequestsException - Too many service requests were made over the given time period.LimitExceededException - A service limit was exceeded.InternalServerErrorException - An internal server error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.Cloud9Exception - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.