codestar.d.ts
35.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class CodeStar extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CodeStar.Types.ClientConfiguration)
config: Config & CodeStar.Types.ClientConfiguration;
/**
* Adds an IAM user to the team for an AWS CodeStar project.
*/
associateTeamMember(params: CodeStar.Types.AssociateTeamMemberRequest, callback?: (err: AWSError, data: CodeStar.Types.AssociateTeamMemberResult) => void): Request<CodeStar.Types.AssociateTeamMemberResult, AWSError>;
/**
* Adds an IAM user to the team for an AWS CodeStar project.
*/
associateTeamMember(callback?: (err: AWSError, data: CodeStar.Types.AssociateTeamMemberResult) => void): Request<CodeStar.Types.AssociateTeamMemberResult, AWSError>;
/**
* Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created.
*/
createProject(params: CodeStar.Types.CreateProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.CreateProjectResult) => void): Request<CodeStar.Types.CreateProjectResult, AWSError>;
/**
* Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created.
*/
createProject(callback?: (err: AWSError, data: CodeStar.Types.CreateProjectResult) => void): Request<CodeStar.Types.CreateProjectResult, AWSError>;
/**
* Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.
*/
createUserProfile(params: CodeStar.Types.CreateUserProfileRequest, callback?: (err: AWSError, data: CodeStar.Types.CreateUserProfileResult) => void): Request<CodeStar.Types.CreateUserProfileResult, AWSError>;
/**
* Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.
*/
createUserProfile(callback?: (err: AWSError, data: CodeStar.Types.CreateUserProfileResult) => void): Request<CodeStar.Types.CreateUserProfileResult, AWSError>;
/**
* Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project.
*/
deleteProject(params: CodeStar.Types.DeleteProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.DeleteProjectResult) => void): Request<CodeStar.Types.DeleteProjectResult, AWSError>;
/**
* Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project.
*/
deleteProject(callback?: (err: AWSError, data: CodeStar.Types.DeleteProjectResult) => void): Request<CodeStar.Types.DeleteProjectResult, AWSError>;
/**
* Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user.
*/
deleteUserProfile(params: CodeStar.Types.DeleteUserProfileRequest, callback?: (err: AWSError, data: CodeStar.Types.DeleteUserProfileResult) => void): Request<CodeStar.Types.DeleteUserProfileResult, AWSError>;
/**
* Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user.
*/
deleteUserProfile(callback?: (err: AWSError, data: CodeStar.Types.DeleteUserProfileResult) => void): Request<CodeStar.Types.DeleteUserProfileResult, AWSError>;
/**
* Describes a project and its resources.
*/
describeProject(params: CodeStar.Types.DescribeProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.DescribeProjectResult) => void): Request<CodeStar.Types.DescribeProjectResult, AWSError>;
/**
* Describes a project and its resources.
*/
describeProject(callback?: (err: AWSError, data: CodeStar.Types.DescribeProjectResult) => void): Request<CodeStar.Types.DescribeProjectResult, AWSError>;
/**
* Describes a user in AWS CodeStar and the user attributes across all projects.
*/
describeUserProfile(params: CodeStar.Types.DescribeUserProfileRequest, callback?: (err: AWSError, data: CodeStar.Types.DescribeUserProfileResult) => void): Request<CodeStar.Types.DescribeUserProfileResult, AWSError>;
/**
* Describes a user in AWS CodeStar and the user attributes across all projects.
*/
describeUserProfile(callback?: (err: AWSError, data: CodeStar.Types.DescribeUserProfileResult) => void): Request<CodeStar.Types.DescribeUserProfileResult, AWSError>;
/**
* Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM.
*/
disassociateTeamMember(params: CodeStar.Types.DisassociateTeamMemberRequest, callback?: (err: AWSError, data: CodeStar.Types.DisassociateTeamMemberResult) => void): Request<CodeStar.Types.DisassociateTeamMemberResult, AWSError>;
/**
* Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM.
*/
disassociateTeamMember(callback?: (err: AWSError, data: CodeStar.Types.DisassociateTeamMemberResult) => void): Request<CodeStar.Types.DisassociateTeamMemberResult, AWSError>;
/**
* Lists all projects in AWS CodeStar associated with your AWS account.
*/
listProjects(params: CodeStar.Types.ListProjectsRequest, callback?: (err: AWSError, data: CodeStar.Types.ListProjectsResult) => void): Request<CodeStar.Types.ListProjectsResult, AWSError>;
/**
* Lists all projects in AWS CodeStar associated with your AWS account.
*/
listProjects(callback?: (err: AWSError, data: CodeStar.Types.ListProjectsResult) => void): Request<CodeStar.Types.ListProjectsResult, AWSError>;
/**
* Lists resources associated with a project in AWS CodeStar.
*/
listResources(params: CodeStar.Types.ListResourcesRequest, callback?: (err: AWSError, data: CodeStar.Types.ListResourcesResult) => void): Request<CodeStar.Types.ListResourcesResult, AWSError>;
/**
* Lists resources associated with a project in AWS CodeStar.
*/
listResources(callback?: (err: AWSError, data: CodeStar.Types.ListResourcesResult) => void): Request<CodeStar.Types.ListResourcesResult, AWSError>;
/**
* Gets the tags for a project.
*/
listTagsForProject(params: CodeStar.Types.ListTagsForProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.ListTagsForProjectResult) => void): Request<CodeStar.Types.ListTagsForProjectResult, AWSError>;
/**
* Gets the tags for a project.
*/
listTagsForProject(callback?: (err: AWSError, data: CodeStar.Types.ListTagsForProjectResult) => void): Request<CodeStar.Types.ListTagsForProjectResult, AWSError>;
/**
* Lists all team members associated with a project.
*/
listTeamMembers(params: CodeStar.Types.ListTeamMembersRequest, callback?: (err: AWSError, data: CodeStar.Types.ListTeamMembersResult) => void): Request<CodeStar.Types.ListTeamMembersResult, AWSError>;
/**
* Lists all team members associated with a project.
*/
listTeamMembers(callback?: (err: AWSError, data: CodeStar.Types.ListTeamMembersResult) => void): Request<CodeStar.Types.ListTeamMembersResult, AWSError>;
/**
* Lists all the user profiles configured for your AWS account in AWS CodeStar.
*/
listUserProfiles(params: CodeStar.Types.ListUserProfilesRequest, callback?: (err: AWSError, data: CodeStar.Types.ListUserProfilesResult) => void): Request<CodeStar.Types.ListUserProfilesResult, AWSError>;
/**
* Lists all the user profiles configured for your AWS account in AWS CodeStar.
*/
listUserProfiles(callback?: (err: AWSError, data: CodeStar.Types.ListUserProfilesResult) => void): Request<CodeStar.Types.ListUserProfilesResult, AWSError>;
/**
* Adds tags to a project.
*/
tagProject(params: CodeStar.Types.TagProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.TagProjectResult) => void): Request<CodeStar.Types.TagProjectResult, AWSError>;
/**
* Adds tags to a project.
*/
tagProject(callback?: (err: AWSError, data: CodeStar.Types.TagProjectResult) => void): Request<CodeStar.Types.TagProjectResult, AWSError>;
/**
* Removes tags from a project.
*/
untagProject(params: CodeStar.Types.UntagProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.UntagProjectResult) => void): Request<CodeStar.Types.UntagProjectResult, AWSError>;
/**
* Removes tags from a project.
*/
untagProject(callback?: (err: AWSError, data: CodeStar.Types.UntagProjectResult) => void): Request<CodeStar.Types.UntagProjectResult, AWSError>;
/**
* Updates a project in AWS CodeStar.
*/
updateProject(params: CodeStar.Types.UpdateProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.UpdateProjectResult) => void): Request<CodeStar.Types.UpdateProjectResult, AWSError>;
/**
* Updates a project in AWS CodeStar.
*/
updateProject(callback?: (err: AWSError, data: CodeStar.Types.UpdateProjectResult) => void): Request<CodeStar.Types.UpdateProjectResult, AWSError>;
/**
* Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources.
*/
updateTeamMember(params: CodeStar.Types.UpdateTeamMemberRequest, callback?: (err: AWSError, data: CodeStar.Types.UpdateTeamMemberResult) => void): Request<CodeStar.Types.UpdateTeamMemberResult, AWSError>;
/**
* Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources.
*/
updateTeamMember(callback?: (err: AWSError, data: CodeStar.Types.UpdateTeamMemberResult) => void): Request<CodeStar.Types.UpdateTeamMemberResult, AWSError>;
/**
* Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.
*/
updateUserProfile(params: CodeStar.Types.UpdateUserProfileRequest, callback?: (err: AWSError, data: CodeStar.Types.UpdateUserProfileResult) => void): Request<CodeStar.Types.UpdateUserProfileResult, AWSError>;
/**
* Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.
*/
updateUserProfile(callback?: (err: AWSError, data: CodeStar.Types.UpdateUserProfileResult) => void): Request<CodeStar.Types.UpdateUserProfileResult, AWSError>;
}
declare namespace CodeStar {
export interface AssociateTeamMemberRequest {
/**
* The ID of the project to which you will add the IAM user.
*/
projectId: ProjectId;
/**
* A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request.
*/
clientRequestToken?: ClientRequestToken;
/**
* The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.
*/
userArn: UserArn;
/**
* The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.
*/
projectRole: Role;
/**
* Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.
*/
remoteAccessAllowed?: RemoteAccessAllowed;
}
export interface AssociateTeamMemberResult {
/**
* The user- or system-generated token from the initial request that can be used to repeat the request.
*/
clientRequestToken?: ClientRequestToken;
}
export type BucketKey = string;
export type BucketName = string;
export type ClientRequestToken = string;
export interface Code {
/**
* The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.
*/
source: CodeSource;
/**
* The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the source code files provided with the project request are placed in the repository.
*/
destination: CodeDestination;
}
export interface CodeCommitCodeDestination {
/**
* The name of the AWS CodeCommit repository to be created in AWS CodeStar.
*/
name: RepositoryName;
}
export interface CodeDestination {
/**
* Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.
*/
codeCommit?: CodeCommitCodeDestination;
/**
* Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.
*/
gitHub?: GitHubCodeDestination;
}
export interface CodeSource {
/**
* Information about the Amazon S3 location where the source code files provided with the project request are stored.
*/
s3: S3Location;
}
export interface CreateProjectRequest {
/**
* The display name for the project to be created in AWS CodeStar.
*/
name: ProjectName;
/**
* The ID of the project to be created in AWS CodeStar.
*/
id: ProjectId;
/**
* The description of the project, if any.
*/
description?: ProjectDescription;
/**
* A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.
*/
clientRequestToken?: ClientRequestToken;
/**
* A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.
*/
sourceCode?: SourceCode;
/**
* The name of the toolchain template file submitted with the project request. If this parameter is specified, the request must also include the sourceCode parameter.
*/
toolchain?: Toolchain;
/**
* The tags created for the project.
*/
tags?: Tags;
}
export interface CreateProjectResult {
/**
* The ID of the project.
*/
id: ProjectId;
/**
* The Amazon Resource Name (ARN) of the created project.
*/
arn: ProjectArn;
/**
* A user- or system-generated token that identifies the entity that requested project creation.
*/
clientRequestToken?: ClientRequestToken;
/**
* Reserved for future use.
*/
projectTemplateId?: ProjectTemplateId;
}
export interface CreateUserProfileRequest {
/**
* The Amazon Resource Name (ARN) of the user in IAM.
*/
userArn: UserArn;
/**
* The name that will be displayed as the friendly name for the user in AWS CodeStar.
*/
displayName: UserProfileDisplayName;
/**
* The email address that will be displayed as part of the user's profile in AWS CodeStar.
*/
emailAddress: Email;
/**
* The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.
*/
sshPublicKey?: SshPublicKey;
}
export interface CreateUserProfileResult {
/**
* The Amazon Resource Name (ARN) of the user in IAM.
*/
userArn: UserArn;
/**
* The name that is displayed as the friendly name for the user in AWS CodeStar.
*/
displayName?: UserProfileDisplayName;
/**
* The email address that is displayed as part of the user's profile in AWS CodeStar.
*/
emailAddress?: Email;
/**
* The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.
*/
sshPublicKey?: SshPublicKey;
/**
* The date the user profile was created, in timestamp format.
*/
createdTimestamp?: CreatedTimestamp;
/**
* The date the user profile was last modified, in timestamp format.
*/
lastModifiedTimestamp?: LastModifiedTimestamp;
}
export type CreatedTimestamp = Date;
export interface DeleteProjectRequest {
/**
* The ID of the project to be deleted in AWS CodeStar.
*/
id: ProjectId;
/**
* A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.
*/
clientRequestToken?: ClientRequestToken;
/**
* Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.
*/
deleteStack?: DeleteStack;
}
export interface DeleteProjectResult {
/**
* The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.
*/
stackId?: StackId;
/**
* The Amazon Resource Name (ARN) of the deleted project.
*/
projectArn?: ProjectArn;
}
export type DeleteStack = boolean;
export interface DeleteUserProfileRequest {
/**
* The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.
*/
userArn: UserArn;
}
export interface DeleteUserProfileResult {
/**
* The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.
*/
userArn: UserArn;
}
export interface DescribeProjectRequest {
/**
* The ID of the project.
*/
id: ProjectId;
}
export interface DescribeProjectResult {
/**
* The display name for the project.
*/
name?: ProjectName;
/**
* The ID of the project.
*/
id?: ProjectId;
/**
* The Amazon Resource Name (ARN) for the project.
*/
arn?: ProjectArn;
/**
* The description of the project, if any.
*/
description?: ProjectDescription;
/**
* A user- or system-generated token that identifies the entity that requested project creation.
*/
clientRequestToken?: ClientRequestToken;
/**
* The date and time the project was created, in timestamp format.
*/
createdTimeStamp?: CreatedTimestamp;
/**
* The ID of the primary stack in AWS CloudFormation used to generate resources for the project.
*/
stackId?: StackId;
/**
* The ID for the AWS CodeStar project template used to create the project.
*/
projectTemplateId?: ProjectTemplateId;
/**
* The project creation or deletion status.
*/
status?: ProjectStatus;
}
export interface DescribeUserProfileRequest {
/**
* The Amazon Resource Name (ARN) of the user.
*/
userArn: UserArn;
}
export interface DescribeUserProfileResult {
/**
* The Amazon Resource Name (ARN) of the user.
*/
userArn: UserArn;
/**
* The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").
*/
displayName?: UserProfileDisplayName;
/**
* The email address for the user. Optional.
*/
emailAddress?: Email;
/**
* The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be used in conjunction with the associated private key for access to project resources, such as Amazon EC2 instances, if a project owner grants remote access to those resources.
*/
sshPublicKey?: SshPublicKey;
/**
* The date and time when the user profile was created in AWS CodeStar, in timestamp format.
*/
createdTimestamp: CreatedTimestamp;
/**
* The date and time when the user profile was last modified, in timestamp format.
*/
lastModifiedTimestamp: LastModifiedTimestamp;
}
export interface DisassociateTeamMemberRequest {
/**
* The ID of the AWS CodeStar project from which you want to remove a team member.
*/
projectId: ProjectId;
/**
* The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.
*/
userArn: UserArn;
}
export interface DisassociateTeamMemberResult {
}
export type Email = string;
export interface GitHubCodeDestination {
/**
* Name of the GitHub repository to be created in AWS CodeStar.
*/
name: RepositoryName;
/**
* Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.
*/
description?: RepositoryDescription;
/**
* The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.
*/
type: RepositoryType;
/**
* The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should be owned by a GitHub organization, provide its name.
*/
owner: RepositoryOwner;
/**
* Whether the GitHub repository is to be a private repository.
*/
privateRepository: RepositoryIsPrivate;
/**
* Whether to enable issues for the GitHub repository.
*/
issuesEnabled: RepositoryEnableIssues;
/**
* The GitHub user's personal access token for the GitHub repository.
*/
token: GitHubPersonalToken;
}
export type GitHubPersonalToken = string;
export type LastModifiedTimestamp = Date;
export interface ListProjectsRequest {
/**
* The continuation token to be used to return the next set of results, if the results cannot be returned in one response.
*/
nextToken?: PaginationToken;
/**
* The maximum amount of data that can be contained in a single set of results.
*/
maxResults?: MaxResults;
}
export interface ListProjectsResult {
/**
* A list of projects.
*/
projects: ProjectsList;
/**
* The continuation token to use when requesting the next set of results, if there are more results to be returned.
*/
nextToken?: PaginationToken;
}
export interface ListResourcesRequest {
/**
* The ID of the project.
*/
projectId: ProjectId;
/**
* The continuation token for the next set of results, if the results cannot be returned in one response.
*/
nextToken?: PaginationToken;
/**
* The maximum amount of data that can be contained in a single set of results.
*/
maxResults?: MaxResults;
}
export interface ListResourcesResult {
/**
* An array of resources associated with the project.
*/
resources?: ResourcesResult;
/**
* The continuation token to use when requesting the next set of results, if there are more results to be returned.
*/
nextToken?: PaginationToken;
}
export interface ListTagsForProjectRequest {
/**
* The ID of the project to get tags for.
*/
id: ProjectId;
/**
* Reserved for future use.
*/
nextToken?: PaginationToken;
/**
* Reserved for future use.
*/
maxResults?: MaxResults;
}
export interface ListTagsForProjectResult {
/**
* The tags for the project.
*/
tags?: Tags;
/**
* Reserved for future use.
*/
nextToken?: PaginationToken;
}
export interface ListTeamMembersRequest {
/**
* The ID of the project for which you want to list team members.
*/
projectId: ProjectId;
/**
* The continuation token for the next set of results, if the results cannot be returned in one response.
*/
nextToken?: PaginationToken;
/**
* The maximum number of team members you want returned in a response.
*/
maxResults?: MaxResults;
}
export interface ListTeamMembersResult {
/**
* A list of team member objects for the project.
*/
teamMembers: TeamMemberResult;
/**
* The continuation token to use when requesting the next set of results, if there are more results to be returned.
*/
nextToken?: PaginationToken;
}
export interface ListUserProfilesRequest {
/**
* The continuation token for the next set of results, if the results cannot be returned in one response.
*/
nextToken?: PaginationToken;
/**
* The maximum number of results to return in a response.
*/
maxResults?: MaxResults;
}
export interface ListUserProfilesResult {
/**
* All the user profiles configured in AWS CodeStar for an AWS account.
*/
userProfiles: UserProfilesList;
/**
* The continuation token to use when requesting the next set of results, if there are more results to be returned.
*/
nextToken?: PaginationToken;
}
export type MaxResults = number;
export type PaginationToken = string;
export type ProjectArn = string;
export type ProjectDescription = string;
export type ProjectId = string;
export type ProjectName = string;
export interface ProjectStatus {
/**
* The phase of completion for a project creation or deletion.
*/
state: State;
/**
* In the case of a project creation or deletion failure, a reason for the failure.
*/
reason?: Reason;
}
export interface ProjectSummary {
/**
* The ID of the project.
*/
projectId?: ProjectId;
/**
* The Amazon Resource Name (ARN) of the project.
*/
projectArn?: ProjectArn;
}
export type ProjectTemplateId = string;
export type ProjectsList = ProjectSummary[];
export type Reason = string;
export type RemoteAccessAllowed = boolean;
export type RepositoryDescription = string;
export type RepositoryEnableIssues = boolean;
export type RepositoryIsPrivate = boolean;
export type RepositoryName = string;
export type RepositoryOwner = string;
export type RepositoryType = string;
export interface Resource {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
id: ResourceId;
}
export type ResourceId = string;
export type ResourcesResult = Resource[];
export type Role = string;
export type RoleArn = string;
export interface S3Location {
/**
* The Amazon S3 bucket name where the source code files provided with the project request are stored.
*/
bucketName?: BucketName;
/**
* The Amazon S3 object key where the source code files provided with the project request are stored.
*/
bucketKey?: BucketKey;
}
export type SourceCode = Code[];
export type SshPublicKey = string;
export type StackId = string;
export type State = string;
export type TagKey = string;
export type TagKeys = TagKey[];
export interface TagProjectRequest {
/**
* The ID of the project you want to add a tag to.
*/
id: ProjectId;
/**
* The tags you want to add to the project.
*/
tags: Tags;
}
export interface TagProjectResult {
/**
* The tags for the project.
*/
tags?: Tags;
}
export type TagValue = string;
export type Tags = {[key: string]: TagValue};
export interface TeamMember {
/**
* The Amazon Resource Name (ARN) of the user in IAM.
*/
userArn: UserArn;
/**
* The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide.
*/
projectRole: Role;
/**
* Whether the user is allowed to remotely access project resources using an SSH public/private key pair.
*/
remoteAccessAllowed?: RemoteAccessAllowed;
}
export type TeamMemberResult = TeamMember[];
export type TemplateParameterKey = string;
export type TemplateParameterMap = {[key: string]: TemplateParameterValue};
export type TemplateParameterValue = string;
export interface Toolchain {
/**
* The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.
*/
source: ToolchainSource;
/**
* The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.
*/
roleArn?: RoleArn;
/**
* The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.
*/
stackParameters?: TemplateParameterMap;
}
export interface ToolchainSource {
/**
* The Amazon S3 bucket where the toolchain template file provided with the project request is stored.
*/
s3: S3Location;
}
export interface UntagProjectRequest {
/**
* The ID of the project to remove tags from.
*/
id: ProjectId;
/**
* The tags to remove from the project.
*/
tags: TagKeys;
}
export interface UntagProjectResult {
}
export interface UpdateProjectRequest {
/**
* The ID of the project you want to update.
*/
id: ProjectId;
/**
* The name of the project you want to update.
*/
name?: ProjectName;
/**
* The description of the project, if any.
*/
description?: ProjectDescription;
}
export interface UpdateProjectResult {
}
export interface UpdateTeamMemberRequest {
/**
* The ID of the project.
*/
projectId: ProjectId;
/**
* The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.
*/
userArn: UserArn;
/**
* The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide.
*/
projectRole?: Role;
/**
* Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources.
*/
remoteAccessAllowed?: RemoteAccessAllowed;
}
export interface UpdateTeamMemberResult {
/**
* The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.
*/
userArn?: UserArn;
/**
* The project role granted to the user.
*/
projectRole?: Role;
/**
* Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile.
*/
remoteAccessAllowed?: RemoteAccessAllowed;
}
export interface UpdateUserProfileRequest {
/**
* The name that will be displayed as the friendly name for the user in AWS CodeStar.
*/
userArn: UserArn;
/**
* The name that is displayed as the friendly name for the user in AWS CodeStar.
*/
displayName?: UserProfileDisplayName;
/**
* The email address that is displayed as part of the user's profile in AWS CodeStar.
*/
emailAddress?: Email;
/**
* The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.
*/
sshPublicKey?: SshPublicKey;
}
export interface UpdateUserProfileResult {
/**
* The Amazon Resource Name (ARN) of the user in IAM.
*/
userArn: UserArn;
/**
* The name that is displayed as the friendly name for the user in AWS CodeStar.
*/
displayName?: UserProfileDisplayName;
/**
* The email address that is displayed as part of the user's profile in AWS CodeStar.
*/
emailAddress?: Email;
/**
* The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.
*/
sshPublicKey?: SshPublicKey;
/**
* The date the user profile was created, in timestamp format.
*/
createdTimestamp?: CreatedTimestamp;
/**
* The date the user profile was last modified, in timestamp format.
*/
lastModifiedTimestamp?: LastModifiedTimestamp;
}
export type UserArn = string;
export type UserProfileDisplayName = string;
export interface UserProfileSummary {
/**
* The Amazon Resource Name (ARN) of the user in IAM.
*/
userArn?: UserArn;
/**
* The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").
*/
displayName?: UserProfileDisplayName;
/**
* The email address associated with the user.
*/
emailAddress?: Email;
/**
* The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.
*/
sshPublicKey?: SshPublicKey;
}
export type UserProfilesList = UserProfileSummary[];
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2017-04-19"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the CodeStar client.
*/
export import Types = CodeStar;
}
export = CodeStar;