com.amazonaws.services.cloud9

Class AWSCloud9Client

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloud9.AWSCloud9Client

All Implemented Interfaces:

AWSCloud9

Direct Known Subclasses:

AWSCloud9AsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSCloud9Client
extends AmazonWebServiceClient
implements AWSCloud9

Client for accessing AWS Cloud9. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.cloud9.AWSCloud9

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSCloud9ClientBuilder	builder()
CreateEnvironmentEC2Result	createEnvironmentEC2(CreateEnvironmentEC2Request request) 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 request) Adds an environment member to an Cloud9 development environment.
DeleteEnvironmentResult	deleteEnvironment(DeleteEnvironmentRequest request) Deletes an Cloud9 development environment.
DeleteEnvironmentMembershipResult	deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest request) Deletes an environment member from an Cloud9 development environment.
DescribeEnvironmentMembershipsResult	describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest request) Gets information about environment members for an Cloud9 development environment.
DescribeEnvironmentsResult	describeEnvironments(DescribeEnvironmentsRequest request) Gets information about Cloud9 development environments.
DescribeEnvironmentStatusResult	describeEnvironmentStatus(DescribeEnvironmentStatusRequest request) 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 request) Gets a list of Cloud9 development environment identifiers.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) 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 request) Adds tags to an Cloud9 development environment.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from an Cloud9 development environment.
UpdateEnvironmentResult	updateEnvironment(UpdateEnvironmentRequest request) Changes the settings of an existing Cloud9 development environment.
UpdateEnvironmentMembershipResult	updateEnvironmentMembership(UpdateEnvironmentMembershipRequest request) Changes the settings of an existing environment member for an Cloud9 development environment.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSCloud9ClientBuilder builder()

createEnvironmentEC2

public CreateEnvironmentEC2Result createEnvironmentEC2(CreateEnvironmentEC2Request request)

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

Specified by:

createEnvironmentEC2 in interface AWSCloud9

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

public CreateEnvironmentMembershipResult createEnvironmentMembership(CreateEnvironmentMembershipRequest request)

Adds an environment member to an Cloud9 development environment.

Specified by:

createEnvironmentMembership in interface AWSCloud9

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

public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)

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

Specified by:

deleteEnvironment in interface AWSCloud9

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

public DeleteEnvironmentMembershipResult deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest request)

Deletes an environment member from an Cloud9 development environment.

Specified by:

deleteEnvironmentMembership in interface AWSCloud9

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

public DescribeEnvironmentMembershipsResult describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest request)

Gets information about environment members for an Cloud9 development environment.

Specified by:

describeEnvironmentMemberships in interface AWSCloud9

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

public DescribeEnvironmentStatusResult describeEnvironmentStatus(DescribeEnvironmentStatusRequest request)

Gets status information for an Cloud9 development environment.

Specified by:

describeEnvironmentStatus in interface AWSCloud9

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

public DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest request)

Gets information about Cloud9 development environments.

Specified by:

describeEnvironments in interface AWSCloud9

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

public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)

Gets a list of Cloud9 development environment identifiers.

Specified by:

listEnvironments in interface AWSCloud9

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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

Specified by:

listTagsForResource in interface AWSCloud9

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

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AWSCloud9

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from an Cloud9 development environment.

Specified by:

untagResource in interface AWSCloud9

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

public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)

Changes the settings of an existing Cloud9 development environment.

Specified by:

updateEnvironment in interface AWSCloud9

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

public UpdateEnvironmentMembershipResult updateEnvironmentMembership(UpdateEnvironmentMembershipRequest request)

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

Specified by:

updateEnvironmentMembership in interface AWSCloud9

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSCloud9

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AWSCloud9

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.

Specified by:

shutdown in interface AWSCloud9

Overrides:

shutdown in class AmazonWebServiceClient