@aws-sdk/client-codestar-connections 3.381.0 → 3.385.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.
@@ -21,10 +21,12 @@ export type ProviderType = (typeof ProviderType)[keyof typeof ProviderType];
21
21
  */
22
22
  export interface Tag {
23
23
  /**
24
+ * @public
24
25
  * <p>The tag's key.</p>
25
26
  */
26
27
  Key: string | undefined;
27
28
  /**
29
+ * @public
28
30
  * <p>The tag's value.</p>
29
31
  */
30
32
  Value: string | undefined;
@@ -34,19 +36,23 @@ export interface Tag {
34
36
  */
35
37
  export interface CreateConnectionInput {
36
38
  /**
39
+ * @public
37
40
  * <p>The name of the external provider where your third-party code repository is
38
41
  * configured.</p>
39
42
  */
40
43
  ProviderType?: ProviderType | string;
41
44
  /**
45
+ * @public
42
46
  * <p>The name of the connection to be created.</p>
43
47
  */
44
48
  ConnectionName: string | undefined;
45
49
  /**
50
+ * @public
46
51
  * <p>The key-value pair to use when tagging the resource.</p>
47
52
  */
48
53
  Tags?: Tag[];
49
54
  /**
55
+ * @public
50
56
  * <p>The Amazon Resource Name (ARN) of the host associated with the connection to be created.</p>
51
57
  */
52
58
  HostArn?: string;
@@ -56,6 +62,7 @@ export interface CreateConnectionInput {
56
62
  */
57
63
  export interface CreateConnectionOutput {
58
64
  /**
65
+ * @public
59
66
  * <p>The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the
60
67
  * connection reference when the connection is shared between Amazon Web Services services.</p>
61
68
  * <note>
@@ -64,6 +71,7 @@ export interface CreateConnectionOutput {
64
71
  */
65
72
  ConnectionArn: string | undefined;
66
73
  /**
74
+ * @public
67
75
  * <p>Specifies the tags applied to the resource.</p>
68
76
  */
69
77
  Tags?: Tag[];
@@ -113,21 +121,25 @@ export declare class ResourceUnavailableException extends __BaseException {
113
121
  */
114
122
  export interface VpcConfiguration {
115
123
  /**
124
+ * @public
116
125
  * <p>The ID of the Amazon VPC connected to the infrastructure where your provider type is
117
126
  * installed.</p>
118
127
  */
119
128
  VpcId: string | undefined;
120
129
  /**
130
+ * @public
121
131
  * <p>The ID of the subnet or subnets associated with the Amazon VPC connected to the
122
132
  * infrastructure where your provider type is installed.</p>
123
133
  */
124
134
  SubnetIds: string[] | undefined;
125
135
  /**
136
+ * @public
126
137
  * <p>The ID of the security group or security groups associated with the Amazon VPC connected
127
138
  * to the infrastructure where your provider type is installed.</p>
128
139
  */
129
140
  SecurityGroupIds: string[] | undefined;
130
141
  /**
142
+ * @public
131
143
  * <p>The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.</p>
132
144
  */
133
145
  TlsCertificate?: string;
@@ -137,21 +149,25 @@ export interface VpcConfiguration {
137
149
  */
138
150
  export interface CreateHostInput {
139
151
  /**
152
+ * @public
140
153
  * <p>The name of the host to be created.</p>
141
154
  */
142
155
  Name: string | undefined;
143
156
  /**
157
+ * @public
144
158
  * <p>The name of the installed provider to be associated with your connection. The host
145
159
  * resource represents the infrastructure where your provider type is installed. The valid
146
160
  * provider type is GitHub Enterprise Server.</p>
147
161
  */
148
162
  ProviderType: ProviderType | string | undefined;
149
163
  /**
164
+ * @public
150
165
  * <p>The endpoint of the infrastructure to be represented by the host after it is
151
166
  * created.</p>
152
167
  */
153
168
  ProviderEndpoint: string | undefined;
154
169
  /**
170
+ * @public
155
171
  * <p>The VPC configuration to be provisioned for the host. A VPC must be configured and the
156
172
  * infrastructure to be represented by the host must already be connected to the VPC.</p>
157
173
  */
@@ -163,6 +179,7 @@ export interface CreateHostInput {
163
179
  */
164
180
  export interface CreateHostOutput {
165
181
  /**
182
+ * @public
166
183
  * <p>The Amazon Resource Name (ARN) of the host to be created.</p>
167
184
  */
168
185
  HostArn?: string;
@@ -173,6 +190,7 @@ export interface CreateHostOutput {
173
190
  */
174
191
  export interface DeleteConnectionInput {
175
192
  /**
193
+ * @public
176
194
  * <p>The Amazon Resource Name (ARN) of the connection to be deleted.</p>
177
195
  * <note>
178
196
  * <p>The ARN is never reused if the connection is deleted.</p>
@@ -190,6 +208,7 @@ export interface DeleteConnectionOutput {
190
208
  */
191
209
  export interface DeleteHostInput {
192
210
  /**
211
+ * @public
193
212
  * <p>The Amazon Resource Name (ARN) of the host to be deleted.</p>
194
213
  */
195
214
  HostArn: string | undefined;
@@ -204,6 +223,7 @@ export interface DeleteHostOutput {
204
223
  */
205
224
  export interface GetConnectionInput {
206
225
  /**
226
+ * @public
207
227
  * <p>The Amazon Resource Name (ARN) of a connection.</p>
208
228
  */
209
229
  ConnectionArn: string | undefined;
@@ -229,10 +249,12 @@ export type ConnectionStatus = (typeof ConnectionStatus)[keyof typeof Connection
229
249
  */
230
250
  export interface Connection {
231
251
  /**
252
+ * @public
232
253
  * <p>The name of the connection. Connection names must be unique in an Amazon Web Services account.</p>
233
254
  */
234
255
  ConnectionName?: string;
235
256
  /**
257
+ * @public
236
258
  * <p>The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection
237
259
  * reference when the connection is shared between Amazon Web Services.</p>
238
260
  * <note>
@@ -241,20 +263,24 @@ export interface Connection {
241
263
  */
242
264
  ConnectionArn?: string;
243
265
  /**
266
+ * @public
244
267
  * <p>The name of the external provider where your third-party code repository is
245
268
  * configured.</p>
246
269
  */
247
270
  ProviderType?: ProviderType | string;
248
271
  /**
272
+ * @public
249
273
  * <p>The identifier of the external provider where your third-party code repository is configured.
250
274
  * For Bitbucket, this is the account ID of the owner of the Bitbucket repository.</p>
251
275
  */
252
276
  OwnerAccountId?: string;
253
277
  /**
278
+ * @public
254
279
  * <p>The current status of the connection. </p>
255
280
  */
256
281
  ConnectionStatus?: ConnectionStatus | string;
257
282
  /**
283
+ * @public
258
284
  * <p>The Amazon Resource Name (ARN) of the host associated with the connection.</p>
259
285
  */
260
286
  HostArn?: string;
@@ -264,6 +290,7 @@ export interface Connection {
264
290
  */
265
291
  export interface GetConnectionOutput {
266
292
  /**
293
+ * @public
267
294
  * <p>The connection details, such as status, owner, and provider type.</p>
268
295
  */
269
296
  Connection?: Connection;
@@ -273,6 +300,7 @@ export interface GetConnectionOutput {
273
300
  */
274
301
  export interface GetHostInput {
275
302
  /**
303
+ * @public
276
304
  * <p>The Amazon Resource Name (ARN) of the requested host.</p>
277
305
  */
278
306
  HostArn: string | undefined;
@@ -282,22 +310,27 @@ export interface GetHostInput {
282
310
  */
283
311
  export interface GetHostOutput {
284
312
  /**
313
+ * @public
285
314
  * <p>The name of the requested host.</p>
286
315
  */
287
316
  Name?: string;
288
317
  /**
318
+ * @public
289
319
  * <p>The status of the requested host.</p>
290
320
  */
291
321
  Status?: string;
292
322
  /**
323
+ * @public
293
324
  * <p>The provider type of the requested host, such as GitHub Enterprise Server.</p>
294
325
  */
295
326
  ProviderType?: ProviderType | string;
296
327
  /**
328
+ * @public
297
329
  * <p>The endpoint of the infrastructure represented by the requested host.</p>
298
330
  */
299
331
  ProviderEndpoint?: string;
300
332
  /**
333
+ * @public
301
334
  * <p>The VPC configuration of the requested host.</p>
302
335
  */
303
336
  VpcConfiguration?: VpcConfiguration;
@@ -307,20 +340,24 @@ export interface GetHostOutput {
307
340
  */
308
341
  export interface ListConnectionsInput {
309
342
  /**
343
+ * @public
310
344
  * <p>Filters the list of connections to those associated with a specified provider, such as
311
345
  * Bitbucket.</p>
312
346
  */
313
347
  ProviderTypeFilter?: ProviderType | string;
314
348
  /**
349
+ * @public
315
350
  * <p>Filters the list of connections to those associated with a specified host.</p>
316
351
  */
317
352
  HostArnFilter?: string;
318
353
  /**
354
+ * @public
319
355
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
320
356
  * results, make another call with the returned <code>nextToken</code> value.</p>
321
357
  */
322
358
  MaxResults?: number;
323
359
  /**
360
+ * @public
324
361
  * <p>The token that was returned from the previous <code>ListConnections</code> call, which
325
362
  * can be used to return the next set of connections in the list.</p>
326
363
  */
@@ -331,11 +368,13 @@ export interface ListConnectionsInput {
331
368
  */
332
369
  export interface ListConnectionsOutput {
333
370
  /**
371
+ * @public
334
372
  * <p>A list of connections and the details for each connection, such as status, owner, and
335
373
  * provider type.</p>
336
374
  */
337
375
  Connections?: Connection[];
338
376
  /**
377
+ * @public
339
378
  * <p>A token that can be used in the next <code>ListConnections</code> call. To view all
340
379
  * items in the list, continue to call this operation with each subsequent token until no more
341
380
  * <code>nextToken</code> values are returned.</p>
@@ -347,11 +386,13 @@ export interface ListConnectionsOutput {
347
386
  */
348
387
  export interface ListHostsInput {
349
388
  /**
389
+ * @public
350
390
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
351
391
  * results, make another call with the returned <code>nextToken</code> value.</p>
352
392
  */
353
393
  MaxResults?: number;
354
394
  /**
395
+ * @public
355
396
  * <p>The token that was returned from the previous <code>ListHosts</code> call, which can be
356
397
  * used to return the next set of hosts in the list.</p>
357
398
  */
@@ -369,32 +410,39 @@ export interface ListHostsInput {
369
410
  */
370
411
  export interface Host {
371
412
  /**
413
+ * @public
372
414
  * <p>The name of the host.</p>
373
415
  */
374
416
  Name?: string;
375
417
  /**
418
+ * @public
376
419
  * <p>The Amazon Resource Name (ARN) of the host.</p>
377
420
  */
378
421
  HostArn?: string;
379
422
  /**
423
+ * @public
380
424
  * <p>The name of the installed provider to be associated with your connection. The host
381
425
  * resource represents the infrastructure where your provider type is installed. The valid
382
426
  * provider type is GitHub Enterprise Server.</p>
383
427
  */
384
428
  ProviderType?: ProviderType | string;
385
429
  /**
430
+ * @public
386
431
  * <p>The endpoint of the infrastructure where your provider type is installed.</p>
387
432
  */
388
433
  ProviderEndpoint?: string;
389
434
  /**
435
+ * @public
390
436
  * <p>The VPC configuration provisioned for the host.</p>
391
437
  */
392
438
  VpcConfiguration?: VpcConfiguration;
393
439
  /**
440
+ * @public
394
441
  * <p>The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.</p>
395
442
  */
396
443
  Status?: string;
397
444
  /**
445
+ * @public
398
446
  * <p>The status description for the host.</p>
399
447
  */
400
448
  StatusMessage?: string;
@@ -404,11 +452,13 @@ export interface Host {
404
452
  */
405
453
  export interface ListHostsOutput {
406
454
  /**
455
+ * @public
407
456
  * <p>A list of hosts and the details for each host, such as status, endpoint, and provider
408
457
  * type.</p>
409
458
  */
410
459
  Hosts?: Host[];
411
460
  /**
461
+ * @public
412
462
  * <p>A token that can be used in the next <code>ListHosts</code> call. To view all items in the
413
463
  * list, continue to call this operation with each subsequent token until no more
414
464
  * <code>nextToken</code> values are returned.</p>
@@ -420,6 +470,7 @@ export interface ListHostsOutput {
420
470
  */
421
471
  export interface ListTagsForResourceInput {
422
472
  /**
473
+ * @public
423
474
  * <p>The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.</p>
424
475
  */
425
476
  ResourceArn: string | undefined;
@@ -429,6 +480,7 @@ export interface ListTagsForResourceInput {
429
480
  */
430
481
  export interface ListTagsForResourceOutput {
431
482
  /**
483
+ * @public
432
484
  * <p>A list of tag key and value pairs associated with the specified resource.</p>
433
485
  */
434
486
  Tags?: Tag[];
@@ -438,10 +490,12 @@ export interface ListTagsForResourceOutput {
438
490
  */
439
491
  export interface TagResourceInput {
440
492
  /**
493
+ * @public
441
494
  * <p>The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.</p>
442
495
  */
443
496
  ResourceArn: string | undefined;
444
497
  /**
498
+ * @public
445
499
  * <p>The tags you want to modify or add to the resource.</p>
446
500
  */
447
501
  Tags: Tag[] | undefined;
@@ -456,10 +510,12 @@ export interface TagResourceOutput {
456
510
  */
457
511
  export interface UntagResourceInput {
458
512
  /**
513
+ * @public
459
514
  * <p>The Amazon Resource Name (ARN) of the resource to remove tags from.</p>
460
515
  */
461
516
  ResourceArn: string | undefined;
462
517
  /**
518
+ * @public
463
519
  * <p>The list of keys for the tags to be removed from the resource.</p>
464
520
  */
465
521
  TagKeys: string[] | undefined;
@@ -500,14 +556,17 @@ export declare class UnsupportedOperationException extends __BaseException {
500
556
  */
501
557
  export interface UpdateHostInput {
502
558
  /**
559
+ * @public
503
560
  * <p>The Amazon Resource Name (ARN) of the host to be updated.</p>
504
561
  */
505
562
  HostArn: string | undefined;
506
563
  /**
564
+ * @public
507
565
  * <p>The URL or endpoint of the host to be updated.</p>
508
566
  */
509
567
  ProviderEndpoint?: string;
510
568
  /**
569
+ * @public
511
570
  * <p>The VPC configuration of the host to be updated. A VPC must be configured and the
512
571
  * infrastructure to be represented by the host must already be connected to the VPC.</p>
513
572
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-codestar-connections",
3
3
  "description": "AWS SDK for JavaScript Codestar Connections Client for Node.js, Browser and React Native",
4
- "version": "3.381.0",
4
+ "version": "3.385.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.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.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",