Class: Aws::Cloud9::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Cloud9::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- lib/aws-sdk-cloud9/client.rb
Overview
An API client for Cloud9. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::Cloud9::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_environment_ec2(params = {}) ⇒ Types::CreateEnvironmentEC2Result
Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
-
#create_environment_membership(params = {}) ⇒ Types::CreateEnvironmentMembershipResult
Adds an environment member to an Cloud9 development environment.
-
#delete_environment(params = {}) ⇒ Struct
Deletes an Cloud9 development environment.
-
#delete_environment_membership(params = {}) ⇒ Struct
Deletes an environment member from a development environment.
-
#describe_environment_memberships(params = {}) ⇒ Types::DescribeEnvironmentMembershipsResult
Gets information about environment members for an Cloud9 development environment.
-
#describe_environment_status(params = {}) ⇒ Types::DescribeEnvironmentStatusResult
Gets status information for an Cloud9 development environment.
-
#describe_environments(params = {}) ⇒ Types::DescribeEnvironmentsResult
Gets information about Cloud9 development environments.
-
#list_environments(params = {}) ⇒ Types::ListEnvironmentsResult
Gets a list of Cloud9 development environment identifiers.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of the tags associated with an Cloud9 development environment.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to an Cloud9 development environment.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from an Cloud9 development environment.
-
#update_environment(params = {}) ⇒ Struct
Changes the settings of an existing Cloud9 development environment.
-
#update_environment_membership(params = {}) ⇒ Types::UpdateEnvironmentMembershipResult
Changes the settings of an existing environment member for an Cloud9 development environment.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'lib/aws-sdk-cloud9/client.rb', line 395 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1277 1278 1279 |
# File 'lib/aws-sdk-cloud9/client.rb', line 1277 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1280 1281 1282 |
# File 'lib/aws-sdk-cloud9/client.rb', line 1280 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 |
# File 'lib/aws-sdk-cloud9/client.rb', line 1255 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-cloud9' context[:gem_version] = '1.67.0' Seahorse::Client::Request.new(handlers, context) end |
#create_environment_ec2(params = {}) ⇒ Types::CreateEnvironmentEC2Result
Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
558 559 560 561 |
# File 'lib/aws-sdk-cloud9/client.rb', line 558 def create_environment_ec2(params = {}, = {}) req = build_request(:create_environment_ec2, params) req.send_request() end |
#create_environment_membership(params = {}) ⇒ Types::CreateEnvironmentMembershipResult
Adds an environment member to an Cloud9 development environment.
624 625 626 627 |
# File 'lib/aws-sdk-cloud9/client.rb', line 624 def create_environment_membership(params = {}, = {}) req = build_request(:create_environment_membership, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Struct
Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
658 659 660 661 |
# File 'lib/aws-sdk-cloud9/client.rb', line 658 def delete_environment(params = {}, = {}) req = build_request(:delete_environment, params) req.send_request() end |
#delete_environment_membership(params = {}) ⇒ Struct
Deletes an environment member from a development environment.
697 698 699 700 |
# File 'lib/aws-sdk-cloud9/client.rb', line 697 def delete_environment_membership(params = {}, = {}) req = build_request(:delete_environment_membership, params) req.send_request() end |
#describe_environment_memberships(params = {}) ⇒ Types::DescribeEnvironmentMembershipsResult
Gets information about environment members for an Cloud9 development environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
847 848 849 850 |
# File 'lib/aws-sdk-cloud9/client.rb', line 847 def describe_environment_memberships(params = {}, = {}) req = build_request(:describe_environment_memberships, params) req.send_request() end |
#describe_environment_status(params = {}) ⇒ Types::DescribeEnvironmentStatusResult
Gets status information for an Cloud9 development environment.
890 891 892 893 |
# File 'lib/aws-sdk-cloud9/client.rb', line 890 def describe_environment_status(params = {}, = {}) req = build_request(:describe_environment_status, params) req.send_request() end |
#describe_environments(params = {}) ⇒ Types::DescribeEnvironmentsResult
Gets information about Cloud9 development environments.
967 968 969 970 |
# File 'lib/aws-sdk-cloud9/client.rb', line 967 def describe_environments(params = {}, = {}) req = build_request(:describe_environments, params) req.send_request() end |
#list_environments(params = {}) ⇒ Types::ListEnvironmentsResult
Gets a list of Cloud9 development environment identifiers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1024 1025 1026 1027 |
# File 'lib/aws-sdk-cloud9/client.rb', line 1024 def list_environments(params = {}, = {}) req = build_request(:list_environments, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of the tags associated with an Cloud9 development environment.
1056 1057 1058 1059 |
# File 'lib/aws-sdk-cloud9/client.rb', line 1056 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1091 1092 1093 1094 |
# File 'lib/aws-sdk-cloud9/client.rb', line 1091 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from an Cloud9 development environment.
1119 1120 1121 1122 |
# File 'lib/aws-sdk-cloud9/client.rb', line 1119 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_environment(params = {}) ⇒ Struct
Changes the settings of an existing Cloud9 development environment.
1179 1180 1181 1182 |
# File 'lib/aws-sdk-cloud9/client.rb', line 1179 def update_environment(params = {}, = {}) req = build_request(:update_environment, params) req.send_request() end |
#update_environment_membership(params = {}) ⇒ Types::UpdateEnvironmentMembershipResult
Changes the settings of an existing environment member for an Cloud9 development environment.
1246 1247 1248 1249 |
# File 'lib/aws-sdk-cloud9/client.rb', line 1246 def update_environment_membership(params = {}, = {}) req = build_request(:update_environment_membership, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1270 1271 1272 |
# File 'lib/aws-sdk-cloud9/client.rb', line 1270 def waiter_names [] end |