aws-sdk-codestar 1.0.0.rc1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-codestar.rb +47 -0
- data/lib/aws-sdk-codestar/client.rb +864 -0
- data/lib/aws-sdk-codestar/client_api.rb +447 -0
- data/lib/aws-sdk-codestar/customizations.rb +0 -0
- data/lib/aws-sdk-codestar/errors.rb +14 -0
- data/lib/aws-sdk-codestar/resource.rb +23 -0
- data/lib/aws-sdk-codestar/types.rb +960 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: d4069260053220b76ea974c92707a6225ba5f6d8
|
4
|
+
data.tar.gz: 831f846a6d50dcf7d18216d166ea7f0d4106f210
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 1db09ce43156586809c75d728a044073de3ed2c81f7f91352c0e53d2f8277b6dc3f5e92dca89d4ca7b9a00723b8961cda850b7f1c3bc69d0e29dc359b4666b1c
|
7
|
+
data.tar.gz: b5f31024b1f2c60937527a27db76cc9f5f417723f2a8dd6ea3ddec6156052d03c76c92d560f506af1dff498f5ef73ef996183f8478975582197ae7515af39a5e
|
@@ -0,0 +1,47 @@
|
|
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
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-codestar/types'
|
12
|
+
require_relative 'aws-sdk-codestar/client_api'
|
13
|
+
require_relative 'aws-sdk-codestar/client'
|
14
|
+
require_relative 'aws-sdk-codestar/errors'
|
15
|
+
require_relative 'aws-sdk-codestar/resource'
|
16
|
+
require_relative 'aws-sdk-codestar/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS CodeStar. This module is available in the
|
19
|
+
# `aws-sdk-codestar` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS CodeStar all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::CodeStar::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::CodeStar
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,864 @@
|
|
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
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
22
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
23
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
24
|
+
|
25
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:codestar)
|
26
|
+
|
27
|
+
module Aws::CodeStar
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :codestar
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
51
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
52
|
+
|
53
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
54
|
+
# Your AWS credentials. This can be an instance of any one of the
|
55
|
+
# following classes:
|
56
|
+
#
|
57
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
58
|
+
# credentials.
|
59
|
+
#
|
60
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
61
|
+
# from an EC2 IMDS on an EC2 instance.
|
62
|
+
#
|
63
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
64
|
+
# shared file, such as `~/.aws/config`.
|
65
|
+
#
|
66
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
67
|
+
#
|
68
|
+
# When `:credentials` are not configured directly, the following
|
69
|
+
# locations will be searched for credentials:
|
70
|
+
#
|
71
|
+
# * `Aws.config[:credentials]`
|
72
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
73
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
74
|
+
# * `~/.aws/credentials`
|
75
|
+
# * `~/.aws/config`
|
76
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
77
|
+
# very aggressive. Construct and pass an instance of
|
78
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
79
|
+
# timeouts.
|
80
|
+
#
|
81
|
+
# @option options [required, String] :region
|
82
|
+
# The AWS region to connect to. The configured `:region` is
|
83
|
+
# used to determine the service `:endpoint`. When not passed,
|
84
|
+
# a default `:region` is search for in the following locations:
|
85
|
+
#
|
86
|
+
# * `Aws.config[:region]`
|
87
|
+
# * `ENV['AWS_REGION']`
|
88
|
+
# * `ENV['AMAZON_REGION']`
|
89
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
90
|
+
# * `~/.aws/credentials`
|
91
|
+
# * `~/.aws/config`
|
92
|
+
#
|
93
|
+
# @option options [String] :access_key_id
|
94
|
+
#
|
95
|
+
# @option options [Boolean] :convert_params (true)
|
96
|
+
# When `true`, an attempt is made to coerce request parameters into
|
97
|
+
# the required types.
|
98
|
+
#
|
99
|
+
# @option options [String] :endpoint
|
100
|
+
# The client endpoint is normally constructed from the `:region`
|
101
|
+
# option. You should only configure an `:endpoint` when connecting
|
102
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
103
|
+
#
|
104
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
105
|
+
# The log formatter.
|
106
|
+
#
|
107
|
+
# @option options [Symbol] :log_level (:info)
|
108
|
+
# The log level to send messages to the `:logger` at.
|
109
|
+
#
|
110
|
+
# @option options [Logger] :logger
|
111
|
+
# The Logger instance to send log messages to. If this option
|
112
|
+
# is not set, logging will be disabled.
|
113
|
+
#
|
114
|
+
# @option options [String] :profile ("default")
|
115
|
+
# Used when loading credentials from the shared credentials file
|
116
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
117
|
+
#
|
118
|
+
# @option options [Integer] :retry_limit (3)
|
119
|
+
# The maximum number of times to retry failed requests. Only
|
120
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
121
|
+
# are retried. Generally, these are throttling errors, data
|
122
|
+
# checksum errors, networking errors, timeout errors and auth
|
123
|
+
# errors from expired credentials.
|
124
|
+
#
|
125
|
+
# @option options [String] :secret_access_key
|
126
|
+
#
|
127
|
+
# @option options [String] :session_token
|
128
|
+
#
|
129
|
+
# @option options [Boolean] :simple_json (false)
|
130
|
+
# Disables request parameter conversion, validation, and formatting.
|
131
|
+
# Also disable response data type conversions. This option is useful
|
132
|
+
# when you want to ensure the highest level of performance by
|
133
|
+
# avoiding overhead of walking request parameters and response data
|
134
|
+
# structures.
|
135
|
+
#
|
136
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
137
|
+
# be formatted exactly as the DynamoDB API expects.
|
138
|
+
#
|
139
|
+
# @option options [Boolean] :stub_responses (false)
|
140
|
+
# Causes the client to return stubbed responses. By default
|
141
|
+
# fake responses are generated and returned. You can specify
|
142
|
+
# the response data to return or errors to raise by calling
|
143
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
144
|
+
#
|
145
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
146
|
+
# requests are made, and retries are disabled.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :validate_params (true)
|
149
|
+
# When `true`, request parameters are validated before
|
150
|
+
# sending the request.
|
151
|
+
#
|
152
|
+
def initialize(*args)
|
153
|
+
super
|
154
|
+
end
|
155
|
+
|
156
|
+
# @!group API Operations
|
157
|
+
|
158
|
+
# Adds an IAM user to the team for an AWS CodeStar project.
|
159
|
+
#
|
160
|
+
# @option params [required, String] :project_id
|
161
|
+
# The ID of the project to which you will add the IAM user.
|
162
|
+
#
|
163
|
+
# @option params [String] :client_request_token
|
164
|
+
# A user- or system-generated token that identifies the entity that
|
165
|
+
# requested the team member association to the project. This token can
|
166
|
+
# be used to repeat the request.
|
167
|
+
#
|
168
|
+
# @option params [required, String] :user_arn
|
169
|
+
# The Amazon Resource Name (ARN) for the IAM user you want to add to the
|
170
|
+
# DevHub project.
|
171
|
+
#
|
172
|
+
# @option params [required, String] :project_role
|
173
|
+
# The AWS CodeStar project role that will apply to this user. This role
|
174
|
+
# determines what actions a user can take in an AWS CodeStar project.
|
175
|
+
#
|
176
|
+
# @option params [Boolean] :remote_access_allowed
|
177
|
+
# Whether the team member is allowed to use an SSH public/private key
|
178
|
+
# pair to remotely access project resources, for example Amazon EC2
|
179
|
+
# instances.
|
180
|
+
#
|
181
|
+
# @return [Types::AssociateTeamMemberResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
182
|
+
#
|
183
|
+
# * {Types::AssociateTeamMemberResult#client_request_token #client_request_token} => String
|
184
|
+
#
|
185
|
+
# @example Request syntax with placeholder values
|
186
|
+
#
|
187
|
+
# resp = client.associate_team_member({
|
188
|
+
# project_id: "ProjectId", # required
|
189
|
+
# client_request_token: "ClientRequestToken",
|
190
|
+
# user_arn: "UserArn", # required
|
191
|
+
# project_role: "Role", # required
|
192
|
+
# remote_access_allowed: false,
|
193
|
+
# })
|
194
|
+
#
|
195
|
+
# @example Response structure
|
196
|
+
#
|
197
|
+
# resp.client_request_token #=> String
|
198
|
+
#
|
199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/AssociateTeamMember AWS API Documentation
|
200
|
+
#
|
201
|
+
# @overload associate_team_member(params = {})
|
202
|
+
# @param [Hash] params ({})
|
203
|
+
def associate_team_member(params = {}, options = {})
|
204
|
+
req = build_request(:associate_team_member, params)
|
205
|
+
req.send_request(options)
|
206
|
+
end
|
207
|
+
|
208
|
+
# Creates a project in AWS CodeStar with minimal structure and no
|
209
|
+
# resources.
|
210
|
+
#
|
211
|
+
# @option params [required, String] :name
|
212
|
+
# The friendly name for the project. This friendly name serves as the
|
213
|
+
# basis for the names for resources associated with the project, such as
|
214
|
+
# a repository name in AWS CodeCommit. The name is limited to 100
|
215
|
+
# characters and cannot contain certain restricted symbols. For more
|
216
|
+
# information, see [Limits][1] in the AWS CodeStar User Guide.
|
217
|
+
#
|
218
|
+
#
|
219
|
+
#
|
220
|
+
# [1]: http://docs.aws.amazon.com/codestar/latest/userguide/limits.html
|
221
|
+
#
|
222
|
+
# @option params [required, String] :id
|
223
|
+
# The ID for the AWS CodeStar project. Project IDs must be unique within
|
224
|
+
# an AWS account. Project IDs cannot exceed 15 characters and cannot
|
225
|
+
# contain capital letters and other restricted symbols. For more
|
226
|
+
# information, see [Limits][1] in the AWS CodeStar User Guide.
|
227
|
+
#
|
228
|
+
#
|
229
|
+
#
|
230
|
+
# [1]: http://docs.aws.amazon.com/codestar/latest/userguide/limits.html
|
231
|
+
#
|
232
|
+
# @option params [String] :description
|
233
|
+
# Optional. The description for the project.
|
234
|
+
#
|
235
|
+
# @option params [String] :client_request_token
|
236
|
+
# A user- or system-generated token that identifies the entity that
|
237
|
+
# requested project creation. This token can be used to repeat the
|
238
|
+
# request. It can also be used to identify which user or system made the
|
239
|
+
# request in DescribeProject and ListProjects.
|
240
|
+
#
|
241
|
+
# @return [Types::CreateProjectResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
242
|
+
#
|
243
|
+
# * {Types::CreateProjectResult#id #id} => String
|
244
|
+
# * {Types::CreateProjectResult#arn #arn} => String
|
245
|
+
# * {Types::CreateProjectResult#client_request_token #client_request_token} => String
|
246
|
+
# * {Types::CreateProjectResult#project_template_id #project_template_id} => String
|
247
|
+
#
|
248
|
+
# @example Request syntax with placeholder values
|
249
|
+
#
|
250
|
+
# resp = client.create_project({
|
251
|
+
# name: "ProjectName", # required
|
252
|
+
# id: "ProjectId", # required
|
253
|
+
# description: "ProjectDescription",
|
254
|
+
# client_request_token: "ClientRequestToken",
|
255
|
+
# })
|
256
|
+
#
|
257
|
+
# @example Response structure
|
258
|
+
#
|
259
|
+
# resp.id #=> String
|
260
|
+
# resp.arn #=> String
|
261
|
+
# resp.client_request_token #=> String
|
262
|
+
# resp.project_template_id #=> String
|
263
|
+
#
|
264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/CreateProject AWS API Documentation
|
265
|
+
#
|
266
|
+
# @overload create_project(params = {})
|
267
|
+
# @param [Hash] params ({})
|
268
|
+
def create_project(params = {}, options = {})
|
269
|
+
req = build_request(:create_project, params)
|
270
|
+
req.send_request(options)
|
271
|
+
end
|
272
|
+
|
273
|
+
# Creates a profile for a user that includes user preferences, such as
|
274
|
+
# the display name and email address assocciated with the user, in AWS
|
275
|
+
# CodeStar. The user profile is not project-specific. Information in the
|
276
|
+
# user profile is displayed wherever the user's information appears to
|
277
|
+
# other users in AWS CodeStar.
|
278
|
+
#
|
279
|
+
# @option params [required, String] :user_arn
|
280
|
+
# The Amazon Resource Name (ARN) of the user in IAM.
|
281
|
+
#
|
282
|
+
# @option params [required, String] :display_name
|
283
|
+
# The name that will be displayed as the friendly name for the user in
|
284
|
+
# AWS CodeStar.
|
285
|
+
#
|
286
|
+
# @option params [required, String] :email_address
|
287
|
+
# The email address that will be displayed as part of the user's
|
288
|
+
# profile in AWS CodeStar.
|
289
|
+
#
|
290
|
+
# @option params [String] :ssh_public_key
|
291
|
+
# The SSH public key associated with the user in AWS CodeStar. If a
|
292
|
+
# project owner allows the user remote access to project resources, this
|
293
|
+
# public key will be used along with the user's private key for SSH
|
294
|
+
# access.
|
295
|
+
#
|
296
|
+
# @return [Types::CreateUserProfileResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
297
|
+
#
|
298
|
+
# * {Types::CreateUserProfileResult#user_arn #user_arn} => String
|
299
|
+
# * {Types::CreateUserProfileResult#display_name #display_name} => String
|
300
|
+
# * {Types::CreateUserProfileResult#email_address #email_address} => String
|
301
|
+
# * {Types::CreateUserProfileResult#ssh_public_key #ssh_public_key} => String
|
302
|
+
# * {Types::CreateUserProfileResult#created_timestamp #created_timestamp} => Time
|
303
|
+
# * {Types::CreateUserProfileResult#last_modified_timestamp #last_modified_timestamp} => Time
|
304
|
+
#
|
305
|
+
# @example Request syntax with placeholder values
|
306
|
+
#
|
307
|
+
# resp = client.create_user_profile({
|
308
|
+
# user_arn: "UserArn", # required
|
309
|
+
# display_name: "UserProfileDisplayName", # required
|
310
|
+
# email_address: "Email", # required
|
311
|
+
# ssh_public_key: "SshPublicKey",
|
312
|
+
# })
|
313
|
+
#
|
314
|
+
# @example Response structure
|
315
|
+
#
|
316
|
+
# resp.user_arn #=> String
|
317
|
+
# resp.display_name #=> String
|
318
|
+
# resp.email_address #=> String
|
319
|
+
# resp.ssh_public_key #=> String
|
320
|
+
# resp.created_timestamp #=> Time
|
321
|
+
# resp.last_modified_timestamp #=> Time
|
322
|
+
#
|
323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/CreateUserProfile AWS API Documentation
|
324
|
+
#
|
325
|
+
# @overload create_user_profile(params = {})
|
326
|
+
# @param [Hash] params ({})
|
327
|
+
def create_user_profile(params = {}, options = {})
|
328
|
+
req = build_request(:create_user_profile, params)
|
329
|
+
req.send_request(options)
|
330
|
+
end
|
331
|
+
|
332
|
+
# Deletes a project, including project resources. Does not delete users
|
333
|
+
# associated with the project, but does delete the IAM roles that
|
334
|
+
# allowed access to the project.
|
335
|
+
#
|
336
|
+
# @option params [required, String] :id
|
337
|
+
# The ID of the project to be deleted in AWS CodeStar.
|
338
|
+
#
|
339
|
+
# @option params [String] :client_request_token
|
340
|
+
# A user- or system-generated token that identifies the entity that
|
341
|
+
# requested project deletion. This token can be used to repeat the
|
342
|
+
# request.
|
343
|
+
#
|
344
|
+
# @option params [Boolean] :delete_stack
|
345
|
+
# Whether to send a delete request for the primary stack in AWS
|
346
|
+
# CloudFormation originally used to generate the project and its
|
347
|
+
# resources. This option will delete all AWS resources for the project
|
348
|
+
# (except for any buckets in Amazon S3) as well as deleting the project
|
349
|
+
# itself. Recommended for most use cases.
|
350
|
+
#
|
351
|
+
# @return [Types::DeleteProjectResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
352
|
+
#
|
353
|
+
# * {Types::DeleteProjectResult#stack_id #stack_id} => String
|
354
|
+
# * {Types::DeleteProjectResult#project_arn #project_arn} => String
|
355
|
+
#
|
356
|
+
# @example Request syntax with placeholder values
|
357
|
+
#
|
358
|
+
# resp = client.delete_project({
|
359
|
+
# id: "ProjectId", # required
|
360
|
+
# client_request_token: "ClientRequestToken",
|
361
|
+
# delete_stack: false,
|
362
|
+
# })
|
363
|
+
#
|
364
|
+
# @example Response structure
|
365
|
+
#
|
366
|
+
# resp.stack_id #=> String
|
367
|
+
# resp.project_arn #=> String
|
368
|
+
#
|
369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DeleteProject AWS API Documentation
|
370
|
+
#
|
371
|
+
# @overload delete_project(params = {})
|
372
|
+
# @param [Hash] params ({})
|
373
|
+
def delete_project(params = {}, options = {})
|
374
|
+
req = build_request(:delete_project, params)
|
375
|
+
req.send_request(options)
|
376
|
+
end
|
377
|
+
|
378
|
+
# Deletes a user profile in AWS CodeStar, including all personal
|
379
|
+
# preference data associated with that profile, such as display name and
|
380
|
+
# email address. It does not delete the history of that user, for
|
381
|
+
# example the history of commits made by that user.
|
382
|
+
#
|
383
|
+
# @option params [required, String] :user_arn
|
384
|
+
# The Amazon Resource Name (ARN) of the user to delete from AWS
|
385
|
+
# CodeStar.
|
386
|
+
#
|
387
|
+
# @return [Types::DeleteUserProfileResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
388
|
+
#
|
389
|
+
# * {Types::DeleteUserProfileResult#user_arn #user_arn} => String
|
390
|
+
#
|
391
|
+
# @example Request syntax with placeholder values
|
392
|
+
#
|
393
|
+
# resp = client.delete_user_profile({
|
394
|
+
# user_arn: "UserArn", # required
|
395
|
+
# })
|
396
|
+
#
|
397
|
+
# @example Response structure
|
398
|
+
#
|
399
|
+
# resp.user_arn #=> String
|
400
|
+
#
|
401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DeleteUserProfile AWS API Documentation
|
402
|
+
#
|
403
|
+
# @overload delete_user_profile(params = {})
|
404
|
+
# @param [Hash] params ({})
|
405
|
+
def delete_user_profile(params = {}, options = {})
|
406
|
+
req = build_request(:delete_user_profile, params)
|
407
|
+
req.send_request(options)
|
408
|
+
end
|
409
|
+
|
410
|
+
# Describes a project and its resources.
|
411
|
+
#
|
412
|
+
# @option params [required, String] :id
|
413
|
+
# The ID of the project.
|
414
|
+
#
|
415
|
+
# @return [Types::DescribeProjectResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
416
|
+
#
|
417
|
+
# * {Types::DescribeProjectResult#name #name} => String
|
418
|
+
# * {Types::DescribeProjectResult#id #id} => String
|
419
|
+
# * {Types::DescribeProjectResult#arn #arn} => String
|
420
|
+
# * {Types::DescribeProjectResult#description #description} => String
|
421
|
+
# * {Types::DescribeProjectResult#client_request_token #client_request_token} => String
|
422
|
+
# * {Types::DescribeProjectResult#created_time_stamp #created_time_stamp} => Time
|
423
|
+
# * {Types::DescribeProjectResult#stack_id #stack_id} => String
|
424
|
+
# * {Types::DescribeProjectResult#project_template_id #project_template_id} => String
|
425
|
+
#
|
426
|
+
# @example Request syntax with placeholder values
|
427
|
+
#
|
428
|
+
# resp = client.describe_project({
|
429
|
+
# id: "ProjectId", # required
|
430
|
+
# })
|
431
|
+
#
|
432
|
+
# @example Response structure
|
433
|
+
#
|
434
|
+
# resp.name #=> String
|
435
|
+
# resp.id #=> String
|
436
|
+
# resp.arn #=> String
|
437
|
+
# resp.description #=> String
|
438
|
+
# resp.client_request_token #=> String
|
439
|
+
# resp.created_time_stamp #=> Time
|
440
|
+
# resp.stack_id #=> String
|
441
|
+
# resp.project_template_id #=> String
|
442
|
+
#
|
443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DescribeProject AWS API Documentation
|
444
|
+
#
|
445
|
+
# @overload describe_project(params = {})
|
446
|
+
# @param [Hash] params ({})
|
447
|
+
def describe_project(params = {}, options = {})
|
448
|
+
req = build_request(:describe_project, params)
|
449
|
+
req.send_request(options)
|
450
|
+
end
|
451
|
+
|
452
|
+
# Describes a user in AWS CodeStar and the user attributes across all
|
453
|
+
# projects.
|
454
|
+
#
|
455
|
+
# @option params [required, String] :user_arn
|
456
|
+
# The Amazon Resource Name (ARN) of the user.
|
457
|
+
#
|
458
|
+
# @return [Types::DescribeUserProfileResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
459
|
+
#
|
460
|
+
# * {Types::DescribeUserProfileResult#user_arn #user_arn} => String
|
461
|
+
# * {Types::DescribeUserProfileResult#display_name #display_name} => String
|
462
|
+
# * {Types::DescribeUserProfileResult#email_address #email_address} => String
|
463
|
+
# * {Types::DescribeUserProfileResult#ssh_public_key #ssh_public_key} => String
|
464
|
+
# * {Types::DescribeUserProfileResult#created_timestamp #created_timestamp} => Time
|
465
|
+
# * {Types::DescribeUserProfileResult#last_modified_timestamp #last_modified_timestamp} => Time
|
466
|
+
#
|
467
|
+
# @example Request syntax with placeholder values
|
468
|
+
#
|
469
|
+
# resp = client.describe_user_profile({
|
470
|
+
# user_arn: "UserArn", # required
|
471
|
+
# })
|
472
|
+
#
|
473
|
+
# @example Response structure
|
474
|
+
#
|
475
|
+
# resp.user_arn #=> String
|
476
|
+
# resp.display_name #=> String
|
477
|
+
# resp.email_address #=> String
|
478
|
+
# resp.ssh_public_key #=> String
|
479
|
+
# resp.created_timestamp #=> Time
|
480
|
+
# resp.last_modified_timestamp #=> Time
|
481
|
+
#
|
482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DescribeUserProfile AWS API Documentation
|
483
|
+
#
|
484
|
+
# @overload describe_user_profile(params = {})
|
485
|
+
# @param [Hash] params ({})
|
486
|
+
def describe_user_profile(params = {}, options = {})
|
487
|
+
req = build_request(:describe_user_profile, params)
|
488
|
+
req.send_request(options)
|
489
|
+
end
|
490
|
+
|
491
|
+
# Removes a user from a project. Removing a user from a project also
|
492
|
+
# removes the IAM policies from that user that allowed access to the
|
493
|
+
# project and its resources. Disassociating a team member does not
|
494
|
+
# remove that user's profile from AWS CodeStar. It does not remove the
|
495
|
+
# user from IAM.
|
496
|
+
#
|
497
|
+
# @option params [required, String] :project_id
|
498
|
+
# The ID of the AWS CodeStar project from which you want to remove a
|
499
|
+
# team member.
|
500
|
+
#
|
501
|
+
# @option params [required, String] :user_arn
|
502
|
+
# The Amazon Resource Name (ARN) of the IAM user or group whom you want
|
503
|
+
# to remove from the project.
|
504
|
+
#
|
505
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
506
|
+
#
|
507
|
+
# @example Request syntax with placeholder values
|
508
|
+
#
|
509
|
+
# resp = client.disassociate_team_member({
|
510
|
+
# project_id: "ProjectId", # required
|
511
|
+
# user_arn: "UserArn", # required
|
512
|
+
# })
|
513
|
+
#
|
514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DisassociateTeamMember AWS API Documentation
|
515
|
+
#
|
516
|
+
# @overload disassociate_team_member(params = {})
|
517
|
+
# @param [Hash] params ({})
|
518
|
+
def disassociate_team_member(params = {}, options = {})
|
519
|
+
req = build_request(:disassociate_team_member, params)
|
520
|
+
req.send_request(options)
|
521
|
+
end
|
522
|
+
|
523
|
+
# Lists all projects in AWS CodeStar associated with your AWS account.
|
524
|
+
#
|
525
|
+
# @option params [String] :next_token
|
526
|
+
# The continuation token to be used to return the next set of results,
|
527
|
+
# if the results cannot be returned in one response.
|
528
|
+
#
|
529
|
+
# @option params [Integer] :max_results
|
530
|
+
# The maximum amount of data that can be contained in a single set of
|
531
|
+
# results.
|
532
|
+
#
|
533
|
+
# @return [Types::ListProjectsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
534
|
+
#
|
535
|
+
# * {Types::ListProjectsResult#projects #projects} => Array<Types::ProjectSummary>
|
536
|
+
# * {Types::ListProjectsResult#next_token #next_token} => String
|
537
|
+
#
|
538
|
+
# @example Request syntax with placeholder values
|
539
|
+
#
|
540
|
+
# resp = client.list_projects({
|
541
|
+
# next_token: "PaginationToken",
|
542
|
+
# max_results: 1,
|
543
|
+
# })
|
544
|
+
#
|
545
|
+
# @example Response structure
|
546
|
+
#
|
547
|
+
# resp.projects #=> Array
|
548
|
+
# resp.projects[0].project_id #=> String
|
549
|
+
# resp.projects[0].project_arn #=> String
|
550
|
+
# resp.next_token #=> String
|
551
|
+
#
|
552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListProjects AWS API Documentation
|
553
|
+
#
|
554
|
+
# @overload list_projects(params = {})
|
555
|
+
# @param [Hash] params ({})
|
556
|
+
def list_projects(params = {}, options = {})
|
557
|
+
req = build_request(:list_projects, params)
|
558
|
+
req.send_request(options)
|
559
|
+
end
|
560
|
+
|
561
|
+
# Lists resources associated with a project in AWS CodeStar.
|
562
|
+
#
|
563
|
+
# @option params [required, String] :project_id
|
564
|
+
# The ID of the project.
|
565
|
+
#
|
566
|
+
# @option params [String] :next_token
|
567
|
+
# The continuation token for the next set of results, if the results
|
568
|
+
# cannot be returned in one response.
|
569
|
+
#
|
570
|
+
# @option params [Integer] :max_results
|
571
|
+
# he maximum amount of data that can be contained in a single set of
|
572
|
+
# results.
|
573
|
+
#
|
574
|
+
# @return [Types::ListResourcesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
575
|
+
#
|
576
|
+
# * {Types::ListResourcesResult#resources #resources} => Array<Types::Resource>
|
577
|
+
# * {Types::ListResourcesResult#next_token #next_token} => String
|
578
|
+
#
|
579
|
+
# @example Request syntax with placeholder values
|
580
|
+
#
|
581
|
+
# resp = client.list_resources({
|
582
|
+
# project_id: "ProjectId", # required
|
583
|
+
# next_token: "PaginationToken",
|
584
|
+
# max_results: 1,
|
585
|
+
# })
|
586
|
+
#
|
587
|
+
# @example Response structure
|
588
|
+
#
|
589
|
+
# resp.resources #=> Array
|
590
|
+
# resp.resources[0].id #=> String
|
591
|
+
# resp.next_token #=> String
|
592
|
+
#
|
593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListResources AWS API Documentation
|
594
|
+
#
|
595
|
+
# @overload list_resources(params = {})
|
596
|
+
# @param [Hash] params ({})
|
597
|
+
def list_resources(params = {}, options = {})
|
598
|
+
req = build_request(:list_resources, params)
|
599
|
+
req.send_request(options)
|
600
|
+
end
|
601
|
+
|
602
|
+
# Lists all team members associated with a project.
|
603
|
+
#
|
604
|
+
# @option params [required, String] :project_id
|
605
|
+
# The ID of the project for which you want to list team members.
|
606
|
+
#
|
607
|
+
# @option params [String] :next_token
|
608
|
+
# The continuation token for the next set of results, if the results
|
609
|
+
# cannot be returned in one response.
|
610
|
+
#
|
611
|
+
# @option params [Integer] :max_results
|
612
|
+
# The maximum number of team members you want returned in a response.
|
613
|
+
#
|
614
|
+
# @return [Types::ListTeamMembersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
615
|
+
#
|
616
|
+
# * {Types::ListTeamMembersResult#team_members #team_members} => Array<Types::TeamMember>
|
617
|
+
# * {Types::ListTeamMembersResult#next_token #next_token} => String
|
618
|
+
#
|
619
|
+
# @example Request syntax with placeholder values
|
620
|
+
#
|
621
|
+
# resp = client.list_team_members({
|
622
|
+
# project_id: "ProjectId", # required
|
623
|
+
# next_token: "PaginationToken",
|
624
|
+
# max_results: 1,
|
625
|
+
# })
|
626
|
+
#
|
627
|
+
# @example Response structure
|
628
|
+
#
|
629
|
+
# resp.team_members #=> Array
|
630
|
+
# resp.team_members[0].user_arn #=> String
|
631
|
+
# resp.team_members[0].project_role #=> String
|
632
|
+
# resp.team_members[0].remote_access_allowed #=> Boolean
|
633
|
+
# resp.next_token #=> String
|
634
|
+
#
|
635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListTeamMembers AWS API Documentation
|
636
|
+
#
|
637
|
+
# @overload list_team_members(params = {})
|
638
|
+
# @param [Hash] params ({})
|
639
|
+
def list_team_members(params = {}, options = {})
|
640
|
+
req = build_request(:list_team_members, params)
|
641
|
+
req.send_request(options)
|
642
|
+
end
|
643
|
+
|
644
|
+
# Lists all the user profiles configured for your AWS account in AWS
|
645
|
+
# CodeStar.
|
646
|
+
#
|
647
|
+
# @option params [String] :next_token
|
648
|
+
# The continuation token for the next set of results, if the results
|
649
|
+
# cannot be returned in one response.
|
650
|
+
#
|
651
|
+
# @option params [Integer] :max_results
|
652
|
+
# The maximum number of results to return in a response.
|
653
|
+
#
|
654
|
+
# @return [Types::ListUserProfilesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
655
|
+
#
|
656
|
+
# * {Types::ListUserProfilesResult#user_profiles #user_profiles} => Array<Types::UserProfileSummary>
|
657
|
+
# * {Types::ListUserProfilesResult#next_token #next_token} => String
|
658
|
+
#
|
659
|
+
# @example Request syntax with placeholder values
|
660
|
+
#
|
661
|
+
# resp = client.list_user_profiles({
|
662
|
+
# next_token: "PaginationToken",
|
663
|
+
# max_results: 1,
|
664
|
+
# })
|
665
|
+
#
|
666
|
+
# @example Response structure
|
667
|
+
#
|
668
|
+
# resp.user_profiles #=> Array
|
669
|
+
# resp.user_profiles[0].user_arn #=> String
|
670
|
+
# resp.user_profiles[0].display_name #=> String
|
671
|
+
# resp.user_profiles[0].email_address #=> String
|
672
|
+
# resp.user_profiles[0].ssh_public_key #=> String
|
673
|
+
# resp.next_token #=> String
|
674
|
+
#
|
675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListUserProfiles AWS API Documentation
|
676
|
+
#
|
677
|
+
# @overload list_user_profiles(params = {})
|
678
|
+
# @param [Hash] params ({})
|
679
|
+
def list_user_profiles(params = {}, options = {})
|
680
|
+
req = build_request(:list_user_profiles, params)
|
681
|
+
req.send_request(options)
|
682
|
+
end
|
683
|
+
|
684
|
+
# Updates a project in AWS CodeStar.
|
685
|
+
#
|
686
|
+
# @option params [required, String] :id
|
687
|
+
# The ID of the project you want to update.
|
688
|
+
#
|
689
|
+
# @option params [String] :name
|
690
|
+
# The name of the project you want to update.
|
691
|
+
#
|
692
|
+
# @option params [String] :description
|
693
|
+
# The description of the project, if any.
|
694
|
+
#
|
695
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
696
|
+
#
|
697
|
+
# @example Request syntax with placeholder values
|
698
|
+
#
|
699
|
+
# resp = client.update_project({
|
700
|
+
# id: "ProjectId", # required
|
701
|
+
# name: "ProjectName",
|
702
|
+
# description: "ProjectDescription",
|
703
|
+
# })
|
704
|
+
#
|
705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateProject AWS API Documentation
|
706
|
+
#
|
707
|
+
# @overload update_project(params = {})
|
708
|
+
# @param [Hash] params ({})
|
709
|
+
def update_project(params = {}, options = {})
|
710
|
+
req = build_request(:update_project, params)
|
711
|
+
req.send_request(options)
|
712
|
+
end
|
713
|
+
|
714
|
+
# Updates a team member's attributes in an AWS CodeStar project. For
|
715
|
+
# example, you can change a team member's role in the project, or
|
716
|
+
# change whether they have remote access to project resources.
|
717
|
+
#
|
718
|
+
# @option params [required, String] :project_id
|
719
|
+
# The ID of the project.
|
720
|
+
#
|
721
|
+
# @option params [required, String] :user_arn
|
722
|
+
# The Amazon Resource Name (ARN) of the user for whom you want to change
|
723
|
+
# team membership attributes.
|
724
|
+
#
|
725
|
+
# @option params [String] :project_role
|
726
|
+
# The role assigned to the user in the project. Project roles have
|
727
|
+
# different levels of access. For more information, see [Working with
|
728
|
+
# Teams][1] in the AWS CodeStar User Guide.
|
729
|
+
#
|
730
|
+
#
|
731
|
+
#
|
732
|
+
# [1]: http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html
|
733
|
+
#
|
734
|
+
# @option params [Boolean] :remote_access_allowed
|
735
|
+
# Whether a team member is allowed to remotely access project resources
|
736
|
+
# using the SSH public key associated with the user's profile. Even if
|
737
|
+
# this is set to True, the user must associate a public key with their
|
738
|
+
# profile before the user can access resources.
|
739
|
+
#
|
740
|
+
# @return [Types::UpdateTeamMemberResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
741
|
+
#
|
742
|
+
# * {Types::UpdateTeamMemberResult#user_arn #user_arn} => String
|
743
|
+
# * {Types::UpdateTeamMemberResult#project_role #project_role} => String
|
744
|
+
# * {Types::UpdateTeamMemberResult#remote_access_allowed #remote_access_allowed} => Boolean
|
745
|
+
#
|
746
|
+
# @example Request syntax with placeholder values
|
747
|
+
#
|
748
|
+
# resp = client.update_team_member({
|
749
|
+
# project_id: "ProjectId", # required
|
750
|
+
# user_arn: "UserArn", # required
|
751
|
+
# project_role: "Role",
|
752
|
+
# remote_access_allowed: false,
|
753
|
+
# })
|
754
|
+
#
|
755
|
+
# @example Response structure
|
756
|
+
#
|
757
|
+
# resp.user_arn #=> String
|
758
|
+
# resp.project_role #=> String
|
759
|
+
# resp.remote_access_allowed #=> Boolean
|
760
|
+
#
|
761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateTeamMember AWS API Documentation
|
762
|
+
#
|
763
|
+
# @overload update_team_member(params = {})
|
764
|
+
# @param [Hash] params ({})
|
765
|
+
def update_team_member(params = {}, options = {})
|
766
|
+
req = build_request(:update_team_member, params)
|
767
|
+
req.send_request(options)
|
768
|
+
end
|
769
|
+
|
770
|
+
# Updates a user's profile in AWS CodeStar. The user profile is not
|
771
|
+
# project-specific. Information in the user profile is displayed
|
772
|
+
# wherever the user's information appears to other users in AWS
|
773
|
+
# CodeStar.
|
774
|
+
#
|
775
|
+
# @option params [required, String] :user_arn
|
776
|
+
# The name that will be displayed as the friendly name for the user in
|
777
|
+
# AWS CodeStar.
|
778
|
+
#
|
779
|
+
# @option params [String] :display_name
|
780
|
+
# The name that is displayed as the friendly name for the user in AWS
|
781
|
+
# CodeStar.
|
782
|
+
#
|
783
|
+
# @option params [String] :email_address
|
784
|
+
# The email address that is displayed as part of the user's profile in
|
785
|
+
# AWS CodeStar.
|
786
|
+
#
|
787
|
+
# @option params [String] :ssh_public_key
|
788
|
+
# The SSH public key associated with the user in AWS CodeStar. If a
|
789
|
+
# project owner allows the user remote access to project resources, this
|
790
|
+
# public key will be used along with the user's private key for SSH
|
791
|
+
# access.
|
792
|
+
#
|
793
|
+
# @return [Types::UpdateUserProfileResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
794
|
+
#
|
795
|
+
# * {Types::UpdateUserProfileResult#user_arn #user_arn} => String
|
796
|
+
# * {Types::UpdateUserProfileResult#display_name #display_name} => String
|
797
|
+
# * {Types::UpdateUserProfileResult#email_address #email_address} => String
|
798
|
+
# * {Types::UpdateUserProfileResult#ssh_public_key #ssh_public_key} => String
|
799
|
+
# * {Types::UpdateUserProfileResult#created_timestamp #created_timestamp} => Time
|
800
|
+
# * {Types::UpdateUserProfileResult#last_modified_timestamp #last_modified_timestamp} => Time
|
801
|
+
#
|
802
|
+
# @example Request syntax with placeholder values
|
803
|
+
#
|
804
|
+
# resp = client.update_user_profile({
|
805
|
+
# user_arn: "UserArn", # required
|
806
|
+
# display_name: "UserProfileDisplayName",
|
807
|
+
# email_address: "Email",
|
808
|
+
# ssh_public_key: "SshPublicKey",
|
809
|
+
# })
|
810
|
+
#
|
811
|
+
# @example Response structure
|
812
|
+
#
|
813
|
+
# resp.user_arn #=> String
|
814
|
+
# resp.display_name #=> String
|
815
|
+
# resp.email_address #=> String
|
816
|
+
# resp.ssh_public_key #=> String
|
817
|
+
# resp.created_timestamp #=> Time
|
818
|
+
# resp.last_modified_timestamp #=> Time
|
819
|
+
#
|
820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateUserProfile AWS API Documentation
|
821
|
+
#
|
822
|
+
# @overload update_user_profile(params = {})
|
823
|
+
# @param [Hash] params ({})
|
824
|
+
def update_user_profile(params = {}, options = {})
|
825
|
+
req = build_request(:update_user_profile, params)
|
826
|
+
req.send_request(options)
|
827
|
+
end
|
828
|
+
|
829
|
+
# @!endgroup
|
830
|
+
|
831
|
+
# @param params ({})
|
832
|
+
# @api private
|
833
|
+
def build_request(operation_name, params = {})
|
834
|
+
handlers = @handlers.for(operation_name)
|
835
|
+
context = Seahorse::Client::RequestContext.new(
|
836
|
+
operation_name: operation_name,
|
837
|
+
operation: config.api.operation(operation_name),
|
838
|
+
client: self,
|
839
|
+
params: params,
|
840
|
+
config: config)
|
841
|
+
context[:gem_name] = 'aws-sdk-codestar'
|
842
|
+
context[:gem_version] = '1.0.0.rc1'
|
843
|
+
Seahorse::Client::Request.new(handlers, context)
|
844
|
+
end
|
845
|
+
|
846
|
+
# @api private
|
847
|
+
# @deprecated
|
848
|
+
def waiter_names
|
849
|
+
[]
|
850
|
+
end
|
851
|
+
|
852
|
+
class << self
|
853
|
+
|
854
|
+
# @api private
|
855
|
+
attr_reader :identifier
|
856
|
+
|
857
|
+
# @api private
|
858
|
+
def errors_module
|
859
|
+
Errors
|
860
|
+
end
|
861
|
+
|
862
|
+
end
|
863
|
+
end
|
864
|
+
end
|