com.amazonaws.services.cloud9.AWSCloud9 Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cloud9;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.cloud9.model.*;
/**
* Interface for accessing AWS Cloud9.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.cloud9.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.
*
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCloud9 {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "cloud9";
/**
*
* Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and
* then connects from the instance to the environment.
*
*
* @param createEnvironmentEC2Request
* @return Result of the CreateEnvironmentEC2 operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSCloud9.CreateEnvironmentEC2
* @see AWS
* API Documentation
*/
CreateEnvironmentEC2Result createEnvironmentEC2(CreateEnvironmentEC2Request createEnvironmentEC2Request);
/**
*
* Adds an environment member to an Cloud9 development environment.
*
*
* @param createEnvironmentMembershipRequest
* @return Result of the CreateEnvironmentMembership operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSCloud9.CreateEnvironmentMembership
* @see AWS API Documentation
*/
CreateEnvironmentMembershipResult createEnvironmentMembership(CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest);
/**
*
* Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also
* terminates the instance.
*
*
* @param deleteEnvironmentRequest
* @return Result of the DeleteEnvironment operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSCloud9.DeleteEnvironment
* @see AWS API
* Documentation
*/
DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest);
/**
*
* Deletes an environment member from a development environment.
*
*
* @param deleteEnvironmentMembershipRequest
* @return Result of the DeleteEnvironmentMembership operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSCloud9.DeleteEnvironmentMembership
* @see AWS API Documentation
*/
DeleteEnvironmentMembershipResult deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest);
/**
*
* Gets information about environment members for an Cloud9 development environment.
*
*
* @param describeEnvironmentMembershipsRequest
* @return Result of the DescribeEnvironmentMemberships operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSCloud9.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
DescribeEnvironmentMembershipsResult describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest);
/**
*
* Gets status information for an Cloud9 development environment.
*
*
* @param describeEnvironmentStatusRequest
* @return Result of the DescribeEnvironmentStatus operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSCloud9.DescribeEnvironmentStatus
* @see AWS API Documentation
*/
DescribeEnvironmentStatusResult describeEnvironmentStatus(DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest);
/**
*
* Gets information about Cloud9 development environments.
*
*
* @param describeEnvironmentsRequest
* @return Result of the DescribeEnvironments operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSCloud9.DescribeEnvironments
* @see AWS
* API Documentation
*/
DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest);
/**
*
* Gets a list of Cloud9 development environment identifiers.
*
*
* @param listEnvironmentsRequest
* @return Result of the ListEnvironments operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSCloud9.ListEnvironments
* @see AWS API
* Documentation
*/
ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest);
/**
*
* Gets a list of the tags associated with an Cloud9 development environment.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws NotFoundException
* The target resource cannot be found.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws BadRequestException
* The target request is invalid.
* @sample AWSCloud9.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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.
*
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws NotFoundException
* The target resource cannot be found.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws BadRequestException
* The target request is invalid.
* @throws ConcurrentAccessException
* A concurrent access issue occurred.
* @sample AWSCloud9.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes tags from an Cloud9 development environment.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws NotFoundException
* The target resource cannot be found.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws BadRequestException
* The target request is invalid.
* @throws ConcurrentAccessException
* A concurrent access issue occurred.
* @sample AWSCloud9.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Changes the settings of an existing Cloud9 development environment.
*
*
* @param updateEnvironmentRequest
* @return Result of the UpdateEnvironment operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSCloud9.UpdateEnvironment
* @see AWS API
* Documentation
*/
UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest);
/**
*
* Changes the settings of an existing environment member for an Cloud9 development environment.
*
*
* @param updateEnvironmentMembershipRequest
* @return Result of the UpdateEnvironmentMembership operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSCloud9.UpdateEnvironmentMembership
* @see AWS API Documentation
*/
UpdateEnvironmentMembershipResult updateEnvironmentMembership(UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}