@aws-sdk/client-cloud9 3.379.1 → 3.382.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.
@@ -50,10 +50,12 @@ export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType
50
50
  */
51
51
  export interface Tag {
52
52
  /**
53
+ * @public
53
54
  * <p>The <b>name</b> part of a tag.</p>
54
55
  */
55
56
  Key: string | undefined;
56
57
  /**
58
+ * @public
57
59
  * <p>The <b>value</b> part of a tag.</p>
58
60
  */
59
61
  Value: string | undefined;
@@ -63,15 +65,18 @@ export interface Tag {
63
65
  */
64
66
  export interface CreateEnvironmentEC2Request {
65
67
  /**
68
+ * @public
66
69
  * <p>The name of the environment to create.</p>
67
70
  * <p>This name is visible to other IAM users in the same Amazon Web Services account.</p>
68
71
  */
69
72
  name: string | undefined;
70
73
  /**
74
+ * @public
71
75
  * <p>The description of the environment to create.</p>
72
76
  */
73
77
  description?: string;
74
78
  /**
79
+ * @public
75
80
  * <p>A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no
76
81
  * more than one time.</p>
77
82
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Client Tokens</a> in the
@@ -79,16 +84,19 @@ export interface CreateEnvironmentEC2Request {
79
84
  */
80
85
  clientRequestToken?: string;
81
86
  /**
87
+ * @public
82
88
  * <p>The type of instance to connect to the environment (for example,
83
89
  * <code>t2.micro</code>).</p>
84
90
  */
85
91
  instanceType: string | undefined;
86
92
  /**
93
+ * @public
87
94
  * <p>The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2
88
95
  * instance.</p>
89
96
  */
90
97
  subnetId?: string;
91
98
  /**
99
+ * @public
92
100
  * <p>The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
93
101
  * To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM)
94
102
  * path.</p>
@@ -142,22 +150,26 @@ export interface CreateEnvironmentEC2Request {
142
150
  */
143
151
  imageId?: string;
144
152
  /**
153
+ * @public
145
154
  * <p>The number of minutes until the running instance is shut down after the environment has
146
155
  * last been used.</p>
147
156
  */
148
157
  automaticStopTimeMinutes?: number;
149
158
  /**
159
+ * @public
150
160
  * <p>The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any
151
161
  * IAM principal. If this value is not specified, the ARN defaults to this environment's
152
162
  * creator.</p>
153
163
  */
154
164
  ownerArn?: string;
155
165
  /**
166
+ * @public
156
167
  * <p>An array of key-value pairs that will be associated with the new Cloud9 development
157
168
  * environment.</p>
158
169
  */
159
170
  tags?: Tag[];
160
171
  /**
172
+ * @public
161
173
  * <p>The connection type used for connecting to an Amazon EC2 environment. Valid values are
162
174
  * <code>CONNECT_SSH</code> (default) and <code>CONNECT_SSM</code> (connected through
163
175
  * Amazon EC2 Systems Manager).</p>
@@ -166,6 +178,7 @@ export interface CreateEnvironmentEC2Request {
166
178
  */
167
179
  connectionType?: ConnectionType | string;
168
180
  /**
181
+ * @public
169
182
  * <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
170
183
  */
171
184
  dryRun?: boolean;
@@ -175,6 +188,7 @@ export interface CreateEnvironmentEC2Request {
175
188
  */
176
189
  export interface CreateEnvironmentEC2Result {
177
190
  /**
191
+ * @public
178
192
  * <p>The ID of the environment that was created.</p>
179
193
  */
180
194
  environmentId?: string;
@@ -266,14 +280,17 @@ export type MemberPermissions = (typeof MemberPermissions)[keyof typeof MemberPe
266
280
  */
267
281
  export interface CreateEnvironmentMembershipRequest {
268
282
  /**
283
+ * @public
269
284
  * <p>The ID of the environment that contains the environment member you want to add.</p>
270
285
  */
271
286
  environmentId: string | undefined;
272
287
  /**
288
+ * @public
273
289
  * <p>The Amazon Resource Name (ARN) of the environment member you want to add.</p>
274
290
  */
275
291
  userArn: string | undefined;
276
292
  /**
293
+ * @public
277
294
  * <p>The type of environment member permissions you want to associate with this environment
278
295
  * member. Available values include:</p>
279
296
  * <ul>
@@ -308,6 +325,7 @@ export type Permissions = (typeof Permissions)[keyof typeof Permissions];
308
325
  */
309
326
  export interface EnvironmentMember {
310
327
  /**
328
+ * @public
311
329
  * <p>The type of environment member permissions associated with this environment member.
312
330
  * Available values include:</p>
313
331
  * <ul>
@@ -327,18 +345,22 @@ export interface EnvironmentMember {
327
345
  */
328
346
  permissions: Permissions | string | undefined;
329
347
  /**
348
+ * @public
330
349
  * <p>The user ID in Identity and Access Management (IAM) of the environment member.</p>
331
350
  */
332
351
  userId: string | undefined;
333
352
  /**
353
+ * @public
334
354
  * <p>The Amazon Resource Name (ARN) of the environment member.</p>
335
355
  */
336
356
  userArn: string | undefined;
337
357
  /**
358
+ * @public
338
359
  * <p>The ID of the environment for the environment member.</p>
339
360
  */
340
361
  environmentId: string | undefined;
341
362
  /**
363
+ * @public
342
364
  * <p>The time, expressed in epoch time format, when the environment member last opened the
343
365
  * environment.</p>
344
366
  */
@@ -349,6 +371,7 @@ export interface EnvironmentMember {
349
371
  */
350
372
  export interface CreateEnvironmentMembershipResult {
351
373
  /**
374
+ * @public
352
375
  * <p>Information about the environment member that was added.</p>
353
376
  */
354
377
  membership: EnvironmentMember | undefined;
@@ -358,6 +381,7 @@ export interface CreateEnvironmentMembershipResult {
358
381
  */
359
382
  export interface DeleteEnvironmentRequest {
360
383
  /**
384
+ * @public
361
385
  * <p>The ID of the environment to delete.</p>
362
386
  */
363
387
  environmentId: string | undefined;
@@ -372,10 +396,12 @@ export interface DeleteEnvironmentResult {
372
396
  */
373
397
  export interface DeleteEnvironmentMembershipRequest {
374
398
  /**
399
+ * @public
375
400
  * <p>The ID of the environment to delete the environment member from.</p>
376
401
  */
377
402
  environmentId: string | undefined;
378
403
  /**
404
+ * @public
379
405
  * <p>The Amazon Resource Name (ARN) of the environment member to delete from the
380
406
  * environment.</p>
381
407
  */
@@ -391,16 +417,19 @@ export interface DeleteEnvironmentMembershipResult {
391
417
  */
392
418
  export interface DescribeEnvironmentMembershipsRequest {
393
419
  /**
420
+ * @public
394
421
  * <p>The Amazon Resource Name (ARN) of an individual environment member to get information
395
422
  * about. If no value is specified, information about all environment members are
396
423
  * returned.</p>
397
424
  */
398
425
  userArn?: string;
399
426
  /**
427
+ * @public
400
428
  * <p>The ID of the environment to get environment member information about.</p>
401
429
  */
402
430
  environmentId?: string;
403
431
  /**
432
+ * @public
404
433
  * <p>The type of environment member permissions to get information about. Available values
405
434
  * include:</p>
406
435
  * <ul>
@@ -421,6 +450,7 @@ export interface DescribeEnvironmentMembershipsRequest {
421
450
  */
422
451
  permissions?: (Permissions | string)[];
423
452
  /**
453
+ * @public
424
454
  * <p>During a previous call, if there are more than 25 items in the list, only the first 25
425
455
  * items are returned, along with a unique string called a <i>next token</i>. To
426
456
  * get the next batch of items in the list, call this operation again, adding the next token to
@@ -429,6 +459,7 @@ export interface DescribeEnvironmentMembershipsRequest {
429
459
  */
430
460
  nextToken?: string;
431
461
  /**
462
+ * @public
432
463
  * <p>The maximum number of environment members to get information about.</p>
433
464
  */
434
465
  maxResults?: number;
@@ -438,10 +469,12 @@ export interface DescribeEnvironmentMembershipsRequest {
438
469
  */
439
470
  export interface DescribeEnvironmentMembershipsResult {
440
471
  /**
472
+ * @public
441
473
  * <p>Information about the environment members for the environment.</p>
442
474
  */
443
475
  memberships?: EnvironmentMember[];
444
476
  /**
477
+ * @public
445
478
  * <p>If there are more than 25 items in the list, only the first 25 items are returned, along
446
479
  * with a unique string called a <i>next token</i>. To get the next batch of items
447
480
  * in the list, call this operation again, adding the next token to the call.</p>
@@ -453,6 +486,7 @@ export interface DescribeEnvironmentMembershipsResult {
453
486
  */
454
487
  export interface DescribeEnvironmentsRequest {
455
488
  /**
489
+ * @public
456
490
  * <p>The IDs of individual environments to get information about.</p>
457
491
  */
458
492
  environmentIds: string[] | undefined;
@@ -479,6 +513,7 @@ export type EnvironmentLifecycleStatus = (typeof EnvironmentLifecycleStatus)[key
479
513
  */
480
514
  export interface EnvironmentLifecycle {
481
515
  /**
516
+ * @public
482
517
  * <p>The current creation or deletion lifecycle state of the environment.</p>
483
518
  * <ul>
484
519
  * <li>
@@ -505,10 +540,12 @@ export interface EnvironmentLifecycle {
505
540
  */
506
541
  status?: EnvironmentLifecycleStatus | string;
507
542
  /**
543
+ * @public
508
544
  * <p>Any informational message about the lifecycle state of the environment.</p>
509
545
  */
510
546
  reason?: string;
511
547
  /**
548
+ * @public
512
549
  * <p>If the environment failed to delete, the Amazon Resource Name (ARN) of the related Amazon Web Services
513
550
  * resource.</p>
514
551
  */
@@ -553,18 +590,22 @@ export type EnvironmentType = (typeof EnvironmentType)[keyof typeof EnvironmentT
553
590
  */
554
591
  export interface Environment {
555
592
  /**
593
+ * @public
556
594
  * <p>The ID of the environment.</p>
557
595
  */
558
596
  id?: string;
559
597
  /**
598
+ * @public
560
599
  * <p>The name of the environment.</p>
561
600
  */
562
601
  name?: string;
563
602
  /**
603
+ * @public
564
604
  * <p>The description for the environment.</p>
565
605
  */
566
606
  description?: string;
567
607
  /**
608
+ * @public
568
609
  * <p>The type of environment. Valid values include the following:</p>
569
610
  * <ul>
570
611
  * <li>
@@ -579,23 +620,28 @@ export interface Environment {
579
620
  */
580
621
  type: EnvironmentType | string | undefined;
581
622
  /**
623
+ * @public
582
624
  * <p>The connection type used for connecting to an Amazon EC2 environment. <code>CONNECT_SSH</code>
583
625
  * is selected by default.</p>
584
626
  */
585
627
  connectionType?: ConnectionType | string;
586
628
  /**
629
+ * @public
587
630
  * <p>The Amazon Resource Name (ARN) of the environment.</p>
588
631
  */
589
632
  arn: string | undefined;
590
633
  /**
634
+ * @public
591
635
  * <p>The Amazon Resource Name (ARN) of the environment owner.</p>
592
636
  */
593
637
  ownerArn: string | undefined;
594
638
  /**
639
+ * @public
595
640
  * <p>The state of the environment in its creation or deletion lifecycle.</p>
596
641
  */
597
642
  lifecycle?: EnvironmentLifecycle;
598
643
  /**
644
+ * @public
599
645
  * <p>Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.
600
646
  * Available values are:</p>
601
647
  * <ul>
@@ -658,6 +704,7 @@ export interface Environment {
658
704
  */
659
705
  export interface DescribeEnvironmentsResult {
660
706
  /**
707
+ * @public
661
708
  * <p>Information about the environments that are returned.</p>
662
709
  */
663
710
  environments?: Environment[];
@@ -667,6 +714,7 @@ export interface DescribeEnvironmentsResult {
667
714
  */
668
715
  export interface DescribeEnvironmentStatusRequest {
669
716
  /**
717
+ * @public
670
718
  * <p>The ID of the environment to get status information about.</p>
671
719
  */
672
720
  environmentId: string | undefined;
@@ -693,6 +741,7 @@ export type EnvironmentStatus = (typeof EnvironmentStatus)[keyof typeof Environm
693
741
  */
694
742
  export interface DescribeEnvironmentStatusResult {
695
743
  /**
744
+ * @public
696
745
  * <p>The status of the environment. Available values include:</p>
697
746
  * <ul>
698
747
  * <li>
@@ -727,6 +776,7 @@ export interface DescribeEnvironmentStatusResult {
727
776
  */
728
777
  status: EnvironmentStatus | string | undefined;
729
778
  /**
779
+ * @public
730
780
  * <p>Any informational message about the status of the environment.</p>
731
781
  */
732
782
  message: string | undefined;
@@ -736,6 +786,7 @@ export interface DescribeEnvironmentStatusResult {
736
786
  */
737
787
  export interface ListEnvironmentsRequest {
738
788
  /**
789
+ * @public
739
790
  * <p>During a previous call, if there are more than 25 items in the list, only the first 25
740
791
  * items are returned, along with a unique string called a <i>next token</i>. To
741
792
  * get the next batch of items in the list, call this operation again, adding the next token to
@@ -744,6 +795,7 @@ export interface ListEnvironmentsRequest {
744
795
  */
745
796
  nextToken?: string;
746
797
  /**
798
+ * @public
747
799
  * <p>The maximum number of environments to get identifiers for.</p>
748
800
  */
749
801
  maxResults?: number;
@@ -753,12 +805,14 @@ export interface ListEnvironmentsRequest {
753
805
  */
754
806
  export interface ListEnvironmentsResult {
755
807
  /**
808
+ * @public
756
809
  * <p>If there are more than 25 items in the list, only the first 25 items are returned, along
757
810
  * with a unique string called a <i>next token</i>. To get the next batch of items
758
811
  * in the list, call this operation again, adding the next token to the call.</p>
759
812
  */
760
813
  nextToken?: string;
761
814
  /**
815
+ * @public
762
816
  * <p>The list of environment identifiers.</p>
763
817
  */
764
818
  environmentIds?: string[];
@@ -768,6 +822,7 @@ export interface ListEnvironmentsResult {
768
822
  */
769
823
  export interface ListTagsForResourceRequest {
770
824
  /**
825
+ * @public
771
826
  * <p>The Amazon Resource Name (ARN) of the Cloud9 development environment to get the tags
772
827
  * for.</p>
773
828
  */
@@ -778,6 +833,7 @@ export interface ListTagsForResourceRequest {
778
833
  */
779
834
  export interface ListTagsForResourceResponse {
780
835
  /**
836
+ * @public
781
837
  * <p>The list of tags associated with the Cloud9 development environment.</p>
782
838
  */
783
839
  Tags?: Tag[];
@@ -801,11 +857,13 @@ export declare class ConcurrentAccessException extends __BaseException {
801
857
  */
802
858
  export interface TagResourceRequest {
803
859
  /**
860
+ * @public
804
861
  * <p>The Amazon Resource Name (ARN) of the Cloud9 development environment to add tags
805
862
  * to.</p>
806
863
  */
807
864
  ResourceARN: string | undefined;
808
865
  /**
866
+ * @public
809
867
  * <p>The list of tags to add to the given Cloud9 development environment.</p>
810
868
  */
811
869
  Tags: Tag[] | undefined;
@@ -820,11 +878,13 @@ export interface TagResourceResponse {
820
878
  */
821
879
  export interface UntagResourceRequest {
822
880
  /**
881
+ * @public
823
882
  * <p>The Amazon Resource Name (ARN) of the Cloud9 development environment to remove tags
824
883
  * from.</p>
825
884
  */
826
885
  ResourceARN: string | undefined;
827
886
  /**
887
+ * @public
828
888
  * <p>The tag names of the tags to remove from the given Cloud9 development
829
889
  * environment.</p>
830
890
  */
@@ -852,18 +912,22 @@ export type ManagedCredentialsAction = (typeof ManagedCredentialsAction)[keyof t
852
912
  */
853
913
  export interface UpdateEnvironmentRequest {
854
914
  /**
915
+ * @public
855
916
  * <p>The ID of the environment to change settings.</p>
856
917
  */
857
918
  environmentId: string | undefined;
858
919
  /**
920
+ * @public
859
921
  * <p>A replacement name for the environment.</p>
860
922
  */
861
923
  name?: string;
862
924
  /**
925
+ * @public
863
926
  * <p>Any new or replacement description for the environment.</p>
864
927
  */
865
928
  description?: string;
866
929
  /**
930
+ * @public
867
931
  * <p>Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary
868
932
  * credentials for an Cloud9 environment by using one of the following values:</p>
869
933
  * <ul>
@@ -895,16 +959,19 @@ export interface UpdateEnvironmentResult {
895
959
  */
896
960
  export interface UpdateEnvironmentMembershipRequest {
897
961
  /**
962
+ * @public
898
963
  * <p>The ID of the environment for the environment member whose settings you want to
899
964
  * change.</p>
900
965
  */
901
966
  environmentId: string | undefined;
902
967
  /**
968
+ * @public
903
969
  * <p>The Amazon Resource Name (ARN) of the environment member whose settings you want to
904
970
  * change.</p>
905
971
  */
906
972
  userArn: string | undefined;
907
973
  /**
974
+ * @public
908
975
  * <p>The replacement type of environment member permissions you want to associate with this
909
976
  * environment member. Available values include:</p>
910
977
  * <ul>
@@ -925,6 +992,7 @@ export interface UpdateEnvironmentMembershipRequest {
925
992
  */
926
993
  export interface UpdateEnvironmentMembershipResult {
927
994
  /**
995
+ * @public
928
996
  * <p>Information about the environment member whose settings were changed.</p>
929
997
  */
930
998
  membership?: EnvironmentMember;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloud9",
3
3
  "description": "AWS SDK for JavaScript Cloud9 Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",