Cloud9

public struct Cloud9

Client object for interacting with AWS Cloud9 service.

AWS Cloud9 AWS 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 AWS Cloud9, see the AWS Cloud9 User Guide. AWS Cloud9 supports these operations: CreateEnvironmentEC2: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then 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.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the Cloud9 client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls

createEnvironmentEC2(_:)
Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
Declaration
Swift

public func createEnvironmentEC2(_ input: CreateEnvironmentEC2Request) -> EventLoopFuture<CreateEnvironmentEC2Result>


                    
                    
                    createEnvironmentMembership(_:)

Adds an environment member to an AWS Cloud9 development environment.

Declaration

Swift

public func createEnvironmentMembership(_ input: CreateEnvironmentMembershipRequest) -> EventLoopFuture<CreateEnvironmentMembershipResult>

deleteEnvironment(_:)
Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
Declaration
Swift

public func deleteEnvironment(_ input: DeleteEnvironmentRequest) -> EventLoopFuture<DeleteEnvironmentResult>


                    
                    
                    deleteEnvironmentMembership(_:)

Deletes an environment member from an AWS Cloud9 development environment.

Declaration

Swift

public func deleteEnvironmentMembership(_ input: DeleteEnvironmentMembershipRequest) -> EventLoopFuture<DeleteEnvironmentMembershipResult>


                    
                    
                    describeEnvironmentMemberships(_:)

Gets information about environment members for an AWS Cloud9 development environment.

Declaration

Swift

public func describeEnvironmentMemberships(_ input: DescribeEnvironmentMembershipsRequest) -> EventLoopFuture<DescribeEnvironmentMembershipsResult>


                    
                    
                    describeEnvironmentStatus(_:)

Gets status information for an AWS Cloud9 development environment.

Declaration

Swift

public func describeEnvironmentStatus(_ input: DescribeEnvironmentStatusRequest) -> EventLoopFuture<DescribeEnvironmentStatusResult>


                    
                    
                    describeEnvironments(_:)

Gets information about AWS Cloud9 development environments.

Declaration

Swift

public func describeEnvironments(_ input: DescribeEnvironmentsRequest) -> EventLoopFuture<DescribeEnvironmentsResult>


                    
                    
                    listEnvironments(_:)

Gets a list of AWS Cloud9 development environment identifiers.

Declaration

Swift

public func listEnvironments(_ input: ListEnvironmentsRequest) -> EventLoopFuture<ListEnvironmentsResult>


                    
                    
                    listTagsForResource(_:)

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

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

tagResource(_:)
Adds tags to an AWS Cloud9 development environment. Tags that you add to an AWS Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.
Declaration
Swift

public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>


                    
                    
                    untagResource(_:)

Removes tags from an AWS Cloud9 development environment.

Declaration

Swift

public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>


                    
                    
                    updateEnvironment(_:)

Changes the settings of an existing AWS Cloud9 development environment.

Declaration

Swift

public func updateEnvironment(_ input: UpdateEnvironmentRequest) -> EventLoopFuture<UpdateEnvironmentResult>


                    
                    
                    updateEnvironmentMembership(_:)

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

Declaration

Swift

public func updateEnvironmentMembership(_ input: UpdateEnvironmentMembershipRequest) -> EventLoopFuture<UpdateEnvironmentMembershipResult>

Paginators


                    
                    
                    describeEnvironmentMembershipsPaginator(_:onPage:)

Gets information about environment members for an AWS Cloud9 development environment.

Declaration

Swift

public func describeEnvironmentMembershipsPaginator(_ input: DescribeEnvironmentMembershipsRequest, onPage: @escaping (DescribeEnvironmentMembershipsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listEnvironmentsPaginator(_:onPage:)

Gets a list of AWS Cloud9 development environment identifiers.

Declaration

Swift

public func listEnvironmentsPaginator(_ input: ListEnvironmentsRequest, onPage: @escaping (ListEnvironmentsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    DescribeEnvironmentMembershipsRequest

Undocumented

Declaration

Swift

public struct DescribeEnvironmentMembershipsRequest : AWSShape

extension Cloud9.DescribeEnvironmentMembershipsRequest: AWSPaginateStringToken


                    
                    
                    ListEnvironmentsRequest

Undocumented

Declaration

Swift

public struct ListEnvironmentsRequest : AWSShape

extension Cloud9.ListEnvironmentsRequest: AWSPaginateStringToken

CreateEnvironmentEC2Request
Undocumented
See more
Declaration
Swift

public struct CreateEnvironmentEC2Request : AWSShape
CreateEnvironmentEC2Result
Undocumented
See more
Declaration
Swift

public struct CreateEnvironmentEC2Result : AWSShape
CreateEnvironmentMembershipRequest
Undocumented
See more
Declaration
Swift

public struct CreateEnvironmentMembershipRequest : AWSShape
CreateEnvironmentMembershipResult
Undocumented
See more
Declaration
Swift

public struct CreateEnvironmentMembershipResult : AWSShape
DeleteEnvironmentMembershipRequest
Undocumented
See more
Declaration
Swift

public struct DeleteEnvironmentMembershipRequest : AWSShape
DeleteEnvironmentMembershipResult
Undocumented
See more
Declaration
Swift

public struct DeleteEnvironmentMembershipResult : AWSShape
DeleteEnvironmentRequest
Undocumented
See more
Declaration
Swift

public struct DeleteEnvironmentRequest : AWSShape
DeleteEnvironmentResult
Undocumented
See more
Declaration
Swift

public struct DeleteEnvironmentResult : AWSShape
DescribeEnvironmentMembershipsResult
Undocumented
See more
Declaration
Swift

public struct DescribeEnvironmentMembershipsResult : AWSShape
DescribeEnvironmentStatusRequest
Undocumented
See more
Declaration
Swift

public struct DescribeEnvironmentStatusRequest : AWSShape
DescribeEnvironmentStatusResult
Undocumented
See more
Declaration
Swift

public struct DescribeEnvironmentStatusResult : AWSShape
DescribeEnvironmentsRequest
Undocumented
See more
Declaration
Swift

public struct DescribeEnvironmentsRequest : AWSShape
DescribeEnvironmentsResult
Undocumented
See more
Declaration
Swift

public struct DescribeEnvironmentsResult : AWSShape
Environment
Undocumented
See more
Declaration
Swift

public struct Environment : AWSShape
EnvironmentLifecycle
Undocumented
See more
Declaration
Swift

public struct EnvironmentLifecycle : AWSShape
EnvironmentMember
Undocumented
See more
Declaration
Swift

public struct EnvironmentMember : AWSShape
ListEnvironmentsResult
Undocumented
See more
Declaration
Swift

public struct ListEnvironmentsResult : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
Tag
Undocumented
See more
Declaration
Swift

public struct Tag : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
TagResourceResponse
Undocumented
See more
Declaration
Swift

public struct TagResourceResponse : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UntagResourceResponse
Undocumented
See more
Declaration
Swift

public struct UntagResourceResponse : AWSShape
UpdateEnvironmentMembershipRequest
Undocumented
See more
Declaration
Swift

public struct UpdateEnvironmentMembershipRequest : AWSShape
UpdateEnvironmentMembershipResult
Undocumented
See more
Declaration
Swift

public struct UpdateEnvironmentMembershipResult : AWSShape
UpdateEnvironmentRequest
Undocumented
See more
Declaration
Swift

public struct UpdateEnvironmentRequest : AWSShape
UpdateEnvironmentResult
Undocumented
See more
Declaration
Swift

public struct UpdateEnvironmentResult : AWSShape

Enums


                    
                    
                    ConnectionType

Undocumented

Declaration

Swift

public enum ConnectionType : String, CustomStringConvertible, Codable


                    
                    
                    EnvironmentLifecycleStatus

Undocumented

Declaration

Swift

public enum EnvironmentLifecycleStatus : String, CustomStringConvertible, Codable


                    
                    
                    EnvironmentStatus

Undocumented

Declaration

Swift

public enum EnvironmentStatus : String, CustomStringConvertible, Codable


                    
                    
                    EnvironmentType

Undocumented

Declaration

Swift

public enum EnvironmentType : String, CustomStringConvertible, Codable


                    
                    
                    MemberPermissions

Undocumented

Declaration

Swift

public enum MemberPermissions : String, CustomStringConvertible, Codable


                    
                    
                    Permissions

Undocumented

Declaration

Swift

public enum Permissions : String, CustomStringConvertible, Codable