Interface Cloud9Client

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface Cloud9Client
extends AwsClient

Service client for accessing AWS Cloud9. This can be created using the static builder() method. Cloud9

Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.

For more information about Cloud9, see the Cloud9 User Guide.

Cloud9 supports these operations:

• CreateEnvironmentEC2: Creates an Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.

• CreateEnvironmentMembership: Adds an environment member to an environment.

• DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, 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.

• ListTagsForResource: Gets the tags for an environment.

• TagResource: Adds tags to an environment.

• UntagResource: Removes tags from an environment.

• UpdateEnvironment: Changes the settings of an existing environment.

• UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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 Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
default CreateEnvironmentEc2Response	createEnvironmentEC2(CreateEnvironmentEc2Request createEnvironmentEc2Request)	Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
default CreateEnvironmentMembershipResponse	createEnvironmentMembership(Consumer<CreateEnvironmentMembershipRequest.Builder> createEnvironmentMembershipRequest)	Adds an environment member to an Cloud9 development environment.
default CreateEnvironmentMembershipResponse	createEnvironmentMembership(CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest)	Adds an environment member to an Cloud9 development environment.
default DeleteEnvironmentResponse	deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)	Deletes an Cloud9 development environment.
default DeleteEnvironmentResponse	deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)	Deletes an Cloud9 development environment.
default DeleteEnvironmentMembershipResponse	deleteEnvironmentMembership(Consumer<DeleteEnvironmentMembershipRequest.Builder> deleteEnvironmentMembershipRequest)	Deletes an environment member from a development environment.
default DeleteEnvironmentMembershipResponse	deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest)	Deletes an environment member from a development environment.
default DescribeEnvironmentMembershipsResponse	describeEnvironmentMemberships()	Gets information about environment members for an Cloud9 development environment.
default DescribeEnvironmentMembershipsResponse	describeEnvironmentMemberships(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest)	Gets information about environment members for an Cloud9 development environment.
default DescribeEnvironmentMembershipsResponse	describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest)	Gets information about environment members for an Cloud9 development environment.
default DescribeEnvironmentMembershipsIterable	describeEnvironmentMembershipsPaginator()	This is a variant of describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest) operation.
default DescribeEnvironmentMembershipsIterable	describeEnvironmentMembershipsPaginator(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest)	This is a variant of describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest) operation.
default DescribeEnvironmentMembershipsIterable	describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest)	This is a variant of describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest) operation.
default DescribeEnvironmentsResponse	describeEnvironments(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest)	Gets information about Cloud9 development environments.
default DescribeEnvironmentsResponse	describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)	Gets information about Cloud9 development environments.
default DescribeEnvironmentStatusResponse	describeEnvironmentStatus(Consumer<DescribeEnvironmentStatusRequest.Builder> describeEnvironmentStatusRequest)	Gets status information for an Cloud9 development environment.
default DescribeEnvironmentStatusResponse	describeEnvironmentStatus(DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest)	Gets status information for an Cloud9 development environment.
default ListEnvironmentsResponse	listEnvironments()	Gets a list of Cloud9 development environment identifiers.
default ListEnvironmentsResponse	listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)	Gets a list of Cloud9 development environment identifiers.
default ListEnvironmentsResponse	listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)	Gets a list of Cloud9 development environment identifiers.
default ListEnvironmentsIterable	listEnvironmentsPaginator()	This is a variant of listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest) operation.
default ListEnvironmentsIterable	listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)	This is a variant of listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest) operation.
default ListEnvironmentsIterable	listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)	This is a variant of listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Gets a list of the tags associated with an Cloud9 development environment.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Gets a list of the tags associated with an Cloud9 development environment.
default Cloud9ServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds tags to an Cloud9 development environment.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds tags to an Cloud9 development environment.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from an Cloud9 development environment.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from an Cloud9 development environment.
default UpdateEnvironmentResponse	updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)	Changes the settings of an existing Cloud9 development environment.
default UpdateEnvironmentResponse	updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)	Changes the settings of an existing Cloud9 development environment.
default UpdateEnvironmentMembershipResponse	updateEnvironmentMembership(Consumer<UpdateEnvironmentMembershipRequest.Builder> updateEnvironmentMembershipRequest)	Changes the settings of an existing environment member for an Cloud9 development environment.
default UpdateEnvironmentMembershipResponse	updateEnvironmentMembership(UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest)	Changes the settings of an existing environment member for an Cloud9 development environment.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createEnvironmentEC2

default CreateEnvironmentEc2Response createEnvironmentEC2(CreateEnvironmentEc2Request createEnvironmentEc2Request)
                                                   throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.

Parameters:

createEnvironmentEc2Request -

Returns:

Result of the CreateEnvironmentEC2 operation returned by the service.

See Also:

• AWS API Documentation

createEnvironmentEC2

default CreateEnvironmentEc2Response createEnvironmentEC2(Consumer<CreateEnvironmentEc2Request.Builder> createEnvironmentEc2Request)
                                                   throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.

This is a convenience which creates an instance of the CreateEnvironmentEc2Request.Builder avoiding the need to create one manually via CreateEnvironmentEc2Request.builder()

Parameters:

createEnvironmentEc2Request - A Consumer that will call methods on CreateEnvironmentEc2Request.Builder to create a request.

Returns:

Result of the CreateEnvironmentEC2 operation returned by the service.

See Also:

• AWS API Documentation

createEnvironmentMembership

default CreateEnvironmentMembershipResponse createEnvironmentMembership(CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest)
                                                                 throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Adds an environment member to an Cloud9 development environment.

Parameters:

createEnvironmentMembershipRequest -

Returns:

Result of the CreateEnvironmentMembership operation returned by the service.

See Also:

• AWS API Documentation

createEnvironmentMembership

default CreateEnvironmentMembershipResponse createEnvironmentMembership(Consumer<CreateEnvironmentMembershipRequest.Builder> createEnvironmentMembershipRequest)
                                                                 throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Adds an environment member to an Cloud9 development environment.

This is a convenience which creates an instance of the CreateEnvironmentMembershipRequest.Builder avoiding the need to create one manually via CreateEnvironmentMembershipRequest.builder()

Parameters:

createEnvironmentMembershipRequest - A Consumer that will call methods on CreateEnvironmentMembershipRequest.Builder to create a request.

Returns:

Result of the CreateEnvironmentMembership operation returned by the service.

See Also:

• AWS API Documentation

deleteEnvironment

default DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
                                             throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

Parameters:

deleteEnvironmentRequest -

Returns:

Result of the DeleteEnvironment operation returned by the service.

See Also:

• AWS API Documentation

deleteEnvironment

default DeleteEnvironmentResponse deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)
                                             throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

This is a convenience which creates an instance of the DeleteEnvironmentRequest.Builder avoiding the need to create one manually via DeleteEnvironmentRequest.builder()

Parameters:

deleteEnvironmentRequest - A Consumer that will call methods on DeleteEnvironmentRequest.Builder to create a request.

Returns:

Result of the DeleteEnvironment operation returned by the service.

See Also:

• AWS API Documentation

deleteEnvironmentMembership

default DeleteEnvironmentMembershipResponse deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest)
                                                                 throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Deletes an environment member from a development environment.

Parameters:

deleteEnvironmentMembershipRequest -

Returns:

Result of the DeleteEnvironmentMembership operation returned by the service.

See Also:

• AWS API Documentation

deleteEnvironmentMembership

default DeleteEnvironmentMembershipResponse deleteEnvironmentMembership(Consumer<DeleteEnvironmentMembershipRequest.Builder> deleteEnvironmentMembershipRequest)
                                                                 throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Deletes an environment member from a development environment.

This is a convenience which creates an instance of the DeleteEnvironmentMembershipRequest.Builder avoiding the need to create one manually via DeleteEnvironmentMembershipRequest.builder()

Parameters:

deleteEnvironmentMembershipRequest - A Consumer that will call methods on DeleteEnvironmentMembershipRequest.Builder to create a request.

Returns:

Result of the DeleteEnvironmentMembership operation returned by the service.

See Also:

• AWS API Documentation

describeEnvironmentMemberships

default DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest)
                                                                       throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets information about environment members for an Cloud9 development environment.

Parameters:

describeEnvironmentMembershipsRequest -

Returns:

Result of the DescribeEnvironmentMemberships operation returned by the service.

See Also:

• AWS API Documentation

describeEnvironmentMemberships

default DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest)
                                                                       throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets information about environment members for an Cloud9 development environment.

This is a convenience which creates an instance of the DescribeEnvironmentMembershipsRequest.Builder avoiding the need to create one manually via DescribeEnvironmentMembershipsRequest.builder()

Parameters:

describeEnvironmentMembershipsRequest - A Consumer that will call methods on DescribeEnvironmentMembershipsRequest.Builder to create a request.

Returns:

Result of the DescribeEnvironmentMemberships operation returned by the service.

See Also:

• AWS API Documentation

describeEnvironmentMemberships

default DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships()
                                                                       throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets information about environment members for an Cloud9 development environment.

Returns:

Result of the DescribeEnvironmentMemberships operation returned by the service.

See Also:

• describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest)
• AWS API Documentation

describeEnvironmentMembershipsPaginator

default DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator()
                                                                                throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

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(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest)
• AWS API Documentation

describeEnvironmentMembershipsPaginator

default DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest)
                                                                                throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

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(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest) operation.

Parameters:

describeEnvironmentMembershipsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeEnvironmentMembershipsPaginator

default DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest)
                                                                                throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

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(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest) operation.

This is a convenience which creates an instance of the DescribeEnvironmentMembershipsRequest.Builder avoiding the need to create one manually via DescribeEnvironmentMembershipsRequest.builder()

Parameters:

describeEnvironmentMembershipsRequest - A Consumer that will call methods on DescribeEnvironmentMembershipsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeEnvironmentStatus

default DescribeEnvironmentStatusResponse describeEnvironmentStatus(DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest)
                                                             throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets status information for an Cloud9 development environment.

Parameters:

describeEnvironmentStatusRequest -

Returns:

Result of the DescribeEnvironmentStatus operation returned by the service.

See Also:

• AWS API Documentation

describeEnvironmentStatus

default DescribeEnvironmentStatusResponse describeEnvironmentStatus(Consumer<DescribeEnvironmentStatusRequest.Builder> describeEnvironmentStatusRequest)
                                                             throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets status information for an Cloud9 development environment.

This is a convenience which creates an instance of the DescribeEnvironmentStatusRequest.Builder avoiding the need to create one manually via DescribeEnvironmentStatusRequest.builder()

Parameters:

describeEnvironmentStatusRequest - A Consumer that will call methods on DescribeEnvironmentStatusRequest.Builder to create a request.

Returns:

Result of the DescribeEnvironmentStatus operation returned by the service.

See Also:

• AWS API Documentation

describeEnvironments

default DescribeEnvironmentsResponse describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
                                                   throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets information about Cloud9 development environments.

Parameters:

describeEnvironmentsRequest -

Returns:

Result of the DescribeEnvironments operation returned by the service.

See Also:

• AWS API Documentation

describeEnvironments

default DescribeEnvironmentsResponse describeEnvironments(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest)
                                                   throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets information about Cloud9 development environments.

This is a convenience which creates an instance of the DescribeEnvironmentsRequest.Builder avoiding the need to create one manually via DescribeEnvironmentsRequest.builder()

Parameters:

describeEnvironmentsRequest - A Consumer that will call methods on DescribeEnvironmentsRequest.Builder to create a request.

Returns:

Result of the DescribeEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
                                           throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets a list of Cloud9 development environment identifiers.

Parameters:

listEnvironmentsRequest -

Returns:

Result of the ListEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                           throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets a list of Cloud9 development environment identifiers.

This is a convenience which creates an instance of the ListEnvironmentsRequest.Builder avoiding the need to create one manually via ListEnvironmentsRequest.builder()

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.Builder to create a request.

Returns:

Result of the ListEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments()
                                           throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets a list of Cloud9 development environment identifiers.

Returns:

Result of the ListEnvironments operation returned by the service.

See Also:

• listEnvironments(ListEnvironmentsRequest)
• AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator()
                                                    throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

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(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listEnvironmentsPaginator(ListEnvironmentsRequest)
• AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)
                                                    throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

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(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest) operation.

Parameters:

listEnvironmentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                                    throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

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(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest) operation.

This is a convenience which creates an instance of the ListEnvironmentsRequest.Builder avoiding the need to create one manually via ListEnvironmentsRequest.builder()

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws NotFoundException,
InternalServerErrorException,
BadRequestException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets a list of the tags associated with an Cloud9 development environment.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws NotFoundException,
InternalServerErrorException,
BadRequestException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Gets a list of the tags associated with an Cloud9 development environment.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws NotFoundException,
InternalServerErrorException,
BadRequestException,
ConcurrentAccessException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Adds tags to an Cloud9 development environment.

Tags that you add to an Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws NotFoundException,
InternalServerErrorException,
BadRequestException,
ConcurrentAccessException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Adds tags to an Cloud9 development environment.

Tags that you add to an Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws NotFoundException,
InternalServerErrorException,
BadRequestException,
ConcurrentAccessException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Removes tags from an Cloud9 development environment.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws NotFoundException,
InternalServerErrorException,
BadRequestException,
ConcurrentAccessException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Removes tags from an Cloud9 development environment.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateEnvironment

default UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
                                             throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Changes the settings of an existing Cloud9 development environment.

Parameters:

updateEnvironmentRequest -

Returns:

Result of the UpdateEnvironment operation returned by the service.

See Also:

• AWS API Documentation

updateEnvironment

default UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)
                                             throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Changes the settings of an existing Cloud9 development environment.

This is a convenience which creates an instance of the UpdateEnvironmentRequest.Builder avoiding the need to create one manually via UpdateEnvironmentRequest.builder()

Parameters:

updateEnvironmentRequest - A Consumer that will call methods on UpdateEnvironmentRequest.Builder to create a request.

Returns:

Result of the UpdateEnvironment operation returned by the service.

See Also:

• AWS API Documentation

updateEnvironmentMembership

default UpdateEnvironmentMembershipResponse updateEnvironmentMembership(UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest)
                                                                 throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Changes the settings of an existing environment member for an Cloud9 development environment.

Parameters:

updateEnvironmentMembershipRequest -

Returns:

Result of the UpdateEnvironmentMembership operation returned by the service.

See Also:

• AWS API Documentation

updateEnvironmentMembership

default UpdateEnvironmentMembershipResponse updateEnvironmentMembership(Consumer<UpdateEnvironmentMembershipRequest.Builder> updateEnvironmentMembershipRequest)
                                                                 throws BadRequestException,
ConflictException,
NotFoundException,
ForbiddenException,
TooManyRequestsException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
Cloud9Exception

Changes the settings of an existing environment member for an Cloud9 development environment.

This is a convenience which creates an instance of the UpdateEnvironmentMembershipRequest.Builder avoiding the need to create one manually via UpdateEnvironmentMembershipRequest.builder()

Parameters:

updateEnvironmentMembershipRequest - A Consumer that will call methods on UpdateEnvironmentMembershipRequest.Builder to create a request.

Returns:

Result of the UpdateEnvironmentMembership operation returned by the service.

See Also:

• AWS API Documentation

create

static Cloud9Client create()

Create a Cloud9Client with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static Cloud9ClientBuilder builder()

Create a builder that can be used to configure and create a Cloud9Client.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default Cloud9ServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration