AWSCloud9 (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.cloud9

Interface AWSCloud9

All Known Subinterfaces:

AWSCloud9Async

All Known Implementing Classes:

AbstractAWSCloud9, AbstractAWSCloud9Async, AWSCloud9AsyncClient, AWSCloud9Client
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCloud9
```
Interface for accessing AWS Cloud9.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCloud9 instead.

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 and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateEnvironmentEC2Result`	`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.
`CreateEnvironmentMembershipResult`	`createEnvironmentMembership (CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest)` Adds an environment member to an Cloud9 development environment.
`DeleteEnvironmentResult`	`deleteEnvironment (DeleteEnvironmentRequest deleteEnvironmentRequest)` Deletes an Cloud9 development environment.
`DeleteEnvironmentMembershipResult`	`deleteEnvironmentMembership (DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest)` Deletes an environment member from a development environment.
`DescribeEnvironmentMembershipsResult`	`describeEnvironmentMemberships (DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest)` Gets information about environment members for an Cloud9 development environment.
`DescribeEnvironmentsResult`	`describeEnvironments (DescribeEnvironmentsRequest describeEnvironmentsRequest)` Gets information about Cloud9 development environments.
`DescribeEnvironmentStatusResult`	`describeEnvironmentStatus (DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest)` Gets status information for an Cloud9 development environment.
`ResponseMetadata`	`getCachedResponseMetadata (AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListEnvironmentsResult`	`listEnvironments (ListEnvironmentsRequest listEnvironmentsRequest)` Gets a list of Cloud9 development environment identifiers.
`ListTagsForResourceResult`	`listTagsForResource (ListTagsForResourceRequest listTagsForResourceRequest)` Gets a list of the tags associated with an Cloud9 development environment.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource (TagResourceRequest tagResourceRequest)` Adds tags to an Cloud9 development environment.
`UntagResourceResult`	`untagResource (UntagResourceRequest untagResourceRequest)` Removes tags from an Cloud9 development environment.
`UpdateEnvironmentResult`	`updateEnvironment (UpdateEnvironmentRequest updateEnvironmentRequest)` Changes the settings of an existing Cloud9 development environment.
`UpdateEnvironmentMembershipResult`	`updateEnvironmentMembership (UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest)` Changes the settings of an existing environment member for an Cloud9 development environment.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createEnvironmentEC2
```
CreateEnvironmentEC2Result 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.
    
    Parameters:
    
    createEnvironmentEC2Request -
    
    Returns:
    
    Result of the CreateEnvironmentEC2 operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createEnvironmentMembership
```
CreateEnvironmentMembershipResult createEnvironmentMembership(CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest)
```
    Adds an environment member to an Cloud9 development environment.
    
    Parameters:
    
    createEnvironmentMembershipRequest -
    
    Returns:
    
    Result of the CreateEnvironmentMembership operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteEnvironment
```
DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
```
    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.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteEnvironmentMembership
```
DeleteEnvironmentMembershipResult deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest)
```
    Deletes an environment member from a development environment.
    
    Parameters:
    
    deleteEnvironmentMembershipRequest -
    
    Returns:
    
    Result of the DeleteEnvironmentMembership operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironmentMemberships
```
DescribeEnvironmentMembershipsResult describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest)
```
    Gets information about environment members for an Cloud9 development environment.
    
    Parameters:
    
    describeEnvironmentMembershipsRequest -
    
    Returns:
    
    Result of the DescribeEnvironmentMemberships operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironmentStatus
```
DescribeEnvironmentStatusResult describeEnvironmentStatus(DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest)
```
    Gets status information for an Cloud9 development environment.
    
    Parameters:
    
    describeEnvironmentStatusRequest -
    
    Returns:
    
    Result of the DescribeEnvironmentStatus operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironments
```
DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
```
    Gets information about Cloud9 development environments.
    
    Parameters:
    
    describeEnvironmentsRequest -
    
    Returns:
    
    Result of the DescribeEnvironments operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEnvironments
```
ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
```
    Gets a list of Cloud9 development environment identifiers.
    
    Parameters:
    
    listEnvironmentsRequest -
    
    Returns:
    
    Result of the ListEnvironments operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Gets a list of the tags associated with an Cloud9 development environment.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    NotFoundException - The target resource cannot be found.
    
    InternalServerErrorException - An internal server error occurred.
    
    BadRequestException - The target request is invalid.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    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.
    
    Throws:
    
    NotFoundException - The target resource cannot be found.
    
    InternalServerErrorException - An internal server error occurred.
    
    BadRequestException - The target request is invalid.
    
    ConcurrentAccessException - A concurrent access issue occurred.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes tags from an Cloud9 development environment.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    NotFoundException - The target resource cannot be found.
    
    InternalServerErrorException - An internal server error occurred.
    
    BadRequestException - The target request is invalid.
    
    ConcurrentAccessException - A concurrent access issue occurred.
    
    See Also:
    
    AWS API Documentation
  - updateEnvironment
```
UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
```
    Changes the settings of an existing Cloud9 development environment.
    
    Parameters:
    
    updateEnvironmentRequest -
    
    Returns:
    
    Result of the UpdateEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateEnvironmentMembership
```
UpdateEnvironmentMembershipResult updateEnvironmentMembership(UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest)
```
    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.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Interface AWSCloud9

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createEnvironmentEC2

createEnvironmentMembership

deleteEnvironment

deleteEnvironmentMembership

describeEnvironmentMemberships

describeEnvironmentStatus

describeEnvironments

listEnvironments

listTagsForResource

tagResource

untagResource

updateEnvironment

updateEnvironmentMembership

shutdown

getCachedResponseMetadata