aws-sdk-cloud9 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b81d38b88649b2e3b60cd47e5e37e9d3971d9e43
-  data.tar.gz: 21c034fb576f07f367e790943f614efc8037c3b7
+  metadata.gz: 3d5c6374b4ac31fcd51f14c702de1e56314d33ad
+  data.tar.gz: 59a8200973c1c4a9d37d5f21fbe30d4e554a66dc
 SHA512:
-  metadata.gz: ed405a4a3b35c407ed347da2a1fa20f14af921c40fccf65b576700445fac657d0b591956064855e7fb1473a7217d618e3726182ae803680f7d2f815d47634f25
-  data.tar.gz: 9da8c0a0dd90ab7d00f660699856a5d85a5d8492cb915d099ef966ae876de394f4102edbdac020c81afbe6942fb8fbedb68839ad30a87beba8371a65a82a52da
+  metadata.gz: 791da0c905acbbdf48febfd3ac122d333a528a8aeed6afa1fc06dd215e8fa896ee882f261d707ce79260f226681e37258d5fb4808b9b9f424a67811e21eb3ef0
+  data.tar.gz: 73d08d852c1cdc3afbf50f412691bac9e6c2b8e773575b11885241178a50e5417dd4e7db1e7a1c7f85f714133ec67e7ee84cf3e95a3d6e7d9845574ad2d3113d

data/lib/aws-sdk-cloud9.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-cloud9/customizations'
 # @service
 module Aws::Cloud9
 
-  GEM_VERSION = '1.0.0'
+  GEM_VERSION = '1.1.0'
 
 end

data/lib/aws-sdk-cloud9/client.rb

@@ -156,8 +156,8 @@ module Aws::Cloud9
     # @!group API Operations
 
     # Creates an AWS Cloud9 development environment, launches an Amazon
-    # Elastic Compute Cloud (Amazon EC2) instance, and then hosts the
-    # environment on the instance.
+    # Elastic Compute Cloud (Amazon EC2) instance, and then connects from
+    # the instance to the environment.
     #
     # @option params [required, String] :name
     #   The name of the environment to create.
@@ -179,7 +179,7 @@ module Aws::Cloud9
     #   [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
     #
     # @option params [required, String] :instance_type
-    #   The type of instance to host the environment on (for example,
+    #   The type of instance to connect to the environment (for example,
     #   `t2.micro`).
     #
     # @option params [String] :subnet_id
@@ -199,6 +199,23 @@ module Aws::Cloud9
     #
     #   * {Types::CreateEnvironmentEC2Result#environment_id #environment_id} => String
     #
+    #
+    # @example Example: CreateEnvironmentEC2
+    #
+    #   resp = client.create_environment_ec2({
+    #     name: "my-demo-environment", 
+    #     automatic_stop_time_minutes: 60, 
+    #     description: "This is my demonstration environment.", 
+    #     instance_type: "t2.micro", 
+    #     owner_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
+    #     subnet_id: "subnet-1fab8aEX", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_environment_ec2({
@@ -246,6 +263,25 @@ module Aws::Cloud9
     #
     #   * {Types::CreateEnvironmentMembershipResult#membership #membership} => Types::EnvironmentMember
     #
+    #
+    # @example Example: CreateEnvironmentMembership
+    #
+    #   resp = client.create_environment_membership({
+    #     environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #     permissions: "read-write", 
+    #     user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     membership: {
+    #       environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #       permissions: "read-write", 
+    #       user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
+    #       user_id: "AIDAJ3BA6O2FMJWCWXHEX", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_environment_membership({
@@ -271,15 +307,26 @@ module Aws::Cloud9
       req.send_request(options)
     end
 
-    # Deletes an AWS Cloud9 development environment. If the environment is
-    # hosted on an Amazon Elastic Compute Cloud (Amazon EC2) instance, also
-    # terminates the instance.
+    # Deletes an AWS Cloud9 development environment. If an Amazon EC2
+    # instance is connected to the environment, also terminates the
+    # instance.
     #
     # @option params [required, String] :environment_id
     #   The ID of the environment to delete.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: DeleteEnvironment
+    #
+    #   resp = client.delete_environment({
+    #     environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_environment({
@@ -307,6 +354,18 @@ module Aws::Cloud9
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: DeleteEnvironmentMembership
+    #
+    #   resp = client.delete_environment_membership({
+    #     environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #     user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_environment_membership({
@@ -364,6 +423,85 @@ module Aws::Cloud9
     #   * {Types::DescribeEnvironmentMembershipsResult#memberships #memberships} => Array<Types::EnvironmentMember>
     #   * {Types::DescribeEnvironmentMembershipsResult#next_token #next_token} => String
     #
+    #
+    # @example Example: DescribeEnvironmentMemberships1
+    #
+    #   # The following example gets information about all of the environment members for the specified AWS Cloud9 development
+    #   # environment.
+    #
+    #   resp = client.describe_environment_memberships({
+    #     environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     memberships: [
+    #       {
+    #         environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #         permissions: "read-write", 
+    #         user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
+    #         user_id: "AIDAJ3BA6O2FMJWCWXHEX", 
+    #       }, 
+    #       {
+    #         environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #         permissions: "owner", 
+    #         user_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
+    #         user_id: "AIDAJNUEDQAQWFELJDLEX", 
+    #       }, 
+    #     ], 
+    #   }
+    #
+    # @example Example: DescribeEnvironmentMemberships2
+    #
+    #   # The following example gets information about the owner of the specified AWS Cloud9 development environment.
+    #
+    #   resp = client.describe_environment_memberships({
+    #     environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #     permissions: [
+    #       "owner", 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     memberships: [
+    #       {
+    #         environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #         permissions: "owner", 
+    #         user_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
+    #         user_id: "AIDAJNUEDQAQWFELJDLEX", 
+    #       }, 
+    #     ], 
+    #   }
+    #
+    # @example Example: DescribeEnvironmentMemberships3
+    #
+    #   # The following example gets AWS Cloud9 development environment membership information for the specified user.
+    #
+    #   resp = client.describe_environment_memberships({
+    #     user_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     memberships: [
+    #       {
+    #         environment_id: "10a75714bd494714929e7f5ec4125aEX", 
+    #         last_access: Time.parse("2018-01-19T11:06:13Z"), 
+    #         permissions: "owner", 
+    #         user_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
+    #         user_id: "AIDAJNUEDQAQWFELJDLEX", 
+    #       }, 
+    #       {
+    #         environment_id: "12bfc3cd537f41cb9776f8af5525c9EX", 
+    #         last_access: Time.parse("2018-01-19T11:39:19Z"), 
+    #         permissions: "owner", 
+    #         user_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
+    #         user_id: "AIDAJNUEDQAQWFELJDLEX", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_environment_memberships({
@@ -403,6 +541,19 @@ module Aws::Cloud9
     #   * {Types::DescribeEnvironmentStatusResult#status #status} => String
     #   * {Types::DescribeEnvironmentStatusResult#message #message} => String
     #
+    #
+    # @example Example: DescribeEnvironmentStatus
+    #
+    #   resp = client.describe_environment_status({
+    #     environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     message: "Environment is ready to use", 
+    #     status: "ready", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_environment_status({
@@ -426,12 +577,43 @@ module Aws::Cloud9
     # Gets information about AWS Cloud9 development environments.
     #
     # @option params [required, Array<String>] :environment_ids
-    #   The IDs of invidividual environments to get information about.
+    #   The IDs of individual environments to get information about.
     #
     # @return [Types::DescribeEnvironmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::DescribeEnvironmentsResult#environments #environments} => Array&lt;Types::Environment&gt;
     #
+    #
+    # @example Example: DescribeEnvironments
+    #
+    #   resp = client.describe_environments({
+    #     environment_ids: [
+    #       "8d9967e2f0624182b74e7690ad69ebEX", 
+    #       "349c86d4579e4e7298d500ff57a6b2EX", 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     environments: [
+    #       {
+    #         name: "my-demo-environment", 
+    #         type: "ec2", 
+    #         arn: "arn:aws:cloud9:us-east-2:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX", 
+    #         description: "This is my demonstration environment.", 
+    #         id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #         owner_arn: "arn:aws:iam::123456789012:user/MyDemoUser", 
+    #       }, 
+    #       {
+    #         name: "another-demo-environment", 
+    #         type: "ssh", 
+    #         arn: "arn:aws:cloud9:us-east-2:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX", 
+    #         id: "349c86d4579e4e7298d500ff57a6b2EX", 
+    #         owner_arn: "arn:aws:sts::123456789012:assumed-role/AnotherDemoUser/AnotherDemoUser", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_environments({
@@ -476,6 +658,20 @@ module Aws::Cloud9
     #   * {Types::ListEnvironmentsResult#next_token #next_token} => String
     #   * {Types::ListEnvironmentsResult#environment_ids #environment_ids} => Array&lt;String&gt;
     #
+    #
+    # @example Example: ListEnvironments
+    #
+    #   resp = client.list_environments({
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     environment_ids: [
+    #       "349c86d4579e4e7298d500ff57a6b2EX", 
+    #       "45a3da47af0840f2b0c0824f5ee232EX", 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_environments({
@@ -505,13 +701,26 @@ module Aws::Cloud9
     #   The ID of the environment to change settings.
     #
     # @option params [String] :name
-    #   Any replacement name for the environment.
+    #   A replacement name for the environment.
     #
     # @option params [String] :description
     #   Any new or replacement description for the environment.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: UpdateEnvironment
+    #
+    #   resp = client.update_environment({
+    #     name: "my-changed-demo-environment", 
+    #     description: "This is my changed demonstration environment.", 
+    #     environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_environment({
@@ -552,6 +761,25 @@ module Aws::Cloud9
     #
     #   * {Types::UpdateEnvironmentMembershipResult#membership #membership} => Types::EnvironmentMember
     #
+    #
+    # @example Example: UpdateEnvironmentMembership
+    #
+    #   resp = client.update_environment_membership({
+    #     environment_id: "8d9967e2f0624182b74e7690ad69ebEX", 
+    #     permissions: "read-only", 
+    #     user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     membership: {
+    #       environment_id: "8d9967e2f0624182b74e7690ad69eb31", 
+    #       permissions: "read-only", 
+    #       user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser", 
+    #       user_id: "AIDAJ3BA6O2FMJWCWXHEX", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_environment_membership({
@@ -590,7 +818,7 @@ module Aws::Cloud9
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloud9'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.1.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cloud9/types.rb

@@ -44,7 +44,7 @@ module Aws::Cloud9
     #   @return [String]
     #
     # @!attribute [rw] instance_type
-    #   The type of instance to host the environment on (for example,
+    #   The type of instance to connect to the environment (for example,
     #   `t2.micro`).
     #   @return [String]
     #
@@ -323,7 +323,7 @@ module Aws::Cloud9
     #       }
     #
     # @!attribute [rw] environment_ids
-    #   The IDs of invidividual environments to get information about.
+    #   The IDs of individual environments to get information about.
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentsRequest AWS API Documentation
@@ -361,10 +361,10 @@ module Aws::Cloud9
     # @!attribute [rw] type
     #   The type of environment. Valid values include the following:
     #
-    #   * `ec2`\: An environment hosted on an Amazon Elastic Compute Cloud
-    #     (Amazon EC2) instance.
+    #   * `ec2`\: An Amazon Elastic Compute Cloud (Amazon EC2) instance
+    #     connects to the environment.
     #
-    #   * `ssh`\: An environment hosted on your own server.
+    #   * `ssh`\: Your own server connects to the environment.
     #   @return [String]
     #
     # @!attribute [rw] arn
@@ -542,7 +542,7 @@ module Aws::Cloud9
     #   @return [String]
     #
     # @!attribute [rw] name
-    #   Any replacement name for the environment.
+    #   A replacement name for the environment.
     #   @return [String]
     #
     # @!attribute [rw] description

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloud9
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core