aws-sdk-codestar 1.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::CodeStar
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,960 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::CodeStar
9
+ module Types
10
+
11
+ # @note When making an API call, you may pass AssociateTeamMemberRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # project_id: "ProjectId", # required
16
+ # client_request_token: "ClientRequestToken",
17
+ # user_arn: "UserArn", # required
18
+ # project_role: "Role", # required
19
+ # remote_access_allowed: false,
20
+ # }
21
+ #
22
+ # @!attribute [rw] project_id
23
+ # The ID of the project to which you will add the IAM user.
24
+ # @return [String]
25
+ #
26
+ # @!attribute [rw] client_request_token
27
+ # A user- or system-generated token that identifies the entity that
28
+ # requested the team member association to the project. This token can
29
+ # be used to repeat the request.
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] user_arn
33
+ # The Amazon Resource Name (ARN) for the IAM user you want to add to
34
+ # the DevHub project.
35
+ # @return [String]
36
+ #
37
+ # @!attribute [rw] project_role
38
+ # The AWS CodeStar project role that will apply to this user. This
39
+ # role determines what actions a user can take in an AWS CodeStar
40
+ # project.
41
+ # @return [String]
42
+ #
43
+ # @!attribute [rw] remote_access_allowed
44
+ # Whether the team member is allowed to use an SSH public/private key
45
+ # pair to remotely access project resources, for example Amazon EC2
46
+ # instances.
47
+ # @return [Boolean]
48
+ #
49
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/AssociateTeamMemberRequest AWS API Documentation
50
+ #
51
+ class AssociateTeamMemberRequest < Struct.new(
52
+ :project_id,
53
+ :client_request_token,
54
+ :user_arn,
55
+ :project_role,
56
+ :remote_access_allowed)
57
+ include Aws::Structure
58
+ end
59
+
60
+ # @!attribute [rw] client_request_token
61
+ # The user- or system-generated token from the initial request that
62
+ # can be used to repeat the request.
63
+ # @return [String]
64
+ #
65
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/AssociateTeamMemberResult AWS API Documentation
66
+ #
67
+ class AssociateTeamMemberResult < Struct.new(
68
+ :client_request_token)
69
+ include Aws::Structure
70
+ end
71
+
72
+ # @note When making an API call, you may pass CreateProjectRequest
73
+ # data as a hash:
74
+ #
75
+ # {
76
+ # name: "ProjectName", # required
77
+ # id: "ProjectId", # required
78
+ # description: "ProjectDescription",
79
+ # client_request_token: "ClientRequestToken",
80
+ # }
81
+ #
82
+ # @!attribute [rw] name
83
+ # The friendly name for the project. This friendly name serves as the
84
+ # basis for the names for resources associated with the project, such
85
+ # as a repository name in AWS CodeCommit. The name is limited to 100
86
+ # characters and cannot contain certain restricted symbols. For more
87
+ # information, see [Limits][1] in the AWS CodeStar User Guide.
88
+ #
89
+ #
90
+ #
91
+ # [1]: http://docs.aws.amazon.com/codestar/latest/userguide/limits.html
92
+ # @return [String]
93
+ #
94
+ # @!attribute [rw] id
95
+ # The ID for the AWS CodeStar project. Project IDs must be unique
96
+ # within an AWS account. Project IDs cannot exceed 15 characters and
97
+ # cannot contain capital letters and other restricted symbols. For
98
+ # more information, see [Limits][1] in the AWS CodeStar User Guide.
99
+ #
100
+ #
101
+ #
102
+ # [1]: http://docs.aws.amazon.com/codestar/latest/userguide/limits.html
103
+ # @return [String]
104
+ #
105
+ # @!attribute [rw] description
106
+ # Optional. The description for the project.
107
+ # @return [String]
108
+ #
109
+ # @!attribute [rw] client_request_token
110
+ # A user- or system-generated token that identifies the entity that
111
+ # requested project creation. This token can be used to repeat the
112
+ # request. It can also be used to identify which user or system made
113
+ # the request in DescribeProject and ListProjects.
114
+ # @return [String]
115
+ #
116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/CreateProjectRequest AWS API Documentation
117
+ #
118
+ class CreateProjectRequest < Struct.new(
119
+ :name,
120
+ :id,
121
+ :description,
122
+ :client_request_token)
123
+ include Aws::Structure
124
+ end
125
+
126
+ # @!attribute [rw] id
127
+ # The ID for the project.
128
+ # @return [String]
129
+ #
130
+ # @!attribute [rw] arn
131
+ # The Amazon Resource Name (ARN) for the project.
132
+ # @return [String]
133
+ #
134
+ # @!attribute [rw] client_request_token
135
+ # The user- or system-generated token from the initial request that
136
+ # can be used to repeat the request. It can also be used to identify
137
+ # which user or system made the request in DescribeProject and
138
+ # ListProjects.
139
+ # @return [String]
140
+ #
141
+ # @!attribute [rw] project_template_id
142
+ # The ID for the AWS CodeStar project template used to create the
143
+ # project.
144
+ # @return [String]
145
+ #
146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/CreateProjectResult AWS API Documentation
147
+ #
148
+ class CreateProjectResult < Struct.new(
149
+ :id,
150
+ :arn,
151
+ :client_request_token,
152
+ :project_template_id)
153
+ include Aws::Structure
154
+ end
155
+
156
+ # @note When making an API call, you may pass CreateUserProfileRequest
157
+ # data as a hash:
158
+ #
159
+ # {
160
+ # user_arn: "UserArn", # required
161
+ # display_name: "UserProfileDisplayName", # required
162
+ # email_address: "Email", # required
163
+ # ssh_public_key: "SshPublicKey",
164
+ # }
165
+ #
166
+ # @!attribute [rw] user_arn
167
+ # The Amazon Resource Name (ARN) of the user in IAM.
168
+ # @return [String]
169
+ #
170
+ # @!attribute [rw] display_name
171
+ # The name that will be displayed as the friendly name for the user in
172
+ # AWS CodeStar.
173
+ # @return [String]
174
+ #
175
+ # @!attribute [rw] email_address
176
+ # The email address that will be displayed as part of the user's
177
+ # profile in AWS CodeStar.
178
+ # @return [String]
179
+ #
180
+ # @!attribute [rw] ssh_public_key
181
+ # The SSH public key associated with the user in AWS CodeStar. If a
182
+ # project owner allows the user remote access to project resources,
183
+ # this public key will be used along with the user's private key for
184
+ # SSH access.
185
+ # @return [String]
186
+ #
187
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/CreateUserProfileRequest AWS API Documentation
188
+ #
189
+ class CreateUserProfileRequest < Struct.new(
190
+ :user_arn,
191
+ :display_name,
192
+ :email_address,
193
+ :ssh_public_key)
194
+ include Aws::Structure
195
+ end
196
+
197
+ # @!attribute [rw] user_arn
198
+ # The Amazon Resource Name (ARN) of the user in IAM.
199
+ # @return [String]
200
+ #
201
+ # @!attribute [rw] display_name
202
+ # The name that is displayed as the friendly name for the user in AWS
203
+ # CodeStar.
204
+ # @return [String]
205
+ #
206
+ # @!attribute [rw] email_address
207
+ # The email address that is displayed as part of the user's profile
208
+ # in AWS CodeStar.
209
+ # @return [String]
210
+ #
211
+ # @!attribute [rw] ssh_public_key
212
+ # The SSH public key associated with the user in AWS CodeStar. This is
213
+ # the public portion of the public/private keypair the user can use to
214
+ # access project resources if a project owner allows the user remote
215
+ # access to those resources.
216
+ # @return [String]
217
+ #
218
+ # @!attribute [rw] created_timestamp
219
+ # The date the user profile was created, in timestamp format.
220
+ # @return [Time]
221
+ #
222
+ # @!attribute [rw] last_modified_timestamp
223
+ # The date the user profile was last modified, in timestamp format.
224
+ # @return [Time]
225
+ #
226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/CreateUserProfileResult AWS API Documentation
227
+ #
228
+ class CreateUserProfileResult < Struct.new(
229
+ :user_arn,
230
+ :display_name,
231
+ :email_address,
232
+ :ssh_public_key,
233
+ :created_timestamp,
234
+ :last_modified_timestamp)
235
+ include Aws::Structure
236
+ end
237
+
238
+ # @note When making an API call, you may pass DeleteProjectRequest
239
+ # data as a hash:
240
+ #
241
+ # {
242
+ # id: "ProjectId", # required
243
+ # client_request_token: "ClientRequestToken",
244
+ # delete_stack: false,
245
+ # }
246
+ #
247
+ # @!attribute [rw] id
248
+ # The ID of the project to be deleted in AWS CodeStar.
249
+ # @return [String]
250
+ #
251
+ # @!attribute [rw] client_request_token
252
+ # A user- or system-generated token that identifies the entity that
253
+ # requested project deletion. This token can be used to repeat the
254
+ # request.
255
+ # @return [String]
256
+ #
257
+ # @!attribute [rw] delete_stack
258
+ # Whether to send a delete request for the primary stack in AWS
259
+ # CloudFormation originally used to generate the project and its
260
+ # resources. This option will delete all AWS resources for the project
261
+ # (except for any buckets in Amazon S3) as well as deleting the
262
+ # project itself. Recommended for most use cases.
263
+ # @return [Boolean]
264
+ #
265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DeleteProjectRequest AWS API Documentation
266
+ #
267
+ class DeleteProjectRequest < Struct.new(
268
+ :id,
269
+ :client_request_token,
270
+ :delete_stack)
271
+ include Aws::Structure
272
+ end
273
+
274
+ # @!attribute [rw] stack_id
275
+ # The ID of the primary stack in AWS CloudFormation that will be
276
+ # deleted as part of deleting the project and its resources.
277
+ # @return [String]
278
+ #
279
+ # @!attribute [rw] project_arn
280
+ # The Amazon Resource Name (ARN) of the deleted project.
281
+ # @return [String]
282
+ #
283
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DeleteProjectResult AWS API Documentation
284
+ #
285
+ class DeleteProjectResult < Struct.new(
286
+ :stack_id,
287
+ :project_arn)
288
+ include Aws::Structure
289
+ end
290
+
291
+ # @note When making an API call, you may pass DeleteUserProfileRequest
292
+ # data as a hash:
293
+ #
294
+ # {
295
+ # user_arn: "UserArn", # required
296
+ # }
297
+ #
298
+ # @!attribute [rw] user_arn
299
+ # The Amazon Resource Name (ARN) of the user to delete from AWS
300
+ # CodeStar.
301
+ # @return [String]
302
+ #
303
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DeleteUserProfileRequest AWS API Documentation
304
+ #
305
+ class DeleteUserProfileRequest < Struct.new(
306
+ :user_arn)
307
+ include Aws::Structure
308
+ end
309
+
310
+ # @!attribute [rw] user_arn
311
+ # The Amazon Resource Name (ARN) of the user deleted from AWS
312
+ # CodeStar.
313
+ # @return [String]
314
+ #
315
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DeleteUserProfileResult AWS API Documentation
316
+ #
317
+ class DeleteUserProfileResult < Struct.new(
318
+ :user_arn)
319
+ include Aws::Structure
320
+ end
321
+
322
+ # @note When making an API call, you may pass DescribeProjectRequest
323
+ # data as a hash:
324
+ #
325
+ # {
326
+ # id: "ProjectId", # required
327
+ # }
328
+ #
329
+ # @!attribute [rw] id
330
+ # The ID of the project.
331
+ # @return [String]
332
+ #
333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DescribeProjectRequest AWS API Documentation
334
+ #
335
+ class DescribeProjectRequest < Struct.new(
336
+ :id)
337
+ include Aws::Structure
338
+ end
339
+
340
+ # @!attribute [rw] name
341
+ # The display name for the project.
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] id
345
+ # The ID of the project.
346
+ # @return [String]
347
+ #
348
+ # @!attribute [rw] arn
349
+ # The Amazon Resource Name (ARN) for the project.
350
+ # @return [String]
351
+ #
352
+ # @!attribute [rw] description
353
+ # The description of the project, if any.
354
+ # @return [String]
355
+ #
356
+ # @!attribute [rw] client_request_token
357
+ # A user- or system-generated token that identifies the entity that
358
+ # requested project creation.
359
+ # @return [String]
360
+ #
361
+ # @!attribute [rw] created_time_stamp
362
+ # The date and time the project was created, in timestamp format.
363
+ # @return [Time]
364
+ #
365
+ # @!attribute [rw] stack_id
366
+ # The ID of the primary stack in AWS CloudFormation used to generate
367
+ # resources for the project.
368
+ # @return [String]
369
+ #
370
+ # @!attribute [rw] project_template_id
371
+ # The ID for the AWS CodeStar project template used to create the
372
+ # project.
373
+ # @return [String]
374
+ #
375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DescribeProjectResult AWS API Documentation
376
+ #
377
+ class DescribeProjectResult < Struct.new(
378
+ :name,
379
+ :id,
380
+ :arn,
381
+ :description,
382
+ :client_request_token,
383
+ :created_time_stamp,
384
+ :stack_id,
385
+ :project_template_id)
386
+ include Aws::Structure
387
+ end
388
+
389
+ # @note When making an API call, you may pass DescribeUserProfileRequest
390
+ # data as a hash:
391
+ #
392
+ # {
393
+ # user_arn: "UserArn", # required
394
+ # }
395
+ #
396
+ # @!attribute [rw] user_arn
397
+ # The Amazon Resource Name (ARN) of the user.
398
+ # @return [String]
399
+ #
400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DescribeUserProfileRequest AWS API Documentation
401
+ #
402
+ class DescribeUserProfileRequest < Struct.new(
403
+ :user_arn)
404
+ include Aws::Structure
405
+ end
406
+
407
+ # @!attribute [rw] user_arn
408
+ # The Amazon Resource Name (ARN) of the user.
409
+ # @return [String]
410
+ #
411
+ # @!attribute [rw] display_name
412
+ # The display name shown for the user in AWS CodeStar projects. For
413
+ # example, this could be set to both first and last name ("Mary
414
+ # Major") or a single name ("Mary"). The display name is also used
415
+ # to generate the initial icon associated with the user in AWS
416
+ # CodeStar projects. If spaces are included in the display name, the
417
+ # first character that appears after the space will be used as the
418
+ # second character in the user initial icon. The initial icon displays
419
+ # a maximum of two characters, so a display name with more than one
420
+ # space (for example "Mary Jane Major") would generate an initial
421
+ # icon using the first character and the first character after the
422
+ # space ("MJ", not "MM").
423
+ # @return [String]
424
+ #
425
+ # @!attribute [rw] email_address
426
+ # The email address for the user. Optional.
427
+ # @return [String]
428
+ #
429
+ # @!attribute [rw] ssh_public_key
430
+ # The SSH public key associated with the user. This SSH public key is
431
+ # associated with the user profile, and can be used in conjunction
432
+ # with the associated private key for access to project resources,
433
+ # such as Amazon EC2 instances, if a project owner grants remote
434
+ # access to those resources.
435
+ # @return [String]
436
+ #
437
+ # @!attribute [rw] created_timestamp
438
+ # The date and time when the user profile was created in AWS CodeStar,
439
+ # in timestamp format.
440
+ # @return [Time]
441
+ #
442
+ # @!attribute [rw] last_modified_timestamp
443
+ # The date and time when the user profile was last modified, in
444
+ # timestamp format.
445
+ # @return [Time]
446
+ #
447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DescribeUserProfileResult AWS API Documentation
448
+ #
449
+ class DescribeUserProfileResult < Struct.new(
450
+ :user_arn,
451
+ :display_name,
452
+ :email_address,
453
+ :ssh_public_key,
454
+ :created_timestamp,
455
+ :last_modified_timestamp)
456
+ include Aws::Structure
457
+ end
458
+
459
+ # @note When making an API call, you may pass DisassociateTeamMemberRequest
460
+ # data as a hash:
461
+ #
462
+ # {
463
+ # project_id: "ProjectId", # required
464
+ # user_arn: "UserArn", # required
465
+ # }
466
+ #
467
+ # @!attribute [rw] project_id
468
+ # The ID of the AWS CodeStar project from which you want to remove a
469
+ # team member.
470
+ # @return [String]
471
+ #
472
+ # @!attribute [rw] user_arn
473
+ # The Amazon Resource Name (ARN) of the IAM user or group whom you
474
+ # want to remove from the project.
475
+ # @return [String]
476
+ #
477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DisassociateTeamMemberRequest AWS API Documentation
478
+ #
479
+ class DisassociateTeamMemberRequest < Struct.new(
480
+ :project_id,
481
+ :user_arn)
482
+ include Aws::Structure
483
+ end
484
+
485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DisassociateTeamMemberResult AWS API Documentation
486
+ #
487
+ class DisassociateTeamMemberResult < Aws::EmptyStructure; end
488
+
489
+ # @note When making an API call, you may pass ListProjectsRequest
490
+ # data as a hash:
491
+ #
492
+ # {
493
+ # next_token: "PaginationToken",
494
+ # max_results: 1,
495
+ # }
496
+ #
497
+ # @!attribute [rw] next_token
498
+ # The continuation token to be used to return the next set of results,
499
+ # if the results cannot be returned in one response.
500
+ # @return [String]
501
+ #
502
+ # @!attribute [rw] max_results
503
+ # The maximum amount of data that can be contained in a single set of
504
+ # results.
505
+ # @return [Integer]
506
+ #
507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListProjectsRequest AWS API Documentation
508
+ #
509
+ class ListProjectsRequest < Struct.new(
510
+ :next_token,
511
+ :max_results)
512
+ include Aws::Structure
513
+ end
514
+
515
+ # @!attribute [rw] projects
516
+ # A list of projects.
517
+ # @return [Array<Types::ProjectSummary>]
518
+ #
519
+ # @!attribute [rw] next_token
520
+ # The continuation token to use when requesting the next set of
521
+ # results, if there are more results to be returned.
522
+ # @return [String]
523
+ #
524
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListProjectsResult AWS API Documentation
525
+ #
526
+ class ListProjectsResult < Struct.new(
527
+ :projects,
528
+ :next_token)
529
+ include Aws::Structure
530
+ end
531
+
532
+ # @note When making an API call, you may pass ListResourcesRequest
533
+ # data as a hash:
534
+ #
535
+ # {
536
+ # project_id: "ProjectId", # required
537
+ # next_token: "PaginationToken",
538
+ # max_results: 1,
539
+ # }
540
+ #
541
+ # @!attribute [rw] project_id
542
+ # The ID of the project.
543
+ # @return [String]
544
+ #
545
+ # @!attribute [rw] next_token
546
+ # The continuation token for the next set of results, if the results
547
+ # cannot be returned in one response.
548
+ # @return [String]
549
+ #
550
+ # @!attribute [rw] max_results
551
+ # he maximum amount of data that can be contained in a single set of
552
+ # results.
553
+ # @return [Integer]
554
+ #
555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListResourcesRequest AWS API Documentation
556
+ #
557
+ class ListResourcesRequest < Struct.new(
558
+ :project_id,
559
+ :next_token,
560
+ :max_results)
561
+ include Aws::Structure
562
+ end
563
+
564
+ # @!attribute [rw] resources
565
+ # An array of resources associated with the project.
566
+ # @return [Array<Types::Resource>]
567
+ #
568
+ # @!attribute [rw] next_token
569
+ # The continuation token to use when requesting the next set of
570
+ # results, if there are more results to be returned.
571
+ # @return [String]
572
+ #
573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListResourcesResult AWS API Documentation
574
+ #
575
+ class ListResourcesResult < Struct.new(
576
+ :resources,
577
+ :next_token)
578
+ include Aws::Structure
579
+ end
580
+
581
+ # @note When making an API call, you may pass ListTeamMembersRequest
582
+ # data as a hash:
583
+ #
584
+ # {
585
+ # project_id: "ProjectId", # required
586
+ # next_token: "PaginationToken",
587
+ # max_results: 1,
588
+ # }
589
+ #
590
+ # @!attribute [rw] project_id
591
+ # The ID of the project for which you want to list team members.
592
+ # @return [String]
593
+ #
594
+ # @!attribute [rw] next_token
595
+ # The continuation token for the next set of results, if the results
596
+ # cannot be returned in one response.
597
+ # @return [String]
598
+ #
599
+ # @!attribute [rw] max_results
600
+ # The maximum number of team members you want returned in a response.
601
+ # @return [Integer]
602
+ #
603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListTeamMembersRequest AWS API Documentation
604
+ #
605
+ class ListTeamMembersRequest < Struct.new(
606
+ :project_id,
607
+ :next_token,
608
+ :max_results)
609
+ include Aws::Structure
610
+ end
611
+
612
+ # @!attribute [rw] team_members
613
+ # A list of team member objects for the project.
614
+ # @return [Array<Types::TeamMember>]
615
+ #
616
+ # @!attribute [rw] next_token
617
+ # The continuation token to use when requesting the next set of
618
+ # results, if there are more results to be returned.
619
+ # @return [String]
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListTeamMembersResult AWS API Documentation
622
+ #
623
+ class ListTeamMembersResult < Struct.new(
624
+ :team_members,
625
+ :next_token)
626
+ include Aws::Structure
627
+ end
628
+
629
+ # @note When making an API call, you may pass ListUserProfilesRequest
630
+ # data as a hash:
631
+ #
632
+ # {
633
+ # next_token: "PaginationToken",
634
+ # max_results: 1,
635
+ # }
636
+ #
637
+ # @!attribute [rw] next_token
638
+ # The continuation token for the next set of results, if the results
639
+ # cannot be returned in one response.
640
+ # @return [String]
641
+ #
642
+ # @!attribute [rw] max_results
643
+ # The maximum number of results to return in a response.
644
+ # @return [Integer]
645
+ #
646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListUserProfilesRequest AWS API Documentation
647
+ #
648
+ class ListUserProfilesRequest < Struct.new(
649
+ :next_token,
650
+ :max_results)
651
+ include Aws::Structure
652
+ end
653
+
654
+ # @!attribute [rw] user_profiles
655
+ # All the user profiles configured in AWS CodeStar for an AWS account.
656
+ # @return [Array<Types::UserProfileSummary>]
657
+ #
658
+ # @!attribute [rw] next_token
659
+ # The continuation token to use when requesting the next set of
660
+ # results, if there are more results to be returned.
661
+ # @return [String]
662
+ #
663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListUserProfilesResult AWS API Documentation
664
+ #
665
+ class ListUserProfilesResult < Struct.new(
666
+ :user_profiles,
667
+ :next_token)
668
+ include Aws::Structure
669
+ end
670
+
671
+ # Information about the metadata for a project.
672
+ #
673
+ # @!attribute [rw] project_id
674
+ # The ID of the project.
675
+ # @return [String]
676
+ #
677
+ # @!attribute [rw] project_arn
678
+ # The Amazon Resource Name (ARN) of the project.
679
+ # @return [String]
680
+ #
681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ProjectSummary AWS API Documentation
682
+ #
683
+ class ProjectSummary < Struct.new(
684
+ :project_id,
685
+ :project_arn)
686
+ include Aws::Structure
687
+ end
688
+
689
+ # Information about a resource for a project.
690
+ #
691
+ # @!attribute [rw] id
692
+ # The Amazon Resource Name (ARN) of the resource.
693
+ # @return [String]
694
+ #
695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/Resource AWS API Documentation
696
+ #
697
+ class Resource < Struct.new(
698
+ :id)
699
+ include Aws::Structure
700
+ end
701
+
702
+ # Information about a team member in a project.
703
+ #
704
+ # @!attribute [rw] user_arn
705
+ # The Amazon Resource Name (ARN) of the user in IAM.
706
+ # @return [String]
707
+ #
708
+ # @!attribute [rw] project_role
709
+ # The role assigned to the user in the project. Project roles have
710
+ # different levels of access. For more information, see [Working with
711
+ # Teams][1] in the AWS CodeStar User Guide.
712
+ #
713
+ #
714
+ #
715
+ # [1]: http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html
716
+ # @return [String]
717
+ #
718
+ # @!attribute [rw] remote_access_allowed
719
+ # Whether the user is allowed to remotely access project resources
720
+ # using an SSH public/private key pair.
721
+ # @return [Boolean]
722
+ #
723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/TeamMember AWS API Documentation
724
+ #
725
+ class TeamMember < Struct.new(
726
+ :user_arn,
727
+ :project_role,
728
+ :remote_access_allowed)
729
+ include Aws::Structure
730
+ end
731
+
732
+ # @note When making an API call, you may pass UpdateProjectRequest
733
+ # data as a hash:
734
+ #
735
+ # {
736
+ # id: "ProjectId", # required
737
+ # name: "ProjectName",
738
+ # description: "ProjectDescription",
739
+ # }
740
+ #
741
+ # @!attribute [rw] id
742
+ # The ID of the project you want to update.
743
+ # @return [String]
744
+ #
745
+ # @!attribute [rw] name
746
+ # The name of the project you want to update.
747
+ # @return [String]
748
+ #
749
+ # @!attribute [rw] description
750
+ # The description of the project, if any.
751
+ # @return [String]
752
+ #
753
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateProjectRequest AWS API Documentation
754
+ #
755
+ class UpdateProjectRequest < Struct.new(
756
+ :id,
757
+ :name,
758
+ :description)
759
+ include Aws::Structure
760
+ end
761
+
762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateProjectResult AWS API Documentation
763
+ #
764
+ class UpdateProjectResult < Aws::EmptyStructure; end
765
+
766
+ # @note When making an API call, you may pass UpdateTeamMemberRequest
767
+ # data as a hash:
768
+ #
769
+ # {
770
+ # project_id: "ProjectId", # required
771
+ # user_arn: "UserArn", # required
772
+ # project_role: "Role",
773
+ # remote_access_allowed: false,
774
+ # }
775
+ #
776
+ # @!attribute [rw] project_id
777
+ # The ID of the project.
778
+ # @return [String]
779
+ #
780
+ # @!attribute [rw] user_arn
781
+ # The Amazon Resource Name (ARN) of the user for whom you want to
782
+ # change team membership attributes.
783
+ # @return [String]
784
+ #
785
+ # @!attribute [rw] project_role
786
+ # The role assigned to the user in the project. Project roles have
787
+ # different levels of access. For more information, see [Working with
788
+ # Teams][1] in the AWS CodeStar User Guide.
789
+ #
790
+ #
791
+ #
792
+ # [1]: http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html
793
+ # @return [String]
794
+ #
795
+ # @!attribute [rw] remote_access_allowed
796
+ # Whether a team member is allowed to remotely access project
797
+ # resources using the SSH public key associated with the user's
798
+ # profile. Even if this is set to True, the user must associate a
799
+ # public key with their profile before the user can access resources.
800
+ # @return [Boolean]
801
+ #
802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateTeamMemberRequest AWS API Documentation
803
+ #
804
+ class UpdateTeamMemberRequest < Struct.new(
805
+ :project_id,
806
+ :user_arn,
807
+ :project_role,
808
+ :remote_access_allowed)
809
+ include Aws::Structure
810
+ end
811
+
812
+ # @!attribute [rw] user_arn
813
+ # The Amazon Resource Name (ARN) of the user whose team membership
814
+ # attributes were updated.
815
+ # @return [String]
816
+ #
817
+ # @!attribute [rw] project_role
818
+ # The project role granted to the user.
819
+ # @return [String]
820
+ #
821
+ # @!attribute [rw] remote_access_allowed
822
+ # Whether a team member is allowed to remotely access project
823
+ # resources using the SSH public key associated with the user's
824
+ # profile.
825
+ # @return [Boolean]
826
+ #
827
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateTeamMemberResult AWS API Documentation
828
+ #
829
+ class UpdateTeamMemberResult < Struct.new(
830
+ :user_arn,
831
+ :project_role,
832
+ :remote_access_allowed)
833
+ include Aws::Structure
834
+ end
835
+
836
+ # @note When making an API call, you may pass UpdateUserProfileRequest
837
+ # data as a hash:
838
+ #
839
+ # {
840
+ # user_arn: "UserArn", # required
841
+ # display_name: "UserProfileDisplayName",
842
+ # email_address: "Email",
843
+ # ssh_public_key: "SshPublicKey",
844
+ # }
845
+ #
846
+ # @!attribute [rw] user_arn
847
+ # The name that will be displayed as the friendly name for the user in
848
+ # AWS CodeStar.
849
+ # @return [String]
850
+ #
851
+ # @!attribute [rw] display_name
852
+ # The name that is displayed as the friendly name for the user in AWS
853
+ # CodeStar.
854
+ # @return [String]
855
+ #
856
+ # @!attribute [rw] email_address
857
+ # The email address that is displayed as part of the user's profile
858
+ # in AWS CodeStar.
859
+ # @return [String]
860
+ #
861
+ # @!attribute [rw] ssh_public_key
862
+ # The SSH public key associated with the user in AWS CodeStar. If a
863
+ # project owner allows the user remote access to project resources,
864
+ # this public key will be used along with the user's private key for
865
+ # SSH access.
866
+ # @return [String]
867
+ #
868
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateUserProfileRequest AWS API Documentation
869
+ #
870
+ class UpdateUserProfileRequest < Struct.new(
871
+ :user_arn,
872
+ :display_name,
873
+ :email_address,
874
+ :ssh_public_key)
875
+ include Aws::Structure
876
+ end
877
+
878
+ # @!attribute [rw] user_arn
879
+ # The Amazon Resource Name (ARN) of the user in IAM.
880
+ # @return [String]
881
+ #
882
+ # @!attribute [rw] display_name
883
+ # The name that is displayed as the friendly name for the user in AWS
884
+ # CodeStar.
885
+ # @return [String]
886
+ #
887
+ # @!attribute [rw] email_address
888
+ # The email address that is displayed as part of the user's profile
889
+ # in AWS CodeStar.
890
+ # @return [String]
891
+ #
892
+ # @!attribute [rw] ssh_public_key
893
+ # The SSH public key associated with the user in AWS CodeStar. This is
894
+ # the public portion of the public/private keypair the user can use to
895
+ # access project resources if a project owner allows the user remote
896
+ # access to those resources.
897
+ # @return [String]
898
+ #
899
+ # @!attribute [rw] created_timestamp
900
+ # The date the user profile was created, in timestamp format.
901
+ # @return [Time]
902
+ #
903
+ # @!attribute [rw] last_modified_timestamp
904
+ # The date the user profile was last modified, in timestamp format.
905
+ # @return [Time]
906
+ #
907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateUserProfileResult AWS API Documentation
908
+ #
909
+ class UpdateUserProfileResult < Struct.new(
910
+ :user_arn,
911
+ :display_name,
912
+ :email_address,
913
+ :ssh_public_key,
914
+ :created_timestamp,
915
+ :last_modified_timestamp)
916
+ include Aws::Structure
917
+ end
918
+
919
+ # Information about a user's profile in AWS CodeStar.
920
+ #
921
+ # @!attribute [rw] user_arn
922
+ # The Amazon Resource Name (ARN) of the user in IAM.
923
+ # @return [String]
924
+ #
925
+ # @!attribute [rw] display_name
926
+ # The display name of a user in AWS CodeStar. For example, this could
927
+ # be set to both first and last name ("Mary Major") or a single name
928
+ # ("Mary"). The display name is also used to generate the initial
929
+ # icon associated with the user in AWS CodeStar projects. If spaces
930
+ # are included in the display name, the first character that appears
931
+ # after the space will be used as the second character in the user
932
+ # initial icon. The initial icon displays a maximum of two characters,
933
+ # so a display name with more than one space (for example "Mary Jane
934
+ # Major") would generate an initial icon using the first character
935
+ # and the first character after the space ("MJ", not "MM").
936
+ # @return [String]
937
+ #
938
+ # @!attribute [rw] email_address
939
+ # The email address associated with the user.
940
+ # @return [String]
941
+ #
942
+ # @!attribute [rw] ssh_public_key
943
+ # The SSH public key associated with the user in AWS CodeStar. If a
944
+ # project owner allows the user remote access to project resources,
945
+ # this public key will be used along with the user's private key for
946
+ # SSH access.
947
+ # @return [String]
948
+ #
949
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UserProfileSummary AWS API Documentation
950
+ #
951
+ class UserProfileSummary < Struct.new(
952
+ :user_arn,
953
+ :display_name,
954
+ :email_address,
955
+ :ssh_public_key)
956
+ include Aws::Structure
957
+ end
958
+
959
+ end
960
+ end