aws-sdk-cloud9 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b81d38b88649b2e3b60cd47e5e37e9d3971d9e43
4
- data.tar.gz: 21c034fb576f07f367e790943f614efc8037c3b7
3
+ metadata.gz: 3d5c6374b4ac31fcd51f14c702de1e56314d33ad
4
+ data.tar.gz: 59a8200973c1c4a9d37d5f21fbe30d4e554a66dc
5
5
  SHA512:
6
- metadata.gz: ed405a4a3b35c407ed347da2a1fa20f14af921c40fccf65b576700445fac657d0b591956064855e7fb1473a7217d618e3726182ae803680f7d2f815d47634f25
7
- data.tar.gz: 9da8c0a0dd90ab7d00f660699856a5d85a5d8492cb915d099ef966ae876de394f4102edbdac020c81afbe6942fb8fbedb68839ad30a87beba8371a65a82a52da
6
+ metadata.gz: 791da0c905acbbdf48febfd3ac122d333a528a8aeed6afa1fc06dd215e8fa896ee882f261d707ce79260f226681e37258d5fb4808b9b9f424a67811e21eb3ef0
7
+ data.tar.gz: 73d08d852c1cdc3afbf50f412691bac9e6c2b8e773575b11885241178a50e5417dd4e7db1e7a1c7f85f714133ec67e7ee84cf3e95a3d6e7d9845574ad2d3113d
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-cloud9/customizations'
42
42
  # @service
43
43
  module Aws::Cloud9
44
44
 
45
- GEM_VERSION = '1.0.0'
45
+ GEM_VERSION = '1.1.0'
46
46
 
47
47
  end
@@ -156,8 +156,8 @@ module Aws::Cloud9
156
156
  # @!group API Operations
157
157
 
158
158
  # Creates an AWS Cloud9 development environment, launches an Amazon
159
- # Elastic Compute Cloud (Amazon EC2) instance, and then hosts the
160
- # environment on the instance.
159
+ # Elastic Compute Cloud (Amazon EC2) instance, and then connects from
160
+ # the instance to the environment.
161
161
  #
162
162
  # @option params [required, String] :name
163
163
  # The name of the environment to create.
@@ -179,7 +179,7 @@ module Aws::Cloud9
179
179
  # [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
180
180
  #
181
181
  # @option params [required, String] :instance_type
182
- # The type of instance to host the environment on (for example,
182
+ # The type of instance to connect to the environment (for example,
183
183
  # `t2.micro`).
184
184
  #
185
185
  # @option params [String] :subnet_id
@@ -199,6 +199,23 @@ module Aws::Cloud9
199
199
  #
200
200
  # * {Types::CreateEnvironmentEC2Result#environment_id #environment_id} => String
201
201
  #
202
+ #
203
+ # @example Example: CreateEnvironmentEC2
204
+ #
205
+ # resp = client.create_environment_ec2({
206
+ # name: "my-demo-environment",
207
+ # automatic_stop_time_minutes: 60,
208
+ # description: "This is my demonstration environment.",
209
+ # instance_type: "t2.micro",
210
+ # owner_arn: "arn:aws:iam::123456789012:user/MyDemoUser",
211
+ # subnet_id: "subnet-1fab8aEX",
212
+ # })
213
+ #
214
+ # resp.to_h outputs the following:
215
+ # {
216
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
217
+ # }
218
+ #
202
219
  # @example Request syntax with placeholder values
203
220
  #
204
221
  # resp = client.create_environment_ec2({
@@ -246,6 +263,25 @@ module Aws::Cloud9
246
263
  #
247
264
  # * {Types::CreateEnvironmentMembershipResult#membership #membership} => Types::EnvironmentMember
248
265
  #
266
+ #
267
+ # @example Example: CreateEnvironmentMembership
268
+ #
269
+ # resp = client.create_environment_membership({
270
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
271
+ # permissions: "read-write",
272
+ # user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser",
273
+ # })
274
+ #
275
+ # resp.to_h outputs the following:
276
+ # {
277
+ # membership: {
278
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
279
+ # permissions: "read-write",
280
+ # user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser",
281
+ # user_id: "AIDAJ3BA6O2FMJWCWXHEX",
282
+ # },
283
+ # }
284
+ #
249
285
  # @example Request syntax with placeholder values
250
286
  #
251
287
  # resp = client.create_environment_membership({
@@ -271,15 +307,26 @@ module Aws::Cloud9
271
307
  req.send_request(options)
272
308
  end
273
309
 
274
- # Deletes an AWS Cloud9 development environment. If the environment is
275
- # hosted on an Amazon Elastic Compute Cloud (Amazon EC2) instance, also
276
- # terminates the instance.
310
+ # Deletes an AWS Cloud9 development environment. If an Amazon EC2
311
+ # instance is connected to the environment, also terminates the
312
+ # instance.
277
313
  #
278
314
  # @option params [required, String] :environment_id
279
315
  # The ID of the environment to delete.
280
316
  #
281
317
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
282
318
  #
319
+ #
320
+ # @example Example: DeleteEnvironment
321
+ #
322
+ # resp = client.delete_environment({
323
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
324
+ # })
325
+ #
326
+ # resp.to_h outputs the following:
327
+ # {
328
+ # }
329
+ #
283
330
  # @example Request syntax with placeholder values
284
331
  #
285
332
  # resp = client.delete_environment({
@@ -307,6 +354,18 @@ module Aws::Cloud9
307
354
  #
308
355
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
309
356
  #
357
+ #
358
+ # @example Example: DeleteEnvironmentMembership
359
+ #
360
+ # resp = client.delete_environment_membership({
361
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
362
+ # user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser",
363
+ # })
364
+ #
365
+ # resp.to_h outputs the following:
366
+ # {
367
+ # }
368
+ #
310
369
  # @example Request syntax with placeholder values
311
370
  #
312
371
  # resp = client.delete_environment_membership({
@@ -364,6 +423,85 @@ module Aws::Cloud9
364
423
  # * {Types::DescribeEnvironmentMembershipsResult#memberships #memberships} => Array<Types::EnvironmentMember>
365
424
  # * {Types::DescribeEnvironmentMembershipsResult#next_token #next_token} => String
366
425
  #
426
+ #
427
+ # @example Example: DescribeEnvironmentMemberships1
428
+ #
429
+ # # The following example gets information about all of the environment members for the specified AWS Cloud9 development
430
+ # # environment.
431
+ #
432
+ # resp = client.describe_environment_memberships({
433
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
434
+ # })
435
+ #
436
+ # resp.to_h outputs the following:
437
+ # {
438
+ # memberships: [
439
+ # {
440
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
441
+ # permissions: "read-write",
442
+ # user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser",
443
+ # user_id: "AIDAJ3BA6O2FMJWCWXHEX",
444
+ # },
445
+ # {
446
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
447
+ # permissions: "owner",
448
+ # user_arn: "arn:aws:iam::123456789012:user/MyDemoUser",
449
+ # user_id: "AIDAJNUEDQAQWFELJDLEX",
450
+ # },
451
+ # ],
452
+ # }
453
+ #
454
+ # @example Example: DescribeEnvironmentMemberships2
455
+ #
456
+ # # The following example gets information about the owner of the specified AWS Cloud9 development environment.
457
+ #
458
+ # resp = client.describe_environment_memberships({
459
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
460
+ # permissions: [
461
+ # "owner",
462
+ # ],
463
+ # })
464
+ #
465
+ # resp.to_h outputs the following:
466
+ # {
467
+ # memberships: [
468
+ # {
469
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
470
+ # permissions: "owner",
471
+ # user_arn: "arn:aws:iam::123456789012:user/MyDemoUser",
472
+ # user_id: "AIDAJNUEDQAQWFELJDLEX",
473
+ # },
474
+ # ],
475
+ # }
476
+ #
477
+ # @example Example: DescribeEnvironmentMemberships3
478
+ #
479
+ # # The following example gets AWS Cloud9 development environment membership information for the specified user.
480
+ #
481
+ # resp = client.describe_environment_memberships({
482
+ # user_arn: "arn:aws:iam::123456789012:user/MyDemoUser",
483
+ # })
484
+ #
485
+ # resp.to_h outputs the following:
486
+ # {
487
+ # memberships: [
488
+ # {
489
+ # environment_id: "10a75714bd494714929e7f5ec4125aEX",
490
+ # last_access: Time.parse("2018-01-19T11:06:13Z"),
491
+ # permissions: "owner",
492
+ # user_arn: "arn:aws:iam::123456789012:user/MyDemoUser",
493
+ # user_id: "AIDAJNUEDQAQWFELJDLEX",
494
+ # },
495
+ # {
496
+ # environment_id: "12bfc3cd537f41cb9776f8af5525c9EX",
497
+ # last_access: Time.parse("2018-01-19T11:39:19Z"),
498
+ # permissions: "owner",
499
+ # user_arn: "arn:aws:iam::123456789012:user/MyDemoUser",
500
+ # user_id: "AIDAJNUEDQAQWFELJDLEX",
501
+ # },
502
+ # ],
503
+ # }
504
+ #
367
505
  # @example Request syntax with placeholder values
368
506
  #
369
507
  # resp = client.describe_environment_memberships({
@@ -403,6 +541,19 @@ module Aws::Cloud9
403
541
  # * {Types::DescribeEnvironmentStatusResult#status #status} => String
404
542
  # * {Types::DescribeEnvironmentStatusResult#message #message} => String
405
543
  #
544
+ #
545
+ # @example Example: DescribeEnvironmentStatus
546
+ #
547
+ # resp = client.describe_environment_status({
548
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
549
+ # })
550
+ #
551
+ # resp.to_h outputs the following:
552
+ # {
553
+ # message: "Environment is ready to use",
554
+ # status: "ready",
555
+ # }
556
+ #
406
557
  # @example Request syntax with placeholder values
407
558
  #
408
559
  # resp = client.describe_environment_status({
@@ -426,12 +577,43 @@ module Aws::Cloud9
426
577
  # Gets information about AWS Cloud9 development environments.
427
578
  #
428
579
  # @option params [required, Array<String>] :environment_ids
429
- # The IDs of invidividual environments to get information about.
580
+ # The IDs of individual environments to get information about.
430
581
  #
431
582
  # @return [Types::DescribeEnvironmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
432
583
  #
433
584
  # * {Types::DescribeEnvironmentsResult#environments #environments} => Array&lt;Types::Environment&gt;
434
585
  #
586
+ #
587
+ # @example Example: DescribeEnvironments
588
+ #
589
+ # resp = client.describe_environments({
590
+ # environment_ids: [
591
+ # "8d9967e2f0624182b74e7690ad69ebEX",
592
+ # "349c86d4579e4e7298d500ff57a6b2EX",
593
+ # ],
594
+ # })
595
+ #
596
+ # resp.to_h outputs the following:
597
+ # {
598
+ # environments: [
599
+ # {
600
+ # name: "my-demo-environment",
601
+ # type: "ec2",
602
+ # arn: "arn:aws:cloud9:us-east-2:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX",
603
+ # description: "This is my demonstration environment.",
604
+ # id: "8d9967e2f0624182b74e7690ad69ebEX",
605
+ # owner_arn: "arn:aws:iam::123456789012:user/MyDemoUser",
606
+ # },
607
+ # {
608
+ # name: "another-demo-environment",
609
+ # type: "ssh",
610
+ # arn: "arn:aws:cloud9:us-east-2:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX",
611
+ # id: "349c86d4579e4e7298d500ff57a6b2EX",
612
+ # owner_arn: "arn:aws:sts::123456789012:assumed-role/AnotherDemoUser/AnotherDemoUser",
613
+ # },
614
+ # ],
615
+ # }
616
+ #
435
617
  # @example Request syntax with placeholder values
436
618
  #
437
619
  # resp = client.describe_environments({
@@ -476,6 +658,20 @@ module Aws::Cloud9
476
658
  # * {Types::ListEnvironmentsResult#next_token #next_token} => String
477
659
  # * {Types::ListEnvironmentsResult#environment_ids #environment_ids} => Array&lt;String&gt;
478
660
  #
661
+ #
662
+ # @example Example: ListEnvironments
663
+ #
664
+ # resp = client.list_environments({
665
+ # })
666
+ #
667
+ # resp.to_h outputs the following:
668
+ # {
669
+ # environment_ids: [
670
+ # "349c86d4579e4e7298d500ff57a6b2EX",
671
+ # "45a3da47af0840f2b0c0824f5ee232EX",
672
+ # ],
673
+ # }
674
+ #
479
675
  # @example Request syntax with placeholder values
480
676
  #
481
677
  # resp = client.list_environments({
@@ -505,13 +701,26 @@ module Aws::Cloud9
505
701
  # The ID of the environment to change settings.
506
702
  #
507
703
  # @option params [String] :name
508
- # Any replacement name for the environment.
704
+ # A replacement name for the environment.
509
705
  #
510
706
  # @option params [String] :description
511
707
  # Any new or replacement description for the environment.
512
708
  #
513
709
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
514
710
  #
711
+ #
712
+ # @example Example: UpdateEnvironment
713
+ #
714
+ # resp = client.update_environment({
715
+ # name: "my-changed-demo-environment",
716
+ # description: "This is my changed demonstration environment.",
717
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
718
+ # })
719
+ #
720
+ # resp.to_h outputs the following:
721
+ # {
722
+ # }
723
+ #
515
724
  # @example Request syntax with placeholder values
516
725
  #
517
726
  # resp = client.update_environment({
@@ -552,6 +761,25 @@ module Aws::Cloud9
552
761
  #
553
762
  # * {Types::UpdateEnvironmentMembershipResult#membership #membership} => Types::EnvironmentMember
554
763
  #
764
+ #
765
+ # @example Example: UpdateEnvironmentMembership
766
+ #
767
+ # resp = client.update_environment_membership({
768
+ # environment_id: "8d9967e2f0624182b74e7690ad69ebEX",
769
+ # permissions: "read-only",
770
+ # user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser",
771
+ # })
772
+ #
773
+ # resp.to_h outputs the following:
774
+ # {
775
+ # membership: {
776
+ # environment_id: "8d9967e2f0624182b74e7690ad69eb31",
777
+ # permissions: "read-only",
778
+ # user_arn: "arn:aws:iam::123456789012:user/AnotherDemoUser",
779
+ # user_id: "AIDAJ3BA6O2FMJWCWXHEX",
780
+ # },
781
+ # }
782
+ #
555
783
  # @example Request syntax with placeholder values
556
784
  #
557
785
  # resp = client.update_environment_membership({
@@ -590,7 +818,7 @@ module Aws::Cloud9
590
818
  params: params,
591
819
  config: config)
592
820
  context[:gem_name] = 'aws-sdk-cloud9'
593
- context[:gem_version] = '1.0.0'
821
+ context[:gem_version] = '1.1.0'
594
822
  Seahorse::Client::Request.new(handlers, context)
595
823
  end
596
824
 
@@ -44,7 +44,7 @@ module Aws::Cloud9
44
44
  # @return [String]
45
45
  #
46
46
  # @!attribute [rw] instance_type
47
- # The type of instance to host the environment on (for example,
47
+ # The type of instance to connect to the environment (for example,
48
48
  # `t2.micro`).
49
49
  # @return [String]
50
50
  #
@@ -323,7 +323,7 @@ module Aws::Cloud9
323
323
  # }
324
324
  #
325
325
  # @!attribute [rw] environment_ids
326
- # The IDs of invidividual environments to get information about.
326
+ # The IDs of individual environments to get information about.
327
327
  # @return [Array<String>]
328
328
  #
329
329
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentsRequest AWS API Documentation
@@ -361,10 +361,10 @@ module Aws::Cloud9
361
361
  # @!attribute [rw] type
362
362
  # The type of environment. Valid values include the following:
363
363
  #
364
- # * `ec2`\: An environment hosted on an Amazon Elastic Compute Cloud
365
- # (Amazon EC2) instance.
364
+ # * `ec2`\: An Amazon Elastic Compute Cloud (Amazon EC2) instance
365
+ # connects to the environment.
366
366
  #
367
- # * `ssh`\: An environment hosted on your own server.
367
+ # * `ssh`\: Your own server connects to the environment.
368
368
  # @return [String]
369
369
  #
370
370
  # @!attribute [rw] arn
@@ -542,7 +542,7 @@ module Aws::Cloud9
542
542
  # @return [String]
543
543
  #
544
544
  # @!attribute [rw] name
545
- # Any replacement name for the environment.
545
+ # A replacement name for the environment.
546
546
  # @return [String]
547
547
  #
548
548
  # @!attribute [rw] description
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-cloud9
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-11-30 00:00:00.000000000 Z
11
+ date: 2018-02-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core